@eventcatalog/sdk 2.7.3 → 2.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/types.d.d.mts +52 -0
  2. package/dist/types.d.d.ts +52 -0
  3. package/dist/types.d.js.map +1 -1
  4. package/package.json +1 -1
package/dist/types.d.d.mts CHANGED
@@ -28,6 +28,15 @@ interface BaseSchema {
28
28
  label?: string;
29
29
  };
30
30
  };
31
+ attachments?:
32
+ | string[]
33
+ | {
34
+ url: string;
35
+ title?: string;
36
+ type?: string;
37
+ description?: string;
38
+ icon?: string;
39
+ }[];
31
40
  resourceGroups?: ResourceGroup[];
32
41
  editUrl?: string;
33
42
  draft?: boolean | { title?: string; message?: string };
@@ -69,18 +78,39 @@ interface CustomDoc {
69
78
  markdown: string;
70
79
  }
71
80
 
81
+ interface MessageDetailsPanelProperty {
82
+ producers?: DetailPanelProperty;
83
+ consumers?: DetailPanelProperty;
84
+ channels?: DetailPanelProperty;
85
+ versions?: DetailPanelProperty;
86
+ repository?: DetailPanelProperty;
87
+ }
88
+
72
89
  interface Event extends BaseSchema {
73
90
  channels?: ChannelPointer[];
91
+ detailsPanel?: MessageDetailsPanelProperty;
74
92
  }
75
93
  interface Command extends BaseSchema {
76
94
  channels?: ChannelPointer[];
95
+ detailsPanel?: MessageDetailsPanelProperty;
77
96
  }
78
97
  interface Query extends BaseSchema {
79
98
  channels?: ChannelPointer[];
99
+ detailsPanel?: MessageDetailsPanelProperty;
80
100
  }
81
101
  interface Channel extends BaseSchema {
82
102
  address?: string;
83
103
  protocols?: string[];
104
+ detailsPanel?: {
105
+ producers?: DetailPanelProperty;
106
+ consumers?: DetailPanelProperty;
107
+ messages?: DetailPanelProperty;
108
+ protocols?: DetailPanelProperty;
109
+ versions?: DetailPanelProperty;
110
+ repository?: DetailPanelProperty;
111
+ owners?: DetailPanelProperty;
112
+ changelog?: DetailPanelProperty;
113
+ };
84
114
  // parameters?: Record<string, Parameter>;
85
115
  parameters?: {
86
116
  [key: string]: {
@@ -102,12 +132,34 @@ interface Service extends BaseSchema {
102
132
  receives?: ResourcePointer[];
103
133
  entities?: ResourcePointer[];
104
134
  specifications?: Specifications;
135
+ detailsPanel?: {
136
+ domains?: DetailPanelProperty;
137
+ messages?: DetailPanelProperty;
138
+ versions?: DetailPanelProperty;
139
+ specifications?: DetailPanelProperty;
140
+ entities?: DetailPanelProperty;
141
+ repository?: DetailPanelProperty;
142
+ owners?: DetailPanelProperty;
143
+ changelog?: DetailPanelProperty;
144
+ };
105
145
  }
106
146
 
107
147
  interface Domain extends BaseSchema {
108
148
  services?: ResourcePointer[];
109
149
  domains?: ResourcePointer[];
110
150
  entities?: ResourcePointer[];
151
+ detailsPanel?: {
152
+ parentDomains?: DetailPanelProperty;
153
+ subdomains?: DetailPanelProperty;
154
+ services?: DetailPanelProperty;
155
+ entities?: DetailPanelProperty;
156
+ messages?: DetailPanelProperty;
157
+ ubiquitousLanguage?: DetailPanelProperty;
158
+ repository?: DetailPanelProperty;
159
+ versions?: DetailPanelProperty;
160
+ owners?: DetailPanelProperty;
161
+ changelog?: DetailPanelProperty;
162
+ };
111
163
  }
112
164
 
113
165
  interface Team {
package/dist/types.d.d.ts CHANGED
@@ -28,6 +28,15 @@ interface BaseSchema {
28
28
  label?: string;
29
29
  };
30
30
  };
31
+ attachments?:
32
+ | string[]
33
+ | {
34
+ url: string;
35
+ title?: string;
36
+ type?: string;
37
+ description?: string;
38
+ icon?: string;
39
+ }[];
31
40
  resourceGroups?: ResourceGroup[];
32
41
  editUrl?: string;
33
42
  draft?: boolean | { title?: string; message?: string };
@@ -69,18 +78,39 @@ interface CustomDoc {
69
78
  markdown: string;
70
79
  }
71
80
 
81
+ interface MessageDetailsPanelProperty {
82
+ producers?: DetailPanelProperty;
83
+ consumers?: DetailPanelProperty;
84
+ channels?: DetailPanelProperty;
85
+ versions?: DetailPanelProperty;
86
+ repository?: DetailPanelProperty;
87
+ }
88
+
72
89
  interface Event extends BaseSchema {
73
90
  channels?: ChannelPointer[];
91
+ detailsPanel?: MessageDetailsPanelProperty;
74
92
  }
75
93
  interface Command extends BaseSchema {
76
94
  channels?: ChannelPointer[];
95
+ detailsPanel?: MessageDetailsPanelProperty;
77
96
  }
78
97
  interface Query extends BaseSchema {
79
98
  channels?: ChannelPointer[];
99
+ detailsPanel?: MessageDetailsPanelProperty;
80
100
  }
81
101
  interface Channel extends BaseSchema {
82
102
  address?: string;
83
103
  protocols?: string[];
104
+ detailsPanel?: {
105
+ producers?: DetailPanelProperty;
106
+ consumers?: DetailPanelProperty;
107
+ messages?: DetailPanelProperty;
108
+ protocols?: DetailPanelProperty;
109
+ versions?: DetailPanelProperty;
110
+ repository?: DetailPanelProperty;
111
+ owners?: DetailPanelProperty;
112
+ changelog?: DetailPanelProperty;
113
+ };
84
114
  // parameters?: Record<string, Parameter>;
85
115
  parameters?: {
86
116
  [key: string]: {
@@ -102,12 +132,34 @@ interface Service extends BaseSchema {
102
132
  receives?: ResourcePointer[];
103
133
  entities?: ResourcePointer[];
104
134
  specifications?: Specifications;
135
+ detailsPanel?: {
136
+ domains?: DetailPanelProperty;
137
+ messages?: DetailPanelProperty;
138
+ versions?: DetailPanelProperty;
139
+ specifications?: DetailPanelProperty;
140
+ entities?: DetailPanelProperty;
141
+ repository?: DetailPanelProperty;
142
+ owners?: DetailPanelProperty;
143
+ changelog?: DetailPanelProperty;
144
+ };
105
145
  }
106
146
 
107
147
  interface Domain extends BaseSchema {
108
148
  services?: ResourcePointer[];
109
149
  domains?: ResourcePointer[];
110
150
  entities?: ResourcePointer[];
151
+ detailsPanel?: {
152
+ parentDomains?: DetailPanelProperty;
153
+ subdomains?: DetailPanelProperty;
154
+ services?: DetailPanelProperty;
155
+ entities?: DetailPanelProperty;
156
+ messages?: DetailPanelProperty;
157
+ ubiquitousLanguage?: DetailPanelProperty;
158
+ repository?: DetailPanelProperty;
159
+ versions?: DetailPanelProperty;
160
+ owners?: DetailPanelProperty;
161
+ changelog?: DetailPanelProperty;
162
+ };
111
163
  }
112
164
 
113
165
  interface Team {
package/dist/types.d.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/types.d.ts"],"sourcesContent":["// Base type for all resources (domains, services and messages)\nexport interface BaseSchema {\n id: string;\n name: string;\n summary?: string;\n version: string;\n badges?: Badge[];\n sidebar?: {\n badge?: string;\n };\n owners?: string[];\n schemaPath?: string;\n markdown: string;\n repository?: {\n language?: string;\n url?: string;\n };\n deprecated?:\n | boolean\n | {\n date?: string;\n message?: string;\n };\n styles?: {\n icon?: string;\n node?: {\n color?: string;\n label?: string;\n };\n };\n resourceGroups?: ResourceGroup[];\n editUrl?: string;\n draft?: boolean | { title?: string; message?: string };\n // SDK types\n schema?: any;\n}\n\nexport type ResourcePointer = {\n id: string;\n version?: string;\n type?: string;\n};\n\nexport interface ResourceGroup {\n id?: string;\n title?: string;\n items: ResourcePointer[];\n limit?: number;\n sidebar?: boolean;\n}\n\nexport interface ChannelPointer extends ResourcePointer {\n parameters?: Record<string, string>;\n}\n\nexport type Message = Event | Command | Query;\n\nenum ResourceType {\n Service = 'service',\n Event = 'event',\n Command = 'command',\n}\n\nexport interface CustomDoc {\n title: string;\n summary: string;\n slug?: string;\n sidebar?: {\n label: string;\n order: number;\n };\n owners?: string[];\n badges?: Badge[];\n fileName?: string;\n markdown: string;\n}\n\nexport interface Event extends BaseSchema {\n channels?: ChannelPointer[];\n}\nexport interface Command extends BaseSchema {\n channels?: ChannelPointer[];\n}\nexport interface Query extends BaseSchema {\n channels?: ChannelPointer[];\n}\nexport interface Channel extends BaseSchema {\n address?: string;\n protocols?: string[];\n // parameters?: Record<string, Parameter>;\n parameters?: {\n [key: string]: {\n enum?: string[];\n default?: string;\n examples?: string[];\n description?: string;\n };\n };\n}\n\nexport interface Specifications {\n asyncapiPath?: string;\n openapiPath?: string;\n}\n\nexport interface Service extends BaseSchema {\n sends?: ResourcePointer[];\n receives?: ResourcePointer[];\n entities?: ResourcePointer[];\n specifications?: Specifications;\n}\n\nexport interface Domain extends BaseSchema {\n services?: ResourcePointer[];\n domains?: ResourcePointer[];\n entities?: ResourcePointer[];\n}\n\nexport interface Team {\n id: string;\n name: string;\n summary?: string;\n email?: string;\n hidden?: boolean;\n slackDirectMessageUrl?: string;\n members?: User[];\n ownedCommands?: Command[];\n ownedServices?: Service[];\n ownedEvents?: Event[];\n markdown: string;\n}\n\nexport interface User {\n id: string;\n name: string;\n avatarUrl: string;\n role?: string;\n hidden?: boolean;\n email?: string;\n slackDirectMessageUrl?: string;\n ownedServices?: Service[];\n ownedEvents?: Event[];\n ownedCommands?: Command[];\n associatedTeams?: Team[];\n markdown: string;\n}\n\nexport interface Badge {\n content: string;\n backgroundColor: string;\n textColor: string;\n icon?: string;\n}\n\nexport interface UbiquitousLanguage {\n id: string;\n name: string;\n summary?: string;\n description?: string;\n icon?: string;\n}\n\nexport interface UbiquitousLanguageDictionary {\n dictionary: UbiquitousLanguage[];\n}\n\ninterface DetailPanelProperty {\n visible: boolean;\n}\n\nexport interface Entity extends BaseSchema {\n aggregateRoot?: boolean;\n identifier?: string;\n properties?: {\n name: string;\n type: string;\n required?: boolean;\n description?: string;\n references?: string;\n referencesIdentifier?: string;\n relationType?: string;\n }[];\n detailsPanel?: {\n domains?: DetailPanelProperty;\n services?: DetailPanelProperty;\n messages?: DetailPanelProperty;\n versions?: DetailPanelProperty;\n owners?: DetailPanelProperty;\n changelog?: DetailPanelProperty;\n };\n}\n\nexport type EventCatalog = {\n version: string;\n catalogVersion: string;\n createdAt: string;\n resources: {\n domains?: ExportedResource<Domain>[];\n services?: ExportedResource<Service>[];\n messages?: {\n events?: ExportedResource<Event>[];\n queries?: ExportedResource<Query>[];\n commands?: ExportedResource<Command>[];\n };\n teams?: ExportedResource<Team>[];\n users?: ExportedResource<User>[];\n channels?: ExportedResource<Channel>[];\n customDocs?: ExportedResource<CustomDoc>[];\n };\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../src/types.d.ts"],"sourcesContent":["// Base type for all resources (domains, services and messages)\nexport interface BaseSchema {\n id: string;\n name: string;\n summary?: string;\n version: string;\n badges?: Badge[];\n sidebar?: {\n badge?: string;\n };\n owners?: string[];\n schemaPath?: string;\n markdown: string;\n repository?: {\n language?: string;\n url?: string;\n };\n deprecated?:\n | boolean\n | {\n date?: string;\n message?: string;\n };\n styles?: {\n icon?: string;\n node?: {\n color?: string;\n label?: string;\n };\n };\n attachments?:\n | string[]\n | {\n url: string;\n title?: string;\n type?: string;\n description?: string;\n icon?: string;\n }[];\n resourceGroups?: ResourceGroup[];\n editUrl?: string;\n draft?: boolean | { title?: string; message?: string };\n // SDK types\n schema?: any;\n}\n\nexport type ResourcePointer = {\n id: string;\n version?: string;\n type?: string;\n};\n\nexport interface ResourceGroup {\n id?: string;\n title?: string;\n items: ResourcePointer[];\n limit?: number;\n sidebar?: boolean;\n}\n\nexport interface ChannelPointer extends ResourcePointer {\n parameters?: Record<string, string>;\n}\n\nexport type Message = Event | Command | Query;\n\nenum ResourceType {\n Service = 'service',\n Event = 'event',\n Command = 'command',\n}\n\nexport interface CustomDoc {\n title: string;\n summary: string;\n slug?: string;\n sidebar?: {\n label: string;\n order: number;\n };\n owners?: string[];\n badges?: Badge[];\n fileName?: string;\n markdown: string;\n}\n\ninterface MessageDetailsPanelProperty {\n producers?: DetailPanelProperty;\n consumers?: DetailPanelProperty;\n channels?: DetailPanelProperty;\n versions?: DetailPanelProperty;\n repository?: DetailPanelProperty;\n}\n\nexport interface Event extends BaseSchema {\n channels?: ChannelPointer[];\n detailsPanel?: MessageDetailsPanelProperty;\n}\nexport interface Command extends BaseSchema {\n channels?: ChannelPointer[];\n detailsPanel?: MessageDetailsPanelProperty;\n}\nexport interface Query extends BaseSchema {\n channels?: ChannelPointer[];\n detailsPanel?: MessageDetailsPanelProperty;\n}\nexport interface Channel extends BaseSchema {\n address?: string;\n protocols?: string[];\n detailsPanel?: {\n producers?: DetailPanelProperty;\n consumers?: DetailPanelProperty;\n messages?: DetailPanelProperty;\n protocols?: DetailPanelProperty;\n versions?: DetailPanelProperty;\n repository?: DetailPanelProperty;\n owners?: DetailPanelProperty;\n changelog?: DetailPanelProperty;\n };\n // parameters?: Record<string, Parameter>;\n parameters?: {\n [key: string]: {\n enum?: string[];\n default?: string;\n examples?: string[];\n description?: string;\n };\n };\n}\n\nexport interface Specifications {\n asyncapiPath?: string;\n openapiPath?: string;\n}\n\nexport interface Service extends BaseSchema {\n sends?: ResourcePointer[];\n receives?: ResourcePointer[];\n entities?: ResourcePointer[];\n specifications?: Specifications;\n detailsPanel?: {\n domains?: DetailPanelProperty;\n messages?: DetailPanelProperty;\n versions?: DetailPanelProperty;\n specifications?: DetailPanelProperty;\n entities?: DetailPanelProperty;\n repository?: DetailPanelProperty;\n owners?: DetailPanelProperty;\n changelog?: DetailPanelProperty;\n };\n}\n\nexport interface Domain extends BaseSchema {\n services?: ResourcePointer[];\n domains?: ResourcePointer[];\n entities?: ResourcePointer[];\n detailsPanel?: {\n parentDomains?: DetailPanelProperty;\n subdomains?: DetailPanelProperty;\n services?: DetailPanelProperty;\n entities?: DetailPanelProperty;\n messages?: DetailPanelProperty;\n ubiquitousLanguage?: DetailPanelProperty;\n repository?: DetailPanelProperty;\n versions?: DetailPanelProperty;\n owners?: DetailPanelProperty;\n changelog?: DetailPanelProperty;\n };\n}\n\nexport interface Team {\n id: string;\n name: string;\n summary?: string;\n email?: string;\n hidden?: boolean;\n slackDirectMessageUrl?: string;\n members?: User[];\n ownedCommands?: Command[];\n ownedServices?: Service[];\n ownedEvents?: Event[];\n markdown: string;\n}\n\nexport interface User {\n id: string;\n name: string;\n avatarUrl: string;\n role?: string;\n hidden?: boolean;\n email?: string;\n slackDirectMessageUrl?: string;\n ownedServices?: Service[];\n ownedEvents?: Event[];\n ownedCommands?: Command[];\n associatedTeams?: Team[];\n markdown: string;\n}\n\nexport interface Badge {\n content: string;\n backgroundColor: string;\n textColor: string;\n icon?: string;\n}\n\nexport interface UbiquitousLanguage {\n id: string;\n name: string;\n summary?: string;\n description?: string;\n icon?: string;\n}\n\nexport interface UbiquitousLanguageDictionary {\n dictionary: UbiquitousLanguage[];\n}\n\ninterface DetailPanelProperty {\n visible: boolean;\n}\n\nexport interface Entity extends BaseSchema {\n aggregateRoot?: boolean;\n identifier?: string;\n properties?: {\n name: string;\n type: string;\n required?: boolean;\n description?: string;\n references?: string;\n referencesIdentifier?: string;\n relationType?: string;\n }[];\n detailsPanel?: {\n domains?: DetailPanelProperty;\n services?: DetailPanelProperty;\n messages?: DetailPanelProperty;\n versions?: DetailPanelProperty;\n owners?: DetailPanelProperty;\n changelog?: DetailPanelProperty;\n };\n}\n\nexport type EventCatalog = {\n version: string;\n catalogVersion: string;\n createdAt: string;\n resources: {\n domains?: ExportedResource<Domain>[];\n services?: ExportedResource<Service>[];\n messages?: {\n events?: ExportedResource<Event>[];\n queries?: ExportedResource<Query>[];\n commands?: ExportedResource<Command>[];\n };\n teams?: ExportedResource<Team>[];\n users?: ExportedResource<User>[];\n channels?: ExportedResource<Channel>[];\n customDocs?: ExportedResource<CustomDoc>[];\n };\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eventcatalog/sdk",
3
- "version": "2.7.3",
3
+ "version": "2.7.5",
4
4
  "description": "SDK to integrate with EventCatalog",
5
5
  "publishConfig": {
6
6
  "access": "public"