@monerium/sdk 2.0.0 → 2.0.3

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [2.0.3](https://github.com/monerium/sdk/compare/v2.0.2...v2.0.3) (2023-01-05)
+
+### Bug Fixes
+
+- build missing and static page deploy not being triggered([#7](https://github.com/monerium/sdk/issues/7)) ([#9](https://github.com/monerium/sdk/issues/9)) ([0c5e955](https://github.com/monerium/sdk/commit/0c5e955a9823c9d2c79cac5d21120fa49ce79741))
+- workflow ([cb27cb4](https://github.com/monerium/sdk/commit/cb27cb484e6f46beb379d9e46d1874c436eb7208))
+- workflow broken ([09623f0](https://github.com/monerium/sdk/commit/09623f0eee78535ee5e3712e6009e44c6082bbd7))
+
+## [2.0.2](https://github.com/monerium/sdk/compare/v2.0.1...v2.0.2) (2023-01-05)
+
+### Bug Fixes
+
+- Update TypeDocs and set workflow to run only on release ([#7](https://github.com/monerium/sdk/issues/7)) ([79c9ec9](https://github.com/monerium/sdk/commit/79c9ec9e7a68ccfb4d9debaacbc9b7b90be0fcde))
+
+## [2.0.1](https://github.com/monerium/sdk/compare/v2.0.0...v2.0.1) (2023-01-05)
+
+### Bug Fixes
+
+- Update TypeDocs and set workflow to run only on release ([#7](https://github.com/monerium/sdk/issues/7)) ([553d765](https://github.com/monerium/sdk/commit/553d765a4a40c807de6628b31b59ddf3064f89a4))
+
+### Miscellaneous
+
+- cleanup ([5aeebbc](https://github.com/monerium/sdk/commit/5aeebbca9a53592e7229168ad66849113638d070))

package/README.md

@@ -5,6 +5,10 @@ Everything you need to interact with the Monerium API - an electronic money issu
 _This package is in development. Please make sure to check if any future updates contain commits
 that may change the behavior of your application before you upgrade._
 
+[Documentation](https://monerium.github.io/sdk/)
+
+[Code coverage](https://monerium.github.io/sdk/coverage)
+
 ## Installing
 
 ```sh
@@ -22,15 +26,4 @@ yarn add @monerium/sdk
 
 ## Publishing
 
-Update your `package.json` to next version number, and remember to tag a release.
-
-Once ready to submit your package to the NPM Registry, execute the following tasks via `yarn`:
-
-- `yarn clean` — Assure a clean build
-- `yarn build` — Build the package
-
-Submit your package to the registry:
-
-```
-yarn publish
-```
+When changes are merged to the `main` branch that follows the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard, [release-please](https://github.com/googleapis/release-please) workflow creates a pull request, preparing for the next release. If kept open, the following commits will also be added to the PR. Merging that PR will create a new release, a workflow will publish it on NPM and tag it on Github.

package/dist/index.d.ts

@@ -0,0 +1,314 @@
+// Generated by dts-bundle-generator v7.1.0
+
+export type Environment = {
+  api: string;
+  web: string;
+};
+export type Config = {
+  environments: {
+    production: Environment;
+    sandbox: Environment;
+  };
+};
+export interface BearerProfile {
+  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">;
+export interface AuthCode {
+  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;
+}
+export interface ClientCredentials {
+  grant_type: "client_credentials";
+  client_id: string;
+  client_secret: string;
+  scope?: string;
+}
+export type PKCERequestArgs = Omit<
+  PKCERequest,
+  "code_challenge" | "code_challenge_method" | "response_type"
+>;
+export type PKCERequest = {
+  client_id: string;
+  code_challenge: string;
+  code_challenge_method: string;
+  response_type: string;
+  state: string;
+  redirect_uri?: string;
+  scope?: string;
+  address?: string;
+};
+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 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;
+  sortCode?: string;
+  accountNumber?: string;
+  network: Network;
+  chain: Chain;
+  id?: string;
+}
+export interface Profile {
+  id: string;
+  name: string;
+  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;
+}
+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;
+}
+export interface Token {
+  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;
+}
+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[];
+}
+/**
+ * How to authenticate
+ * ```ts
+ *
+ * import { MoneriumClient } from '@monerium/sdk'
+ *
+ * const client = new MoneriumClient();
+ *
+ * // Start by authenticating
+ * await client.auth({
+ *  client_id:
+ *  client_secret:
+ * })
+ * ```
+ * */
+export declare class MoneriumClient {
+  #private;
+  /** The PKCE code verifier */
+  codeVerifier?: string;
+  bearerProfile?: BearerProfile;
+  constructor(env?: "production" | "sandbox");
+  auth(args: AuthArgs): Promise<void>;
+  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 {};

package/dist/index.es.js

@@ -19,18 +19,6 @@ var E = (e, t, i) => (
     F(e, t, "write to private field"), c ? c.call(e, i) : t.set(e, i), i
   );
 var x = (e, t, i) => (F(e, t, "access private method"), i);
-const se = {
-  environments: {
-    production: {
-      api: "https://api.monerium.app",
-      web: "https://monerium.app",
-    },
-    sandbox: {
-      api: "https://api.monerium.dev",
-      web: "https://sandbox.monerium.dev",
-    },
-  },
-};
 var U =
   typeof globalThis < "u"
     ? globalThis
@@ -41,7 +29,7 @@ var U =
     : typeof self < "u"
     ? self
     : {};
-function ae(e) {
+function se(e) {
   if (e.__esModule) return e;
   var t = e.default;
   if (typeof t == "function") {
@@ -77,7 +65,7 @@ function ae(e) {
   );
 }
 var M = {},
-  ce = {
+  ae = {
     get exports() {
       return M;
     },
@@ -85,7 +73,7 @@ var M = {},
       M = e;
     },
   };
-function ue(e) {
+function ce(e) {
   throw new Error(
     'Could not dynamically require "' +
       e +
@@ -93,7 +81,7 @@ function ue(e) {
   );
 }
 var L = {},
-  fe = {
+  ue = {
     get exports() {
       return L;
     },
@@ -101,18 +89,18 @@ var L = {},
       L = e;
     },
   };
-const le = {},
-  he = /* @__PURE__ */ Object.freeze(
+const fe = {},
+  le = /* @__PURE__ */ Object.freeze(
     /* @__PURE__ */ Object.defineProperty(
       {
         __proto__: null,
-        default: le,
+        default: fe,
       },
       Symbol.toStringTag,
       { value: "Module" }
     )
   ),
-  pe = /* @__PURE__ */ ae(he);
+  he = /* @__PURE__ */ se(le);
 var Q;
 function G() {
   return (
@@ -137,10 +125,10 @@ function G() {
                   window.msCrypto &&
                   (p = window.msCrypto),
                 !p && typeof U < "u" && U.crypto && (p = U.crypto),
-                !p && typeof ue == "function")
+                !p && typeof ce == "function")
               )
                 try {
-                  p = pe;
+                  p = he;
                 } catch {}
               var R = function () {
                   if (p) {
@@ -362,7 +350,7 @@ function G() {
             })(Math);
           return i;
         });
-      })(fe)),
+      })(ue)),
     L
   );
 }
@@ -430,9 +418,9 @@ function G() {
       i.enc.Base64url
     );
   });
-})(ce);
+})(ae);
 var V = {},
-  ve = {
+  pe = {
     get exports() {
       return V;
     },
@@ -440,6 +428,53 @@ var V = {},
       V = e;
     },
   };
+(function (e, t) {
+  (function (i, c) {
+    e.exports = c(G());
+  })(U, function (i) {
+    return (
+      (function () {
+        if (typeof ArrayBuffer == "function") {
+          var c = i,
+            y = c.lib,
+            p = y.WordArray,
+            R = p.init,
+            k = (p.init = function (a) {
+              if (
+                (a instanceof ArrayBuffer && (a = new Uint8Array(a)),
+                (a instanceof Int8Array ||
+                  (typeof Uint8ClampedArray < "u" &&
+                    a instanceof Uint8ClampedArray) ||
+                  a instanceof Int16Array ||
+                  a instanceof Uint16Array ||
+                  a instanceof Int32Array ||
+                  a instanceof Uint32Array ||
+                  a instanceof Float32Array ||
+                  a instanceof Float64Array) &&
+                  (a = new Uint8Array(a.buffer, a.byteOffset, a.byteLength)),
+                a instanceof Uint8Array)
+              ) {
+                for (var w = a.byteLength, d = [], l = 0; l < w; l++)
+                  d[l >>> 2] |= a[l] << (24 - (l % 4) * 8);
+                R.call(this, d, w);
+              } else R.apply(this, arguments);
+            });
+          k.prototype = p;
+        }
+      })(),
+      i.lib.WordArray
+    );
+  });
+})(pe);
+var N = {},
+  ve = {
+    get exports() {
+      return N;
+    },
+    set exports(e) {
+      N = e;
+    },
+  };
 (function (e, t) {
   (function (i, c) {
     e.exports = c(G());
@@ -558,53 +593,18 @@ var V = {},
     );
   });
 })(ve);
-var N = {},
-  de = {
-    get exports() {
-      return N;
+const de = {
+  environments: {
+    production: {
+      api: "https://api.monerium.app",
+      web: "https://monerium.app",
     },
-    set exports(e) {
-      N = e;
+    sandbox: {
+      api: "https://api.monerium.dev",
+      web: "https://sandbox.monerium.dev",
     },
-  };
-(function (e, t) {
-  (function (i, c) {
-    e.exports = c(G());
-  })(U, function (i) {
-    return (
-      (function () {
-        if (typeof ArrayBuffer == "function") {
-          var c = i,
-            y = c.lib,
-            p = y.WordArray,
-            R = p.init,
-            k = (p.init = function (a) {
-              if (
-                (a instanceof ArrayBuffer && (a = new Uint8Array(a)),
-                (a instanceof Int8Array ||
-                  (typeof Uint8ClampedArray < "u" &&
-                    a instanceof Uint8ClampedArray) ||
-                  a instanceof Int16Array ||
-                  a instanceof Uint16Array ||
-                  a instanceof Int32Array ||
-                  a instanceof Uint32Array ||
-                  a instanceof Float32Array ||
-                  a instanceof Float64Array) &&
-                  (a = new Uint8Array(a.buffer, a.byteOffset, a.byteLength)),
-                a instanceof Uint8Array)
-              ) {
-                for (var w = a.byteLength, d = [], l = 0; l < w; l++)
-                  d[l >>> 2] |= a[l] << (24 - (l % 4) * 8);
-                R.call(this, d, w);
-              } else R.apply(this, arguments);
-            });
-          k.prototype = p;
-        }
-      })(),
-      i.lib.WordArray
-    );
-  });
-})(de);
+  },
+};
 var O, z, S, A, T, X, q, Z, I, K;
 class Re {
   constructor(t = "sandbox") {
@@ -616,7 +616,7 @@ class Re {
     P(this, z, void 0);
     j(this, "codeVerifier");
     j(this, "bearerProfile");
-    D(this, O, se.environments[t]);
+    D(this, O, de.environments[t]);
   }
   async auth(t) {
     let i;
@@ -637,8 +637,8 @@ class Re {
       D(this, z, `Bearer ${this.bearerProfile.access_token}`);
   }
   pkceRequest(t) {
-    this.codeVerifier = N.random(64).toString();
-    const i = M.stringify(V(this.codeVerifier)),
+    this.codeVerifier = V.random(64).toString();
+    const i = M.stringify(N(this.codeVerifier)),
       c = {
         ...t,
         code_challenge: i,