Typeid support

packages/openapi-ts/src/ir/types.d.ts

@@ -138,6 +138,7 @@ interface IRSchemaObject
     | 'pattern'
     | 'required'
     | 'title'
+    | 'example'
   > {
   /**
    * If the schema is intended to be used as an object property, it can be

packages/openapi-ts/src/openApi/2.0.x/parser/schema.ts

@@ -32,6 +32,10 @@
   irSchema: IR.SchemaObject;
   schema: SchemaObject;
 }) => {
+  if (schema.example) {
+    irSchema.example = schema.example;
+  }
+
   if (schema.description) {
     irSchema.description = schema.description;
   }

packages/openapi-ts/src/openApi/3.0.x/parser/schema.ts

@@ -36,6 +36,10 @@
     irSchema.deprecated = schema.deprecated;
   }
 
+  if (schema.example) {
+    irSchema.example = schema.example;
+  }
+
   if (schema.description) {
     irSchema.description = schema.description;
   }

packages/openapi-ts/src/openApi/3.1.x/parser/schema.ts

@@ -42,6 +42,10 @@
     irSchema.deprecated = schema.deprecated;
   }
 
+  if (schema.example) {
+    irSchema.example = schema.example;
+  }
+
   if (schema.description) {
     irSchema.description = schema.description;
   }

packages/openapi-ts/src/plugins/@hey-api/typescript/config.ts

@@ -17,6 +17,7 @@ export const defaultConfig: Plugin.Config<Config> = {
   readableNameBuilder: '{{name}}Readable',
   style: 'preserve',
   tree: false,
+  typeids: false,
   writableNameBuilder: '{{name}}Writable',
 };
 

packages/openapi-ts/src/plugins/@hey-api/typescript/plugin.ts

@@ -617,10 +617,12 @@
 
 const stringTypeToIdentifier = ({
   context,
+  plugin,
   schema,
 }: {
   context: IR.Context;
   namespace: Array<ts.Statement>;
+  plugin: Plugin.Instance<Config>;
   schema: SchemaWithType<'string'>;
 }): ts.TypeNode => {
   if (schema.const !== undefined) {
@@ -649,6 +651,20 @@
         return compiler.typeReferenceNode({ typeName: 'Date' });
       }
     }
+
+    if (schema.format === 'typeid' && schema.example && plugin.typeids) {
+      const type = String(schema.example).split('_')[0]!;
+      return compiler.typeReferenceNode({
+        typeArguments: [
+          compiler.literalTypeNode({
+            literal: compiler.stringLiteral({
+              text: type,
+            }),
+          }),
+        ],
+        typeName: 'TypeID',
+      });
+    }
   }
 
   return compiler.keywordTypeNode({
@@ -763,6 +779,7 @@
       return stringTypeToIdentifier({
         context,
         namespace,
+        plugin,
         schema: schema as SchemaWithType<'string'>,
       });
     case 'tuple':
@@ -1255,6 +1272,31 @@
     namespace: 'type',
   });
 
+  if (plugin.typeids) {
+    const typeParameter = compiler.typeParameterDeclaration({
+      constraint: compiler.keywordTypeNode({
+        keyword: 'string',
+      }),
+      name: 'T',
+    });
+    const node = compiler.typeAliasDeclaration({
+      name: 'TypeID',
+      type: compiler.templateLiteralType({
+        value: [
+          compiler.typeReferenceNode({
+            typeName: 'T',
+          }),
+          '_',
+          compiler.keywordTypeNode({
+            keyword: 'string',
+          }),
+        ],
+      }),
+      typeParameters: [typeParameter],
+    });
+    file.add(node);
+  }
+
   context.subscribe('schema', ({ $ref, schema }) => {
     if (
       plugin.readOnlyWriteOnlyBehavior === 'off' ||

packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts

@@ -67,6 +67,12 @@
    * @default '{{name}}Writable'
    */
   writableNameBuilder?: string;
+  /**
+   * Generate types for [TypeIDs](https://github.com/jetify-com/typeid/tree/main/spec).
+   *
+   * @default false
+   */
+  typeids?: boolean;
 
   // DEPRECATED OPTIONS BELOW