@drakkar.software/starfish-client 3.0.0-alpha.1 → 3.0.0-alpha.11

package/dist/logger.d.ts

@@ -5,6 +5,9 @@ export interface SyncMetrics {
     conflictCount?: number;
     retryCount?: number;
     cacheHit?: boolean;
+    /** Elements an append-log pull dropped under `onElementError: "skip"`
+     *  (failed verification/decryption). Omitted when none were skipped. */
+    skippedCount?: number;
 }
 /** Structured logger for sync operations. */
 export interface SyncLogger {

package/dist/mobile-lifecycle.d.ts

@@ -1,5 +1,5 @@
 import type { StoreApi } from "zustand/vanilla";
-import type { StarfishStore } from "./bindings/zustand.js";
+import type { StarfishStore, StarfishLogStore } from "./bindings/zustand.js";
 /**
  * Minimal interface matching React Native's `AppState` module.
  * Pass `AppState` from `react-native` directly.
@@ -69,3 +69,30 @@ export interface MobileLifecycleOptions {
  * @returns A cleanup function that removes all event listeners.
  */
 export declare function createMobileLifecycle(store: StoreApi<StarfishStore>, deps: MobileLifecycleDeps, options?: MobileLifecycleOptions): () => void;
+export interface AppendLogLifecycleOptions {
+    /**
+     * Pull new elements when the app returns to the foreground.
+     * Only pulls if the store is online and not already loading.
+     * Default: `true`.
+     */
+    pullOnForeground?: boolean;
+}
+/**
+ * Wires React Native app lifecycle events to an append-log store
+ * (`createStarfishLog`). A log is read-only, so this only pulls on foreground
+ * (there is nothing to flush on background). NetInfo connectivity changes are
+ * forwarded to `store.getState().setOnline()`.
+ *
+ * ```ts
+ * import { AppState } from "react-native"
+ * import NetInfo from "@react-native-community/netinfo"
+ * import { createStarfishLog, createAppendLogMobileLifecycle } from "@drakkar.software/starfish-client"
+ *
+ * const store = createStarfishLog({ cursor })
+ * const cleanup = createAppendLogMobileLifecycle(store, { appState: AppState, netInfo: NetInfo })
+ * useEffect(() => cleanup, [])
+ * ```
+ *
+ * @returns A cleanup function that removes all event listeners.
+ */
+export declare function createAppendLogMobileLifecycle(store: StoreApi<StarfishLogStore>, deps: MobileLifecycleDeps, options?: AppendLogLifecycleOptions): () => void;

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { CapCert } from "@drakkar.software/starfish-protocol";
+import type { Alg, CapCert } from "@drakkar.software/starfish-protocol";
 /** Push conflict error (HTTP 409). */
 export declare class ConflictError extends Error {
     constructor();
@@ -29,17 +29,44 @@ export interface StarfishCapProvider {
      * The client then sends it as `X-Starfish-Pub` so the server can verify the
      * request signature against it and check the cap's `aud` allow-list. Omit
      * `pubHex` for device/member caps (the server uses `cap.sub`).
+     *
+     * `presenterAlg` is the crypto suite of `devEdPrivHex` (the key that signs
+     * the request). It matters only for `audience` caps, where the presenter is
+     * an arbitrary redeemer whose suite is unrelated to the cap's `issAlg`; the
+     * client sends it as `X-Starfish-Alg`. For device/member caps the subject's
+     * suite is taken authoritatively from the verified cert, so this is ignored.
+     * Defaults to `"ed25519"` when omitted.
      */
     getCap(): Promise<{
         cap: CapCert;
         devEdPrivHex: string;
         pubHex?: string;
+        presenterAlg?: Alg;
     }>;
 }
 /** Options for creating a StarfishClient. */
 export interface StarfishClientOptions {
     /** Base URL of the Starfish server (e.g. "https://api.example.com/v1"). */
     baseUrl: string;
+    /**
+     * Optional namespace for a namespace-mounted server. When set, every request
+     * path `/{action}/…` is rewritten to `/v1/{namespace}/{action}/…` for BOTH the
+     * URL the client hits AND the canonical path it signs, so the signature the
+     * server reconstructs from the namespaced URL verifies (no rewrite layer
+     * needed). Mirrors the Python client's `namespace` parameter.
+     *
+     * Crucially this also rewrites the paths that namespace-unaware SDK helpers
+     * build internally (e.g. `starfish-keyring`'s `addCollectionRecipient`, blob
+     * uploads), so consumers no longer hand-prefix paths or wrap the client to
+     * reach a namespaced deployment. Leave unset (default) for a root-mounted
+     * server — paths pass through unchanged, byte-identical to before.
+     *
+     * Pass the bare namespace name (e.g. `"octochat"`); `baseUrl` then carries only
+     * the origin (and any reverse-proxy mount the proxy strips), not the `/v1`
+     * version segment. Must match `[A-Za-z0-9_-]+` and not be a reserved route name
+     * (`pull`, `push`, `health`, `batch`).
+     */
+    namespace?: string;
     /**
      * Cap-cert provider. When set, requests are signed with Ed25519 and carry
      * `Authorization: Cap <…>`. Omit for unauthenticated public-read collections.

package/package.json

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