@monerium/sdk 2.2.0 → 2.2.2

package/CHANGELOG.md

@@ -1,26 +1,43 @@
 # Changelog
 
-## [2.2.0](https://github.com/monerium/sdk/compare/v2.1.23...v2.2.0) (2023-04-25)
+## [2.2.2](https://github.com/monerium/sdk/compare/v2.2.1...v2.2.2) (2023-04-26)
+
+
+### Bug Fixes
+
+* coverage output path ([675b7cd](https://github.com/monerium/sdk/commit/675b7cd3536a320dcbe915bfeb077609bfa834b1))
+
+
+### Miscellaneous
+
+* archive build and reuse for deploying static files. ([#80](https://github.com/monerium/sdk/issues/80)) ([cfc34d8](https://github.com/monerium/sdk/commit/cfc34d80f2db547505c34b55ab3b2a7d0a37aae5))
+* move .prettierignore into configs folder and add some rules ([171b0b3](https://github.com/monerium/sdk/commit/171b0b3c5dc807f0bec0cc9220b390302fdd98e9))
 
+## [2.2.1](https://github.com/monerium/sdk/compare/v2.2.0...v2.2.1) (2023-04-26)
+
+### Miscellaneous
+
+- backward support for node 16.15 ([a80379b](https://github.com/monerium/sdk/commit/a80379b8849f78e541d9f4455cd12cd676e7751f))
+- ignore release please branches for build ([4b68cfa](https://github.com/monerium/sdk/commit/4b68cfa17380432136620acb67e856619333e3aa))
+- move configs to reduce clutter in root folder ([#78](https://github.com/monerium/sdk/issues/78)) ([f2dcb21](https://github.com/monerium/sdk/commit/f2dcb2190811c9521e029eb15caef3b4ee557c4a))
+
+## [2.2.0](https://github.com/monerium/sdk/compare/v2.1.23...v2.2.0) (2023-04-25)
 
 ### Features
 
-* use Yarn PnP ([#73](https://github.com/monerium/sdk/issues/73)) ([4295154](https://github.com/monerium/sdk/commit/4295154487c3eb255b23816b5cf32aac52cae710))
+- use Yarn PnP ([#73](https://github.com/monerium/sdk/issues/73)) ([4295154](https://github.com/monerium/sdk/commit/4295154487c3eb255b23816b5cf32aac52cae710))
 
 ## [2.1.23](https://github.com/monerium/sdk/compare/v2.1.22...v2.1.23) (2023-04-25)
 
-
 ### Bug Fixes
 
-* now it should publish succesfully to npm registry ([#71](https://github.com/monerium/sdk/issues/71)) ([5b5e37b](https://github.com/monerium/sdk/commit/5b5e37b2cde1d1e0411e3e023cfcd5f7eca376d6))
+- now it should publish succesfully to npm registry ([#71](https://github.com/monerium/sdk/issues/71)) ([5b5e37b](https://github.com/monerium/sdk/commit/5b5e37b2cde1d1e0411e3e023cfcd5f7eca376d6))
 
 ## [2.1.22](https://github.com/monerium/sdk/compare/v2.1.21...v2.1.22) (2023-04-24)
 
-
 ### Bug Fixes
 
-* deploy static pipeline ([#69](https://github.com/monerium/sdk/issues/69)) ([38067e7](https://github.com/monerium/sdk/commit/38067e75e3334b6eb20dcc182f1d6aaca5af0caa))
-
+- deploy static pipeline ([#69](https://github.com/monerium/sdk/issues/69)) ([38067e7](https://github.com/monerium/sdk/commit/38067e75e3334b6eb20dcc182f1d6aaca5af0caa))
 
 ## [2.1.21](https://github.com/monerium/sdk/compare/v2.1.20...v2.1.21) (2023-04-24)
 

package/dist/index.d.ts

@@ -1,328 +1,322 @@
 // Generated by dts-bundle-generator v7.2.0
 
 export type Environment = {
-  api: string;
-  web: string;
+	api: string;
+	web: string;
 };
 export type Config = {
-  environments: {
-    production: Environment;
-    sandbox: Environment;
-  };
+	environments: {
+		production: Environment;
+		sandbox: Environment;
+	};
 };
 export interface BearerProfile {
-  access_token: string;
-  token_type: string;
-  expires_in: number;
-  refresh_token: string;
-  profile: string;
-  userId: string;
+	access_token: string;
+	token_type: string;
+	expires_in: number;
+	refresh_token: string;
+	profile: string;
+	userId: string;
 }
 export declare enum Currency {
-  eur = 'eur',
-  usd = 'usd',
-  gbp = 'gbp',
-  isk = 'isk',
-}
-export type AuthArgs =
-  | Omit<AuthCode, 'grant_type'>
-  | Omit<RefreshToken, 'grant_type'>
-  | Omit<ClientCredentials, 'grant_type'>;
+	eur = "eur",
+	usd = "usd",
+	gbp = "gbp",
+	isk = "isk"
+}
+export type AuthArgs = Omit<AuthCode, "grant_type"> | Omit<RefreshToken, "grant_type"> | Omit<ClientCredentials, "grant_type">;
 export interface AuthCode {
-  grant_type: 'authorization_code';
-  client_id: string;
-  code: string;
-  code_verifier: string;
-  redirect_uri: string;
-  scope?: string;
+	grant_type: "authorization_code";
+	client_id: string;
+	code: string;
+	code_verifier: string;
+	redirect_uri: string;
+	scope?: string;
 }
 export interface RefreshToken {
-  grant_type: 'refresh_token';
-  client_id: string;
-  refresh_token: string;
-  scope?: string;
+	grant_type: "refresh_token";
+	client_id: string;
+	refresh_token: string;
+	scope?: string;
 }
 export interface ClientCredentials {
-  grant_type: 'client_credentials';
-  client_id: string;
-  client_secret: string;
-  scope?: string;
+	grant_type: "client_credentials";
+	client_id: string;
+	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 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;
-  /** 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;
+	/** the authentication flow client id of the application */
+	client_id: string;
+	/** the code challenge automatically generated by the SDK */
+	code_challenge: 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',
-  resource = 'resource',
-  jwt = 'jwt',
-  apiKey = 'apiKey',
+	password = "password",
+	resource = "resource",
+	jwt = "jwt",
+	apiKey = "apiKey"
 }
 export declare enum ProfileType {
-  corporate = 'corporate',
-  personal = 'personal',
+	corporate = "corporate",
+	personal = "personal"
 }
 export declare enum Permission {
-  read = 'read',
-  write = 'write',
+	read = "read",
+	write = "write"
 }
 export interface AuthProfile {
-  id: string;
-  type: ProfileType;
-  name: string;
-  perms: Permission[];
+	id: string;
+	type: ProfileType;
+	name: string;
+	perms: Permission[];
 }
 export interface AuthContext {
-  userId: string;
-  email: string;
-  name: string;
-  roles: 'admin'[];
-  auth: {
-    method: Method;
-    subject: string;
-    verified: boolean;
-  };
-  defaultProfile: string;
-  profiles: AuthProfile[];
+	userId: string;
+	email: string;
+	name: string;
+	roles: "admin"[];
+	auth: {
+		method: Method;
+		subject: string;
+		verified: boolean;
+	};
+	defaultProfile: string;
+	profiles: AuthProfile[];
 }
 export declare enum KYCState {
-  absent = 'absent',
-  submitted = 'submitted',
-  pending = 'pending',
-  confirmed = 'confirmed',
+	absent = "absent",
+	submitted = "submitted",
+	pending = "pending",
+	confirmed = "confirmed"
 }
 export declare enum KYCOutcome {
-  approved = 'approved',
-  rejected = 'rejected',
-  unknown = 'unknown',
+	approved = "approved",
+	rejected = "rejected",
+	unknown = "unknown"
 }
 export interface KYC {
-  state: KYCState;
-  outcome: KYCOutcome;
+	state: KYCState;
+	outcome: KYCOutcome;
 }
 export declare enum PaymentStandard {
-  iban = 'iban',
-  scan = 'scan',
+	iban = "iban",
+	scan = "scan"
 }
 export interface Account {
-  address: string;
-  currency: Currency;
-  standard: PaymentStandard;
-  iban?: string;
-  sortCode?: string;
-  accountNumber?: string;
-  network: Network;
-  chain: Chain;
-  id?: string;
+	address: string;
+	currency: Currency;
+	standard: PaymentStandard;
+	iban?: string;
+	sortCode?: string;
+	accountNumber?: string;
+	network: Network;
+	chain: Chain;
+	id?: string;
 }
 export interface Profile {
-  id: string;
-  name: string;
-  kyc: KYC;
-  accounts: Account[];
+	id: string;
+	name: string;
+	kyc: KYC;
+	accounts: Account[];
 }
 export declare enum Chain {
-  polygon = 'polygon',
-  ethereum = 'ethereum',
-  gnosis = 'gnosis',
+	polygon = "polygon",
+	ethereum = "ethereum",
+	gnosis = "gnosis"
 }
 export declare enum Network {
-  mainnet = 'mainnet',
-  chiado = 'chiado',
-  goerli = 'goerli',
-  mumbai = 'mumbai',
+	mainnet = "mainnet",
+	chiado = "chiado",
+	goerli = "goerli",
+	mumbai = "mumbai"
 }
 export interface Balance {
-  currency: Currency;
-  amount: string;
+	currency: Currency;
+	amount: string;
 }
 export interface Balances {
-  id: string;
-  address: string;
-  chain: Chain;
-  network: Network;
-  balances: Balance[];
+	id: string;
+	address: string;
+	chain: Chain;
+	network: Network;
+	balances: Balance[];
 }
 export declare enum OrderKind {
-  redeem = 'redeem',
-  issue = 'issue',
+	redeem = "redeem",
+	issue = "issue"
 }
 export declare enum OrderState {
-  placed = 'placed',
-  pending = 'pending',
-  processed = 'processed',
-  rejected = 'rejected',
+	placed = "placed",
+	pending = "pending",
+	processed = "processed",
+	rejected = "rejected"
 }
 export interface Fee {
-  provider: 'satchel';
-  currency: Currency;
-  amount: string;
+	provider: "satchel";
+	currency: Currency;
+	amount: string;
 }
 export interface IBAN {
-  standard: PaymentStandard.iban;
-  iban: string;
+	standard: PaymentStandard.iban;
+	iban: string;
 }
 export interface SCAN {
-  standard: PaymentStandard.scan;
-  sortCode: string;
-  accountNumber: string;
+	standard: PaymentStandard.scan;
+	sortCode: string;
+	accountNumber: string;
 }
 export interface Individual {
-  firstName: string;
-  lastName: string;
-  country?: string;
+	firstName: string;
+	lastName: string;
+	country?: string;
 }
 export interface Corporation {
-  companyName: string;
-  country: string;
+	companyName: string;
+	country: string;
 }
 export interface Counterpart {
-  identifier: IBAN | SCAN;
-  details: Individual | Corporation;
+	identifier: IBAN | SCAN;
+	details: Individual | Corporation;
 }
 export interface OrderMetadata {
-  approvedAt: string;
-  processedAt: string;
-  rejectedAt: string;
-  state: OrderState;
-  placedBy: string;
-  placedAt: string;
-  receivedAmount: string;
-  sentAmount: string;
+	approvedAt: string;
+	processedAt: string;
+	rejectedAt: string;
+	state: OrderState;
+	placedBy: string;
+	placedAt: string;
+	receivedAmount: string;
+	sentAmount: string;
 }
 export interface OrderFilter {
-  address?: string;
-  txHash?: string;
-  profile?: string;
-  memo?: string;
-  accountId?: string;
-  state?: OrderState;
+	address?: string;
+	txHash?: string;
+	profile?: string;
+	memo?: string;
+	accountId?: string;
+	state?: OrderState;
 }
 export interface Order {
-  id: string;
-  profile: string;
-  accountId: string;
-  address: string;
-  kind: OrderKind;
-  amount: string;
-  currency: Currency;
-  totalFee: string;
-  fees: Fee[];
-  counterpart: Counterpart;
-  memo: string;
-  rejectedReason: string;
-  supportingDocumentId: string;
-  meta: OrderMetadata;
+	id: string;
+	profile: string;
+	accountId: string;
+	address: string;
+	kind: OrderKind;
+	amount: string;
+	currency: Currency;
+	totalFee: string;
+	fees: Fee[];
+	counterpart: Counterpart;
+	memo: string;
+	rejectedReason: string;
+	supportingDocumentId: string;
+	meta: OrderMetadata;
 }
 export interface Token {
-  currency: Currency;
-  ticker: string;
-  symbol: string;
-  chain: Chain;
-  network: Network;
-  address: string;
-  decimals: number;
+	currency: Currency;
+	ticker: string;
+	symbol: string;
+	chain: Chain;
+	network: Network;
+	address: string;
+	decimals: number;
 }
 export interface NewOrder {
-  kind: OrderKind;
-  amount: string;
-  signature: string;
-  accountId?: string;
-  address: string;
-  currency: Currency;
-  counterpart: Counterpart;
-  message: string;
-  memo: string;
-  supportingDocumentId?: string;
-  chain: Chain;
-  network: Network;
+	kind: OrderKind;
+	amount: string;
+	signature: string;
+	accountId?: string;
+	address: string;
+	currency: Currency;
+	counterpart: Counterpart;
+	message: string;
+	memo: string;
+	supportingDocumentId?: string;
+	chain: Chain;
+	network: Network;
 }
 export interface SupportingDocMetadata {
-  uploadedBy: string;
-  createdAt: string;
-  updatedAt: string;
+	uploadedBy: string;
+	createdAt: string;
+	updatedAt: string;
 }
 export interface SupportingDoc {
-  id: string;
-  name: string;
-  type: string;
-  size: number;
-  hash: string;
-  meta: SupportingDocMetadata;
+	id: string;
+	name: string;
+	type: string;
+	size: number;
+	hash: string;
+	meta: SupportingDocMetadata;
 }
 export interface CurrencyAccounts {
-  network: Network;
-  chain: Chain;
-  currency: Currency;
+	network: Network;
+	chain: Chain;
+	currency: Currency;
 }
 export interface LinkAddress {
-  address: string;
-  message: string;
-  signature: string;
-  accounts: CurrencyAccounts[];
-  network?: Network;
-  chain?: Chain;
+	address: string;
+	message: string;
+	signature: string;
+	accounts: CurrencyAccounts[];
+	network?: Network;
+	chain?: Chain;
 }
 export declare class MoneriumClient {
-  #private;
-  /** The PKCE code verifier */
-  codeVerifier?: string;
-  bearerProfile?: BearerProfile;
-  constructor(env?: 'production' | 'sandbox');
-  auth(args: AuthArgs): Promise<BearerProfile>;
-  /**
-   * 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 {@link getAuthFlowURI} instead.
-   */
-  pkceRequest: (args: PKCERequestArgs) => string;
-  getAuthContext(): Promise<AuthContext>;
-  /**
-   * @param {string} profileId - the id of the profile to fetch.
-   */
-  getProfile(profileId: string): Promise<Profile>;
-  /**
-   * @param {string=} profileId - the id of the profile to fetch balances.
-   */
-  getBalances(profileId?: string): Promise<Balances> | Promise<Balances[]>;
-  getOrders(filter?: OrderFilter): Promise<Order[]>;
-  getOrder(orderId: string): Promise<Order>;
-  getTokens(): Promise<Token[]>;
-  linkAddress(profileId: string, body: LinkAddress): Promise<any>;
-  placeOrder(order: NewOrder, profileId?: string): Promise<Order>;
-  uploadSupportingDocument(document: File): Promise<SupportingDoc>;
+	#private;
+	/** The PKCE code verifier */
+	codeVerifier?: string;
+	bearerProfile?: BearerProfile;
+	constructor(env?: "production" | "sandbox");
+	auth(args: AuthArgs): Promise<BearerProfile>;
+	/**
+	 * 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 {@link getAuthFlowURI} instead.
+	 */
+	pkceRequest: (args: PKCERequestArgs) => string;
+	getAuthContext(): Promise<AuthContext>;
+	/**
+	 * @param {string} profileId - the id of the profile to fetch.
+	 */
+	getProfile(profileId: string): Promise<Profile>;
+	/**
+	 * @param {string=} profileId - the id of the profile to fetch balances.
+	 */
+	getBalances(profileId?: string): Promise<Balances> | Promise<Balances[]>;
+	getOrders(filter?: OrderFilter): Promise<Order[]>;
+	getOrder(orderId: string): Promise<Order>;
+	getTokens(): Promise<Token[]>;
+	linkAddress(profileId: string, body: LinkAddress): Promise<any>;
+	placeOrder(order: NewOrder, profileId?: string): Promise<Order>;
+	uploadSupportingDocument(document: File): Promise<SupportingDoc>;
 }
 
 export {};