@relyio/sdk 0.15.0 → 0.17.0

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.
Files changed (40) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/dist/{chunk-3BHDGUNS.cjs → chunk-6E22GYPB.cjs} +434 -593
  3. package/dist/chunk-6PTRZP5U.cjs +433 -0
  4. package/dist/{chunk-PCFTJLEP.js → chunk-DIZY6CKM.js} +2 -2
  5. package/dist/{chunk-X4KSS7PP.cjs → chunk-GHYB6IZK.cjs} +2 -2
  6. package/dist/chunk-OVMIHAYK.js +411 -0
  7. package/dist/{chunk-PXA5ONIU.js → chunk-VS2DEUTN.js} +397 -560
  8. package/dist/client/index.cjs +4 -3
  9. package/dist/client/index.d.cts +3 -4
  10. package/dist/client/index.d.ts +3 -4
  11. package/dist/client/index.js +2 -1
  12. package/dist/{define-content-type-B2gQZkTy.d.cts → define-content-type-AuL9-oz6.d.cts} +668 -85
  13. package/dist/{define-content-type-Ds5rCAYl.d.ts → define-content-type-BGoQxqLf.d.ts} +668 -85
  14. package/dist/{define-schema-CxpIYFFR.d.ts → define-schema-DgCX9YB7.d.ts} +1 -1
  15. package/dist/{define-schema-Cm_5y3ei.d.cts → define-schema-DkXwpp0I.d.cts} +1 -1
  16. package/dist/{index-DQ7eTUPQ.d.ts → index-BBp8_tn9.d.ts} +467 -193
  17. package/dist/{index-DY64WjZM.d.cts → index-Bp4AiNT3.d.cts} +1 -1
  18. package/dist/{index-Db3_tmYf.d.ts → index-DaMZ4FQ_.d.ts} +1 -1
  19. package/dist/{index-F0UuHpRj.d.cts → index-DxRmKPrR.d.cts} +467 -193
  20. package/dist/index.cjs +96 -71
  21. package/dist/index.d.cts +26 -16
  22. package/dist/index.d.ts +26 -16
  23. package/dist/index.js +4 -3
  24. package/dist/markdown/index.cjs +10 -2
  25. package/dist/markdown/index.d.cts +12 -3
  26. package/dist/markdown/index.d.ts +12 -3
  27. package/dist/markdown/index.js +10 -2
  28. package/dist/preview/index.cjs +29 -0
  29. package/dist/preview/index.d.cts +117 -0
  30. package/dist/preview/index.d.ts +117 -0
  31. package/dist/preview/index.js +4 -0
  32. package/dist/rich-text/index.d.cts +2 -2
  33. package/dist/rich-text/index.d.ts +2 -2
  34. package/dist/schema/index.cjs +33 -33
  35. package/dist/schema/index.d.cts +3 -3
  36. package/dist/schema/index.d.ts +3 -3
  37. package/dist/schema/index.js +1 -1
  38. package/dist/types/index.d.cts +1 -1
  39. package/dist/types/index.d.ts +1 -1
  40. package/package.json +10 -4
package/dist/index.cjs CHANGED
@@ -2,9 +2,10 @@
2
2
 
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
- var chunkX4KSS7PP_cjs = require('./chunk-X4KSS7PP.cjs');
6
- var chunk3BHDGUNS_cjs = require('./chunk-3BHDGUNS.cjs');
5
+ var chunkGHYB6IZK_cjs = require('./chunk-GHYB6IZK.cjs');
6
+ var chunk6E22GYPB_cjs = require('./chunk-6E22GYPB.cjs');
7
7
  require('./chunk-LSRPMNPT.cjs');
8
+ var chunk6PTRZP5U_cjs = require('./chunk-6PTRZP5U.cjs');
8
9
  require('./chunk-PPA2WWOH.cjs');
9
10
  var chunkTZL374LS_cjs = require('./chunk-TZL374LS.cjs');
10
11
  var chunkRSHMA4KT_cjs = require('./chunk-RSHMA4KT.cjs');
@@ -21,9 +22,9 @@ function stopOnUnknownAnswer(_answer) {
21
22
  }
22
23
  chunkMWMSFIWN_cjs.__name(stopOnUnknownAnswer, "stopOnUnknownAnswer");
23
24
  function classifyFollowFailure(error) {
24
- if (error instanceof chunk3BHDGUNS_cjs.LiveEdgeError) return liveEdgeVerdict(error);
25
- if (!(error instanceof chunk3BHDGUNS_cjs.SDKError) || !error.retryable) return { retry: false };
26
- const afterMs = chunk3BHDGUNS_cjs.serviceInstructedDelayMs(error, Date.now());
25
+ if (error instanceof chunk6E22GYPB_cjs.LiveEdgeError) return liveEdgeVerdict(error);
26
+ if (!(error instanceof chunk6E22GYPB_cjs.SDKError) || !error.retryable) return { retry: false };
27
+ const afterMs = chunk6E22GYPB_cjs.serviceInstructedDelayMs(error, Date.now());
27
28
  return afterMs === void 0 ? { retry: true } : { retry: true, afterMs };
28
29
  }
29
30
  chunkMWMSFIWN_cjs.__name(classifyFollowFailure, "classifyFollowFailure");
@@ -37,7 +38,7 @@ function liveEdgeVerdict(error) {
37
38
  return { retry: true, ...hint };
38
39
  }
39
40
  case "back-off": {
40
- return { retry: true, ...hint, backOffMs: chunk3BHDGUNS_cjs.VISITOR_ADMISSION_RETRY_AFTER_SECONDS * 1e3 };
41
+ return { retry: true, ...hint, backOffMs: chunk6PTRZP5U_cjs.VISITOR_ADMISSION_RETRY_AFTER_SECONDS * 1e3 };
41
42
  }
42
43
  default: {
43
44
  return stopOnUnknownAnswer(error.retry);
@@ -50,10 +51,10 @@ async function followChanges(source, options) {
50
51
  const classify = options.classify ?? classifyFollowFailure;
51
52
  const random = options.random ?? Math.random;
52
53
  const report = /* @__PURE__ */ chunkMWMSFIWN_cjs.__name((state) => {
53
- if (!chunk3BHDGUNS_cjs.isAborted(signal)) options.onState?.(state);
54
+ if (!chunk6E22GYPB_cjs.isAborted(signal)) options.onState?.(state);
54
55
  }, "report");
55
56
  const resync = /* @__PURE__ */ chunkMWMSFIWN_cjs.__name(async (cause) => {
56
- if (chunk3BHDGUNS_cjs.isAborted(signal)) return;
57
+ if (chunk6E22GYPB_cjs.isAborted(signal)) return;
57
58
  await onResync(cause);
58
59
  report({ kind: "resynced", resync: cause });
59
60
  }, "resync");
@@ -62,12 +63,12 @@ async function followChanges(source, options) {
62
63
  let unanchored = false;
63
64
  let current;
64
65
  for (; ; ) {
65
- if (chunk3BHDGUNS_cjs.isAborted(signal)) return { kind: "aborted", since };
66
+ if (chunk6E22GYPB_cjs.isAborted(signal)) return { kind: "aborted", since };
66
67
  try {
67
68
  if (unanchored) {
68
69
  unanchored = false;
69
70
  await resync({ cause: "no-cursor" });
70
- if (chunk3BHDGUNS_cjs.isAborted(signal)) return { kind: "aborted", since };
71
+ if (chunk6E22GYPB_cjs.isAborted(signal)) return { kind: "aborted", since };
71
72
  }
72
73
  report({ kind: "following" });
73
74
  const open = {};
@@ -84,13 +85,13 @@ async function followChanges(source, options) {
84
85
  }, "reached")
85
86
  });
86
87
  for await (const change of changes) {
87
- if (chunk3BHDGUNS_cjs.isAborted(signal)) return { kind: "aborted", since };
88
+ if (chunk6E22GYPB_cjs.isAborted(signal)) return { kind: "aborted", since };
88
89
  failures = 0;
89
90
  await onChange(change);
90
91
  since = change.cursor;
91
- if (chunk3BHDGUNS_cjs.isAborted(signal)) return { kind: "aborted", since };
92
+ if (chunk6E22GYPB_cjs.isAborted(signal)) return { kind: "aborted", since };
92
93
  }
93
- if (chunk3BHDGUNS_cjs.isAborted(signal)) return { kind: "aborted", since };
94
+ if (chunk6E22GYPB_cjs.isAborted(signal)) return { kind: "aborted", since };
94
95
  const error = new Error(
95
96
  "The change source completed without its signal aborting; a source ends only on abort and throws every other end."
96
97
  );
@@ -98,7 +99,7 @@ async function followChanges(source, options) {
98
99
  return { kind: "stopped", since, error };
99
100
  } catch (error) {
100
101
  current = void 0;
101
- if (chunk3BHDGUNS_cjs.isAborted(signal)) return { kind: "aborted", since };
102
+ if (chunk6E22GYPB_cjs.isAborted(signal)) return { kind: "aborted", since };
102
103
  const verdict = classify(error);
103
104
  if (!verdict.retry) {
104
105
  report({ kind: "stopped", error });
@@ -107,7 +108,7 @@ async function followChanges(source, options) {
107
108
  failures += 1;
108
109
  const retryInMs = retryDelayMs(failures, verdict, random);
109
110
  report({ kind: "reconnecting", error, retryInMs });
110
- await chunk3BHDGUNS_cjs.sleep(retryInMs, signal);
111
+ await chunk6E22GYPB_cjs.sleep(retryInMs, signal);
111
112
  if (since === void 0) unanchored = true;
112
113
  }
113
114
  }
@@ -279,227 +280,251 @@ var VERSION = "__VERSION__";
279
280
 
280
281
  Object.defineProperty(exports, "defineAssetType", {
281
282
  enumerable: true,
282
- get: function () { return chunkX4KSS7PP_cjs.defineAssetType; }
283
+ get: function () { return chunkGHYB6IZK_cjs.defineAssetType; }
283
284
  });
284
285
  Object.defineProperty(exports, "defineContentType", {
285
286
  enumerable: true,
286
- get: function () { return chunkX4KSS7PP_cjs.defineContentType; }
287
+ get: function () { return chunkGHYB6IZK_cjs.defineContentType; }
288
+ });
289
+ Object.defineProperty(exports, "defineLocale", {
290
+ enumerable: true,
291
+ get: function () { return chunkGHYB6IZK_cjs.defineLocale; }
287
292
  });
288
293
  Object.defineProperty(exports, "defineQuery", {
289
294
  enumerable: true,
290
- get: function () { return chunkX4KSS7PP_cjs.defineQuery; }
295
+ get: function () { return chunkGHYB6IZK_cjs.defineQuery; }
291
296
  });
292
297
  Object.defineProperty(exports, "defineSchema", {
293
298
  enumerable: true,
294
- get: function () { return chunkX4KSS7PP_cjs.defineSchema; }
299
+ get: function () { return chunkGHYB6IZK_cjs.defineSchema; }
295
300
  });
296
301
  Object.defineProperty(exports, "defineSettingsGroup", {
297
302
  enumerable: true,
298
- get: function () { return chunkX4KSS7PP_cjs.defineSettingsGroup; }
303
+ get: function () { return chunkGHYB6IZK_cjs.defineSettingsGroup; }
299
304
  });
300
305
  Object.defineProperty(exports, "defineSingleton", {
301
306
  enumerable: true,
302
- get: function () { return chunkX4KSS7PP_cjs.defineSingleton; }
307
+ get: function () { return chunkGHYB6IZK_cjs.defineSingleton; }
303
308
  });
304
309
  Object.defineProperty(exports, "fields", {
305
310
  enumerable: true,
306
- get: function () { return chunkX4KSS7PP_cjs.fields; }
311
+ get: function () { return chunkGHYB6IZK_cjs.fields; }
307
312
  });
308
313
  Object.defineProperty(exports, "fieldset", {
309
314
  enumerable: true,
310
- get: function () { return chunkX4KSS7PP_cjs.fieldset; }
315
+ get: function () { return chunkGHYB6IZK_cjs.fieldset; }
311
316
  });
312
317
  Object.defineProperty(exports, "AssetClient", {
313
318
  enumerable: true,
314
- get: function () { return chunk3BHDGUNS_cjs.AssetClient; }
319
+ get: function () { return chunk6E22GYPB_cjs.AssetClient; }
315
320
  });
316
321
  Object.defineProperty(exports, "AssetFileBuilder", {
317
322
  enumerable: true,
318
- get: function () { return chunk3BHDGUNS_cjs.AssetFileBuilder; }
323
+ get: function () { return chunk6E22GYPB_cjs.AssetFileBuilder; }
319
324
  });
320
325
  Object.defineProperty(exports, "AssetUploadBuilder", {
321
326
  enumerable: true,
322
- get: function () { return chunk3BHDGUNS_cjs.AssetUploadBuilder; }
327
+ get: function () { return chunk6E22GYPB_cjs.AssetUploadBuilder; }
323
328
  });
324
329
  Object.defineProperty(exports, "AuthorizationError", {
325
330
  enumerable: true,
326
- get: function () { return chunk3BHDGUNS_cjs.AuthorizationError; }
331
+ get: function () { return chunk6E22GYPB_cjs.AuthorizationError; }
327
332
  });
328
333
  Object.defineProperty(exports, "BaseValidationError", {
329
334
  enumerable: true,
330
- get: function () { return chunk3BHDGUNS_cjs.BaseValidationError; }
335
+ get: function () { return chunk6E22GYPB_cjs.BaseValidationError; }
331
336
  });
332
337
  Object.defineProperty(exports, "ChangesExpiredError", {
333
338
  enumerable: true,
334
- get: function () { return chunk3BHDGUNS_cjs.ChangesExpiredError; }
339
+ get: function () { return chunk6E22GYPB_cjs.ChangesExpiredError; }
335
340
  });
336
341
  Object.defineProperty(exports, "ConnectionError", {
337
342
  enumerable: true,
338
- get: function () { return chunk3BHDGUNS_cjs.ConnectionError; }
343
+ get: function () { return chunk6E22GYPB_cjs.ConnectionError; }
339
344
  });
340
345
  Object.defineProperty(exports, "ContentClient", {
341
346
  enumerable: true,
342
- get: function () { return chunk3BHDGUNS_cjs.ContentClient; }
347
+ get: function () { return chunk6E22GYPB_cjs.ContentClient; }
348
+ });
349
+ Object.defineProperty(exports, "DefaultRetryPolicy", {
350
+ enumerable: true,
351
+ get: function () { return chunk6E22GYPB_cjs.DefaultRetryPolicy; }
343
352
  });
344
353
  Object.defineProperty(exports, "ErrorMapper", {
345
354
  enumerable: true,
346
- get: function () { return chunk3BHDGUNS_cjs.ErrorMapper; }
355
+ get: function () { return chunk6E22GYPB_cjs.ErrorMapper; }
347
356
  });
348
357
  Object.defineProperty(exports, "FileUploadError", {
349
358
  enumerable: true,
350
- get: function () { return chunk3BHDGUNS_cjs.FileUploadError; }
359
+ get: function () { return chunk6E22GYPB_cjs.FileUploadError; }
351
360
  });
352
361
  Object.defineProperty(exports, "FileValidationError", {
353
362
  enumerable: true,
354
- get: function () { return chunk3BHDGUNS_cjs.FileValidationError; }
363
+ get: function () { return chunk6E22GYPB_cjs.FileValidationError; }
355
364
  });
356
365
  Object.defineProperty(exports, "HttpClient", {
357
366
  enumerable: true,
358
- get: function () { return chunk3BHDGUNS_cjs.HttpClient; }
367
+ get: function () { return chunk6E22GYPB_cjs.HttpClient; }
359
368
  });
360
369
  Object.defineProperty(exports, "InvalidApiKeyError", {
361
370
  enumerable: true,
362
- get: function () { return chunk3BHDGUNS_cjs.InvalidApiKeyError; }
371
+ get: function () { return chunk6E22GYPB_cjs.InvalidApiKeyError; }
363
372
  });
364
373
  Object.defineProperty(exports, "InvalidPayloadError", {
365
374
  enumerable: true,
366
- get: function () { return chunk3BHDGUNS_cjs.InvalidPayloadError; }
375
+ get: function () { return chunk6E22GYPB_cjs.InvalidPayloadError; }
367
376
  });
368
377
  Object.defineProperty(exports, "LIVE_KEEPALIVE_INTERVAL_MS", {
369
378
  enumerable: true,
370
- get: function () { return chunk3BHDGUNS_cjs.LIVE_KEEPALIVE_INTERVAL_MS; }
379
+ get: function () { return chunk6E22GYPB_cjs.LIVE_KEEPALIVE_INTERVAL_MS; }
371
380
  });
372
381
  Object.defineProperty(exports, "LIVE_SOCKET_OPEN_TIMEOUT_MS", {
373
382
  enumerable: true,
374
- get: function () { return chunk3BHDGUNS_cjs.LIVE_SOCKET_OPEN_TIMEOUT_MS; }
383
+ get: function () { return chunk6E22GYPB_cjs.LIVE_SOCKET_OPEN_TIMEOUT_MS; }
375
384
  });
376
385
  Object.defineProperty(exports, "LiveEdgeError", {
377
386
  enumerable: true,
378
- get: function () { return chunk3BHDGUNS_cjs.LiveEdgeError; }
387
+ get: function () { return chunk6E22GYPB_cjs.LiveEdgeError; }
379
388
  });
380
389
  Object.defineProperty(exports, "MethodNotAllowedError", {
381
390
  enumerable: true,
382
- get: function () { return chunk3BHDGUNS_cjs.MethodNotAllowedError; }
391
+ get: function () { return chunk6E22GYPB_cjs.MethodNotAllowedError; }
383
392
  });
384
393
  Object.defineProperty(exports, "MissingApiKeyError", {
385
394
  enumerable: true,
386
- get: function () { return chunk3BHDGUNS_cjs.MissingApiKeyError; }
395
+ get: function () { return chunk6E22GYPB_cjs.MissingApiKeyError; }
387
396
  });
388
397
  Object.defineProperty(exports, "NetworkError", {
389
398
  enumerable: true,
390
- get: function () { return chunk3BHDGUNS_cjs.NetworkError; }
399
+ get: function () { return chunk6E22GYPB_cjs.NetworkError; }
400
+ });
401
+ Object.defineProperty(exports, "PREVIEW_KEY_PREFIX", {
402
+ enumerable: true,
403
+ get: function () { return chunk6E22GYPB_cjs.PREVIEW_KEY_PREFIX; }
391
404
  });
392
405
  Object.defineProperty(exports, "PUBLISHABLE_KEY_PREFIX", {
393
406
  enumerable: true,
394
- get: function () { return chunk3BHDGUNS_cjs.PUBLISHABLE_KEY_PREFIX; }
407
+ get: function () { return chunk6E22GYPB_cjs.PUBLISHABLE_KEY_PREFIX; }
395
408
  });
396
409
  Object.defineProperty(exports, "PayloadTooLargeError", {
397
410
  enumerable: true,
398
- get: function () { return chunk3BHDGUNS_cjs.PayloadTooLargeError; }
411
+ get: function () { return chunk6E22GYPB_cjs.PayloadTooLargeError; }
399
412
  });
400
413
  Object.defineProperty(exports, "PlanFeatureUnavailableError", {
401
414
  enumerable: true,
402
- get: function () { return chunk3BHDGUNS_cjs.PlanFeatureUnavailableError; }
415
+ get: function () { return chunk6E22GYPB_cjs.PlanFeatureUnavailableError; }
403
416
  });
404
417
  Object.defineProperty(exports, "RateLimitError", {
405
418
  enumerable: true,
406
- get: function () { return chunk3BHDGUNS_cjs.RateLimitError; }
419
+ get: function () { return chunk6E22GYPB_cjs.RateLimitError; }
407
420
  });
408
421
  Object.defineProperty(exports, "ReadOnlyKeyError", {
409
422
  enumerable: true,
410
- get: function () { return chunk3BHDGUNS_cjs.ReadOnlyKeyError; }
423
+ get: function () { return chunk6E22GYPB_cjs.ReadOnlyKeyError; }
411
424
  });
412
425
  Object.defineProperty(exports, "ResourceConflictError", {
413
426
  enumerable: true,
414
- get: function () { return chunk3BHDGUNS_cjs.ResourceConflictError; }
427
+ get: function () { return chunk6E22GYPB_cjs.ResourceConflictError; }
415
428
  });
416
429
  Object.defineProperty(exports, "ResourceExpiredError", {
417
430
  enumerable: true,
418
- get: function () { return chunk3BHDGUNS_cjs.ResourceExpiredError; }
431
+ get: function () { return chunk6E22GYPB_cjs.ResourceExpiredError; }
419
432
  });
420
433
  Object.defineProperty(exports, "ResourceNotFoundError", {
421
434
  enumerable: true,
422
- get: function () { return chunk3BHDGUNS_cjs.ResourceNotFoundError; }
435
+ get: function () { return chunk6E22GYPB_cjs.ResourceNotFoundError; }
423
436
  });
424
437
  Object.defineProperty(exports, "SDKError", {
425
438
  enumerable: true,
426
- get: function () { return chunk3BHDGUNS_cjs.SDKError; }
439
+ get: function () { return chunk6E22GYPB_cjs.SDKError; }
427
440
  });
428
441
  Object.defineProperty(exports, "ServerError", {
429
442
  enumerable: true,
430
- get: function () { return chunk3BHDGUNS_cjs.ServerError; }
443
+ get: function () { return chunk6E22GYPB_cjs.ServerError; }
431
444
  });
432
445
  Object.defineProperty(exports, "ServiceIndeterminateError", {
433
446
  enumerable: true,
434
- get: function () { return chunk3BHDGUNS_cjs.ServiceIndeterminateError; }
447
+ get: function () { return chunk6E22GYPB_cjs.ServiceIndeterminateError; }
435
448
  });
436
449
  Object.defineProperty(exports, "SettingsClient", {
437
450
  enumerable: true,
438
- get: function () { return chunk3BHDGUNS_cjs.SettingsClient; }
451
+ get: function () { return chunk6E22GYPB_cjs.SettingsClient; }
439
452
  });
440
453
  Object.defineProperty(exports, "SingletonClient", {
441
454
  enumerable: true,
442
- get: function () { return chunk3BHDGUNS_cjs.SingletonClient; }
455
+ get: function () { return chunk6E22GYPB_cjs.SingletonClient; }
443
456
  });
444
457
  Object.defineProperty(exports, "TimeoutError", {
445
458
  enumerable: true,
446
- get: function () { return chunk3BHDGUNS_cjs.TimeoutError; }
459
+ get: function () { return chunk6E22GYPB_cjs.TimeoutError; }
447
460
  });
448
461
  Object.defineProperty(exports, "TransactionRolledBackError", {
449
462
  enumerable: true,
450
- get: function () { return chunk3BHDGUNS_cjs.TransactionRolledBackError; }
463
+ get: function () { return chunk6E22GYPB_cjs.TransactionRolledBackError; }
451
464
  });
452
465
  Object.defineProperty(exports, "TypedRelyIOClient", {
453
466
  enumerable: true,
454
- get: function () { return chunk3BHDGUNS_cjs.TypedRelyIOClient; }
467
+ get: function () { return chunk6E22GYPB_cjs.TypedRelyIOClient; }
455
468
  });
456
469
  Object.defineProperty(exports, "UnknownContractError", {
457
470
  enumerable: true,
458
- get: function () { return chunk3BHDGUNS_cjs.UnknownContractError; }
471
+ get: function () { return chunk6E22GYPB_cjs.UnknownContractError; }
459
472
  });
460
473
  Object.defineProperty(exports, "UsageQuotaExceededError", {
461
474
  enumerable: true,
462
- get: function () { return chunk3BHDGUNS_cjs.UsageQuotaExceededError; }
475
+ get: function () { return chunk6E22GYPB_cjs.UsageQuotaExceededError; }
463
476
  });
464
477
  Object.defineProperty(exports, "ValidationError", {
465
478
  enumerable: true,
466
- get: function () { return chunk3BHDGUNS_cjs.ValidationError; }
479
+ get: function () { return chunk6E22GYPB_cjs.ValidationError; }
467
480
  });
468
481
  Object.defineProperty(exports, "createClient", {
469
482
  enumerable: true,
470
- get: function () { return chunk3BHDGUNS_cjs.createClient; }
483
+ get: function () { return chunk6E22GYPB_cjs.createClient; }
471
484
  });
472
485
  Object.defineProperty(exports, "default", {
473
486
  enumerable: true,
474
- get: function () { return chunk3BHDGUNS_cjs.createClient; }
487
+ get: function () { return chunk6E22GYPB_cjs.createClient; }
475
488
  });
476
489
  Object.defineProperty(exports, "isAssetEntry", {
477
490
  enumerable: true,
478
- get: function () { return chunk3BHDGUNS_cjs.isAssetEntry; }
491
+ get: function () { return chunk6E22GYPB_cjs.isAssetEntry; }
479
492
  });
480
493
  Object.defineProperty(exports, "isMissingEntry", {
481
494
  enumerable: true,
482
- get: function () { return chunk3BHDGUNS_cjs.isMissingEntry; }
495
+ get: function () { return chunk6E22GYPB_cjs.isMissingEntry; }
496
+ });
497
+ Object.defineProperty(exports, "isPreviewKey", {
498
+ enumerable: true,
499
+ get: function () { return chunk6E22GYPB_cjs.isPreviewKey; }
483
500
  });
484
501
  Object.defineProperty(exports, "isPublishableKey", {
485
502
  enumerable: true,
486
- get: function () { return chunk3BHDGUNS_cjs.isPublishableKey; }
503
+ get: function () { return chunk6E22GYPB_cjs.isPublishableKey; }
504
+ });
505
+ Object.defineProperty(exports, "isReplaySafe", {
506
+ enumerable: true,
507
+ get: function () { return chunk6E22GYPB_cjs.isReplaySafe; }
487
508
  });
488
509
  Object.defineProperty(exports, "isResourceNotFound", {
489
510
  enumerable: true,
490
- get: function () { return chunk3BHDGUNS_cjs.isResourceNotFound; }
511
+ get: function () { return chunk6E22GYPB_cjs.isResourceNotFound; }
491
512
  });
492
513
  Object.defineProperty(exports, "matchRoute", {
493
514
  enumerable: true,
494
- get: function () { return chunk3BHDGUNS_cjs.matchRoute; }
515
+ get: function () { return chunk6E22GYPB_cjs.matchRoute; }
516
+ });
517
+ Object.defineProperty(exports, "retryPolicyFor", {
518
+ enumerable: true,
519
+ get: function () { return chunk6E22GYPB_cjs.retryPolicyFor; }
495
520
  });
496
521
  Object.defineProperty(exports, "validateFile", {
497
522
  enumerable: true,
498
- get: function () { return chunk3BHDGUNS_cjs.validateFile; }
523
+ get: function () { return chunk6E22GYPB_cjs.validateFile; }
499
524
  });
500
525
  Object.defineProperty(exports, "versionCheckOf", {
501
526
  enumerable: true,
502
- get: function () { return chunk3BHDGUNS_cjs.versionCheckOf; }
527
+ get: function () { return chunk6E22GYPB_cjs.versionCheckOf; }
503
528
  });
504
529
  Object.defineProperty(exports, "camelToSnake", {
505
530
  enumerable: true,
package/dist/index.d.cts CHANGED
@@ -1,12 +1,11 @@
1
- import { C as Change, a as ChangesExpiredError, b as ChangesExpiredReason } from './index-F0UuHpRj.cjs';
2
- export { i as ActiveSandbox, aI as AdhocQuery, aJ as AdhocRecord, aG as AggregateMetric, A as AnySchemaDefinition, m as ApiMethod, l as ApiPath, n as ApiSuccessBody, aR as AssetClient, a_ as AssetEntryResponse, aS as AssetFileBuilder, aY as AssetFileExtracted, b7 as AssetPlacement, aT as AssetUploadBuilder, aV as AssetVisibility, ai as AutocompleteOptions, ad as AutocompleteResponse, ac as AutocompleteSuggestion, ay as BatchBody, az as BatchCreate, aC as BatchDelete, aF as BatchDeleteTarget, at as BatchOperationResult, aB as BatchReplace, av as BatchResponse, aD as BatchSingletonWrite, au as BatchSummary, aE as BatchTarget, aA as BatchUpdate, aw as BatchWrite, ax as BatchWriteOptions, s as ChangesHeadOptions, t as ChangesOptions, U as ChildrenListOptions, Q as ChildrenOptions, e as ClientDefaults, f as ClientSchema, b2 as ConfirmInput, b3 as ConfirmResult, y as ContentClient, b6 as CreateAssetOptions, z as CreateEntryOptions, g as DeployedContentType, D as DeployedLocale, J as DocumentFields, V as DocumentReadOptions, K as DocumentVersion, N as DocumentVersionsOptions, O as DocumentWriteOptions, X as EntryList, E as EntryPlacement, B as EntryWriteOptions, F as FeedChange, Y as FieldKey, aX as FileBackend, bj as FileErrorCode, aW as FileStatus, aZ as FileStatusResult, bl as FileUploadError, bk as FileUploadErrorCode, bn as FileValidationConstraints, bm as FileValidationError, Z as FreshOption, _ as GetOptions, H as Health, j as HttpClient, u as LIVE_KEEPALIVE_INTERVAL_MS, w as LIVE_SOCKET_OPEN_TIMEOUT_MS, $ as ListAllOptions, a0 as ListOptions, x as LiveChangesOptions, L as LocaleCodeOf, a1 as LocaleOption, M as MatchRouteOptions, ba as MultipartCreateResult, bb as MultipartPart, bc as MultipartTarget, aK as NamedQueryOptions, aL as NamedQueryParams, a2 as Paging, a$ as PopulatedAssetReference, b0 as PresignInput, b1 as PresignResult, P as Project, aM as QueryAggregate, aN as QueryAnswer, aO as QueryCall, aH as QueryMetadata, aP as QueryName, aQ as QueryTypeName, a3 as ReadAs, q as ReadEntry, a4 as ReadLocale, R as Register, h as RegisteredSchema, b4 as ResolveUrlInput, b5 as ResolveUrlResult, bf as ResourceConflictError, bg as ResourceExpiredError, be as ResourceNotFoundError, r as RetryableWriteOptions, p as RouteMatch, S as SandboxState, ah as SearchEntry, aj as SearchFacet, ak as SearchFieldKey, al as SearchHighlight, aa as SearchHitMetadata, am as SearchOptions, an as SearchPage, ab as SearchResponse, a9 as SearchResultItem, ao as SearchScope, ap as SearchSelected, aq as SearchSortOption, ag as SearchTypeName, ar as SearchWhere, k as SendOptions, I as SettingsClient, as as SimilarOptions, af as SimilarResponse, ae as SimilarResult, G as SingletonClient, a5 as SortOption, d as TypedClientConfig, T as TypedRelyIOClient, b8 as UpdateAssetOptions, bd as UploadProgress, a6 as VersionOptions, b9 as WaitUntilReadyOptions, W as Wire, a7 as WrittenReadScope, a8 as WrittenSort, c as createClient, c as default, aU as isAssetEntry, bi as isMissingEntry, bh as isResourceNotFound, o as matchRoute, bo as validateFile, v as versionCheckOf } from './index-F0UuHpRj.cjs';
1
+ import { C as Change, a as ChangesExpiredError, V as VisitorRetry, b as ChangesExpiredReason } from './index-DxRmKPrR.cjs';
2
+ export { i as ActiveSandbox, aS as AdhocQuery, aT as AdhocRecord, aQ as AggregateMetric, A as AnySchemaDefinition, m as ApiMethod, l as ApiPath, n as ApiSuccessBody, a$ as AssetClient, b8 as AssetEntryResponse, b0 as AssetFileBuilder, b6 as AssetFileExtracted, b9 as AssetFileWhere, bi as AssetPlacement, b1 as AssetUploadBuilder, b3 as AssetVisibility, as as AutocompleteOptions, an as AutocompleteResponse, am as AutocompleteSuggestion, aI as BatchBody, aJ as BatchCreate, aM as BatchDelete, aP as BatchDeleteTarget, aD as BatchOperationResult, aL as BatchReplace, aF as BatchResponse, aN as BatchSingletonWrite, aE as BatchSummary, aO as BatchTarget, aK as BatchUpdate, aG as BatchWrite, aH as BatchWriteOptions, y as ChangesHeadOptions, z as ChangesOptions, aa as ChildEntry, a0 as ChildrenListOptions, $ as ChildrenOptions, ab as ChildrenRead, e as ClientDefaults, f as ClientSchema, bd as ConfirmInput, be as ConfirmResult, I as ContentClient, bh as CreateAssetOptions, J as CreateEntryOptions, s as DefaultRetryPolicy, g as DeployedContentType, D as DeployedLocale, U as DocumentFields, a1 as DocumentReadOptions, X as DocumentVersion, Y as DocumentVersionRow, Z as DocumentVersionsOptions, _ as DocumentWriteOptions, a2 as EntryList, K as EntryPlacement, N as EntryWriteOptions, F as FeedChange, a3 as FieldKey, b5 as FileBackend, bu as FileErrorCode, b4 as FileStatus, b7 as FileStatusResult, bw as FileUploadError, bv as FileUploadErrorCode, by as FileValidationConstraints, bx as FileValidationError, a4 as FreshOption, a5 as GetOptions, H as Health, j as HttpClient, B as LIVE_KEEPALIVE_INTERVAL_MS, E as LIVE_SOCKET_OPEN_TIMEOUT_MS, a6 as ListAllOptions, a7 as ListOptions, G as LiveChangesOptions, L as LocaleCodeOf, a8 as LocaleOption, M as MatchRouteOptions, bl as MultipartCreateResult, bm as MultipartPart, bn as MultipartTarget, aU as NamedQueryOptions, aV as NamedQueryParams, a9 as Paging, ba as PopulatedAssetReference, bb as PresignInput, bc as PresignResult, P as Project, aW as QueryAggregate, aX as QueryAnswer, aY as QueryCall, aR as QueryMetadata, aZ as QueryName, a_ as QueryTypeName, ac as ReadAs, q as ReadEntry, ae as ReadLocale, R as Register, h as RegisteredSchema, bf as ResolveUrlInput, bg as ResolveUrlResult, bq as ResourceConflictError, br as ResourceExpiredError, bp as ResourceNotFoundError, w as RetryPolicy, x as RetryableRequest, r as RetryableWriteOptions, p as RouteMatch, S as SandboxState, ar as SearchEntry, at as SearchFacet, au as SearchFieldKey, av as SearchHighlight, ak as SearchHitMetadata, aw as SearchOptions, ax as SearchPage, al as SearchResponse, aj as SearchResultItem, ay as SearchScope, az as SearchSelected, aA as SearchSortOption, aq as SearchTypeName, aB as SearchWhere, k as SendOptions, Q as SettingsClient, aC as SimilarOptions, ap as SimilarResponse, ao as SimilarResult, O as SingletonClient, af as SortOption, d as TypedClientConfig, T as TypedRelyIOClient, bj as UpdateAssetOptions, bo as UploadProgress, ag as VersionOptions, bk as WaitUntilReadyOptions, W as Wire, ad as WithChildren, ah as WrittenReadScope, ai as WrittenSort, c as createClient, c as default, b2 as isAssetEntry, bt as isMissingEntry, t as isReplaySafe, bs as isResourceNotFound, o as matchRoute, u as retryPolicyFor, bz as validateFile, v as versionCheckOf } from './index-DxRmKPrR.cjs';
3
3
  export { fields } from './schema/index.cjs';
4
- import { cl as SDKError, aM as EntryMetadata } from './define-content-type-B2gQZkTy.cjs';
5
- export { aH as AnyDeclaredFieldset, cS as ApiResponse, cq as AssetFileBlock, ak as AssetReading, b2 as AssetServedBlocks, a$ as AssetTypeDefinition, cr as AssetUrls, cs as BaseContent, B as BaseFieldConfig, cu as BaseSettingsGroup, ct as BaseSingleton, cY as BaseValidationError, ai as BlockOf, cO as CacheConfig, cU as CacheStrategy, am as CheckInclude, al as CheckedIncludes, an as ContentReading, aL as ContentTypeDefinition, cG as ContentTypeSchema, cA as CreateInput, cF as CustomQuery, cz as DateOnlyOperator, cQ as DebugConfig, aG as DeclaredFieldset, cW as Environment, h as FieldDefinition, aJ as FieldMember, cJ as FieldOptions, i as FieldRule, ac as FieldSchemaContext, j as FieldType, cH as FieldTypeName, k as FieldUIConfig, ad as FieldValue, ae as FieldValues, aF as Fieldset, b5 as FileKindConfig, bj as FileScanConfig, bi as FileUploadConfig, bb as ImageExifConfig, b3 as ImageKindConfig, ba as ImageSourceConfig, b9 as ImageUploadConfig, ao as IncludablePaths, b1 as InferAssetEntry, b0 as InferAssetType, aN as InferContentType, ca as InferJsonSchema, aT as InferSingleton, c_ as InvalidPayloadError, cb as JsonFieldValue, cc as JsonSchema, cd as JsonValue, ah as Keyed, a_ as KeyedAssetTypeConfig, aK as KeyedContentTypeConfig, K as KeyedEnumConfig, l as KeyedField, m as KeyedFieldOptions, aI as KeyedFieldsetConfig, aV as KeyedSettingsGroupConfig, aQ as KeyedSingletonConfig, co as LiveWebSocket, cp as LiveWebSocketConstructor, aO as LocalePublicationFields, r as LocalizationConfig, s as Localized, t as LocalizedDetails, cV as LogLevel, cN as PerformanceMetrics, aq as ReadWith, ap as Reading, cP as RealtimeConfig, cL as RealtimeEvent, cK as RealtimeEventType, cm as RelyIOConfig, cn as RelyIOConfigUpdate, cR as RequestConfig, cC as RestoredContent, cT as RetryConfig, cB as RevisedContent, aW as SettingsGroupDefinition, ar as SettingsReading, aj as ShapeValue, cE as SingletonContent, aR as SingletonContentTypeDefinition, aS as SingletonMetadata, as as SingletonReading, cM as SubscriptionOptions, ag as UnresolvedEntry, at as UntypedReading, cD as UpdateInput, cZ as ValidationError, cI as ValidationRule, cX as ValidationViolation, bc as VariantDefinition, bf as VideoCaptionsConfig, bg as VideoDownloadConfig, b4 as VideoKindConfig, be as VideoPosterConfig, bd as VideoUploadConfig, bh as VideoWatermarkConfig, cx as WhereClause, cw as WhereFieldCondition, cy as WhereOperator, cv as WhereScalar, W as WidgetOptions, aZ as defineAssetType, aD as defineContentType, aU as defineSettingsGroup, aP as defineSingleton, aE as fieldset } from './define-content-type-B2gQZkTy.cjs';
6
- import { VisitorRetry } from './live-visitor.js';
4
+ import { cl as SDKError, aM as EntryMetadata } from './define-content-type-AuL9-oz6.cjs';
5
+ export { aH as AnyDeclaredFieldset, cV as ApiResponse, cq as AssetFileBlock, ak as AssetReading, b2 as AssetServedBlocks, a$ as AssetTypeDefinition, cr as AssetUrls, cs as BaseContent, B as BaseFieldConfig, cu as BaseSettingsGroup, ct as BaseSingleton, c$ as BaseValidationError, ai as BlockOf, cS as CacheConfig, cX as CacheStrategy, am as CheckInclude, al as CheckedIncludes, an as ContentReading, aL as ContentTypeDefinition, cL as ContentTypeSchema, cG as ContentVersion, cH as ContentVersionRow, cA as CreateInput, cB as CreatedContent, cK as CustomQuery, cz as DateOnlyOperator, cT as DebugConfig, aG as DeclaredFieldset, cZ as Environment, h as FieldDefinition, aJ as FieldMember, cN as FieldOptions, i as FieldRule, ac as FieldSchemaContext, j as FieldType, k as FieldUIConfig, ad as FieldValue, ae as FieldValues, aF as Fieldset, b5 as FileKindConfig, bj as FileScanConfig, bi as FileUploadConfig, bb as ImageExifConfig, b3 as ImageKindConfig, ba as ImageSourceConfig, b9 as ImageUploadConfig, ao as IncludablePaths, b1 as InferAssetEntry, b0 as InferAssetType, aN as InferContentType, ca as InferJsonSchema, aT as InferSingleton, d1 as InvalidPayloadError, cb as JsonFieldValue, cc as JsonSchema, cd as JsonValue, ah as Keyed, a_ as KeyedAssetTypeConfig, aK as KeyedContentTypeConfig, K as KeyedEnumConfig, l as KeyedField, m as KeyedFieldOptions, aI as KeyedFieldsetConfig, aV as KeyedSettingsGroupConfig, aQ as KeyedSingletonConfig, co as LiveWebSocket, cp as LiveWebSocketConstructor, aO as LocalePublicationFields, r as LocalizationConfig, s as Localized, t as LocalizedDetails, cY as LogLevel, cR as PerformanceMetrics, aq as ReadWith, ap as Reading, cP as RealtimeEvent, cO as RealtimeEventType, cm as RelyIOConfig, cn as RelyIOConfigUpdate, cU as RequestConfig, cF as RestoredContent, cW as RetryConfig, cC as RevisedContent, aW as SettingsGroupDefinition, ar as SettingsReading, aj as ShapeValue, cJ as SingletonContent, aR as SingletonContentTypeDefinition, aS as SingletonMetadata, as as SingletonReading, cQ as SubscriptionOptions, ag as UnresolvedEntry, at as UntypedReading, cI as UpdateInput, d0 as ValidationError, cM as ValidationRule, c_ as ValidationViolation, bc as VariantDefinition, bf as VideoCaptionsConfig, bg as VideoDownloadConfig, b4 as VideoKindConfig, be as VideoPosterConfig, bd as VideoUploadConfig, bh as VideoWatermarkConfig, cx as WhereClause, cw as WhereFieldCondition, cy as WhereOperator, cv as WhereScalar, W as WidgetOptions, cE as WrittenSettingsGroup, cD as WrittenSingleton, aZ as defineAssetType, aD as defineContentType, au as defineLocale, aU as defineSettingsGroup, aP as defineSingleton, aE as fieldset } from './define-content-type-AuL9-oz6.cjs';
7
6
  export { camelToSnake, createDeferred, debounce, deepClone, generateId, isBrowser, isNode, isPlainObject, isValidEmail, isValidUrl, mergeDeep, omit, pick, retry, sleep, snakeToCamel, throttle, toSafeString } from './utils/index.cjs';
8
- export { n as RICH_TEXT_VOID_TAGS, R as RelyIOFieldAttributes, a as RelyIOFieldName, b as RelyIOFieldPath, c as RelyIOKeyed, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, r as relyioField, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from './index-DY64WjZM.cjs';
9
- export { A as AggregateBlock, L as AnyQueryParameters, M as DeclaredParameters, n as FetchBlock, w as FilterDefinition, I as IncludeDefinition, J as InferQueryParams, G as InferQueryResponse, Q as QueryConfig, l as QueryDefinition, K as QueryParameterValue, h as SchemaAssetTypeNames, S as SchemaConfig, b as SchemaContentTypeNames, a as SchemaDefinition, i as SchemaEntry, j as SchemaEntryOf, f as SchemaLocaleCodes, e as SchemaQueryNames, g as SchemaSettingsGroupNames, c as SchemaSingletonNames, o as SearchBlock, v as SelectMapping, s as SortCondition, W as WhereCondition, k as defineQuery, d as defineSchema } from './define-schema-Cm_5y3ei.cjs';
7
+ export { n as RICH_TEXT_VOID_TAGS, R as RelyIOFieldAttributes, a as RelyIOFieldName, b as RelyIOFieldPath, c as RelyIOKeyed, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, r as relyioField, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from './index-Bp4AiNT3.cjs';
8
+ export { A as AggregateBlock, L as AnyQueryParameters, M as DeclaredParameters, n as FetchBlock, w as FilterDefinition, I as IncludeDefinition, J as InferQueryParams, G as InferQueryResponse, Q as QueryConfig, l as QueryDefinition, K as QueryParameterValue, h as SchemaAssetTypeNames, S as SchemaConfig, b as SchemaContentTypeNames, a as SchemaDefinition, i as SchemaEntry, j as SchemaEntryOf, f as SchemaLocaleCodes, e as SchemaQueryNames, g as SchemaSettingsGroupNames, c as SchemaSingletonNames, o as SearchBlock, v as SelectMapping, s as SortCondition, W as WhereCondition, k as defineQuery, d as defineSchema } from './define-schema-DkXwpp0I.cjs';
10
9
  export { e as RichTextBlock, f as RichTextCellAlignment, g as RichTextCodeBlock, h as RichTextCodeGroup, i as RichTextCodeLines, j as RichTextDivider, d as RichTextEntryLinkMark, k as RichTextHeading, l as RichTextInline, m as RichTextLineBreak, n as RichTextLinkMark, o as RichTextList, p as RichTextListItem, q as RichTextListStyle, r as RichTextMark, s as RichTextMarkType, t as RichTextNode, u as RichTextParagraph, v as RichTextQuote, w as RichTextSpan, x as RichTextStructure, y as RichTextTable, z as RichTextTableCell, B as RichTextTableRow, b as RichTextValue } from './rich-text.d-BWc-5gX1.cjs';
11
10
  import './dev-handshake/index.cjs';
12
11
 
@@ -35,6 +34,18 @@ declare const PUBLISHABLE_KEY_PREFIX = "rly_pub_";
35
34
  * publishable key, so the answer is `false` rather than a `TypeError` in a caller that only asked.
36
35
  */
37
36
  declare const isPublishableKey: (apiKey: string | undefined) => boolean;
37
+ /**
38
+ * A preview key's prefix: scope `prev`, the one project key that reads drafts and the only kind a
39
+ * client sends a pull request's preview dataset with (`github-integration-spec.md` decision 14).
40
+ * Restated from the service's `isPreviewApiKey` and held to it by `src/__tests__/key-kind.test.ts`,
41
+ * as the publishable prefix is.
42
+ */
43
+ declare const PREVIEW_KEY_PREFIX = "rly_prev_";
44
+ /**
45
+ * Whether `apiKey` is a preview key (`rly_prev_…`). It reads the prefix only, as
46
+ * {@link isPublishableKey} does; `undefined` — a client holding no key — is not one.
47
+ */
48
+ declare const isPreviewKey: (apiKey: string | undefined) => boolean;
38
49
 
39
50
  /**
40
51
  * `followChanges()` — the one loop that follows a changes source until its
@@ -432,9 +443,13 @@ declare class PayloadTooLargeError extends SDKError {
432
443
  getUserMessage(): string;
433
444
  }
434
445
  /**
435
- * `TRANSACTION_ROLLED_BACK` — an atomic batch failed at one member and nothing
436
- * was written. `failedIndex` is which one, so a caller can fix that operation
437
- * rather than re-sending the whole batch blind.
446
+ * `TRANSACTION_ROLLED_BACK` — an atomic batch failed and nothing was written.
447
+ *
448
+ * `failedIndex` is the index, in the batch, of the operation this refusal was
449
+ * served for. The service sends each rolled-back item its **own** index, so it
450
+ * does not say which operation caused the rollback: read it as "this is
451
+ * operation N", never "operation N failed". Find the cause among the batch's
452
+ * results, not here.
438
453
  */
439
454
  declare class TransactionRolledBackError extends SDKError {
440
455
  readonly code = "TRANSACTION_ROLLED_BACK";
@@ -552,11 +567,6 @@ declare class LiveEdgeError extends SDKError {
552
567
  readonly retryAfterMs?: number;
553
568
  readonly context?: Record<string, unknown>;
554
569
  });
555
- /**
556
- * The base class rebuilds an error through its own four-argument constructor, which this class
557
- * does not have; rebuilt that way, `end` would be a string and `retry` a number.
558
- */
559
- withContext(context: Record<string, unknown>): this;
560
570
  getUserMessage(): string;
561
571
  }
562
572
 
@@ -972,4 +982,4 @@ declare function snapToLadder(value: number): number;
972
982
 
973
983
  declare const VERSION = "__VERSION__";
974
984
 
975
- export { AuthorizationError, Change, type ChangeSource, type ChangeSourceOptions, ChangesExpiredError, ChangesExpiredReason, ConnectionError, EntryMetadata, ErrorMapper, FOLLOW_BACK_OFF_MAX_MS, FOLLOW_RETRY_BASE_MS, FOLLOW_RETRY_MAX_MS, type FollowEnd, type FollowOptions, type FollowResync, type FollowState, type FollowVerdict, IMAGE_LADDER, InvalidApiKeyError, type KeyPathSegment, type LanguageSwitcherOption, type LanguageSwitcherOptions, type LiveEdgeEnd, LiveEdgeError, type LocaleMetadata, type LocaleStatus, type LocalizedEntry, MethodNotAllowedError, MissingApiKeyError, NetworkError, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, RELYIO_CHANGE_EVENT, RELYIO_RESYNC_EVENT, RateLimitError, ReadOnlyKeyError, type RelyIOChangeDetail, type RelyIOResyncDetail, SDKError, ServerError, ServiceIndeterminateError, TimeoutError, TransactionRolledBackError, type TranslationCompleteness, UnknownContractError, UsageQuotaExceededError, VERSION, buildLanguageSwitcher, classifyFollowFailure, estimateTranslationCompleteness, followChanges, formatKeyPath, getAllLocalizedValues, getAvailableLocaleCodes, getDefaultLocale, getFallbackFields, getFieldFallbackLocale, getLocalizedField, getPublishedLocaleCodes, getRequestedLocale, hasLocale, isFieldFallback, isPublishableKey, isPublishedInLocale, localeHelpers, needsTranslation, parseKeyPath, snapToLadder };
985
+ export { AuthorizationError, Change, type ChangeSource, type ChangeSourceOptions, ChangesExpiredError, ChangesExpiredReason, ConnectionError, EntryMetadata, ErrorMapper, FOLLOW_BACK_OFF_MAX_MS, FOLLOW_RETRY_BASE_MS, FOLLOW_RETRY_MAX_MS, type FollowEnd, type FollowOptions, type FollowResync, type FollowState, type FollowVerdict, IMAGE_LADDER, InvalidApiKeyError, type KeyPathSegment, type LanguageSwitcherOption, type LanguageSwitcherOptions, type LiveEdgeEnd, LiveEdgeError, type LocaleMetadata, type LocaleStatus, type LocalizedEntry, MethodNotAllowedError, MissingApiKeyError, NetworkError, PREVIEW_KEY_PREFIX, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, RELYIO_CHANGE_EVENT, RELYIO_RESYNC_EVENT, RateLimitError, ReadOnlyKeyError, type RelyIOChangeDetail, type RelyIOResyncDetail, SDKError, ServerError, ServiceIndeterminateError, TimeoutError, TransactionRolledBackError, type TranslationCompleteness, UnknownContractError, UsageQuotaExceededError, VERSION, buildLanguageSwitcher, classifyFollowFailure, estimateTranslationCompleteness, followChanges, formatKeyPath, getAllLocalizedValues, getAvailableLocaleCodes, getDefaultLocale, getFallbackFields, getFieldFallbackLocale, getLocalizedField, getPublishedLocaleCodes, getRequestedLocale, hasLocale, isFieldFallback, isPreviewKey, isPublishableKey, isPublishedInLocale, localeHelpers, needsTranslation, parseKeyPath, snapToLadder };
package/dist/index.d.ts CHANGED
@@ -1,12 +1,11 @@
1
- import { C as Change, a as ChangesExpiredError, b as ChangesExpiredReason } from './index-DQ7eTUPQ.js';
2
- export { i as ActiveSandbox, aI as AdhocQuery, aJ as AdhocRecord, aG as AggregateMetric, A as AnySchemaDefinition, m as ApiMethod, l as ApiPath, n as ApiSuccessBody, aR as AssetClient, a_ as AssetEntryResponse, aS as AssetFileBuilder, aY as AssetFileExtracted, b7 as AssetPlacement, aT as AssetUploadBuilder, aV as AssetVisibility, ai as AutocompleteOptions, ad as AutocompleteResponse, ac as AutocompleteSuggestion, ay as BatchBody, az as BatchCreate, aC as BatchDelete, aF as BatchDeleteTarget, at as BatchOperationResult, aB as BatchReplace, av as BatchResponse, aD as BatchSingletonWrite, au as BatchSummary, aE as BatchTarget, aA as BatchUpdate, aw as BatchWrite, ax as BatchWriteOptions, s as ChangesHeadOptions, t as ChangesOptions, U as ChildrenListOptions, Q as ChildrenOptions, e as ClientDefaults, f as ClientSchema, b2 as ConfirmInput, b3 as ConfirmResult, y as ContentClient, b6 as CreateAssetOptions, z as CreateEntryOptions, g as DeployedContentType, D as DeployedLocale, J as DocumentFields, V as DocumentReadOptions, K as DocumentVersion, N as DocumentVersionsOptions, O as DocumentWriteOptions, X as EntryList, E as EntryPlacement, B as EntryWriteOptions, F as FeedChange, Y as FieldKey, aX as FileBackend, bj as FileErrorCode, aW as FileStatus, aZ as FileStatusResult, bl as FileUploadError, bk as FileUploadErrorCode, bn as FileValidationConstraints, bm as FileValidationError, Z as FreshOption, _ as GetOptions, H as Health, j as HttpClient, u as LIVE_KEEPALIVE_INTERVAL_MS, w as LIVE_SOCKET_OPEN_TIMEOUT_MS, $ as ListAllOptions, a0 as ListOptions, x as LiveChangesOptions, L as LocaleCodeOf, a1 as LocaleOption, M as MatchRouteOptions, ba as MultipartCreateResult, bb as MultipartPart, bc as MultipartTarget, aK as NamedQueryOptions, aL as NamedQueryParams, a2 as Paging, a$ as PopulatedAssetReference, b0 as PresignInput, b1 as PresignResult, P as Project, aM as QueryAggregate, aN as QueryAnswer, aO as QueryCall, aH as QueryMetadata, aP as QueryName, aQ as QueryTypeName, a3 as ReadAs, q as ReadEntry, a4 as ReadLocale, R as Register, h as RegisteredSchema, b4 as ResolveUrlInput, b5 as ResolveUrlResult, bf as ResourceConflictError, bg as ResourceExpiredError, be as ResourceNotFoundError, r as RetryableWriteOptions, p as RouteMatch, S as SandboxState, ah as SearchEntry, aj as SearchFacet, ak as SearchFieldKey, al as SearchHighlight, aa as SearchHitMetadata, am as SearchOptions, an as SearchPage, ab as SearchResponse, a9 as SearchResultItem, ao as SearchScope, ap as SearchSelected, aq as SearchSortOption, ag as SearchTypeName, ar as SearchWhere, k as SendOptions, I as SettingsClient, as as SimilarOptions, af as SimilarResponse, ae as SimilarResult, G as SingletonClient, a5 as SortOption, d as TypedClientConfig, T as TypedRelyIOClient, b8 as UpdateAssetOptions, bd as UploadProgress, a6 as VersionOptions, b9 as WaitUntilReadyOptions, W as Wire, a7 as WrittenReadScope, a8 as WrittenSort, c as createClient, c as default, aU as isAssetEntry, bi as isMissingEntry, bh as isResourceNotFound, o as matchRoute, bo as validateFile, v as versionCheckOf } from './index-DQ7eTUPQ.js';
1
+ import { C as Change, a as ChangesExpiredError, V as VisitorRetry, b as ChangesExpiredReason } from './index-BBp8_tn9.js';
2
+ export { i as ActiveSandbox, aS as AdhocQuery, aT as AdhocRecord, aQ as AggregateMetric, A as AnySchemaDefinition, m as ApiMethod, l as ApiPath, n as ApiSuccessBody, a$ as AssetClient, b8 as AssetEntryResponse, b0 as AssetFileBuilder, b6 as AssetFileExtracted, b9 as AssetFileWhere, bi as AssetPlacement, b1 as AssetUploadBuilder, b3 as AssetVisibility, as as AutocompleteOptions, an as AutocompleteResponse, am as AutocompleteSuggestion, aI as BatchBody, aJ as BatchCreate, aM as BatchDelete, aP as BatchDeleteTarget, aD as BatchOperationResult, aL as BatchReplace, aF as BatchResponse, aN as BatchSingletonWrite, aE as BatchSummary, aO as BatchTarget, aK as BatchUpdate, aG as BatchWrite, aH as BatchWriteOptions, y as ChangesHeadOptions, z as ChangesOptions, aa as ChildEntry, a0 as ChildrenListOptions, $ as ChildrenOptions, ab as ChildrenRead, e as ClientDefaults, f as ClientSchema, bd as ConfirmInput, be as ConfirmResult, I as ContentClient, bh as CreateAssetOptions, J as CreateEntryOptions, s as DefaultRetryPolicy, g as DeployedContentType, D as DeployedLocale, U as DocumentFields, a1 as DocumentReadOptions, X as DocumentVersion, Y as DocumentVersionRow, Z as DocumentVersionsOptions, _ as DocumentWriteOptions, a2 as EntryList, K as EntryPlacement, N as EntryWriteOptions, F as FeedChange, a3 as FieldKey, b5 as FileBackend, bu as FileErrorCode, b4 as FileStatus, b7 as FileStatusResult, bw as FileUploadError, bv as FileUploadErrorCode, by as FileValidationConstraints, bx as FileValidationError, a4 as FreshOption, a5 as GetOptions, H as Health, j as HttpClient, B as LIVE_KEEPALIVE_INTERVAL_MS, E as LIVE_SOCKET_OPEN_TIMEOUT_MS, a6 as ListAllOptions, a7 as ListOptions, G as LiveChangesOptions, L as LocaleCodeOf, a8 as LocaleOption, M as MatchRouteOptions, bl as MultipartCreateResult, bm as MultipartPart, bn as MultipartTarget, aU as NamedQueryOptions, aV as NamedQueryParams, a9 as Paging, ba as PopulatedAssetReference, bb as PresignInput, bc as PresignResult, P as Project, aW as QueryAggregate, aX as QueryAnswer, aY as QueryCall, aR as QueryMetadata, aZ as QueryName, a_ as QueryTypeName, ac as ReadAs, q as ReadEntry, ae as ReadLocale, R as Register, h as RegisteredSchema, bf as ResolveUrlInput, bg as ResolveUrlResult, bq as ResourceConflictError, br as ResourceExpiredError, bp as ResourceNotFoundError, w as RetryPolicy, x as RetryableRequest, r as RetryableWriteOptions, p as RouteMatch, S as SandboxState, ar as SearchEntry, at as SearchFacet, au as SearchFieldKey, av as SearchHighlight, ak as SearchHitMetadata, aw as SearchOptions, ax as SearchPage, al as SearchResponse, aj as SearchResultItem, ay as SearchScope, az as SearchSelected, aA as SearchSortOption, aq as SearchTypeName, aB as SearchWhere, k as SendOptions, Q as SettingsClient, aC as SimilarOptions, ap as SimilarResponse, ao as SimilarResult, O as SingletonClient, af as SortOption, d as TypedClientConfig, T as TypedRelyIOClient, bj as UpdateAssetOptions, bo as UploadProgress, ag as VersionOptions, bk as WaitUntilReadyOptions, W as Wire, ad as WithChildren, ah as WrittenReadScope, ai as WrittenSort, c as createClient, c as default, b2 as isAssetEntry, bt as isMissingEntry, t as isReplaySafe, bs as isResourceNotFound, o as matchRoute, u as retryPolicyFor, bz as validateFile, v as versionCheckOf } from './index-BBp8_tn9.js';
3
3
  export { fields } from './schema/index.js';
4
- import { cl as SDKError, aM as EntryMetadata } from './define-content-type-Ds5rCAYl.js';
5
- export { aH as AnyDeclaredFieldset, cS as ApiResponse, cq as AssetFileBlock, ak as AssetReading, b2 as AssetServedBlocks, a$ as AssetTypeDefinition, cr as AssetUrls, cs as BaseContent, B as BaseFieldConfig, cu as BaseSettingsGroup, ct as BaseSingleton, cY as BaseValidationError, ai as BlockOf, cO as CacheConfig, cU as CacheStrategy, am as CheckInclude, al as CheckedIncludes, an as ContentReading, aL as ContentTypeDefinition, cG as ContentTypeSchema, cA as CreateInput, cF as CustomQuery, cz as DateOnlyOperator, cQ as DebugConfig, aG as DeclaredFieldset, cW as Environment, h as FieldDefinition, aJ as FieldMember, cJ as FieldOptions, i as FieldRule, ac as FieldSchemaContext, j as FieldType, cH as FieldTypeName, k as FieldUIConfig, ad as FieldValue, ae as FieldValues, aF as Fieldset, b5 as FileKindConfig, bj as FileScanConfig, bi as FileUploadConfig, bb as ImageExifConfig, b3 as ImageKindConfig, ba as ImageSourceConfig, b9 as ImageUploadConfig, ao as IncludablePaths, b1 as InferAssetEntry, b0 as InferAssetType, aN as InferContentType, ca as InferJsonSchema, aT as InferSingleton, c_ as InvalidPayloadError, cb as JsonFieldValue, cc as JsonSchema, cd as JsonValue, ah as Keyed, a_ as KeyedAssetTypeConfig, aK as KeyedContentTypeConfig, K as KeyedEnumConfig, l as KeyedField, m as KeyedFieldOptions, aI as KeyedFieldsetConfig, aV as KeyedSettingsGroupConfig, aQ as KeyedSingletonConfig, co as LiveWebSocket, cp as LiveWebSocketConstructor, aO as LocalePublicationFields, r as LocalizationConfig, s as Localized, t as LocalizedDetails, cV as LogLevel, cN as PerformanceMetrics, aq as ReadWith, ap as Reading, cP as RealtimeConfig, cL as RealtimeEvent, cK as RealtimeEventType, cm as RelyIOConfig, cn as RelyIOConfigUpdate, cR as RequestConfig, cC as RestoredContent, cT as RetryConfig, cB as RevisedContent, aW as SettingsGroupDefinition, ar as SettingsReading, aj as ShapeValue, cE as SingletonContent, aR as SingletonContentTypeDefinition, aS as SingletonMetadata, as as SingletonReading, cM as SubscriptionOptions, ag as UnresolvedEntry, at as UntypedReading, cD as UpdateInput, cZ as ValidationError, cI as ValidationRule, cX as ValidationViolation, bc as VariantDefinition, bf as VideoCaptionsConfig, bg as VideoDownloadConfig, b4 as VideoKindConfig, be as VideoPosterConfig, bd as VideoUploadConfig, bh as VideoWatermarkConfig, cx as WhereClause, cw as WhereFieldCondition, cy as WhereOperator, cv as WhereScalar, W as WidgetOptions, aZ as defineAssetType, aD as defineContentType, aU as defineSettingsGroup, aP as defineSingleton, aE as fieldset } from './define-content-type-Ds5rCAYl.js';
6
- import { VisitorRetry } from './live-visitor.js';
4
+ import { cl as SDKError, aM as EntryMetadata } from './define-content-type-BGoQxqLf.js';
5
+ export { aH as AnyDeclaredFieldset, cV as ApiResponse, cq as AssetFileBlock, ak as AssetReading, b2 as AssetServedBlocks, a$ as AssetTypeDefinition, cr as AssetUrls, cs as BaseContent, B as BaseFieldConfig, cu as BaseSettingsGroup, ct as BaseSingleton, c$ as BaseValidationError, ai as BlockOf, cS as CacheConfig, cX as CacheStrategy, am as CheckInclude, al as CheckedIncludes, an as ContentReading, aL as ContentTypeDefinition, cL as ContentTypeSchema, cG as ContentVersion, cH as ContentVersionRow, cA as CreateInput, cB as CreatedContent, cK as CustomQuery, cz as DateOnlyOperator, cT as DebugConfig, aG as DeclaredFieldset, cZ as Environment, h as FieldDefinition, aJ as FieldMember, cN as FieldOptions, i as FieldRule, ac as FieldSchemaContext, j as FieldType, k as FieldUIConfig, ad as FieldValue, ae as FieldValues, aF as Fieldset, b5 as FileKindConfig, bj as FileScanConfig, bi as FileUploadConfig, bb as ImageExifConfig, b3 as ImageKindConfig, ba as ImageSourceConfig, b9 as ImageUploadConfig, ao as IncludablePaths, b1 as InferAssetEntry, b0 as InferAssetType, aN as InferContentType, ca as InferJsonSchema, aT as InferSingleton, d1 as InvalidPayloadError, cb as JsonFieldValue, cc as JsonSchema, cd as JsonValue, ah as Keyed, a_ as KeyedAssetTypeConfig, aK as KeyedContentTypeConfig, K as KeyedEnumConfig, l as KeyedField, m as KeyedFieldOptions, aI as KeyedFieldsetConfig, aV as KeyedSettingsGroupConfig, aQ as KeyedSingletonConfig, co as LiveWebSocket, cp as LiveWebSocketConstructor, aO as LocalePublicationFields, r as LocalizationConfig, s as Localized, t as LocalizedDetails, cY as LogLevel, cR as PerformanceMetrics, aq as ReadWith, ap as Reading, cP as RealtimeEvent, cO as RealtimeEventType, cm as RelyIOConfig, cn as RelyIOConfigUpdate, cU as RequestConfig, cF as RestoredContent, cW as RetryConfig, cC as RevisedContent, aW as SettingsGroupDefinition, ar as SettingsReading, aj as ShapeValue, cJ as SingletonContent, aR as SingletonContentTypeDefinition, aS as SingletonMetadata, as as SingletonReading, cQ as SubscriptionOptions, ag as UnresolvedEntry, at as UntypedReading, cI as UpdateInput, d0 as ValidationError, cM as ValidationRule, c_ as ValidationViolation, bc as VariantDefinition, bf as VideoCaptionsConfig, bg as VideoDownloadConfig, b4 as VideoKindConfig, be as VideoPosterConfig, bd as VideoUploadConfig, bh as VideoWatermarkConfig, cx as WhereClause, cw as WhereFieldCondition, cy as WhereOperator, cv as WhereScalar, W as WidgetOptions, cE as WrittenSettingsGroup, cD as WrittenSingleton, aZ as defineAssetType, aD as defineContentType, au as defineLocale, aU as defineSettingsGroup, aP as defineSingleton, aE as fieldset } from './define-content-type-BGoQxqLf.js';
7
6
  export { camelToSnake, createDeferred, debounce, deepClone, generateId, isBrowser, isNode, isPlainObject, isValidEmail, isValidUrl, mergeDeep, omit, pick, retry, sleep, snakeToCamel, throttle, toSafeString } from './utils/index.js';
8
- export { n as RICH_TEXT_VOID_TAGS, R as RelyIOFieldAttributes, a as RelyIOFieldName, b as RelyIOFieldPath, c as RelyIOKeyed, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, r as relyioField, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from './index-Db3_tmYf.js';
9
- export { A as AggregateBlock, L as AnyQueryParameters, M as DeclaredParameters, n as FetchBlock, w as FilterDefinition, I as IncludeDefinition, J as InferQueryParams, G as InferQueryResponse, Q as QueryConfig, l as QueryDefinition, K as QueryParameterValue, h as SchemaAssetTypeNames, S as SchemaConfig, b as SchemaContentTypeNames, a as SchemaDefinition, i as SchemaEntry, j as SchemaEntryOf, f as SchemaLocaleCodes, e as SchemaQueryNames, g as SchemaSettingsGroupNames, c as SchemaSingletonNames, o as SearchBlock, v as SelectMapping, s as SortCondition, W as WhereCondition, k as defineQuery, d as defineSchema } from './define-schema-CxpIYFFR.js';
7
+ export { n as RICH_TEXT_VOID_TAGS, R as RelyIOFieldAttributes, a as RelyIOFieldName, b as RelyIOFieldPath, c as RelyIOKeyed, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, r as relyioField, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from './index-DaMZ4FQ_.js';
8
+ export { A as AggregateBlock, L as AnyQueryParameters, M as DeclaredParameters, n as FetchBlock, w as FilterDefinition, I as IncludeDefinition, J as InferQueryParams, G as InferQueryResponse, Q as QueryConfig, l as QueryDefinition, K as QueryParameterValue, h as SchemaAssetTypeNames, S as SchemaConfig, b as SchemaContentTypeNames, a as SchemaDefinition, i as SchemaEntry, j as SchemaEntryOf, f as SchemaLocaleCodes, e as SchemaQueryNames, g as SchemaSettingsGroupNames, c as SchemaSingletonNames, o as SearchBlock, v as SelectMapping, s as SortCondition, W as WhereCondition, k as defineQuery, d as defineSchema } from './define-schema-DgCX9YB7.js';
10
9
  export { e as RichTextBlock, f as RichTextCellAlignment, g as RichTextCodeBlock, h as RichTextCodeGroup, i as RichTextCodeLines, j as RichTextDivider, d as RichTextEntryLinkMark, k as RichTextHeading, l as RichTextInline, m as RichTextLineBreak, n as RichTextLinkMark, o as RichTextList, p as RichTextListItem, q as RichTextListStyle, r as RichTextMark, s as RichTextMarkType, t as RichTextNode, u as RichTextParagraph, v as RichTextQuote, w as RichTextSpan, x as RichTextStructure, y as RichTextTable, z as RichTextTableCell, B as RichTextTableRow, b as RichTextValue } from './rich-text.d-BWc-5gX1.js';
11
10
  import './dev-handshake/index.js';
12
11
 
@@ -35,6 +34,18 @@ declare const PUBLISHABLE_KEY_PREFIX = "rly_pub_";
35
34
  * publishable key, so the answer is `false` rather than a `TypeError` in a caller that only asked.
36
35
  */
37
36
  declare const isPublishableKey: (apiKey: string | undefined) => boolean;
37
+ /**
38
+ * A preview key's prefix: scope `prev`, the one project key that reads drafts and the only kind a
39
+ * client sends a pull request's preview dataset with (`github-integration-spec.md` decision 14).
40
+ * Restated from the service's `isPreviewApiKey` and held to it by `src/__tests__/key-kind.test.ts`,
41
+ * as the publishable prefix is.
42
+ */
43
+ declare const PREVIEW_KEY_PREFIX = "rly_prev_";
44
+ /**
45
+ * Whether `apiKey` is a preview key (`rly_prev_…`). It reads the prefix only, as
46
+ * {@link isPublishableKey} does; `undefined` — a client holding no key — is not one.
47
+ */
48
+ declare const isPreviewKey: (apiKey: string | undefined) => boolean;
38
49
 
39
50
  /**
40
51
  * `followChanges()` — the one loop that follows a changes source until its
@@ -432,9 +443,13 @@ declare class PayloadTooLargeError extends SDKError {
432
443
  getUserMessage(): string;
433
444
  }
434
445
  /**
435
- * `TRANSACTION_ROLLED_BACK` — an atomic batch failed at one member and nothing
436
- * was written. `failedIndex` is which one, so a caller can fix that operation
437
- * rather than re-sending the whole batch blind.
446
+ * `TRANSACTION_ROLLED_BACK` — an atomic batch failed and nothing was written.
447
+ *
448
+ * `failedIndex` is the index, in the batch, of the operation this refusal was
449
+ * served for. The service sends each rolled-back item its **own** index, so it
450
+ * does not say which operation caused the rollback: read it as "this is
451
+ * operation N", never "operation N failed". Find the cause among the batch's
452
+ * results, not here.
438
453
  */
439
454
  declare class TransactionRolledBackError extends SDKError {
440
455
  readonly code = "TRANSACTION_ROLLED_BACK";
@@ -552,11 +567,6 @@ declare class LiveEdgeError extends SDKError {
552
567
  readonly retryAfterMs?: number;
553
568
  readonly context?: Record<string, unknown>;
554
569
  });
555
- /**
556
- * The base class rebuilds an error through its own four-argument constructor, which this class
557
- * does not have; rebuilt that way, `end` would be a string and `retry` a number.
558
- */
559
- withContext(context: Record<string, unknown>): this;
560
570
  getUserMessage(): string;
561
571
  }
562
572
 
@@ -972,4 +982,4 @@ declare function snapToLadder(value: number): number;
972
982
 
973
983
  declare const VERSION = "__VERSION__";
974
984
 
975
- export { AuthorizationError, Change, type ChangeSource, type ChangeSourceOptions, ChangesExpiredError, ChangesExpiredReason, ConnectionError, EntryMetadata, ErrorMapper, FOLLOW_BACK_OFF_MAX_MS, FOLLOW_RETRY_BASE_MS, FOLLOW_RETRY_MAX_MS, type FollowEnd, type FollowOptions, type FollowResync, type FollowState, type FollowVerdict, IMAGE_LADDER, InvalidApiKeyError, type KeyPathSegment, type LanguageSwitcherOption, type LanguageSwitcherOptions, type LiveEdgeEnd, LiveEdgeError, type LocaleMetadata, type LocaleStatus, type LocalizedEntry, MethodNotAllowedError, MissingApiKeyError, NetworkError, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, RELYIO_CHANGE_EVENT, RELYIO_RESYNC_EVENT, RateLimitError, ReadOnlyKeyError, type RelyIOChangeDetail, type RelyIOResyncDetail, SDKError, ServerError, ServiceIndeterminateError, TimeoutError, TransactionRolledBackError, type TranslationCompleteness, UnknownContractError, UsageQuotaExceededError, VERSION, buildLanguageSwitcher, classifyFollowFailure, estimateTranslationCompleteness, followChanges, formatKeyPath, getAllLocalizedValues, getAvailableLocaleCodes, getDefaultLocale, getFallbackFields, getFieldFallbackLocale, getLocalizedField, getPublishedLocaleCodes, getRequestedLocale, hasLocale, isFieldFallback, isPublishableKey, isPublishedInLocale, localeHelpers, needsTranslation, parseKeyPath, snapToLadder };
985
+ export { AuthorizationError, Change, type ChangeSource, type ChangeSourceOptions, ChangesExpiredError, ChangesExpiredReason, ConnectionError, EntryMetadata, ErrorMapper, FOLLOW_BACK_OFF_MAX_MS, FOLLOW_RETRY_BASE_MS, FOLLOW_RETRY_MAX_MS, type FollowEnd, type FollowOptions, type FollowResync, type FollowState, type FollowVerdict, IMAGE_LADDER, InvalidApiKeyError, type KeyPathSegment, type LanguageSwitcherOption, type LanguageSwitcherOptions, type LiveEdgeEnd, LiveEdgeError, type LocaleMetadata, type LocaleStatus, type LocalizedEntry, MethodNotAllowedError, MissingApiKeyError, NetworkError, PREVIEW_KEY_PREFIX, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, RELYIO_CHANGE_EVENT, RELYIO_RESYNC_EVENT, RateLimitError, ReadOnlyKeyError, type RelyIOChangeDetail, type RelyIOResyncDetail, SDKError, ServerError, ServiceIndeterminateError, TimeoutError, TransactionRolledBackError, type TranslationCompleteness, UnknownContractError, UsageQuotaExceededError, VERSION, buildLanguageSwitcher, classifyFollowFailure, estimateTranslationCompleteness, followChanges, formatKeyPath, getAllLocalizedValues, getAvailableLocaleCodes, getDefaultLocale, getFallbackFields, getFieldFallbackLocale, getLocalizedField, getPublishedLocaleCodes, getRequestedLocale, hasLocale, isFieldFallback, isPreviewKey, isPublishableKey, isPublishedInLocale, localeHelpers, needsTranslation, parseKeyPath, snapToLadder };