@ai-matrx/vault 0.1.28 → 0.1.30

package/dist/index.d.cts

@@ -899,6 +899,15 @@ declare function createVaultKnobs(client: KnobClient, address: {
     organizationId: string;
     userId: string;
 }): VaultKnobs;
+/**
+ * The organization's reveal and backup settings every host obeys. They were first set for the desktop
+ * app (`desktop.vault`), and are the only organization settings for them, so the website and the
+ * extension read the same two: a host's own `revealSeconds` / `backupPassphraseMinLength` wins.
+ */
+declare const REVEAL_SECONDS_KNOB = "desktop.vault.reveal_hide_seconds";
+declare const BACKUP_PASSPHRASE_MIN_KNOB = "desktop.vault.backup_passphrase_min_length";
+/** A positive whole number from the organization's settings, else null (unset, unreadable, nonsense). */
+declare function positiveKnob(resolved: Readonly<Record<string, unknown>>, key: string): number | null;
 
 /** Bringing items in and taking them out: imports, login CSV export, encrypted backup and restore. */
 
@@ -1252,8 +1261,16 @@ interface VaultHostCapabilities {
     lock?: VaultLock;
     /** The host's clipboard: every copy goes through it; a secret is the host's to clear (`lock.ts`). */
     clipboard?: VaultClipboard;
-    /** How long a shown value stays shown, in seconds (an organization knob the host reads); default 20. */
+    /**
+     * How long a shown value stays shown, in seconds. Without it the organization's setting
+     * (`REVEAL_SECONDS_KNOB`, read through `knobs`) decides; with neither, 20.
+     */
     revealSeconds?: number;
+    /**
+     * The shortest passphrase an encrypted backup takes. Without it the organization's setting
+     * (`BACKUP_PASSPHRASE_MIN_KNOB`, read through `knobs`) decides; with neither, any passphrase.
+     */
+    backupPassphraseMinLength?: number;
     /**
      * How often the list re-reads itself while the vault is on screen, in seconds (the desktop's
      * refresh knob). Without it the organization's `vault.list.refresh_seconds` knob decides; with
@@ -1300,9 +1317,18 @@ interface VaultLock {
  * the host to take custody: clear it after a while if it is still there, and on lock or quit.
  */
 interface VaultClipboard {
+    /**
+     * Writes `text`. A host that clears a secret later may answer when (`clearsAtMs`, epoch ms): the
+     * copied line then says "Clears at 3:42 PM". Answering nothing says only "<label> copied".
+     */
     copy(text: string, how: {
         secret: boolean;
-    }): Promise<void>;
+    }): Promise<void | VaultCopied>;
+}
+/** What a host clipboard may answer after a copy. */
+interface VaultCopied {
+    /** When the host will clear what it just wrote (epoch ms); null or absent = it will not. */
+    clearsAtMs?: number | null;
 }
 declare const LOCKED_MESSAGE = "The vault is locked. Unlock it first.";
 declare class VaultLockedError extends Error {
@@ -1329,6 +1355,8 @@ declare function copyValue(text: string, label: string, options: CopyOptions, de
     clipboard?: VaultClipboard | undefined;
     notify: Notify;
 }): Promise<boolean>;
+/** "Password copied", or "Password copied. Clears at 3:42 PM" when the host says when it clears it. */
+declare function copiedLine(label: string, clearsAtMs: number | null): string;
 
 /**
  * What an agent may know about the vault: its NON-SECRET shape, never a value.
@@ -1392,7 +1420,7 @@ interface VaultAppProps {
     onInventory?: (inventory: VaultInventory) => void;
 }
 /** THE VAULT WORKSPACE: one component for the web app, the extension side panel and the desktop app. */
-declare function VaultApp(props: VaultAppProps): react.JSX.Element;
+declare function VaultApp(given: VaultAppProps): react.JSX.Element;
 
 interface SharingPortOptions {
     /**
@@ -1452,13 +1480,24 @@ declare function GenerateButton({ onUse, label, limits, disabled }: {
     disabled?: boolean;
 }): react.JSX.Element | null;
 
+/**
+ * A HOST OBJECT THE SCREEN OWNS (a port to the page, a subscription to main): made and disposed in
+ * the SAME effect, so React's StrictMode mount → cleanup → mount (and any remount) leaves a live one,
+ * never the disposed first copy a `useMemo` + cleanup-only effect would keep. null until the first
+ * effect runs (render a placeholder, never a host without it). `deps` re-make it, as `useEffect`'s.
+ */
+declare function useDisposable<T extends {
+    dispose(): void;
+}>(create: () => T, deps: readonly unknown[]): T | null;
+
 /**
  * THE row menu's entries, one source for every menu that offers them: the row's own More button and
  * right-click menu, and a host's own right-click menu (the website's v3 menu, which wraps the vault
  * and so cannot render the package's hooks). Each list row registers a reader of its CURRENT entries
  * on its element; `rowMenuEntriesAt(target)` reads them for whatever a right-click landed on.
  */
-type RowMenuEntryKind = "copy" | "favorite" | "open" | "copy-name" | "host";
+/** `manage`: Activity, Share and Delete, the item's own actions offered on its row. */
+type RowMenuEntryKind = "copy" | "favorite" | "open" | "copy-name" | "manage" | "host";
 interface RowMenuEntry {
     label: string;
     onSelect: () => void;
@@ -1470,6 +1509,8 @@ interface RowMenuEntry {
 }
 /** The entries of the row a right-click landed on (`[data-item]`), else none. */
 declare function rowMenuEntriesAt(target: Element | null | undefined): readonly RowMenuEntry[];
+/** The item actions a row's menu offers beside copy and open (every host, one list). */
+type RowItemAction = "activity" | "share" | "delete";
 
 /**
  * AN EMPTY CREDENTIAL IS A FACT; AN EMPTY READ OF A FULL ONE IS A FAILURE (DD-160, lane
@@ -1515,4 +1556,4 @@ declare function holdingsDoorIsAbsent(code: string | undefined | null): boolean;
  */
 declare function emptyReadAlarm(total: number, emptyIds: readonly string[], holdings: Holdings): string | null;
 
-export { type ApiVaultPortOptions, CATEGORIES, CONFIRM_RETURN_KEY, type CategoryId, type Confirmed, type CopyOptions, DEFAULT_LOCATION, type DefinitionField, type FieldHandling, type FieldKind, GenerateButton, HIDDEN_ITEM_TAG, HOLDINGS_DOOR_MIGRATION, type HoldingRow, type Holdings, type IdentityAccount, IdentityGate, type IdentityMethod, type ItemDraft, LOCKED_MESSAGE, type NoticeKind, type Notify, type ReturnStore, type RowMenuEntry, type RowMenuEntryKind, type SaveResult, type SupabaseAuthLike, type SupabaseIdentityOptions, type TotpReading, type UriMatchMode, type UrlGuess, type VaultAgentScope, VaultApp, type VaultAppProps, type VaultAttachment, type VaultAuthenticator, type VaultClipboard, type VaultCustomField, type VaultDefinition, type VaultField, type VaultHostCapabilities, type VaultIdentity, type VaultInventory, type VaultItem, type VaultItemCapabilities, type VaultKnobs, type VaultLayout, type VaultLocation, type VaultLock, VaultLockedError, type VaultOrganizationRef, type VaultOwner, type VaultPort, type VaultSelection, type VaultSnapshot, type VaultSort, type VaultUserStateDoor, categoryOf, copyValue, createApiVaultPort, createSupabaseIdentity, createVaultKnobs, emptyReadAlarm, guardPort, holdingsDoorIsAbsent, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, providerOf, rowMenuEntriesAt, siteDomainOf, sortItems, useConfirmed, vaultInventoryScope, vaultItemFacts, wasCancelled };
+export { type ApiVaultPortOptions, BACKUP_PASSPHRASE_MIN_KNOB, CATEGORIES, CONFIRM_RETURN_KEY, type CategoryId, type Confirmed, type CopyOptions, DEFAULT_LOCATION, type DefinitionField, type FieldHandling, type FieldKind, GenerateButton, HIDDEN_ITEM_TAG, HOLDINGS_DOOR_MIGRATION, type HoldingRow, type Holdings, type IdentityAccount, IdentityGate, type IdentityMethod, type ItemDraft, LOCKED_MESSAGE, type NoticeKind, type Notify, REVEAL_SECONDS_KNOB, type ReturnStore, type RowItemAction, type RowMenuEntry, type RowMenuEntryKind, type SaveResult, type SupabaseAuthLike, type SupabaseIdentityOptions, type TotpReading, type UriMatchMode, type UrlGuess, type VaultAgentScope, VaultApp, type VaultAppProps, type VaultAttachment, type VaultAuthenticator, type VaultClipboard, type VaultCopied, type VaultCustomField, type VaultDefinition, type VaultField, type VaultHostCapabilities, type VaultIdentity, type VaultInventory, type VaultItem, type VaultItemCapabilities, type VaultKnobs, type VaultLayout, type VaultLocation, type VaultLock, VaultLockedError, type VaultOrganizationRef, type VaultOwner, type VaultPort, type VaultSelection, type VaultSnapshot, type VaultSort, type VaultUserStateDoor, categoryOf, copiedLine, copyValue, createApiVaultPort, createSupabaseIdentity, createVaultKnobs, emptyReadAlarm, guardPort, holdingsDoorIsAbsent, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, positiveKnob, providerOf, rowMenuEntriesAt, siteDomainOf, sortItems, useConfirmed, useDisposable, vaultInventoryScope, vaultItemFacts, wasCancelled };

package/dist/index.d.ts

@@ -899,6 +899,15 @@ declare function createVaultKnobs(client: KnobClient, address: {
     organizationId: string;
     userId: string;
 }): VaultKnobs;
+/**
+ * The organization's reveal and backup settings every host obeys. They were first set for the desktop
+ * app (`desktop.vault`), and are the only organization settings for them, so the website and the
+ * extension read the same two: a host's own `revealSeconds` / `backupPassphraseMinLength` wins.
+ */
+declare const REVEAL_SECONDS_KNOB = "desktop.vault.reveal_hide_seconds";
+declare const BACKUP_PASSPHRASE_MIN_KNOB = "desktop.vault.backup_passphrase_min_length";
+/** A positive whole number from the organization's settings, else null (unset, unreadable, nonsense). */
+declare function positiveKnob(resolved: Readonly<Record<string, unknown>>, key: string): number | null;
 
 /** Bringing items in and taking them out: imports, login CSV export, encrypted backup and restore. */
 
@@ -1252,8 +1261,16 @@ interface VaultHostCapabilities {
     lock?: VaultLock;
     /** The host's clipboard: every copy goes through it; a secret is the host's to clear (`lock.ts`). */
     clipboard?: VaultClipboard;
-    /** How long a shown value stays shown, in seconds (an organization knob the host reads); default 20. */
+    /**
+     * How long a shown value stays shown, in seconds. Without it the organization's setting
+     * (`REVEAL_SECONDS_KNOB`, read through `knobs`) decides; with neither, 20.
+     */
     revealSeconds?: number;
+    /**
+     * The shortest passphrase an encrypted backup takes. Without it the organization's setting
+     * (`BACKUP_PASSPHRASE_MIN_KNOB`, read through `knobs`) decides; with neither, any passphrase.
+     */
+    backupPassphraseMinLength?: number;
     /**
      * How often the list re-reads itself while the vault is on screen, in seconds (the desktop's
      * refresh knob). Without it the organization's `vault.list.refresh_seconds` knob decides; with
@@ -1300,9 +1317,18 @@ interface VaultLock {
  * the host to take custody: clear it after a while if it is still there, and on lock or quit.
  */
 interface VaultClipboard {
+    /**
+     * Writes `text`. A host that clears a secret later may answer when (`clearsAtMs`, epoch ms): the
+     * copied line then says "Clears at 3:42 PM". Answering nothing says only "<label> copied".
+     */
     copy(text: string, how: {
         secret: boolean;
-    }): Promise<void>;
+    }): Promise<void | VaultCopied>;
+}
+/** What a host clipboard may answer after a copy. */
+interface VaultCopied {
+    /** When the host will clear what it just wrote (epoch ms); null or absent = it will not. */
+    clearsAtMs?: number | null;
 }
 declare const LOCKED_MESSAGE = "The vault is locked. Unlock it first.";
 declare class VaultLockedError extends Error {
@@ -1329,6 +1355,8 @@ declare function copyValue(text: string, label: string, options: CopyOptions, de
     clipboard?: VaultClipboard | undefined;
     notify: Notify;
 }): Promise<boolean>;
+/** "Password copied", or "Password copied. Clears at 3:42 PM" when the host says when it clears it. */
+declare function copiedLine(label: string, clearsAtMs: number | null): string;
 
 /**
  * What an agent may know about the vault: its NON-SECRET shape, never a value.
@@ -1392,7 +1420,7 @@ interface VaultAppProps {
     onInventory?: (inventory: VaultInventory) => void;
 }
 /** THE VAULT WORKSPACE: one component for the web app, the extension side panel and the desktop app. */
-declare function VaultApp(props: VaultAppProps): react.JSX.Element;
+declare function VaultApp(given: VaultAppProps): react.JSX.Element;
 
 interface SharingPortOptions {
     /**
@@ -1452,13 +1480,24 @@ declare function GenerateButton({ onUse, label, limits, disabled }: {
     disabled?: boolean;
 }): react.JSX.Element | null;
 
+/**
+ * A HOST OBJECT THE SCREEN OWNS (a port to the page, a subscription to main): made and disposed in
+ * the SAME effect, so React's StrictMode mount → cleanup → mount (and any remount) leaves a live one,
+ * never the disposed first copy a `useMemo` + cleanup-only effect would keep. null until the first
+ * effect runs (render a placeholder, never a host without it). `deps` re-make it, as `useEffect`'s.
+ */
+declare function useDisposable<T extends {
+    dispose(): void;
+}>(create: () => T, deps: readonly unknown[]): T | null;
+
 /**
  * THE row menu's entries, one source for every menu that offers them: the row's own More button and
  * right-click menu, and a host's own right-click menu (the website's v3 menu, which wraps the vault
  * and so cannot render the package's hooks). Each list row registers a reader of its CURRENT entries
  * on its element; `rowMenuEntriesAt(target)` reads them for whatever a right-click landed on.
  */
-type RowMenuEntryKind = "copy" | "favorite" | "open" | "copy-name" | "host";
+/** `manage`: Activity, Share and Delete, the item's own actions offered on its row. */
+type RowMenuEntryKind = "copy" | "favorite" | "open" | "copy-name" | "manage" | "host";
 interface RowMenuEntry {
     label: string;
     onSelect: () => void;
@@ -1470,6 +1509,8 @@ interface RowMenuEntry {
 }
 /** The entries of the row a right-click landed on (`[data-item]`), else none. */
 declare function rowMenuEntriesAt(target: Element | null | undefined): readonly RowMenuEntry[];
+/** The item actions a row's menu offers beside copy and open (every host, one list). */
+type RowItemAction = "activity" | "share" | "delete";
 
 /**
  * AN EMPTY CREDENTIAL IS A FACT; AN EMPTY READ OF A FULL ONE IS A FAILURE (DD-160, lane
@@ -1515,4 +1556,4 @@ declare function holdingsDoorIsAbsent(code: string | undefined | null): boolean;
  */
 declare function emptyReadAlarm(total: number, emptyIds: readonly string[], holdings: Holdings): string | null;
 
-export { type ApiVaultPortOptions, CATEGORIES, CONFIRM_RETURN_KEY, type CategoryId, type Confirmed, type CopyOptions, DEFAULT_LOCATION, type DefinitionField, type FieldHandling, type FieldKind, GenerateButton, HIDDEN_ITEM_TAG, HOLDINGS_DOOR_MIGRATION, type HoldingRow, type Holdings, type IdentityAccount, IdentityGate, type IdentityMethod, type ItemDraft, LOCKED_MESSAGE, type NoticeKind, type Notify, type ReturnStore, type RowMenuEntry, type RowMenuEntryKind, type SaveResult, type SupabaseAuthLike, type SupabaseIdentityOptions, type TotpReading, type UriMatchMode, type UrlGuess, type VaultAgentScope, VaultApp, type VaultAppProps, type VaultAttachment, type VaultAuthenticator, type VaultClipboard, type VaultCustomField, type VaultDefinition, type VaultField, type VaultHostCapabilities, type VaultIdentity, type VaultInventory, type VaultItem, type VaultItemCapabilities, type VaultKnobs, type VaultLayout, type VaultLocation, type VaultLock, VaultLockedError, type VaultOrganizationRef, type VaultOwner, type VaultPort, type VaultSelection, type VaultSnapshot, type VaultSort, type VaultUserStateDoor, categoryOf, copyValue, createApiVaultPort, createSupabaseIdentity, createVaultKnobs, emptyReadAlarm, guardPort, holdingsDoorIsAbsent, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, providerOf, rowMenuEntriesAt, siteDomainOf, sortItems, useConfirmed, vaultInventoryScope, vaultItemFacts, wasCancelled };
+export { type ApiVaultPortOptions, BACKUP_PASSPHRASE_MIN_KNOB, CATEGORIES, CONFIRM_RETURN_KEY, type CategoryId, type Confirmed, type CopyOptions, DEFAULT_LOCATION, type DefinitionField, type FieldHandling, type FieldKind, GenerateButton, HIDDEN_ITEM_TAG, HOLDINGS_DOOR_MIGRATION, type HoldingRow, type Holdings, type IdentityAccount, IdentityGate, type IdentityMethod, type ItemDraft, LOCKED_MESSAGE, type NoticeKind, type Notify, REVEAL_SECONDS_KNOB, type ReturnStore, type RowItemAction, type RowMenuEntry, type RowMenuEntryKind, type SaveResult, type SupabaseAuthLike, type SupabaseIdentityOptions, type TotpReading, type UriMatchMode, type UrlGuess, type VaultAgentScope, VaultApp, type VaultAppProps, type VaultAttachment, type VaultAuthenticator, type VaultClipboard, type VaultCopied, type VaultCustomField, type VaultDefinition, type VaultField, type VaultHostCapabilities, type VaultIdentity, type VaultInventory, type VaultItem, type VaultItemCapabilities, type VaultKnobs, type VaultLayout, type VaultLocation, type VaultLock, VaultLockedError, type VaultOrganizationRef, type VaultOwner, type VaultPort, type VaultSelection, type VaultSnapshot, type VaultSort, type VaultUserStateDoor, categoryOf, copiedLine, copyValue, createApiVaultPort, createSupabaseIdentity, createVaultKnobs, emptyReadAlarm, guardPort, holdingsDoorIsAbsent, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, positiveKnob, providerOf, rowMenuEntriesAt, siteDomainOf, sortItems, useConfirmed, useDisposable, vaultInventoryScope, vaultItemFacts, wasCancelled };