@claimscore/event-schemas 0.1.0-beta.2 → 1.0.0

package/README.md

@@ -8,35 +8,70 @@ See the [Event Schemas ADR](https://www.notion.so/Event-Schemas-ADR-33d12233cdbc
 
 ## How it works
 
-1. Schemas are written as `.proto` files under `schemas/{domain}/`
+1. Schemas are written as `.proto` files under `schemas/{domain}/v{N}/`
 2. [`buf`](https://buf.build/) compiles them to TypeScript under `gen/node/`
-3. Generated files are **committed** — CI fails if they drift from the source
-4. The npm package `@claimscore/event-schemas` is published on every `v*` git tag
-5. Schemas are registered in the Confluent Schema Registry on every merge to `main`
+3. `scripts/generate-index.mjs` auto-generates `gen/node/index.ts` (root barrel) and `gen/node/topics.ts` (Kafka topic name constants) from the file structure
+4. Generated files are **committed** — CI fails if they drift from the source
+5. The npm package `@claimscore/event-schemas` is published on every `v*` git tag
+6. Schemas are registered in the Confluent Schema Registry on every merge to `main`
 
 ---
 
 ## Naming convention
 
-`{domain}.{entity}.{event}.{version}` → e.g. `organization.invitation.created.v1`
+`{domain}.{event}.{version}` → e.g. `permission.created.v1`
 
-- Proto file: `schemas/organization/v1/invitation_created.proto`
-- Kafka topic subject: `organization.invitation.created.v1-value`
-- Package: `organization.v1`
+| Part | Source | Example |
+|---|---|---|
+| `domain` | folder under `schemas/` | `permission` |
+| `event` | proto filename (no extension) | `created` |
+| `version` | version folder | `v1` |
+
+**Proto file path:** `schemas/{domain}/v{N}/{event}.proto`
+**Proto package:** `{domain}.v{N}`
+**Kafka topic:** `{domain}.{event}.v{N}`
+
+### Examples
+
+| Proto file | Package | Kafka topic |
+|---|---|---|
+| `schemas/permission/v1/created.proto` | `permission.v1` | `permission.created.v1` |
+| `schemas/invitation/v1/verification_resent.proto` | `invitation.v1` | `invitation.verification_resent.v1` |
+| `schemas/report/v1/generated.proto` | `report.v1` | `report.generated.v1` |
+
+> The domain folder is the entity. Do **not** repeat the domain name in the filename — `case/v1/created.proto` not `case/v1/case_created.proto`.
+
+---
+
+## Topic name auto-generation
+
+`gen/node/topics.ts` is fully auto-generated from the file structure. The `Topics` constant is keyed by PascalCase `{Domain}{Event}` and valued with the topic string:
+
+```ts
+export const Topics = {
+  PermissionCreated: "permission.created.v1",
+  InvitationVerificationResent: "invitation.verification_resent.v1",
+  ReportGenerated: "report.generated.v1",
+  // ...
+} as const;
+```
+
+This file is regenerated every time you run `npm run generate`. **Do not edit it manually.**
 
 ---
 
 ## Adding a new schema
 
-1. Create `schemas/{domain}/v{N}/{entity}_{event}.proto`
-2. Run `buf generate` locally
-3. Export the new type from `gen/node/index.ts`
-4. Open a PR — CI will lint, check for breaking changes, and verify generated files match
+1. Create `schemas/{domain}/v{N}/{event}.proto` following the naming convention above
+2. Set the proto package to `{domain}.v{N}`
+3. Run `npm run generate` — this regenerates TypeScript types, the root barrel, and the `Topics` constant automatically
+4. Commit all files under `gen/node/`
+5. Open a PR — CI will lint, check for breaking changes, and verify generated files match
 
 **Backward compatibility rules (BACKWARD mode):**
 - New fields must be `optional`
 - Never remove a field — mark it `reserved` instead
-- Breaking changes require a new version (e.g. `invitation_created_v2.proto`)
+- Breaking changes require a new version folder (e.g. `schemas/invitation/v2/`)
 
 ---
 
@@ -51,11 +86,32 @@ Add to your `.npmrc` (or set via environment):
 @claimscore:registry=https://registry.npmjs.org/
 ```
 
-Usage:
+### Importing types
+
 ```ts
-import { InvitationCreated } from '@claimscore/event-schemas/organization/v1/invitation_created';
+// Root import — tree-shakeable, only used schemas are bundled
+import { InvitationCreated, PermissionCreated } from '@claimscore/event-schemas';
+
+// Deep import — also available but not needed
+import { InvitationCreated } from '@claimscore/event-schemas/invitation/v1/created';
 ```
 
+### Importing topic names
+
+```ts
+import { Topics } from '@covalynt/event-schemas';
+// or direct (tree-shakes to just the Topics object)
+import { Topics } from '@covalynt/event-schemas/topics';
+
+// Producer
+await producer.send({ topic: Topics.InvitationCreated, messages: [...] });
+
+// Consumer
+await consumer.subscribe({ topics: [Topics.PermissionCreated] });
+```
+
+`Topics` values are typed as string literals (`"permission.created.v1"`, not `string`), so TypeScript catches mismatches at the call site.
+
 ---
 
 ## Local development
@@ -63,14 +119,17 @@ import { InvitationCreated } from '@claimscore/event-schemas/organization/v1/inv
 **Prerequisites:** [`buf`](https://buf.build/docs/installation)
 
 ```bash
+# Regenerate TypeScript types, barrel index, and topic constants
+npm run generate
+
 # Lint all schemas
-buf lint
+npm run lint
 
 # Check for breaking changes against main
-buf breaking --against '.git#branch=main'
+npm run breaking
 
-# Regenerate TypeScript types
-buf generate
+# Full build (clean dist + generate + compile)
+npm run build
 ```
 
 ---

package/dist/{account/v1/account_activated.js → cjs/account/v1/activated.js}

@@ -1,9 +1,9 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: account/v1/account_activated.proto
+// source: account/v1/activated.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AccountActivated = exports.protobufPackage = void 0;
 /* eslint-disable */

package/dist/{case/v1/case_created.js → cjs/case/v1/created.js}

@@ -1,9 +1,9 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: case/v1/case_created.proto
+// source: case/v1/created.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CaseCreated = exports.protobufPackage = void 0;
 /* eslint-disable */

package/dist/{file → cjs/file}/v1/analysis_requested.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
 // source: file/v1/analysis_requested.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/{file → cjs/file}/v1/preprocess_completed.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
 // source: file/v1/preprocess_completed.proto
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Topics = exports.ReportGenerated = exports.Attachment = exports.DeliveryType = exports.FileType = exports.PermissionUpdated = exports.PermissionDeleted = exports.PermissionCreated = exports.InvitationVerificationResent = exports.InvitationCreated = exports.CasePermission = exports.InvitationApproved = exports.PreprocessCompleted = exports.AnalysisRequested = exports.CaseCreated = exports.AccountActivated = void 0;
+// AUTO-GENERATED by scripts/generate-index.mjs. Do not edit manually.
+var activated_1 = require("./account/v1/activated");
+Object.defineProperty(exports, "AccountActivated", { enumerable: true, get: function () { return activated_1.AccountActivated; } });
+var created_1 = require("./case/v1/created");
+Object.defineProperty(exports, "CaseCreated", { enumerable: true, get: function () { return created_1.CaseCreated; } });
+var analysis_requested_1 = require("./file/v1/analysis_requested");
+Object.defineProperty(exports, "AnalysisRequested", { enumerable: true, get: function () { return analysis_requested_1.AnalysisRequested; } });
+var preprocess_completed_1 = require("./file/v1/preprocess_completed");
+Object.defineProperty(exports, "PreprocessCompleted", { enumerable: true, get: function () { return preprocess_completed_1.PreprocessCompleted; } });
+var approved_1 = require("./invitation/v1/approved");
+Object.defineProperty(exports, "InvitationApproved", { enumerable: true, get: function () { return approved_1.InvitationApproved; } });
+var created_2 = require("./invitation/v1/created");
+Object.defineProperty(exports, "CasePermission", { enumerable: true, get: function () { return created_2.CasePermission; } });
+Object.defineProperty(exports, "InvitationCreated", { enumerable: true, get: function () { return created_2.InvitationCreated; } });
+var verification_resent_1 = require("./invitation/v1/verification_resent");
+Object.defineProperty(exports, "InvitationVerificationResent", { enumerable: true, get: function () { return verification_resent_1.InvitationVerificationResent; } });
+var created_3 = require("./permission/v1/created");
+Object.defineProperty(exports, "PermissionCreated", { enumerable: true, get: function () { return created_3.PermissionCreated; } });
+var deleted_1 = require("./permission/v1/deleted");
+Object.defineProperty(exports, "PermissionDeleted", { enumerable: true, get: function () { return deleted_1.PermissionDeleted; } });
+var updated_1 = require("./permission/v1/updated");
+Object.defineProperty(exports, "PermissionUpdated", { enumerable: true, get: function () { return updated_1.PermissionUpdated; } });
+var generated_1 = require("./report/v1/generated");
+Object.defineProperty(exports, "FileType", { enumerable: true, get: function () { return generated_1.FileType; } });
+Object.defineProperty(exports, "DeliveryType", { enumerable: true, get: function () { return generated_1.DeliveryType; } });
+Object.defineProperty(exports, "Attachment", { enumerable: true, get: function () { return generated_1.Attachment; } });
+Object.defineProperty(exports, "ReportGenerated", { enumerable: true, get: function () { return generated_1.ReportGenerated; } });
+var topics_1 = require("./topics");
+Object.defineProperty(exports, "Topics", { enumerable: true, get: function () { return topics_1.Topics; } });

package/dist/{invitation/v1/invitation_approved.js → cjs/invitation/v1/approved.js}

@@ -1,9 +1,9 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: invitation/v1/invitation_approved.proto
+// source: invitation/v1/approved.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvitationApproved = exports.protobufPackage = void 0;
 /* eslint-disable */

package/dist/{organization/v1/invitation_created.js → cjs/invitation/v1/created.js}

@@ -1,14 +1,14 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: organization/v1/invitation_created.proto
+// source: invitation/v1/created.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvitationCreated = exports.CasePermission = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
-exports.protobufPackage = "organization.v1";
+exports.protobufPackage = "invitation.v1";
 function createBaseCasePermission() {
     return { caseId: "", roleName: "" };
 }

package/dist/{invitation/v1/invitation_verification_resent.js → cjs/invitation/v1/verification_resent.js}

@@ -1,9 +1,9 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: invitation/v1/invitation_verification_resent.proto
+// source: invitation/v1/verification_resent.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvitationVerificationResent = exports.protobufPackage = void 0;
 /* eslint-disable */

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/{case/v1/permission_created.js → cjs/permission/v1/created.js}

@@ -1,14 +1,14 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: case/v1/permission_created.proto
+// source: permission/v1/created.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PermissionCreated = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
-exports.protobufPackage = "case.v1";
+exports.protobufPackage = "permission.v1";
 function createBasePermissionCreated() {
     return {
         caseId: "",

package/dist/{case/v1/permission_deleted.js → cjs/permission/v1/deleted.js}

@@ -1,14 +1,14 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: case/v1/permission_deleted.proto
+// source: permission/v1/deleted.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PermissionDeleted = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
-exports.protobufPackage = "case.v1";
+exports.protobufPackage = "permission.v1";
 function createBasePermissionDeleted() {
     return {
         caseId: "",

package/dist/{case/v1/permission_updated.js → cjs/permission/v1/updated.js}

@@ -1,14 +1,14 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: case/v1/permission_updated.proto
+// source: permission/v1/updated.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PermissionUpdated = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
-exports.protobufPackage = "case.v1";
+exports.protobufPackage = "permission.v1";
 function createBasePermissionUpdated() {
     return {
         caseId: "",

package/dist/{report/v1/report_generated.js → cjs/report/v1/generated.js}

@@ -1,9 +1,9 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.7
+//   protoc-gen-ts_proto  v2.11.8
 //   protoc               unknown
-// source: report/v1/report_generated.proto
+// source: report/v1/generated.proto
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReportGenerated = exports.Attachment = exports.DeliveryType = exports.FileType = exports.protobufPackage = void 0;
 exports.fileTypeFromJSON = fileTypeFromJSON;

package/dist/cjs/topics.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Topics = void 0;
+// AUTO-GENERATED by scripts/generate-index.mjs. Do not edit manually.
+exports.Topics = {
+    AccountActivated: "account.activated.v1",
+    CaseCreated: "case.created.v1",
+    FileAnalysisRequested: "file.analysis_requested.v1",
+    FilePreprocessCompleted: "file.preprocess_completed.v1",
+    InvitationApproved: "invitation.approved.v1",
+    InvitationCreated: "invitation.created.v1",
+    InvitationVerificationResent: "invitation.verification_resent.v1",
+    PermissionCreated: "permission.created.v1",
+    PermissionDeleted: "permission.deleted.v1",
+    PermissionUpdated: "permission.updated.v1",
+    ReportGenerated: "report.generated.v1",
+};

package/dist/esm/account/v1/activated.js

@@ -0,0 +1,186 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.8
+//   protoc               unknown
+// source: account/v1/activated.proto
+/* eslint-disable */
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export const protobufPackage = "account.v1";
+function createBaseAccountActivated() {
+    return {
+        accountId: "",
+        email: "",
+        firstName: "",
+        lastName: "",
+        organizationId: "",
+        organizationName: "",
+        invitationId: "",
+    };
+}
+export const AccountActivated = {
+    encode(message, writer = new BinaryWriter()) {
+        if (message.accountId !== "") {
+            writer.uint32(10).string(message.accountId);
+        }
+        if (message.email !== "") {
+            writer.uint32(18).string(message.email);
+        }
+        if (message.firstName !== "") {
+            writer.uint32(26).string(message.firstName);
+        }
+        if (message.lastName !== "") {
+            writer.uint32(34).string(message.lastName);
+        }
+        if (message.organizationId !== "") {
+            writer.uint32(42).string(message.organizationId);
+        }
+        if (message.organizationName !== "") {
+            writer.uint32(50).string(message.organizationName);
+        }
+        if (message.invitationId !== "") {
+            writer.uint32(58).string(message.invitationId);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseAccountActivated();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.accountId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.email = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.firstName = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.lastName = reader.string();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.organizationId = reader.string();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.organizationName = reader.string();
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.invitationId = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            accountId: isSet(object.accountId)
+                ? globalThis.String(object.accountId)
+                : isSet(object.account_id)
+                    ? globalThis.String(object.account_id)
+                    : "",
+            email: isSet(object.email) ? globalThis.String(object.email) : "",
+            firstName: isSet(object.firstName)
+                ? globalThis.String(object.firstName)
+                : isSet(object.first_name)
+                    ? globalThis.String(object.first_name)
+                    : "",
+            lastName: isSet(object.lastName)
+                ? globalThis.String(object.lastName)
+                : isSet(object.last_name)
+                    ? globalThis.String(object.last_name)
+                    : "",
+            organizationId: isSet(object.organizationId)
+                ? globalThis.String(object.organizationId)
+                : isSet(object.organization_id)
+                    ? globalThis.String(object.organization_id)
+                    : "",
+            organizationName: isSet(object.organizationName)
+                ? globalThis.String(object.organizationName)
+                : isSet(object.organization_name)
+                    ? globalThis.String(object.organization_name)
+                    : "",
+            invitationId: isSet(object.invitationId)
+                ? globalThis.String(object.invitationId)
+                : isSet(object.invitation_id)
+                    ? globalThis.String(object.invitation_id)
+                    : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.accountId !== "") {
+            obj.accountId = message.accountId;
+        }
+        if (message.email !== "") {
+            obj.email = message.email;
+        }
+        if (message.firstName !== "") {
+            obj.firstName = message.firstName;
+        }
+        if (message.lastName !== "") {
+            obj.lastName = message.lastName;
+        }
+        if (message.organizationId !== "") {
+            obj.organizationId = message.organizationId;
+        }
+        if (message.organizationName !== "") {
+            obj.organizationName = message.organizationName;
+        }
+        if (message.invitationId !== "") {
+            obj.invitationId = message.invitationId;
+        }
+        return obj;
+    },
+    create(base) {
+        return AccountActivated.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseAccountActivated();
+        message.accountId = object.accountId ?? "";
+        message.email = object.email ?? "";
+        message.firstName = object.firstName ?? "";
+        message.lastName = object.lastName ?? "";
+        message.organizationId = object.organizationId ?? "";
+        message.organizationName = object.organizationName ?? "";
+        message.invitationId = object.invitationId ?? "";
+        return message;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}