@guestyorg/tokenization-js 1.0.0-0

package/LICENSE.md

@@ -0,0 +1,35 @@
+MIT License
+
+Copyright (c) 2023 Guesty Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Disclaimer Regarding Non-Compliance with Assimilation Instructions
+
+In accordance with the terms of the MIT License, users and advertisers are granted permission to use, modify, and distribute this software. However, the following disclaimer shall apply:
+
+- The original authors and copyright holders of this software are not responsible for any non-compliance with the assimilation instructions provided in the documentation or any associated materials. Users, advertisers, and third parties who choose to use, modify, or distribute this software are solely responsible for ensuring compliance with any assimilation, attribution, or other requirements outlined in the documentation.
+
+- By using, modifying, or distributing this software, you acknowledge and agree that the responsibility for adhering to any assimilation instructions lies with the user, advertiser, or third party, and any consequences resulting from non-compliance are the sole responsibility of those parties.
+
+This disclaimer is in addition to, and does not supersede the terms and conditions outlined in the MIT License, which governs the use, modification, and distribution of this Software.
+
+User Responsibility Regarding Data Collection
+
+This Software may collect and process data. By using, modifying, or distributing the Software, you agree to the following:
+
+1. Data Handling: You are solely responsible for understanding and complying with any data collection, storage, and processing practices outlined in the documentation or associated materials. This includes but is not limited to ensuring that any data collected complies with applicable data protection and privacy laws and regulations.
+
+2. Data Security: You are responsible for implementing appropriate security measures to protect any data collected through the use of this Software. This includes safeguarding data against unauthorized access, disclosure, or modification.
+
+3. Data Consent: If this Software collects personally identifiable information or sensitive data, you must obtain appropriate consent from individuals whose data is collected, and you must adhere to any applicable consent requirements and data subject rights.
+
+4. Data Ownership: Any data collected and processed by this software remains the property of the individuals or entities to whom it pertains. You do not acquire ownership rights to the data by using this Software.
+
+5. No Liability: The original authors and copyright holders of this software are not liable for any issues, damages, or legal obligations related to the data collected or processed through the use of this software. You assume full responsibility for any data-related matters.
+
+This clause is in addition to, and does not supersede, the terms and conditions outlined in the MIT License, which govern the use, modification, and distribution of this Software.

package/README.md

@@ -0,0 +1,90 @@
+# [Guesty Tokenization JS SDK](https://github.com/guestyorg/tokenization-js/wiki)
+
+There are two ways to integrate the SDK:
+
+### Manually include a script tag
+
+Add a script tag to your application `head` or `body`.
+This loads `guestyTokenization` object to the global `window` scope of the browser
+
+```html
+<script src="https://pay.guesty.com/tokenization/v1/init.js"></script>
+```
+
+#### Note: To be PCI-compliant, you must load the SDK directly from https://pay.guesty.com. You cannot include it in a bundle or host it yourself
+
+### Use it as an ES module
+
+Advantages of loading the SDK as a module:
+
+- loads script asynchronously to ensure page rendering isn't blocked
+- returns a Promise to know when script loading is complete
+- resolves to `null` if called in a server environment
+
+## Installation
+
+Use `npm` to install the Guesty Tokenization JS module:
+
+```sh
+npm install @guestyorg/tokenization-js
+```
+
+## Usage
+
+Import the `loadScript` function for asynchronously loading the Guesty Tokenization JS SDK
+
+### loadScript(options?)
+
+- accepts an `options` object to configure script URL and attributes
+- returns a Promise that resolves with `window.guestyTokenization` after the SDK is finished loading
+
+#### options
+
+- `sandbox` - load the SDK in a sandbox mode
+
+```js
+loadScript({ sandbox: true });
+```
+
+This is equivalent to the following script:
+
+```html
+<script
+  src="https://pay.guesty.com/tokenization/v1/init.js"
+  data-env="sandbox"
+></script>
+```
+
+#### Async/Await
+
+```js
+import { loadScript } from '@guesty/tokenization-js';
+
+try {
+  const guestyTokenization = await loadScript();
+  // Guesty Tokenization JS SDK is loaded and ready to use
+} catch (error) {
+  console.error('Failed to load the Guesty Tokenization JS SDK script', error);
+}
+```
+
+#### Promises
+
+```js
+import { loadScript } from '@guesty/tokenization-js';
+
+loadScript()
+  .then((guestyTokenization) => {
+    // Guesty Tokenization JS SDK is loaded and ready to use
+  })
+  .catch((error) => {
+    console.error(
+      'Failed to load the Guesty Tokenization JS SDK script',
+      error
+    );
+  });
+```
+
+## TypeScript Support
+
+This package includes TypeScript type definitions for the Guesty Tokenization JS SDK. This includes types for the `window.guestyTokenization` namespace. We support projects using TypeScript versions >= 3.8.

package/index.js

@@ -0,0 +1,5 @@
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./lib/cjs/guesty-tokenization-js.min.js');
+} else {
+  module.exports = require('./lib/cjs/guesty-tokenization-js.js');
+}

package/lib/cjs/guesty-tokenization-js.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var findScriptElement = function (url) {
+    return document.querySelector("script[src=\"".concat(url, "\"]"));
+};
+var injectScriptElement = function (_a) {
+    var url = _a.url, sandbox = _a.sandbox, onSuccess = _a.onSuccess, onError = _a.onError;
+    var script = document.createElement('script');
+    script.src = url;
+    script.async = true;
+    script.onerror = onError;
+    script.onload = onSuccess;
+    if (sandbox) {
+        script.setAttribute('data-env', 'sandbox');
+    }
+    document.head.insertBefore(script, document.head.firstElementChild);
+};
+
+var NAMESPACE = 'guestyTokenization';
+var SCRIPT_URL = 'https://pay.guesty.com/tokenization/v1/init.js';
+
+var loadScript = function (options) {
+    if (options === void 0) { options = {}; }
+    if (typeof window === 'undefined') {
+        return Promise.resolve(null);
+    }
+    var existingScript = findScriptElement(SCRIPT_URL);
+    var existingNamespace = window[NAMESPACE];
+    if (existingScript) {
+        if (existingNamespace) {
+            return Promise.resolve(existingNamespace);
+        }
+        existingScript.remove();
+    }
+    return new Promise(function (resolve, reject) {
+        var _a;
+        injectScriptElement({
+            url: SCRIPT_URL,
+            sandbox: (_a = options.sandbox) !== null && _a !== void 0 ? _a : false,
+            onSuccess: function () {
+                var newNamespace = window[NAMESPACE];
+                if (newNamespace) {
+                    resolve(newNamespace);
+                }
+                else {
+                    reject(new Error('Guesty Tokenization is not available'));
+                }
+            },
+            onError: function () {
+                reject(new Error("The script ".concat(SCRIPT_URL, " failed to load")));
+            },
+        });
+    });
+};
+
+exports.loadScript = loadScript;

package/lib/cjs/guesty-tokenization-js.min.js

@@ -0,0 +1 @@
+"use strict";var e="guestyTokenization",o="https://pay.guesty.com/tokenization/v1/init.js";exports.loadScript=function(n){if(void 0===n&&(n={}),"undefined"==typeof window)return Promise.resolve(null);var r,t=(r=o,document.querySelector('script[src="'.concat(r,'"]'))),i=window[e];if(t){if(i)return Promise.resolve(i);t.remove()}return new Promise((function(r,t){var i;!function(e){var o=e.url,n=e.sandbox,r=e.onSuccess,t=e.onError,i=document.createElement("script");i.src=o,i.async=!0,i.onerror=t,i.onload=r,n&&i.setAttribute("data-env","sandbox"),document.head.insertBefore(i,document.head.firstElementChild)}({url:o,sandbox:null!==(i=n.sandbox)&&void 0!==i&&i,onSuccess:function(){var o=window[e];o?r(o):t(new Error("Guesty Tokenization is not available"))},onError:function(){t(new Error("The script ".concat(o," failed to load")))}})}))};

package/lib/cjs/src/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const NAMESPACE = "guestyTokenization";
+export declare const SCRIPT_URL = "https://pay.guesty.com/tokenization/v1/init.js";
+//# sourceMappingURL=constants.d.ts.map

package/lib/cjs/src/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,uBAAuB,CAAC;AAC9C,eAAO,MAAM,UAAU,mDAAmD,CAAC"}

package/lib/cjs/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './loadScript';
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/lib/cjs/src/loadScript.d.ts

@@ -0,0 +1,3 @@
+import { LoadScriptOptions } from '../types';
+export declare const loadScript: (options?: LoadScriptOptions) => Promise<unknown>;
+//# sourceMappingURL=loadScript.d.ts.map

package/lib/cjs/src/loadScript.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadScript.d.ts","sourceRoot":"","sources":["../../src/loadScript.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,UAAU,aAAa,iBAAiB,qBAgCpD,CAAC"}

package/lib/cjs/src/utils.d.ts

@@ -0,0 +1,9 @@
+export declare const findScriptElement: (url: string) => Element | null;
+export interface InjectScriptElementOptions {
+    url: string;
+    sandbox: boolean;
+    onSuccess: () => void;
+    onError: () => void;
+}
+export declare const injectScriptElement: ({ url, sandbox, onSuccess, onError, }: InjectScriptElementOptions) => void;
+//# sourceMappingURL=utils.d.ts.map

package/lib/cjs/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,QAAS,MAAM,mBAE5C,CAAC;AAEF,MAAM,WAAW,0BAA0B;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,eAAO,MAAM,mBAAmB,0CAK7B,0BAA0B,SAY5B,CAAC"}

package/lib/esm/guesty-tokenization-js.js

@@ -0,0 +1,54 @@
+var findScriptElement = function (url) {
+    return document.querySelector("script[src=\"".concat(url, "\"]"));
+};
+var injectScriptElement = function (_a) {
+    var url = _a.url, sandbox = _a.sandbox, onSuccess = _a.onSuccess, onError = _a.onError;
+    var script = document.createElement('script');
+    script.src = url;
+    script.async = true;
+    script.onerror = onError;
+    script.onload = onSuccess;
+    if (sandbox) {
+        script.setAttribute('data-env', 'sandbox');
+    }
+    document.head.insertBefore(script, document.head.firstElementChild);
+};
+
+var NAMESPACE = 'guestyTokenization';
+var SCRIPT_URL = 'https://pay.guesty.com/tokenization/v1/init.js';
+
+var loadScript = function (options) {
+    if (options === void 0) { options = {}; }
+    if (typeof window === 'undefined') {
+        return Promise.resolve(null);
+    }
+    var existingScript = findScriptElement(SCRIPT_URL);
+    var existingNamespace = window[NAMESPACE];
+    if (existingScript) {
+        if (existingNamespace) {
+            return Promise.resolve(existingNamespace);
+        }
+        existingScript.remove();
+    }
+    return new Promise(function (resolve, reject) {
+        var _a;
+        injectScriptElement({
+            url: SCRIPT_URL,
+            sandbox: (_a = options.sandbox) !== null && _a !== void 0 ? _a : false,
+            onSuccess: function () {
+                var newNamespace = window[NAMESPACE];
+                if (newNamespace) {
+                    resolve(newNamespace);
+                }
+                else {
+                    reject(new Error('Guesty Tokenization is not available'));
+                }
+            },
+            onError: function () {
+                reject(new Error("The script ".concat(SCRIPT_URL, " failed to load")));
+            },
+        });
+    });
+};
+
+export { loadScript };

package/lib/esm/guesty-tokenization-js.min.js

@@ -0,0 +1 @@
+var e="guestyTokenization",n="https://pay.guesty.com/tokenization/v1/init.js",o=function(o){if(void 0===o&&(o={}),"undefined"==typeof window)return Promise.resolve(null);var r,t=(r=n,document.querySelector('script[src="'.concat(r,'"]'))),i=window[e];if(t){if(i)return Promise.resolve(i);t.remove()}return new Promise((function(r,t){var i;!function(e){var n=e.url,o=e.sandbox,r=e.onSuccess,t=e.onError,i=document.createElement("script");i.src=n,i.async=!0,i.onerror=t,i.onload=r,o&&i.setAttribute("data-env","sandbox"),document.head.insertBefore(i,document.head.firstElementChild)}({url:n,sandbox:null!==(i=o.sandbox)&&void 0!==i&&i,onSuccess:function(){var n=window[e];n?r(n):t(new Error("Guesty Tokenization is not available"))},onError:function(){t(new Error("The script ".concat(n," failed to load")))}})}))};export{o as loadScript};

package/lib/esm/src/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const NAMESPACE = "guestyTokenization";
+export declare const SCRIPT_URL = "https://pay.guesty.com/tokenization/v1/init.js";
+//# sourceMappingURL=constants.d.ts.map

package/lib/esm/src/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,uBAAuB,CAAC;AAC9C,eAAO,MAAM,UAAU,mDAAmD,CAAC"}

package/lib/esm/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './loadScript';
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/lib/esm/src/loadScript.d.ts

@@ -0,0 +1,3 @@
+import { LoadScriptOptions } from '../types';
+export declare const loadScript: (options?: LoadScriptOptions) => Promise<unknown>;
+//# sourceMappingURL=loadScript.d.ts.map

package/lib/esm/src/loadScript.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadScript.d.ts","sourceRoot":"","sources":["../../src/loadScript.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,UAAU,aAAa,iBAAiB,qBAgCpD,CAAC"}

package/lib/esm/src/utils.d.ts

@@ -0,0 +1,9 @@
+export declare const findScriptElement: (url: string) => Element | null;
+export interface InjectScriptElementOptions {
+    url: string;
+    sandbox: boolean;
+    onSuccess: () => void;
+    onError: () => void;
+}
+export declare const injectScriptElement: ({ url, sandbox, onSuccess, onError, }: InjectScriptElementOptions) => void;
+//# sourceMappingURL=utils.d.ts.map

package/lib/esm/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,QAAS,MAAM,mBAE5C,CAAC;AAEF,MAAM,WAAW,0BAA0B;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,eAAO,MAAM,mBAAmB,0CAK7B,0BAA0B,SAY5B,CAAC"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@guestyorg/tokenization-js",
+  "version": "1.0.0-0",
+  "description": "Guesty Tokenization SDK loading utility and types",
+  "main": "index.js",
+  "module": "lib/esm/guesty-tokenization-js.js",
+  "types": "types/index.d.ts",
+  "files": [
+    "lib",
+    "types"
+  ],
+  "scripts": {
+    "test": "jest --coverage --color",
+    "clean": "rm -rf ./lib",
+    "build": "yarn clean && rollup --config --bundleConfigAsCjs",
+    "lint": "eslint . --fix",
+    "prettier": "prettier **/*.{js|ts}",
+    "release": "np --no-publish"
+  },
+  "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.3",
+    "@rollup/plugin-typescript": "^11.1.2",
+    "@types/jest": "^29.2.4",
+    "@typescript-eslint/eslint-plugin": "^5.45.1",
+    "@typescript-eslint/parser": "^5.45.1",
+    "eslint": "^8.29.0",
+    "eslint-config-airbnb-base": "^14.0.0",
+    "eslint-config-prettier": "^6.0.0",
+    "husky": "^4.2.3",
+    "jest": "^29.3.1",
+    "jest-environment-jsdom": "^29.3.1",
+    "lint-staged": "^10.0.7",
+    "prettier": "^2.8.0",
+    "rollup": "^3.28.1",
+    "ts-jest": "^29.0.3",
+    "typescript": "^4.9.3"
+  },
+  "husky": {
+    "hooks": {
+      "pre-push": "yarn lint",
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,ts,css,json,md}": [
+      "prettier --write",
+      "git add"
+    ],
+    "*.{jsx,js,ts}": [
+      "eslint --fix",
+      "git add"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guestyorg/tokenization-js.git"
+  },
+  "keywords": [],
+  "author": "Guesty Inc.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/guestyorg/tokenization-js/issues"
+  },
+  "homepage": "https://github.com/guestyorg/tokenization-js/wiki",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,51 @@
+export interface GuestyTokenizationStyles {
+  mobileBreakpoint?: number;
+  fontFamily?: string;
+  fontSizeMd?: number;
+  fontSizeLg?: number;
+  fontWeightRegular?: number;
+  fontWeightBold?: number;
+  colorText?: string;
+  colorTextError?: string;
+  colorBorder?: string;
+  colorBorderError?: string;
+  colorBorderHover?: string;
+  colorPlaceholder?: string;
+  colorBackgroundError?: string;
+  colorBackgroundDisabled?: string;
+}
+
+export interface GuestyTokenizationRenderOptions {
+  containerId: string;
+  providerId: string;
+  amount: number;
+  currency: string;
+  onStatusChange?: (status: boolean) => void;
+  styles?: GuestyTokenizationStyles;
+  lang?: string;
+}
+
+export interface PaymentMethod {
+  _id: string;
+}
+
+export interface GuestyTokenizationNamespace {
+  render: (options: GuestyTokenizationRenderOptions) => Promise<void>;
+  destroy: () => Promise<void>;
+  submit: () => Promise<PaymentMethod>;
+  validate: () => void;
+}
+
+export interface LoadScriptOptions {
+  sandbox?: boolean;
+}
+
+export function loadScript(
+  options?: LoadScriptOptions
+): Promise<GuestyTokenizationNamespace | null>;
+
+declare global {
+  interface Window {
+    guestyTokenization?: GuestyTokenizationNamespace | null;
+  }
+}