@monerium/sdk 2.0.7 → 2.0.10

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [2.0.10](https://github.com/monerium/sdk/compare/v2.0.9...v2.0.10) (2023-02-16)
+
+### Miscellaneous
+
+- define properties for automatic wallet link on auth flow ([#19](https://github.com/monerium/sdk/issues/19)) ([3bf845c](https://github.com/monerium/sdk/commit/3bf845cac60bb8a2d5ee7a9dbfa56c76f6996178))
+
+## [2.0.9](https://github.com/monerium/sdk/compare/v2.0.8...v2.0.9) (2023-02-06)
+
+### Bug Fixes
+
+- build files ([1b0f99f](https://github.com/monerium/sdk/commit/1b0f99fcc6635de69b62de72198f22daa2d36b10))
+
+## [2.0.8](https://github.com/monerium/sdk/compare/v2.0.7...v2.0.8) (2023-02-06)
+
+### Bug Fixes
+
+- move dts-bundle config to configs and update paths ([2de558f](https://github.com/monerium/sdk/commit/2de558f6c69b5c72d77ee1065e326d05072ad16c))
+
+### Miscellaneous
+
+- add getting started to README and document pckeRequest ([8cf68dd](https://github.com/monerium/sdk/commit/8cf68dd7fcf28b098192ca0da8dfdb3878a3e449))
+- deprecate pkceRequest for getAuthFlowURI ([4f33174](https://github.com/monerium/sdk/commit/4f33174abbdbc0758b61efc4161e4fc234524ca5))
+
 ## [2.0.7](https://github.com/monerium/sdk/compare/v2.0.6...v2.0.7) (2023-01-11)
 
 ### Miscellaneous

package/README.md

@@ -1,11 +1,11 @@
 # @monerium/sdk
 
-Everything you need to interact with the Monerium API - an electronic money issuer.
+Everything you need to interact with the [Monerium API](https://monerium.dev/api-docs) - an electronic money issuer.
 
 _This package is in development. Please make sure to check if any future updates contain commits
 that may change the behavior of your application before you upgrade._
 
-[Documentation](https://monerium.github.io/sdk/)
+[SDK Documentation](https://monerium.github.io/sdk/)
 
 [Code coverage](https://monerium.github.io/sdk/coverage)
 
@@ -16,16 +16,70 @@ that may change the behavior of your application before you upgrade._
 yarn add @monerium/sdk
 ```
 
-## Developing
-
-We are using [commitlint](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional) to enforce that developers format the commit messages according to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
-
 ## Usage
 
 - `start`: Run Vite in host mode for a local development environment (not included in production build)
 - `watch`: Run Vite in watch mode to detect changes to files during development
 - `build`: Run Vite to build a production release distributable
 
+## Getting started
+
+If you are new here, we recommend starting in the [Developer Portal](https://monerium.dev/docs/welcome). There you will more about `client_id`'s and ways of authenticating.
+
+### Import the SDK and initialize a client
+
+```ts
+import { MoneriumClient } from "@monerium/sdk";
+
+const client = new MoneriumClient();
+```
+
+### Authenticate using client credentials
+
+```ts
+await client.auth({
+ client_id: "your_client_credentials_uuid"
+ client_secret: "your_client_secret"
+})
+
+// User is now authenticated, get authentication data
+await client.getAuthContext()
+```
+
+### Authenticate using auth flow
+
+```ts
+// Construct the authFlowUrl for your application and redirect your customer.
+let authFlowUrl = client.getAuthFlowURI({
+  client_id: "your_client_authflow_uuid"
+  // optional automatic wallet selection:
+  network: "mumbai",
+  chain: "polygon",
+  address: "0xValidAddress72413Fa92980B889A1eCE84dD",
+  signature: "0xValidSignature0df2b6c9e0fc067ab29bdbf322bec30aad7c46dcd97f62498a91ef7795957397e0f49426e000b0f500c347219ddd98dc5080982563055e918031c"
+
+})
+// Redirecting to the Monerium onboarding / Authentication flow.
+window.location.replace(authFlowUrl)
+
+// As the final step of the flow, the customer will be routed back to the `redirect_uri` with a `code` parameter attached to it.
+// i.e. http://your-webpage.com/monerium-integration?code=1234abcd
+
+await client.auth({
+ client_id: "your_client_authflow_uuid",
+ code: new URLSearchParams(window.location.search).get('code'),
+ code_verifier: client.code_verifier,
+ redirect_url: "http://your-webpage.com/monerium-integration"
+})
+
+// User is now authenticated, get authentication data
+await client.getAuthContext()
+```
+
+## Developing
+
+We are using [commitlint](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional) to enforce that developers format the commit messages according to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.
+
 ## Publishing
 
 When changes are merged to the `main` branch that follows the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard, [release-please](https://github.com/googleapis/release-please) workflow creates a pull request, preparing for the next release. If kept open, the following commits will also be added to the PR. Merging that PR will create a new release, a workflow will publish it on NPM and tag it on Github.

package/dist/index.d.ts

@@ -48,19 +48,36 @@ export interface ClientCredentials {
   client_secret: string;
   scope?: string;
 }
+/**
+ * @returns A {@link PKCERequest} object with properties omitted that are automatically computed in by the SDK.
+ */
 export type PKCERequestArgs = Omit<
   PKCERequest,
   "code_challenge" | "code_challenge_method" | "response_type"
 >;
 export type PKCERequest = {
+  /** the authentication flow client id of the application */
   client_id: string;
+  /** the code challenge automatically generated by the SDK */
   code_challenge: string;
-  code_challenge_method: string;
-  response_type: string;
+  /** the code challenge method for the authentication flow , handled by the SDK  */
+  code_challenge_method: "S256";
+  /** the response type of the authentication flow, handled by the SDK */
+  response_type: "code";
+  /** the state of the application */
   state?: string;
+  /** the redirect uri of the application */
   redirect_uri?: string;
+  /** the scope of the application */
   scope?: string;
+  /** the address of the wallet to automatically link */
   address?: string;
+  /** the signature of the wallet to automatically link */
+  signature?: string;
+  /** the network of the wallet to automatically link */
+  network?: Network;
+  /** the chain of the wallet to automatically link */
+  chain?: Chain;
 };
 declare enum Method {
   password = "password",
@@ -271,21 +288,6 @@ export interface LinkAddress {
   signature: string;
   accounts: CurrencyAccounts[];
 }
-/**
- * How to authenticate
- * ```ts
- *
- * import { MoneriumClient } from '@monerium/sdk'
- *
- * const client = new MoneriumClient();
- *
- * // Start by authenticating
- * await client.auth({
- *  client_id: "your_client_id"
- *  client_secret: "your_client_secret"
- * })
- * ```
- * */
 export declare class MoneriumClient {
   #private;
   /** The PKCE code verifier */
@@ -295,17 +297,15 @@ export declare class MoneriumClient {
   auth(args: AuthArgs): Promise<void>;
   /**
    * Construct the url to the authorization code flow,
-   * the code verifier is needed afterwards to obtain an access token and is therefore stored in this.codeVerifier
-   *
-   * ```
-   * let authFlowUrl = client.pkceRequest({
-   *  client_id:
-   *  redirect_uri:
-   * })
-   * ```
+   * the code verifier is needed afterwards to obtain an access token and is therefore stored in `this.codeVerifier`
+   * For automatic wallet link, add the following properties: `address`, `signature`, `chain` & `network`
    * @returns string
    */
-  pkceRequest(args: PKCERequestArgs): string;
+  getAuthFlowURI(args: PKCERequestArgs): string;
+  /**
+   *  @deprecated since v2.0.7, use {@link getAuthFlowURI} instead.
+   */
+  pkceRequest: (args: PKCERequestArgs) => string;
   getAuthContext(): Promise<AuthContext>;
   /**
    * @param {string} profileId - the id of the profile to fetch.