@moneytree/mt-link-javascript-sdk 4.3.0 → 5.0.0

package/README.md

@@ -10,6 +10,8 @@ Read the [documentation](https://moneytree.github.io/mt-link-javascript-sdk/) fo
 
 ## For SDK Maintainers
 
+> Requires [Yarn 4](https://yarnpkg.com/getting-started/install). Run `npm install -g corepack && corepack enable` to activate it.
+
 ```bash
 yarn install
 yarn lint       # runs eslint
@@ -30,9 +32,12 @@ We use [docsify](https://docsify.js.org/) to serve the documentation landing pag
 
 ### Publishing
 
+To release a new version, run the commands below. The build and changelog are generated automatically as part of the version bump, no extra steps required.
+
 ```bash
 npm version (patch|minor|major) # chose the right version bump based on the changes, see https://semver.org
-# after merging the new version to master
+git push origin <branch> --follow-tags
+# after merging the PR to master
 npm login
 npm publish
 ```

package/dist/api/authorize-url.d.ts

@@ -1,2 +1,2 @@
 import { StoredOptions, AuthorizeUrlOptions } from '../typings';
-export default function authorize(storedOptions: StoredOptions, options?: AuthorizeUrlOptions): string;
+export default function authorize(storedOptions: StoredOptions, options?: AuthorizeUrlOptions): Promise<string>;

package/dist/api/authorize.d.ts

@@ -1,2 +1,2 @@
 import { StoredOptions, AuthorizeOptions } from '../typings';
-export default function authorize(storedOptions: StoredOptions, options?: AuthorizeOptions): void;
+export default function authorize(storedOptions: StoredOptions, options?: AuthorizeOptions): Promise<void>;

package/dist/api/logout-url.d.ts

@@ -1,2 +1,2 @@
 import { StoredOptions, LogoutUrlOptions } from '../typings';
-export default function logoutUrl(storedOptions: StoredOptions, options?: LogoutUrlOptions): string;
+export default function logoutUrl(storedOptions: StoredOptions, options?: LogoutUrlOptions): Promise<string>;

package/dist/api/logout.d.ts

@@ -1,2 +1,2 @@
 import { StoredOptions, LogoutOptions } from '../typings';
-export default function logout(storedOptions: StoredOptions, options?: LogoutOptions): void;
+export default function logout(storedOptions: StoredOptions, options?: LogoutOptions): Promise<void>;

package/dist/api/onboard-url.d.ts

@@ -1,2 +1,2 @@
 import { StoredOptions, OnboardUrlOptions } from '../typings';
-export default function onboardUrl(storedOptions: StoredOptions, options?: OnboardUrlOptions): string;
+export default function onboardUrl(storedOptions: StoredOptions, options?: OnboardUrlOptions): Promise<string>;

package/dist/api/onboard.d.ts

@@ -1,2 +1,2 @@
 import { StoredOptions, OnboardOptions } from '../typings';
-export default function onboard(storedOptions: StoredOptions, options?: OnboardOptions): void;
+export default function onboard(storedOptions: StoredOptions, options?: OnboardOptions): Promise<void>;

package/dist/api/open-service-url.d.ts

@@ -1,10 +1,10 @@
-import { StoredOptions, LinkKitOpenServiceUrlOptions, MyAccountOpenServiceUrlOptions, ConfigsOptionsWithoutIsNewTab, VaultOpenServiceUrlViewServiceList, VaultOpenServiceUrlViewServiceConnection, VaultOpenServiceUrlViewConnectionSetting, VaultOpenServiceUrlViewConnectionUpdate, VaultOpenServiceUrlViewConnectionDelete, VaultOpenServiceUrlViewCustomerSupport } from '../typings';
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'link-kit', options?: LinkKitOpenServiceUrlOptions): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'myaccount', options?: MyAccountOpenServiceUrlOptions): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: ConfigsOptionsWithoutIsNewTab): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceList): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceConnection): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionSetting): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionUpdate): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionDelete): string;
-export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewCustomerSupport): string;
+import { StoredOptions, LinkKitOpenServiceUrlOptions, MyAccountOpenServiceUrlOptions, VaultOpenServiceUrlOptions, VaultOpenServiceUrlViewServiceList, VaultOpenServiceUrlViewServiceConnection, VaultOpenServiceUrlViewConnectionSetting, VaultOpenServiceUrlViewConnectionUpdate, VaultOpenServiceUrlViewConnectionDelete, VaultOpenServiceUrlViewCustomerSupport } from '../typings';
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'link-kit', options?: LinkKitOpenServiceUrlOptions): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'myaccount', options?: MyAccountOpenServiceUrlOptions): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlOptions): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceList): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceConnection): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionSetting): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionUpdate): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionDelete): Promise<string>;
+export default function openServiceUrl(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceUrlViewCustomerSupport): Promise<string>;

package/dist/api/open-service.d.ts

@@ -1,10 +1,10 @@
-import { StoredOptions, LinkKitOpenServiceOptions, MyAccountOpenServiceOptions, VaultOpenServiceViewServiceList, VaultOpenServiceViewServiceConnection, VaultOpenServiceViewConnectionSetting, VaultOpenServiceViewConnectionUpdate, VaultOpenServiceViewConnectionDelete, VaultOpenServiceViewCustomerSupport, ConfigsOptions } from '../typings';
-export default function openService(storedOptions: StoredOptions, serviceId: 'link-kit', options?: LinkKitOpenServiceOptions): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'myaccount', options?: MyAccountOpenServiceOptions): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: ConfigsOptions): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewServiceList): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewServiceConnection): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewConnectionSetting): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewConnectionUpdate): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewConnectionDelete): void;
-export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewCustomerSupport): void;
+import { StoredOptions, LinkKitOpenServiceOptions, MyAccountOpenServiceOptions, VaultOpenServiceOptions, VaultOpenServiceViewServiceList, VaultOpenServiceViewServiceConnection, VaultOpenServiceViewConnectionSetting, VaultOpenServiceViewConnectionUpdate, VaultOpenServiceViewConnectionDelete, VaultOpenServiceViewCustomerSupport } from '../typings';
+export default function openService(storedOptions: StoredOptions, serviceId: 'link-kit', options?: LinkKitOpenServiceOptions): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'myaccount', options?: MyAccountOpenServiceOptions): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceOptions): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewServiceList): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewServiceConnection): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewConnectionSetting): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewConnectionUpdate): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewConnectionDelete): Promise<void>;
+export default function openService(storedOptions: StoredOptions, serviceId: 'vault', options?: VaultOpenServiceViewCustomerSupport): Promise<void>;

package/dist/helper.d.ts

@@ -1,8 +1,8 @@
-import { Scopes, InitOptions, ConfigsOptions } from './typings';
+import { Scopes, InitOptions, ConfigsOptions, StoredOptions } from './typings';
 export declare function constructScopes(scopes?: Scopes): string | undefined;
 export declare function getIsTabValue(isNewTab?: boolean): '' | '_self';
-export declare function mergeConfigs(initValues: InitOptions, newValues: ConfigsOptions, ignoreKeys?: string[]): ConfigsOptions;
-export declare function generateConfigs(configs?: ConfigsOptions): string;
+export declare function mergeConfigs(initValues: InitOptions, newValues: ConfigsOptions, ignoreKeys?: string[]): StoredOptions & ConfigsOptions;
+export declare function generateConfigs(configs?: StoredOptions & ConfigsOptions): Promise<string>;
 export declare function generateCodeChallenge(): string;
 export declare function generateSdkHeaderInfo(): {
     'mt-sdk-platform': string;

package/dist/index.d.ts

@@ -1,29 +1,29 @@
-import { Token, StoredOptions, LogoutOptions, InitOptions, AuthorizeOptions, OnboardOptions, ExchangeTokenOptions, RequestLoginLinkOptions, TokenInfo, AuthorizeUrlOptions, LogoutUrlOptions, OnboardUrlOptions, LinkKitOpenServiceUrlOptions, MyAccountOpenServiceUrlOptions, LinkKitOpenServiceOptions, MyAccountOpenServiceOptions, ConfigsOptions, ConfigsOptionsWithoutIsNewTab, VaultOpenServiceUrlViewServiceList, VaultOpenServiceUrlViewServiceConnection, VaultOpenServiceUrlViewConnectionSetting, VaultOpenServiceUrlViewCustomerSupport, VaultOpenServiceViewServiceList, VaultOpenServiceViewServiceConnection, VaultOpenServiceViewConnectionSetting, VaultOpenServiceViewCustomerSupport } from './typings';
+import { Token, StoredOptions, LogoutOptions, InitOptions, AuthorizeOptions, OnboardOptions, ExchangeTokenOptions, RequestLoginLinkOptions, TokenInfo, AuthorizeUrlOptions, LogoutUrlOptions, OnboardUrlOptions, LinkKitOpenServiceUrlOptions, MyAccountOpenServiceUrlOptions, LinkKitOpenServiceOptions, MyAccountOpenServiceOptions, VaultOpenServiceOptions, VaultOpenServiceUrlOptions, VaultOpenServiceUrlViewServiceList, VaultOpenServiceUrlViewServiceConnection, VaultOpenServiceUrlViewConnectionSetting, VaultOpenServiceUrlViewCustomerSupport, VaultOpenServiceViewServiceList, VaultOpenServiceViewServiceConnection, VaultOpenServiceViewConnectionSetting, VaultOpenServiceViewCustomerSupport } from './typings';
 export * from './typings';
 export declare class MtLinkSdk {
     storedOptions: StoredOptions;
     init(clientId: string, options?: InitOptions): void;
     setSamlSubjectId(value: string): void;
-    authorize(options?: AuthorizeOptions): void;
-    authorizeUrl(options?: AuthorizeUrlOptions): string;
-    onboard(options?: OnboardOptions): void;
-    onboardUrl(options?: OnboardUrlOptions): string;
-    logout(options?: LogoutOptions): void;
-    logoutUrl(options?: LogoutUrlOptions): string;
-    openService(serviceId: 'link-kit', options?: LinkKitOpenServiceOptions): void;
-    openService(serviceId: 'myaccount', options?: MyAccountOpenServiceOptions): void;
-    openService(serviceId: 'vault', options?: ConfigsOptions): void;
-    openService(serviceId: 'vault', options?: VaultOpenServiceViewServiceList): void;
-    openService(serviceId: 'vault', options?: VaultOpenServiceViewServiceConnection): void;
-    openService(serviceId: 'vault', options?: VaultOpenServiceViewConnectionSetting): void;
-    openService(serviceId: 'vault', options?: VaultOpenServiceViewCustomerSupport): void;
-    openServiceUrl(serviceId: 'link-kit', options?: LinkKitOpenServiceUrlOptions): string;
-    openServiceUrl(serviceId: 'myaccount', options?: MyAccountOpenServiceUrlOptions): string;
-    openServiceUrl(serviceId: 'vault', options?: ConfigsOptionsWithoutIsNewTab): string;
-    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceList): string;
-    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceConnection): string;
-    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionSetting): string;
-    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewCustomerSupport): string;
+    authorize(options?: AuthorizeOptions): Promise<void>;
+    authorizeUrl(options?: AuthorizeUrlOptions): Promise<string>;
+    onboard(options?: OnboardOptions): Promise<void>;
+    onboardUrl(options?: OnboardUrlOptions): Promise<string>;
+    logout(options?: LogoutOptions): Promise<void>;
+    logoutUrl(options?: LogoutUrlOptions): Promise<string>;
+    openService(serviceId: 'link-kit', options?: LinkKitOpenServiceOptions): Promise<void>;
+    openService(serviceId: 'myaccount', options?: MyAccountOpenServiceOptions): Promise<void>;
+    openService(serviceId: 'vault', options?: VaultOpenServiceOptions): Promise<void>;
+    openService(serviceId: 'vault', options?: VaultOpenServiceViewServiceList): Promise<void>;
+    openService(serviceId: 'vault', options?: VaultOpenServiceViewServiceConnection): Promise<void>;
+    openService(serviceId: 'vault', options?: VaultOpenServiceViewConnectionSetting): Promise<void>;
+    openService(serviceId: 'vault', options?: VaultOpenServiceViewCustomerSupport): Promise<void>;
+    openServiceUrl(serviceId: 'link-kit', options?: LinkKitOpenServiceUrlOptions): Promise<string>;
+    openServiceUrl(serviceId: 'myaccount', options?: MyAccountOpenServiceUrlOptions): Promise<string>;
+    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlOptions): Promise<string>;
+    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceList): Promise<string>;
+    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewServiceConnection): Promise<string>;
+    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewConnectionSetting): Promise<string>;
+    openServiceUrl(serviceId: 'vault', options?: VaultOpenServiceUrlViewCustomerSupport): Promise<string>;
     requestLoginLink(options?: RequestLoginLinkOptions): Promise<void>;
     exchangeToken(options?: ExchangeTokenOptions): Promise<Token>;
     tokenInfo(token: string): Promise<TokenInfo>;