@imtbl/sdk 1.5.4 → 1.6.0-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.4';
+const SDK_VERSION$1 = '1.6.0-alpha.1';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -7523,6 +7523,9 @@ const CollectionsApiAxiosParamCreator = function (configuration) {
             const localVarQueryParameter = {};
             // authentication ImmutableApiKey required
             await setApiKeyToObject(localVarHeaderParameter, "x-immutable-api-key", configuration);
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject$1(localVarHeaderParameter, configuration);
             localVarHeaderParameter['Content-Type'] = 'application/json';
             setSearchParams$2(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -8522,13 +8525,14 @@ const NftsApiAxiosParamCreator = function (configuration) {
          * @summary List NFTs by contract address
          * @param {string} contractAddress Contract address
          * @param {string} chainName The name of chain
+         * @param {Array<string>} [tokenId] List of token IDs to filter by
          * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
          * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
          * @param {number} [pageSize] Maximum number of items to return
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listNFTs: async (contractAddress, chainName, fromUpdatedAt, pageCursor, pageSize, options = {}) => {
+        listNFTs: async (contractAddress, chainName, tokenId, fromUpdatedAt, pageCursor, pageSize, options = {}) => {
             // verify required parameter 'contractAddress' is not null or undefined
             assertParamExists$2('listNFTs', 'contractAddress', contractAddress);
             // verify required parameter 'chainName' is not null or undefined
@@ -8545,6 +8549,9 @@ const NftsApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
+            if (tokenId) {
+                localVarQueryParameter['token_id'] = tokenId;
+            }
             if (fromUpdatedAt !== undefined) {
                 localVarQueryParameter['from_updated_at'] = (fromUpdatedAt instanceof Date) ?
                     fromUpdatedAt.toISOString() :
@@ -8650,14 +8657,15 @@ const NftsApiFp = function (configuration) {
          * @summary List NFTs by contract address
          * @param {string} contractAddress Contract address
          * @param {string} chainName The name of chain
+         * @param {Array<string>} [tokenId] List of token IDs to filter by
          * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
          * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
          * @param {number} [pageSize] Maximum number of items to return
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listNFTs(contractAddress, chainName, fromUpdatedAt, pageCursor, pageSize, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listNFTs(contractAddress, chainName, fromUpdatedAt, pageCursor, pageSize, options);
+        async listNFTs(contractAddress, chainName, tokenId, fromUpdatedAt, pageCursor, pageSize, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listNFTs(contractAddress, chainName, tokenId, fromUpdatedAt, pageCursor, pageSize, options);
             return createRequestFunction$2(localVarAxiosArgs, globalAxios$1, BASE_PATH$2, configuration);
         },
         /**
@@ -8712,7 +8720,7 @@ const NftsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         listNFTs(requestParameters, options) {
-            return localVarFp.listNFTs(requestParameters.contractAddress, requestParameters.chainName, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath));
+            return localVarFp.listNFTs(requestParameters.contractAddress, requestParameters.chainName, requestParameters.tokenId, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(axios, basePath));
         },
         /**
          * List NFTs by account address
@@ -8764,7 +8772,7 @@ class NftsApi extends BaseAPI$2 {
      * @memberof NftsApi
      */
     listNFTs(requestParameters, options) {
-        return NftsApiFp(this.configuration).listNFTs(requestParameters.contractAddress, requestParameters.chainName, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
+        return NftsApiFp(this.configuration).listNFTs(requestParameters.contractAddress, requestParameters.chainName, requestParameters.tokenId, requestParameters.fromUpdatedAt, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * List NFTs by account address
@@ -11289,7 +11297,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.5.4' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.6.0-alpha.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11361,7 +11369,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.4',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.6.0-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11794,7 +11802,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.5.4',
+    sdkVersion: 'ts-immutable-sdk-1.6.0-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -18257,7 +18265,7 @@ const transformTypedData = (typedData, chainId) => {
     return transformedTypedData;
 };
 const signTypedDataV4 = async ({ params, method, magicProvider, jsonRpcProvider, relayerClient, guardianClient, }) => guardianClient
-    .withConfirmationScreen({ width: 480, height: 730 })(async () => {
+    .withConfirmationScreen({ width: 480, height: 720 })(async () => {
     const fromAddress = params[0];
     const typedDataParam = params[1];
     if (!fromAddress || !typedDataParam) {
@@ -37448,7 +37456,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.4';
+const SDK_VERSION = '1.6.0-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -42615,7 +42623,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.5.4';
+const SDK_VERSION_MARKER = '1.6.0-alpha.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -46230,7 +46238,8 @@ 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');
     }
@@ -46252,6 +46261,12 @@ function loadUnresolved(version) {
     document.head.appendChild(tag);
     return { loaded: false, element: tag };
 }
+// Gets the CDN url for the split checkout widgets bundle
+function getWidgetsEsmUrl(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-';
 const publishableKeyDomainAllowlist = [
@@ -46359,10 +46374,20 @@ class Checkout {
         const checkout = this;
         // Preload the configurations
         await checkout.config.remote.getConfig();
+        try {
+            const factory = await this.loadEsModules(init.config, init.version);
+            return factory;
+        }
+        catch (err) {
+            throw new CheckoutError('Failed to load widgets script', CheckoutErrorType.WIDGETS_SCRIPT_LOAD_ERROR, { error: err });
+        }
+    }
+    async loadUmdBundle(config, version) {
+        const checkout = this;
         const factory = new Promise((resolve, reject) => {
             function checkForWidgetsBundleLoaded() {
                 if (typeof ImmutableCheckoutWidgets !== 'undefined') {
-                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
+                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, config));
                 }
                 else {
                     // If ImmutableCheckoutWidgets is not defined, wait for set amount of time.
@@ -46372,9 +46397,9 @@ class Checkout {
                 }
             }
             try {
-                const script = loadUnresolved(init.version);
+                const script = loadUnresolvedBundle(version);
                 if (script.loaded && typeof ImmutableCheckoutWidgets !== 'undefined') {
-                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
+                    resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, config));
                 }
                 else {
                     checkForWidgetsBundleLoaded();
@@ -46386,6 +46411,24 @@ class Checkout {
         });
         return factory;
     }
+    async loadEsModules(config, version) {
+        const checkout = this;
+        try {
+            const cdnUrl = getWidgetsEsmUrl(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);
+            if (checkoutWidgetsModule && checkoutWidgetsModule.WidgetsFactory) {
+                return new checkoutWidgetsModule.WidgetsFactory(checkout, config);
+            }
+        }
+        catch (err) {
+            // eslint-disable-next-line no-console
+            console.warn(`Failed to resolve checkout widgets module, falling back to UMD bundle. Error: ${err.message}`);
+        }
+        // Fallback to UMD bundle if esm bundle fails to load
+        return await checkout.loadUmdBundle(config, version);
+    }
     /**
      * Creates a provider using the given parameters.
      * @param {CreateProviderParams} params - The parameters for creating the provider.

package/dist/index.d.ts

@@ -12133,53 +12133,14 @@ interface NFT$1 {
      * @memberof NFT
      */
     'youtube_url': string | null;
-}
-
-/**
- * Immutable zkEVM API
- * Immutable Multi Rollup API
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-/**
- * List of normalized NFT metadata attributes
- * @export
- * @interface NFTMetadataAttributes
- */
-interface NFTMetadataAttributes$1 {
     /**
      * List of NFT Metadata attributes
      * @type {Array<NFTMetadataAttribute>}
-     * @memberof NFTMetadataAttributes
+     * @memberof NFT
      */
     'attributes': Array<NFTMetadataAttribute$1>;
 }
 
-/**
- * Immutable zkEVM API
- * Immutable Multi Rollup API
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-/**
- * @type NFTWithMetadataAttributes
- * A single NFT with metadata attributes
- * @export
- */
-type NFTWithMetadataAttributes$1 = NFT$1 & NFTMetadataAttributes$1;
-
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -12200,10 +12161,10 @@ type NFTWithMetadataAttributes$1 = NFT$1 & NFTMetadataAttributes$1;
 interface GetNFTResult$1 {
     /**
      *
-     * @type {NFTWithMetadataAttributes}
+     * @type {NFT}
      * @memberof GetNFTResult
      */
-    'result': NFTWithMetadataAttributes$1;
+    'result': NFT$1;
 }
 
 /**
@@ -12566,7 +12527,7 @@ interface ListNFTOwnersResult$1 {
  */
 interface ListNFTsResult$1 {
     /**
-     * List of nfts
+     * List of NFTs
      * @type {Array<NFT>}
      * @memberof ListNFTsResult
      */
@@ -13462,6 +13423,12 @@ interface NftsApiListNFTsRequest {
      * @memberof NftsApiListNFTs
      */
     readonly chainName: string;
+    /**
+     * List of token IDs to filter by
+     * @type {Array<string>}
+     * @memberof NftsApiListNFTs
+     */
+    readonly tokenId?: Array<string>;
     /**
      * Datetime to use as the oldest updated timestamp
      * @type {string}
@@ -15400,6 +15367,18 @@ interface GetMintRequestResult {
      * @memberof GetMintRequestResult
      */
     'transaction_hash': string | null;
+    /**
+     * When the mint request was created
+     * @type {string}
+     * @memberof GetMintRequestResult
+     */
+    'created_at': string;
+    /**
+     * When the mint request was last updated
+     * @type {string}
+     * @memberof GetMintRequestResult
+     */
+    'updated_at': string;
     /**
      *
      * @type {MintRequestErrorMessage}
@@ -15510,53 +15489,14 @@ interface NFT {
      * @memberof NFT
      */
     'youtube_url': string | null;
-}
-
-/**
- * Immutable zkEVM API
- * Immutable Multi Rollup API
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-/**
- * List of normalized NFT metadata attributes
- * @export
- * @interface NFTMetadataAttributes
- */
-interface NFTMetadataAttributes {
     /**
      * List of NFT Metadata attributes
      * @type {Array<NFTMetadataAttribute>}
-     * @memberof NFTMetadataAttributes
+     * @memberof NFT
      */
     'attributes': Array<NFTMetadataAttribute>;
 }
 
-/**
- * Immutable zkEVM API
- * Immutable Multi Rollup API
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: support@immutable.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-/**
- * @type NFTWithMetadataAttributes
- * A single NFT with metadata attributes
- * @export
- */
-type NFTWithMetadataAttributes = NFT & NFTMetadataAttributes;
-
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -15577,10 +15517,10 @@ type NFTWithMetadataAttributes = NFT & NFTMetadataAttributes;
 interface GetNFTResult {
     /**
      *
-     * @type {NFTWithMetadataAttributes}
+     * @type {NFT}
      * @memberof GetNFTResult
      */
-    'result': NFTWithMetadataAttributes;
+    'result': NFT;
 }
 
 /**
@@ -16181,6 +16121,12 @@ interface NFTWithBalance {
      * @memberof NFTWithBalance
      */
     'youtube_url': string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof NFTWithBalance
+     */
+    'attributes': Array<NFTMetadataAttribute>;
     /**
      * The balance of NFT in the account
      * @type {string}
@@ -16208,7 +16154,7 @@ interface NFTWithBalance {
  */
 interface ListNFTsByOwnerResult {
     /**
-     * List of nfts by owner
+     * List of NFTs by owner
      * @type {Array<NFTWithBalance>}
      * @memberof ListNFTsByOwnerResult
      */
@@ -16240,7 +16186,7 @@ interface ListNFTsByOwnerResult {
  */
 interface ListNFTsResult {
     /**
-     * List of nfts
+     * List of NFTs
      * @type {Array<NFT>}
      * @memberof ListNFTsResult
      */
@@ -17277,6 +17223,12 @@ interface ListNFTsRequestParams {
      * @memberof ListNFTs
      */
     readonly chainName: string;
+    /**
+     * List of token IDs to filter by
+     * @type {Array<string>}
+     * @memberof ListNFTs
+     */
+    readonly tokenId?: Array<string>;
     /**
      * Datetime to use as the oldest updated timestamp
      * @type {string}
@@ -17504,11 +17456,9 @@ type index_d_NFTContractType = NFTContractType;
 declare const index_d_NFTContractType: typeof NFTContractType;
 type index_d_NFTMetadataAttribute = NFTMetadataAttribute;
 type index_d_NFTMetadataAttributeValue = NFTMetadataAttributeValue;
-type index_d_NFTMetadataAttributes = NFTMetadataAttributes;
 type index_d_NFTOwner = NFTOwner;
 type index_d_NFTSale = NFTSale;
 type index_d_NFTWithBalance = NFTWithBalance;
-type index_d_NFTWithMetadataAttributes = NFTWithMetadataAttributes;
 type index_d_NFTWithOwner = NFTWithOwner;
 type index_d_NativeItemTypeEnum = NativeItemTypeEnum;
 declare const index_d_NativeItemTypeEnum: typeof NativeItemTypeEnum;
@@ -17624,11 +17574,9 @@ declare namespace index_d {
     index_d_NFTContractType as NFTContractType,
     index_d_NFTMetadataAttribute as NFTMetadataAttribute,
     index_d_NFTMetadataAttributeValue as NFTMetadataAttributeValue,
-    index_d_NFTMetadataAttributes as NFTMetadataAttributes,
     index_d_NFTOwner as NFTOwner,
     index_d_NFTSale as NFTSale,
     index_d_NFTWithBalance as NFTWithBalance,
-    index_d_NFTWithMetadataAttributes as NFTWithMetadataAttributes,
     index_d_NFTWithOwner as NFTWithOwner,
     NativeItem$2 as NativeItem,
     index_d_NativeItemTypeEnum as NativeItemTypeEnum,
@@ -32213,7 +32161,7 @@ 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).
  */
 type WidgetsInit = {
     config: WidgetConfiguration;
@@ -32237,6 +32185,8 @@ declare class Checkout {
      * @param {WidgetsInit} init - The initialisation parameters for loading the widgets bundle and applying configuration
      */
     widgets(init: WidgetsInit): Promise<ImmutableCheckoutWidgets.WidgetsFactory>;
+    private loadUmdBundle;
+    private loadEsModules;
     /**
      * Creates a provider using the given parameters.
      * @param {CreateProviderParams} params - The parameters for creating the provider.