@openapi-qraft/plugin 1.13.1 → 1.14.0-beta.2

package/dist/lib/processOperationNameModifierOption.js

@@ -0,0 +1,102 @@
+import { createServicePathMatch } from './createServicePathMatch.js';
+import { parseOperationGlobs, } from './parseOperationGlobs.js';
+import { splitCommaSeparatedGlobs } from './splitCommaSeparatedGlobs.js';
+export const processOperationNameModifierOption = (modifiers, services) => {
+    if (!modifiers.length)
+        return {
+            errors: [],
+            services,
+        };
+    const operationNameModifiers = modifiers.map((modifier) => ({
+        ...modifier,
+        isPathMatch: createServicePathMatch(splitCommaSeparatedGlobs(modifier.pathGlobs)),
+    }));
+    const serviceOperationReplacements = new Map();
+    const replacedOperationNamesServices = services.map((service) => {
+        serviceOperationReplacements.set(service.name, new Map());
+        return {
+            ...service,
+            operations: service.operations.map((operation) => {
+                const operationReplacements = serviceOperationReplacements.get(service.name);
+                if (!operationReplacements)
+                    throw new Error('operationReplacements not found');
+                const operationModifiers = operationNameModifiers.filter((modifier) => modifier.isPathMatch(operation.path) &&
+                    (modifier.methods === undefined ||
+                        modifier.methods.includes(operation.method)) &&
+                    normalizeOperationNameModifierRegex(modifier.operationNameModifierRegex).test(operation.name));
+                const replacedOperationName = operationModifiers.reduce((operationName, modifier) => operationName.replace(normalizeOperationNameModifierRegex(modifier.operationNameModifierRegex), modifier.operationNameModifierReplace), operation.name);
+                if (replacedOperationName !== operation.name) {
+                    if (!operationReplacements.has(replacedOperationName))
+                        operationReplacements.set(replacedOperationName, new Map());
+                    operationReplacements.get(replacedOperationName)?.set(operation.name, operationModifiers.map(({ isPathMatch: _, ...operationModifiersRest }) => operationModifiersRest));
+                }
+                return {
+                    ...operation,
+                    name: replacedOperationName,
+                };
+            }),
+        };
+    });
+    const errors = Array.from(serviceOperationReplacements).flatMap(([serviceName, modifiedOperations]) => Array.from(modifiedOperations).flatMap(([replacedOperationName, operationModifierMap]) => {
+        if (operationModifierMap.size > 1) {
+            return Array.from(operationModifierMap).map(([originalOperationName, modifiers]) => ({
+                serviceName,
+                replacedOperationName,
+                originalOperationName,
+                modifiers,
+            }));
+        }
+        const [originalOperationName, modifiers] = Array.from(operationModifierMap).at(0) ?? [];
+        if (modifiers && modifiers.length > 1) {
+            return [
+                {
+                    serviceName,
+                    replacedOperationName,
+                    originalOperationName,
+                    modifiers,
+                },
+            ];
+        }
+        return [];
+    }));
+    return {
+        errors,
+        services: replacedOperationNamesServices,
+    };
+};
+function normalizeOperationNameModifierRegex(regex) {
+    return new RegExp(regex, 'g');
+}
+/**
+ * Parses the given options string into a structured format.
+ *
+ * @param optionItems - The configuration string to parse. Eg. `/foo,/bar/**:post[A-Z][A-Za-z]+sId[A-Z][A-Za-z]+ ==> createOne` or `post /** ==> createOne`
+ * @returns The parsed configuration.
+ *
+ * @example
+ * ```ts
+ * const parsedConfig = parseOperationNameModifier("/foo,/bar/**:/**:post[A-Z][A-Za-z]+sId[A-Z][A-Za-z]+ ==> createOne");
+ * ```
+ */
+export function parseOperationNameModifier(...optionItems) {
+    const globOperationNameModifierMap = [];
+    for (const optionItem of optionItems) {
+        const operationGlobsRaw = optionItem.slice(0, Math.max(0, optionItem.indexOf(':')));
+        if (!operationGlobsRaw.length)
+            throw new Error(`Invalid operation name modifier: ${optionItem}. Must be in the format of 'pathGlobs:operationNameModifierRegex ==> operationNameModifierReplace'`);
+        const modifierPattern = optionItem.slice(operationGlobsRaw.length + 1);
+        const patternRegex = modifierPattern.slice(0, modifierPattern.indexOf('==>'));
+        const patternReplace = modifierPattern.slice(modifierPattern.indexOf('==>') + '==>'.length + 1);
+        const { methods, pathGlobs } = parseOperationGlobs(operationGlobsRaw);
+        if (!splitCommaSeparatedGlobs(pathGlobs).length)
+            throw new Error(`Invalid path glob: ${pathGlobs}. Must be a comma-separated list of globs.`);
+        globOperationNameModifierMap.push({
+            methods,
+            pathGlobs,
+            operationNameModifierRegex: patternRegex.trim(),
+            operationNameModifierReplace: patternReplace.trim(),
+        });
+    }
+    return globOperationNameModifierMap;
+}
+//# sourceMappingURL=processOperationNameModifierOption.js.map

package/dist/lib/processOperationNameModifierOption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processOperationNameModifierOption.js","sourceRoot":"","sources":["../../src/lib/processOperationNameModifierOption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE,OAAO,EAEL,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAChD,SAAkC,EAClC,QAAmB,EACnB,EAAE;IACF,IAAI,CAAC,SAAS,CAAC,MAAM;QACnB,OAAO;YACL,MAAM,EAAE,EAAE;YACV,QAAQ;SACT,CAAC;IAEJ,MAAM,sBAAsB,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC1D,GAAG,QAAQ;QACX,WAAW,EAAE,sBAAsB,CACjC,wBAAwB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAC7C;KACF,CAAC,CAAC,CAAC;IAMJ,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAMzC,CAAC;IAEJ,MAAM,8BAA8B,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAC9D,4BAA4B,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QAE1D,OAAO;YACL,GAAG,OAAO;YACV,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC/C,MAAM,qBAAqB,GAAG,4BAA4B,CAAC,GAAG,CAC5D,OAAO,CAAC,IAAI,CACb,CAAC;gBAEF,IAAI,CAAC,qBAAqB;oBACxB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;gBAErD,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,MAAM,CACtD,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC;oBACpC,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS;wBAC7B,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;oBAC9C,mCAAmC,CACjC,QAAQ,CAAC,0BAA0B,CACpC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACzB,CAAC;gBAEF,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,MAAM,CACrD,CAAC,aAAa,EAAE,QAAQ,EAAE,EAAE,CAC1B,aAAa,CAAC,OAAO,CACnB,mCAAmC,CACjC,QAAQ,CAAC,0BAA0B,CACpC,EACD,QAAQ,CAAC,4BAA4B,CACtC,EACH,SAAS,CAAC,IAAI,CACf,CAAC;gBAEF,IAAI,qBAAqB,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;oBAC7C,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,qBAAqB,CAAC;wBACnD,qBAAqB,CAAC,GAAG,CAAC,qBAAqB,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;oBAC9D,qBAAqB,CAAC,GAAG,CAAC,qBAAqB,CAAC,EAAE,GAAG,CACnD,SAAS,CAAC,IAAI,EACd,kBAAkB,CAAC,GAAG,CACpB,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,GAAG,sBAAsB,EAAE,EAAE,EAAE,CAChD,sBAAsB,CACzB,CACF,CAAC;gBACJ,CAAC;gBAED,OAAO;oBACL,GAAG,SAAS;oBACZ,IAAI,EAAE,qBAAqB;iBAC5B,CAAC;YACJ,CAAC,CAAC;SACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAC7D,CAAC,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAAE,EAAE,CACpC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAO,CACpC,CAAC,CAAC,qBAAqB,EAAE,oBAAoB,CAAC,EAAE,EAAE;QAChD,IAAI,oBAAoB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,GAAG,CACzC,CAAC,CAAC,qBAAqB,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;gBACvC,WAAW;gBACX,qBAAqB;gBACrB,qBAAqB;gBACrB,SAAS;aACV,CAAC,CACH,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,qBAAqB,EAAE,SAAS,CAAC,GACtC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAE/C,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtC,OAAO;gBACL;oBACE,WAAW;oBACX,qBAAqB;oBACrB,qBAAqB;oBACrB,SAAS;iBACV;aACF,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC,CACF,CACJ,CAAC;IAEF,OAAO;QACL,MAAM;QACN,QAAQ,EAAE,8BAA8B;KACzC,CAAC;AACJ,CAAC,CAAC;AAEF,SAAS,mCAAmC,CAAC,KAAa;IACxD,OAAO,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAChC,CAAC;AAkBD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,0BAA0B,CACxC,GAAG,WAAqB;IAExB,MAAM,4BAA4B,GAAiC,EAAE,CAAC;IAEtE,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,iBAAiB,GAAG,UAAU,CAAC,KAAK,CACxC,CAAC,EACD,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CACrC,CAAC;QAEF,IAAI,CAAC,iBAAiB,CAAC,MAAM;YAC3B,MAAM,IAAI,KAAK,CACb,oCAAoC,UAAU,oGAAoG,CACnJ,CAAC;QAEJ,MAAM,eAAe,GAAG,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAEvE,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CACxC,CAAC,EACD,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAC/B,CAAC;QACF,MAAM,cAAc,GAAG,eAAe,CAAC,KAAK,CAC1C,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAClD,CAAC;QAEF,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;QAEtE,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,MAAM;YAC7C,MAAM,IAAI,KAAK,CACb,sBAAsB,SAAS,4CAA4C,CAC5E,CAAC;QAEJ,4BAA4B,CAAC,IAAI,CAAC;YAChC,OAAO;YACP,SAAS;YACT,0BAA0B,EAAE,YAAY,CAAC,IAAI,EAAE;YAC/C,4BAA4B,EAAE,cAAc,CAAC,IAAI,EAAE;SACpD,CAAC,CAAC;IACL,CAAC;IAED,OAAO,4BAA4B,CAAC;AACtC,CAAC"}

package/dist/lib/splitCommaSeparatedGlobs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Normalize a comma-separated list of globs
+ * @param commaSeparatedGlobs - Example: `/foo ,    /bar/**, ,`
+ * @returns Example: `/foo,/bar/**`
+ */
+export declare function splitCommaSeparatedGlobs(commaSeparatedGlobs: string | undefined): string[];
+//# sourceMappingURL=splitCommaSeparatedGlobs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"splitCommaSeparatedGlobs.d.ts","sourceRoot":"","sources":["../../src/lib/splitCommaSeparatedGlobs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,mBAAmB,EAAE,MAAM,GAAG,SAAS,GACtC,MAAM,EAAE,CAQV"}

package/dist/lib/splitCommaSeparatedGlobs.js

@@ -0,0 +1,16 @@
+/**
+ * Normalize a comma-separated list of globs
+ * @param commaSeparatedGlobs - Example: `/foo ,    /bar/**, ,`
+ * @returns Example: `/foo,/bar/**`
+ */
+export function splitCommaSeparatedGlobs(commaSeparatedGlobs) {
+    if (commaSeparatedGlobs === undefined)
+        return [];
+    if (typeof commaSeparatedGlobs !== 'string')
+        throw new Error('Invalid input');
+    return commaSeparatedGlobs
+        .split(',')
+        .map((path) => path.trim())
+        .filter(Boolean);
+}
+//# sourceMappingURL=splitCommaSeparatedGlobs.js.map

package/dist/lib/splitCommaSeparatedGlobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitCommaSeparatedGlobs.js","sourceRoot":"","sources":["../../src/lib/splitCommaSeparatedGlobs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,mBAAuC;IAEvC,IAAI,mBAAmB,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACjD,IAAI,OAAO,mBAAmB,KAAK,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;IAE9E,OAAO,mBAAmB;SACvB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,OAAO,CAAC,CAAC;AACrB,CAAC"}

package/dist/packageVersion.d.ts

@@ -1,2 +1,2 @@
-export declare const packageVersion = "1.13.1";
+export declare const packageVersion = "1.14.0-beta.2";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,cAAc,kBAAkB,CAAC"}

package/dist/packageVersion.js

@@ -1,3 +1,3 @@
 // This file was generated automatically
-export const packageVersion = '1.13.1';
+export const packageVersion = '1.14.0-beta.2';
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@openapi-qraft/plugin",
-  "version": "1.13.1",
+  "version": "1.14.0-beta.2",
   "packageManager": "yarn@4.0.2",
   "type": "module",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
     "dev": "yarn build --watch --noEmitOnError false",
-    "test": "vitest run",
+    "test": "vitest run --coverage",
     "typecheck": "tsc --noEmit",
     "lint": "eslint",
     "clean": "rimraf dist/",
@@ -29,7 +29,7 @@
     "camelcase": "^8.0.0",
     "commander": "^11.1.0",
     "micromatch": "^4.0.5",
-    "openapi-typescript": "7.0.0-next.11",
+    "openapi-typescript": "^7.3.0",
     "ora": "^8.0.1",
     "yaml": "^2.3.4"
   },

package/src/lib/QraftCommand.ts

@@ -7,7 +7,6 @@ import c from 'ansi-colors';
 import { Command } from 'commander';
 import ora, { Ora } from 'ora';
 import { packageVersion } from '../packageVersion.js';
-import { parsePathGlobs } from './createServicePathMatch.js';
 import { filterDocumentPaths } from './filterDocumentPaths.js';
 import { GeneratorFile } from './GeneratorFile.js';
 import { handleSchemaInput } from './handleSchemaInput.js';
@@ -16,10 +15,15 @@ import { OpenAPISchemaType } from './open-api/OpenAPISchemaType.js';
 import { readSchema } from './open-api/readSchema.js';
 import { OutputOptions } from './OutputOptions.js';
 import {
-  createPredefinedParametersGlobMap,
+  createPredefinedParametersGlobs,
   parseOperationPredefinedParametersOption,
   predefineSchemaParameters,
 } from './predefineSchemaParameters.js';
+import {
+  parseOperationNameModifier,
+  processOperationNameModifierOption,
+} from './processOperationNameModifierOption.js';
+import { splitCommaSeparatedGlobs } from './splitCommaSeparatedGlobs.js';
 import { writeGeneratorFiles } from './writeGeneratorFiles.js';
 
 export class QraftCommand extends Command {
@@ -50,7 +54,11 @@ export class QraftCommand extends Command {
       )
       .option(
         '--operation-predefined-parameters <patterns...>',
-        'Predefined parameters for services. The specified services parameters will be optional. Eg: "/**:header.x-monite-version,query.x-api-key;/user/**,/post/**:header.x-monite-entity-id"'
+        'Predefined parameters for services. The specified services parameters will be optional. Eg: "/**:header.x-monite-version,query.x-api-key" or "get /**:header.x-monite-entity-id"'
+      )
+      .option(
+        '--operation-name-modifier <patterns...>',
+        'Modifies operation names using a pattern. Use the `==>` operator to separate the regular expression (left) and the substitution string (right). For example: "post /**:[A-Za-z]+Id ==> createOne"'
       )
       .option(
         '--postfix-services <string>',
@@ -96,20 +104,20 @@ export class QraftCommand extends Command {
     spinner.text = 'Reading OpenAPI Schema';
     let schema = filterDocumentPaths(
       await readSchema(input),
-      parsePathGlobs(args.filterServices)
+      splitCommaSeparatedGlobs(args.filterServices)
     );
 
     if (args.operationPredefinedParameters) {
-      const predefinedParametersGlobMap = createPredefinedParametersGlobMap(
+      const predefinedParametersGlobs = createPredefinedParametersGlobs(
         schema,
         parseOperationPredefinedParametersOption(
           ...args.operationPredefinedParameters
         )
       );
 
-      const predefinedParametersErrors = Object.values(
-        predefinedParametersGlobMap
-      ).flatMap(({ errors }) => errors);
+      const predefinedParametersErrors = predefinedParametersGlobs.flatMap(
+        ({ errors }) => errors
+      );
 
       if (predefinedParametersErrors.length) {
         predefinedParametersErrors.forEach((error) => spinner.warn(error));
@@ -119,15 +127,56 @@ export class QraftCommand extends Command {
         process.exit(1);
       }
 
-      schema = predefineSchemaParameters(schema, predefinedParametersGlobMap);
+      schema = predefineSchemaParameters(schema, predefinedParametersGlobs);
     }
 
     spinner.text = 'Getting OpenAPI Services';
-    const services = getServices(schema as OpenAPISchemaType, {
+    let services = getServices(schema as OpenAPISchemaType, {
       postfixServices: args.postfixServices,
       serviceNameBase: args.serviceNameBase,
     });
 
+    if (args.operationNameModifier) {
+      const {
+        services: modifiedServicesOperationNames,
+        errors: operationNameModifierErrors,
+      } = processOperationNameModifierOption(
+        parseOperationNameModifier(
+          ...(Array.isArray(args.operationNameModifier)
+            ? args.operationNameModifier
+            : [args.operationNameModifier])
+        ),
+        services
+      );
+
+      if (operationNameModifierErrors.length) {
+        operationNameModifierErrors.forEach((error) => {
+          spinner.fail(
+            [
+              c.red.bold(
+                `Error occurred during operation name modifier setup: '${error.serviceName}.${error.originalOperationName}' to '${error.replacedOperationName}'`
+              ),
+              c.yellow(
+                error.modifiers
+                  .map(
+                    ({
+                      pathGlobs,
+                      operationNameModifierRegex,
+                      operationNameModifierReplace,
+                    }) =>
+                      `Conflicting operation name modifier: '${pathGlobs}': '${operationNameModifierRegex}' => '${operationNameModifierReplace}'`
+                  )
+                  .join('\n')
+              ),
+            ].join('\n')
+          );
+        });
+        process.exit(1);
+      }
+
+      services = modifiedServicesOperationNames;
+    }
+
     spinner.text = 'Generating code';
 
     const outputDir = normalizeOutputDirPath(args.outputDir);

package/src/lib/createServicePathMatch.ts

@@ -26,21 +26,3 @@ export const createServicePathMatch = (servicesGlob: string[]) => {
     });
   };
 };
-
-/**
- * Parse services filter option to array
- * @example
- * ```ts
- * parsePathGlobs('/user/**,/post/**')
- * ```
- * @param endpointGlobs
- */
-export function parsePathGlobs(endpointGlobs: string): string[] | undefined {
-  return endpointGlobs
-    ? endpointGlobs
-        .split(',')
-        .filter((item: unknown): item is string =>
-          Boolean(typeof item === 'string' && item.trim())
-        )
-    : undefined;
-}

package/src/lib/filterDocumentPaths.ts

@@ -13,9 +13,9 @@ import { createServicePathMatch } from './createServicePathMatch.js';
  */
 export const filterDocumentPaths = (
   schema: OpenAPI3,
-  servicesGlob: string[] | undefined
+  servicesGlob: string[]
 ): OpenAPI3 => {
-  if (!servicesGlob) return schema;
+  if (!servicesGlob.length) return schema;
 
   const isPathMatch = createServicePathMatch(servicesGlob);
   const paths: typeof schema.paths = {};

package/src/lib/parseOperationGlobs.ts

@@ -0,0 +1,55 @@
+import { ServiceOperation } from './open-api/getServices.js';
+import { splitCommaSeparatedGlobs } from './splitCommaSeparatedGlobs.js';
+
+/**
+ *
+ * @param operationFullGlobs - Example: `post /**`, `/**,/foo/bar`
+ * @returns `pathGlobs`, and `methods` as an array if methods are specified, or `undefined`
+ * @example
+ * ```ts
+ * parseOperationGlobs('post /**');
+ * parseOperationGlobs('patch,put /foo/bar');
+ * ```
+ */
+export const parseOperationGlobs = (operationFullGlobs: string) => {
+  const methodsGlobsRaw = operationFullGlobs.slice(
+    0,
+    Math.max(0, operationFullGlobs.indexOf('/'))
+  );
+
+  const methods = methodsGlobsRaw
+    .split(',')
+    .map((method) => method.trim().toLowerCase())
+    .filter(isSupportedOperationMethod);
+
+  methods.sort(sortSupportedMethods);
+
+  return {
+    methods: methods.length ? methods : undefined,
+    pathGlobs: splitCommaSeparatedGlobs(
+      operationFullGlobs.slice(methodsGlobsRaw.length)
+    ).join(','),
+  };
+};
+
+const supportedOperationMethods = Object.values({
+  get: 'get',
+  post: 'post',
+  put: 'put',
+  patch: 'patch',
+  delete: 'delete',
+  options: 'options',
+  head: 'head',
+  trace: 'trace',
+} satisfies { [Method in OperationGlobMethods]: Method });
+
+const isSupportedOperationMethod = (
+  operationRaw: string
+): operationRaw is OperationGlobMethods =>
+  supportedOperationMethods.includes(operationRaw as OperationGlobMethods);
+
+const sortSupportedMethods = (a: string, b: string) =>
+  supportedOperationMethods.indexOf(a as OperationGlobMethods) -
+  supportedOperationMethods.indexOf(b as OperationGlobMethods);
+
+export type OperationGlobMethods = ServiceOperation['method'];