Merge pull request #35 from moneytree/2.0.0-beta

SDK version 2.0.0-beta

Author: mt-max

README.md

@@ -1,119 +1,5 @@
 # Moneytree Link JavaScript SDK
 
-This is a library for browser client to help you integrate Moneytree tools such as My Account and the Vault without having to do it yourself.
+This is a library for browser client to help you integrate Moneytree tools such as My Account and the Vault without having to do worry about the complex configurations.
 
-## Installation
-
-### Browser based
-
-Include the script tag
-
-```html
-<script
-  type="text/javascript"
-  src="https://cdn.jsdelivr.net/npm/@moneytree/mt-link-javascript-sdk@<version>/dist/index.js"
-></script>
-```
-
-Change the `<version>` by the one you need (most likely the latest available).
-You can also replace `<version>` by `latest` to always get the latest published, at your own risk.
-
-You will find the library under `window.mtLinkSdk`.
-
-### CommonJS
-
-Using NPM simply install the library
-
-```shell
-npm install @moneytree/mt-link-javascript-sdk
-```
-
-Then you can use it directly in your code:
-
-```js
-var mtLinkSdk = require('@moneytree/mt-link-javascript-sdk'); // es5
-// or
-import mtLinkSdk from '@moneytree/mt-link-javascript-sdk'; // es-next
-```
-
-The source also include a Typescript definition.
-
-## API
-
-### Inititalising the API
-
-Call the following method with your desired configuration.
-`init(<config>)`
-
-Config properties:
-
-```js
-{
-  clientId, // string; // The id of the application that asks for authorization.
-  responseType, // string; // Tells the authorization server which grant to execute (e.g.: code).
-  scope, // string[]; // A list of permissions that the application requires.
-  redirectUri, // string; // URI to return the user to after authorization is complete.
-  continueTo, // string; // [optional] Parameter appended as `continue` to the `redirectUri`.
-  locale, // string; // [optional] To force the display to a specific language (e.g.: en-AU).
-  state, // string; // [optional] An opaque value, used for security purposes. If this request parameter is set in the request, then it is returned to the application as part of the redirect_uri.
-  isTestEnvironment // boolean; // [optional] If you wanna use the staging or production environment
-}
-```
-
-### Open the page for the user to authorize your application
-
-`mtLinkSdk.authorize(options);`
-You can pass the following options:
-
-- `newTab`: Open in a new browser tab
-  - Values: `true` or `false`
-  - Default: `false`
-- `authPage`: Page to display during unauthenticated redirection
-  - Values: `'login'` or `'signup'`.
-  - Default: `'login'`
-- `email`: To prefill the email field for signup and login
-  - Values: A string
-  - Default: `undefined`
-- `backTo`: Redirect URL for some actions (back, revoke, logout, delete)
-  - Values: A string representing a URL
-  - Default: Current URL
-- `showAuthToggle`: Option to hide the button to toggle between login and signup pages
-  - Values: `false`
-  - Default: `undefined`
-
-### Logout from current session
-
-`mtLinkSdk.logout(options);`
-You can pass the following options:
-
-- `newTab`: Open in a new browser tab
-  - Values: `true` or `false`
-  - Default: `false`
-
-- `backTo`: Redirect back to this url after logout, url must be whitelisted (contact support)
-  - Values: A string representing a URL
-  - Default: `undefined`
-
-### Open the setting page of the user account
-
-`mtLinkSdk.openSettings(options);`
-You can pass the following options:
-
-- `newTab`: Open in a new browser tab
-  - Values: `true` or `false`
-  - Default: `false`
-- `backTo`: Redirect URL for some actions (back, revoke, logout, delete)
-  - Values: A string representing a URL
-  - Default: Current URL
-
-### Open the vault to let the user add credentials
-
-`mtLinkSdk.openVault(options);`
-You can pass the following options:
-
-- `newTab`: Open in a new browser tab
-  - Values: `true` or `false`
-  - Default: `false`
-- `backTo`: Redirect URL for some actions (back, revoke, logout, delete)
-  - Values: A string representing a URL
-  - Default: Current URL
+Read the [documentation](docs/README.md) for more information.

dist/api/authorize.d.ts

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

dist/api/exchange-token.d.ts

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

dist/api/logout.d.ts

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

dist/api/onboard.d.ts

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

dist/api/open-service.d.ts

@@ -0,0 +1,2 @@
+import { StoredOptions, ServiceId, ConfigsOptions } from '../typings';
+export default function openService(storedOptions: StoredOptions, serviceId: ServiceId, options?: ConfigsOptions): void;

dist/api/request-magic-link.d.ts

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

dist/api/token-info.d.ts

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

dist/endpoints.d.ts

@@ -0,0 +1,5 @@
+import { Scopes, InitOptions, ConfigsOptions } 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;