@monerium/sdk 2.2.3 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [2.3.0](https://github.com/monerium/sdk/compare/v2.2.3...v2.3.0) (2023-04-30)
+
+
+### ⚠ BREAKING CHANGES
+
+* '@monerium/sdk' now exports Network and Chain as types, previously enums </br> Enums are now exported under 'constants' </br> import { constants } from '@monerium/sdk'; </br> const { Network } = constants; </br></br> new Network type takes two optional params for Chain and Environmant</br> import { Network } from '@monerium/sdk'</br></br> // is valid </br> const network: Network<'gnosis','production> = 'mainnet';</br> const network: Network<'gnosis','sandbox> = 'chiado';</br> const network: Network<'gnosis',> = 'chiado';</br> const network: Network = 'chiado';</br></br> // is invalid </br> const network: Network<'gnosis','sandbox> = 'mainnet';</br> const network: Network<'gnosis'> = 'goerli';</br>
+
+### Features
+
+* expose helper to create place order message ([#85](https://github.com/monerium/sdk/issues/85)) ([b124370](https://github.com/monerium/sdk/commit/b1243702c534a6d40e0ce657ff8db9a6f55546a5))
+* network types with optional chain and env type params ([#82](https://github.com/monerium/sdk/issues/82)) ([154d626](https://github.com/monerium/sdk/commit/154d626798150640ac2ed331b98029a18984555c))
+* refactor, improve and test fetch ([#86](https://github.com/monerium/sdk/issues/86)) ([26a8ceb](https://github.com/monerium/sdk/commit/26a8ceb78ec38553709afa2add0108ee3e10e125))
+
+
+### Miscellaneous
+
+* release 2.3.0 ([bff6ece](https://github.com/monerium/sdk/commit/bff6ece14c0b7b7a362b21df0b024b0a6a8f6678))
+
 ## [2.2.3](https://github.com/monerium/sdk/compare/v2.2.2...v2.2.3) (2023-04-28)
 
 

package/dist/index.d.ts

@@ -10,14 +10,15 @@ export type Config = {
 		sandbox: Environment;
 	};
 };
-export interface BearerProfile {
-	access_token: string;
-	token_type: string;
-	expires_in: number;
-	refresh_token: string;
-	profile: string;
-	userId: string;
-}
+export type ENV = "sandbox" | "production";
+export type EthereumTestnet = "goerli";
+export type GnosisTestnet = "chiado";
+export type PolygonTestnet = "mumbai";
+export type Chain = "ethereum" | "gnosis" | "polygon";
+export type Networks = EthereumTestnet | GnosisTestnet | PolygonTestnet | "mainnet";
+export type NetworkSemiStrict<C extends Chain> = C extends "ethereum" ? EthereumTestnet | "mainnet" : C extends "gnosis" ? GnosisTestnet | "mainnet" : C extends "polygon" ? PolygonTestnet | "mainnet" : never;
+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",
@@ -33,6 +34,14 @@ export interface AuthCode {
 	redirect_uri: string;
 	scope?: string;
 }
+export interface BearerProfile {
+	access_token: string;
+	token_type: string;
+	expires_in: number;
+	refresh_token: string;
+	profile: string;
+	userId: string;
+}
 export interface RefreshToken {
 	grant_type: "refresh_token";
 	client_id: string;
@@ -142,17 +151,6 @@ export interface Profile {
 	kyc: KYC;
 	accounts: Account[];
 }
-export declare enum Chain {
-	polygon = "polygon",
-	ethereum = "ethereum",
-	gnosis = "gnosis"
-}
-export declare enum Network {
-	mainnet = "mainnet",
-	chiado = "chiado",
-	goerli = "goerli",
-	mumbai = "mumbai"
-}
 export interface Balance {
 	currency: Currency;
 	amount: string;
@@ -314,9 +312,19 @@ export declare class MoneriumClient {
 	getOrders(filter?: OrderFilter): Promise<Order[]>;
 	getOrder(orderId: string): Promise<Order>;
 	getTokens(): Promise<Token[]>;
-	linkAddress(profileId: string, body: LinkAddress): Promise<any>;
+	linkAddress(profileId: string, body: LinkAddress): Promise<unknown>;
 	placeOrder(order: NewOrder, profileId?: string): Promise<Order>;
 	uploadSupportingDocument(document: File): Promise<SupportingDoc>;
 }
+/**
+ * The message to be signed when placing an order.
+ *
+ * @returns string
+ */
+export declare const placeOrderMessage: ({ currency, amount, iban, }: {
+	currency: Currency | Uppercase<Currency> | string;
+	amount: string | number;
+	iban: string;
+}) => string;
 
 export {};