@imtbl/sdk 1.5.3-alpha.5 → 1.5.4-alpha.1

package/dist/index.cjs

@@ -174,7 +174,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.5.3-alpha.5';
+const SDK_VERSION$1 = '1.5.4-alpha.1';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -11289,7 +11289,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.5.3-alpha.5' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.5.4-alpha.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11361,7 +11361,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.3-alpha.5',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.4-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11794,7 +11794,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.5.3-alpha.5',
+    sdkVersion: 'ts-immutable-sdk-1.5.4-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -37448,7 +37448,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.3-alpha.5';
+const SDK_VERSION = '1.5.4-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -42615,7 +42615,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.5.3-alpha.5';
+const SDK_VERSION_MARKER = '1.5.4-alpha.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -46230,28 +46230,34 @@ function validateAndBuildVersion(version) {
     return validatedVersion;
 }
 
-function loadUnresolved(version) {
+// Loads the checkout widgets bundle from the CDN and appends the script to the document head
+function loadUnresolvedBundle(version) {
     if (window === undefined) {
         throw new Error('missing window object: please run Checkout client side');
     }
     if (document === undefined) {
         throw new Error('missing document object: please run Checkout client side');
     }
-    // const scriptId = 'immutable-checkout-widgets-bundle';
+    const scriptId = 'immutable-checkout-widgets-bundle';
     const validVersion = validateAndBuildVersion(version);
     // Prevent the script to be loaded more than once
     // by checking the presence of the script and its version.
-    // const initScript = document.getElementById(scriptId) as HTMLScriptElement;
-    // if (initScript) return { loaded: true, element: initScript };
-    // const tag = document.createElement('script');
-    const cdnUrl = `https://cdn.jsdelivr.net/npm/@imtbl/sdk@${validVersion}/dist/browser/checkout/widgets.js`;
-    // if (useLocalBundle()) cdnUrl = `http://${window.location.host}/lib/js/widgets.js`;
-    // tag.setAttribute('id', scriptId);
-    // tag.setAttribute('data-version', validVersion);
-    // tag.setAttribute('type', 'module');
-    // tag.setAttribute('src', cdnUrl);
-    // document.head.appendChild(tag);
-    return { loaded: false, cdnUrl };
+    const initScript = document.getElementById(scriptId);
+    if (initScript)
+        return { loaded: true, element: initScript };
+    const tag = document.createElement('script');
+    let cdnUrl = `https://cdn.jsdelivr.net/npm/@imtbl/sdk@${validVersion}/dist/browser/checkout/widgets.js`;
+    tag.setAttribute('id', scriptId);
+    tag.setAttribute('data-version', validVersion);
+    tag.setAttribute('src', cdnUrl);
+    document.head.appendChild(tag);
+    return { loaded: false, element: tag };
+}
+// Gets the CDN url for the split checkout widgets bundle
+function getCdnUrl(version) {
+    const validVersion = validateAndBuildVersion(version);
+    let cdnUrl = `https://cdn.jsdelivr.net/npm/@imtbl/sdk@${validVersion}/dist/browser/checkout/widgets-esm.js`;
+    return cdnUrl;
 }
 
 const PUBLISHABLE_KEY_PREFIX = 'pk_imapik-';
@@ -46330,6 +46336,7 @@ const SANDBOX_CONFIGURATION = {
     },
     passport: undefined,
 };
+const WIDGETS_SCRIPT_TIMEOUT = 100;
 // Checkout SDK
 class Checkout {
     readOnlyProviders;
@@ -46359,19 +46366,46 @@ class Checkout {
         const checkout = this;
         // Preload the configurations
         await checkout.config.remote.getConfig();
-        const load = loadUnresolved(init.version);
-        const checkoutWidgetsModule = await import(/* webpackIgnore: true */ load.cdnUrl);
-        const factory = new Promise((resolve, reject) => {
-            try {
+        // Resolves the factory for the esm build of the widgets
+        if (init.useEsModules) {
+            const cdnUrl = getCdnUrl(init.version);
+            // WebpackIgnore comment required to prevent webpack modifying the import statement and
+            // breaking the dynamic import in certain applications integrating checkout
+            const checkoutWidgetsModule = await import(/* webpackIgnore: true */ cdnUrl);
+            const factory = new Promise((resolve, reject) => {
                 if (checkoutWidgetsModule && checkoutWidgetsModule.WidgetsFactory) {
                     resolve(new checkoutWidgetsModule.WidgetsFactory(checkout, init.config));
                 }
                 else {
-                    throw new Error('WidgetsFactory is not found in the imported module.');
+                    reject(new CheckoutError('Unable to resolve the WidgetsFactory from the checkout widgets module', CheckoutErrorType.WIDGETS_SCRIPT_LOAD_ERROR));
+                }
+            });
+            return factory;
+        }
+        // Resolves the factory for the umd build of the widgets
+        const factory = new Promise((resolve, reject) => {
+            function checkForWidgetsBundleLoaded() {
+                if (typeof ImmutableCheckoutWidgets !== 'undefined') {
+                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
+                }
+                else {
+                    // If ImmutableCheckoutWidgets is not defined, wait for set amount of time.
+                    // When time has elapsed, check again if ImmutableCheckoutWidgets is defined.
+                    // Once it's defined, the promise will resolve and setTimeout won't be called again.
+                    setTimeout(checkForWidgetsBundleLoaded, WIDGETS_SCRIPT_TIMEOUT);
                 }
             }
-            catch (error) {
-                reject(error);
+            try {
+                const script = loadUnresolvedBundle(init.version);
+                if (script.loaded && typeof ImmutableCheckoutWidgets !== 'undefined') {
+                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
+                }
+                else {
+                    checkForWidgetsBundleLoaded();
+                }
+            }
+            catch (err) {
+                reject(new CheckoutError('Failed to load widgets script', CheckoutErrorType.WIDGETS_SCRIPT_LOAD_ERROR, { error: err }));
             }
         });
         return factory;

package/dist/index.d.ts

@@ -32213,11 +32213,14 @@ type CheckoutWidgetsConfig = {
 /**
  * Represents the configuration options for instantiating the Checkout Widgets factory.
  * @property {WidgetConfiguration} config - global configuration options for the widgets.
- * @property {SemanticVersion | undefined} version - version of the Checkout widgets bundle (default latest version will be used).
+ * @property {SemanticVersion | undefined} version - version of the Checkout widgets bundle(default latest version will be used).
+ * @property {boolean | undefined} useEsModules - Set to true to use the esm build of the widgets.
  */
 type WidgetsInit = {
     config: WidgetConfiguration;
     version?: SemanticVersion;
+    /** Loads separate parts of the widget script as required for performance improvements. */
+    useEsModules?: boolean;
 };
 
 declare class Checkout {

package/dist/index.js

@@ -152,7 +152,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.5.3-alpha.5';
+const SDK_VERSION$1 = '1.5.4-alpha.1';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -11267,7 +11267,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.5.3-alpha.5' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.5.4-alpha.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11339,7 +11339,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.3-alpha.5',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.4-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11772,7 +11772,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.5.3-alpha.5',
+    sdkVersion: 'ts-immutable-sdk-1.5.4-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -37426,7 +37426,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.3-alpha.5';
+const SDK_VERSION = '1.5.4-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -42593,7 +42593,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.5.3-alpha.5';
+const SDK_VERSION_MARKER = '1.5.4-alpha.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -46208,28 +46208,34 @@ function validateAndBuildVersion(version) {
     return validatedVersion;
 }
 
-function loadUnresolved(version) {
+// Loads the checkout widgets bundle from the CDN and appends the script to the document head
+function loadUnresolvedBundle(version) {
     if (window === undefined) {
         throw new Error('missing window object: please run Checkout client side');
     }
     if (document === undefined) {
         throw new Error('missing document object: please run Checkout client side');
     }
-    // const scriptId = 'immutable-checkout-widgets-bundle';
+    const scriptId = 'immutable-checkout-widgets-bundle';
     const validVersion = validateAndBuildVersion(version);
     // Prevent the script to be loaded more than once
     // by checking the presence of the script and its version.
-    // const initScript = document.getElementById(scriptId) as HTMLScriptElement;
-    // if (initScript) return { loaded: true, element: initScript };
-    // const tag = document.createElement('script');
-    const cdnUrl = `https://cdn.jsdelivr.net/npm/@imtbl/sdk@${validVersion}/dist/browser/checkout/widgets.js`;
-    // if (useLocalBundle()) cdnUrl = `http://${window.location.host}/lib/js/widgets.js`;
-    // tag.setAttribute('id', scriptId);
-    // tag.setAttribute('data-version', validVersion);
-    // tag.setAttribute('type', 'module');
-    // tag.setAttribute('src', cdnUrl);
-    // document.head.appendChild(tag);
-    return { loaded: false, cdnUrl };
+    const initScript = document.getElementById(scriptId);
+    if (initScript)
+        return { loaded: true, element: initScript };
+    const tag = document.createElement('script');
+    let cdnUrl = `https://cdn.jsdelivr.net/npm/@imtbl/sdk@${validVersion}/dist/browser/checkout/widgets.js`;
+    tag.setAttribute('id', scriptId);
+    tag.setAttribute('data-version', validVersion);
+    tag.setAttribute('src', cdnUrl);
+    document.head.appendChild(tag);
+    return { loaded: false, element: tag };
+}
+// Gets the CDN url for the split checkout widgets bundle
+function getCdnUrl(version) {
+    const validVersion = validateAndBuildVersion(version);
+    let cdnUrl = `https://cdn.jsdelivr.net/npm/@imtbl/sdk@${validVersion}/dist/browser/checkout/widgets-esm.js`;
+    return cdnUrl;
 }
 
 const PUBLISHABLE_KEY_PREFIX = 'pk_imapik-';
@@ -46308,6 +46314,7 @@ const SANDBOX_CONFIGURATION = {
     },
     passport: undefined,
 };
+const WIDGETS_SCRIPT_TIMEOUT = 100;
 // Checkout SDK
 class Checkout {
     readOnlyProviders;
@@ -46337,19 +46344,46 @@ class Checkout {
         const checkout = this;
         // Preload the configurations
         await checkout.config.remote.getConfig();
-        const load = loadUnresolved(init.version);
-        const checkoutWidgetsModule = await import(/* webpackIgnore: true */ load.cdnUrl);
-        const factory = new Promise((resolve, reject) => {
-            try {
+        // Resolves the factory for the esm build of the widgets
+        if (init.useEsModules) {
+            const cdnUrl = getCdnUrl(init.version);
+            // WebpackIgnore comment required to prevent webpack modifying the import statement and
+            // breaking the dynamic import in certain applications integrating checkout
+            const checkoutWidgetsModule = await import(/* webpackIgnore: true */ cdnUrl);
+            const factory = new Promise((resolve, reject) => {
                 if (checkoutWidgetsModule && checkoutWidgetsModule.WidgetsFactory) {
                     resolve(new checkoutWidgetsModule.WidgetsFactory(checkout, init.config));
                 }
                 else {
-                    throw new Error('WidgetsFactory is not found in the imported module.');
+                    reject(new CheckoutError('Unable to resolve the WidgetsFactory from the checkout widgets module', CheckoutErrorType.WIDGETS_SCRIPT_LOAD_ERROR));
+                }
+            });
+            return factory;
+        }
+        // Resolves the factory for the umd build of the widgets
+        const factory = new Promise((resolve, reject) => {
+            function checkForWidgetsBundleLoaded() {
+                if (typeof ImmutableCheckoutWidgets !== 'undefined') {
+                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
+                }
+                else {
+                    // If ImmutableCheckoutWidgets is not defined, wait for set amount of time.
+                    // When time has elapsed, check again if ImmutableCheckoutWidgets is defined.
+                    // Once it's defined, the promise will resolve and setTimeout won't be called again.
+                    setTimeout(checkForWidgetsBundleLoaded, WIDGETS_SCRIPT_TIMEOUT);
                 }
             }
-            catch (error) {
-                reject(error);
+            try {
+                const script = loadUnresolvedBundle(init.version);
+                if (script.loaded && typeof ImmutableCheckoutWidgets !== 'undefined') {
+                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
+                }
+                else {
+                    checkForWidgetsBundleLoaded();
+                }
+            }
+            catch (err) {
+                reject(new CheckoutError('Failed to load widgets script', CheckoutErrorType.WIDGETS_SCRIPT_LOAD_ERROR, { error: err }));
             }
         });
         return factory;

package/dist/orderbook.js

@@ -131,7 +131,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.3-alpha.5';
+const SDK_VERSION = '1.5.4-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';

package/dist/passport.js

@@ -9138,7 +9138,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.5.3-alpha.5' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.5.4-alpha.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -9317,7 +9317,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.3-alpha.5';
+const SDK_VERSION = '1.5.4-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -9529,7 +9529,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.5.3-alpha.5',
+    sdkVersion: 'ts-immutable-sdk-1.5.4-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/dist/x.js

@@ -136,7 +136,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.3-alpha.5';
+const SDK_VERSION = '1.5.4-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -327,7 +327,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.5.3-alpha.5',
+    sdkVersion: 'ts-immutable-sdk-1.5.4-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "1.5.3-alpha.5",
+  "version": "1.5.4-alpha.1",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",