@stoplight/elements-core 7.7.0 → 7.7.2

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

@@ -1,9 +1,13 @@
-import { Meta, Story } from '@storybook/react';
+import type { ErrorBoundaryProps } from '@stoplight/react-error-boundary';
+import type { Meta, Story } from '@storybook/react';
 import * as React from 'react';
-interface HelperReturn<P> {
+declare type DocsProps = {
+    data: unknown;
+} & ErrorBoundaryProps;
+interface HelperReturn<P extends Partial<DocsProps>> {
     meta: Meta<P>;
     createStory(name: string, input: Partial<P>): Story<P>;
     createHoistedStory(input: Partial<P>): Story<P>;
 }
-export declare const createStoriesForDocsComponent: <P>(Component: React.ComponentType<P>, title?: string | undefined) => HelperReturn<P>;
+export declare const createStoriesForDocsComponent: <P extends Partial<DocsProps> = DocsProps>(Component: React.ComponentType<P>, title?: string | undefined) => HelperReturn<P>;
 export {};

package/context/RouterType.d.ts

@@ -1,3 +1,4 @@
 import * as React from 'react';
 import type { RouterType } from '../types';
-export declare const RouterTypeContext: React.Context<RouterType>;
+export declare const RouterTypeContext: React.Context<RouterType | null>;
+export declare const useRouterType: () => RouterType | null;

package/index.esm.js

@@ -2088,9 +2088,17 @@ ${scopes.map(([key, value]) => `- \`${key}\` - ${value}`).join('\n')}`;
     return description;
 }
 
-const RouterTypeContext = React.createContext('history');
+const RouterTypeContext = React.createContext(null);
+const useRouterType = () => {
+    return React.useContext(RouterTypeContext);
+};
 
-const LinkHeading = React.memo(function LinkHeading(_a) {
+const LinkHeading = React.memo(function LinkHeading(props) {
+    const isUsingRouter = !!useRouterType();
+    const Comp = isUsingRouter ? CustomLinkHeading : LinkHeading$1;
+    return React.createElement(Comp, Object.assign({}, props));
+});
+const CustomLinkHeading = React.memo(function LinkHeading(_a) {
     var { id: _id } = _a, props = __rest(_a, ["id"]);
     const { pathname } = useLocation();
     const routerKind = React.useContext(RouterTypeContext);
@@ -2172,7 +2180,6 @@ const Parameters = ({ parameters, parameterType }) => {
 };
 Parameters.displayName = 'HttpOperation.Parameters';
 const httpOperationParamsToSchema = ({ parameters, parameterType }) => {
-    var _a, _b, _c;
     if (!parameters || !parameters.length)
         return null;
     const schema = {
@@ -2182,19 +2189,22 @@ const httpOperationParamsToSchema = ({ parameters, parameterType }) => {
     const sortedParams = sortBy(parameters, ['required', 'name']);
     for (const p of sortedParams) {
         const { name, description, required, deprecated, examples, style } = p;
+        const paramSchema = isPlainObject$1(p.schema) ? p.schema : {};
         const paramExamples = (examples === null || examples === void 0 ? void 0 : examples.map(example => {
             if (isNodeExample(example)) {
                 return example.value;
             }
             return example.externalValue;
         })) || [];
-        const schemaExamples = (_a = p.schema) === null || _a === void 0 ? void 0 : _a.examples;
+        const schemaExamples = paramSchema.examples;
         const schemaExamplesArray = Array.isArray(schemaExamples) ? schemaExamples : [];
-        const paramDescription = description || ((_b = p.schema) === null || _b === void 0 ? void 0 : _b.description);
-        const paramDeprecated = deprecated || p.schema.deprecated;
+        const paramDescription = description || paramSchema.description;
+        const paramDeprecated = !!(deprecated || paramSchema.deprecated);
         const paramStyle = style && defaultStyle[parameterType] !== style ? readableStyles[style] || style : undefined;
-        schema.properties[p.name] = Object.assign(Object.assign({}, (p.schema || {})), { description: paramDescription, examples: [...paramExamples, ...schemaExamplesArray], deprecated: paramDeprecated, style: paramStyle, 'x-stoplight': Object.assign(Object.assign({}, (((_c = p.schema) === null || _c === void 0 ? void 0 : _c['x-stoplight']) || {})), { id: p.id }) });
-        if (required) {
+        if (isPlainObject$1(schema.properties)) {
+            schema.properties[p.name] = Object.assign(Object.assign({}, paramSchema), { description: paramDescription, examples: [...paramExamples, ...schemaExamplesArray], deprecated: paramDeprecated, style: paramStyle, 'x-stoplight': Object.assign(Object.assign({}, (isPlainObject$1(paramSchema['x-stoplight']) ? paramSchema['x-stoplight'] : {})), { id: p.id }) });
+        }
+        if (required && Array.isArray(schema.required)) {
             schema.required.push(name);
         }
     }

package/index.js

@@ -2142,9 +2142,17 @@ ${scopes.map(([key, value]) => `- \`${key}\` - ${value}`).join('\n')}`;
     return description;
 }
 
-const RouterTypeContext = React__namespace.createContext('history');
+const RouterTypeContext = React__namespace.createContext(null);
+const useRouterType = () => {
+    return React__namespace.useContext(RouterTypeContext);
+};
 
-const LinkHeading = React__namespace.memo(function LinkHeading(_a) {
+const LinkHeading = React__namespace.memo(function LinkHeading(props) {
+    const isUsingRouter = !!useRouterType();
+    const Comp = isUsingRouter ? CustomLinkHeading : mosaic.LinkHeading;
+    return React__namespace.createElement(Comp, Object.assign({}, props));
+});
+const CustomLinkHeading = React__namespace.memo(function LinkHeading(_a) {
     var { id: _id } = _a, props = tslib.__rest(_a, ["id"]);
     const { pathname } = reactRouterDom.useLocation();
     const routerKind = React__namespace.useContext(RouterTypeContext);
@@ -2226,7 +2234,6 @@ const Parameters = ({ parameters, parameterType }) => {
 };
 Parameters.displayName = 'HttpOperation.Parameters';
 const httpOperationParamsToSchema = ({ parameters, parameterType }) => {
-    var _a, _b, _c;
     if (!parameters || !parameters.length)
         return null;
     const schema = {
@@ -2236,19 +2243,22 @@ const httpOperationParamsToSchema = ({ parameters, parameterType }) => {
     const sortedParams = sortBy__default["default"](parameters, ['required', 'name']);
     for (const p of sortedParams) {
         const { name, description, required, deprecated, examples, style } = p;
+        const paramSchema = json.isPlainObject(p.schema) ? p.schema : {};
         const paramExamples = (examples === null || examples === void 0 ? void 0 : examples.map(example => {
             if (isNodeExample(example)) {
                 return example.value;
             }
             return example.externalValue;
         })) || [];
-        const schemaExamples = (_a = p.schema) === null || _a === void 0 ? void 0 : _a.examples;
+        const schemaExamples = paramSchema.examples;
         const schemaExamplesArray = Array.isArray(schemaExamples) ? schemaExamples : [];
-        const paramDescription = description || ((_b = p.schema) === null || _b === void 0 ? void 0 : _b.description);
-        const paramDeprecated = deprecated || p.schema.deprecated;
+        const paramDescription = description || paramSchema.description;
+        const paramDeprecated = !!(deprecated || paramSchema.deprecated);
         const paramStyle = style && defaultStyle[parameterType] !== style ? readableStyles[style] || style : undefined;
-        schema.properties[p.name] = Object.assign(Object.assign({}, (p.schema || {})), { description: paramDescription, examples: [...paramExamples, ...schemaExamplesArray], deprecated: paramDeprecated, style: paramStyle, 'x-stoplight': Object.assign(Object.assign({}, (((_c = p.schema) === null || _c === void 0 ? void 0 : _c['x-stoplight']) || {})), { id: p.id }) });
-        if (required) {
+        if (json.isPlainObject(schema.properties)) {
+            schema.properties[p.name] = Object.assign(Object.assign({}, paramSchema), { description: paramDescription, examples: [...paramExamples, ...schemaExamplesArray], deprecated: paramDeprecated, style: paramStyle, 'x-stoplight': Object.assign(Object.assign({}, (json.isPlainObject(paramSchema['x-stoplight']) ? paramSchema['x-stoplight'] : {})), { id: p.id }) });
+        }
+        if (required && Array.isArray(schema.required)) {
             schema.required.push(name);
         }
     }

package/index.mjs

@@ -2088,9 +2088,17 @@ ${scopes.map(([key, value]) => `- \`${key}\` - ${value}`).join('\n')}`;
     return description;
 }
 
-const RouterTypeContext = React.createContext('history');
+const RouterTypeContext = React.createContext(null);
+const useRouterType = () => {
+    return React.useContext(RouterTypeContext);
+};
 
-const LinkHeading = React.memo(function LinkHeading(_a) {
+const LinkHeading = React.memo(function LinkHeading(props) {
+    const isUsingRouter = !!useRouterType();
+    const Comp = isUsingRouter ? CustomLinkHeading : LinkHeading$1;
+    return React.createElement(Comp, Object.assign({}, props));
+});
+const CustomLinkHeading = React.memo(function LinkHeading(_a) {
     var { id: _id } = _a, props = __rest(_a, ["id"]);
     const { pathname } = useLocation();
     const routerKind = React.useContext(RouterTypeContext);
@@ -2172,7 +2180,6 @@ const Parameters = ({ parameters, parameterType }) => {
 };
 Parameters.displayName = 'HttpOperation.Parameters';
 const httpOperationParamsToSchema = ({ parameters, parameterType }) => {
-    var _a, _b, _c;
     if (!parameters || !parameters.length)
         return null;
     const schema = {
@@ -2182,19 +2189,22 @@ const httpOperationParamsToSchema = ({ parameters, parameterType }) => {
     const sortedParams = sortBy(parameters, ['required', 'name']);
     for (const p of sortedParams) {
         const { name, description, required, deprecated, examples, style } = p;
+        const paramSchema = isPlainObject$1(p.schema) ? p.schema : {};
         const paramExamples = (examples === null || examples === void 0 ? void 0 : examples.map(example => {
             if (isNodeExample(example)) {
                 return example.value;
             }
             return example.externalValue;
         })) || [];
-        const schemaExamples = (_a = p.schema) === null || _a === void 0 ? void 0 : _a.examples;
+        const schemaExamples = paramSchema.examples;
         const schemaExamplesArray = Array.isArray(schemaExamples) ? schemaExamples : [];
-        const paramDescription = description || ((_b = p.schema) === null || _b === void 0 ? void 0 : _b.description);
-        const paramDeprecated = deprecated || p.schema.deprecated;
+        const paramDescription = description || paramSchema.description;
+        const paramDeprecated = !!(deprecated || paramSchema.deprecated);
         const paramStyle = style && defaultStyle[parameterType] !== style ? readableStyles[style] || style : undefined;
-        schema.properties[p.name] = Object.assign(Object.assign({}, (p.schema || {})), { description: paramDescription, examples: [...paramExamples, ...schemaExamplesArray], deprecated: paramDeprecated, style: paramStyle, 'x-stoplight': Object.assign(Object.assign({}, (((_c = p.schema) === null || _c === void 0 ? void 0 : _c['x-stoplight']) || {})), { id: p.id }) });
-        if (required) {
+        if (isPlainObject$1(schema.properties)) {
+            schema.properties[p.name] = Object.assign(Object.assign({}, paramSchema), { description: paramDescription, examples: [...paramExamples, ...schemaExamplesArray], deprecated: paramDeprecated, style: paramStyle, 'x-stoplight': Object.assign(Object.assign({}, (isPlainObject$1(paramSchema['x-stoplight']) ? paramSchema['x-stoplight'] : {})), { id: p.id }) });
+        }
+        if (required && Array.isArray(schema.required)) {
             schema.required.push(name);
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/elements-core",
-  "version": "7.7.0",
+  "version": "7.7.2",
   "main": "./index.js",
   "sideEffects": [
     "web-components.min.js",