@drakkar.software/starfish-client 1.11.0 → 1.14.0

package/dist/config.d.ts

@@ -0,0 +1,34 @@
+/** Encryption modes supported by the Starfish server. */
+export type EncryptionMode = "none" | "identity" | "server" | "delegated";
+/** Per-collection metadata returned by GET /config. */
+export interface CollectionClientInfo {
+    name: string;
+    maxBodyBytes: number;
+    encryption: EncryptionMode;
+    allowedMimeTypes: string[];
+    pullOnly?: boolean;
+    pushOnly?: boolean;
+    queueOnly?: boolean;
+    clientEncrypted?: boolean;
+    /** Base64-encoded public key for client-side encryption, if configured on the server. */
+    publicKey?: string;
+    ttlMs?: number;
+    forceFullFetch?: boolean;
+}
+/** Response shape of GET /config. */
+export interface ConfigResponse {
+    collections: CollectionClientInfo[];
+    namespaces?: Record<string, {
+        collections: CollectionClientInfo[];
+    }>;
+}
+/**
+ * Fetch the server's collection manifest from GET /config.
+ *
+ * @param baseUrl - Base URL of the Starfish server (e.g. `"https://api.example.com/v1"`).
+ * @param options.headers - Optional request headers (e.g. `Authorization`).
+ * @throws {Error} if the server returns a non-2xx response.
+ */
+export declare function fetchServerConfig(baseUrl: string, options?: {
+    headers?: Record<string, string>;
+}): Promise<ConfigResponse>;

package/dist/config.js

@@ -0,0 +1,18 @@
+/**
+ * Fetch the server's collection manifest from GET /config.
+ *
+ * @param baseUrl - Base URL of the Starfish server (e.g. `"https://api.example.com/v1"`).
+ * @param options.headers - Optional request headers (e.g. `Authorization`).
+ * @throws {Error} if the server returns a non-2xx response.
+ */
+export async function fetchServerConfig(baseUrl, options) {
+    const url = `${baseUrl.replace(/\/$/, "")}/config`;
+    const res = await fetch(url, {
+        method: "GET",
+        headers: options?.headers,
+    });
+    if (!res.ok) {
+        throw new Error(`fetchServerConfig: ${res.status} ${res.statusText}`);
+    }
+    return res.json();
+}

package/dist/index.d.ts

@@ -25,6 +25,8 @@ export type { Snapshot, SnapshotHistoryOptions } from "./history.js";
 export { startPolling, startAdaptivePolling } from "./polling.js";
 export type { PollableState, AdaptivePollingOptions, AdaptivePollingControls } from "./polling.js";
 export { createDedupFetch } from "./dedup.js";
+export { fetchServerConfig } from "./config.js";
+export type { EncryptionMode, CollectionClientInfo, ConfigResponse } from "./config.js";
 export { createIndexedDBStorage } from "./storage/indexeddb.js";
 export type { IndexedDBStorageOptions, AsyncStateStorage } from "./storage/indexeddb.js";
 export { exportData, importData, exportToBlob } from "./export.js";

package/dist/index.js

@@ -12,6 +12,7 @@ export { createUnionMerge, createSoftDeleteResolver, timestampWinner, pruneTombs
 export { SnapshotHistory } from "./history.js";
 export { startPolling, startAdaptivePolling } from "./polling.js";
 export { createDedupFetch } from "./dedup.js";
+export { fetchServerConfig } from "./config.js";
 export { createIndexedDBStorage } from "./storage/indexeddb.js";
 export { exportData, importData, exportToBlob } from "./export.js";
 export { isBackgroundSyncSupported, registerBackgroundSync } from "./background-sync.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drakkar.software/starfish-client",
-  "version": "1.11.0",
+  "version": "1.14.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/Drakkar-Software/starfish.git",
@@ -64,7 +64,7 @@
     }
   },
   "dependencies": {
-    "@drakkar.software/starfish-protocol": "1.11.0"
+    "@drakkar.software/starfish-protocol": "1.14.0"
   },
   "devDependencies": {
     "@legendapp/state": "^2.0.0",