@openapi-qraft/plugin 2.0.0-next.9 → 2.0.0

package/src/lib/predefineSchemaParameters.ts

@@ -5,6 +5,7 @@ import {
   ReferenceObject,
 } from 'openapi-typescript/src/types.js';
 import { createServicePathMatch } from './createServicePathMatch.js';
+import { replaceRefParametersWithComponent } from './open-api/replaceRefParametersWithComponent.js';
 import {
   OperationGlobMethods,
   parseOperationGlobs,
@@ -43,12 +44,12 @@ export function predefineSchemaParameters(
         const predefinedOperation = predefinedPathItem?.[method];
         if (predefinedOperation) assertIsOperationObject(predefinedOperation);
 
-        const operationParameters =
-          predefinedOperation?.parameters ?? operation.parameters ?? [];
-
-        assertIsParameterObjects(operationParameters);
+        const operationParameters = replaceRefParametersWithComponent(
+          predefinedOperation?.parameters ?? operation.parameters,
+          schema.components?.parameters
+        );
 
-        const predefinedParameters = operationParameters.map(
+        const predefinedParameters = operationParameters?.map(
           (operationParameter) => {
             if (
               findPredefinedOperationParameter(
@@ -204,8 +205,11 @@ export function createPredefinedParametersGlobs(
 
         assertIsOperationObject(operation);
 
-        const operationParameters = operation.parameters ?? [];
-        assertIsParameterObjects(operationParameters);
+        const operationParameters = replaceRefParametersWithComponent(
+          // @ts-expect-error the issue with custom OpenAPISchemaType
+          operation.parameters,
+          schema.components?.parameters
+        );
 
         const predefinedParametersGlobKey = createOperationGlobsKey(
           pathGlobs,
@@ -231,6 +235,7 @@ export function createPredefinedParametersGlobs(
         for (const parameterSchemaToPredefine of parametersToPredefine) {
           const parameterToPredefine = findPredefinedOperationParameter(
             parameterSchemaToPredefine,
+            // @ts-expect-error the issue with custom OpenAPISchemaType
             operationParameters
           );
 
@@ -341,18 +346,6 @@ export function assertIsOperationObject(
   }
 }
 
-export function assertIsParameterObjects(
-  parameterObjects: Array<ParameterObject | ReferenceObject>
-): asserts parameterObjects is Array<ParameterObject> {
-  parameterObjects.forEach((parameterObject) => {
-    if ('$ref' in parameterObject) {
-      throw new Error(
-        `Expected a ParameterObject, but got a ReferenceObject: ${parameterObject}`
-      );
-    }
-  });
-}
-
 type ParsedPredefinedParametersOption = {
   methods: OperationGlobMethods[] | undefined;
   pathGlobs: string;

package/src/lib/processOperationNameModifierOption.ts

@@ -1,6 +1,6 @@
 import { createServicePathMatch } from './createServicePathMatch.js';
 import { getOperationIdName } from './open-api/getOperationName.js';
-import { Service } from './open-api/getServices.js';
+import { OpenAPIService } from './open-api/OpenAPIService.js';
 import {
   OperationGlobMethods,
   parseOperationGlobs,
@@ -9,7 +9,7 @@ import { splitCommaSeparatedGlobs } from './splitCommaSeparatedGlobs.js';
 
 export const processOperationNameModifierOption = (
   modifiers: OperationNameModifier[],
-  services: Service[]
+  services: OpenAPIService[]
 ) => {
   if (!modifiers.length)
     return {
@@ -17,7 +17,7 @@ export const processOperationNameModifierOption = (
       services,
     };
 
-  const operationNameModifiers = modifiers.map((modifier) => ({
+  const availableOperationNameModifiers = modifiers.map((modifier) => ({
     ...modifier,
     isPathMatch: createServicePathMatch(
       splitCommaSeparatedGlobs(modifier.pathGlobs)
@@ -36,6 +36,8 @@ export const processOperationNameModifierOption = (
     >
   >();
 
+  const processedOperationNameModifiers = new Set<(typeof modifiers)[number]>();
+
   for (const service of services) {
     serviceOperationReplacements.set(service.name, new Map());
 
@@ -47,7 +49,7 @@ export const processOperationNameModifierOption = (
       if (!operationReplacements)
         throw new Error('operationReplacements not found');
 
-      const operationModifiers = operationNameModifiers.filter(
+      const operationNameModifiers = availableOperationNameModifiers.filter(
         (modifier) =>
           modifier.isPathMatch(operation.path) &&
           (modifier.methods === undefined ||
@@ -58,16 +60,16 @@ export const processOperationNameModifierOption = (
       );
 
       const replacedOperationName = getOperationIdName(
-        operationModifiers.reduce(
-          (operationName, modifier) =>
-            operationName.replace(
-              normalizeOperationNameModifierRegex(
-                modifier.operationNameModifierRegex
-              ),
-              modifier.operationNameModifierReplace
+        operationNameModifiers.reduce((operationNameAcc, modifier) => {
+          processedOperationNameModifiers.add(modifier);
+
+          return operationNameAcc.replace(
+            normalizeOperationNameModifierRegex(
+              modifier.operationNameModifierRegex
             ),
-          operation.name
-        )
+            modifier.operationNameModifierReplace
+          );
+        }, operation.name)
       );
 
       if (replacedOperationName !== operation.name) {
@@ -75,7 +77,7 @@ export const processOperationNameModifierOption = (
           operationReplacements.set(replacedOperationName, new Map());
         operationReplacements.get(replacedOperationName)?.set(
           operation.name,
-          operationModifiers.map(
+          operationNameModifiers.map(
             ({ isPathMatch: _, ...operationModifiersRest }) =>
               operationModifiersRest
           )
@@ -102,13 +104,26 @@ export const processOperationNameModifierOption = (
     }),
   }));
 
-  const errors = Array.from(serviceOperationReplacements).flatMap(
+  const errors: Array<
+    | {
+        type: 'conflictingOperationNameModifier';
+        serviceName: string;
+        replacedOperationName: string;
+        originalOperationName: string | undefined;
+        modifiers: OperationNameModifier[];
+      }
+    | {
+        type: 'unusedOperationNameModifier';
+        modifier: OperationNameModifier;
+      }
+  > = Array.from(serviceOperationReplacements).flatMap(
     ([serviceName, modifiedOperations]) =>
       Array.from(modifiedOperations).flatMap(
         ([replacedOperationName, operationModifierMap]) => {
           if (operationModifierMap.size > 1) {
             return Array.from(operationModifierMap).map(
               ([originalOperationName, modifiers]) => ({
+                type: 'conflictingOperationNameModifier',
                 serviceName,
                 replacedOperationName,
                 originalOperationName,
@@ -123,6 +138,7 @@ export const processOperationNameModifierOption = (
           if (modifiers && modifiers.length > 1) {
             return [
               {
+                type: 'conflictingOperationNameModifier',
                 serviceName,
                 replacedOperationName,
                 originalOperationName,
@@ -136,6 +152,20 @@ export const processOperationNameModifierOption = (
       )
   );
 
+  availableOperationNameModifiers.forEach((modifier) => {
+    if (!processedOperationNameModifiers.has(modifier)) {
+      errors.push({
+        type: 'unusedOperationNameModifier',
+        modifier: {
+          methods: modifier.methods,
+          pathGlobs: modifier.pathGlobs,
+          operationNameModifierRegex: modifier.operationNameModifierRegex,
+          operationNameModifierReplace: modifier.operationNameModifierReplace,
+        },
+      });
+    }
+  });
+
   return {
     errors,
     services: replacedOperationNamesServices,

package/src/packageVersion.ts

@@ -1,2 +1,2 @@
 // This file was generated automatically
-export const packageVersion = '2.0.0-next.9';
+export const packageVersion = '2.0.0';