@skillstew/common 1.0.37 → 1.0.39

package/README.md

@@ -0,0 +1,85 @@
+# Common Package (`@skillstew/common`)
+
+A shared npm package containing event definitions used across all services. It defines the canonical event names, Zod payload schemas, and the `AppEvent` envelope type.
+
+**Published to:** npm (`@skillstew/common`)  
+**Package Manager:** npm  
+**Version:** patch-bumped on each publish via `npm run pub`
+
+## What It Exports
+
+### `AppEvent<T>`
+
+The envelope type for all inter-service events:
+
+```ts
+interface AppEvent<T extends EventName> {
+  eventId: string;
+  eventName: T;
+  timestamp: string; // ISO format
+  producer: string; // service that emitted the event
+  data: EventPayload<T>; // Zod-validated payload
+  traceId?: string;
+}
+```
+
+### `CreateEvent(eventName, data, producer, traceId?)`
+
+Factory function that builds an `AppEvent` with a random UUID and ISO timestamp.
+
+### `EventSchemas`
+
+A single object mapping every event name to its Zod schema. Used by outbox workers to validate payloads before publishing, and by consumers to parse incoming events.
+
+### `EventName` / `EventPayload<T>`
+
+Derived types — `EventName` is the union of all event name strings, and `EventPayload<T>` infers the payload type from the corresponding Zod schema.
+
+## Event Catalog
+
+### User Events
+
+| Event Name            | Payload Fields                                                      |
+| --------------------- | ------------------------------------------------------------------- |
+| `user.registered`     | `id`, `email`                                                       |
+| `user.verified`       | `id`                                                                |
+| `user.profileUpdated` | `id`, `name?`, `username?`, `location?`, `languages?`, `avatarKey?` |
+
+### Skill Events
+
+| Event Name             | Payload Fields                                             |
+| ---------------------- | ---------------------------------------------------------- |
+| `skill.created`        | `id`, `name`, `normalizedName`, `alternateNames`, `status` |
+| `skill.updated`        | Same as `skill.created`                                    |
+| `skill.deleted`        | `id`                                                       |
+| `skill.profileUpdated` | `userId`, `offered[{id, name}]`, `wanted[{id, name}]`      |
+
+### Connection Events
+
+| Event Name             | Payload Fields                                                                                        |
+| ---------------------- | ----------------------------------------------------------------------------------------------------- |
+| `connection.requested` | `connectionId`, `requesterId`, `requesterUsername?`, `recipientId`, `recipientUsername?`, `timestamp` |
+| `connection.accepted`  | `connectionId`, `accepterId`, `accepterUsername?`, `requesterId`, `requesterUsername?`, `timestamp`   |
+| `connection.rejected`  | `connectionId`, `rejecterId`, `rejecterUsername?`, `requesterId`, `requesterUsername?`, `timestamp`   |
+
+## Adding a New Event
+
+1. Create or update a Zod schema in `src/events/schemas/`
+2. Add the event name → schema mapping to the schema group object (e.g., `UserEventSchemas`)
+3. The event name is automatically available in `EventName`, and the payload type is inferred from the schema
+4. Run `npm run pub` to patch-bump, build, and publish
+
+## Directory Structure
+
+```
+common/src/
+├── index.ts                 # Re-exports everything
+└── events/
+    ├── AppEvent.ts           # AppEvent<T> interface
+    ├── CreateEvent.ts        # Factory function
+    ├── EventMap.ts           # EventSchemas, EventName, EventPayload<T>
+    └── schemas/
+        ├── userEventsSchema.ts              # user.registered, user.verified, user.profileUpdated
+        ├── skillsEventSchemas.ts            # skill.created, skill.updated, skill.deleted, skill.profileUpdated
+        └── userConnectionEventSchemas.ts    # connection.requested, connection.accepted, connection.rejected
+```

package/build/events/EventMap.d.ts

@@ -1,5 +1,20 @@
 import z from "zod";
 export declare const EventSchemas: {
+    readonly "expert.registered": z.ZodObject<{
+        id: z.ZodUUID;
+        email: z.ZodEmail;
+        token: z.ZodString;
+    }, z.core.$strip>;
+    readonly "expert.onboarded": z.ZodObject<{
+        expertId: z.ZodUUID;
+        fullName: z.ZodString;
+        bio: z.ZodString;
+        socialLinks: z.ZodArray<z.ZodString>;
+        username: z.ZodString;
+        yearsExperience: z.ZodNumber;
+        hasTeachingExperience: z.ZodBoolean;
+        teachingExperienceDesc: z.ZodString;
+    }, z.core.$strip>;
     readonly "connection.requested": z.ZodObject<{
         connectionId: z.ZodString;
         requesterId: z.ZodString;

package/build/events/EventMap.js

@@ -4,7 +4,8 @@ exports.EventName = exports.EventSchemas = void 0;
 const userEventsSchema_1 = require("./schemas/userEventsSchema");
 const skillsEventSchemas_1 = require("./schemas/skillsEventSchemas");
 const userConnectionEventSchemas_1 = require("./schemas/userConnectionEventSchemas");
+const expertEventsSchema_1 = require("./schemas/expertEventsSchema");
 // Union of all app event schemas
-exports.EventSchemas = Object.assign(Object.assign(Object.assign({}, userEventsSchema_1.UserEventSchemas), skillsEventSchemas_1.SkillsEventSchemas), userConnectionEventSchemas_1.ConnectionEventSchemas);
+exports.EventSchemas = Object.assign(Object.assign(Object.assign(Object.assign({}, userEventsSchema_1.UserEventSchemas), skillsEventSchemas_1.SkillsEventSchemas), userConnectionEventSchemas_1.ConnectionEventSchemas), expertEventsSchema_1.ExpertEventSchemas);
 // Array of all event names
 exports.EventName = Object.keys(exports.EventSchemas);

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

@@ -0,0 +1,33 @@
+import z from "zod";
+export declare const expertRegisteredSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    email: z.ZodEmail;
+    token: z.ZodString;
+}, z.core.$strip>;
+export declare const newExpertOnboardedSchema: z.ZodObject<{
+    expertId: z.ZodUUID;
+    fullName: z.ZodString;
+    bio: z.ZodString;
+    socialLinks: z.ZodArray<z.ZodString>;
+    username: z.ZodString;
+    yearsExperience: z.ZodNumber;
+    hasTeachingExperience: z.ZodBoolean;
+    teachingExperienceDesc: z.ZodString;
+}, z.core.$strip>;
+export declare const ExpertEventSchemas: {
+    readonly "expert.registered": z.ZodObject<{
+        id: z.ZodUUID;
+        email: z.ZodEmail;
+        token: z.ZodString;
+    }, z.core.$strip>;
+    readonly "expert.onboarded": z.ZodObject<{
+        expertId: z.ZodUUID;
+        fullName: z.ZodString;
+        bio: z.ZodString;
+        socialLinks: z.ZodArray<z.ZodString>;
+        username: z.ZodString;
+        yearsExperience: z.ZodNumber;
+        hasTeachingExperience: z.ZodBoolean;
+        teachingExperienceDesc: z.ZodString;
+    }, z.core.$strip>;
+};

package/build/events/schemas/expertEventsSchema.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpertEventSchemas = exports.newExpertOnboardedSchema = exports.expertRegisteredSchema = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.expertRegisteredSchema = zod_1.default.object({
+    id: zod_1.default.uuid(),
+    email: zod_1.default.email(),
+    token: zod_1.default.string(),
+});
+exports.newExpertOnboardedSchema = zod_1.default.object({
+    expertId: zod_1.default.uuid(),
+    fullName: zod_1.default.string(),
+    bio: zod_1.default.string(),
+    socialLinks: zod_1.default.array(zod_1.default.string()),
+    username: zod_1.default.string(),
+    yearsExperience: zod_1.default.number(),
+    hasTeachingExperience: zod_1.default.boolean(),
+    teachingExperienceDesc: zod_1.default.string(),
+});
+exports.ExpertEventSchemas = {
+    "expert.registered": exports.expertRegisteredSchema,
+    "expert.onboarded": exports.newExpertOnboardedSchema,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skillstew/common",
-  "version": "1.0.37",
+  "version": "1.0.39",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "scripts": {

package/src/events/EventMap.ts

@@ -2,6 +2,7 @@ import z from "zod";
 import { UserEventSchemas } from "./schemas/userEventsSchema";
 import { SkillsEventSchemas } from "./schemas/skillsEventSchemas";
 import { ConnectionEventSchemas } from "./schemas/userConnectionEventSchemas";
+import { ExpertEventSchemas } from "./schemas/expertEventsSchema";
 
 // Union of all app event schemas
 
@@ -9,6 +10,7 @@ export const EventSchemas = {
   ...UserEventSchemas,
   ...SkillsEventSchemas,
   ...ConnectionEventSchemas,
+  ...ExpertEventSchemas,
 } as const;
 
 // Array of all event names

package/src/events/schemas/expertEventsSchema.ts

@@ -0,0 +1,23 @@
+import z from "zod";
+
+export const expertRegisteredSchema = z.object({
+  id: z.uuid(),
+  email: z.email(),
+  token: z.string(),
+});
+
+export const newExpertOnboardedSchema = z.object({
+  expertId: z.uuid(),
+  fullName: z.string(),
+  bio: z.string(),
+  socialLinks: z.array(z.string()),
+  username: z.string(),
+  yearsExperience: z.number(),
+  hasTeachingExperience: z.boolean(),
+  teachingExperienceDesc: z.string(),
+});
+
+export const ExpertEventSchemas = {
+  "expert.registered": expertRegisteredSchema,
+  "expert.onboarded": newExpertOnboardedSchema,
+} as const;

package/publish.sh

@@ -1,27 +0,0 @@
-#!/bin/bash
-
-# Exit immediately on error
-set -e
-
-# Change to correct dir
-cd "/home/faheem/Work/dev/brototype/skillStew/skill-stew-api/common/"
-
-# 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
-git push
-
-# Step 6: Publish to npm
-npm publish