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

package/dist/index.cjs.js

@@ -165,6 +165,10 @@ exports.Action = void 0;
      * Notifies child Experience about the request to load more data
      */
     Action["OnMoreDataRequested"] = "onMoreDataRequested";
+    /**
+     * Notifies about a share request
+     */
+    Action["OnShare"] = "onShare";
 })(exports.Action || (exports.Action = {}));
 /**
  * @internal
@@ -234,7 +238,7 @@ exports.QueryParam = void 0;
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
-var _a$2;
+var _a$3;
 /**
  * Defines a set of error codes that may be encountered when using the
  * Launcher Kit bridge
@@ -273,14 +277,14 @@ exports.BridgeError = void 0;
      */
     BridgeError["RequestTimeoutError"] = "request_timeout_error";
 })(exports.BridgeError || (exports.BridgeError = {}));
-var BridgeErrorMessages = (_a$2 = {},
-    _a$2[exports.BridgeError.InvalidRequestTimeoutError] = function () {
+var BridgeErrorMessages = (_a$3 = {},
+    _a$3[exports.BridgeError.InvalidRequestTimeoutError] = function () {
         return 'Request timeout must be greater than 0';
     },
-    _a$2[exports.BridgeError.RequestTimeoutError] = function (action, timeout) {
+    _a$3[exports.BridgeError.RequestTimeoutError] = function (action, timeout) {
         return "Request timeout: action \"" + action + "\" did not receive a response within " + timeout + "ms";
     },
-    _a$2);
+    _a$3);
 
 /**
  * @license
@@ -299,8 +303,9 @@ var Config = {
     requestTimeout: 20000,
 };
 /**
- * Sets a new timeout value for requests (default is 20_000 mseconds).
+ * Sets a new timeout value for requests (default is 20,000 ms).
  *
+ * @remarks
  * This function updates the request timeout in the application's configuration.
  * It ensures that the new timeout value is a positive number, and throws
  * an error if the value is non-positive.
@@ -350,7 +355,7 @@ function isMessage(message) {
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
-var _a$1, _b$1, _c$1, _d$1;
+var _a$2, _b$1, _c$1, _d$1;
 var _e, _f, _g;
 var globals$2 = sdkUtil.getGlobal();
 var receiveMessage = function (message) {
@@ -382,7 +387,7 @@ function handleWindowMessage(_a) {
  */
 // The Monterosa SDK namespace may already exist, either because it was created
 // by a native SDK or by another web app using the JS SDK from the same scope.
-(_a$1 = globals$2.monterosaSdk) !== null && _a$1 !== void 0 ? _a$1 : (globals$2.monterosaSdk = {
+(_a$2 = globals$2.monterosaSdk) !== null && _a$2 !== void 0 ? _a$2 : (globals$2.monterosaSdk = {
     initialised: false,
     emitter: new sdkUtil.Emitter(),
     receiveMessage: receiveMessage,
@@ -411,13 +416,13 @@ if (!globals$2.monterosaSdk.initialised) {
  *
  * More details on the license can be found at https://www.monterosa.co/sdk/license
  */
-var _a, _b, _c, _d;
+var _a$1, _b, _c, _d;
 var globals$1 = sdkUtil.getGlobal();
 /**
  * @internal
  */
 var IFRAME_ID_PREFIX = 'micBridge';
-var IS_IOS = !!((_c = (_b = (_a = globals$1.webkit) === null || _a === void 0 ? void 0 : _a.messageHandlers) === null || _b === void 0 ? void 0 : _b.monterosaSdk) === null || _c === void 0 ? void 0 : _c.postMessage);
+var IS_IOS = !!((_c = (_b = (_a$1 = globals$1.webkit) === null || _a$1 === void 0 ? void 0 : _a$1.messageHandlers) === null || _b === void 0 ? void 0 : _b.monterosaSdk) === null || _c === void 0 ? void 0 : _c.postMessage);
 var IS_ANDROID = !!((_d = globals$1.monterosaSdk) === null || _d === void 0 ? void 0 : _d.postMessage);
 var IS_WEB = globals$1.self !== globals$1.parent;
 /**
@@ -612,9 +617,7 @@ function sendSdkMessage(bridged, action, payload) {
     return bridged.bridge.send(action, payload, exports.Source.Sdk);
 }
 /**
- * This function allows to send a simple message with action name and payload to
- * a recipient which can be either parent application (from Experience to parent
- * application) or child Experience (from parent page to Experience).
+ * Sends a message with an action name and payload to a parent application or child Experience.
  *
  * @remarks
  * Usage example in parent application:
@@ -668,14 +671,13 @@ function sendSdkRequest(bridged, action, payload, timeout) {
     return bridged.bridge.request(action, payload, timeout, exports.Source.Sdk);
 }
 /**
- * This function allows to send a request with action name and payload to
- * a recipient which can be either parent application (from Experience to parent
- * application) or child Experience (from parent page to Experience). It is similar
- * to {@link sendMessage} with only one difference is that it returns a Promise which
- * resolves if the recipient response with {@link respondToMessage}. Otherwise it
- * will rejects after a certain timeout.
+ * Sends a request and returns a Promise that resolves when the recipient responds.
  *
  * @remarks
+ * Similar to {@link sendMessage} but returns a Promise which
+ * resolves if the recipient responds with {@link respondToMessage}. Otherwise it
+ * rejects after a certain timeout.
+ *
  * Usage example in parent application:
  *
  * @example
@@ -758,6 +760,8 @@ function onSdkMessage(bridged, callback) {
     return onMessageFunc(bridged, exports.Source.Sdk, callback);
 }
 /**
+ * @internal
+ *
  * Adds an observer for when user message is received
  *
  * @param bridged - Instance of either {@link ParentApplication} or {@link Experience}
@@ -1059,7 +1063,7 @@ function unstashStyles(element) {
     element.removeAttribute('data-stash');
 }
 
-var version = "0.18.9";
+var version = "0.18.10-local-only-storage.2";
 
 /**
  * @license
@@ -1207,10 +1211,12 @@ function experienceReady(experience) {
     });
 }
 /**
- * Embeds web Experience app into iframe. There is only one app can be
- * associated with Experience and it is configured in
- * Monterosa / Interaction Cloud. Please refer the developer guide to get
- * more information on what is app and how to configure it:
+ * Embeds a web Experience app into an iframe.
+ *
+ * @remarks
+ * There is only one app that can be associated with an Experience and it is
+ * configured in Monterosa / Interaction Cloud. Please refer to the developer
+ * guide for more information:
  * {@link https://products.monterosa.co/mic/developer-guides/whats-an-app}
  *
  * @example
@@ -1219,8 +1225,8 @@ function experienceReady(experience) {
  *
  * embed(experience, 'container-id');
  * ```
- * @param {Experience} - An instance of Experience
- * @param {HTMLElement | string} containerOrId - HTML element instance or
+ * @param experience - An instance of Experience
+ * @param containerOrId - HTML element instance or
  *     element id where iframe is embedded into.
  *
  * @public
@@ -1421,12 +1427,13 @@ function getUrlParam(param) {
     return urlParams.get(param);
 }
 /**
+ * Returns whether the Experience should hide its header and footer.
+ *
+ * @remarks
  * The SDK on the parent application will by default request a child
  * Experience to hide its header and footer by setting a query parameter called
  * `micHideHeaderAndFooter` to `1`.
  *
- * This function will return true if that is the case, and false otherwise.
- *
  * When true, the developer of a child Experience is expected to hide it's headers
  * and footers as the parent application is actively providing them.
  *
@@ -1457,8 +1464,6 @@ function isAutoresizesHeight() {
  *
  * sendReady();
  * ```
- *
- * @returns void
  */
 function sendReady() {
     var parentApp = getParentApplication();
@@ -1469,9 +1474,9 @@ function sendReady() {
     sendSdkMessage(parentApp, exports.Action.OnReady);
 }
 /**
- * Sends a message to the SDK of the parent application informing it that
- * the UI of this Experience has completed loading.
+ * Notifies the parent application that the Experience UI has completed loading.
  *
+ * @remarks
  * You should call this method when your UI has completed loading and you are ready to
  * display data to the user. This can be when your network calls have successfully requested
  * data and you have updated the DOM for it, or when an error has occurred and you want
@@ -1567,13 +1572,184 @@ function reportExperienceSizeChanges(element) {
     return function () { return observer.unobserve(element); };
 }
 
+/**
+ * @license
+ * share.ts
+ * launcher-kit
+ *
+ * Copyright © 2026 Monterosa Productions Limited. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+var _a;
+/**
+ * Share requests block on the native share tray which waits for user
+ * interaction (composing a message, picking a target app, etc.). The default
+ * bridge timeout of 20 seconds is too short for this. 5 minutes gives users
+ * ample time while still acting as a safety net against lost messages.
+ */
+var SHARE_REQUEST_TIMEOUT = 300000;
+/**
+ * Error codes for share operations.
+ *
+ * @public
+ */
+exports.ShareError = void 0;
+(function (ShareError) {
+    /**
+     * Error occurred in the parent application while handling the share request.
+     */
+    ShareError["ParentAppError"] = "parent_app_error";
+    /**
+     * The share operation failed (e.g. user denied permission or the browser does
+     * not support sharing).
+     */
+    ShareError["ShareFailed"] = "share_failed";
+})(exports.ShareError || (exports.ShareError = {}));
+/**
+ * Human-readable error message templates for share operations.
+ */
+var ShareErrorMessages = (_a = {},
+    _a[exports.ShareError.ParentAppError] = function (error) {
+        return "Parent application error: " + error;
+    },
+    _a[exports.ShareError.ShareFailed] = function (error) { return "Share failed: " + error; },
+    _a);
+/**
+ * Executes share using the Web Share API.
+ *
+ * @internal
+ */
+function executeShare(data) {
+    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]);
+                    return [4 /*yield*/, navigator.share({
+                            url: data.url,
+                            title: data.title,
+                            text: data.description,
+                        })];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/, 'success'];
+                case 2:
+                    err_1 = _a.sent();
+                    if (err_1 instanceof DOMException && err_1.name === 'AbortError') {
+                        return [2 /*return*/, 'cancelled'];
+                    }
+                    throw sdkUtil.createError(exports.ShareError.ShareFailed, ShareErrorMessages, sdkUtil.getErrorMessage(err_1));
+                case 3: return [2 /*return*/];
+            }
+        });
+    });
+}
+/**
+ * Initiates a share action. When running inside a parent application,
+ * the share request is sent to the parent via the communication bridge.
+ * When running standalone, `navigator.share()` is called directly.
+ *
+ * @param data - The data to share
+ * @returns Resolves when the share completes or the user dismisses the dialog.
+ */
+function share(data) {
+    return __awaiter(this, void 0, void 0, function () {
+        var parentApp, response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    parentApp = getParentApplication();
+                    if (!(parentApp !== null)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, sendSdkRequest(parentApp, exports.Action.OnShare, data, SHARE_REQUEST_TIMEOUT)];
+                case 1:
+                    response = _a.sent();
+                    if (response.payload.result === 'failure') {
+                        throw sdkUtil.createError(exports.ShareError.ParentAppError, ShareErrorMessages, response.payload.message);
+                    }
+                    // 'success' and 'cancelled' both resolve silently
+                    return [2 /*return*/];
+                case 2: return [4 /*yield*/, executeShare(data)];
+                case 3:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+/**
+ * Registers a callback to be called when a share request is received
+ * from a child Experience.
+ *
+ * @param experience - The Experience instance to listen on
+ * @param callback - Called with ShareData when a share request is received
+ * @returns Unsubscribe function
+ */
+function onShare(experience, callback) {
+    return onSdkMessage(experience, function (message) {
+        if (message.action === exports.Action.OnShare) {
+            callback(message.payload);
+        }
+    });
+}
+function onExperienceEmbed(experience) {
+    var _this = this;
+    return onSdkMessage(experience, function (message) { return __awaiter(_this, void 0, void 0, function () {
+        var parentApp, payload, response, result, err_2;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (message.action !== exports.Action.OnShare) {
+                        return [2 /*return*/];
+                    }
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 6, , 7]);
+                    parentApp = getParentApplication();
+                    payload = void 0;
+                    if (!(parentApp !== null)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, sendSdkRequest(parentApp, exports.Action.OnShare, message.payload, SHARE_REQUEST_TIMEOUT)];
+                case 2:
+                    response = _a.sent();
+                    payload = response.payload;
+                    return [3 /*break*/, 5];
+                case 3: return [4 /*yield*/, executeShare(message.payload)];
+                case 4:
+                    result = _a.sent();
+                    payload = {
+                        result: result,
+                        message: result === 'success' ? 'Share successful' : 'Share cancelled',
+                        data: {},
+                    };
+                    _a.label = 5;
+                case 5:
+                    respondToSdkMessage(experience, message, payload);
+                    return [3 /*break*/, 7];
+                case 6:
+                    err_2 = _a.sent();
+                    respondToSdkMessage(experience, message, {
+                        result: 'failure',
+                        message: sdkUtil.getErrorMessage(err_2),
+                        data: {},
+                    });
+                    return [3 /*break*/, 7];
+                case 7: return [2 /*return*/];
+            }
+        });
+    }); });
+}
+registerEmbedHook(onExperienceEmbed);
+
 exports.BRIDGE_VERSION = VERSION$1;
 exports.BridgeImpl = BridgeImpl;
 exports.ExperienceImpl = ExperienceImpl;
 exports.ParentApplicationImpl = ParentApplicationImpl;
+exports.ShareErrorMessages = ShareErrorMessages;
 exports.VERSION = VERSION;
 exports.embed = embed;
 exports.enableLogging = enableLogging;
+exports.executeShare = executeShare;
 exports.getBridge = getBridge;
 exports.getExperience = getExperience;
 exports.getParentApplication = getParentApplication;
@@ -1583,6 +1759,7 @@ exports.onMessage = onMessage;
 exports.onMoreDataRequested = onMoreDataRequested;
 exports.onReady = onReady;
 exports.onSdkMessage = onSdkMessage;
+exports.onShare = onShare;
 exports.registerEmbedHook = registerEmbedHook;
 exports.reportExperienceSizeChanges = reportExperienceSizeChanges;
 exports.requestMoreData = requestMoreData;
@@ -1597,6 +1774,7 @@ exports.sendRequest = sendRequest;
 exports.sendSdkMessage = sendSdkMessage;
 exports.sendSdkRequest = sendSdkRequest;
 exports.setRequestTimeout = setRequestTimeout;
+exports.share = share;
 exports.shouldHideHeaderAndFooter = shouldHideHeaderAndFooter;
 exports.unmount = unmount;
 //# sourceMappingURL=index.cjs.js.map