@stoplight/elements-core 8.1.4 → 8.3.1

package/__fixtures__/articles/schema-with-refs.d.ts

@@ -1 +1 @@
-export declare const schemaWithRefs = "---\ntitle: Schema with refs\n---\n\n# Schema with refs (Swr)\n\n### Schema\n\nThis is bundled schema with refs\n\n```json jsonSchema\n{\n  \"title\": \"DerefTest\",\n  \"type\": \"object\",\n  \"description\": \"Dereferencing test object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"inner\": {\n      \"description\": \"Inner object\",\n      \"title\": \"Inner\",\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\n          \"type\": \"string\"\n        },\n        \"referencedObject\": {\n          \"$ref\": \"#/properties/referencedObject\",\n          \"description\": \"Inner referenced object\"\n        }\n      },\n      \"required\": [\n        \"id\",\n        \"bookingRate\"\n      ]\n    },\n    \"referencedObject\": {\n      \"description\": \"Referenced object\",\n      \"title\": \"ReferencedObject\",\n      \"type\": \"object\",\n      \"required\": [\n        \"property1\",\n        \"property2\",\n        \"property3\"\n      ],\n      \"properties\": {\n        \"property1\": {\n          \"type\": \"integer\",\n          \"description\": \"Property 1\"\n        },\n        \"property2\": {\n          \"type\": \"string\",\n          \"description\": \"Property 2\"\n        },\n        \"property3\": {\n          \"type\": \"boolean\",\n          \"description\": \"Property 3\"\n        }\n      }\n    }\n  },\n  \"required\": [\n    \"id\",\n    \"inner\",\n    \"referencedObject\"\n  ]\n}\n```";
+export declare const schemaWithRefs = "---\ntitle: Schema with refs\n---\n\n# Schema with refs (Swr)\n\n### Schema\n\nThis is bundled schema with refs\n\n```json jsonSchema\n{\n  \"title\": \"DerefTest\",\n  \"type\": \"object\",\n  \"description\": \"Dereferencing test object\",\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"inner\": {\n      \"description\": \"Inner object\",\n      \"title\": \"Inner\",\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\n          \"type\": \"string\"\n        },\n        \"referencedObject\": {\n          \"$ref\": \"#/properties/referencedObject\",\n          \"description\": \"Inner referenced object\"\n        }\n      },\n      \"required\": [\n        \"id\",\n        \"bookingRate\"\n      ]\n    },\n    \"referencedObject\": {\n      \"description\": \"Referenced object\",\n      \"title\": \"ReferencedObject\",\n      \"type\": \"object\",\n      \"required\": [\n        \"property1\",\n        \"property2\",\n        \"property3\"\n      ],\n      \"properties\": {\n        \"property1\": {\n          \"type\": \"integer\",\n          \"description\": \"Property 1\"\n        },\n        \"property2\": {\n          \"type\": \"string\",\n          \"description\": \"Property 2\"\n        },\n        \"property3\": {\n          \"type\": \"boolean\",\n          \"description\": \"Property 3\"\n        },\n        \"property4\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"BUSINESS\",\n            \"PERSONAL\",\n            \"OTHER\"\n          ],\n          \"x-enum-descriptions\": {\n            \"BUSINESS\": \"Enum description for BUSINESS\",\n            \"PERSONAL\": \"Enum description for PERSONAL\",\n            \"OTHER\": \"Enum description for OTHER\"\n          }\n        }\n      }\n    }\n  },\n  \"required\": [\n    \"id\",\n    \"inner\",\n    \"referencedObject\"\n  ]\n}\n```";

package/components/Docs/Article/Article.stories.d.ts

@@ -1,13 +1,17 @@
 declare const meta: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;
 export default meta;
 export declare const Basic: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;
 export declare const KitchenSink: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;
 export declare const MultipleTryIts: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;

package/components/Docs/Docs.d.ts

@@ -1,3 +1,4 @@
+import { SchemaNode } from '@stoplight/json-schema-tree';
 import type { NodeHasChangedFn, NodeType } from '@stoplight/types';
 import { Location } from 'history';
 import * as React from 'react';
@@ -5,6 +6,13 @@ import { ParsedNode } from '../../types';
 import { ReferenceResolver } from '../../utils/ref-resolving/ReferenceResolver';
 import { ExportButtonProps } from './HttpService/ExportButton';
 declare type NodeUnsupportedFn = (err: 'dataEmpty' | 'invalidType' | Error) => void;
+export declare type VendorExtensionsData = Record<string, unknown>;
+export declare type ExtensionRowProps = {
+    schemaNode: SchemaNode;
+    nestingLevel: number;
+    vendorExtensions: VendorExtensionsData;
+};
+export declare type ExtensionAddonRenderer = (props: ExtensionRowProps) => React.ReactNode;
 interface BaseDocsProps {
     className?: string;
     uri?: string;
@@ -27,6 +35,7 @@ interface BaseDocsProps {
     };
     nodeHasChanged?: NodeHasChangedFn<React.ReactNode>;
     nodeUnsupported?: NodeUnsupportedFn;
+    renderExtensionAddon?: ExtensionAddonRenderer;
 }
 export interface DocsProps extends BaseDocsProps {
     nodeType: NodeType;

package/components/Docs/HttpOperation/Callbacks.d.ts

@@ -1,4 +1,5 @@
 import { IHttpCallbackOperation } from '@stoplight/types';
+import { ExtensionAddonRenderer } from '../Docs';
 export interface CallbacksProps {
     callbacks: IHttpCallbackOperation[];
     isCompact?: boolean;
@@ -6,6 +7,7 @@ export interface CallbacksProps {
 export interface CallbackProps {
     data: IHttpCallbackOperation;
     isCompact?: boolean;
+    renderExtensionAddon?: ExtensionAddonRenderer;
 }
 export declare const Callbacks: {
     ({ callbacks, isCompact }: CallbacksProps): JSX.Element;

package/components/Docs/HttpOperation/HttpOperation.stories.d.ts

@@ -1,7 +1,9 @@
 declare const meta: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;
 export default meta;
 export declare const Story: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;

package/components/Docs/HttpService/HttpService.stories.d.ts

@@ -1,7 +1,9 @@
 declare const meta: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;
 export default meta;
 export declare const Story: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;

package/components/Docs/Model/Model.stories.d.ts

@@ -1,7 +1,9 @@
 declare const meta: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;
 export default meta;
 export declare const Story: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, {
     data: any;
+    renderExtensionAddon?: import("..").ExtensionAddonRenderer | undefined;
 } & import("@stoplight/react-error-boundary").ErrorBoundaryProps<{}>>;

package/components/Docs/NodeVendorExtensions.d.ts

@@ -0,0 +1,7 @@
+import { INode } from '@stoplight/types';
+import type { JSONSchema7 } from 'json-schema';
+import * as React from 'react';
+export declare type NodeVendorExtensionsProps = {
+    data: INode | JSONSchema7;
+};
+export declare const NodeVendorExtensions: React.NamedExoticComponent<NodeVendorExtensionsProps>;

package/components/Docs/story-helper.d.ts

@@ -1,8 +1,10 @@
 import type { ErrorBoundaryProps } from '@stoplight/react-error-boundary';
 import type { Meta, StoryFn } from '@storybook/react';
 import * as React from 'react';
+import { ExtensionAddonRenderer } from './Docs';
 declare type DocsProps = {
     data: any;
+    renderExtensionAddon?: ExtensionAddonRenderer;
 } & ErrorBoundaryProps;
 declare type storyOptions = DocsProps & {
     layoutOptions?: object;

package/components/Docs/story-renderer-helper.d.ts

@@ -0,0 +1,3 @@
+import { ExtensionAddonRenderer } from './Docs';
+export declare const renderExtensionRenderer: ExtensionAddonRenderer;
+export declare const wrapOptionsContext: (story: any) => JSX.Element;

package/components/RequestSamples/RequestSamples.d.ts

@@ -1,7 +1,9 @@
 import { Request } from 'har-format';
 import React from 'react';
+import { CodeSample } from './extractCodeSamples';
 export interface RequestSamplesProps {
     request: Request;
+    customCodeSamples?: CodeSample[];
     embeddedInMd?: boolean;
 }
 export declare const RequestSamples: React.NamedExoticComponent<RequestSamplesProps>;

package/components/RequestSamples/RequestSamples.stories.d.ts

@@ -2,3 +2,4 @@ import { RequestSamplesProps } from './RequestSamples';
 declare const _default: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0a347bb9").R, RequestSamplesProps>;
 export default _default;
 export declare const HoistedStory: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, RequestSamplesProps>;
+export declare const RequestSampleWithCustomCodes: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, RequestSamplesProps>;

package/components/RequestSamples/extractCodeSamples.d.ts

@@ -0,0 +1,7 @@
+export declare type CodeSample = {
+    lang: string;
+    lib?: string;
+    label: string;
+    source: string;
+};
+export declare const extractCodeSamples: (obj: unknown) => CodeSample[];

package/components/RequestSamples/index.d.ts

@@ -1 +1,2 @@
+export * from './extractCodeSamples';
 export * from './RequestSamples';

package/components/RequestSamples/requestSampleConfigs.d.ts

@@ -1,16 +1,14 @@
 import { CodeViewerLanguage } from '@stoplight/mosaic-code-viewer';
 import { Dictionary } from '@stoplight/types';
-declare type SupportedLanguage = string;
-declare type SupportedLibrary = string;
-interface LibraryConfig {
+export declare type SupportedLanguage = string;
+export declare type SupportedLibrary = string;
+export interface LibraryConfig {
     httpSnippetLibrary: string;
 }
-interface LanguageConfig {
+export interface LanguageConfig {
     mosaicCodeViewerLanguage: CodeViewerLanguage;
     httpSnippetLanguage: string;
     libraries?: Dictionary<LibraryConfig, SupportedLibrary>;
 }
-declare type RequestSampleConfigs = Dictionary<LanguageConfig, SupportedLanguage>;
+export declare type RequestSampleConfigs = Dictionary<LanguageConfig, SupportedLanguage>;
 export declare const requestSampleConfigs: RequestSampleConfigs;
-export declare const getConfigFor: (language: string, library: string) => LanguageConfig & Partial<LibraryConfig>;
-export {};

package/components/TableOfContents/constants.d.ts

@@ -24,4 +24,7 @@ export declare const NODE_META_COLOR: {
     put: string;
     patch: string;
     delete: string;
+    head: string;
+    options: string;
+    trace: string;
 };

package/constants.d.ts

@@ -11,6 +11,9 @@ export declare const HttpMethodColors: {
     readonly put: "warning";
     readonly patch: "warning";
     readonly delete: "danger";
+    readonly head: "#9061F9";
+    readonly options: "#0D5AA7";
+    readonly trace: "#0D0B28";
 };
 export declare const HttpCodeColor: {
     readonly 0: "red";

package/context/Options.d.ts

@@ -1,9 +1,9 @@
 import * as React from 'react';
 import type { DocsProps } from '../components/Docs';
-export declare type ElementsOptionsContextProps = Pick<DocsProps, 'nodeHasChanged'>;
+export declare type ElementsOptionsContextProps = Pick<DocsProps, 'nodeHasChanged' | 'renderExtensionAddon'>;
 export declare const ElementsOptionsContext: React.Context<ElementsOptionsContextProps>;
 export declare const useOptionsCtx: () => ElementsOptionsContextProps;
 export declare type ProviderProps = Partial<ElementsOptionsContextProps> & {
     children: React.ReactNode;
 };
-export declare function ElementsOptionsProvider({ children, nodeHasChanged }: ProviderProps): JSX.Element;
+export declare function ElementsOptionsProvider({ children, nodeHasChanged, renderExtensionAddon }: ProviderProps): JSX.Element;

package/index.d.ts

@@ -1,4 +1,4 @@
-export { Docs, DocsProps, ParsedDocs } from './components/Docs';
+export { Docs, DocsProps, ExtensionAddonRenderer, ExtensionRowProps, ParsedDocs } from './components/Docs';
 export { DeprecatedBadge } from './components/Docs/HttpOperation/Badges';
 export { ExportButton, ExportButtonProps } from './components/Docs/HttpService/ExportButton';
 export { ResponsiveSidebarLayout } from './components/Layout/ResponsiveSidebarLayout';
@@ -17,6 +17,7 @@ export { TryIt, TryItProps, TryItWithRequestSamples, TryItWithRequestSamplesProp
 export { HttpMethodColors, NodeTypeColors, NodeTypeIconDefs, NodeTypePrettyName } from './constants';
 export { MockingProvider } from './containers/MockingProvider';
 export { InlineRefResolverProvider } from './context/InlineRefResolver';
+export { ElementsOptionsProvider } from './context/Options';
 export { PersistenceContextProvider, withPersistenceBoundary } from './context/Persistence';
 export { RouterTypeContext } from './context/RouterType';
 export { withMosaicProvider } from './hoc/withMosaicProvider';