improve types

geut · May 24, 2024 · 2f2655d · 2f2655d
1 parent 21a19f6
commit 2f2655d
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 6 deletions.
diff --git a/src/writer.js b/src/writer.js
@@ -73,6 +73,28 @@ export const write = async (path, opts = {}) => {
    * @typedef {import('@sinclair/typebox').Static<T>} Static
    */
 
+  /**
+   * @typedef {{
+   *  [Path in keyof typeof schema]: {
+   *    [Method in keyof typeof schema[Path]]: {
+   *      [Prop in keyof typeof schema[Path][Method]]: typeof schema[Path][Method][Prop] extends TSchema ?
+   *        Static<typeof schema[Path][Method][Prop]> :
+   *        undefined
+   *    }
+   *  }
+   * }} SchemaType
+   */
+
+  /**
+   * @typedef {{
+   *  [ComponentType in keyof typeof _components]: {
+   *    [ComponentName in keyof typeof _components[ComponentType]]: typeof _components[ComponentType][ComponentName] extends TSchema ?
+   *      Static<typeof _components[ComponentType][ComponentName]> :
+   *      undefined
+   *  }
+   * }} ComponentType
+   */
+
   /** @typedef {Json[]} JsonArray */
   /** @typedef {{ [key: string | number]: Json }} JsonRecord */
   /** @typedef {string} JsonString */

diff --git a/test/index.js b/test/index.js
@@ -1,8 +1,3 @@
-/**
- * @template {import('@sinclair/typebox').TSchema} T
- * @typedef {import('@sinclair/typebox').Static<T>} Static
- */
-
 import test, { after } from 'node:test'
 import assert from 'node:assert'
 import { readFile, writeFile, mkdir } from 'node:fs/promises'
@@ -290,7 +285,7 @@ test('basic test', async () => {
       const { data, error, clientError } = await postRoute(args)
       assert.equal(error, undefined)
       assert.equal(clientError, undefined)
-      expectTypeOf(data).toEqualTypeOf(/** @type {Static<typeof import('../tmp/schema.js')['schema']['/some-route/{id}']['POST']['data']>} */(args))
+      expectTypeOf(data).toEqualTypeOf(/** @type {import('../tmp/schema.js').SchemaType['/some-route/{id}']['POST']['data']} */(args))
     })
   })
 })

diff --git a/test/petstore.txt b/test/petstore.txt
@@ -10,6 +10,28 @@
  * @typedef {import('@sinclair/typebox').Static<T>} Static
  */
 
+/**
+ * @typedef {{
+ *  [Path in keyof typeof schema]: {
+ *    [Method in keyof typeof schema[Path]]: {
+ *      [Prop in keyof typeof schema[Path][Method]]: typeof schema[Path][Method][Prop] extends TSchema ?
+ *        Static<typeof schema[Path][Method][Prop]> :
+ *        undefined
+ *    }
+ *  }
+ * }} SchemaType
+ */
+
+/**
+ * @typedef {{
+ *  [ComponentType in keyof typeof _components]: {
+ *    [ComponentName in keyof typeof _components[ComponentType]]: typeof _components[ComponentType][ComponentName] extends TSchema ?
+ *      Static<typeof _components[ComponentType][ComponentName]> :
+ *      undefined
+ *  }
+ * }} ComponentType
+ */
+
 /** @typedef {Json[]} JsonArray */
 /** @typedef {{ [key: string | number]: Json }} JsonRecord */
 /** @typedef {string} JsonString */

diff --git a/test/schema.cjs.txt b/test/schema.cjs.txt
@@ -10,6 +10,28 @@
  * @typedef {import('@sinclair/typebox').Static<T>} Static
  */
 
+/**
+ * @typedef {{
+ *  [Path in keyof typeof schema]: {
+ *    [Method in keyof typeof schema[Path]]: {
+ *      [Prop in keyof typeof schema[Path][Method]]: typeof schema[Path][Method][Prop] extends TSchema ?
+ *        Static<typeof schema[Path][Method][Prop]> :
+ *        undefined
+ *    }
+ *  }
+ * }} SchemaType
+ */
+
+/**
+ * @typedef {{
+ *  [ComponentType in keyof typeof _components]: {
+ *    [ComponentName in keyof typeof _components[ComponentType]]: typeof _components[ComponentType][ComponentName] extends TSchema ?
+ *      Static<typeof _components[ComponentType][ComponentName]> :
+ *      undefined
+ *  }
+ * }} ComponentType
+ */
+
 /** @typedef {Json[]} JsonArray */
 /** @typedef {{ [key: string | number]: Json }} JsonRecord */
 /** @typedef {string} JsonString */

diff --git a/test/schema.txt b/test/schema.txt
@@ -10,6 +10,28 @@
  * @typedef {import('@sinclair/typebox').Static<T>} Static
  */
 
+/**
+ * @typedef {{
+ *  [Path in keyof typeof schema]: {
+ *    [Method in keyof typeof schema[Path]]: {
+ *      [Prop in keyof typeof schema[Path][Method]]: typeof schema[Path][Method][Prop] extends TSchema ?
+ *        Static<typeof schema[Path][Method][Prop]> :
+ *        undefined
+ *    }
+ *  }
+ * }} SchemaType
+ */
+
+/**
+ * @typedef {{
+ *  [ComponentType in keyof typeof _components]: {
+ *    [ComponentName in keyof typeof _components[ComponentType]]: typeof _components[ComponentType][ComponentName] extends TSchema ?
+ *      Static<typeof _components[ComponentType][ComponentName]> :
+ *      undefined
+ *  }
+ * }} ComponentType
+ */
+
 /** @typedef {Json[]} JsonArray */
 /** @typedef {{ [key: string | number]: Json }} JsonRecord */
 /** @typedef {string} JsonString */