@monterosa/sdk-interact-kit 0.19.0-rc.5 → 2.0.0-rc.1

package/dist/core/element/factory.d.ts

@@ -12,8 +12,8 @@ import { ElementContext } from './context';
 import { InteractEvent } from '../event/public-types';
 import { Answer } from './answer';
 export declare const elements: Map<string, InteractElement>;
-export declare function buildElement(options: ElementOptions, context: ElementContext): InteractElement;
+export declare function buildElement(options: ElementOptions, context: ElementContext): Promise<InteractElement>;
 export declare function configureEvent(event: InteractEvent): Promise<void>;
 export declare function sendAnswer(element: InteractElement, userAnswer: Answer): Promise<void>;
-export declare function storeAnswer(element: InteractElement, userAnswer: Answer): void;
-export declare function restoreAnswer(element: InteractElement): void;
+export declare function storeAnswer(element: InteractElement, userAnswer: Answer): Promise<void>;
+export declare function restoreAnswer(element: InteractElement): Promise<void>;

package/dist/core/event/event_impl.d.ts

@@ -20,6 +20,9 @@ export declare class EventImpl extends Emitter implements InteractEvent {
     private _internalState;
     private _initState;
     private _history;
+    private boundHandleState;
+    private boundHandleInternalState;
+    private boundHandleEventsUpdated;
     private unsubscribeStateHandler;
     private unsubscribeInternalStateHandler;
     private unsubscribeListingsHandler;
@@ -28,7 +31,7 @@ export declare class EventImpl extends Emitter implements InteractEvent {
     private calculateInternalState;
     private handleState;
     private handleInternalState;
-    private handleListings;
+    private handleEventsUpdated;
     /** @internal */
     destroy(): void;
     get context(): EventContext;

package/dist/core/project/api.d.ts

@@ -8,7 +8,7 @@
  */
 import { MonterosaSdk } from '@monterosa/sdk-core';
 import { Unsubscribe } from '@monterosa/sdk-util';
-import { InteractProject, Listings } from './public-types';
+import { InteractProject } from './public-types';
 /**
  * @internal
  */
@@ -18,17 +18,16 @@ declare const getProjectMemoized: (...args: any[]) => Promise<InteractProject>;
  * with the {@link @monterosa/sdk-core#MonterosaSdk | configured sdk}
  */
 declare function getProject(sdk?: MonterosaSdk): Promise<InteractProject>;
-/**
- * @internal
- */
-export declare function fetchListings(host: string, projectId: string): Promise<Listings>;
 /**
  * Adds an observer for when {@link InteractProject.fields |  project fields}
  * are updated
  */
 declare function onProjectFieldsUpdated(project: InteractProject, callback: () => void): Unsubscribe;
 /**
- * @internal
+ * Adds an observer that is called when the project listings are updated.
+ *
+ * @deprecated Use {@link onEventAdded()}, {@link onEventUpdated()} and
+ * {@link onEventRemoved()} instead
  */
 declare function onProjectListingsUpdated(project: InteractProject, callback: () => void): Unsubscribe;
 export { getProject, getProjectMemoized, onProjectFieldsUpdated, onProjectListingsUpdated, };

package/dist/core/project/project_impl.d.ts

@@ -34,6 +34,11 @@ export declare class ProjectImpl extends Emitter implements InteractProject {
      * Calculates events that were created (present in new listings but not in old)
      */
     private _calculateCreatedEvents;
+    /**
+     * Calculates events that were updated (present in old listings and new,
+     * but with different digest)
+     */
+    private _calculateUpdatedEvents;
     /**
      * Calculates events that were deleted (present in old listings but not in new)
      */

package/dist/index.cjs.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var sdkConnectKit = require('@monterosa/sdk-connect-kit');
 var sdkUtil = require('@monterosa/sdk-util');
 var sdkCore = require('@monterosa/sdk-core');
+var sdkInteractInterop = require('@monterosa/sdk-interact-interop');
+var sdkStorageKit = require('@monterosa/sdk-storage-kit');
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -493,31 +495,6 @@ function onConnectionHealthState(connectionHealth, callback) {
     return sdkUtil.subscribe(connectionHealth, 'state', callback);
 }
 
-/**
- * @license
- * @monterosa/sdk-interact-kit
- *
- * Copyright © 2022 Monterosa Productions Limited. All rights reserved.
- *
- * More details on the license can be found at https://www.monterosa.co/sdk/license
- */
-function fetchSettings(host, id) {
-    return __awaiter(this, void 0, void 0, function () {
-        var response, data;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, fetch("https://".concat(host, "/projects/").concat(id.substring(0, 2), "/").concat(id, "/settings.json"))];
-                case 1:
-                    response = _a.sent();
-                    return [4 /*yield*/, response.json()];
-                case 2:
-                    data = _a.sent();
-                    return [2 /*return*/, data];
-            }
-        });
-    });
-}
-
 /**
  * @license
  * @monterosa/sdk-interact-kit
@@ -651,11 +628,12 @@ var ProjectImpl = /** @class */ (function (_super) {
         },
         set: function (newListings) {
             var createdEvents = this._calculateCreatedEvents(newListings);
+            var updatedEvents = this._calculateUpdatedEvents(newListings);
             var deletedEvents = this._calculateDeletedEvents(newListings);
             this._listings = __assign({}, newListings);
             this._updateLocales(newListings);
             this._updateEventsChecksum(newListings);
-            this._emitListingsEvents(createdEvents, deletedEvents);
+            this._emitListingsEvents(createdEvents, updatedEvents, deletedEvents);
         },
         enumerable: false,
         configurable: true
@@ -673,6 +651,25 @@ var ProjectImpl = /** @class */ (function (_super) {
             return !_this._listings.events.some(function (event) { return id === event.id; });
         });
     };
+    /**
+     * Calculates events that were updated (present in old listings and new,
+     * but with different digest)
+     */
+    ProjectImpl.prototype._calculateUpdatedEvents = function (newListings) {
+        var _this = this;
+        if (!this._listings) {
+            return [];
+        }
+        return newListings.events.filter(function (event) {
+            // find event data in new listings
+            var existingEvent = _this._listings.events.find(function (_a) {
+                var id = _a.id;
+                return event.id === id;
+            });
+            // return true if event data is found and digest is different
+            return existingEvent && event.digest !== existingEvent.digest;
+        });
+    };
     /**
      * Calculates events that were deleted (present in old listings but not in new)
      */
@@ -707,16 +704,20 @@ var ProjectImpl = /** @class */ (function (_super) {
     /**
      * Emits events based on created and deleted events
      */
-    ProjectImpl.prototype._emitListingsEvents = function (createdEvents, deletedEvents) {
+    ProjectImpl.prototype._emitListingsEvents = function (createdEvents, updatedEvents, deletedEvents) {
         var hasCreatedEvents = createdEvents.length > 0;
         var hasDeletedEvents = deletedEvents.length > 0;
-        var hasChanges = hasCreatedEvents || hasDeletedEvents;
+        var hasUpdatedEvents = updatedEvents.length > 0;
+        var hasChanges = hasCreatedEvents || hasDeletedEvents || hasUpdatedEvents;
         if (hasCreatedEvents) {
             this.emit('listings_events_created', createdEvents);
         }
         if (hasDeletedEvents) {
             this.emit('listings_events_deleted', deletedEvents);
         }
+        if (hasUpdatedEvents) {
+            this.emit('listings_events_updated', updatedEvents);
+        }
         if (hasChanges) {
             this.emit('listings');
         }
@@ -844,7 +845,7 @@ function buildProject(options, context) {
                         throw new Error("Unable to fetch project ".concat(id, " listings. Possibly wrong project id."));
                     }
                     _a = project;
-                    return [4 /*yield*/, fetchSettings(project.host, project.id)];
+                    return [4 /*yield*/, sdkInteractInterop.fetchSettings(project.host, project.id)];
                 case 4:
                     _a.fields = _b.sent();
                     return [2 /*return*/, project];
@@ -928,7 +929,7 @@ function handleListings(project, data) {
                     _d.trys.push([1, 4, , 5]);
                     if (!(oldDigest !== undefined && newDigest !== oldDigest)) return [3 /*break*/, 3];
                     _b = project;
-                    return [4 /*yield*/, fetchSettings(project.host, project.id)];
+                    return [4 /*yield*/, sdkInteractInterop.fetchSettings(project.host, project.id)];
                 case 2:
                     _b.fields = _d.sent();
                     _d.label = 3;
@@ -978,25 +979,6 @@ function getProject(sdk) {
     if (sdk === void 0) { sdk = sdkCore.getSdk(); }
     return getProjectMemoized(sdk);
 }
-/**
- * @internal
- */
-function fetchListings(host, projectId) {
-    return __awaiter(this, void 0, void 0, function () {
-        var response, data;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, fetch("https://".concat(host, "/projects/").concat(projectId.substring(0, 2), "/").concat(projectId, "/listings.json"))];
-                case 1:
-                    response = _a.sent();
-                    return [4 /*yield*/, response.json()];
-                case 2:
-                    data = (_a.sent());
-                    return [2 /*return*/, data];
-            }
-        });
-    });
-}
 /**
  * Adds an observer for when {@link InteractProject.fields |  project fields}
  * are updated
@@ -1005,9 +987,13 @@ function onProjectFieldsUpdated(project, callback) {
     return sdkUtil.subscribe(project, 'updated', callback);
 }
 /**
- * @internal
+ * Adds an observer that is called when the project listings are updated.
+ *
+ * @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');
     return sdkUtil.subscribe(project, 'listings', callback);
 }
 
@@ -1101,11 +1087,12 @@ var EventImpl = /** @class */ (function (_super) {
         _this._context = context;
         _this._state = _this.calculateState();
         _this._internalState = _this.calculateInternalState();
-        _this.unsubscribeStateHandler = sdkUtil.onTick(function () { return _this.handleState(); });
-        _this.unsubscribeInternalStateHandler = sdkUtil.onTick(function () {
-            _this.handleInternalState();
-        });
-        _this.unsubscribeListingsHandler = onProjectListingsUpdated(context.project, function () { return _this.handleListings(); });
+        _this.boundHandleState = _this.handleState.bind(_this);
+        _this.boundHandleInternalState = _this.handleInternalState.bind(_this);
+        _this.boundHandleEventsUpdated = _this.handleEventsUpdated.bind(_this);
+        _this.unsubscribeStateHandler = sdkUtil.onTick(_this.boundHandleState);
+        _this.unsubscribeInternalStateHandler = sdkUtil.onTick(_this.boundHandleInternalState);
+        _this.unsubscribeListingsHandler = sdkUtil.subscribe(_this.context.project, 'listings_events_updated', _this.boundHandleEventsUpdated);
         return _this;
     }
     EventImpl.prototype.calculateState = function () {
@@ -1149,15 +1136,17 @@ var EventImpl = /** @class */ (function (_super) {
             this.emit('internal_state', internalState);
         }
     };
-    EventImpl.prototype.handleListings = function () {
+    EventImpl.prototype.handleEventsUpdated = function (events) {
         var _this = this;
-        var project = this.context.project;
-        var data = project.events.find(function (_a) {
+        var data = events.find(function (_a) {
             var id = _a.id;
             return id === _this.id;
         });
         if (data && this._data.digest !== data.digest) {
             this._data = data;
+            // Forcing state recalculation to ensure the event is in the correct state
+            this.handleState();
+            this.handleInternalState();
             this.emit('updated');
         }
     };
@@ -1993,6 +1982,7 @@ var ElementImpl = /** @class */ (function (_super) {
     };
     ElementImpl.prototype.update = function (data) {
         this._data = data;
+        this.handleState();
     };
     ElementImpl.prototype.destroy = function () {
         this.unsubscribeStateHandler();
@@ -2240,15 +2230,24 @@ var ElementImpl = /** @class */ (function (_super) {
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
 var elements = new Map();
-var storageAvailable = sdkUtil.checkAvailability();
 function buildElement(options, context) {
-    if (elements.has(options.id)) {
-        return elements.get(options.id);
-    }
-    var element = new ElementImpl(options, context);
-    restoreAnswer(element);
-    elements.set(element.id, element);
-    return element;
+    return __awaiter(this, void 0, void 0, function () {
+        var element;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (elements.has(options.id)) {
+                        return [2 /*return*/, elements.get(options.id)];
+                    }
+                    element = new ElementImpl(options, context);
+                    return [4 /*yield*/, restoreAnswer(element)];
+                case 1:
+                    _a.sent();
+                    elements.set(element.id, element);
+                    return [2 /*return*/, element];
+            }
+        });
+    });
 }
 function getElementByPolld(pollId) {
     return Array.from(elements.values()).find(function (element) { return element.pollId === pollId; });
@@ -2347,19 +2346,28 @@ function handleCreateMessage(message) {
                     if (event === null) {
                         return [2 /*return*/];
                     }
-                    if (elements.has(options.id)) {
-                        element = elements.get(options.id);
-                        if (options.updated_at > element.updatedAt) {
-                            element.update(options);
-                            event.emit('update', element);
-                        }
-                    }
-                    else {
-                        context = __assign(__assign({}, event.context), { event: event });
-                        element = buildElement(options, context);
-                        event.emit('publish', element);
+                    if (!elements.has(options.id)) return [3 /*break*/, 2];
+                    element = elements.get(options.id);
+                    if (options.updated_at > element.updatedAt ||
+                        // This is a workaround to handle a Studio issue when two /create/ messages
+                        // are sent upon correct option reveal. The first /create/ message contains
+                        // the same duration but a different updated_at timestamp. The second /create/
+                        // message contains the same updated_at timestamp but a different duration.
+                        // Therefore, we need to check if the duration is different to ensure that
+                        // the element is updated correctly.
+                        options.duration !== element.duration) {
+                        element.update(options);
+                        event.emit('update', element);
                     }
-                    return [2 /*return*/];
+                    return [3 /*break*/, 4];
+                case 2:
+                    context = __assign(__assign({}, event.context), { event: event });
+                    return [4 /*yield*/, buildElement(options, context)];
+                case 3:
+                    element = _a.sent();
+                    event.emit('publish', element);
+                    _a.label = 4;
+                case 4: return [2 /*return*/];
             }
         });
     });
@@ -2408,32 +2416,70 @@ function handleRevealMessage(message) {
     if (!element) {
         return;
     }
-    element.correctOption = correctOption;
-    element.context.event.emit('update', element);
+    if (element.correctOption !== correctOption) {
+        element.correctOption = correctOption;
+        element.context.event.emit('update', element);
+    }
 }
 function handleEventHistory(history) {
+    var _a, e_1, _b, _c;
     return __awaiter(this, void 0, void 0, function () {
-        var event, context, _i, _a, snapshot;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var event, context, _d, _e, _f, snapshot, e_1_1;
+        return __generator(this, function (_g) {
+            switch (_g.label) {
                 case 0:
                     if (history.timeline.length === 0) {
                         return [2 /*return*/];
                     }
                     return [4 /*yield*/, getEvent(history.config.id)];
                 case 1:
-                    event = _b.sent();
+                    event = _g.sent();
                     if (event === null) {
                         return [2 /*return*/];
                     }
                     context = __assign(__assign({}, event.context), { event: event });
-                    for (_i = 0, _a = history.timeline; _i < _a.length; _i++) {
-                        snapshot = _a[_i];
-                        if (!elements.has(snapshot.id)) {
-                            buildElement(snapshot, context);
-                        }
-                    }
-                    return [2 /*return*/];
+                    _g.label = 2;
+                case 2:
+                    _g.trys.push([2, 11, 12, 17]);
+                    _d = true, _e = __asyncValues(history.timeline);
+                    _g.label = 3;
+                case 3: return [4 /*yield*/, _e.next()];
+                case 4:
+                    if (!(_f = _g.sent(), _a = _f.done, !_a)) return [3 /*break*/, 10];
+                    _c = _f.value;
+                    _d = false;
+                    _g.label = 5;
+                case 5:
+                    _g.trys.push([5, , 8, 9]);
+                    snapshot = _c;
+                    if (!!elements.has(snapshot.id)) return [3 /*break*/, 7];
+                    return [4 /*yield*/, buildElement(snapshot, context)];
+                case 6:
+                    _g.sent();
+                    _g.label = 7;
+                case 7: return [3 /*break*/, 9];
+                case 8:
+                    _d = true;
+                    return [7 /*endfinally*/];
+                case 9: return [3 /*break*/, 3];
+                case 10: return [3 /*break*/, 17];
+                case 11:
+                    e_1_1 = _g.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 17];
+                case 12:
+                    _g.trys.push([12, , 15, 16]);
+                    if (!(!_d && !_a && (_b = _e.return))) return [3 /*break*/, 14];
+                    return [4 /*yield*/, _b.call(_e)];
+                case 13:
+                    _g.sent();
+                    _g.label = 14;
+                case 14: return [3 /*break*/, 16];
+                case 15:
+                    if (e_1) throw e_1.error;
+                    return [7 /*endfinally*/];
+                case 16: return [7 /*endfinally*/];
+                case 17: return [2 /*return*/];
             }
         });
     });
@@ -2462,27 +2508,41 @@ function sendAnswer(element, userAnswer) {
     });
 }
 function storeAnswer(element, userAnswer) {
-    try {
-        element.userAnswer = userAnswer;
-        if (storageAvailable) {
-            // Can throw a "QuotaExceededError" DOMException exception
-            // if the quota has been exceeded.
-            sdkUtil.setItem("element_".concat(element.id, "_vote"), JSON.stringify(userAnswer));
-        }
-    }
-    catch (err) {
-        if (err instanceof Error) {
-            console.warn("Can't store user answer: ".concat(err.message));
-        }
-    }
+    return __awaiter(this, void 0, void 0, function () {
+        var err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    element.userAnswer = userAnswer;
+                    return [4 /*yield*/, sdkStorageKit.storageWrite("element_".concat(element.id, "_vote"), JSON.stringify(userAnswer))];
+                case 1:
+                    _a.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    err_1 = _a.sent();
+                    console.warn("Failed to store user answer: ".concat(sdkUtil.getErrorMessage(err_1)));
+                    return [3 /*break*/, 3];
+                case 3: return [2 /*return*/];
+            }
+        });
+    });
 }
 function restoreAnswer(element) {
-    if (storageAvailable) {
-        var userAnswer = sdkUtil.getItem("element_".concat(element.id, "_vote"));
-        if (userAnswer !== null) {
-            element.userAnswer = Answer.fromJSON(userAnswer);
-        }
-    }
+    return __awaiter(this, void 0, void 0, function () {
+        var userAnswer;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, sdkStorageKit.storageRead("element_".concat(element.id, "_vote"))];
+                case 1:
+                    userAnswer = _a.sent();
+                    if (userAnswer !== null) {
+                        element.userAnswer = Answer.fromJSON(userAnswer);
+                    }
+                    return [2 /*return*/];
+            }
+        });
+    });
 }
 
 /**
@@ -2867,7 +2927,6 @@ exports.ElementImpl = ElementImpl;
 exports.EventImpl = EventImpl;
 exports.ProjectImpl = ProjectImpl;
 exports.answer = answer;
-exports.fetchListings = fetchListings;
 exports.getConnect = getConnect;
 exports.getConnectionHealth = getConnectionHealth;
 exports.getElement = getElement;