@scalar/openapi-parser 0.10.15 → 0.10.17

package/dist/utils/upgradeFromThreeToThreeOne.js

@@ -1,147 +1,121 @@
-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
- */
+import { traverse } from "./traverse.js";
 function upgradeFromThreeToThreeOne(originalSpecification) {
-    let specification = originalSpecification;
-    // Version
-    if (specification !== null && typeof specification.openapi === 'string' && specification.openapi.startsWith('3.0')) {
-        specification.openapi = '3.1.1';
+  let specification = originalSpecification;
+  if (specification !== null && typeof specification.openapi === "string" && specification.openapi.startsWith("3.0")) {
+    specification.openapi = "3.1.1";
+  } else {
+    return specification;
+  }
+  specification = traverse(specification, (schema) => {
+    if (schema.type !== "undefined" && schema.nullable === true) {
+      schema.type = [schema.type, "null"];
+      delete schema.nullable;
     }
-    else {
-        // Skip if it’s something else than 3.0.x
-        return specification;
+    return schema;
+  });
+  specification = traverse(specification, (schema) => {
+    if (schema.exclusiveMinimum === true) {
+      schema.exclusiveMinimum = schema.minimum;
+      delete schema.minimum;
+    } else if (schema.exclusiveMinimum === false) {
+      delete schema.exclusiveMinimum;
     }
-    // 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,
-            };
+    if (schema.exclusiveMaximum === true) {
+      schema.exclusiveMaximum = schema.maximum;
+      delete schema.maximum;
+    } else if (schema.exclusiveMaximum === false) {
+      delete schema.exclusiveMaximum;
+    }
+    return schema;
+  });
+  specification = traverse(specification, (schema, path) => {
+    if (schema.example !== void 0) {
+      if (isSchemaPath(path)) {
+        schema.examples = [schema.example];
+      } else {
+        schema.examples = {
+          default: {
+            value: schema.example
+          }
+        };
+      }
+      delete schema.example;
+    }
+    return schema;
+  });
+  specification = traverse(specification, (schema, path) => {
+    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";
+      });
+      if (isMultipart) {
+        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;
-    });
-    // Declaring $schema Dialects to protect against change
-    // if (typeof specification.$schema === 'undefined') {
-    //   specification.$schema = 'http://json-schema.org/draft-07/schema#'
-    // }
-    return specification;
+      }
+    }
+    return schema;
+  });
+  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;
+  });
+  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
+      };
+    }
+    return 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);
-        }
-        return path.includes(location);
-    }) ||
-        path.includes('schema') ||
-        path.some((segment) => segment.endsWith('Schema')));
+  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);
+    }
+    return path.includes(location);
+  }) || path.includes("schema") || path.some((segment) => segment.endsWith("Schema"));
 }
-
-export { isSchemaPath, upgradeFromThreeToThreeOne };
+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/**\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(originalSpecification: UnknownObject) {\n  let specification = originalSpecification\n\n  // Version\n  if (specification !== null && typeof specification.openapi === 'string' && specification.openapi.startsWith('3.0')) {\n    specification.openapi = '3.1.1'\n  } else {\n    // Skip if it\u2019s something else than 3.0.x\n    return specification\n  }\n\n  // Nullable types\n  specification = traverse(specification, (schema) => {\n    if (schema.type !== 'undefined' && schema.nullable === true) {\n      schema.type = [schema.type, 'null']\n      delete schema.nullable\n    }\n\n    return schema\n  })\n\n  // exclusiveMinimum and exclusiveMaximum\n  specification = traverse(specification, (schema) => {\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    return schema\n  })\n\n  // Use examples not example\n  specification = traverse(specification, (schema, path) => {\n    if (schema.example !== undefined) {\n      // Arrays in schemas\n      if (isSchemaPath(path)) {\n        schema.examples = [schema.example]\n      }\n      // Objects everywhere else\n      else {\n        schema.examples = {\n          default: {\n            value: schema.example,\n          },\n        }\n      }\n      delete schema.example\n    }\n\n    return schema\n  })\n\n  // Multipart file uploads with a binary file\n  specification = traverse(specification, (schema, path) => {\n    if (schema.type === 'object' && schema.properties !== undefined) {\n      // Check if this is a multipart request body schema\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        // Types\n        const entries: [string, any][] = Object.entries(schema.properties)\n\n        for (const [_, value] of entries) {\n          if (typeof value === 'object' && value.type === 'string' && value.format === 'binary') {\n            value.contentMediaType = 'application/octet-stream'\n            delete value.format\n          }\n        }\n      }\n    }\n\n    return schema\n  })\n\n  // Uploading a binary file in a POST request\n  specification = traverse(specification, (schema, path) => {\n    if (path.includes('content') && path.includes('application/octet-stream')) {\n      return {}\n    }\n\n    if (schema.type === 'string' && schema.format === 'binary') {\n      return {\n        type: 'string',\n        contentMediaType: 'application/octet-stream',\n      }\n    }\n\n    return schema\n  })\n\n  // Uploading an image with base64 encoding\n  specification = traverse(specification, (schema) => {\n    if (schema.type === 'string' && schema.format === 'base64') {\n      return {\n        type: 'string',\n        contentEncoding: 'base64',\n      }\n    }\n\n    return schema\n  })\n\n  specification = traverse(specification, (schema, path) => {\n    if (schema.type === 'string' && schema.format === 'byte') {\n      const parentPath = path.slice(0, -1)\n      const contentMediaType = parentPath.find((_, index) => path[index - 1] === 'content')\n\n      return {\n        type: 'string',\n        contentEncoding: 'base64',\n        contentMediaType,\n      }\n    }\n\n    return schema\n  })\n\n  // Declaring $schema Dialects to protect against change\n  // if (typeof specification.$schema === 'undefined') {\n  //   specification.$schema = 'http://json-schema.org/draft-07/schema#'\n  // }\n\n  return specification as OpenAPIV3_1.Document\n}\n\n/** Determine if the current path is within a schema */\nexport function isSchemaPath(path: string[]): boolean {\n  const schemaLocations = [\n    ['components', 'schemas'],\n    'properties',\n    'items',\n    'allOf',\n    'anyOf',\n    'oneOf',\n    'not',\n    'additionalProperties',\n  ]\n\n  return (\n    schemaLocations.some((location) => {\n      if (Array.isArray(location)) {\n        return location.every((segment, index) => path[index] === segment)\n      }\n      return path.includes(location)\n    }) ||\n    path.includes('schema') ||\n    path.some((segment) => segment.endsWith('Schema'))\n  )\n}\n"],
+  "mappings": "AAGA,SAAS,gBAAgB;AAOlB,SAAS,2BAA2B,uBAAsC;AAC/E,MAAI,gBAAgB;AAGpB,MAAI,kBAAkB,QAAQ,OAAO,cAAc,YAAY,YAAY,cAAc,QAAQ,WAAW,KAAK,GAAG;AAClH,kBAAc,UAAU;AAAA,EAC1B,OAAO;AAEL,WAAO;AAAA,EACT;AAGA,kBAAgB,SAAS,eAAe,CAAC,WAAW;AAClD,QAAI,OAAO,SAAS,eAAe,OAAO,aAAa,MAAM;AAC3D,aAAO,OAAO,CAAC,OAAO,MAAM,MAAM;AAClC,aAAO,OAAO;AAAA,IAChB;AAEA,WAAO;AAAA,EACT,CAAC;AAGD,kBAAgB,SAAS,eAAe,CAAC,WAAW;AAClD,QAAI,OAAO,qBAAqB,MAAM;AACpC,aAAO,mBAAmB,OAAO;AACjC,aAAO,OAAO;AAAA,IAChB,WAAW,OAAO,qBAAqB,OAAO;AAC5C,aAAO,OAAO;AAAA,IAChB;AAEA,QAAI,OAAO,qBAAqB,MAAM;AACpC,aAAO,mBAAmB,OAAO;AACjC,aAAO,OAAO;AAAA,IAChB,WAAW,OAAO,qBAAqB,OAAO;AAC5C,aAAO,OAAO;AAAA,IAChB;AAEA,WAAO;AAAA,EACT,CAAC;AAGD,kBAAgB,SAAS,eAAe,CAAC,QAAQ,SAAS;AACxD,QAAI,OAAO,YAAY,QAAW;AAEhC,UAAI,aAAa,IAAI,GAAG;AACtB,eAAO,WAAW,CAAC,OAAO,OAAO;AAAA,MACnC,OAEK;AACH,eAAO,WAAW;AAAA,UAChB,SAAS;AAAA,YACP,OAAO,OAAO;AAAA,UAChB;AAAA,QACF;AAAA,MACF;AACA,aAAO,OAAO;AAAA,IAChB;AAEA,WAAO;AAAA,EACT,CAAC;AAGD,kBAAgB,SAAS,eAAe,CAAC,QAAQ,SAAS;AACxD,QAAI,OAAO,SAAS,YAAY,OAAO,eAAe,QAAW;AAE/D,YAAM,aAAa,KAAK,MAAM,GAAG,EAAE;AACnC,YAAM,cAAc,WAAW,KAAK,CAAC,SAAS,UAAU;AACtD,eAAO,YAAY,aAAa,KAAK,QAAQ,CAAC,MAAM;AAAA,MACtD,CAAC;AAED,UAAI,aAAa;AAEf,cAAM,UAA2B,OAAO,QAAQ,OAAO,UAAU;AAEjE,mBAAW,CAAC,GAAG,KAAK,KAAK,SAAS;AAChC,cAAI,OAAO,UAAU,YAAY,MAAM,SAAS,YAAY,MAAM,WAAW,UAAU;AACrF,kBAAM,mBAAmB;AACzB,mBAAO,MAAM;AAAA,UACf;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAGD,kBAAgB,SAAS,eAAe,CAAC,QAAQ,SAAS;AACxD,QAAI,KAAK,SAAS,SAAS,KAAK,KAAK,SAAS,0BAA0B,GAAG;AACzE,aAAO,CAAC;AAAA,IACV;AAEA,QAAI,OAAO,SAAS,YAAY,OAAO,WAAW,UAAU;AAC1D,aAAO;AAAA,QACL,MAAM;AAAA,QACN,kBAAkB;AAAA,MACpB;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAGD,kBAAgB,SAAS,eAAe,CAAC,WAAW;AAClD,QAAI,OAAO,SAAS,YAAY,OAAO,WAAW,UAAU;AAC1D,aAAO;AAAA,QACL,MAAM;AAAA,QACN,iBAAiB;AAAA,MACnB;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAED,kBAAgB,SAAS,eAAe,CAAC,QAAQ,SAAS;AACxD,QAAI,OAAO,SAAS,YAAY,OAAO,WAAW,QAAQ;AACxD,YAAM,aAAa,KAAK,MAAM,GAAG,EAAE;AACnC,YAAM,mBAAmB,WAAW,KAAK,CAAC,GAAG,UAAU,KAAK,QAAQ,CAAC,MAAM,SAAS;AAEpF,aAAO;AAAA,QACL,MAAM;AAAA,QACN,iBAAiB;AAAA,QACjB;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAOD,SAAO;AACT;AAGO,SAAS,aAAa,MAAyB;AACpD,QAAM,kBAAkB;AAAA,IACtB,CAAC,cAAc,SAAS;AAAA,IACxB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,SACE,gBAAgB,KAAK,CAAC,aAAa;AACjC,QAAI,MAAM,QAAQ,QAAQ,GAAG;AAC3B,aAAO,SAAS,MAAM,CAAC,SAAS,UAAU,KAAK,KAAK,MAAM,OAAO;AAAA,IACnE;AACA,WAAO,KAAK,SAAS,QAAQ;AAAA,EAC/B,CAAC,KACD,KAAK,SAAS,QAAQ,KACtB,KAAK,KAAK,CAAC,YAAY,QAAQ,SAAS,QAAQ,CAAC;AAErD;",
+  "names": []
+}