@imtbl/sdk 0.28.10 → 0.29.0-alpha.1

package/dist/config.d.ts

@@ -6,17 +6,29 @@ declare class ImmutableConfiguration {
     readonly environment: Environment;
     readonly rateLimitingKey?: string;
     readonly apiKey?: string;
-    readonly clientAppId?: string;
+    readonly publishableKey?: string;
     constructor(options: {
         environment: Environment;
-        rateLimitingKey?: string;
-        apiKey?: string;
-        clientAppId?: string;
     });
 }
+declare const addApiKeyToAxiosHeader: (apiKey: string) => void;
+declare const addPublishableKeyToAxiosHeader: (publishableKey: string) => void;
+declare const addRateLimitingKeyToAxiosHeader: (rateLimitingKey: string) => void;
+type ImmutableConfigurationWithRequireableFields<T> = ImmutableConfiguration & (T extends {
+    apiKey: 'required';
+} ? Required<{
+    apiKey: string;
+}> : {}) & (T extends {
+    publishableKey: 'required';
+} ? Required<{
+    publishableKey: string;
+}> : {});
+type ImmutableConfigurationWithOmitableFields<T> = (T extends {
+    apiKey: 'omit';
+} ? Omit<ImmutableConfigurationWithRequireableFields<T>, 'apiKey'> : ImmutableConfigurationWithRequireableFields<T>);
 interface ModuleConfiguration<T> {
-    baseConfig: ImmutableConfiguration;
+    baseConfig: ImmutableConfigurationWithOmitableFields<T>;
     overrides?: T;
 }
 
-export { Environment, ImmutableConfiguration, ModuleConfiguration };
+export { Environment, ImmutableConfiguration, ModuleConfiguration, addApiKeyToAxiosHeader, addPublishableKeyToAxiosHeader, addRateLimitingKeyToAxiosHeader };

package/dist/config.js

@@ -9,28 +9,29 @@ class ImmutableConfiguration {
     environment;
     rateLimitingKey;
     apiKey;
-    clientAppId;
+    publishableKey;
     constructor(options) {
         this.environment = options.environment;
-        if (options.rateLimitingKey) {
-            this.rateLimitingKey = options.rateLimitingKey;
-            axios.defaults.headers.common['x-api-key'] = this.rateLimitingKey;
-        }
-        if (options.apiKey) {
-            if (!options.apiKey.startsWith('sk_imapik-')) {
-                throw new Error('Invalid API key');
-            }
-            this.apiKey = options.apiKey;
-            axios.defaults.headers.common['x-immutable-api-key'] = this.apiKey;
-        }
-        if (options.clientAppId) {
-            if (!options.clientAppId.startsWith('cai_imapik-')) {
-                throw new Error('Invalid Client App Id');
-            }
-            this.clientAppId = options.clientAppId;
-            axios.defaults.headers.common['x-immutable-client-app-id'] = this.clientAppId;
-        }
     }
 }
+const API_KEY_PREFIX = 'sk_imapik-';
+const PUBLISHABLE_KEY_PREFIX = 'pk_imapik-';
+const PUBLISHABLE_KEY_LENGTH = 30;
+const addApiKeyToAxiosHeader = (apiKey) => {
+    if (!apiKey.startsWith(API_KEY_PREFIX)) {
+        throw new Error('Invalid API key. Create your api key in Immutable developer hub. https://hub.immutable.com');
+    }
+    axios.defaults.headers.common['x-immutable-api-key'] = apiKey;
+};
+const addPublishableKeyToAxiosHeader = (publishableKey) => {
+    if (!publishableKey.startsWith(PUBLISHABLE_KEY_PREFIX) || publishableKey.length !== PUBLISHABLE_KEY_LENGTH) {
+        throw new Error('Invalid Publishable key. Create your Publishable key in Immutable developer hub.'
+            + ' https://hub.immutable.com');
+    }
+    axios.defaults.headers.common['x-immutable-publishable-key'] = publishableKey;
+};
+const addRateLimitingKeyToAxiosHeader = (rateLimitingKey) => {
+    axios.defaults.headers.common['x-api-key'] = rateLimitingKey;
+};
 
-export { Environment, ImmutableConfiguration };
+export { Environment, ImmutableConfiguration, addApiKeyToAxiosHeader, addPublishableKeyToAxiosHeader, addRateLimitingKeyToAxiosHeader };

package/dist/immutablex_client.d.ts

@@ -9742,16 +9742,25 @@ declare class ImmutableConfiguration {
     readonly environment: Environment;
     readonly rateLimitingKey?: string;
     readonly apiKey?: string;
-    readonly clientAppId?: string;
+    readonly publishableKey?: string;
     constructor(options: {
         environment: Environment;
-        rateLimitingKey?: string;
-        apiKey?: string;
-        clientAppId?: string;
     });
 }
+type ImmutableConfigurationWithRequireableFields<T> = ImmutableConfiguration & (T extends {
+    apiKey: 'required';
+} ? Required<{
+    apiKey: string;
+}> : {}) & (T extends {
+    publishableKey: 'required';
+} ? Required<{
+    publishableKey: string;
+}> : {});
+type ImmutableConfigurationWithOmitableFields<T> = (T extends {
+    apiKey: 'omit';
+} ? Omit<ImmutableConfigurationWithRequireableFields<T>, 'apiKey'> : ImmutableConfigurationWithRequireableFields<T>);
 interface ModuleConfiguration<T> {
-    baseConfig: ImmutableConfiguration;
+    baseConfig: ImmutableConfigurationWithOmitableFields<T>;
     overrides?: T;
 }
 

package/dist/immutablex_client.js

@@ -17,7 +17,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.28.10',
+    sdkVersion: 'ts-immutable-sdk-0.29.0-alpha.1',
 });
 /**
  * Sets `sdkVersion` at the time of build