@monerium/sdk 2.6.4 → 2.7.0

package/dist/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@monerium/sdk",
+  "version": "2.7.0",
+  "description": "Everything you need to interact with the Monerium API - an electronic money issuer.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/monerium/sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/monerium/sdk/issues"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">= 16.15"
+  },
+  "packageManager": "yarn@3.5.0",
+  "dependencies": {
+    "crypto-js": "^4.2.0"
+  },
+  "scripts": {
+    "build:watch": "yarn build:main --watch",
+    "docs": "yarn typedoc --options docs/typedoc.json && node docs/editStatic.js",
+    "docs:watch": "nodemon --watch . --ignore static -e ts,css,md --exec 'typedoc --options docs/typedoc.json && node docs/editStatic.js'"
+  },
+  "devDependencies": {
+    "typedoc": "0.23.23",
+    "typedoc-theme-hierarchy": "^3.2.1"
+  }
+}

package/dist/types.d.ts

@@ -0,0 +1,348 @@
+export type Environment = {
+    api: string;
+    web: string;
+    wss: string;
+};
+export type Config = {
+    environments: {
+        production: Environment;
+        sandbox: Environment;
+    };
+};
+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 type ChainId = 1 | 5 | 100 | 137 | 10200 | 80001;
+export declare enum Currency {
+    eur = "eur"
+}
+export type TokenSymbol = 'EURe';
+export type Ticker = 'EUR';
+export type AuthArgs = Omit<AuthCodeRequest, 'grant_type'> | Omit<RefreshTokenRequest, 'grant_type'> | Omit<ClientCredentialsRequest, 'grant_type'>;
+export type OpenArgs = Omit<AuthCodeRequest, 'grant_type' | 'code' | 'code_verifier'> | Omit<RefreshTokenRequest, 'grant_type'> | Omit<ClientCredentialsRequest, 'grant_type'> | PKCERequestArgs;
+/** One of the options for the {@link AuthArgs}.
+ *
+ * [Auth endpoint in API documentation:](https://monerium.dev/api-docs#operation/auth).
+ * */
+export interface AuthCodeRequest {
+    grant_type: 'authorization_code';
+    client_id: string;
+    code: string;
+    code_verifier: string;
+    redirect_uri: string;
+    scope?: string;
+}
+/** One of the options for the {@link AuthArgs}.
+ *
+ * [Auth endpoint in API documentation:](https://monerium.dev/api-docs#operation/auth).
+ * */
+export interface RefreshTokenRequest {
+    grant_type: 'refresh_token';
+    client_id: string;
+    refresh_token: string;
+    scope?: string;
+}
+/** One of the options for the {@link AuthArgs}.
+ *
+ * [Auth endpoint in API documentation:](https://monerium.dev/api-docs#operation/auth).
+ * */
+export interface ClientCredentialsRequest {
+    grant_type: 'client_credentials';
+    client_id: string;
+    client_secret: string;
+    scope?: string;
+}
+export interface BearerProfile {
+    access_token: string;
+    token_type: string;
+    expires_in: number;
+    refresh_token: string;
+    profile: string;
+    userId: 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;
+    /** 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;
+    /** @deprecated - Use chainId - the network of the wallet to automatically link */
+    network?: Network;
+    /** @deprecated - Use chainId - the chain of the wallet to automatically link */
+    chain?: Chain;
+    /** The network of the wallet to automatically link  */
+    chainId?: ChainId | number;
+};
+declare enum Method {
+    password = "password",
+    resource = "resource",
+    jwt = "jwt",
+    apiKey = "apiKey"
+}
+export declare enum ProfileType {
+    corporate = "corporate",
+    personal = "personal"
+}
+export declare enum Permission {
+    read = "read",
+    write = "write"
+}
+export interface AuthProfile {
+    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[];
+}
+export declare enum KYCState {
+    absent = "absent",
+    submitted = "submitted",
+    pending = "pending",
+    confirmed = "confirmed"
+}
+export declare enum KYCOutcome {
+    approved = "approved",
+    rejected = "rejected",
+    unknown = "unknown"
+}
+export declare enum AccountState {
+    requested = "requested",
+    approved = "approved",
+    pending = "pending"
+}
+export interface KYC {
+    state: KYCState;
+    outcome: KYCOutcome;
+}
+export declare enum PaymentStandard {
+    iban = "iban",
+    scan = "scan"
+}
+export interface Account {
+    address: string;
+    currency: Currency;
+    standard: PaymentStandard;
+    iban?: string;
+    network: Network;
+    chain: Chain;
+    id?: string;
+    state?: AccountState;
+}
+export interface Profile {
+    id: string;
+    name: string;
+    kyc: KYC;
+    accounts: Account[];
+}
+export interface Balance {
+    currency: Currency;
+    amount: string;
+}
+export interface Balances {
+    id: string;
+    address: string;
+    chain: Chain;
+    network: Network;
+    balances: Balance[];
+}
+export declare enum OrderKind {
+    redeem = "redeem",
+    issue = "issue"
+}
+export declare enum OrderState {
+    placed = "placed",
+    pending = "pending",
+    processed = "processed",
+    rejected = "rejected"
+}
+export interface Fee {
+    provider: 'satchel';
+    currency: Currency;
+    amount: string;
+}
+export interface IBAN {
+    standard: PaymentStandard.iban;
+    iban: string;
+}
+export interface SCAN {
+    standard: PaymentStandard.scan;
+    sortCode: string;
+    accountNumber: string;
+}
+export interface Individual {
+    firstName: string;
+    lastName: string;
+    country?: string;
+}
+export interface Corporation {
+    companyName: string;
+    country: string;
+}
+export interface Counterpart {
+    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;
+}
+export interface OrderFilter {
+    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;
+}
+/**
+ * Information about the EURe token on different networks.
+ */
+export interface Token {
+    currency: Currency;
+    ticker: Ticker;
+    symbol: TokenSymbol;
+    chain: Chain;
+    network: Network;
+    /** The address of the EURe contract on this network */
+    address: string;
+    /** How many decimals this token supports */
+    decimals: number;
+}
+export type NewOrder = NewOrderByAddress | NewOrderByAccountId;
+export interface NewOrderCommon {
+    amount: string;
+    signature: string;
+    counterpart: Counterpart;
+    message: 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;
+    updatedAt: string;
+}
+export interface SupportingDoc {
+    id: string;
+    name: string;
+    type: string;
+    size: number;
+    hash: string;
+    meta: SupportingDocMetadata;
+}
+export interface CurrencyAccounts {
+    network: Network;
+    chain: Chain;
+    currency: Currency;
+}
+export interface LinkAddress {
+    address: string;
+    message: string;
+    signature: string;
+    accounts: CurrencyAccounts[];
+    network?: Network;
+    chain?: Chain;
+}
+export type OrderNotification = {
+    id: string;
+    profile: string;
+    accountId: string;
+    address: string;
+    kind: string;
+    amount: string;
+    currency: string;
+    totalFee: string;
+    fees: Fee[];
+    counterpart: Counterpart;
+    memo: string;
+    rejectedReason: string;
+    supportingDocumentId: string;
+    meta: OrderMetadata;
+};
+export type MoneriumEvent = OrderState;
+export type MoneriumEventListener = (notification: OrderNotification) => void;
+export type ClassOptions = {
+    environment?: ENV;
+} & BearerTokenCredentials;
+export type AuthFlowOptions = {
+    clientId?: string;
+    redirectUrl?: string;
+    address?: string;
+    signature?: string;
+    chainId?: number;
+};
+export type ClientCredentials = {
+    clientId: string;
+    clientSecret: string;
+};
+export type AuthorizationCodeCredentials = {
+    clientId: string;
+    redirectUrl: string;
+};
+export type BearerTokenCredentials = ClientCredentials | AuthorizationCodeCredentials;
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,27 @@
+import { Balances, Chain, ChainId, Networks, Profile } from '../src/types';
+export declare const rfc3339: (d: Date) => string;
+/**
+ * The message to be signed when placing an order.
+ *
+ * @returns string
+ */
+export declare const placeOrderMessage: (amount: string | number, iban: string) => string;
+/**
+ * Replacement for URLSearchParams, Metamask snaps do not include node globals.
+ * It will not handle all special characters the same way as URLSearchParams, but it will be good enough for our use case.
+ * @param body a json format of the body to be encoded
+ * @returns 'application/x-www-form-urlencoded' compatible string
+ */
+export declare const urlEncoded: (body: Record<string, string>) => string | undefined;
+/**
+ * Get the corresponding Monerium SDK Chain from the current chain id
+ * @returns The Chain
+ */
+export declare const getChain: (chainId: number) => Chain;
+/**
+ * Get the corresponding Monerium SDK Network from the current chain id
+ * @returns The Network
+ */
+export declare const getNetwork: (chainId: number) => Networks;
+export declare const getIban: (profile: Profile, address: string, chainId: number) => string;
+export declare const getAmount: (balances?: Balances[], address?: string, chainId?: ChainId) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monerium/sdk",
-  "version": "2.6.4",
+  "version": "2.7.0",
   "description": "Everything you need to interact with the Monerium API - an electronic money issuer.",
   "license": "MIT",
   "repository": {
@@ -10,62 +10,32 @@
   "bugs": {
     "url": "https://github.com/monerium/sdk/issues"
   },
-  "main": "dist/index.umd.js",
-  "module": "dist/index.mjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.mjs",
-      "require": "./dist/index.umd.js"
+      "require": "./dist/index.js"
     }
   },
-  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "engines": {
     "node": ">= 16.15"
   },
+  "packageManager": "yarn@3.5.0",
+  "dependencies": {
+    "crypto-js": "^4.2.0"
+  },
   "scripts": {
-    "build": "NODE_OPTIONS=--experimental-fetch yarn build:main",
-    "build:main": "tsc && vite --config ./configs/vite.config.ts build && dts-bundle-generator --config ./configs/dts-bundle-generator.ts",
-    "clean": "rm -rf dist && rm -rf node_modules && rm -rf static",
-    "docs": "typedoc --options configs/typedoc.json",
-    "docs:watch": "yarn docs --watch",
-    "format": "prettier . --write --ignore-path ./configs/.prettierignore",
-    "lint": "eslint . -c ./.eslintrc --ext .ts",
-    "prepare": "husky install",
-    "prepublish": "yarn build && yarn lint && yarn format && yarn test:coverage",
-    "test": "NODE_OPTIONS=\"--experimental-fetch --experimental-vm-modules\" yarn test:main",
-    "test:main": "jest --config ./jest.config.ts",
-    "test:coverage": "yarn test --coverage",
-    "watch": "tsc && vite build --config ./configs/vite.config.ts --watch"
+    "build:watch": "yarn build:main --watch",
+    "docs": "yarn typedoc --options docs/typedoc.json && node docs/editStatic.js",
+    "docs:watch": "nodemon --watch . --ignore static -e ts,css,md --exec 'typedoc --options docs/typedoc.json && node docs/editStatic.js'"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.4.1",
-    "@commitlint/config-conventional": "^17.4.0",
-    "@types/crypto-js": "^4.1.1",
-    "@types/jest": "^29.5.1",
-    "@types/node": "^18.11.18",
-    "@typescript-eslint/eslint-plugin": "^5.46.0",
-    "@typescript-eslint/parser": "^5.46.0",
-    "crypto-js": "^4.1.1",
-    "dts-bundle-generator": "^7.1.0",
-    "eslint": "^8.29.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^27.1.7",
-    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.2",
-    "jest": "^29.5.0",
-    "jest-fetch-mock": "^3.0.3",
-    "prettier": "^2.8.8",
-    "ts-jest": "^29.0.3",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.4.1",
-    "typedoc": "^0.23.23",
-    "typedoc-theme-hierarchy": "^3.0.2",
-    "typescript": "^5.0.4",
-    "vite": "^4.0.0"
-  },
-  "packageManager": "yarn@3.5.0",
-  "prettier": "./configs/.prettierrc.js"
-}
+    "typedoc": "0.23.23",
+    "typedoc-theme-hierarchy": "^3.2.1"
+  }
+}