@monerium/sdk 2.12.0 → 2.13.0

package/dist/client.d.ts

@@ -1,112 +0,0 @@
-import type { AuthArgs, AuthorizationCodeCredentials, AuthContext, Balances, BearerProfile, ClassOptions, ENV, Environment, LinkAddress, MoneriumEvent, MoneriumEventListener, NewOrder, AuthFlowOptions, Order, OrderFilter, PKCERequestArgs, Profile, SupportingDoc, Token, ClientCredentials } from './types';
-export declare class MoneriumClient {
-    #private;
-    /**
-     * @deprecated, use localStorage, will be removed in v3
-     * The PKCE code verifier
-     * */
-    codeVerifier?: string;
-    /** The bearer profile will be available after authentication, it includes the access_token and refresh_token */
-    bearerProfile?: BearerProfile;
-    isAuthorized: boolean;
-    state: string | undefined;
-    /** Constructor for no arguments, defaults to sandbox */
-    constructor();
-    /** Constructor with only env as an argument*/
-    constructor(env: ENV);
-    /** Constructor with {@link ClassOptions} */
-    constructor(options: ClassOptions);
-    /**
-     * Construct the url to the authorization code flow,
-     * Code Verifier needed for the code challenge is stored in local storage
-     * For automatic wallet link, add the following properties: `address`, `signature` & `chainId`
-     * @returns string
-     * {@link https://monerium.dev/api-docs#operation/auth}
-     */
-    authorize(client?: AuthFlowOptions): Promise<void>;
-    /**
-     * Get access to the API
-     * @param {AuthorizationCodeCredentials | ClientCredentials} client - the client credentials
-     * @returns boolean to indicate if access has been granted
-     */
-    getAccess(client?: AuthorizationCodeCredentials | ClientCredentials): Promise<boolean>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/auth-context}
-     */
-    getAuthContext(): Promise<AuthContext>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/profile}
-     * @param {string} profileId - the id of the profile to fetch.
-  
-     */
-    getProfile(profileId: string): Promise<Profile>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/profile-balances}
-     * @param {string=} profileId - the id of the profile to fetch balances.
-     */
-    getBalances(profileId?: string): Promise<Balances[]>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/orders}
-     */
-    getOrders(filter?: OrderFilter): Promise<Order[]>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/order}
-     */
-    getOrder(orderId: string): Promise<Order>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/tokens}
-     */
-    getTokens(): Promise<Token[]>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/profile-addresses}
-     */
-    linkAddress(profileId: string, body: LinkAddress): Promise<unknown>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/post-orders}
-     */
-    placeOrder(order: NewOrder, profileId?: string): Promise<Order>;
-    /**
-     * {@link https://monerium.dev/api-docs#operation/supporting-document}
-     */
-    uploadSupportingDocument(document: File): Promise<SupportingDoc>;
-    connectOrderSocket(): Promise<void>;
-    subscribeToOrderNotifications: () => WebSocket;
-    /**
-     * Cleanups the socket and the subscriptions
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Revokes access
-     */
-    revokeAccess(): Promise<void>;
-    /**
-     * Subscribe to MoneriumEvent to receive notifications using the Monerium API (WebSocket)
-     * We are setting a subscription map because we need the user to have a token to start the WebSocket connection
-     * {@link https://monerium.dev/api-docs#operation/profile-orders-notifications}
-     * @param event The event to subscribe to
-     * @param handler The handler to be called when the event is triggered
-     */
-    subscribeOrders(event: MoneriumEvent, handler: MoneriumEventListener): void;
-    /**
-     * Unsubscribe from MoneriumEvent and close the socket if there are no more subscriptions
-     * @param event The event to unsubscribe from
-     */
-    unsubscribeOrders(event: MoneriumEvent): void;
-    /**
-     * @deprecated since v2.6.4, will be removed in 2.7.2+, use {@link getAccess} instead.
-     */
-    auth: (args: AuthArgs) => Promise<BearerProfile>;
-    /**
-     * @deprecated since v2.7.1, will be removed in 2.7.2+, use {@link getAccess} instead.
-     */
-    connect: (args: AuthArgs) => Promise<BearerProfile>;
-    /**
-     * @deprecated since v2.6.4, will be removed in 2.7.2+, use {@link authorize} instead.
-     */
-    getAuthFlowURI: (args: PKCERequestArgs) => string;
-    /**
-     *  @deprecated since v2.0.7, will be removed in 2.7.2+, use {@link getAuthFlowURI} instead.
-     */
-    pkceRequest: (args: PKCERequestArgs) => string;
-    getEnvironment: () => Environment;
-}

package/dist/config.d.ts

@@ -1,3 +0,0 @@
-import type { Config } from './types';
-declare const MONERIUM_CONFIG: Config;
-export { MONERIUM_CONFIG };

package/dist/constants.d.ts

@@ -1,9 +0,0 @@
-export declare const LINK_MESSAGE = "I hereby declare that I am the address owner.";
-export declare const STORAGE_CODE_VERIFIER = "monerium.sdk.code_verifier";
-export declare const STORAGE_REFRESH_TOKEN = "monerium.sdk.refresh_token";
-declare const constants: {
-    LINK_MESSAGE: string;
-    STORAGE_CODE_VERIFIER: string;
-    STORAGE_REFRESH_TOKEN: string;
-};
-export default constants;

package/dist/helpers/auth.helpers.d.ts

@@ -1,23 +0,0 @@
-import { AuthArgs, AuthCodeRequest, ClientCredentialsRequest, PKCERequestArgs, RefreshTokenRequest } from '../types';
-/** Structure the Auth Flow params, support for ChainId instead of chain & network */
-export declare const getAuthFlowParams: (args: PKCERequestArgs, codeChallenge: string) => string | undefined;
-/**
- * Find a more secure way to generate a random string
- * Using crypto-js to generate a random string was causing the following error:
- * `Error: Native crypto module could not be used to get secure random number.`
- * https://github.com/brix/crypto-js/issues/256
- */
-export declare const generateRandomString: () => string;
-/** Generate the PKCE code challenge */
-export declare const generateCodeChallenge: (codeVerifier: string) => string;
-/**
- * Constructs the Auth Flow URL and stores the code verifier in the local storage
- */
-export declare const getAuthFlowUrlAndStoreCodeVerifier: (baseUrl: string, args: PKCERequestArgs) => string;
-/**
- * Clean the query string from the URL
- */
-export declare const cleanQueryString: () => void;
-export declare const isAuthCode: (args: AuthArgs) => args is AuthCodeRequest;
-export declare const isRefreshToken: (args: AuthArgs) => args is RefreshTokenRequest;
-export declare const isClientCredentials: (args: AuthArgs) => args is ClientCredentialsRequest;

package/dist/helpers/index.d.ts

@@ -1,2 +0,0 @@
-export * from './auth.helpers';
-export * from './service.helpers';

package/dist/helpers/service.helpers.d.ts

@@ -1 +0,0 @@
-export declare const rest: <T>(url: string, method: string, body?: BodyInit | Record<string, string>, headers?: Record<string, string>) => Promise<T>;

package/dist/package.json

@@ -1,40 +0,0 @@
-{
-  "name": "@monerium/sdk",
-  "version": "2.12.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/js-sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/monerium/js-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"
-  },
-  "dependencies": {
-    "crypto-js": "^4.2.0"
-  },
-  "scripts": {
-    "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": {
-    "nodemon": "3.0.1",
-    "typedoc": "0.23.23",
-    "typedoc-theme-hierarchy": "^3.2.1"
-  }
-}

package/dist/types.d.ts

@@ -1,373 +0,0 @@
-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 = 'sepolia';
-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 = number | 1 | 11155111 | 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  */
-    network?: Network;
-    /** @deprecated - Use chainId */
-    chain?: Chain;
-    /** The network of the wallet to automatically link  */
-    chainId?: ChainId;
-};
-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",
-    chain = "chain"
-}
-export interface Identifier {
-    standard: PaymentStandard;
-    bic?: string;
-}
-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 extends Identifier {
-    standard: PaymentStandard.iban;
-    iban: string;
-}
-export interface CrossChain extends Identifier {
-    standard: PaymentStandard.chain;
-    address: string;
-    chainId: ChainId;
-    /** @deprecated - Use chainId */
-    chain?: Chain;
-    /** @deprecated - Use chainId */
-    network?: Network;
-}
-export interface SCAN extends Identifier {
-    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 | CrossChain;
-    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;
-    currency?: Currency /** Not needed right now, only EUR */;
-    counterpart: Counterpart;
-    message: string;
-    memo?: string;
-    supportingDocumentId?: string;
-}
-export interface NewOrderByAddress extends NewOrderCommon {
-    address: string;
-    /** @deprecated - Use 'chainId' */
-    chain?: Chain;
-    /** @deprecated - Use 'chainId' */
-    network?: Network;
-    chainId: ChainId;
-}
-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 {
-    /** @deprecated - Use 'chainId' */
-    network?: Network;
-    /** @deprecated - Use 'chainId' */
-    chain?: Chain;
-    chainId: ChainId;
-    currency: Currency;
-}
-export interface LinkAddress {
-    address: string;
-    message: string;
-    signature: string;
-    accounts: CurrencyAccounts[];
-    /** @deprecated - Use 'chainId' */
-    network?: Network;
-    /** @deprecated - Use 'chainId' */
-    chain?: Chain;
-    chainId?: ChainId;
-}
-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?: ChainId;
-    state?: string;
-};
-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

@@ -1,28 +0,0 @@
-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, receiver: string, chainId?: number, currency?: 'eur' | 'gbp' | 'usd' | 'isk') => 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;
-export declare const mapChainAndNetwork: (body: any) => any;