@velony/contracts 2.0.0 → 3.0.0

package/README.md

@@ -16,21 +16,24 @@ This package provides TypeScript interfaces for integration events used across V
 
 ```typescript
 import { 
-  UserRegisteredLocalIntegrationEvent,
-  UserEmailAddedIntegrationEvent,
-  UserPhoneNumberAddedIntegrationEvent 
+  UserCreatedIntegrationEvent,
+  UserEmailChangedIntegrationEvent,
+  UserPhoneNumberChangedIntegrationEvent 
 } from '@velony/contracts';
 
-// Example: Handle a user registered event
-const event: UserRegisteredLocalIntegrationEvent = {
+// Example: Handle a user created event
+const event: UserCreatedIntegrationEvent = {
   id: 'evt-123',
-  type: 'user.registered-local',
+  type: 'user.created',
   version: '1.0.0',
   occurredAt: new Date(),
   payload: {
     userId: 'user-123',
     name: 'John Doe',
-    username: 'johndoe'
+    username: 'johndoe',
+    avatarPath: 'https://example.com/avatar.jpg',
+    email: 'john.doe@example.com',
+    phoneNumber: '+1234567890'
   },
   partitionKey: 'user-123',
   createdAt: new Date(),
@@ -42,19 +45,15 @@ const event: UserRegisteredLocalIntegrationEvent = {
 
 ### Identity Domain
 
+- `UserAvatarChangedIntegrationEvent` - Fired when a user's avatar is changed
 - `UserCreatedIntegrationEvent` - Fired when a new user is created
 - `UserDeletedIntegrationEvent` - Fired when a user is deleted
-- `UserNameUpdatedIntegrationEvent` - Fired when a user's name is updated
-- `UserUsernameUpdatedIntegrationEvent` - Fired when a user's username is updated
-- `UserEmailAddedIntegrationEvent` - Fired when an email is added to a user
+- `UserEmailChangedIntegrationEvent` - Fired when a user's email is changed
 - `UserEmailRemovedIntegrationEvent` - Fired when an email is removed from a user
-- `UserEmailUpdatedIntegrationEvent` - Fired when a user's email is updated
-- `UserPhoneAddedIntegrationEvent` - Fired when a phone number is added to a user
-- `UserPhoneRemovedIntegrationEvent` - Fired when a phone number is removed from a user
-- `UserPhoneUpdatedIntegrationEvent` - Fired when a user's phone number is updated
-- `UserAvatarPathAddedIntegrationEvent` - Fired when an avatar path is added to a user
-- `UserAvatarPathRemovedIntegrationEvent` - Fired when an avatar path is removed from a user
-- `UserAvatarPathUpdatedIntegrationEvent` - Fired when a user's avatar path is updated
+- `UserNameChangedIntegrationEvent` - Fired when a user's name is changed
+- `UserPhoneNumberChangedIntegrationEvent` - Fired when a user's phone number is changed
+- `UserPhoneNumberRemovedIntegrationEvent` - Fired when a phone number is removed from a user
+- `UserUsernameChangedIntegrationEvent` - Fired when a user's username is changed
 
 ## License
 

package/dist/identity/user-avatar-changed.integration-event.d.ts

@@ -0,0 +1,12 @@
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.avatar.changed': {
+            payload: {
+                userId: string;
+                avatarPath: string | null;
+            };
+        };
+    }
+}
+export type UserAvatarChangedIntegrationEvent = IntegrationEvent<'user.avatar.changed'>;

package/dist/identity/user-avatar-changed.integration-event.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user-avatar-changed.integration-event.js.map

package/dist/identity/user-avatar-changed.integration-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-avatar-changed.integration-event.js","sourceRoot":"","sources":["../../src/identity/user-avatar-changed.integration-event.ts"],"names":[],"mappings":""}

package/dist/identity/user-avatar-path-added.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.avatar-path.added';
-interface Payload {
-    userId: string;
-    avatarPath: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.avatar-path.added': {
+            payload: {
+                userId: string;
+                avatarPath: string;
+            };
+        };
+    }
 }
-export interface UserAvatarPathAddedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserAvatarPathAddedIntegrationEvent = IntegrationEvent<'user.avatar-path.added'>;

package/dist/identity/user-avatar-path-changed.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.avatar-path.changed';
-interface Payload {
-    userId: string;
-    avatarPath: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.avatar-path.changed': {
+            payload: {
+                userId: string;
+                avatarPath: string;
+            };
+        };
+    }
 }
-export interface UserAvatarPathChangedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserAvatarPathChangedIntegrationEvent = IntegrationEvent<'user.avatar-path.changed'>;

package/dist/identity/user-avatar-path-removed.integration-event.d.ts

@@ -1,10 +1,11 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.avatar-path.removed';
-interface Payload {
-    userId: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.avatar-path.removed': {
+            payload: {
+                userId: string;
+            };
+        };
+    }
 }
-export interface UserAvatarPathRemovedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserAvatarPathRemovedIntegrationEvent = IntegrationEvent<'user.avatar-path.removed'>;

package/dist/identity/user-created.integration-event.d.ts

@@ -0,0 +1,16 @@
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.created': {
+            payload: {
+                userId: string;
+                name: string;
+                username: string;
+                avatarPath?: string;
+                email?: string;
+                phoneNumber?: string;
+            };
+        };
+    }
+}
+export type UserCreatedIntegrationEvent = IntegrationEvent<'user.created'>;

package/dist/identity/user-created.integration-event.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user-created.integration-event.js.map

package/dist/identity/user-created.integration-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-created.integration-event.js","sourceRoot":"","sources":["../../src/identity/user-created.integration-event.ts"],"names":[],"mappings":""}

package/dist/identity/user-deleted.integration-event.d.ts

@@ -1,10 +1,11 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.deleted';
-interface Payload {
-    userId: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.deleted': {
+            payload: {
+                userId: string;
+            };
+        };
+    }
 }
-export interface UserDeletedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserDeletedIntegrationEvent = IntegrationEvent<'user.deleted'>;

package/dist/identity/user-email-added.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.email.added';
-interface Payload {
-    userId: string;
-    email: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.email.added': {
+            payload: {
+                userId: string;
+                email: string;
+            };
+        };
+    }
 }
-export interface UserEmailAddedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserEmailAddedIntegrationEvent = IntegrationEvent<'user.email.added'>;

package/dist/identity/user-email-change-issued.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.email-change.issued';
-interface Payload {
-    userId: string;
-    email: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.email-change.issued': {
+            payload: {
+                userId: string;
+                email: string;
+            };
+        };
+    }
 }
-export interface UserEmailChangeIssuedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserEmailChangeIssuedIntegrationEvent = IntegrationEvent<'user.email-change.issued'>;

package/dist/identity/user-email-change-revoked.integration-event.d.ts

@@ -1,10 +1,11 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.email-change.revoked';
-interface Payload {
-    userId: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.email-change.revoked': {
+            payload: {
+                userId: string;
+            };
+        };
+    }
 }
-export interface UserEmailChangeRevokedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserEmailChangeRevokedIntegrationEvent = IntegrationEvent<'user.email-change.revoked'>;

package/dist/identity/user-email-changed.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.email.changed';
-interface Payload {
-    userId: string;
-    email: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.email.changed': {
+            payload: {
+                userId: string;
+                email: string;
+            };
+        };
+    }
 }
-export interface UserEmailChangedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserEmailChangedIntegrationEvent = IntegrationEvent<'user.email.changed'>;

package/dist/identity/user-email-removed.integration-event.d.ts

@@ -1,10 +1,11 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.email.removed';
-interface Payload {
-    userId: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.email.removed': {
+            payload: {
+                userId: string;
+            };
+        };
+    }
 }
-export interface UserEmailRemovedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserEmailRemovedIntegrationEvent = IntegrationEvent<'user.email.removed'>;

package/dist/identity/user-name-changed.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.name.changed';
-interface Payload {
-    userId: string;
-    name: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.name.changed': {
+            payload: {
+                userId: string;
+                name: string;
+            };
+        };
+    }
 }
-export interface UserNameChangedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserNameChangedIntegrationEvent = IntegrationEvent<'user.name.changed'>;

package/dist/identity/user-phone-number-added.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.phone-number.added';
-interface Payload {
-    userId: string;
-    phoneNumber: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.phone-number.added': {
+            payload: {
+                userId: string;
+                phoneNumber: string;
+            };
+        };
+    }
 }
-export interface UserPhoneNumberAddedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserPhoneNumberAddedIntegrationEvent = IntegrationEvent<'user.phone-number.added'>;

package/dist/identity/user-phone-number-change-issued.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.phone-number-change.issued';
-interface Payload {
-    userId: string;
-    phoneNumber: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.phone-number-change.issued': {
+            payload: {
+                userId: string;
+                phoneNumber: string;
+            };
+        };
+    }
 }
-export interface UserPhoneNumberChangeIssuedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserPhoneNumberChangeIssuedIntegrationEvent = IntegrationEvent<'user.phone-number-change.issued'>;

package/dist/identity/user-phone-number-change-revoked.integration-event.d.ts

@@ -1,10 +1,11 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.phone-number-change.revoked';
-interface Payload {
-    userId: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.phone-number-change.revoked': {
+            payload: {
+                userId: string;
+            };
+        };
+    }
 }
-export interface UserPhoneNumberChangeRevokedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserPhoneNumberChangeRevokedIntegrationEvent = IntegrationEvent<'user.phone-number-change.revoked'>;

package/dist/identity/user-phone-number-changed.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.phone-number.changed';
-interface Payload {
-    userId: string;
-    phoneNumber: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.phone-number.changed': {
+            payload: {
+                userId: string;
+                phoneNumber: string;
+            };
+        };
+    }
 }
-export interface UserPhoneNumberChangedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserPhoneNumberChangedIntegrationEvent = IntegrationEvent<'user.phone-number.changed'>;

package/dist/identity/user-phone-number-removed.integration-event.d.ts

@@ -1,10 +1,11 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.phone-number.removed';
-interface Payload {
-    userId: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.phone-number.removed': {
+            payload: {
+                userId: string;
+            };
+        };
+    }
 }
-export interface UserPhoneNumberRemovedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserPhoneNumberRemovedIntegrationEvent = IntegrationEvent<'user.phone-number.removed'>;

package/dist/identity/user-registered-local.integration-event.d.ts

@@ -1,12 +1,13 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.registered-local';
-interface Payload {
-    userId: string;
-    name: string;
-    username: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.registered-local': {
+            payload: {
+                userId: string;
+                name: string;
+                username: string;
+            };
+        };
+    }
 }
-export interface UserRegisteredLocalIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserRegisteredLocalIntegrationEvent = IntegrationEvent<'user.registered-local'>;

package/dist/identity/user-username-changed.integration-event.d.ts

@@ -1,11 +1,12 @@
-import { IntegrationEvent } from '../integration-event.interface';
-type Type = 'user.username.changed';
-interface Payload {
-    userId: string;
-    username: string;
+import { IntegrationEvent } from '../integration-event';
+declare module '../integration-event' {
+    interface IntegrationEventRegistry {
+        'user.username.changed': {
+            payload: {
+                userId: string;
+                username: string;
+            };
+        };
+    }
 }
-export interface UserUsernameChangedIntegrationEvent extends IntegrationEvent<Type, Payload> {
-    type: Type;
-    payload: Payload;
-}
-export {};
+export type UserUsernameChangedIntegrationEvent = IntegrationEvent<'user.username.changed'>;

package/dist/index.d.ts

@@ -1,18 +1,10 @@
-export type { IntegrationEvent } from './integration-event.interface';
-export type { UserAvatarPathAddedIntegrationEvent } from './identity/user-avatar-path-added.integration-event';
-export type { UserAvatarPathChangedIntegrationEvent } from './identity/user-avatar-path-changed.integration-event';
-export type { UserAvatarPathRemovedIntegrationEvent } from './identity/user-avatar-path-removed.integration-event';
+export type { IntegrationEvent, AnyIntegrationEvent, IntegrationEventRegistry, } from './integration-event';
+export type { UserAvatarChangedIntegrationEvent } from './identity/user-avatar-changed.integration-event';
+export type { UserCreatedIntegrationEvent } from './identity/user-created.integration-event';
 export type { UserDeletedIntegrationEvent } from './identity/user-deleted.integration-event';
-export type { UserEmailAddedIntegrationEvent } from './identity/user-email-added.integration-event';
-export type { UserEmailChangeIssuedIntegrationEvent } from './identity/user-email-change-issued.integration-event';
-export type { UserEmailChangeRevokedIntegrationEvent } from './identity/user-email-change-revoked.integration-event';
 export type { UserEmailChangedIntegrationEvent } from './identity/user-email-changed.integration-event';
 export type { UserEmailRemovedIntegrationEvent } from './identity/user-email-removed.integration-event';
 export type { UserNameChangedIntegrationEvent } from './identity/user-name-changed.integration-event';
-export type { UserPhoneNumberAddedIntegrationEvent } from './identity/user-phone-number-added.integration-event';
-export type { UserPhoneNumberChangeIssuedIntegrationEvent } from './identity/user-phone-number-change-issued.integration-event';
-export type { UserPhoneNumberChangeRevokedIntegrationEvent } from './identity/user-phone-number-change-revoked.integration-event';
 export type { UserPhoneNumberChangedIntegrationEvent } from './identity/user-phone-number-changed.integration-event';
 export type { UserPhoneNumberRemovedIntegrationEvent } from './identity/user-phone-number-removed.integration-event';
-export type { UserRegisteredLocalIntegrationEvent } from './identity/user-registered-local.integration-event';
 export type { UserUsernameChangedIntegrationEvent } from './identity/user-username-changed.integration-event';

package/dist/integration-event.d.ts

@@ -0,0 +1,67 @@
+declare const INTEGRATION_EVENT_BRAND: unique symbol;
+/**
+ * Registry that maps integration event types to their payload types.
+ * Extend this interface to register new integration event types.
+ */
+export interface IntegrationEventRegistry {
+    [key: string]: {
+        payload: unknown;
+    };
+}
+/**
+ * Integration event represents a significant business event that has occurred
+ * and needs to be communicated to external systems or bounded contexts.
+ * Unlike domain events which are internal, integration events cross bounded context boundaries.
+ *
+ * @template TType - The type identifier for the event (must be registered in IntegrationEventRegistry)
+ */
+export type IntegrationEvent<TType extends keyof IntegrationEventRegistry> = {
+    readonly [INTEGRATION_EVENT_BRAND]: void;
+    /**
+     * Unique identifier for this event instance.
+     * @readonly
+     */
+    readonly id: string;
+    /**
+     * Type identifier for the event.
+     * @readonly
+     */
+    readonly type: TType;
+    /**
+     * Version of the event schema for backward compatibility.
+     * @readonly
+     */
+    readonly version: string;
+    /**
+     * The timestamp when the original domain event occurred.
+     * @readonly
+     */
+    readonly occurredAt: Date;
+    /**
+     * The data payload specific to this event.
+     * @readonly
+     */
+    readonly payload: IntegrationEventRegistry[TType]['payload'];
+    /**
+     * Key used for partitioning in message brokers for ordering guarantees.
+     * @readonly
+     */
+    readonly partitionKey: string;
+    /**
+     * The timestamp when this integration event was created.
+     * @readonly
+     */
+    readonly createdAt: Date;
+    /**
+     * The timestamp when this event was published to the message broker.
+     * Null if not yet published.
+     * @readonly
+     */
+    readonly publishedAt: Date | null;
+};
+/**
+ * Union type representing any integration event registered in the IntegrationEventRegistry.
+ * Useful for type-safe collections and handlers that work with multiple integration event types.
+ */
+export type AnyIntegrationEvent = IntegrationEvent<keyof IntegrationEventRegistry>;
+export {};

package/dist/{integration-event.interface.js → integration-event.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=integration-event.interface.js.map
+//# sourceMappingURL=integration-event.js.map

package/dist/integration-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration-event.js","sourceRoot":"","sources":["../src/integration-event.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velony/contracts",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "TypeScript contracts library providing integration event interfaces for event-driven architecture",
   "keywords": [
     "contracts",

package/dist/integration-event.interface.d.ts

@@ -1,10 +0,0 @@
-export interface IntegrationEvent<TType extends string, TPayload> {
-    id: string;
-    type: TType;
-    version: string;
-    occurredAt: Date;
-    payload: TPayload;
-    partitionKey: string;
-    createdAt: Date;
-    publishedAt: Date | null;
-}

package/dist/integration-event.interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"integration-event.interface.js","sourceRoot":"","sources":["../src/integration-event.interface.ts"],"names":[],"mappings":""}