@scalar/openapi-parser 0.18.3 → 0.20.0

package/dist/utils/join/merge-objects.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/utils/join/merge-objects.ts"],
+  "sourcesContent": ["/**\n * Deep merges two objects, combining their properties recursively.\n *\n * \u26A0\uFE0F Note: This operation assumes there are no key collisions between the objects.\n * @param a - Target object to merge into\n * @param b - Source object to merge from\n * @returns The merged object (mutates and returns a)\n *\n * @example\n * // Simple merge\n * const a = { name: 'John' }\n * const b = { age: 30 }\n * mergeObjects(a, b) // { name: 'John', age: 30 }\n *\n * // Nested merge\n * const a = { user: { name: 'John' } }\n * const b = { user: { age: 30 } }\n * mergeObjects(a, b) // { user: { name: 'John', age: 30 } }\n */\nexport const mergeObjects = <R>(a: Record<string, unknown>, b: Record<string, unknown>): R => {\n  for (const key in b) {\n    if (!(key in a)) {\n      a[key] = b[key]\n    } else {\n      const aValue = a[key]\n      const bValue = b[key]\n\n      if (typeof aValue === 'object' && aValue !== null && typeof bValue === 'object' && bValue !== null) {\n        mergeObjects(aValue as Record<string, unknown>, bValue as Record<string, unknown>)\n      } else {\n        a[key] = bValue // Overwrite with b's value if not an object\n      }\n    }\n  }\n\n  return a as R\n}\n"],
+  "mappings": "AAmBO,MAAM,eAAe,CAAI,GAA4B,MAAkC;AAC5F,aAAW,OAAO,GAAG;AACnB,QAAI,EAAE,OAAO,IAAI;AACf,QAAE,GAAG,IAAI,EAAE,GAAG;AAAA,IAChB,OAAO;AACL,YAAM,SAAS,EAAE,GAAG;AACpB,YAAM,SAAS,EAAE,GAAG;AAEpB,UAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,OAAO,WAAW,YAAY,WAAW,MAAM;AAClG,qBAAa,QAAmC,MAAiC;AAAA,MACnF,OAAO;AACL,UAAE,GAAG,IAAI;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;",
+  "names": []
+}

package/dist/utils/upgrade-from-three-to-three-one.js

@@ -77,23 +77,27 @@ const applyChangesToDocument = (schema, path) => {
   if (path.includes("content") && path.includes("application/octet-stream")) {
     return {};
   }
+  const { format: _, ...rest } = schema;
   if (schema.type === "string") {
     if (schema.format === "binary") {
       return {
+        ...rest,
         type: "string",
         contentMediaType: "application/octet-stream"
       };
     }
     if (schema.format === "base64") {
       return {
+        ...rest,
         type: "string",
         contentEncoding: "base64"
       };
     }
     if (schema.format === "byte") {
       const parentPath = path.slice(0, -1);
-      const contentMediaType = parentPath.find((_, index) => path[index - 1] === "content");
+      const contentMediaType = parentPath.find((_2, index) => path[index - 1] === "content");
       return {
+        ...rest,
         type: "string",
         contentEncoding: "base64",
         contentMediaType

package/dist/utils/upgrade-from-three-to-three-one.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/upgrade-from-three-to-three-one.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\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  // 6. Handle x-webhooks\n  if (schema['x-webhooks'] !== undefined) {\n    schema.webhooks = schema['x-webhooks']\n    delete schema['x-webhooks']\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;AAGM,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,UAAa,OAAO,aAAa,MAAM;AACzD,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;AAGA,MAAI,OAAO,YAAY,MAAM,QAAW;AACtC,WAAO,WAAW,OAAO,YAAY;AACrC,WAAO,OAAO,YAAY;AAAA,EAC5B;AAEA,SAAO;AACT;",
-  "names": []
+  "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\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  // 6. Handle older formats\n  const { format: _, ...rest } = schema\n\n  if (schema.type === 'string') {\n    if (schema.format === 'binary') {\n      return {\n        ...rest,\n        type: 'string',\n        contentMediaType: 'application/octet-stream',\n      }\n    }\n\n    if (schema.format === 'base64') {\n      return {\n        ...rest,\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        ...rest,\n        type: 'string',\n        contentEncoding: 'base64',\n        contentMediaType,\n      }\n    }\n  }\n\n  // 7. Handle x-webhooks\n  if (schema['x-webhooks'] !== undefined) {\n    schema.webhooks = schema['x-webhooks']\n    delete schema['x-webhooks']\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;AAGM,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,UAAa,OAAO,aAAa,MAAM;AACzD,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;AAGA,QAAM,EAAE,QAAQ,GAAG,GAAG,KAAK,IAAI;AAE/B,MAAI,OAAO,SAAS,UAAU;AAC5B,QAAI,OAAO,WAAW,UAAU;AAC9B,aAAO;AAAA,QACL,GAAG;AAAA,QACH,MAAM;AAAA,QACN,kBAAkB;AAAA,MACpB;AAAA,IACF;AAEA,QAAI,OAAO,WAAW,UAAU;AAC9B,aAAO;AAAA,QACL,GAAG;AAAA,QACH,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,CAACA,IAAG,UAAU,KAAK,QAAQ,CAAC,MAAM,SAAS;AACpF,aAAO;AAAA,QACL,GAAG;AAAA,QACH,MAAM;AAAA,QACN,iBAAiB;AAAA,QACjB;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAGA,MAAI,OAAO,YAAY,MAAM,QAAW;AACtC,WAAO,WAAW,OAAO,YAAY;AACrC,WAAO,OAAO,YAAY;AAAA,EAC5B;AAEA,SAAO;AACT;",
+  "names": ["_"]
 }

package/package.json

@@ -17,7 +17,7 @@
     "parser",
     "typescript"
   ],
-  "version": "0.18.3",
+  "version": "0.20.0",
   "engines": {
     "node": ">=20"
   },
@@ -30,16 +30,6 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./plugins": {
-      "import": "./dist/plugins.js",
-      "types": "./dist/plugins.d.ts",
-      "default": "./dist/plugins.js"
-    },
-    "./plugins-browser": {
-      "import": "./dist/plugins-browser.js",
-      "types": "./dist/plugins-browser.d.ts",
-      "default": "./dist/plugins-browser.js"
-    },
     "./plugins/fetch-urls": {
       "import": "./dist/plugins/fetch-urls/index.js",
       "types": "./dist/plugins/fetch-urls/index.d.ts",
@@ -64,6 +54,7 @@
     "jsonpointer": "^5.0.1",
     "leven": "^4.0.0",
     "yaml": "2.8.0",
+    "@scalar/json-magic": "0.3.0",
     "@scalar/openapi-types": "0.3.7"
   },
   "devDependencies": {
@@ -74,8 +65,8 @@
     "just-diff": "^6.0.2",
     "tinybench": "^2.8.0",
     "vite": "6.1.6",
-    "@scalar/build-tooling": "0.2.4",
-    "@scalar/types": "0.2.11"
+    "@scalar/types": "0.2.12",
+    "@scalar/build-tooling": "0.2.6"
   },
   "scripts": {
     "build": "scalar-build-esbuild",

package/dist/plugins-browser.d.ts

@@ -1,4 +0,0 @@
-export { fetchUrls } from './utils/bundle/plugins/fetch-urls/index.js';
-export { parseJson } from './utils/bundle/plugins/parse-json/index.js';
-export { parseYaml } from './utils/bundle/plugins/parse-yaml/index.js';
-//# sourceMappingURL=plugins-browser.d.ts.map

package/dist/plugins-browser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugins-browser.d.ts","sourceRoot":"","sources":["../src/plugins-browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA"}

package/dist/plugins-browser.js

@@ -1,9 +0,0 @@
-import { fetchUrls } from "./utils/bundle/plugins/fetch-urls/index.js";
-import { parseJson } from "./utils/bundle/plugins/parse-json/index.js";
-import { parseYaml } from "./utils/bundle/plugins/parse-yaml/index.js";
-export {
-  fetchUrls,
-  parseJson,
-  parseYaml
-};
-//# sourceMappingURL=plugins-browser.js.map

package/dist/plugins-browser.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/plugins-browser.ts"],
-  "sourcesContent": ["export { fetchUrls } from './utils/bundle/plugins/fetch-urls'\nexport { parseJson } from './utils/bundle/plugins/parse-json'\nexport { parseYaml } from './utils/bundle/plugins/parse-yaml'\n"],
-  "mappings": "AAAA,SAAS,iBAAiB;AAC1B,SAAS,iBAAiB;AAC1B,SAAS,iBAAiB;",
-  "names": []
-}

package/dist/plugins.d.ts

@@ -1,5 +0,0 @@
-export { fetchUrls } from './utils/bundle/plugins/fetch-urls/index.js';
-export { readFiles } from './utils/bundle/plugins/read-files/index.js';
-export { parseJson } from './utils/bundle/plugins/parse-json/index.js';
-export { parseYaml } from './utils/bundle/plugins/parse-yaml/index.js';
-//# sourceMappingURL=plugins.d.ts.map

package/dist/plugins.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA"}

package/dist/plugins.js

@@ -1,11 +0,0 @@
-import { fetchUrls } from "./utils/bundle/plugins/fetch-urls/index.js";
-import { readFiles } from "./utils/bundle/plugins/read-files/index.js";
-import { parseJson } from "./utils/bundle/plugins/parse-json/index.js";
-import { parseYaml } from "./utils/bundle/plugins/parse-yaml/index.js";
-export {
-  fetchUrls,
-  parseJson,
-  parseYaml,
-  readFiles
-};
-//# sourceMappingURL=plugins.js.map

package/dist/plugins.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../src/plugins.ts"],
-  "sourcesContent": ["export { fetchUrls } from './utils/bundle/plugins/fetch-urls'\nexport { readFiles } from './utils/bundle/plugins/read-files'\nexport { parseJson } from './utils/bundle/plugins/parse-json'\nexport { parseYaml } from './utils/bundle/plugins/parse-yaml'\n"],
-  "mappings": "AAAA,SAAS,iBAAiB;AAC1B,SAAS,iBAAiB;AAC1B,SAAS,iBAAiB;AAC1B,SAAS,iBAAiB;",
-  "names": []
-}

package/dist/utils/bundle/bundle.d.ts

@@ -1,286 +0,0 @@
-import type { UnknownObject } from '../../types/index.js';
-/**
- * Checks if a string is a remote URL (starts with http:// or https://)
- * @param value - The URL string to check
- * @returns true if the string is a remote URL, false otherwise
- * @example
- * ```ts
- * isRemoteUrl('https://example.com/schema.json') // true
- * isRemoteUrl('http://api.example.com/schemas/user.json') // true
- * isRemoteUrl('#/components/schemas/User') // false
- * isRemoteUrl('./local-schema.json') // false
- * ```
- */
-export declare function isRemoteUrl(value: string): boolean;
-/**
- * Checks if a string represents a file path by ensuring it's not a remote URL,
- * YAML content, or JSON content.
- *
- * @param value - The string to check
- * @returns true if the string appears to be a file path, false otherwise
- * @example
- * ```ts
- * isFilePath('./schemas/user.json') // true
- * isFilePath('https://example.com/schema.json') // false
- * isFilePath('{"type": "object"}') // false
- * isFilePath('type: object') // false
- * ```
- */
-export declare function isFilePath(value: string): boolean;
-/**
- * Checks if a string is a local reference (starts with #)
- * @param value - The reference string to check
- * @returns true if the string is a local reference, false otherwise
- * @example
- * ```ts
- * isLocalRef('#/components/schemas/User') // true
- * isLocalRef('https://example.com/schema.json') // false
- * isLocalRef('./local-schema.json') // false
- * ```
- */
-export declare function isLocalRef(value: string): boolean;
-export type ResolveResult = {
-    ok: true;
-    data: unknown;
-} | {
-    ok: false;
-};
-/**
- * Retrieves a nested value from an object using an array of property segments.
- * @param target - The target object to traverse
- * @param segments - Array of property names representing the path to the desired value
- * @returns The value at the specified path, or undefined if the path doesn't exist
- * @example
- * const obj = { foo: { bar: { baz: 42 } } };
- * getNestedValue(obj, ['foo', 'bar', 'baz']); // returns 42
- */
-export declare function getNestedValue(target: Record<string, any>, segments: string[]): any;
-/**
- * Sets a value at a specified path in an object, creating intermediate objects/arrays as needed.
- * This function traverses the object structure and creates any missing intermediate objects
- * or arrays based on the path segments. If the next segment is a numeric string, it creates
- * an array instead of an object.
- *
- * ⚠️ Warning: Be careful with object keys that look like numbers (e.g. "123") as this function
- * will interpret them as array indices and create arrays instead of objects. If you need to
- * use numeric-looking keys, consider prefixing them with a non-numeric character.
- *
- * @param obj - The target object to set the value in
- * @param path - The JSON pointer path where the value should be set
- * @param value - The value to set at the specified path
- * @throws {Error} If attempting to set a value at the root path ('')
- *
- * @example
- * const obj = {}
- * setValueAtPath(obj, '/foo/bar/0', 'value')
- * // Result:
- * // {
- * //   foo: {
- * //     bar: ['value']
- * //   }
- * // }
- *
- * @example
- * const obj = { existing: { path: 'old' } }
- * setValueAtPath(obj, '/existing/path', 'new')
- * // Result:
- * // {
- * //   existing: {
- * //     path: 'new'
- * //   }
- * // }
- *
- * @example
- * // ⚠️ Warning: This will create an array instead of an object with key "123"
- * setValueAtPath(obj, '/foo/123/bar', 'value')
- * // Result:
- * // {
- * //   foo: [
- * //     undefined,
- * //     undefined,
- * //     undefined,
- * //     { bar: 'value' }
- * //   ]
- * // }
- */
-export declare function setValueAtPath(obj: any, path: string, value: any): void;
-/**
- * Prefixes an internal JSON reference with a given path prefix.
- * Takes a local reference (starting with #) and prepends the provided prefix segments.
- *
- * @param input - The internal reference string to prefix (must start with #)
- * @param prefix - Array of path segments to prepend to the reference
- * @returns The prefixed reference string
- * @throws Error if input is not a local reference
- * @example
- * prefixInternalRef('#/components/schemas/User', ['definitions'])
- * // Returns: '#/definitions/components/schemas/User'
- */
-export declare function prefixInternalRef(input: string, prefix: string[]): string;
-/**
- * Updates internal references in an object by adding a prefix to their paths.
- * Recursively traverses the input object and modifies any local $ref references
- * by prepending the given prefix to their paths. This is used when embedding external
- * documents to maintain correct reference paths relative to the main document.
- *
- * @param input - The object to update references in
- * @param prefix - Array of path segments to prepend to internal reference paths
- * @returns void
- * @example
- * ```ts
- * const input = {
- *   foo: {
- *     $ref: '#/components/schemas/User'
- *   }
- * }
- * prefixInternalRefRecursive(input, ['definitions'])
- * // Result:
- * // {
- * //   foo: {
- * //     $ref: '#/definitions/components/schemas/User'
- * //   }
- * // }
- * ```
- */
-export declare function prefixInternalRefRecursive(input: unknown, prefix: string[]): void;
-/**
- * Represents a plugin that handles resolving references from external sources.
- * Plugins are responsible for fetching and processing data from different sources
- * like URLs or the filesystem. Each plugin must implement validation to determine
- * if it can handle a specific reference, and an execution function to perform
- * the actual resolution.
- *
- * @property validate - Determines if this plugin can handle the given reference
- * @property exec - Fetches and processes the reference, returning the resolved data
- */
-export type Plugin = {
-    validate: (value: string) => boolean;
-    exec: (value: string) => Promise<ResolveResult>;
-};
-/**
- * Configuration options for the bundler.
- * Controls how external references are resolved and processed during bundling.
- */
-type Config = {
-    /**
-     * Array of plugins that handle resolving references from different sources.
-     * Each plugin is responsible for fetching and processing data from specific sources
-     * like URLs or the filesystem.
-     */
-    plugins: Plugin[];
-    /**
-     * Optional root object that serves as the base document when bundling a subpart.
-     * This allows resolving references relative to the root document's location,
-     * ensuring proper path resolution for nested references.
-     */
-    root?: UnknownObject;
-    /**
-     * Optional cache to store promises of resolved references.
-     * Helps avoid duplicate fetches/reads of the same resource by storing
-     * the resolution promises for reuse.
-     */
-    cache?: Map<string, Promise<ResolveResult>>;
-    /**
-     * Cache of visited nodes during partial bundling.
-     * Used to prevent re-bundling the same tree multiple times when doing partial bundling,
-     * improving performance by avoiding redundant processing of already bundled sections.
-     */
-    visitedNodes?: Set<unknown>;
-    /**
-     * Enable tree shaking to optimize the bundle size.
-     * When enabled, only the parts of external documents that are actually referenced
-     * will be included in the final bundle.
-     */
-    treeShake: boolean;
-    /**
-     * Optional flag to generate a URL map.
-     * When enabled, tracks the original source URLs of bundled references
-     * in an x-ext-urls section for reference mapping.
-     */
-    urlMap?: boolean;
-    /**
-     * Optional function to compress input URLs or file paths before bundling.
-     * Returns either a Promise resolving to the compressed string or the compressed string directly.
-     */
-    compress?: (value: string) => Promise<string> | string;
-    /**
-     * Optional hooks to monitor the bundler's lifecycle.
-     * Allows tracking the progress and status of reference resolution.
-     */
-    hooks?: Partial<{
-        /** Called when starting to resolve a reference */
-        onResolveStart: (node: Record<string, unknown> & Record<'$ref', unknown>) => void;
-        /** Called when a reference resolution fails */
-        onResolveError: (node: Record<string, unknown> & Record<'$ref', unknown>) => void;
-        /** Called when a reference is successfully resolved */
-        onResolveSuccess: (node: Record<string, unknown> & Record<'$ref', unknown>) => void;
-    }>;
-};
-/**
- * Bundles an OpenAPI specification by resolving all external references.
- * This function traverses the input object recursively and embeds external $ref
- * references into an x-ext section. External references can be URLs or local files.
- * The original $refs are updated to point to their embedded content in the x-ext section.
- * If the input is an object, it will be modified in place by adding an x-ext
- * property to store resolved external references.
- *
- * @param input - The OpenAPI specification to bundle. Can be either an object or string.
- *                If a string is provided, it will be resolved using the provided plugins.
- *                If no plugin can process the input, the onReferenceError hook will be invoked
- *                and an error will be emitted to the console.
- * @param config - Configuration object containing plugins and options for bundling OpenAPI specifications
- * @returns A promise that resolves to the bundled specification with all references embedded
- * @example
- * // Example with object input
- * const spec = {
- *   paths: {
- *     '/users': {
- *       $ref: 'https://example.com/schemas/users.yaml'
- *     }
- *   }
- * }
- *
- * const bundled = await bundle(spec, {
- *   plugins: [fetchUrls()],
- *   treeShake: true,
- *   urlMap: true,
- *   hooks: {
- *     onResolveStart: (ref) => console.log('Resolving:', ref.$ref),
- *     onResolveSuccess: (ref) => console.log('Resolved:', ref.$ref),
- *     onResolveError: (ref) => console.log('Failed to resolve:', ref.$ref)
- *   }
- * })
- * // Result:
- * // {
- * //   paths: {
- * //     '/users': {
- * //       $ref: '#/x-ext/abc123'
- * //     }
- * //   },
- * //   'x-ext': {
- * //     'abc123': {
- * //       // Resolved content from users.yaml
- * //     }
- * //   },
- * //   'x-ext-urls': {
- * //     'https://example.com/schemas/users.yaml': 'abc123'
- * //   }
- * // }
- *
- * // Example with URL input
- * const bundledFromUrl = await bundle('https://example.com/openapi.yaml', {
- *   plugins: [fetchUrls()],
- *   treeShake: true,
- *   urlMap: true,
- *   hooks: {
- *     onResolveStart: (ref) => console.log('Resolving:', ref.$ref),
- *     onResolveSuccess: (ref) => console.log('Resolved:', ref.$ref),
- *     onResolveError: (ref) => console.log('Failed to resolve:', ref.$ref)
- *   }
- * })
- * // The function will first fetch the OpenAPI spec from the URL,
- * // then bundle all its external references into the x-ext section
- */
-export declare function bundle(input: UnknownObject | string, config: Config): Promise<object>;
-export {};
-//# sourceMappingURL=bundle.d.ts.map

package/dist/utils/bundle/bundle.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["../../../src/utils/bundle/bundle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAS5C;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,WAOxC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,WAEvC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED,MAAM,MAAM,aAAa,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAA;CAAE,CAAA;AA2BvE;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAO7E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAyBvE;AAiCD;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAMhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAgB1E;AAqFD;;;;;;;;;GASG;AACH,MAAM,MAAM,MAAM,GAAG;IAEnB,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAA;IAEpC,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;CAChD,CAAA;AAED;;;GAGG;AACH,KAAK,MAAM,GAAG;IACZ;;;;OAIG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;IAEjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,aAAa,CAAA;IAEpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAA;IAE3C;;;;OAIG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IAE3B;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;IAEtD;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;QACd,kDAAkD;QAClD,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;QACjF,+CAA+C;QAC/C,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;QACjF,uDAAuD;QACvD,gBAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;KACpF,CAAC,CAAA;CACH,CAAA;AAuBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,wBAAsB,MAAM,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,mBA6MzE"}