@~lyre/auth 0.4.0 → 0.6.0

package/dist/admin.d.ts

@@ -69,12 +69,41 @@ interface InviteResult {
     userGroupId?: string | null;
     [key: string]: unknown;
 }
+/**
+ * A profile field an app collects about a user — the spec a consumer renders a form input from.
+ * Mirrors Accounts' `fields` registry, so a consumer never hardcodes one app's idea of a person.
+ */
+interface ProfileFieldSpec {
+    id: string;
+    fieldName: string;
+    label: string;
+    fieldType: string;
+    required: boolean;
+    hidden: boolean;
+    enumValues: string[] | null;
+    inputPrefix: string | null;
+    validationRegex: string | null;
+    validationMessage: string | null;
+    displayOrder: number;
+}
+/** Whether an email can be invited to an app. See `checkInviteEmail`. */
+interface InviteEmailCheck {
+    email: string;
+    /** `member` = already has app access; `invited` = a live invite exists; `available` = go ahead. */
+    state: 'member' | 'invited' | 'available';
+    /** Whether an Accounts user already exists for this address (they keep their own profile). */
+    hasAccount: boolean;
+    /** When the pending invite lapses — only for `invited`. */
+    expiresAt?: string;
+}
 /** A pending (not yet accepted, not yet expired) app invitation. */
 interface PendingInvite {
     id: string;
     email: string;
     /** The workspace the invitee joins on acceptance; null for a group-less invite. */
     userGroupId: string | null;
+    /** Values captured on the invite form, keyed by field name. Prefills the accept form. */
+    profileData?: Record<string, string>;
     createdAt: string;
     expiresAt: string;
     /** The inviter's email, when still resolvable. */
@@ -132,11 +161,49 @@ declare class AccountsAdmin {
     inviteToApp(appSlug: string, input: {
         email: string;
         userGroupId?: string | null;
+        /** Profile values from the invite form, keyed by field name (see `listAppProfileFields`).
+         *  Accounts drops any key the app does not collect, so authorization-shaped values
+         *  (role, assignability) can never be set from here. */
+        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.
+     */
+    listAppProfileFields(appSlug: string): 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>;
+    /**
+     * 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`). */
@@ -203,4 +270,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 InviteResult, type ListUsersQuery, type ListUsersResult, type PendingInvite, 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, createAccountsAdmin };

package/dist/admin.js

@@ -79,6 +79,56 @@ var AccountsAdmin = class {
       body: input
     });
   }
+  /**
+   * 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.
+   */
+  async listAppProfileFields(appSlug) {
+    const data = await this.request(
+      "GET",
+      `/api/auth/apps/${encodeURIComponent(appSlug)}/profile-fields`,
+      { auth: "session" }
+    );
+    return data.fields ?? [];
+  }
+  /**
+   * 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.
+   */
+  async checkInviteEmail(appSlug, email) {
+    return this.request(
+      "GET",
+      `/api/auth/apps/${encodeURIComponent(appSlug)}/invites/lookup?email=${encodeURIComponent(email)}`,
+      { auth: "session" }
+    );
+  }
+  /**
+   * 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(
@@ -96,6 +146,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.4.0",
+	"version": "0.6.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,