@monerium/sdk 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [2.4.0](https://github.com/monerium/sdk/compare/v2.3.0...v2.4.0) (2023-05-09)
+
+
+### Features
+
+* kind always redeem from place order [#87](https://github.com/monerium/sdk/issues/87) ([#88](https://github.com/monerium/sdk/issues/88)) ([850921e](https://github.com/monerium/sdk/commit/850921ed0aa8d36e180ee7c1df439e04f5d7085b))
+
+
+### Bug Fixes
+
+* custom urlEncoder for x-www-forms so the package works for Metamask snapa ([#91](https://github.com/monerium/sdk/issues/91)) ([8375164](https://github.com/monerium/sdk/commit/83751645565c4b7054f8aabffaa8f91eea8d5caf))
+* lint ([82f8f7c](https://github.com/monerium/sdk/commit/82f8f7c0192b235c4e0e584a25d52490e1575aa3))
+* vscode cant detect the configs in nested folder ([#89](https://github.com/monerium/sdk/issues/89)) ([398dcf1](https://github.com/monerium/sdk/commit/398dcf1513de86a7c3949493e3728aac746349fa))
+* we only support EUR for now + adjust placeOrder request type ([1c54932](https://github.com/monerium/sdk/commit/1c549321192c115947f1ce574c97cf618353a6ef))
+* we only support EUR for now + adjust placeOrder request type ([07f801a](https://github.com/monerium/sdk/commit/07f801a1088bf2df014af549214199bb17ee8f51))
+
+
+### Miscellaneous
+
+* add a comment to explain how to use the Network type ([c913224](https://github.com/monerium/sdk/commit/c9132242d2f977524ba6467210344b1c8dc51e85))
+* add info about sdks to Readme ([ad10488](https://github.com/monerium/sdk/commit/ad10488ce634787bee3b1eab8be6b8d78f56f834))
+
 ## [2.3.0](https://github.com/monerium/sdk/compare/v2.2.3...v2.3.0) (2023-04-30)
 
 

package/README.md

@@ -16,9 +16,14 @@ that may change the behavior of your application before you upgrade._
 yarn add @monerium/sdk
 ```
 
+Smart IDEs (such as VSCode) require [special configuration](https://yarnpkg.com/getting-started/editor-sdks) for TypeScript to work when using Plug'n'Play installs.
+
+```sh
+yarn dlx @yarnpkg/sdks vscode
+```
+
 ## 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
 
@@ -43,7 +48,7 @@ If you are new here, we recommend starting in the [Developer Portal](https://mon
 ### Import the SDK and initialize a client
 
 ```ts
-import { MoneriumClient } from "@monerium/sdk";
+import { MoneriumClient } from '@monerium/sdk';
 
 const client = new MoneriumClient();
 ```
@@ -84,10 +89,10 @@ window.location.replace(authFlowUrl)
 // 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: window.localStorage.getItem("myCodeVerifier"),
-  redirect_url: "http://your-webpage.com/monerium-integration",
+  client_id: 'your_client_authflow_uuid',
+  code: new URLSearchParams(window.location.search).get('code'),
+  code_verifier: window.localStorage.getItem('myCodeVerifier'),
+  redirect_url: 'http://your-webpage.com/monerium-integration',
 });
 
 // User is now authenticated, get authentication data

package/dist/index.d.ts

@@ -20,10 +20,7 @@ export type NetworkSemiStrict<C extends Chain> = C extends "ethereum" ? Ethereum
 export type NetworkStrict<C extends Chain, E extends ENV> = E extends "production" ? "mainnet" : E extends "sandbox" ? C extends "ethereum" ? EthereumTestnet : C extends "gnosis" ? GnosisTestnet : C extends "polygon" ? PolygonTestnet : never : never;
 export type Network<C extends Chain = Chain, E extends ENV = ENV> = C extends Chain ? E extends ENV ? NetworkStrict<C, E> & NetworkSemiStrict<C> : never : never;
 export declare enum Currency {
-	eur = "eur",
-	usd = "usd",
-	gbp = "gbp",
-	isk = "isk"
+	eur = "eur"
 }
 export type AuthArgs = Omit<AuthCode, "grant_type"> | Omit<RefreshToken, "grant_type"> | Omit<ClientCredentials, "grant_type">;
 export interface AuthCode {
@@ -139,8 +136,6 @@ export interface Account {
 	currency: Currency;
 	standard: PaymentStandard;
 	iban?: string;
-	sortCode?: string;
-	accountNumber?: string;
 	network: Network;
 	chain: Chain;
 	id?: string;
@@ -242,20 +237,23 @@ export interface Token {
 	address: string;
 	decimals: number;
 }
-export interface NewOrder {
-	kind: OrderKind;
+export type NewOrder = NewOrderByAddress | NewOrderByAccountId;
+export interface NewOrderCommon {
 	amount: string;
 	signature: string;
-	accountId?: string;
-	address: string;
-	currency: Currency;
 	counterpart: Counterpart;
 	message: string;
-	memo: string;
+	memo?: string;
 	supportingDocumentId?: string;
+}
+export interface NewOrderByAddress extends NewOrderCommon {
+	address: string;
 	chain: Chain;
 	network: Network;
 }
+export interface NewOrderByAccountId extends NewOrderCommon {
+	accountId: string;
+}
 export interface SupportingDocMetadata {
 	uploadedBy: string;
 	createdAt: string;
@@ -321,8 +319,7 @@ export declare class MoneriumClient {
  *
  * @returns string
  */
-export declare const placeOrderMessage: ({ currency, amount, iban, }: {
-	currency: Currency | Uppercase<Currency> | string;
+export declare const placeOrderMessage: ({ amount, iban, }: {
 	amount: string | number;
 	iban: string;
 }) => string;