@jpmorganchase/elemental-dev-portal 1.0.0 → 2.2.1

package/components/BranchSelector/BranchSelector.d.ts

@@ -0,0 +1,7 @@
+import { Branch } from '../../types';
+export declare type BranchSelectorProps = {
+    branchSlug: string;
+    branches: Branch[];
+    onChange: (branch: Branch) => void;
+};
+export declare const BranchSelector: ({ branchSlug, branches, onChange }: BranchSelectorProps) => JSX.Element;

package/components/BranchSelector/BranchSelector.spec.d.ts

@@ -0,0 +1,15 @@
+export declare const branches: ({
+    id: number;
+    slug: string;
+    is_default: boolean;
+    is_published: boolean;
+    projectId: number;
+    name: string;
+} | {
+    id: number;
+    slug: string;
+    is_default: boolean;
+    is_published: boolean;
+    projectId: number;
+    name?: undefined;
+})[];

package/components/BranchSelector/BranchSelector.stories.d.ts

@@ -0,0 +1,29 @@
+import { Story } from '@storybook/react';
+declare const _default: {
+    title: string;
+    component: ({ projectId }: {
+        projectId: string;
+    }) => JSX.Element;
+    argTypes: {
+        projectId: {
+            table: {
+                category: string;
+            };
+        };
+        platformUrl: {
+            table: {
+                category: string;
+            };
+        };
+    };
+    args: {
+        projectId: string;
+        platformUrl: string;
+    };
+};
+export default _default;
+export declare const Playground: Story<{
+    nodeSlug: string;
+    projectId: string;
+    branchSlug?: string;
+}>;

package/components/DevPortalProvider/index.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+export declare type DevPortalProviderProps = {
+    platformUrl?: string;
+    platformAuthToken?: string;
+};
+export declare const PlatformContext: React.Context<DevPortalProviderProps>;
+export declare const DevPortalProvider: React.FC<DevPortalProviderProps>;

package/components/Forbidden.d.ts

@@ -0,0 +1 @@
+export declare const Forbidden: () => JSX.Element;

package/components/Loading.d.ts

@@ -0,0 +1 @@
+export declare const Loading: () => JSX.Element;

package/components/NodeContent/NodeContent.d.ts

@@ -0,0 +1,17 @@
+import { CustomLinkComponent, DocsProps, ReferenceResolver } from '@jpmorganchase/elemental-core';
+import { Node } from '../../types';
+declare type DocsBaseProps = Pick<DocsProps, 'tryItCorsProxy' | 'tryItCredentialsPolicy' | 'nodeHasChanged'>;
+declare type DocsLayoutProps = Pick<Required<DocsProps>['layoutOptions'], 'compact' | 'hideTryIt' | 'hideTryItPanel' | 'hideExport'>;
+export declare type NodeContentProps = {
+    node: Node;
+    Link: CustomLinkComponent;
+    hideMocking?: boolean;
+    refResolver?: ReferenceResolver;
+    onExportRequest?: (type: 'original' | 'bundled') => void;
+} & DocsBaseProps & DocsLayoutProps;
+export declare const NodeContent: ({ node, Link, hideMocking, refResolver, tryItCorsProxy, tryItCredentialsPolicy, nodeHasChanged, compact, hideTryIt, hideTryItPanel, hideExport, onExportRequest, }: NodeContentProps) => JSX.Element;
+export declare const getNodeUriParts: (uri: string) => {
+    fileUri: string;
+    pointer: string;
+};
+export {};

package/components/NodeContent/NodeContent.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/components/NodeContent/NodeContent.stories.d.ts

@@ -0,0 +1,43 @@
+import { Story } from '@storybook/react';
+declare const _default: {
+    title: string;
+    component: ({ nodeSlug, projectId, branchSlug, }: {
+        nodeSlug: string;
+        projectId: string;
+        branchSlug?: string | undefined;
+    }) => JSX.Element;
+    argTypes: {
+        nodeSlug: {
+            table: {
+                category: string;
+            };
+        };
+        projectId: {
+            table: {
+                category: string;
+            };
+        };
+        branchSlug: {
+            table: {
+                category: string;
+            };
+        };
+        platformUrl: {
+            table: {
+                category: string;
+            };
+        };
+    };
+    args: {
+        nodeSlug: string;
+        projectId: string;
+        branchSlug: string;
+        platformUrl: string;
+    };
+};
+export default _default;
+export declare const Playground: Story<{
+    nodeSlug: string;
+    projectId: string;
+    branchSlug?: string;
+}>;

package/components/NotFound.d.ts

@@ -0,0 +1 @@
+export declare const NotFound: () => JSX.Element;

package/components/Search/Search.d.ts

@@ -0,0 +1,13 @@
+import { ModalProps } from '@stoplight/mosaic';
+import * as React from 'react';
+import { NodeSearchResult } from '../../types';
+export declare type SearchProps = {
+    isLoading?: boolean;
+    search?: string;
+    searchResults?: NodeSearchResult[];
+    onSearch: (search: string) => void;
+    onClick: (result: NodeSearchResult) => void;
+    isOpen?: boolean;
+    onClose: ModalProps['onClose'];
+};
+export declare const Search: React.FC<SearchProps>;

package/components/Search/Search.stories.d.ts

@@ -0,0 +1,33 @@
+import { Story } from '@storybook/react';
+declare type SearchWrapperProps = {
+    projectIds: string[];
+    workspaceId: string;
+};
+declare const _default: {
+    title: string;
+    component: ({ projectIds, workspaceId }: SearchWrapperProps) => JSX.Element;
+    argTypes: {
+        workspaceId: {
+            table: {
+                category: string;
+            };
+        };
+        projectIds: {
+            table: {
+                category: string;
+            };
+        };
+        platformUrl: {
+            table: {
+                category: string;
+            };
+        };
+    };
+    args: {
+        projectIds: string[];
+        workspaceId: string;
+        platformUrl: string;
+    };
+};
+export default _default;
+export declare const Playground: Story<SearchWrapperProps>;

package/components/TableOfContents/TableOfContents.d.ts

@@ -0,0 +1,12 @@
+import { CustomLinkComponent } from '@jpmorganchase/elemental-core';
+import { BoxProps } from '@stoplight/mosaic';
+import { ProjectTableOfContents } from '../../types';
+export declare type TableOfContentsProps = BoxProps<'div'> & {
+    activeId: string;
+    tableOfContents: ProjectTableOfContents;
+    Link: CustomLinkComponent;
+    collapseTableOfContents?: boolean;
+    externalScrollbar?: boolean;
+    onLinkClick?(): void;
+};
+export declare const TableOfContents: ({ tableOfContents, activeId, Link, collapseTableOfContents, externalScrollbar, onLinkClick, ...boxProps }: TableOfContentsProps) => JSX.Element;

package/components/TableOfContents/TableOfContents.stories.d.ts

@@ -0,0 +1,36 @@
+import { Story } from '@storybook/react';
+declare const _default: {
+    title: string;
+    component: ({ projectId, branchSlug }: {
+        projectId: string;
+        branchSlug?: string | undefined;
+    }) => JSX.Element;
+    argTypes: {
+        projectId: {
+            table: {
+                category: string;
+            };
+        };
+        branchSlug: {
+            table: {
+                category: string;
+            };
+        };
+        platformUrl: {
+            table: {
+                category: string;
+            };
+        };
+    };
+    args: {
+        projectId: string;
+        branchSlug: string;
+        platformUrl: string;
+    };
+};
+export default _default;
+export declare const Playground: Story<{
+    nodeSlug: string;
+    projectId: string;
+    branchSlug?: string;
+}>;

package/components/UpgradeToStarter.d.ts

@@ -0,0 +1 @@
+export declare const UpgradeToStarter: () => JSX.Element;

package/consts.d.ts

@@ -0,0 +1,28 @@
+export declare const devPortalCacheKeys: {
+    all: readonly ["@stoplight/elements-dev-portal/client-query"];
+    projects: () => readonly ["@stoplight/elements-dev-portal/client-query", "projects"];
+    project: (projectId: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string];
+    projectsList: () => readonly ["@stoplight/elements-dev-portal/client-query", "projects", "list"];
+    projectDetails: (projectId: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "details"];
+    branches: (projectId: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches"];
+    branch: (projectId: string, branch: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", string];
+    branchesList: (projectId: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", "list"];
+    branchDetails: (projectId: string, branch: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", string, "details"];
+    branchTOC: (projectId: string, branch: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", string, "toc"];
+    branchNodes: (projectId: string, branch: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", string, "nodes"];
+    branchNode: (projectId: string, branch: string, node: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", string, "nodes", string];
+    branchNodesList: (projectId: string, branch: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", string, "nodes", "list"];
+    branchNodeDetails: (projectId: string, branch: string, node: string) => readonly ["@stoplight/elements-dev-portal/client-query", "projects", string, "branches", string, "nodes", string, "details"];
+    search: () => string[];
+    searchNodes: (filters: {
+        projectIds?: string[];
+        branchSlug?: string;
+        workspaceId?: string;
+        search?: string;
+    }) => (string | {
+        projectIds?: string[] | undefined;
+        branchSlug?: string | undefined;
+        workspaceId?: string | undefined;
+        search?: string | undefined;
+    })[];
+};

package/containers/StoplightProject.d.ts

@@ -0,0 +1,13 @@
+import { RoutingProps } from '@jpmorganchase/elemental-core';
+import * as React from 'react';
+export interface StoplightProjectProps extends RoutingProps {
+    projectId: string;
+    platformUrl?: string;
+    hideTryIt?: boolean;
+    hideMocking?: boolean;
+    hideExport?: boolean;
+    collapseTableOfContents?: boolean;
+    tryItCredentialsPolicy?: 'omit' | 'include' | 'same-origin';
+    tryItCorsProxy?: string;
+}
+export declare const StoplightProject: React.FC<StoplightProjectProps>;

package/containers/StoplightProject.spec.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/containers/StoplightProject.stories.d.ts

@@ -0,0 +1,45 @@
+import { Story } from '@storybook/react';
+import * as React from 'react';
+import { StoplightProjectProps } from './StoplightProject';
+declare const _default: {
+    title: string;
+    component: React.FC<StoplightProjectProps>;
+    argTypes: {
+        projectId: {
+            table: {
+                category: string;
+            };
+        };
+        hideTryIt: {
+            table: {
+                category: string;
+            };
+        };
+        hideMocking: {
+            table: {
+                category: string;
+            };
+        };
+        basePath: {
+            table: {
+                category: string;
+            };
+        };
+        router: {
+            table: {
+                category: string;
+            };
+        };
+        platformUrl: {
+            table: {
+                category: string;
+            };
+        };
+    };
+    args: {
+        router: string;
+        platformUrl: string;
+    };
+};
+export default _default;
+export declare const Playground: Story<StoplightProjectProps>;

package/handlers/getBranches.d.ts

@@ -0,0 +1,6 @@
+import { Branch } from '../types';
+export declare const getBranches: ({ projectId, platformUrl, platformAuthToken, }: {
+    projectId: string;
+    platformUrl?: string | undefined;
+    platformAuthToken?: string | undefined;
+}) => Promise<Branch[]>;

package/handlers/getNodeContent.d.ts

@@ -0,0 +1,12 @@
+import { Node } from '../types';
+export declare class ResponseError extends Error {
+    code: number;
+    constructor(message: string, responseCode: number);
+}
+export declare const getNodeContent: ({ nodeSlug, projectId, branchSlug, platformUrl, platformAuthToken, }: {
+    nodeSlug: string;
+    projectId: string;
+    branchSlug?: string | undefined;
+    platformUrl?: string | undefined;
+    platformAuthToken?: string | undefined;
+}) => Promise<Node>;

package/handlers/getNodes.d.ts

@@ -0,0 +1,9 @@
+import { NodeSearchResult } from '../types';
+export declare const getNodes: ({ workspaceId, branchSlug, projectIds, search, platformUrl, platformAuthToken, }: {
+    workspaceId?: string | undefined;
+    branchSlug?: string | undefined;
+    projectIds?: string[] | undefined;
+    search?: string | undefined;
+    platformUrl?: string | undefined;
+    platformAuthToken?: string | undefined;
+}) => Promise<NodeSearchResult[]>;

package/handlers/getTableOfContents.d.ts

@@ -0,0 +1,7 @@
+import { ProjectTableOfContents } from '../types';
+export declare const getTableOfContents: ({ projectId, branchSlug, platformUrl, platformAuthToken, }: {
+    projectId: string;
+    branchSlug?: string | undefined;
+    platformUrl?: string | undefined;
+    platformAuthToken?: string | undefined;
+}) => Promise<ProjectTableOfContents>;

package/handlers/getWorkspace.d.ts

@@ -0,0 +1,6 @@
+import { Workspace } from '../types';
+export declare const getWorkspace: ({ projectIds, platformUrl, platformAuthToken, }: {
+    projectIds: string[];
+    platformUrl?: string | undefined;
+    platformAuthToken?: string | undefined;
+}) => Promise<Workspace>;

package/hooks/useGetBranches.d.ts

@@ -0,0 +1,3 @@
+export declare function useGetBranches({ projectId }: {
+    projectId: string;
+}): import("react-query").UseQueryResult<import("..").Branch[], unknown>;

package/hooks/useGetNodeContent.d.ts

@@ -0,0 +1,5 @@
+export declare function useGetNodeContent({ nodeSlug, projectId, branchSlug, }: {
+    nodeSlug: string;
+    projectId: string;
+    branchSlug?: string;
+}): import("react-query").UseQueryResult<import("..").Node, unknown>;

package/hooks/useGetNodes.d.ts

@@ -0,0 +1,7 @@
+export declare function useGetNodes({ search, workspaceId, projectIds, branch, pause, }: {
+    search: string;
+    workspaceId?: string;
+    projectIds?: string[];
+    branch?: string;
+    pause?: boolean;
+}): import("react-query").UseQueryResult<import("..").NodeSearchResult[], unknown>;

package/hooks/useGetTableOfContents.d.ts

@@ -0,0 +1,4 @@
+export declare function useGetTableOfContents({ projectId, branchSlug }: {
+    projectId: string;
+    branchSlug?: string;
+}): import("react-query").UseQueryResult<import("..").ProjectTableOfContents, unknown>;

package/hooks/useGetWorkspace.d.ts

@@ -0,0 +1,3 @@
+export declare function useGetWorkspace({ projectIds }: {
+    projectIds: string[];
+}): import("react-query").UseQueryResult<import("../types").Workspace, unknown>;