@basictech/react 0.12.0-beta.2 → 0.12.0-beta.4

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode, ReactElement, RefObject, ButtonHTMLAttributes, HTMLAttributes } from 'react';
-import { BasicSchema, BasicConfig, BasicClient, BasicAccount, BasicProfile, ReadOnlyReason, AuthStatus as AuthStatus$1, BasicError, AuthUser, BasicSyncStatus, BasicRejection, BasicConflict, SourceRef, SchemaStatus, BasicDb, Repo, FileRecord, MountFileInfo, StorageInfo, FileListQuery, MountInfo, MountHandle, OutgoingShareInfo, CreateOutgoingShareInput, MountsQuery, JsonObject, BasicRecord, Query, ProjectProfile, ProjectProfilePatch, MountViewerFiles, OwnerFiles, TableNames, Collection, InferValue, KeyValueStorage, TokenStore, AuthChannelContext, AuthMessageChannel, ReplicaStoreFactory, StoragePartition, ReplicaStore, UploadTransportAdapter } from '@basictech/core';
+import { BasicSchema, BasicConfig, BasicClient, BasicAccount, BasicProfile, ReadOnlyReason, AuthStatus as AuthStatus$1, BasicError, AuthUser, BasicSyncStatus, BasicRejection, BasicConflict, SourceRef, SchemaStatus, BasicDb, Repo, FileRecord, MountFileInfo, StorageInfo, FileListQuery, MountInfo, MountHandle, OutgoingShareInfo, CreateOutgoingShareInput, MountsQuery, JsonObject, BasicRecord, Query, ProjectProfile, ProjectProfilePatch, ShareInviteInfo, MountViewerFiles, OwnerFiles, TableNames, Collection, InferValue, KeyValueStorage, TokenStore, AuthChannelContext, AuthMessageChannel, ReplicaStoreFactory, StoragePartition, ReplicaStore, UploadTransportAdapter } from '@basictech/core';
 
 type BrowserBasicConfig<S extends BasicSchema = BasicSchema> = BasicConfig<S>;
 /** Create a core client with the complete browser adapter set installed. */
@@ -133,6 +133,29 @@ interface UseProjectProfileResult extends AsyncResult<ProjectProfile | null> {
 }
 declare function useProjectProfile(enabled?: boolean): UseProjectProfileResult;
 
+interface UseShareInvitesResult {
+    data: ShareInviteInfo[];
+    isLoading: boolean;
+    error: BasicError | null;
+    refresh(): void;
+    get(id: string): Promise<ShareInviteInfo>;
+    accept(id: string): Promise<MountInfo>;
+    decline(id: string): Promise<ShareInviteInfo>;
+    delete(id: string): Promise<ShareInviteInfo>;
+    resolveContactHandle(did: string): Promise<string | null>;
+}
+declare function useShareInvites(enabled?: boolean): UseShareInvitesResult;
+
+/** Names/photos are optional app-supplied data, never inferred from a share title. */
+interface ShareRecipient {
+    did: string;
+    name?: string | null;
+    handle?: string | null;
+    picture?: string | null;
+}
+type UseShareRecipientsResult = AsyncResult<ShareRecipient[]>;
+declare function useShareRecipients(dids: readonly string[]): UseShareRecipientsResult;
+
 type CreateBasicConfig<S extends BasicSchema> = BrowserBasicConfig<S> & {
     schema: S;
 };
@@ -169,6 +192,8 @@ interface CreatedBasic<S extends BasicSchema> {
     useStorageInfo(): UseStorageInfoResult;
     useMounts(query?: MountsQuery): UseMountsResult<S>;
     useOutgoingShares(): UseOutgoingSharesResult;
+    useShareInvites(enabled?: boolean): UseShareInvitesResult;
+    useShareRecipients(dids: readonly string[]): UseShareRecipientsResult;
 }
 /** Create one browser client and a complete hook surface bound to its schema. */
 declare function createBasic<const S extends BasicSchema>(config: CreateBasicConfig<S>): CreatedBasic<S>;
@@ -198,6 +223,9 @@ declare function useCollection<V extends JsonObject = JsonObject>(name: string,
 
 interface BasicAppearance {
     theme?: 'light' | 'dark';
+    /** Background color. Choose a light or dark base to match the theme. */
+    base?: string;
+    /** Hex colors get automatic black/white foreground contrast. */
     accent?: string;
     radius?: string;
     density?: 'compact' | 'comfortable';
@@ -218,16 +246,34 @@ interface AuthButtonProps extends BasicButtonProps {
 declare function SignInButton(props: AuthButtonProps): react.JSX.Element;
 declare function SignOutButton(props: AuthButtonProps): react.JSX.Element;
 interface UserAvatarProps extends HTMLAttributes<HTMLSpanElement> {
-    profile?: (Pick<BasicProfile, 'name' | 'handle' | 'email' | 'picture'> & Partial<Pick<BasicProfile, 'kind'>>) | null;
+    profile?: (Pick<BasicProfile, 'name' | 'handle' | 'email' | 'picture'> & Partial<Pick<BasicProfile, 'id' | 'did' | 'kind'>>) | null;
     size?: number;
     showSyncBadge?: boolean;
     sync?: UseSyncStatusResult;
     accounts?: UseAccountsResult;
     auth?: UseAuthResult;
     projectProfile?: UseProjectProfileResult;
+    invites?: UseShareInvitesResult;
+    showInvites?: boolean;
     allowAddAccount?: boolean;
+    menuItems?: UserMenuItem[];
+}
+declare function UserAvatar({ accounts, auth, projectProfile, invites, showInvites, allowAddAccount, menuItems, ...avatarProps }: UserAvatarProps): react.JSX.Element;
+interface ShareRecipientAvatarProps extends HTMLAttributes<HTMLSpanElement> {
+    recipient: ShareRecipient;
+    size?: number;
 }
-declare function UserAvatar({ accounts, auth, projectProfile, allowAddAccount, ...avatarProps }: UserAvatarProps): react.JSX.Element;
+/** Display-only identity: no account menu, sync badge, provider, or profile lookup. */
+declare function ShareRecipientAvatar({ recipient, ...props }: ShareRecipientAvatarProps): react.JSX.Element;
+type ShareRecipientLabelProps = ShareRecipientAvatarProps;
+/** Avatar and visible handle; accepts the same data as the avatar-only components. */
+declare function ShareRecipientLabel({ recipient, size, className, ...props }: ShareRecipientLabelProps): react.JSX.Element;
+interface ShareRecipientAvatarsProps extends HTMLAttributes<HTMLSpanElement> {
+    recipients: readonly ShareRecipient[];
+    size?: number;
+    max?: number;
+}
+declare function ShareRecipientAvatars({ recipients, size, max, className, ...props }: ShareRecipientAvatarsProps): react.JSX.Element;
 declare function AuthStatus({ auth: supplied, className, ...props }: HTMLAttributes<HTMLSpanElement> & {
     auth?: UseAuthResult;
 }): react.JSX.Element;
@@ -235,6 +281,19 @@ declare function SyncStatus({ sync: supplied, source, className, ...props }: HTM
     sync?: UseSyncStatusResult;
     source?: SourceRef;
 }): react.JSX.Element | null;
+/** App-owned items appear after Manage account and before Sign out. */
+type UserMenuItem = {
+    id: string;
+    label: string;
+    icon?: ReactNode;
+    disabled?: boolean;
+} & ({
+    href: string;
+    onClick?: never;
+} | {
+    onClick: () => void | Promise<void>;
+    href?: never;
+});
 interface UserButtonProps {
     accounts?: UseAccountsResult;
     auth?: UseAuthResult;
@@ -245,17 +304,20 @@ interface UserButtonProps {
     showSyncBadge?: boolean;
     shape?: 'rounded' | 'square';
     projectProfile?: UseProjectProfileResult;
+    invites?: UseShareInvitesResult;
+    showInvites?: boolean;
     /** Show the action to sign in to another account. Defaults to true. */
     allowAddAccount?: boolean;
     className?: string;
     accountSettingsUrl?: string;
+    menuItems?: UserMenuItem[];
 }
 declare function UserButton(props: UserButtonProps): react.JSX.Element;
 interface UserMenuProps extends UserButtonProps {
     trigger?: 'avatar' | 'button';
     avatarProps?: UserAvatarProps;
 }
-declare function UserMenu({ accounts: supplied, auth: suppliedAuth, sync, showSyncStatus, showSyncBadge, shape, trigger, avatarProps, projectProfile, allowAddAccount, className, accountSettingsUrl, }: UserMenuProps): react.JSX.Element;
+declare function UserMenu({ accounts: supplied, auth: suppliedAuth, sync, showSyncStatus, showSyncBadge, shape, trigger, avatarProps, projectProfile, invites, showInvites, allowAddAccount, className, accountSettingsUrl, menuItems, }: UserMenuProps): react.JSX.Element;
 interface BasicModalProps {
     open?: boolean;
     onOpenChange?: (open: boolean) => void;
@@ -267,21 +329,39 @@ interface AccountSettingsModalProps extends BasicModalProps {
     auth?: UseAuthResult;
     accounts?: UseAccountsResult;
     projectProfile?: UseProjectProfileResult;
+    invites?: UseShareInvitesResult;
+    /** Show the in-app invitation inbox. Defaults to true; loads only when selected. */
+    showInvites?: boolean;
     sync?: UseSyncStatusResult;
     accountSettingsUrl?: string;
     children?: ReactNode;
 }
-declare function AccountSettingsModal({ auth: suppliedAuth, accounts: suppliedAccounts, accountSettingsUrl, projectProfile, sync, children, ...props }: AccountSettingsModalProps): react.JSX.Element;
+declare function AccountSettingsModal({ auth: suppliedAuth, accounts: suppliedAccounts, accountSettingsUrl, projectProfile, invites, showInvites, sync, children, ...props }: AccountSettingsModalProps): react.JSX.Element;
+interface ShareInvitesProps extends HTMLAttributes<HTMLElement> {
+    auth?: UseAuthResult;
+    accounts?: UseAccountsResult;
+    /** Optional complete hook result, useful for previews or app-owned state. */
+    invites?: UseShareInvitesResult;
+}
+/** Inline invitation inbox, shared by standalone and account-settings dialogs. */
+declare function ShareInvites({ auth: suppliedAuth, accounts: suppliedAccounts, invites, className, ...props }: ShareInvitesProps): react.JSX.Element;
+interface ShareInvitesModalProps extends BasicModalProps {
+    auth?: UseAuthResult;
+    accounts?: UseAccountsResult;
+    invites?: UseShareInvitesResult;
+}
+declare function ShareInvitesModal({ auth, accounts, invites, ...props }: ShareInvitesModalProps): react.JSX.Element;
 interface SharesModalProps extends BasicModalProps {
     auth?: UseAuthResult;
     accounts?: UseAccountsResult;
     sync?: UseSyncStatusResult;
     shares?: UseOutgoingSharesResult;
+    invites?: UseShareInvitesResult;
     /** Explicit least-privilege scope; the component never infers all tables. */
     scope: CreateOutgoingShareInput['scope'];
     repo?: CreateOutgoingShareInput['repo'];
 }
-declare function SharesModal({ auth: supplied, accounts: suppliedAccounts, sync, shares, scope, repo, ...props }: SharesModalProps): react.JSX.Element;
+declare function SharesModal({ auth: supplied, accounts: suppliedAccounts, sync, shares, invites, scope, repo, ...props }: SharesModalProps): react.JSX.Element;
 
 /** Synchronous browser Storage adapted to core's key-value contract. */
 declare class BrowserKeyValueStorage implements KeyValueStorage {
@@ -378,4 +458,4 @@ declare class PersistenceStore implements ReplicaStoreFactory {
 /** Browser multipart transport with upload progress, adapted from the Drive UI. */
 declare const browserUploadTransport: UploadTransportAdapter;
 
-export { type AccessTokenAdopter, AccountSettingsModal, type AccountSettingsModalProps, type AuthButtonProps, AuthStatus, type BasicAppearance, BasicButton, type BasicButtonProps, type BasicModalProps, BasicProvider, type BasicProviderProps, BasicUIProvider, type BoundBasicProviderProps, type BrowserBasicConfig, BrowserKeyValueStorage, type BrowserLockManager, type BrowserMessageChannel, BrowserTokenStore, type CreateBasicConfig, type CreatedBasic, PersistenceStore, type PersistenceStoreOptions, SharesModal, type SharesModalProps, SignInButton, SignOutButton, SyncStatus, type UseAccountsResult, type UseAuthResult, type UseBasicResult, type UseFilesResult, type UseMountsResult, type UseOutgoingSharesResult, type UseProjectProfileResult, type UseQueryResult, type UseReposResult, type UseStorageInfoResult, type UseSyncStatusResult, UserAvatar, type UserAvatarProps, UserButton, type UserButtonProps, UserMenu, type UserMenuProps, browserCurrentUrl, browserNavigate, browserReplaceUrl, browserStorage, browserUploadTransport, createBasic, createBasicClient, createBrowserAuthChannelFactory, createBrowserMessageChannel, useAccounts, useAuth, useBasic, useCollection, useDb, useFiles, useMounts, useOutgoingShares, useProjectProfile, useQuery, useRepos, useSchemaStatus, useStorageInfo, useSyncStatus };
+export { type AccessTokenAdopter, AccountSettingsModal, type AccountSettingsModalProps, type AuthButtonProps, AuthStatus, type BasicAppearance, BasicButton, type BasicButtonProps, type BasicModalProps, BasicProvider, type BasicProviderProps, BasicUIProvider, type BoundBasicProviderProps, type BrowserBasicConfig, BrowserKeyValueStorage, type BrowserLockManager, type BrowserMessageChannel, BrowserTokenStore, type CreateBasicConfig, type CreatedBasic, PersistenceStore, type PersistenceStoreOptions, ShareInvites, ShareInvitesModal, type ShareInvitesModalProps, type ShareInvitesProps, type ShareRecipient, ShareRecipientAvatar, type ShareRecipientAvatarProps, ShareRecipientAvatars, type ShareRecipientAvatarsProps, ShareRecipientLabel, type ShareRecipientLabelProps, SharesModal, type SharesModalProps, SignInButton, SignOutButton, SyncStatus, type UseAccountsResult, type UseAuthResult, type UseBasicResult, type UseFilesResult, type UseMountsResult, type UseOutgoingSharesResult, type UseProjectProfileResult, type UseQueryResult, type UseReposResult, type UseShareInvitesResult, type UseShareRecipientsResult, type UseStorageInfoResult, type UseSyncStatusResult, UserAvatar, type UserAvatarProps, UserButton, type UserButtonProps, UserMenu, type UserMenuItem, type UserMenuProps, browserCurrentUrl, browserNavigate, browserReplaceUrl, browserStorage, browserUploadTransport, createBasic, createBasicClient, createBrowserAuthChannelFactory, createBrowserMessageChannel, useAccounts, useAuth, useBasic, useCollection, useDb, useFiles, useMounts, useOutgoingShares, useProjectProfile, useQuery, useRepos, useSchemaStatus, useShareInvites, useShareRecipients, useStorageInfo, useSyncStatus };