@jpmorganchase/elemental-dev-portal 1.0.0 → 2.2.1

package/src/handlers/__tests__/getNodes.test.ts

@@ -1,38 +0,0 @@
-import fetchMock from 'jest-fetch-mock';
-
-import { getNodes } from '../getNodes';
-
-describe('getNodes', () => {
-  beforeEach(() => {
-    fetchMock.resetMocks();
-    localStorage.clear();
-  });
-
-  describe('with a provided workspace identifier', () => {
-    it('should URI encode the parameters in the request URL', async () => {
-      fetchMock.mockResolvedValue(
-        new Response('{}', {
-          status: 200,
-          statusText: 'OK',
-          headers: [],
-        }),
-      );
-
-      await getNodes({
-        workspaceId: 'my?workspace',
-        projectIds: ['some/slash'],
-        branchSlug: 'test+branch',
-        search: 'a?special&search',
-      });
-
-      expect(fetchMock).toBeCalledWith(
-        'https://stoplight.io/api/v1/workspaces/my%3Fworkspace/nodes?project_ids[0]=some%2Fslash&search=a%3Fspecial%26search&branch=test%2Bbranch',
-        {
-          headers: expect.objectContaining({
-            'Stoplight-Elements-Version': expect.any(String),
-          }),
-        },
-      );
-    });
-  });
-});

package/src/handlers/__tests__/getTableOfContents.test.ts

@@ -1,34 +0,0 @@
-import fetchMock from 'jest-fetch-mock';
-
-import { getTableOfContents } from '../getTableOfContents';
-
-describe('getTableOfContents', () => {
-  beforeEach(() => {
-    fetchMock.resetMocks();
-    localStorage.clear();
-  });
-
-  it('should URI encode the parameters in the request URL', async () => {
-    fetchMock.mockResolvedValue(
-      new Response('{}', {
-        status: 200,
-        statusText: 'OK',
-        headers: [],
-      }),
-    );
-
-    await getTableOfContents({
-      projectId: 'some/slash',
-      branchSlug: 'test+branch',
-    });
-
-    expect(fetchMock).toBeCalledWith(
-      'https://stoplight.io/api/v1/projects/some%2Fslash/table-of-contents?branch=test%2Bbranch',
-      {
-        headers: expect.objectContaining({
-          'Stoplight-Elements-Version': expect.any(String),
-        }),
-      },
-    );
-  });
-});

package/src/handlers/__tests__/getWorkspace.test.ts

@@ -1,30 +0,0 @@
-import fetchMock from 'jest-fetch-mock';
-
-import { getWorkspace } from '../getWorkspace';
-
-describe('getWorkspace', () => {
-  beforeEach(() => {
-    fetchMock.resetMocks();
-    localStorage.clear();
-  });
-
-  it('should URI encode the parameters in the request URL', async () => {
-    fetchMock.mockResolvedValue(
-      new Response('{}', {
-        status: 200,
-        statusText: 'OK',
-        headers: [],
-      }),
-    );
-
-    await getWorkspace({
-      projectIds: ['some/slash'],
-    });
-
-    expect(fetchMock).toBeCalledWith('https://stoplight.io/api/v1/projects/some%2Fslash', {
-      headers: expect.objectContaining({
-        'Stoplight-Elements-Version': expect.any(String),
-      }),
-    });
-  });
-});

package/src/handlers/getBranches.ts

@@ -1,27 +0,0 @@
-import { Branch } from '../types';
-import { appVersion } from '../version';
-
-export const getBranches = async ({
-  projectId,
-  platformUrl = 'https://stoplight.io',
-  platformAuthToken,
-}: {
-  projectId: string;
-  platformUrl?: string;
-  platformAuthToken?: string;
-}): Promise<Branch[]> => {
-  const encodedProjectId = encodeURIComponent(projectId);
-  const response = await fetch(`${platformUrl}/api/v1/projects/${encodedProjectId}/branches`, {
-    headers: {
-      'Stoplight-Elements-Version': appVersion,
-      ...(platformAuthToken && { Authorization: `Bearer ${platformAuthToken}` }),
-    },
-  });
-  const data = await response.json();
-
-  if (!response.ok) {
-    throw new Error(data);
-  }
-
-  return data;
-};

package/src/handlers/getNodeContent.ts

@@ -1,53 +0,0 @@
-import { Node } from '../types';
-import { appVersion } from '../version';
-
-export class ResponseError extends Error {
-  code: number;
-
-  constructor(message: string, responseCode: number) {
-    super(message);
-    this.name = 'ResponseError';
-    this.code = responseCode;
-  }
-}
-
-export const getNodeContent = async ({
-  nodeSlug,
-  projectId,
-  branchSlug,
-  platformUrl = 'https://stoplight.io',
-  platformAuthToken,
-}: {
-  nodeSlug: string;
-  projectId: string;
-  branchSlug?: string;
-  platformUrl?: string;
-  platformAuthToken?: string;
-}): Promise<Node> => {
-  const encodedNodeSlug = encodeURIComponent(nodeSlug);
-  const encodedProjectId = encodeURIComponent(projectId);
-  const encodedBranchSlug = branchSlug ? encodeURIComponent(branchSlug) : '';
-  const branchQuery = encodedBranchSlug ? `?branch=${encodedBranchSlug}` : '';
-  const response = await fetch(
-    `${platformUrl}/api/v1/projects/${encodedProjectId}/nodes/${encodedNodeSlug}${branchQuery}`,
-    {
-      headers: {
-        'Stoplight-Elements-Version': appVersion,
-        ...(platformAuthToken && { Authorization: `Bearer ${platformAuthToken}` }),
-      },
-    },
-  );
-  const data = await response.json();
-
-  if (!response.ok) {
-    if (response.status === 402) {
-      throw new ResponseError('Payment Required', response.status);
-    } else if (response.status === 403) {
-      throw new ResponseError('Forbidden', response.status);
-    } else {
-      throw new ResponseError('Something went wrong', response.status);
-    }
-  }
-
-  return data;
-};

package/src/handlers/getNodes.ts

@@ -1,69 +0,0 @@
-import { NodeSearchResult } from '../types';
-import { appVersion } from '../version';
-
-export const getNodes = async ({
-  workspaceId,
-  branchSlug,
-  projectIds,
-  search,
-  platformUrl = 'https://stoplight.io',
-  platformAuthToken,
-}: {
-  workspaceId?: string;
-  branchSlug?: string;
-  projectIds?: string[];
-  search?: string;
-  platformUrl?: string;
-  platformAuthToken?: string;
-}): Promise<NodeSearchResult[]> => {
-  const queryParams = [];
-  let fetchedWorkspaceId = workspaceId || '';
-
-  if (!workspaceId && projectIds?.length) {
-    const encodedProjectId = encodeURIComponent(projectIds[0]);
-    const response = await fetch(`${platformUrl}/api/v1/projects/${encodedProjectId}`, {
-      headers: {
-        'Stoplight-Elements-Version': appVersion,
-        ...(platformAuthToken && { Authorization: `Bearer ${platformAuthToken}` }),
-      },
-    });
-    const data = await response.json();
-    fetchedWorkspaceId = data.workspace.id;
-  }
-
-  if (projectIds && projectIds.length) {
-    queryParams.push(
-      ...projectIds.map((projectId, index) => {
-        const encodedProjectId = encodeURIComponent(projectId);
-        return `project_ids[${index}]=${encodedProjectId}`;
-      }),
-    );
-  }
-
-  if (search) {
-    const encodedSearch = encodeURIComponent(search);
-    queryParams.push(`search=${encodedSearch}`);
-  }
-
-  if (branchSlug) {
-    const encodedBranchSlug = encodeURIComponent(branchSlug);
-    queryParams.push(`branch=${encodedBranchSlug}`);
-  }
-
-  const query = queryParams.length ? `?${queryParams.join('&')}` : '';
-
-  const encodedWorkspaceId = encodeURIComponent(fetchedWorkspaceId);
-  const response = await fetch(`${platformUrl}/api/v1/workspaces/${encodedWorkspaceId}/nodes${query}`, {
-    headers: {
-      'Stoplight-Elements-Version': appVersion,
-      ...(platformAuthToken && { Authorization: `Bearer ${platformAuthToken}` }),
-    },
-  });
-  const data = await response.json();
-
-  if (!response.ok) {
-    throw new Error(data);
-  }
-
-  return data;
-};

package/src/handlers/getTableOfContents.ts

@@ -1,30 +0,0 @@
-import { ProjectTableOfContents } from '../types';
-import { appVersion } from '../version';
-
-export const getTableOfContents = async ({
-  projectId,
-  branchSlug,
-  platformUrl = 'https://stoplight.io',
-  platformAuthToken,
-}: {
-  projectId: string;
-  branchSlug?: string;
-  platformUrl?: string;
-  platformAuthToken?: string;
-}): Promise<ProjectTableOfContents> => {
-  const encodedProjectId = encodeURIComponent(projectId);
-  const encodedBranchSlug = branchSlug ? encodeURIComponent(branchSlug) : '';
-  const branchQuery = encodedBranchSlug ? `?branch=${encodedBranchSlug}` : '';
-  const response = await fetch(`${platformUrl}/api/v1/projects/${encodedProjectId}/table-of-contents${branchQuery}`, {
-    headers: {
-      'Stoplight-Elements-Version': appVersion,
-      ...(platformAuthToken && { Authorization: `Bearer ${platformAuthToken}` }),
-    },
-  });
-  const data = await response.json();
-
-  if (!response.ok) {
-    throw new Error(data);
-  }
-  return data;
-};

package/src/handlers/getWorkspace.ts

@@ -1,27 +0,0 @@
-import { Workspace } from '../types';
-import { appVersion } from '../version';
-
-export const getWorkspace = async ({
-  projectIds,
-  platformUrl = 'https://stoplight.io',
-  platformAuthToken,
-}: {
-  projectIds: string[];
-  platformUrl?: string;
-  platformAuthToken?: string;
-}): Promise<Workspace> => {
-  const encodedProjectId = encodeURIComponent(projectIds[0]);
-  const response = await fetch(`${platformUrl}/api/v1/projects/${encodedProjectId}`, {
-    headers: {
-      'Stoplight-Elements-Version': appVersion,
-      ...(platformAuthToken && { Authorization: `Bearer ${platformAuthToken}` }),
-    },
-  });
-  const data = await response.json();
-
-  if (!response.ok) {
-    throw new Error(data);
-  }
-
-  return data;
-};

package/src/hooks/__tests__/dataFetching.spec.tsx

@@ -1,42 +0,0 @@
-import '@testing-library/jest-dom';
-
-import { act, renderHook } from '@testing-library/react-hooks';
-import fetchMock from 'jest-fetch-mock';
-import * as React from 'react';
-
-import { DevPortalProvider } from '../../components/DevPortalProvider';
-import { useGetBranches } from '../useGetBranches';
-import { useGetNodeContent } from '../useGetNodeContent';
-import { useGetNodes } from '../useGetNodes';
-import { useGetTableOfContents } from '../useGetTableOfContents';
-
-describe('data fetching', () => {
-  beforeEach(() => {
-    fetchMock.mockResponse(() => Promise.resolve({ status: 200 }));
-    fetchMock.enableMocks();
-  });
-
-  afterEach(() => {
-    fetchMock.disableMocks();
-  });
-
-  it.each<[string, Function, Record<string, string>]>([
-    ['useGetTableOfContents', useGetTableOfContents, { projectId: 'id' }],
-    ['useGetBranches', useGetBranches, { projectId: 'id' }],
-    ['useGetNodeContent', useGetNodeContent, { projectId: 'id', nodeSlug: 'node' }],
-    ['useGetNodes', useGetNodes, { search: 'search', workspaceId: 'id' }],
-  ])('includes authorization header when auth token is present in context for %s', async (_, hook, args) => {
-    const { waitFor } = renderHook(() => hook(args), {
-      wrapper: ({ children }) => <DevPortalProvider platformAuthToken="secret">{children}</DevPortalProvider>,
-    });
-
-    await act(async () => {
-      await waitFor(() => expect(fetchMock).toHaveBeenCalled());
-    });
-    const requestInit = fetchMock.mock.calls[0][1]!;
-
-    const headers = new Headers(requestInit.headers);
-
-    expect(headers.get('Authorization')).toBe('Bearer secret');
-  });
-});

package/src/hooks/useGetBranches.ts

@@ -1,17 +0,0 @@
-import * as React from 'react';
-import { useQuery } from 'react-query';
-
-import { PlatformContext } from '../components/DevPortalProvider';
-import { devPortalCacheKeys } from '../consts';
-import { getBranches } from '../handlers/getBranches';
-
-export function useGetBranches({ projectId }: { projectId: string }) {
-  const { platformUrl, platformAuthToken } = React.useContext(PlatformContext);
-  return useQuery(
-    [...devPortalCacheKeys.branchesList(projectId), platformUrl, platformAuthToken],
-    () => getBranches({ projectId, platformUrl, platformAuthToken }),
-    {
-      enabled: projectId ? true : false,
-    },
-  );
-}

package/src/hooks/useGetNodeContent.ts

@@ -1,24 +0,0 @@
-import * as React from 'react';
-import { useQuery } from 'react-query';
-
-import { PlatformContext } from '../components/DevPortalProvider';
-import { devPortalCacheKeys } from '../consts';
-import { getNodeContent } from '../handlers/getNodeContent';
-
-export function useGetNodeContent({
-  nodeSlug,
-  projectId,
-  branchSlug,
-}: {
-  nodeSlug: string;
-  projectId: string;
-  branchSlug?: string;
-}) {
-  const { platformUrl, platformAuthToken } = React.useContext(PlatformContext);
-
-  return useQuery(
-    [...devPortalCacheKeys.branchNodeDetails(projectId, branchSlug ?? '', nodeSlug), platformUrl, platformAuthToken],
-    () => getNodeContent({ nodeSlug, projectId, branchSlug, platformUrl, platformAuthToken }),
-    { enabled: nodeSlug && projectId ? true : false },
-  );
-}

package/src/hooks/useGetNodes.ts

@@ -1,34 +0,0 @@
-import * as React from 'react';
-import { useQuery } from 'react-query';
-import { useDebounce } from 'use-debounce';
-
-import { PlatformContext } from '../components/DevPortalProvider';
-import { devPortalCacheKeys } from '../consts';
-import { getNodes } from '../handlers/getNodes';
-
-export function useGetNodes({
-  search,
-  workspaceId,
-  projectIds,
-  branch,
-  pause,
-}: {
-  search: string;
-  workspaceId?: string;
-  projectIds?: string[];
-  branch?: string;
-  pause?: boolean;
-}) {
-  const { platformUrl, platformAuthToken } = React.useContext(PlatformContext);
-  const [debounceSearch] = useDebounce(search, 500);
-  return useQuery(
-    [
-      ...devPortalCacheKeys.searchNodes({ projectIds, branchSlug: branch, workspaceId, search: debounceSearch }),
-      platformUrl,
-      platformAuthToken,
-    ],
-    () =>
-      getNodes({ workspaceId, projectIds, branchSlug: branch, search: debounceSearch, platformUrl, platformAuthToken }),
-    { enabled: !pause, keepPreviousData: true },
-  );
-}

package/src/hooks/useGetTableOfContents.ts

@@ -1,15 +0,0 @@
-import * as React from 'react';
-import { useQuery } from 'react-query';
-
-import { PlatformContext } from '../components/DevPortalProvider';
-import { devPortalCacheKeys } from '../consts';
-import { getTableOfContents } from '../handlers/getTableOfContents';
-
-export function useGetTableOfContents({ projectId, branchSlug }: { projectId: string; branchSlug?: string }) {
-  const { platformUrl, platformAuthToken } = React.useContext(PlatformContext);
-  return useQuery(
-    [...devPortalCacheKeys.branchTOC(projectId, branchSlug ?? ''), platformUrl, platformAuthToken],
-    () => getTableOfContents({ projectId, branchSlug, platformUrl, platformAuthToken }),
-    { enabled: projectId ? true : false },
-  );
-}

package/src/hooks/useGetWorkspace.tsx

@@ -1,13 +0,0 @@
-import * as React from 'react';
-import { useQuery } from 'react-query';
-
-import { PlatformContext } from '../components/DevPortalProvider';
-import { devPortalCacheKeys } from '../consts';
-import { getWorkspace } from '../handlers/getWorkspace';
-
-export function useGetWorkspace({ projectIds }: { projectIds: string[] }) {
-  const { platformUrl, platformAuthToken } = React.useContext(PlatformContext);
-  return useQuery([...devPortalCacheKeys.searchNodes({ projectIds }), platformUrl, platformAuthToken], () =>
-    getWorkspace({ projectIds, platformUrl, platformAuthToken }),
-  );
-}

package/src/styles.css

@@ -1 +0,0 @@
-@import '../../elements-core/src/styles.css';

package/src/types.ts

@@ -1,81 +0,0 @@
-import { TableOfContentsItem } from '@stoplight/elements-core';
-
-export type Branch = {
-  id: number;
-  slug: string;
-  is_default: boolean;
-  is_published: boolean;
-  projectId: number;
-  name?: string;
-};
-
-export type ProjectTableOfContents = {
-  items: TableOfContentsItem[];
-  hide_powered_by?: boolean;
-  collapseTableOfContents?: boolean;
-};
-
-export type Node = NodeSummary & {
-  data: any;
-  links: {
-    mock_url?: string;
-    /**
-     * @deprecated use export_original_file_url instead
-     */
-    export_url?: string;
-    /**
-     * The URL to export the original file. This is not a bundled output, meaning references are left in place.
-     */
-    export_original_file_url?: string;
-    /**
-     * The URL to export a bundled form of the file. Bundling means references are copied into the output file.
-     */
-    export_bundled_file_url?: string;
-  };
-  outbound_edges: NodeEdge[];
-  inbound_edges: NodeEdge[];
-};
-
-export type NodeSummary = {
-  id: string;
-  type: string;
-  uri: string;
-  slug: string;
-  title: string;
-  summary: string;
-  project_id: string;
-  branch_id: string;
-  branch_node_id: number;
-  branch: string;
-};
-
-export type NodeEdge = {
-  id: string;
-  type: string;
-  uri: string;
-  slug: string;
-  title: string;
-};
-
-export type NodeSearchResult = NodeSummary & {
-  highlighted: {
-    name: string | null;
-    summary: string | null;
-    data: string | null;
-  };
-  project_slug: string;
-  project_name: string;
-  node_id: number;
-};
-
-export type Workspace = {
-  id: string;
-  name: string;
-  slug: string;
-  default_branch_id: string;
-  workspace: {
-    id: string;
-    name: string;
-    slug: string;
-  };
-};

package/src/version.ts

@@ -1,2 +0,0 @@
-// auto-updated during build
-export const appVersion = '1.10.2';

package/src/web-components/__stories__/StoplightProject.stories.tsx

@@ -1,33 +0,0 @@
-import '../index';
-
-import { Story } from '@storybook/react';
-import React from 'react';
-
-declare global {
-  namespace JSX {
-    interface IntrinsicElements {
-      'elements-stoplight-project': React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
-    }
-  }
-}
-
-const Template: Story = (props: any) => <elements-stoplight-project {...props} />;
-
-export default {
-  title: 'web-components/StoplightProject',
-  argTypes: {
-    projectId: { control: 'text' },
-    platformUrl: { control: 'text' },
-    router: {
-      control: { type: 'inline-radio', options: ['history', 'hash', 'memory'] },
-      defaultValue: 'history',
-    },
-  },
-};
-
-export const defaultProject = Template.bind({});
-defaultProject.storyName = "Stoplight's Demo workspace";
-defaultProject.args = {
-  projectId: 'cHJqOjYwNjYx',
-  platformUrl: 'https://stoplight.io',
-};

package/src/web-components/components.ts

@@ -1,17 +0,0 @@
-import { createElementClass } from '@stoplight/elements-core';
-
-import { StoplightProject } from '../containers/StoplightProject';
-
-export const StoplightProjectElement = createElementClass(StoplightProject, {
-  projectId: { type: 'string', defaultValue: '' },
-  hideTryIt: { type: 'boolean' },
-  hideMocking: { type: 'boolean' },
-  hideExport: { type: 'boolean' },
-  basePath: { type: 'string' },
-  staticRouterPath: { type: 'string' },
-  router: { type: 'string' },
-  platformUrl: { type: 'string' },
-  collapseTableOfContents: { type: 'boolean' },
-  tryItCredentialsPolicy: { type: 'string' },
-  tryItCorsProxy: { type: 'string' },
-});

package/src/web-components/index.ts

@@ -1,3 +0,0 @@
-import { StoplightProjectElement } from './components';
-
-window.customElements.define('elements-stoplight-project', StoplightProjectElement);

package/tsconfig.build.json

@@ -1,18 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "**/__*__/**"
-  ],
-  "compilerOptions": {
-    "baseUrl": "./",
-    "outDir": "dist",
-    "moduleResolution": "node",
-    "paths": {
-      "@stoplight/elements-core": ["../elements-core/dist"],
-      "@stoplight/elements-core/*": ["../elements-core/dist/*"]
-    }
-  }
-}

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-
-  "include": ["src"],
-
-  "exclude": ["**/__fixtures__/**", "**/__stories__/**", "**/__tests__/**"]
-}

package/web-components.config.js

@@ -1 +0,0 @@
-module.exports = require('../../web-components.webpack.config');