@arbidocs/blocks 0.5.23 → 0.5.24

package/dist/connection/auth/CompactLogin.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The compact sign-in of embedded hosts (an Office task pane, a browser extension): email and
+ * password, or SSO in a popup (the host opens it, `onSsoSignIn`) followed by the master password
+ * the account's keys are derived from. The same actions as the sign-in page (`useLoginActions`)
+ * and the same SSO completion as the callback page (`completeSsoSignIn`), arranged for a narrow
+ * pane, with errors shown in place.
+ */
+import { type ReactElement } from 'react';
+import { type SsoUser } from './support';
+export interface CompactLoginOptions {
+    /**
+     * Sign in at the SSO provider in a popup: the provider's token and user, or `null` when the
+     * popup closed without one. Absent: no SSO.
+     */
+    onSsoSignIn?: () => Promise<{
+        accessToken: string;
+        user: SsoUser;
+    } | null>;
+    /** Signed in, with the person's first name. */
+    onSignedIn?: (name: string) => void;
+    /** The product name in the copy ("Sign in with …", "your … master password"). */
+    appName?: string;
+    /** The SSO provider's name on its buttons. Default: the product name. */
+    ssoName?: string;
+}
+export declare function CompactLogin({ onSsoSignIn, onSignedIn, appName, ssoName, }: CompactLoginOptions): ReactElement;

package/dist/connection/auth/ConnectedLoginPage.d.ts

@@ -6,4 +6,12 @@
  * configuration's `auth` (and `sso`), see `./support`.
  */
 import { type ReactElement } from 'react';
-export declare function ConnectedLoginPage(): ReactElement;
+import { type CompactLoginOptions } from './CompactLogin';
+export interface ConnectedLoginPageProps extends CompactLoginOptions {
+    /**
+     * `page` (default): the full sign-in and registration page. `compact`: the sign-in of an embedded
+     * host's narrow pane (email and password, or SSO in a popup, `onSsoSignIn`).
+     */
+    layout?: 'page' | 'compact';
+}
+export declare function ConnectedLoginPage({ layout, ...compact }?: ConnectedLoginPageProps): ReactElement;

package/dist/connection/auth/index.d.ts

@@ -1,4 +1,6 @@
-export { ConnectedLoginPage } from './ConnectedLoginPage';
+export { ConnectedLoginPage, type ConnectedLoginPageProps } from './ConnectedLoginPage';
+export { type CompactLoginOptions } from './CompactLogin';
+export { openSsoPopup } from './sso-popup';
 export { ConnectedSsoCallback } from './ConnectedSsoCallback';
 export { SsoResendVerificationButton } from './SsoResendVerificationButton';
 export { resolveSsoName, type NameSource, type ResolvedName } from './sso-name';

package/dist/connection/auth/sso-popup.d.ts

@@ -0,0 +1,13 @@
+/**
+ * SSO in a popup, for hosts that cannot leave their page (an Office task pane, an extension): open
+ * the provider's sign-in, and wait for the callback page in the popup to post the provider's token
+ * and user back (`window.opener.postMessage({ accessToken, user }, origin)`). Resolves `null` when
+ * the popup is closed first; rejects with the provider's error.
+ */
+import type { SsoUser } from './support';
+export declare function openSsoPopup(url: string, { features }?: {
+    features?: string;
+}): Promise<{
+    accessToken: string;
+    user: SsoUser;
+} | null>;

package/dist/connection/auth/sso-sign-in.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Finishing a sign-in through SSO, once the provider has signed the person in: what their account
+ * is for the provider's email (`arbi.sso.status`), then, with the master password, register a new
+ * account (and back it up), link a local one, or sign in. One implementation for the full-page
+ * callback (`ConnectedSsoCallback`) and the compact sign-in of embedded hosts.
+ */
+import type { components, LoginResult } from '@arbidocs/client';
+import type { useArbi } from '@arbidocs/react';
+import type { SsoUser } from './support';
+export type SsoAccountStatus = components['schemas']['SSOStatusResponse'];
+type Arbi = ReturnType<typeof useArbi>;
+/** What the provider's account is on this deployment (`new_user`, `sso_exists`, `local_exists`). */
+export declare function ssoAccountStatus(arbi: Arbi, token: string, user: SsoUser): Promise<{
+    status: string;
+    email: string;
+    given_name?: string | null;
+    family_name?: string | null;
+}>;
+export interface CompleteSsoSignIn {
+    token: string;
+    user: SsoUser;
+    status: SsoAccountStatus;
+    /** The master password: a new one for `new_user`, the account's otherwise. */
+    password: string;
+    /** A new account: download its recovery key (default on). */
+    saveRecoveryKey?: boolean;
+}
+/**
+ * Sign in with the master password by account status. A new account is registered (the SSO token
+ * stands in for the verification code), backed up, and signed in with the provider's name and
+ * picture; `registered` says so. A local account is linked to SSO (`linked`).
+ */
+export declare function completeSsoSignIn(arbi: Arbi, { token, user, status, password, saveRecoveryKey }: CompleteSsoSignIn): Promise<{
+    login: LoginResult | undefined;
+    registered: boolean;
+    linked: boolean;
+}>;
+export {};

package/dist/connection/auth/useLoginActions.d.ts

@@ -5,9 +5,11 @@
  * session in, and the site's sign-in hooks run around it.
  */
 import type { LoginFormActions, LoginFormState } from './useLoginForm';
-export declare function useLoginActions({ formState, formActions, }: {
+export declare function useLoginActions({ formState, formActions, onError, }: {
     formState: LoginFormState;
     formActions: LoginFormActions;
+    /** Show a refusal in the form itself. Default: a notice. */
+    onError?: (message: string) => void;
 }): {
     isAuthenticating: boolean;
     isRequestingCode: boolean;
@@ -19,7 +21,7 @@ export declare function useLoginActions({ formState, formActions, }: {
             email: string;
             password: string;
         };
-    }) => Promise<void>;
+    }) => Promise<import("@arbidocs/client").LoginResult | undefined>;
     handleRegister: (saveRecoveryKey?: boolean) => Promise<void>;
     handleRequestVerificationCode: () => Promise<void>;
 };

package/dist/connection/projects/ConnectedProjectsPanel.d.ts

@@ -8,6 +8,7 @@
  * (`tabs`); without it the panel keeps them and opens its own projects' tabs.
  */
 import { type ReactNode } from 'react';
+import { type ProjectsListPageProps } from './ProjectsListPage';
 /** The base tab's id. */
 export declare const PROJECTS_BASE_TAB_ID = "projects";
 /** The panel's project tabs, kept by a host. */
@@ -21,6 +22,13 @@ export interface ProjectPanelTabs {
     onClose: (projectId: string) => void;
 }
 export interface ConnectedProjectsPanelProps {
+    /**
+     * `panel` (default): the Plan & Usage panel with a tab per open project. `page`: the projects
+     * list as a page (`page` options), a row opening the project through `environment.openProject`.
+     */
+    layout?: 'panel' | 'page';
+    /** The list page's words, columns and header actions (`layout="page"`). */
+    page?: ProjectsListPageProps;
     /** Host-kept tabs; the panel keeps its own without. */
     tabs?: ProjectPanelTabs;
     /** A project's storage section, at the foot of its detail. */
@@ -31,4 +39,4 @@ export interface ConnectedProjectsPanelProps {
     headerRight?: ReactNode;
     className?: string;
 }
-export declare function ConnectedProjectsPanel({ tabs: hostTabs, projectStorage, footer, headerRight, className, }: ConnectedProjectsPanelProps): import("react").JSX.Element;
+export declare function ConnectedProjectsPanel({ layout, page, ...panel }: ConnectedProjectsPanelProps): import("react").JSX.Element;

package/dist/connection/projects/ProjectsListPage.d.ts

@@ -0,0 +1,40 @@
+/**
+ * The projects list as a page (`ConnectedProjectsPanel layout="page"`): every project with its
+ * client, stage, documents, threads, people and storage (`useProjectSummaries`), searchable by
+ * project or workspace name; a row opens the project (`environment.openProject`). A site names
+ * things its own way (`labels`) and picks the columns (`columns`).
+ */
+import { type ReactNode } from 'react';
+/** The list's columns, in order. */
+export type ProjectListColumn = 'name' | 'client' | 'stage' | 'documents' | 'conversations' | 'members' | 'storage';
+export declare const DEFAULT_PROJECT_LIST_COLUMNS: readonly ProjectListColumn[];
+export interface ProjectsListLabels {
+    eyebrow?: ReactNode;
+    title: string;
+    description?: ReactNode;
+    searchPlaceholder: string;
+    /** Column headers. */
+    columns: Record<ProjectListColumn, string>;
+    /** "opened 3 Oct 2026" under a project's name. */
+    opened: string;
+    loadingTitle: string;
+    loadingDescription?: string;
+    emptyTitle: string;
+    emptyDescription?: string;
+}
+export declare const DEFAULT_PROJECTS_LIST_LABELS: ProjectsListLabels;
+export interface ProjectsListPageProps {
+    /** The site's words; each field falls back to the default. */
+    labels?: Partial<Omit<ProjectsListLabels, 'columns'>> & {
+        columns?: Partial<Record<ProjectListColumn, string>>;
+    };
+    /** The columns shown, in order. Default: all. */
+    columns?: readonly ProjectListColumn[];
+    /** The header's actions (a "new project" button). */
+    actions?: ReactNode;
+    /** The page's test-id prefix. Default: `projects`. */
+    testId?: string;
+}
+/** One decimal GB, or MB when tiny; "—" with nothing stored. */
+export declare function formatStorageGb(gb: number): string;
+export declare function ProjectsListPage({ labels: given, columns: shown, actions, testId, }: ProjectsListPageProps): import("react").JSX.Element;

package/dist/connection/projects/index.d.ts

@@ -1,2 +1,3 @@
 export { ConnectedProjectsPanel, PROJECTS_BASE_TAB_ID, type ConnectedProjectsPanelProps, type ProjectPanelTabs, } from './ConnectedProjectsPanel';
 export { buildProjectSummaries, primaryProjectWorkspace, useProjectSummaries, useProjectSummary, type ProjectMemberSummary, type ProjectSummary, type ProjectWorkspaceSummary, } from './useProjectSummaries';
+export { DEFAULT_PROJECT_LIST_COLUMNS, DEFAULT_PROJECTS_LIST_LABELS, formatStorageGb, type ProjectListColumn, type ProjectsListLabels, type ProjectsListPageProps, } from './ProjectsListPage';

package/dist/connection/settings-page/appearanceSection.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Appearance, as a settings section a site adds as data (`ConnectedSettingsPage sections`).
+ *
+ * Two parts, each shown when the site supplies its store:
+ * - `appearance`: the reader's colour scheme, text size and typeface on this device
+ *   ({@link createAppearanceStore});
+ * - `theme`: the site's brand tokens, edited live ({@link createThemeStore} + `ThemeEditor`).
+ */
+import type { ReactNode } from 'react';
+import type { SettingsPageSection } from '../../settings/SettingsPage';
+import type { AppearanceBundle } from '../../theme/appearance';
+import type { ThemeBundle } from '../../theme/store';
+import { type ThemeEditorProps } from '../../theme/ThemeEditor';
+export interface AppearanceSettingsSectionOptions {
+    /** The reader's appearance store: shows colour scheme, text size and typeface. */
+    appearance?: AppearanceBundle;
+    /** The site's theme bundle: shows the token editor. */
+    theme?: ThemeBundle;
+    /** The theme editor's live preview card. */
+    themePreview?: ThemeEditorProps['preview'];
+    /** The theme editor's heading icon (a site's accent). Default: a palette. */
+    icon?: ReactNode;
+    /** The theme editor's description. */
+    description?: string;
+}
+/**
+ * Appearance. The tab shows a palette when the section edits the theme's colours, a type glyph
+ * when it only sets the reader's own scheme, size and typeface.
+ */
+export declare function appearanceSettingsSection(options: AppearanceSettingsSectionOptions): SettingsPageSection;

package/dist/connection/settings-page/index.d.ts

@@ -5,3 +5,4 @@ export { ConnectedPrivacySettings, type ConnectedPrivacySettingsProps, } from '.
 export { ConnectedPremiumModels } from './ConnectedPremiumModels';
 export { SessionStatusIcon, renderSessionStatusIcon } from './SessionStatusIcon';
 export { usageSettingsSection, connectionSettingsSection, organisationSettingsSection, type UsageSettingsSectionOptions, type ConnectionSettingsSectionOptions, type OrganisationSettingsSectionOptions, } from './sections';
+export { appearanceSettingsSection, type AppearanceSettingsSectionOptions, } from './appearanceSection';