@drakkar.software/starfish-client 1.19.2 → 2.0.0

package/dist/config.d.ts

@@ -1,5 +1,14 @@
 /** Encryption modes supported by the Starfish server. */
 export type EncryptionMode = "none" | "identity" | "server" | "delegated";
+/** Append-only configuration exposed via GET /config. */
+export interface AppendOnlyClientInfo {
+    /** Array field name in the stored document. Defaults to "items". */
+    field?: string;
+    /** false = no storage write (replaces queueOnly). true/absent = append to array. */
+    persist?: boolean;
+    /** When true, server validates client's baseHash against hash(lastItem). */
+    checkLastItem?: boolean;
+}
 /** Per-collection metadata returned by GET /config. */
 export interface CollectionClientInfo {
     name: string;
@@ -8,7 +17,7 @@ export interface CollectionClientInfo {
     allowedMimeTypes: string[];
     pullOnly?: boolean;
     pushOnly?: boolean;
-    queueOnly?: boolean;
+    appendOnly?: AppendOnlyClientInfo;
     clientEncrypted?: boolean;
     /** Base64-encoded public key for client-side encryption, if configured on the server. */
     publicKey?: string;

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export type { CryptoProvider, Base64Provider, PlatformConfig } from "@drakkar.so
 export { stableStringify, computeHash } from "@drakkar.software/starfish-protocol";
 export type { PullResult, PushSuccess } from "@drakkar.software/starfish-protocol";
 export { StarfishClient } from "./client.js";
-export type { BlobPullResult, BlobPushResult } from "./client.js";
+export type { BlobPullResult, BlobPushResult, AppendPullOptions } from "./client.js";
 export { SyncManager } from "./sync.js";
 export type { SyncManagerOptions } from "./sync.js";
 export { createEncryptor, ENCRYPTED_KEY } from "./crypto.js";
@@ -46,3 +46,4 @@ export { deriveGroupKeyPair, generateGroupKey, wrapGroupKey, unwrapGroupKey, cre
 export type { GroupKeyPair, EpochKeyring, GroupKeyring } from "./group-crypto.js";
 export { pullEntitlements } from "./entitlements.js";
 export type { PullEntitlementsOptions } from "./entitlements.js";
+export type { AppendOnlyClientInfo } from "./config.js";

package/dist/index.js

@@ -19,6 +19,7 @@ var StarfishHttpError = class extends Error {
 };
 
 // src/client.ts
+var APPEND_DEFAULT_FIELD = "items";
 var StarfishClient = class {
   baseUrl;
   auth;
@@ -28,13 +29,24 @@ var StarfishClient = class {
     this.auth = options.auth;
     this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
   }
-  /**
-   * Pull synced data from the server.
-   * @param path - The pull endpoint path (e.g. "/pull/users/abc/settings")
-   * @param checkpoint - Only return data updated after this timestamp (0 = full pull)
-   */
-  async pull(path, checkpoint) {
-    const url = checkpoint ? `${this.baseUrl}${path}?checkpoint=${checkpoint}` : `${this.baseUrl}${path}`;
+  async pull(path, checkpointOrOptions) {
+    let url = `${this.baseUrl}${path}`;
+    let appendField;
+    if (typeof checkpointOrOptions === "number") {
+      if (checkpointOrOptions) url += `?checkpoint=${checkpointOrOptions}`;
+    } else if (checkpointOrOptions != null) {
+      appendField = checkpointOrOptions.appendField ?? APPEND_DEFAULT_FIELD;
+      const params = new URLSearchParams();
+      if (checkpointOrOptions.since != null) {
+        if (checkpointOrOptions.since < 0) throw new Error("since must be non-negative");
+        params.set("checkpoint", String(checkpointOrOptions.since));
+      }
+      if (checkpointOrOptions.last != null) {
+        if (checkpointOrOptions.last < 0) throw new Error("last must be non-negative");
+        params.set("last", String(checkpointOrOptions.last));
+      }
+      if (params.size > 0) url += `?${params.toString()}`;
+    }
     const authHeaders = this.auth ? await this.auth({ method: "GET", path, body: null }) : {};
     const res = await this.fetch(url, {
       method: "GET",
@@ -43,7 +55,12 @@ var StarfishClient = class {
     if (!res.ok) {
       throw new StarfishHttpError(res.status, await res.text());
     }
-    return res.json();
+    const result = await res.json();
+    if (appendField !== void 0) {
+      const list = result.data?.[appendField];
+      return Array.isArray(list) ? list : [];
+    }
+    return result;
   }
   /**
    * Push synced data to the server.