@togatherlabs/event-sdk 1.0.17 → 1.0.18

package/README.md

@@ -206,6 +206,58 @@ print(decoded)
    * Use `int64` for timestamps, `string` for IDs/emails, etc.
 
 
+## How to Type a Event
+
+A Event will have many fields like 
+```proto
+message DomainEventExample {
+ /// event name (e.g. "user.account.created")
+  string event_name = 1;  
+  /// Schema version (e.g."v1"), reciving systems can use this to deserialize the payload accordingly with version
+  string event_version = 2; 
+  /// The entity or aggregate this event belongs to (for partitioning) 
+  string aggregate_id = 3; 
+ /// Binary-encoded event data (the inner protobuf message),will be typed check events for specific event
+  bytes payload = 4;     
+  /// Epoch timestamp in milliseconds when the event was created,indicate when this action was recorded by the system
+  int64 timestamp = 5; 
+}
+```
+### How should you type a event
+```proto
+syntax = "proto3";
+
+package admin.v1;
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FieldOptions {
+  string fixed_value = 50001;
+}
+
+message Payload {
+  string id = 10;          // Account ID
+  string email = 11;       // Account email
+  string name = 12;        // Account name
+  int64 created_at = 13;   // Account creation timestamp
+}
+
+message AdminAccountCreated {
+  // Common metadata fields (in every event)
+   // "admin.account.created"
+   string event_name = 1 [(fixed_value) = "admin.account.created"];
+  
+  string event_version = 2;    // "v1"
+  string aggregate_id = 3;     // Account ID for partitioning
+  int64 timestamp = 4;         // When event was created
+  string trace_id = 5;   // For distributed tracing
+
+  Payload payload = 9;         // Event-specific data
+}
+
+```
+check the docs to see why this decistion was taken: [docs](./docs/how_to_type_event.md)
+
 ## Troubleshooting
 
 * **ModuleNotFoundError in Python**

package/gen/ts/admin/v1/admin_created_pb.d.ts

@@ -0,0 +1,95 @@
+// @generated by protoc-gen-es v2.10.0 with parameter "target=js+dts,import_extension=none"
+// @generated from file admin/v1/admin_created.proto (package admin.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenExtension, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { FieldOptions } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file admin/v1/admin_created.proto.
+ */
+export declare const file_admin_v1_admin_created: GenFile;
+
+/**
+ * @generated from message admin.v1.Payload
+ */
+export declare type Payload = Message<"admin.v1.Payload"> & {
+  /**
+   * @generated from field: string id = 10;
+   */
+  id: string;
+
+  /**
+   * @generated from field: string email = 11;
+   */
+  email: string;
+
+  /**
+   * @generated from field: string first_name = 12;
+   */
+  firstName: string;
+
+  /**
+   * @generated from field: string last_name = 13;
+   */
+  lastName: string;
+
+  /**
+   * @generated from field: int64 created_at = 14;
+   */
+  createdAt: bigint;
+};
+
+/**
+ * Describes the message admin.v1.Payload.
+ * Use `create(PayloadSchema)` to create a new message.
+ */
+export declare const PayloadSchema: GenMessage<Payload>;
+
+/**
+ * @generated from message admin.v1.AdminAccountCreated
+ */
+export declare type AdminAccountCreated = Message<"admin.v1.AdminAccountCreated"> & {
+  /**
+   * @generated from field: string event_name = 1;
+   */
+  eventName: string;
+
+  /**
+   * @generated from field: int32 event_version = 2;
+   */
+  eventVersion: number;
+
+  /**
+   * @generated from field: string aggregate_id = 3;
+   */
+  aggregateId: string;
+
+  /**
+   * @generated from field: int64 timestamp = 4;
+   */
+  timestamp: bigint;
+
+  /**
+   * @generated from field: string trace_id = 5;
+   */
+  traceId: string;
+
+  /**
+   * @generated from field: admin.v1.Payload payload = 9;
+   */
+  payload?: Payload;
+};
+
+/**
+ * Describes the message admin.v1.AdminAccountCreated.
+ * Use `create(AdminAccountCreatedSchema)` to create a new message.
+ */
+export declare const AdminAccountCreatedSchema: GenMessage<AdminAccountCreated>;
+
+/**
+ * @generated from extension: string fixed_value = 50001;
+ */
+export declare const fixed_value: GenExtension<FieldOptions, string>;
+

package/gen/ts/admin/v1/admin_created_pb.js

@@ -0,0 +1,33 @@
+// @generated by protoc-gen-es v2.10.0 with parameter "target=js+dts,import_extension=none"
+// @generated from file admin/v1/admin_created.proto (package admin.v1, syntax proto3)
+/* eslint-disable */
+
+import { extDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_google_protobuf_descriptor } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file admin/v1/admin_created.proto.
+ */
+export const file_admin_v1_admin_created = /*@__PURE__*/
+  fileDesc("ChxhZG1pbi92MS9hZG1pbl9jcmVhdGVkLnByb3RvEghhZG1pbi52MSJfCgdQYXlsb2FkEgoKAmlkGAogASgJEg0KBWVtYWlsGAsgASgJEhIKCmZpcnN0X25hbWUYDCABKAkSEQoJbGFzdF9uYW1lGA0gASgJEhIKCmNyZWF0ZWRfYXQYDiABKAMiwQEKE0FkbWluQWNjb3VudENyZWF0ZWQSLQoKZXZlbnRfbmFtZRgBIAEoCUIZirUYFWFkbWluLmFjY291bnQuY3JlYXRlZBIcCg1ldmVudF92ZXJzaW9uGAIgASgFQgWKtRgBMRIUCgxhZ2dyZWdhdGVfaWQYAyABKAkSEQoJdGltZXN0YW1wGAQgASgDEhAKCHRyYWNlX2lkGAUgASgJEiIKB3BheWxvYWQYCSABKAsyES5hZG1pbi52MS5QYXlsb2FkOkAKC2ZpeGVkX3ZhbHVlEh0uZ29vZ2xlLnByb3RvYnVmLkZpZWxkT3B0aW9ucxjRhgMgASgJUgpmaXhlZFZhbHVlQmIKDGNvbS5hZG1pbi52MUIRQWRtaW5DcmVhdGVkUHJvdG9QAaICA0FYWKoCCEFkbWluLlYxygIIQWRtaW5cVjHiAhRBZG1pblxWMVxHUEJNZXRhZGF0YeoCCUFkbWluOjpWMWIGcHJvdG8z", [file_google_protobuf_descriptor]);
+
+/**
+ * Describes the message admin.v1.Payload.
+ * Use `create(PayloadSchema)` to create a new message.
+ */
+export const PayloadSchema = /*@__PURE__*/
+  messageDesc(file_admin_v1_admin_created, 0);
+
+/**
+ * Describes the message admin.v1.AdminAccountCreated.
+ * Use `create(AdminAccountCreatedSchema)` to create a new message.
+ */
+export const AdminAccountCreatedSchema = /*@__PURE__*/
+  messageDesc(file_admin_v1_admin_created, 1);
+
+/**
+ * @generated from extension: string fixed_value = 50001;
+ */
+export const fixed_value = /*@__PURE__*/
+  extDesc(file_admin_v1_admin_created, 0);
+

package/gen/ts/admin/v1/index.d.ts

@@ -0,0 +1 @@
+export * from './admin_created_pb';

package/gen/ts/admin/v1/index.js

@@ -0,0 +1 @@
+export * from './admin_created_pb';

package/gen/ts/index.d.ts

@@ -1 +1,2 @@
+export * from './admin/v1';
 export * from './user/v1';

package/gen/ts/index.js

@@ -1 +1,2 @@
+export * from './admin/v1';
 export * from './user/v1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@togatherlabs/event-sdk",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "description": "Shared Protobuf event schemas and generated code for toGather microservices",
   "exports": {
     "./user/v1": {
@@ -21,6 +21,7 @@
     "@commitlint/cli": "^20.1.0",
     "@commitlint/config-conventional": "^20.0.0",
     "@commitlint/cz-commitlint": "^20.1.0",
+    "@commitlint/types": "^20.0.0",
     "commitizen": "^4.3.1",
     "husky": "^9.1.7",
     "inquirer": "^9.3.8",