add path regex property to optimized operation

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flexbase/openapi-generator",
-  "version": "3.1.13",
+  "version": "3.2.0",
   "description": "Open API code generator",
   "author": {
     "name": "Flexbase Technologies",
@@ -49,20 +49,20 @@
   },
   "dependencies": {
     "@flexbase/logger": "^3.0.1",
-    "@readme/openapi-parser": "^2.6.0",
+    "@readme/openapi-parser": "^3.0.1",
     "@stoplight/json-ref-resolver": "^3.1.6",
     "@stoplight/json-schema-ref-parser": "^10.0.0",
     "chalk": "^5.3.0",
-    "commander": "^13.0.0",
-    "fs-extra": "^11.2.0",
-    "glob": "^11.0.0",
+    "commander": "^13.1.0",
+    "fs-extra": "^11.3.0",
+    "glob": "^11.0.1",
     "handlebars": "^4.7.8",
     "highlight.js": "^11.10.0",
     "openapi-types": "^12.1.3",
     "path": "^0.12.7",
-    "prettier": "^3.3.3",
+    "prettier": "^3.5.3",
     "useful-handlebars-helpers": "^0.12.0",
-    "uuid": "^11.0.3"
+    "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@flexbase/packr": "^1.2.0",
@@ -71,22 +71,22 @@
     "@semantic-release/git": "^10.0.1",
     "@types/fs-extra": "^11.0.4",
     "@types/glob": "^8.1.0",
-    "@types/node": "^22.9.0",
+    "@types/node": "^22.13.11",
     "@types/prettier": "^3.0.0",
     "@types/uuid": "^10.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.13.0",
-    "@typescript-eslint/parser": "^8.13.0",
-    "@vitest/coverage-v8": "^2.1.4",
-    "eslint": "9.17.0",
+    "@typescript-eslint/eslint-plugin": "^8.27.0",
+    "@typescript-eslint/parser": "^8.27.0",
+    "@vitest/coverage-v8": "^3.0.9",
+    "eslint": "9.23.0",
     "husky": "^9.1.6",
     "is-ci": "^4.1.0",
-    "lint-staged": "^15.2.10",
-    "semantic-release": "^24.2.0",
-    "typescript": "^5.6.3",
-    "typescript-eslint": "^8.13.0",
-    "vite": "6.0.7",
-    "vite-plugin-dts": "^4.3.0",
-    "vitest": "^2.1.4"
+    "lint-staged": "^15.5.0",
+    "semantic-release": "^24.2.3",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.27.0",
+    "vite": "6.2.2",
+    "vite-plugin-dts": "^4.5.3",
+    "vitest": "^3.0.9"
   },
   "lint-staged": {
     "src/**/*.{ts,tsx,json}": "eslint --cache --fix --max-warnings=0",

src/main.ts

@@ -3,7 +3,7 @@ import { program } from 'commander';
 import * as glob from 'glob';
 import Path from 'path';
 import fs from 'fs-extra';
-import pkg from '../package.json' assert { type: 'json' };
+import pkg from '../package.json' with { type: 'json' };
 import { OpenApiGeneratorConfiguation } from './runtime.config.js';
 import { build } from './build.js';
 import { parseSpec } from './parse.js';

src/optimizer/nodes/operation.ts

@@ -17,6 +17,7 @@ export interface Operation extends OptimizedNode {
   callbacks?: Reference;
   security?: Record<string, string[]>[];
   extensions?: Record<string, string>;
+  pathRegex?: Record<string, string>;
 }
 
 export const isOperation = (value: OptimizedNode): value is Operation => {

src/optimizer/openapi.optimizer.ts

@@ -17,6 +17,8 @@ export class OpenApiOptimizer {
 
     this.optimizeComponents(optimizedDocument.components);
 
+    this.buildPathRegex(optimizedDocument);
+
     return optimizedDocument;
   }
 
@@ -33,6 +35,15 @@ export class OpenApiOptimizer {
     return found as parsed.Component<T>;
   }
 
+  private lookupComponent(node: optimized.Reference, components: optimized.Components, type: keyof optimized.Components) {
+    const name = node.$ref.substring(node.$ref.lastIndexOf('/') + 1);
+    const found = Object.entries(components[type] ?? {}).find(x => x[0] === name);
+    if (!found) {
+      return undefined;
+    }
+    return found[1];
+  }
+
   private createParameterObject(
     parameters: (parsed.Parameter | parsed.Reference)[],
     parsedComponents: parsed.Components,
@@ -136,10 +147,11 @@ export class OpenApiOptimizer {
       }
     }
 
-    let pathParameter;
-    let headerParameter;
-    let queryParameter;
-    let cookieParameter;
+    let pathParameter: optimized.Reference | undefined;
+    let headerParameter: optimized.Reference | undefined;
+    let queryParameter: optimized.Reference | undefined;
+    let cookieParameter: optimized.Reference | undefined;
+    let pathRegex: Record<string, string> | undefined;
 
     const name = `${operation.operationId}`;
 
@@ -156,7 +168,7 @@ export class OpenApiOptimizer {
       cookieParameter = this.optimizeParameters(document, components, cookieParams, name, 'cookieParameters');
     }
 
-    return { pathParameter, headerParameter, queryParameter, cookieParameter };
+    return { pathParameter, headerParameter, queryParameter, cookieParameter, pathRegex };
   }
 
   private optimizeOperationResponses(document: ParsedDocument, components: optimized.Components, operation: parsed.Operation) {
@@ -212,7 +224,11 @@ export class OpenApiOptimizer {
 
     const request = this.optimizeOperationRequest(document, components, operation);
 
-    const { pathParameter, headerParameter, queryParameter, cookieParameter } = this.optimizeOperationParameters(document, components, operation);
+    const { pathParameter, headerParameter, queryParameter, cookieParameter, pathRegex } = this.optimizeOperationParameters(
+      document,
+      components,
+      operation,
+    );
 
     return {
       type: 'operation',
@@ -231,6 +247,7 @@ export class OpenApiOptimizer {
       headerParameter,
       queryParameter,
       cookieParameter,
+      pathRegex,
     };
   }
 
@@ -250,7 +267,8 @@ export class OpenApiOptimizer {
         if (parsed.isReference(path.definition)) {
           this._logger.warn('Path references not supported');
         } else {
-          paths.push({ type: 'path', name: path.name, operations: this.optimizePathItem(document, components, path.definition) });
+          const operations = this.optimizePathItem(document, components, path.definition);
+          paths.push({ type: 'path', name: path.name, operations });
         }
       }
     });
@@ -309,4 +327,45 @@ export class OpenApiOptimizer {
     if (components.queryParameters) components.queryParameters = this.optimizeComponentRecord(components.queryParameters);
     if (components.cookieParameters) components.cookieParameters = this.optimizeComponentRecord(components.cookieParameters);
   }
+
+  private getPathParamRegex(pathParameter: optimized.Reference, components: optimized.Components) {
+    let pathRegex: Record<string, string> | undefined;
+
+    const found = this.lookupComponent(pathParameter, components, 'pathParameters') ?? this.lookupComponent(pathParameter, components, 'parameters');
+
+    if (found) {
+      if (optimized.isObjectNode(found) || optimized.isParameterObject(found)) {
+        found.properties.forEach(p => {
+          if (optimized.isParameter(p)) {
+            const name = p.name;
+            const definition = p.definition;
+
+            pathRegex = { ...pathRegex, [name]: definition.format ?? definition.type };
+          }
+        });
+      } else if (optimized.isComposite(found) || optimized.isUnion(found)) {
+        // todo need to recursively check the definitions
+
+        found.definitions?.forEach(d => {
+          if (optimized.isReference(d)) {
+            pathRegex = { ...pathRegex, ...this.getPathParamRegex(d, components) };
+          }
+        });
+      }
+    } else {
+      this._logger.warn(`Unable to find path parameter: (${pathParameter.$ref})`);
+    }
+
+    return pathRegex;
+  }
+
+  private buildPathRegex(document: OptimizedDocument) {
+    document.paths.forEach(path => {
+      path.operations.forEach(operation => {
+        if (operation.pathParameter) {
+          operation.pathRegex = this.getPathParamRegex(operation.pathParameter, document.components);
+        }
+      });
+    });
+  }
 }

src/parser/openapi.parser.ts

@@ -194,6 +194,7 @@ export abstract class OpenApiParser {
       const name = record[0];
       const schema = record[1];
       const definition = schema ? this.parsePathItemObject(schema, components) : undefined;
+
       nodes.push({
         type: 'pathItem',
         name,

vite.config.ts

@@ -3,7 +3,7 @@
 import { defineConfig } from 'vite';
 import path from 'path';
 import typescript from '@rollup/plugin-typescript';
-import pkg from './package.json' assert { type: 'json' };
+import pkg from './package.json' with { type: 'json' };
 import dts from 'vite-plugin-dts';
 
 const resolvePath = (str: string) => path.resolve(__dirname, str);