@redocly/asyncapi-docs 1.2.0-next.1 → 1.2.0-next.3

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.1",
+  "version": "1.2.0-next.3",
   "description": "Async API docs for Redocly Realm",
   "main": "lib/index.js",
   "module": "lib/index.js",
@@ -40,8 +40,8 @@
     "styled-components": "5.3.11",
     "web-vitals": "3.3.1",
     "@redocly/config": "0.28.0",
-    "@redocly/openapi-docs": "3.13.0-next.1",
-    "@redocly/theme": "0.57.0-next.1"
+    "@redocly/openapi-docs": "3.13.0-next.3",
+    "@redocly/theme": "0.57.0-next.2"
   },
   "peerDependencies": {
     "react": "^19.1.0"