docusaurus/packages/docusaurus-plugin-content-docs/src/__tests__/props.test.ts

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import {fromPartial} from '@total-typescript/shoehorn';
import {
  toSidebarDocItemLinkProp,
  toSidebarsProp,
  toTagDocListProp,
} from '../props';

describe('toTagDocListProp', () => {
  type Params = Parameters<typeof toTagDocListProp>[0];
  type Tag = Params['tag'];
  type Doc = Params['docs'][number];

  const allTagsPath = '/all/tags';

  it('works', () => {
    const tag: Tag = {
      label: 'tag1',
      permalink: '/tag1',
      docIds: ['id1', 'id3'],
      unlisted: false,
    };

    const doc1 = {
      id: 'id1',
      title: 'ZZZ 1',
      description: 'Description 1',
      permalink: '/doc1',
    } as Doc;
    const doc2 = {
      id: 'id2',
      title: 'XXX 2',
      description: 'Description 2',
      permalink: '/doc2',
    } as Doc;
    const doc3 = {
      id: 'id3',
      title: 'AAA 3',
      description: 'Description 3',
      permalink: '/doc3',
    } as Doc;
    const doc4 = {
      id: 'id4',
      title: 'UUU 4',
      description: 'Description 4',
      permalink: '/doc4',
    } as Doc;

    const result = toTagDocListProp({
      allTagsPath,
      tag,
      docs: [doc1, doc2, doc3, doc4],
    });

    expect(result).toEqual({
      allTagsPath,
      count: 2,
      label: tag.label,
      permalink: tag.permalink,
      unlisted: false,
      items: [doc3, doc1], // Docs sorted by title, ignore "id5" absence
    });
  });
});

describe('toSidebarDocItemLinkProp', () => {
  type Params = Parameters<typeof toSidebarDocItemLinkProp>[0];
  type Result = ReturnType<typeof toSidebarDocItemLinkProp>;
  type DocSidebarItem = Params['item'];
  type Doc = Params['doc'];

  const id = 'some-doc-id';

  const item: DocSidebarItem = {
    type: 'doc',
    id,
    label: 'doc sidebar item label',
  };

  const doc: Doc = {
    id,
    title: 'doc title',
    permalink: '/docPermalink',
    frontMatter: {},
    unlisted: false,
  };

  it('works', () => {
    const result = toSidebarDocItemLinkProp({
      item,
      doc,
    });

    expect(result).toEqual({
      type: 'link',
      docId: id,
      unlisted: false,
      label: item.label,
      autoAddBaseUrl: undefined,
      className: undefined,
      href: doc.permalink,
      customProps: undefined,
    } as Result);
  });

  it('uses unlisted from metadata and ignores frontMatter', () => {
    expect(
      toSidebarDocItemLinkProp({
        item,
        doc: {
          ...doc,
          unlisted: true,
          frontMatter: {
            unlisted: false,
          },
        },
      }).unlisted,
    ).toBe(true);

    expect(
      toSidebarDocItemLinkProp({
        item,
        doc: {
          ...doc,
          unlisted: false,
          frontMatter: {
            unlisted: true,
          },
        },
      }).unlisted,
    ).toBe(false);
  });
});

describe('toSidebarsProp', () => {
  type Params = Parameters<typeof toSidebarsProp>[0];

  it('works', () => {
    const params: Params = {
      docs: [
        fromPartial({
          id: 'doc-id-1',
          frontMatter: {},
        }),
      ],
      sidebars: {
        mySidebar: [
          {
            type: 'link',
            label: 'Example link',
            key: 'link-example-key',
            href: 'https://example.com',
          },
          {
            type: 'ref',
            label: 'Doc 1 ref',
            key: 'ref-with-doc-id-1',
            id: 'doc-id-1',
          },
          {
            type: 'ref',
            label: 'Doc 1 ref bis',
            // no key on purpose
            id: 'doc-id-1',
          },
          {
            type: 'category',
            label: 'My category',
            key: 'my-category-key',
            collapsible: false,
            collapsed: true,
            items: [
              {
                type: 'doc',
                label: 'Doc 1',
                key: 'doc-id-1',
                id: 'doc-id-1',
              },
              {
                type: 'doc',
                label: 'Doc 1 bis',
                // no key on purpose
                id: 'doc-id-1',
              },
            ],
          },
        ],
      },
    };

    const result = toSidebarsProp(params);

    expect(result).toMatchInlineSnapshot(`
      {
        "mySidebar": [
          {
            "href": "https://example.com",
            "key": "link-example-key",
            "label": "Example link",
            "type": "link",
          },
          {
            "className": undefined,
            "customProps": undefined,
            "docId": "doc-id-1",
            "href": undefined,
            "key": "ref-with-doc-id-1",
            "label": "Doc 1 ref",
            "type": "link",
            "unlisted": undefined,
          },
          {
            "className": undefined,
            "customProps": undefined,
            "docId": "doc-id-1",
            "href": undefined,
            "label": "Doc 1 ref bis",
            "type": "link",
            "unlisted": undefined,
          },
          {
            "collapsed": true,
            "collapsible": false,
            "items": [
              {
                "className": undefined,
                "customProps": undefined,
                "docId": "doc-id-1",
                "href": undefined,
                "key": "doc-id-1",
                "label": "Doc 1",
                "type": "link",
                "unlisted": undefined,
              },
              {
                "className": undefined,
                "customProps": undefined,
                "docId": "doc-id-1",
                "href": undefined,
                "label": "Doc 1 bis",
                "type": "link",
                "unlisted": undefined,
              },
            ],
            "key": "my-category-key",
            "label": "My category",
            "type": "category",
          },
        ],
      }
    `);
  });
});