@scalar/openapi-parser 0.25.4 → 0.25.6

package/dist/utils/join/join.js

@@ -1,178 +1,292 @@
-import { bundle } from "@scalar/json-magic/bundle";
-import { mergeObjects } from "../../utils/join/merge-objects.js";
-import { upgrade } from "../../utils/upgrade.js";
+import { bundle } from '@scalar/json-magic/bundle';
+import { mergeObjects } from '../../utils/join/merge-objects.js';
+import { upgrade } from '../../utils/upgrade.js';
+/**
+ * Returns the intersection of two sets as an array.
+ *
+ * @param a - The first set
+ * @param b - The second set
+ * @returns An array containing the elements present in both sets
+ *
+ * @example
+ * const setA = new Set([1, 2, 3, 4])
+ * const setB = new Set([3, 4, 5, 6])
+ * const intersection = getSetIntersection(setA, setB)
+ * // intersection: [3, 4]
+ */
 const getSetIntersection = (a, b) => {
-  const result = [];
-  for (const value of a) {
-    if (b.has(value)) {
-      result.push(value);
+    const result = [];
+    for (const value of a) {
+        if (b.has(value)) {
+            result.push(value);
+        }
     }
-  }
-  return result;
+    return result;
 };
+/**
+ * Returns the value if it is not nullish (or, for arrays, not empty), otherwise returns the provided default value.
+ * Useful for handling OpenAPI fields that may be missing or empty.
+ */
 const withDefault = (value, defaultValue) => {
-  if (Array.isArray(value)) {
-    return value.length ? value : defaultValue;
-  }
-  if (typeof value === "object" && value !== null) {
-    return Object.keys(value).length ? value : defaultValue;
-  }
-  return value ?? defaultValue;
+    if (Array.isArray(value)) {
+        return value.length ? value : defaultValue;
+    }
+    if (typeof value === 'object' && value !== null) {
+        return Object.keys(value).length ? value : defaultValue;
+    }
+    return value ?? defaultValue;
 };
+/**
+ * Merges multiple OpenAPI PathsObjects into a single PathsObject.
+ * - If a path does not exist in the result, it is added directly.
+ * - If a path already exists, its operations (get, post, etc.) are merged.
+ * - If the same operation (e.g., "get") exists for the same path in multiple inputs,
+ *   a conflict is recorded for that path and method.
+ *
+ * @param inputs - Array of OpenAPIV3_1.PathsObject to merge
+ * @returns An object containing the merged paths and a list of conflicts
+ */
 const mergePaths = (inputs) => {
-  const result = {};
-  const conflicts = [];
-  for (const paths of inputs) {
-    if (typeof paths !== "object") {
-      continue;
-    }
-    for (const [path, pathItem] of Object.entries(paths)) {
-      if (!result[path]) {
-        result[path] = pathItem;
-        continue;
-      }
-      const intersectingKeys = getSetIntersection(new Set(Object.keys(result[path])), new Set(Object.keys(pathItem)));
-      result[path] = { ...result[path], ...pathItem };
-      intersectingKeys.forEach((key) => conflicts.push({ method: key, path }));
+    const result = {};
+    const conflicts = [];
+    for (const paths of inputs) {
+        if (typeof paths !== 'object') {
+            continue;
+        }
+        for (const [path, pathItem] of Object.entries(paths)) {
+            if (!result[path]) {
+                // If the path does not exist, add it directly
+                result[path] = pathItem;
+                continue;
+            }
+            // Find intersecting operation keys (e.g., "get", "post") for this path
+            const intersectingKeys = getSetIntersection(new Set(Object.keys(result[path])), new Set(Object.keys(pathItem)));
+            // If the path exists, merge the operations (get, post, etc.)
+            result[path] = { ...result[path], ...pathItem };
+            // Record conflicts for each intersecting operation key
+            intersectingKeys.forEach((key) => conflicts.push({ method: key, path }));
+        }
     }
-  }
-  return { paths: result, conflicts };
+    return { paths: result, conflicts };
 };
+/**
+ * Merges multiple arrays of OpenAPI TagObjects into a single array, ensuring uniqueness by tag name.
+ * - If a tag with the same name appears in multiple arrays, only the first occurrence is included in the result.
+ *
+ * @param inputs - Array of arrays of OpenAPIV3_1.TagObject to merge
+ * @returns An array of unique TagObjects (by name)
+ */
 const mergeTags = (inputs) => {
-  const cache = /* @__PURE__ */ new Set();
-  const result = [];
-  for (const tags of inputs) {
-    for (const tag of tags) {
-      if (!cache.has(tag.name)) {
-        result.push(tag);
-      }
-      cache.add(tag.name);
+    const cache = new Set();
+    const result = [];
+    for (const tags of inputs) {
+        for (const tag of tags) {
+            if (!cache.has(tag.name)) {
+                result.push(tag);
+            }
+            cache.add(tag.name);
+        }
     }
-  }
-  return result;
+    return result;
 };
+/**
+ * Merges multiple arrays of OpenAPI ServerObjects into a single array, ensuring uniqueness by server URL.
+ * - If a server with the same URL appears in multiple arrays, only the first occurrence is included in the result.
+ *
+ * @param inputs - Array of arrays of OpenAPIV3_1.ServerObject to merge
+ * @returns An array of unique ServerObjects (by url)
+ */
 const mergeServers = (inputs) => {
-  const cache = /* @__PURE__ */ new Set();
-  const result = [];
-  for (const servers of inputs) {
-    for (const server of servers) {
-      if (!cache.has(server.url)) {
-        result.push(server);
-      }
-      cache.add(server.url);
+    const cache = new Set();
+    const result = [];
+    for (const servers of inputs) {
+        for (const server of servers) {
+            if (!cache.has(server.url)) {
+                result.push(server);
+            }
+            cache.add(server.url);
+        }
     }
-  }
-  return result;
+    return result;
 };
+/**
+ * Merges multiple OpenAPI ComponentsObject instances into a single components object.
+ * - If a component with the same type and name appears in multiple inputs, only the first occurrence is included.
+ * - Any conflicts (duplicate component names within the same type) are recorded in the `conflicts` array.
+ *
+ * @param inputs - Array of OpenAPIV3_1.ComponentsObject to merge
+ * @returns An object containing the merged components and an array of conflicts
+ */
 const mergeComponents = (inputs) => {
-  const result = {};
-  const conflicts = [];
-  for (const components of inputs) {
-    if (typeof components !== "object") {
-      continue;
-    }
-    for (const [key, value] of Object.entries(components)) {
-      for (const [name, component] of Object.entries(value)) {
-        if (!result[key]) {
-          result[key] = {};
+    const result = {};
+    const conflicts = [];
+    for (const components of inputs) {
+        if (typeof components !== 'object') {
+            continue;
         }
-        if (result[key][name]) {
-          conflicts.push({ componentType: key, name });
-        } else {
-          result[key][name] = component;
+        // Merge each component type (schemas, responses, parameters, etc.)
+        for (const [key, value] of Object.entries(components)) {
+            for (const [name, component] of Object.entries(value)) {
+                if (!result[key]) {
+                    result[key] = {};
+                }
+                if (result[key][name]) {
+                    // If the component already exists, record a conflict
+                    conflicts.push({ componentType: key, name });
+                }
+                else {
+                    // Otherwise, add the component
+                    result[key][name] = component;
+                }
+            }
         }
-      }
     }
-  }
-  return { components: result, conflicts };
+    return { components: result, conflicts };
 };
+/**
+ * Prefixes component names and their references in multiple OpenAPI documents.
+ *
+ * This function mutates each input document in-place by:
+ *   1. Prefixing all component names (e.g., schema names) with the corresponding prefix.
+ *   2. Updating all $ref values that point to components to use the prefixed names.
+ *
+ * This is useful when merging multiple OpenAPI documents to avoid component name collisions.
+ *
+ * @param inputs - Array of OpenAPI documents to mutate.
+ * @param prefixes - Array of prefixes to apply to each document's components.
+ */
 const prefixComponents = async (inputs, prefixes) => {
-  for (const index of inputs.keys()) {
-    await bundle(inputs[index], {
-      treeShake: false,
-      urlMap: false,
-      plugins: [
-        // Plugin to update $ref values to use the prefixed component names
-        {
-          type: "lifecycle",
-          onBeforeNodeProcess: (node) => {
-            const ref = node["$ref"];
-            if (typeof ref !== "string") {
-              return;
-            }
-            if (!ref.startsWith("#/components/")) {
-              return;
-            }
-            const parts = ref.split("/");
-            if (parts.length < 4) {
-              return;
-            }
-            parts[3] = `${prefixes[index] ?? ""}${parts[3]}`;
-            node["$ref"] = parts.join("/");
-          }
-        },
-        // Plugin to rename component keys with the prefix
-        {
-          type: "lifecycle",
-          onBeforeNodeProcess: (node, context) => {
-            if (context.path.length === 2 && context.path[0] === "components") {
-              const prefix = prefixes[index];
-              Object.keys(node).forEach((key) => {
-                const newKey = `${prefix ?? ""}${key}`;
-                const childNode = node[key];
-                delete node[key];
-                node[newKey] = childNode;
-              });
-            }
-          }
-        }
-      ]
-    });
-  }
+    for (const index of inputs.keys()) {
+        await bundle(inputs[index], {
+            treeShake: false,
+            urlMap: false,
+            plugins: [
+                // Plugin to update $ref values to use the prefixed component names
+                {
+                    type: 'lifecycle',
+                    onBeforeNodeProcess: (node) => {
+                        const ref = node['$ref'];
+                        if (typeof ref !== 'string') {
+                            return;
+                        }
+                        // Only process refs that point to components
+                        if (!ref.startsWith('#/components/')) {
+                            return;
+                        }
+                        const parts = ref.split('/');
+                        // Ensure the ref has the expected structure: #/components/{type}/{name}
+                        if (parts.length < 4) {
+                            return;
+                        }
+                        // Prefix the component name (parts[3]) with the provided prefix
+                        parts[3] = `${prefixes[index] ?? ''}${parts[3]}`;
+                        node['$ref'] = parts.join('/');
+                    },
+                },
+                // Plugin to rename component keys with the prefix
+                {
+                    type: 'lifecycle',
+                    onBeforeNodeProcess: (node, context) => {
+                        // Check if the node is a component type object (e.g., schemas, responses) under "components"
+                        if (context.path.length === 2 && context.path[0] === 'components') {
+                            const prefix = prefixes[index];
+                            Object.keys(node).forEach((key) => {
+                                const newKey = `${prefix ?? ''}${key}`;
+                                const childNode = node[key];
+                                delete node[key];
+                                node[newKey] = childNode;
+                            });
+                        }
+                    },
+                },
+            ],
+        });
+    }
 };
-const join = async (inputs, config) => {
-  const upgraded = inputs.map((it) => upgrade(it).specification);
-  if (config?.prefixComponents) {
-    await prefixComponents(upgraded, config.prefixComponents);
-  }
-  upgraded.reverse();
-  const info = upgraded.reduce((acc, curr) => {
-    if (curr.info && typeof curr.info === "object") {
-      return mergeObjects(acc, curr.info);
+/**
+ * Joins multiple OpenAPI documents into a single document.
+ *
+ * - Merges the "info" object, paths, webhooks, tags, and servers from all input documents.
+ * - If there are conflicting paths or webhooks (same path and method), returns a list of conflicts.
+ * - Only the first occurrence of a tag (by name) or server (by url) is included.
+ * - The merge is performed in reverse order, so the first document in the input array has the highest precedence.
+ *
+ * @param inputs - Array of OpenAPI documents (UnknownObject) to join
+ * @returns {JoinResult} - { ok: true, document } if successful, or { ok: false, conflicts } if there are conflicts
+ *
+ * @example
+ * const doc1 = {
+ *   info: { title: "API 1", version: "1.0.0" },
+ *   paths: { "/foo": { get: { summary: "Get Foo" } } },
+ *   tags: [{ name: "foo" }],
+ *   servers: [{ url: "https://api1.example.com" }]
+ * }
+ * const doc2 = {
+ *   info: { description: "Second API" },
+ *   paths: { "/bar": { get: { summary: "Get Bar" } } },
+ *   tags: [{ name: "bar" }],
+ *   servers: [{ url: "https://api2.example.com" }]
+ * }
+ * const result = join([doc1, doc2])
+ * // result.ok === true
+ * // result.document.info.title === "API 1"
+ * // result.document.info.description === "Second API"
+ * // result.document.paths has both "/foo" and "/bar"
+ * // result.document.tags contains both "foo" and "bar"
+ * // result.document.servers contains both server URLs
+ */
+export const join = async (inputs, config) => {
+    // Reverse the input list and upgrade them (first input has highest precedence)
+    const upgraded = inputs.map((it) => upgrade(it).specification);
+    // Preprocess documents by prefixing components if specified
+    if (config?.prefixComponents) {
+        await prefixComponents(upgraded, config.prefixComponents);
+    }
+    // Reverse the upgraded documents to ensure the first document has the highest precedence
+    upgraded.reverse();
+    // Merge only the "info" object from all inputs
+    const info = upgraded.reduce((acc, curr) => {
+        if (curr.info && typeof curr.info === 'object') {
+            return mergeObjects(acc, curr.info);
+        }
+        return acc;
+    }, {});
+    // Merge paths from all documents, collecting conflicts
+    const { paths, conflicts: pathConflicts } = mergePaths(upgraded.map((it) => it.paths ?? {}));
+    // Merge webhooks from all documents, collecting conflicts
+    const { paths: webhooks, conflicts: webhookConflicts } = mergePaths(upgraded.map((it) => it.webhooks ?? {}));
+    // Merge tags, ensuring uniqueness by tag name
+    const tags = mergeTags(upgraded.map((it) => it.tags ?? []));
+    // Merge servers, ensuring uniqueness by server url
+    const servers = mergeServers(upgraded.map((it) => it.servers ?? []));
+    // Merge components, collecting conflicts
+    const { components, conflicts: componentConflicts } = mergeComponents(upgraded.map((it) => it.components ?? {}));
+    // Merge all documents in the upgraded array into a single object (shallow merge)
+    const result = upgraded.reduce((acc, curr) => ({ ...acc, ...curr }), {});
+    // Collect all conflicts (paths and webhooks)
+    const conflicts = [
+        ...pathConflicts.map((it) => ({ type: 'path', ...it })),
+        ...webhookConflicts.map((it) => ({ type: 'webhook', ...it })),
+        ...componentConflicts.map((it) => ({ type: 'component', ...it })),
+    ];
+    // If there are any conflicts, return them
+    if (conflicts.length) {
+        return {
+            ok: false,
+            conflicts,
+        };
     }
-    return acc;
-  }, {});
-  const { paths, conflicts: pathConflicts } = mergePaths(upgraded.map((it) => it.paths ?? {}));
-  const { paths: webhooks, conflicts: webhookConflicts } = mergePaths(upgraded.map((it) => it.webhooks ?? {}));
-  const tags = mergeTags(upgraded.map((it) => it.tags ?? []));
-  const servers = mergeServers(upgraded.map((it) => it.servers ?? []));
-  const { components, conflicts: componentConflicts } = mergeComponents(upgraded.map((it) => it.components ?? {}));
-  const result = upgraded.reduce((acc, curr) => ({ ...acc, ...curr }), {});
-  const conflicts = [
-    ...pathConflicts.map((it) => ({ type: "path", ...it })),
-    ...webhookConflicts.map((it) => ({ type: "webhook", ...it })),
-    ...componentConflicts.map((it) => ({ type: "component", ...it }))
-  ];
-  if (conflicts.length) {
+    // Return the merged OpenAPI document
     return {
-      ok: false,
-      conflicts
+        ok: true,
+        document: {
+            ...result,
+            info,
+            paths,
+            webhooks: withDefault(webhooks, undefined),
+            tags: withDefault(tags, undefined),
+            servers: withDefault(servers, undefined),
+            components: withDefault(components, undefined),
+        },
     };
-  }
-  return {
-    ok: true,
-    document: {
-      ...result,
-      info,
-      paths,
-      webhooks: withDefault(webhooks, void 0),
-      tags: withDefault(tags, void 0),
-      servers: withDefault(servers, void 0),
-      components: withDefault(components, void 0)
-    }
-  };
-};
-export {
-  join
 };
-//# sourceMappingURL=join.js.map

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

@@ -1,20 +1,37 @@
-const mergeObjects = (a, b) => {
-  for (const key in b) {
-    if (!(key in a)) {
-      a[key] = b[key];
-    } else {
-      const aValue = a[key];
-      const bValue = b[key];
-      if (typeof aValue === "object" && aValue !== null && typeof bValue === "object" && bValue !== null) {
-        mergeObjects(aValue, bValue);
-      } else {
-        a[key] = bValue;
-      }
+/**
+ * Deep merges two objects, combining their properties recursively.
+ *
+ * ⚠️ Note: This operation assumes there are no key collisions between the objects.
+ * @param a - Target object to merge into
+ * @param b - Source object to merge from
+ * @returns The merged object (mutates and returns a)
+ *
+ * @example
+ * // Simple merge
+ * const a = { name: 'John' }
+ * const b = { age: 30 }
+ * mergeObjects(a, b) // { name: 'John', age: 30 }
+ *
+ * // Nested merge
+ * const a = { user: { name: 'John' } }
+ * const b = { user: { age: 30 } }
+ * mergeObjects(a, b) // { user: { name: 'John', age: 30 } }
+ */
+export const mergeObjects = (a, b) => {
+    for (const key in b) {
+        if (!(key in a)) {
+            a[key] = b[key];
+        }
+        else {
+            const aValue = a[key];
+            const bValue = b[key];
+            if (typeof aValue === 'object' && aValue !== null && typeof bValue === 'object' && bValue !== null) {
+                mergeObjects(aValue, bValue);
+            }
+            else {
+                a[key] = bValue; // Overwrite with b's value if not an object
+            }
+        }
     }
-  }
-  return a;
+    return a;
 };
-export {
-  mergeObjects
-};
-//# sourceMappingURL=merge-objects.js.map

package/dist/utils/load/index.js

@@ -1,5 +1 @@
-import { load } from "./load.js";
-export {
-  load
-};
-//# sourceMappingURL=index.js.map
+export { load } from './load.js';