@shipfox/api-workspaces 5.0.0 → 6.0.0

package/drizzle/0004_tired_talon.sql

@@ -0,0 +1 @@
+ALTER TABLE "workspaces_invitations" ADD COLUMN "revoked_at" timestamp with time zone;

package/drizzle/meta/0004_snapshot.json

@@ -0,0 +1,448 @@
+{
+  "id": "8eaf4dda-d82b-4389-9d02-2c2da9258419",
+  "prevId": "86af97dc-249d-4cc9-98bc-52681d4ca30f",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.workspaces_invitations": {
+      "name": "workspaces_invitations",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "workspace_id": {
+          "name": "workspace_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "email": {
+          "name": "email",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "hashed_token": {
+          "name": "hashed_token",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "expires_at": {
+          "name": "expires_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "revoked_at": {
+          "name": "revoked_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "accepted_at": {
+          "name": "accepted_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "accepted_by_user_id": {
+          "name": "accepted_by_user_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "invited_by_user_id": {
+          "name": "invited_by_user_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "invited_by_display": {
+          "name": "invited_by_display",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {
+        "workspaces_invitations_hashed_token_unique": {
+          "name": "workspaces_invitations_hashed_token_unique",
+          "columns": [
+            {
+              "expression": "hashed_token",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "workspaces_invitations_workspace_email_idx": {
+          "name": "workspaces_invitations_workspace_email_idx",
+          "columns": [
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "email",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {
+        "workspaces_invitations_workspace_id_workspaces_id_fk": {
+          "name": "workspaces_invitations_workspace_id_workspaces_id_fk",
+          "tableFrom": "workspaces_invitations",
+          "tableTo": "workspaces",
+          "columnsFrom": ["workspace_id"],
+          "columnsTo": ["id"],
+          "onDelete": "cascade",
+          "onUpdate": "no action"
+        }
+      },
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    },
+    "public.workspaces_memberships": {
+      "name": "workspaces_memberships",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "user_id": {
+          "name": "user_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "user_email": {
+          "name": "user_email",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "user_name": {
+          "name": "user_name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "workspace_id": {
+          "name": "workspace_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {
+        "workspaces_memberships_user_workspace_unique": {
+          "name": "workspaces_memberships_user_workspace_unique",
+          "columns": [
+            {
+              "expression": "user_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": true,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "workspaces_memberships_workspace_id_idx": {
+          "name": "workspaces_memberships_workspace_id_idx",
+          "columns": [
+            {
+              "expression": "workspace_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {
+        "workspaces_memberships_workspace_id_workspaces_id_fk": {
+          "name": "workspaces_memberships_workspace_id_workspaces_id_fk",
+          "tableFrom": "workspaces_memberships",
+          "tableTo": "workspaces",
+          "columnsFrom": ["workspace_id"],
+          "columnsTo": ["id"],
+          "onDelete": "cascade",
+          "onUpdate": "no action"
+        }
+      },
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    },
+    "public.workspaces_outbox": {
+      "name": "workspaces_outbox",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "event_type": {
+          "name": "event_type",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "ordering_key": {
+          "name": "ordering_key",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "payload": {
+          "name": "payload",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "dispatched_at": {
+          "name": "dispatched_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "dispatch_attempts": {
+          "name": "dispatch_attempts",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "default": 0
+        },
+        "next_dispatch_at": {
+          "name": "next_dispatch_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "last_dispatch_error": {
+          "name": "last_dispatch_error",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "last_dispatch_failed_at": {
+          "name": "last_dispatch_failed_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "dead_lettered_at": {
+          "name": "dead_lettered_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": false
+        }
+      },
+      "indexes": {
+        "workspaces_outbox_pending_idx": {
+          "name": "workspaces_outbox_pending_idx",
+          "columns": [
+            {
+              "expression": "next_dispatch_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "created_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "where": "\"dispatched_at\" IS NULL AND \"dead_lettered_at\" IS NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "workspaces_outbox_dispatched_retention_idx": {
+          "name": "workspaces_outbox_dispatched_retention_idx",
+          "columns": [
+            {
+              "expression": "dispatched_at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "where": "\"dispatched_at\" IS NOT NULL",
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    },
+    "public.workspaces": {
+      "name": "workspaces",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "uuidv7()"
+        },
+        "name": {
+          "name": "name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "status": {
+          "name": "status",
+          "type": "workspaces_workspace_status",
+          "typeSchema": "public",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'active'"
+        },
+        "settings": {
+          "name": "settings",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "'{}'::jsonb"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {
+    "public.workspaces_workspace_status": {
+      "name": "workspaces_workspace_status",
+      "schema": "public",
+      "values": ["active", "suspended", "deleted"]
+    }
+  },
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/drizzle/meta/_journal.json

@@ -29,6 +29,13 @@
       "when": 1782352229611,
       "tag": "0003_outgoing_enchantress",
       "breakpoints": true
+    },
+    {
+      "idx": 4,
+      "version": "7",
+      "when": 1784571790437,
+      "tag": "0004_tired_talon",
+      "breakpoints": true
     }
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-workspaces",
   "license": "MIT",
-  "version": "5.0.0",
+  "version": "6.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -19,23 +19,29 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./errors": {
+      "types": "./dist/core/errors.d.ts",
+      "default": "./dist/core/errors.js"
     }
   },
   "dependencies": {
     "drizzle-orm": "^0.45.2",
     "zod": "^4.4.3",
-    "@shipfox/api-auth-context": "5.0.0",
-    "@shipfox/api-workspaces-dto": "5.0.0",
+    "@shipfox/api-common-dto": "6.0.0",
+    "@shipfox/api-auth-context": "6.0.0",
+    "@shipfox/api-workspaces-dto": "6.0.0",
     "@shipfox/config": "1.2.2",
-    "@shipfox/node-drizzle": "0.3.1",
-    "@shipfox/node-fastify": "0.2.3",
+    "@shipfox/inter-module": "0.2.0",
+    "@shipfox/node-drizzle": "0.3.2",
+    "@shipfox/node-fastify": "0.2.4",
     "@shipfox/node-email": "0.2.2",
-    "@shipfox/node-mailer": "0.1.4",
-    "@shipfox/node-module": "0.3.2",
+    "@shipfox/node-mailer": "0.2.0",
+    "@shipfox/node-module": "0.4.0",
     "@shipfox/node-opentelemetry": "0.5.2",
-    "@shipfox/node-outbox": "0.2.3",
+    "@shipfox/node-outbox": "0.2.4",
     "@shipfox/node-postgres": "0.4.2",
-    "@shipfox/node-tokens": "0.2.1"
+    "@shipfox/node-tokens": "0.3.0"
   },
   "devDependencies": {
     "@types/pg": "^8.15.5",
@@ -44,6 +50,7 @@
     "fastify-type-provider-zod": "^6.0.0",
     "fishery": "^2.4.0",
     "@shipfox/biome": "1.8.2",
+    "@shipfox/depcruise": "1.0.2",
     "@shipfox/swc": "1.2.6",
     "@shipfox/ts-config": "1.3.8",
     "@shipfox/typescript": "1.1.7",
@@ -53,6 +60,7 @@
     "build": "shipfox-swc",
     "check": "shipfox-biome-check",
     "check:fix": "shipfox-biome-check --write",
+    "depcruise": "shipfox-depcruise",
     "test": "shipfox-vitest-run",
     "test:watch": "shipfox-vitest-watch",
     "type": "shipfox-tsc-check",

package/src/config.ts

@@ -1,51 +1,8 @@
-import {createConfig, num, str} from '@shipfox/config';
-import {createConsoleMailer, createSmtpMailer, type Mailer} from '@shipfox/node-mailer';
+import {createConfig, str} from '@shipfox/config';
 
 export const config = createConfig({
   CLIENT_BASE_URL: str({
     desc: 'Base URL of the client app. Used to build links in workspace invitation emails.',
     default: 'http://localhost:5173',
   }),
-  MAILER_TRANSPORT: str({
-    desc: 'How emails are delivered. Use console to print them to the log, or smtp to send them through an SMTP server.',
-    choices: ['console', 'smtp'],
-    default: 'console',
-  }),
-  MAILER_FROM: str({
-    desc: 'Sender address shown on outgoing emails.',
-    default: 'noreply@shipfox.local',
-  }),
-  SMTP_HOST: str({
-    desc: 'Hostname of the SMTP server. Required when MAILER_TRANSPORT is smtp.',
-    default: undefined,
-  }),
-  SMTP_PORT: num({
-    desc: 'Port of the SMTP server.',
-    default: 587,
-  }),
-  SMTP_USER: str({
-    desc: 'Username for SMTP authentication. Leave it unset if the server needs no login.',
-    default: undefined,
-  }),
-  SMTP_PASSWORD: str({
-    desc: 'Password for SMTP authentication. Leave it unset if the server needs no login.',
-    default: undefined,
-  }),
 });
-
-function createMailer(): Mailer {
-  if (config.MAILER_TRANSPORT === 'smtp') {
-    if (!config.SMTP_HOST) throw new Error('SMTP_HOST is required when MAILER_TRANSPORT=smtp');
-    return createSmtpMailer({
-      host: config.SMTP_HOST,
-      port: config.SMTP_PORT,
-      ...(config.SMTP_USER ? {user: config.SMTP_USER} : {}),
-      ...(config.SMTP_PASSWORD ? {password: config.SMTP_PASSWORD} : {}),
-      from: config.MAILER_FROM,
-    });
-  }
-
-  return createConsoleMailer({from: config.MAILER_FROM});
-}
-
-export const mailer = createMailer();

package/src/core/entities/invitation.ts

@@ -4,6 +4,7 @@ export interface Invitation {
   email: string;
   hashedToken: string;
   expiresAt: Date;
+  revokedAt: Date | null;
   acceptedAt: Date | null;
   acceptedByUserId: string | null;
   invitedByUserId: string;

package/src/core/invitations.test.ts

@@ -1,7 +1,9 @@
 import {WORKSPACES_INVITATION_SEND_REQUESTED} from '@shipfox/api-workspaces-dto';
 import type {Mailer, MailMessage} from '@shipfox/node-mailer';
+import {hashOpaqueToken} from '@shipfox/node-tokens';
 import {and, desc, eq, sql} from 'drizzle-orm';
 import {db} from '#db/db.js';
+import {findInvitationByToken, revokeInvitation} from '#db/invitations.js';
 import {createMembership} from '#db/memberships.js';
 import {workspacesOutbox} from '#db/schema/outbox.js';
 import {userFactory, workspaceFactory} from '#test/index.js';
@@ -10,7 +12,11 @@ import {
   OpenInvitationExistsError,
   TokenAlreadyUsedError,
 } from './errors.js';
-import {acceptWorkspaceInvitation, createWorkspaceInvitation} from './invitations.js';
+import {
+  acceptWorkspaceInvitation,
+  createWorkspaceInvitation,
+  previewInvitation,
+} from './invitations.js';
 
 const testConfig = vi.hoisted(
   (): {
@@ -241,11 +247,38 @@ describe('invitations core', () => {
     const result = await acceptWorkspaceInvitation({
       token,
       userId: invitee.userId,
-      email: invitee.email,
+      email: `  ${invitee.email.toUpperCase()}  `,
     });
     expect(result.membership.workspaceId).toBe(workspace.id);
 
     const reused = acceptWorkspaceInvitation({token, userId: invitee.userId, email: invitee.email});
     await expect(reused).rejects.toBeInstanceOf(TokenAlreadyUsedError);
   });
+
+  test('previewInvitation treats a revoked invitation as invalid', async () => {
+    const inviter = userFactory.build();
+    const workspace = await workspaceFactory.create();
+    await createMembership({
+      userId: inviter.userId,
+      userEmail: inviter.email,
+      userName: inviter.name,
+      workspaceId: workspace.id,
+    });
+    const email = `revoked-${crypto.randomUUID()}@example.com`;
+    await createWorkspaceInvitation({
+      workspaceId: workspace.id,
+      email,
+      invitedByUserId: inviter.userId,
+      invitedByMemberships: [{workspaceId: workspace.id, role: 'admin'}],
+    });
+    const payload = await latestInvitationPayload(email);
+    const token = extractToken(payload.inviteLink);
+    const invitation = await findInvitationByToken({hashedToken: hashOpaqueToken(token)});
+    if (!invitation) throw new Error('Expected stored invitation');
+    await revokeInvitation({invitationId: invitation.id});
+
+    const result = await previewInvitation({token});
+
+    expect(result).toEqual({status: 'invalid'});
+  });
 });