@lightspeed/online-payments-sdk 0.1.1 → 0.1.3

package/dist/cjs/frameMessenger.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrameMessenger = void 0;
+var createFrameMessenger = function (hostWindow, contentIframe, contentOrigin) {
+    var publishMessage = function (eventType, payload) {
+        if (contentIframe.contentWindow) {
+            contentIframe.contentWindow.postMessage({ type: eventType, payload: payload }, contentOrigin);
+            return {
+                success: true,
+            };
+        }
+        else {
+            return {
+                success: false,
+                message: 'Failed to send event',
+            };
+        }
+    };
+    // if the events are not getting received its because you changed window to hostWindow
+    var awaitMessage = function (eventType) {
+        return new Promise(function (resolve) {
+            var handler = function (event) {
+                if (event.origin === contentOrigin) {
+                    if (validateEventTypeAndPayload(eventType, event.data)) {
+                        hostWindow.removeEventListener('message', handler);
+                        resolve(event.data);
+                    }
+                }
+            };
+            hostWindow.addEventListener('message', handler);
+        });
+    };
+    return {
+        publishMessage: publishMessage,
+        awaitMessage: awaitMessage,
+    };
+};
+function validateEventTypeAndPayload(eventType, event) {
+    var _a, _b, _c, _d;
+    var e = event;
+    if (e.type !== eventType) {
+        return false;
+    }
+    switch (eventType) {
+        case 'READY':
+            return true;
+        case 'COMPLETE': {
+            var completeEvent = e;
+            return ((_b = (_a = completeEvent === null || completeEvent === void 0 ? void 0 : completeEvent.payload) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.paymentId) !== undefined;
+        }
+        case 'ERROR': {
+            var errorEvent = e;
+            return ((_d = (_c = errorEvent.payload) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.code) !== undefined;
+        }
+        default:
+            return false;
+    }
+}
+exports.FrameMessenger = { createFrameMessenger: createFrameMessenger };

package/dist/cjs/index.js

@@ -0,0 +1,93 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mountLightspeedPayments = void 0;
+var frameMessenger_1 = require("./frameMessenger");
+var getContentHostname = function () {
+    var _a, _b;
+    return ((_b = (_a = process.env.OVERRIDE_IFRAME_CONTENT_HOSTNAME) !== null && _a !== void 0 ? _a : process.env.IFRAME_CONTENT_HOSTNAME) !== null && _b !== void 0 ? _b : '');
+};
+function createOnlinePaymentsInterface(messenger) {
+    var _this = this;
+    return {
+        collectPaymentMethod: function (paymentSessionId) { return __awaiter(_this, void 0, void 0, function () {
+            var responseListeners, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        responseListeners = Promise.race([
+                            messenger.awaitMessage('COMPLETE'),
+                            messenger.awaitMessage('ERROR'),
+                        ]);
+                        messenger.publishMessage('SET_PAYMENT_SESSION_V1', { paymentSessionId: paymentSessionId });
+                        return [4 /*yield*/, responseListeners];
+                    case 1:
+                        response = _a.sent();
+                        if (response.type === 'COMPLETE') {
+                            return [2 /*return*/, {
+                                    success: true,
+                                    paymentId: response.payload.data.paymentId,
+                                }];
+                        }
+                        throw Error(response.payload.data.message);
+                }
+            });
+        }); },
+    };
+}
+function mountLightspeedPayments(mountPoint) {
+    return __awaiter(this, void 0, void 0, function () {
+        var contentHostname, lspIframe, messenger, ready;
+        return __generator(this, function (_a) {
+            contentHostname = getContentHostname();
+            lspIframe = window.document.createElement('iframe');
+            lspIframe.height = '800px';
+            lspIframe.width = '700px';
+            lspIframe.src = contentHostname;
+            if (!mountPoint) {
+                throw Error('HtmlElement to mount checkout to is required. Received undefined');
+            }
+            messenger = frameMessenger_1.FrameMessenger.createFrameMessenger(window, lspIframe, contentHostname);
+            ready = messenger.awaitMessage('READY');
+            mountPoint.appendChild(lspIframe);
+            // Only return the messenger once it is verified that the content within the iframe is listening
+            return [2 /*return*/, ready.then(function () { return createOnlinePaymentsInterface(messenger); })];
+        });
+    });
+}
+exports.mountLightspeedPayments = mountLightspeedPayments;

package/dist/frameMessenger.d.ts

@@ -0,0 +1,41 @@
+type PublishableMessagePayloadMapping = {
+    SET_PAYMENT_SESSION_V1: {
+        paymentSessionId: string;
+    };
+};
+type PublishableMessage = keyof PublishableMessagePayloadMapping;
+type MessageEventData<K extends AwaitableMessage, T> = {
+    type: K;
+    payload: T;
+};
+export type AwaitableMessagePayloadMap = {
+    READY: MessageEventData<'READY', undefined>;
+    ERROR: MessageEventData<'ERROR', {
+        version: string;
+        data: {
+            code: string;
+            message: string;
+        };
+    }>;
+    COMPLETE: MessageEventData<'COMPLETE', {
+        version: string;
+        data: {
+            paymentId: string;
+        };
+    }>;
+};
+export type AwaitableMessage = keyof AwaitableMessagePayloadMap;
+type PublishMessageResult = {
+    success: true;
+} | {
+    success: false;
+    message: string;
+};
+export type FrameMessenger = {
+    awaitMessage<T extends AwaitableMessage>(eventType: T): Promise<AwaitableMessagePayloadMap[T]>;
+    publishMessage<T extends PublishableMessage>(eventType: T, payload: PublishableMessagePayloadMapping[T]): PublishMessageResult;
+};
+export declare const FrameMessenger: {
+    createFrameMessenger: (hostWindow: Window, contentIframe: HTMLIFrameElement, contentOrigin: string) => FrameMessenger;
+};
+export {};

package/dist/frameMessenger.js

@@ -0,0 +1,56 @@
+var createFrameMessenger = function (hostWindow, contentIframe, contentOrigin) {
+    var publishMessage = function (eventType, payload) {
+        if (contentIframe.contentWindow) {
+            contentIframe.contentWindow.postMessage({ type: eventType, payload: payload }, contentOrigin);
+            return {
+                success: true,
+            };
+        }
+        else {
+            return {
+                success: false,
+                message: 'Failed to send event',
+            };
+        }
+    };
+    // if the events are not getting received its because you changed window to hostWindow
+    var awaitMessage = function (eventType) {
+        return new Promise(function (resolve) {
+            var handler = function (event) {
+                if (event.origin === contentOrigin) {
+                    if (validateEventTypeAndPayload(eventType, event.data)) {
+                        hostWindow.removeEventListener('message', handler);
+                        resolve(event.data);
+                    }
+                }
+            };
+            hostWindow.addEventListener('message', handler);
+        });
+    };
+    return {
+        publishMessage: publishMessage,
+        awaitMessage: awaitMessage,
+    };
+};
+function validateEventTypeAndPayload(eventType, event) {
+    var _a, _b, _c, _d;
+    var e = event;
+    if (e.type !== eventType) {
+        return false;
+    }
+    switch (eventType) {
+        case 'READY':
+            return true;
+        case 'COMPLETE': {
+            var completeEvent = e;
+            return ((_b = (_a = completeEvent === null || completeEvent === void 0 ? void 0 : completeEvent.payload) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.paymentId) !== undefined;
+        }
+        case 'ERROR': {
+            var errorEvent = e;
+            return ((_d = (_c = errorEvent.payload) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.code) !== undefined;
+        }
+        default:
+            return false;
+    }
+}
+export var FrameMessenger = { createFrameMessenger: createFrameMessenger };

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export type Configuration = {
+    payment_session: string;
+};
+export type CollectPaymentMethodResponse = {
+    success: true;
+    paymentId: string;
+};
+export type OnlinePaymentsInterface = {
+    collectPaymentMethod(paymentSessionId: string): Promise<CollectPaymentMethodResponse>;
+};
+export declare function mountLightspeedPayments(mountPoint: HTMLElement): Promise<OnlinePaymentsInterface>;

package/dist/index.js

@@ -0,0 +1,89 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { FrameMessenger } from './frameMessenger';
+var getContentHostname = function () {
+    var _a, _b;
+    return ((_b = (_a = process.env.OVERRIDE_IFRAME_CONTENT_HOSTNAME) !== null && _a !== void 0 ? _a : process.env.IFRAME_CONTENT_HOSTNAME) !== null && _b !== void 0 ? _b : '');
+};
+function createOnlinePaymentsInterface(messenger) {
+    var _this = this;
+    return {
+        collectPaymentMethod: function (paymentSessionId) { return __awaiter(_this, void 0, void 0, function () {
+            var responseListeners, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        responseListeners = Promise.race([
+                            messenger.awaitMessage('COMPLETE'),
+                            messenger.awaitMessage('ERROR'),
+                        ]);
+                        messenger.publishMessage('SET_PAYMENT_SESSION_V1', { paymentSessionId: paymentSessionId });
+                        return [4 /*yield*/, responseListeners];
+                    case 1:
+                        response = _a.sent();
+                        if (response.type === 'COMPLETE') {
+                            return [2 /*return*/, {
+                                    success: true,
+                                    paymentId: response.payload.data.paymentId,
+                                }];
+                        }
+                        throw Error(response.payload.data.message);
+                }
+            });
+        }); },
+    };
+}
+export function mountLightspeedPayments(mountPoint) {
+    return __awaiter(this, void 0, void 0, function () {
+        var contentHostname, lspIframe, messenger, ready;
+        return __generator(this, function (_a) {
+            contentHostname = getContentHostname();
+            lspIframe = window.document.createElement('iframe');
+            lspIframe.height = '800px';
+            lspIframe.width = '700px';
+            lspIframe.src = contentHostname;
+            if (!mountPoint) {
+                throw Error('HtmlElement to mount checkout to is required. Received undefined');
+            }
+            messenger = FrameMessenger.createFrameMessenger(window, lspIframe, contentHostname);
+            ready = messenger.awaitMessage('READY');
+            mountPoint.appendChild(lspIframe);
+            // Only return the messenger once it is verified that the content within the iframe is listening
+            return [2 /*return*/, ready.then(function () { return createOnlinePaymentsInterface(messenger); })];
+        });
+    });
+}

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@lightspeed/online-payments-sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Process online-payments with Lightspeed Payments",
-  "type": "module",
   "author": "Lightspeed Commerce Inc.",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist/cjs/index.js",