@huma-finance/shared 0.0.30 → 0.0.32

package/dist/services/EAService.d.ts

@@ -1,153 +1,153 @@
-/**
- * Object representing the token information of the approval.
- * @typedef {Object} Token
- * @property {string} symbol The symbol of the base token of the pool.
- * @property {string} name The name of the base token of the pool.
- * @property {number} decimal The number of decimals for the base token of the pool.
- */
-type Token = {
-    symbol: string;
-    name: string;
-    decimal: number;
-};
-/**
- * Object representing the approved loan terms.
- * @typedef {Object} Terms
- * @property {string} creditLimit The credit limit for the borrower in the pool's base currency.
- * @property {string} creditLimitFormatted The credit limit for the borrower in the pool's base currency, formatted with that tokens' decimals.
- * @property {number} intervalInDays The interval in days for credit line rebalancing.
- * @property {number} remainingPeriods The number of remaining payback periods in the credit line.
- * @property {number} aprInBps The annual percentage rate in basis points.
- */
-type Terms = {
-    creditLimit: string;
-    creditLimitFormatted: string;
-    intervalInDays: number;
-    remainingPeriods: number;
-    aprInBps: number;
-};
-/**
- * Object representing receivable information of the approval.
- * @typedef {Object} Receivable
- * @property {string} asset The address of the receivable asset contract.
- * @property {number|string} param The identifying parameter for the receivable asset, often the token ID of an ERC721.
- * @property {string} amount The expected payment amount of the receivable asset.
- * @property {string} amountFormatted The expected payment amount of the receivable asset, formatted with that tokens' decimals.
- */
-type Receivable = {
-    asset: string;
-    param: string;
-    amount: string;
-    amountFormatted: string;
-};
-/**
- * Object representing EA approval.
- * @typedef {Object} Approval
- * @property {Token} token The token information for the approval.
- * @property {Terms} terms The approved loan terms.
- * @property {Receivable} receivable The receivable information.
- */
-export type Approval = {
-    token: Token;
-    terms: Terms;
-    receivable?: Receivable;
-};
-/**
- * Object representing EA rejection.
- * @typedef {Object} Rejection
- * @property {string[]} reasons Rejection reasons.
- */
-export type Rejection = {
-    reasons: string[];
-};
-/**
- * Object representing the response to the underwriting approval request.
- * @typedef {Object} ApprovalResult
- * @property {Approval | Rejection} result the EA decision, either an approval or rejection.
- */
-export type ApprovalResult = {
-    result: Approval | Rejection;
-};
-/**
- * Object representing the receivable in an underwriting request.
- * @typedef {Object} ReceivableRequest
- * @property {string} address The address of the receivable asset contract.
- * @property {string} [param] The parameter for the receivable asset. E.g. For Request Network integrations,
- * this would be the request ID associated with the ERC20TransferableReceivable.
- */
-type ReceivableRequest = {
-    address: string;
-    param?: string;
-};
-/**
- * Object representing the additional data required for a receivable-based underwriting request.
- * @typedef {Object} EARequestContextReceivable
- * @property {ReceivableRequest} receivable The receivable information.
- */
-type EARequestContextReceivable = {
-    receivable: ReceivableRequest;
-};
-/**
- * Object representing the additional data required for a stream factoring underwriting request.
- * @typedef {Object} EARequestContextStream
- * @property {ReceivableRequest} receivable The receivable information.
- * @property {string} payerWalletAddress The address of the payer.
- * @property {string} superToken The address of the SuperToken contract.
- */
-type EARequestContextStream = {
-    receivable: ReceivableRequest;
-    payerWalletAddress: string;
-    superToken: string;
-};
-/**
- * Object that represents the payload for an underwriting request.
- * @typedef {Object} EAPayload
- * @property {string} poolAddress The pool address to approve.
- * @property {string} borrowerWalletAddress The address of the borrower.
- * @property {EARequestContextReceivable | EARequestContextStream} [context] Extra values to submit with the approval request.
- */
-export type EAPayload = {
-    poolAddress: string;
-    borrowerWalletAddress: string;
-    context?: EARequestContextReceivable | EARequestContextStream;
-};
-/**
- * Object representing the response to the underwriting preapproval request.
- * @typedef {Object} PreapprovalResult
- * @property {boolean} approved the EA decision, either an approval or rejection.
- * @property {string[]} [rejectionReasons] The reasons for rejection, if any
- */
-export type PreapprovalResult = {
-    approved: boolean;
-    rejectionReasons?: string[];
-};
-/**
- * Object that includes extra data to be submitted to the underwriting preapproval request when
- * checking for receivable requests
- * @typedef {Object} EAPreapproveContextReceivable
- * @property {string} payerWalletAddress The wallet of the payer of the receivable
- */
-type EAPreapproveContextReceivable = {
-    payerWalletAddress: string;
-};
-/**
- * Object that represents the payload for a preapprove check.
- * @typedef {Object} EAPreapprovalPayload
- * @property {string} poolAddress The pool address to approve.
- * @property {string} borrowerWalletAddress The address of the borrower.
- * @property {EAPreapproveContextReceivable} [context] Extra values to submit with the preapproval request.
- */
-export type EAPreapprovalPayload = {
-    poolAddress: string;
-    borrowerWalletAddress: string;
-    context?: EAPreapproveContextReceivable;
-};
-export declare const EAService: {
-    approve: (payload: EAPayload, chainId: number, isDev?: boolean) => Promise<Approval>;
-    approveLender: (payload: {
-        poolAddress: string;
-        lenderWalletAddress: string;
-    }, chainId: number) => Promise<ApprovalResult>;
-    preapprove: (payload: EAPreapprovalPayload, chainId: number, isDev?: boolean) => Promise<PreapprovalResult>;
-};
-export {};
+/**
+ * Object representing the token information of the approval.
+ * @typedef {Object} Token
+ * @property {string} symbol The symbol of the base token of the pool.
+ * @property {string} name The name of the base token of the pool.
+ * @property {number} decimal The number of decimals for the base token of the pool.
+ */
+type Token = {
+    symbol: string;
+    name: string;
+    decimal: number;
+};
+/**
+ * Object representing the approved loan terms.
+ * @typedef {Object} Terms
+ * @property {string} creditLimit The credit limit for the borrower in the pool's base currency.
+ * @property {string} creditLimitFormatted The credit limit for the borrower in the pool's base currency, formatted with that tokens' decimals.
+ * @property {number} intervalInDays The interval in days for credit line rebalancing.
+ * @property {number} remainingPeriods The number of remaining payback periods in the credit line.
+ * @property {number} aprInBps The annual percentage rate in basis points.
+ */
+type Terms = {
+    creditLimit: string;
+    creditLimitFormatted: string;
+    intervalInDays: number;
+    remainingPeriods: number;
+    aprInBps: number;
+};
+/**
+ * Object representing receivable information of the approval.
+ * @typedef {Object} Receivable
+ * @property {string} asset The address of the receivable asset contract.
+ * @property {number|string} param The identifying parameter for the receivable asset, often the token ID of an ERC721.
+ * @property {string} amount The expected payment amount of the receivable asset.
+ * @property {string} amountFormatted The expected payment amount of the receivable asset, formatted with that tokens' decimals.
+ */
+type Receivable = {
+    asset: string;
+    param: string;
+    amount: string;
+    amountFormatted: string;
+};
+/**
+ * Object representing EA approval.
+ * @typedef {Object} Approval
+ * @property {Token} token The token information for the approval.
+ * @property {Terms} terms The approved loan terms.
+ * @property {Receivable} receivable The receivable information.
+ */
+export type Approval = {
+    token: Token;
+    terms: Terms;
+    receivable?: Receivable;
+};
+/**
+ * Object representing EA rejection.
+ * @typedef {Object} Rejection
+ * @property {string[]} reasons Rejection reasons.
+ */
+export type Rejection = {
+    reasons: string[];
+};
+/**
+ * Object representing the response to the underwriting approval request.
+ * @typedef {Object} ApprovalResult
+ * @property {Approval | Rejection} result the EA decision, either an approval or rejection.
+ */
+export type ApprovalResult = {
+    result: Approval | Rejection;
+};
+/**
+ * Object representing the receivable in an underwriting request.
+ * @typedef {Object} ReceivableRequest
+ * @property {string} address The address of the receivable asset contract.
+ * @property {string} [param] The parameter for the receivable asset. E.g. For Request Network integrations,
+ * this would be the request ID associated with the ERC20TransferableReceivable.
+ */
+type ReceivableRequest = {
+    address: string;
+    param?: string;
+};
+/**
+ * Object representing the additional data required for a receivable-based underwriting request.
+ * @typedef {Object} EARequestContextReceivable
+ * @property {ReceivableRequest} receivable The receivable information.
+ */
+type EARequestContextReceivable = {
+    receivable: ReceivableRequest;
+};
+/**
+ * Object representing the additional data required for a stream factoring underwriting request.
+ * @typedef {Object} EARequestContextStream
+ * @property {ReceivableRequest} receivable The receivable information.
+ * @property {string} payerWalletAddress The address of the payer.
+ * @property {string} superToken The address of the SuperToken contract.
+ */
+type EARequestContextStream = {
+    receivable: ReceivableRequest;
+    payerWalletAddress: string;
+    superToken: string;
+};
+/**
+ * Object that represents the payload for an underwriting request.
+ * @typedef {Object} EAPayload
+ * @property {string} poolAddress The pool address to approve.
+ * @property {string} borrowerWalletAddress The address of the borrower.
+ * @property {EARequestContextReceivable | EARequestContextStream} [context] Extra values to submit with the approval request.
+ */
+export type EAPayload = {
+    poolAddress: string;
+    borrowerWalletAddress: string;
+    context?: EARequestContextReceivable | EARequestContextStream;
+};
+/**
+ * Object representing the response to the underwriting preapproval request.
+ * @typedef {Object} PreapprovalResult
+ * @property {boolean} approved the EA decision, either an approval or rejection.
+ * @property {string[]} [rejectionReasons] The reasons for rejection, if any
+ */
+export type PreapprovalResult = {
+    approved: boolean;
+    rejectionReasons?: string[];
+};
+/**
+ * Object that includes extra data to be submitted to the underwriting preapproval request when
+ * checking for receivable requests
+ * @typedef {Object} EAPreapproveContextReceivable
+ * @property {string} payerWalletAddress The wallet of the payer of the receivable
+ */
+type EAPreapproveContextReceivable = {
+    payerWalletAddress: string;
+};
+/**
+ * Object that represents the payload for a preapprove check.
+ * @typedef {Object} EAPreapprovalPayload
+ * @property {string} poolAddress The pool address to approve.
+ * @property {string} borrowerWalletAddress The address of the borrower.
+ * @property {EAPreapproveContextReceivable} [context] Extra values to submit with the preapproval request.
+ */
+export type EAPreapprovalPayload = {
+    poolAddress: string;
+    borrowerWalletAddress: string;
+    context?: EAPreapproveContextReceivable;
+};
+export declare const EAService: {
+    approve: (payload: EAPayload, chainId: number, isDev?: boolean) => Promise<Approval>;
+    approveLender: (payload: {
+        poolAddress: string;
+        lenderWalletAddress: string;
+    }, chainId: number) => Promise<ApprovalResult>;
+    preapprove: (payload: EAPreapprovalPayload, chainId: number, isDev?: boolean) => Promise<PreapprovalResult>;
+};
+export {};

package/dist/services/IdentityService.d.ts

@@ -28,8 +28,25 @@ export type VerificationStatusResult = {
     isVerified: boolean;
     isNotOnboarded: boolean;
 };
+/**
+ * Object representing the response to the document signature status request.
+ * @typedef {Object} DocSignatureStatus
+ * @property {string} envelopeId the envelope id to get the document signature status.
+ * @property {string} status the document signature status.
+ */
+export type DocSignatureStatus = {
+    envelopeId: string;
+    status: 'completed' | 'created' | 'declined' | 'deleted' | 'delivered' | 'processing' | 'sent' | 'signed' | 'template' | 'voided';
+};
 export declare const IdentityService: {
     getVerificationStatus: (walletAddress: string, pool: string, chainId: number, isDev?: boolean) => Promise<VerificationStatusResult>;
     onboard: (walletAddress: string, code: string, pool: string, chainId: number, isDev?: boolean) => Promise<string>;
+    getDocSignatureStatus: (envelopeId: string, chainId: number, isDev?: boolean) => Promise<DocSignatureStatus>;
+    requestDocSignature: (walletAddress: string, chainId: number, isDev?: boolean) => Promise<{
+        envelopeId: string;
+    }>;
+    resendDocSignatureLink: (envelopeId: string, chainId: number, isDev?: boolean) => Promise<{
+        envelopeId: string;
+    }>;
 };
 export {};

package/dist/services/IdentityService.js

@@ -1,5 +1,5 @@
 import { configUtil } from '../utils/config';
-import { requestPost, requestPut } from '../utils/request';
+import { requestGet, requestPost, requestPut } from '../utils/request';
 /**
  * Enum representing the identity status.
  * @typedef {Enum} IdentityStatus
@@ -43,12 +43,39 @@ const getVerificationStatus = async (walletAddress, pool, chainId, isDev = false
  * @param {boolean} isDev Is dev environment or not.
  * @returns {Promise<string>} Promise that returns the onboard result
  */
-const onboard = async (walletAddress, code, pool, chainId, isDev = false) => {
-    const result = await requestPost(`${configUtil.getIdentityAPIUrl(chainId, isDev)}/wallets/${walletAddress}/onboard?code=${code}&poolAddress=${pool}`);
-    return result;
-};
+const onboard = async (walletAddress, code, pool, chainId, isDev = false) => requestPost(`${configUtil.getIdentityAPIUrl(chainId, isDev)}/wallets/${walletAddress}/onboard?code=${code}&poolAddress=${pool}`);
+/**
+ *  Get document signature status
+ *
+ * @param {string} envelopeId The envelope id.
+ * @param {number} chainId chain Id.
+ * @param {boolean} isDev Is dev environment or not.
+ * @returns {Promise<{envelopeId: string}>} Promise that returns the envelope id
+ */
+const getDocSignatureStatus = async (envelopeId, chainId, isDev = false) => requestGet(`${configUtil.getIdentityAPIUrl(chainId, isDev)}/${envelopeId}/document-signature-status`);
+/**
+ * Request document signature
+ *
+ * @param {string} walletAddress The wallet address.
+ * @param {number} chainId chain Id.
+ * @param {boolean} isDev Is dev environment or not.
+ * @returns {Promise<{envelopeId: string}>} Promise that returns the envelope id
+ */
+const requestDocSignature = async (walletAddress, chainId, isDev = false) => requestPost(`${configUtil.getIdentityAPIUrl(chainId, isDev)}/request-document-signature`, { walletAddress });
+/**
+ * Resend document signature link
+ *
+ * @param {string} envelopeId The envelope id.
+ * @param {number} chainId chain Id.
+ * @param {boolean} isDev Is dev environment or not.
+ * @returns {Promise<{envelopeId: string}>} Promise that returns the envelope id
+ */
+const resendDocSignatureLink = async (envelopeId, chainId, isDev = false) => requestPost(`${configUtil.getIdentityAPIUrl(chainId, isDev)}/resend-document-signature-link`, { envelopeId });
 export const IdentityService = {
     getVerificationStatus,
     onboard,
+    getDocSignatureStatus,
+    requestDocSignature,
+    resendDocSignatureLink,
 };
 //# sourceMappingURL=IdentityService.js.map

package/dist/services/IdentityService.js.map

@@ -1 +1 @@
-{"version":3,"file":"IdentityService.js","sourceRoot":"","sources":["../../src/services/IdentityService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE1D;;;GAGG;AACH,IAAK,0BAWJ;AAXD,WAAK,0BAA0B;IAC7B,uDAAyB,CAAA;IACzB,2FAA6D,CAAA;IAC7D,+DAAiC,CAAA;IACjC,6EAA+C,CAAA;IAC/C,iGAAmE,CAAA;IACnE,2FAA6D,CAAA;IAC7D,6FAA+D,CAAA;IAC/D,+GAAiF,CAAA;IACjF,qGAAuE,CAAA;IACvE,uEAAyC,CAAA;AAC3C,CAAC,EAXI,0BAA0B,KAA1B,0BAA0B,QAW9B;AAiBD;;;;;;;;GAQG;AACH,MAAM,qBAAqB,GAAG,KAAK,EACjC,aAAqB,EACrB,IAAY,EACZ,OAAe,EACf,KAAK,GAAG,KAAK,EACsB,EAAE;IACrC,MAAM,MAAM,GAAG,MAAM,UAAU,CAC7B,GAAG,UAAU,CAAC,iBAAiB,CAC7B,OAAO,EACP,KAAK,CACN,YAAY,aAAa,oCAAoC,IAAI,EAAE,CACrE,CAAA;IAED,MAAM,CAAC,UAAU,GAAG,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC,QAAQ,CAClE,MAAM,CAAC,kBAAkB,CAC1B,CAAA;IACD,MAAM,CAAC,cAAc;QACnB,MAAM,CAAC,kBAAkB,KAAK,0BAA0B,CAAC,kBAAkB,CAAA;IAE7E,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,GAAG,KAAK,EACnB,aAAqB,EACrB,IAAY,EACZ,IAAY,EACZ,OAAe,EACf,KAAK,GAAG,KAAK,EACI,EAAE;IACnB,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,GAAG,UAAU,CAAC,iBAAiB,CAC7B,OAAO,EACP,KAAK,CACN,YAAY,aAAa,iBAAiB,IAAI,gBAAgB,IAAI,EAAE,CACtE,CAAA;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,qBAAqB;IACrB,OAAO;CACR,CAAA"}
+{"version":3,"file":"IdentityService.js","sourceRoot":"","sources":["../../src/services/IdentityService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAEtE;;;GAGG;AACH,IAAK,0BAWJ;AAXD,WAAK,0BAA0B;IAC7B,uDAAyB,CAAA;IACzB,2FAA6D,CAAA;IAC7D,+DAAiC,CAAA;IACjC,6EAA+C,CAAA;IAC/C,iGAAmE,CAAA;IACnE,2FAA6D,CAAA;IAC7D,6FAA+D,CAAA;IAC/D,+GAAiF,CAAA;IACjF,qGAAuE,CAAA;IACvE,uEAAyC,CAAA;AAC3C,CAAC,EAXI,0BAA0B,KAA1B,0BAA0B,QAW9B;AAsCD;;;;;;;;GAQG;AACH,MAAM,qBAAqB,GAAG,KAAK,EACjC,aAAqB,EACrB,IAAY,EACZ,OAAe,EACf,KAAK,GAAG,KAAK,EACsB,EAAE;IACrC,MAAM,MAAM,GAAG,MAAM,UAAU,CAC7B,GAAG,UAAU,CAAC,iBAAiB,CAC7B,OAAO,EACP,KAAK,CACN,YAAY,aAAa,oCAAoC,IAAI,EAAE,CACrE,CAAA;IAED,MAAM,CAAC,UAAU,GAAG,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC,QAAQ,CAClE,MAAM,CAAC,kBAAkB,CAC1B,CAAA;IACD,MAAM,CAAC,cAAc;QACnB,MAAM,CAAC,kBAAkB,KAAK,0BAA0B,CAAC,kBAAkB,CAAA;IAE7E,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,GAAG,KAAK,EACnB,aAAqB,EACrB,IAAY,EACZ,IAAY,EACZ,OAAe,EACf,KAAK,GAAG,KAAK,EACI,EAAE,CACnB,WAAW,CACT,GAAG,UAAU,CAAC,iBAAiB,CAC7B,OAAO,EACP,KAAK,CACN,YAAY,aAAa,iBAAiB,IAAI,gBAAgB,IAAI,EAAE,CACtE,CAAA;AAEH;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,KAAK,EACjC,UAAkB,EAClB,OAAe,EACf,KAAK,GAAG,KAAK,EACgB,EAAE,CAC/B,UAAU,CACR,GAAG,UAAU,CAAC,iBAAiB,CAC7B,OAAO,EACP,KAAK,CACN,IAAI,UAAU,4BAA4B,CAC5C,CAAA;AAEH;;;;;;;GAOG;AACH,MAAM,mBAAmB,GAAG,KAAK,EAC/B,aAAqB,EACrB,OAAe,EACf,KAAK,GAAG,KAAK,EACoB,EAAE,CACnC,WAAW,CACT,GAAG,UAAU,CAAC,iBAAiB,CAC7B,OAAO,EACP,KAAK,CACN,6BAA6B,EAC9B,EAAE,aAAa,EAAE,CAClB,CAAA;AAEH;;;;;;;GAOG;AACH,MAAM,sBAAsB,GAAG,KAAK,EAClC,UAAkB,EAClB,OAAe,EACf,KAAK,GAAG,KAAK,EACoB,EAAE,CACnC,WAAW,CACT,GAAG,UAAU,CAAC,iBAAiB,CAC7B,OAAO,EACP,KAAK,CACN,iCAAiC,EAClC,EAAE,UAAU,EAAE,CACf,CAAA;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,qBAAqB;IACrB,OAAO;IACP,qBAAqB;IACrB,mBAAmB;IACnB,sBAAsB;CACvB,CAAA"}

package/dist/services/RNService.d.ts

@@ -1,14 +1,14 @@
-export type RequestInfoType = {
-    expectedAmount: string;
-    payer: {
-        type: string;
-        value: string;
-    };
-    payee: {
-        type: string;
-        value: string;
-    };
-};
-export declare const RNService: {
-    getRequestInfo: (requestId: string, chainId: number) => Promise<any>;
-};
+export type RequestInfoType = {
+    expectedAmount: string;
+    payer: {
+        type: string;
+        value: string;
+    };
+    payee: {
+        type: string;
+        value: string;
+    };
+};
+export declare const RNService: {
+    getRequestInfo: (requestId: string, chainId: number) => Promise<any>;
+};

package/dist/services/index.d.ts

@@ -1,3 +1,3 @@
-export * from './EAService';
-export * from './RNService';
-export * from './IdentityService';
+export * from './EAService';
+export * from './RNService';
+export * from './IdentityService';