@ossy/users 1.13.2 → 1.13.3

package/README.md

@@ -0,0 +1,72 @@
+# @ossy/users
+
+User domain package for the Ossy platform — event-sourced user entities, workspace membership, and user-scoped API token actions.
+
+## What this package provides
+
+| Primitive | File | Id / export |
+|---|---|---|
+| Schema | `user.schema.js` | `@ossy/users/schema/user` |
+| Schema ids | `schema-ids.js` | `UserSchema` |
+| Aggregate | `user.aggregate.js` | `User` (`kind: 'entity'`, `SchemaId`) |
+| Events | `users.events.js` | `UsersEvents.Created`, `SignInVerified`, `NameUpdated`, … |
+| Queries | `users.queries.js` | `UsersQueries` |
+| Startup | `users.startup.js` | Bot user bootstrap |
+
+Client exports (`@ossy/users`) surface action metadata for the SDK. Server exports (`@ossy/users/server`) include the aggregate, events, queries, and validators.
+
+## Actions
+
+| Action | Access | Task |
+|--------|--------|------|
+| `@ossy/users/actions/update-details` | authenticated | `@ossy/users/tasks/update-details` |
+| `@ossy/users/actions/get-current-user-history` | authenticated | `@ossy/users/tasks/get-current-user-history` |
+| `@ossy/users/actions/join-workspace` | authenticated | `@ossy/users/tasks/join-workspace` |
+| `@ossy/users/actions/leave-workspace` | authenticated | `@ossy/users/tasks/leave-workspace` |
+| `@ossy/users/actions/get-api-tokens` | authenticated | `@ossy/users/tasks/get-api-tokens` |
+| `@ossy/users/actions/create-api-token` | authenticated | `@ossy/users/tasks/create-api-token` |
+| `@ossy/users/actions/invalidate-api-token` | authenticated | `@ossy/users/tasks/invalidate-api-token` |
+
+API token tasks delegate to `@ossy/tokens` (`TokenEvents.Created` / revoke flows).
+
+## User schema (ADR 0006)
+
+| Schema | Id | Fields |
+|---|---|---|
+| User | `@ossy/users/schema/user` | `email`, `firstName`, `lastName` |
+
+## Event model (ADR 0008)
+
+User entity events use the universal envelope: `type` (schema id), `resourceId`, `event` (lifecycle name), `payload`, `createdBy`.
+
+| Event | Effect |
+|---|---|
+| `Created` | New user (`type: 'User'` or `'Bot'`) |
+| `SignInVerified` | Sets `verifiedAt` on first verification |
+| `NameUpdated` | Updates `firstName` / `lastName` |
+| `WorkspaceJoined` | Adds workspace id to `workspaces[]` |
+| `WorkspaceLeft` | Removes workspace id from `workspaces[]` |
+
+`UsersEvents.SignedUp` was renamed to `UsersEvents.Created` to match the ADR 0008 lifecycle name.
+
+## Server usage
+
+```js
+import { Aggregate } from '@ossy/event-store'
+import { User, UsersEvents, UserSchema } from '@ossy/users/server'
+
+const created = UsersEvents.Created({ email, firstName, lastName })
+const user = await Aggregate.Of(User, created).then(Aggregate.View())
+
+UserSchema.user
+// => '@ossy/users/schema/user'
+```
+
+## Testing
+
+```bash
+npm test -w @ossy/users
+npm run test:integration -w @ossy/users
+```
+
+Unit coverage lives in package tests; `users.integration.spec.js` exercises actions against `@ossy/platform`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ossy/users",
   "description": "User domain - aggregate, events, and validators for the Ossy user model",
-  "version": "1.13.2",
+  "version": "1.13.3",
   "private": false,
   "type": "module",
   "main": "./src/index.js",
@@ -11,7 +11,8 @@
     "./server": "./src/server.js"
   },
   "scripts": {
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest --verbose"
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:integration": "NODE_OPTIONS=--experimental-vm-modules jest --config jest.integration.config.js --verbose"
   },
   "author": "Ossy <yourfriends@ossy.se> (https://ossy.se)",
   "license": "MIT",
@@ -28,12 +29,13 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@ossy/observability": "^1.8.2",
+    "@ossy/observability": "^1.8.3",
+    "@ossy/schema": "^1.0.1",
     "nanoid": "^5.1.11"
   },
   "devDependencies": {
     "@jest/globals": "^30.2.0",
-    "@ossy/platform": "^1.39.2",
+    "@ossy/platform": "^1.39.3",
     "casual": "^1.6.2",
     "jest": "^30.2.0"
   },
@@ -41,5 +43,5 @@
     "/src",
     "README.md"
   ],
-  "gitHead": "2b8745d57fee8b6c08787e2755b4df489291a5cd"
+  "gitHead": "a0d89185a17f8de8ce328c3a648c108ff1d61d8f"
 }

package/src/create-api-token.action.js

@@ -1 +1 @@
-export const metadata = { id: 'users/create-api-token', access: 'authenticated' }
+export const metadata = { id: '@ossy/users/actions/create-api-token', access: 'authenticated' }

package/src/create-api-token.task.js

@@ -1,12 +1,14 @@
+import { nanoid } from 'nanoid'
 import jwt from 'jsonwebtoken'
 import { Aggregate } from '@ossy/event-store'
 import { Token, TokenEvents } from '@ossy/tokens/server'
 import { ConfigService } from '@ossy/platform'
 import { createLogger } from '@ossy/observability'
+import { normalizeScopes } from '@ossy/schema'
 
-export const metadata = { id: 'users/create-api-token' }
+export const metadata = { id: '@ossy/users/tasks/create-api-token' }
 
-const log = createLogger('users/create-api-token')
+const log = createLogger('@ossy/users/tasks/create-api-token')
 
 const SECONDS_IN_100_YEARS = 60 * 60 * 24 * 365 * 100
 
@@ -16,19 +18,35 @@ export async function run({ payload, req }) {
   const description = payload?.description
 
   if (!name || typeof name !== 'string') {
-    log.debug('[users/create-api-token] No name provided')
+    log.debug('[users/tasks/create-api-token] No name provided')
     throw Object.assign(new Error('No name provided'), { status: 400 })
   }
   if (!description || typeof description !== 'string') {
-    log.debug('[users/create-api-token] No description provided')
+    log.debug('[users/tasks/create-api-token] No description provided')
     throw Object.assign(new Error('No description provided'), { status: 400 })
   }
 
   const expiresIn = SECONDS_IN_100_YEARS
   const expiresAt = Date.now() + expiresIn * 1000
-  const token = jwt.sign({ sub: createdBy, type: 'Api' }, ConfigService.TokenSecret, { expiresIn })
-
-  const event = TokenEvents.Created({ name, description, createdBy, type: 'Api', subject: createdBy, token, expiresAt })
+  const scopes = normalizeScopes(payload?.scopes)
+  const resourceId = nanoid()
+  const token = jwt.sign(
+    { sub: createdBy, type: 'Api', jti: resourceId, scopes },
+    ConfigService.TokenSecret,
+    { expiresIn },
+  )
+
+  const event = TokenEvents.Created({
+    resourceId,
+    name,
+    description,
+    createdBy,
+    type: 'Api',
+    subject: createdBy,
+    token,
+    expiresAt,
+    scopes,
+  })
 
   return Aggregate.Of(Token, event).then(Aggregate.View())
 }

package/src/en.translations.json

@@ -1,16 +1,16 @@
 {
-  "users/create-api-token.label": "Create API token",
-  "users/create-api-token.description": "Create a personal API token for the authenticated user",
-  "users/get-api-tokens.label": "Get API tokens",
-  "users/get-api-tokens.description": "List API tokens for the authenticated user",
-  "users/get-current-user-history.label": "Get user history",
-  "users/get-current-user-history.description": "Return activity history for the current user",
-  "users/invalidate-api-token.label": "Invalidate API token",
-  "users/invalidate-api-token.description": "Revoke an API token by id",
-  "users/join-workspace.label": "Join workspace",
-  "users/join-workspace.description": "Add the current user to a workspace",
-  "users/leave-workspace.label": "Leave workspace",
-  "users/leave-workspace.description": "Remove the current user from a workspace",
-  "users/update-details.label": "Update user details",
-  "users/update-details.description": "Update profile fields for the authenticated user"
+  "@ossy/users/actions/create-api-token.label": "Create API token",
+  "@ossy/users/actions/create-api-token.description": "Create a personal API token for the authenticated user",
+  "@ossy/users/actions/get-api-tokens.label": "Get API tokens",
+  "@ossy/users/actions/get-api-tokens.description": "List API tokens for the authenticated user",
+  "@ossy/users/actions/get-current-user-history.label": "Get user history",
+  "@ossy/users/actions/get-current-user-history.description": "Return activity history for the current user",
+  "@ossy/users/actions/invalidate-api-token.label": "Invalidate API token",
+  "@ossy/users/actions/invalidate-api-token.description": "Revoke an API token by id",
+  "@ossy/users/actions/join-workspace.label": "Join workspace",
+  "@ossy/users/actions/join-workspace.description": "Add the current user to a workspace",
+  "@ossy/users/actions/leave-workspace.label": "Leave workspace",
+  "@ossy/users/actions/leave-workspace.description": "Remove the current user from a workspace",
+  "@ossy/users/actions/update-details.label": "Update user details",
+  "@ossy/users/actions/update-details.description": "Update profile fields for the authenticated user"
 }

package/src/get-api-tokens.action.js

@@ -1 +1 @@
-export const metadata = { id: 'users/get-api-tokens', access: 'authenticated' }
+export const metadata = { id: '@ossy/users/actions/get-api-tokens', access: 'authenticated' }

package/src/get-api-tokens.task.js

@@ -1,16 +1,17 @@
 import { Aggregate } from '@ossy/event-store'
+import { TokenSchema } from '@ossy/tokens/server'
 import { createLogger } from '@ossy/observability'
 
-export const metadata = { id: 'users/get-api-tokens' }
+export const metadata = { id: '@ossy/users/tasks/get-api-tokens' }
 
-const log = createLogger('users/get-api-tokens')
+const log = createLogger('@ossy/users/tasks/get-api-tokens')
 
-export async function run({ payload, req }) {
+export async function run ({ payload, req }) {
   const userId = payload?.userId ?? req?.userId
 
-  log.info('[users/get-api-tokens] Fetching API tokens for user')
+  log.info('[users/tasks/get-api-tokens] Fetching API tokens for user')
   const tokens = await Aggregate.Collection.find({
-    type: 'Token',
+    type: TokenSchema.token,
     'state.subject': userId,
     'state.type': 'Api',
   }, { state: true }).toArray().then(docs => docs.map(d => d.state))

package/src/get-current-user-history.action.js

@@ -1 +1 @@
-export const metadata = { id: 'users/get-current-user-history', access: 'authenticated' }
+export const metadata = { id: '@ossy/users/actions/get-current-user-history', access: 'authenticated' }

package/src/get-current-user-history.task.js

@@ -1,10 +1,10 @@
 import { EventStore } from '@ossy/event-store'
 import { User } from '@ossy/users/server'
 
-export const metadata = { id: 'users/get-current-user-history' }
+export const metadata = { id: '@ossy/users/tasks/get-current-user-history' }
 
-export async function run({ payload, req }) {
+export async function run ({ payload, req }) {
   const userId = payload?.userId ?? req?.userId
-  const events = await EventStore.GetEventStream({ aggregateId: userId, fromVersion: 0 })
+  const events = await EventStore.GetResourceStream({ resourceId: userId, fromVersion: 0 })
   return User.History(events)
 }

package/src/invalidate-api-token.action.js

@@ -1 +1 @@
-export const metadata = { id: 'users/invalidate-api-token', access: 'authenticated' }
+export const metadata = { id: '@ossy/users/actions/invalidate-api-token', access: 'authenticated' }

package/src/invalidate-api-token.task.js

@@ -1,7 +1,7 @@
 import { Aggregate } from '@ossy/event-store'
 import { Token, TokenEvents } from '@ossy/tokens/server'
 
-export const metadata = { id: 'users/invalidate-api-token' }
+export const metadata = { id: '@ossy/users/tasks/invalidate-api-token' }
 
 export async function run({ payload, req }) {
   const createdBy = payload?.userId ?? req?.userId

package/src/join-workspace.action.js

@@ -1 +1 @@
-export const metadata = { id: 'users/join-workspace', access: 'authenticated' }
+export const metadata = { id: '@ossy/users/actions/join-workspace', access: 'authenticated' }

package/src/join-workspace.task.js

@@ -1,7 +1,7 @@
 import { Aggregate } from '@ossy/event-store'
 import { User, UsersEvents } from '@ossy/users/server'
 
-export const metadata = { id: 'users/join-workspace' }
+export const metadata = { id: '@ossy/users/tasks/join-workspace' }
 
 export async function run({ payload, req }) {
   const userId = payload?.targetUserId ?? payload?.userId ?? req?.userId

package/src/leave-workspace.action.js

@@ -1 +1 @@
-export const metadata = { id: 'users/leave-workspace', access: 'authenticated' }
+export const metadata = { id: '@ossy/users/actions/leave-workspace', access: 'authenticated' }

package/src/leave-workspace.task.js

@@ -1,7 +1,7 @@
 import { Aggregate } from '@ossy/event-store'
 import { User, UsersEvents } from '@ossy/users/server'
 
-export const metadata = { id: 'users/leave-workspace' }
+export const metadata = { id: '@ossy/users/tasks/leave-workspace' }
 
 export async function run({ payload, req }) {
   const userId = payload?.userId ?? req?.userId

package/src/schema-ids.js

@@ -0,0 +1,3 @@
+export const UserSchema = Object.freeze({
+  user: '@ossy/users/schema/user',
+})

package/src/server.js

@@ -2,3 +2,4 @@ export * from './user.aggregate.js'
 export * from './users.events.js'
 export * from './users.validators.js'
 export * from './users.queries.js'
+export { UserSchema } from './schema-ids.js'

package/src/sv.translations.json

@@ -1,16 +1,16 @@
 {
-  "users/create-api-token.label": "Skapa API-nyckel",
-  "users/create-api-token.description": "Skapa en personlig API-nyckel för den inloggade användaren",
-  "users/get-api-tokens.label": "Hämta API-nycklar",
-  "users/get-api-tokens.description": "Lista API-nycklar för den inloggade användaren",
-  "users/get-current-user-history.label": "Hämta användarhistorik",
-  "users/get-current-user-history.description": "Returnera aktivitetshistorik för nuvarande användare",
-  "users/invalidate-api-token.label": "Ogiltigförklara API-nyckel",
-  "users/invalidate-api-token.description": "Återkalla en API-nyckel via id",
-  "users/join-workspace.label": "Gå med i workspace",
-  "users/join-workspace.description": "Lägg till nuvarande användare i ett workspace",
-  "users/leave-workspace.label": "Lämna workspace",
-  "users/leave-workspace.description": "Ta bort nuvarande användare från ett workspace",
-  "users/update-details.label": "Uppdatera användaruppgifter",
-  "users/update-details.description": "Uppdatera profilfält för den inloggade användaren"
+  "@ossy/users/actions/create-api-token.label": "Skapa API-nyckel",
+  "@ossy/users/actions/create-api-token.description": "Skapa en personlig API-nyckel för den inloggade användaren",
+  "@ossy/users/actions/get-api-tokens.label": "Hämta API-nycklar",
+  "@ossy/users/actions/get-api-tokens.description": "Lista API-nycklar för den inloggade användaren",
+  "@ossy/users/actions/get-current-user-history.label": "Hämta användarhistorik",
+  "@ossy/users/actions/get-current-user-history.description": "Returnera aktivitetshistorik för nuvarande användare",
+  "@ossy/users/actions/invalidate-api-token.label": "Ogiltigförklara API-nyckel",
+  "@ossy/users/actions/invalidate-api-token.description": "Återkalla en API-nyckel via id",
+  "@ossy/users/actions/join-workspace.label": "Gå med i workspace",
+  "@ossy/users/actions/join-workspace.description": "Lägg till nuvarande användare i ett workspace",
+  "@ossy/users/actions/leave-workspace.label": "Lämna workspace",
+  "@ossy/users/actions/leave-workspace.description": "Ta bort nuvarande användare från ett workspace",
+  "@ossy/users/actions/update-details.label": "Uppdatera användaruppgifter",
+  "@ossy/users/actions/update-details.description": "Uppdatera profilfält för den inloggade användaren"
 }

package/src/update-details.action.js

@@ -1 +1 @@
-export const metadata = { id: 'users/update-details', access: 'authenticated' }
+export const metadata = { id: '@ossy/users/actions/update-details', access: 'authenticated' }

package/src/update-details.task.js

@@ -1,7 +1,7 @@
 import { Aggregate } from '@ossy/event-store'
 import { User, UsersEvents } from '@ossy/users/server'
 
-export const metadata = { id: 'users/update-details' }
+export const metadata = { id: '@ossy/users/tasks/update-details' }
 
 export async function run({ payload, req }) {
   const createdBy = payload?.userId ?? req?.userId

package/src/user.aggregate.js

@@ -1,85 +1,73 @@
+import { UserSchema } from './schema-ids.js'
+
 export class User {
 
+  static kind = 'entity'
+  static SchemaId = UserSchema.user
   static AggregateType = 'User'
 
-  static View(events, savedState = {}) {
+  static View (events, savedState = {}) {
     return events.reduce((user, event) => {
+      switch (event.event) {
 
-      switch (event.type) {
-
-        case 'SignedUp':
+        case 'Created':
           return {
             ...user,
-            id: event.aggregateId,
+            id: event.resourceId,
             type: event.payload.type,
             created: event.created,
             email: event.payload.email,
-            verificationToken: event.payload.verificationToken,
             firstName: event.payload.firstName,
             lastName: event.payload.lastName,
-            workspaces: user.workspaces ?? []
+            workspaces: user.workspaces ?? [],
           }
 
         case 'SignInVerified':
           return {
             ...user,
-            verifiedAt: user.verifiedAt ?? event.created
+            verifiedAt: user.verifiedAt ?? event.created,
           }
 
         case 'NameUpdated': {
           const firstName = event.payload.firstName || user.firstName
           const lastName = event.payload.lastName || user.lastName
-          return {
-            ...user,
-            firstName,
-            lastName
-          }
+          return { ...user, firstName, lastName }
         }
 
-        // TODO: #415
-        // case 'EmailUpdated':
-        // return {
-        //   ...user,
-        //   email: event.payload.email
-        // }
-
         case 'WorkspaceJoined':
           return {
             ...user,
-            workspaces: [...new Set([...(user.workspaces ?? []), event.payload.workspaceId])]
+            workspaces: [...new Set([...(user.workspaces ?? []), event.payload.workspaceId])],
           }
 
         case 'WorkspaceLeft':
           return {
             ...user,
-            workspaces: (user.workspaces ?? []).filter(id => id !== event.payload.workspaceId)
+            workspaces: (user.workspaces ?? []).filter(id => id !== event.payload.workspaceId),
           }
 
         default:
           return user
-
       }
     }, savedState)
   }
 
-  static UserForWorkspace(events, aggregate) {
+  static UserForWorkspace (events, aggregate) {
     const user = User.View(events, aggregate)
     return {
       id: user.id,
       firstName: user.firstName,
       lastName: user.lastName,
       email: user.email,
-      type: user.type
+      type: user.type,
     }
   }
 
-  static History(events) {
-    // TODO: add aggregate 
+  static History (events) {
     return events
       .sort((a, b) => b.created - a.created)
-      .map(event => ({ type: event.type, created: event.created }))
+      .map(event => ({ type: event.event, created: event.created }))
   }
-
 }
 
 export { User as Aggregate }

package/src/user.schema.js

@@ -0,0 +1,11 @@
+export default {
+  id: '@ossy/users/schema/user',
+  name: 'User',
+  categoryName: 'Users',
+  icon: 'user',
+  fields: [
+    { name: 'email', type: 'text' },
+    { name: 'firstName', type: 'text' },
+    { name: 'lastName', type: 'text' },
+  ],
+}

package/src/users.events.js

@@ -1,121 +1,57 @@
 import { nanoid } from 'nanoid'
+import { UserSchema } from './schema-ids.js'
 
 /**
-  * Database queries related to workspace events
-  * @class
-  */
+ * ADR 0008 user entity events.
+ */
 export class UsersEvents {
 
-  static SignedUp({
+  static Created ({
     email,
     lastName,
     firstName,
     userId: _userId,
-    type = 'User' // is 'User' or 'Bot'
+    type = 'User',
   }) {
-    const userId = _userId || nanoid()
-    return ({
-      type: 'SignedUp',
-      aggregateId: userId,
-      createdBy: userId,
-      payload: {
-        email: email,
-        lastName,
-        firstName,
-        type: type
-      }
-    })
-   }
-
-  //  static SignInRequested({ createdBy }) {
-  //    return ({
-  //      type: 'SignInRequested',
-  //      createdBy: createdBy,
-  //      payload: { verificationToken: TokenService.new() }
-  //    })
-  //   }
+    const resourceId = _userId ?? nanoid()
+    return {
+      type: UserSchema.user,
+      resourceId,
+      event: 'Created',
+      createdBy: resourceId,
+      payload: { email, lastName, firstName, type },
+    }
+  }
 
-  /** Same JWT as the `auth` cookie / WebAuth token aggregate — see `UsersQueries.getIdByAuthToken`. */
-  static SignInVerified({ createdBy, token }) {
-    return ({
-      type: 'SignInVerified',
+  static SignInVerified ({ createdBy, token }) {
+    return {
+      event: 'SignInVerified',
       createdBy,
-      payload: { token }
-    })
+      payload: { token },
+    }
   }
 
-    // static SignedOff({ token, createdBy }) {
-    //   return ({
-    //     type: 'SignedOff',
-    //     createdBy: createdBy,
-    //     payload: { token }
-    //   })
-    // }
-
-    // static ApiTokenCreated({ name, createdBy, description, token, expiresAt }) {
-    //   return ({
-    //     type: 'ApiTokenCreated',
-    //     createdBy: createdBy,
-    //     payload: {
-    //       name,
-    //       expiresAt: expiresAt,
-    //       description: description,
-    //       token: token
-    //     }
-    //   })
-    // }
-
-    // static ApiTokenInvalidated({ createdBy, tokenId }) {
-    //   return ({
-    //     type: 'ApiTokenInvalidated',
-    //     createdBy: createdBy,
-    //     payload: { tokenId }
-    //   })
-    // }
-
-    static NameUpdated({ lastName, firstName, createdBy }) {
-      return ({
-        type: 'NameUpdated',
-        createdBy: createdBy,
-        payload: {
-          lastName,
-          firstName
-        }
-      })
-     }
-
-    // TODO: #415
-    //  static EmailChangeRequested({ email, createdBy }) {
-    //   return ({
-    //     type: 'EmailUpdated',
-    //     createdBy: createdBy,
-    //     payload: { email }
-    //   })
-    //  }
-
-    // TODO: #415
-    //  static EmailUpdated({ email, createdBy }) {
-    //   return ({
-    //     type: 'EmailUpdated',
-    //     createdBy: createdBy,
-    //     payload: { email }
-    //   })
-    //  }
-
-    static WorkspaceJoined({ workspaceId, createdBy }) {
-      return ({
-        type: 'WorkspaceJoined',
-        createdBy,
-        payload: { workspaceId }
-      })
+  static NameUpdated ({ lastName, firstName, createdBy }) {
+    return {
+      event: 'NameUpdated',
+      createdBy,
+      payload: { lastName, firstName },
     }
+  }
 
-    static WorkspaceLeft({ workspaceId, createdBy }) {
-      return ({
-        type: 'WorkspaceLeft',
-        createdBy,
-        payload: { workspaceId }
-      })
+  static WorkspaceJoined ({ workspaceId, createdBy }) {
+    return {
+      event: 'WorkspaceJoined',
+      createdBy,
+      payload: { workspaceId },
     }
+  }
 
+  static WorkspaceLeft ({ workspaceId, createdBy }) {
+    return {
+      event: 'WorkspaceLeft',
+      createdBy,
+      payload: { workspaceId },
+    }
+  }
 }

package/src/{users.spec.js → users.integration.spec.js}

@@ -1,6 +1,9 @@
 import casual from 'casual'
 import { TestUtil, getApiTestBaseUrl, getSetCookieHeader } from '@ossy/platform/test'
 
+const USER_SCHEMA = '@ossy/users/schema/user'
+const TOKEN_SCHEMA = '@ossy/tokens/schema/token'
+
 const authHeaders = (token) => ({
   'Content-Type': 'application/json',
   Authorization: token,
@@ -29,31 +32,31 @@ function invalidSignUpPayload(invalidEmail) {
   return o
 }
 
-describe('[authentication/sign-up]', () => {
+describe('[authentication/actions/sign-up]', () => {
 
   describe('given an email that is not already in use', () => {
 
     it('must return OK 200', () => TestUtil.AssertActionResponse({
-      actionId: 'authentication/sign-up',
+      actionId: '@ossy/authentication/actions/sign-up',
       body: TestUtil.signUpBody({ email: casual.email }),
       expectedResponseStatus: 200,
       expectedResponseBody: { ok: true }
     }))
 
-    it('must produce a SignedUp event', async () => {
+    it('must produce a Created event', async () => {
 
       const email = casual.email
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/sign-up',
+        actionId: '@ossy/authentication/actions/sign-up',
         body: TestUtil.signUpBody({ email }),
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
       })
 
       await TestUtil.AssertEventExist({
-        aggregateType: 'User',
-        type: { $in: [ 'SignedUp' ] },
+        type: USER_SCHEMA,
+        event: 'Created',
         'payload.email': email
       })
 
@@ -67,7 +70,7 @@ describe('[authentication/sign-up]', () => {
       const email = casual.email
 
       const signUpTestRequest = {
-        actionId: 'authentication/sign-up',
+        actionId: '@ossy/authentication/actions/sign-up',
         body: TestUtil.signUpBody({ email }),
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
@@ -81,7 +84,7 @@ describe('[authentication/sign-up]', () => {
       const email = `dup-${Date.now()}-${casual.email}`
 
       const signUpTestRequest = {
-        actionId: 'authentication/sign-up',
+        actionId: '@ossy/authentication/actions/sign-up',
         body: TestUtil.signUpBody({ email }),
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
@@ -91,8 +94,8 @@ describe('[authentication/sign-up]', () => {
       await TestUtil.AssertActionResponse(signUpTestRequest)
 
       const signUpEvents = await TestUtil.GetEvents({
-        aggregateType: 'User',
-        type: { $in: [ 'SignedUp' ] },
+        type: USER_SCHEMA,
+        event: 'Created',
         'payload.email': email
       })
 
@@ -107,7 +110,7 @@ describe('[authentication/sign-up]', () => {
       it(
         `must return BAD REQUEST 400 for invalid email: ${invalidEmail}`,
         () => TestUtil.AssertActionResponse({
-          actionId: 'authentication/sign-up',
+          actionId: '@ossy/authentication/actions/sign-up',
           payload: invalidSignUpPayload(invalidEmail),
           expectedResponseStatus: 400,
           expectedResponseBody: { error: 'Invalid email' }
@@ -118,7 +121,7 @@ describe('[authentication/sign-up]', () => {
 
 })
 
-describe('[authentication/request-sign-in]', () => {
+describe('[authentication/actions/request-sign-in]', () => {
 
   describe('given an email that is in use', () => {
 
@@ -126,14 +129,14 @@ describe('[authentication/request-sign-in]', () => {
       const email = casual.email
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/sign-up',
+        actionId: '@ossy/authentication/actions/sign-up',
         body: TestUtil.signUpBody({ email }),
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
       })
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/request-sign-in',
+        actionId: '@ossy/authentication/actions/request-sign-in',
         payload: { email },
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
@@ -146,26 +149,26 @@ describe('[authentication/request-sign-in]', () => {
       const email = casual.email
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/sign-up',
+        actionId: '@ossy/authentication/actions/sign-up',
         body: TestUtil.signUpBody({ email }),
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
       })
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/request-sign-in',
+        actionId: '@ossy/authentication/actions/request-sign-in',
         payload: { email },
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
       })
 
-      const signedUpEvent = await TestUtil.GetEvent({
-        aggregateType: 'User',
-        type: { $in: [ 'SignedUp' ] },
+      const createdEvent = await TestUtil.GetEvent({
+        type: USER_SCHEMA,
+        event: 'Created',
         'payload.email': email
       })
 
-      const jwt = await TestUtil.getLatestVerificationJwtForSubject(signedUpEvent.aggregateId)
+      const jwt = await TestUtil.getLatestVerificationJwtForSubject(createdEvent.resourceId)
       expect(typeof jwt).toBe('string')
     })
 
@@ -175,7 +178,7 @@ describe('[authentication/request-sign-in]', () => {
 
     it('must, for security reasons, return an OK 200 response', async () => {
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/request-sign-in',
+        actionId: '@ossy/authentication/actions/request-sign-in',
         payload: { email: casual.email },
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
@@ -187,7 +190,7 @@ describe('[authentication/request-sign-in]', () => {
       const verificationTokensBefore = await TestUtil.countVerificationTokenEvents()
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/request-sign-in',
+        actionId: '@ossy/authentication/actions/request-sign-in',
         payload: { email: casual.email },
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
@@ -207,7 +210,7 @@ describe('[authentication/request-sign-in]', () => {
       it(
         `must return BAD REQUEST 400 for invalid email: ${invalidEmail}`,
         () => TestUtil.AssertActionResponse({
-          actionId: 'authentication/request-sign-in',
+          actionId: '@ossy/authentication/actions/request-sign-in',
           payload: { email: invalidEmail },
           expectedResponseStatus: 400,
           expectedResponseBody: { error: 'No email provided' }
@@ -220,24 +223,24 @@ describe('[authentication/request-sign-in]', () => {
 
 describe('[/users/verify-sign-in][GET]', () => {
 
-  describe('given a valid token created from a SignedUp event', () => {
+  describe('given a valid token created from a Created event', () => {
     it('must return OK 200 and an auth cookie and must produce a SignInVerified event', async () => {
       const email = casual.email
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/sign-up',
+        actionId: '@ossy/authentication/actions/sign-up',
         body: TestUtil.signUpBody({ email }),
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
       })
 
-      const signedUpEvent = await TestUtil.GetEvent({
-        aggregateType: 'User',
-        type: { $in: [ 'SignedUp' ] },
+      const createdEvent = await TestUtil.GetEvent({
+        type: USER_SCHEMA,
+        event: 'Created',
         'payload.email': email
       })
 
-      const verificationJwt = await TestUtil.getLatestVerificationJwtForSubject(signedUpEvent.aggregateId)
+      const verificationJwt = await TestUtil.getLatestVerificationJwtForSubject(createdEvent.resourceId)
 
       const response = await fetch(
         `${getApiTestBaseUrl()}/users/verify-sign-in?token=${verificationJwt}`,
@@ -247,9 +250,9 @@ describe('[/users/verify-sign-in][GET]', () => {
       const body = await response.json()
 
       const signInVerifiedEvent = await TestUtil.GetEvent({
-        aggregateType: 'User',
-        aggregateId: signedUpEvent.aggregateId,
-        type: { $in: [ 'SignInVerified' ] },
+        type: USER_SCHEMA,
+        resourceId: createdEvent.resourceId,
+        event: 'SignInVerified',
       })
 
       expect(body).toBe('')
@@ -264,26 +267,26 @@ describe('[/users/verify-sign-in][GET]', () => {
       const email = casual.email
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/sign-up',
+        actionId: '@ossy/authentication/actions/sign-up',
         body: TestUtil.signUpBody({ email }),
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
       })
 
       await TestUtil.AssertActionResponse({
-        actionId: 'authentication/request-sign-in',
+        actionId: '@ossy/authentication/actions/request-sign-in',
         payload: { email },
         expectedResponseStatus: 200,
         expectedResponseBody: { ok: true }
       })
 
-      const signedUpEvent = await TestUtil.GetEvent({
-        aggregateType: 'User',
-        type: { $in: [ 'SignedUp' ] },
+      const createdEvent = await TestUtil.GetEvent({
+        type: USER_SCHEMA,
+        event: 'Created',
         'payload.email': email
       })
 
-      const verificationJwt = await TestUtil.getLatestVerificationJwtForSubject(signedUpEvent.aggregateId)
+      const verificationJwt = await TestUtil.getLatestVerificationJwtForSubject(createdEvent.resourceId)
 
       const response = await fetch(
         `${getApiTestBaseUrl()}/users/verify-sign-in?token=${verificationJwt}`,
@@ -293,9 +296,9 @@ describe('[/users/verify-sign-in][GET]', () => {
       const body = await response.json()
 
       const signInVerifiedEvent = await TestUtil.GetEvent({
-        aggregateType: 'User',
-        aggregateId: signedUpEvent.aggregateId,
-        type: { $in: [ 'SignInVerified' ] },
+        type: USER_SCHEMA,
+        resourceId: createdEvent.resourceId,
+        event: 'SignInVerified',
       })
 
       expect(body).toBe('')
@@ -334,11 +337,11 @@ describe('[/users/verify-sign-in][GET]', () => {
 
 })
 
-describe('[authentication/get-current-user]', () => {
+describe('[authentication/actions/get-current-user]', () => {
 
   describe('given no auth token is provided', () => {
     it('must return null', async () => {
-      const response = await TestUtil.InvokeAction({ actionId: 'authentication/get-current-user' })
+      const response = await TestUtil.InvokeAction({ actionId: '@ossy/authentication/actions/get-current-user' })
       expect(response.status).toEqual(200)
       await expect(response.json()).resolves.toBeNull()
     })
@@ -349,7 +352,7 @@ describe('[authentication/get-current-user]', () => {
       const user = await TestUtil.GetAuthenticatedTestUser()
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'authentication/get-current-user',
+        actionId: '@ossy/authentication/actions/get-current-user',
         headers: authHeaders(user.token),
       })
 
@@ -370,10 +373,10 @@ describe('[authentication/get-current-user]', () => {
   })
 })
 
-describe('[users/get-current-user-history]', () => {
+describe('[users/actions/get-current-user-history]', () => {
 
   TestUtil.AssertActionAuthenticationNeeded({
-    actionId: 'users/get-current-user-history',
+    actionId: '@ossy/users/actions/get-current-user-history',
   })
 
   describe('given an auth token', () => {
@@ -381,7 +384,7 @@ describe('[users/get-current-user-history]', () => {
       const user = await TestUtil.GetAuthenticatedTestUser()
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'users/get-current-user-history',
+        actionId: '@ossy/users/actions/get-current-user-history',
         headers: authHeaders(user.token),
       })
 
@@ -392,26 +395,26 @@ describe('[users/get-current-user-history]', () => {
 
       expect(body.map(x => x.type)).toEqual([
         'SignInVerified',
-        'SignedUp'
+        'Created'
       ])
 
     })
   })
 })
 
-describe('[users/create-api-token]', () => {
+describe('[users/actions/create-api-token]', () => {
 
   TestUtil.AssertActionAuthenticationNeeded({
-    actionId: 'users/create-api-token',
+    actionId: '@ossy/users/actions/create-api-token',
     payload: { name: 't', description: 'd' }
   })
 
   describe('given a valid auth token', () => {
-    it('must return OK 200 with an API token and produce an ApiTokenCreated event', async () => {
+    it('must return OK 200 with an API token and produce an Api token Created event', async () => {
       const user = await TestUtil.GetAuthenticatedTestUser()
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'users/create-api-token',
+        actionId: '@ossy/users/actions/create-api-token',
         headers: authHeaders(user.token),
         payload: { name: 'cli', description: casual.sentence }
       })
@@ -428,7 +431,7 @@ describe('[users/create-api-token]', () => {
           description: event.payload.description,
           token: event.payload.token,
           created: event.created,
-          id: event.aggregateId,
+          id: event.resourceId,
           type: 'Api',
           name: 'cli',
         })
@@ -448,7 +451,7 @@ describe('[users/create-api-token]', () => {
         else payload = invalidDescription
 
         const response = await TestUtil.InvokeAction({
-          actionId: 'users/create-api-token',
+          actionId: '@ossy/users/actions/create-api-token',
           headers: authHeaders(user.token),
           payload,
         })
@@ -456,9 +459,11 @@ describe('[users/create-api-token]', () => {
         const responseBody = await response.json()
 
         const event = TestUtil.GetEvent({
-          aggregateId: user.id,
-          aggregateType: 'User',
-          type: 'ApiTokenCreated'
+          type: TOKEN_SCHEMA,
+          event: 'Created',
+          'payload.type': 'Api',
+          'payload.subject': user.id,
+          createdBy: user.id,
         })
 
         expect(response.status).toEqual(400)
@@ -471,10 +476,10 @@ describe('[users/create-api-token]', () => {
 
 })
 
-describe('[users/get-api-tokens]', () => {
+describe('[users/actions/get-api-tokens]', () => {
 
   TestUtil.AssertActionAuthenticationNeeded({
-    actionId: 'users/get-api-tokens',
+    actionId: '@ossy/users/actions/get-api-tokens',
   })
 
   describe('given authentication token is provided', () => {
@@ -483,13 +488,13 @@ describe('[users/get-api-tokens]', () => {
       const user = await TestUtil.GetAuthenticatedTestUser()
 
       const token = await TestUtil.InvokeAction({
-        actionId: 'users/create-api-token',
+        actionId: '@ossy/users/actions/create-api-token',
         headers: authHeaders(user.token),
         payload: { name: 'list-test', description: casual.sentence }
       }).then(response => response.json())
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'users/get-api-tokens',
+        actionId: '@ossy/users/actions/get-api-tokens',
         headers: authHeaders(user.token),
       })
 
@@ -516,7 +521,7 @@ describe('[users/get-api-tokens]', () => {
 
 const createApiToken = async (user) => {
   const token = await TestUtil.InvokeAction({
-    actionId: 'users/create-api-token',
+    actionId: '@ossy/users/actions/create-api-token',
     headers: authHeaders(user.token),
     payload: { name: 'delete-test', description: casual.sentence }
   }).then(response => response.json())
@@ -524,21 +529,21 @@ const createApiToken = async (user) => {
   return token
 }
 
-describe('[users/invalidate-api-token]', () => {
+describe('[users/actions/invalidate-api-token]', () => {
 
   TestUtil.AssertActionAuthenticationNeeded({
-    actionId: 'users/invalidate-api-token',
+    actionId: '@ossy/users/actions/invalidate-api-token',
     payload: { tokenId: '123' },
   })
 
   describe('authentication with user token', () => {
 
-    it('must return OK 200 and produce an ApiTokenInvalidated event', async () => {
+    it('must return OK 200 and produce a Revoked event', async () => {
       const user = await TestUtil.GetAuthenticatedTestUser()
       const token = await createApiToken(user)
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'users/invalidate-api-token',
+        actionId: '@ossy/users/actions/invalidate-api-token',
         headers: authHeaders(user.token),
         payload: { tokenId: token.id },
       })
@@ -546,9 +551,9 @@ describe('[users/invalidate-api-token]', () => {
       const responseBody = await response.json()
 
       const event = await TestUtil.GetEvent({
-        aggregateId: token.id,
-        aggregateType: 'Token',
-        type: 'Revoked',
+        resourceId: token.id,
+        type: TOKEN_SCHEMA,
+        event: 'Revoked',
       })
 
       expect(response.status).toEqual(200)
@@ -562,13 +567,13 @@ describe('[users/invalidate-api-token]', () => {
       const token = await createApiToken(user)
 
       await TestUtil.InvokeAction({
-        actionId: 'users/invalidate-api-token',
+        actionId: '@ossy/users/actions/invalidate-api-token',
         headers: authHeaders(user.token),
         payload: { tokenId: token.id },
       })
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'users/get-api-tokens',
+        actionId: '@ossy/users/actions/get-api-tokens',
         headers: authHeaders(user.token),
       })
 
@@ -582,12 +587,12 @@ describe('[users/invalidate-api-token]', () => {
 
   describe('authentication with API token', () => {
 
-    it('must return OK 200 and produce an ApiTokenInvalidated event', async () => {
+    it('must return OK 200 and produce a Revoked event', async () => {
       const user = await TestUtil.GetAuthenticatedTestUser()
       const token = await createApiToken(user)
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'users/invalidate-api-token',
+        actionId: '@ossy/users/actions/invalidate-api-token',
         headers: authHeaders(token.token),
         payload: { tokenId: token.id },
       })
@@ -595,9 +600,9 @@ describe('[users/invalidate-api-token]', () => {
       const responseBody = await response.json()
 
       const event = await TestUtil.GetEvent({
-        aggregateId: token.id,
-        aggregateType: 'Token',
-        type: 'Revoked',
+        resourceId: token.id,
+        type: TOKEN_SCHEMA,
+        event: 'Revoked',
       })
 
       expect(response.status).toEqual(200)
@@ -611,13 +616,13 @@ describe('[users/invalidate-api-token]', () => {
       const token = await createApiToken(user)
 
       await TestUtil.InvokeAction({
-        actionId: 'users/invalidate-api-token',
+        actionId: '@ossy/users/actions/invalidate-api-token',
         headers: authHeaders(token.token),
         payload: { tokenId: token.id },
       })
 
       const response = await TestUtil.InvokeAction({
-        actionId: 'users/get-api-tokens',
+        actionId: '@ossy/users/actions/get-api-tokens',
         headers: authHeaders(token.token),
       })
 

package/src/users.queries.js

@@ -1,52 +1,37 @@
 import { EventStore, Aggregate } from '@ossy/event-store'
+import { UserSchema } from './schema-ids.js'
 import { createLogger } from '@ossy/observability'
 
 const log = createLogger('users')
 
-/**
- * Database queries related to user aggregates.
- * @class
- */
 export class UsersQueries {
 
-  static getByEmail(email) {
+  static getByEmail (email) {
     log.debug(`[UsersQueries][getByEmail()] Fetch user for ${email}`)
 
     return Aggregate.Collection.findOne({
-      type: 'User',
-      'state.email': email
+      type: UserSchema.user,
+      'state.email': email,
     }).then(aggregate => aggregate?.state)
-      .then(user => {
-        !!user
-          ? log.debug('[UsersQueries][getByEmail()] Found user', { user })
-          : log.debug('[UsersQueries][getByEmail()] No user found')
-        
-        return user
-      })
   }
 
-  static getIdByVerificationToken(token) {
+  static getIdByVerificationToken (token) {
     log.info('[UsersQueries] Using verificationToken to fetch userId')
 
     return EventStore.FindEvent({
-      aggregateType: 'User',
-      type: { $in: [ 'SignedUp', 'SignInRequested' ] },
-      'payload.verificationToken': token
-    }).then(event => event.aggregateId)
+      type: UserSchema.user,
+      event: 'Created',
+      'payload.verificationToken': token,
+    }).then(event => event?.resourceId)
   }
 
-  static getIdByAuthToken(token) {
+  static getIdByAuthToken (token) {
     log.info('[UsersQueries] Using authToken to fetch userId')
-    log.debug('[UsersQueries] token', { token })
 
     return EventStore.FindEvent({
-      aggregateType: 'User',
-      type: { $in: [ 'SignInVerified' ] },
-      'payload.token': token
-    }).then(event => {
-      log.debug('[UsersQueries] Found', { event })
-      return event.aggregateId
-    })
+      type: UserSchema.user,
+      event: 'SignInVerified',
+      'payload.token': token,
+    }).then(event => event?.resourceId)
   }
-
 }

package/src/users.startup.js

@@ -1,5 +1,5 @@
 import { Aggregate } from '@ossy/event-store'
-import { UsersEvents, User } from './server.js'
+import { UsersEvents, User, UserSchema } from './server.js'
 import { createLogger } from '@ossy/observability'
 
 const log = createLogger('users')
@@ -19,7 +19,7 @@ export async function run ({ env }) {
   log.info('[users.startup][create-bot-user] Starting bot user creation script')
 
   const existing = await Aggregate.Collection.findOne({
-    type: 'User',
+    type: UserSchema.user,
     'state.email': botEmail,
   })
 
@@ -30,12 +30,12 @@ export async function run ({ env }) {
 
   log.info('[users.startup][create-bot-user] No bot user found, creating')
 
-  const signedUpEvent = UsersEvents.SignedUp({
+  const createdEvent = UsersEvents.Created({
     type: 'Bot',
     email: botEmail,
     userId: botUserId,
   })
 
-  await Aggregate.Of(User, signedUpEvent)
+  await Aggregate.Of(User, createdEvent)
   log.info('[users.startup][create-bot-user] Bot user created')
 }