@eventcatalog/sdk 0.0.3 → 0.0.4

package/dist/types.d.d.mts

@@ -1,20 +1,61 @@
-type Badge = {
-  content: string;
-  backgroundColor: string;
-  textColor: string;
-};
-
-type Event = {
+// Base type for all resources (domains, services and messages)
+interface BaseSchema {
   id: string;
   name: string;
+  summary?: string;
   version: string;
-  summary: string;
-  owners?: string[];
   badges?: Badge[];
-  // Path to the schema file.
+  owners?: string[];
   schemaPath?: string;
-  // Markdown content of the event
   markdown: string;
+}
+
+type ResourcePointer = {
+  id: string;
+  version: string;
 };
 
-export type { Badge, Event };
+type Message = Event | Command;
+
+interface Event extends BaseSchema {}
+interface Command extends BaseSchema {}
+
+interface Service extends BaseSchema {
+  sends?: ResourcePointer[];
+  receives?: ResourcePointer[];
+}
+
+interface Team {
+  id: string;
+  name: string;
+  summary?: string;
+  email?: string;
+  hidden?: boolean;
+  slackDirectMessageUrl?: string;
+  members?: User[];
+  ownedCommands?: Command[];
+  ownedServices?: Service[];
+  ownedEvents?: Event[];
+}
+
+interface User {
+  id: string;
+  name: string;
+  avatarUrl: string;
+  role?: string;
+  hidden?: boolean;
+  email?: string;
+  slackDirectMessageUrl?: string;
+  ownedServices?: Service[];
+  ownedEvents?: Event[];
+  ownedCommands?: Command[];
+  associatedTeams?: Team[];
+}
+
+interface Badge {
+  content: string;
+  backgroundColor: string;
+  textColor: string;
+}
+
+export type { Badge, BaseSchema, Command, Event, Message, ResourcePointer, Service, Team, User };

package/dist/types.d.d.ts

@@ -1,20 +1,61 @@
-type Badge = {
-  content: string;
-  backgroundColor: string;
-  textColor: string;
-};
-
-type Event = {
+// Base type for all resources (domains, services and messages)
+interface BaseSchema {
   id: string;
   name: string;
+  summary?: string;
   version: string;
-  summary: string;
-  owners?: string[];
   badges?: Badge[];
-  // Path to the schema file.
+  owners?: string[];
   schemaPath?: string;
-  // Markdown content of the event
   markdown: string;
+}
+
+type ResourcePointer = {
+  id: string;
+  version: string;
 };
 
-export type { Badge, Event };
+type Message = Event | Command;
+
+interface Event extends BaseSchema {}
+interface Command extends BaseSchema {}
+
+interface Service extends BaseSchema {
+  sends?: ResourcePointer[];
+  receives?: ResourcePointer[];
+}
+
+interface Team {
+  id: string;
+  name: string;
+  summary?: string;
+  email?: string;
+  hidden?: boolean;
+  slackDirectMessageUrl?: string;
+  members?: User[];
+  ownedCommands?: Command[];
+  ownedServices?: Service[];
+  ownedEvents?: Event[];
+}
+
+interface User {
+  id: string;
+  name: string;
+  avatarUrl: string;
+  role?: string;
+  hidden?: boolean;
+  email?: string;
+  slackDirectMessageUrl?: string;
+  ownedServices?: Service[];
+  ownedEvents?: Event[];
+  ownedCommands?: Command[];
+  associatedTeams?: Team[];
+}
+
+interface Badge {
+  content: string;
+  backgroundColor: string;
+  textColor: string;
+}
+
+export type { Badge, BaseSchema, Command, Event, Message, ResourcePointer, Service, Team, User };

package/dist/types.d.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.d.ts"],"sourcesContent":["export type Badge = {\n  content: string;\n  backgroundColor: string;\n  textColor: string;\n};\n\nexport type Event = {\n  id: string;\n  name: string;\n  version: string;\n  summary: string;\n  owners?: string[];\n  badges?: Badge[];\n  // Path to the schema file.\n  schemaPath?: string;\n  // Markdown content of the event\n  markdown: string;\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"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  owners?: string[];\n  schemaPath?: string;\n  markdown: string;\n}\n\nexport type ResourcePointer = {\n  id: string;\n  version: string;\n};\n\nexport type Message = Event | Command;\n\nexport interface Event extends BaseSchema {}\nexport interface Command extends BaseSchema {}\n\nexport interface Service extends BaseSchema {\n  sends?: ResourcePointer[];\n  receives?: 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}\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}\n\nexport interface Badge {\n  content: string;\n  backgroundColor: string;\n  textColor: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eventcatalog/sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "SDK to integrate with EventCatalog",
   "publishConfig": {
     "access": "public"