@skillstew/common 1.0.12 → 1.0.14

package/build/events/AppEvent.d.ts

@@ -0,0 +1,12 @@
+import { EventName, EventPayload } from "./EventMap";
+export interface AppEvent<T extends EventName> {
+    eventId: string;
+    eventName: T;
+    timestamp: string;
+    producer: string;
+    data: EventPayload<T>;
+    traceId?: string;
+}
+export type UserRegisteredEvent = AppEvent<"user.registered">;
+export type UserVerifiedEvent = AppEvent<"user.verified">;
+export type AnyAppEvent = AppEvent<EventName>;

package/build/events/AppEvent.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/CreateEvent.d.ts

@@ -0,0 +1,3 @@
+import { AppEvent } from "./AppEvent";
+import { EventName, EventPayload } from "./EventMap";
+export declare function CreateEvent<T extends EventName>(eventName: T, data: EventPayload<T>, producer: string, traceId?: string): AppEvent<T>;

package/build/events/CreateEvent.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateEvent = CreateEvent;
+const crypto_1 = require("crypto");
+function CreateEvent(eventName, data, producer, traceId) {
+    return {
+        eventName,
+        eventId: (0, crypto_1.randomUUID)(),
+        data,
+        producer,
+        timestamp: new Date().toISOString(),
+        traceId,
+    };
+}

package/build/events/EventMap.d.ts

@@ -0,0 +1,12 @@
+import z from "zod";
+export declare const EventSchemas: {
+    readonly "user.registered": z.ZodObject<{
+        id: z.ZodUUID;
+        email: z.ZodEmail;
+    }, z.core.$strip>;
+    readonly "user.verified": z.ZodObject<{
+        id: z.ZodUUID;
+    }, z.core.$strip>;
+};
+export type EventName = keyof typeof EventSchemas;
+export type EventPayload<T extends EventName> = z.infer<(typeof EventSchemas)[T]>;

package/build/events/EventMap.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventSchemas = void 0;
+const userEventsSchema_1 = require("./schemas/userEventsSchema");
+// Union of all app event schemas
+exports.EventSchemas = Object.assign({}, userEventsSchema_1.UserEventSchemas);

package/build/events/schemas/userEventsSchema.d.ts

@@ -0,0 +1,17 @@
+import z from "zod";
+export declare const userRegisteredSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    email: z.ZodEmail;
+}, z.core.$strip>;
+export declare const userVerifiedSchema: z.ZodObject<{
+    id: z.ZodUUID;
+}, z.core.$strip>;
+export declare const UserEventSchemas: {
+    readonly "user.registered": z.ZodObject<{
+        id: z.ZodUUID;
+        email: z.ZodEmail;
+    }, z.core.$strip>;
+    readonly "user.verified": z.ZodObject<{
+        id: z.ZodUUID;
+    }, z.core.$strip>;
+};

package/build/events/schemas/userEventsSchema.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserEventSchemas = exports.userVerifiedSchema = exports.userRegisteredSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.userRegisteredSchema = zod_1.default.object({
+    id: zod_1.default.uuid(),
+    email: zod_1.default.email(),
+});
+exports.userVerifiedSchema = zod_1.default.object({
+    id: zod_1.default.uuid(),
+});
+exports.UserEventSchemas = {
+    "user.registered": exports.userRegisteredSchema,
+    "user.verified": exports.userVerifiedSchema,
+};

package/build/index.d.ts

@@ -9,3 +9,5 @@ export * from "./middlewares/authMiddleware";
 export * from "./middlewares/requireRole";
 export * from "./types/UserRoles";
 export * from "./constants/HttpStatus";
+export * from "./events/AppEvent";
+export * from "./events/schemas/userEventsSchema";

package/build/index.js

@@ -30,3 +30,6 @@ __exportStar(require("./middlewares/requireRole"), exports);
 __exportStar(require("./types/UserRoles"), exports);
 // Constants
 __exportStar(require("./constants/HttpStatus"), exports);
+// Events
+__exportStar(require("./events/AppEvent"), exports);
+__exportStar(require("./events/schemas/userEventsSchema"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skillstew/common",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "scripts": {
@@ -17,6 +17,7 @@
     "@types/jsonwebtoken": "^9.0.10",
     "del-cli": "^6.0.0",
     "express": "^5.1.0",
-    "jsonwebtoken": "^9.0.2"
+    "jsonwebtoken": "^9.0.2",
+    "zod": "^4.0.10"
   }
 }

package/publish.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Exit immediately on error
+set -e
+
+# Step 1: Bump patch version
+npm version patch
+
+# Step 2: Build the package
+npm run build
+
+# Step 3: Stage all changes
+git add .
+
+# Step 4: Prompt for a commit message
+echo "Enter commit message:"
+read COMMIT_MESSAGE
+git commit -m "$COMMIT_MESSAGE"
+
+# Step 5: Push to GitHub
+echo "Enter remote branch to push to:"
+read REMOTE_BRANCH
+git push -u origin "$REMOTE_BRANCH"
+
+# Step 6: Publish to npm
+npm publish

package/src/events/AppEvent.ts

@@ -0,0 +1,15 @@
+import { EventName, EventPayload } from "./EventMap";
+
+export interface AppEvent<T extends EventName> {
+  eventId: string;
+  eventName: T;
+  timestamp: string; // ISO format
+  producer: string; // the service that emitted this event
+  data: EventPayload<T>;
+  traceId?: string;
+}
+
+export type UserRegisteredEvent = AppEvent<"user.registered">;
+export type UserVerifiedEvent = AppEvent<"user.verified">;
+
+export type AnyAppEvent = AppEvent<EventName>;

package/src/events/CreateEvent.ts

@@ -0,0 +1,19 @@
+import { AppEvent } from "./AppEvent";
+import { EventName, EventPayload } from "./EventMap";
+import { randomUUID } from "crypto";
+
+export function CreateEvent<T extends EventName>(
+  eventName: T,
+  data: EventPayload<T>,
+  producer: string,
+  traceId?: string,
+): AppEvent<T> {
+  return {
+    eventName,
+    eventId: randomUUID(),
+    data,
+    producer,
+    timestamp: new Date().toISOString(),
+    traceId,
+  };
+}

package/src/events/EventMap.ts

@@ -0,0 +1,16 @@
+import z from "zod";
+import { UserEventSchemas } from "./schemas/userEventsSchema";
+
+// Union of all app event schemas
+
+export const EventSchemas = {
+  ...UserEventSchemas,
+} as const;
+
+// Union of all app event names
+export type EventName = keyof typeof EventSchemas;
+
+// Union of all app event payloads
+export type EventPayload<T extends EventName> = z.infer<
+  (typeof EventSchemas)[T]
+>;

package/src/events/schemas/userEventsSchema.ts

@@ -0,0 +1,15 @@
+import z from "zod";
+
+export const userRegisteredSchema = z.object({
+  id: z.uuid(),
+  email: z.email(),
+});
+
+export const userVerifiedSchema = z.object({
+  id: z.uuid(),
+});
+
+export const UserEventSchemas = {
+  "user.registered": userRegisteredSchema,
+  "user.verified": userVerifiedSchema,
+} as const;

package/src/index.ts

@@ -18,3 +18,7 @@ export * from "./types/UserRoles";
 
 // Constants
 export * from "./constants/HttpStatus";
+
+// Events
+export * from "./events/AppEvent";
+export * from "./events/schemas/userEventsSchema";