@meetreeve/module-team 0.0.0-stage → 0.3.0

package/dist/config/index.d.mts

@@ -0,0 +1,159 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+/**
+ * Roles the org-members router knows. `billing_manager` is a legacy alias
+ * the backend still accepts; no surface offers it from the invite dialog.
+ * Rows may still carry a role this union doesn't name, so row fields are
+ * typed `string` and the panel renders unknown roles verbatim.
+ */
+type TeamRole = "owner" | "admin" | "billing_manager" | "member" | "viewer";
+/** A role the invite dialog and the role picker can hand out (never `owner`). */
+type AssignableRole = Exclude<TeamRole, "owner" | "billing_manager">;
+/** One live member of the org (`OrganizationMember` row). `GET /api/org/members`. */
+interface TeamMember {
+    /** OrganizationMember.id — the id every member route takes. */
+    id: string;
+    user_id: string;
+    email: string | null;
+    role: string;
+    is_default: boolean;
+    /** ISO-8601. */
+    created_at: string;
+}
+/** One invitation record. `GET /api/org/invitations`. */
+interface Invitation {
+    id: string;
+    email: string;
+    role: string;
+    invited_by_email: string | null;
+    /** pending | accepted | expired | revoked */
+    status: string;
+    /** ISO-8601. */
+    created_at: string;
+    /** ISO-8601. */
+    expires_at: string;
+    accepted_at: string | null;
+    /**
+     * Spaces the invitee joins on accept (DEV-15988 / reeve-services DEV-15559).
+     * The backend always sends it; optional so a backend that predates it
+     * still type-checks as "no pre-set spaces".
+     */
+    spaces?: InvitationSpace[];
+}
+/** A space role. */
+type SpaceRole = "member" | "admin";
+/** One pre-set space on an invitation (`GET /api/org/invitations` item). */
+interface InvitationSpace {
+    id: string;
+    name: string;
+    role: SpaceRole;
+}
+/** One space an invite (or a pending invitation) should land the invitee in. */
+interface InviteSpace {
+    space_id: string;
+    role: SpaceRole;
+}
+/**
+ * One of the org's spaces, as the invite dialog's Spaces picker lists it
+ * (reeve-frontend maps `GET /api/org/rbac/spaces` onto this). Every space is
+ * offered, the default one included: nobody joins a space automatically
+ * (DEV-16808). `can_manage: false` rows are shown disabled.
+ */
+interface SpaceOption {
+    id: string;
+    name: string;
+    kind?: string;
+    is_default: boolean;
+    can_manage: boolean;
+}
+/** `POST /api/org/invite`. */
+interface InviteMemberResponse {
+    message: string;
+    email: string;
+    role: string;
+    invitation_id?: string;
+}
+/**
+ * The data-access boundary the panel is built against. Every method takes
+ * the org it acts on: there is no ambient "current org" anywhere in this
+ * package, so a request can never be issued for an org other than the one
+ * the caller named (DEV-8592). `createTeamClient` is the reference
+ * implementation; a host may supply its own.
+ */
+interface TeamClient {
+    listMembers(orgId: string): Promise<TeamMember[]>;
+    updateMemberRole(orgId: string, memberId: string, role: string): Promise<void>;
+    removeMember(orgId: string, memberId: string): Promise<void>;
+    /**
+     * `spaces` goes in the body whenever it is passed, `[]` included (a
+     * one-space org sends `[]`, DEV-16808); omitted keeps the pre-DEV-15988
+     * request.
+     */
+    inviteMember(orgId: string, email: string, role: string, spaces?: InviteSpace[]): Promise<InviteMemberResponse>;
+    listInvitations(orgId: string): Promise<Invitation[]>;
+    revokeInvitation(orgId: string, invitationId: string): Promise<void>;
+    resendInvitation(orgId: string, invitationId: string): Promise<void>;
+}
+
+type TeamNotice = {
+    kind: "success" | "error";
+    message: string;
+};
+/** What `renderInvitationActions` gets besides the invitation. */
+interface InvitationActionHelpers {
+    /** Refetch members and invitations, as Resend does after it lands. */
+    reload: () => Promise<void>;
+}
+interface TeamMembersPanelProps {
+    /**
+     * Data access. `createTeamClient({ fetch })` from `@meetreeve/module-team/client`.
+     * Pass a stable instance (module scope or `useMemo`): a new client refetches.
+     */
+    client: TeamClient;
+    /**
+     * The org whose team this panel shows. Required: every request is issued
+     * for this org, and changing it resets the panel (DEV-8592).
+     */
+    orgId: string;
+    /**
+     * Roles the invite dialog AND the per-member role picker offer, in order.
+     * Default admin/member/viewer. The operator cockpit (DEV-2439) passes
+     * `["admin", "member"]`.
+     */
+    inviteRoles?: AssignableRole[];
+    /**
+     * The signed-in user's email: marks their row "you", and that row's role
+     * decides which role changes the picker offers (DEV-18190). Without it, or
+     * when no member matches, every role shows as a plain label.
+     */
+    currentUserEmail?: string | null;
+    /**
+     * Host-owned per-member controls (Studio's Budget / Capabilities dialogs).
+     * Rendered at the end of every member row, owners included; the host
+     * decides per member what to show.
+     */
+    renderMemberActions?: (member: TeamMember) => ReactNode;
+    /**
+     * Host-owned per-invitation controls, rendered next to Resend / Revoke on
+     * every pending invitation. Call `reload` after a change the row shows.
+     */
+    renderInvitationActions?: (invitation: Invitation, helpers: InvitationActionHelpers) => ReactNode;
+    /**
+     * The org's spaces for the invite dialog's Spaces picker. When omitted the
+     * dialog has no picker and invites go out exactly as before. Called each
+     * time the dialog opens; until it answers, the invite is held, since an org
+     * with several spaces refuses an invite that names none (422
+     * `spaces_required`).
+     */
+    loadSpaceOptions?: () => Promise<SpaceOption[]>;
+    /** Called with every success/error notice the panel shows inline. */
+    onNotice?: (notice: TeamNotice) => void;
+}
+/**
+ * Keyed on `orgId`: an org change remounts the body, which is what resets
+ * every piece of per-org state at once — no reset effect to forget.
+ */
+declare function TeamMembersPanel(props: TeamMembersPanelProps): react.JSX.Element;
+
+export { type AssignableRole, type Invitation, type InvitationActionHelpers, type InvitationSpace, type InviteMemberResponse, type InviteSpace, type SpaceOption, type SpaceRole, type TeamClient, type TeamMember, TeamMembersPanel, type TeamMembersPanelProps, type TeamNotice, type TeamRole };

package/dist/config/index.d.ts

@@ -0,0 +1,159 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+/**
+ * Roles the org-members router knows. `billing_manager` is a legacy alias
+ * the backend still accepts; no surface offers it from the invite dialog.
+ * Rows may still carry a role this union doesn't name, so row fields are
+ * typed `string` and the panel renders unknown roles verbatim.
+ */
+type TeamRole = "owner" | "admin" | "billing_manager" | "member" | "viewer";
+/** A role the invite dialog and the role picker can hand out (never `owner`). */
+type AssignableRole = Exclude<TeamRole, "owner" | "billing_manager">;
+/** One live member of the org (`OrganizationMember` row). `GET /api/org/members`. */
+interface TeamMember {
+    /** OrganizationMember.id — the id every member route takes. */
+    id: string;
+    user_id: string;
+    email: string | null;
+    role: string;
+    is_default: boolean;
+    /** ISO-8601. */
+    created_at: string;
+}
+/** One invitation record. `GET /api/org/invitations`. */
+interface Invitation {
+    id: string;
+    email: string;
+    role: string;
+    invited_by_email: string | null;
+    /** pending | accepted | expired | revoked */
+    status: string;
+    /** ISO-8601. */
+    created_at: string;
+    /** ISO-8601. */
+    expires_at: string;
+    accepted_at: string | null;
+    /**
+     * Spaces the invitee joins on accept (DEV-15988 / reeve-services DEV-15559).
+     * The backend always sends it; optional so a backend that predates it
+     * still type-checks as "no pre-set spaces".
+     */
+    spaces?: InvitationSpace[];
+}
+/** A space role. */
+type SpaceRole = "member" | "admin";
+/** One pre-set space on an invitation (`GET /api/org/invitations` item). */
+interface InvitationSpace {
+    id: string;
+    name: string;
+    role: SpaceRole;
+}
+/** One space an invite (or a pending invitation) should land the invitee in. */
+interface InviteSpace {
+    space_id: string;
+    role: SpaceRole;
+}
+/**
+ * One of the org's spaces, as the invite dialog's Spaces picker lists it
+ * (reeve-frontend maps `GET /api/org/rbac/spaces` onto this). Every space is
+ * offered, the default one included: nobody joins a space automatically
+ * (DEV-16808). `can_manage: false` rows are shown disabled.
+ */
+interface SpaceOption {
+    id: string;
+    name: string;
+    kind?: string;
+    is_default: boolean;
+    can_manage: boolean;
+}
+/** `POST /api/org/invite`. */
+interface InviteMemberResponse {
+    message: string;
+    email: string;
+    role: string;
+    invitation_id?: string;
+}
+/**
+ * The data-access boundary the panel is built against. Every method takes
+ * the org it acts on: there is no ambient "current org" anywhere in this
+ * package, so a request can never be issued for an org other than the one
+ * the caller named (DEV-8592). `createTeamClient` is the reference
+ * implementation; a host may supply its own.
+ */
+interface TeamClient {
+    listMembers(orgId: string): Promise<TeamMember[]>;
+    updateMemberRole(orgId: string, memberId: string, role: string): Promise<void>;
+    removeMember(orgId: string, memberId: string): Promise<void>;
+    /**
+     * `spaces` goes in the body whenever it is passed, `[]` included (a
+     * one-space org sends `[]`, DEV-16808); omitted keeps the pre-DEV-15988
+     * request.
+     */
+    inviteMember(orgId: string, email: string, role: string, spaces?: InviteSpace[]): Promise<InviteMemberResponse>;
+    listInvitations(orgId: string): Promise<Invitation[]>;
+    revokeInvitation(orgId: string, invitationId: string): Promise<void>;
+    resendInvitation(orgId: string, invitationId: string): Promise<void>;
+}
+
+type TeamNotice = {
+    kind: "success" | "error";
+    message: string;
+};
+/** What `renderInvitationActions` gets besides the invitation. */
+interface InvitationActionHelpers {
+    /** Refetch members and invitations, as Resend does after it lands. */
+    reload: () => Promise<void>;
+}
+interface TeamMembersPanelProps {
+    /**
+     * Data access. `createTeamClient({ fetch })` from `@meetreeve/module-team/client`.
+     * Pass a stable instance (module scope or `useMemo`): a new client refetches.
+     */
+    client: TeamClient;
+    /**
+     * The org whose team this panel shows. Required: every request is issued
+     * for this org, and changing it resets the panel (DEV-8592).
+     */
+    orgId: string;
+    /**
+     * Roles the invite dialog AND the per-member role picker offer, in order.
+     * Default admin/member/viewer. The operator cockpit (DEV-2439) passes
+     * `["admin", "member"]`.
+     */
+    inviteRoles?: AssignableRole[];
+    /**
+     * The signed-in user's email: marks their row "you", and that row's role
+     * decides which role changes the picker offers (DEV-18190). Without it, or
+     * when no member matches, every role shows as a plain label.
+     */
+    currentUserEmail?: string | null;
+    /**
+     * Host-owned per-member controls (Studio's Budget / Capabilities dialogs).
+     * Rendered at the end of every member row, owners included; the host
+     * decides per member what to show.
+     */
+    renderMemberActions?: (member: TeamMember) => ReactNode;
+    /**
+     * Host-owned per-invitation controls, rendered next to Resend / Revoke on
+     * every pending invitation. Call `reload` after a change the row shows.
+     */
+    renderInvitationActions?: (invitation: Invitation, helpers: InvitationActionHelpers) => ReactNode;
+    /**
+     * The org's spaces for the invite dialog's Spaces picker. When omitted the
+     * dialog has no picker and invites go out exactly as before. Called each
+     * time the dialog opens; until it answers, the invite is held, since an org
+     * with several spaces refuses an invite that names none (422
+     * `spaces_required`).
+     */
+    loadSpaceOptions?: () => Promise<SpaceOption[]>;
+    /** Called with every success/error notice the panel shows inline. */
+    onNotice?: (notice: TeamNotice) => void;
+}
+/**
+ * Keyed on `orgId`: an org change remounts the body, which is what resets
+ * every piece of per-org state at once — no reset effect to forget.
+ */
+declare function TeamMembersPanel(props: TeamMembersPanelProps): react.JSX.Element;
+
+export { type AssignableRole, type Invitation, type InvitationActionHelpers, type InvitationSpace, type InviteMemberResponse, type InviteSpace, type SpaceOption, type SpaceRole, type TeamClient, type TeamMember, TeamMembersPanel, type TeamMembersPanelProps, type TeamNotice, type TeamRole };