@jskit-ai/workspaces-core 0.2.4 → 0.2.6

package/src/server/workspaceMembers/workspaceMembersActions.js

@@ -1,8 +1,8 @@
 import { workspaceInviteAssistantOutput } from "../../shared/resources/workspaceAssistantOutputs.js";
 import { composeSchemaDefinitions } from "@jskit-ai/kernel/shared/validators";
-import { returnJsonApiData } from "@jskit-ai/http-runtime/shared";
+import { jsonApiResultValue } from "@jskit-ai/http-runtime/shared";
 import { resolveWorkspace } from "../support/resolveWorkspace.js";
-import { resolveActionUser } from "../common/support/resolveActionUser.js";
+import { resolveActionUser } from "@jskit-ai/users-core/server/resolveActionUser";
 import { workspaceMembersResource } from "../../shared/resources/workspaceMembersResource.js";
 import {
   INVITE_RECIPIENT_BOOTSTRAP_AUDIENCE,
@@ -20,7 +20,7 @@ const WORKSPACE_INVITE_CREATED_EVENTS = createWorkspaceEntityAndBootstrapEvents(
   workspaceEntity: "invite",
   workspaceOperation: "created",
   workspaceRealtimeEvent: "workspace.invites.changed",
-  bootstrapEntityId: ({ result } = {}) => result?.value?.createdInviteId,
+  bootstrapEntityId: ({ result }) => jsonApiResultValue(result).createdInviteId,
   bootstrapAudience: INVITE_RECIPIENT_BOOTSTRAP_AUDIENCE
 });
 
@@ -28,7 +28,7 @@ const WORKSPACE_INVITE_REVOKED_EVENTS = createWorkspaceEntityAndBootstrapEvents(
   workspaceEntity: "invite",
   workspaceOperation: "updated",
   workspaceRealtimeEvent: "workspace.invites.changed",
-  bootstrapEntityId: ({ result } = {}) => result?.value?.revokedInviteId,
+  bootstrapEntityId: ({ result }) => jsonApiResultValue(result).revokedInviteId,
   bootstrapAudience: INVITE_RECIPIENT_BOOTSTRAP_AUDIENCE
 });
 
@@ -36,7 +36,7 @@ const updateMemberRoleActionInput = composeSchemaDefinitions([
   workspaceSlugParamsValidator,
   workspaceMembersResource.operations.updateMemberRole.input
 ], {
-  mode: workspaceMembersResource.operations.updateMemberRole.input.mode,
+  mode: "create",
   context: "workspaceMembersActions.updateMemberRoleActionInput"
 });
 
@@ -44,7 +44,7 @@ const removeMemberActionInput = composeSchemaDefinitions([
   workspaceSlugParamsValidator,
   workspaceMembersResource.operations.removeMember.input
 ], {
-  mode: workspaceMembersResource.operations.removeMember.input.mode,
+  mode: "create",
   context: "workspaceMembersActions.removeMemberActionInput"
 });
 
@@ -52,7 +52,7 @@ const createInviteActionInput = composeSchemaDefinitions([
   workspaceSlugParamsValidator,
   workspaceMembersResource.operations.createInvite.body
 ], {
-  mode: workspaceMembersResource.operations.createInvite.body.mode,
+  mode: "create",
   context: "workspaceMembersActions.createInviteActionInput"
 });
 
@@ -60,223 +60,193 @@ const revokeInviteActionInput = composeSchemaDefinitions([
   workspaceSlugParamsValidator,
   workspaceMembersResource.operations.revokeInvite.input
 ], {
-  mode: workspaceMembersResource.operations.revokeInvite.input.mode,
+  mode: "create",
   context: "workspaceMembersActions.revokeInviteActionInput"
 });
 
-const workspaceMembersActionSpecifications = Object.freeze([
-  {
-    id: "workspace.roles.list",
-    version: 1,
-    kind: "query",
-    channels: ["api", "automation", "internal"],
-    surfaces: ["*"],
-    permission: {
-      require: "all",
-      permissions: ["workspace.roles.view"]
-    },
-    input: workspaceSlugParamsValidator,
-    output: null,
-    extensions: {
-      assistant: {
-        description: "List the active workspace roles and assignable permissions.",
-        output: workspaceMembersResource.operations.rolesList.output,
-        transformResult: (result) => result.value
-      }
-    },
-    idempotency: "none",
-    async run(workspaceMembersService, _input, context) {
-      return returnJsonApiData(await workspaceMembersService.listRoles({ context }));
-    }
-  },
-  {
-    id: "workspace.members.list",
-    version: 1,
-    kind: "query",
-    channels: ["api", "automation", "internal"],
-    surfaces: ["*"],
-    permission: {
-      require: "all",
-      permissions: ["workspace.members.view"]
-    },
-    input: workspaceSlugParamsValidator,
-    output: null,
-    extensions: {
-      assistant: {
-        description: "List members of the active workspace.",
-        output: workspaceMembersResource.operations.membersList.output,
-        transformResult: (result) => result.value
-      }
-    },
-    idempotency: "none",
-    async run(workspaceMembersService, input, context) {
-      return returnJsonApiData(await workspaceMembersService.listMembers(resolveWorkspace(context, input), {
-        context
-      }));
-    }
-  },
-  {
-    id: "workspace.member.role.update",
-    version: 1,
-    kind: "command",
-    channels: ["api", "automation", "internal"],
-    surfaces: ["*"],
-    permission: {
-      require: "all",
-      permissions: ["workspace.members.manage"]
-    },
-    input: updateMemberRoleActionInput,
-    output: null,
-    extensions: {
-      assistant: {
-        description: "Change a member’s role in the active workspace.",
-        output: workspaceMembersResource.operations.updateMemberRole.output,
-        transformResult: (result) => result.value
-      }
-    },
-    idempotency: "optional",
-    events: WORKSPACE_MEMBER_CHANGED_EVENTS,
-    async run(workspaceMembersService, input, context) {
-      return returnJsonApiData(await workspaceMembersService.updateMemberRole(resolveWorkspace(context, input), {
-        memberUserId: input.memberUserId,
-        roleSid: input.roleSid
-      }, {
-        context
-      }));
-    }
-  },
-  {
-    id: "workspace.member.remove",
-    version: 1,
-    kind: "command",
-    channels: ["api", "automation", "internal"],
-    surfaces: ["*"],
-    permission: {
-      require: "all",
-      permissions: ["workspace.members.manage"]
-    },
-    input: removeMemberActionInput,
-    output: null,
-    extensions: {
-      assistant: {
-        description: "Remove a member from the active workspace.",
-        output: workspaceMembersResource.operations.removeMember.output,
-        transformResult: (result) => result.value
-      }
-    },
-    idempotency: "optional",
-    events: WORKSPACE_MEMBER_CHANGED_EVENTS,
-    async run(workspaceMembersService, input, context) {
-      return returnJsonApiData(await workspaceMembersService.removeMember(resolveWorkspace(context, input), {
-        memberUserId: input.memberUserId
-      }, {
-        context
-      }));
-    }
-  },
-  {
-    id: "workspace.invites.list",
-    version: 1,
-    kind: "query",
-    channels: ["api", "automation", "internal"],
-    surfaces: ["*"],
-    permission: {
-      require: "all",
-      permissions: ["workspace.members.view"]
-    },
-    input: workspaceSlugParamsValidator,
-    output: null,
-    extensions: {
-      assistant: {
-        description: "List invitations for the active workspace without invitation tokens.",
-        output: workspaceMembersResource.operations.invitesList.output,
-        transformResult: (result) => result.value
-      }
-    },
-    idempotency: "none",
-    async run(workspaceMembersService, input, context) {
-      return returnJsonApiData(await workspaceMembersService.listInvites(resolveWorkspace(context, input), {
-        context
-      }));
-    }
-  },
-  {
-    id: "workspace.invite.create",
-    version: 1,
-    kind: "command",
-    channels: ["api", "assistant_tool", "automation", "internal"],
-    surfaces: ["*"],
-    permission: {
-      require: "all",
-      permissions: ["workspace.members.invite"]
-    },
-    input: createInviteActionInput,
-    output: null,
-    extensions: {
-      assistant: {
-        description: "Invite a person to the active workspace and report delivery status without exposing invitation links.",
-        output: workspaceInviteAssistantOutput,
-        transformResult: (result) => ({
-          createdInviteId: result.value.createdInviteId,
-          invites: result.value.invites.map(({ id, email, roleSid, status, expiresAt }) =>
-            ({ id, email, roleSid, status, expiresAt })),
-          deliveryStatus: result.value.inviteDelivery.status
-        })
-      }
-    },
-    idempotency: "optional",
-    events: WORKSPACE_INVITE_CREATED_EVENTS,
-    async run(workspaceMembersService, input, context) {
-      return returnJsonApiData(await workspaceMembersService.createInvite(
+/** @param {{ workspaceMembersService: import("../types.js").WorkspaceMembersService }} dependencies */
+function createWorkspaceMembersActions({ workspaceMembersService }) {
+  return Object.freeze([
+    Object.freeze({
+      id: "workspace.roles.list",
+      version: 1,
+      kind: "query",
+      channels: ["api", "automation", "internal"],
+      surfaces: ["*"],
+      permission: {
+        require: "all",
+        permissions: ["workspace.roles.view"]
+      },
+      input: workspaceSlugParamsValidator,
+      output: null,
+      extensions: {
+        assistant: {
+          description: "List the active workspace roles and assignable permissions.",
+          output: workspaceMembersResource.operations.rolesList.output,
+          transformResult: (result) => result.value
+        }
+      },
+      execute: () => workspaceMembersService.listRolesResponse()
+    }),
+    Object.freeze({
+      id: "workspace.members.list",
+      version: 1,
+      kind: "query",
+      channels: ["api", "automation", "internal"],
+      surfaces: ["*"],
+      permission: {
+        require: "all",
+        permissions: ["workspace.members.view"]
+      },
+      input: workspaceSlugParamsValidator,
+      output: null,
+      extensions: {
+        assistant: {
+          description: "List members of the active workspace.",
+          output: workspaceMembersResource.operations.membersList.output,
+          transformResult: (result) => result.value
+        }
+      },
+      execute: (input, context) => workspaceMembersService.listMembersResponse(
+        resolveWorkspace(context, input),
+        { context }
+      )
+    }),
+    Object.freeze({
+      id: "workspace.member.role.update",
+      version: 1,
+      kind: "command",
+      channels: ["api", "automation", "internal"],
+      surfaces: ["*"],
+      permission: {
+        require: "all",
+        permissions: ["workspace.members.manage"]
+      },
+      input: updateMemberRoleActionInput,
+      output: null,
+      extensions: {
+        assistant: {
+          description: "Change a member’s role in the active workspace.",
+          output: workspaceMembersResource.operations.updateMemberRole.output,
+          transformResult: (result) => result.value
+        }
+      },
+      events: WORKSPACE_MEMBER_CHANGED_EVENTS,
+      execute: (input, context) => workspaceMembersService.updateMemberRole(
+        resolveWorkspace(context, input),
+        input,
+        { context }
+      )
+    }),
+    Object.freeze({
+      id: "workspace.member.remove",
+      version: 1,
+      kind: "command",
+      channels: ["api", "automation", "internal"],
+      surfaces: ["*"],
+      permission: {
+        require: "all",
+        permissions: ["workspace.members.manage"]
+      },
+      input: removeMemberActionInput,
+      output: null,
+      extensions: {
+        assistant: {
+          description: "Remove a member from the active workspace.",
+          output: workspaceMembersResource.operations.removeMember.output,
+          transformResult: (result) => result.value
+        }
+      },
+      events: WORKSPACE_MEMBER_CHANGED_EVENTS,
+      execute: (input, context) => workspaceMembersService.removeMember(
+        resolveWorkspace(context, input),
+        input,
+        { context }
+      )
+    }),
+    Object.freeze({
+      id: "workspace.invites.list",
+      version: 1,
+      kind: "query",
+      channels: ["api", "automation", "internal"],
+      surfaces: ["*"],
+      permission: {
+        require: "all",
+        permissions: ["workspace.members.view"]
+      },
+      input: workspaceSlugParamsValidator,
+      output: null,
+      extensions: {
+        assistant: {
+          description: "List invitations for the active workspace without invitation tokens.",
+          output: workspaceMembersResource.operations.invitesList.output,
+          transformResult: (result) => result.value
+        }
+      },
+      execute: (input, context) => workspaceMembersService.listInvitesResponse(
+        resolveWorkspace(context, input),
+        { context }
+      )
+    }),
+    Object.freeze({
+      id: "workspace.invite.create",
+      version: 1,
+      kind: "command",
+      channels: ["api", "assistant_tool", "automation", "internal"],
+      surfaces: ["*"],
+      permission: {
+        require: "all",
+        permissions: ["workspace.members.invite"]
+      },
+      input: createInviteActionInput,
+      output: null,
+      extensions: {
+        assistant: {
+          description: "Invite a person to the active workspace and report delivery status without exposing invitation links.",
+          output: workspaceInviteAssistantOutput,
+          transformResult: (result) => ({
+            createdInviteId: result.value.createdInviteId,
+            invites: result.value.invites.map(({ id, email, roleSid, status, expiresAt }) =>
+              ({ id, email, roleSid, status, expiresAt })),
+            deliveryStatus: result.value.inviteDelivery.status
+          })
+        }
+      },
+      events: WORKSPACE_INVITE_CREATED_EVENTS,
+      execute: (input, context) => workspaceMembersService.createInvite(
         resolveWorkspace(context, input),
         resolveActionUser(context, input),
-        {
-          email: input.email,
-          roleSid: input.roleSid
-        },
-        {
-          context
+        input,
+        { context }
+      )
+    }),
+    Object.freeze({
+      id: "workspace.invite.revoke",
+      version: 1,
+      kind: "command",
+      channels: ["api", "automation", "internal"],
+      surfaces: ["*"],
+      permission: {
+        require: "all",
+        permissions: ["workspace.invites.revoke"]
+      },
+      input: revokeInviteActionInput,
+      output: null,
+      extensions: {
+        assistant: {
+          description: "Revoke an invitation to the active workspace.",
+          output: workspaceMembersResource.operations.revokeInvite.output,
+          transformResult: (result) => result.value
         }
-      ));
-    }
-  },
-  {
-    id: "workspace.invite.revoke",
-    version: 1,
-    kind: "command",
-    channels: ["api", "automation", "internal"],
-    surfaces: ["*"],
-    permission: {
-      require: "all",
-      permissions: ["workspace.invites.revoke"]
-    },
-    input: revokeInviteActionInput,
-    output: null,
-    extensions: {
-      assistant: {
-        description: "Revoke an invitation to the active workspace.",
-        output: workspaceMembersResource.operations.revokeInvite.output,
-        transformResult: (result) => result.value
-      }
-    },
-    idempotency: "optional",
-    events: WORKSPACE_INVITE_REVOKED_EVENTS,
-    async run(workspaceMembersService, input, context) {
-      return returnJsonApiData(await workspaceMembersService.revokeInvite(resolveWorkspace(context, input), input.inviteId, {
-        context
-      }));
-    }
-  }
-]);
-
-function buildWorkspaceMembersActions({ workspaceMembersService } = {}) {
-  if (!workspaceMembersService) throw new TypeError("buildWorkspaceMembersActions requires workspaceMembersService.");
-  return workspaceMembersActionSpecifications.map(({ run, ...definition }) => Object.freeze({
-    ...definition,
-    execute(input, context) {
-      return run(workspaceMembersService, input, context);
-    }
-  }));
+      },
+      events: WORKSPACE_INVITE_REVOKED_EVENTS,
+      execute: (input, context) => workspaceMembersService.revokeInvite(
+        resolveWorkspace(context, input),
+        input.inviteId,
+        { context }
+      )
+    })
+  ]);
 }
 
-export { workspaceMembersActionSpecifications, buildWorkspaceMembersActions };
+export { createWorkspaceMembersActions };

package/src/server/workspaceMembers/{bootWorkspaceMembers.js → workspaceMembersRoutes.js}

@@ -7,31 +7,19 @@ import {
   WORKSPACE_ROLE_CATALOG_TRANSPORT
 } from "../../shared/jsonApiTransports.js";
 import { workspaceMembersResource } from "../../shared/resources/workspaceMembersResource.js";
-import { resolveWorkspaceRoutePath } from "../common/support/workspaceRoutePaths.js";
+import { resolveWorkspaceRecordId } from "../common/support/workspaceRecordId.js";
+import { resolveWorkspaceRoutePath } from "../support/workspaceRoutePaths.js";
 import {
   routeParamsValidator,
   workspaceSlugParamsValidator
 } from "../common/validators/routeParamsValidator.js";
 import { resolveDefaultWorkspaceRouteSurfaceIdFromAppConfig } from "../support/workspaceActionSurfaces.js";
 
-function resolveWorkspaceAggregateRecordId(record = {}, context = {}) {
-  const workspaceId = record?.workspace?.id;
-  if (workspaceId != null && String(workspaceId).trim()) {
-    return workspaceId;
-  }
-
-  const workspaceSlug = context?.request?.params?.workspaceSlug;
-  if (workspaceSlug != null && String(workspaceSlug).trim()) {
-    return workspaceSlug;
-  }
-
-  throw new Error("Workspace JSON:API response requires workspace id.");
-}
-
-function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitationsEnabled = false } = {}) {
-  if (!router || typeof router.register !== "function") {
-    throw new TypeError("registerWorkspaceMembersRoutes requires router.register().");
-  }
+/**
+ * @param {import("@jskit-ai/kernel/server/types").RuntimeRouter} router
+ * @param {{ config: import("@jskit-ai/kernel/server/types").RuntimeConfig, workspaceInvitationsEnabled: boolean }} options
+ */
+function registerWorkspaceMembersRoutes(router, { config, workspaceInvitationsEnabled }) {
   const workspaceRouteSurfaceId = resolveDefaultWorkspaceRouteSurfaceIdFromAppConfig(config);
 
   router.register(
@@ -51,7 +39,7 @@ function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitati
         ...WORKSPACE_ROLE_CATALOG_TRANSPORT,
         output: workspaceMembersResource.operations.rolesList.output,
         outputKind: "record",
-        getRecordId: resolveWorkspaceAggregateRecordId
+        getRecordId: resolveWorkspaceRecordId
       })
     },
     async function (request, reply) {
@@ -82,7 +70,7 @@ function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitati
         ...WORKSPACE_MEMBERS_TRANSPORT,
         output: workspaceMembersResource.operations.membersList.output,
         outputKind: "record",
-        getRecordId: resolveWorkspaceAggregateRecordId
+        getRecordId: resolveWorkspaceRecordId
       })
     },
     async function (request, reply) {
@@ -114,7 +102,7 @@ function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitati
         body: workspaceMembersResource.operations.updateMemberRole.body,
         output: workspaceMembersResource.operations.updateMemberRole.output,
         outputKind: "record",
-        getRecordId: resolveWorkspaceAggregateRecordId,
+        getRecordId: resolveWorkspaceRecordId,
         includeValidation400: true
       })
     },
@@ -148,7 +136,7 @@ function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitati
         ...WORKSPACE_MEMBERS_TRANSPORT,
         output: workspaceMembersResource.operations.removeMember.output,
         outputKind: "record",
-        getRecordId: resolveWorkspaceAggregateRecordId
+        getRecordId: resolveWorkspaceRecordId
       })
     },
     async function (request, reply) {
@@ -181,7 +169,7 @@ function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitati
           ...WORKSPACE_INVITES_TRANSPORT,
           output: workspaceMembersResource.operations.invitesList.output,
           outputKind: "record",
-          getRecordId: resolveWorkspaceAggregateRecordId
+          getRecordId: resolveWorkspaceRecordId
         })
       },
       async function (request, reply) {
@@ -213,7 +201,7 @@ function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitati
           body: workspaceMembersResource.operations.createInvite.body,
           output: workspaceMembersResource.operations.createInvite.output,
           outputKind: "record",
-          getRecordId: resolveWorkspaceAggregateRecordId,
+          getRecordId: resolveWorkspaceRecordId,
           includeValidation400: true
         })
       },
@@ -247,7 +235,7 @@ function registerWorkspaceMembersRoutes(router, { config = {}, workspaceInvitati
           ...WORKSPACE_INVITES_TRANSPORT,
           output: workspaceMembersResource.operations.revokeInvite.output,
           outputKind: "record",
-          getRecordId: resolveWorkspaceAggregateRecordId
+          getRecordId: resolveWorkspaceRecordId
         })
       },
       async function (request, reply) {