@sparkvault/sdk-mobile 6.0.2 → 7.0.1

package/src/vaults.ts

@@ -1,75 +1,33 @@
 import type { MobileHttpClient } from './http.js';
 import type {
+  AccessLogRetention,
   CreateVaultRequest,
   CreateVaultResponse,
+  DisableVaultSharingResponse,
+  EnableVaultSharingResponse,
   ListVaultsResponse,
   UnsealVaultRequest,
   UnsealVaultResponse,
+  UpdateAccessLogRetentionResponse,
   UpdateVaultRequest,
   UpdateVaultResponse,
+  UpdateVaultSharingResponse,
+  UploadConfig,
+  UploadConfigUpdate,
+  UploadPortalDisabled,
+  UploadPortalEnabled,
+  UploadWidgetDisabled,
+  UploadWidgetEnabled,
   Vault,
+  VaultSharingConfig,
+  VaultSharingOptions,
 } from './types.js';
 import { validateVaultId } from './validation.js';
 import { base64EncodeUtf8 } from './encoding.js';
+import { apiPath } from './request-path.js';
 
-/** A string every char of which fits in a single header byte (latin1). */
-function isLatin1(value: string): boolean {
-  for (let i = 0; i < value.length; i++) {
-    if (value.charCodeAt(i) > 0xff) return false;
-  }
-  return true;
-}
-
-export interface SharingConfig {
-  vault_id: string;
-  public_sharing_enabled: boolean;
-  all_ingots_public: boolean;
-  session_length_seconds: number | null;
-  enabled_at: number | null;
-}
-
-export interface UploadConfig {
-  vault_id: string;
-  upload_portal_enabled: boolean;
-  upload_portal_enabled_at: number | null;
-  upload_widget_enabled: boolean;
-  upload_widget_enabled_at: number | null;
-  max_size_bytes: number | null;
-  notification_email: string | null;
-  portal_url?: string;
-}
-
-export interface UploadPortalEnabled {
-  vault_id: string;
-  upload_portal_enabled: true;
-  enabled_at: number;
-  portal_url: string;
-}
-
-export interface UploadWidgetEnabled {
-  vault_id: string;
-  upload_widget_enabled: true;
-  enabled_at: number;
-}
-
-export interface UploadPortalDisabled {
-  vault_id: string;
-  upload_portal_enabled: false;
-  disabled_at: number;
-}
-
-export interface UploadWidgetDisabled {
-  vault_id: string;
-  upload_widget_enabled: false;
-  disabled_at: number;
-}
-
-export interface UploadConfigUpdate {
-  vault_id: string;
-  max_size_bytes: number;
-  notification_email: string | null;
-  updated_at: number;
-}
+/** GET /v1/vaults' largest page (apps/api vaults/list.js maxLimit). */
+const VAULT_LIST_PAGE_LIMIT = 500;
 
 export class MobileVaultsClient {
   private readonly http: MobileHttpClient;
@@ -79,7 +37,7 @@ export class MobileVaultsClient {
   }
 
   async create(request: CreateVaultRequest): Promise<CreateVaultResponse> {
-    const response = await this.http.post<CreateVaultResponse>('/vaults', request);
+    const response = await this.http.post<CreateVaultResponse>(apiPath`/vaults`, request);
     return response.data;
   }
 
@@ -88,25 +46,38 @@ export class MobileVaultsClient {
     limit?: number;
     cursor?: string;
   }): Promise<ListVaultsResponse> {
-    const params = new URLSearchParams();
-    if (options?.status) params.append('status', options.status);
-    if (options?.limit) params.append('limit', options.limit.toString());
-    if (options?.cursor) params.append('cursor', options.cursor);
-
-    const query = params.toString();
-    const response = await this.http.get<ListVaultsResponse>(query ? `/vaults?${query}` : '/vaults');
+    const response = await this.http.get<ListVaultsResponse>(apiPath`/vaults`, {
+      query: { status: options?.status, limit: options?.limit || undefined, cursor: options?.cursor },
+    });
     return response.data;
   }
 
+  /**
+   * Every vault on the account, newest first. Follows next_cursor at the
+   * largest page size until the server reports no more — a page the server
+   * filtered down to nothing still carries a cursor. A failed page fails the
+   * listing: a vault picker must never show a silently partial account.
+   */
+  async listAll(options?: { status?: 'sealed' | 'unsealed' }): Promise<Vault[]> {
+    const vaults: Vault[] = [];
+    let cursor: string | undefined;
+    do {
+      const page = await this.list({ ...options, limit: VAULT_LIST_PAGE_LIMIT, cursor });
+      vaults.push(...page.vaults);
+      cursor = page.has_more ? page.next_cursor : undefined;
+    } while (cursor);
+    return vaults;
+  }
+
   async get(vaultId: string): Promise<Vault> {
     validateVaultId(vaultId);
-    const response = await this.http.get<Vault>(`/vaults/${vaultId}`);
+    const response = await this.http.get<Vault>(apiPath`/vaults/${vaultId}`);
     return response.data;
   }
 
   async update(vaultId: string, request: UpdateVaultRequest): Promise<UpdateVaultResponse> {
     validateVaultId(vaultId);
-    const response = await this.http.put<UpdateVaultResponse>(`/vaults/${vaultId}`, request);
+    const response = await this.http.put<UpdateVaultResponse>(apiPath`/vaults/${vaultId}`, request);
     return response.data;
   }
 
@@ -117,62 +88,58 @@ export class MobileVaultsClient {
    * The name is sent base64(UTF-8) as `X-Confirm-Name-B64` so that vaults named
    * with any Unicode (emoji, CJK, the U+202F in macOS-style names) are
    * deletable — a raw header value throws before the request is sent for
-   * non-latin1 characters. The legacy raw header is included only when the name
-   * is latin1-safe, for older API servers.
+   * non-latin1 characters.
    */
   async delete(vaultId: string, name: string): Promise<void> {
     validateVaultId(vaultId);
     if (!name) {
       throw new Error('Vault name is required to confirm deletion');
     }
-    const headers: Record<string, string> = {
-      'X-Confirm-Name-B64': base64EncodeUtf8(name),
-    };
-    if (isLatin1(name)) {
-      headers['X-Confirm-Name'] = name;
-    }
-    await this.http.delete(`/vaults/${vaultId}`, { headers });
+    await this.http.delete(apiPath`/vaults/${vaultId}`, {
+      headers: { 'X-Confirm-Name-B64': base64EncodeUtf8(name) },
+    });
   }
 
   async unseal(vaultId: string, request: UnsealVaultRequest): Promise<UnsealVaultResponse> {
     validateVaultId(vaultId);
-    const response = await this.http.post<UnsealVaultResponse>(`/vaults/${vaultId}/unseal`, request);
+    const response = await this.http.post<UnsealVaultResponse>(apiPath`/vaults/${vaultId}/unseal`, request);
     return response.data;
   }
 
+  /**
+   * Seal the vault: end every session of it, so every VAT minted for it stops
+   * working, whoever holds it. To end only the caller's own session, use
+   * `endSession`.
+   */
   async seal(vaultId: string): Promise<void> {
     validateVaultId(vaultId);
-    await this.http.post(`/vaults/${vaultId}/seal`);
+    await this.http.post(apiPath`/vaults/${vaultId}/seal`);
+  }
+
+  /**
+   * End the session `vat` names, and no other session of the vault: every
+   * other holder keeps theirs. A VAT the server already refuses (an
+   * `isVatExpiredError` or a `vatRefusalReason` of VAT_INVALID) names a
+   * session that is already over.
+   */
+  async endSession(vaultId: string, vat: string): Promise<void> {
+    validateVaultId(vaultId);
+    await this.http.delete(apiPath`/vaults/${vaultId}/session`, { vat });
   }
 
-  async getSharingConfig(vaultId: string): Promise<SharingConfig> {
+  async getSharingConfig(vaultId: string): Promise<VaultSharingConfig> {
     validateVaultId(vaultId);
-    const response = await this.http.get<SharingConfig>(`/vaults/${vaultId}/sharing`);
+    const response = await this.http.get<VaultSharingConfig>(apiPath`/vaults/${vaultId}/sharing`);
     return response.data;
   }
 
   async enableSharing(
     vaultId: string,
     vmk: string,
-    options?: {
-      all_ingots_public?: boolean;
-      session_length_seconds?: number;
-    }
-  ): Promise<{
-    vault_id: string;
-    public_sharing_enabled: boolean;
-    all_ingots_public: boolean;
-    session_length_seconds: number;
-    enabled_at: number;
-  }> {
+    options?: VaultSharingOptions
+  ): Promise<EnableVaultSharingResponse> {
     validateVaultId(vaultId);
-    const response = await this.http.post<{
-      vault_id: string;
-      public_sharing_enabled: boolean;
-      all_ingots_public: boolean;
-      session_length_seconds: number;
-      enabled_at: number;
-    }>(`/vaults/${vaultId}/sharing/enable`, {
+    const response = await this.http.post<EnableVaultSharingResponse>(apiPath`/vaults/${vaultId}/sharing/enable`, {
       vmk,
       all_ingots_public: options?.all_ingots_public,
       session_length_seconds: options?.session_length_seconds,
@@ -180,72 +147,39 @@ export class MobileVaultsClient {
     return response.data;
   }
 
-  async disableSharing(vaultId: string): Promise<{
-    vault_id: string;
-    public_sharing_enabled: false;
-    disabled_at: number;
-    shares_revoked: number;
-  }> {
+  async disableSharing(vaultId: string): Promise<DisableVaultSharingResponse> {
     validateVaultId(vaultId);
-    const response = await this.http.post<{
-      vault_id: string;
-      public_sharing_enabled: false;
-      disabled_at: number;
-      shares_revoked: number;
-    }>(`/vaults/${vaultId}/sharing/disable`);
+    const response = await this.http.post<DisableVaultSharingResponse>(apiPath`/vaults/${vaultId}/sharing/disable`);
     return response.data;
   }
 
+  /**
+   * Update the vault's sharing policy. Making every ingot public publishes
+   * each file to anyone holding its URL, so the API accepts
+   * `all_ingots_public: true` only with a read-write VAT for this vault.
+   */
   async updateSharingConfig(
     vaultId: string,
-    config: {
-      all_ingots_public?: boolean;
-      session_length_seconds?: number;
-    }
-  ): Promise<{
-    vault_id: string;
-    public_sharing_enabled: boolean;
-    all_ingots_public: boolean;
-    session_length_seconds: number;
-    updated_at: number;
-  }> {
+    config: VaultSharingOptions,
+    vat?: string
+  ): Promise<UpdateVaultSharingResponse> {
     validateVaultId(vaultId);
-    const response = await this.http.put<{
-      vault_id: string;
-      public_sharing_enabled: boolean;
-      all_ingots_public: boolean;
-      session_length_seconds: number;
-      updated_at: number;
-    }>(`/vaults/${vaultId}/sharing`, config);
+    const response = await this.http.put<UpdateVaultSharingResponse>(apiPath`/vaults/${vaultId}/sharing`, config, { vat });
     return response.data;
   }
 
-  async getAccessLogRetention(vaultId: string): Promise<{
-    vault_id: string;
-    access_log_retention_seconds: number;
-  }> {
+  async getAccessLogRetention(vaultId: string): Promise<AccessLogRetention> {
     validateVaultId(vaultId);
-    const response = await this.http.get<{
-      vault_id: string;
-      access_log_retention_seconds: number;
-    }>(`/vaults/${vaultId}/access-log-retention`);
+    const response = await this.http.get<AccessLogRetention>(apiPath`/vaults/${vaultId}/access-log-retention`);
     return response.data;
   }
 
   async updateAccessLogRetention(
     vaultId: string,
     retentionSeconds: number
-  ): Promise<{
-    vault_id: string;
-    access_log_retention_seconds: number;
-    updated_at: number;
-  }> {
+  ): Promise<UpdateAccessLogRetentionResponse> {
     validateVaultId(vaultId);
-    const response = await this.http.put<{
-      vault_id: string;
-      access_log_retention_seconds: number;
-      updated_at: number;
-    }>(`/vaults/${vaultId}/access-log-retention`, {
+    const response = await this.http.put<UpdateAccessLogRetentionResponse>(apiPath`/vaults/${vaultId}/access-log-retention`, {
       access_log_retention_seconds: retentionSeconds,
     });
     return response.data;
@@ -253,13 +187,13 @@ export class MobileVaultsClient {
 
   async getUploadConfig(vaultId: string): Promise<UploadConfig> {
     validateVaultId(vaultId);
-    const response = await this.http.get<UploadConfig>(`/vaults/${vaultId}/upload`);
+    const response = await this.http.get<UploadConfig>(apiPath`/vaults/${vaultId}/upload`);
     return response.data;
   }
 
   async enableUploadPortal(vaultId: string, vmk: string): Promise<UploadPortalEnabled> {
     validateVaultId(vaultId);
-    const response = await this.http.post<UploadPortalEnabled>(`/vaults/${vaultId}/upload/portal/enable`, {
+    const response = await this.http.post<UploadPortalEnabled>(apiPath`/vaults/${vaultId}/upload/portal/enable`, {
       vmk,
     });
     return response.data;
@@ -267,13 +201,13 @@ export class MobileVaultsClient {
 
   async disableUploadPortal(vaultId: string): Promise<UploadPortalDisabled> {
     validateVaultId(vaultId);
-    const response = await this.http.post<UploadPortalDisabled>(`/vaults/${vaultId}/upload/portal/disable`);
+    const response = await this.http.post<UploadPortalDisabled>(apiPath`/vaults/${vaultId}/upload/portal/disable`);
     return response.data;
   }
 
   async enableUploadWidget(vaultId: string, vmk: string): Promise<UploadWidgetEnabled> {
     validateVaultId(vaultId);
-    const response = await this.http.post<UploadWidgetEnabled>(`/vaults/${vaultId}/upload/widget/enable`, {
+    const response = await this.http.post<UploadWidgetEnabled>(apiPath`/vaults/${vaultId}/upload/widget/enable`, {
       vmk,
     });
     return response.data;
@@ -281,7 +215,7 @@ export class MobileVaultsClient {
 
   async disableUploadWidget(vaultId: string): Promise<UploadWidgetDisabled> {
     validateVaultId(vaultId);
-    const response = await this.http.post<UploadWidgetDisabled>(`/vaults/${vaultId}/upload/widget/disable`);
+    const response = await this.http.post<UploadWidgetDisabled>(apiPath`/vaults/${vaultId}/upload/widget/disable`);
     return response.data;
   }
 
@@ -293,7 +227,7 @@ export class MobileVaultsClient {
     }
   ): Promise<UploadConfigUpdate> {
     validateVaultId(vaultId);
-    const response = await this.http.put<UploadConfigUpdate>(`/vaults/${vaultId}/upload`, config);
+    const response = await this.http.put<UploadConfigUpdate>(apiPath`/vaults/${vaultId}/upload`, config);
     return response.data;
   }
 }

package/dist/platform-domains.generated.d.ts

@@ -1,2 +0,0 @@
-export declare const SPARKVAULT_ROOT_DOMAIN = "sparkvault.com";
-export declare const SPARKVAULT_PLATFORM_SV_HOSTS: readonly string[];

package/dist/platform-domains.generated.js

@@ -1,16 +0,0 @@
-// GENERATED FILE — do not edit by hand.
-// Source of truth: packages/app-sdk/src/platform-domains.js
-// Regenerate with: pnpm --filter @sparkvault/sdk-mobile build
-export const SPARKVAULT_ROOT_DOMAIN = "sparkvault.com";
-export const SPARKVAULT_PLATFORM_SV_HOSTS = Object.freeze([
-    "auth.sv",
-    "x.sv",
-    "files.sv",
-    "file.sv",
-    "send.sv",
-    "spark.sv",
-    "by.sv",
-    "at.sv",
-    "db.sv",
-]);
-//# sourceMappingURL=platform-domains.generated.js.map

package/dist/platform-domains.generated.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"platform-domains.generated.js","sourceRoot":"","sources":["../src/platform-domains.generated.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,4DAA4D;AAC5D,8DAA8D;AAE9D,MAAM,CAAC,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEvD,MAAM,CAAC,MAAM,4BAA4B,GAAsB,MAAM,CAAC,MAAM,CAAC;IAC3E,SAAS;IACT,MAAM;IACN,UAAU;IACV,SAAS;IACT,SAAS;IACT,UAAU;IACV,OAAO;IACP,OAAO;IACP,OAAO;CACR,CAAC,CAAC"}

package/src/platform-domains.generated.ts

@@ -1,17 +0,0 @@
-// GENERATED FILE — do not edit by hand.
-// Source of truth: packages/app-sdk/src/platform-domains.js
-// Regenerate with: pnpm --filter @sparkvault/sdk-mobile build
-
-export const SPARKVAULT_ROOT_DOMAIN = "sparkvault.com";
-
-export const SPARKVAULT_PLATFORM_SV_HOSTS: readonly string[] = Object.freeze([
-  "auth.sv",
-  "x.sv",
-  "files.sv",
-  "file.sv",
-  "send.sv",
-  "spark.sv",
-  "by.sv",
-  "at.sv",
-  "db.sv",
-]);