@stoplight/elements 7.16.6 → 8.0.1

package/index.js

@@ -13,6 +13,7 @@ var reactQuery = require('react-query');
 var reactRouterDom = require('react-router-dom');
 var yaml = require('@stoplight/yaml');
 var saver = require('file-saver');
+var oas = require('@stoplight/http-spec/oas');
 var oas2 = require('@stoplight/http-spec/oas2');
 var oas3 = require('@stoplight/http-spec/oas3');
 var json = require('@stoplight/json');
@@ -49,13 +50,12 @@ var get__default = /*#__PURE__*/_interopDefaultLegacy(get);
 var isObject__default = /*#__PURE__*/_interopDefaultLegacy(isObject);
 var last__default = /*#__PURE__*/_interopDefaultLegacy(last);
 
-const computeTagGroups = (serviceNode) => {
+function computeTagGroups(serviceNode, nodeType) {
     const groupsByTagId = {};
     const ungrouped = [];
     const lowerCaseServiceTags = serviceNode.tags.map(tn => tn.toLowerCase());
-    for (const node of serviceNode.children) {
-        if (node.type !== types.NodeType.HttpOperation)
-            continue;
+    const groupableNodes = serviceNode.children.filter(n => n.type === nodeType);
+    for (const node of groupableNodes) {
         const tagName = node.tags[0];
         if (tagName) {
             const tagId = tagName.toLowerCase();
@@ -91,7 +91,7 @@ const computeTagGroups = (serviceNode) => {
     })
         .map(([, tagGroup]) => tagGroup);
     return { groups: orderedTagGroups, ungrouped };
-};
+}
 const defaultComputerAPITreeConfig = {
     hideSchemas: false,
     hideInternal: false,
@@ -106,12 +106,12 @@ const computeAPITree = (serviceNode, config = {}) => {
         type: 'overview',
         meta: '',
     });
-    const operationNodes = serviceNode.children.filter(node => node.type === types.NodeType.HttpOperation);
-    if (operationNodes.length) {
+    const hasOperationNodes = serviceNode.children.some(node => node.type === types.NodeType.HttpOperation);
+    if (hasOperationNodes) {
         tree.push({
             title: 'Endpoints',
         });
-        const { groups, ungrouped } = computeTagGroups(serviceNode);
+        const { groups, ungrouped } = computeTagGroups(serviceNode, types.NodeType.HttpOperation);
         ungrouped.forEach(operationNode => {
             if (mergedConfig.hideInternal && operationNode.data.internal) {
                 return;
@@ -141,13 +141,54 @@ const computeAPITree = (serviceNode, config = {}) => {
                 tree.push({
                     title: group.title,
                     items,
+                    itemsType: 'http_operation',
+                });
+            }
+        });
+    }
+    const hasWebhookNodes = serviceNode.children.some(node => node.type === types.NodeType.HttpWebhook);
+    if (hasWebhookNodes) {
+        tree.push({
+            title: 'Webhooks',
+        });
+        const { groups, ungrouped } = computeTagGroups(serviceNode, types.NodeType.HttpWebhook);
+        ungrouped.forEach(operationNode => {
+            if (mergedConfig.hideInternal && operationNode.data.internal) {
+                return;
+            }
+            tree.push({
+                id: operationNode.uri,
+                slug: operationNode.uri,
+                title: operationNode.name,
+                type: operationNode.type,
+                meta: operationNode.data.method,
+            });
+        });
+        groups.forEach(group => {
+            const items = group.items.flatMap(operationNode => {
+                if (mergedConfig.hideInternal && operationNode.data.internal) {
+                    return [];
+                }
+                return {
+                    id: operationNode.uri,
+                    slug: operationNode.uri,
+                    title: operationNode.name,
+                    type: operationNode.type,
+                    meta: operationNode.data.method,
+                };
+            });
+            if (items.length > 0) {
+                tree.push({
+                    title: group.title,
+                    items,
+                    itemsType: 'http_webhook',
                 });
             }
         });
     }
     let schemaNodes = serviceNode.children.filter(node => node.type === types.NodeType.Model);
     if (mergedConfig.hideInternal) {
-        schemaNodes = schemaNodes.filter(node => !node.data['x-internal']);
+        schemaNodes = schemaNodes.filter(n => !isInternal(n));
     }
     if (!mergedConfig.hideSchemas && schemaNodes.length) {
         tree.push({
@@ -181,7 +222,7 @@ const findFirstNodeSlug = (tree) => {
 };
 const isInternal = (node) => {
     const data = node.data;
-    if (elementsCore.isHttpOperation(data)) {
+    if (elementsCore.isHttpOperation(data) || elementsCore.isHttpWebhookOperation(data)) {
         return !!data.internal;
     }
     if (elementsCore.isHttpService(data)) {
@@ -191,7 +232,12 @@ const isInternal = (node) => {
 };
 
 const itemMatchesHash = (hash, item) => {
-    return hash.substr(1) === `${item.data.path}-${item.data.method}`;
+    if (item.type === types.NodeType.HttpOperation) {
+        return hash.substr(1) === `${item.data.path}-${item.data.method}`;
+    }
+    else {
+        return hash.substr(1) === `${item.data.name}-${item.data.method}`;
+    }
 };
 const TryItContext = React__namespace.createContext({
     hideTryIt: false,
@@ -209,14 +255,19 @@ const LocationContext = React__namespace.createContext({
 });
 LocationContext.displayName = 'LocationContext';
 const APIWithStackedLayout = ({ serviceNode, hideTryIt, hideExport, exportProps, tryItCredentialsPolicy, tryItCorsProxy, showPoweredByLink = true, location, }) => {
-    const { groups } = computeTagGroups(serviceNode);
+    const { groups: operationGroups } = computeTagGroups(serviceNode, types.NodeType.HttpOperation);
+    const { groups: webhookGroups } = computeTagGroups(serviceNode, types.NodeType.HttpWebhook);
     return (React__namespace.createElement(LocationContext.Provider, { value: { location } },
         React__namespace.createElement(TryItContext.Provider, { value: { hideTryIt, tryItCredentialsPolicy, corsProxy: tryItCorsProxy } },
             React__namespace.createElement(mosaic.Flex, { w: "full", flexDirection: "col", m: "auto", className: "sl-max-w-4xl" },
                 React__namespace.createElement(mosaic.Box, { w: "full", borderB: true },
                     React__namespace.createElement(elementsCore.Docs, { className: "sl-mx-auto", nodeData: serviceNode.data, nodeTitle: serviceNode.name, nodeType: types.NodeType.HttpService, location: location, layoutOptions: { showPoweredByLink, hideExport }, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy })),
-                groups.map(group => (React__namespace.createElement(Group, { key: group.title, group: group })))))));
+                operationGroups.length > 0 && webhookGroups.length > 0 ? React__namespace.createElement(mosaic.Heading, { size: 2 }, "Endpoints") : null,
+                operationGroups.map(group => (React__namespace.createElement(Group, { key: group.title, group: group }))),
+                webhookGroups.length > 0 ? React__namespace.createElement(mosaic.Heading, { size: 2 }, "Webhooks") : null,
+                webhookGroups.map(group => (React__namespace.createElement(Group, { key: group.title, group: group })))))));
 };
+APIWithStackedLayout.displayName = 'APIWithStackedLayout';
 const Group = React__namespace.memo(({ group }) => {
     const [isExpanded, setIsExpanded] = React__namespace.useState(false);
     const scrollRef = React__namespace.useRef(null);
@@ -243,6 +294,7 @@ const Group = React__namespace.memo(({ group }) => {
             return React__namespace.createElement(Item, { key: item.uri, item: item });
         }))));
 });
+Group.displayName = 'Group';
 const Item = React__namespace.memo(({ item }) => {
     const { location } = React__namespace.useContext(LocationContext);
     const { hash } = location;
@@ -264,7 +316,7 @@ const Item = React__namespace.memo(({ item }) => {
     return (React__namespace.createElement(mosaic.Box, { ref: scrollRef, w: "full", my: 2, border: true, borderColor: { default: isExpanded ? 'light' : 'transparent', hover: 'light' }, bg: { default: isExpanded ? 'code' : 'transparent', hover: 'code' } },
         React__namespace.createElement(mosaic.Flex, { mx: "auto", alignItems: "center", cursor: "pointer", fontSize: "lg", p: 2, onClick: onClick, color: "current" },
             React__namespace.createElement(mosaic.Box, { w: 24, textTransform: "uppercase", textAlign: "center", fontWeight: "semibold", border: true, rounded: true, px: 2, bg: "canvas", className: cn__default["default"](`sl-mr-5 sl-text-base`, `sl-text-${color}`, `sl-border-${color}`) }, item.data.method || 'UNKNOWN'),
-            React__namespace.createElement(mosaic.Box, { flex: 1, fontWeight: "medium", wordBreak: "all" }, item.data.path),
+            React__namespace.createElement(mosaic.Box, { flex: 1, fontWeight: "medium", wordBreak: "all" }, item.type === types.NodeType.HttpOperation ? item.data.path : item.name),
             isDeprecated && React__namespace.createElement(elementsCore.DeprecatedBadge, null)),
         React__namespace.createElement(Collapse, { isOpen: isExpanded },
             React__namespace.createElement(mosaic.Box, { flex: 1, p: 2, fontWeight: "medium", mx: "auto", fontSize: "xl" }, item.name),
@@ -278,10 +330,37 @@ const Item = React__namespace.memo(({ item }) => {
                     React__namespace.createElement(mosaic.TabPanel, null,
                         React__namespace.createElement(elementsCore.TryItWithRequestSamples, { httpOperation: item.data, tryItCredentialsPolicy: tryItCredentialsPolicy, corsProxy: corsProxy }))))))));
 });
+Item.displayName = 'Item';
 const Collapse = ({ isOpen, children }) => {
     if (!isOpen)
         return null;
     return React__namespace.createElement(mosaic.Box, null, children);
+};
+Collapse.displayName = 'Collapse';
+
+const APIWithResponsiveSidebarLayout = ({ serviceNode, logo, hideTryIt, compact, hideSchemas, hideInternal, hideExport, exportProps, tryItCredentialsPolicy, tryItCorsProxy, }) => {
+    const container = React__namespace.useRef(null);
+    const tree = React__namespace.useMemo(() => computeAPITree(serviceNode, { hideSchemas, hideInternal }), [serviceNode, hideSchemas, hideInternal]);
+    const location = reactRouterDom.useLocation();
+    const { pathname } = location;
+    const isRootPath = !pathname || pathname === '/';
+    const node = isRootPath ? serviceNode : serviceNode.children.find(child => child.uri === pathname);
+    const layoutOptions = React__namespace.useMemo(() => ({ hideTryIt: hideTryIt, compact: compact, hideExport: hideExport || (node === null || node === void 0 ? void 0 : node.type) !== types.NodeType.HttpService }), [hideTryIt, hideExport, node, compact]);
+    if (!node) {
+        const firstSlug = findFirstNodeSlug(tree);
+        if (firstSlug) {
+            return React__namespace.createElement(reactRouterDom.Redirect, { to: firstSlug });
+        }
+    }
+    if (hideInternal && node && isInternal(node)) {
+        return React__namespace.createElement(reactRouterDom.Redirect, { to: "/" });
+    }
+    const handleTocClick = () => {
+        if (container.current) {
+            container.current.scrollIntoView();
+        }
+    };
+    return (React__namespace.createElement(elementsCore.ResponsiveSidebarLayout, { onTocClick: handleTocClick, tree: tree, logo: logo !== null && logo !== void 0 ? logo : serviceNode.data.logo, ref: container, name: serviceNode.name }, node && (React__namespace.createElement(elementsCore.ParsedDocs, { key: pathname, uri: pathname, node: node, nodeTitle: node.name, layoutOptions: layoutOptions, location: location, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy }))));
 };
 
 const APIWithSidebarLayout = ({ serviceNode, logo, hideTryIt, hideSchemas, hideInternal, hideExport, exportProps, tryItCredentialsPolicy, tryItCorsProxy, }) => {
@@ -301,26 +380,32 @@ const APIWithSidebarLayout = ({ serviceNode, logo, hideTryIt, hideSchemas, hideI
     if (hideInternal && node && isInternal(node)) {
         return React__namespace.createElement(reactRouterDom.Redirect, { to: "/" });
     }
+    const sidebar = (React__namespace.createElement(Sidebar, { serviceNode: serviceNode, logo: logo, container: container, pathname: pathname, tree: tree }));
+    return (React__namespace.createElement(elementsCore.SidebarLayout, { ref: container, sidebar: sidebar }, node && (React__namespace.createElement(elementsCore.ParsedDocs, { key: pathname, uri: pathname, node: node, nodeTitle: node.name, layoutOptions: layoutOptions, location: location, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy }))));
+};
+const Sidebar = ({ serviceNode, logo, container, pathname, tree }) => {
     const handleTocClick = () => {
         if (container.current) {
             container.current.scrollIntoView();
         }
     };
-    const sidebar = (React__namespace.createElement(React__namespace.Fragment, null,
+    return (React__namespace.createElement(React__namespace.Fragment, null,
         React__namespace.createElement(mosaic.Flex, { ml: 4, mb: 5, alignItems: "center" },
             logo ? (React__namespace.createElement(elementsCore.Logo, { logo: { url: logo, altText: 'logo' } })) : (serviceNode.data.logo && React__namespace.createElement(elementsCore.Logo, { logo: serviceNode.data.logo })),
             React__namespace.createElement(mosaic.Heading, { size: 4 }, serviceNode.name)),
         React__namespace.createElement(mosaic.Flex, { flexGrow: true, flexShrink: true, overflowY: "auto", direction: "col" },
             React__namespace.createElement(elementsCore.TableOfContents, { tree: tree, activeId: pathname, Link: reactRouterDom.Link, onLinkClick: handleTocClick })),
         React__namespace.createElement(elementsCore.PoweredByLink, { source: serviceNode.name, pathname: pathname, packageType: "elements" })));
-    return (React__namespace.createElement(elementsCore.SidebarLayout, { ref: container, sidebar: sidebar }, node && (React__namespace.createElement(elementsCore.ParsedDocs, { key: pathname, uri: pathname, node: node, nodeTitle: node.name, layoutOptions: layoutOptions, location: location, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy }))));
-};
+};
+Sidebar.displayName = 'Sidebar';
 
 var NodeTypes;
 (function (NodeTypes) {
     NodeTypes["Paths"] = "paths";
     NodeTypes["Path"] = "path";
     NodeTypes["Operation"] = "operation";
+    NodeTypes["Webhooks"] = "webhooks";
+    NodeTypes["Webhook"] = "webhook";
     NodeTypes["Components"] = "components";
     NodeTypes["Models"] = "models";
     NodeTypes["Model"] = "model";
@@ -372,6 +457,22 @@ const oas3SourceMap = [
             },
         ],
     },
+    {
+        match: 'webhooks',
+        type: NodeTypes.Webhooks,
+        children: [
+            {
+                notMatch: '^x-',
+                type: NodeTypes.Webhook,
+                children: [
+                    {
+                        match: 'get|post|put|delete|options|head|patch|trace',
+                        type: NodeTypes.Webhook,
+                    },
+                ],
+            },
+        ],
+    },
     {
         match: 'components',
         type: NodeTypes.Components,
@@ -426,7 +527,7 @@ function computeServiceNode(document, map, transformService, transformOperation)
     return serviceNode;
 }
 function computeChildNodes(document, data, map, transformer, parentUri = '') {
-    var _a;
+    var _a, _b;
     const nodes = [];
     if (!isObject__default["default"](data))
         return nodes;
@@ -439,7 +540,12 @@ function computeChildNodes(document, data, map, transformer, parentUri = '') {
             if (match.type === NodeTypes.Operation && jsonPath.length === 3) {
                 const path = String(jsonPath[1]);
                 const method = String(jsonPath[2]);
-                const operationDocument = transformer({ document, path, method });
+                const operationDocument = transformer({
+                    document,
+                    name: path,
+                    method,
+                    config: oas.OPERATION_CONFIG,
+                });
                 let parsedUri;
                 const encodedPath = String(json.encodePointerFragment(path));
                 if (operationDocument.iid) {
@@ -456,6 +562,31 @@ function computeChildNodes(document, data, map, transformer, parentUri = '') {
                     tags: ((_a = operationDocument.tags) === null || _a === void 0 ? void 0 : _a.map(tag => tag.name)) || [],
                 });
             }
+            else if (match.type === NodeTypes.Webhook && jsonPath.length === 3) {
+                const name = String(jsonPath[1]);
+                const method = String(jsonPath[2]);
+                const webhookDocument = transformer({
+                    document,
+                    name,
+                    method,
+                    config: oas.WEBHOOK_CONFIG,
+                });
+                let parsedUri;
+                const encodedPath = String(json.encodePointerFragment(name));
+                if (webhookDocument.iid) {
+                    parsedUri = `/webhooks/${webhookDocument.iid}`;
+                }
+                else {
+                    parsedUri = uri.replace(encodedPath, elementsCore.slugify(name));
+                }
+                nodes.push({
+                    type: types.NodeType.HttpWebhook,
+                    uri: parsedUri,
+                    data: webhookDocument,
+                    name: webhookDocument.summary || webhookDocument.name,
+                    tags: ((_b = webhookDocument.tags) === null || _b === void 0 ? void 0 : _b.map(tag => tag.name)) || [],
+                });
+            }
             else if (match.type === NodeTypes.Model) {
                 const schemaDocument = get__default["default"](document, jsonPath);
                 const parsedUri = uri.replace(OAS_MODEL_REGEXP, 'schemas/');
@@ -528,9 +659,10 @@ const propsAreWithDocument = (props) => {
     return props.hasOwnProperty('apiDescriptionDocument');
 };
 const APIImpl = props => {
-    const { layout, apiDescriptionUrl = '', logo, hideTryIt, hideSchemas, hideInternal, hideExport, tryItCredentialsPolicy, tryItCorsProxy, maxRefDepth, } = props;
+    const { layout = 'sidebar', apiDescriptionUrl = '', logo, hideTryIt, hideSchemas, hideInternal, hideExport, tryItCredentialsPolicy, tryItCorsProxy, maxRefDepth, } = props;
     const location = reactRouterDom.useLocation();
     const apiDescriptionDocument = propsAreWithDocument(props) ? props.apiDescriptionDocument : undefined;
+    const { isResponsiveLayoutEnabled } = elementsCore.useResponsiveLayout();
     const { data: fetchedDocument, error } = reactQuery.useQuery([apiDescriptionUrl], () => fetch(apiDescriptionUrl).then(res => {
         if (res.ok) {
             return res.text();
@@ -556,7 +688,10 @@ const APIImpl = props => {
         return (React__namespace.createElement(mosaic.Flex, { justify: "center", alignItems: "center", w: "full", minH: "screen" },
             React__namespace.createElement(elementsCore.NonIdealState, { title: "Failed to parse OpenAPI file", description: "Please make sure your OpenAPI file is valid and try again" })));
     }
-    return (React__namespace.createElement(elementsCore.InlineRefResolverProvider, { document: parsedDocument, maxRefDepth: maxRefDepth }, layout === 'stacked' ? (React__namespace.createElement(APIWithStackedLayout, { serviceNode: serviceNode, hideTryIt: hideTryIt, hideExport: hideExport, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy, location: location })) : (React__namespace.createElement(APIWithSidebarLayout, { logo: logo, serviceNode: serviceNode, hideTryIt: hideTryIt, hideSchemas: hideSchemas, hideInternal: hideInternal, hideExport: hideExport, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy }))));
+    return (React__namespace.createElement(elementsCore.InlineRefResolverProvider, { document: parsedDocument, maxRefDepth: maxRefDepth },
+        layout === 'stacked' && (React__namespace.createElement(APIWithStackedLayout, { serviceNode: serviceNode, hideTryIt: hideTryIt, hideExport: hideExport, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy, location: location })),
+        layout === 'sidebar' && (React__namespace.createElement(APIWithSidebarLayout, { logo: logo, serviceNode: serviceNode, hideTryIt: hideTryIt, hideSchemas: hideSchemas, hideInternal: hideInternal, hideExport: hideExport, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy })),
+        layout === 'responsive' && (React__namespace.createElement(APIWithResponsiveSidebarLayout, { logo: logo, serviceNode: serviceNode, hideTryIt: hideTryIt, hideSchemas: hideSchemas, hideInternal: hideInternal, hideExport: hideExport, exportProps: exportProps, tryItCredentialsPolicy: tryItCredentialsPolicy, tryItCorsProxy: tryItCorsProxy, compact: isResponsiveLayoutEnabled }))));
 };
 const API = flow__default["default"](elementsCore.withRouter, elementsCore.withStyles, elementsCore.withPersistenceBoundary, elementsCore.withMosaicProvider, elementsCore.withQueryClientProvider)(APIImpl);