@relyio/sdk 0.5.0 → 0.6.0

package/dist/index.cjs

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var chunkHAQELDZN_cjs = require('./chunk-HAQELDZN.cjs');
-var chunkCIRT6TVT_cjs = require('./chunk-CIRT6TVT.cjs');
+var chunkDY2XT7OF_cjs = require('./chunk-DY2XT7OF.cjs');
+var chunkGCMQUM6N_cjs = require('./chunk-GCMQUM6N.cjs');
 require('./chunk-LSRPMNPT.cjs');
 require('./chunk-PPA2WWOH.cjs');
 var chunkHT6NFRM2_cjs = require('./chunk-HT6NFRM2.cjs');
@@ -11,6 +11,91 @@ 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;
+function classifyFollowFailure(error) {
+  if (!(error instanceof chunkGCMQUM6N_cjs.SDKError) || !error.retryable) return { retry: false };
+  const afterMs = chunkGCMQUM6N_cjs.serviceInstructedDelayMs(error, Date.now());
+  return afterMs === void 0 ? { retry: true } : { retry: true, afterMs };
+}
+chunkMWMSFIWN_cjs.__name(classifyFollowFailure, "classifyFollowFailure");
+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 (!chunkGCMQUM6N_cjs.isAborted(signal)) options.onState?.(state);
+  }, "report");
+  const resync = /* @__PURE__ */ chunkMWMSFIWN_cjs.__name(async (cause) => {
+    if (chunkGCMQUM6N_cjs.isAborted(signal)) return;
+    await onResync(cause);
+    report({ kind: "resynced", resync: cause });
+  }, "resync");
+  let since = options.since;
+  let failures = 0;
+  let unanchored = false;
+  let current;
+  for (; ; ) {
+    if (chunkGCMQUM6N_cjs.isAborted(signal)) return { kind: "aborted", since };
+    try {
+      if (unanchored) {
+        unanchored = false;
+        await resync({ cause: "no-cursor" });
+        if (chunkGCMQUM6N_cjs.isAborted(signal)) return { kind: "aborted", since };
+      }
+      report({ kind: "following" });
+      const open = {};
+      current = open;
+      const changes = source({
+        ...since === void 0 ? {} : { since },
+        signal,
+        onExpired: /* @__PURE__ */ chunkMWMSFIWN_cjs.__name((expired) => resync({ cause: "expired", expired }), "onExpired"),
+        opened: /* @__PURE__ */ chunkMWMSFIWN_cjs.__name(() => {
+          if (current === open) failures = 0;
+        }, "opened")
+      });
+      for await (const change of changes) {
+        if (chunkGCMQUM6N_cjs.isAborted(signal)) return { kind: "aborted", since };
+        failures = 0;
+        await onChange(change);
+        since = change.cursor;
+        if (chunkGCMQUM6N_cjs.isAborted(signal)) return { kind: "aborted", since };
+      }
+      if (chunkGCMQUM6N_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."
+      );
+      report({ kind: "stopped", error });
+      return { kind: "stopped", since, error };
+    } catch (error) {
+      current = void 0;
+      if (chunkGCMQUM6N_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);
+      report({ kind: "reconnecting", error, retryInMs });
+      await chunkGCMQUM6N_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);
+  const jittered = ceiling - Math.floor(ceiling / 2 * random());
+  return hintMs === void 0 ? jittered : Math.max(hintMs, jittered);
+}
+chunkMWMSFIWN_cjs.__name(retryDelayMs, "retryDelayMs");
+
 // src/locale/index.ts
 function needsTranslation(entry, locale) {
   const fallbacks = entry._metadata?.localeFallbacksApplied;
@@ -171,6 +256,7 @@ chunkMWMSFIWN_cjs.__name(requireMetadata, "requireMetadata");
 
 // src/binding/change-event.ts
 var RELYIO_CHANGE_EVENT = "relyio:change";
+var RELYIO_RESYNC_EVENT = "relyio:resync";
 
 // src/image/ladder.ts
 var IMAGE_LADDER = {
@@ -191,267 +277,267 @@ var VERSION = "__VERSION__";
 
 Object.defineProperty(exports, "defineAssetType", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineAssetType; }
+  get: function () { return chunkDY2XT7OF_cjs.defineAssetType; }
 });
 Object.defineProperty(exports, "defineComponent", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineComponent; }
+  get: function () { return chunkDY2XT7OF_cjs.defineComponent; }
 });
 Object.defineProperty(exports, "defineContentType", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineContentType; }
+  get: function () { return chunkDY2XT7OF_cjs.defineContentType; }
 });
 Object.defineProperty(exports, "defineQuery", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineQuery; }
+  get: function () { return chunkDY2XT7OF_cjs.defineQuery; }
 });
 Object.defineProperty(exports, "defineSchema", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineSchema; }
+  get: function () { return chunkDY2XT7OF_cjs.defineSchema; }
 });
 Object.defineProperty(exports, "defineSettingsGroup", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineSettingsGroup; }
+  get: function () { return chunkDY2XT7OF_cjs.defineSettingsGroup; }
 });
 Object.defineProperty(exports, "defineSingleton", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineSingleton; }
+  get: function () { return chunkDY2XT7OF_cjs.defineSingleton; }
 });
 Object.defineProperty(exports, "defineSingletonContentType", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.defineSingletonContentType; }
+  get: function () { return chunkDY2XT7OF_cjs.defineSingletonContentType; }
 });
 Object.defineProperty(exports, "fields", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.fields; }
+  get: function () { return chunkDY2XT7OF_cjs.fields; }
 });
 Object.defineProperty(exports, "fieldset", {
   enumerable: true,
-  get: function () { return chunkHAQELDZN_cjs.fieldset; }
+  get: function () { return chunkDY2XT7OF_cjs.fieldset; }
 });
 Object.defineProperty(exports, "AdhocQueryBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AdhocQueryBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.AdhocQueryBuilder; }
 });
 Object.defineProperty(exports, "AdhocQueryClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AdhocQueryClient; }
+  get: function () { return chunkGCMQUM6N_cjs.AdhocQueryClient; }
 });
 Object.defineProperty(exports, "AssetClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AssetClient; }
+  get: function () { return chunkGCMQUM6N_cjs.AssetClient; }
 });
 Object.defineProperty(exports, "AssetFileBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AssetFileBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.AssetFileBuilder; }
 });
 Object.defineProperty(exports, "AssetUploadBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AssetUploadBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.AssetUploadBuilder; }
 });
 Object.defineProperty(exports, "AuthenticationError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AuthenticationError; }
+  get: function () { return chunkGCMQUM6N_cjs.AuthenticationError; }
 });
 Object.defineProperty(exports, "AuthorizationError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AuthorizationError; }
+  get: function () { return chunkGCMQUM6N_cjs.AuthorizationError; }
 });
 Object.defineProperty(exports, "AutocompleteBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.AutocompleteBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.AutocompleteBuilder; }
 });
 Object.defineProperty(exports, "BaseValidationError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.BaseValidationError; }
+  get: function () { return chunkGCMQUM6N_cjs.BaseValidationError; }
 });
 Object.defineProperty(exports, "BatchBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.BatchBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.BatchBuilder; }
 });
 Object.defineProperty(exports, "BatchClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.BatchClient; }
+  get: function () { return chunkGCMQUM6N_cjs.BatchClient; }
 });
 Object.defineProperty(exports, "ChangesExpiredError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ChangesExpiredError; }
+  get: function () { return chunkGCMQUM6N_cjs.ChangesExpiredError; }
 });
 Object.defineProperty(exports, "ConnectionError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ConnectionError; }
+  get: function () { return chunkGCMQUM6N_cjs.ConnectionError; }
 });
 Object.defineProperty(exports, "ContentByIdBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ContentByIdBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.ContentByIdBuilder; }
 });
 Object.defineProperty(exports, "ContentClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ContentClient; }
+  get: function () { return chunkGCMQUM6N_cjs.ContentClient; }
 });
 Object.defineProperty(exports, "ContentQueryBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ContentQueryBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.ContentQueryBuilder; }
 });
 Object.defineProperty(exports, "ErrorMapper", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ErrorMapper; }
+  get: function () { return chunkGCMQUM6N_cjs.ErrorMapper; }
 });
 Object.defineProperty(exports, "FileUploadError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.FileUploadError; }
+  get: function () { return chunkGCMQUM6N_cjs.FileUploadError; }
 });
 Object.defineProperty(exports, "FileValidationError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.FileValidationError; }
+  get: function () { return chunkGCMQUM6N_cjs.FileValidationError; }
 });
 Object.defineProperty(exports, "HttpClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.HttpClient; }
+  get: function () { return chunkGCMQUM6N_cjs.HttpClient; }
 });
 Object.defineProperty(exports, "InvalidApiKeyError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.InvalidApiKeyError; }
+  get: function () { return chunkGCMQUM6N_cjs.InvalidApiKeyError; }
 });
 Object.defineProperty(exports, "InvalidFieldTypeError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.InvalidFieldTypeError; }
+  get: function () { return chunkGCMQUM6N_cjs.InvalidFieldTypeError; }
 });
 Object.defineProperty(exports, "InvalidPayloadError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.InvalidPayloadError; }
+  get: function () { return chunkGCMQUM6N_cjs.InvalidPayloadError; }
 });
 Object.defineProperty(exports, "MethodNotAllowedError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.MethodNotAllowedError; }
+  get: function () { return chunkGCMQUM6N_cjs.MethodNotAllowedError; }
 });
 Object.defineProperty(exports, "MissingApiKeyError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.MissingApiKeyError; }
+  get: function () { return chunkGCMQUM6N_cjs.MissingApiKeyError; }
 });
 Object.defineProperty(exports, "NetworkError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.NetworkError; }
+  get: function () { return chunkGCMQUM6N_cjs.NetworkError; }
 });
 Object.defineProperty(exports, "PayloadTooLargeError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.PayloadTooLargeError; }
+  get: function () { return chunkGCMQUM6N_cjs.PayloadTooLargeError; }
 });
 Object.defineProperty(exports, "PlanFeatureUnavailableError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.PlanFeatureUnavailableError; }
+  get: function () { return chunkGCMQUM6N_cjs.PlanFeatureUnavailableError; }
 });
 Object.defineProperty(exports, "RateLimitError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.RateLimitError; }
+  get: function () { return chunkGCMQUM6N_cjs.RateLimitError; }
 });
 Object.defineProperty(exports, "ReadOnlyKeyError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ReadOnlyKeyError; }
+  get: function () { return chunkGCMQUM6N_cjs.ReadOnlyKeyError; }
 });
 Object.defineProperty(exports, "RequiredFieldError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.RequiredFieldError; }
+  get: function () { return chunkGCMQUM6N_cjs.RequiredFieldError; }
 });
 Object.defineProperty(exports, "ResourceConflictError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ResourceConflictError; }
+  get: function () { return chunkGCMQUM6N_cjs.ResourceConflictError; }
 });
 Object.defineProperty(exports, "ResourceExpiredError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ResourceExpiredError; }
+  get: function () { return chunkGCMQUM6N_cjs.ResourceExpiredError; }
 });
 Object.defineProperty(exports, "ResourceNotFoundError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ResourceNotFoundError; }
+  get: function () { return chunkGCMQUM6N_cjs.ResourceNotFoundError; }
 });
 Object.defineProperty(exports, "SDKError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.SDKError; }
+  get: function () { return chunkGCMQUM6N_cjs.SDKError; }
 });
 Object.defineProperty(exports, "SchemaValidationError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.SchemaValidationError; }
+  get: function () { return chunkGCMQUM6N_cjs.SchemaValidationError; }
 });
 Object.defineProperty(exports, "SearchBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.SearchBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.SearchBuilder; }
 });
 Object.defineProperty(exports, "SearchClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.SearchClient; }
+  get: function () { return chunkGCMQUM6N_cjs.SearchClient; }
 });
 Object.defineProperty(exports, "ServerError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ServerError; }
+  get: function () { return chunkGCMQUM6N_cjs.ServerError; }
 });
 Object.defineProperty(exports, "ServiceIndeterminateError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ServiceIndeterminateError; }
+  get: function () { return chunkGCMQUM6N_cjs.ServiceIndeterminateError; }
 });
 Object.defineProperty(exports, "SettingsClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.SettingsClient; }
+  get: function () { return chunkGCMQUM6N_cjs.SettingsClient; }
 });
 Object.defineProperty(exports, "SimilarBuilder", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.SimilarBuilder; }
+  get: function () { return chunkGCMQUM6N_cjs.SimilarBuilder; }
 });
 Object.defineProperty(exports, "SingletonClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.SingletonClient; }
+  get: function () { return chunkGCMQUM6N_cjs.SingletonClient; }
 });
 Object.defineProperty(exports, "TimeoutError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.TimeoutError; }
+  get: function () { return chunkGCMQUM6N_cjs.TimeoutError; }
 });
 Object.defineProperty(exports, "TransactionRolledBackError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.TransactionRolledBackError; }
+  get: function () { return chunkGCMQUM6N_cjs.TransactionRolledBackError; }
 });
 Object.defineProperty(exports, "TypedRelyIOClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.TypedRelyIOClient; }
+  get: function () { return chunkGCMQUM6N_cjs.TypedRelyIOClient; }
 });
 Object.defineProperty(exports, "UnknownContractError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.UnknownContractError; }
+  get: function () { return chunkGCMQUM6N_cjs.UnknownContractError; }
 });
 Object.defineProperty(exports, "UsageQuotaExceededError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.UsageQuotaExceededError; }
+  get: function () { return chunkGCMQUM6N_cjs.UsageQuotaExceededError; }
 });
 Object.defineProperty(exports, "ValidationError", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.ValidationError; }
+  get: function () { return chunkGCMQUM6N_cjs.ValidationError; }
 });
 Object.defineProperty(exports, "createClient", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.createClient; }
+  get: function () { return chunkGCMQUM6N_cjs.createClient; }
 });
 Object.defineProperty(exports, "default", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.createClient; }
+  get: function () { return chunkGCMQUM6N_cjs.createClient; }
 });
 Object.defineProperty(exports, "entityTagOf", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.entityTagOf; }
+  get: function () { return chunkGCMQUM6N_cjs.entityTagOf; }
 });
 Object.defineProperty(exports, "isAssetEntry", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.isAssetEntry; }
+  get: function () { return chunkGCMQUM6N_cjs.isAssetEntry; }
 });
 Object.defineProperty(exports, "isResourceNotFound", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.isResourceNotFound; }
+  get: function () { return chunkGCMQUM6N_cjs.isResourceNotFound; }
 });
 Object.defineProperty(exports, "matchRoute", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.matchRoute; }
+  get: function () { return chunkGCMQUM6N_cjs.matchRoute; }
 });
 Object.defineProperty(exports, "validateFile", {
   enumerable: true,
-  get: function () { return chunkCIRT6TVT_cjs.validateFile; }
+  get: function () { return chunkGCMQUM6N_cjs.validateFile; }
 });
 Object.defineProperty(exports, "camelToSnake", {
   enumerable: true,
@@ -525,11 +611,17 @@ Object.defineProperty(exports, "toSafeString", {
   enumerable: true,
   get: function () { return chunkHT6NFRM2_cjs.toSafeString; }
 });
+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;
 exports.buildLanguageSwitcher = buildLanguageSwitcher;
+exports.classifyFollowFailure = classifyFollowFailure;
 exports.estimateTranslationCompleteness = estimateTranslationCompleteness;
+exports.followChanges = followChanges;
 exports.getAllLocalizedValues = getAllLocalizedValues;
 exports.getAvailableLocaleCodes = getAvailableLocaleCodes;
 exports.getDefaultLocale = getDefaultLocale;
@@ -540,6 +632,7 @@ exports.getPublishedLocaleCodes = getPublishedLocaleCodes;
 exports.getRequestedLocale = getRequestedLocale;
 exports.hasLocale = hasLocale;
 exports.isFieldFallback = isFieldFallback;
+exports.isPublishableKey = isPublishableKey;
 exports.isPublishedInLocale = isPublishedInLocale;
 exports.localeHelpers = localeHelpers;
 exports.needsTranslation = needsTranslation;