docusaurus-plugin-openapi-docs 1.0.2 → 1.0.3

package/lib/openapi/openapi.js

@@ -16,10 +16,11 @@ const openapi_to_postmanv2_1 = __importDefault(require("@paloaltonetworks/openap
 const postman_collection_1 = __importDefault(require("@paloaltonetworks/postman-collection"));
 const chalk_1 = __importDefault(require("chalk"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const js_yaml_1 = __importDefault(require("js-yaml"));
 const json_refs_1 = __importDefault(require("json-refs"));
 const lodash_1 = require("lodash");
+const index_1 = require("../index");
 const createExample_1 = require("./createExample");
+const loadAndBundleSpec_1 = require("./utils/loadAndBundleSpec");
 /**
  * Finds any reference objects in the OpenAPI definition and resolves them to a finalized value.
  */
@@ -63,13 +64,39 @@ async function createPostmanCollection(openapiData) {
     }
     return await jsonToCollection(data);
 }
-function createItems(openapiData) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+function createItems(openapiData, sidebarOptions) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
     // TODO: Find a better way to handle this
     let items = [];
-    // Only create an info page if we have a description.
+    const infoId = (0, lodash_1.kebabCase)(openapiData.info.title);
+    if ((sidebarOptions === null || sidebarOptions === void 0 ? void 0 : sidebarOptions.categoryLinkSource) === "tag") {
+        // Only create an tag pages if categoryLinkSource set to tag.
+        const tags = (_a = openapiData.tags) !== null && _a !== void 0 ? _a : [];
+        // eslint-disable-next-line array-callback-return
+        tags
+            .filter((tag) => { var _a; return !((_a = tag.description) === null || _a === void 0 ? void 0 : _a.includes("SchemaDefinition")); })
+            // eslint-disable-next-line array-callback-return
+            .map((tag) => {
+            var _a;
+            const description = getTagDisplayName(tag.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []);
+            const tagId = (0, lodash_1.kebabCase)(tag.name);
+            const tagPage = {
+                type: "tag",
+                id: tagId,
+                unversionedId: tagId,
+                title: description !== null && description !== void 0 ? description : "",
+                description: description !== null && description !== void 0 ? description : "",
+                slug: "/" + tagId,
+                frontMatter: {},
+                tag: {
+                    ...tag,
+                },
+            };
+            items.push(tagPage);
+        });
+    }
     if (openapiData.info.description) {
-        const infoId = (0, lodash_1.kebabCase)(openapiData.info.title);
+        // Only create an info page if we have a description.
         const infoPage = {
             type: "info",
             id: infoId,
@@ -78,10 +105,11 @@ function createItems(openapiData) {
             description: openapiData.info.description,
             slug: "/" + infoId,
             frontMatter: {},
+            securitySchemes: (_b = openapiData.components) === null || _b === void 0 ? void 0 : _b.securitySchemes,
             info: {
                 ...openapiData.info,
-                tags: (_a = openapiData.tags) === null || _a === void 0 ? void 0 : _a.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
-                title: (_b = openapiData.info.title) !== null && _b !== void 0 ? _b : "Introduction",
+                tags: (_c = openapiData.tags) === null || _c === void 0 ? void 0 : _c.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                title: (_d = openapiData.info.title) !== null && _d !== void 0 ? _d : "Introduction",
             },
         };
         items.push(infoPage);
@@ -89,16 +117,16 @@ function createItems(openapiData) {
     for (let [path, pathObject] of Object.entries(openapiData.paths)) {
         const { $ref, description, parameters, servers, summary, ...rest } = pathObject;
         for (let [method, operationObject] of Object.entries({ ...rest })) {
-            const title = (_d = (_c = operationObject.summary) !== null && _c !== void 0 ? _c : operationObject.operationId) !== null && _d !== void 0 ? _d : "Missing summary";
+            const title = (_f = (_e = operationObject.summary) !== null && _e !== void 0 ? _e : operationObject.operationId) !== null && _f !== void 0 ? _f : "Missing summary";
             if (operationObject.description === undefined) {
                 operationObject.description =
-                    (_f = (_e = operationObject.summary) !== null && _e !== void 0 ? _e : operationObject.operationId) !== null && _f !== void 0 ? _f : "";
+                    (_h = (_g = operationObject.summary) !== null && _g !== void 0 ? _g : operationObject.operationId) !== null && _h !== void 0 ? _h : "";
             }
             const baseId = (0, lodash_1.kebabCase)(title);
-            const servers = (_h = (_g = operationObject.servers) !== null && _g !== void 0 ? _g : pathObject.servers) !== null && _h !== void 0 ? _h : openapiData.servers;
-            const security = (_j = operationObject.security) !== null && _j !== void 0 ? _j : openapiData.security;
+            const servers = (_k = (_j = operationObject.servers) !== null && _j !== void 0 ? _j : pathObject.servers) !== null && _k !== void 0 ? _k : openapiData.servers;
+            const security = (_l = operationObject.security) !== null && _l !== void 0 ? _l : openapiData.security;
             // Add security schemes so we know how to handle security.
-            const securitySchemes = (_k = openapiData.components) === null || _k === void 0 ? void 0 : _k.securitySchemes;
+            const securitySchemes = (_m = openapiData.components) === null || _m === void 0 ? void 0 : _m.securitySchemes;
             // Make sure schemes are lowercase. See: https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/79
             if (securitySchemes) {
                 for (let securityScheme of Object.values(securitySchemes)) {
@@ -108,7 +136,7 @@ function createItems(openapiData) {
                 }
             }
             let jsonRequestBodyExample;
-            const body = (_m = (_l = operationObject.requestBody) === null || _l === void 0 ? void 0 : _l.content) === null || _m === void 0 ? void 0 : _m["application/json"];
+            const body = (_p = (_o = operationObject.requestBody) === null || _o === void 0 ? void 0 : _o.content) === null || _p === void 0 ? void 0 : _p["application/json"];
             if (body === null || body === void 0 ? void 0 : body.schema) {
                 jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(body.schema);
             }
@@ -117,6 +145,7 @@ function createItems(openapiData) {
             const apiPage = {
                 type: "api",
                 id: baseId,
+                infoId: infoId !== null && infoId !== void 0 ? infoId : "",
                 unversionedId: baseId,
                 title: title,
                 description: description !== null && description !== void 0 ? description : "",
@@ -124,7 +153,7 @@ function createItems(openapiData) {
                 frontMatter: {},
                 api: {
                     ...defaults,
-                    tags: (_o = operationObject.tags) === null || _o === void 0 ? void 0 : _o.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                    tags: (_q = operationObject.tags) === null || _q === void 0 ? void 0 : _q.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
                     method,
                     path,
                     servers,
@@ -149,7 +178,7 @@ function bindCollectionToApiItems(items, postmanCollection) {
             .getPath({ unresolved: true }) // unresolved returns "/:variableName" instead of "/<type>"
             .replace(/:([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
         const apiItem = items.find((item) => {
-            if (item.type === "info") {
+            if (item.type === "info" || item.type === "tag") {
                 return false;
             }
             return item.api.path === path && item.api.method === method;
@@ -160,29 +189,30 @@ function bindCollectionToApiItems(items, postmanCollection) {
     });
 }
 async function readOpenapiFiles(openapiPath, _options) {
-    const stat = await fs_extra_1.default.lstat(openapiPath);
-    if (stat.isDirectory()) {
-        console.warn(chalk_1.default.yellow("WARNING: Loading a directory of OpenAPI definitions is experimental and subject to unannounced breaking changes."));
-        // TODO: Add config for inlcude/ignore
-        const allFiles = await (0, utils_1.Globby)(["**/*.{json,yaml,yml}"], {
-            cwd: openapiPath,
-            ignore: utils_1.GlobExcludeDefault,
-        });
-        const sources = allFiles.filter((x) => !x.includes("_category_")); // todo: regex exclude?
-        return Promise.all(sources.map(async (source) => {
-            // TODO: make a function for this
-            const fullPath = path_1.default.join(openapiPath, source);
-            const openapiString = await fs_extra_1.default.readFile(fullPath, "utf-8");
-            const data = js_yaml_1.default.load(openapiString);
-            return {
-                source: fullPath,
-                sourceDirName: path_1.default.dirname(source),
-                data,
-            };
-        }));
+    if (!(0, index_1.isURL)(openapiPath)) {
+        const stat = await fs_extra_1.default.lstat(openapiPath);
+        if (stat.isDirectory()) {
+            console.warn(chalk_1.default.yellow("WARNING: Loading a directory of OpenAPI definitions is experimental and subject to unannounced breaking changes."));
+            // TODO: Add config for inlcude/ignore
+            const allFiles = await (0, utils_1.Globby)(["**/*.{json,yaml,yml}"], {
+                cwd: openapiPath,
+                ignore: utils_1.GlobExcludeDefault,
+                deep: 1,
+            });
+            const sources = allFiles.filter((x) => !x.includes("_category_")); // todo: regex exclude?
+            return Promise.all(sources.map(async (source) => {
+                // TODO: make a function for this
+                const fullPath = path_1.default.join(openapiPath, source);
+                const data = (await (0, loadAndBundleSpec_1.loadAndBundleSpec)(fullPath));
+                return {
+                    source: fullPath,
+                    sourceDirName: path_1.default.dirname(source),
+                    data,
+                };
+            }));
+        }
     }
-    const openapiString = await fs_extra_1.default.readFile(openapiPath, "utf-8");
-    const data = js_yaml_1.default.load(openapiString);
+    const data = (await (0, loadAndBundleSpec_1.loadAndBundleSpec)(openapiPath));
     return [
         {
             source: openapiPath,
@@ -192,9 +222,9 @@ async function readOpenapiFiles(openapiPath, _options) {
     ];
 }
 exports.readOpenapiFiles = readOpenapiFiles;
-async function processOpenapiFiles(files) {
+async function processOpenapiFiles(files, sidebarOptions) {
     const promises = files.map(async (file) => {
-        const processedFile = await processOpenapiFile(file.data);
+        const processedFile = await processOpenapiFile(file.data, sidebarOptions);
         const itemsObjectsArray = processedFile[0].map((item) => ({
             ...item,
         }));
@@ -213,10 +243,10 @@ async function processOpenapiFiles(files) {
     return [items, tags];
 }
 exports.processOpenapiFiles = processOpenapiFiles;
-async function processOpenapiFile(openapiDataWithRefs) {
+async function processOpenapiFile(openapiDataWithRefs, sidebarOptions) {
     const openapiData = await resolveRefs(openapiDataWithRefs);
     const postmanCollection = await createPostmanCollection(openapiData);
-    const items = createItems(openapiData);
+    const items = createItems(openapiData, sidebarOptions);
     bindCollectionToApiItems(items, postmanCollection);
     let tags = [];
     if (openapiData.tags !== undefined) {

package/lib/openapi/openapi.test.js

@@ -22,12 +22,6 @@ describe("openapi", () => {
             const yaml = results.find((x) => x.source.endsWith("openapi.yaml"));
             expect(yaml).toBeTruthy();
             expect(yaml === null || yaml === void 0 ? void 0 : yaml.sourceDirName).toBe(".");
-            const froyo = results.find((x) => x.source.endsWith("froyo.yaml"));
-            expect(froyo).toBeTruthy();
-            expect(froyo === null || froyo === void 0 ? void 0 : froyo.sourceDirName).toBe("yogurtstore");
-            const nested = results.find((x) => x.source.endsWith("nested.yaml"));
-            expect(nested).toBeTruthy();
-            expect(nested === null || nested === void 0 ? void 0 : nested.sourceDirName).toBe("yogurtstore/nested");
         });
     });
 });

package/lib/openapi/utils/loadAndBundleSpec.d.ts

@@ -0,0 +1,3 @@
+import { OpenAPISpec } from "./types";
+export declare function loadAndBundleSpec(specUrlOrObject: object | string): Promise<OpenAPISpec>;
+export declare function convertSwagger2OpenAPI(spec: any): Promise<OpenAPISpec>;

package/lib/openapi/utils/loadAndBundleSpec.js

@@ -0,0 +1,44 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertSwagger2OpenAPI = exports.loadAndBundleSpec = void 0;
+const bundle_1 = require("@redocly/openapi-core/lib/bundle");
+const config_1 = require("@redocly/openapi-core/lib/config/config");
+const swagger2openapi_1 = require("swagger2openapi");
+async function loadAndBundleSpec(specUrlOrObject) {
+    const config = new config_1.Config({});
+    const bundleOpts = {
+        config,
+        base: process.cwd(),
+    };
+    if (typeof specUrlOrObject === "object" && specUrlOrObject !== null) {
+        bundleOpts["doc"] = {
+            source: { absoluteRef: "" },
+            parsed: specUrlOrObject,
+        };
+    }
+    else {
+        bundleOpts["ref"] = specUrlOrObject;
+    }
+    // Force dereference ?
+    // bundleOpts["dereference"] = true;
+    const { bundle: { parsed }, } = await (0, bundle_1.bundle)(bundleOpts);
+    return parsed.swagger !== undefined ? convertSwagger2OpenAPI(parsed) : parsed;
+}
+exports.loadAndBundleSpec = loadAndBundleSpec;
+function convertSwagger2OpenAPI(spec) {
+    console.warn("[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0");
+    return new Promise((resolve, reject) => (0, swagger2openapi_1.convertObj)(spec, { patch: true, warnOnly: true, text: "{}", anchors: true }, (err, res) => {
+        // TODO: log any warnings
+        if (err) {
+            return reject(err);
+        }
+        resolve(res && res.openapi);
+    }));
+}
+exports.convertSwagger2OpenAPI = convertSwagger2OpenAPI;

package/lib/openapi/utils/types.d.ts

@@ -0,0 +1,306 @@
+declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+export interface OpenAPISpec {
+    openapi: string;
+    info: OpenAPIInfo;
+    servers?: OpenAPIServer[];
+    paths: OpenAPIPaths;
+    components?: OpenAPIComponents;
+    security?: OpenAPISecurityRequirement[];
+    tags?: OpenAPITag[];
+    externalDocs?: OpenAPIExternalDocumentation;
+    "x-webhooks"?: OpenAPIPaths;
+    webhooks?: OpenAPIPaths;
+}
+export interface OpenAPIInfo {
+    title: string;
+    version: string;
+    description?: string;
+    summary?: string;
+    termsOfService?: string;
+    contact?: OpenAPIContact;
+    license?: OpenAPILicense;
+}
+export interface OpenAPIServer {
+    url: string;
+    description?: string;
+    variables?: {
+        [name: string]: OpenAPIServerVariable;
+    };
+}
+export interface OpenAPIServerVariable {
+    enum?: string[];
+    default: string;
+    description?: string;
+}
+export interface OpenAPIPaths {
+    [path: string]: OpenAPIPath;
+}
+export interface OpenAPIRef {
+    $ref: string;
+}
+export declare type Referenced<T> = OpenAPIRef | T;
+export interface OpenAPIPath {
+    summary?: string;
+    description?: string;
+    get?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    trace?: OpenAPIOperation;
+    servers?: OpenAPIServer[];
+    parameters?: Array<Referenced<OpenAPIParameter>>;
+    $ref?: string;
+}
+export interface OpenAPIXCodeSample {
+    lang: string;
+    label?: string;
+    source: string;
+}
+export interface OpenAPIOperation {
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    operationId?: string;
+    parameters?: Array<Referenced<OpenAPIParameter>>;
+    requestBody?: Referenced<OpenAPIRequestBody>;
+    responses: OpenAPIResponses;
+    callbacks?: {
+        [name: string]: Referenced<OpenAPICallback>;
+    };
+    deprecated?: boolean;
+    security?: OpenAPISecurityRequirement[];
+    servers?: OpenAPIServer[];
+    "x-codeSamples"?: OpenAPIXCodeSample[];
+    "x-code-samples"?: OpenAPIXCodeSample[];
+}
+export interface OpenAPIParameter {
+    name: string;
+    in?: OpenAPIParameterLocation;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: OpenAPIParameterStyle;
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: Referenced<OpenAPISchema>;
+    example?: any;
+    examples?: {
+        [media: string]: Referenced<OpenAPIExample>;
+    };
+    content?: {
+        [media: string]: OpenAPIMediaType;
+    };
+    encoding?: Record<string, OpenAPIEncoding>;
+    const?: any;
+}
+export interface OpenAPIExample {
+    value: any;
+    summary?: string;
+    description?: string;
+    externalValue?: string;
+}
+export interface OpenAPISchema {
+    $ref?: string;
+    type?: string | string[];
+    properties?: {
+        [name: string]: OpenAPISchema;
+    };
+    patternProperties?: {
+        [name: string]: OpenAPISchema;
+    };
+    additionalProperties?: boolean | OpenAPISchema;
+    unevaluatedProperties?: boolean | OpenAPISchema;
+    description?: string;
+    default?: any;
+    items?: OpenAPISchema | OpenAPISchema[] | boolean;
+    required?: string[];
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    deprecated?: boolean;
+    format?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    discriminator?: OpenAPIDiscriminator;
+    nullable?: boolean;
+    oneOf?: OpenAPISchema[];
+    anyOf?: OpenAPISchema[];
+    allOf?: OpenAPISchema[];
+    not?: OpenAPISchema;
+    title?: string;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean | number;
+    minimum?: number;
+    exclusiveMinimum?: boolean | number;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxProperties?: number;
+    minProperties?: number;
+    enum?: any[];
+    example?: any;
+    if?: OpenAPISchema;
+    else?: OpenAPISchema;
+    then?: OpenAPISchema;
+    examples?: any[];
+    const?: string;
+    contentEncoding?: string;
+    contentMediaType?: string;
+    prefixItems?: OpenAPISchema[];
+    additionalItems?: OpenAPISchema | boolean;
+}
+export interface OpenAPIDiscriminator {
+    propertyName: string;
+    mapping?: {
+        [name: string]: string;
+    };
+    "x-explicitMappingOnly"?: boolean;
+}
+export interface OpenAPIMediaType {
+    schema?: Referenced<OpenAPISchema>;
+    example?: any;
+    examples?: {
+        [name: string]: Referenced<OpenAPIExample>;
+    };
+    encoding?: {
+        [field: string]: OpenAPIEncoding;
+    };
+}
+export interface OpenAPIEncoding {
+    contentType: string;
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    style: OpenAPIParameterStyle;
+    explode: boolean;
+    allowReserved: boolean;
+}
+export declare type OpenAPIParameterLocation = "query" | "header" | "path" | "cookie";
+export declare type OpenAPIParameterStyle = "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+export interface OpenAPIRequestBody {
+    description?: string;
+    required?: boolean;
+    content: {
+        [mime: string]: OpenAPIMediaType;
+    };
+    "x-examples"?: {
+        [mime: string]: {
+            [name: string]: Referenced<OpenAPIExample>;
+        };
+    };
+    "x-example"?: {
+        [mime: string]: any;
+    };
+}
+export interface OpenAPIResponses {
+    [code: string]: Referenced<OpenAPIResponse>;
+}
+export interface OpenAPIResponse extends Pick<OpenAPIRequestBody, "description" | "x-examples" | "x-example"> {
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    links?: {
+        [name: string]: Referenced<OpenAPILink>;
+    };
+    content?: {
+        [mime: string]: OpenAPIMediaType;
+    };
+}
+export interface OpenAPILink {
+    $ref?: string;
+}
+export declare type OpenAPIHeader = Omit<OpenAPIParameter, "in" | "name">;
+export interface OpenAPICallback {
+    [name: string]: OpenAPIPath;
+}
+export interface OpenAPIComponents {
+    schemas?: {
+        [name: string]: Referenced<OpenAPISchema>;
+    };
+    responses?: {
+        [name: string]: Referenced<OpenAPIResponse>;
+    };
+    parameters?: {
+        [name: string]: Referenced<OpenAPIParameter>;
+    };
+    examples?: {
+        [name: string]: Referenced<OpenAPIExample>;
+    };
+    requestBodies?: {
+        [name: string]: Referenced<OpenAPIRequestBody>;
+    };
+    headers?: {
+        [name: string]: Referenced<OpenAPIHeader>;
+    };
+    securitySchemes?: {
+        [name: string]: Referenced<OpenAPISecurityScheme>;
+    };
+    links?: {
+        [name: string]: Referenced<OpenAPILink>;
+    };
+    callbacks?: {
+        [name: string]: Referenced<OpenAPICallback>;
+    };
+}
+export interface OpenAPISecurityRequirement {
+    [name: string]: string[];
+}
+export interface OpenAPISecurityScheme {
+    type: "apiKey" | "http" | "oauth2" | "openIdConnect";
+    description?: string;
+    name?: string;
+    in?: "query" | "header" | "cookie";
+    scheme?: string;
+    bearerFormat: string;
+    flows: {
+        implicit?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            authorizationUrl: string;
+        };
+        password?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+        };
+        clientCredentials?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+        };
+        authorizationCode?: {
+            refreshUrl?: string;
+            scopes: Record<string, string>;
+            tokenUrl: string;
+        };
+    };
+    openIdConnectUrl?: string;
+}
+export interface OpenAPITag {
+    name: string;
+    description?: string;
+    externalDocs?: OpenAPIExternalDocumentation;
+    "x-displayName"?: string;
+}
+export interface OpenAPIExternalDocumentation {
+    description?: string;
+    url: string;
+}
+export interface OpenAPIContact {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+export interface OpenAPILicense {
+    name: string;
+    url?: string;
+    identifier?: string;
+}
+export {};

package/lib/openapi/utils/types.js

@@ -0,0 +1,8 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/sidebars/index.js

@@ -67,7 +67,7 @@ function groupByTags(items, sidebarOptions, options, tags) {
     const tagged = apiTags
         .map((tag) => {
         // Map info object to tag
-        const infoObject = intros.find((i) => i.tags.includes(tag));
+        const taggedInfoObject = intros.find((i) => i.tags ? i.tags.includes(tag) : undefined);
         const tagObject = tags.flat().find((t) => {
             var _a;
             return (_a = (tag === t.name || tag === t["x-displayName"])) !== null && _a !== void 0 ? _a : {
@@ -77,20 +77,18 @@ function groupByTags(items, sidebarOptions, options, tags) {
         });
         // TODO: perhaps move this into a getLinkConfig() function
         let linkConfig = undefined;
-        if (infoObject !== undefined && categoryLinkSource === "info") {
+        if (taggedInfoObject !== undefined && categoryLinkSource === "info") {
             linkConfig = {
                 type: "doc",
-                id: `${basePath}/${infoObject.id}`,
+                id: `${basePath}/${taggedInfoObject.id}`,
             };
         }
         // TODO: perhaps move this into a getLinkConfig() function
         if (tagObject !== undefined && categoryLinkSource === "tag") {
-            const linkDescription = tagObject === null || tagObject === void 0 ? void 0 : tagObject.description;
+            const tagId = (0, lodash_1.kebabCase)(tagObject.name);
             linkConfig = {
-                type: "generated-index",
-                title: tag,
-                description: linkDescription,
-                slug: "/category/" + (0, lodash_1.kebabCase)(tag),
+                type: "doc",
+                id: `${basePath}/${tagId}`,
             };
         }
         // Default behavior
@@ -113,28 +111,34 @@ function groupByTags(items, sidebarOptions, options, tags) {
         };
     })
         .filter((item) => item.items.length > 0); // Filter out any categories with no items.
-    // TODO: determine how we want to handle these
-    // const untagged = [
-    //   {
-    //     type: "category" as const,
-    //     label: "UNTAGGED",
-    //     collapsible: sidebarCollapsible,
-    //     collapsed: sidebarCollapsed,
-    //     items: apiItems
-    //       .filter(({ api }) => api.tags === undefined || api.tags.length === 0)
-    //       .map(createDocItem),
-    //   },
-    // ];
+    // Handle items with no tag
+    const untaggedItems = apiItems
+        .filter(({ api }) => api.tags === undefined || api.tags.length === 0)
+        .map(createDocItem);
+    let untagged = [];
+    if (untaggedItems.length > 0) {
+        untagged = [
+            {
+                type: "category",
+                label: "UNTAGGED",
+                collapsible: sidebarCollapsible,
+                collapsed: sidebarCollapsed,
+                items: apiItems
+                    .filter(({ api }) => api.tags === undefined || api.tags.length === 0)
+                    .map(createDocItem),
+            },
+        ];
+    }
     // Shift root intro doc to top of sidebar
     // TODO: Add input validation for categoryLinkSource options
     if (rootIntroDoc && categoryLinkSource !== "info") {
         tagged.unshift(rootIntroDoc);
     }
-    return [...tagged];
+    return [...tagged, ...untagged];
 }
 function generateSidebarSlice(sidebarOptions, options, api, tags) {
     let sidebarSlice = [];
-    if (sidebarOptions.groupPathsBy === "tags") {
+    if (sidebarOptions.groupPathsBy === "tag") {
         sidebarSlice = groupByTags(api, sidebarOptions, options, tags);
     }
     return sidebarSlice;