@openapi-qraft/openapi-typescript-plugin 1.1.0-beta.3 → 1.1.0-beta.5

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @openapi-qraft/openapi-typescript
 
+## 1.1.0-beta.5
+
+### Minor Changes
+
+- 0df334b: Added `--explicit-component-exports` option to export API components as separate type aliases alongside `components` interface by [@EcksDy](https://github.com/EcksDy)
+
+### Patch Changes
+
+- @openapi-qraft/plugin@1.14.0-beta.5
+
+## 1.1.0-beta.4
+
+### Patch Changes
+
+- Updated dependencies [346a408]
+  - @openapi-qraft/plugin@1.14.0-beta.4
+
 ## 1.1.0-beta.3
 
 ### Patch Changes

package/dist/generateSchemaTypes.d.ts

@@ -7,6 +7,7 @@ export declare function generateSchemaTypes(schema: string | URL | OpenAPI3 | Re
     silent: boolean;
     args: Pick<OpenAPITSOptions, 'additionalProperties' | 'alphabetize' | 'arrayLength' | 'defaultNonNullable' | 'emptyObjectsUnknown' | 'enum' | 'enumValues' | 'dedupeEnums' | 'excludeDeprecated' | 'exportType' | 'immutable' | 'pathParamsAsTypes' | 'propertiesRequiredByDefault'> & {
         blobFromBinary?: boolean;
+        explicitComponentExports?: boolean;
     };
 }): Promise<string>;
 //# sourceMappingURL=generateSchemaTypes.d.ts.map

package/dist/generateSchemaTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateSchemaTypes.d.ts","sourceRoot":"","sources":["../src/generateSchemaTypes.ts"],"names":[],"mappings":";;;AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAKrE,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,EACnD,EACE,MAAM,EACN,IAAI,GACL,EAAE;IACD,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,IAAI,CACR,gBAAgB,EACd,sBAAsB,GACtB,aAAa,GACb,aAAa,GACb,oBAAoB,GACpB,qBAAqB,GACrB,MAAM,GACN,YAAY,GACZ,aAAa,GACb,mBAAmB,GACnB,YAAY,GACZ,WAAW,GACX,mBAAmB,GACnB,6BAA6B,CAChC,GAAG;QACF,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH,mBAqBF"}
+{"version":3,"file":"generateSchemaTypes.d.ts","sourceRoot":"","sources":["../src/generateSchemaTypes.ts"],"names":[],"mappings":";;;AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAMrE,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,GAAG,GAAG,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,EACnD,EACE,MAAM,EACN,IAAI,GACL,EAAE;IACD,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,IAAI,CACR,gBAAgB,EACd,sBAAsB,GACtB,aAAa,GACb,aAAa,GACb,oBAAoB,GACpB,qBAAqB,GACrB,MAAM,GACN,YAAY,GACZ,aAAa,GACb,mBAAmB,GACnB,YAAY,GACZ,WAAW,GACX,mBAAmB,GACnB,6BAA6B,CAChC,GAAG;QACF,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;CACH,mBAwBF"}

package/dist/generateSchemaTypes.js

@@ -1,8 +1,9 @@
 import { createConfig } from '@redocly/openapi-core';
 import openapiTS, { astToString } from 'openapi-typescript';
 import ts from 'typescript';
+import { createExportsForComponentSchemas } from './lib/createExportsForComponentSchemas.js';
 export async function generateSchemaTypes(schema, { silent, args, }) {
-    return astToString(await openapiTS(schema, {
+    const ast = await openapiTS(schema, {
         transform: args.blobFromBinary ? transformFormatBinary : undefined,
         additionalProperties: args.additionalProperties,
         alphabetize: args.alphabetize,
@@ -18,7 +19,10 @@ export async function generateSchemaTypes(schema, { silent, args, }) {
         redocly: await createConfig({}, { extends: ['minimal'] }),
         propertiesRequiredByDefault: args.propertiesRequiredByDefault,
         silent,
-    }));
+    });
+    if (args.explicitComponentExports)
+        return astToString(ast.concat(createExportsForComponentSchemas(ast)));
+    return astToString(ast);
 }
 function transformFormatBinary(schemaObject) {
     if (schemaObject.format !== 'binary')

package/dist/generateSchemaTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateSchemaTypes.js","sourceRoot":"","sources":["../src/generateSchemaTypes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,SAAS,EAAE,EAAE,WAAW,EAAgB,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,MAAmD,EACnD,EACE,MAAM,EACN,IAAI,GAqBL;IAED,OAAO,WAAW,CAChB,MAAM,SAAS,CAAC,MAAM,EAAE;QACtB,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS;QAClE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;QAC/C,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,8EAA8E;QAC9E,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;QAC3C,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;QAC7C,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;QACzC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;QACzC,OAAO,EAAE,MAAM,YAAY,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;QACzD,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;QAC7D,MAAM;KACP,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,YAA0B;IACvD,IAAI,YAAY,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO;IAE7C,OAAO;QACL,MAAM,EAAE,YAAY,CAAC,QAAQ;YAC3B,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC;gBAC7B,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAChC,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EACnC,SAAS,CACV;gBACD,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;aAC1D,CAAC;YACJ,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAChC,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EACnC,SAAS,CACV;QACL,0FAA0F;QAC1F,aAAa,EAAE,KAAK;KACrB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"generateSchemaTypes.js","sourceRoot":"","sources":["../src/generateSchemaTypes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,SAAS,EAAE,EAAE,WAAW,EAAgB,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAE7F,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,MAAmD,EACnD,EACE,MAAM,EACN,IAAI,GAsBL;IAED,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE;QAClC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS;QAClE,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;QAC/C,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,8EAA8E;QAC9E,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;QAC3C,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;QAC7C,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;QACzC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;QACzC,OAAO,EAAE,MAAM,YAAY,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;QACzD,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;QAC7D,MAAM;KACP,CAAC,CAAC;IAEH,IAAI,IAAI,CAAC,wBAAwB;QAC/B,OAAO,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,gCAAgC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAExE,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,qBAAqB,CAAC,YAA0B;IACvD,IAAI,YAAY,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO;IAE7C,OAAO;QACL,MAAM,EAAE,YAAY,CAAC,QAAQ;YAC3B,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC;gBAC7B,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAChC,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EACnC,SAAS,CACV;gBACD,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;aAC1D,CAAC;YACJ,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAChC,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EACnC,SAAS,CACV;QACL,0FAA0F;QAC1F,aAAa,EAAE,KAAK;KACrB,CAAC;AACJ,CAAC"}

package/dist/lib/createExportsForComponentSchemas.d.ts

@@ -0,0 +1,4 @@
+import ts from 'typescript';
+export declare function createExportsForComponentSchemas(ast: ts.Node[]): ts.TypeAliasDeclaration[];
+export declare function getExportedNames(ast: ts.Node[]): string[];
+//# sourceMappingURL=createExportsForComponentSchemas.d.ts.map

package/dist/lib/createExportsForComponentSchemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createExportsForComponentSchemas.d.ts","sourceRoot":"","sources":["../../src/lib/createExportsForComponentSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,EAAE,6BA6C9D;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,EAAE,YAa9C"}

package/dist/lib/createExportsForComponentSchemas.js

@@ -0,0 +1,40 @@
+import ts from 'typescript';
+export function createExportsForComponentSchemas(ast) {
+    const componentsInterface = ast
+        .filter(ts.isInterfaceDeclaration)
+        .find((node) => node.name.text === 'components');
+    if (!componentsInterface)
+        return [];
+    const componentSchemas = componentsInterface.members
+        .filter(ts.isPropertySignature)
+        .find((node) => ts.isIdentifier(node.name) && node.name.text === 'schemas');
+    if (!componentSchemas)
+        return [];
+    const exportedNames = getExportedNames(ast);
+    const schemaNames = componentSchemas.type &&
+        ts.isTypeLiteralNode(componentSchemas.type) &&
+        componentSchemas.type.members.reduce((acc, node) => {
+            if (ts.isPropertySignature(node) && ts.isIdentifier(node.name)) {
+                const componentName = node.name.text;
+                if (!exportedNames.includes(componentName))
+                    acc.push(componentName);
+            }
+            return acc;
+        }, []);
+    if (!schemaNames)
+        return [];
+    const exportStatements = schemaNames.map((name) => {
+        return ts.factory.createTypeAliasDeclaration([ts.factory.createToken(ts.SyntaxKind.ExportKeyword)], ts.factory.createIdentifier(name), undefined, ts.factory.createIndexedAccessTypeNode(ts.factory.createIndexedAccessTypeNode(ts.factory.createTypeReferenceNode(ts.factory.createIdentifier('components'), undefined), ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral('schemas'))), ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral(name))));
+    });
+    return exportStatements;
+}
+export function getExportedNames(ast) {
+    return ast.reduce((acc, node) => {
+        if (ts.isInterfaceDeclaration(node) &&
+            ts.isIdentifier(node.name) &&
+            node.modifiers?.some((modifier) => modifier.kind === ts.SyntaxKind.ExportKeyword))
+            acc.push(node.name.text);
+        return acc;
+    }, []);
+}
+//# sourceMappingURL=createExportsForComponentSchemas.js.map

package/dist/lib/createExportsForComponentSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createExportsForComponentSchemas.js","sourceRoot":"","sources":["../../src/lib/createExportsForComponentSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,MAAM,UAAU,gCAAgC,CAAC,GAAc;IAC7D,MAAM,mBAAmB,GAAG,GAAG;SAC5B,MAAM,CAAC,EAAE,CAAC,sBAAsB,CAAC;SACjC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC;IACnD,IAAI,CAAC,mBAAmB;QAAE,OAAO,EAAE,CAAC;IAEpC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,OAAO;SACjD,MAAM,CAAC,EAAE,CAAC,mBAAmB,CAAC;SAC9B,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAC9E,IAAI,CAAC,gBAAgB;QAAE,OAAO,EAAE,CAAC;IAEjC,MAAM,aAAa,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAC5C,MAAM,WAAW,GACf,gBAAgB,CAAC,IAAI;QACrB,EAAE,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAC3C,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAW,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC3D,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/D,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBACrC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC;oBAAE,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACtE,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,IAAI,CAAC,WAAW;QAAE,OAAO,EAAE,CAAC;IAE5B,MAAM,gBAAgB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAChD,OAAO,EAAE,CAAC,OAAO,CAAC,0BAA0B,CAC1C,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,EACrD,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,EACjC,SAAS,EACT,EAAE,CAAC,OAAO,CAAC,2BAA2B,CACpC,EAAE,CAAC,OAAO,CAAC,2BAA2B,CACpC,EAAE,CAAC,OAAO,CAAC,uBAAuB,CAChC,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,EACzC,SAAS,CACV,EACD,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAC9B,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAC1C,CACF,EACD,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CACvE,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,GAAc;IAC7C,OAAO,GAAG,CAAC,MAAM,CAAW,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACxC,IACE,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC;YAC/B,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,IAAI,CAAC,SAAS,EAAE,IAAI,CAClB,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAC5D;YAED,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE3B,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC"}

package/dist/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAQlF,eAAO,MAAM,MAAM,EAAE,kBAuIpB,CAAC;AAEF,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,MAAM,UA0B7D"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAQlF,eAAO,MAAM,MAAM,EAAE,kBA2IpB,CAAC;AAEF,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,MAAM,UA0B7D"}

package/dist/plugin.js

@@ -22,6 +22,7 @@ export const plugin = {
             .option('--alphabetize', 'Sort object keys alphabetically')
             .option('--exclude-deprecated', 'Exclude deprecated types')
             .option('--no-blob-from-binary', 'If this option is enabled, binary format fields will not be converted to Blob types, preserving the native representation')
+            .option('--explicit-component-exports', 'Enabling this option will export API components as separate type aliases, alongside `components` interface')
             .action(async ({ output, args, spinner, schema }, resolve) => {
             spinner.text = 'Generating OpenAPI Document Types';
             const code = await generateSchemaTypes(schema, {

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAE9E,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EACL,4BAA4B,EAC5B,yBAAyB,GAC1B,MAAM,uCAAuC,CAAC;AAE/C,MAAM,CAAC,MAAM,MAAM,GAAuB;IACxC,YAAY,CAAC,OAAO;QAClB,OAAO;aACJ,WAAW,CACV,oIAAoI,CACrI;aACA,MAAM,CACL,kCAAkC,EAClC,mDAAmD,EACnD,gCAAgC,EAChC,WAAW,CACZ;aACA,MAAM,CAAC,QAAQ,EAAE,wCAAwC,CAAC;aAC1D,MAAM,CAAC,eAAe,EAAE,+BAA+B,CAAC;aACxD,MAAM,CAAC,gBAAgB,EAAE,wCAAwC,CAAC;aAClE,MAAM,CACL,mBAAmB,EACnB,gDAAgD,CACjD;aACA,MAAM,CAAC,aAAa,EAAE,yBAAyB,CAAC;aAChD,MAAM,CACL,yBAAyB,EACzB,gEAAgE,CACjE;aACA,MAAM,CACL,yBAAyB,EACzB,yEAAyE,CAC1E;aACA,MAAM,CACL,wBAAwB,EACxB,4EAA4E,CAC7E;aACA,MAAM,CACL,kCAAkC,EAClC,2EAA2E,CAC5E;aACA,MAAM,CACL,gBAAgB,EAChB,iDAAiD,CAClD;aACA,MAAM,CACL,wBAAwB,EACxB,yCAAyC,CAC1C;aACA,MAAM,CAAC,eAAe,EAAE,iCAAiC,CAAC;aAC1D,MAAM,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;aAC1D,MAAM,CACL,uBAAuB,EACvB,2HAA2H,CAC5H;aACA,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE;YAC3D,OAAO,CAAC,IAAI,GAAG,mCAAmC,CAAC;YAEnD,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;gBAC7C,IAAI;gBACJ,MAAM,EAAE,IAAI;aACb,CAAC,CAAC;YAEH,OAAO,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;YAEpD,OAAO,CAAC;gBACN;oBACE,IAAI,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG,CAAC;oBACpD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,GAAG,IAAI;iBAC7D;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IACD,gBAAgB,CAAC,OAAO,EAAE,OAAO;QAC/B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YAAE,OAAO;QAEtD,4DAA4D;QAC5D,OAAO,CAAC,OAAO;aACZ,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,wBAAwB,CAAC;YACtE,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAE/B,8DAA8D;QAC9D,OAAO,CAAC,OAAO;aACZ,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,OAAO,MAAM,CAAC,aAAa,EAAE,KAAK,oBAAoB,CAAC;QACzD,CAAC,CAAC;YACF,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAElB,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;YACxC,mDAAmD;YACnD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,wBAAwB,CAAC,EAAE,CAAC;gBACtD,IAAI,oBAAoB,GAAG,WAAW,CAAC,cAAc,CACnD,sBAAsB,CACvB,CAAC;gBAEF,IACE,WAAW,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,KAAK,SAAS,EACtE,CAAC;oBACD,oBAAoB,GAAG,oBAAoB,CAAC,KAAK,CAC/C,CAAC,EACD,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,CAClC,CAAC;gBACJ,CAAC;gBAED,oDAAoD;gBACpD,WAAW,CAAC,cAAc,CACxB,wBAAwB,EACxB,4BAA4B,CAC1B,oBAAoB,EACpB,WAAW,CAAC,cAAc,CAAC,0BAA0B,CAAC,CACvD,CACF,CAAC;YACJ,CAAC;YAED,MAAM,sBAAsB,GAAG,WAAW,CAAC,cAAc,CACvD,wBAAwB,CACzB,CAAC;YAEF,qEAAqE;YACrE,IACE,WAAW,CAAC,cAAc,CAAC,0BAA0B,CAAC;gBACtD,WAAW;qBACR,cAAc,CAAC,sBAAsB,CAAC;oBACvC,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC;gBACvB,sBAAsB;gBACtB,CAAC,sBAAsB,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAC5C,CAAC;gBACD,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,qCAAqC,EACrC,kJAAkJ,CACnJ,CAAC;YACJ,CAAC;YAED,2CAA2C;YAC3C,IAAI,OAAO,CAAC,cAAc,CAAC,oBAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC/D,WAAW,CAAC,cAAc,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC;YACzD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC;AAEF,MAAM,UAAU,gCAAgC,CAAC,KAAa;IAC5D,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,8BAA8B,EAC9B,+DAA+D,CAChE,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,8BAA8B,EAC9B,sDAAsD,CACvD,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,8BAA8B,EAC9B,wDAAwD,CACzD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4CAA4C,CAAC;AAE9E,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EACL,4BAA4B,EAC5B,yBAAyB,GAC1B,MAAM,uCAAuC,CAAC;AAE/C,MAAM,CAAC,MAAM,MAAM,GAAuB;IACxC,YAAY,CAAC,OAAO;QAClB,OAAO;aACJ,WAAW,CACV,oIAAoI,CACrI;aACA,MAAM,CACL,kCAAkC,EAClC,mDAAmD,EACnD,gCAAgC,EAChC,WAAW,CACZ;aACA,MAAM,CAAC,QAAQ,EAAE,wCAAwC,CAAC;aAC1D,MAAM,CAAC,eAAe,EAAE,+BAA+B,CAAC;aACxD,MAAM,CAAC,gBAAgB,EAAE,wCAAwC,CAAC;aAClE,MAAM,CACL,mBAAmB,EACnB,gDAAgD,CACjD;aACA,MAAM,CAAC,aAAa,EAAE,yBAAyB,CAAC;aAChD,MAAM,CACL,yBAAyB,EACzB,gEAAgE,CACjE;aACA,MAAM,CACL,yBAAyB,EACzB,yEAAyE,CAC1E;aACA,MAAM,CACL,wBAAwB,EACxB,4EAA4E,CAC7E;aACA,MAAM,CACL,kCAAkC,EAClC,2EAA2E,CAC5E;aACA,MAAM,CACL,gBAAgB,EAChB,iDAAiD,CAClD;aACA,MAAM,CACL,wBAAwB,EACxB,yCAAyC,CAC1C;aACA,MAAM,CAAC,eAAe,EAAE,iCAAiC,CAAC;aAC1D,MAAM,CAAC,sBAAsB,EAAE,0BAA0B,CAAC;aAC1D,MAAM,CACL,uBAAuB,EACvB,2HAA2H,CAC5H;aACA,MAAM,CACL,8BAA8B,EAC9B,4GAA4G,CAC7G;aACA,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE;YAC3D,OAAO,CAAC,IAAI,GAAG,mCAAmC,CAAC;YAEnD,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;gBAC7C,IAAI;gBACJ,MAAM,EAAE,IAAI;aACb,CAAC,CAAC;YAEH,OAAO,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;YAEpD,OAAO,CAAC;gBACN;oBACE,IAAI,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG,CAAC;oBACpD,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,GAAG,IAAI;iBAC7D;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IACD,gBAAgB,CAAC,OAAO,EAAE,OAAO;QAC/B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YAAE,OAAO;QAEtD,4DAA4D;QAC5D,OAAO,CAAC,OAAO;aACZ,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,wBAAwB,CAAC;YACtE,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAE/B,8DAA8D;QAC9D,OAAO,CAAC,OAAO;aACZ,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,OAAO,MAAM,CAAC,aAAa,EAAE,KAAK,oBAAoB,CAAC;QACzD,CAAC,CAAC;YACF,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAElB,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;YACxC,mDAAmD;YACnD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,wBAAwB,CAAC,EAAE,CAAC;gBACtD,IAAI,oBAAoB,GAAG,WAAW,CAAC,cAAc,CACnD,sBAAsB,CACvB,CAAC;gBAEF,IACE,WAAW,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,KAAK,SAAS,EACtE,CAAC;oBACD,oBAAoB,GAAG,oBAAoB,CAAC,KAAK,CAC/C,CAAC,EACD,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,CAClC,CAAC;gBACJ,CAAC;gBAED,oDAAoD;gBACpD,WAAW,CAAC,cAAc,CACxB,wBAAwB,EACxB,4BAA4B,CAC1B,oBAAoB,EACpB,WAAW,CAAC,cAAc,CAAC,0BAA0B,CAAC,CACvD,CACF,CAAC;YACJ,CAAC;YAED,MAAM,sBAAsB,GAAG,WAAW,CAAC,cAAc,CACvD,wBAAwB,CACzB,CAAC;YAEF,qEAAqE;YACrE,IACE,WAAW,CAAC,cAAc,CAAC,0BAA0B,CAAC;gBACtD,WAAW;qBACR,cAAc,CAAC,sBAAsB,CAAC;oBACvC,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC;gBACvB,sBAAsB;gBACtB,CAAC,sBAAsB,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAC5C,CAAC;gBACD,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,qCAAqC,EACrC,kJAAkJ,CACnJ,CAAC;YACJ,CAAC;YAED,2CAA2C;YAC3C,IAAI,OAAO,CAAC,cAAc,CAAC,oBAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC/D,WAAW,CAAC,cAAc,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC;YACzD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC;AAEF,MAAM,UAAU,gCAAgC,CAAC,KAAa;IAC5D,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,8BAA8B,EAC9B,+DAA+D,CAChE,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,8BAA8B,EAC9B,sDAAsD,CACvD,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,cAAc,CACtB,CAAC,EACD,8BAA8B,EAC9B,wDAAwD,CACzD,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/openapi-typescript-plugin",
-  "version": "1.1.0-beta.3",
+  "version": "1.1.0-beta.5",
   "type": "module",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -26,7 +26,7 @@
     }
   },
   "dependencies": {
-    "@openapi-qraft/plugin": "^1.14.0-beta.3",
+    "@openapi-qraft/plugin": "^1.14.0-beta.5",
     "openapi-typescript": "^7.3.0",
     "typescript": "^5.3.3"
   },

package/src/generateSchemaTypes.ts

@@ -3,6 +3,7 @@ import type { OpenAPI3, OpenAPITSOptions } from 'openapi-typescript';
 import { createConfig } from '@redocly/openapi-core';
 import openapiTS, { astToString, SchemaObject } from 'openapi-typescript';
 import ts from 'typescript';
+import { createExportsForComponentSchemas } from './lib/createExportsForComponentSchemas.js';
 
 export async function generateSchemaTypes(
   schema: string | URL | OpenAPI3 | Readable | Buffer,
@@ -28,28 +29,32 @@ export async function generateSchemaTypes(
       | 'propertiesRequiredByDefault'
     > & {
       blobFromBinary?: boolean;
+      explicitComponentExports?: boolean;
     };
   }
 ) {
-  return astToString(
-    await openapiTS(schema, {
-      transform: args.blobFromBinary ? transformFormatBinary : undefined,
-      additionalProperties: args.additionalProperties,
-      alphabetize: args.alphabetize,
-      arrayLength: args.arrayLength,
-      // contentNever: args.contentNever, // todo::add `contentNever` in new version
-      defaultNonNullable: args.defaultNonNullable,
-      emptyObjectsUnknown: args.emptyObjectsUnknown,
-      enum: args.enum,
-      excludeDeprecated: args.excludeDeprecated,
-      exportType: args.exportType,
-      immutable: args.immutable,
-      pathParamsAsTypes: args.pathParamsAsTypes,
-      redocly: await createConfig({}, { extends: ['minimal'] }),
-      propertiesRequiredByDefault: args.propertiesRequiredByDefault,
-      silent,
-    })
-  );
+  const ast = await openapiTS(schema, {
+    transform: args.blobFromBinary ? transformFormatBinary : undefined,
+    additionalProperties: args.additionalProperties,
+    alphabetize: args.alphabetize,
+    arrayLength: args.arrayLength,
+    // contentNever: args.contentNever, // todo::add `contentNever` in new version
+    defaultNonNullable: args.defaultNonNullable,
+    emptyObjectsUnknown: args.emptyObjectsUnknown,
+    enum: args.enum,
+    excludeDeprecated: args.excludeDeprecated,
+    exportType: args.exportType,
+    immutable: args.immutable,
+    pathParamsAsTypes: args.pathParamsAsTypes,
+    redocly: await createConfig({}, { extends: ['minimal'] }),
+    propertiesRequiredByDefault: args.propertiesRequiredByDefault,
+    silent,
+  });
+
+  if (args.explicitComponentExports)
+    return astToString(ast.concat(createExportsForComponentSchemas(ast)));
+
+  return astToString(ast);
 }
 
 function transformFormatBinary(schemaObject: SchemaObject) {

package/src/lib/createExportsForComponentSchemas.ts

@@ -0,0 +1,63 @@
+import ts from 'typescript';
+
+export function createExportsForComponentSchemas(ast: ts.Node[]) {
+  const componentsInterface = ast
+    .filter(ts.isInterfaceDeclaration)
+    .find((node) => node.name.text === 'components');
+  if (!componentsInterface) return [];
+
+  const componentSchemas = componentsInterface.members
+    .filter(ts.isPropertySignature)
+    .find((node) => ts.isIdentifier(node.name) && node.name.text === 'schemas');
+  if (!componentSchemas) return [];
+
+  const exportedNames = getExportedNames(ast);
+  const schemaNames =
+    componentSchemas.type &&
+    ts.isTypeLiteralNode(componentSchemas.type) &&
+    componentSchemas.type.members.reduce<string[]>((acc, node) => {
+      if (ts.isPropertySignature(node) && ts.isIdentifier(node.name)) {
+        const componentName = node.name.text;
+        if (!exportedNames.includes(componentName)) acc.push(componentName);
+      }
+      return acc;
+    }, []);
+  if (!schemaNames) return [];
+
+  const exportStatements = schemaNames.map((name) => {
+    return ts.factory.createTypeAliasDeclaration(
+      [ts.factory.createToken(ts.SyntaxKind.ExportKeyword)],
+      ts.factory.createIdentifier(name),
+      undefined,
+      ts.factory.createIndexedAccessTypeNode(
+        ts.factory.createIndexedAccessTypeNode(
+          ts.factory.createTypeReferenceNode(
+            ts.factory.createIdentifier('components'),
+            undefined
+          ),
+          ts.factory.createLiteralTypeNode(
+            ts.factory.createStringLiteral('schemas')
+          )
+        ),
+        ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral(name))
+      )
+    );
+  });
+
+  return exportStatements;
+}
+
+export function getExportedNames(ast: ts.Node[]) {
+  return ast.reduce<string[]>((acc, node) => {
+    if (
+      ts.isInterfaceDeclaration(node) &&
+      ts.isIdentifier(node.name) &&
+      node.modifiers?.some(
+        (modifier) => modifier.kind === ts.SyntaxKind.ExportKeyword
+      )
+    )
+      acc.push(node.name.text);
+
+    return acc;
+  }, []);
+}

package/src/plugin.ts

@@ -58,6 +58,10 @@ export const plugin: QraftCommandPlugin = {
         '--no-blob-from-binary',
         'If this option is enabled, binary format fields will not be converted to Blob types, preserving the native representation'
       )
+      .option(
+        '--explicit-component-exports',
+        'Enabling this option will export API components as separate type aliases, alongside `components` interface'
+      )
       .action(async ({ output, args, spinner, schema }, resolve) => {
         spinner.text = 'Generating OpenAPI Document Types';