@stoplight/elements-dev-portal 3.0.11 → 3.0.12-beta-0.2

package/src/components/BranchSelector/BranchSelector.tsx

@@ -0,0 +1,50 @@
+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

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

package/src/components/DevPortalProvider/index.tsx

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,128 @@
+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

@@ -0,0 +1,60 @@
+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';

package/src/components/NodeContent/NodeContent.tsx

@@ -0,0 +1,235 @@
+import {
+  CustomLinkComponent,
+  Docs,
+  DocsProps,
+  LinkHeading,
+  MarkdownComponentsProvider,
+  MockingProvider,
+  ReferenceResolver,
+  RouterTypeContext,
+} from '@stoplight/elements-core';
+import { CustomComponentMapping } from '@stoplight/markdown-viewer';
+import { dirname, resolve } from '@stoplight/path';
+import { NodeType } from '@stoplight/types';
+import * as React from 'react';
+import { useLocation } from 'react-router-dom';
+
+import { Node } from '../../types';
+
+// Props shared with elements-core Docs component
+type DocsBaseProps = Pick<
+  DocsProps,
+  'tryItCorsProxy' | 'tryItCredentialsPolicy' | 'nodeHasChanged' | 'nodeUnsupported'
+>;
+type DocsLayoutProps = Pick<
+  Required<DocsProps>['layoutOptions'],
+  'compact' | 'hideTryIt' | 'hideTryItPanel' | 'hideSamples' | 'hideExport' | 'hideSecurityInfo' | 'hideServerInfo'
+>;
+
+export type NodeContentProps = {
+  node: Node;
+  Link: CustomLinkComponent;
+
+  /**
+   * Allows to hide mocking button
+   */
+  hideMocking?: boolean;
+
+  /**
+   * Support for custom reference resolver
+   */
+  refResolver?: ReferenceResolver;
+
+  maxRefDepth?: number;
+
+  onExportRequest?: (type: 'original' | 'bundled') => void;
+} & DocsBaseProps &
+  DocsLayoutProps;
+
+export const NodeContent = ({
+  node,
+  Link,
+  hideMocking,
+  refResolver,
+  maxRefDepth,
+
+  // Docs base props
+  tryItCorsProxy,
+  tryItCredentialsPolicy,
+  nodeHasChanged,
+  nodeUnsupported,
+
+  // Docs layout props
+  compact,
+  hideTryIt,
+  hideSamples,
+  hideTryItPanel,
+  hideSecurityInfo,
+  hideServerInfo,
+
+  // Exporting
+  hideExport,
+  onExportRequest,
+}: NodeContentProps) => {
+  return (
+    <NodeLinkContext.Provider value={[node, Link]}>
+      <MarkdownComponentsProvider
+        value={{
+          a: LinkComponent,
+          // These override the default markdown-viewer components and modifies the
+          // rendering of hash routing hrefs for headings in elements-core for the BaseArticleComponent
+          h2: ({ color, ...props }) => <LinkHeading size={2} {...props} />,
+          h3: ({ color, ...props }) => <LinkHeading size={3} {...props} />,
+          h4: ({ color, ...props }) => <LinkHeading size={4} {...props} />,
+        }}
+      >
+        <MockingProvider mockUrl={node.links.mock_url} hideMocking={hideMocking}>
+          <Docs
+            nodeType={node.type as NodeType}
+            nodeData={node.data}
+            nodeTitle={node.title}
+            disableProps={node?.disableProps}
+            layoutOptions={{
+              compact,
+              hideTryIt: hideTryIt,
+              hideTryItPanel: hideTryItPanel,
+              hideSamples,
+              hideSecurityInfo: hideSecurityInfo,
+              hideServerInfo: hideServerInfo,
+              hideExport:
+                hideExport ||
+                (node.links.export_url ?? node.links.export_original_file_url ?? node.links.export_bundled_file_url) ===
+                  undefined,
+            }}
+            useNodeForRefResolving
+            refResolver={refResolver}
+            maxRefDepth={maxRefDepth}
+            tryItCorsProxy={tryItCorsProxy}
+            exportProps={
+              [NodeType.HttpService, NodeType.Model].includes(node.type as NodeType)
+                ? {
+                    original: onExportRequest
+                      ? { onPress: () => onExportRequest('original') }
+                      : { href: node.links.export_original_file_url ?? node.links.export_url },
+                    bundled: onExportRequest
+                      ? { onPress: () => onExportRequest('bundled') }
+                      : { href: node.links.export_bundled_file_url ?? getBundledUrl(node.links.export_url) },
+                  }
+                : undefined
+            }
+            tryItCredentialsPolicy={tryItCredentialsPolicy}
+            nodeHasChanged={nodeHasChanged}
+            nodeUnsupported={nodeUnsupported}
+          />
+        </MockingProvider>
+      </MarkdownComponentsProvider>
+    </NodeLinkContext.Provider>
+  );
+};
+
+const NodeLinkContext = React.createContext<[Node, CustomLinkComponent] | undefined>(undefined);
+
+const externalRegex = new RegExp('^(?:[a-z]+:)?//', 'i');
+const LinkComponent: CustomComponentMapping['a'] = ({ children, href, title }) => {
+  console.log('LinkComponent href-----', href);
+  const ctx = React.useContext(NodeLinkContext);
+  const routerKind = React.useContext(RouterTypeContext);
+
+  const { pathname } = useLocation();
+  const route = pathname.split('#')[0];
+
+  try {
+    if (href && externalRegex.test(href)) {
+      const baseURL = window.location.host;
+      const hrefURL = new URL(href).host;
+
+      if (baseURL === hrefURL) {
+        // Open URL in same tab if domain match
+        return (
+          <a href={href} title={title ? title : undefined}>
+            {children}
+          </a>
+        );
+      }
+      return (
+        <a href={href} target="_blank" rel="noreferrer" title={title ? title : undefined}>
+          {children}
+        </a>
+      );
+    }
+  } catch (error) {
+    console.error(error);
+  }
+
+  if (href && ctx) {
+    const [node, Link] = ctx;
+    console.log('LinkComponent node-----', node);
+
+    // Resolve relative file URI with
+    const { fileUri } = getNodeUriParts(node.uri);
+    const { fileUri: hrefFileUri } = getNodeUriParts(href);
+
+    let resolvedUri;
+    if (hrefFileUri) {
+      // if the href is targeting another file, resolve it against the dir path of current file
+      resolvedUri = resolve(dirname(fileUri), href);
+    } else {
+      // If the href does not include a file, resolve it relative to the current file
+      resolvedUri = resolve(fileUri, href);
+    }
+
+    const [resolvedUriWithoutAnchor, hash] = resolvedUri.split('#');
+    const decodedUrl = decodeURIComponent(href);
+    const decodedResolvedUriWithoutAnchor = decodeURIComponent(resolvedUriWithoutAnchor);
+    const [pagePathWithoutHash] = pathname.split('#');
+
+    let edge = node.outbound_edges.find(
+      edge => edge.uri === decodedUrl || edge.uri === decodedResolvedUriWithoutAnchor,
+    );
+
+    if (!edge) {
+      edge = node.outbound_edges.find(edge => pagePathWithoutHash === `/${edge.slug}`);
+    }
+
+    if (edge) {
+      const slug = routerKind === 'hash' ? `#${route.replace(node.slug, edge.slug)}` : edge.slug;
+      return <Link to={`${slug}${hash ? `#${hash}` : ''}`}>{children}</Link>;
+    }
+  }
+
+  const fullHref = routerKind === 'hash' ? `#${route}${href}` : href;
+  return <a href={fullHref}>{children}</a>;
+};
+
+function getBundledUrl(url: string | undefined) {
+  if (url === undefined) return undefined;
+  const bundledUrl = new URL(url);
+  const searchParams = new URLSearchParams(bundledUrl.search);
+  searchParams.append('deref', 'optimizedBundle');
+  bundledUrl.search = searchParams.toString();
+  return bundledUrl.toString();
+}
+
+// Extract out just the file portion of the node URI
+// This handles cases such as links to http_operation node uris, which include both the file + encoded pointer, e.g.
+//
+// /reference/openapi.json/paths/~1v2~1contact~1last_change/post#heading-anchor
+// fileUri = /reference/openapi.json
+// pointer = /paths/~1v2~1contact~1last_change/post#heading-anchor
+export const getNodeUriParts = (uri: string): { fileUri: string; pointer: string } => {
+  // Check: added console for debugging purpose
+  console.log('getNodeUriParts uri-----', uri, 'typeof uri:', typeof uri);
+  // Guard against undefined or non-string input
+  if (!uri || typeof uri !== 'string') return { fileUri: '', pointer: '' };
+  const parts = uri.split(/(\.yaml|\.yml|\.json|\.md)/);
+  if (parts === undefined || void 0) {
+    return { fileUri: '', pointer: '' };
+  }
+  if (!parts || parts.length === 1) {
+    return { fileUri: '', pointer: parts[0] || '' };
+  }
+
+  const fileUri = `${parts[0] || ''}${parts[1] || ''}`;
+
+  return { fileUri, pointer: parts[2] || '' };
+};

package/src/components/NodeContent/index.tsx

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

package/src/components/NotFound.tsx

@@ -0,0 +1,11 @@
+import { Box, Flex, Heading, VStack } from '@stoplight/mosaic';
+import React from 'react';
+
+export const NotFound = () => (
+  <Flex align="center" justify="center" flexGrow>
+    <VStack spacing={4} align="center">
+      <Heading size={1}>Not Found</Heading>
+      <Box as="p">Could not find what you are looking for</Box>
+    </VStack>
+  </Flex>
+);