@drakkar.software/starfish-client 3.0.0-alpha.21 → 3.0.0-alpha.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.js CHANGED
@@ -1,60 +1,277 @@
1
+ import { AUTHOR_PUBKEY_FIELD, AUTHOR_SIGNATURE_FIELD, DATA_FIELD, TS_FIELD, BASE_HASH_FIELD, PUSH_PATH_PREFIX, HEADER_AUTHORIZATION, HEADER_SIG, HEADER_TS, HEADER_NONCE, HEADER_PUB, HEADER_CONTENT_TYPE, HEADER_ACCEPT, signAppendAuthor, signRequest, stableStringify, } from "@drakkar.software/starfish-protocol";
1
2
  import { ConflictError, StarfishHttpError } from "./types.js";
3
+ const APPEND_DEFAULT_FIELD = "items";
4
+ /** The storage `documentKey` for a push `path`: the path with the `/push/`
5
+ * action prefix stripped (the namespace lives only in the URL). The author
6
+ * signature binds to this key. */
7
+ export function stripPushPrefix(path) {
8
+ return path.startsWith(PUSH_PATH_PREFIX) ? path.slice(PUSH_PATH_PREFIX.length) : path;
9
+ }
10
+ /**
11
+ * Base64-encode the canonical stable-stringification of a cap-cert.
12
+ *
13
+ * Used as the value of the `Authorization: Cap <…>` header in v3.0. We rely
14
+ * on the host's `btoa` for browsers and fall back to `Buffer` in Node so the
15
+ * client stays free of native dependencies.
16
+ */
17
+ function encodeCapAuth(cap) {
18
+ const json = stableStringify(cap);
19
+ if (typeof btoa === "function") {
20
+ return btoa(json);
21
+ }
22
+ const bufCtor = globalThis.Buffer;
23
+ if (bufCtor)
24
+ return bufCtor.from(json, "utf-8").toString("base64");
25
+ throw new Error("No base64 encoder available");
26
+ }
2
27
  /**
3
28
  * Low-level HTTP client for the Starfish sync protocol.
4
29
  * Handles auth headers and response parsing.
5
30
  */
6
31
  export class StarfishClient {
7
32
  baseUrl;
8
- auth;
33
+ namespace;
34
+ capProvider;
9
35
  fetch;
36
+ /**
37
+ * Installed client-side plugins. Currently stored as inert data; no
38
+ * hooks fire yet. Extensions can inspect this list if needed.
39
+ */
40
+ plugins;
10
41
  constructor(options) {
11
42
  this.baseUrl = options.baseUrl.replace(/\/$/, "");
12
- this.auth = options.auth;
43
+ // Empty string ⇒ no namespace (treat like unset), so a falsy env value
44
+ // doesn't produce a malformed `/v1//…` path.
45
+ this.namespace = options.namespace || undefined;
46
+ this.capProvider = options.capProvider;
13
47
  this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
48
+ this.plugins = options.plugins ? [...options.plugins] : [];
14
49
  }
15
50
  /**
16
- * Pull synced data from the server.
17
- * @param path - The pull endpoint path (e.g. "/pull/users/abc/settings")
18
- * @param checkpoint - Only return data updated after this timestamp (0 = full pull)
51
+ * Resolve the host portion of the URL the client will send to. The host
52
+ * is folded into the signed canonical input as the `h` field so the
53
+ * server can refuse a signature that was minted against a different
54
+ * Starfish host (replay-across-servers defence).
55
+ *
56
+ * When `baseUrl` is relative — e.g. the consumer passed a custom `fetch`
57
+ * that resolves relative URLs in its own context — there is no parseable
58
+ * host; we return `""` so signing still proceeds. The server-side
59
+ * verifier will also reconstruct host from its inbound URL, so the
60
+ * empty-host case still verifies symmetrically when both sides agree.
19
61
  */
20
- async pull(path, checkpoint) {
21
- const url = checkpoint
22
- ? `${this.baseUrl}${path}?checkpoint=${checkpoint}`
23
- : `${this.baseUrl}${path}`;
24
- const authHeaders = this.auth
25
- ? await this.auth({ method: "GET", path, body: null })
26
- : {};
62
+ signingHost() {
63
+ try {
64
+ return new URL(this.baseUrl).host;
65
+ }
66
+ catch {
67
+ return "";
68
+ }
69
+ }
70
+ /**
71
+ * Rewrite a request path for the configured namespace. A no-op when no
72
+ * namespace is set; otherwise `/{action}/…` becomes `/v1/{namespace}/{action}/…`
73
+ * (the `/v1` protocol-version segment is part of the namespaced route, matching
74
+ * the Python client and the server's namespace mount).
75
+ *
76
+ * Applied to the path used for BOTH the signature and the URL so the canonical
77
+ * path the client signs equals the path the server reconstructs from the URL.
78
+ * Covers SDK-helper-built paths too — that's the point: a namespace-unaware
79
+ * helper passing `/push/spaces/x/_keyring` reaches `/v1/{ns}/push/spaces/x/_keyring`.
80
+ */
81
+ applyNamespace(path) {
82
+ return this.namespace ? `/v1/${this.namespace}${path}` : path;
83
+ }
84
+ /**
85
+ * Build auth headers for a request. When a `capProvider` is set, signs the
86
+ * request with the device's Ed25519 private key and returns the v3 header
87
+ * set (`Authorization: Cap …`, `X-Starfish-Sig`, `X-Starfish-Ts`,
88
+ * `X-Starfish-Nonce`). Empty when no provider is configured (public reads).
89
+ *
90
+ * Body bytes signed MUST equal the bytes sent on the wire — callers pass
91
+ * the already-serialized body string here so signing and transmission agree.
92
+ * The host bound into the signature is derived from `baseUrl` once per call.
93
+ */
94
+ async buildAuthHeaders(method, pathAndQuery, body) {
95
+ if (!this.capProvider)
96
+ return {};
97
+ const capCtx = await this.capProvider.getCap();
98
+ return this.capRequestHeaders(capCtx, method, pathAndQuery, body);
99
+ }
100
+ /**
101
+ * Build the request-signing headers from an ALREADY-fetched cap context. Split
102
+ * out of {@link buildAuthHeaders} so {@link append} can fetch the cap once and
103
+ * reuse it for BOTH the author signature (over the element data) and the
104
+ * request signature (over the body), without redeeming the cap twice — a
105
+ * second `getCap()` could rotate keys and break the `authorPubkey ===
106
+ * presenter` bind the server checks.
107
+ */
108
+ async capRequestHeaders(capCtx, method, pathAndQuery, body) {
109
+ const { cap, devEdPrivHex, pubHex } = capCtx;
110
+ const req = {
111
+ method,
112
+ pathAndQuery,
113
+ body,
114
+ host: this.signingHost(),
115
+ };
116
+ const { sig, ts, nonce } = await signRequest(req, devEdPrivHex);
117
+ const headers = {
118
+ [HEADER_AUTHORIZATION]: `Cap ${encodeCapAuth(cap)}`,
119
+ [HEADER_SIG]: sig,
120
+ [HEADER_TS]: String(ts),
121
+ [HEADER_NONCE]: nonce,
122
+ };
123
+ // Audience (public-link) caps bind no single subject, so the server needs
124
+ // the presenter's pubkey to verify the signature and check the allow-list.
125
+ if (pubHex !== undefined)
126
+ headers[HEADER_PUB] = pubHex;
127
+ return headers;
128
+ }
129
+ /**
130
+ * Resolve the author public key to attach to a signed append: the redeemer's
131
+ * `pubHex` for an audience cap, else the cert subject `cap.sub` for a
132
+ * device/member cap. This is the SAME key that signs the request, so a server
133
+ * enforcing author proof can bind the stored element to its writer. Returns
134
+ * undefined only for a (malformed) cap with neither — the append then goes
135
+ * unsigned and a server requiring signatures rejects it.
136
+ */
137
+ appendAuthorKey(capCtx) {
138
+ const { cap, pubHex } = capCtx;
139
+ const authorPubHex = pubHex ?? cap.sub;
140
+ if (authorPubHex === undefined)
141
+ return null;
142
+ return { authorPubHex };
143
+ }
144
+ async pull(path, checkpointOrOptions) {
145
+ let pathAndQuery = this.applyNamespace(path);
146
+ let appendField;
147
+ if (typeof checkpointOrOptions === "number") {
148
+ if (checkpointOrOptions)
149
+ pathAndQuery += `?checkpoint=${checkpointOrOptions}`;
150
+ }
151
+ else if (checkpointOrOptions != null) {
152
+ // Disambiguate AppendPullOptions vs PullOptions.
153
+ //
154
+ // PullOptions are identified by the presence of `withKeyring` or
155
+ // `checkpoint` keys (which AppendPullOptions does not have — append
156
+ // uses `since`, not `checkpoint`). Anything else, including an empty
157
+ // `{}` object, retains the historical behavior of AppendPullOptions
158
+ // (extracts `data.items` with `?` query).
159
+ const opts = checkpointOrOptions;
160
+ const isPullOptions = opts.withKeyring !== undefined || opts.checkpoint !== undefined;
161
+ const params = new URLSearchParams();
162
+ if (isPullOptions) {
163
+ if (opts.checkpoint != null && opts.checkpoint > 0) {
164
+ params.set("checkpoint", String(opts.checkpoint));
165
+ }
166
+ if (opts.withKeyring) {
167
+ params.set("withKeyring", "1");
168
+ }
169
+ }
170
+ else {
171
+ appendField = opts.appendField ?? APPEND_DEFAULT_FIELD;
172
+ if (opts.since != null) {
173
+ if (opts.since < 0)
174
+ throw new Error("since must be non-negative");
175
+ params.set("checkpoint", String(opts.since));
176
+ }
177
+ if (opts.last != null) {
178
+ if (opts.last < 0)
179
+ throw new Error("last must be non-negative");
180
+ params.set("last", String(opts.last));
181
+ }
182
+ }
183
+ if (params.size > 0)
184
+ pathAndQuery += `?${params.toString()}`;
185
+ }
186
+ const url = `${this.baseUrl}${pathAndQuery}`;
187
+ const authHeaders = await this.buildAuthHeaders("GET", pathAndQuery, undefined);
27
188
  const res = await this.fetch(url, {
28
189
  method: "GET",
29
- headers: { Accept: "application/json", ...authHeaders },
190
+ headers: { [HEADER_ACCEPT]: "application/json", ...authHeaders },
30
191
  });
31
192
  if (!res.ok) {
32
193
  throw new StarfishHttpError(res.status, await res.text());
33
194
  }
34
- return res.json();
195
+ const result = await res.json();
196
+ if (appendField !== undefined) {
197
+ const list = result.data?.[appendField];
198
+ return (Array.isArray(list) ? list : []);
199
+ }
200
+ return result;
201
+ }
202
+ /**
203
+ * Pull several documents in one round-trip via `/batch/pull`. `collections` is
204
+ * the list of distinct collection names; `opts.params` supplies, per collection,
205
+ * an ARRAY of path-param sets — one per document to read — so the SAME collection
206
+ * can fan in many documents (e.g. many users' `profile`) in a single request.
207
+ * The server auto-fills the `{identity}` param from the authenticated caller for
208
+ * any set that omits it, so a self-doc collection needs no params. Returns a map
209
+ * of collection name → an ARRAY of pulled documents (or per-document `{ error }`),
210
+ * in request order. Honors the configured namespace.
211
+ *
212
+ * For the common "many docs of one collection" case prefer {@link batchPullMany}.
213
+ *
214
+ * Note: not append/checkpoint-aware — for incremental append-only reads use
215
+ * `pull(path, { since })` (or `AppendLogCursor`) per collection.
216
+ */
217
+ async batchPull(collections, opts = {}) {
218
+ const search = new URLSearchParams();
219
+ search.set("collections", collections.join(","));
220
+ if (opts.params && Object.keys(opts.params).length > 0) {
221
+ search.set("params", JSON.stringify(opts.params));
222
+ }
223
+ const pathAndQuery = `${this.applyNamespace("/batch/pull")}?${search.toString()}`;
224
+ const url = `${this.baseUrl}${pathAndQuery}`;
225
+ const authHeaders = await this.buildAuthHeaders("GET", pathAndQuery, undefined);
226
+ const res = await this.fetch(url, {
227
+ method: "GET",
228
+ headers: { [HEADER_ACCEPT]: "application/json", ...authHeaders },
229
+ });
230
+ if (!res.ok) {
231
+ throw new StarfishHttpError(res.status, await res.text());
232
+ }
233
+ return await res.json();
234
+ }
235
+ /**
236
+ * Convenience over {@link batchPull} for reading MANY documents of ONE
237
+ * collection in a single round-trip: pass the per-document param-sets and get
238
+ * back the {@link BatchPullEntry} array aligned to `paramsList` by index (each
239
+ * entry is `{ data, hash, timestamp }` or `{ error }`). An empty `paramsList`
240
+ * issues no request and returns `[]`.
241
+ */
242
+ async batchPullMany(collection, paramsList) {
243
+ if (paramsList.length === 0)
244
+ return [];
245
+ const res = await this.batchPull([collection], { params: { [collection]: paramsList } });
246
+ return res.collections[collection] ?? [];
35
247
  }
36
248
  /**
37
249
  * Push synced data to the server.
38
250
  * @param path - The push endpoint path (e.g. "/push/users/abc/settings")
39
251
  * @param data - The full document data to push
40
252
  * @param baseHash - Hash of the document this push is based on (null for first push)
41
- * @param authorSignature - Optional author signature for provenance
253
+ *
254
+ * v3 author proof (`authorPubkey` + `authorSignature`) is passed via `author`
255
+ * (produced by `SyncManager` when a `signer` is configured) and sent as
256
+ * top-level body siblings of `data`, where the server verifies it.
42
257
  * @throws {ConflictError} if the server detects a hash mismatch (409)
43
258
  */
44
- async push(path, data, baseHash, authorSignature) {
259
+ async push(path, data, baseHash, author) {
45
260
  const body = JSON.stringify({
46
- data,
47
- baseHash,
48
- ...(authorSignature && { authorSignature }),
261
+ [DATA_FIELD]: data,
262
+ [BASE_HASH_FIELD]: baseHash,
263
+ ...(author && {
264
+ [AUTHOR_PUBKEY_FIELD]: author.authorPubkey,
265
+ [AUTHOR_SIGNATURE_FIELD]: author.authorSignature,
266
+ }),
49
267
  });
50
- const authHeaders = this.auth
51
- ? await this.auth({ method: "POST", path, body })
52
- : {};
53
- const res = await this.fetch(`${this.baseUrl}${path}`, {
268
+ const sendPath = this.applyNamespace(path);
269
+ const authHeaders = await this.buildAuthHeaders("POST", sendPath, body);
270
+ const res = await this.fetch(`${this.baseUrl}${sendPath}`, {
54
271
  method: "POST",
55
272
  headers: {
56
- "Content-Type": "application/json",
57
- Accept: "application/json",
273
+ [HEADER_CONTENT_TYPE]: "application/json",
274
+ [HEADER_ACCEPT]: "application/json",
58
275
  ...authHeaders,
59
276
  },
60
277
  body,
@@ -67,23 +284,84 @@ export class StarfishClient {
67
284
  }
68
285
  return res.json();
69
286
  }
287
+ /**
288
+ * Append an element to an appendOnly (`by_timestamp`) collection.
289
+ *
290
+ * Unlike {@link push}, appendOnly writes carry no hash/conflict check — an
291
+ * authorized append is always accepted. Each element is stored server-side as
292
+ * `{ts, data}` and pulls can filter by `ts` via `since`/`checkpoint`.
293
+ *
294
+ * @param path - the push endpoint (e.g. "/push/events")
295
+ * @param data - the element payload. For a `delegated` collection, encrypt it
296
+ * first (e.g. `createKeyringEncryptor(keyring, kem).encrypt(data)`); the
297
+ * server stores it opaquely and never reads it.
298
+ * @param opts.ts - optional client-supplied element timestamp (ms). Must be a
299
+ * non-negative integer strictly greater than the latest stored element's ts
300
+ * (else the server responds 409). Omit to let the server assign one.
301
+ * @throws {StarfishHttpError} on a non-2xx response — e.g. 409
302
+ * `{ error: "non_monotonic_timestamp" }` for a non-monotonic timestamp, or
303
+ * `{ error: "append_limit_exceeded", limit }` if the collection's `maxItems`
304
+ * cap is reached (partition by a path parameter for higher volume).
305
+ */
306
+ async append(path, data, opts = {}) {
307
+ const sendPath = this.applyNamespace(path);
308
+ const bodyObj = { [DATA_FIELD]: data };
309
+ if (opts.ts !== undefined)
310
+ bodyObj[TS_FIELD] = opts.ts;
311
+ // Author proof. Fetch the cap ONCE and reuse it for both the author
312
+ // signature (over the element `data`) and the request signature (over the
313
+ // final body) — see {@link capRequestHeaders}. The author fields are signed
314
+ // with the same key that authenticates the request, so a collection with
315
+ // `requireAuthorSignature` (the default) binds the stored element to its
316
+ // writer. Without a cap provider the append is sent unsigned and such a
317
+ // collection rejects it.
318
+ const capCtx = this.capProvider ? await this.capProvider.getCap() : null;
319
+ if (capCtx) {
320
+ const authorKey = this.appendAuthorKey(capCtx);
321
+ if (authorKey) {
322
+ // The signature binds the author to BOTH the element data AND the
323
+ // document it is written to (the storage path = `path` minus the
324
+ // `/push/` action prefix; the namespace lives only in the URL).
325
+ const documentKey = stripPushPrefix(path);
326
+ const { authorPubkey, authorSignature } = signAppendAuthor(documentKey, data, authorKey.authorPubHex, capCtx.devEdPrivHex);
327
+ bodyObj[AUTHOR_PUBKEY_FIELD] = authorPubkey;
328
+ bodyObj[AUTHOR_SIGNATURE_FIELD] = authorSignature;
329
+ }
330
+ }
331
+ const body = JSON.stringify(bodyObj);
332
+ const authHeaders = capCtx
333
+ ? await this.capRequestHeaders(capCtx, "POST", sendPath, body)
334
+ : {};
335
+ const res = await this.fetch(`${this.baseUrl}${sendPath}`, {
336
+ method: "POST",
337
+ headers: {
338
+ [HEADER_CONTENT_TYPE]: "application/json",
339
+ [HEADER_ACCEPT]: "application/json",
340
+ ...authHeaders,
341
+ },
342
+ body,
343
+ });
344
+ if (!res.ok) {
345
+ throw new StarfishHttpError(res.status, await res.text());
346
+ }
347
+ return res.json();
348
+ }
70
349
  /**
71
350
  * Pull binary data from a blob collection.
72
351
  * Returns raw bytes with the content hash from the ETag header.
73
352
  */
74
353
  async pullBlob(path) {
75
- const authHeaders = this.auth
76
- ? await this.auth({ method: "GET", path, body: null })
77
- : {};
78
- const res = await this.fetch(`${this.baseUrl}${path}`, {
354
+ const sendPath = this.applyNamespace(path);
355
+ const authHeaders = await this.buildAuthHeaders("GET", sendPath, undefined);
356
+ const res = await this.fetch(`${this.baseUrl}${sendPath}`, {
79
357
  method: "GET",
80
- headers: { Accept: "*/*", ...authHeaders },
358
+ headers: { [HEADER_ACCEPT]: "*/*", ...authHeaders },
81
359
  });
82
360
  if (!res.ok) {
83
361
  throw new StarfishHttpError(res.status, await res.text());
84
362
  }
85
363
  const etag = res.headers.get("ETag")?.replace(/"/g, "") ?? null;
86
- const contentType = res.headers.get("Content-Type") ?? "application/octet-stream";
364
+ const contentType = res.headers.get(HEADER_CONTENT_TYPE) ?? "application/octet-stream";
87
365
  const data = await res.arrayBuffer();
88
366
  return { data, hash: etag, contentType };
89
367
  }
@@ -92,14 +370,15 @@ export class StarfishClient {
92
370
  * Binary collections use last-write-wins (no conflict detection).
93
371
  */
94
372
  async pushBlob(path, data, contentType) {
95
- const authHeaders = this.auth
96
- ? await this.auth({ method: "POST", path, body: null })
97
- : {};
98
- const res = await this.fetch(`${this.baseUrl}${path}`, {
373
+ // Blobs are not JSON; we leave body undefined when signing — server-side
374
+ // verification is expected to use a separate path for blob uploads.
375
+ const sendPath = this.applyNamespace(path);
376
+ const authHeaders = await this.buildAuthHeaders("POST", sendPath, undefined);
377
+ const res = await this.fetch(`${this.baseUrl}${sendPath}`, {
99
378
  method: "POST",
100
379
  headers: {
101
- "Content-Type": contentType,
102
- Accept: "application/json",
380
+ [HEADER_CONTENT_TYPE]: contentType,
381
+ [HEADER_ACCEPT]: "application/json",
103
382
  ...authHeaders,
104
383
  },
105
384
  body: data,
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Phase-2 transitional shim. Device-directory helpers now live in
3
+ * `@drakkar.software/starfish-identities`; member-directory helpers now live
4
+ * in `@drakkar.software/starfish-sharing`. Removed in Phase 3.
5
+ */
6
+ export { addDeviceEntry, listDevices, removeDeviceEntry, devicesPathFor, } from "@drakkar.software/starfish-identities";
7
+ export type { DirectoryEntry, Directory, DeviceEntry, ListDirectoryOpts, } from "@drakkar.software/starfish-identities";
8
+ export { addMemberEntry, listMembers, removeMemberEntry, membersPathFor, } from "@drakkar.software/starfish-sharing";
9
+ export type { MemberEntry } from "@drakkar.software/starfish-sharing";
@@ -0,0 +1,24 @@
1
+ // src/directory.ts
2
+ import {
3
+ addDeviceEntry,
4
+ listDevices,
5
+ removeDeviceEntry,
6
+ devicesPathFor
7
+ } from "@drakkar.software/starfish-identities";
8
+ import {
9
+ addMemberEntry,
10
+ listMembers,
11
+ removeMemberEntry,
12
+ membersPathFor
13
+ } from "@drakkar.software/starfish-sharing";
14
+ export {
15
+ addDeviceEntry,
16
+ addMemberEntry,
17
+ devicesPathFor,
18
+ listDevices,
19
+ listMembers,
20
+ membersPathFor,
21
+ removeDeviceEntry,
22
+ removeMemberEntry
23
+ };
24
+ //# sourceMappingURL=directory.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../src/directory.ts"],
4
+ "sourcesContent": ["/**\n * Phase-2 transitional shim. Device-directory helpers now live in\n * `@drakkar.software/starfish-identities`; member-directory helpers now live\n * in `@drakkar.software/starfish-sharing`. Removed in Phase 3.\n */\nexport {\n addDeviceEntry,\n listDevices,\n removeDeviceEntry,\n devicesPathFor,\n} from \"@drakkar.software/starfish-identities\"\nexport type {\n DirectoryEntry,\n Directory,\n DeviceEntry,\n ListDirectoryOpts,\n} from \"@drakkar.software/starfish-identities\"\n\nexport {\n addMemberEntry,\n listMembers,\n removeMemberEntry,\n membersPathFor,\n} from \"@drakkar.software/starfish-sharing\"\nexport type { MemberEntry } from \"@drakkar.software/starfish-sharing\"\n"],
5
+ "mappings": ";AAKA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAQP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;",
6
+ "names": []
7
+ }
@@ -1,84 +1,6 @@
1
- declare const WORDLIST: string[];
2
- /** Credentials derived from a passphrase. Pass directly to SyncManager / StarfishClient. */
3
- export interface DerivedCredentials {
4
- /** Hex-encoded auth token. Use as `Bearer ${authToken}` in request headers. */
5
- authToken: string;
6
- /**
7
- * Short identifier derived from the auth token (first 16 hex chars = 8 bytes).
8
- * Used as the user/namespace segment in collection paths.
9
- */
10
- userId: string;
11
- /**
12
- * Hex-encoded key suitable as `encryptionSecret` for SyncManager.
13
- * Combined with `encryptionSalt` to derive the AES-256-GCM key via HKDF.
14
- */
15
- encryptionSecret: string;
16
- /**
17
- * Value suitable as `encryptionSalt` for SyncManager. Equals `userId`.
18
- * Using a per-identity salt ensures that even if two users share a passphrase,
19
- * their encryption keys are different.
20
- */
21
- encryptionSalt: string;
22
- /**
23
- * Hex-encoded X25519 public key for group encryption.
24
- * Publish this so group admins can wrap the Group Encryption Key (GEK) for you.
25
- * Safe to store in a public Starfish document.
26
- */
27
- groupPublicKey: string;
28
- /**
29
- * Hex-encoded X25519 private key for group encryption.
30
- * Used to unwrap the GEK from a keyring document.
31
- * Never transmit this — keep it in memory or derive it from the passphrase.
32
- */
33
- groupPrivateKey: string;
34
- }
35
1
  /**
36
- * Generates a cryptographically random passphrase from the built-in 256-word list.
37
- *
38
- * Each word represents one byte of entropy (256 words = one byte per word, zero modulo bias).
39
- * A 12-word passphrase gives 96 bits of entropy — stronger than a random UUID.
40
- *
41
- * @param wordCount Number of words (default: 12).
42
- * @param wordlist Custom word list (must have exactly 256 entries).
2
+ * Phase-2 transitional shim. The implementation lives in
3
+ * `@drakkar.software/starfish-identities`. Removed in Phase 3.
43
4
  */
44
- export declare function generatePassphrase(wordCount?: number, wordlist?: string[]): string;
45
- /**
46
- * Derives auth credentials from a passphrase.
47
- *
48
- * All derivations are deterministic — the same passphrase always produces the same credentials.
49
- * Sharing the passphrase grants access on any device.
50
- *
51
- * The returned values map directly to Starfish options:
52
- * ```ts
53
- * const creds = await deriveCredentials(passphrase)
54
- *
55
- * const client = new StarfishClient({
56
- * baseUrl: serverUrl,
57
- * auth: () => ({ Authorization: `Bearer ${creds.authToken}` }),
58
- * })
59
- * const syncManager = new SyncManager({
60
- * client,
61
- * pullPath: `/pull/${creds.userId}/wedding`,
62
- * pushPath: `/push/${creds.userId}/wedding`,
63
- * encryptionSecret: creds.encryptionSecret,
64
- * encryptionSalt: creds.encryptionSalt,
65
- * })
66
- * ```
67
- */
68
- export declare function deriveCredentials(passphrase: string): Promise<DerivedCredentials>;
69
- /**
70
- * Encodes an invite payload as a URL-safe token and appends it as `?t=<token>`.
71
- *
72
- * ```ts
73
- * const url = buildInviteUrl("myapp://join", { name: "Alice & Bob", p: passphrase })
74
- * // → "myapp://join?t=eyJuYW1lIjoiQWxpY2UgJiBCb2IifQ"
75
- * ```
76
- */
77
- export declare function buildInviteUrl(baseUrl: string, payload: Record<string, unknown>): string;
78
- /**
79
- * Decodes an invite URL produced by `buildInviteUrl`.
80
- *
81
- * Returns the decoded payload, or `null` if the URL is missing or malformed.
82
- */
83
- export declare function parseInviteUrl(url: string): Record<string, unknown> | null;
84
- export { WORDLIST as DEFAULT_WORDLIST };
5
+ export { deriveRootIdentity } from "@drakkar.software/starfish-identities";
6
+ export type { RootIdentity, RootKeyPair } from "@drakkar.software/starfish-identities";