@scalar/openapi-parser 0.10.16 → 0.11.0

package/dist/utils/upgradeFromThreeToThreeOne.js

@@ -1,147 +1,110 @@
-import { traverse } from './traverse.js';
-
-/**
- * Upgrade from OpenAPI 3.0.x to 3.1.1
- *
- * https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
- */
-function upgradeFromThreeToThreeOne(originalSpecification) {
-    let specification = originalSpecification;
-    // Version
-    if (specification !== null && typeof specification.openapi === 'string' && specification.openapi.startsWith('3.0')) {
-        specification.openapi = '3.1.1';
-    }
-    else {
-        // Skip if it’s something else than 3.0.x
-        return specification;
-    }
-    // Nullable types
-    specification = traverse(specification, (schema) => {
-        if (schema.type !== 'undefined' && schema.nullable === true) {
-            schema.type = [schema.type, 'null'];
-            delete schema.nullable;
-        }
-        return schema;
-    });
-    // exclusiveMinimum and exclusiveMaximum
-    specification = traverse(specification, (schema) => {
-        if (schema.exclusiveMinimum === true) {
-            schema.exclusiveMinimum = schema.minimum;
-            delete schema.minimum;
-        }
-        else if (schema.exclusiveMinimum === false) {
-            delete schema.exclusiveMinimum;
-        }
-        if (schema.exclusiveMaximum === true) {
-            schema.exclusiveMaximum = schema.maximum;
-            delete schema.maximum;
-        }
-        else if (schema.exclusiveMaximum === false) {
-            delete schema.exclusiveMaximum;
-        }
-        return schema;
-    });
-    // Use examples not example
-    specification = traverse(specification, (schema, path) => {
-        if (schema.example !== undefined) {
-            // Arrays in schemas
-            if (isSchemaPath(path)) {
-                schema.examples = [schema.example];
-            }
-            // Objects everywhere else
-            else {
-                schema.examples = {
-                    default: {
-                        value: schema.example,
-                    },
-                };
-            }
-            delete schema.example;
-        }
-        return schema;
-    });
-    // Multipart file uploads with a binary file
-    specification = traverse(specification, (schema, path) => {
-        if (schema.type === 'object' && schema.properties !== undefined) {
-            // Check if this is a multipart request body schema
-            const parentPath = path.slice(0, -1);
-            const isMultipart = parentPath.some((segment, index) => {
-                return segment === 'content' && path[index + 1] === 'multipart/form-data';
-            });
-            if (isMultipart) {
-                // Types
-                const entries = Object.entries(schema.properties);
-                for (const [_, value] of entries) {
-                    if (typeof value === 'object' && value.type === 'string' && value.format === 'binary') {
-                        value.contentMediaType = 'application/octet-stream';
-                        delete value.format;
-                    }
-                }
-            }
-        }
-        return schema;
-    });
-    // Uploading a binary file in a POST request
-    specification = traverse(specification, (schema, path) => {
-        if (path.includes('content') && path.includes('application/octet-stream')) {
-            return {};
-        }
-        if (schema.type === 'string' && schema.format === 'binary') {
-            return {
-                type: 'string',
-                contentMediaType: 'application/octet-stream',
-            };
-        }
-        return schema;
-    });
-    // Uploading an image with base64 encoding
-    specification = traverse(specification, (schema) => {
-        if (schema.type === 'string' && schema.format === 'base64') {
-            return {
-                type: 'string',
-                contentEncoding: 'base64',
-            };
-        }
-        return schema;
-    });
-    specification = traverse(specification, (schema, path) => {
-        if (schema.type === 'string' && schema.format === 'byte') {
-            const parentPath = path.slice(0, -1);
-            const contentMediaType = parentPath.find((_, index) => path[index - 1] === 'content');
-            return {
-                type: 'string',
-                contentEncoding: 'base64',
-                contentMediaType,
-            };
+import { traverse } from "./traverse.js";
+const SCHEMA_SEGMENTS = /* @__PURE__ */ new Set([
+  "properties",
+  "items",
+  "allOf",
+  "anyOf",
+  "oneOf",
+  "not",
+  "additionalProperties",
+  "schema"
+]);
+const SCHEMA_PATHS = /* @__PURE__ */ new Set(["components/schemas"]);
+function isSchemaPath(path) {
+  if (path.some((segment) => SCHEMA_SEGMENTS.has(segment))) {
+    return true;
+  }
+  if (path.some((segment) => segment.endsWith("Schema"))) {
+    return true;
+  }
+  if (path.length >= 2 && path[0] === "components" && path[1] === "schemas") {
+    return true;
+  }
+  return false;
+}
+function upgradeFromThreeToThreeOne(originalContent) {
+  let content = originalContent;
+  if (content === null || typeof content.openapi !== "string" || !content.openapi.startsWith("3.0")) {
+    return content;
+  }
+  content.openapi = "3.1.1";
+  content = traverse(content, applyChangesToDocument);
+  return content;
+}
+const applyChangesToDocument = (schema, path) => {
+  if (schema.type !== "undefined" && schema.nullable === true) {
+    schema.type = [schema.type, "null"];
+    delete schema.nullable;
+  }
+  if (schema.exclusiveMinimum === true) {
+    schema.exclusiveMinimum = schema.minimum;
+    delete schema.minimum;
+  } else if (schema.exclusiveMinimum === false) {
+    delete schema.exclusiveMinimum;
+  }
+  if (schema.exclusiveMaximum === true) {
+    schema.exclusiveMaximum = schema.maximum;
+    delete schema.maximum;
+  } else if (schema.exclusiveMaximum === false) {
+    delete schema.exclusiveMaximum;
+  }
+  if (schema.example !== void 0) {
+    if (isSchemaPath(path)) {
+      schema.examples = [schema.example];
+    } else {
+      schema.examples = {
+        default: {
+          value: schema.example
         }
-        return schema;
+      };
+    }
+    delete schema.example;
+  }
+  if (schema.type === "object" && schema.properties !== void 0) {
+    const parentPath = path.slice(0, -1);
+    const isMultipart = parentPath.some((segment, index) => {
+      return segment === "content" && path[index + 1] === "multipart/form-data";
     });
-    // Declaring $schema Dialects to protect against change
-    // if (typeof specification.$schema === 'undefined') {
-    //   specification.$schema = 'http://json-schema.org/draft-07/schema#'
-    // }
-    return specification;
-}
-/** Determine if the current path is within a schema */
-function isSchemaPath(path) {
-    const schemaLocations = [
-        ['components', 'schemas'],
-        'properties',
-        'items',
-        'allOf',
-        'anyOf',
-        'oneOf',
-        'not',
-        'additionalProperties',
-    ];
-    return (schemaLocations.some((location) => {
-        if (Array.isArray(location)) {
-            return location.every((segment, index) => path[index] === segment);
+    if (isMultipart) {
+      for (const value of Object.values(schema.properties)) {
+        if (typeof value === "object" && value !== null && "type" in value && "format" in value && value.type === "string" && value.format === "binary") {
+          ;
+          value.contentMediaType = "application/octet-stream";
+          delete value.format;
         }
-        return path.includes(location);
-    }) ||
-        path.includes('schema') ||
-        path.some((segment) => segment.endsWith('Schema')));
-}
-
-export { isSchemaPath, upgradeFromThreeToThreeOne };
+      }
+    }
+  }
+  if (path.includes("content") && path.includes("application/octet-stream")) {
+    return {};
+  }
+  if (schema.type === "string") {
+    if (schema.format === "binary") {
+      return {
+        type: "string",
+        contentMediaType: "application/octet-stream"
+      };
+    }
+    if (schema.format === "base64") {
+      return {
+        type: "string",
+        contentEncoding: "base64"
+      };
+    }
+    if (schema.format === "byte") {
+      const parentPath = path.slice(0, -1);
+      const contentMediaType = parentPath.find((_, index) => path[index - 1] === "content");
+      return {
+        type: "string",
+        contentEncoding: "base64",
+        contentMediaType
+      };
+    }
+  }
+  return schema;
+};
+export {
+  isSchemaPath,
+  upgradeFromThreeToThreeOne
+};
+//# sourceMappingURL=upgradeFromThreeToThreeOne.js.map

package/dist/utils/upgradeFromThreeToThreeOne.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/upgradeFromThreeToThreeOne.ts"],
+  "sourcesContent": ["import type { OpenAPIV3_1 } from '@scalar/openapi-types'\nimport type { UnknownObject } from '@scalar/types/utils'\n\nimport { traverse } from './traverse'\n\n// Create Sets for faster schema path lookups\nconst SCHEMA_SEGMENTS = new Set([\n  'properties',\n  'items',\n  'allOf',\n  'anyOf',\n  'oneOf',\n  'not',\n  'additionalProperties',\n  'schema',\n])\n\nconst SCHEMA_PATHS = new Set(['components/schemas'])\n\n/** Determine if the current path is within a schema - optimized version */\nexport function isSchemaPath(path: string[]): boolean {\n  // Check for schema segments first (most common case)\n  if (path.some((segment) => SCHEMA_SEGMENTS.has(segment))) {\n    return true\n  }\n\n  // Check for schema suffix\n  if (path.some((segment) => segment.endsWith('Schema'))) {\n    return true\n  }\n\n  // Check for components/schemas path\n  if (path.length >= 2 && path[0] === 'components' && path[1] === 'schemas') {\n    return true\n  }\n\n  return false\n}\n\n/**\n * Upgrade from OpenAPI 3.0.x to 3.1.1\n *\n * https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0\n */\nexport function upgradeFromThreeToThreeOne(originalContent: UnknownObject) {\n  let content = originalContent\n\n  // Version check - early return if not 3.0.x\n  if (content === null || typeof content.openapi !== 'string' || !content.openapi.startsWith('3.0')) {\n    return content\n  }\n\n  content.openapi = '3.1.1'\n\n  // Single traversal that handles all transformations\n  content = traverse(content, applyChangesToDocument)\n\n  return content as OpenAPIV3_1.Document\n}\n\nconst applyChangesToDocument = (schema: UnknownObject, path: string[]) => {\n  // 1. Handle nullable types\n  if (schema.type !== 'undefined' && schema.nullable === true) {\n    schema.type = [schema.type, 'null']\n    delete schema.nullable\n  }\n\n  // 2. Handle exclusiveMinimum and exclusiveMaximum\n  if (schema.exclusiveMinimum === true) {\n    schema.exclusiveMinimum = schema.minimum\n    delete schema.minimum\n  } else if (schema.exclusiveMinimum === false) {\n    delete schema.exclusiveMinimum\n  }\n\n  if (schema.exclusiveMaximum === true) {\n    schema.exclusiveMaximum = schema.maximum\n    delete schema.maximum\n  } else if (schema.exclusiveMaximum === false) {\n    delete schema.exclusiveMaximum\n  }\n\n  // 3. Handle examples\n  if (schema.example !== undefined) {\n    if (isSchemaPath(path)) {\n      schema.examples = [schema.example]\n    } else {\n      schema.examples = {\n        default: {\n          value: schema.example,\n        },\n      }\n    }\n    delete schema.example\n  }\n\n  // 4. Handle multipart file uploads\n  if (schema.type === 'object' && schema.properties !== undefined) {\n    const parentPath = path.slice(0, -1)\n    const isMultipart = parentPath.some((segment, index) => {\n      return segment === 'content' && path[index + 1] === 'multipart/form-data'\n    })\n\n    if (isMultipart) {\n      for (const value of Object.values(schema.properties)) {\n        if (\n          typeof value === 'object' &&\n          value !== null &&\n          'type' in value &&\n          'format' in value &&\n          value.type === 'string' &&\n          value.format === 'binary'\n        ) {\n          ;(value as any).contentMediaType = 'application/octet-stream'\n          delete (value as any).format\n        }\n      }\n    }\n  }\n\n  // 5. Handle binary file uploads\n  if (path.includes('content') && path.includes('application/octet-stream')) {\n    return {}\n  }\n\n  if (schema.type === 'string') {\n    if (schema.format === 'binary') {\n      return {\n        type: 'string',\n        contentMediaType: 'application/octet-stream',\n      }\n    }\n\n    if (schema.format === 'base64') {\n      return {\n        type: 'string',\n        contentEncoding: 'base64',\n      }\n    }\n\n    if (schema.format === 'byte') {\n      const parentPath = path.slice(0, -1)\n      const contentMediaType = parentPath.find((_, index) => path[index - 1] === 'content')\n      return {\n        type: 'string',\n        contentEncoding: 'base64',\n        contentMediaType,\n      }\n    }\n  }\n\n  return schema\n}\n"],
+  "mappings": "AAGA,SAAS,gBAAgB;AAGzB,MAAM,kBAAkB,oBAAI,IAAI;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAED,MAAM,eAAe,oBAAI,IAAI,CAAC,oBAAoB,CAAC;AAG5C,SAAS,aAAa,MAAyB;AAEpD,MAAI,KAAK,KAAK,CAAC,YAAY,gBAAgB,IAAI,OAAO,CAAC,GAAG;AACxD,WAAO;AAAA,EACT;AAGA,MAAI,KAAK,KAAK,CAAC,YAAY,QAAQ,SAAS,QAAQ,CAAC,GAAG;AACtD,WAAO;AAAA,EACT;AAGA,MAAI,KAAK,UAAU,KAAK,KAAK,CAAC,MAAM,gBAAgB,KAAK,CAAC,MAAM,WAAW;AACzE,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAOO,SAAS,2BAA2B,iBAAgC;AACzE,MAAI,UAAU;AAGd,MAAI,YAAY,QAAQ,OAAO,QAAQ,YAAY,YAAY,CAAC,QAAQ,QAAQ,WAAW,KAAK,GAAG;AACjG,WAAO;AAAA,EACT;AAEA,UAAQ,UAAU;AAGlB,YAAU,SAAS,SAAS,sBAAsB;AAElD,SAAO;AACT;AAEA,MAAM,yBAAyB,CAAC,QAAuB,SAAmB;AAExE,MAAI,OAAO,SAAS,eAAe,OAAO,aAAa,MAAM;AAC3D,WAAO,OAAO,CAAC,OAAO,MAAM,MAAM;AAClC,WAAO,OAAO;AAAA,EAChB;AAGA,MAAI,OAAO,qBAAqB,MAAM;AACpC,WAAO,mBAAmB,OAAO;AACjC,WAAO,OAAO;AAAA,EAChB,WAAW,OAAO,qBAAqB,OAAO;AAC5C,WAAO,OAAO;AAAA,EAChB;AAEA,MAAI,OAAO,qBAAqB,MAAM;AACpC,WAAO,mBAAmB,OAAO;AACjC,WAAO,OAAO;AAAA,EAChB,WAAW,OAAO,qBAAqB,OAAO;AAC5C,WAAO,OAAO;AAAA,EAChB;AAGA,MAAI,OAAO,YAAY,QAAW;AAChC,QAAI,aAAa,IAAI,GAAG;AACtB,aAAO,WAAW,CAAC,OAAO,OAAO;AAAA,IACnC,OAAO;AACL,aAAO,WAAW;AAAA,QAChB,SAAS;AAAA,UACP,OAAO,OAAO;AAAA,QAChB;AAAA,MACF;AAAA,IACF;AACA,WAAO,OAAO;AAAA,EAChB;AAGA,MAAI,OAAO,SAAS,YAAY,OAAO,eAAe,QAAW;AAC/D,UAAM,aAAa,KAAK,MAAM,GAAG,EAAE;AACnC,UAAM,cAAc,WAAW,KAAK,CAAC,SAAS,UAAU;AACtD,aAAO,YAAY,aAAa,KAAK,QAAQ,CAAC,MAAM;AAAA,IACtD,CAAC;AAED,QAAI,aAAa;AACf,iBAAW,SAAS,OAAO,OAAO,OAAO,UAAU,GAAG;AACpD,YACE,OAAO,UAAU,YACjB,UAAU,QACV,UAAU,SACV,YAAY,SACZ,MAAM,SAAS,YACf,MAAM,WAAW,UACjB;AACA;AAAC,UAAC,MAAc,mBAAmB;AACnC,iBAAQ,MAAc;AAAA,QACxB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAGA,MAAI,KAAK,SAAS,SAAS,KAAK,KAAK,SAAS,0BAA0B,GAAG;AACzE,WAAO,CAAC;AAAA,EACV;AAEA,MAAI,OAAO,SAAS,UAAU;AAC5B,QAAI,OAAO,WAAW,UAAU;AAC9B,aAAO;AAAA,QACL,MAAM;AAAA,QACN,kBAAkB;AAAA,MACpB;AAAA,IACF;AAEA,QAAI,OAAO,WAAW,UAAU;AAC9B,aAAO;AAAA,QACL,MAAM;AAAA,QACN,iBAAiB;AAAA,MACnB;AAAA,IACF;AAEA,QAAI,OAAO,WAAW,QAAQ;AAC5B,YAAM,aAAa,KAAK,MAAM,GAAG,EAAE;AACnC,YAAM,mBAAmB,WAAW,KAAK,CAAC,GAAG,UAAU,KAAK,QAAQ,CAAC,MAAM,SAAS;AACpF,aAAO;AAAA,QACL,MAAM;AAAA,QACN,iBAAiB;AAAA,QACjB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;",
+  "names": []
+}