@owneraio/finp2p-sdk-js 0.16.24 → 0.16.26

package/README.md

@@ -1,9 +1,14 @@
+# FinP2P SDK Introduction
+The Ownera sdk provides an easy to use set of APIs to work with Ownera FinP2P node for various use cases,
+the sdk handles most of the heavy lifting for executing operations on the FinP2P network,
+such as signature templates generation and signing, asset managements, escrow interface and more.
+
 # Ownera API service 
 The purpose of this sdk is to provide an interface to the Ownera APIs.  
 It covers the following:
-- [Transactional API](https://finp2p-docs.ownera.io/reference/transactional-api-introduction)
+- [Transactional API](https://finp2p-docs.ownera.io/reference/transactional-api-introduction-1)
 - [Query API](https://finp2p-docs.ownera.io/reference/graphql-api)
-- [Escrow API](https://finp2p-docs.ownera.io/reference/escrow-api-introduction)
+- [Escrow API](https://finp2p-docs.ownera.io/reference/holdoperation)
 - Custody adapter
 - Regulation verifiers
 
@@ -11,106 +16,186 @@ It exposes types for Typescript.
 
 To build the `lib/` and use the package, just run `yarn build`.
 
-Detailed documentation available [here](https://finp2p-docs.ownera.io/reference/introduction-2)
-
-## Setup
-You need to create a `.env` file in your project with the following keys
-```
-NODE_MSPID=<organization_id, e.g: bank-us>
-OWNERA_API_ADDRESS=<API url, e.g: network-bank-us.api.local.ownera.io>
-```
-
 ## Usage
 
 ### Core
+[SDK](./classes/sdk.md)
+
 ```typescript
-import { Sdk } from '@owneraio/finp2p-sdk-js';
+import { Sdk } from "@owneraio/finp2p-sdk-js";
 
 const sdk = new Sdk({
-  orgId: 'myOrdId',
-  owneraAPIAddress: 'https://my-ownera-node.io',
-  owneraRASAddress: 'https://my-ownera-reg-app-store.io',
+  orgId: "myOrdId",
+  owneraAPIAddress: "https://my-ownera-node.io",
+  owneraRASAddress: "https://my-ownera-reg-app-store.io",
   authConfig: { 
-    apiKey: '<my-api-key>',
+    apiKey: "<my-api-key>",
     secret: { 
       type: 1|2, 
-      raw: '<my-stringified-private-key>',
+      raw: "<my-stringified-private-key>",
     },
   },
-  custodyAdapterBaseURL: '<optional-custody-url>',
-});
-
-const asset = await sdk.createAsset({
-  name: `my-asset-name`,
-  type: 'Company',
-  issuerId: 'asset-issuer-finp2p-id',
-  verifiers: [],
-  denomination: { type: 'fiat', code: 'USD' },
+  custodyAdapterBaseURL: "<optional-custody-url>",
 });
 ```
 
-### Inner functions
+#### Inner Properties:
+- [logger](./classes/sdk.md#logger)
+- [nodeId](./classes/sdk.md#nodeid)
+- [owneraAPI](./classes/sdk.md#owneraapi)
+- [utils](./classes/sdk.md#utils)
+
+#### Inner functions:
+- [Create Asset](#create-asset)
+- [Create User](#create-user)
+- [Get Asset](#get-asset)
+- [Get User](#get-user)
+- [Get Organization](#get-organization)
+
+
+####  [Create asset](./classes/sdk.md#createasset)
+Returns Promise with [AssetInterface](./interfaces/assetinterface.md)
+
+Usage example:
 ```typescript
-import { Asset, AssetConfig, OwneraAPI } from '@owneraio/finp2p-sdk-js';
+    const { email, name, phoneNumber } = payload.user;
+    let issuer;
+
+    const users = await sdk.owneraAPI.query.getUsers({});
+    issuer = users.filter((o) => o.email === email)[0];
+
+    if (!issuer) {
+        const { id, publicKey } = await Custody.createAccount({
+            name,
+            phoneNumber,
+        });
+        
+        const user = await sdk.createUser({
+            withSignatureProvider: {
+                publicKey,
+                signingMethod: signingMethod({ id, custody: sdk.owneraAPI.custodyAdapter! }),
+            },
+        });
+
+        issuer = await user.getData();
+    }
 
-export default async () => {
-  const config: AssetConfig = {
-    recipientRules: [],
-    recipientClaimProviders: [],
-  };
 
   // Create Asset
-  const result = await OwneraAPI.profiles.createAsset({ config });
-  // Get Assets
-  const assets: Asset[] = await OwneraAPI.oss.getAssets({});
-  console.info(assets);
-};
+    const createdAsset = await sdk.createAsset({
+        name: "Asset Name",
+        type: "company",
+        verifiers: [
+            {
+                id: "1",
+                name: "Accreditation",
+                provider: "OTHER",
+            },
+        ],
+        issuerId: issuer.id,
+        denomination: {
+            type: "fiat",
+            code: "USD"
+        }});
+    
+    // get asset data
+    const createdAssetInfo = await createdAsset.getData();
 ```
 
-### Create user
+#### [Create user](./classes/sdk.md#createuser)
+Returns Promise with [UserInterface](./interfaces/userinterface.md)
+
+Usage example:
 ```typescript
-// Create signing method using custody adapter
-const signingMethod = (custody: CustodyAdapter, id: string) => async (hash: string) => {
-  let attempt = 0;
-  let signatureResponse = await custody.createSignature({ id, hash });
-  const signatureId = signatureResponse.id;
-  const doRetry = !['FAILED', 'COMPLETED'].includes(signatureResponse.status);
-  while (doRetry && attempt < 10) {
-    signatureResponse = await custody.getSignature({ signatureId });
-    attempt = attempt + 1;
-  }
-
-  if (doRetry && attempt === 10) {
-    throw {
-      code: 408,
-      name: 'SignatureError',
-      message: 'Timeout - unable to get signature',
-      data: signatureResponse,
-    };
-  }
-
-  if (signatureResponse.status === 'FAILED') {
-    throw {
-      code: 500,
-      name: 'SignatureError',
-      message: 'Failure - unable to get signature',
-      data: signatureResponse,
+    // Create signing method using custody adapter
+    const signingMethod = (custody: CustodyAdapter, id: string) => async (hash: string) => {
+      let attempt = 0;
+      let signatureResponse = await custody.createSignature({ id, hash });
+      const signatureId = signatureResponse.id;
+      const doRetry = !["FAILED", "COMPLETED"].includes(signatureResponse.status);
+      while (doRetry && attempt < 10) {
+        signatureResponse = await custody.getSignature({ signatureId });
+        attempt = attempt + 1;
+      }
+    
+      if (doRetry && attempt === 10) {
+        throw {
+          code: 408,
+          name: "SignatureError",
+          message: "Timeout - unable to get signature",
+          data: signatureResponse,
+        };
+      }
+    
+      if (signatureResponse.status === "FAILED") {
+        throw {
+          code: 500,
+          name: "SignatureError",
+          message: "Failure - unable to get signature",
+          data: signatureResponse,
+        };
+      }
+    
+      return Promise.resolve(signatureResponse.signature);
     };
-  }
+    
+    // Create user 
+    const uniqueIdentifier = Date.now();
+    const account = await sdk.owneraAPI.custodyAdapter!.createAccount({
+      uniqueIdentifier,
+      name: `${uniqueIdentifier} custody account`,
+    });
+    
+    const user = await sdk.createUser({
+      withSignatureProvider: {
+        publicKey: account.publicKey,
+        signingMethod: signingMethod(sdk.owneraAPI.custodyAdapter!, account.id),
+      },
+    });
+```
 
-  return Promise.resolve(signatureResponse.signature);
-};
+#### [Get Asset](./classes/sdk.md#getasset)
+Returns [AssetInterface](./interfaces/assetinterface.md)
 
-// Create user 
-const uniqueIdentifier = Date.now();
-const account = await sdk.owneraAPI.custodyAdapter!.createAccount({
-  uniqueIdentifier,
-  name: `${uniqueIdentifier} custody account`,
-});
-const user = await sdk.createUser({
-  withSignatureProvider: {
-    publicKey: account.publicKey,
-    signingMethod: signingMethod(sdk.owneraAPI.custodyAdapter!, account.id),
-  },
-});
+Usage example:
+```typescript
+    const assetInterface = await getAsset({ assetId });
+    const asset = await assetInterface.getData();
+```
+
+#### [Get User](./classes/sdk.md#getuser)
+Returns Promise with [UserInterface](./interfaces/userinterface.md)
+
+Usage example:
+```typescript
+    const publicKey = "<your-public-key>";
+    type signingMeth = (r: {custody: CustodyAdapter, id: string}): (hash: string, details?: SignatureDetails) => Promise<string>;
+    const signingMethod: signingMeth = (r: {custody: CustodyAdapter, id: string}) => {/* Your signingMethod implementation */};
+
+    const user = await getSdk().getUser({
+        userId: r.userId,
+        withSignatureProvider: {
+            publicKey: userData.publicKey,
+            signingMethod: signingMethod({
+                custody: getSdk().owneraAPI.custodyAdapter!,
+                id: investorCustodyAccountId,
+            }),
+        },
+    });
 ```
+
+    user = await sdk.getUser({ userId: profile.id });
+```
+
+#### [Get Organization](./classes/sdk.md#getorganization)
+Returns [OrganizationInterface](./interfaces/organizationinterface.md)
+
+Usage example:
+```typescript
+    // get organization API
+    const org = sdk.getOrganization({ });
+```
+
+### Another examples
+More extended recipes you can check [here](https://finp2p-docs.ownera.io/recipes)
+

package/lib/OwneraAPI/custody-api/index.js

@@ -11,15 +11,39 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const index = (connector, logger) => ({
+    /**
+     * @description Create new account
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     createAccount: (request) => __awaiter(void 0, void 0, void 0, function* () {
         if (request.hasOwnProperty('phoneNumber') && request.phoneNumber === undefined) {
             delete request.phoneNumber;
         }
         return (0, utils_1.custodyPost)('/accounts', request, connector, logger);
     }),
+    /**
+     * @description Create signature
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     createSignature: (request) => __awaiter(void 0, void 0, void 0, function* () {
         return (0, utils_1.custodyPost)('/signatures', request, connector, logger);
     }),
+    /**
+     * @description Get signature
+     *
+     * @param r
+     *
+     * @returns
+     *
+     */
     getSignature: (r) => __awaiter(void 0, void 0, void 0, function* () {
         return (0, utils_1.custodyGet)(`/signatures/${r.signatureId}`, connector, logger);
     }),

package/lib/OwneraAPI/custody-api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/OwneraAPI/custody-api/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,oCAAmD;AAGnD,MAAM,KAAK,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAkB,EAAE,CAAC,CAAC;IAC3E,aAAa,EAAE,CAAO,OAAO,EAAE,EAAE;QAC/B,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE;YAC9E,OAAO,OAAO,CAAC,WAAW,CAAC;SAC5B;QACD,OAAO,IAAA,mBAAW,EAA0B,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC,CAAA;IACD,eAAe,EAAE,CAAO,OAAO,EAAE,EAAE;QACjC,OAAO,IAAA,mBAAW,EAA8B,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7F,CAAC,CAAA;IACD,YAAY,EAAE,CAAO,CAA0B,EAAE,EAAE;QACjD,OAAO,IAAA,kBAAU,EAAY,eAAe,CAAC,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAClF,CAAC,CAAA;CACF,CAAC,CAAC;AAEH,kBAAe,KAAK,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/OwneraAPI/custody-api/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,oCAAmD;AAGnD,MAAM,KAAK,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAkB,EAAE,CAAC,CAAC;IAC3E;;;;;;;OAOG;IACH,aAAa,EAAE,CAAO,OAAO,EAAE,EAAE;QAC/B,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE;YAC9E,OAAO,OAAO,CAAC,WAAW,CAAC;SAC5B;QACD,OAAO,IAAA,mBAAW,EAA0B,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC,CAAA;IACD;;;;;;;OAOG;IACH,eAAe,EAAE,CAAO,OAAO,EAAE,EAAE;QACjC,OAAO,IAAA,mBAAW,EAA8B,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7F,CAAC,CAAA;IACD;;;;;;;OAOG;IACH,YAAY,EAAE,CAAO,CAA0B,EAAE,EAAE;QACjD,OAAO,IAAA,kBAAU,EAAY,eAAe,CAAC,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAClF,CAAC,CAAA;CACF,CAAC,CAAC;AAEH,kBAAe,KAAK,CAAC"}

package/lib/OwneraAPI/finp2p-node-api/certificates.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const certificates = (connector, logger) => ({
+    /**
+     * @description Create certificate
+     *
+     * @param request
+     * @param options
+     *
+     * @returns
+     *
+     */
     create: (request, options) => {
         const { subjectId, type, issuanceDate, expirationDate, data } = request;
         return (0, utils_1.apiPost)(`/profiles/${subjectId}/certificates`, {
@@ -11,6 +20,15 @@ const certificates = (connector, logger) => ({
             data: JSON.stringify(data),
         }, connector, logger, options);
     },
+    /**
+     * @description Update certificate
+     *
+     * @param request
+     * @param options
+     *
+     * @returns
+     *
+     */
     update: (request, options) => {
         const { profileId, certificateId, data, expirationDate, issuanceDate } = request;
         return (0, utils_1.apiPut)(`/profiles/${profileId}/certificates/${certificateId}`, {

package/lib/OwneraAPI/finp2p-node-api/certificates.js.map

@@ -1 +1 @@
-{"version":3,"file":"certificates.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/certificates.ts"],"names":[],"mappings":";;AAQA,oCAA2C;AAI3C,MAAM,YAAY,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAgB,EAAE,CAAC,CAAC;IAChF,MAAM,EAAE,CAAC,OAA2B,EAAE,OAAwB,EAAuB,EAAE;QACrF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACxE,OAAO,IAAA,eAAO,EACZ,aAAa,SAAS,eAAe,EACrC;YACE,IAAI;YACJ,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;YAC7C,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;YACjD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,EACD,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,CAAC,OAAkC,EAAE,OAAwB,EAAiB,EAAE;QACtF,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QACjF,OAAO,IAAA,cAAM,EACX,aAAa,SAAS,iBAAiB,aAAa,EAAE,EACtD;YACE,IAAI;YACJ,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;YACjD,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;SAC9C,EACD,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,YAAY,CAAC"}
+{"version":3,"file":"certificates.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/certificates.ts"],"names":[],"mappings":";;AAQA,oCAA2C;AAI3C,MAAM,YAAY,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAgB,EAAE,CAAC,CAAC;IAC9E;;;;;;;;OAQG;IACL,MAAM,EAAE,CAAC,OAA2B,EAAE,OAAwB,EAAuB,EAAE;QACrF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACxE,OAAO,IAAA,eAAO,EACZ,aAAa,SAAS,eAAe,EACrC;YACE,IAAI;YACJ,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;YAC7C,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;YACjD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,EACD,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;IACC;;;;;;;;OAQG;IACL,MAAM,EAAE,CAAC,OAAkC,EAAE,OAAwB,EAAiB,EAAE;QACtF,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,cAAc,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QACjF,OAAO,IAAA,cAAM,EACX,aAAa,SAAS,iBAAiB,aAAa,EAAE,EACtD;YACE,IAAI;YACJ,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;YACjD,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;SAC9C,EACD,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,YAAY,CAAC"}

package/lib/OwneraAPI/finp2p-node-api/documents.js

@@ -2,13 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const documents = (connector, logger) => ({
+    /**
+     * @description Create Document
+     *
+     * @param request
+     * @param options
+     *
+     * @returns
+     *
+     */
     create: (request, options) => {
         const { profileId, certificateId, files } = request;
         return (0, utils_1.docPost)(`/profiles/${profileId}/certificates/${certificateId}/docs`, files, connector, logger, options);
     },
+    /**
+     * @description Get Document
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     get: (request) => {
         return (0, utils_1.docGetFile)(`/docs/${request.uri}`, connector, logger);
     },
+    /**
+     * @description Update Document
+     *
+     * @param request
+     * @param options
+     *
+     * @returns
+     *
+     */
     update: (request, options) => {
         const { profileId, certificateId, id, file } = request;
         return (0, utils_1.docPut)(`/profiles/${profileId}/certificates/${certificateId}/docs/${id}`, { file }, connector, logger, options);

package/lib/OwneraAPI/finp2p-node-api/documents.js.map

@@ -1 +1 @@
-{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/documents.ts"],"names":[],"mappings":";;AAQA,oCAAuD;AAIvD,MAAM,SAAS,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAa,EAAE,CAAC,CAAC;IAC1E,MAAM,EAAE,CAAC,OAA+B,EAAE,OAAwB,EAA6B,EAAE;QAC/F,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACpD,OAAO,IAAA,eAAO,EACZ,aAAa,SAAS,iBAAiB,aAAa,OAAO,EAC3D,KAAK,EACL,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;IAED,GAAG,EAAE,CAAC,OAA2B,EAAkC,EAAE;QACnE,OAAO,IAAA,kBAAU,EAAC,SAAS,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,EAAE,CAAC,OAA+B,EAAE,OAAwB,EAAiB,EAAE;QACnF,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACvD,OAAO,IAAA,cAAM,EACX,aAAa,SAAS,iBAAiB,aAAa,SAAS,EAAE,EAAE,EACjE,EAAE,IAAI,EAAE,EACR,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,SAAS,CAAC"}
+{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/documents.ts"],"names":[],"mappings":";;AAQA,oCAAuD;AAIvD,MAAM,SAAS,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAa,EAAE,CAAC,CAAC;IAC1E;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,OAA+B,EAAE,OAAwB,EAA6B,EAAE;QAC/F,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;QACpD,OAAO,IAAA,eAAO,EACZ,aAAa,SAAS,iBAAiB,aAAa,OAAO,EAC3D,KAAK,EACL,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,EAAE,CAAC,OAA2B,EAAkC,EAAE;QACnE,OAAO,IAAA,kBAAU,EAAC,SAAS,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,OAA+B,EAAE,OAAwB,EAAiB,EAAE;QACnF,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACvD,OAAO,IAAA,cAAM,EACX,aAAa,SAAS,iBAAiB,aAAa,SAAS,EAAE,EAAE,EACjE,EAAE,IAAI,EAAE,EACR,SAAS,EACT,MAAM,EACN,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,SAAS,CAAC"}

package/lib/OwneraAPI/finp2p-node-api/messages.js

@@ -6,6 +6,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const form_data_1 = __importDefault(require("form-data"));
 const messages = (connector, logger) => ({
+    /**
+     * @description Send message
+     *
+     * @param request
+     * @param options
+     *
+     * @returns
+     *
+     */
     sendMessage: (request, options) => {
         const formData = new form_data_1.default();
         const tmpRequest = Object.assign({}, request);
@@ -34,6 +43,14 @@ const messages = (connector, logger) => ({
         attachments.map((a) => formData.append(`attachments`, a));
         return (0, utils_1.apiPost)('/messages/send', formData, connector, logger, Object.assign(Object.assign({}, options), { multipart: true }));
     },
+    /**
+     * @description Get attachment
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     getAttachment: (request) => {
         return (0, utils_1.docGetFile)(`/messages/attachments/${request.uuid}`, connector, logger);
     },

package/lib/OwneraAPI/finp2p-node-api/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/messages.ts"],"names":[],"mappings":";;;;;AAAA,oCAA+C;AAK/C,0DAAiC;AAGjC,MAAM,QAAQ,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAY,EAAE,CAAC,CAAC;IACxE,WAAW,EAAE,CAAC,OAA2B,EAAE,OAAwB,EAA6B,EAAE;QAChG,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,MAAM,UAAU,qBAAqC,OAAO,CAAE,CAAC;QAC/D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE;YAC5B,OAAO,UAAU,CAAC,WAAW,CAAC;SAC/B;QAED,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACvC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE;gBAC5B,KAAK,CAAC,CAAC,CAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aACjE;iBAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,eAAe,EAAE;gBACvC,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAkB,CAAC;gBAChD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnC,MAAM,CAAC,GAAG,aAAa,CAAC,CAAwB,CAAC,CAAC;oBAClD,IAAI,CAAC,CAAC,CAAC,EAAE;wBACP,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;qBACvB;gBACH,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;QACH,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC;QAE1D,OAAO,IAAA,eAAO,EAAwB,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kCAC9E,OAAO,KACV,SAAS,EAAE,IAAI,IACf,CAAC;IACL,CAAC;IACD,aAAa,EAAE,CAAC,OAA6B,EAAkC,EAAE;QAC/E,OAAO,IAAA,kBAAU,EAAC,yBAAyB,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAChF,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/messages.ts"],"names":[],"mappings":";;;;;AAAA,oCAA+C;AAK/C,0DAAiC;AAGjC,MAAM,QAAQ,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAY,EAAE,CAAC,CAAC;IACxE;;;;;;;;OAQG;IACH,WAAW,EAAE,CAAC,OAA2B,EAAE,OAAwB,EAA6B,EAAE;QAChG,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAChC,MAAM,UAAU,qBAAqC,OAAO,CAAE,CAAC;QAC/D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE;YAC5B,OAAO,UAAU,CAAC,WAAW,CAAC;SAC/B;QAED,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACvC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE;gBAC5B,KAAK,CAAC,CAAC,CAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;aACjE;iBAAM,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,eAAe,EAAE;gBACvC,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAkB,CAAC;gBAChD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnC,MAAM,CAAC,GAAG,aAAa,CAAC,CAAwB,CAAC,CAAC;oBAClD,IAAI,CAAC,CAAC,CAAC,EAAE;wBACP,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;qBACvB;gBACH,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;aAClC;QACH,CAAC,CAAC,CAAC;QACH,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC;QAE1D,OAAO,IAAA,eAAO,EAAwB,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kCAC9E,OAAO,KACV,SAAS,EAAE,IAAI,IACf,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACH,aAAa,EAAE,CAAC,OAA6B,EAAkC,EAAE;QAC/E,OAAO,IAAA,kBAAU,EAAC,yBAAyB,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAChF,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,QAAQ,CAAC"}

package/lib/OwneraAPI/finp2p-node-api/operations.js

@@ -2,18 +2,58 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const operations = (connector, logger) => ({
+    /**
+     * @description Get execution operation status
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     executionOperationStatus: (request) => {
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
+    /**
+     * @description Get profile operation status
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     profileOperationStatus: (request) => {
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
+    /**
+     * @description Get deposit operation status
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     depositOperationStatus: (request) => {
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
+    /**
+     * @description Get withdraw operation status
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     withdrawOperationStatus: (request) => {
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
+    /**
+     * @description Wait operation completion
+     *
+     * @param request
+     *
+     * @returns
+     *
+     */
     waitOperationCompletion: (request) => {
         return (0, utils_1.waitOperation)(request.cid, request.subscriptionExpiry, connector, logger, request.delay);
     },

package/lib/OwneraAPI/finp2p-node-api/operations.js.map

@@ -1 +1 @@
-{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/operations.ts"],"names":[],"mappings":";;AACA,oCAAiD;AAKjD,MAAM,UAAU,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAc,EAAE,CAAC,CAAC;IAC5E,wBAAwB,EAAE,CAAC,OAAkC,EAA4B,EAAE;QACzF,OAAO,IAAA,cAAM,EAAkB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;IACD,sBAAsB,EAAE,CAAC,OAAkC,EAA6B,EAAE;QACxF,OAAO,IAAA,cAAM,EAAmB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,CAAC;IACD,sBAAsB,EAAE,CAAC,OAAkC,EAA4B,EAAE;QACvF,OAAO,IAAA,cAAM,EAAkB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;IACD,uBAAuB,EAAE,CAAC,OAAkC,EAA6B,EAAE;QACzF,OAAO,IAAA,cAAM,EAAmB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,CAAC;IACD,uBAAuB,EAAE,CAAsB,OAAqC,EAAc,EAAE;QAClG,OAAO,IAAA,qBAAa,EAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,kBAAkB,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAClG,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,UAAU,CAAC"}
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/operations.ts"],"names":[],"mappings":";;AACA,oCAAiD;AAKjD,MAAM,UAAU,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAc,EAAE,CAAC,CAAC;IAC5E;;;;;;;OAOG;IACH,wBAAwB,EAAE,CAAC,OAAkC,EAA4B,EAAE;QACzF,OAAO,IAAA,cAAM,EAAkB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;IACD;;;;;;;OAOG;IACH,sBAAsB,EAAE,CAAC,OAAkC,EAA6B,EAAE;QACxF,OAAO,IAAA,cAAM,EAAmB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,CAAC;IACD;;;;;;;OAOG;IACH,sBAAsB,EAAE,CAAC,OAAkC,EAA4B,EAAE;QACvF,OAAO,IAAA,cAAM,EAAkB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACzF,CAAC;IACD;;;;;;;OAOG;IACH,uBAAuB,EAAE,CAAC,OAAkC,EAA6B,EAAE;QACzF,OAAO,IAAA,cAAM,EAAmB,sBAAsB,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1F,CAAC;IACD;;;;;;;OAOG;IACH,uBAAuB,EAAE,CAAsB,OAAqC,EAAc,EAAE;QAClG,OAAO,IAAA,qBAAa,EAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,kBAAkB,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAClG,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,UAAU,CAAC"}

package/lib/OwneraAPI/finp2p-node-api/organizations.js

@@ -11,7 +11,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const organizations = (nodeMSP, client, logger) => ({
+    /**
+     * @description Get current organization Id
+     *
+     * @returns
+     *
+     */
     getOrganizationId: () => __awaiter(void 0, void 0, void 0, function* () { return nodeMSP.toLowerCase().replace('msp', ''); }),
+    /**
+     * @description Get organizations
+     *
+     * @returns
+     *
+     */
     getOrganizations: () => __awaiter(void 0, void 0, void 0, function* () {
         var _a;
         const query = `

package/lib/OwneraAPI/finp2p-node-api/organizations.js.map

@@ -1 +1 @@
-{"version":3,"file":"organizations.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/organizations.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,oCAA+C;AAM/C,MAAM,aAAa,GAAG,CAAC,OAAe,EAAE,MAAiB,EAAE,MAAc,EAAiB,EAAE,CAAC,CAAC;IAC5F,iBAAiB,EAAE,GAAS,EAAE,kDAAC,OAAA,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA,GAAA;IACvE,gBAAgB,EAAE,GAAS,EAAE;;QAC3B,MAAM,KAAK,GAAG;;;;;;;;;;;;KAYb,CAAC;QACF,MAAM,UAAU,GAAsB;YACpC,KAAK,EAAE,CAAC,GAAQ,EAAE,EAAE,eAAC,OAAA,CAAA,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,aAAa,0CAAE,KAAK,0CAAE,MAAM,IAAG,CAAC,CAAA,EAAA;YAC1D,IAAI,EAAE,kBAAkB;SACzB,CAAC;QACF,MAAM,OAAO,GAAG,CAAC,MAAM,IAAA,gBAAQ,EAAsB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC;QACvG,OAAO,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,EAAE,CAAC;IAC9B,CAAC,CAAA;CACF,CAAC,CAAC;AAEH,kBAAe,aAAa,CAAC"}
+{"version":3,"file":"organizations.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/organizations.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,oCAA+C;AAM/C,MAAM,aAAa,GAAG,CAAC,OAAe,EAAE,MAAiB,EAAE,MAAc,EAAiB,EAAE,CAAC,CAAC;IAC5F;;;;;OAKG;IACH,iBAAiB,EAAE,GAAS,EAAE,kDAAC,OAAA,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA,GAAA;IACvE;;;;;OAKG;IACH,gBAAgB,EAAE,GAAS,EAAE;;QAC3B,MAAM,KAAK,GAAG;;;;;;;;;;;;KAYb,CAAC;QACF,MAAM,UAAU,GAAsB;YACpC,KAAK,EAAE,CAAC,GAAQ,EAAE,EAAE,eAAC,OAAA,CAAA,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,aAAa,0CAAE,KAAK,0CAAE,MAAM,IAAG,CAAC,CAAA,EAAA;YAC1D,IAAI,EAAE,kBAAkB;SACzB,CAAC;QACF,MAAM,OAAO,GAAG,CAAC,MAAM,IAAA,gBAAQ,EAAsB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC;QACvG,OAAO,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,EAAE,CAAC;IAC9B,CAAC,CAAA;CACF,CAAC,CAAC;AAEH,kBAAe,aAAa,CAAC"}

package/lib/OwneraAPI/finp2p-node-api/payments.js

@@ -2,7 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const payments = (connector, logger) => ({
+    /**
+     * @description Deposit money
+     *
+     * @param request
+     * @param options
+     *
+     * @returns
+     *
+     */
     deposit: (request, options) => (0, utils_1.apiPost)(`/payments/deposit`, request, connector, logger, options),
+    /**
+     * @description Withdraw money
+     *
+     * @param request
+     * @param options
+     *
+     * @returns
+     *
+     */
     withdraw: (request, options) => (0, utils_1.apiPost)(`/payments/withdraw`, request, connector, logger, options),
 });
 exports.default = payments;

package/lib/OwneraAPI/finp2p-node-api/payments.js.map

@@ -1 +1 @@
-{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/payments.ts"],"names":[],"mappings":";;AACA,oCAAmC;AAKnC,MAAM,QAAQ,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAY,EAAE,CAAC,CAAC;IACxE,OAAO,EAAE,CAAC,OAAuB,EAAE,OAAwB,EAA4B,EAAE,CACvF,IAAA,eAAO,EAAkC,mBAAmB,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC;IACpG,QAAQ,EAAE,CAAC,OAAwB,EAAE,OAAwB,EAA6B,EAAE,CAC1F,IAAA,eAAO,EAAoC,oBAAoB,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC;CACxG,CAAC,CAAC;AAEH,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../../src/OwneraAPI/finp2p-node-api/payments.ts"],"names":[],"mappings":";;AACA,oCAAmC;AAKnC,MAAM,QAAQ,GAAG,CAAC,SAAwB,EAAE,MAAc,EAAY,EAAE,CAAC,CAAC;IACxE;;;;;;;;OAQG;IACH,OAAO,EAAE,CAAC,OAAuB,EAAE,OAAwB,EAA4B,EAAE,CACvF,IAAA,eAAO,EAAkC,mBAAmB,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC;IACpG;;;;;;;;OAQG;IACH,QAAQ,EAAE,CAAC,OAAwB,EAAE,OAAwB,EAA6B,EAAE,CAC1F,IAAA,eAAO,EAAoC,oBAAoB,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC;CACxG,CAAC,CAAC;AAEH,kBAAe,QAAQ,CAAC"}