@stoplight/elements-dev-portal 3.0.12-beta-0.1 → 3.0.13

package/src/__fixtures__/table-of-contents.json

@@ -1,144 +0,0 @@
-{
-  "showPoweredBy": true,
-  "items": [
-    { "id": "ZG9jOjE", "title": "Introduction", "type": "article", "slug": "ZG9jOjE-introduction", "meta": "" },
-    { "id": "ZG9jOjI", "title": "UI Overview", "type": "article", "slug": "ZG9jOjI-ui-overview", "meta": "" },
-    { "title": "markdown" },
-    { "id": "ZG9jOjM", "title": "Markdown Basics", "type": "article", "slug": "ZG9jOjM-markdown-basics", "meta": "" },
-    {
-      "id": "ZG9jOjQ",
-      "title": "Stoplight Flavored Markdown (SMD)",
-      "type": "article",
-      "slug": "ZG9jOjQ-stoplight-flavored-markdown-smd",
-      "meta": ""
-    },
-    { "title": "APIS" },
-    {
-      "id": "YXBpOjEy",
-      "title": "Swagger Petstore",
-      "type": "http_service",
-      "slug": "YXBpOjEy-swagger-petstore",
-      "meta": "",
-      "items": [
-        {
-          "title": "pets",
-          "items": [
-            {
-              "id": "b3A6MTU",
-              "title": "Create a pet",
-              "type": "http_operation",
-              "slug": "b3A6MTU-create-a-pet",
-              "meta": "post"
-            },
-            {
-              "id": "b3A6MTY",
-              "title": "Info for a specific pet",
-              "type": "http_operation",
-              "slug": "b3A6MTY-info-for-a-specific-pet",
-              "meta": "get"
-            },
-            {
-              "id": "b3A6MTQ",
-              "title": "List all pets",
-              "type": "http_operation",
-              "slug": "b3A6MTQ-list-all-pets",
-              "meta": "get"
-            }
-          ]
-        },
-        {
-          "title": "Schemas",
-          "items": [{ "id": "c2NoOjg", "title": "Pets", "type": "model", "slug": "c2NoOjg-pets", "meta": "" }]
-        }
-      ]
-    },
-    {
-      "id": "YXBpOjM4OTQzNA",
-      "title": "To-dos",
-      "type": "http_service",
-      "slug": "YXBpOjM4OTQzNA-to-dos",
-      "meta": "",
-      "items": [
-        {
-          "id": "b3A6Mzg5NDM1",
-          "title": "List Todos",
-          "type": "http_operation",
-          "slug": "b3A6Mzg5NDM1-list-todos",
-          "meta": "get"
-        },
-        {
-          "id": "b3A6Mzg5NDM2",
-          "title": "Create Todo",
-          "type": "http_operation",
-          "slug": "b3A6Mzg5NDM2-create-todo",
-          "meta": "post"
-        },
-        {
-          "id": "b3A6Mzg5NDM4",
-          "title": "Get Todo",
-          "type": "http_operation",
-          "slug": "b3A6Mzg5NDM4-get-todo",
-          "meta": "get"
-        },
-        {
-          "id": "b3A6OTE0NjUxMA",
-          "title": "Replace Todo",
-          "type": "http_operation",
-          "slug": "b3A6OTE0NjUxMA-replace-todo",
-          "meta": "put"
-        },
-        {
-          "id": "b3A6Mzg5NDM5",
-          "title": "Delete Todo",
-          "type": "http_operation",
-          "slug": "b3A6Mzg5NDM5-delete-todo",
-          "meta": "delete"
-        },
-        {
-          "id": "b3A6Mzg5NDQw",
-          "title": "Update Todo",
-          "type": "http_operation",
-          "slug": "b3A6Mzg5NDQw-update-todo",
-          "meta": "patch"
-        },
-        {
-          "title": "Users",
-          "items": [
-            {
-              "id": "b3A6OTE0NjUxMw",
-              "title": "Get User",
-              "type": "http_operation",
-              "slug": "b3A6OTE0NjUxMw-get-user",
-              "meta": "get"
-            },
-            {
-              "id": "b3A6OTE0NjUxNA",
-              "title": "Delete User",
-              "type": "http_operation",
-              "slug": "b3A6OTE0NjUxNA-delete-user",
-              "meta": "delete"
-            },
-            {
-              "id": "b3A6OTE0NjUxNQ",
-              "title": "Create User",
-              "type": "http_operation",
-              "slug": "b3A6OTE0NjUxNQ-create-user",
-              "meta": "post"
-            }
-          ]
-        },
-        {
-          "title": "Schemas",
-          "items": [
-            { "id": "c2NoOjkxNDY1MDA", "title": "Todo", "type": "model", "slug": "c2NoOjkxNDY1MDA-todo", "meta": "" },
-            { "id": "c2NoOjkxNDY1MDE", "title": "User", "type": "model", "slug": "c2NoOjkxNDY1MDE-user", "meta": "" }
-          ]
-        }
-      ]
-    },
-    { "title": "Schemas" },
-    { "id": "c2NoOjU", "title": "Error", "type": "model", "slug": "c2NoOjU-error", "meta": "" },
-    { "id": "c2NoOjY", "title": "Category", "type": "model", "slug": "c2NoOjY-category", "meta": "" },
-    { "id": "c2NoOjc", "title": "Pet", "type": "model", "slug": "c2NoOjc-pet", "meta": "" }
-  ]
-}

package/src/components/BranchSelector/BranchSelector.spec.tsx

@@ -1,61 +0,0 @@
-import { Provider as MosaicProvider } from '@stoplight/mosaic';
-import { screen } from '@testing-library/dom';
-import { render } from '@testing-library/react';
-import userEvent from '@testing-library/user-event';
-import * as React from 'react';
-
-import { Branch } from '../../types';
-import { BranchSelector } from './BranchSelector';
-
-export const branches: Branch[] = [
-  {
-    id: 0,
-    slug: 'main',
-    is_default: true,
-    is_published: false,
-    name: 'main-name',
-  },
-  {
-    id: 1,
-    slug: 'beta',
-    is_default: false,
-    is_published: false,
-  },
-  {
-    id: 2,
-    slug: 'feature-branch',
-    is_default: false,
-    is_published: false,
-  },
-];
-
-const BranchSelectorWrapper: React.FC = () => {
-  const [branchSlug, setBranchSlug] = React.useState('main');
-
-  return (
-    <MosaicProvider>
-      <BranchSelector branchSlug={branchSlug} branches={branches} onChange={branch => setBranchSlug(branch.slug)} />
-    </MosaicProvider>
-  );
-};
-
-function getBranchSelector() {
-  return screen.getByRole('button');
-}
-
-describe('Branch selector', () => {
-  it('shows the default branch by default', () => {
-    render(<BranchSelectorWrapper />);
-
-    expect(getBranchSelector()).toHaveTextContent('main-name');
-  });
-
-  it('selects a branch', () => {
-    render(<BranchSelectorWrapper />);
-
-    userEvent.click(getBranchSelector());
-    userEvent.click(screen.getByRole('menuitemradio', { name: 'beta' }));
-
-    expect(getBranchSelector()).toHaveTextContent('beta');
-  });
-});

package/src/components/BranchSelector/BranchSelector.stories.tsx

@@ -1,41 +0,0 @@
-import { Box } from '@stoplight/mosaic';
-import { Story } from '@storybook/react';
-import * as React from 'react';
-
-import { useGetBranches } from '../../hooks/useGetBranches';
-import { BranchSelector } from './';
-
-// Wrapper to show how to use the node content hook
-const BranchSelectorWrapper = ({ projectId }: { projectId: string }) => {
-  const [branchSlug, setBranchSlug] = React.useState('master');
-  const { data } = useGetBranches({ projectId });
-
-  if (data) {
-    return (
-      <Box mt={10} w={40}>
-        <BranchSelector branchSlug={branchSlug} branches={data.items} onChange={branch => setBranchSlug(branch.slug)} />
-      </Box>
-    );
-  }
-
-  return <Box>Loading</Box>;
-};
-
-export default {
-  title: 'Public/BranchSelector',
-  component: BranchSelectorWrapper,
-  argTypes: {
-    projectId: { table: { category: 'Input' } },
-    platformUrl: { table: { category: 'Input' } },
-  },
-  args: {
-    projectId: 'cHJqOjYwNjYx',
-    platformUrl: 'https://stoplight.io',
-  },
-};
-
-export const Playground: Story<{ nodeSlug: string; projectId: string; branchSlug?: string }> = args => (
-  <BranchSelectorWrapper {...args} />
-);
-
-Playground.storyName = 'Studio Demo';

package/src/components/BranchSelector/BranchSelector.tsx

@@ -1,50 +0,0 @@
-import { FieldButton, Menu } from '@stoplight/mosaic';
-import * as React from 'react';
-
-import { Branch } from '../../types';
-
-export type BranchSelectorProps = {
-  branchSlug: string;
-  branches: Branch[];
-  onChange: (branch: Branch) => void;
-};
-
-export const BranchSelector = ({ branchSlug, branches, onChange }: BranchSelectorProps) => {
-  const currentBranch = branches.find(branch => (!branchSlug ? branch.is_default : branch.slug === branchSlug));
-  const handleChange = React.useCallback(
-    (selectedSlug: React.ReactText) => {
-      const selectedBranch = branches.find(branch => branch.slug === selectedSlug);
-      if (selectedBranch) {
-        onChange(selectedBranch);
-      }
-    },
-    [onChange, branches],
-  );
-
-  return (
-    <Menu
-      aria-label="Versions"
-      placement="bottom left"
-      closeOnPress
-      matchTriggerWidth
-      renderTrigger={({ isOpen }) => (
-        <FieldButton w="full" icon="layer-group" px={4} h="md" active={isOpen} borderR={0} roundedR="none">
-          {currentBranch?.name || currentBranch?.slug || 'Choose a version'}
-        </FieldButton>
-      )}
-      items={[
-        {
-          type: 'option_group',
-          title: 'Versions',
-          onChange: handleChange,
-          value: currentBranch?.slug || '',
-          children: branches.map(branch => ({
-            title: branch.name || branch.slug,
-            value: branch.slug,
-            meta: branch.is_default ? 'Default' : undefined,
-          })),
-        },
-      ]}
-    />
-  );
-};

package/src/components/BranchSelector/index.tsx

@@ -1 +0,0 @@
-export * from './BranchSelector';

package/src/components/DevPortalProvider/index.tsx

@@ -1,25 +0,0 @@
-import { withMosaicProvider, withPersistenceBoundary, withQueryClientProvider } from '@stoplight/elements-core';
-import * as React from 'react';
-
-export type DevPortalProviderProps = {
-  platformUrl?: string;
-  platformAuthToken?: string;
-  isLoggedIn?: boolean;
-};
-
-export const PlatformContext = React.createContext<DevPortalProviderProps>({ platformUrl: 'https://stoplight.io' });
-
-const PlatformProvider: React.FC<DevPortalProviderProps> = ({
-  platformUrl = 'https://stoplight.io',
-  platformAuthToken,
-  isLoggedIn,
-  children,
-}) => {
-  return (
-    <PlatformContext.Provider value={{ platformUrl, platformAuthToken, isLoggedIn }}>
-      {children}
-    </PlatformContext.Provider>
-  );
-};
-
-export const DevPortalProvider = withPersistenceBoundary(withQueryClientProvider(withMosaicProvider(PlatformProvider)));

package/src/components/Forbidden.tsx

@@ -1,11 +0,0 @@
-import { Box, Flex, Heading, VStack } from '@stoplight/mosaic';
-import React from 'react';
-
-export const Forbidden = () => (
-  <Flex align="center" justify="center" flexGrow>
-    <VStack spacing={4} align="center">
-      <Heading size={1}>Forbidden</Heading>
-      <Box as="p">You don't have permission to access this resource</Box>
-    </VStack>
-  </Flex>
-);

package/src/components/Loading.tsx

@@ -1,9 +0,0 @@
-import { faCircleNotch } from '@fortawesome/free-solid-svg-icons';
-import { Flex, Icon } from '@stoplight/mosaic';
-import React from 'react';
-
-export const Loading = () => (
-  <Flex justify="center" alignItems="center" w="full" minH="screen" color="muted">
-    <Icon icon={faCircleNotch} size="3x" spin />
-  </Flex>
-);

package/src/components/NodeContent/NodeContent.spec.tsx

@@ -1,128 +0,0 @@
-import { CustomLinkComponent } from '@stoplight/elements-core';
-import { fireEvent, render, screen } from '@testing-library/react';
-import * as React from 'react';
-import { MemoryRouter } from 'react-router-dom';
-
-import nodeContent from '../../__fixtures__/node-content.json';
-import { NodeContent } from './NodeContent';
-
-const DummyLink: CustomLinkComponent = ({ children, ...propsRest }) => {
-  return <a {...propsRest}>{children}</a>;
-};
-
-const data = {
-  id: '35hsi28m3b2m0',
-  branch_node_id: -1,
-  type: 'article',
-  uri: '/docs/test.md',
-  slug: '35hsi28m3b2m0-header',
-  title: 'Header',
-  summary:
-    'This is the main header section.\nThe beginning of an awesome article...\nLorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetu...',
-  project_id: 'cHJqOjQz',
-  branch_id: 'YnI6MjQw',
-  branch: 'main',
-  links: {},
-  outbound_edges: [
-    {
-      id: '35hsi28m3b2m0',
-      type: 'article',
-      slug: '35hsi28m3b2m0-header',
-      title: 'Header',
-      uri: '/docs/test.md',
-    },
-  ],
-  inbound_edges: [],
-  data: '---\nstoplight-id: 35hsi28m3b2m0\n---\n\n# Header\nThis is the main header section.\nThe beginning of an awesome article...\nLorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Naggggm quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc,\n\n## Subheader\nThis is the subheader section. More ContentHere is some more dummy content to fill the page.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus lacinia odio vitae vestibulum vestibulum. Cras venenatis euismod malesuada.\nThe beginning of an awesome article...\nLorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Naggggm quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc,\n### External\nLinkFor more information, visit Google.\nThe beginning of an awesome article...\nLorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Naggggm quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc,\n\n[Go to header](#header)\n\n[Go to subheader](#subheader)\n\n<a href="https://www.google.com">Go to Google</a>',
-};
-describe(NodeContent.name, () => {
-  it('renders correctly', async () => {
-    const { unmount } = render(
-      <MemoryRouter>
-        <NodeContent node={nodeContent} Link={DummyLink} />
-      </MemoryRouter>,
-    );
-
-    expect(screen.getByRole('heading', { name: /create todo/i })).toBeInTheDocument();
-    expect(
-      await screen.findByText(
-        'Markdown is supported in descriptions. Add information here for users to get accustomed to endpoints',
-      ),
-    ).toBeInTheDocument();
-
-    unmount();
-  });
-
-  it('shows TryIt by default', () => {
-    const { unmount } = render(
-      <MemoryRouter>
-        <NodeContent node={nodeContent} Link={DummyLink} />
-      </MemoryRouter>,
-    );
-
-    expect(screen.getByText(/send api request/i)).toBeInTheDocument();
-
-    unmount();
-  });
-
-  it('can hide TryIt', () => {
-    const { unmount } = render(
-      <MemoryRouter>
-        <NodeContent node={nodeContent} Link={DummyLink} hideTryIt />
-      </MemoryRouter>,
-    );
-
-    expect(screen.queryByText(/send api request/i)).not.toBeInTheDocument();
-
-    unmount();
-  });
-
-  it('can hide SecurityInfo', () => {
-    const { unmount } = render(
-      <MemoryRouter>
-        <NodeContent node={nodeContent} Link={DummyLink} hideSecurityInfo />
-      </MemoryRouter>,
-    );
-
-    expect(screen.getByRole('heading', { name: /create todo/i })).toBeInTheDocument();
-    expect(screen.queryByText(/API Key/i)).not.toBeInTheDocument();
-
-    unmount();
-  });
-});
-
-describe('NodeContent Component Navigation Links', () => {
-  const originalLocation = window.location;
-  beforeAll(() => {
-    delete (window as any).location;
-    (window as any).location = {
-      ...originalLocation,
-      pathname: data.slug,
-    };
-  });
-
-  it('renders links with correct href attributes and navigates to target sections on click', () => {
-    const { unmount } = render(
-      <MemoryRouter>
-        <NodeContent node={data} Link={DummyLink} hideSecurityInfo />
-      </MemoryRouter>,
-    );
-
-    const headerElement = screen.getByRole('link', { name: /Go to header/i });
-    const subheaderElement = screen.getByRole('link', { name: /Go to subheader/i });
-
-    expect(headerElement).toHaveAttribute('href', '#header');
-    expect(subheaderElement).toHaveAttribute('href', '#subheader');
-    fireEvent.click(headerElement);
-
-    expect(document.getElementById('header')).toBeInTheDocument();
-    fireEvent.click(subheaderElement);
-    expect(document.getElementById('subheader')).toBeInTheDocument();
-
-    unmount();
-
-    afterAll(() => {
-      window.location = originalLocation;
-    });
-  });
-});

package/src/components/NodeContent/NodeContent.stories.tsx

@@ -1,60 +0,0 @@
-import { Story } from '@storybook/react';
-import * as React from 'react';
-
-import { useGetNodeContent } from '../../hooks/useGetNodeContent';
-import { NodeContent } from './';
-
-// Wrapper to show how to use the node content hook
-const NodeContentWrapper = ({
-  nodeSlug,
-  projectId,
-  branchSlug,
-}: {
-  nodeSlug: string;
-  projectId: string;
-  branchSlug?: string;
-}) => {
-  const { data } = useGetNodeContent({ nodeSlug, projectId, branchSlug });
-
-  return data ? (
-    <NodeContent
-      node={data}
-      Link={({ children, ...props }) => {
-        return (
-          <a
-            onClick={() => {
-              console.log('Link clicked!', props);
-            }}
-          >
-            {children}
-          </a>
-        );
-      }}
-    />
-  ) : (
-    <>Loading</>
-  );
-};
-
-export default {
-  title: 'Public/NodeContent',
-  component: NodeContentWrapper,
-  argTypes: {
-    nodeSlug: { table: { category: 'Input' } },
-    projectId: { table: { category: 'Input' } },
-    branchSlug: { table: { category: 'Input' } },
-    platformUrl: { table: { category: 'Input' } },
-  },
-  args: {
-    nodeSlug: 'b3A6Mzg5NDM2-create-todo',
-    projectId: 'cHJqOjYwNjYx',
-    branchSlug: '',
-    platformUrl: 'https://stoplight.io',
-  },
-};
-
-export const Playground: Story<{ nodeSlug: string; projectId: string; branchSlug?: string }> = args => (
-  <NodeContentWrapper {...args} />
-);
-
-Playground.storyName = 'Create Todo';