@redocly/asyncapi-docs 1.2.0-next.2 → 1.2.0-next.4

package/lib/components/ApiInfo.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ApiInfo=void 0;const e=require("react/jsx-runtime"),t=require("jotai"),n=require("@redocly/openapi-docs"),u=require("@redocly/theme"),c=require("./common"),i=require("../jotai-store/app"),d=()=>{const o=(0,t.useAtomValue)(i.definitionAtom),s=(0,t.useAtomValue)(i.routingBasePathAtom),a=(0,t.useAtomValue)(i.markdocOptionsAtom),r=(0,n.saveTextBeforeHeading)((0,n.getValueFromMdParsedExtension)(o.info,"description")||"");return(0,e.jsxs)(n.Section,{sectionId:s,children:[(0,e.jsxs)(c.ApiHeader,{children:[o.info.title," ",o.info.version,(0,e.jsx)(u.PageActions,{pageSlug:s})]}),r&&(0,e.jsx)(n.Markdown,{source:r,markdocOptions:a}),o.info.externalDocs&&(0,e.jsx)(c.ExternalDocumentationWrapper,{children:(0,e.jsx)(n.ExternalDocumentation,{externalDocs:o.info.externalDocs})})]})};exports.ApiInfo=d;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ApiInfo=void 0;const t=require("react/jsx-runtime"),n=require("jotai"),o=require("@redocly/openapi-docs"),d=require("@redocly/theme"),r=require("./common"),s=require("../jotai-store/app"),l=require("../hooks"),m=()=>{const e=(0,n.useAtomValue)(s.definitionAtom),i=(0,n.useAtomValue)(s.routingBasePathAtom),c=(0,n.useAtomValue)(s.markdocOptionsAtom),u=(0,l.useTranslate)(),a=(0,o.saveTextBeforeHeading)((0,o.getValueFromMdParsedExtension)(e.info,"description")||"");return(0,t.jsxs)(o.Section,{sectionId:i,children:[(0,t.jsxs)(r.ApiHeader,{children:[e.info.title," ",e.info.version,(0,t.jsx)(d.PageActions,{pageSlug:i})]}),a&&(0,t.jsx)(o.Markdown,{source:a,markdocOptions:c}),e.info.externalDocs&&(0,t.jsx)(r.ExternalDocumentationWrapper,{children:(0,t.jsx)(o.ExternalDocumentation,{externalDocs:e.info.externalDocs})}),e.info["x-metadata"]&&(0,t.jsx)(o.Metadata,{metadata:e.info["x-metadata"],translate:u})]})};exports.ApiInfo=m;

package/lib/components/DownloadSpecification.js

@@ -1,4 +1,4 @@
-"use strict";var d=exports&&exports.__importDefault||function(o){return o&&o.__esModule?o:{default:o}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DownloadSpecification=void 0;const e=require("react/jsx-runtime"),i=require("react"),r=d(require("styled-components")),t=require("@redocly/theme"),u=require("@redocly/openapi-docs"),p=require("jotai"),f=require("../jotai-store/app");function m(){const o=(0,p.useAtomValue)(f.downloadUrlsAtom),a=(0,u.useDownloadInfo)({downloadUrls:o}),l=(0,i.useCallback)(n=>{switch(n){case"yaml":return(0,e.jsx)(t.DocumentIcon,{});case"json":return(0,e.jsx)(t.JsonIcon,{});default:return(0,e.jsx)(t.FileIcon,{})}},[]);return a?(0,e.jsx)(_,{children:(a||[]).map(({title:n,url:s,iconType:c})=>(0,e.jsxs)(x,{children:[(0,e.jsxs)(w,{children:[l(c),(0,e.jsx)("a",{href:s,target:"_blank",download:!0,rel:"noreferrer",children:n})]}),(0,e.jsx)("a",{href:s,target:"_blank",download:!0,rel:"noreferrer",children:(0,e.jsx)(t.Button,{variant:"text",size:"small",icon:(0,e.jsx)(t.DownloadIcon,{})})})]},n))}):(0,e.jsx)(e.Fragment,{})}exports.DownloadSpecification=(0,i.memo)(m);const x=r.default.div`
+"use strict";var u=exports&&exports.__importDefault||function(o){return o&&o.__esModule?o:{default:o}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DownloadSpecification=void 0;const e=require("react/jsx-runtime"),i=require("react"),r=u(require("styled-components")),n=require("@redocly/theme"),p=require("@redocly/openapi-docs"),f=require("jotai"),m=require("../jotai-store/app"),x=require("../hooks");function w(){const o=(0,x.useTelemetry)(),c=(0,f.useAtomValue)(m.downloadUrlsAtom),a=(0,p.useDownloadInfo)({downloadUrls:c}),l=(0,i.useCallback)(t=>{switch(t){case"yaml":return(0,e.jsx)(n.DocumentIcon,{});case"json":return(0,e.jsx)(n.JsonIcon,{});default:return(0,e.jsx)(n.FileIcon,{})}},[]);return a?(0,e.jsx)(h,{children:(a||[]).map(({title:t,url:s,iconType:d})=>(0,e.jsxs)(_,{onClick:()=>o.send({type:"asyncapi_docs.download_definition.clicked"}),children:[(0,e.jsxs)(b,{children:[l(d),(0,e.jsx)("a",{href:s,target:"_blank",download:!0,rel:"noreferrer",children:t})]}),(0,e.jsx)("a",{href:s,target:"_blank",download:!0,rel:"noreferrer",children:(0,e.jsx)(n.Button,{variant:"text",size:"small",icon:(0,e.jsx)(n.DownloadIcon,{})})})]},t))}):(0,e.jsx)(e.Fragment,{})}exports.DownloadSpecification=(0,i.memo)(w);const _=r.default.div`
   display: flex;
   align-items: baseline;
   justify-content: space-between;
@@ -10,7 +10,7 @@
     padding-bottom: 0px;
     border-bottom: none;
   }
-`,w=r.default.span`
+`,b=r.default.span`
   display: flex;
   width: calc(100% - 25px);
   gap: var(--spacing-xs);
@@ -28,7 +28,7 @@
     overflow: hidden;
     white-space: nowrap;
   }
-`,_=r.default.div`
+`,h=r.default.div`
   display: flex;
   align-items: center;
   align-self: flex-start;

package/lib/components/Server.js

@@ -1,28 +1,28 @@
-"use strict";var u=exports&&exports.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Server=void 0;const e=require("react/jsx-runtime"),s=u(require("styled-components")),n=require("@redocly/theme"),p=require("react"),x=require("./ServerModal"),l=require("./common"),f=({server:t,showDetails:o})=>{const[i,r]=(0,p.useState)(!1);(0,n.useModalScrollLock)(i);const c=a=>{switch(a){case"kafka":return(0,e.jsx)(n.KafkaIcon,{size:"20px"});case"amqp":return(0,e.jsx)(n.RabbitMQIcon,{size:"20px"});default:return(0,e.jsx)(n.DatabaseIcon,{size:"20px"})}};return(0,e.jsxs)(v,{"data-component-name":"Server/Server",children:[(0,e.jsxs)(g,{children:[(0,e.jsx)(h,{children:c(t.value.protocol)}),(0,e.jsx)(m,{children:t.key})]}),(0,e.jsxs)(j,{children:[(0,e.jsx)(l.HostList,{children:t.value.host.split(" ").map((a,d)=>(0,e.jsx)("span",{children:a},d))}),(0,e.jsx)(n.CopyButton,{data:t.value.host},t.value.host)]}),o&&(0,e.jsx)(_,{onClick:()=>r(!0),children:(0,e.jsx)(l.MoreDetailsButton,{expanded:!1})}),i&&(0,e.jsx)(n.Portal,{mountId:"api-content",children:(0,e.jsx)(x.ServerModal,{server:t,onClose:()=>r(!1)})})]})};exports.Server=f;const v=s.default.div`
+"use strict";var x=exports&&exports.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Server=void 0;const e=require("react/jsx-runtime"),s=x(require("styled-components")),n=require("@redocly/theme"),f=require("react"),h=require("./ServerModal"),o=require("./common"),v=require("../hooks"),g=({server:t,showDetails:l})=>{const[r,i]=(0,f.useState)(!1),c=(0,v.useTelemetry)();(0,n.useModalScrollLock)(r);const d=a=>{switch(a){case"kafka":return(0,e.jsx)(n.KafkaIcon,{size:"20px"});case"amqp":return(0,e.jsx)(n.RabbitMQIcon,{size:"20px"});default:return(0,e.jsx)(n.DatabaseIcon,{size:"20px"})}},p=()=>{i(!0),c.send({type:"asyncapi_docs.server_modal.opened"})};return(0,e.jsxs)(m,{"data-component-name":"Server/Server",children:[(0,e.jsxs)(_,{children:[(0,e.jsx)(j,{children:d(t.value.protocol)}),(0,e.jsx)(S,{children:t.key})]}),(0,e.jsxs)(y,{children:[(0,e.jsx)(o.HostList,{children:t.value.host.split(" ").map((a,u)=>(0,e.jsx)("span",{children:a},u))}),(0,e.jsx)(n.CopyButton,{data:t.value.host},t.value.host)]}),l&&(0,e.jsx)(M,{onClick:p,children:(0,e.jsx)(o.MoreDetailsButton,{expanded:!1})}),r&&(0,e.jsx)(n.Portal,{mountId:"api-content",children:(0,e.jsx)(h.ServerModal,{server:t,onClose:()=>i(!1)})})]})};exports.Server=g;const m=s.default.div`
   display: flex;
   flex-direction: column;
   gap: var(--spacing-xxs);
   padding: var(--spacing-sm) var(--spacing-md);
-`,h=s.default.div`
+`,j=s.default.div`
   width: 20px;
   height: 20px;
   display: flex;
   align-items: center;
   justify-content: center;
-`,g=s.default.div`
+`,_=s.default.div`
   display: flex;
   flex-direction: row;
   align-items: center;
   gap: var(--spacing-xxs);
-`,j=s.default.span`
+`,y=s.default.span`
   padding-left: var(--spacing-lg);
   min-height: 24px;
   display: flex;
   align-items: center;
   justify-content: space-between;
-`,m=s.default.span`
+`,S=s.default.span`
   font-weight: var(--font-weight-semibold);
   text-transform: capitalize;
-`,_=s.default.div`
+`,M=s.default.div`
   padding-left: var(--spacing-lg);
 `;

package/lib/types/async-api.d.ts

@@ -1,7 +1,11 @@
+import type { ENTITY_RELATION_TYPES } from '@redocly/theme';
 import type { Node } from '@markdoc/markdoc';
 import type { ResolvedNavItem, REDOCLY_TEAMS_RBAC } from '@redocly/config';
 import type { JSONSchema7 } from 'json-schema';
 import type { ApiItemData } from './apiItem';
+export type Referenced<T> = T | {
+    $ref: string;
+};
 export interface AsyncApiDefinition {
     asyncapi: string;
     id?: string;
@@ -17,6 +21,21 @@ export interface AsyncApiDefinition {
         [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
     }[];
 }
+export interface AsyncApiDefinitionReferenced {
+    asyncapi: string;
+    id?: string;
+    info: AsyncApiInfo;
+    servers?: Record<string, AsyncApiServer>;
+    defaultContentType?: string;
+    channels?: AsyncApiChannels;
+    operations?: AsyncApiOperationsReferenced;
+    components?: AsyncApiComponentsReferenced;
+    'x-tagGroups'?: {
+        name: string;
+        tags: string[];
+        [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+    }[];
+}
 export interface AsyncApiInfo {
     title: string;
     version: string;
@@ -135,8 +154,22 @@ export interface AsyncApiParameter {
     location?: string;
 }
 export interface AsyncApiMessage {
-    headers?: JSONSchema7 | MultiFormatSchemaObject;
-    payload?: JSONSchema7 | MultiFormatSchemaObject;
+    headers?: AsyncAPISchema;
+    payload?: AsyncAPISchema;
+    correlationId?: AsyncApiCorrelationId;
+    contentType?: string;
+    name?: string;
+    title?: string;
+    summary?: string;
+    description?: string;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiMessageBinding;
+    examples?: AsyncApiMessageExample[];
+}
+export interface AsyncApiMessageReferenced {
+    headers?: AsyncAPISchema;
+    payload?: Referenced<AsyncAPISchema>;
     correlationId?: AsyncApiCorrelationId;
     contentType?: string;
     name?: string;
@@ -174,6 +207,9 @@ export interface MultiFormatSchemaObject {
 export interface AsyncApiOperations {
     [name: string]: AsyncApiOperation;
 }
+export interface AsyncApiOperationsReferenced {
+    [name: string]: AsyncApiOperationReferenced;
+}
 export interface AsyncApiOperation {
     action: 'send' | 'receive';
     channel: AsyncApiChannel;
@@ -187,7 +223,29 @@ export interface AsyncApiOperation {
     messages?: AsyncApiMessage[];
     reply?: AsyncApiOperationReply;
     'x-badges'?: AsyncApiXBadges[];
-    'x-owner-key'?: string;
+    'x-catalog-relations'?: {
+        type: (typeof ENTITY_RELATION_TYPES)[number];
+        key: string;
+    }[];
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+}
+export interface AsyncApiOperationReferenced {
+    action: 'send' | 'receive';
+    channel: AsyncApiChannel;
+    title?: string;
+    summary?: string;
+    description?: string;
+    tags?: AsyncApiTag[];
+    externalDocs?: AsyncApiExternalDocs;
+    bindings?: AsyncApiOperationBinding;
+    traits?: AsyncApiOperationTraits[];
+    messages?: Referenced<AsyncApiMessage>[];
+    reply?: AsyncApiOperationReply;
+    'x-badges'?: AsyncApiXBadges[];
+    'x-catalog-relations'?: {
+        type: (typeof ENTITY_RELATION_TYPES)[number];
+        key: string;
+    }[];
     [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
 }
 export interface AsyncApiOperationReply {
@@ -222,6 +280,12 @@ export interface AsyncApiOperationKafkaBinding {
 }
 export interface AsyncApiComponents {
     messages: Record<string, AsyncApiMessage>;
+    schemas: Record<string, AsyncAPISchema>;
+    tags: Record<string, AsyncApiTag>;
+}
+export interface AsyncApiComponentsReferenced {
+    messages: Record<string, AsyncApiMessageReferenced>;
+    schemas: Record<string, AsyncAPISchema>;
     tags: Record<string, AsyncApiTag>;
 }
 export interface AvroSchema {
@@ -251,3 +315,4 @@ export type DownloadUrls = {
 export type ChannelWithKey = AsyncApiChannel & {
     key: string;
 };
+export type AsyncAPISchema = JSONSchema7 | MultiFormatSchemaObject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/asyncapi-docs",
-  "version": "1.2.0-next.2",
+  "version": "1.2.0-next.4",
   "description": "Async API docs for Redocly Realm",
   "main": "lib/index.js",
   "module": "lib/index.js",
@@ -39,9 +39,9 @@
     "react-router-dom": "^6.21.1",
     "styled-components": "5.3.11",
     "web-vitals": "3.3.1",
-    "@redocly/config": "0.28.0",
-    "@redocly/openapi-docs": "3.13.0-next.2",
-    "@redocly/theme": "0.57.0-next.1"
+    "@redocly/openapi-docs": "3.13.0-next.4",
+    "@redocly/theme": "0.57.0-next.3",
+    "@redocly/config": "0.28.0"
   },
   "peerDependencies": {
     "react": "^19.1.0"