@scalar/openapi-to-markdown 1.5.3 → 1.6.0

package/dist/render-tags.js

@@ -0,0 +1,73 @@
+/** Keep tag ancestry visible without exceeding Markdown's six heading levels. */
+export const getTagSections = (tags, openapiVersion) => {
+    const nested = /^3\.2\./.test(openapiVersion);
+    const label = (tag) => (nested ? (tag.summary ?? tag.name) : tag.name);
+    const byName = new Map(tags.map((tag) => [tag.name, tag]));
+    // Duplicate names cannot identify a parent unambiguously. Preserve every declaration.
+    if (!nested || byName.size !== tags.length) {
+        return tags.map((tag) => ({ tag, title: label(tag) }));
+    }
+    const titles = new Map();
+    const parents = new Map();
+    const invalid = new Set();
+    for (const tag of tags) {
+        const chain = [];
+        const seen = new Set();
+        const pending = [tag];
+        while (pending.length) {
+            const current = pending.pop();
+            if (seen.has(current.name) || invalid.has(current.name)) {
+                // Invalid cycles and chains leading into them stay flat, like reference navigation.
+                for (const member of chain) {
+                    titles.set(member.name, label(member));
+                    invalid.add(member.name);
+                }
+                break;
+            }
+            if (titles.has(current.name)) {
+                break;
+            }
+            seen.add(current.name);
+            chain.push(current);
+            const parent = current.parent === undefined ? undefined : byName.get(current.parent);
+            if (parent) {
+                pending.push(parent);
+            }
+        }
+        for (const current of chain.reverse()) {
+            if (titles.has(current.name)) {
+                continue;
+            }
+            const parentTitle = current.parent === undefined ? undefined : titles.get(current.parent);
+            titles.set(current.name, parentTitle === undefined ? label(current) : `${parentTitle} › ${label(current)}`);
+            if (parentTitle !== undefined && current.parent !== undefined) {
+                parents.set(current.name, current.parent);
+            }
+        }
+    }
+    const children = new Map();
+    const roots = [];
+    for (const tag of tags) {
+        const parent = parents.get(tag.name);
+        if (parent === undefined) {
+            roots.push(tag);
+        }
+        else {
+            const siblings = children.get(parent) ?? [];
+            siblings.push(tag);
+            children.set(parent, siblings);
+        }
+    }
+    const sections = [];
+    const pending = roots.reverse();
+    while (pending.length) {
+        const tag = pending.pop();
+        sections.push({ tag, title: titles.get(tag.name) });
+        // Use a stack instead of recursion so deeply nested descriptions cannot exhaust the call stack.
+        const siblings = children.get(tag.name) ?? [];
+        for (const child of [...siblings].reverse()) {
+            pending.push(child);
+        }
+    }
+    return sections;
+};

package/dist/restore-boolean-schemas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"restore-boolean-schemas.d.ts","sourceRoot":"","sources":["../src/restore-boolean-schemas.ts"],"names":[],"mappings":"AAEA,kGAAkG;AAClG,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAA;AAmB1D;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,cAAc,EAAE,KAAK,MAAM,KAAG,cAAc,GAAG,SAWzF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAChC,QAAQ,OAAO,EACf,QAAQ,OAAO,EACf,WAAU,cAA2B,KACpC,IA2BF,CAAA"}
+{"version":3,"file":"restore-boolean-schemas.d.ts","sourceRoot":"","sources":["../src/restore-boolean-schemas.ts"],"names":[],"mappings":"AAEA,kGAAkG;AAClG,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAA;AAmB1D;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,cAAc,EAAE,KAAK,MAAM,KAAG,cAAc,GAAG,SAuBzF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAChC,QAAQ,OAAO,EACf,QAAQ,OAAO,EACf,WAAU,cAA2B,KACpC,IAoCF,CAAA"}

package/dist/restore-boolean-schemas.js

@@ -20,21 +20,27 @@ const schemaFields = new Set([
  * is not part of the schema tree, such as example payloads and schema metadata.
  */
 export const getChildPosition = (position, key) => {
-    if (position === 'map')
+    if (position === 'map') {
         return 'schema';
+    }
     if (position === 'schema') {
-        if (schemaMaps.has(key))
+        if (schemaMaps.has(key)) {
             return 'map';
-        if (schemaArrays.has(key) || schemaFields.has(key))
+        }
+        if (schemaArrays.has(key) || schemaFields.has(key)) {
             return 'schema';
+        }
         return undefined;
     }
-    if (key === 'schema' || key === 'itemSchema')
+    if (key === 'schema' || key === 'itemSchema') {
         return 'schema';
-    if (key === 'schemas')
+    }
+    if (key === 'schemas') {
         return 'map';
-    if (['example', 'examples', 'default', 'const', 'enum'].includes(key))
+    }
+    if (['example', 'examples', 'default', 'const', 'enum'].includes(key)) {
         return undefined;
+    }
     return 'document';
 };
 /**
@@ -45,16 +51,19 @@ export const getChildPosition = (position, key) => {
 export const restoreBooleanSchemas = (source, target, position = 'document') => {
     const seen = new WeakSet();
     const visit = (original, coerced, context) => {
-        if (context === 'schema' && typeof original === 'boolean')
+        if (context === 'schema' && typeof original === 'boolean') {
             return original;
-        if (!original || typeof original !== 'object' || !coerced || typeof coerced !== 'object' || seen.has(coerced))
+        }
+        if (!original || typeof original !== 'object' || !coerced || typeof coerced !== 'object' || seen.has(coerced)) {
             return coerced;
+        }
         seen.add(coerced);
         if (Array.isArray(original) && Array.isArray(coerced)) {
             for (const [index, value] of original.entries()) {
                 const property = Object.getOwnPropertyDescriptor(coerced, index);
-                if (!property || !('value' in property))
+                if (!property || !('value' in property)) {
                     continue;
+                }
                 Object.defineProperty(coerced, index, { ...property, value: visit(value, property.value, context) });
             }
         }
@@ -63,11 +72,13 @@ export const restoreBooleanSchemas = (source, target, position = 'document') =>
                 // Never follow inherited values or invoke setters, including __proto__.
                 // Defining an own data property still preserves those names in schema maps.
                 const property = Object.getOwnPropertyDescriptor(coerced, key);
-                if (!property || !('value' in property))
+                if (!property || !('value' in property)) {
                     continue;
+                }
                 const childContext = getChildPosition(context, key);
-                if (childContext === undefined)
+                if (childContext === undefined) {
                     continue;
+                }
                 Object.defineProperty(coerced, key, { ...property, value: visit(value, property.value, childContext) });
             }
         }

package/dist/select-document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"select-document.d.ts","sourceRoot":"","sources":["../src/select-document.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAA;AACjF,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,8DAA8D,CAAA;AAEnH,gFAAgF;AAChF,MAAM,MAAM,iBAAiB,GACzB;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,eAAe,CAAA;CACxB,GACD;IACE,WAAW,EAAE,MAAM,CAAA;CACpB,GACD;IACE,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AACL,2EAA2E;AAC3E,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GACvD,CACI;KACG,GAAG,IAAI,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,aAAa,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,GACrF,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC;CAC3B,CAAC,MAAM,aAAa,CAAC,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,EAAE,KAAK,CAAC,CAAC,CAC9C,CAAA;AAEH,mFAAmF;AACnF,MAAM,MAAM,sBAAsB,GAAG;IACnC,4GAA4G;IAC5G,gBAAgB,CAAC,EAAE;QACjB,IAAI,EAAE,QAAQ,CAAA;QACd,oFAAoF;QACpF,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,KAAK,MAAM,GAAG,SAAS,CAAA;QAC7E;;;WAGG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAC3B,CAAA;CACF,CAAA;AAED,KAAK,aAAa,GAAG;IACnB,SAAS,EAAE,iBAAiB,CAAA;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,eAAe,CAAA;KAAE,CAAA;IAClD,YAAY,EAAE,IAAI,CAAA;CACnB,CAAA;AACD,KAAK,cAAc,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,CAAA;AA+G/D,KAAK,cAAc,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,cAAc,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAEnF;;;GAGG;AACH,KAAK,cAAc,GAAG;IACpB,qDAAqD;IACrD,cAAc,EAAE,MAAM,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;IAC3D,0EAA0E;IAC1E,eAAe,EAAE,MAAM,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;IAC5D,2DAA2D;IAC3D,eAAe,EAAE,MAAM,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnD,CAAA;AA8BD,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAAI,UAAU,eAAe,KAAG,cAWhE,CAAA;AAwDD;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,eAAe,EACzB,UAAS,oBAAyB,EAClC,SAAQ,cAA+C,KACtD,eA2NF,CAAA"}
+{"version":3,"file":"select-document.d.ts","sourceRoot":"","sources":["../src/select-document.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4CAA4C,CAAA;AACjF,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,8DAA8D,CAAA;AAEnH,gFAAgF;AAChF,MAAM,MAAM,iBAAiB,GACzB;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,eAAe,CAAA;CACxB,GACD;IACE,WAAW,EAAE,MAAM,CAAA;CACpB,GACD;IACE,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AACL,2EAA2E;AAC3E,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,GACvD,CACI;KACG,GAAG,IAAI,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,aAAa,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,GACrF,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC;CAC3B,CAAC,MAAM,aAAa,CAAC,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,aAAa,EAAE,KAAK,CAAC,CAAC,CAC9C,CAAA;AAEH,mFAAmF;AACnF,MAAM,MAAM,sBAAsB,GAAG;IACnC,4GAA4G;IAC5G,gBAAgB,CAAC,EAAE;QACjB,IAAI,EAAE,QAAQ,CAAA;QACd,oFAAoF;QACpF,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,KAAK,MAAM,GAAG,SAAS,CAAA;QAC7E;;;WAGG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAC3B,CAAA;CACF,CAAA;AAED,KAAK,aAAa,GAAG;IACnB,SAAS,EAAE,iBAAiB,CAAA;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,eAAe,CAAA;KAAE,CAAA;IAClD,YAAY,EAAE,IAAI,CAAA;CACnB,CAAA;AACD,KAAK,cAAc,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,CAAA;AA+G/D,KAAK,cAAc,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,cAAc,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAEnF;;;GAGG;AACH,KAAK,cAAc,GAAG;IACpB,qDAAqD;IACrD,cAAc,EAAE,MAAM,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;IAC3D,0EAA0E;IAC1E,eAAe,EAAE,MAAM,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,CAAA;IAC5D,2DAA2D;IAC3D,eAAe,EAAE,MAAM,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnD,CAAA;AA8BD,gGAAgG;AAChG,eAAO,MAAM,oBAAoB,GAAI,UAAU,eAAe,KAAG,cAWhE,CAAA;AAwDD;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,UAAU,eAAe,EACzB,UAAS,oBAAyB,EAClC,SAAQ,cAA+C,KACtD,eA+NF,CAAA"}

package/dist/select-document.js

@@ -338,7 +338,11 @@ export const selectDocument = (document, options = {}, lookup = createDocumentLo
         for (const [key, child] of Object.entries(value)) {
             // Names such as "example" are valid map entries; only keyword positions hold opaque data.
             if (key !== '$ref-value' && (namedLevels || (!opaqueValues.has(key) && !key.startsWith('x-')))) {
-                const childNamedLevels = namedLevels ? namedLevels - 1 : key === 'callbacks' ? 2 : namedMaps.has(key) ? 1 : 0;
+                let childNamedLevels = namedLevels - 1;
+                if (!namedLevels) {
+                    const mapLevels = namedMaps.has(key) ? 1 : 0;
+                    childNamedLevels = key === 'callbacks' ? 2 : mapLevels;
+                }
                 visit(child, childNamedLevels);
             }
         }

package/package.json

@@ -16,7 +16,7 @@
     "llm",
     "swagger"
   ],
-  "version": "1.5.3",
+  "version": "1.6.0",
   "engines": {
     "node": ">=22"
   },
@@ -33,6 +33,11 @@
       "import": "./dist/browser.js",
       "types": "./dist/browser.d.ts",
       "default": "./dist/browser.js"
+    },
+    "./markdown": {
+      "import": "./dist/markdown/index.js",
+      "types": "./dist/markdown/index.d.ts",
+      "default": "./dist/markdown/index.js"
     }
   },
   "files": [
@@ -40,11 +45,11 @@
     "CHANGELOG.md"
   ],
   "dependencies": {
-    "@scalar/code-highlight": "0.4.8",
-    "@scalar/helpers": "0.16.2",
-    "@scalar/json-magic": "0.15.6",
-    "@scalar/openapi-upgrader": "0.4.3",
-    "@scalar/workspace-store": "0.68.2",
+    "@scalar/code-highlight": "0.4.10",
+    "@scalar/helpers": "0.16.4",
+    "@scalar/json-magic": "0.16.0",
+    "@scalar/openapi-upgrader": "0.4.5",
+    "@scalar/workspace-store": "0.68.4",
     "rehype-parse": "^9.0.1",
     "rehype-remark": "^10.0.1",
     "rehype-sanitize": "^6.0.0",
@@ -54,9 +59,9 @@
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@scalar/components": "0.31.0",
-    "@scalar/galaxy": "0.7.1",
-    "@scalar/themes": "0.19.0",
+    "@scalar/components": "0.32.0",
+    "@scalar/galaxy": "0.7.2",
+    "@scalar/themes": "0.19.2",
     "@tailwindcss/vite": "^4.3.3",
     "@types/mdast": "^4.0.4",
     "@vitejs/plugin-vue": "^6.0.8",