Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,37 @@
## [4.0.0](https://github.com/moneytree/mt-link-javascript-sdk/compare/3.2.1...4.0.0) (2023-10-06)

### New Features

* feat(sdk) remove `pkce` option becuase all OAuth flows must use PKCE ([2234e0e](https://github.com/moneytree/mt-link-javascript-sdk/commit/2234e0e))
* feat(sdk) return the full token from `exchangeToken` ([5131f12](https://github.com/moneytree/mt-link-javascript-sdk/commit/5131f12))

### Sample App improvements

* fix(sample) fix formatting errors in html ([fc70d52](https://github.com/moneytree/mt-link-javascript-sdk/commit/fc70d52))
* fix(sample) use new service options after re-write in 3.2.1 ([bf9b14a](https://github.com/moneytree/mt-link-javascript-sdk/commit/bf9b14a))
* refactor(sample): inline variable, use staging, remove useless await ([04c119b](https://github.com/moneytree/mt-link-javascript-sdk/commit/04c119b))

### Documentation improvements

* doc(sample) update sample to use new exchangeToken type ([0e68876](https://github.com/moneytree/mt-link-javascript-sdk/commit/0e68876))
* doc(sdk) add TSDoc comments to public API ([f530830](https://github.com/moneytree/mt-link-javascript-sdk/commit/f530830))
* doc(sdk) fix typos and inconsistencies ([a926047](https://github.com/moneytree/mt-link-javascript-sdk/commit/a926047))
* doc(sdk) replace markdown API doc with links typedoc ([b18603d](https://github.com/moneytree/mt-link-javascript-sdk/commit/b18603d))
* doc(sdk) update documentation for exchangeCode function ([40e7cb4](https://github.com/moneytree/mt-link-javascript-sdk/commit/40e7cb4))
* doc(sdk) update readme with badge maintainer instructions ([7fd3f27](https://github.com/moneytree/mt-link-javascript-sdk/commit/7fd3f27))
* docs(sdk) fix typos ([89f69cd](https://github.com/moneytree/mt-link-javascript-sdk/commit/89f69cd))

### Build improvements

* build(all) add cspell ([a3660a8](https://github.com/moneytree/mt-link-javascript-sdk/commit/a3660a8))
* build(all) upgrade node from 12 -> 16 ([8c62758](https://github.com/moneytree/mt-link-javascript-sdk/commit/8c62758))
* build(all) upgrade node from 16 -> 18 ([c3b62a7](https://github.com/moneytree/mt-link-javascript-sdk/commit/c3b62a7)), closes [/nodejs.org/en/blog/release/v17.0.0#openssl-3-0](https://github.com//nodejs.org/en/blog/release/v17.0.0/issues/openssl-3-0) [/github.com/webpack/webpack/issues/14532#issuecomment-947513562](https://github.com//github.com/webpack/webpack/issues/14532/issues/issuecomment-947513562)
* build(all) upgrade typescript to 4.9.5 ([ab74095](https://github.com/moneytree/mt-link-javascript-sdk/commit/ab74095))
* build(all) add codeowners ([fd73d63](https://github.com/moneytree/mt-link-javascript-sdk/commit/fd73d63))
* build(all) add codeowners (like, really) ([7fea9d9](https://github.com/moneytree/mt-link-javascript-sdk/commit/7fea9d9))
* build(all) setup prettier formatting in pre-commit hook ([3f9ea23](https://github.com/moneytree/mt-link-javascript-sdk/commit/3f9ea23))
* build(doc) add typedoc ([a804fef](https://github.com/moneytree/mt-link-javascript-sdk/commit/a804fef))

## [3.2.1](https://github.com/moneytree/mt-link-javascript-sdk/compare/3.2.0...3.2.1) (2023-08-24)


Expand Down Expand Up @@ -144,6 +178,3 @@ one via the APIs' options parameter if you need one.
### Features

* creating a JS SDK ([333cf8c](https://github.com/moneytree/mt-link-javascript-sdk/commit/333cf8c36f7a8299c2bccf441454b04d31e7d907))



2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions dist/typings.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,17 @@ export type Scopes = string | string[];
interface AuthorizeConfigsOptions {
forceLogout?: boolean;
}
interface OAuthSharedParams {
export interface OAuthSharedParams {
state?: string;
redirectUri?: string;
}
export interface AuthorizeOptions extends OAuthSharedParams, ConfigsOptions, AuthorizeConfigsOptions {
scopes?: Scopes;
codeChallenge?: string;
pkce?: boolean;
}
export type AuthorizeUrlOptions = Omit<AuthorizeOptions, 'isNewTab'>;
export type Mode = 'production' | 'staging' | 'develop' | 'local';
export type InitOptions = Omit<Omit<Omit<AuthorizeOptions, 'forceLogout'>, 'codeChallenge'>, 'pkce'> & PrivateParams & {
export type InitOptions = Omit<Omit<AuthorizeOptions, 'forceLogout'>, 'codeChallenge'> & PrivateParams & {
mode?: Mode;
locale?: string;
};
Expand Down
20 changes: 10 additions & 10 deletions docs/types/assets/highlight.css
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
:root {
--light-hl-0: #001080;
--dark-hl-0: #9CDCFE;
--light-hl-0: #795E26;
--dark-hl-0: #DCDCAA;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #795E26;
--dark-hl-2: #DCDCAA;
--light-hl-3: #A31515;
--dark-hl-3: #CE9178;
--light-hl-4: #0000FF;
--dark-hl-4: #569CD6;
--light-hl-5: #008000;
--dark-hl-5: #6A9955;
--light-hl-2: #A31515;
--dark-hl-2: #CE9178;
--light-hl-3: #008000;
--dark-hl-3: #6A9955;
--light-hl-4: #001080;
--dark-hl-4: #9CDCFE;
--light-hl-5: #0000FF;
--dark-hl-5: #569CD6;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
Expand Down
112 changes: 56 additions & 56 deletions docs/types/classes/MtLinkSdk.html

Large diffs are not rendered by default.

23 changes: 20 additions & 3 deletions docs/types/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,17 @@
<div class="col-content">
<div class="tsd-page-title">
<h2>@moneytree/mt-link-javascript-sdk</h2></div>
<div class="tsd-panel tsd-typography"><a id="md:moneytree-link-javascript-sdk" class="tsd-anchor"></a><h1><a href="#md:moneytree-link-javascript-sdk">Moneytree Link JavaScript SDK</a></h1><p>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.</p>
<p>Read the <a href="docs/README.md">documentation</a> for more information.</p>
<div class="tsd-panel tsd-typography"><a id="md:moneytree-link-javascript-sdk" class="tsd-anchor"></a><h1><a href="#md:moneytree-link-javascript-sdk">Moneytree Link JavaScript SDK</a></h1><p><a href="https://www.npmjs.com/package/@moneytree/mt-link-javascript-sdk"><img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F%40moneytree%2Fmt-link-javascript-sdk&query=%24%5B'dist-tags'%5D%5B'latest'%5D&logo=npm&label=%40moneytree%2Fmt-link-javascript-sdk&color=14BF31" alt="NPM Badge"></a></p>
<p>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.</p>
<a id="md:for-sdk-users" class="tsd-anchor"></a><h2><a href="#md:for-sdk-users">For SDK Users</a></h2><p>Read the <a href="https://moneytree.github.io/mt-link-javascript-sdk/">documentation</a> for more information.</p>
<a id="md:for-sdk-maintainers" class="tsd-anchor"></a><h2><a href="#md:for-sdk-maintainers">For SDK Maintainers</a></h2><pre><code class="language-bash"><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">install</span><br/><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">lint</span><span class="hl-1"> </span><span class="hl-3"># runs eslint</span><br/><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">test</span><span class="hl-1"> </span><span class="hl-3"># runs all the tests</span><br/><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">build</span><span class="hl-1"> </span><span class="hl-3"># bundles the library</span>
</code><button>Copy</button></pre>
<p>There is a minimal sample application in the <code>sample</code> directory.</p>
<a id="md:documentation" class="tsd-anchor"></a><h3><a href="#md:documentation">Documentation</a></h3><pre><code class="language-bash"><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">build:docs</span><span class="hl-1"> </span><span class="hl-3"># bundles the documentation</span><br/><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-2">start:docs</span><span class="hl-1"> </span><span class="hl-3"># Serves the documentation</span>
</code><button>Copy</button></pre>
<p>We use <a href="https://docsify.js.org/">docsify</a> to serve the documentation landing page (<code>docs/README.md</code>) and <a href="https://typedoc.org/">typedoc</a> to generate the API documentation (<code>docs/types</code>).</p>
<a id="md:publishing" class="tsd-anchor"></a><h3><a href="#md:publishing">Publishing</a></h3><pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">version</span><br/><span class="hl-3"># after merging the new version to master</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">login</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">publish</span>
</code><button>Copy</button></pre>
</div></div>
<div class="col-sidebar">
<div class="page-menu">
Expand All @@ -36,7 +45,15 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<ul>
<li>
<ul>
<li><a href="#md:moneytree-link-javascript-sdk"><span>Moneytree <wbr/>Link <wbr/>Java<wbr/>Script SDK</span></a></li></ul></li></ul></div></details></div>
<li><a href="#md:moneytree-link-javascript-sdk"><span>Moneytree <wbr/>Link <wbr/>Java<wbr/>Script SDK</span></a></li>
<li>
<ul>
<li><a href="#md:for-sdk-users"><span>For SDK <wbr/>Users</span></a></li>
<li><a href="#md:for-sdk-maintainers"><span>For SDK <wbr/>Maintainers</span></a></li>
<li>
<ul>
<li><a href="#md:documentation"><span>Documentation</span></a></li>
<li><a href="#md:publishing"><span>Publishing</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>@moneytree/mt-link-javascript-sdk</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".">
Expand Down
Loading