@sparkvault/sdk-mobile 7.0.1 → 7.0.3

package/src/types.ts

@@ -67,6 +67,13 @@ export interface SparkVaultUser {
   name?: string;
   role: OrgRole;
   has_passkey?: boolean;
+  /**
+   * Whether this user is the account owner (the member whose email is the
+   * account's email), who alone may delete the account. Only GET /v1/profile
+   * sends it: a sign-in, signup or refresh answer, and a profile save's
+   * answer, carry no flag.
+   */
+  is_account_owner?: boolean;
   created_at: number;
 }
 
@@ -731,6 +738,10 @@ export interface FolderContentsResponse {
 
 export interface UploadResult {
   ingot_id: string;
+  /**
+   * The name the ingot is stored under: the server's numbered name under
+   * `new_name`, and for a replace the name it was sent, else the one it kept.
+   */
   name: string;
   size_bytes: number;
   storage_location: 's3';
@@ -749,14 +760,40 @@ export interface UploadResult {
    * `retryLater` is set.
    */
   status?: Ingot['status'];
+  /**
+   * The ingot's `content_version` (Forge's activation marker) as the strongly
+   * consistent read after the transfer found it, null when the server
+   * recorded none. It is this upload's publication or a later writer's that
+   * already replaced it, so it does not say which publication holds these
+   * bytes. A read-modify-write names this upload's own publication, its
+   * session's `uploadId` (`IngotUploadSession`), as the next replace's
+   * `expectedContentVersion`, so a save built on stale content is refused
+   * (412) instead of discarding another writer's changes.
+   */
+  content_version: string | null;
 }
 
+/**
+ * An Ingot's durable sharing settings, as GET and PUT
+ * /vaults/:id/ingots/:ingot_id/sharing answer them (apps/api/src/ingots/sharing.js,
+ * `formatSharingConfig`; `ingots.test-d.ts` pins the field set).
+ */
 export interface IngotSharingConfig {
+  ingot_id: string;
+  vault_id: string;
+  /** Whether the vault shares files at all. */
+  sharing_enabled: boolean;
   shared: boolean;
-  visibility?: 'invite_only' | 'authenticated' | 'public';
-  share_code?: string;
-  share_url?: string;
-  invites?: IngotInvite[];
+  /** Null while the Ingot is not shared. */
+  visibility: 'invite_only' | 'authenticated' | 'public' | null;
+  /** The Ingot's durable files.sv link; null while it is not shared. */
+  public_url: string | null;
+  /** The code in `public_url`; null while the Ingot is not shared. */
+  link_code: string | null;
+  /** Whether the vault makes every Ingot public, which pins this one to Public. */
+  vault_all_ingots_public: boolean;
+  session_length_seconds: number;
+  invites: IngotInvite[];
 }
 
 export interface IngotInvite {
@@ -892,6 +929,16 @@ export interface IngotUploadSession extends TusSessionInfo {
   ingotId: string;
   /** Whether the upload minted the ingot (see `UploadResult.created`). */
   created: boolean;
+  /**
+   * Forge's id for this upload (the session URL's last segment), which the
+   * server stamps as the ingot's `content_version` when the upload publishes.
+   * Forge acknowledges the final chunk only once the upload published, so an
+   * upload that succeeded published as this id. One that failed with its last
+   * answer lost may still have published, or publish later: the ingot's
+   * `content_version` reading this id says it did, and any other value proves
+   * nothing either way.
+   */
+  uploadId: string;
 }
 
 /**