@skmtc/core 0.29.0 → 0.31.0

package/script/parse/v3-2/object/toObject.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toObject = void 0;
+const Object_js_1 = require("../../../oas/object/Object.js");
+const toSchemasV3_js_1 = require("../schema/toSchemasV3.js");
+const toAdditionalPropertiesV3_js_1 = require("./toAdditionalPropertiesV3.js");
+const toSpecificationExtensionsV3_js_1 = require("../specificationExtensions/toSpecificationExtensionsV3.js");
+const parseNullable_js_1 = require("../_helpers/parseNullable.js");
+const parseEnum_js_1 = require("../_helpers/parseEnum.js");
+const parseExample_js_1 = require("../_helpers/parseExample.js");
+const parseDefault_js_1 = require("../_helpers/parseDefault.js");
+const toExternalDocs_js_1 = require("../externalDocs/toExternalDocs.js");
+const toObject = ({ value, context, stackTrail }) => {
+    const { nullable, value: valueWithoutNullable } = (0, parseNullable_js_1.parseNullable)({
+        value,
+        context,
+        stackTrail
+    });
+    const { example: unparsedExample, ...valueWithoutExample } = valueWithoutNullable;
+    const example = (0, parseExample_js_1.parseExample)({
+        value: unparsedExample,
+        context,
+        parent: valueWithoutNullable,
+        nullable,
+        check: isObject,
+        toMessage: item => `Removed invalid example. Expected "object", got: ${item}`,
+        stackTrail
+    });
+    const { enum: unparsedEnums, ...valueWithoutEnums } = valueWithoutExample;
+    const enums = (0, parseEnum_js_1.parseEnum)({
+        value: unparsedEnums,
+        nullable,
+        parent: valueWithoutExample,
+        context,
+        stackTrail,
+        check: isObject,
+        toMessage: item => `Removed invalid enum. Expected "object", got: ${item}`
+    });
+    const { default: unparsedDefaultValue, ...valueWithoutDefault } = valueWithoutEnums;
+    const defaultValue = (0, parseDefault_js_1.parseDefault)({
+        value: unparsedDefaultValue,
+        context,
+        parent: valueWithoutEnums,
+        nullable,
+        check: isObject,
+        toMessage: item => `Removed invalid default. Expected "object", got: ${item}`,
+        stackTrail
+    });
+    return toParsedObject({
+        context,
+        nullable,
+        example,
+        enums,
+        defaultValue,
+        value: valueWithoutDefault,
+        stackTrail
+    });
+};
+exports.toObject = toObject;
+const toParsedObject = ({ context, stackTrail, nullable, example, enums, defaultValue, value }) => {
+    const { type: _type, title, description, externalDocs, deprecated, properties, required, maxProperties, minProperties, additionalProperties, readOnly, writeOnly, ...skipped } = value;
+    const extensionFields = (0, toSpecificationExtensionsV3_js_1.toSpecificationExtensionsV3)({
+        skipped,
+        parent: value,
+        context,
+        stackTrail,
+        parentType: 'schema:object'
+    });
+    return context.withStackTrail(stackTrail, () => new Object_js_1.OasObject({
+        title,
+        description,
+        externalDocs: stackTrail.trace('externalDocs', st => (0, toExternalDocs_js_1.toExternalDocs)({ externalDocs, stackTrail: st, context })),
+        nullable,
+        example,
+        enums,
+        properties: stackTrail.trace('properties', st => (0, toSchemasV3_js_1.toOptionalSchemasV3)({
+            schemas: properties,
+            stackTrail: st,
+            context
+        })),
+        required,
+        maxProperties,
+        minProperties,
+        additionalProperties: stackTrail.trace('additionalProperties', st => (0, toAdditionalPropertiesV3_js_1.toAdditionalPropertiesV3)({ additionalProperties, stackTrail: st, context })),
+        extensionFields,
+        default: defaultValue,
+        deprecated,
+        readOnly,
+        writeOnly
+    }, context));
+};
+const isObject = (value) => {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+};

package/script/parse/v3-2/operation/toOperationsV3.d.ts

@@ -0,0 +1,25 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import type { Method } from '../../../types/Method.js';
+import type { ParseContextType } from '../../../context/parseTypes.js';
+import { OasOperation } from '../../../oas/operation/Operation.js';
+import type { OasPathItem } from '../../../oas/pathItem/PathItem.js';
+import type { StackTrail } from '../../../context/StackTrail.js';
+type OperationInfo = {
+    method: Method;
+    path: string;
+    pathItem: OasPathItem | undefined;
+};
+export type ToOperationV3Args = {
+    operation: OpenAPIV3.OperationObject;
+    operationInfo: OperationInfo;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+export declare const toOperationV3: ({ operation, operationInfo, stackTrail, context }: ToOperationV3Args) => OasOperation;
+export type ToOperationsV3Args = {
+    paths: OpenAPIV3.PathsObject | undefined;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+export declare const toOperationsV3: ({ paths, stackTrail, context }: ToOperationsV3Args) => OasOperation[];
+export {};

package/script/parse/v3-2/operation/toOperationsV3.js

@@ -0,0 +1,134 @@
+"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("../../../oas/operation/Operation.js");
+const toPathItemV3_js_1 = require("../pathItem/toPathItemV3.js");
+const methods_js_1 = require("../methods.js");
+const dropAdditionalOperationsV3_js_1 = require("../pathItem/dropAdditionalOperationsV3.js");
+const warnQuerystringConflictsV3_js_1 = require("../parameter/warnQuerystringConflictsV3.js");
+const toSpecificationExtensionsV3_js_1 = require("../specificationExtensions/toSpecificationExtensionsV3.js");
+const toSecurityRequirement_js_1 = require("../securityRequirement/toSecurityRequirement.js");
+const toExternalDocs_js_1 = require("../externalDocs/toExternalDocs.js");
+const toServerV3_js_1 = require("../server/toServerV3.js");
+const toOperationV3 = ({ operation, operationInfo, stackTrail, context }) => {
+    const { method, path, pathItem } = operationInfo;
+    const { operationId, tags, summary, description, parameters, requestBody, responses, deprecated, security, externalDocs, servers, 
+    // Callbacks are a deliberate non-goal (no out-of-band callback codegen).
+    // Pull it out so it is dropped silently instead of warned as an
+    // unexpected property on every operation that declares one.
+    callbacks: _callbacks, ...skipped } = operation;
+    const extensionFields = (0, toSpecificationExtensionsV3_js_1.toSpecificationExtensionsV3)({
+        skipped,
+        parent: operation,
+        context,
+        stackTrail,
+        parentType: 'operation'
+    });
+    const parsedParameters = stackTrail.trace('parameters', st => (0, toParameterV3_js_1.toParameterListV3)({ parameters, stackTrail: st, context }));
+    (0, warnQuerystringConflictsV3_js_1.warnQuerystringConflictsV3)({ parameters: parsedParameters, pathItem, stackTrail, context });
+    const parsedRequestBody = stackTrail.trace('requestBody', st => (0, toRequestBodiesV3_js_1.toRequestBodyV3)({ requestBody, stackTrail: st, context }));
+    const parsedResponses = stackTrail.trace('responses', st => (0, toResponseV3_js_1.toResponsesV3)({ responses, stackTrail: st, context }));
+    const parsedSecurity = stackTrail.trace('security', st => (0, toSecurityRequirement_js_1.toSecurityRequirementsV3)({ security, stackTrail: st, context }));
+    const parsedExternalDocs = stackTrail.trace('externalDocs', st => (0, toExternalDocs_js_1.toExternalDocs)({ externalDocs, stackTrail: st, context }));
+    const parsedServers = stackTrail.trace('servers', st => (0, toServerV3_js_1.toOptionalServersV3)({ servers, stackTrail: st, context }));
+    return context.withStackTrail(stackTrail, () => new Operation_js_1.OasOperation({
+        pathItem,
+        path,
+        method,
+        operationId,
+        summary,
+        tags,
+        description,
+        parameters: parsedParameters,
+        requestBody: parsedRequestBody,
+        responses: parsedResponses,
+        deprecated,
+        security: parsedSecurity,
+        externalDocs: parsedExternalDocs,
+        servers: parsedServers,
+        extensionFields
+    }, context));
+};
+exports.toOperationV3 = toOperationV3;
+const toOperationsV3 = ({ paths, stackTrail, context }) => {
+    if (!paths) {
+        return [];
+    }
+    return Object.entries(paths).flatMap(([path, pathItem]) => {
+        return stackTrail.trace(path, pathStack => {
+            if (!pathItem) {
+                return [];
+            }
+            const fixedFields = (0, dropAdditionalOperationsV3_js_1.dropAdditionalOperationsV3)({ pathItem, stackTrail: pathStack, context });
+            const cleaned = Object.entries(fixedFields).reduce(({ rest, methodObject }, [key, operation]) => {
+                const method = (0, methods_js_1.toPathItemMethod)(key);
+                if (method) {
+                    const { [method]: _deleted, ...remaining } = rest;
+                    return {
+                        rest: remaining,
+                        methodObject: {
+                            ...methodObject,
+                            [method]: operation
+                        }
+                    };
+                }
+                return { rest, methodObject };
+            }, {
+                rest: fixedFields,
+                methodObject: {}
+            });
+            const pathItemResult = (0, toPathItemV3_js_1.toPathItemResultV3)({
+                pathItem: cleaned.rest,
+                stackTrail: pathStack,
+                context
+            });
+            if (!pathItemResult.valid) {
+                return [];
+            }
+            const pathItemObject = pathItemResult.pathItem;
+            return Object.entries(cleaned.methodObject)
+                .map(([method, operation]) => {
+                // Use `pathStack` (the trail with `path` already pushed),
+                // not the outer `stackTrail` — otherwise downstream traces
+                // record paths:<method>:... and lose the actual path
+                // segment, which breaks `OasDocument.removeItem` and the
+                // dependency-ref invalidation it backs.
+                return pathStack.trace(method, st => {
+                    if (!operation) {
+                        return;
+                    }
+                    try {
+                        return (0, exports.toOperationV3)({
+                            operation,
+                            operationInfo: {
+                                method: method,
+                                path,
+                                pathItem: pathItemObject
+                            },
+                            stackTrail: st,
+                            context
+                        });
+                    }
+                    catch (error) {
+                        const normalized = error instanceof Error ? error : new Error(String(error));
+                        context.logIssue({
+                            key: method,
+                            parent: operation,
+                            level: 'error',
+                            message: normalized.message,
+                            cause: normalized,
+                            stackTrail: st,
+                            type: 'INVALID_OPERATION'
+                        });
+                        return undefined;
+                    }
+                });
+            })
+                .filter((item) => Boolean(item));
+        });
+    });
+};
+exports.toOperationsV3 = toOperationsV3;

package/script/parse/v3-2/parameter/toParameterV3.d.ts

@@ -0,0 +1,39 @@
+import type { ParseContextType } from '../../../context/parseTypes.js';
+import { type OasParameterLocation } from '../../../oas/parameter/parameter-types.js';
+import type { OpenAPIV3 } from 'openapi-types';
+import { OasParameter } from '../../../oas/parameter/Parameter.js';
+import type { OasRef } from '../../../oas/ref/Ref.js';
+import type { StackTrail } from '../../../context/StackTrail.js';
+export type ToParameterListV3Args = {
+    parameters: (OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject)[] | undefined;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+export declare const toParameterListV3: ({ parameters, stackTrail, context }: ToParameterListV3Args) => (OasParameter | OasRef<"parameter">)[] | undefined;
+export type ToParametersV3Args = {
+    parameters: Record<string, OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject>;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+export declare const toParametersV3: ({ parameters, stackTrail, context }: ToParametersV3Args) => Record<string, OasParameter | OasRef<"parameter">>;
+export type ToOptionalParametersV3Args = {
+    parameters: Record<string, OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject> | undefined;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+export declare const toOptionalParametersV3: ({ parameters, stackTrail, context }: ToOptionalParametersV3Args) => Record<string, OasParameter | OasRef<"parameter">> | undefined;
+export type ToParameterV3Args = {
+    parameter: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+export type ToStyleArgs = {
+    style: string | undefined;
+    location: OasParameterLocation;
+    stackTrail: StackTrail;
+};
+export type ToExplodeArgs = {
+    explode: boolean | undefined;
+    style: string | undefined;
+    stackTrail: StackTrail;
+};

package/script/parse/v3-2/parameter/toParameterV3.js

@@ -0,0 +1,191 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toOptionalParametersV3 = exports.toParametersV3 = exports.toParameterListV3 = void 0;
+const tryParseAt_js_1 = require("../../../context/tryParseAt.js");
+const refFns_js_1 = require("../../../helpers/refFns.js");
+const parameter_types_js_1 = require("../../../oas/parameter/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("../../../oas/parameter/Parameter.js");
+const toSpecificationExtensionsV3_js_1 = require("../specificationExtensions/toSpecificationExtensionsV3.js");
+const v = __importStar(require("valibot"));
+const toParameterListV3 = ({ parameters, stackTrail, context }) => {
+    if (!parameters) {
+        return undefined;
+    }
+    return parameters.flatMap((parameter, index) => {
+        const querystringIssue = toQuerystringIssue(parameter);
+        if (querystringIssue) {
+            context.logIssue({
+                key: `${index}`,
+                parent: parameter,
+                level: 'error',
+                message: querystringIssue,
+                stackTrail,
+                type: 'INVALID_PARAMETER'
+            });
+            return [];
+        }
+        return [
+            stackTrail.trace(`${index}`, st => toParameterV3({ parameter, stackTrail: st, context }))
+        ];
+    });
+};
+exports.toParameterListV3 = toParameterListV3;
+/**
+ * A `querystring` parameter describes the whole query string, so it must
+ * carry `content` with exactly one media type, and no `schema`. Returns
+ * the problem, or `undefined` when the parameter is valid or is not a
+ * `querystring` parameter.
+ */
+const toQuerystringIssue = (parameter) => {
+    if ((0, refFns_js_1.isRef)(parameter) || parameter.in !== 'querystring') {
+        return undefined;
+    }
+    if (parameter.schema || Object.keys(parameter.content ?? {}).length !== 1) {
+        return `Parameter '${parameter.name}' in querystring must define content with exactly one media type, and no schema`;
+    }
+    return undefined;
+};
+const toParametersV3 = ({ parameters, stackTrail, context }) => {
+    const output = {};
+    const entries = Object.entries(parameters);
+    for (const [key, parameter] of entries) {
+        const parsed = (0, tryParseAt_js_1.tryParseAt)({
+            stackTrail,
+            key,
+            context,
+            type: 'INVALID_PARAMETER',
+            parent: parameter,
+            fn: st => toParameterV3({ parameter, stackTrail: st, context })
+        });
+        if (parsed !== undefined) {
+            output[key] = parsed;
+        }
+    }
+    return output;
+};
+exports.toParametersV3 = toParametersV3;
+const toOptionalParametersV3 = ({ parameters, stackTrail, context }) => {
+    if (!parameters) {
+        return undefined;
+    }
+    return (0, exports.toParametersV3)({ parameters, stackTrail, context });
+};
+exports.toOptionalParametersV3 = toOptionalParametersV3;
+const toParameterV3 = ({ parameter, stackTrail, context }) => {
+    if ((0, refFns_js_1.isRef)(parameter)) {
+        return (0, toRefV31_js_1.toRefV31)({ ref: parameter, refType: 'parameter', stackTrail, context });
+    }
+    const querystringIssue = toQuerystringIssue(parameter);
+    if (querystringIssue) {
+        throw new Error(querystringIssue);
+    }
+    const { name, in: location, description, required, deprecated, allowEmptyValue, allowReserved, schema, example, examples, content, style, explode, ...skipped } = parameter;
+    const extensionFields = (0, toSpecificationExtensionsV3_js_1.toSpecificationExtensionsV3)({
+        skipped,
+        parent: parameter,
+        context,
+        stackTrail,
+        parentType: 'parameter'
+    });
+    const parsedLocation = v.parse(parameter_types_js_1.oasParameterLocation, location);
+    if (parsedLocation === 'path' && !required) {
+        console.warn(`Path parameters must be required`);
+    }
+    // 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: stackTrail.trace('style', st => toStyle({ style, location: parsedLocation, stackTrail: st })),
+        explode: stackTrail.trace('explode', st => toExplode({ explode, style, stackTrail: st })),
+        allowEmptyValue,
+        allowReserved,
+        schema: stackTrail.trace('schema', st => (0, toSchemasV3_js_1.toOptionalSchemaV3)({ schema, stackTrail: st, context })),
+        examples: stackTrail.trace('examples', st => (0, toExamplesV3_js_1.toExamplesV3)({
+            examples,
+            example,
+            exampleKey: `${name}-${parsedLocation}`,
+            stackTrail: st,
+            context
+        })),
+        content: stackTrail.trace('content', st => (0, toMediaTypeItemV3_js_1.toOptionalMediaTypeItemsV3)({ content, stackTrail: st, context })),
+        extensionFields
+    };
+    return context.withStackTrail(stackTrail, () => new Parameter_js_1.OasParameter(fields, context));
+};
+const toStyle = ({ style, location, stackTrail }) => {
+    const parsed = v.parse(v.optional(parameter_types_js_1.oasParameterStyle), style);
+    if (parsed === 'cookie' && location !== 'cookie') {
+        throw new Error(`Style 'cookie' is only allowed for cookie parameters, not ${location}`);
+    }
+    if (parsed !== undefined) {
+        return parsed;
+    }
+    switch (location) {
+        case 'path':
+        case 'header':
+            return 'simple';
+        case 'query':
+        case 'cookie':
+            return 'form';
+        case 'querystring':
+            // A querystring parameter is serialized by its `content` media type.
+            return undefined;
+        default: {
+            const _exhaustive = location;
+            throw new Error(`Unhandled location: ${_exhaustive}`);
+        }
+    }
+};
+const toExplode = ({ explode, style, stackTrail }) => {
+    if (explode !== undefined) {
+        return explode;
+    }
+    switch (style) {
+        case 'form':
+        case 'cookie':
+            return true;
+        default:
+            return false;
+    }
+};

package/script/parse/v3-2/parameter/warnQuerystringConflictsV3.d.ts

@@ -0,0 +1,22 @@
+import type { ParseContextType } from '../../../context/parseTypes.js';
+import type { StackTrail } from '../../../context/StackTrail.js';
+import type { OasParameter } from '../../../oas/parameter/Parameter.js';
+import type { OasPathItem } from '../../../oas/pathItem/PathItem.js';
+import type { OasRef } from '../../../oas/ref/Ref.js';
+export type WarnQuerystringConflictsV3Args = {
+    parameters: (OasParameter | OasRef<'parameter'>)[] | undefined;
+    pathItem: OasPathItem | undefined;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+/**
+ * Logs an `INVALID_PARAMETER` warning on the operation's `parameters` when
+ * the operation and its path item together declare more than one
+ * `querystring` parameter, or a `querystring` parameter alongside an
+ * `in: query` parameter. An operation parameter replaces a path item
+ * parameter with the same name and location. The parameters are kept.
+ *
+ * Only inline parameters are checked: a `$ref` parameter cannot be
+ * resolved while the document is still being parsed.
+ */
+export declare const warnQuerystringConflictsV3: ({ parameters, pathItem, stackTrail, context }: WarnQuerystringConflictsV3Args) => void;

package/script/parse/v3-2/parameter/warnQuerystringConflictsV3.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.warnQuerystringConflictsV3 = void 0;
+/**
+ * Logs an `INVALID_PARAMETER` warning on the operation's `parameters` when
+ * the operation and its path item together declare more than one
+ * `querystring` parameter, or a `querystring` parameter alongside an
+ * `in: query` parameter. An operation parameter replaces a path item
+ * parameter with the same name and location. The parameters are kept.
+ *
+ * Only inline parameters are checked: a `$ref` parameter cannot be
+ * resolved while the document is still being parsed.
+ */
+const warnQuerystringConflictsV3 = ({ parameters, pathItem, stackTrail, context }) => {
+    const inlineParameters = [...(pathItem?.parameters ?? []), ...(parameters ?? [])].filter((parameter) => !parameter.isRef());
+    const merged = [
+        ...new Map(inlineParameters.map(parameter => [`${parameter.location}:${parameter.name}`, parameter])).values()
+    ];
+    const querystringCount = merged.filter(({ location }) => location === 'querystring').length;
+    if (querystringCount === 0) {
+        return;
+    }
+    const queryNames = merged.filter(({ location }) => location === 'query').map(({ name }) => name);
+    const messages = [
+        querystringCount > 1
+            ? `Operation has ${querystringCount} querystring parameters. At most one is allowed.`
+            : undefined,
+        queryNames.length
+            ? `A querystring parameter must not appear with query parameters (${queryNames.join(', ')}).`
+            : undefined
+    ].filter((message) => Boolean(message));
+    messages.forEach(message => {
+        context.logIssue({
+            key: 'parameters',
+            parent: parameters,
+            level: 'warning',
+            message,
+            stackTrail,
+            type: 'INVALID_PARAMETER'
+        });
+    });
+};
+exports.warnQuerystringConflictsV3 = warnQuerystringConflictsV3;

package/script/parse/v3-2/pathItem/dropAdditionalOperationsV3.d.ts

@@ -0,0 +1,17 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import type { ParseContextType } from '../../../context/parseTypes.js';
+import type { StackTrail } from '../../../context/StackTrail.js';
+export type DropAdditionalOperationsV3Args = {
+    pathItem: OpenAPIV3.PathItemObject;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+/**
+ * Removes the 3.2 `additionalOperations` map from a path item and logs one
+ * `UNSUPPORTED_OPERATION_METHOD` warning per entry, naming the method. The
+ * operations are dropped: no generator renders an arbitrary method yet.
+ *
+ * A value that is not a map (a primitive or an array) stays on the path
+ * item, so the path item parser reports it as a skipped field.
+ */
+export declare const dropAdditionalOperationsV3: ({ pathItem, stackTrail, context }: DropAdditionalOperationsV3Args) => OpenAPIV3.PathItemObject;

package/script/parse/v3-2/pathItem/dropAdditionalOperationsV3.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dropAdditionalOperationsV3 = void 0;
+/**
+ * Removes the 3.2 `additionalOperations` map from a path item and logs one
+ * `UNSUPPORTED_OPERATION_METHOD` warning per entry, naming the method. The
+ * operations are dropped: no generator renders an arbitrary method yet.
+ *
+ * A value that is not a map (a primitive or an array) stays on the path
+ * item, so the path item parser reports it as a skipped field.
+ */
+const dropAdditionalOperationsV3 = ({ pathItem, stackTrail, context }) => {
+    // `Object.hasOwn` is false for a primitive path item value, which the
+    // path item parser then reports as a skipped field.
+    if (!Object.hasOwn(pathItem, 'additionalOperations') || !('additionalOperations' in pathItem)) {
+        return pathItem;
+    }
+    const { additionalOperations, ...rest } = pathItem;
+    if (typeof additionalOperations !== 'object' ||
+        additionalOperations === null ||
+        Array.isArray(additionalOperations)) {
+        return pathItem;
+    }
+    stackTrail.trace('additionalOperations', st => {
+        Object.entries(additionalOperations).forEach(([method, operation]) => {
+            context.logIssue({
+                key: method,
+                parent: operation,
+                level: 'warning',
+                message: `Operation method '${method}' in additionalOperations is not supported. The operation is dropped.`,
+                stackTrail: st,
+                type: 'UNSUPPORTED_OPERATION_METHOD'
+            });
+        });
+    });
+    return rest;
+};
+exports.dropAdditionalOperationsV3 = dropAdditionalOperationsV3;

package/script/parse/v3-2/pathItem/toPathItemV3.d.ts

@@ -0,0 +1,23 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import type { ParseContextType } from '../../../context/parseTypes.js';
+import { OasPathItem } from '../../../oas/pathItem/PathItem.js';
+import type { StackTrail } from '../../../context/StackTrail.js';
+export type ToPathItemV3Args = {
+    pathItem: OpenAPIV3.PathItemObject;
+    stackTrail: StackTrail;
+    context: ParseContextType;
+};
+export declare const toPathItemV3: ({ pathItem, stackTrail, context }: ToPathItemV3Args) => OasPathItem;
+export type PathItemResult = {
+    valid: true;
+    pathItem: OasPathItem | undefined;
+} | {
+    valid: false;
+};
+/**
+ * Parses a path item's shared fields without letting a throw escape. A
+ * path-level parameter that fails validation (for example `in: body`) logs
+ * one `INVALID_OPERATION` at the path and returns `{ valid: false }`, so
+ * the caller skips that path and keeps the rest.
+ */
+export declare const toPathItemResultV3: ({ pathItem, stackTrail, context }: ToPathItemV3Args) => PathItemResult;