@imtbl/sdk 1.7.1 → 1.7.3-alpha.1

package/dist/index.cjs

@@ -142,7 +142,7 @@ const storeDetail$1 = (key, value) => {
     };
     setItem$1(Store$1.RUNTIME, RUNTIME_DETAILS$1);
 };
-const getDetail$1 = (key) => {
+const getDetail$1$1 = (key) => {
     // Handle the scenario where detail is a falsy value
     if (RUNTIME_DETAILS$1[key] === undefined) {
         return undefined;
@@ -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.7.1';
+const SDK_VERSION$1 = '1.7.3-alpha.1';
 const getReferrer$1 = () => {
     if (isNode$1()) {
         return '';
@@ -217,7 +217,7 @@ const initialise$2 = async () => {
     initialised$1 = true;
     try {
         const runtimeDetails = flattenProperties$1(getRuntimeDetails$1());
-        const existingRuntimeId = getDetail$1(Detail$1.RUNTIME_ID);
+        const existingRuntimeId = getDetail$1$1(Detail$1.RUNTIME_ID);
         const body = {
             version: 1,
             data: {
@@ -370,6 +370,7 @@ const setPublishableApiKeyFn$1 = (publishableApiKey) => {
     storeDetail$1(Detail$1.PUBLISHABLE_API_KEY, publishableApiKey);
 };
 const setPublishableApiKey = errorBoundary$1(getGlobalisedValue$2('setPublishableApiKey', setPublishableApiKeyFn$1));
+const getDetail = errorBoundary$1(getGlobalisedValue$2('getDetail', getDetail$1$1));
 
 var Environment$1;
 (function (Environment) {
@@ -8440,6 +8441,85 @@ class NftOwnersApi extends BaseAPI$2 {
  */
 const NftsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Create a mint request to mint a set of NFTs for a given collection
+         * @summary Mint NFTs
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {CreateMintRequestRequest} createMintRequestRequest the request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createMintRequest: async (contractAddress, chainName, createMintRequestRequest, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists$2('createMintRequest', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$2('createMintRequest', 'chainName', chainName);
+            // verify required parameter 'createMintRequestRequest' is not null or undefined
+            assertParamExists$2('createMintRequest', 'createMintRequestRequest', createMintRequestRequest);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests`
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$2);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ImmutableApiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-immutable-api-key", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams$2(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = serializeDataIfNeeded$2(createMintRequestRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString$2(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieve the status of a mint request identified by its reference_id
+         * @summary Mint NFTs
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {string} referenceId The ID of the mint request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMintRequest: async (contractAddress, chainName, referenceId, options = {}) => {
+            // verify required parameter 'contractAddress' is not null or undefined
+            assertParamExists$2('getMintRequest', 'contractAddress', contractAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists$2('getMintRequest', 'chainName', chainName);
+            // verify required parameter 'referenceId' is not null or undefined
+            assertParamExists$2('getMintRequest', 'referenceId', referenceId);
+            const localVarPath = `/v1/chains/{chain_name}/collections/{contract_address}/nfts/mint-requests/{reference_id}`
+                .replace(`{${"contract_address"}}`, encodeURIComponent(String(contractAddress)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)))
+                .replace(`{${"reference_id"}}`, encodeURIComponent(String(referenceId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL$2);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ImmutableApiKey required
+            await setApiKeyToObject(localVarHeaderParameter, "x-immutable-api-key", configuration);
+            setSearchParams$2(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString$2(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get NFT by token ID
          * @summary Get NFT by token ID
@@ -8625,6 +8705,32 @@ const NftsApiAxiosParamCreator = function (configuration) {
 const NftsApiFp = function (configuration) {
     const localVarAxiosParamCreator = NftsApiAxiosParamCreator(configuration);
     return {
+        /**
+         * Create a mint request to mint a set of NFTs for a given collection
+         * @summary Mint NFTs
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {CreateMintRequestRequest} createMintRequestRequest the request body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createMintRequest(contractAddress, chainName, createMintRequestRequest, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createMintRequest(contractAddress, chainName, createMintRequestRequest, options);
+            return createRequestFunction$2(localVarAxiosArgs, globalAxios$1, BASE_PATH$2, configuration);
+        },
+        /**
+         * Retrieve the status of a mint request identified by its reference_id
+         * @summary Mint NFTs
+         * @param {string} contractAddress The address of contract
+         * @param {string} chainName The name of chain
+         * @param {string} referenceId The ID of the mint request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getMintRequest(contractAddress, chainName, referenceId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getMintRequest(contractAddress, chainName, referenceId, options);
+            return createRequestFunction$2(localVarAxiosArgs, globalAxios$1, BASE_PATH$2, configuration);
+        },
         /**
          * Get NFT by token ID
          * @summary Get NFT by token ID
@@ -8692,6 +8798,26 @@ const NftsApiFp = function (configuration) {
 const NftsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = NftsApiFp(configuration);
     return {
+        /**
+         * Create a mint request to mint a set of NFTs for a given collection
+         * @summary Mint NFTs
+         * @param {NftsApiCreateMintRequestRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createMintRequest(requestParameters, options) {
+            return localVarFp.createMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.createMintRequestRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieve the status of a mint request identified by its reference_id
+         * @summary Mint NFTs
+         * @param {NftsApiGetMintRequestRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMintRequest(requestParameters, options) {
+            return localVarFp.getMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.referenceId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get NFT by token ID
          * @summary Get NFT by token ID
@@ -8741,6 +8867,28 @@ const NftsApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 class NftsApi extends BaseAPI$2 {
+    /**
+     * Create a mint request to mint a set of NFTs for a given collection
+     * @summary Mint NFTs
+     * @param {NftsApiCreateMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    createMintRequest(requestParameters, options) {
+        return NftsApiFp(this.configuration).createMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.createMintRequestRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Retrieve the status of a mint request identified by its reference_id
+     * @summary Mint NFTs
+     * @param {NftsApiGetMintRequestRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NftsApi
+     */
+    getMintRequest(requestParameters, options) {
+        return NftsApiFp(this.configuration).getMintRequest(requestParameters.contractAddress, requestParameters.chainName, requestParameters.referenceId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get NFT by token ID
      * @summary Get NFT by token ID
@@ -11297,7 +11445,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.7.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-1.7.3-alpha.1' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -11369,7 +11517,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.7.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.7.3-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11802,7 +11950,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.7.1',
+    sdkVersion: 'ts-immutable-sdk-1.7.3-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -16536,10 +16684,20 @@ class AuthManager {
             },
         });
     };
-    async login() {
+    /**
+     * login
+     * @param anonymousId Caller can pass an anonymousId if they want to associate their user's identity with immutable's internal instrumentation.
+     */
+    async login(anonymousId) {
         return withPassportError(async () => {
+            const rid = getDetail(Detail$1.RUNTIME_ID);
             const popupWindowFeatures = { width: 410, height: 450 };
             const oidcUser = await this.userManager.signinPopup({
+                extraQueryParams: {
+                    ...(this.userManager.settings?.extraQueryParams ?? {}),
+                    rid: rid || '',
+                    third_party_a_id: anonymousId || '',
+                },
                 popupWindowFeatures,
             });
             return AuthManager.mapOidcUserToDomainModel(oidcUser);
@@ -16559,17 +16717,22 @@ class AuthManager {
     async loginCallback() {
         return withPassportError(async () => this.userManager.signinPopupCallback(), PassportErrorType.AUTHENTICATION_ERROR);
     }
-    async loginWithDeviceFlow() {
+    /**
+     * loginWithDeviceFlow
+     * @param anonymousId Caller can pass an anonymousId if they want to associate their user's identity with immutable's internal instrumentation.
+     */
+    async loginWithDeviceFlow(anonymousId) {
         return withPassportError(async () => {
             const response = await globalAxios$1.post(`${this.config.authenticationDomain}/oauth/device/code`, {
                 client_id: this.config.oidcConfiguration.clientId,
                 scope: this.config.oidcConfiguration.scope,
                 audience: this.config.oidcConfiguration.audience,
             }, formUrlEncodedHeader);
+            const rid = getDetail(Detail$1.RUNTIME_ID);
             return {
                 code: response.data.user_code,
                 deviceCode: response.data.device_code,
-                url: response.data.verification_uri_complete,
+                url: `${response.data.verification_uri_complete}${rid ? `&rid=${rid}` : ''}${anonymousId ? `&third_party_a_id=${anonymousId}` : ''}`,
                 interval: response.data.interval,
             };
         }, PassportErrorType.AUTHENTICATION_ERROR);
@@ -37406,7 +37569,7 @@ const storeDetail = (key, value) => {
     };
     setItem(Store.RUNTIME, RUNTIME_DETAILS);
 };
-const getDetail = (key) => {
+const getDetail$1 = (key) => {
     // Handle the scenario where detail is a falsy value
     if (RUNTIME_DETAILS[key] === undefined) {
         return undefined;
@@ -37438,7 +37601,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.7.1';
+const SDK_VERSION = '1.7.3-alpha.1';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -37481,7 +37644,7 @@ const initialise = async () => {
     initialised = true;
     try {
         const runtimeDetails = flattenProperties(getRuntimeDetails());
-        const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
+        const existingRuntimeId = getDetail$1(Detail.RUNTIME_ID);
         const body = {
             version: 1,
             data: {
@@ -37613,6 +37776,7 @@ const setPublishableApiKeyFn = (publishableApiKey) => {
     storeDetail(Detail.PUBLISHABLE_API_KEY, publishableApiKey);
 };
 errorBoundary(getGlobalisedValue('setPublishableApiKey', setPublishableApiKeyFn));
+errorBoundary(getGlobalisedValue('getDetail', getDetail$1));
 
 var Environment;
 (function (Environment) {
@@ -42605,7 +42769,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.7.1';
+const SDK_VERSION_MARKER = '1.7.3-alpha.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;