@jpmorganchase/elemental 6.0.2 → 7.1.1

package/components/API/APIWithResponsiveSidebarLayout.d.ts

@@ -0,0 +1,25 @@
+import { ExportButtonProps } from '@jpmorganchase/elemental-core';
+import { ExtensionAddonRenderer } from '@jpmorganchase/elemental-core/components/Docs';
+import * as React from 'react';
+import { ServiceNode } from '../../utils/oas/types';
+declare type SidebarLayoutProps = {
+    serviceNode: ServiceNode;
+    logo?: string;
+    hideTryItPanel?: boolean;
+    hideTryIt?: boolean;
+    hideSamples?: boolean;
+    hideSchemas?: boolean;
+    hideInternal?: boolean;
+    hideExport?: boolean;
+    hideServerInfo?: boolean;
+    hideSecurityInfo?: boolean;
+    exportProps?: ExportButtonProps;
+    tryItCredentialsPolicy?: 'omit' | 'include' | 'same-origin';
+    tryItCorsProxy?: string;
+    compact?: number | boolean;
+    renderExtensionAddon?: ExtensionAddonRenderer;
+    basePath?: string;
+    outerRouter?: boolean;
+};
+export declare const APIWithResponsiveSidebarLayout: React.FC<SidebarLayoutProps>;
+export {};

package/components/API/APIWithSidebarLayout.d.ts

@@ -1,20 +1,36 @@
-import { ExportButtonProps } from '@jpmorganchase/elemental-core';
+import { ExportButtonProps, TableOfContentsItem } from '@jpmorganchase/elemental-core';
+import { ExtensionAddonRenderer } from '@jpmorganchase/elemental-core/components/Docs';
 import * as React from 'react';
 import { ServiceNode } from '../../utils/oas/types';
 declare type SidebarLayoutProps = {
     serviceNode: ServiceNode;
     logo?: string;
+    hideTryItPanel?: boolean;
     hideTryIt?: boolean;
+    hideSamples?: boolean;
     hideSchemas?: boolean;
     hideInternal?: boolean;
+    hideServerInfo?: boolean;
+    hideSecurityInfo?: boolean;
     hideExport?: boolean;
     hideInlineExamples?: boolean;
     exportProps?: ExportButtonProps;
     tryItCredentialsPolicy?: 'omit' | 'include' | 'same-origin';
     tryItCorsProxy?: string;
+    renderExtensionAddon?: ExtensionAddonRenderer;
+    basePath?: string;
+    outerRouter?: boolean;
     tryItOutDefaultServer?: string;
     useCustomNav?: boolean;
     layout?: 'sidebar' | 'drawer';
 };
 export declare const APIWithSidebarLayout: React.FC<SidebarLayoutProps>;
+declare type SidebarProps = {
+    serviceNode: ServiceNode;
+    logo?: string;
+    container: React.RefObject<HTMLElement>;
+    pathname: string;
+    tree: TableOfContentsItem[];
+};
+export declare const Sidebar: React.FC<SidebarProps>;
 export {};

package/components/API/APIWithStackedLayout.d.ts

@@ -1,15 +1,30 @@
 import { ExportButtonProps } from '@jpmorganchase/elemental-core';
+import { ExtensionAddonRenderer } from '@jpmorganchase/elemental-core/components/Docs';
 import * as React from 'react';
 import { ServiceNode } from '../../utils/oas/types';
 declare type TryItCredentialsPolicy = 'omit' | 'include' | 'same-origin';
+interface Location {
+    pathname: string;
+    search: string;
+    hash: string;
+    state: unknown;
+    key: string;
+}
 declare type StackedLayoutProps = {
     serviceNode: ServiceNode;
+    hideTryItPanel?: boolean;
     hideTryIt?: boolean;
+    hideSamples?: boolean;
     hideExport?: boolean;
-    hideInlineExamples?: boolean;
+    hideServerInfo?: boolean;
+    hideSecurityInfo?: boolean;
     exportProps?: ExportButtonProps;
     tryItCredentialsPolicy?: TryItCredentialsPolicy;
     tryItCorsProxy?: string;
+    showPoweredByLink?: boolean;
+    location: Location;
+    renderExtensionAddon?: ExtensionAddonRenderer;
+    hideInlineExamples?: boolean;
     tryItOutDefaultServer?: string;
 };
 export declare const APIWithStackedLayout: React.FC<StackedLayoutProps>;

package/components/API/utils.d.ts

@@ -1,12 +1,13 @@
 import { TableOfContentsItem } from '@jpmorganchase/elemental-core';
-import { OperationNode, ServiceChildNode, ServiceNode } from '../../utils/oas/types';
-export declare type TagGroup = {
+import { OperationNode, SchemaNode, ServiceChildNode, ServiceNode, WebhookNode } from '../../utils/oas/types';
+declare type GroupableNode = OperationNode | WebhookNode | SchemaNode;
+export declare type TagGroup<T extends GroupableNode> = {
     title: string;
-    items: OperationNode[];
+    items: T[];
 };
-export declare const computeTagGroups: (serviceNode: ServiceNode) => {
-    groups: TagGroup[];
-    ungrouped: OperationNode[];
+export declare function computeTagGroups<T extends GroupableNode>(serviceNode: ServiceNode, nodeType: T['type']): {
+    groups: TagGroup<T>[];
+    ungrouped: T[];
 };
 interface ComputeAPITreeConfig {
     hideSchemas?: boolean;
@@ -15,4 +16,5 @@ interface ComputeAPITreeConfig {
 export declare const computeAPITree: (serviceNode: ServiceNode, config?: ComputeAPITreeConfig) => TableOfContentsItem[];
 export declare const findFirstNodeSlug: (tree: TableOfContentsItem[]) => string | void;
 export declare const isInternal: (node: ServiceChildNode | ServiceNode) => boolean;
+export declare const resolveRelativePath: (currentPath: string, basePath: string, outerRouter: boolean) => string;
 export {};

package/containers/API.d.ts

@@ -1,4 +1,5 @@
 import { RoutingProps } from '@jpmorganchase/elemental-core';
+import { ExtensionAddonRenderer } from '@jpmorganchase/elemental-core/components/Docs';
 import * as React from 'react';
 export declare type APIProps = APIPropsWithDocument | APIPropsWithUrl;
 export declare type APIPropsWithUrl = {
@@ -9,15 +10,22 @@ export declare type APIPropsWithDocument = {
     apiDescriptionUrl?: string;
 } & CommonAPIProps;
 export interface CommonAPIProps extends RoutingProps {
-    layout?: 'sidebar' | 'stacked' | 'drawer';
+    layout?: 'sidebar' | 'stacked' | 'responsive' | 'drawer';
     logo?: string;
     hideTryIt?: boolean;
+    hideSamples?: boolean;
+    hideTryItPanel?: boolean;
+    hideSecurityInfo?: boolean;
+    hideServerInfo?: boolean;
     hideSchemas?: boolean;
     hideInternal?: boolean;
     hideExport?: boolean;
     hideInlineExamples?: boolean;
     tryItCredentialsPolicy?: 'omit' | 'include' | 'same-origin';
     tryItCorsProxy?: string;
+    maxRefDepth?: number;
+    renderExtensionAddon?: ExtensionAddonRenderer;
+    outerRouter?: boolean;
     tryItOutDefaultServer?: string;
     useCustomNav?: boolean;
 }

package/containers/API.spec.d.ts

@@ -1,3 +1 @@
 import '@testing-library/jest-dom';
-import * as React from 'react';
-export declare const APIWithoutRouter: React.FC<import("./API").APIProps>;

package/containers/API.stories.d.ts

@@ -50,7 +50,9 @@ export declare const APIWithInternalOperations: import("@storybook/types").Annot
 export declare const OpenApi3Schema: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
 export declare const BadgesForSchema: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
 export declare const StackedLayout: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
+export declare const ResponsiveLayout: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
 export declare const Box: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
 export declare const DigitalOcean: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
 export declare const Github: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
 export declare const Instagram: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;
+export declare const WithExtensionRenderer: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, APIProps>;

package/containers/story-helper.d.ts

@@ -0,0 +1,2 @@
+export declare const renderExtensionRenderer: (props: any) => JSX.Element | null;
+export declare const wrapOptionsContext: (story: any) => JSX.Element;

package/index.d.ts

@@ -1,5 +1,7 @@
+export { APIWithStackedLayout } from './components/API/APIWithStackedLayout';
 export type { APIProps } from './containers/API';
 export { API } from './containers/API';
 export { useGetOasNavTree } from './hooks/oas-nav-tree/useGetOasNavTree';
 export { useExportDocumentProps } from './hooks/useExportDocumentProps';
 export { transformOasToServiceNode } from './utils/oas';
+export type { ServiceNode } from './utils/oas/types';