@relyio/sdk 0.7.0 → 0.8.0

package/dist/index.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var chunk72UK5U7T_cjs = require('./chunk-72UK5U7T.cjs');
-var chunkVH2DE7HZ_cjs = require('./chunk-VH2DE7HZ.cjs');
+var chunkXIE7WJV3_cjs = require('./chunk-XIE7WJV3.cjs');
 require('./chunk-LSRPMNPT.cjs');
 require('./chunk-PPA2WWOH.cjs');
 var chunkTZL374LS_cjs = require('./chunk-TZL374LS.cjs');
@@ -11,28 +11,48 @@ var chunkMWMSFIWN_cjs = require('./chunk-MWMSFIWN.cjs');
 
 /* RelyIO SDK - Built with ❤️ by the RelyIO Team */
 
-// src/config/key-kind.ts
-var PUBLISHABLE_KEY_PREFIX = "rly_pub_";
-var isPublishableKey = /* @__PURE__ */ chunkMWMSFIWN_cjs.__name((apiKey) => apiKey?.startsWith(PUBLISHABLE_KEY_PREFIX) === true, "isPublishableKey");
-
 // src/changes/follow.ts
 var FOLLOW_RETRY_BASE_MS = 1e3;
 var FOLLOW_RETRY_MAX_MS = 3e4;
+var FOLLOW_BACK_OFF_MAX_MS = 15 * 6e4;
+function stopOnUnknownAnswer(_answer) {
+  return { retry: false };
+}
+chunkMWMSFIWN_cjs.__name(stopOnUnknownAnswer, "stopOnUnknownAnswer");
 function classifyFollowFailure(error) {
-  if (!(error instanceof chunkVH2DE7HZ_cjs.SDKError) || !error.retryable) return { retry: false };
-  const afterMs = chunkVH2DE7HZ_cjs.serviceInstructedDelayMs(error, Date.now());
+  if (error instanceof chunkXIE7WJV3_cjs.LiveEdgeError) return liveEdgeVerdict(error);
+  if (!(error instanceof chunkXIE7WJV3_cjs.SDKError) || !error.retryable) return { retry: false };
+  const afterMs = chunkXIE7WJV3_cjs.serviceInstructedDelayMs(error, Date.now());
   return afterMs === void 0 ? { retry: true } : { retry: true, afterMs };
 }
 chunkMWMSFIWN_cjs.__name(classifyFollowFailure, "classifyFollowFailure");
+function liveEdgeVerdict(error) {
+  const hint = error.retryAfterMs === void 0 ? {} : { afterMs: error.retryAfterMs };
+  switch (error.retry) {
+    case "stop": {
+      return { retry: false };
+    }
+    case "retry": {
+      return { retry: true, ...hint };
+    }
+    case "back-off": {
+      return { retry: true, ...hint, backOffMs: chunkXIE7WJV3_cjs.VISITOR_ADMISSION_RETRY_AFTER_SECONDS * 1e3 };
+    }
+    default: {
+      return stopOnUnknownAnswer(error.retry);
+    }
+  }
+}
+chunkMWMSFIWN_cjs.__name(liveEdgeVerdict, "liveEdgeVerdict");
 async function followChanges(source, options) {
   const { signal, onChange, onResync } = options;
   const classify = options.classify ?? classifyFollowFailure;
   const random = options.random ?? Math.random;
   const report = /* @__PURE__ */ chunkMWMSFIWN_cjs.__name((state) => {
-    if (!chunkVH2DE7HZ_cjs.isAborted(signal)) options.onState?.(state);
+    if (!chunkXIE7WJV3_cjs.isAborted(signal)) options.onState?.(state);
   }, "report");
   const resync = /* @__PURE__ */ chunkMWMSFIWN_cjs.__name(async (cause) => {
-    if (chunkVH2DE7HZ_cjs.isAborted(signal)) return;
+    if (chunkXIE7WJV3_cjs.isAborted(signal)) return;
     await onResync(cause);
     report({ kind: "resynced", resync: cause });
   }, "resync");
@@ -41,12 +61,12 @@ async function followChanges(source, options) {
   let unanchored = false;
   let current;
   for (; ; ) {
-    if (chunkVH2DE7HZ_cjs.isAborted(signal)) return { kind: "aborted", since };
+    if (chunkXIE7WJV3_cjs.isAborted(signal)) return { kind: "aborted", since };
     try {
       if (unanchored) {
         unanchored = false;
         await resync({ cause: "no-cursor" });
-        if (chunkVH2DE7HZ_cjs.isAborted(signal)) return { kind: "aborted", since };
+        if (chunkXIE7WJV3_cjs.isAborted(signal)) return { kind: "aborted", since };
       }
       report({ kind: "following" });
       const open = {};
@@ -57,16 +77,19 @@ async function followChanges(source, options) {
         onExpired: /* @__PURE__ */ chunkMWMSFIWN_cjs.__name((expired) => resync({ cause: "expired", expired }), "onExpired"),
         opened: /* @__PURE__ */ chunkMWMSFIWN_cjs.__name(() => {
           if (current === open) failures = 0;
-        }, "opened")
+        }, "opened"),
+        reached: /* @__PURE__ */ chunkMWMSFIWN_cjs.__name((cursor) => {
+          if (current === open) since = cursor;
+        }, "reached")
       });
       for await (const change of changes) {
-        if (chunkVH2DE7HZ_cjs.isAborted(signal)) return { kind: "aborted", since };
+        if (chunkXIE7WJV3_cjs.isAborted(signal)) return { kind: "aborted", since };
         failures = 0;
         await onChange(change);
         since = change.cursor;
-        if (chunkVH2DE7HZ_cjs.isAborted(signal)) return { kind: "aborted", since };
+        if (chunkXIE7WJV3_cjs.isAborted(signal)) return { kind: "aborted", since };
       }
-      if (chunkVH2DE7HZ_cjs.isAborted(signal)) return { kind: "aborted", since };
+      if (chunkXIE7WJV3_cjs.isAborted(signal)) return { kind: "aborted", since };
       const error = new Error(
         "The change source completed without its signal aborting; a source ends only on abort and throws every other end."
       );
@@ -74,25 +97,27 @@ async function followChanges(source, options) {
       return { kind: "stopped", since, error };
     } catch (error) {
       current = void 0;
-      if (chunkVH2DE7HZ_cjs.isAborted(signal)) return { kind: "aborted", since };
+      if (chunkXIE7WJV3_cjs.isAborted(signal)) return { kind: "aborted", since };
       const verdict = classify(error);
       if (!verdict.retry) {
         report({ kind: "stopped", error });
         return { kind: "stopped", since, error };
       }
       failures += 1;
-      const retryInMs = retryDelayMs(failures, verdict.afterMs, random);
+      const retryInMs = retryDelayMs(failures, verdict, random);
       report({ kind: "reconnecting", error, retryInMs });
-      await chunkVH2DE7HZ_cjs.sleep(retryInMs, signal);
+      await chunkXIE7WJV3_cjs.sleep(retryInMs, signal);
       if (since === void 0) unanchored = true;
     }
   }
 }
 chunkMWMSFIWN_cjs.__name(followChanges, "followChanges");
-function retryDelayMs(failures, hintMs, random) {
-  const ceiling = Math.min(FOLLOW_RETRY_BASE_MS * 2 ** (failures - 1), FOLLOW_RETRY_MAX_MS);
+function retryDelayMs(failures, verdict, random) {
+  const { afterMs, backOffMs } = verdict;
+  const [base, max] = backOffMs === void 0 ? [FOLLOW_RETRY_BASE_MS, FOLLOW_RETRY_MAX_MS] : [2 * backOffMs, Math.max(FOLLOW_BACK_OFF_MAX_MS, 2 * backOffMs)];
+  const ceiling = Math.min(base * 2 ** (failures - 1), max);
   const jittered = ceiling - Math.floor(ceiling / 2 * random());
-  return hintMs === void 0 ? jittered : Math.max(hintMs, jittered);
+  return afterMs === void 0 ? jittered : Math.max(afterMs, jittered);
 }
 chunkMWMSFIWN_cjs.__name(retryDelayMs, "retryDelayMs");
 
@@ -317,211 +342,227 @@ Object.defineProperty(exports, "fieldset", {
 });
 Object.defineProperty(exports, "AdhocQueryBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.AdhocQueryBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.AdhocQueryBuilder; }
 });
 Object.defineProperty(exports, "AdhocQueryClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.AdhocQueryClient; }
+  get: function () { return chunkXIE7WJV3_cjs.AdhocQueryClient; }
 });
 Object.defineProperty(exports, "AssetClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.AssetClient; }
+  get: function () { return chunkXIE7WJV3_cjs.AssetClient; }
 });
 Object.defineProperty(exports, "AssetFileBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.AssetFileBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.AssetFileBuilder; }
 });
 Object.defineProperty(exports, "AssetUploadBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.AssetUploadBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.AssetUploadBuilder; }
 });
 Object.defineProperty(exports, "AuthorizationError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.AuthorizationError; }
+  get: function () { return chunkXIE7WJV3_cjs.AuthorizationError; }
 });
 Object.defineProperty(exports, "AutocompleteBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.AutocompleteBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.AutocompleteBuilder; }
 });
 Object.defineProperty(exports, "BaseValidationError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.BaseValidationError; }
+  get: function () { return chunkXIE7WJV3_cjs.BaseValidationError; }
 });
 Object.defineProperty(exports, "BatchBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.BatchBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.BatchBuilder; }
 });
 Object.defineProperty(exports, "BatchClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.BatchClient; }
+  get: function () { return chunkXIE7WJV3_cjs.BatchClient; }
 });
 Object.defineProperty(exports, "ChangesExpiredError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ChangesExpiredError; }
+  get: function () { return chunkXIE7WJV3_cjs.ChangesExpiredError; }
 });
 Object.defineProperty(exports, "ConnectionError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ConnectionError; }
+  get: function () { return chunkXIE7WJV3_cjs.ConnectionError; }
 });
 Object.defineProperty(exports, "ContentByIdBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ContentByIdBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.ContentByIdBuilder; }
 });
 Object.defineProperty(exports, "ContentClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ContentClient; }
+  get: function () { return chunkXIE7WJV3_cjs.ContentClient; }
 });
 Object.defineProperty(exports, "ContentQueryBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ContentQueryBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.ContentQueryBuilder; }
 });
 Object.defineProperty(exports, "ErrorMapper", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ErrorMapper; }
+  get: function () { return chunkXIE7WJV3_cjs.ErrorMapper; }
 });
 Object.defineProperty(exports, "FileUploadError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.FileUploadError; }
+  get: function () { return chunkXIE7WJV3_cjs.FileUploadError; }
 });
 Object.defineProperty(exports, "FileValidationError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.FileValidationError; }
+  get: function () { return chunkXIE7WJV3_cjs.FileValidationError; }
 });
 Object.defineProperty(exports, "HttpClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.HttpClient; }
+  get: function () { return chunkXIE7WJV3_cjs.HttpClient; }
 });
 Object.defineProperty(exports, "InvalidApiKeyError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.InvalidApiKeyError; }
+  get: function () { return chunkXIE7WJV3_cjs.InvalidApiKeyError; }
 });
 Object.defineProperty(exports, "InvalidPayloadError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.InvalidPayloadError; }
+  get: function () { return chunkXIE7WJV3_cjs.InvalidPayloadError; }
+});
+Object.defineProperty(exports, "LIVE_KEEPALIVE_INTERVAL_MS", {
+  enumerable: true,
+  get: function () { return chunkXIE7WJV3_cjs.LIVE_KEEPALIVE_INTERVAL_MS; }
+});
+Object.defineProperty(exports, "LiveEdgeError", {
+  enumerable: true,
+  get: function () { return chunkXIE7WJV3_cjs.LiveEdgeError; }
 });
 Object.defineProperty(exports, "MethodNotAllowedError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.MethodNotAllowedError; }
+  get: function () { return chunkXIE7WJV3_cjs.MethodNotAllowedError; }
 });
 Object.defineProperty(exports, "MissingApiKeyError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.MissingApiKeyError; }
+  get: function () { return chunkXIE7WJV3_cjs.MissingApiKeyError; }
 });
 Object.defineProperty(exports, "NetworkError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.NetworkError; }
+  get: function () { return chunkXIE7WJV3_cjs.NetworkError; }
+});
+Object.defineProperty(exports, "PUBLISHABLE_KEY_PREFIX", {
+  enumerable: true,
+  get: function () { return chunkXIE7WJV3_cjs.PUBLISHABLE_KEY_PREFIX; }
 });
 Object.defineProperty(exports, "PayloadTooLargeError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.PayloadTooLargeError; }
+  get: function () { return chunkXIE7WJV3_cjs.PayloadTooLargeError; }
 });
 Object.defineProperty(exports, "PlanFeatureUnavailableError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.PlanFeatureUnavailableError; }
+  get: function () { return chunkXIE7WJV3_cjs.PlanFeatureUnavailableError; }
 });
 Object.defineProperty(exports, "RateLimitError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.RateLimitError; }
+  get: function () { return chunkXIE7WJV3_cjs.RateLimitError; }
 });
 Object.defineProperty(exports, "ReadOnlyKeyError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ReadOnlyKeyError; }
+  get: function () { return chunkXIE7WJV3_cjs.ReadOnlyKeyError; }
 });
 Object.defineProperty(exports, "ResourceConflictError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ResourceConflictError; }
+  get: function () { return chunkXIE7WJV3_cjs.ResourceConflictError; }
 });
 Object.defineProperty(exports, "ResourceExpiredError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ResourceExpiredError; }
+  get: function () { return chunkXIE7WJV3_cjs.ResourceExpiredError; }
 });
 Object.defineProperty(exports, "ResourceNotFoundError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ResourceNotFoundError; }
+  get: function () { return chunkXIE7WJV3_cjs.ResourceNotFoundError; }
 });
 Object.defineProperty(exports, "SDKError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.SDKError; }
+  get: function () { return chunkXIE7WJV3_cjs.SDKError; }
 });
 Object.defineProperty(exports, "SearchBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.SearchBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.SearchBuilder; }
 });
 Object.defineProperty(exports, "SearchClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.SearchClient; }
+  get: function () { return chunkXIE7WJV3_cjs.SearchClient; }
 });
 Object.defineProperty(exports, "ServerError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ServerError; }
+  get: function () { return chunkXIE7WJV3_cjs.ServerError; }
 });
 Object.defineProperty(exports, "ServiceIndeterminateError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ServiceIndeterminateError; }
+  get: function () { return chunkXIE7WJV3_cjs.ServiceIndeterminateError; }
 });
 Object.defineProperty(exports, "SettingsClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.SettingsClient; }
+  get: function () { return chunkXIE7WJV3_cjs.SettingsClient; }
 });
 Object.defineProperty(exports, "SimilarBuilder", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.SimilarBuilder; }
+  get: function () { return chunkXIE7WJV3_cjs.SimilarBuilder; }
 });
 Object.defineProperty(exports, "SingletonClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.SingletonClient; }
+  get: function () { return chunkXIE7WJV3_cjs.SingletonClient; }
 });
 Object.defineProperty(exports, "TimeoutError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.TimeoutError; }
+  get: function () { return chunkXIE7WJV3_cjs.TimeoutError; }
 });
 Object.defineProperty(exports, "TransactionRolledBackError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.TransactionRolledBackError; }
+  get: function () { return chunkXIE7WJV3_cjs.TransactionRolledBackError; }
 });
 Object.defineProperty(exports, "TypedRelyIOClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.TypedRelyIOClient; }
+  get: function () { return chunkXIE7WJV3_cjs.TypedRelyIOClient; }
 });
 Object.defineProperty(exports, "UnknownContractError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.UnknownContractError; }
+  get: function () { return chunkXIE7WJV3_cjs.UnknownContractError; }
 });
 Object.defineProperty(exports, "UsageQuotaExceededError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.UsageQuotaExceededError; }
+  get: function () { return chunkXIE7WJV3_cjs.UsageQuotaExceededError; }
 });
 Object.defineProperty(exports, "ValidationError", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.ValidationError; }
+  get: function () { return chunkXIE7WJV3_cjs.ValidationError; }
 });
 Object.defineProperty(exports, "createClient", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.createClient; }
+  get: function () { return chunkXIE7WJV3_cjs.createClient; }
 });
 Object.defineProperty(exports, "default", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.createClient; }
+  get: function () { return chunkXIE7WJV3_cjs.createClient; }
 });
 Object.defineProperty(exports, "entityTagOf", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.entityTagOf; }
+  get: function () { return chunkXIE7WJV3_cjs.entityTagOf; }
 });
 Object.defineProperty(exports, "isAssetEntry", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.isAssetEntry; }
+  get: function () { return chunkXIE7WJV3_cjs.isAssetEntry; }
+});
+Object.defineProperty(exports, "isPublishableKey", {
+  enumerable: true,
+  get: function () { return chunkXIE7WJV3_cjs.isPublishableKey; }
 });
 Object.defineProperty(exports, "isResourceNotFound", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.isResourceNotFound; }
+  get: function () { return chunkXIE7WJV3_cjs.isResourceNotFound; }
 });
 Object.defineProperty(exports, "matchRoute", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.matchRoute; }
+  get: function () { return chunkXIE7WJV3_cjs.matchRoute; }
 });
 Object.defineProperty(exports, "validateFile", {
   enumerable: true,
-  get: function () { return chunkVH2DE7HZ_cjs.validateFile; }
+  get: function () { return chunkXIE7WJV3_cjs.validateFile; }
 });
 Object.defineProperty(exports, "camelToSnake", {
   enumerable: true,
@@ -595,10 +636,10 @@ Object.defineProperty(exports, "toSafeString", {
   enumerable: true,
   get: function () { return chunkTZL374LS_cjs.toSafeString; }
 });
+exports.FOLLOW_BACK_OFF_MAX_MS = FOLLOW_BACK_OFF_MAX_MS;
 exports.FOLLOW_RETRY_BASE_MS = FOLLOW_RETRY_BASE_MS;
 exports.FOLLOW_RETRY_MAX_MS = FOLLOW_RETRY_MAX_MS;
 exports.IMAGE_LADDER = IMAGE_LADDER;
-exports.PUBLISHABLE_KEY_PREFIX = PUBLISHABLE_KEY_PREFIX;
 exports.RELYIO_CHANGE_EVENT = RELYIO_CHANGE_EVENT;
 exports.RELYIO_RESYNC_EVENT = RELYIO_RESYNC_EVENT;
 exports.VERSION = VERSION;
@@ -616,7 +657,6 @@ exports.getPublishedLocaleCodes = getPublishedLocaleCodes;
 exports.getRequestedLocale = getRequestedLocale;
 exports.hasLocale = hasLocale;
 exports.isFieldFallback = isFieldFallback;
-exports.isPublishableKey = isPublishableKey;
 exports.isPublishedInLocale = isPublishedInLocale;
 exports.localeHelpers = localeHelpers;
 exports.needsTranslation = needsTranslation;