@claimscore/event-schemas 0.1.0-beta.2

package/README.md

@@ -0,0 +1,83 @@
+# event-schemas
+
+Single source of truth for all Covalynt Kafka event schemas, defined as `.proto` files and compiled to typed clients per language.
+
+See the [Event Schemas ADR](https://www.notion.so/Event-Schemas-ADR-33d12233cdbc80c7831fc2ddec9095b0) for full context and decisions.
+
+---
+
+## How it works
+
+1. Schemas are written as `.proto` files under `schemas/{domain}/`
+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`
+
+---
+
+## Naming convention
+
+`{domain}.{entity}.{event}.{version}` → e.g. `organization.invitation.created.v1`
+
+- Proto file: `schemas/organization/v1/invitation_created.proto`
+- Kafka topic subject: `organization.invitation.created.v1-value`
+- Package: `organization.v1`
+
+---
+
+## 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
+
+**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`)
+
+---
+
+## Consuming in Node.js
+
+```bash
+npm install @claimscore/event-schemas
+```
+
+Add to your `.npmrc` (or set via environment):
+```
+@claimscore:registry=https://registry.npmjs.org/
+```
+
+Usage:
+```ts
+import { InvitationCreated } from '@claimscore/event-schemas/organization/v1/invitation_created';
+```
+
+---
+
+## Local development
+
+**Prerequisites:** [`buf`](https://buf.build/docs/installation)
+
+```bash
+# Lint all schemas
+buf lint
+
+# Check for breaking changes against main
+buf breaking --against '.git#branch=main'
+
+# Regenerate TypeScript types
+buf generate
+```
+
+---
+
+## CI variables required
+
+| Variable | Description |
+|----------|-------------|
+| `SCHEMA_REGISTRY_URL` | Base URL of the Confluent Schema Registry on GCP |
+| `SCHEMA_REGISTRY_API_KEY` | Base64-encoded `key:secret` for registry auth |

package/dist/account/v1/account_activated.d.ts

@@ -0,0 +1,31 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "account.v1";
+export interface AccountActivated {
+    accountId: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    organizationId: string;
+    organizationName: string;
+    invitationId: string;
+}
+export declare const AccountActivated: MessageFns<AccountActivated>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};

package/dist/account/v1/account_activated.js

@@ -0,0 +1,189 @@
+"use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.7
+//   protoc               unknown
+// source: account/v1/account_activated.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountActivated = exports.protobufPackage = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+exports.protobufPackage = "account.v1";
+function createBaseAccountActivated() {
+    return {
+        accountId: "",
+        email: "",
+        firstName: "",
+        lastName: "",
+        organizationId: "",
+        organizationName: "",
+        invitationId: "",
+    };
+}
+exports.AccountActivated = {
+    encode(message, writer = new wire_1.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 wire_1.BinaryReader ? input : new wire_1.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 exports.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;
+}

package/dist/case/v1/case_created.d.ts

@@ -0,0 +1,34 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "case.v1";
+export interface CaseCreated {
+    caseId: string;
+    caseName: string;
+    organizationId: string;
+    country: string;
+    createdBy: string;
+    timestamp: string;
+    caseNumber: string;
+    court: string;
+    jurisdiction: string[];
+    timezone?: string | undefined;
+}
+export declare const CaseCreated: MessageFns<CaseCreated>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};

package/dist/case/v1/case_created.js

@@ -0,0 +1,235 @@
+"use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.7
+//   protoc               unknown
+// source: case/v1/case_created.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CaseCreated = exports.protobufPackage = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+exports.protobufPackage = "case.v1";
+function createBaseCaseCreated() {
+    return {
+        caseId: "",
+        caseName: "",
+        organizationId: "",
+        country: "",
+        createdBy: "",
+        timestamp: "",
+        caseNumber: "",
+        court: "",
+        jurisdiction: [],
+        timezone: undefined,
+    };
+}
+exports.CaseCreated = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.caseId !== "") {
+            writer.uint32(10).string(message.caseId);
+        }
+        if (message.caseName !== "") {
+            writer.uint32(18).string(message.caseName);
+        }
+        if (message.organizationId !== "") {
+            writer.uint32(26).string(message.organizationId);
+        }
+        if (message.country !== "") {
+            writer.uint32(34).string(message.country);
+        }
+        if (message.createdBy !== "") {
+            writer.uint32(42).string(message.createdBy);
+        }
+        if (message.timestamp !== "") {
+            writer.uint32(50).string(message.timestamp);
+        }
+        if (message.caseNumber !== "") {
+            writer.uint32(58).string(message.caseNumber);
+        }
+        if (message.court !== "") {
+            writer.uint32(66).string(message.court);
+        }
+        for (const v of message.jurisdiction) {
+            writer.uint32(74).string(v);
+        }
+        if (message.timezone !== undefined) {
+            writer.uint32(82).string(message.timezone);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCaseCreated();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.caseId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.caseName = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.organizationId = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.country = reader.string();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.createdBy = reader.string();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.timestamp = reader.string();
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.caseNumber = reader.string();
+                    continue;
+                }
+                case 8: {
+                    if (tag !== 66) {
+                        break;
+                    }
+                    message.court = reader.string();
+                    continue;
+                }
+                case 9: {
+                    if (tag !== 74) {
+                        break;
+                    }
+                    message.jurisdiction.push(reader.string());
+                    continue;
+                }
+                case 10: {
+                    if (tag !== 82) {
+                        break;
+                    }
+                    message.timezone = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            caseId: isSet(object.caseId)
+                ? globalThis.String(object.caseId)
+                : isSet(object.case_id)
+                    ? globalThis.String(object.case_id)
+                    : "",
+            caseName: isSet(object.caseName)
+                ? globalThis.String(object.caseName)
+                : isSet(object.case_name)
+                    ? globalThis.String(object.case_name)
+                    : "",
+            organizationId: isSet(object.organizationId)
+                ? globalThis.String(object.organizationId)
+                : isSet(object.organization_id)
+                    ? globalThis.String(object.organization_id)
+                    : "",
+            country: isSet(object.country) ? globalThis.String(object.country) : "",
+            createdBy: isSet(object.createdBy)
+                ? globalThis.String(object.createdBy)
+                : isSet(object.created_by)
+                    ? globalThis.String(object.created_by)
+                    : "",
+            timestamp: isSet(object.timestamp) ? globalThis.String(object.timestamp) : "",
+            caseNumber: isSet(object.caseNumber)
+                ? globalThis.String(object.caseNumber)
+                : isSet(object.case_number)
+                    ? globalThis.String(object.case_number)
+                    : "",
+            court: isSet(object.court) ? globalThis.String(object.court) : "",
+            jurisdiction: globalThis.Array.isArray(object?.jurisdiction)
+                ? object.jurisdiction.map((e) => globalThis.String(e))
+                : [],
+            timezone: isSet(object.timezone) ? globalThis.String(object.timezone) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.caseId !== "") {
+            obj.caseId = message.caseId;
+        }
+        if (message.caseName !== "") {
+            obj.caseName = message.caseName;
+        }
+        if (message.organizationId !== "") {
+            obj.organizationId = message.organizationId;
+        }
+        if (message.country !== "") {
+            obj.country = message.country;
+        }
+        if (message.createdBy !== "") {
+            obj.createdBy = message.createdBy;
+        }
+        if (message.timestamp !== "") {
+            obj.timestamp = message.timestamp;
+        }
+        if (message.caseNumber !== "") {
+            obj.caseNumber = message.caseNumber;
+        }
+        if (message.court !== "") {
+            obj.court = message.court;
+        }
+        if (message.jurisdiction?.length) {
+            obj.jurisdiction = message.jurisdiction;
+        }
+        if (message.timezone !== undefined) {
+            obj.timezone = message.timezone;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.CaseCreated.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCaseCreated();
+        message.caseId = object.caseId ?? "";
+        message.caseName = object.caseName ?? "";
+        message.organizationId = object.organizationId ?? "";
+        message.country = object.country ?? "";
+        message.createdBy = object.createdBy ?? "";
+        message.timestamp = object.timestamp ?? "";
+        message.caseNumber = object.caseNumber ?? "";
+        message.court = object.court ?? "";
+        message.jurisdiction = object.jurisdiction?.map((e) => e) || [];
+        message.timezone = object.timezone ?? undefined;
+        return message;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/case/v1/permission_created.d.ts

@@ -0,0 +1,32 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "case.v1";
+export interface PermissionCreated {
+    caseId: string;
+    caseName: string;
+    accountId: string;
+    email: string;
+    firstName: string;
+    roleName: string;
+    organizationId: string;
+    managerAccountId: string;
+}
+export declare const PermissionCreated: MessageFns<PermissionCreated>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};