@shipfox/api-workspaces 9.3.0 → 10.0.0

package/drizzle/0001_complex_beast.sql

@@ -0,0 +1 @@
+CREATE INDEX "workspaces_name_id_idx" ON "workspaces_workspaces" USING btree ("name","id");

package/drizzle/meta/0001_snapshot.json

@@ -0,0 +1,476 @@
+{
+  "id": "8af7d61b-bfa2-426e-81bc-6523c4c0a368",
+  "prevId": "074ad011-b8db-44f8-b880-47460ca229d2",
+  "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_workspaces_id_fk": {
+          "name": "workspaces_invitations_workspace_id_workspaces_workspaces_id_fk",
+          "tableFrom": "workspaces_invitations",
+          "tableTo": "workspaces_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_workspaces_id_fk": {
+          "name": "workspaces_memberships_workspace_id_workspaces_workspaces_id_fk",
+          "tableFrom": "workspaces_memberships",
+          "tableTo": "workspaces_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_workspaces": {
+      "name": "workspaces_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_by": {
+          "name": "created_by",
+          "type": "uuid",
+          "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_name_id_idx": {
+          "name": "workspaces_name_id_idx",
+          "columns": [
+            {
+              "expression": "name",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "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

@@ -8,6 +8,13 @@
       "when": 1777229181112,
       "tag": "0000_initial",
       "breakpoints": true
+    },
+    {
+      "idx": 1,
+      "version": "7",
+      "when": 1785217735221,
+      "tag": "0001_complex_beast",
+      "breakpoints": true
     }
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-workspaces",
   "license": "MIT",
-  "version": "9.3.0",
+  "version": "10.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -25,15 +25,18 @@
     "drizzle-orm": "^0.45.2",
     "zod": "^4.4.3",
     "@shipfox/api-common-dto": "9.2.0",
-    "@shipfox/api-auth-context": "9.3.0",
-    "@shipfox/api-workspaces-dto": "9.3.0",
+    "@shipfox/api-auth-context": "10.0.0",
+    "@shipfox/api-auth-dto": "10.0.0",
+    "@shipfox/api-projects-dto": "10.0.0",
+    "@shipfox/api-runners-dto": "10.0.0",
+    "@shipfox/api-workspaces-dto": "10.0.0",
     "@shipfox/config": "1.2.4",
     "@shipfox/inter-module": "0.2.2",
     "@shipfox/node-drizzle": "0.3.4",
-    "@shipfox/node-fastify": "0.3.4",
+    "@shipfox/node-fastify": "0.4.0",
     "@shipfox/node-email": "0.3.4",
     "@shipfox/node-mailer": "0.2.4",
-    "@shipfox/node-module": "1.0.3",
+    "@shipfox/node-module": "1.0.4",
     "@shipfox/node-opentelemetry": "0.6.3",
     "@shipfox/node-outbox": "0.2.6",
     "@shipfox/node-postgres": "0.4.4",

package/src/core/admin-workspaces.ts

@@ -0,0 +1,114 @@
+import type {ProjectsModuleClient} from '@shipfox/api-projects-dto/inter-module';
+import type {RunnersInterModuleClient} from '@shipfox/api-runners-dto/inter-module';
+import type {StringIdCursor} from '@shipfox/node-drizzle';
+import {logger} from '@shipfox/node-opentelemetry';
+import {listAdminWorkspaces as listAdminWorkspaceRows} from '#db/workspaces.js';
+
+export interface WorkspaceAdministratorSummary {
+  id: string;
+  name: string;
+  status: 'active' | 'suspended' | 'deleted';
+  memberSummary: {count: number};
+  projectSummary: {state: 'available'; count: number} | {state: 'unknown'};
+  jobCounts: {state: 'available'; queued: number; running: number} | {state: 'unknown'};
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface ListWorkspaceAdministratorSummariesParams {
+  workspaceId?: string | undefined;
+  search?: string | undefined;
+  status?: 'active' | 'suspended' | 'deleted' | undefined;
+  limit: number;
+  cursor?: StringIdCursor | undefined;
+  projects: ProjectsModuleClient;
+  runners: RunnersInterModuleClient;
+}
+
+export interface ListWorkspaceAdministratorSummariesResult {
+  workspaces: WorkspaceAdministratorSummary[];
+  nextCursor: StringIdCursor | null;
+}
+
+export async function listWorkspaceAdministratorSummaries(
+  params: ListWorkspaceAdministratorSummariesParams,
+): Promise<ListWorkspaceAdministratorSummariesResult> {
+  const result = await listAdminWorkspaceRows(params);
+  const workspaceIds = result.workspaces.map(({id}) => id);
+  const [projectCounts, jobCounts] = await Promise.all([
+    getProjectCounts(params.projects, workspaceIds),
+    getJobCounts(params.runners, workspaceIds),
+  ]);
+
+  return {
+    workspaces: result.workspaces.map((workspace) => ({
+      id: workspace.id,
+      name: workspace.name,
+      status: workspace.status,
+      memberSummary: {count: workspace.memberCount},
+      projectSummary: projectCounts?.get(workspace.id) ?? {state: 'unknown'},
+      jobCounts: jobCounts?.get(workspace.id) ?? {state: 'unknown'},
+      createdAt: workspace.createdAt,
+      updatedAt: workspace.updatedAt,
+    })),
+    nextCursor: result.nextCursor,
+  };
+}
+
+async function getProjectCounts(
+  projects: ProjectsModuleClient,
+  workspaceIds: string[],
+): Promise<Map<string, {state: 'available'; count: number} | {state: 'unknown'}> | null> {
+  if (workspaceIds.length === 0) return new Map();
+
+  try {
+    const result = await projects.getWorkspaceProjectCounts({workspaceIds});
+    const counts = new Map(
+      result.counts.map(({workspaceId, count}) => [
+        workspaceId,
+        {state: 'available', count} as const,
+      ]),
+    );
+    return new Map(
+      workspaceIds.map((workspaceId) => [
+        workspaceId,
+        counts.get(workspaceId) ?? {state: 'unknown'},
+      ]),
+    );
+  } catch (error) {
+    logger().warn(
+      {operation: 'admin-workspace-project-summary', err: error},
+      'Project summary unavailable',
+    );
+    return null;
+  }
+}
+
+async function getJobCounts(
+  runners: RunnersInterModuleClient,
+  workspaceIds: string[],
+): Promise<Map<
+  string,
+  {state: 'available'; queued: number; running: number} | {state: 'unknown'}
+> | null> {
+  if (workspaceIds.length === 0) return new Map();
+
+  try {
+    const result = await runners.getWorkspaceJobCounts({workspaceIds});
+    const counts = new Map(
+      result.counts.map(({workspaceId, queued, running}) => [
+        workspaceId,
+        {state: 'available', queued, running} as const,
+      ]),
+    );
+    return new Map(
+      workspaceIds.map((workspaceId) => [
+        workspaceId,
+        counts.get(workspaceId) ?? {state: 'unknown'},
+      ]),
+    );
+  } catch (error) {
+    logger().warn({operation: 'admin-workspace-job-counts', err: error}, 'Job counts unavailable');
+    return null;
+  }
+}

package/src/core/index.ts

@@ -1,3 +1,9 @@
+export {
+  type ListWorkspaceAdministratorSummariesParams,
+  type ListWorkspaceAdministratorSummariesResult,
+  listWorkspaceAdministratorSummaries,
+  type WorkspaceAdministratorSummary,
+} from './admin-workspaces.js';
 export type {Invitation} from './entities/invitation.js';
 export type {Membership} from './entities/membership.js';
 export type {Workspace, WorkspaceStatus} from './entities/workspace.js';

package/src/db/index.ts

@@ -24,7 +24,10 @@ export {
 } from './memberships.js';
 export {workspacesOutbox} from './schema/outbox.js';
 export type {
+  AdminWorkspaceRow,
   CreateWorkspaceParams,
+  ListAdminWorkspaceParams,
+  ListAdminWorkspaceResult,
   UpdateWorkspaceParams,
   WorkspaceServiceMetrics,
 } from './workspaces.js';
@@ -32,6 +35,7 @@ export {
   createWorkspace,
   getWorkspaceById,
   getWorkspaceServiceMetrics,
+  listAdminWorkspaces,
   updateWorkspace,
 } from './workspaces.js';