feat: ability to specify exact model names for export

Author: mdevils

package.json

@@ -41,13 +41,13 @@
     "precheck": "tsc --noEmit && jest && ",
     "build": "rimraf lib && tsc -p tsconfig.build.json && cp -R src/schema-to-typescript/common/core/* lib/schema-to-typescript/common/core && cp -R src/schema-to-typescript/common/validation-providers/zod-validation-provider/*-*.ts lib/schema-to-typescript/common/validation-providers/zod-validation-provider",
     "build:docs": "rm -Rf docs && typedoc --exclude test --excludeInternal --excludeExternals --disableSources --plugin typedoc-plugin-markdown --entryDocument ../README.md --out docs src/index.ts src/openapi.ts src/openapi-client.ts && ts-node tools/cleanup-docs.ts",
-    "prepublishOnly": "npm run build && npm run build:docs",
+    "prepublishOnly": "npm run build",
     "lint": "eslint {src,test,tools}/**/*.ts",
     "lint:fix": "eslint --fix {src,test,tools}/**/*.ts",
     "test": "jest",
     "test:watch": "jest --watch --watchPathIgnorePatterns tmp",
     "test:update": "ts-node src/cli/index.ts generate test/pet-store/api-typescript-generator-config.ts",
-    "release": "standard-version"
+    "release": "npm run build:docs && standard-version"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.24.4",

src/schema-to-typescript/common/client.ts

@@ -65,6 +65,7 @@ export function generateClient({
         name,
         exportModels,
         exportServices,
+        exportErrorClass,
         errorClassName,
         generateJsDoc,
         ...filenameConfig
@@ -111,13 +112,17 @@ export function generateClient({
     );
 
     const errorTypeName = errorClassName ?? `${name}Error`;
-    const errorTypeExport = exportNamedDeclaration(
-        classDeclaration(
-            identifier(errorTypeName),
-            memberExpression(identifier(commonHttpClientImportName), identifier(commonHttpClientErrorClassName)),
-            classBody([classProperty(identifier('name'), stringLiteral(errorTypeName))])
-        )
+    const additionalTypeStatements: Statement[] = [];
+    const errorClassDeclaration = classDeclaration(
+        identifier(errorTypeName),
+        memberExpression(identifier(commonHttpClientImportName), identifier(commonHttpClientErrorClassName)),
+        classBody([classProperty(identifier('name'), stringLiteral(errorTypeName))])
     );
+    if (exportErrorClass !== false) {
+        additionalTypeStatements.push(exportNamedDeclaration(errorClassDeclaration));
+    } else {
+        additionalTypeStatements.push(errorClassDeclaration);
+    }
 
     const clientClassBody = classBody([
         classProperty(
@@ -281,8 +286,14 @@ export function generateClient({
     const exportTypes: ExportNamedDeclaration = exportNamedDeclaration(null, []);
     exportTypes.exportKind = 'type';
 
-    if (exportModels) {
+    if (exportModels && exportModels !== 'none') {
+        const modelsToExport = new Set(
+            exportModels === 'all' ? modelImportInfos.map(({modelName}) => modelName) : exportModels.models
+        );
         for (const {modelName, importPath} of modelImportInfos) {
+            if (!modelsToExport.has(modelName)) {
+                continue;
+            }
             addDependencyImport(dependencyImports, getRelativeImportPath(clientImportPath, importPath), modelName, {
                 kind: 'type',
                 entity: {name: modelName}
@@ -293,8 +304,14 @@ export function generateClient({
 
     const exports: ExportNamedDeclaration = exportNamedDeclaration(null, []);
 
-    if (exportServices) {
+    if (exportServices && exportServices !== 'none') {
+        const servicesToExport = new Set(
+            exportServices === 'all' ? generatedServiceImports.map(({name}) => name) : exportServices.services
+        );
         for (const {name, importPath} of generatedServiceImports) {
+            if (!servicesToExport.has(name)) {
+                continue;
+            }
             addDependencyImport(dependencyImports, getRelativeImportPath(clientImportPath, importPath), name, {
                 kind: 'value',
                 entity: {name}
@@ -333,7 +350,7 @@ export function generateClient({
                 ),
                 ...generateTsImports(dependencyImports),
                 optionsTypeExport,
-                errorTypeExport,
+                ...additionalTypeStatements,
                 clientClass,
                 ...otherStatements,
                 ...(exportTypes.specifiers.length > 0 ? [exportTypes] : []),

src/schema-to-typescript/config.ts

@@ -158,7 +158,8 @@ export interface CommonOpenApiClientGeneratorConfigDocument {
  */
 export interface CommonOpenApiClientGeneratorConfigPostprocess {
     /**
-     * If true, runs ESLint on the generated files.
+     * If true, runs ESLint on the generated files. ESlint should be installed in the project and the configuration
+     * should be present. This postprocess step can take a long time for large schemas.
      */
     eslint?: boolean;
 }

src/schema-to-typescript/openapi-to-typescript-client.ts

@@ -690,15 +690,31 @@ export interface OpenApiClientGeneratorConfigClient {
     /**
      * Whether to export services from the client file.
      *
-     * @default false
+     * @default 'none'
      */
-    exportServices?: boolean;
+    exportServices?:
+        | 'all'
+        | 'none'
+        | {
+              services: string[];
+          };
     /**
      * Whether to export models from the client file.
      *
-     * @default false
+     * @default 'none'
+     */
+    exportModels?:
+        | 'all'
+        | 'none'
+        | {
+              models: string[];
+          };
+    /**
+     * Whether to export the error class from the client file.
+     *
+     * @default true
      */
-    exportModels?: boolean;
+    exportErrorClass?: boolean;
     /**
      * Client JSDoc generation callback.
      */