@monerium/sdk 2.0.9 → 2.0.12

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [2.0.12](https://github.com/monerium/sdk/compare/v2.0.11...v2.0.12) (2023-02-25)
+
+### Bug Fixes
+
+- replace encodeBase64Url, not available in the downgraded version of crypto-js ([c883b64](https://github.com/monerium/sdk/commit/c883b6422b1d068752a420abce2ce3a14d8a4092))
+
+## [2.0.11](https://github.com/monerium/sdk/compare/v2.0.10...v2.0.11) (2023-02-25)
+
+### Bug Fixes
+
+- crypto-js to 3.1.9-1 because of https://github.com/brix/crypto-js/issues/256 ([00bffd9](https://github.com/monerium/sdk/commit/00bffd9e7e90315f09cee4a8ade60121d1e1b75a))
+
+### Miscellaneous
+
+- remove unnecessary comment ([c8d64ad](https://github.com/monerium/sdk/commit/c8d64adad6157eecd1e2a3faf0bec0a86da74f07))
+
+## [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

package/README.md

@@ -22,17 +22,21 @@ yarn add @monerium/sdk
 - `watch`: Run Vite in watch mode to detect changes to files during development
 - `build`: Run Vite to build a production release distributable
 
-### Getting started
+## 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'
+import { MoneriumClient } from "@monerium/sdk";
 
 const client = new MoneriumClient();
+```
 
-/** Authenticate using client credentials */
+### Authenticate using client credentials
 
+```ts
 await client.auth({
  client_id: "your_client_credentials_uuid"
  client_secret: "your_client_secret"
@@ -40,14 +44,20 @@ await client.auth({
 
 // User is now authenticated, get authentication data
 await client.getAuthContext()
+```
 
-/*************************************/
-/** Or, authenticate using auth flow */
+### 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"
-  redirect_uri: "http://your-webpage.com/monerium-integration"
+  // optional automatic wallet selection:
+  network: "mumbai",
+  chain: "polygon",
+  address: "0xValidAddress72413Fa92980B889A1eCE84dD",
+  signature: "0xValidSignature0df2b6c9e0fc067ab29bdbf322bec30aad7c46dcd97f62498a91ef7795957397e0f49426e000b0f500c347219ddd98dc5080982563055e918031c"
+
 })
 // Redirecting to the Monerium onboarding / Authentication flow.
 window.location.replace(authFlowUrl)

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",
@@ -276,17 +293,17 @@ export declare class MoneriumClient {
   /** The PKCE code verifier */
   codeVerifier?: string;
   bearerProfile?: BearerProfile;
-  clientId?: string;
   constructor(env?: "production" | "sandbox");
   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`
+   * For automatic wallet link, add the following properties: `address`, `signature`, `chain` & `network`
    * @returns string
    */
   getAuthFlowURI(args: PKCERequestArgs): string;
   /**
-   *  @deprecated since v2.0.7, use getAuthFlowURI instead.
+   *  @deprecated since v2.0.7, use {@link getAuthFlowURI} instead.
    */
   pkceRequest: (args: PKCERequestArgs) => string;
   getAuthContext(): Promise<AuthContext>;