@fonderie/workspaces 5.0.0 → 5.2.0

package/dist/index.d.cts

@@ -19,7 +19,7 @@ interface IWorkspacesConfig {
     personalWorkspace?: boolean;
     routes?: Partial<Record<WorkspaceRouteId, WorkspaceRouteOverride>>;
 }
-type WorkspaceRouteId = 'createWorkspace' | 'listWorkspaces' | 'getWorkspace' | 'updateWorkspace' | 'archive' | 'restore' | 'getSettings' | 'updateSettings' | 'listMembers' | 'removeMember' | 'getMemberRoles' | 'addMemberRole' | 'removeMemberRole' | 'listInvitations' | 'invite' | 'cancelInvitation' | 'acceptInvitation' | 'createRole' | 'listRoles' | 'getRole' | 'updateRole' | 'removeRole' | 'setRolePermissions';
+type WorkspaceRouteId = 'createWorkspace' | 'listWorkspaces' | 'getWorkspace' | 'updateWorkspace' | 'archive' | 'restore' | 'getSettings' | 'updateSettings' | 'listMembers' | 'removeMember' | 'getMemberRoles' | 'addMemberRole' | 'removeMemberRole' | 'listInvitations' | 'invite' | 'cancelInvitation' | 'acceptInvitation' | 'createRole' | 'listRoles' | 'getRole' | 'updateRole' | 'removeRole' | 'getRolePermissions' | 'setRolePermissions';
 type WorkspaceRouteOverride = string | {
     method?: string;
     path?: string;
@@ -59,6 +59,7 @@ interface IWorkspaceDTO {
     isPersonal: boolean;
     isArchived: boolean;
     archivedAt: string;
+    archivedBy: string;
     createdAt: string;
     updatedAt: string;
 }
@@ -77,6 +78,18 @@ interface IMemberDTO {
     roleName: string;
     confirmed: boolean;
     createdAt: string;
+    /**
+     * Identity, carried so a member list is renderable from this endpoint alone.
+     *
+     * listMembers() already joins the users table for these; without them a
+     * client has no name to show and falls back to printing a user id.
+     *
+     * Empty string when absent, matching every other string field in this file.
+     */
+    email: string;
+    firstName: string;
+    lastName: string;
+    profileImageUrl: string;
 }
 interface IInvitationDTO {
     id: string;
@@ -116,10 +129,10 @@ declare const updateWorkspaceSchema: z.ZodObject<{
         line1: z.ZodOptional<z.ZodString>;
         line2: z.ZodOptional<z.ZodString>;
         city: z.ZodOptional<z.ZodString>;
-        region: z.ZodOptional<z.ZodString>;
-        postalCode: z.ZodOptional<z.ZodString>;
+        state: z.ZodOptional<z.ZodString>;
+        zip: z.ZodOptional<z.ZodString>;
         country: z.ZodOptional<z.ZodString>;
-    }, z.core.$loose>>>;
+    }, z.core.$strip>>>;
 }, z.core.$strip>;
 declare const updateSettingsSchema: z.ZodObject<{
     locale: z.ZodOptional<z.ZodString>;
@@ -214,4 +227,11 @@ interface IImportMembership {
 }
 declare function importMembership(store: IStoreAdapter, m: IImportMembership): Promise<void>;
 
-export { EVENT_KEYS, type IImportMembership, type IImportRole, type IImportWorkspace, IInvitation, type IInvitationDTO, IMember, type IMemberDTO, IRole, type IRoleDTO, IWorkspace, type IWorkspaceDTO, IWorkspaceSettings, type IWorkspaceSettingsDTO, type IWorkspacesConfig, MESSAGE_KEYS, type WorkspacesEventKey, type WorkspacesMessageKey, WorkspacesModule, importMembership, importRole, importWorkspace, schemas, toInvitationDTO, toMemberDTO, toRoleDTO, toSettingsDTO, toWorkspaceDTO };
+declare function deleteUserData(store: IStoreAdapter, userId: string): Promise<number>;
+declare function exportUserData(store: IStoreAdapter, userId: string): Promise<unknown>;
+declare function workspaceExportContributor(store: IStoreAdapter): {
+    name: string;
+    collect: (userId: string) => Promise<unknown>;
+};
+
+export { EVENT_KEYS, type IImportMembership, type IImportRole, type IImportWorkspace, IInvitation, type IInvitationDTO, IMember, type IMemberDTO, IRole, type IRoleDTO, IWorkspace, type IWorkspaceDTO, IWorkspaceSettings, type IWorkspaceSettingsDTO, type IWorkspacesConfig, MESSAGE_KEYS, type WorkspacesEventKey, type WorkspacesMessageKey, WorkspacesModule, deleteUserData, exportUserData, importMembership, importRole, importWorkspace, schemas, toInvitationDTO, toMemberDTO, toRoleDTO, toSettingsDTO, toWorkspaceDTO, workspaceExportContributor };

package/dist/index.d.ts

@@ -19,7 +19,7 @@ interface IWorkspacesConfig {
     personalWorkspace?: boolean;
     routes?: Partial<Record<WorkspaceRouteId, WorkspaceRouteOverride>>;
 }
-type WorkspaceRouteId = 'createWorkspace' | 'listWorkspaces' | 'getWorkspace' | 'updateWorkspace' | 'archive' | 'restore' | 'getSettings' | 'updateSettings' | 'listMembers' | 'removeMember' | 'getMemberRoles' | 'addMemberRole' | 'removeMemberRole' | 'listInvitations' | 'invite' | 'cancelInvitation' | 'acceptInvitation' | 'createRole' | 'listRoles' | 'getRole' | 'updateRole' | 'removeRole' | 'setRolePermissions';
+type WorkspaceRouteId = 'createWorkspace' | 'listWorkspaces' | 'getWorkspace' | 'updateWorkspace' | 'archive' | 'restore' | 'getSettings' | 'updateSettings' | 'listMembers' | 'removeMember' | 'getMemberRoles' | 'addMemberRole' | 'removeMemberRole' | 'listInvitations' | 'invite' | 'cancelInvitation' | 'acceptInvitation' | 'createRole' | 'listRoles' | 'getRole' | 'updateRole' | 'removeRole' | 'getRolePermissions' | 'setRolePermissions';
 type WorkspaceRouteOverride = string | {
     method?: string;
     path?: string;
@@ -59,6 +59,7 @@ interface IWorkspaceDTO {
     isPersonal: boolean;
     isArchived: boolean;
     archivedAt: string;
+    archivedBy: string;
     createdAt: string;
     updatedAt: string;
 }
@@ -77,6 +78,18 @@ interface IMemberDTO {
     roleName: string;
     confirmed: boolean;
     createdAt: string;
+    /**
+     * Identity, carried so a member list is renderable from this endpoint alone.
+     *
+     * listMembers() already joins the users table for these; without them a
+     * client has no name to show and falls back to printing a user id.
+     *
+     * Empty string when absent, matching every other string field in this file.
+     */
+    email: string;
+    firstName: string;
+    lastName: string;
+    profileImageUrl: string;
 }
 interface IInvitationDTO {
     id: string;
@@ -116,10 +129,10 @@ declare const updateWorkspaceSchema: z.ZodObject<{
         line1: z.ZodOptional<z.ZodString>;
         line2: z.ZodOptional<z.ZodString>;
         city: z.ZodOptional<z.ZodString>;
-        region: z.ZodOptional<z.ZodString>;
-        postalCode: z.ZodOptional<z.ZodString>;
+        state: z.ZodOptional<z.ZodString>;
+        zip: z.ZodOptional<z.ZodString>;
         country: z.ZodOptional<z.ZodString>;
-    }, z.core.$loose>>>;
+    }, z.core.$strip>>>;
 }, z.core.$strip>;
 declare const updateSettingsSchema: z.ZodObject<{
     locale: z.ZodOptional<z.ZodString>;
@@ -214,4 +227,11 @@ interface IImportMembership {
 }
 declare function importMembership(store: IStoreAdapter, m: IImportMembership): Promise<void>;
 
-export { EVENT_KEYS, type IImportMembership, type IImportRole, type IImportWorkspace, IInvitation, type IInvitationDTO, IMember, type IMemberDTO, IRole, type IRoleDTO, IWorkspace, type IWorkspaceDTO, IWorkspaceSettings, type IWorkspaceSettingsDTO, type IWorkspacesConfig, MESSAGE_KEYS, type WorkspacesEventKey, type WorkspacesMessageKey, WorkspacesModule, importMembership, importRole, importWorkspace, schemas, toInvitationDTO, toMemberDTO, toRoleDTO, toSettingsDTO, toWorkspaceDTO };
+declare function deleteUserData(store: IStoreAdapter, userId: string): Promise<number>;
+declare function exportUserData(store: IStoreAdapter, userId: string): Promise<unknown>;
+declare function workspaceExportContributor(store: IStoreAdapter): {
+    name: string;
+    collect: (userId: string) => Promise<unknown>;
+};
+
+export { EVENT_KEYS, type IImportMembership, type IImportRole, type IImportWorkspace, IInvitation, type IInvitationDTO, IMember, type IMemberDTO, IRole, type IRoleDTO, IWorkspace, type IWorkspaceDTO, IWorkspaceSettings, type IWorkspaceSettingsDTO, type IWorkspacesConfig, MESSAGE_KEYS, type WorkspacesEventKey, type WorkspacesMessageKey, WorkspacesModule, deleteUserData, exportUserData, importMembership, importRole, importWorkspace, schemas, toInvitationDTO, toMemberDTO, toRoleDTO, toSettingsDTO, toWorkspaceDTO, workspaceExportContributor };

package/dist/index.js

@@ -42,10 +42,10 @@ var addressSchema = z.object({
   line1: z.string().max(200).optional(),
   line2: z.string().max(200).optional(),
   city: z.string().max(100).optional(),
-  region: z.string().max(100).optional(),
-  postalCode: z.string().max(20).optional(),
+  state: z.string().max(100).optional(),
+  zip: z.string().max(20).optional(),
   country: z.string().max(60).optional()
-}).passthrough();
+});
 var updateWorkspaceSchema = z.object({
   name: z.string().trim().min(1).max(200).optional(),
   description: z.string().max(2e3).nullable().optional(),
@@ -586,6 +586,19 @@ async function setRolePermissions(roleId, workspaceId, permissions, store) {
     }
   });
 }
+async function getRolePermissions(roleId, workspaceId, store) {
+  return store.query(
+    `SELECT permission_key AS "permissionKey",
+		        can_create     AS "canCreate",
+		        can_read       AS "canRead",
+		        can_update     AS "canUpdate",
+		        can_delete     AS "canDelete"
+		   FROM fonderie_role_permissions
+		  WHERE role_id = $1 AND workspace_id = $2
+		  ORDER BY permission_key`,
+    [roleId, workspaceId]
+  );
+}
 
 // src/models/role.model.ts
 var RoleModel = class {
@@ -614,10 +627,13 @@ var RoleModel = class {
   setPermissions(roleId, workspaceId, permissions) {
     return setRolePermissions(roleId, workspaceId, permissions, this.store);
   }
+  getPermissions(roleId, workspaceId) {
+    return getRolePermissions(roleId, workspaceId, this.store);
+  }
 };
 
 // src/dtos/workspace.ts
-import { stringOrEmpty, booleanOrFalse } from "@fonderie/core/parser";
+import { booleanOrFalse, dateOrEmpty, stringOrEmpty } from "@fonderie/core/parser";
 function toWorkspaceDTO(ws) {
   const addr = ws.address ?? {};
   return {
@@ -641,9 +657,10 @@ function toWorkspaceDTO(ws) {
     ownerId: stringOrEmpty(ws.ownerId),
     isPersonal: booleanOrFalse(ws.isPersonal),
     isArchived: ws.archivedAt !== null,
-    archivedAt: stringOrEmpty(ws.archivedAt),
-    createdAt: stringOrEmpty(ws.createdAt),
-    updatedAt: stringOrEmpty(ws.updatedAt)
+    archivedAt: dateOrEmpty(ws.archivedAt),
+    archivedBy: stringOrEmpty(ws.archivedBy),
+    createdAt: dateOrEmpty(ws.createdAt),
+    updatedAt: dateOrEmpty(ws.updatedAt)
   };
 }
 function toRoleDTO(role) {
@@ -663,7 +680,11 @@ function toMemberDTO(m) {
     roleId: stringOrEmpty(m.roleId),
     roleName: stringOrEmpty(m.roleName),
     confirmed: booleanOrFalse(m.confirmed),
-    createdAt: stringOrEmpty(m.createdAt)
+    createdAt: dateOrEmpty(m.createdAt),
+    email: stringOrEmpty(m.email),
+    firstName: stringOrEmpty(m.firstName),
+    lastName: stringOrEmpty(m.lastName),
+    profileImageUrl: stringOrEmpty(m.profileImageUrl)
   };
 }
 function toInvitationDTO(inv) {
@@ -674,8 +695,8 @@ function toInvitationDTO(inv) {
     roleId: stringOrEmpty(inv.roleId),
     token: stringOrEmpty(inv.token),
     status: stringOrEmpty(inv.status),
-    expiresAt: stringOrEmpty(inv.expiresAt),
-    createdAt: stringOrEmpty(inv.createdAt)
+    expiresAt: dateOrEmpty(inv.expiresAt),
+    createdAt: dateOrEmpty(inv.createdAt)
   };
 }
 function toSettingsDTO(s) {
@@ -994,6 +1015,24 @@ function roleController(store) {
       await roles.delete(roleId, ctx.workspace.id);
       return setApiResponse4(HTTP4.OK, "ROLE_DELETED", "Role deleted successfully.");
     },
+    async getPermissions(ctx) {
+      if (!ctx.workspace) {
+        return setApiResponse4(HTTP4.NOT_FOUND, "NOT_FOUND", "Workspace not found");
+      }
+      const params = ctx.meta["params"];
+      const roleId = params?.["roleId"];
+      if (!roleId) {
+        return setApiResponse4(HTTP4.UNPROCESSABLE, "INVALID_PARAMETER", "roleId is required");
+      }
+      const role = await roles.findById(roleId);
+      if (!role) {
+        return setApiResponse4(HTTP4.NOT_FOUND, "NOT_FOUND", "Role not found");
+      }
+      const permissions = await roles.getPermissions(roleId, ctx.workspace.id);
+      return setApiResponse4(HTTP4.OK, "PERMISSIONS_FETCHED", "Role permissions retrieved successfully.", {
+        permissions
+      });
+    },
     async setPermissions(ctx) {
       if (!ctx.workspace) {
         return setApiResponse4(HTTP4.NOT_FOUND, "NOT_FOUND", "Workspace not found");
@@ -1304,6 +1343,7 @@ function buildWorkspaceRoutes(store, config, bus) {
     R("getRole", "GET", "/workspaces/roles/:roleId", requireAuth, wsCtx, role.get),
     R("updateRole", "PUT", "/workspaces/roles/:roleId", requireAuth, wsCtx, validate(updateRoleSchema), role.update),
     R("removeRole", "DELETE", "/workspaces/roles/:roleId", requireAuth, wsCtx, role.remove),
+    R("getRolePermissions", "GET", "/workspaces/roles/:roleId/permissions", requireAuth, wsCtx, role.getPermissions),
     R("setRolePermissions", "POST", "/workspaces/roles/:roleId/permissions", requireAuth, wsCtx, validate(setRolePermissionsSchema), role.setPermissions),
     // ── Workspace lifecycle
     R("archive", "POST", "/workspaces/archive", requireAuth, wsCtx, workspace.archive),
@@ -1460,10 +1500,35 @@ async function importMembership(store, m) {
     vals
   );
 }
+
+// src/retention.ts
+async function deleteUserData(store, userId) {
+  const rows = await store.query(
+    `DELETE FROM fonderie_role_user_workspaces WHERE user_id = $1 RETURNING user_id`,
+    [userId]
+  );
+  return rows.length;
+}
+async function exportUserData(store, userId) {
+  const rows = await store.query(
+    `SELECT ruw.workspace_id, ruw.role_id, r.name AS role_name
+		 FROM fonderie_role_user_workspaces ruw
+		 JOIN fonderie_roles r ON r.id = ruw.role_id
+		 WHERE ruw.user_id = $1 AND ruw.removed = false
+		 ORDER BY ruw.workspace_id`,
+    [userId]
+  );
+  return { memberships: rows };
+}
+function workspaceExportContributor(store) {
+  return { name: "workspaces", collect: (userId) => exportUserData(store, userId) };
+}
 export {
   EVENT_KEYS,
   MESSAGE_KEYS,
   WorkspacesModule,
+  deleteUserData,
+  exportUserData,
   importMembership,
   importRole,
   importWorkspace,
@@ -1474,6 +1539,7 @@ export {
   toRoleDTO,
   toSettingsDTO,
   toWorkspaceDTO,
-  withWorkspace
+  withWorkspace,
+  workspaceExportContributor
 };
 //# sourceMappingURL=index.js.map