@let-aurn/swagger-client 0.3.3 → 0.4.0

package/README.md

@@ -24,6 +24,37 @@ npx swagger-client generate --config=swagger-client.json
 
 `client` can be `angular` or `react`.
 
+`swaggers-directory` accepts a directory (all JSON files recursively), a file
+glob, or an array of include/exclude glob patterns. Paths are relative to the
+command's working directory; absolute paths also work. Use forward slashes in
+glob patterns. `*` matches within one directory and `**` matches across nested
+directories.
+
+To include only one subtree:
+
+```json
+{
+  "swaggers-directory": "swaggers/should-not-be-ignored/**/*.json"
+}
+```
+
+To include JSON files while excluding a subtree:
+
+```json
+{
+  "swaggers-directory": [
+    "swaggers/**/*.json",
+    "!swaggers/should-be-ignored/**"
+  ]
+}
+```
+
+Exclusions apply regardless of pattern order. Duplicate matches are processed
+once, in sorted file order; only `.json` files are read. Glob selections with
+no matching JSON files fail with an error. For glob or array selections,
+generated `sourceFile` metadata is relative to the working directory; a plain
+directory keeps metadata relative to that directory.
+
 `serverUrlIndex` is optional and selects a zero-based index from each document's
 top-level `servers` array to prefix generated endpoint paths:
 

package/dist/core/load-config.js

@@ -2,6 +2,7 @@ import { readFile } from "node:fs/promises";
 import { resolve } from "node:path";
 import { validateEndpointNamespace } from "./endpoint-namespace.js";
 import { validateServerUrlIndex } from "./server-url.js";
+import { resolveSwaggerInput, validateSwaggerInput } from "./swagger-files.js";
 /**
  * Loads and validates a swagger-client configuration file.
  *
@@ -16,7 +17,7 @@ export async function loadConfig(configPath) {
     validateConfig(config, absolutePath);
     return {
         ...config,
-        "swaggers-directory": resolve(config["swaggers-directory"]),
+        "swaggers-directory": resolveSwaggerInput(config["swaggers-directory"]),
         output: {
             "api-models.ts": resolve(config.output["api-models.ts"]),
             "api-endpoints.ts": resolve(config.output["api-endpoints.ts"]),
@@ -29,9 +30,7 @@ function validateConfig(config, configPath) {
     if (config.client !== "angular" && config.client !== "react") {
         throw new Error(`${configPath}: "client" must be "angular" or "react".`);
     }
-    if (!config["swaggers-directory"]) {
-        throw new Error(`${configPath}: "swaggers-directory" is required.`);
-    }
+    validateSwaggerInput(config["swaggers-directory"], configPath);
     if (config["endpoint-name-strategy"] !== undefined &&
         config["endpoint-name-strategy"] !== "operationId" &&
         config["endpoint-name-strategy"] !== "tagAndOperationId" &&

package/dist/core/read-openapi.d.ts

@@ -1,12 +1,12 @@
 import type { EndpointNameStrategy, EndpointNamespaceConfig, ProjectModel } from "./types.js";
 /**
- * Reads OpenAPI JSON files from a directory and converts them to the generator project model.
+ * Reads selected OpenAPI JSON files and converts them to the generator project model.
  *
- * @param swaggerDirectory The directory containing one or more OpenAPI JSON files.
+ * @param swaggerDirectory A directory, glob, or array of include/exclude glob patterns.
  * @param endpointNameStrategy The strategy used to name generated endpoint constants.
  * @param endpointNamespace Configurable document field and optional namespace extraction regex.
  * @param serverUrlIndex Optional document server URL index to prefix endpoint paths with.
  * @returns The normalized schemas and endpoints discovered in the OpenAPI files.
  * @throws Error when a JSON file cannot be read or parsed.
  */
-export declare function readOpenApiProject(swaggerDirectory: string, endpointNameStrategy?: EndpointNameStrategy, endpointNamespace?: EndpointNamespaceConfig, serverUrlIndex?: number): Promise<ProjectModel>;
+export declare function readOpenApiProject(swaggerDirectory: string | string[], endpointNameStrategy?: EndpointNameStrategy, endpointNamespace?: EndpointNamespaceConfig, serverUrlIndex?: number): Promise<ProjectModel>;

package/dist/core/read-openapi.js

@@ -1,14 +1,15 @@
-import { readdir, readFile } from "node:fs/promises";
-import { join, relative } from "node:path";
+import { readFile } from "node:fs/promises";
+import { relative } from "node:path";
 import { schemaToType } from "./schema-to-typescript.js";
 import { ensureIdentifier, toPascalCase, uniqueName } from "./names.js";
 import { extractEndpointNamespace, validateEndpointNamespace } from "./endpoint-namespace.js";
 import { selectServerUrl, validateServerUrlIndex } from "./server-url.js";
+import { discoverSwaggerFiles } from "./swagger-files.js";
 const HTTP_METHODS = new Set(["get", "post", "put", "patch", "delete", "head", "options"]);
 /**
- * Reads OpenAPI JSON files from a directory and converts them to the generator project model.
+ * Reads selected OpenAPI JSON files and converts them to the generator project model.
  *
- * @param swaggerDirectory The directory containing one or more OpenAPI JSON files.
+ * @param swaggerDirectory A directory, glob, or array of include/exclude glob patterns.
  * @param endpointNameStrategy The strategy used to name generated endpoint constants.
  * @param endpointNamespace Configurable document field and optional namespace extraction regex.
  * @param serverUrlIndex Optional document server URL index to prefix endpoint paths with.
@@ -16,18 +17,18 @@ const HTTP_METHODS = new Set(["get", "post", "put", "patch", "delete", "head", "
  * @throws Error when a JSON file cannot be read or parsed.
  */
 export async function readOpenApiProject(swaggerDirectory, endpointNameStrategy = "operationId", endpointNamespace, serverUrlIndex) {
-    validateServerUrlIndex(serverUrlIndex, swaggerDirectory);
+    validateServerUrlIndex(serverUrlIndex, String(swaggerDirectory));
     if (endpointNameStrategy === "namespaceTagAndOperationId") {
-        validateEndpointNamespace(endpointNamespace, swaggerDirectory);
+        validateEndpointNamespace(endpointNamespace, String(swaggerDirectory));
     }
-    const files = await findJsonFiles(swaggerDirectory);
+    const { files, sourceDirectory } = await discoverSwaggerFiles(swaggerDirectory);
     const schemas = [];
     const endpoints = [];
     const usedSchemaNames = new Set();
     const usedEndpointNames = new Set();
     for (const file of files) {
         const document = JSON.parse(await readFile(file, "utf8"));
-        const sourceFile = relative(swaggerDirectory, file);
+        const sourceFile = relative(sourceDirectory, file);
         const serverUrl = selectServerUrl(document, serverUrlIndex, sourceFile);
         const schemaNameMap = collectSchemas(document, schemas, usedSchemaNames);
         const namespace = endpointNameStrategy === "namespaceTagAndOperationId"
@@ -37,20 +38,6 @@ export async function readOpenApiProject(swaggerDirectory, endpointNameStrategy
     }
     return { schemas, endpoints };
 }
-async function findJsonFiles(directory) {
-    const entries = await readdir(directory, { withFileTypes: true });
-    const files = [];
-    for (const entry of entries) {
-        const path = join(directory, entry.name);
-        if (entry.isDirectory()) {
-            files.push(...await findJsonFiles(path));
-        }
-        else if (entry.isFile() && entry.name.endsWith(".json")) {
-            files.push(path);
-        }
-    }
-    return files.sort();
-}
 function collectSchemas(document, schemas, usedSchemaNames) {
     const schemaNameMap = new Map();
     const sourceSchemas = document.components?.schemas ?? document.definitions ?? {};

package/dist/core/swagger-files.d.ts

@@ -0,0 +1,6 @@
+export declare function validateSwaggerInput(input: string | string[], source: string): void;
+export declare function resolveSwaggerInput(input: string | string[]): string | string[];
+export declare function discoverSwaggerFiles(input: string | string[]): Promise<{
+    files: string[];
+    sourceDirectory: string;
+}>;

package/dist/core/swagger-files.js

@@ -0,0 +1,57 @@
+import { readdir, stat } from "node:fs/promises";
+import { join, posix, resolve } from "node:path";
+import { glob, isDynamicPattern } from "tinyglobby";
+export function validateSwaggerInput(input, source) {
+    const patterns = Array.isArray(input) ? input : [input];
+    if (patterns.length === 0 || patterns.some(pattern => typeof pattern !== "string" || pattern.trim() === "" || pattern === "!")) {
+        throw new Error(`${source}: "swaggers-directory" must be a non-empty directory, glob, or array of patterns.`);
+    }
+    if (patterns.every(isExclusion)) {
+        throw new Error(`${source}: "swaggers-directory" must include at least one positive pattern.`);
+    }
+}
+export function resolveSwaggerInput(input) {
+    const resolvePattern = (pattern) => {
+        const excluded = isExclusion(pattern);
+        const path = excluded ? pattern.slice(1) : pattern;
+        return (excluded ? "!" : "") + posix.resolve(process.cwd().split("\\").join("/"), path);
+    };
+    return Array.isArray(input) ? input.map(resolvePattern) : resolvePattern(input);
+}
+export async function discoverSwaggerFiles(input) {
+    validateSwaggerInput(input, "OpenAPI input");
+    if (typeof input === "string" && !isDynamicPattern(input)) {
+        const path = resolve(input);
+        if ((await stat(path)).isDirectory()) {
+            return { files: await findJsonFiles(path), sourceDirectory: path };
+        }
+    }
+    const matches = await glob(input, {
+        absolute: true,
+        onlyFiles: true,
+        dot: true,
+        followSymbolicLinks: false
+    });
+    const files = [...new Set(matches.filter(file => file.endsWith(".json")))].sort();
+    if (files.length === 0) {
+        throw new Error(`No OpenAPI JSON files match "swaggers-directory": ${JSON.stringify(input)}.`);
+    }
+    return { files, sourceDirectory: process.cwd() };
+}
+function isExclusion(pattern) {
+    return pattern.startsWith("!") && !pattern.startsWith("!(");
+}
+async function findJsonFiles(directory) {
+    const entries = await readdir(directory, { withFileTypes: true });
+    const files = [];
+    for (const entry of entries) {
+        const path = join(directory, entry.name);
+        if (entry.isDirectory()) {
+            files.push(...await findJsonFiles(path));
+        }
+        else if (entry.isFile() && entry.name.endsWith(".json")) {
+            files.push(path);
+        }
+    }
+    return files.sort();
+}

package/dist/core/types.d.ts

@@ -8,7 +8,8 @@ export interface EndpointNamespaceConfig {
 }
 export interface SwaggerClientConfig {
     client: ClientKind;
-    "swaggers-directory": string;
+    /** Directory, file glob, or include/exclude glob patterns, relative to the working directory. */
+    "swaggers-directory": string | string[];
     "endpoint-name-strategy"?: EndpointNameStrategy;
     "endpoint-namespace"?: EndpointNamespaceConfig;
     /** Index of the document server URL to prefix endpoint paths with. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@let-aurn/swagger-client",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "Generate typed Angular and React clients from OpenAPI JSON files.",
   "type": "module",
   "bin": {
@@ -48,5 +48,8 @@
     "react": {
       "optional": true
     }
+  },
+  "dependencies": {
+    "tinyglobby": "^0.2.17"
   }
 }