@ai-matrx/vault 0.1.20 → 0.1.22

package/dist/index.d.cts

@@ -39,6 +39,14 @@ interface VaultOwner {
     kind: "me" | "organization" | "shared";
     label: string;
     organizationId: string | null;
+    /**
+     * An organization's list also holds a member's OWN credential they shared into it: it is
+     * attributed to the organization it came through (kind "organization"), never to the viewer,
+     * and this says so. Absent on everything else.
+     */
+    memberShared?: {
+        userId: string | null;
+    };
 }
 interface VaultItemCapabilities {
     canUse: boolean;
@@ -1159,6 +1167,11 @@ interface SaveResult {
 interface VaultSnapshot {
     /** Parts that could not be read this time (an organization, shared items, one-time codes). */
     unavailable: readonly string[];
+    /**
+     * Parts still being read (organization names, "Shared with me"): set only on a partial snapshot
+     * handed to `load`'s `onProgress`; the snapshot `load` resolves with never has it.
+     */
+    pending?: readonly string[];
     items: readonly VaultItem[];
     /** Items in the trash (deleted, still recoverable). Never mixed into `items`. */
     deleted: readonly VaultItem[];
@@ -1172,7 +1185,11 @@ interface VaultSnapshot {
  * `sharing`, …) in its own folder.
  */
 interface VaultPort {
-    load(): Promise<VaultSnapshot>;
+    /**
+     * The whole vault. `onProgress` (optional) is called with partial snapshots as parts arrive: the
+     * person's own items first, then each organization's list the moment it answers.
+     */
+    load(onProgress?: (partial: VaultSnapshot) => void): Promise<VaultSnapshot>;
     /** The one path to a plaintext value. Audited by the server; handling `sealed` always refuses. */
     reveal(item: VaultItem, fieldKey: string): Promise<string>;
     /** `organizationId` null = the person's own vault. */
@@ -1427,4 +1444,23 @@ declare function GenerateButton({ onUse, label, limits, disabled }: {
     disabled?: boolean;
 }): react.JSX.Element | 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, type IdentityAccount, IdentityGate, type IdentityMethod, type ItemDraft, LOCKED_MESSAGE, type NoticeKind, type Notify, type ReturnStore, 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, guardPort, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, providerOf, siteDomainOf, sortItems, useConfirmed, vaultInventoryScope, vaultItemFacts, wasCancelled };
+/**
+ * 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";
+interface RowMenuEntry {
+    label: string;
+    onSelect: () => void;
+    /** What the entry is, so a host can take only some (the website keeps its own Open and Copy name). */
+    kind?: RowMenuEntryKind;
+    /** Stable key for the entry ("copy:password", "favorite"). */
+    id?: string;
+    disabled?: boolean;
+}
+/** The entries of the row a right-click landed on (`[data-item]`), else none. */
+declare function rowMenuEntriesAt(target: Element | null | undefined): readonly RowMenuEntry[];
+
+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, 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, guardPort, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, providerOf, rowMenuEntriesAt, siteDomainOf, sortItems, useConfirmed, vaultInventoryScope, vaultItemFacts, wasCancelled };

package/dist/index.d.ts

@@ -39,6 +39,14 @@ interface VaultOwner {
     kind: "me" | "organization" | "shared";
     label: string;
     organizationId: string | null;
+    /**
+     * An organization's list also holds a member's OWN credential they shared into it: it is
+     * attributed to the organization it came through (kind "organization"), never to the viewer,
+     * and this says so. Absent on everything else.
+     */
+    memberShared?: {
+        userId: string | null;
+    };
 }
 interface VaultItemCapabilities {
     canUse: boolean;
@@ -1159,6 +1167,11 @@ interface SaveResult {
 interface VaultSnapshot {
     /** Parts that could not be read this time (an organization, shared items, one-time codes). */
     unavailable: readonly string[];
+    /**
+     * Parts still being read (organization names, "Shared with me"): set only on a partial snapshot
+     * handed to `load`'s `onProgress`; the snapshot `load` resolves with never has it.
+     */
+    pending?: readonly string[];
     items: readonly VaultItem[];
     /** Items in the trash (deleted, still recoverable). Never mixed into `items`. */
     deleted: readonly VaultItem[];
@@ -1172,7 +1185,11 @@ interface VaultSnapshot {
  * `sharing`, …) in its own folder.
  */
 interface VaultPort {
-    load(): Promise<VaultSnapshot>;
+    /**
+     * The whole vault. `onProgress` (optional) is called with partial snapshots as parts arrive: the
+     * person's own items first, then each organization's list the moment it answers.
+     */
+    load(onProgress?: (partial: VaultSnapshot) => void): Promise<VaultSnapshot>;
     /** The one path to a plaintext value. Audited by the server; handling `sealed` always refuses. */
     reveal(item: VaultItem, fieldKey: string): Promise<string>;
     /** `organizationId` null = the person's own vault. */
@@ -1427,4 +1444,23 @@ declare function GenerateButton({ onUse, label, limits, disabled }: {
     disabled?: boolean;
 }): react.JSX.Element | 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, type IdentityAccount, IdentityGate, type IdentityMethod, type ItemDraft, LOCKED_MESSAGE, type NoticeKind, type Notify, type ReturnStore, 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, guardPort, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, providerOf, siteDomainOf, sortItems, useConfirmed, vaultInventoryScope, vaultItemFacts, wasCancelled };
+/**
+ * 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";
+interface RowMenuEntry {
+    label: string;
+    onSelect: () => void;
+    /** What the entry is, so a host can take only some (the website keeps its own Open and Copy name). */
+    kind?: RowMenuEntryKind;
+    /** Stable key for the entry ("copy:password", "favorite"). */
+    id?: string;
+    disabled?: boolean;
+}
+/** The entries of the row a right-click landed on (`[data-item]`), else none. */
+declare function rowMenuEntriesAt(target: Element | null | undefined): readonly RowMenuEntry[];
+
+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, 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, guardPort, inferFromUrl, isHiddenItem, itemIdAt, locationFromParams, locationToParams, loginSiteOf, matchesQuery, needsRecentSignIn, parseDefinitions, providerOf, rowMenuEntriesAt, siteDomainOf, sortItems, useConfirmed, vaultInventoryScope, vaultItemFacts, wasCancelled };