@strapi/openapi 0.0.0 → 5.20.0

package/dist/assemblers/document/path/path-item/operation/factory.mjs

@@ -0,0 +1,35 @@
+import { OperationIDAssembler } from './operation-id.mjs';
+import { OperationParametersAssembler } from './parameters.mjs';
+import { OperationResponsesAssembler } from './responses.mjs';
+import { OperationTagsAssembler } from './tags.mjs';
+import { BodyAssembler } from './body.mjs';
+
+class OperationAssemblerFactory {
+    createAll() {
+        return [
+            this._createOperationIDAssembler(),
+            this._createParametersAssembler(),
+            this._createResponsesAssembler(),
+            this._createTagsAssembler(),
+            this._createBodyAssembler()
+        ];
+    }
+    _createOperationIDAssembler() {
+        return new OperationIDAssembler();
+    }
+    _createParametersAssembler() {
+        return new OperationParametersAssembler();
+    }
+    _createResponsesAssembler() {
+        return new OperationResponsesAssembler();
+    }
+    _createTagsAssembler() {
+        return new OperationTagsAssembler();
+    }
+    _createBodyAssembler() {
+        return new BodyAssembler();
+    }
+}
+
+export { OperationAssemblerFactory };
+//# sourceMappingURL=factory.mjs.map

package/dist/assemblers/document/path/path-item/operation/factory.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.mjs","sources":["../../../../../../src/assemblers/document/path/path-item/operation/factory.ts"],"sourcesContent":["import type { Assembler } from '../../../..';\n\nimport { OperationIDAssembler } from './operation-id';\nimport { OperationParametersAssembler } from './parameters';\nimport { OperationResponsesAssembler } from './responses';\nimport { OperationTagsAssembler } from './tags';\nimport { BodyAssembler } from './body';\n\nexport class OperationAssemblerFactory {\n  createAll(): Assembler.Operation[] {\n    return [\n      this._createOperationIDAssembler(),\n      this._createParametersAssembler(),\n      this._createResponsesAssembler(),\n      this._createTagsAssembler(),\n      this._createBodyAssembler(),\n    ];\n  }\n\n  private _createOperationIDAssembler() {\n    return new OperationIDAssembler();\n  }\n\n  private _createParametersAssembler() {\n    return new OperationParametersAssembler();\n  }\n\n  private _createResponsesAssembler() {\n    return new OperationResponsesAssembler();\n  }\n\n  private _createTagsAssembler() {\n    return new OperationTagsAssembler();\n  }\n\n  private _createBodyAssembler() {\n    return new BodyAssembler();\n  }\n}\n"],"names":["OperationAssemblerFactory","createAll","_createOperationIDAssembler","_createParametersAssembler","_createResponsesAssembler","_createTagsAssembler","_createBodyAssembler","OperationIDAssembler","OperationParametersAssembler","OperationResponsesAssembler","OperationTagsAssembler","BodyAssembler"],"mappings":";;;;;;AAQO,MAAMA,yBAAAA,CAAAA;IACXC,SAAmC,GAAA;QACjC,OAAO;AACL,YAAA,IAAI,CAACC,2BAA2B,EAAA;AAChC,YAAA,IAAI,CAACC,0BAA0B,EAAA;AAC/B,YAAA,IAAI,CAACC,yBAAyB,EAAA;AAC9B,YAAA,IAAI,CAACC,oBAAoB,EAAA;AACzB,YAAA,IAAI,CAACC,oBAAoB;AAC1B,SAAA;AACH;IAEQJ,2BAA8B,GAAA;AACpC,QAAA,OAAO,IAAIK,oBAAAA,EAAAA;AACb;IAEQJ,0BAA6B,GAAA;AACnC,QAAA,OAAO,IAAIK,4BAAAA,EAAAA;AACb;IAEQJ,yBAA4B,GAAA;AAClC,QAAA,OAAO,IAAIK,2BAAAA,EAAAA;AACb;IAEQJ,oBAAuB,GAAA;AAC7B,QAAA,OAAO,IAAIK,sBAAAA,EAAAA;AACb;IAEQJ,oBAAuB,GAAA;AAC7B,QAAA,OAAO,IAAIK,aAAAA,EAAAA;AACb;AACF;;;;"}

package/dist/assemblers/document/path/path-item/operation/index.d.ts

@@ -0,0 +1,8 @@
+export { OperationAssembler } from './operation';
+export { OperationAssemblerFactory } from './factory';
+export { OperationParametersAssembler } from './parameters';
+export { OperationIDAssembler } from './operation-id';
+export { OperationResponsesAssembler } from './responses';
+export { OperationTagsAssembler } from './tags';
+export { BodyAssembler } from './body';
+//# sourceMappingURL=index.d.ts.map

package/dist/assemblers/document/path/path-item/operation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/assemblers/document/path/path-item/operation/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAGtD,OAAO,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC"}

package/dist/assemblers/document/path/path-item/operation/operation-id.d.ts

@@ -0,0 +1,10 @@
+import type { Core } from '@strapi/types';
+import type { OperationContext } from '../../../../../types';
+import type { Assembler } from '../../../..';
+export declare class OperationIDAssembler implements Assembler.Operation {
+    assemble(context: OperationContext, route: Core.Route): void;
+    private _maybeAppendOrigin;
+    private _appendMethod;
+    private _maybeAppendPath;
+}
+//# sourceMappingURL=operation-id.d.ts.map

package/dist/assemblers/document/path/path-item/operation/operation-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-id.d.ts","sourceRoot":"","sources":["../../../../../../src/assemblers/document/path/path-item/operation/operation-id.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAI1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAI7C,qBAAa,oBAAqB,YAAW,SAAS,CAAC,SAAS;IAC9D,QAAQ,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI;IAkB5D,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,gBAAgB;CA0BzB"}

package/dist/assemblers/document/path/path-item/operation/operation-id.js

@@ -0,0 +1,47 @@
+'use strict';
+
+var constants = require('../../../../../constants.js');
+var debug$1 = require('../../../../../utils/debug.js');
+require('node:crypto');
+require('zod/v4');
+
+const debug = debug$1.createDebugger('assembler:operation-id');
+class OperationIDAssembler {
+    assemble(context, route) {
+        const { path, method, info } = route;
+        const origin = info.apiName ?? info.pluginName;
+        const [operationId] = [
+            ''
+        ]// 'origin/' or ''
+        .map(this._maybeAppendOrigin(origin))// 'origin/get' or 'get'
+        .map(this._appendMethod(method))// 'origin/get/entity_by_id' or 'get/entity_by_id'
+        .map(this._maybeAppendPath(path));
+        debug('assembled an operation ID for %o %o: %o', method, path, operationId);
+        context.output.data.operationId = operationId;
+    }
+    _maybeAppendOrigin(origin) {
+        return ()=>origin ? `${origin}/` : '';
+    }
+    _appendMethod(method) {
+        return (operationId)=>`${operationId}${method.toLowerCase()}`;
+    }
+    _maybeAppendPath(path) {
+        const pathParts = path.split('/').filter(Boolean);
+        return (operationId)=>{
+            if (!pathParts.length) {
+                return operationId;
+            }
+            // Make sure to add a trailing slash after the method name
+            let appendix = '/';
+            const formatPart = (str)=>/[_/]$/.test(appendix) ? str : `_${str}`;
+            pathParts.forEach((part)=>{
+                const match = constants.REGEX_STRAPI_PATH_PARAMS.exec(part);
+                appendix += match ? formatPart(`by_${match[1]}`) : formatPart(part.replaceAll(/\W/g, '_'));
+            });
+            return `${operationId}${appendix}`;
+        };
+    }
+}
+
+exports.OperationIDAssembler = OperationIDAssembler;
+//# sourceMappingURL=operation-id.js.map

package/dist/assemblers/document/path/path-item/operation/operation-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-id.js","sources":["../../../../../../src/assemblers/document/path/path-item/operation/operation-id.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport { REGEX_STRAPI_PATH_PARAMS } from '../../../../../constants';\n\nimport type { OperationContext } from '../../../../../types';\nimport { createDebugger } from '../../../../../utils';\nimport type { Assembler } from '../../../..';\n\nconst debug = createDebugger('assembler:operation-id');\n\nexport class OperationIDAssembler implements Assembler.Operation {\n  assemble(context: OperationContext, route: Core.Route): void {\n    const { path, method, info } = route;\n\n    const origin = info.apiName ?? info.pluginName;\n\n    const [operationId] = ['']\n      // 'origin/' or ''\n      .map(this._maybeAppendOrigin(origin))\n      // 'origin/get' or 'get'\n      .map(this._appendMethod(method))\n      // 'origin/get/entity_by_id' or 'get/entity_by_id'\n      .map(this._maybeAppendPath(path));\n\n    debug('assembled an operation ID for %o %o: %o', method, path, operationId);\n\n    context.output.data.operationId = operationId;\n  }\n\n  private _maybeAppendOrigin(origin?: string) {\n    return () => (origin ? `${origin}/` : '');\n  }\n\n  private _appendMethod(method: string) {\n    return (operationId: string) => `${operationId}${method.toLowerCase()}`;\n  }\n\n  private _maybeAppendPath(path: string) {\n    const pathParts = path.split('/').filter(Boolean);\n\n    return (operationId: string) => {\n      if (!pathParts.length) {\n        return operationId;\n      }\n\n      // Make sure to add a trailing slash after the method name\n      let appendix = '/';\n\n      const formatPart = (str: string) => (/[_/]$/.test(appendix) ? str : `_${str}`);\n\n      pathParts.forEach((part) => {\n        const match = REGEX_STRAPI_PATH_PARAMS.exec(part);\n\n        appendix += match\n          ? // Parameter\n            formatPart(`by_${match[1]}`)\n          : // Regular path segment\n            formatPart(part.replaceAll(/\\W/g, '_'));\n      });\n\n      return `${operationId}${appendix}`;\n    };\n  }\n}\n"],"names":["debug","createDebugger","OperationIDAssembler","assemble","context","route","path","method","info","origin","apiName","pluginName","operationId","map","_maybeAppendOrigin","_appendMethod","_maybeAppendPath","output","data","toLowerCase","pathParts","split","filter","Boolean","length","appendix","formatPart","str","test","forEach","part","match","REGEX_STRAPI_PATH_PARAMS","exec","replaceAll"],"mappings":";;;;;;;AAQA,MAAMA,QAAQC,sBAAe,CAAA,wBAAA,CAAA;AAEtB,MAAMC,oBAAAA,CAAAA;IACXC,QAASC,CAAAA,OAAyB,EAAEC,KAAiB,EAAQ;AAC3D,QAAA,MAAM,EAAEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAE,GAAGH,KAAAA;AAE/B,QAAA,MAAMI,MAASD,GAAAA,IAAAA,CAAKE,OAAO,IAAIF,KAAKG,UAAU;QAE9C,MAAM,CAACC,YAAY,GAAG;AAAC,YAAA;AAAG,SACxB;AACCC,SAAAA,GAAG,CAAC,IAAI,CAACC,kBAAkB,CAACL,QAC7B;AACCI,SAAAA,GAAG,CAAC,IAAI,CAACE,aAAa,CAACR,QACxB;AACCM,SAAAA,GAAG,CAAC,IAAI,CAACG,gBAAgB,CAACV,IAAAA,CAAAA,CAAAA;QAE7BN,KAAM,CAAA,yCAAA,EAA2CO,QAAQD,IAAMM,EAAAA,WAAAA,CAAAA;AAE/DR,QAAAA,OAAAA,CAAQa,MAAM,CAACC,IAAI,CAACN,WAAW,GAAGA,WAAAA;AACpC;AAEQE,IAAAA,kBAAAA,CAAmBL,MAAe,EAAE;AAC1C,QAAA,OAAO,IAAOA,MAAS,GAAA,CAAC,EAAEA,MAAO,CAAA,CAAC,CAAC,GAAG,EAAA;AACxC;AAEQM,IAAAA,aAAAA,CAAcR,MAAc,EAAE;QACpC,OAAO,CAACK,cAAwB,CAAC,EAAEA,YAAY,EAAEL,MAAAA,CAAOY,WAAW,EAAA,CAAG,CAAC;AACzE;AAEQH,IAAAA,gBAAAA,CAAiBV,IAAY,EAAE;AACrC,QAAA,MAAMc,YAAYd,IAAKe,CAAAA,KAAK,CAAC,GAAA,CAAA,CAAKC,MAAM,CAACC,OAAAA,CAAAA;AAEzC,QAAA,OAAO,CAACX,WAAAA,GAAAA;YACN,IAAI,CAACQ,SAAUI,CAAAA,MAAM,EAAE;gBACrB,OAAOZ,WAAAA;AACT;;AAGA,YAAA,IAAIa,QAAW,GAAA,GAAA;AAEf,YAAA,MAAMC,UAAa,GAAA,CAACC,GAAiB,GAAA,OAAA,CAAQC,IAAI,CAACH,QAAYE,CAAAA,GAAAA,GAAAA,GAAM,CAAC,CAAC,EAAEA,GAAAA,CAAI,CAAC;YAE7EP,SAAUS,CAAAA,OAAO,CAAC,CAACC,IAAAA,GAAAA;gBACjB,MAAMC,KAAAA,GAAQC,kCAAyBC,CAAAA,IAAI,CAACH,IAAAA,CAAAA;AAE5CL,gBAAAA,QAAAA,IAAYM,KAERL,GAAAA,UAAAA,CAAW,CAAC,GAAG,EAAEK,KAAK,CAAC,CAAE,CAAA,CAAC,CAAC,CAE3BL,GAAAA,UAAAA,CAAWI,IAAKI,CAAAA,UAAU,CAAC,KAAO,EAAA,GAAA,CAAA,CAAA;AACxC,aAAA,CAAA;AAEA,YAAA,OAAO,CAAC,EAAEtB,WAAY,CAAA,EAAEa,SAAS,CAAC;AACpC,SAAA;AACF;AACF;;;;"}

package/dist/assemblers/document/path/path-item/operation/operation-id.mjs

@@ -0,0 +1,45 @@
+import { REGEX_STRAPI_PATH_PARAMS } from '../../../../../constants.mjs';
+import { createDebugger } from '../../../../../utils/debug.mjs';
+import 'node:crypto';
+import 'zod/v4';
+
+const debug = createDebugger('assembler:operation-id');
+class OperationIDAssembler {
+    assemble(context, route) {
+        const { path, method, info } = route;
+        const origin = info.apiName ?? info.pluginName;
+        const [operationId] = [
+            ''
+        ]// 'origin/' or ''
+        .map(this._maybeAppendOrigin(origin))// 'origin/get' or 'get'
+        .map(this._appendMethod(method))// 'origin/get/entity_by_id' or 'get/entity_by_id'
+        .map(this._maybeAppendPath(path));
+        debug('assembled an operation ID for %o %o: %o', method, path, operationId);
+        context.output.data.operationId = operationId;
+    }
+    _maybeAppendOrigin(origin) {
+        return ()=>origin ? `${origin}/` : '';
+    }
+    _appendMethod(method) {
+        return (operationId)=>`${operationId}${method.toLowerCase()}`;
+    }
+    _maybeAppendPath(path) {
+        const pathParts = path.split('/').filter(Boolean);
+        return (operationId)=>{
+            if (!pathParts.length) {
+                return operationId;
+            }
+            // Make sure to add a trailing slash after the method name
+            let appendix = '/';
+            const formatPart = (str)=>/[_/]$/.test(appendix) ? str : `_${str}`;
+            pathParts.forEach((part)=>{
+                const match = REGEX_STRAPI_PATH_PARAMS.exec(part);
+                appendix += match ? formatPart(`by_${match[1]}`) : formatPart(part.replaceAll(/\W/g, '_'));
+            });
+            return `${operationId}${appendix}`;
+        };
+    }
+}
+
+export { OperationIDAssembler };
+//# sourceMappingURL=operation-id.mjs.map

package/dist/assemblers/document/path/path-item/operation/operation-id.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-id.mjs","sources":["../../../../../../src/assemblers/document/path/path-item/operation/operation-id.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport { REGEX_STRAPI_PATH_PARAMS } from '../../../../../constants';\n\nimport type { OperationContext } from '../../../../../types';\nimport { createDebugger } from '../../../../../utils';\nimport type { Assembler } from '../../../..';\n\nconst debug = createDebugger('assembler:operation-id');\n\nexport class OperationIDAssembler implements Assembler.Operation {\n  assemble(context: OperationContext, route: Core.Route): void {\n    const { path, method, info } = route;\n\n    const origin = info.apiName ?? info.pluginName;\n\n    const [operationId] = ['']\n      // 'origin/' or ''\n      .map(this._maybeAppendOrigin(origin))\n      // 'origin/get' or 'get'\n      .map(this._appendMethod(method))\n      // 'origin/get/entity_by_id' or 'get/entity_by_id'\n      .map(this._maybeAppendPath(path));\n\n    debug('assembled an operation ID for %o %o: %o', method, path, operationId);\n\n    context.output.data.operationId = operationId;\n  }\n\n  private _maybeAppendOrigin(origin?: string) {\n    return () => (origin ? `${origin}/` : '');\n  }\n\n  private _appendMethod(method: string) {\n    return (operationId: string) => `${operationId}${method.toLowerCase()}`;\n  }\n\n  private _maybeAppendPath(path: string) {\n    const pathParts = path.split('/').filter(Boolean);\n\n    return (operationId: string) => {\n      if (!pathParts.length) {\n        return operationId;\n      }\n\n      // Make sure to add a trailing slash after the method name\n      let appendix = '/';\n\n      const formatPart = (str: string) => (/[_/]$/.test(appendix) ? str : `_${str}`);\n\n      pathParts.forEach((part) => {\n        const match = REGEX_STRAPI_PATH_PARAMS.exec(part);\n\n        appendix += match\n          ? // Parameter\n            formatPart(`by_${match[1]}`)\n          : // Regular path segment\n            formatPart(part.replaceAll(/\\W/g, '_'));\n      });\n\n      return `${operationId}${appendix}`;\n    };\n  }\n}\n"],"names":["debug","createDebugger","OperationIDAssembler","assemble","context","route","path","method","info","origin","apiName","pluginName","operationId","map","_maybeAppendOrigin","_appendMethod","_maybeAppendPath","output","data","toLowerCase","pathParts","split","filter","Boolean","length","appendix","formatPart","str","test","forEach","part","match","REGEX_STRAPI_PATH_PARAMS","exec","replaceAll"],"mappings":";;;;;AAQA,MAAMA,QAAQC,cAAe,CAAA,wBAAA,CAAA;AAEtB,MAAMC,oBAAAA,CAAAA;IACXC,QAASC,CAAAA,OAAyB,EAAEC,KAAiB,EAAQ;AAC3D,QAAA,MAAM,EAAEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAE,GAAGH,KAAAA;AAE/B,QAAA,MAAMI,MAASD,GAAAA,IAAAA,CAAKE,OAAO,IAAIF,KAAKG,UAAU;QAE9C,MAAM,CAACC,YAAY,GAAG;AAAC,YAAA;AAAG,SACxB;AACCC,SAAAA,GAAG,CAAC,IAAI,CAACC,kBAAkB,CAACL,QAC7B;AACCI,SAAAA,GAAG,CAAC,IAAI,CAACE,aAAa,CAACR,QACxB;AACCM,SAAAA,GAAG,CAAC,IAAI,CAACG,gBAAgB,CAACV,IAAAA,CAAAA,CAAAA;QAE7BN,KAAM,CAAA,yCAAA,EAA2CO,QAAQD,IAAMM,EAAAA,WAAAA,CAAAA;AAE/DR,QAAAA,OAAAA,CAAQa,MAAM,CAACC,IAAI,CAACN,WAAW,GAAGA,WAAAA;AACpC;AAEQE,IAAAA,kBAAAA,CAAmBL,MAAe,EAAE;AAC1C,QAAA,OAAO,IAAOA,MAAS,GAAA,CAAC,EAAEA,MAAO,CAAA,CAAC,CAAC,GAAG,EAAA;AACxC;AAEQM,IAAAA,aAAAA,CAAcR,MAAc,EAAE;QACpC,OAAO,CAACK,cAAwB,CAAC,EAAEA,YAAY,EAAEL,MAAAA,CAAOY,WAAW,EAAA,CAAG,CAAC;AACzE;AAEQH,IAAAA,gBAAAA,CAAiBV,IAAY,EAAE;AACrC,QAAA,MAAMc,YAAYd,IAAKe,CAAAA,KAAK,CAAC,GAAA,CAAA,CAAKC,MAAM,CAACC,OAAAA,CAAAA;AAEzC,QAAA,OAAO,CAACX,WAAAA,GAAAA;YACN,IAAI,CAACQ,SAAUI,CAAAA,MAAM,EAAE;gBACrB,OAAOZ,WAAAA;AACT;;AAGA,YAAA,IAAIa,QAAW,GAAA,GAAA;AAEf,YAAA,MAAMC,UAAa,GAAA,CAACC,GAAiB,GAAA,OAAA,CAAQC,IAAI,CAACH,QAAYE,CAAAA,GAAAA,GAAAA,GAAM,CAAC,CAAC,EAAEA,GAAAA,CAAI,CAAC;YAE7EP,SAAUS,CAAAA,OAAO,CAAC,CAACC,IAAAA,GAAAA;gBACjB,MAAMC,KAAAA,GAAQC,wBAAyBC,CAAAA,IAAI,CAACH,IAAAA,CAAAA;AAE5CL,gBAAAA,QAAAA,IAAYM,KAERL,GAAAA,UAAAA,CAAW,CAAC,GAAG,EAAEK,KAAK,CAAC,CAAE,CAAA,CAAC,CAAC,CAE3BL,GAAAA,UAAAA,CAAWI,IAAKI,CAAAA,UAAU,CAAC,KAAO,EAAA,GAAA,CAAA,CAAA;AACxC,aAAA,CAAA;AAEA,YAAA,OAAO,CAAC,EAAEtB,WAAY,CAAA,EAAEa,SAAS,CAAC;AACpC,SAAA;AACF;AACF;;;;"}

package/dist/assemblers/document/path/path-item/operation/operation.d.ts

@@ -0,0 +1,13 @@
+import type { Core } from '@strapi/types';
+import { OperationContextFactory } from '../../../../../context';
+import type { PathItemContext } from '../../../../../types';
+import type { Assembler } from '../../../..';
+export declare class OperationAssembler implements Assembler.PathItem {
+    private readonly _assemblers;
+    private readonly _contextFactory;
+    constructor(assemblers: Assembler.Operation[], contextFactory?: OperationContextFactory);
+    assemble(context: PathItemContext, path: string, routes: Core.Route[]): void;
+    private _validateOperationObject;
+    private _validateHTTPIndex;
+}
+//# sourceMappingURL=operation.d.ts.map

package/dist/assemblers/document/path/path-item/operation/operation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../../../../src/assemblers/document/path/path-item/operation/operation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAGjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAI7C,qBAAa,kBAAmB,YAAW,SAAS,CAAC,QAAQ;IAC3D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAwB;IAEpD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;gBAGxD,UAAU,EAAE,SAAS,CAAC,SAAS,EAAE,EACjC,cAAc,GAAE,uBAAuD;IAMzE,QAAQ,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI;IA6B5E,OAAO,CAAC,wBAAwB;IAQhC,OAAO,CAAC,kBAAkB;CAS3B"}

package/dist/assemblers/document/path/path-item/operation/operation.js

@@ -0,0 +1,51 @@
+'use strict';
+
+var openapiTypes = require('openapi-types');
+var debug$1 = require('../../../../../utils/debug.js');
+require('node:crypto');
+require('zod/v4');
+var operation = require('../../../../../context/factories/operation.js');
+
+const debug = debug$1.createDebugger('assembler:operation');
+class OperationAssembler {
+    assemble(context, path, routes) {
+        const { output, ...defaultContextProps } = context;
+        for (const route of routes){
+            const { method } = route;
+            const methodIndex = method.toLowerCase();
+            const operationContext = this._contextFactory.create(defaultContextProps);
+            this._validateHTTPIndex(methodIndex);
+            debug('assembling operation object for %o %o...', method, path);
+            for (const assembler of this._assemblers){
+                debug('running assembler: %s...', assembler.constructor.name);
+                assembler.assemble(operationContext, route);
+            }
+            const { data: operationObject } = operationContext.output;
+            this._validateOperationObject(operationObject);
+            debug('assembled operation object for %o %o', method, path);
+            Object.assign(output.data, {
+                [methodIndex]: operationObject
+            });
+        }
+    }
+    _validateOperationObject(operation) {
+        if (!('responses' in operation)) {
+            throw new Error('Invalid operation object: missing "responses" property');
+        }
+    }
+    _validateHTTPIndex(method) {
+        // HttpMethods is exported as an enum in OpenAPIV3 and as a type only in OpenAPIV3_1
+        const allowedMethods = Object.values(openapiTypes.OpenAPIV3.HttpMethods);
+        const isAllowedMethod = allowedMethods.includes(method);
+        if (!isAllowedMethod) {
+            throw new Error(`Invalid HTTP method object: ${method}. Expected one of ${allowedMethods}`);
+        }
+    }
+    constructor(assemblers, contextFactory = new operation.OperationContextFactory()){
+        this._assemblers = assemblers;
+        this._contextFactory = contextFactory;
+    }
+}
+
+exports.OperationAssembler = OperationAssembler;
+//# sourceMappingURL=operation.js.map

package/dist/assemblers/document/path/path-item/operation/operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation.js","sources":["../../../../../../src/assemblers/document/path/path-item/operation/operation.ts"],"sourcesContent":["import { OpenAPIV3_1, OpenAPIV3 } from 'openapi-types';\n\nimport type { Core } from '@strapi/types';\n\nimport { OperationContextFactory } from '../../../../../context';\nimport { createDebugger } from '../../../../../utils';\n\nimport type { PathItemContext } from '../../../../../types';\n\nimport type { Assembler } from '../../../..';\n\nconst debug = createDebugger('assembler:operation');\n\nexport class OperationAssembler implements Assembler.PathItem {\n  private readonly _assemblers: Assembler.Operation[];\n\n  private readonly _contextFactory: OperationContextFactory;\n\n  constructor(\n    assemblers: Assembler.Operation[],\n    contextFactory: OperationContextFactory = new OperationContextFactory()\n  ) {\n    this._assemblers = assemblers;\n    this._contextFactory = contextFactory;\n  }\n\n  assemble(context: PathItemContext, path: string, routes: Core.Route[]): void {\n    const { output, ...defaultContextProps } = context;\n\n    for (const route of routes) {\n      const { method } = route;\n\n      const methodIndex = method.toLowerCase();\n      const operationContext = this._contextFactory.create(defaultContextProps);\n\n      this._validateHTTPIndex(methodIndex);\n\n      debug('assembling operation object for %o %o...', method, path);\n\n      for (const assembler of this._assemblers) {\n        debug('running assembler: %s...', assembler.constructor.name);\n\n        assembler.assemble(operationContext, route);\n      }\n\n      const { data: operationObject } = operationContext.output;\n\n      this._validateOperationObject(operationObject);\n\n      debug('assembled operation object for %o %o', method, path);\n\n      Object.assign(output.data, { [methodIndex]: operationObject });\n    }\n  }\n\n  private _validateOperationObject(\n    operation: Partial<OpenAPIV3_1.OperationObject>\n  ): asserts operation is OpenAPIV3_1.OperationObject {\n    if (!('responses' in operation)) {\n      throw new Error('Invalid operation object: missing \"responses\" property');\n    }\n  }\n\n  private _validateHTTPIndex(method: string): asserts method is OpenAPIV3_1.HttpMethods {\n    // HttpMethods is exported as an enum in OpenAPIV3 and as a type only in OpenAPIV3_1\n    const allowedMethods = Object.values<string>(OpenAPIV3.HttpMethods);\n    const isAllowedMethod = allowedMethods.includes(method);\n\n    if (!isAllowedMethod) {\n      throw new Error(`Invalid HTTP method object: ${method}. Expected one of ${allowedMethods}`);\n    }\n  }\n}\n"],"names":["debug","createDebugger","OperationAssembler","assemble","context","path","routes","output","defaultContextProps","route","method","methodIndex","toLowerCase","operationContext","_contextFactory","create","_validateHTTPIndex","assembler","_assemblers","constructor","name","data","operationObject","_validateOperationObject","Object","assign","operation","Error","allowedMethods","values","OpenAPIV3","HttpMethods","isAllowedMethod","includes","assemblers","contextFactory","OperationContextFactory"],"mappings":";;;;;;;;AAWA,MAAMA,QAAQC,sBAAe,CAAA,qBAAA,CAAA;AAEtB,MAAMC,kBAAAA,CAAAA;AAaXC,IAAAA,QAAAA,CAASC,OAAwB,EAAEC,IAAY,EAAEC,MAAoB,EAAQ;AAC3E,QAAA,MAAM,EAAEC,MAAM,EAAE,GAAGC,qBAAqB,GAAGJ,OAAAA;QAE3C,KAAK,MAAMK,SAASH,MAAQ,CAAA;YAC1B,MAAM,EAAEI,MAAM,EAAE,GAAGD,KAAAA;YAEnB,MAAME,WAAAA,GAAcD,OAAOE,WAAW,EAAA;AACtC,YAAA,MAAMC,mBAAmB,IAAI,CAACC,eAAe,CAACC,MAAM,CAACP,mBAAAA,CAAAA;YAErD,IAAI,CAACQ,kBAAkB,CAACL,WAAAA,CAAAA;AAExBX,YAAAA,KAAAA,CAAM,4CAA4CU,MAAQL,EAAAA,IAAAA,CAAAA;AAE1D,YAAA,KAAK,MAAMY,SAAAA,IAAa,IAAI,CAACC,WAAW,CAAE;AACxClB,gBAAAA,KAAAA,CAAM,0BAA4BiB,EAAAA,SAAAA,CAAUE,WAAW,CAACC,IAAI,CAAA;gBAE5DH,SAAUd,CAAAA,QAAQ,CAACU,gBAAkBJ,EAAAA,KAAAA,CAAAA;AACvC;AAEA,YAAA,MAAM,EAAEY,IAAMC,EAAAA,eAAe,EAAE,GAAGT,iBAAiBN,MAAM;YAEzD,IAAI,CAACgB,wBAAwB,CAACD,eAAAA,CAAAA;AAE9BtB,YAAAA,KAAAA,CAAM,wCAAwCU,MAAQL,EAAAA,IAAAA,CAAAA;AAEtDmB,YAAAA,MAAAA,CAAOC,MAAM,CAAClB,MAAOc,CAAAA,IAAI,EAAE;AAAE,gBAAA,CAACV,cAAcW;AAAgB,aAAA,CAAA;AAC9D;AACF;AAEQC,IAAAA,wBAAAA,CACNG,SAA+C,EACG;AAClD,QAAA,IAAI,EAAE,WAAeA,IAAAA,SAAQ,CAAI,EAAA;AAC/B,YAAA,MAAM,IAAIC,KAAM,CAAA,wDAAA,CAAA;AAClB;AACF;AAEQX,IAAAA,kBAAAA,CAAmBN,MAAc,EAA6C;;AAEpF,QAAA,MAAMkB,cAAiBJ,GAAAA,MAAAA,CAAOK,MAAM,CAASC,uBAAUC,WAAW,CAAA;QAClE,MAAMC,eAAAA,GAAkBJ,cAAeK,CAAAA,QAAQ,CAACvB,MAAAA,CAAAA;AAEhD,QAAA,IAAI,CAACsB,eAAiB,EAAA;YACpB,MAAM,IAAIL,MAAM,CAAC,4BAA4B,EAAEjB,MAAO,CAAA,kBAAkB,EAAEkB,cAAAA,CAAe,CAAC,CAAA;AAC5F;AACF;AArDAT,IAAAA,WAAAA,CACEe,UAAiC,EACjCC,cAA0C,GAAA,IAAIC,mCAAyB,CACvE;QACA,IAAI,CAAClB,WAAW,GAAGgB,UAAAA;QACnB,IAAI,CAACpB,eAAe,GAAGqB,cAAAA;AACzB;AAgDF;;;;"}

package/dist/assemblers/document/path/path-item/operation/operation.mjs

@@ -0,0 +1,49 @@
+import { OpenAPIV3 } from 'openapi-types';
+import { createDebugger } from '../../../../../utils/debug.mjs';
+import 'node:crypto';
+import 'zod/v4';
+import { OperationContextFactory } from '../../../../../context/factories/operation.mjs';
+
+const debug = createDebugger('assembler:operation');
+class OperationAssembler {
+    assemble(context, path, routes) {
+        const { output, ...defaultContextProps } = context;
+        for (const route of routes){
+            const { method } = route;
+            const methodIndex = method.toLowerCase();
+            const operationContext = this._contextFactory.create(defaultContextProps);
+            this._validateHTTPIndex(methodIndex);
+            debug('assembling operation object for %o %o...', method, path);
+            for (const assembler of this._assemblers){
+                debug('running assembler: %s...', assembler.constructor.name);
+                assembler.assemble(operationContext, route);
+            }
+            const { data: operationObject } = operationContext.output;
+            this._validateOperationObject(operationObject);
+            debug('assembled operation object for %o %o', method, path);
+            Object.assign(output.data, {
+                [methodIndex]: operationObject
+            });
+        }
+    }
+    _validateOperationObject(operation) {
+        if (!('responses' in operation)) {
+            throw new Error('Invalid operation object: missing "responses" property');
+        }
+    }
+    _validateHTTPIndex(method) {
+        // HttpMethods is exported as an enum in OpenAPIV3 and as a type only in OpenAPIV3_1
+        const allowedMethods = Object.values(OpenAPIV3.HttpMethods);
+        const isAllowedMethod = allowedMethods.includes(method);
+        if (!isAllowedMethod) {
+            throw new Error(`Invalid HTTP method object: ${method}. Expected one of ${allowedMethods}`);
+        }
+    }
+    constructor(assemblers, contextFactory = new OperationContextFactory()){
+        this._assemblers = assemblers;
+        this._contextFactory = contextFactory;
+    }
+}
+
+export { OperationAssembler };
+//# sourceMappingURL=operation.mjs.map

package/dist/assemblers/document/path/path-item/operation/operation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation.mjs","sources":["../../../../../../src/assemblers/document/path/path-item/operation/operation.ts"],"sourcesContent":["import { OpenAPIV3_1, OpenAPIV3 } from 'openapi-types';\n\nimport type { Core } from '@strapi/types';\n\nimport { OperationContextFactory } from '../../../../../context';\nimport { createDebugger } from '../../../../../utils';\n\nimport type { PathItemContext } from '../../../../../types';\n\nimport type { Assembler } from '../../../..';\n\nconst debug = createDebugger('assembler:operation');\n\nexport class OperationAssembler implements Assembler.PathItem {\n  private readonly _assemblers: Assembler.Operation[];\n\n  private readonly _contextFactory: OperationContextFactory;\n\n  constructor(\n    assemblers: Assembler.Operation[],\n    contextFactory: OperationContextFactory = new OperationContextFactory()\n  ) {\n    this._assemblers = assemblers;\n    this._contextFactory = contextFactory;\n  }\n\n  assemble(context: PathItemContext, path: string, routes: Core.Route[]): void {\n    const { output, ...defaultContextProps } = context;\n\n    for (const route of routes) {\n      const { method } = route;\n\n      const methodIndex = method.toLowerCase();\n      const operationContext = this._contextFactory.create(defaultContextProps);\n\n      this._validateHTTPIndex(methodIndex);\n\n      debug('assembling operation object for %o %o...', method, path);\n\n      for (const assembler of this._assemblers) {\n        debug('running assembler: %s...', assembler.constructor.name);\n\n        assembler.assemble(operationContext, route);\n      }\n\n      const { data: operationObject } = operationContext.output;\n\n      this._validateOperationObject(operationObject);\n\n      debug('assembled operation object for %o %o', method, path);\n\n      Object.assign(output.data, { [methodIndex]: operationObject });\n    }\n  }\n\n  private _validateOperationObject(\n    operation: Partial<OpenAPIV3_1.OperationObject>\n  ): asserts operation is OpenAPIV3_1.OperationObject {\n    if (!('responses' in operation)) {\n      throw new Error('Invalid operation object: missing \"responses\" property');\n    }\n  }\n\n  private _validateHTTPIndex(method: string): asserts method is OpenAPIV3_1.HttpMethods {\n    // HttpMethods is exported as an enum in OpenAPIV3 and as a type only in OpenAPIV3_1\n    const allowedMethods = Object.values<string>(OpenAPIV3.HttpMethods);\n    const isAllowedMethod = allowedMethods.includes(method);\n\n    if (!isAllowedMethod) {\n      throw new Error(`Invalid HTTP method object: ${method}. Expected one of ${allowedMethods}`);\n    }\n  }\n}\n"],"names":["debug","createDebugger","OperationAssembler","assemble","context","path","routes","output","defaultContextProps","route","method","methodIndex","toLowerCase","operationContext","_contextFactory","create","_validateHTTPIndex","assembler","_assemblers","constructor","name","data","operationObject","_validateOperationObject","Object","assign","operation","Error","allowedMethods","values","OpenAPIV3","HttpMethods","isAllowedMethod","includes","assemblers","contextFactory","OperationContextFactory"],"mappings":";;;;;;AAWA,MAAMA,QAAQC,cAAe,CAAA,qBAAA,CAAA;AAEtB,MAAMC,kBAAAA,CAAAA;AAaXC,IAAAA,QAAAA,CAASC,OAAwB,EAAEC,IAAY,EAAEC,MAAoB,EAAQ;AAC3E,QAAA,MAAM,EAAEC,MAAM,EAAE,GAAGC,qBAAqB,GAAGJ,OAAAA;QAE3C,KAAK,MAAMK,SAASH,MAAQ,CAAA;YAC1B,MAAM,EAAEI,MAAM,EAAE,GAAGD,KAAAA;YAEnB,MAAME,WAAAA,GAAcD,OAAOE,WAAW,EAAA;AACtC,YAAA,MAAMC,mBAAmB,IAAI,CAACC,eAAe,CAACC,MAAM,CAACP,mBAAAA,CAAAA;YAErD,IAAI,CAACQ,kBAAkB,CAACL,WAAAA,CAAAA;AAExBX,YAAAA,KAAAA,CAAM,4CAA4CU,MAAQL,EAAAA,IAAAA,CAAAA;AAE1D,YAAA,KAAK,MAAMY,SAAAA,IAAa,IAAI,CAACC,WAAW,CAAE;AACxClB,gBAAAA,KAAAA,CAAM,0BAA4BiB,EAAAA,SAAAA,CAAUE,WAAW,CAACC,IAAI,CAAA;gBAE5DH,SAAUd,CAAAA,QAAQ,CAACU,gBAAkBJ,EAAAA,KAAAA,CAAAA;AACvC;AAEA,YAAA,MAAM,EAAEY,IAAMC,EAAAA,eAAe,EAAE,GAAGT,iBAAiBN,MAAM;YAEzD,IAAI,CAACgB,wBAAwB,CAACD,eAAAA,CAAAA;AAE9BtB,YAAAA,KAAAA,CAAM,wCAAwCU,MAAQL,EAAAA,IAAAA,CAAAA;AAEtDmB,YAAAA,MAAAA,CAAOC,MAAM,CAAClB,MAAOc,CAAAA,IAAI,EAAE;AAAE,gBAAA,CAACV,cAAcW;AAAgB,aAAA,CAAA;AAC9D;AACF;AAEQC,IAAAA,wBAAAA,CACNG,SAA+C,EACG;AAClD,QAAA,IAAI,EAAE,WAAeA,IAAAA,SAAQ,CAAI,EAAA;AAC/B,YAAA,MAAM,IAAIC,KAAM,CAAA,wDAAA,CAAA;AAClB;AACF;AAEQX,IAAAA,kBAAAA,CAAmBN,MAAc,EAA6C;;AAEpF,QAAA,MAAMkB,cAAiBJ,GAAAA,MAAAA,CAAOK,MAAM,CAASC,UAAUC,WAAW,CAAA;QAClE,MAAMC,eAAAA,GAAkBJ,cAAeK,CAAAA,QAAQ,CAACvB,MAAAA,CAAAA;AAEhD,QAAA,IAAI,CAACsB,eAAiB,EAAA;YACpB,MAAM,IAAIL,MAAM,CAAC,4BAA4B,EAAEjB,MAAO,CAAA,kBAAkB,EAAEkB,cAAAA,CAAe,CAAC,CAAA;AAC5F;AACF;AArDAT,IAAAA,WAAAA,CACEe,UAAiC,EACjCC,cAA0C,GAAA,IAAIC,yBAAyB,CACvE;QACA,IAAI,CAAClB,WAAW,GAAGgB,UAAAA;QACnB,IAAI,CAACpB,eAAe,GAAGqB,cAAAA;AACzB;AAgDF;;;;"}

package/dist/assemblers/document/path/path-item/operation/parameters.d.ts

@@ -0,0 +1,9 @@
+import type { Core } from '@strapi/types';
+import type { Assembler } from '../../../..';
+import type { OperationContext } from '../../../../../types';
+export declare class OperationParametersAssembler implements Assembler.Operation {
+    assemble(context: OperationContext, route: Core.Route): void;
+    private _getPathParameters;
+    private _getQueryParameters;
+}
+//# sourceMappingURL=parameters.d.ts.map

package/dist/assemblers/document/path/path-item/operation/parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../../../../src/assemblers/document/path/path-item/operation/parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAQ7D,qBAAa,4BAA6B,YAAW,SAAS,CAAC,SAAS;IACtE,QAAQ,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI;IAe5D,OAAO,CAAC,kBAAkB;IAoB1B,OAAO,CAAC,mBAAmB;CAuB5B"}

package/dist/assemblers/document/path/path-item/operation/parameters.js

@@ -0,0 +1,67 @@
+'use strict';
+
+var debug$1 = require('../../../../../utils/debug.js');
+var zod = require('../../../../../utils/zod.js');
+
+const debug = debug$1.createDebugger('assembler:parameters');
+class OperationParametersAssembler {
+    assemble(context, route) {
+        debug('assembling parameters for %o %o...', route.method, route.path);
+        const pathParameters = this._getPathParameters(route);
+        debug('found %o path parameters', pathParameters.length);
+        const queryParameters = this._getQueryParameters(route);
+        debug('found %o query parameters', queryParameters.length);
+        const parameters = [
+            ...pathParameters,
+            ...queryParameters
+        ];
+        debug('assembled %o parameters for %o %o', parameters.length, route.method, route.path);
+        context.output.data.parameters = parameters;
+    }
+    _getPathParameters(route) {
+        const { params } = route.request ?? {};
+        // TODO: Allow auto inference (from path) if enabled through configuration
+        if (!params) {
+            return [];
+        }
+        const pathParams = [];
+        for (const [name, zodSchema] of Object.entries(params)){
+            const required = !zodSchema.isOptional();
+            const schema = zod.zodToOpenAPI(zodSchema);
+            pathParams.push({
+                name,
+                in: 'path',
+                required,
+                schema
+            });
+        }
+        return pathParams;
+    }
+    _getQueryParameters(route) {
+        const { query } = route.request ?? {};
+        if (!query) {
+            return [];
+        }
+        const queryParams = [];
+        for (const [name, zodSchema] of Object.entries(query)){
+            const required = !zodSchema.isOptional();
+            const schema = zod.zodToOpenAPI(zodSchema);
+            const param = {
+                name,
+                in: 'query',
+                required,
+                schema
+            };
+            // In Strapi, query params are always interpreted as query strings, which isn't supported by the specification
+            // TODO: Make that configurable somehow
+            Object.assign(param, {
+                'x-strapi-serialize': 'querystring'
+            });
+            queryParams.push(param);
+        }
+        return queryParams;
+    }
+}
+
+exports.OperationParametersAssembler = OperationParametersAssembler;
+//# sourceMappingURL=parameters.js.map

package/dist/assemblers/document/path/path-item/operation/parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.js","sources":["../../../../../../src/assemblers/document/path/path-item/operation/parameters.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\nimport type { OpenAPIV3_1 } from 'openapi-types';\nimport type { Assembler } from '../../../..';\n\nimport type { OperationContext } from '../../../../../types';\nimport { createDebugger, zodToOpenAPI } from '../../../../../utils';\n\nconst debug = createDebugger('assembler:parameters');\n\ntype PathParameterObject = OpenAPIV3_1.ParameterObject & { in: 'path' };\ntype QueryParameterObject = OpenAPIV3_1.ParameterObject & { in: 'query' };\n\nexport class OperationParametersAssembler implements Assembler.Operation {\n  assemble(context: OperationContext, route: Core.Route): void {\n    debug('assembling parameters for %o %o...', route.method, route.path);\n\n    const pathParameters = this._getPathParameters(route);\n    debug('found %o path parameters', pathParameters.length);\n\n    const queryParameters = this._getQueryParameters(route);\n    debug('found %o query parameters', queryParameters.length);\n\n    const parameters = [...pathParameters, ...queryParameters];\n    debug('assembled %o parameters for %o %o', parameters.length, route.method, route.path);\n\n    context.output.data.parameters = parameters;\n  }\n\n  private _getPathParameters(route: Core.Route): PathParameterObject[] {\n    const { params } = route.request ?? {};\n\n    // TODO: Allow auto inference (from path) if enabled through configuration\n    if (!params) {\n      return [];\n    }\n\n    const pathParams: PathParameterObject[] = [];\n\n    for (const [name, zodSchema] of Object.entries(params)) {\n      const required = !zodSchema.isOptional();\n      const schema = zodToOpenAPI(zodSchema) as any;\n\n      pathParams.push({ name, in: 'path', required, schema });\n    }\n\n    return pathParams;\n  }\n\n  private _getQueryParameters(route: Core.Route): QueryParameterObject[] {\n    const { query } = route.request ?? {};\n\n    if (!query) {\n      return [];\n    }\n\n    const queryParams: QueryParameterObject[] = [];\n\n    for (const [name, zodSchema] of Object.entries(query)) {\n      const required = !zodSchema.isOptional();\n      const schema = zodToOpenAPI(zodSchema) as any;\n      const param: QueryParameterObject = { name, in: 'query', required, schema };\n\n      // In Strapi, query params are always interpreted as query strings, which isn't supported by the specification\n      // TODO: Make that configurable somehow\n      Object.assign(param, { 'x-strapi-serialize': 'querystring' });\n\n      queryParams.push(param);\n    }\n\n    return queryParams;\n  }\n}\n"],"names":["debug","createDebugger","OperationParametersAssembler","assemble","context","route","method","path","pathParameters","_getPathParameters","length","queryParameters","_getQueryParameters","parameters","output","data","params","request","pathParams","name","zodSchema","Object","entries","required","isOptional","schema","zodToOpenAPI","push","in","query","queryParams","param","assign"],"mappings":";;;;;AAOA,MAAMA,QAAQC,sBAAe,CAAA,sBAAA,CAAA;AAKtB,MAAMC,4BAAAA,CAAAA;IACXC,QAASC,CAAAA,OAAyB,EAAEC,KAAiB,EAAQ;AAC3DL,QAAAA,KAAAA,CAAM,oCAAsCK,EAAAA,KAAAA,CAAMC,MAAM,EAAED,MAAME,IAAI,CAAA;AAEpE,QAAA,MAAMC,cAAiB,GAAA,IAAI,CAACC,kBAAkB,CAACJ,KAAAA,CAAAA;QAC/CL,KAAM,CAAA,0BAAA,EAA4BQ,eAAeE,MAAM,CAAA;AAEvD,QAAA,MAAMC,eAAkB,GAAA,IAAI,CAACC,mBAAmB,CAACP,KAAAA,CAAAA;QACjDL,KAAM,CAAA,2BAAA,EAA6BW,gBAAgBD,MAAM,CAAA;AAEzD,QAAA,MAAMG,UAAa,GAAA;AAAIL,YAAAA,GAAAA,cAAAA;AAAmBG,YAAAA,GAAAA;AAAgB,SAAA;QAC1DX,KAAM,CAAA,mCAAA,EAAqCa,WAAWH,MAAM,EAAEL,MAAMC,MAAM,EAAED,MAAME,IAAI,CAAA;AAEtFH,QAAAA,OAAAA,CAAQU,MAAM,CAACC,IAAI,CAACF,UAAU,GAAGA,UAAAA;AACnC;AAEQJ,IAAAA,kBAAAA,CAAmBJ,KAAiB,EAAyB;AACnE,QAAA,MAAM,EAAEW,MAAM,EAAE,GAAGX,KAAMY,CAAAA,OAAO,IAAI,EAAC;;AAGrC,QAAA,IAAI,CAACD,MAAQ,EAAA;AACX,YAAA,OAAO,EAAE;AACX;AAEA,QAAA,MAAME,aAAoC,EAAE;QAE5C,KAAK,MAAM,CAACC,IAAMC,EAAAA,SAAAA,CAAU,IAAIC,MAAOC,CAAAA,OAAO,CAACN,MAAS,CAAA,CAAA;YACtD,MAAMO,QAAAA,GAAW,CAACH,SAAAA,CAAUI,UAAU,EAAA;AACtC,YAAA,MAAMC,SAASC,gBAAaN,CAAAA,SAAAA,CAAAA;AAE5BF,YAAAA,UAAAA,CAAWS,IAAI,CAAC;AAAER,gBAAAA,IAAAA;gBAAMS,EAAI,EAAA,MAAA;AAAQL,gBAAAA,QAAAA;AAAUE,gBAAAA;AAAO,aAAA,CAAA;AACvD;QAEA,OAAOP,UAAAA;AACT;AAEQN,IAAAA,mBAAAA,CAAoBP,KAAiB,EAA0B;AACrE,QAAA,MAAM,EAAEwB,KAAK,EAAE,GAAGxB,KAAMY,CAAAA,OAAO,IAAI,EAAC;AAEpC,QAAA,IAAI,CAACY,KAAO,EAAA;AACV,YAAA,OAAO,EAAE;AACX;AAEA,QAAA,MAAMC,cAAsC,EAAE;QAE9C,KAAK,MAAM,CAACX,IAAMC,EAAAA,SAAAA,CAAU,IAAIC,MAAOC,CAAAA,OAAO,CAACO,KAAQ,CAAA,CAAA;YACrD,MAAMN,QAAAA,GAAW,CAACH,SAAAA,CAAUI,UAAU,EAAA;AACtC,YAAA,MAAMC,SAASC,gBAAaN,CAAAA,SAAAA,CAAAA;AAC5B,YAAA,MAAMW,KAA8B,GAAA;AAAEZ,gBAAAA,IAAAA;gBAAMS,EAAI,EAAA,OAAA;AAASL,gBAAAA,QAAAA;AAAUE,gBAAAA;AAAO,aAAA;;;YAI1EJ,MAAOW,CAAAA,MAAM,CAACD,KAAO,EAAA;gBAAE,oBAAsB,EAAA;AAAc,aAAA,CAAA;AAE3DD,YAAAA,WAAAA,CAAYH,IAAI,CAACI,KAAAA,CAAAA;AACnB;QAEA,OAAOD,WAAAA;AACT;AACF;;;;"}

package/dist/assemblers/document/path/path-item/operation/parameters.mjs

@@ -0,0 +1,65 @@
+import { createDebugger } from '../../../../../utils/debug.mjs';
+import { zodToOpenAPI } from '../../../../../utils/zod.mjs';
+
+const debug = createDebugger('assembler:parameters');
+class OperationParametersAssembler {
+    assemble(context, route) {
+        debug('assembling parameters for %o %o...', route.method, route.path);
+        const pathParameters = this._getPathParameters(route);
+        debug('found %o path parameters', pathParameters.length);
+        const queryParameters = this._getQueryParameters(route);
+        debug('found %o query parameters', queryParameters.length);
+        const parameters = [
+            ...pathParameters,
+            ...queryParameters
+        ];
+        debug('assembled %o parameters for %o %o', parameters.length, route.method, route.path);
+        context.output.data.parameters = parameters;
+    }
+    _getPathParameters(route) {
+        const { params } = route.request ?? {};
+        // TODO: Allow auto inference (from path) if enabled through configuration
+        if (!params) {
+            return [];
+        }
+        const pathParams = [];
+        for (const [name, zodSchema] of Object.entries(params)){
+            const required = !zodSchema.isOptional();
+            const schema = zodToOpenAPI(zodSchema);
+            pathParams.push({
+                name,
+                in: 'path',
+                required,
+                schema
+            });
+        }
+        return pathParams;
+    }
+    _getQueryParameters(route) {
+        const { query } = route.request ?? {};
+        if (!query) {
+            return [];
+        }
+        const queryParams = [];
+        for (const [name, zodSchema] of Object.entries(query)){
+            const required = !zodSchema.isOptional();
+            const schema = zodToOpenAPI(zodSchema);
+            const param = {
+                name,
+                in: 'query',
+                required,
+                schema
+            };
+            // In Strapi, query params are always interpreted as query strings, which isn't supported by the specification
+            // TODO: Make that configurable somehow
+            Object.assign(param, {
+                'x-strapi-serialize': 'querystring'
+            });
+            queryParams.push(param);
+        }
+        return queryParams;
+    }
+}
+
+export { OperationParametersAssembler };
+//# sourceMappingURL=parameters.mjs.map

package/dist/assemblers/document/path/path-item/operation/parameters.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.mjs","sources":["../../../../../../src/assemblers/document/path/path-item/operation/parameters.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\nimport type { OpenAPIV3_1 } from 'openapi-types';\nimport type { Assembler } from '../../../..';\n\nimport type { OperationContext } from '../../../../../types';\nimport { createDebugger, zodToOpenAPI } from '../../../../../utils';\n\nconst debug = createDebugger('assembler:parameters');\n\ntype PathParameterObject = OpenAPIV3_1.ParameterObject & { in: 'path' };\ntype QueryParameterObject = OpenAPIV3_1.ParameterObject & { in: 'query' };\n\nexport class OperationParametersAssembler implements Assembler.Operation {\n  assemble(context: OperationContext, route: Core.Route): void {\n    debug('assembling parameters for %o %o...', route.method, route.path);\n\n    const pathParameters = this._getPathParameters(route);\n    debug('found %o path parameters', pathParameters.length);\n\n    const queryParameters = this._getQueryParameters(route);\n    debug('found %o query parameters', queryParameters.length);\n\n    const parameters = [...pathParameters, ...queryParameters];\n    debug('assembled %o parameters for %o %o', parameters.length, route.method, route.path);\n\n    context.output.data.parameters = parameters;\n  }\n\n  private _getPathParameters(route: Core.Route): PathParameterObject[] {\n    const { params } = route.request ?? {};\n\n    // TODO: Allow auto inference (from path) if enabled through configuration\n    if (!params) {\n      return [];\n    }\n\n    const pathParams: PathParameterObject[] = [];\n\n    for (const [name, zodSchema] of Object.entries(params)) {\n      const required = !zodSchema.isOptional();\n      const schema = zodToOpenAPI(zodSchema) as any;\n\n      pathParams.push({ name, in: 'path', required, schema });\n    }\n\n    return pathParams;\n  }\n\n  private _getQueryParameters(route: Core.Route): QueryParameterObject[] {\n    const { query } = route.request ?? {};\n\n    if (!query) {\n      return [];\n    }\n\n    const queryParams: QueryParameterObject[] = [];\n\n    for (const [name, zodSchema] of Object.entries(query)) {\n      const required = !zodSchema.isOptional();\n      const schema = zodToOpenAPI(zodSchema) as any;\n      const param: QueryParameterObject = { name, in: 'query', required, schema };\n\n      // In Strapi, query params are always interpreted as query strings, which isn't supported by the specification\n      // TODO: Make that configurable somehow\n      Object.assign(param, { 'x-strapi-serialize': 'querystring' });\n\n      queryParams.push(param);\n    }\n\n    return queryParams;\n  }\n}\n"],"names":["debug","createDebugger","OperationParametersAssembler","assemble","context","route","method","path","pathParameters","_getPathParameters","length","queryParameters","_getQueryParameters","parameters","output","data","params","request","pathParams","name","zodSchema","Object","entries","required","isOptional","schema","zodToOpenAPI","push","in","query","queryParams","param","assign"],"mappings":";;;AAOA,MAAMA,QAAQC,cAAe,CAAA,sBAAA,CAAA;AAKtB,MAAMC,4BAAAA,CAAAA;IACXC,QAASC,CAAAA,OAAyB,EAAEC,KAAiB,EAAQ;AAC3DL,QAAAA,KAAAA,CAAM,oCAAsCK,EAAAA,KAAAA,CAAMC,MAAM,EAAED,MAAME,IAAI,CAAA;AAEpE,QAAA,MAAMC,cAAiB,GAAA,IAAI,CAACC,kBAAkB,CAACJ,KAAAA,CAAAA;QAC/CL,KAAM,CAAA,0BAAA,EAA4BQ,eAAeE,MAAM,CAAA;AAEvD,QAAA,MAAMC,eAAkB,GAAA,IAAI,CAACC,mBAAmB,CAACP,KAAAA,CAAAA;QACjDL,KAAM,CAAA,2BAAA,EAA6BW,gBAAgBD,MAAM,CAAA;AAEzD,QAAA,MAAMG,UAAa,GAAA;AAAIL,YAAAA,GAAAA,cAAAA;AAAmBG,YAAAA,GAAAA;AAAgB,SAAA;QAC1DX,KAAM,CAAA,mCAAA,EAAqCa,WAAWH,MAAM,EAAEL,MAAMC,MAAM,EAAED,MAAME,IAAI,CAAA;AAEtFH,QAAAA,OAAAA,CAAQU,MAAM,CAACC,IAAI,CAACF,UAAU,GAAGA,UAAAA;AACnC;AAEQJ,IAAAA,kBAAAA,CAAmBJ,KAAiB,EAAyB;AACnE,QAAA,MAAM,EAAEW,MAAM,EAAE,GAAGX,KAAMY,CAAAA,OAAO,IAAI,EAAC;;AAGrC,QAAA,IAAI,CAACD,MAAQ,EAAA;AACX,YAAA,OAAO,EAAE;AACX;AAEA,QAAA,MAAME,aAAoC,EAAE;QAE5C,KAAK,MAAM,CAACC,IAAMC,EAAAA,SAAAA,CAAU,IAAIC,MAAOC,CAAAA,OAAO,CAACN,MAAS,CAAA,CAAA;YACtD,MAAMO,QAAAA,GAAW,CAACH,SAAAA,CAAUI,UAAU,EAAA;AACtC,YAAA,MAAMC,SAASC,YAAaN,CAAAA,SAAAA,CAAAA;AAE5BF,YAAAA,UAAAA,CAAWS,IAAI,CAAC;AAAER,gBAAAA,IAAAA;gBAAMS,EAAI,EAAA,MAAA;AAAQL,gBAAAA,QAAAA;AAAUE,gBAAAA;AAAO,aAAA,CAAA;AACvD;QAEA,OAAOP,UAAAA;AACT;AAEQN,IAAAA,mBAAAA,CAAoBP,KAAiB,EAA0B;AACrE,QAAA,MAAM,EAAEwB,KAAK,EAAE,GAAGxB,KAAMY,CAAAA,OAAO,IAAI,EAAC;AAEpC,QAAA,IAAI,CAACY,KAAO,EAAA;AACV,YAAA,OAAO,EAAE;AACX;AAEA,QAAA,MAAMC,cAAsC,EAAE;QAE9C,KAAK,MAAM,CAACX,IAAMC,EAAAA,SAAAA,CAAU,IAAIC,MAAOC,CAAAA,OAAO,CAACO,KAAQ,CAAA,CAAA;YACrD,MAAMN,QAAAA,GAAW,CAACH,SAAAA,CAAUI,UAAU,EAAA;AACtC,YAAA,MAAMC,SAASC,YAAaN,CAAAA,SAAAA,CAAAA;AAC5B,YAAA,MAAMW,KAA8B,GAAA;AAAEZ,gBAAAA,IAAAA;gBAAMS,EAAI,EAAA,OAAA;AAASL,gBAAAA,QAAAA;AAAUE,gBAAAA;AAAO,aAAA;;;YAI1EJ,MAAOW,CAAAA,MAAM,CAACD,KAAO,EAAA;gBAAE,oBAAsB,EAAA;AAAc,aAAA,CAAA;AAE3DD,YAAAA,WAAAA,CAAYH,IAAI,CAACI,KAAAA,CAAAA;AACnB;QAEA,OAAOD,WAAAA;AACT;AACF;;;;"}

package/dist/assemblers/document/path/path-item/operation/responses.d.ts

@@ -0,0 +1,8 @@
+import type { Core } from '@strapi/types';
+import type { Assembler } from '../../../..';
+import type { OperationContext } from '../../../../../types';
+export declare class OperationResponsesAssembler implements Assembler.Operation {
+    private get _errors();
+    assemble(context: OperationContext, route: Core.Route): void;
+}
+//# sourceMappingURL=responses.d.ts.map

package/dist/assemblers/document/path/path-item/operation/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../../../src/assemblers/document/path/path-item/operation/responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAG7D,qBAAa,2BAA4B,YAAW,SAAS,CAAC,SAAS;IACrE,OAAO,KAAK,OAAO,GAQlB;IAED,QAAQ,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI;CAqB7D"}

package/dist/assemblers/document/path/path-item/operation/responses.js

@@ -0,0 +1,51 @@
+'use strict';
+
+require('debug');
+var zod = require('../../../../../utils/zod.js');
+
+class OperationResponsesAssembler {
+    get _errors() {
+        return {
+            400: {
+                description: 'Bad request'
+            },
+            401: {
+                description: 'Unauthorized'
+            },
+            403: {
+                description: 'Forbidden'
+            },
+            404: {
+                description: 'Not found'
+            },
+            500: {
+                description: 'Internal server error'
+            }
+        };
+    }
+    assemble(context, route) {
+        const { output } = context;
+        const responses = {
+            ...output.data.responses
+        };
+        // Register common error responses first to allow manual overrides
+        for (const [errorCode, response] of Object.entries(this._errors)){
+            responses[errorCode] = response;
+        }
+        if (route.response) {
+            const schema = zod.zodToOpenAPI(route.response);
+            responses[200] = {
+                description: 'OK',
+                content: {
+                    'application/json': {
+                        schema
+                    }
+                }
+            };
+        }
+        output.data.responses = responses;
+    }
+}
+
+exports.OperationResponsesAssembler = OperationResponsesAssembler;
+//# sourceMappingURL=responses.js.map

package/dist/assemblers/document/path/path-item/operation/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.js","sources":["../../../../../../src/assemblers/document/path/path-item/operation/responses.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\nimport type { OpenAPIV3_1 } from 'openapi-types';\nimport type { Assembler } from '../../../..';\nimport type { OperationContext } from '../../../../../types';\nimport { zodToOpenAPI } from '../../../../../utils';\n\nexport class OperationResponsesAssembler implements Assembler.Operation {\n  private get _errors() {\n    return {\n      400: { description: 'Bad request' },\n      401: { description: 'Unauthorized' },\n      403: { description: 'Forbidden' },\n      404: { description: 'Not found' },\n      500: { description: 'Internal server error' },\n    };\n  }\n\n  assemble(context: OperationContext, route: Core.Route): void {\n    const { output } = context;\n\n    const responses = { ...output.data.responses } satisfies OpenAPIV3_1.ResponsesObject;\n\n    // Register common error responses first to allow manual overrides\n    for (const [errorCode, response] of Object.entries(this._errors)) {\n      responses[errorCode] = response;\n    }\n\n    if (route.response) {\n      const schema = zodToOpenAPI(route.response);\n\n      responses[200] = {\n        description: 'OK',\n        content: { 'application/json': { schema } },\n      };\n    }\n\n    output.data.responses = responses;\n  }\n}\n"],"names":["OperationResponsesAssembler","_errors","description","assemble","context","route","output","responses","data","errorCode","response","Object","entries","schema","zodToOpenAPI","content"],"mappings":";;;;;AAMO,MAAMA,2BAAAA,CAAAA;AACX,IAAA,IAAYC,OAAU,GAAA;QACpB,OAAO;YACL,GAAK,EAAA;gBAAEC,WAAa,EAAA;AAAc,aAAA;YAClC,GAAK,EAAA;gBAAEA,WAAa,EAAA;AAAe,aAAA;YACnC,GAAK,EAAA;gBAAEA,WAAa,EAAA;AAAY,aAAA;YAChC,GAAK,EAAA;gBAAEA,WAAa,EAAA;AAAY,aAAA;YAChC,GAAK,EAAA;gBAAEA,WAAa,EAAA;AAAwB;AAC9C,SAAA;AACF;IAEAC,QAASC,CAAAA,OAAyB,EAAEC,KAAiB,EAAQ;QAC3D,MAAM,EAAEC,MAAM,EAAE,GAAGF,OAAAA;AAEnB,QAAA,MAAMG,SAAY,GAAA;YAAE,GAAGD,MAAAA,CAAOE,IAAI,CAACD;AAAU,SAAA;;QAG7C,KAAK,MAAM,CAACE,SAAAA,EAAWC,QAAS,CAAA,IAAIC,MAAOC,CAAAA,OAAO,CAAC,IAAI,CAACX,OAAO,CAAG,CAAA;YAChEM,SAAS,CAACE,UAAU,GAAGC,QAAAA;AACzB;QAEA,IAAIL,KAAAA,CAAMK,QAAQ,EAAE;YAClB,MAAMG,MAAAA,GAASC,gBAAaT,CAAAA,KAAAA,CAAMK,QAAQ,CAAA;YAE1CH,SAAS,CAAC,IAAI,GAAG;gBACfL,WAAa,EAAA,IAAA;gBACba,OAAS,EAAA;oBAAE,kBAAoB,EAAA;AAAEF,wBAAAA;AAAO;AAAE;AAC5C,aAAA;AACF;QAEAP,MAAOE,CAAAA,IAAI,CAACD,SAAS,GAAGA,SAAAA;AAC1B;AACF;;;;"}