Give format precendence over type property

.gitignore

@@ -3,6 +3,7 @@
 # editors
 #.vscode
 .idea/
+*.iml
 
 # dependencies
 node_modules
@@ -47,3 +48,4 @@ test.json
 docs/.vitepress/cache/**
 docs/.vitepress/dist/**
 !__snapshots__
+.pnpm-store/

packages/swagger-ts/mocks/type_assertions.yaml

@@ -0,0 +1,51 @@
+components:
+  schemas:
+    Body_upload_file_api_assets_post:
+      properties:
+        file:
+          format: binary
+          title: File
+          type: string
+      required:
+      - file
+      title: Body_upload_file_api_assets_post
+      type: object
+      $comment: |
+        export type BodyUploadFileApiAssetsPost = {
+            /**
+            * @type string binary
+            */
+            file: Blob;
+        };
+    Plain_file:
+      format: binary
+      title: File
+      type: string
+      $comment: export type PlainFile = Blob;
+    Plain_date:
+      format: date
+      title: Date
+      type: string
+      $comment: export type PlainDate = Date;
+    Plain_time:
+      format: time
+      title: Time
+      type: number
+      $comment: export type PlainTime = number;
+    Plain_date_time:
+      format: date-time
+      title: Datetime
+      type: string
+      $comment: 
+    Plain_email:
+      format: email
+      title: Email
+      type: string
+    Plain_uuid:
+      format: uuid
+      title: UUID
+      type: string
+info:
+  title: Type Assertions
+openapi: 3.1.0
+paths: {}

packages/swagger-ts/src/TypeGenerator.test.ts

@@ -457,3 +457,162 @@ describe('TypeGenerator enums', async () => {
     expect(await format(output)).toMatchSnapshot()
   })
 })
+
+describe('TypeGenerator type assertions', async () => {
+  const schemaPath = path.resolve(__dirname, '../mocks/type_assertions.yaml')
+  const oas = await new OasManager().parse(schemaPath)
+
+  const schemas = oas.getDefinition().components?.schemas
+
+  test('generates file property with `File` type', async () => {
+    const generator = new TypeGenerator({
+      usedEnumNames: {},
+      enumType: 'asConst',
+      dateType: 'string',
+      optionalType: 'questionToken',
+      transformers: {},
+      oasType: false,
+      unknownType: 'unknown',
+    }, {
+      oas,
+      pluginManager: mockedPluginManager,
+    })
+    const node = generator.build({ schema: schemas?.Body_upload_file_api_assets_post as OasTypes.SchemaObject, baseName: 'Body_upload_file_api_assets_post' })
+
+    const output = print(node, undefined)
+
+    expect(output).toBeDefined()
+    expect(output).toMatchSnapshot()
+  })
+
+  test('generates Plain_File types correctly', async () => {
+    const generator = new TypeGenerator({
+      usedEnumNames: {},
+      enumType: 'asConst',
+      dateType: 'string',
+      optionalType: 'questionToken',
+      transformers: {},
+      oasType: false,
+      unknownType: 'unknown',
+    }, {
+      oas,
+      pluginManager: mockedPluginManager,
+    })
+    const node = generator.build({ schema: schemas?.Plain_file as OasTypes.SchemaObject, baseName: 'Plain_file' })
+
+    const output = print(node, undefined)
+
+    expect(output).toBeDefined()
+    expect(output).toMatchSnapshot()
+  })
+
+  test('generates Date type correctly when dateType = date', async () => {
+    const generator = new TypeGenerator({
+      usedEnumNames: {},
+      enumType: 'asConst',
+      dateType: 'date',
+      optionalType: 'questionToken',
+      transformers: {},
+      oasType: false,
+      unknownType: 'unknown',
+    }, {
+      oas,
+      pluginManager: mockedPluginManager,
+    })
+
+    const node = generator.build({ schema: schemas?.Plain_date as OasTypes.SchemaObject, baseName: 'Plain_date' })
+
+    const output = print(node, undefined)
+
+    expect(output).toBeDefined()
+    expect(output).toMatchSnapshot()
+  })
+
+  test('generates Date type correctly when dateType = string', async () => {
+    const generator = new TypeGenerator({
+      usedEnumNames: {},
+      enumType: 'asConst',
+      dateType: 'string',
+      optionalType: 'questionToken',
+      transformers: {},
+      oasType: false,
+      unknownType: 'unknown',
+    }, {
+      oas,
+      pluginManager: mockedPluginManager,
+    })
+
+    const node = generator.build({ schema: schemas?.Plain_date as OasTypes.SchemaObject, baseName: 'Plain_date' })
+
+    const output = print(node, undefined)
+
+    expect(output).toBeDefined()
+    expect(output).toMatchSnapshot()
+  })
+
+  test('generates Time type correctly', async () => {
+    const generator = new TypeGenerator({
+      usedEnumNames: {},
+      enumType: 'asConst',
+      dateType: 'string',
+      optionalType: 'questionToken',
+      transformers: {},
+      oasType: false,
+      unknownType: 'unknown',
+    }, {
+      oas,
+      pluginManager: mockedPluginManager,
+    })
+
+    const node = generator.build({ schema: schemas?.Plain_time as OasTypes.SchemaObject, baseName: 'Plain_time' })
+
+    const output = print(node, undefined)
+
+    expect(output).toBeDefined()
+    expect(output).toMatchSnapshot()
+  })
+
+  test('generates Email type correctly', async () => {
+    const generator = new TypeGenerator({
+      usedEnumNames: {},
+      enumType: 'asConst',
+      dateType: 'string',
+      optionalType: 'questionToken',
+      transformers: {},
+      oasType: false,
+      unknownType: 'unknown',
+    }, {
+      oas,
+      pluginManager: mockedPluginManager,
+    })
+
+    const node = generator.build({ schema: schemas?.Plain_email as OasTypes.SchemaObject, baseName: 'Plain_email' })
+
+    const output = print(node, undefined)
+
+    expect(output).toBeDefined()
+    expect(output).toMatchSnapshot()
+  })
+
+  test('generates UUID type correctly', async () => {
+    const generator = new TypeGenerator({
+      usedEnumNames: {},
+      enumType: 'asConst',
+      dateType: 'string',
+      optionalType: 'questionToken',
+      transformers: {},
+      oasType: false,
+      unknownType: 'unknown',
+    }, {
+      oas,
+      pluginManager: mockedPluginManager,
+    })
+
+    const node = generator.build({ schema: schemas?.Plain_uuid as OasTypes.SchemaObject, baseName: 'Plain_uuid' })
+
+    const output = print(node, undefined)
+
+    expect(output).toBeDefined()
+    expect(output).toMatchSnapshot()
+  })
+})

packages/swagger-ts/src/TypeGenerator.ts

@@ -115,7 +115,14 @@
       const schema = properties[name] as OasTypes.SchemaObject
 
       const isRequired = Array.isArray(required) ? required.includes(name) : !!required
-      let type = this.getTypeFromSchema(schema, this.context.pluginManager.resolveName({ name: `${baseName || ''} ${name}`, pluginKey, type: 'type' }))
+      let type = this.getTypeFromSchema(
+        schema,
+        this.context.pluginManager.resolveName({
+          name: `${baseName || ''} ${name}`,
+          pluginKey,
+          type: 'type',
+        }),
+      )
 
       if (!type) {
         return null
@@ -303,7 +310,14 @@
           type: this.options.enumType,
         }),
       )
-      return factory.createTypeReferenceNode(this.context.pluginManager.resolveName({ name: enumName, pluginKey, type: 'type' }), undefined)
+      return factory.createTypeReferenceNode(
+        this.context.pluginManager.resolveName({
+          name: enumName,
+          pluginKey,
+          type: 'type',
+        }),
+        undefined,
+      )
     }
 
     if (schema.enum) {
@@ -386,8 +400,47 @@
         })
       }
 
-      if (this.options.dateType === 'date' && ['date', 'date-time'].some((item) => item === schema.format)) {
-        return factory.createTypeReferenceNode(factory.createIdentifier('Date'))
+      /**
+       * > Structural validation alone may be insufficient to allow an application to correctly utilize certain values. The "format"
+       * > annotation keyword is defined to allow schema authors to convey semantic information for a fixed subset of values which are
+       * > accurately described by authoritative resources, be they RFCs or other external specifications.
+       *
+       * In other words: format is more specific than type alone, hence it should override the type value, if possible.
+       *
+       * see also https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-00#rfc.section.7
+       */
+      if (schema.format) {
+        switch (schema.format) {
+          case 'binary':
+            if (schema.type === 'string') {
+              return factory.createTypeReferenceNode('Blob', [])
+            }
+            break
+          // 7.3.1. Dates, Times, and Duration
+          case 'date-time':
+          case 'date':
+          case 'time':
+            if (this.options.dateType === 'date') {
+              return factory.createTypeReferenceNode(factory.createIdentifier('Date'))
+            }
+          case 'uuid':
+            // TODO how to work with this? use https://www.npmjs.com/package/uuid for it?
+            break
+          case 'duration':
+          case 'email':
+          case 'idn-email':
+          case 'hostname':
+          case 'idn-hostname':
+          case 'ipv4':
+          case 'ipv6':
+          case 'uri':
+          case 'uri-reference':
+          case 'json-pointer':
+          case 'relative-json-pointer':
+          default:
+            // formats not yet implemented: ignore.
+            break
+        }
       }
 
       // string, boolean, null, number
@@ -396,10 +449,6 @@
       }
     }
 
-    if (schema.format === 'binary') {
-      return factory.createTypeReferenceNode('Blob', [])
-    }
-
     return this.#unknownReturn
   }
 

packages/swagger-ts/src/__snapshots__/TypeGenerator.test.ts.snap

@@ -221,3 +221,43 @@ exports[`TypeGenerator petStoreRef > generate type for Pets 1`] = `
 "export type Pets = Pet[]
 "
 `;
+
+exports[`TypeGenerator type assertions > generates Date type correctly when dateType = date 1`] = `
+"export type PlainDate = Date;
+"
+`;
+
+exports[`TypeGenerator type assertions > generates Date type correctly when dateType = string 1`] = `
+"export type PlainDate = string;
+"
+`;
+
+exports[`TypeGenerator type assertions > generates Email type correctly 1`] = `
+"export type PlainEmail = string;
+"
+`;
+
+exports[`TypeGenerator type assertions > generates Plain_File types correctly 1`] = `
+"export type PlainFile = Blob;
+"
+`;
+
+exports[`TypeGenerator type assertions > generates Time type correctly 1`] = `
+"export type PlainTime = number;
+"
+`;
+
+exports[`TypeGenerator type assertions > generates UUID type correctly 1`] = `
+"export type PlainUuid = string;
+"
+`;
+
+exports[`TypeGenerator type assertions > generates file property with \`File\` type 1`] = `
+"export type BodyUploadFileApiAssetsPost = {
+    /**
+     * @type string binary
+    */
+    file: Blob;
+};
+"
+`;