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

package/src/hooks/useGetBranches.ts

@@ -0,0 +1,17 @@
+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, isLoggedIn } = React.useContext(PlatformContext);
+  return useQuery(
+    [...devPortalCacheKeys.branchesList(projectId), platformUrl, isLoggedIn],
+    () => getBranches({ projectId, platformUrl, platformAuthToken }),
+    {
+      enabled: projectId ? true : false,
+    },
+  );
+}

package/src/hooks/useGetNodeContent.ts

@@ -0,0 +1,24 @@
+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, isLoggedIn } = React.useContext(PlatformContext);
+
+  return useQuery(
+    [...devPortalCacheKeys.branchNodeDetails(projectId, branchSlug ?? '', nodeSlug), platformUrl, isLoggedIn],
+    () => getNodeContent({ nodeSlug, projectId, branchSlug, platformUrl, platformAuthToken }),
+    { enabled: nodeSlug && projectId ? true : false },
+  );
+}

package/src/hooks/useGetNodes.ts

@@ -0,0 +1,34 @@
+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, isLoggedIn } = React.useContext(PlatformContext);
+  const [debounceSearch] = useDebounce(search, 500);
+  return useQuery(
+    [
+      ...devPortalCacheKeys.searchNodes({ projectIds, branchSlug: branch, workspaceId, search: debounceSearch }),
+      platformUrl,
+      isLoggedIn,
+    ],
+    () =>
+      getNodes({ workspaceId, projectIds, branchSlug: branch, search: debounceSearch, platformUrl, platformAuthToken }),
+    { enabled: !pause, keepPreviousData: true },
+  );
+}

package/src/hooks/useGetTableOfContents.ts

@@ -0,0 +1,17 @@
+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, isLoggedIn } = React.useContext(PlatformContext);
+  return useQuery(
+    [...devPortalCacheKeys.branchTOC(projectId, branchSlug ?? ''), platformUrl, isLoggedIn],
+    () => getTableOfContents({ projectId, branchSlug, platformUrl, platformAuthToken }),
+    // Here projectId cHJqOjA is an encoded value of zero,
+    // hence avoiding the graphql call for invalid project id
+    { enabled: projectId && projectId !== 'cHJqOjA' ? true : false },
+  );
+}

package/src/hooks/useGetWorkspace.tsx

@@ -0,0 +1,13 @@
+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/index.ts

@@ -0,0 +1,25 @@
+export type { BranchSelectorProps } from './components/BranchSelector';
+export { BranchSelector } from './components/BranchSelector';
+export type { DevPortalProviderProps } from './components/DevPortalProvider';
+export { DevPortalProvider } from './components/DevPortalProvider';
+export type { NodeContentProps } from './components/NodeContent';
+export { NodeContent } from './components/NodeContent';
+export type { SearchProps } from './components/Search';
+export { Search, SearchResults } from './components/Search';
+export type { TableOfContentsProps } from './components/TableOfContents';
+export { TableOfContents } from './components/TableOfContents';
+export { devPortalCacheKeys } from './consts';
+export type { StoplightProjectProps } from './containers/StoplightProject';
+export { StoplightProject } from './containers/StoplightProject';
+export { getBranches } from './handlers/getBranches';
+export { getNodeContent, ResponseError } from './handlers/getNodeContent';
+export { getNodes } from './handlers/getNodes';
+export { getTableOfContents } from './handlers/getTableOfContents';
+export { getWorkspace } from './handlers/getWorkspace';
+export { useGetBranches } from './hooks/useGetBranches';
+export { useGetNodeContent } from './hooks/useGetNodeContent';
+export { useGetNodes } from './hooks/useGetNodes';
+export { useGetTableOfContents } from './hooks/useGetTableOfContents';
+export { useGetWorkspace } from './hooks/useGetWorkspace';
+export type { ProjectTableOfContents } from './types';
+export type { Branch, Node, NodeSearchResult } from './types';

package/src/styles.css

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

package/src/types.ts

@@ -0,0 +1,85 @@
+import { TableOfContentsItem } from '@stoplight/elements-core';
+
+export type Branch = {
+  id: number;
+  slug: string;
+  is_default: boolean;
+  is_published: boolean;
+  name?: string;
+};
+
+export type Branches = {
+  items: Branch[];
+};
+
+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[];
+  disableProps?: any;
+};
+
+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

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

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

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

@@ -0,0 +1,19 @@
+import { createElementClass } from '@stoplight/elements-core';
+
+import { StoplightProject } from '../containers/StoplightProject';
+
+export const StoplightProjectElement = createElementClass(StoplightProject, {
+  projectId: { type: 'string', defaultValue: '' },
+  hideTryIt: { type: 'boolean' },
+  hideServerInfo: { type: 'boolean' },
+  hideSecurityInfo: { 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

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

package/tsconfig.build.json

@@ -0,0 +1,18 @@
+{
+  "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

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

package/web-components.config.js

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

package/version.d.ts

@@ -1 +0,0 @@
-export declare const appVersion = "3.0.11";