@eventcatalog/sdk 2.7.3 → 2.7.4

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 +43 -0
  2. package/dist/types.d.d.ts +43 -0
  3. package/dist/types.d.js.map +1 -1
  4. package/package.json +1 -1
package/dist/types.d.d.mts CHANGED
@@ -69,18 +69,39 @@ interface CustomDoc {
69
69
  markdown: string;
70
70
  }
71
71
 
72
+ interface MessageDetailsPanelProperty {
73
+ producers?: DetailPanelProperty;
74
+ consumers?: DetailPanelProperty;
75
+ channels?: DetailPanelProperty;
76
+ versions?: DetailPanelProperty;
77
+ repository?: DetailPanelProperty;
78
+ }
79
+
72
80
  interface Event extends BaseSchema {
73
81
  channels?: ChannelPointer[];
82
+ detailsPanel?: MessageDetailsPanelProperty;
74
83
  }
75
84
  interface Command extends BaseSchema {
76
85
  channels?: ChannelPointer[];
86
+ detailsPanel?: MessageDetailsPanelProperty;
77
87
  }
78
88
  interface Query extends BaseSchema {
79
89
  channels?: ChannelPointer[];
90
+ detailsPanel?: MessageDetailsPanelProperty;
80
91
  }
81
92
  interface Channel extends BaseSchema {
82
93
  address?: string;
83
94
  protocols?: string[];
95
+ detailsPanel?: {
96
+ producers?: DetailPanelProperty;
97
+ consumers?: DetailPanelProperty;
98
+ messages?: DetailPanelProperty;
99
+ protocols?: DetailPanelProperty;
100
+ versions?: DetailPanelProperty;
101
+ repository?: DetailPanelProperty;
102
+ owners?: DetailPanelProperty;
103
+ changelog?: DetailPanelProperty;
104
+ };
84
105
  // parameters?: Record<string, Parameter>;
85
106
  parameters?: {
86
107
  [key: string]: {
@@ -102,12 +123,34 @@ interface Service extends BaseSchema {
102
123
  receives?: ResourcePointer[];
103
124
  entities?: ResourcePointer[];
104
125
  specifications?: Specifications;
126
+ detailsPanel?: {
127
+ domains?: DetailPanelProperty;
128
+ messages?: DetailPanelProperty;
129
+ versions?: DetailPanelProperty;
130
+ specifications?: DetailPanelProperty;
131
+ entities?: DetailPanelProperty;
132
+ repository?: DetailPanelProperty;
133
+ owners?: DetailPanelProperty;
134
+ changelog?: DetailPanelProperty;
135
+ };
105
136
  }
106
137
 
107
138
  interface Domain extends BaseSchema {
108
139
  services?: ResourcePointer[];
109
140
  domains?: ResourcePointer[];
110
141
  entities?: ResourcePointer[];
142
+ detailsPanel?: {
143
+ parentDomains?: DetailPanelProperty;
144
+ subdomains?: DetailPanelProperty;
145
+ services?: DetailPanelProperty;
146
+ entities?: DetailPanelProperty;
147
+ messages?: DetailPanelProperty;
148
+ ubiquitousLanguage?: DetailPanelProperty;
149
+ repository?: DetailPanelProperty;
150
+ versions?: DetailPanelProperty;
151
+ owners?: DetailPanelProperty;
152
+ changelog?: DetailPanelProperty;
153
+ };
111
154
  }
112
155
 
113
156
  interface Team {
package/dist/types.d.d.ts CHANGED
@@ -69,18 +69,39 @@ interface CustomDoc {
69
69
  markdown: string;
70
70
  }
71
71
 
72
+ interface MessageDetailsPanelProperty {
73
+ producers?: DetailPanelProperty;
74
+ consumers?: DetailPanelProperty;
75
+ channels?: DetailPanelProperty;
76
+ versions?: DetailPanelProperty;
77
+ repository?: DetailPanelProperty;
78
+ }
79
+
72
80
  interface Event extends BaseSchema {
73
81
  channels?: ChannelPointer[];
82
+ detailsPanel?: MessageDetailsPanelProperty;
74
83
  }
75
84
  interface Command extends BaseSchema {
76
85
  channels?: ChannelPointer[];
86
+ detailsPanel?: MessageDetailsPanelProperty;
77
87
  }
78
88
  interface Query extends BaseSchema {
79
89
  channels?: ChannelPointer[];
90
+ detailsPanel?: MessageDetailsPanelProperty;
80
91
  }
81
92
  interface Channel extends BaseSchema {
82
93
  address?: string;
83
94
  protocols?: string[];
95
+ detailsPanel?: {
96
+ producers?: DetailPanelProperty;
97
+ consumers?: DetailPanelProperty;
98
+ messages?: DetailPanelProperty;
99
+ protocols?: DetailPanelProperty;
100
+ versions?: DetailPanelProperty;
101
+ repository?: DetailPanelProperty;
102
+ owners?: DetailPanelProperty;
103
+ changelog?: DetailPanelProperty;
104
+ };
84
105
  // parameters?: Record<string, Parameter>;
85
106
  parameters?: {
86
107
  [key: string]: {
@@ -102,12 +123,34 @@ interface Service extends BaseSchema {
102
123
  receives?: ResourcePointer[];
103
124
  entities?: ResourcePointer[];
104
125
  specifications?: Specifications;
126
+ detailsPanel?: {
127
+ domains?: DetailPanelProperty;
128
+ messages?: DetailPanelProperty;
129
+ versions?: DetailPanelProperty;
130
+ specifications?: DetailPanelProperty;
131
+ entities?: DetailPanelProperty;
132
+ repository?: DetailPanelProperty;
133
+ owners?: DetailPanelProperty;
134
+ changelog?: DetailPanelProperty;
135
+ };
105
136
  }
106
137
 
107
138
  interface Domain extends BaseSchema {
108
139
  services?: ResourcePointer[];
109
140
  domains?: ResourcePointer[];
110
141
  entities?: ResourcePointer[];
142
+ detailsPanel?: {
143
+ parentDomains?: DetailPanelProperty;
144
+ subdomains?: DetailPanelProperty;
145
+ services?: DetailPanelProperty;
146
+ entities?: DetailPanelProperty;
147
+ messages?: DetailPanelProperty;
148
+ ubiquitousLanguage?: DetailPanelProperty;
149
+ repository?: DetailPanelProperty;
150
+ versions?: DetailPanelProperty;
151
+ owners?: DetailPanelProperty;
152
+ changelog?: DetailPanelProperty;
153
+ };
111
154
  }
112
155
 
113
156
  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 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.4",
4
4
  "description": "SDK to integrate with EventCatalog",
5
5
  "publishConfig": {
6
6
  "access": "public"