@~lyre/auth 0.5.0 → 0.7.0

package/dist/admin.d.ts

@@ -96,6 +96,14 @@ interface InviteEmailCheck {
     /** When the pending invite lapses — only for `invited`. */
     expiresAt?: string;
 }
+/** A workspace (user_group) with its app-scoped profile values. */
+interface WorkspaceProfile {
+    id: string;
+    slug: string;
+    displayName: string;
+    /** App-scoped values keyed by field name — e.g. `support_email`. Empty when no app was scoped. */
+    profileData: Record<string, string>;
+}
 /** A pending (not yet accepted, not yet expired) app invitation. */
 interface PendingInvite {
     id: string;
@@ -167,20 +175,65 @@ declare class AccountsAdmin {
         profileData?: Record<string, string> | null;
     }): Promise<InviteResult>;
     /**
-     * The profile fields this app collects about a user — the spec to render an invite form from.
-     * Session-authed. Never includes email: that is the invite's identity, not a profile value.
+     * The profile fields this app collects about a SUBJECT — the spec to render a form from.
+     * `ownerType: 'user'` (default) is what an invite form collects about a person; `'user_group'` is
+     * what a workspace's edit form collects about itself. Session-authed. A user's email is never
+     * included: that is identity, not a profile value.
      */
-    listAppProfileFields(appSlug: string): Promise<ProfileFieldSpec[]>;
+    listAppProfileFields(appSlug: string, ownerType?: 'user' | 'user_group'): Promise<ProfileFieldSpec[]>;
     /**
      * Whether an email can be invited — for a live check on an invite form, so the inviter learns
      * BEFORE submitting that someone is already a member or already invited. Email only, exact match.
      * Session-authed.
      */
     checkInviteEmail(appSlug: string, email: string): Promise<InviteEmailCheck>;
+    /**
+     * A workspace's own details — name plus its app-scoped profile values (support email, …).
+     * Service-key authed (`stats:read`). Pass `appId` to scope the profile values.
+     *
+     * Workspace details live in Accounts, which owns the group. Consumers previously had no way to
+     * read them and fell back to a retiring legacy system's copy.
+     */
+    getUserGroup(groupId: string, opts?: {
+        appId?: string;
+    }): Promise<WorkspaceProfile>;
+    /**
+     * Update a workspace's name and/or its app-scoped profile values. Service-key authed
+     * (`users:write`). An empty profile value CLEARS that field rather than storing an empty string.
+     * Accounts drops any key the app does not declare for `user_group`.
+     */
+    updateUserGroup(groupId: string, input: {
+        displayName?: string;
+        profileData?: Record<string, string>;
+        appId?: string;
+    }): Promise<WorkspaceProfile>;
+    /**
+     * Add a user to a workspace group. Service-key authed (`users:write`).
+     *
+     * Membership was read-only over the API, which is why "reactivate user" had to fall back to
+     * re-INVITING an existing colleague. Use this to restore membership instead.
+     */
+    addGroupMember(groupId: string, userId: string, opts?: {
+        role?: string;
+    }): Promise<void>;
+    /**
+     * Remove a user from a workspace group. Service-key authed (`users:write`). Idempotent.
+     *
+     * Removing a user's APP access does NOT remove their group membership, and the members list
+     * reads membership — so without this a "deleted" user keeps reappearing in the workspace.
+     */
+    removeGroupMember(groupId: string, userId: string): Promise<void>;
     /** Revoke a pending invite (withdraw one sent in error). Session-authed. */
     revokeAppInvite(appSlug: string, inviteId: string): Promise<void>;
     /** Everyone with access to an app. Session-authed. */
     listAppUsers(appSlug: string): Promise<AppMember[]>;
+    /**
+     * Restore an existing user's access to an app. Session-authed. Idempotent.
+     *
+     * The counterpart to `removeAppUser`. Distinct from `inviteToApp`: this is for an account that
+     * already exists and already consented, so it must NOT put the person through registration again.
+     */
+    addAppUser(appSlug: string, userId: string): Promise<void>;
     /** Revoke a user's access to an app. Session-authed. */
     removeAppUser(appSlug: string, userId: string): Promise<void>;
     /** Members of a user_group (the workspace's agents). Service-key authed (`stats:read`). */
@@ -247,4 +300,4 @@ declare class AccountsAdmin {
 /** Convenience factory mirroring the SDK's other `create*` helpers. */
 declare function createAccountsAdmin(opts: AccountsAdminOptions): AccountsAdmin;
 
-export { AccountsAdmin, AccountsAdminError, type AccountsAdminOptions, type AccountsUser, type AppMember, type ChangePasswordResult, type GroupMember, type InviteEmailCheck, type InviteResult, type ListUsersQuery, type ListUsersResult, type PendingInvite, type ProfileFieldSpec, createAccountsAdmin };
+export { AccountsAdmin, AccountsAdminError, type AccountsAdminOptions, type AccountsUser, type AppMember, type ChangePasswordResult, type GroupMember, type InviteEmailCheck, type InviteResult, type ListUsersQuery, type ListUsersResult, type PendingInvite, type ProfileFieldSpec, type WorkspaceProfile, createAccountsAdmin };

package/dist/admin.js

@@ -80,13 +80,16 @@ var AccountsAdmin = class {
     });
   }
   /**
-   * The profile fields this app collects about a user — the spec to render an invite form from.
-   * Session-authed. Never includes email: that is the invite's identity, not a profile value.
+   * The profile fields this app collects about a SUBJECT — the spec to render a form from.
+   * `ownerType: 'user'` (default) is what an invite form collects about a person; `'user_group'` is
+   * what a workspace's edit form collects about itself. Session-authed. A user's email is never
+   * included: that is identity, not a profile value.
    */
-  async listAppProfileFields(appSlug) {
+  async listAppProfileFields(appSlug, ownerType = "user") {
+    const suffix = ownerType === "user_group" ? "?ownerType=user_group" : "";
     const data = await this.request(
       "GET",
-      `/api/auth/apps/${encodeURIComponent(appSlug)}/profile-fields`,
+      `/api/auth/apps/${encodeURIComponent(appSlug)}/profile-fields${suffix}`,
       { auth: "session" }
     );
     return data.fields ?? [];
@@ -103,6 +106,59 @@ var AccountsAdmin = class {
       { auth: "session" }
     );
   }
+  /**
+   * A workspace's own details — name plus its app-scoped profile values (support email, …).
+   * Service-key authed (`stats:read`). Pass `appId` to scope the profile values.
+   *
+   * Workspace details live in Accounts, which owns the group. Consumers previously had no way to
+   * read them and fell back to a retiring legacy system's copy.
+   */
+  async getUserGroup(groupId, opts = {}) {
+    const suffix = opts.appId ? `?appId=${encodeURIComponent(opts.appId)}` : "";
+    return this.request(
+      "GET",
+      `/api/auth/user-groups/${encodeURIComponent(groupId)}${suffix}`,
+      { auth: "key" }
+    );
+  }
+  /**
+   * Update a workspace's name and/or its app-scoped profile values. Service-key authed
+   * (`users:write`). An empty profile value CLEARS that field rather than storing an empty string.
+   * Accounts drops any key the app does not declare for `user_group`.
+   */
+  async updateUserGroup(groupId, input) {
+    return this.request(
+      "PATCH",
+      `/api/auth/user-groups/${encodeURIComponent(groupId)}`,
+      { auth: "key", body: input }
+    );
+  }
+  /**
+   * Add a user to a workspace group. Service-key authed (`users:write`).
+   *
+   * Membership was read-only over the API, which is why "reactivate user" had to fall back to
+   * re-INVITING an existing colleague. Use this to restore membership instead.
+   */
+  async addGroupMember(groupId, userId, opts = {}) {
+    await this.request(
+      "POST",
+      `/api/auth/user-groups/${encodeURIComponent(groupId)}/members`,
+      { auth: "key", body: { userId, ...opts.role ? { role: opts.role } : {} } }
+    );
+  }
+  /**
+   * Remove a user from a workspace group. Service-key authed (`users:write`). Idempotent.
+   *
+   * Removing a user's APP access does NOT remove their group membership, and the members list
+   * reads membership — so without this a "deleted" user keeps reappearing in the workspace.
+   */
+  async removeGroupMember(groupId, userId) {
+    await this.request(
+      "DELETE",
+      `/api/auth/user-groups/${encodeURIComponent(groupId)}/members?userId=${encodeURIComponent(userId)}`,
+      { auth: "key" }
+    );
+  }
   /** Revoke a pending invite (withdraw one sent in error). Session-authed. */
   async revokeAppInvite(appSlug, inviteId) {
     await this.request(
@@ -120,6 +176,19 @@ var AccountsAdmin = class {
     );
     return data.users ?? [];
   }
+  /**
+   * Restore an existing user's access to an app. Session-authed. Idempotent.
+   *
+   * The counterpart to `removeAppUser`. Distinct from `inviteToApp`: this is for an account that
+   * already exists and already consented, so it must NOT put the person through registration again.
+   */
+  async addAppUser(appSlug, userId) {
+    await this.request(
+      "POST",
+      `/api/auth/apps/${encodeURIComponent(appSlug)}/users`,
+      { auth: "session", body: { userId } }
+    );
+  }
   /** Revoke a user's access to an app. Session-authed. */
   async removeAppUser(appSlug, userId) {
     await this.request(

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@~lyre/auth",
-	"version": "0.5.0",
+	"version": "0.7.0",
 	"description": "Shared Axis Accounts auth SDK \u2014 framework-agnostic session/identity core (HMAC-signed cookies, accounts login/callback/logout) plus an optional turnkey SvelteKit adapter.",
 	"type": "module",
 	"sideEffects": false,