@skmtc/core 0.0.225 → 0.0.227

package/script/oas/operation/Operation.d.ts

@@ -0,0 +1,52 @@
+import { OasBase } from '../../oas-elements/OasBase.js';
+import type { CoreContext } from '../../context/CoreContext.js';
+import type { Trail } from '../../context/Trail.js';
+import type { Method } from '../../types/Method.js';
+import type { OasPathItem } from '../pathItem/PathItem.js';
+import type { OasParameter } from '../parameter/Parameter.js';
+import type { OasRequestBody } from '../requestBody/RequestBody.js';
+import type { OasResponse } from '../response/Response.js';
+import type { OasParameterLocation } from '../parameter/parameter-types.js';
+import type { OasSchema } from '../schema/Schema.js';
+import type { OasRef } from '../ref/Ref.js';
+export type OperationFields = {
+    path: string;
+    method: Method;
+    pathItem: OasPathItem;
+    operationId: string | undefined;
+    summary: string | undefined;
+    tags: string[] | undefined;
+    description: string | undefined;
+    parameters: (OasParameter | OasRef<'parameter'>)[] | undefined;
+    requestBody: OasRequestBody | OasRef<'requestBody'> | undefined;
+    responses: Record<string, OasResponse | OasRef<'response'>>;
+    deprecated: boolean | undefined;
+};
+type ToOperationV3Args = {
+    fields: OperationFields;
+    trail: Trail;
+    context: CoreContext;
+    skipped: Record<string, unknown>;
+};
+/** Operation represents a resource path and a method that can be executed against it */
+export declare class OasOperation extends OasBase {
+    oasType: 'operation';
+    fields: OperationFields;
+    constructor({ fields, trail, skipped, context }: ToOperationV3Args);
+    toSuccessResponse(): OasResponse | OasRef<'response'>;
+    toRequestBody(mediaType?: string): OasSchema | OasRef<'schema'> | undefined;
+    toParams(filter: OasParameterLocation[]): OasParameter[];
+    get path(): string;
+    get method(): Method;
+    get pathItem(): OasPathItem;
+    get operationId(): string | undefined;
+    get summary(): string | undefined;
+    get tags(): string[] | undefined;
+    get description(): string | undefined;
+    get parameters(): (OasParameter | OasRef<'parameter'>)[] | undefined;
+    get requestBody(): OasRequestBody | OasRef<'requestBody'> | undefined;
+    get responses(): Record<string, OasResponse | OasRef<'response'>>;
+    get deprecated(): boolean | undefined;
+}
+export {};
+//# sourceMappingURL=Operation.d.ts.map

package/script/oas/operation/Operation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Operation.d.ts","sourceRoot":"","sources":["../../../src/oas/operation/Operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAC/D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,WAAW,CAAA;IACrB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC1B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,WAAW,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAC/D,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;CAChC,CAAA;AAED,KAAK,iBAAiB,GAAG;IACvB,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACjC,CAAA;AACD,wFAAwF;AACxF,qBAAa,YAAa,SAAQ,OAAO;IACvC,OAAO,EAAE,WAAW,CAAc;IAClC,MAAM,EAAE,eAAe,CAAA;gBAEX,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,iBAAiB;IAMlE,iBAAiB,IAAI,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;IAWrD,aAAa,CACX,SAAS,SAAqB,GAC7B,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAI3C,QAAQ,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,YAAY,EAAE;IAQxD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,QAAQ,IAAI,WAAW,CAE1B;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED,IAAI,IAAI,IAAI,MAAM,EAAE,GAAG,SAAS,CAE/B;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,UAAU,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAEnE;IAED,IAAI,WAAW,IAAI,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAEpE;IAED,IAAI,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAEhE;IAED,IAAI,UAAU,IAAI,OAAO,GAAG,SAAS,CAEpC;CACF"}

package/script/oas/operation/Operation.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasOperation = void 0;
+const OasBase_js_1 = require("../../oas-elements/OasBase.js");
+/** Operation represents a resource path and a method that can be executed against it */
+class OasOperation extends OasBase_js_1.OasBase {
+    constructor({ fields, trail, skipped, context }) {
+        super({ trail, skipped, context });
+        Object.defineProperty(this, "oasType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'operation'
+        });
+        Object.defineProperty(this, "fields", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.fields = fields;
+    }
+    toSuccessResponse() {
+        const { default: defaultResponse, ...httpCodeResponses } = this.responses;
+        const successCode = Object.keys(httpCodeResponses)
+            .map(httpCode => parseInt(httpCode))
+            .sort((a, b) => a - b)
+            .find(httpCode => httpCode >= 200 && httpCode < 300);
+        return successCode ? httpCodeResponses[successCode] : defaultResponse;
+    }
+    toRequestBody(mediaType = 'application/json') {
+        return this.requestBody?.resolve().content[mediaType]?.schema;
+    }
+    toParams(filter) {
+        return (this.parameters
+            ?.map(param => param.resolve())
+            .filter(param => filter.includes(param.location)) ?? []);
+    }
+    get path() {
+        return this.fields.path;
+    }
+    get method() {
+        return this.fields.method;
+    }
+    get pathItem() {
+        return this.fields.pathItem;
+    }
+    get operationId() {
+        return this.fields.operationId;
+    }
+    get summary() {
+        return this.fields.summary;
+    }
+    get tags() {
+        return this.fields.tags;
+    }
+    get description() {
+        return this.fields.description;
+    }
+    get parameters() {
+        return this.fields.parameters;
+    }
+    get requestBody() {
+        return this.fields.requestBody;
+    }
+    get responses() {
+        return this.fields.responses;
+    }
+    get deprecated() {
+        return this.fields.deprecated;
+    }
+}
+exports.OasOperation = OasOperation;

package/script/oas/operation/toOperationsV3.d.ts

@@ -0,0 +1,26 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import type { Method } from '../../types/Method.js';
+import type { CoreContext } from '../../context/CoreContext.js';
+import type { Trail } from '../../context/Trail.js';
+import { OasOperation } from './Operation.js';
+import type { OasPathItem } from '../pathItem/PathItem.js';
+type OperationInfo = {
+    method: Method;
+    path: string;
+    pathItem: OasPathItem;
+};
+type ToOperationV3Args = {
+    operation: OpenAPIV3.OperationObject;
+    operationInfo: OperationInfo;
+    trail: Trail;
+    context: CoreContext;
+};
+export declare const toOperationV3: ({ operation, operationInfo, trail, context }: ToOperationV3Args) => OasOperation;
+type ToOperationsV3Args = {
+    paths: OpenAPIV3.PathsObject;
+    trail: Trail;
+    context: CoreContext;
+};
+export declare const toOperationsV3: ({ paths, trail, context }: ToOperationsV3Args) => OasOperation[];
+export {};
+//# sourceMappingURL=toOperationsV3.d.ts.map

package/script/oas/operation/toOperationsV3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toOperationsV3.d.ts","sourceRoot":"","sources":["../../../src/oas/operation/toOperationsV3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAI/D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAG7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAE1D,KAAK,aAAa,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,WAAW,CAAA;CACtB,CAAA;AAED,KAAK,iBAAiB,GAAG;IACvB,SAAS,EAAE,SAAS,CAAC,eAAe,CAAA;IACpC,aAAa,EAAE,aAAa,CAAA;IAC5B,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,aAAa,iDAKvB,iBAAiB,KAAG,YAyCtB,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,KAAK,EAAE,SAAS,CAAC,WAAW,CAAA;IAC5B,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,cAAc,8BAIxB,kBAAkB,KAAG,YAAY,EAsDnC,CAAA"}

package/script/oas/operation/toOperationsV3.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toOperationsV3 = exports.toOperationV3 = void 0;
+const toRequestBodiesV3_js_1 = require("../requestBody/toRequestBodiesV3.js");
+const toResponseV3_js_1 = require("../response/toResponseV3.js");
+const toParameterV3_js_1 = require("../parameter/toParameterV3.js");
+const Operation_js_1 = require("./Operation.js");
+const toPathItemV3_js_1 = require("../pathItem/toPathItemV3.js");
+const toOperationV3 = ({ operation, operationInfo, trail, context }) => {
+    const { method, path, pathItem } = operationInfo;
+    const { operationId, tags, summary, description, parameters, requestBody, responses, deprecated, ...skipped } = operation;
+    const fields = {
+        pathItem,
+        path,
+        method,
+        operationId,
+        summary,
+        tags,
+        description,
+        parameters: (0, toParameterV3_js_1.toParameterListV3)({
+            parameters,
+            trail: trail.add('parameters'),
+            context
+        }),
+        requestBody: (0, toRequestBodiesV3_js_1.toRequestBodyV3)({
+            requestBody,
+            trail: trail.add('requestBody'),
+            context
+        }),
+        responses: (0, toResponseV3_js_1.toResponsesV3)({
+            responses,
+            trail: trail.add('responses'),
+            context
+        }),
+        deprecated
+    };
+    return new Operation_js_1.OasOperation({ fields, trail, context, skipped });
+};
+exports.toOperationV3 = toOperationV3;
+const toOperationsV3 = ({ paths, trail, context }) => {
+    return Object.entries(paths).flatMap(([path, pathItem]) => {
+        if (!pathItem) {
+            return [];
+        }
+        const { get, post, put, delete: deleteMethod, options, head, patch, trace, ...rest } = pathItem;
+        const pathItemObject = (0, toPathItemV3_js_1.toPathItemV3)({
+            pathItem: rest,
+            trail: trail.addApiPath(path),
+            context
+        });
+        const methodObjects = {
+            get,
+            post,
+            put,
+            delete: deleteMethod,
+            options,
+            head,
+            patch,
+            trace
+        };
+        return Object.entries(methodObjects)
+            .map(([method, operation]) => {
+            if (!operation) {
+                return;
+            }
+            return (0, exports.toOperationV3)({
+                operation,
+                operationInfo: {
+                    method: method,
+                    path,
+                    pathItem: pathItemObject
+                },
+                trail: trail.addApiPath(path).addMethod(method),
+                context
+            });
+        })
+            .filter((item) => Boolean(item));
+    });
+};
+exports.toOperationsV3 = toOperationsV3;

package/script/oas/parameter/Parameter.d.ts

@@ -0,0 +1,51 @@
+import { OasBase } from '../../oas-elements/OasBase.js';
+import type { OasParameterLocation, OasParameterStyle } from './parameter-types.js';
+import type { Trail } from '../../context/Trail.js';
+import type { CoreContext } from '../../context/CoreContext.js';
+import type { OasMediaType } from '../mediaType/MediaType.js';
+import type { OasRef } from '../ref/Ref.js';
+import type { OasExample } from '../example/Example.js';
+import type { OasSchema } from '../schema/Schema.js';
+export type ParameterFields = {
+    name: string;
+    location: OasParameterLocation;
+    description: string | undefined;
+    required: boolean | undefined;
+    deprecated: boolean | undefined;
+    allowEmptyValue: boolean | undefined;
+    allowReserved: boolean | undefined;
+    schema: OasSchema | OasRef<'schema'> | undefined;
+    examples: Record<string, OasExample | OasRef<'example'>> | undefined;
+    content: Record<string, OasMediaType> | undefined;
+    style: OasParameterStyle;
+    explode: boolean;
+};
+type ToParameterV3Args = {
+    fields: ParameterFields;
+    trail: Trail;
+    skipped: Record<string, unknown>;
+    context: CoreContext;
+};
+export declare class OasParameter extends OasBase {
+    oasType: 'parameter';
+    fields: ParameterFields;
+    constructor({ fields, trail, skipped, context }: ToParameterV3Args);
+    get name(): string;
+    get location(): OasParameterLocation;
+    get description(): string | undefined;
+    get required(): boolean | undefined;
+    get deprecated(): boolean | undefined;
+    get allowEmptyValue(): boolean | undefined;
+    get schema(): OasSchema | OasRef<'schema'> | undefined;
+    get examples(): Record<string, OasExample | OasRef<'example'>> | undefined;
+    get content(): Record<string, OasMediaType> | undefined;
+    get style(): OasParameterStyle;
+    get explode(): boolean;
+    get allowReserved(): boolean | undefined;
+    isRef(): this is OasRef<'parameter'>;
+    resolve(): OasParameter;
+    resolveOnce(): OasParameter;
+    toSchema(mediaType?: string): OasSchema | OasRef<'schema'> | undefined;
+}
+export {};
+//# sourceMappingURL=Parameter.d.ts.map

package/script/oas/parameter/Parameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Parameter.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/Parameter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AACvD,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAKpD,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,eAAe,EAAE,OAAO,GAAG,SAAS,CAAA;IACpC,aAAa,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IACjD,KAAK,EAAE,iBAAiB,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,KAAK,iBAAiB,GAAG;IACvB,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,qBAAa,YAAa,SAAQ,OAAO;IACvC,OAAO,EAAE,WAAW,CAAc;IAClC,MAAM,EAAE,eAAe,CAAA;gBAEX,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,iBAAiB;IAMlE,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,QAAQ,IAAI,oBAAoB,CAEnC;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,QAAQ,IAAI,OAAO,GAAG,SAAS,CAElC;IAED,IAAI,UAAU,IAAI,OAAO,GAAG,SAAS,CAEpC;IAED,IAAI,eAAe,IAAI,OAAO,GAAG,SAAS,CAEzC;IAED,IAAI,MAAM,IAAI,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAErD;IAED,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAEzE;IAED,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAEtD;IAED,IAAI,KAAK,IAAI,iBAAiB,CAE7B;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,IAAI,aAAa,IAAI,OAAO,GAAG,SAAS,CAEvC;IAED,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC;IAIpC,OAAO,IAAI,YAAY;IAIvB,WAAW,IAAI,YAAY;IAI3B,QAAQ,CACN,SAAS,GAAE,MAA2B,GACrC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;CAO5C"}

package/script/oas/parameter/Parameter.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasParameter = void 0;
+const OasBase_js_1 = require("../../oas-elements/OasBase.js");
+class OasParameter extends OasBase_js_1.OasBase {
+    constructor({ fields, trail, skipped, context }) {
+        super({ trail, skipped, context });
+        Object.defineProperty(this, "oasType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'parameter'
+        });
+        Object.defineProperty(this, "fields", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.fields = fields;
+    }
+    get name() {
+        return this.fields.name;
+    }
+    get location() {
+        return this.fields.location;
+    }
+    get description() {
+        return this.fields.description;
+    }
+    get required() {
+        return this.fields.required;
+    }
+    get deprecated() {
+        return this.fields.deprecated;
+    }
+    get allowEmptyValue() {
+        return this.fields.allowEmptyValue;
+    }
+    get schema() {
+        return this.fields.schema;
+    }
+    get examples() {
+        return this.fields.examples;
+    }
+    get content() {
+        return this.fields.content;
+    }
+    get style() {
+        return this.fields.style;
+    }
+    get explode() {
+        return this.fields.explode;
+    }
+    get allowReserved() {
+        return this.fields.allowReserved;
+    }
+    isRef() {
+        return false;
+    }
+    resolve() {
+        return this;
+    }
+    resolveOnce() {
+        return this;
+    }
+    toSchema(mediaType = 'application/json') {
+        if (this.schema) {
+            return this.schema;
+        }
+        return this.fields.content?.[mediaType]?.schema;
+    }
+}
+exports.OasParameter = OasParameter;

package/script/oas/parameter/parameter-types.d.ts

@@ -0,0 +1,26 @@
+import { type OasExampleData } from '../example/example-types.js';
+import { type OasMediaTypeData } from '../mediaType/mediaType-types.js';
+import { type OasExampleRefData, type OasSchemaRefData } from '../ref/ref-types.js';
+import { type OasSchemaData } from '../schema/schema-types.js';
+import { z } from 'zod';
+export type OasParameterLocation = 'query' | 'header' | 'path' | 'cookie';
+export declare const oasParameterLocation: z.ZodType<OasParameterLocation>;
+export type OasParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
+export declare const oasParameterStyle: z.ZodType<OasParameterStyle>;
+export type OasParameterData = {
+    oasType: 'parameter';
+    allowEmptyValue?: boolean;
+    allowReserved?: boolean;
+    content?: Record<string, OasMediaTypeData>;
+    deprecated?: boolean;
+    description?: string;
+    examples?: Record<string, OasExampleData | OasExampleRefData>;
+    explode: boolean;
+    location: OasParameterLocation;
+    name: string;
+    required?: boolean;
+    schema?: OasSchemaData | OasSchemaRefData;
+    style: OasParameterStyle;
+};
+export declare const oasParameterData: z.ZodType<OasParameterData>;
+//# sourceMappingURL=parameter-types.d.ts.map

package/script/oas/parameter/parameter-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter-types.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/parameter-types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EAEpB,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EACL,KAAK,gBAAgB,EAEtB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEzE,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAK/D,CAAA;AAEF,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,eAAe,GACf,YAAY,CAAA;AAEhB,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAQzD,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,WAAW,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB,CAAC,CAAA;IAC7D,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,aAAa,GAAG,gBAAgB,CAAA;IACzC,KAAK,EAAE,iBAAiB,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAgBvD,CAAA"}

package/script/oas/parameter/parameter-types.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.oasParameterData = exports.oasParameterStyle = exports.oasParameterLocation = void 0;
+const example_types_js_1 = require("../example/example-types.js");
+const markdown_types_js_1 = require("../markdown/markdown-types.js");
+const mediaType_types_js_1 = require("../mediaType/mediaType-types.js");
+const ref_types_js_1 = require("../ref/ref-types.js");
+const schema_types_js_1 = require("../schema/schema-types.js");
+const zod_1 = require("zod");
+exports.oasParameterLocation = zod_1.z.enum([
+    'query',
+    'header',
+    'path',
+    'cookie'
+]);
+exports.oasParameterStyle = zod_1.z.enum([
+    'matrix',
+    'label',
+    'form',
+    'simple',
+    'spaceDelimited',
+    'pipeDelimited',
+    'deepObject'
+]);
+exports.oasParameterData = zod_1.z.object({
+    oasType: zod_1.z.literal('parameter'),
+    // Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.
+    // example: z.any().optional(),
+    allowReserved: zod_1.z.boolean().optional(),
+    allowEmptyValue: zod_1.z.boolean().optional(),
+    content: zod_1.z.record(mediaType_types_js_1.oasMediaTypeData).optional(),
+    deprecated: zod_1.z.boolean().optional(),
+    description: markdown_types_js_1.markdown.optional(),
+    examples: zod_1.z.record(zod_1.z.union([example_types_js_1.oasExampleData, ref_types_js_1.oasExampleRefData])).optional(),
+    explode: zod_1.z.boolean(),
+    location: exports.oasParameterLocation,
+    name: zod_1.z.string(),
+    required: zod_1.z.boolean().optional(),
+    schema: zod_1.z.union([schema_types_js_1.oasSchemaData, ref_types_js_1.oasSchemaRefData]).optional(),
+    style: exports.oasParameterStyle
+});

package/script/oas/parameter/toParameterV3.d.ts

@@ -0,0 +1,25 @@
+import type { CoreContext } from '../../context/CoreContext.js';
+import type { OpenAPIV3 } from 'openapi-types';
+import type { Trail } from '../../context/Trail.js';
+import { OasParameter } from './Parameter.js';
+import type { OasRef } from '../ref/Ref.js';
+type ToParameterListV3Args = {
+    parameters: (OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject)[] | undefined;
+    trail: Trail;
+    context: CoreContext;
+};
+export declare const toParameterListV3: ({ parameters, trail, context }: ToParameterListV3Args) => (OasParameter | OasRef<"parameter">)[] | undefined;
+type ToParametersV3Args = {
+    parameters: Record<string, OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject>;
+    trail: Trail;
+    context: CoreContext;
+};
+export declare const toParametersV3: ({ parameters, trail, context }: ToParametersV3Args) => Record<string, OasParameter | OasRef<"parameter">>;
+type ToOptionalParametersV3Args = {
+    parameters: Record<string, OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject> | undefined;
+    trail: Trail;
+    context: CoreContext;
+};
+export declare const toOptionalParametersV3: ({ parameters, trail, context }: ToOptionalParametersV3Args) => Record<string, OasParameter | OasRef<"parameter">> | undefined;
+export {};
+//# sourceMappingURL=toParameterV3.d.ts.map

package/script/oas/parameter/toParameterV3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toParameterV3.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/toParameterV3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAQ/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAI9C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAG3C,KAAK,qBAAqB,GAAG;IAC3B,UAAU,EACN,CAAC,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,eAAe,CAAC,EAAE,GACzD,SAAS,CAAA;IACb,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,iBAAiB,mCAI3B,qBAAqB,KACpB,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GACtC,SAQH,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,UAAU,EAAE,MAAM,CAChB,MAAM,EACN,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,eAAe,CACtD,CAAA;IACD,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,cAAc,mCAIxB,kBAAkB,KAAG,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CASxE,CAAA;AAED,KAAK,0BAA0B,GAAG;IAChC,UAAU,EACN,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,eAAe,CAAC,GACrE,SAAS,CAAA;IACb,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,sBAAsB,mCAIhC,0BAA0B,KACzB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,GAClD,SAMH,CAAA"}

package/script/oas/parameter/toParameterV3.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toOptionalParametersV3 = exports.toParametersV3 = exports.toParameterListV3 = void 0;
+const refFns_js_1 = require("../../helpers/refFns.js");
+const parameter_types_js_1 = require("./parameter-types.js");
+const toExamplesV3_js_1 = require("../example/toExamplesV3.js");
+const toRefV31_js_1 = require("../ref/toRefV31.js");
+const toSchemasV3_js_1 = require("../schema/toSchemasV3.js");
+const toMediaTypeItemV3_js_1 = require("../mediaType/toMediaTypeItemV3.js");
+const Parameter_js_1 = require("./Parameter.js");
+const ts_pattern_1 = require("ts-pattern");
+const toParameterListV3 = ({ parameters, trail, context }) => {
+    if (!parameters) {
+        return undefined;
+    }
+    return parameters.map((parameter, index) => toParameterV3({ parameter, trail: trail.add(`${index}`), context }));
+};
+exports.toParameterListV3 = toParameterListV3;
+const toParametersV3 = ({ parameters, trail, context }) => {
+    return Object.fromEntries(Object.entries(parameters).map(([key, value]) => {
+        return [
+            key,
+            toParameterV3({ parameter: value, trail: trail.add(key), context })
+        ];
+    }));
+};
+exports.toParametersV3 = toParametersV3;
+const toOptionalParametersV3 = ({ parameters, trail, context }) => {
+    if (!parameters) {
+        return undefined;
+    }
+    return (0, exports.toParametersV3)({ parameters, trail, context });
+};
+exports.toOptionalParametersV3 = toOptionalParametersV3;
+const toParameterV3 = ({ parameter, trail, context }) => {
+    if ((0, refFns_js_1.isRef)(parameter)) {
+        return (0, toRefV31_js_1.toRefV31)({ ref: parameter, refType: 'parameter', trail, context });
+    }
+    const { name, in: location, description, required, deprecated, allowEmptyValue, allowReserved, schema, example, examples, content, style, explode, ...skipped } = parameter;
+    const parsedLocation = parameter_types_js_1.oasParameterLocation.parse(location);
+    if (parsedLocation === 'path' && !required) {
+        console.warn(JSON.stringify({
+            message: `Path parameters must be required`,
+            trail: trail.toString()
+        }));
+    }
+    // Set missing 'required' to true for path parameters and false for others
+    const defaultRequired = typeof required === 'undefined'
+        ? parsedLocation === 'path'
+            ? true
+            : false
+        : required;
+    const fields = {
+        name,
+        location: parsedLocation,
+        description,
+        required: defaultRequired,
+        deprecated,
+        style: toStyle({ style, location: parsedLocation }),
+        explode: toExplode({ explode, style }),
+        allowEmptyValue,
+        allowReserved,
+        schema: (0, toSchemasV3_js_1.toOptionalSchemaV3)({ schema, trail: trail.add('schema'), context }),
+        examples: (0, toExamplesV3_js_1.toExamplesV3)({
+            examples,
+            example,
+            exampleKey: `${name}-${parsedLocation}`,
+            trail: trail.add('examples'),
+            context
+        }),
+        content: (0, toMediaTypeItemV3_js_1.toOptionalMediaTypeItemsV3)({
+            content,
+            trail: trail.add('content'),
+            context
+        })
+    };
+    return new Parameter_js_1.OasParameter({ fields, trail, skipped, context });
+};
+const toStyle = ({ style, location }) => {
+    const parsed = parameter_types_js_1.oasParameterStyle.optional().parse(style);
+    return (parsed ??
+        (0, ts_pattern_1.match)(location)
+            .with('path', () => 'simple')
+            .with('header', () => 'simple')
+            .with('query', () => 'form')
+            .with('cookie', () => 'form')
+            .exhaustive());
+};
+const toExplode = ({ explode, style }) => {
+    return (explode ??
+        (0, ts_pattern_1.match)(style)
+            .with('form', () => true)
+            .otherwise(() => false));
+};

package/script/oas/pathItem/PathItem.d.ts

@@ -0,0 +1,26 @@
+import { OasBase } from '../../oas-elements/OasBase.js';
+import type { Trail } from '../../context/Trail.js';
+import type { CoreContext } from '../../context/CoreContext.js';
+import type { OasParameter } from '../parameter/Parameter.js';
+import type { OasRef } from '../ref/Ref.js';
+export type PathItemFields = {
+    summary: string | undefined;
+    description: string | undefined;
+    parameters: (OasParameter | OasRef<'parameter'>)[] | undefined;
+};
+type ToPathItemV3Args = {
+    fields: PathItemFields;
+    trail: Trail;
+    skipped: Record<string, unknown>;
+    context: CoreContext;
+};
+export declare class OasPathItem extends OasBase {
+    oasType: 'pathItem';
+    fields: PathItemFields;
+    constructor({ fields, trail, skipped, context }: ToPathItemV3Args);
+    get summary(): string | undefined;
+    get description(): string | undefined;
+    get parameters(): (OasParameter | OasRef<'parameter'>)[] | undefined;
+}
+export {};
+//# sourceMappingURL=PathItem.d.ts.map

package/script/oas/pathItem/PathItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathItem.d.ts","sourceRoot":"","sources":["../../../src/oas/pathItem/PathItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;CAC/D,CAAA;AAED,KAAK,gBAAgB,GAAG;IACtB,MAAM,EAAE,cAAc,CAAA;IACtB,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,qBAAa,WAAY,SAAQ,OAAO;IACtC,OAAO,EAAE,UAAU,CAAa;IAChC,MAAM,EAAE,cAAc,CAAA;gBAEV,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,gBAAgB;IAMjE,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,UAAU,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAEnE;CACF"}

package/script/oas/pathItem/PathItem.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasPathItem = void 0;
+const OasBase_js_1 = require("../../oas-elements/OasBase.js");
+class OasPathItem extends OasBase_js_1.OasBase {
+    constructor({ fields, trail, skipped, context }) {
+        super({ trail, skipped, context });
+        Object.defineProperty(this, "oasType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'pathItem'
+        });
+        Object.defineProperty(this, "fields", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.fields = fields;
+    }
+    get summary() {
+        return this.fields.summary;
+    }
+    get description() {
+        return this.fields.description;
+    }
+    get parameters() {
+        return this.fields.parameters;
+    }
+}
+exports.OasPathItem = OasPathItem;

package/script/oas/pathItem/toPathItemV3.d.ts

@@ -0,0 +1,12 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import type { CoreContext } from '../../context/CoreContext.js';
+import type { Trail } from '../../context/Trail.js';
+import { OasPathItem } from './PathItem.js';
+type ToPathItemV3Args = {
+    pathItem: OpenAPIV3.PathItemObject;
+    trail: Trail;
+    context: CoreContext;
+};
+export declare const toPathItemV3: ({ pathItem, trail, context }: ToPathItemV3Args) => OasPathItem;
+export {};
+//# sourceMappingURL=toPathItemV3.d.ts.map

package/script/oas/pathItem/toPathItemV3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toPathItemV3.d.ts","sourceRoot":"","sources":["../../../src/oas/pathItem/toPathItemV3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAE/D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAG3C,KAAK,gBAAgB,GAAG;IACtB,QAAQ,EAAE,SAAS,CAAC,cAAc,CAAA;IAClC,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,YAAY,iCAItB,gBAAgB,KAAG,WAcrB,CAAA"}