@drakkar.software/starfish-client 3.0.0-alpha.4 → 3.0.0-alpha.6

package/dist/types.d.ts

@@ -48,6 +48,25 @@ export interface StarfishCapProvider {
 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.4",
+  "version": "3.0.0-alpha.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/Drakkar-Software/starfish.git",
@@ -60,7 +60,7 @@
     }
   },
   "dependencies": {
-    "@drakkar.software/starfish-protocol": "3.0.0-alpha.4"
+    "@drakkar.software/starfish-protocol": "3.0.0-alpha.6"
   },
   "devDependencies": {
     "@legendapp/state": "^2.0.0",