@monterosa/sdk-interact-kit 0.18.9 → 0.18.10-local-only-storage.2

package/dist/index.cjs.js

@@ -413,7 +413,7 @@ exports.ConnectionHealthState = void 0;
     ConnectionHealthState["Ok"] = "ok";
     /**
      * The client is either trying to establish a connection but failing, or
-     * the client has been explicetily {@link @monterosa/sdk-connect-kit#disconnect() | disconnected}
+     * the client has been explicitly {@link @monterosa/sdk-connect-kit#disconnect() | disconnected}
      */
     ConnectionHealthState["Error"] = "error";
 })(exports.ConnectionHealthState || (exports.ConnectionHealthState = {}));
@@ -486,6 +486,9 @@ var getConnectionHealthMemoized = sdkUtil.memoizePromise(function (sdk) { return
 }); }, function (sdk) { return sdk.options.host; });
 /**
  * Returns {@link ConnectionHealth | connection health} instance
+ *
+ * @param sdk - The SDK instance to monitor
+ * @returns The connection health instance.
  */
 function getConnectionHealth(sdk) {
     if (sdk === void 0) { sdk = sdkCore.getSdk(); }
@@ -493,7 +496,10 @@ function getConnectionHealth(sdk) {
 }
 /**
  * Adds an observer for when
- * {@link ConnectionHealth.state | connection health state} changed
+ * {@link ConnectionHealth | connection health state} changed
+ *
+ * @param connectionHealth - The instance to observe
+ * @param callback - Called with the new state
  */
 function onConnectionHealthState(connectionHealth, callback) {
     return sdkUtil.subscribe(connectionHealth, 'state', callback);
@@ -987,15 +993,22 @@ var getProjectMemoized = sdkUtil.memoizePromise(function (sdk) { return __awaite
 }); }, function (sdk) { return sdk.options.projectId; });
 /**
  * Returns {@link InteractProject | project instance} associated
- * with the {@link @monterosa/sdk-core#MonterosaSdk | configured sdk}
+ * with the
+ * {@link @monterosa/sdk-core#MonterosaSdk | configured sdk}
+ *
+ * @param sdk - The SDK instance. Defaults to the default SDK.
+ * @returns The project instance.
  */
 function getProject(sdk) {
     if (sdk === void 0) { sdk = sdkCore.getSdk(); }
     return getProjectMemoized(sdk);
 }
 /**
- * Adds an observer for when {@link InteractProject.fields |  project fields}
- * are updated
+ * Adds an observer for when
+ * {@link InteractProject | project fields} are updated
+ *
+ * @param project - The project to observe
+ * @param callback - Called when project fields change
  */
 function onProjectFieldsUpdated(project, callback) {
     return sdkUtil.subscribe(project, 'updated', callback);
@@ -1003,8 +1016,9 @@ function onProjectFieldsUpdated(project, callback) {
 /**
  * Adds an observer that is called when the project listings are updated.
  *
- * @deprecated Use {@link onEventAdded()}, {@link onEventUpdated()} and
- * {@link onEventRemoved()} instead
+ * @deprecated Use {@link onEventAdded},
+ * {@link onEventUpdated} and
+ * {@link onEventRemoved} instead
  */
 function onProjectListingsUpdated(project, callback) {
     console.warn('onProjectListingsUpdated() is deprecated. Please use onEventAdded(), onEventUpdated() and onEventRemoved() instead');
@@ -1057,14 +1071,14 @@ function fetchHistory(host, id) {
 exports.EventState = void 0;
 (function (EventState) {
     /**
-     * The event is in the `upcoming` state when its {@link InteractEvent.startAt | start time}
-     * less than the {@link now | current time}.
+     * The event is in the `upcoming` state when its {@link InteractEvent | startAt}
+     * less than the {@link @monterosa/sdk-util#now | current time}.
      */
     EventState["Upcoming"] = "upcoming";
     /**
-     * The event is in the `active` state when its {@link InteractEvent.startAt | start time}
-     * equal or more than the {@link now | current time} and less than the
-     * {@link InteractEvent.endAt | end time}.
+     * The event is in the `active` state when its {@link InteractEvent | startAt}
+     * equal or more than the {@link @monterosa/sdk-util#now | current time} and less than the
+     * {@link InteractEvent | endAt}.
      */
     EventState["Active"] = "active";
     /**
@@ -1072,8 +1086,8 @@ exports.EventState = void 0;
      */
     EventState["Prolonged"] = "prolonged";
     /**
-     * The event is in the `finished` state when its {@link InteractEvent.endAt | end time}
-     * equal or more than the {@link now | current time}.
+     * The event is in the `finished` state when its {@link InteractEvent | endAt}
+     * equal or more than the {@link @monterosa/sdk-util#now | current time}.
      */
     EventState["Finished"] = "finished";
 })(exports.EventState || (exports.EventState = {}));
@@ -1484,7 +1498,7 @@ var getEventsMemoized = sdkUtil.memoizePromise(function (project) { return __awa
                         // Calling builder function that creates an event instance.
                         // Existing event will be returned if it already exists in the cache
                         .map(function (data) { return buildEvent(data, context); })
-                        // Sort events so the most recent event is first, and the oldest is last
+                        // Sort events so the oldest event is first, and the most recent is last
                         .sort(function (a, b) { return a.startAt - b.startAt; }))];
         }
     });
@@ -1523,6 +1537,7 @@ function (project) {
  *
  * @param project - A project instance. If not provided,
  *   the one from the default sdk will be fetched.
+ * @returns A promise that resolves to an array of events.
  */
 function getEvents(project) {
     return getEventsMemoized(project);
@@ -1577,20 +1592,27 @@ var getEventMemoized = sdkUtil.memoizePromise(function (id, project) { return __
  * @param project - A project instance. If not provided,
  *   the one from the default sdk will be fetched.
  *
- * @returns A an event associated with the provided id and project or null if no such
- *   event exists in the project.
+ * @returns The event associated with the provided id,
+ *   or null if no such event exists in the project.
  */
 function getEvent(id, project) {
     return getEventMemoized(id, project);
 }
 /**
- * Adds an observer for when {@link InteractEvent.state | event state} changed
+ * Adds an observer for when
+ * {@link InteractEvent | event state} changed
+ *
+ * @param event - The event to observe
+ * @param callback - Called with the new state
  */
 function onEventState(event, callback) {
     return sdkUtil.subscribe(event, 'state', callback);
 }
 /**
  * Adds an observer for when event's data changed
+ *
+ * @param event - The event to observe
+ * @param callback - Called when the event data changes
  */
 function onEventUpdated(event, callback) {
     return sdkUtil.subscribe(event, 'updated', callback);
@@ -1609,6 +1631,9 @@ function onEventUpdated(event, callback) {
  * - When a future event starts, a new future event may be added to the list,
  *   depending on the project configuration, to ensure a minimum number of
  *   upcoming events are always available.
+ *
+ * @param project - The project to observe
+ * @param callback - Called with the added event
  */
 function onEventAdded(project, callback) {
     var _this = this;
@@ -1659,6 +1684,9 @@ function onEventAdded(project, callback) {
  * {@link onEventAdded} alias.
  *
  * @deprecated Use the new {@link onEventAdded} function instead.
+ *
+ * @param project - The project to observe
+ * @param callback - Called with the added event
  */
 function onEventPublished(project, callback) {
     console.warn('onEventPublished() is deprecated. Please use onEventAdded() instead');
@@ -1678,6 +1706,9 @@ function onEventPublished(project, callback) {
  * - The event is removed after a period of time since its completion. This period
  *   is calculated as 45 seconds plus the Maximum allowed delay (configured in
  *   Project Settings in Studio).
+ *
+ * @param project - The project to observe
+ * @param callback - Called with the removed event
  */
 function onEventRemoved(project, callback) {
     var _this = this;
@@ -1742,13 +1773,21 @@ var _a;
  */
 exports.AnswerError = void 0;
 (function (AnswerError) {
+    /** Selected option index is out of range. */
     AnswerError["OptionIndexOutOfRange"] = "out_of_range";
+    /** Fewer options selected than the minimum required. */
     AnswerError["BelowMinVoteOptions"] = "below_min_vote_options";
+    /** More options selected than the maximum allowed. */
     AnswerError["AboveMaxVoteOptions"] = "above_max_vote_options";
+    /** User has exceeded the maximum votes allowed. */
     AnswerError["AboveMaxVotesPerUser"] = "above_max_per_user";
+    /** A single option received more votes than allowed. */
     AnswerError["AboveMaxVotesPerOption"] = "above_max_per_option";
+    /** Attempted to vote on a non-interactive element. */
     AnswerError["VotedOnNonInteractiveElement"] = "non_interactive_element";
+    /** Attempted to vote on a closed element. */
     AnswerError["VotedOnClosedElement"] = "closed_element";
+    /** No vote value was provided. */
     AnswerError["EmptyVote"] = "empty_vote";
 })(exports.AnswerError || (exports.AnswerError = {}));
 var AnswerErrorMessages = (_a = {},
@@ -2568,7 +2607,10 @@ var getElementMemoized = sdkUtil.memoizePromise(function (event, id) { return __
     });
 }); }, function (event, id) { return id; });
 /**
- * Returns an element of a specific event by its id
+ * Returns an element of a specific event by its id.
+ *
+ * @param event - The event that owns the element
+ * @param id - The element identifier
  */
 function getElement(event, id) {
     return getElementMemoized(event, id);
@@ -2585,7 +2627,7 @@ var getElementsMemoized = sdkUtil.memoizePromise(function (event) { return __awa
                 return [2 /*return*/, (Array.from(elements.values())
                         // Get elements which belong only to the provided event
                         .filter(function (element) { return element.eventId === event.id; })
-                        // Sort elements so the most recent event is first, and the oldest is last
+                        // Sort elements so the oldest element is first, and the most recent is last
                         .sort(function (a, b) { return a.publishedAt - b.publishedAt; }))];
         }
     });
@@ -2594,6 +2636,9 @@ var getElementsMemoized = sdkUtil.memoizePromise(function (event) { return __awa
 });
 /**
  * Returns the list of elements published in a specific event
+ *
+ * @param event - The event to fetch elements for
+ * @returns The published elements, sorted oldest first.
  */
 function getElements(event) {
     return getElementsMemoized(event);
@@ -2689,22 +2734,31 @@ function isNumbers(value) {
     return value.every(function (v) { return typeof v === 'number'; });
 }
 /**
- * Adds an observer for when {@link InteractElement.results | element results}
- * are updated
+ * Adds an observer for when
+ * {@link InteractElement | element results} are updated
+ *
+ * @param element - The element to observe
+ * @param callback - Called when results are updated
  */
 function onElementResults(element, callback) {
     return sdkUtil.subscribe(element, 'results', callback);
 }
 /**
- * Adds an observer for when {@link InteractElement.state | element state}
- * changed
+ * Adds an observer for when
+ * {@link InteractElement | element state} changed
+ *
+ * @param element - The element to observe
+ * @param callback - Called when the state changes
  */
 function onElementStateChanged(element, callback) {
     return sdkUtil.subscribe(element, 'state', callback);
 }
 /**
- * Adds an observer for when {@link InteractElement.fields | element's data}
- * is updated
+ * Adds an observer for when
+ * {@link InteractElement | element fields} are updated
+ *
+ * @param event - The event containing the elements
+ * @param callback - Called with the updated element
  */
 function onElementUpdated(event, callback) {
     configureEvent(event);
@@ -2712,6 +2766,9 @@ function onElementUpdated(event, callback) {
 }
 /**
  * Adds an observer for when a new element is published
+ *
+ * @param event - The event to observe
+ * @param callback - Called with the published element
  */
 function onElementPublished(event, callback) {
     configureEvent(event);
@@ -2723,6 +2780,9 @@ function onElementPublished(event, callback) {
 }
 /**
  * Adds an observer for when an element is revoked
+ *
+ * @param event - The event to observe
+ * @param callback - Called with the revoked element
  */
 function onElementRevoked(event, callback) {
     configureEvent(event);