@marinoscar/platform-web 0.1.0-next.3 → 0.1.0-next.4

package/dist/identity/headless/adapters.d.ts

@@ -0,0 +1,85 @@
+import type { ComponentType, ReactElement, ReactNode } from 'react';
+import type { IdentityApi } from './api.js';
+import type { IdentityDataTableComponent } from './table.js';
+/**
+ * What {@link IdentityWebAdapters.Spinner} takes.
+ *
+ * @stability experimental
+ */
+export interface IdentitySpinnerProps {
+    /** A whole-page wait (the login page while the session probe runs). */
+    fullScreen?: boolean;
+}
+/**
+ * What the identity pages take from the app. Every member is optional; keep
+ * the object a module constant.
+ *
+ * @example
+ * ```ts
+ * // apps/web/src/platform/identityAdapters.ts
+ * export const appIdentityAdapters: IdentityWebAdapters = {
+ *   appName: APP_NAME,
+ *   Spinner: LoadingSpinner,
+ *   DataTable,
+ * };
+ * ```
+ *
+ * @extensionPoint option
+ * @stability experimental
+ */
+export interface IdentityWebAdapters {
+    /**
+     * The product name the sign-in error copy names ("isn't approved to use
+     * <appName> yet").
+     *
+     * @defaultValue `'this app'`
+     */
+    appName?: string;
+    /** The app's loading spinner (`fullScreen` for a whole-page wait). Default an MUI `CircularProgress`. */
+    Spinner?: ComponentType<IdentitySpinnerProps>;
+    /** The app's table for the users, allowlist and token lists. Default a plain MUI table. */
+    DataTable?: IdentityDataTableComponent;
+    /** The identity calls. Default `createIdentityApi(usePlatformApi())`. */
+    api?: IdentityApi;
+}
+/**
+ * Hands the app's {@link IdentityWebAdapters} to every identity page below
+ * it. Mount it once, around the routes (the login page renders outside the
+ * signed-in shell, so above it).
+ *
+ * @param props - `adapters`: the app's adapters (a module constant); `children`: the routed tree.
+ * @returns the provider element.
+ *
+ * @example
+ * ```tsx
+ * <IdentityWebAdaptersProvider adapters={appIdentityAdapters}>{routes}</IdentityWebAdaptersProvider>
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export declare function IdentityWebAdaptersProvider(props: {
+    adapters: IdentityWebAdapters;
+    children: ReactNode;
+}): ReactElement;
+/**
+ * The adapters in context (an empty object without a provider).
+ *
+ * @returns the app's identity adapters.
+ *
+ * @stability experimental
+ */
+export declare function useIdentityWebAdapters(): IdentityWebAdapters;
+/**
+ * The identity client the hooks use: `explicit` when given, else the
+ * adapters' `api`, else `createIdentityApi` over the platform host's
+ * transport.
+ *
+ * @param explicit - a client to use instead (keep its identity stable).
+ * @returns the client.
+ * @throws Error when none of the three is available.
+ *
+ * @stability experimental
+ */
+export declare function useIdentityApi(explicit?: IdentityApi): IdentityApi;
+//# sourceMappingURL=adapters.d.ts.map

package/dist/identity/headless/adapters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.d.ts","sourceRoot":"","sources":["../../../src/identity/headless/adapters.tsx"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAIpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,uEAAuE;IACvE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yGAAyG;IACzG,OAAO,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;IAC9C,2FAA2F;IAC3F,SAAS,CAAC,EAAE,0BAA0B,CAAC;IACvC,yEAAyE;IACzE,GAAG,CAAC,EAAE,WAAW,CAAC;CACnB;AAOD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE;IACjD,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,YAAY,CAIf;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,IAAI,mBAAmB,CAE5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAYlE"}

package/dist/identity/headless/adapters.js

@@ -0,0 +1,71 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+// =============================================================================
+// The identity slice's app adapters (issue #727, PP-6.6)
+// =============================================================================
+//
+// What the identity pages need from the app beyond the platform host: the
+// product name the sign-in copy uses, the app's spinner and table (the app
+// owns appearance), and optionally the app's own identity API client. The
+// telemetry slice's `TelemetryWebAdaptersProvider` is the model.
+//
+// Without a provider every adapter has a default: a generic product name, an
+// MUI spinner, a plain MUI table, and `createIdentityApi(host.api)`.
+// =============================================================================
+import { createContext, useContext, useMemo } from 'react';
+import { useOptionalPlatformHost } from '../../core/index.js';
+import { createIdentityApi } from './api.js';
+const NO_ADAPTERS = Object.freeze({});
+const IdentityWebAdaptersContext = createContext(NO_ADAPTERS);
+IdentityWebAdaptersContext.displayName = 'IdentityWebAdaptersContext';
+/**
+ * Hands the app's {@link IdentityWebAdapters} to every identity page below
+ * it. Mount it once, around the routes (the login page renders outside the
+ * signed-in shell, so above it).
+ *
+ * @param props - `adapters`: the app's adapters (a module constant); `children`: the routed tree.
+ * @returns the provider element.
+ *
+ * @example
+ * ```tsx
+ * <IdentityWebAdaptersProvider adapters={appIdentityAdapters}>{routes}</IdentityWebAdaptersProvider>
+ * ```
+ *
+ * @extensionPoint component
+ * @stability experimental
+ */
+export function IdentityWebAdaptersProvider(props) {
+    return (_jsx(IdentityWebAdaptersContext.Provider, { value: props.adapters, children: props.children }));
+}
+/**
+ * The adapters in context (an empty object without a provider).
+ *
+ * @returns the app's identity adapters.
+ *
+ * @stability experimental
+ */
+export function useIdentityWebAdapters() {
+    return useContext(IdentityWebAdaptersContext);
+}
+/**
+ * The identity client the hooks use: `explicit` when given, else the
+ * adapters' `api`, else `createIdentityApi` over the platform host's
+ * transport.
+ *
+ * @param explicit - a client to use instead (keep its identity stable).
+ * @returns the client.
+ * @throws Error when none of the three is available.
+ *
+ * @stability experimental
+ */
+export function useIdentityApi(explicit) {
+    const adapters = useIdentityWebAdapters();
+    const hostApi = useOptionalPlatformHost()?.api;
+    const fromHost = useMemo(() => (hostApi ? createIdentityApi(hostApi) : null), [hostApi]);
+    const api = explicit ?? adapters.api ?? fromHost;
+    if (!api) {
+        throw new Error('useIdentityApi: no identity client. Mount PlatformHostProvider (@marinoscar/platform-web/core) or ' +
+            'IdentityWebAdaptersProvider with an `api`, or pass a client to the hook.');
+    }
+    return api;
+}
+//# sourceMappingURL=adapters.js.map

package/dist/identity/headless/adapters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.js","sourceRoot":"","sources":["../../../src/identity/headless/adapters.tsx"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yDAAyD;AACzD,gFAAgF;AAChF,EAAE;AACF,0EAA0E;AAC1E,2EAA2E;AAC3E,0EAA0E;AAC1E,iEAAiE;AACjE,EAAE;AACF,6EAA6E;AAC7E,qEAAqE;AACrE,gFAAgF;AAEhF,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAG3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AA+C7C,MAAM,WAAW,GAAwB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAE3D,MAAM,0BAA0B,GAAG,aAAa,CAAsB,WAAW,CAAC,CAAC;AACnF,0BAA0B,CAAC,WAAW,GAAG,4BAA4B,CAAC;AAEtE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,2BAA2B,CAAC,KAG3C;IACC,OAAO,CACL,KAAC,0BAA0B,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,YAAG,KAAK,CAAC,QAAQ,GAAuC,CACnH,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAC,QAAsB;IACnD,MAAM,QAAQ,GAAG,sBAAsB,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAG,uBAAuB,EAAE,EAAE,GAAG,CAAC;IAC/C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACzF,MAAM,GAAG,GAAG,QAAQ,IAAI,QAAQ,CAAC,GAAG,IAAI,QAAQ,CAAC;IACjD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CACb,oGAAoG;YAClG,0EAA0E,CAC7E,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/identity/headless/api.d.ts

@@ -0,0 +1,492 @@
+import type { BuiltinOrgRole, PatDurationUnitValue, RoleDescriptor as ContractRoleDescriptor, RoleScopeValue, UserExtensions } from '@marinoscar/platform-contract/identity';
+import type { PlatformApiClient } from '../../core/index.js';
+/**
+ * A user as a list row names them (who added an entry, who sent an invitation).
+ *
+ * @stability stable
+ */
+export interface IdentityUserRef {
+    /** The user's id. */
+    id: string;
+    /** The user's email address. */
+    email: string;
+}
+/**
+ * One row of `GET /api/users`.
+ *
+ * @stability stable
+ */
+export interface UserListItem {
+    /** The user's id. */
+    id: string;
+    /** The user's email address. */
+    email: string;
+    /** The display-name override, or `null`. */
+    displayName: string | null;
+    /** The provider's display name, or `null`. */
+    providerDisplayName: string | null;
+    /** The resolved picture, or `null`. */
+    profileImageUrl: string | null;
+    /** The provider's picture, or `null`. */
+    providerProfileImageUrl?: string | null;
+    /** Whether the account is active. */
+    isActive: boolean;
+    /** The user's system role names. */
+    roles: string[];
+    /** ISO 8601 creation time. */
+    createdAt: string;
+    /** ISO 8601 last update. */
+    updatedAt: string;
+    /**
+     * What the app's user-list extensions added for this user on the server
+     * (`registerUserListExtension` of `@marinoscar/platform-api/identity`), keyed
+     * by extension id. Absent when none contributed. A column reads one with
+     * {@link userExtension}.
+     */
+    extensions?: UserExtensions;
+}
+/**
+ * A page of a list endpoint (`docs/API.md` pagination).
+ *
+ * @typeParam T - the row type.
+ * @stability stable
+ */
+export interface Paginated<T> {
+    /** The rows of this page. */
+    items: T[];
+    /** Rows across all pages. */
+    total: number;
+    /** This page, one-based. */
+    page: number;
+    /** The page size. */
+    pageSize: number;
+    /** The number of pages. */
+    totalPages: number;
+}
+/**
+ * `GET /api/users`.
+ *
+ * @stability stable
+ */
+export type UsersResponse = Paginated<UserListItem>;
+/**
+ * Sort keys `GET /api/users` accepts (`userListQuerySchema.sortBy`). Typed so
+ * a table column declaring `sortable` against a field the endpoint rejects is
+ * a compile error, not a 400.
+ *
+ * @stability stable
+ */
+export type UserSortField = 'email' | 'createdAt' | 'updatedAt';
+/**
+ * The query `GET /api/users` accepts.
+ *
+ * @stability stable
+ */
+export interface UserListParams {
+    /** The page, one-based. */
+    page?: number;
+    /** The page size. */
+    pageSize?: number;
+    /** Matches email, display name and provider display name. */
+    search?: string;
+    /** Only users holding this role. */
+    role?: string;
+    /** Only active (`true`) or inactive (`false`) users. */
+    isActive?: boolean;
+    /** The sort key. */
+    sortBy?: UserSortField;
+    /** The sort direction. */
+    sortOrder?: 'asc' | 'desc';
+}
+/**
+ * One row of `GET /api/allowlist`.
+ *
+ * @stability stable
+ */
+export interface AllowedEmailEntry {
+    /** The entry's id. */
+    id: string;
+    /** The allowed address. */
+    email: string;
+    /** Who added it, or `null`. */
+    addedBy: IdentityUserRef | null;
+    /** ISO 8601 time it was added. */
+    addedAt: string;
+    /** Who signed in with it, or `null` while pending. */
+    claimedBy: IdentityUserRef | null;
+    /** ISO 8601 time it was claimed, or `null`. */
+    claimedAt: string | null;
+    /** Free-text notes, or `null`. */
+    notes: string | null;
+}
+/**
+ * `GET /api/allowlist`.
+ *
+ * @stability stable
+ */
+export type AllowlistResponse = Paginated<AllowedEmailEntry>;
+/**
+ * Sort keys `GET /api/allowlist` accepts (`allowlistQuerySchema.sortBy`).
+ *
+ * @stability stable
+ */
+export type AllowlistSortField = 'email' | 'addedAt' | 'claimedAt';
+/**
+ * The query `GET /api/allowlist` accepts.
+ *
+ * @stability stable
+ */
+export interface AllowlistParams {
+    /** The page, one-based. */
+    page?: number;
+    /** The page size. */
+    pageSize?: number;
+    /** Matches the address. */
+    search?: string;
+    /** Pending, claimed or all entries. */
+    status?: 'all' | 'pending' | 'claimed';
+    /** The sort key. */
+    sortBy?: AllowlistSortField;
+    /** The sort direction. */
+    sortOrder?: 'asc' | 'desc';
+}
+/**
+ * What `GET /api/auth/device/activate?code=...` returns for a pending code.
+ *
+ * EVERY FIELD UNDER `clientInfo` IS ATTACKER-CHOSEN: `POST /auth/device/code`
+ * is public and stores its body verbatim. The types describe what a
+ * well-behaved client sends, not what will arrive; `readCredentialKind` is
+ * the only place this object is interpreted.
+ *
+ * @stability stable
+ */
+export interface DeviceActivationInfo {
+    /** The user code, `XXXX-XXXX`. */
+    userCode: string;
+    /** What the device said about itself; may be absent or `null`-filled. */
+    clientInfo?: {
+        /** The device's chosen name. */
+        deviceName?: string;
+        /** Its user agent. */
+        userAgent?: string;
+        /** The address it called from. */
+        ipAddress?: string;
+        /**
+         * The credential it asked for. A `string`, not the `'session' | 'pat'`
+         * union: older rows have none, and the column is not re-validated on read.
+         */
+        tokenType?: string;
+    };
+    /** ISO 8601 expiry of the code. */
+    expiresAt: string;
+}
+/**
+ * What `POST /api/auth/device/authorize` returns.
+ *
+ * @stability stable
+ */
+export interface DeviceAuthorizationResponse {
+    /** Whether the decision was recorded. */
+    success: boolean;
+    /** The API's message. */
+    message: string;
+}
+/**
+ * A personal access token's lifetime unit.
+ *
+ * @stability stable
+ */
+export type PatDurationUnit = PatDurationUnitValue;
+/**
+ * One row of `GET /api/pat`. Never carries the token value.
+ *
+ * @stability stable
+ */
+export interface PersonalAccessToken {
+    /** The token's id. */
+    id: string;
+    /** Its name. */
+    name: string;
+    /** Its prefix, for identification. */
+    tokenPrefix: string;
+    /** The duration value used when creating it. */
+    durationValue: number;
+    /** The duration unit used when creating it. */
+    durationUnit: PatDurationUnit;
+    /** ISO 8601 expiry. */
+    expiresAt: string;
+    /** ISO 8601 time of last use, or `null`. */
+    lastUsedAt: string | null;
+    /** ISO 8601 creation time. */
+    createdAt: string;
+    /** ISO 8601 revocation time, or `null`. */
+    revokedAt: string | null;
+}
+/**
+ * `POST /api/pat` response: the raw token value, shown once.
+ *
+ * @stability stable
+ */
+export interface PatCreatedResponse {
+    /** The raw token value (`pat_...`); shown only once. */
+    token: string;
+    /** The token's id. */
+    id: string;
+    /** Its name. */
+    name: string;
+    /** Its prefix. */
+    tokenPrefix: string;
+    /** ISO 8601 expiry. */
+    expiresAt: string;
+    /** ISO 8601 creation time. */
+    createdAt: string;
+}
+/**
+ * `POST /api/pat` body.
+ *
+ * @stability stable
+ */
+export interface CreatePatInput {
+    /** A human-readable name. */
+    name: string;
+    /** The lifetime, in `durationUnit`. */
+    durationValue: number;
+    /** The unit of `durationValue`. */
+    durationUnit: PatDurationUnit;
+}
+/**
+ * The org roles the platform ships, highest first (`BUILTIN_ORG_ROLES` of the
+ * contract).
+ *
+ * @deprecated The roles a caller may assign are the API's to say: read them
+ *   with `useRoles('org')` (`GET /api/roles?scope=org`), which also lists an
+ *   app's own roles. Kept for one release; no packaged page reads it.
+ * @stability stable
+ */
+export declare const ORG_ROLES: readonly ["org_admin", "contributor", "viewer"];
+/**
+ * An org role id: a built-in one (autocompleted) or any string an app
+ * registered.
+ *
+ * @stability stable
+ */
+export type OrgRole = BuiltinOrgRole | (string & {});
+/**
+ * One role as `GET /api/roles` describes it: id, label, description, scope and
+ * whether the invite, member and user-role routes may assign it.
+ *
+ * @stability experimental
+ */
+export type RoleDescriptor = ContractRoleDescriptor;
+/**
+ * A role scope: `system` (held in `user_roles`) or `org` (held on a membership).
+ *
+ * @stability experimental
+ */
+export type RoleScope = RoleScopeValue;
+/**
+ * A membership status.
+ *
+ * @stability stable
+ */
+export type OrgMemberStatus = 'active' | 'suspended';
+/**
+ * An invitation status.
+ *
+ * @stability stable
+ */
+export type OrgInviteStatus = 'pending' | 'accepted' | 'revoked' | 'expired';
+/**
+ * One member of the active organization (`orgMemberResponseSchema`).
+ *
+ * @stability stable
+ */
+export interface OrgMember {
+    /** The member's user id. */
+    userId: string;
+    /** Their email address. */
+    email: string;
+    /** Their display name, or `null`. */
+    displayName: string | null;
+    /** Their org role. */
+    role: string;
+    /** Their membership status. */
+    status: OrgMemberStatus;
+    /** ISO 8601 time of their last activity, or `null`. */
+    lastActiveAt: string | null;
+    /** ISO 8601 time they joined. */
+    joinedAt: string;
+}
+/**
+ * One invitation to the active organization (`orgInviteResponseSchema`).
+ *
+ * @stability stable
+ */
+export interface OrgInvite {
+    /** The invitation's id. */
+    id: string;
+    /** The invited address. */
+    email: string;
+    /** The org role it grants. */
+    role: string;
+    /** Its status. */
+    status: OrgInviteStatus;
+    /** Free-text notes, or `null`. */
+    notes: string | null;
+    /** ISO 8601 expiry, or `null`. */
+    expiresAt: string | null;
+    /** ISO 8601 creation time. */
+    createdAt: string;
+    /** ISO 8601 acceptance time, or `null`. */
+    acceptedAt: string | null;
+    /** Who sent it, or `null`. */
+    invitedBy: IdentityUserRef | null;
+    /** Who accepted it, or `null`. */
+    acceptedBy: IdentityUserRef | null;
+}
+/**
+ * One organization of the deployment (`organizationResponseSchema`).
+ *
+ * @stability stable
+ */
+export interface Organization {
+    /** The organization's id. */
+    id: string;
+    /** Its name. */
+    name: string;
+    /** Its slug. */
+    slug: string;
+    /** Whether it is the default organization. */
+    isDefault: boolean;
+    /** Its number of members. */
+    memberCount: number;
+    /** ISO 8601 creation time. */
+    createdAt: string;
+    /** ISO 8601 last update. */
+    updatedAt: string;
+}
+/**
+ * The query `GET /api/org/members` accepts.
+ *
+ * @stability stable
+ */
+export interface OrgMemberListParams {
+    /** The page, one-based. */
+    page?: number;
+    /** The page size. */
+    pageSize?: number;
+    /** Matches email and display name. */
+    search?: string;
+    /** Only members with this status. */
+    status?: 'all' | OrgMemberStatus;
+}
+/**
+ * The query `GET /api/org/invites` accepts.
+ *
+ * @stability stable
+ */
+export interface OrgInviteListParams {
+    /** The page, one-based. */
+    page?: number;
+    /** The page size. */
+    pageSize?: number;
+    /** Only invitations with this status. */
+    status?: 'all' | OrgInviteStatus;
+}
+/**
+ * The query `GET /api/admin/organizations` accepts.
+ *
+ * @stability stable
+ */
+export interface OrganizationListParams {
+    /** The page, one-based. */
+    page?: number;
+    /** The page size. */
+    pageSize?: number;
+    /** Matches name and slug. */
+    search?: string;
+}
+/**
+ * Every identity call the packaged pages make. {@link createIdentityApi}
+ * builds one over the app's transport; an app may hand its own through the
+ * identity adapters (`IdentityWebAdapters.api`), for example to keep calling
+ * its existing service functions.
+ *
+ * @extensionPoint option
+ * @stability experimental
+ */
+export interface IdentityApi {
+    /** `GET /roles?scope=...` (`users:read` for `system`, `org_members:read` for `org`). */
+    getRoles(scope?: RoleScope): Promise<RoleDescriptor[]>;
+    /** `GET /users?...`. */
+    getUsers(params?: UserListParams): Promise<UsersResponse>;
+    /** `PATCH /users/:id`. */
+    updateUser(id: string, data: {
+        displayName?: string;
+        isActive?: boolean;
+    }): Promise<UserListItem>;
+    /** `PUT /users/:id/roles`. */
+    updateUserRoles(id: string, roles: string[]): Promise<UserListItem>;
+    /** `GET /allowlist?...`. */
+    getAllowlist(params?: AllowlistParams): Promise<AllowlistResponse>;
+    /** `POST /allowlist`. */
+    addToAllowlist(email: string, notes?: string): Promise<AllowedEmailEntry>;
+    /** `DELETE /allowlist/:id`. */
+    removeFromAllowlist(id: string): Promise<void>;
+    /** `GET /auth/device/activate?code=...`. */
+    getDeviceActivationInfo(userCode: string): Promise<DeviceActivationInfo>;
+    /** `POST /auth/device/authorize`. */
+    authorizeDevice(userCode: string, approve: boolean): Promise<DeviceAuthorizationResponse>;
+    /** `GET /pat`. */
+    getPersonalAccessTokens(): Promise<PersonalAccessToken[]>;
+    /** `POST /pat`. */
+    createPersonalAccessToken(data: CreatePatInput): Promise<PatCreatedResponse>;
+    /** `DELETE /pat/:id`. */
+    revokePersonalAccessToken(id: string): Promise<void>;
+    /** `GET /org/members?...` (the active organization). */
+    getOrgMembers(params?: OrgMemberListParams): Promise<Paginated<OrgMember>>;
+    /** `PATCH /org/members/:userId`. */
+    updateOrgMember(userId: string, data: {
+        roleName?: OrgRole;
+        status?: OrgMemberStatus;
+    }): Promise<OrgMember>;
+    /** `DELETE /org/members/:userId`. */
+    removeOrgMember(userId: string): Promise<void>;
+    /** `GET /org/invites?...` (the active organization). */
+    getOrgInvites(params?: OrgInviteListParams): Promise<Paginated<OrgInvite>>;
+    /** `POST /org/invites`. */
+    createOrgInvite(data: {
+        email: string;
+        roleName: OrgRole;
+        notes?: string;
+    }): Promise<OrgInvite>;
+    /** `DELETE /org/invites/:id`. */
+    revokeOrgInvite(id: string): Promise<void>;
+    /** `GET /admin/organizations?...`. */
+    getOrganizations(params?: OrganizationListParams): Promise<Paginated<Organization>>;
+    /** `POST /admin/organizations`. */
+    createOrganization(data: {
+        name: string;
+        slug: string;
+        firstAdminEmail: string;
+    }): Promise<Organization>;
+    /** `PATCH /admin/organizations/:id`. */
+    renameOrganization(id: string, name: string): Promise<Organization>;
+}
+/**
+ * The identity calls over `api` (the app's transport). Paths are relative to
+ * the API base, as every `PlatformApiClient` call.
+ *
+ * @param api - the app's transport (`usePlatformApi()`); keep its identity stable.
+ * @returns the client.
+ *
+ * @example
+ * ```ts
+ * const identity = createIdentityApi(usePlatformApi());
+ * const page = await identity.getUsers({ page: 1, pageSize: 10 });
+ * ```
+ *
+ * @stability experimental
+ */
+export declare function createIdentityApi(api: PlatformApiClient): IdentityApi;
+//# sourceMappingURL=api.d.ts.map

package/dist/identity/headless/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/identity/headless/api.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,cAAc,IAAI,sBAAsB,EACxC,cAAc,EACd,cAAc,EACf,MAAM,wCAAwC,CAAC;AAEhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAI7D;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,8CAA8C;IAC9C,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,uCAAuC;IACvC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,yCAAyC;IACzC,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,qCAAqC;IACrC,QAAQ,EAAE,OAAO,CAAC;IAClB,oCAAoC;IACpC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,6BAA6B;IAC7B,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;AAEpD;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oBAAoB;IACpB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAChC,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,SAAS,EAAE,eAAe,GAAG,IAAI,CAAC;IAClC,+CAA+C;IAC/C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,kCAAkC;IAClC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;AAEnE;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,MAAM,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,SAAS,CAAC;IACvC,oBAAoB;IACpB,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,0BAA0B;IAC1B,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC5B;AAID;;;;;;;;;GASG;AACH,MAAM,WAAW,oBAAoB;IACnC,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,UAAU,CAAC,EAAE;QACX,gCAAgC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,sBAAsB;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kCAAkC;QAClC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,yCAAyC;IACzC,OAAO,EAAE,OAAO,CAAC;IACjB,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;CACjB;AAID;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,oBAAoB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,YAAY,EAAE,eAAe,CAAC;IAC9B,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,YAAY,EAAE,eAAe,CAAC;CAC/B;AAID;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,iDAAkD,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAErD;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAEpD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,cAAc,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,WAAW,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;AAE7E;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,MAAM,EAAE,eAAe,CAAC;IACxB,uDAAuD;IACvD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,MAAM,EAAE,eAAe,CAAC;IACxB,kCAAkC;IAClC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kCAAkC;IAClC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,8BAA8B;IAC9B,SAAS,EAAE,eAAe,GAAG,IAAI,CAAC;IAClC,kCAAkC;IAClC,UAAU,EAAE,eAAe,GAAG,IAAI,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,SAAS,EAAE,OAAO,CAAC;IACnB,6BAA6B;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,MAAM,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,MAAM,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,wFAAwF;IACxF,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvD,wBAAwB;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1D,0BAA0B;IAC1B,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAClG,8BAA8B;IAC9B,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACpE,4BAA4B;IAC5B,YAAY,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACnE,yBAAyB;IACzB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC1E,+BAA+B;IAC/B,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,4CAA4C;IAC5C,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACzE,qCAAqC;IACrC,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC1F,kBAAkB;IAClB,uBAAuB,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC1D,mBAAmB;IACnB,yBAAyB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7E,yBAAyB;IACzB,yBAAyB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,wDAAwD;IACxD,aAAa,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3E,oCAAoC;IACpC,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5G,qCAAqC;IACrC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,wDAAwD;IACxD,aAAa,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3E,2BAA2B;IAC3B,eAAe,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAChG,iCAAiC;IACjC,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,sCAAsC;IACtC,gBAAgB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;IACpF,mCAAmC;IACnC,kBAAkB,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACzG,wCAAwC;IACxC,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CACrE;AAWD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,iBAAiB,GAAG,WAAW,CAsDrE"}