@arbidocs/blocks 0.4.86 → 0.4.88

package/dist/activity/NotificationRelevanceControls.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Follow and mute controls. A workspace member is pushed only what concerns them; following a
+ * workspace or a thread opts in to everything from it, and muting a workspace silences it,
+ * mentions included. Presentational: the host owns the settings and the save.
+ */
+/** `default` (what names or involves you), `following` (everything) or `muted` (nothing). */
+export type NotificationLevel = 'default' | 'following' | 'muted';
+export interface WorkspaceNotificationMenuLabels {
+    trigger: string;
+    heading: string;
+    default: string;
+    defaultHint: string;
+    following: string;
+    followingHint: string;
+    muted: string;
+    mutedHint: string;
+    activity: string;
+}
+export declare const DEFAULT_WORKSPACE_NOTIFICATION_MENU_LABELS: WorkspaceNotificationMenuLabels;
+export interface WorkspaceNotificationMenuProps {
+    level: NotificationLevel;
+    onLevelChange: (level: NotificationLevel) => void;
+    disabled?: boolean;
+    /** Adds an item that opens the workspace's activity feed. */
+    onOpenActivity?: () => void;
+    labels?: Partial<WorkspaceNotificationMenuLabels>;
+    className?: string;
+    testId?: string;
+}
+/** A bell button whose menu sets how much of a workspace reaches the user. */
+export declare function WorkspaceNotificationMenu({ level, onLevelChange, disabled, onOpenActivity, labels, className, testId, }: WorkspaceNotificationMenuProps): import("react").JSX.Element;
+export interface ThreadFollowLabels {
+    follow: string;
+    unfollow: string;
+}
+export declare const DEFAULT_THREAD_FOLLOW_LABELS: ThreadFollowLabels;
+export interface ThreadFollowProps {
+    following: boolean;
+    onFollowingChange: (following: boolean) => void;
+    disabled?: boolean;
+    labels?: Partial<ThreadFollowLabels>;
+    testId?: string;
+}
+/** "Follow thread" / "Unfollow thread" as an item of a thread's options menu. */
+export declare function ThreadFollowMenuItem({ following, onFollowingChange, disabled, labels, testId, }: ThreadFollowProps): import("react").JSX.Element;
+/** The same switch as a bell button, for a thread header without a menu. */
+export declare function ThreadFollowButton({ following, onFollowingChange, disabled, labels, testId, }: ThreadFollowProps): import("react").JSX.Element;

package/dist/activity/WorkspaceActivityList.d.ts

@@ -0,0 +1,34 @@
+import { type WorkspaceActivityItem, type WorkspaceActivityTarget } from './workspace-activity';
+export interface WorkspaceActivityListLabels {
+    empty: string;
+    loading: string;
+    error: string;
+    loadMore: string;
+    loadingMore: string;
+    retry: string;
+    /** Who did it when the entry names no one. */
+    system: string;
+}
+export declare const DEFAULT_WORKSPACE_ACTIVITY_LABELS: WorkspaceActivityListLabels;
+export interface WorkspaceActivityListProps {
+    /** Entries, newest first (every page loaded so far). */
+    items: readonly WorkspaceActivityItem[];
+    isLoading?: boolean;
+    isError?: boolean;
+    /** Another page exists. */
+    hasMore?: boolean;
+    isLoadingMore?: boolean;
+    onLoadMore?: () => void;
+    onRetry?: () => void;
+    /** Open what an entry is about: its thread, document version or run. */
+    onOpen?: (target: WorkspaceActivityTarget, item: WorkspaceActivityItem) => void;
+    /** A person's or agent's display name by id. */
+    nameOf?: (id: string) => string | undefined;
+    /** "2 hours ago"; default the local date and time. */
+    formatTime?: (iso: string) => string;
+    labels?: Partial<WorkspaceActivityListLabels>;
+    className?: string;
+    testId?: string;
+}
+/** A workspace's activity, newest first, one line per entry; a line opens what it is about. */
+export declare function WorkspaceActivityList({ items, isLoading, isError, hasMore, isLoadingMore, onLoadMore, onRetry, onOpen, nameOf, formatTime, labels, className, testId, }: WorkspaceActivityListProps): import("react").JSX.Element;

package/dist/activity/index.d.ts

@@ -0,0 +1,3 @@
+export { workspaceActivityHeadline, workspaceActivityTarget, type WorkspaceActivityItem, type WorkspaceActivitySource, type WorkspaceActivityTarget, } from './workspace-activity';
+export { WorkspaceActivityList, DEFAULT_WORKSPACE_ACTIVITY_LABELS, type WorkspaceActivityListProps, type WorkspaceActivityListLabels, } from './WorkspaceActivityList';
+export { WorkspaceNotificationMenu, ThreadFollowMenuItem, ThreadFollowButton, DEFAULT_WORKSPACE_NOTIFICATION_MENU_LABELS, DEFAULT_THREAD_FOLLOW_LABELS, type NotificationLevel, type WorkspaceNotificationMenuProps, type WorkspaceNotificationMenuLabels, type ThreadFollowProps, type ThreadFollowLabels, } from './NotificationRelevanceControls';

package/dist/activity/workspace-activity.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The workspace activity feed's entries, as `GET /v1/workspace/{id}/activity` returns them, and what
+ * each one says and opens. Everything a person is not pushed (uploads, other people's threads, runs)
+ * can still be found here.
+ */
+/** Where an entry comes from. */
+export type WorkspaceActivitySource = 'thread' | 'message' | 'document' | 'workflow';
+/** One entry of the feed (the shape of the API's `WorkspaceActivityEntry`). */
+export interface WorkspaceActivityItem {
+    external_id: string;
+    source: WorkspaceActivitySource;
+    /** A thread event kind, `message_posted`, `document_uploaded` / `_version` / `_signed`, `workflow_run`. */
+    kind: string;
+    actor_ext_id?: string | null;
+    conversation_ext_id?: string | null;
+    /** Decrypted when the session has the workspace open, else null. */
+    conversation_title?: string | null;
+    message_ext_id?: string | null;
+    document_ext_id?: string | null;
+    document_name?: string | null;
+    version?: number | null;
+    workflow_ext_id?: string | null;
+    workflow_name?: string | null;
+    /** A workflow run's status. */
+    status?: string | null;
+    detail?: Record<string, unknown> | null;
+    created_at: string;
+}
+/** What clicking an entry opens. */
+export type WorkspaceActivityTarget = {
+    kind: 'thread';
+    conversationId: string;
+    messageId?: string;
+} | {
+    kind: 'document';
+    documentId: string;
+    version?: number;
+} | {
+    kind: 'workflow';
+    workflowId: string;
+    conversationId?: string;
+};
+/** The thread, document version or run an entry opens; null when it names nothing openable. */
+export declare function workspaceActivityTarget(item: WorkspaceActivityItem): WorkspaceActivityTarget | null;
+/** What happened, without who did it: "Uploaded “Lease.pdf”", "Marked done in “Smith v Jones”". */
+export declare function workspaceActivityHeadline(item: WorkspaceActivityItem): string;