xumm-sdk - npm Package Compare versions

Comparing version 0.4.6 to 0.5.0

dist/src/index.d.ts

@@ -17,3 +17,3 @@ import { Storage } from './Storage';
     getCuratedAssets(): Promise<import("./types").CuratedAssetsResponse>;
-    getKycStatus(userToken: string): Promise<"NONE" | "IN_PROGRESS" | "REJECTED" | "SUCCESSFUL">;
+    getKycStatus(userTokenOrAccount: string): Promise<"NONE" | "IN_PROGRESS" | "REJECTED" | "SUCCESSFUL">;
     getTransaction(txHash: string): Promise<import("./types").XrplTransaction>;
@@ -20,0 +20,0 @@ }

dist/src/index.js

@@ -61,4 +61,4 @@ "use strict";
     }
-    getKycStatus(userToken) {
-        return this.Meta.getKycStatus(userToken);
+    getKycStatus(userTokenOrAccount) {
+        return this.Meta.getKycStatus(userTokenOrAccount);
     }
@@ -65,0 +65,0 @@ getTransaction(txHash) {

dist/src/Meta.d.ts

@@ -9,4 +9,4 @@ import type { ApplicationDetails, CreatePayload, AnyJson, CuratedAssetsResponse, PossibleKycStatuses, XrplTransaction } from './types';
     getCuratedAssets(): Promise<CuratedAssetsResponse>;
-    getKycStatus(userToken: string): Promise<keyof PossibleKycStatuses>;
+    getKycStatus(userTokenOrAccount: string): Promise<keyof PossibleKycStatuses>;
     getTransaction(txHash: string): Promise<XrplTransaction>;
 }

dist/src/Meta.js

@@ -82,8 +82,14 @@ "use strict";
     }
-    getKycStatus(userToken) {
+    getKycStatus(userTokenOrAccount) {
         return __awaiter(this, void 0, void 0, function* () {
-            const call = yield this.call('kyc-status', 'POST', {
-                user_token: userToken
-            });
-            return (call === null || call === void 0 ? void 0 : call.kycStatus) || 'NONE';
+            if (userTokenOrAccount.trim().match(/^r/)) {
+                const call = yield this.call('kyc-status/' + userTokenOrAccount.trim());
+                return (call === null || call === void 0 ? void 0 : call.kycApproved) ? 'SUCCESSFUL' : 'NONE';
+            }
+            else {
+                const call = yield this.call('kyc-status', 'POST', {
+                    user_token: userTokenOrAccount
+                });
+                return (call === null || call === void 0 ? void 0 : call.kycStatus) || 'NONE';
+            }
         });
@@ -90,0 +96,0 @@ }

dist/src/types/index.d.ts

@@ -6,2 +6,3 @@ export * from './xumm-api';
 export type { KycStatusResponse, PossibleKycStatuses } from './Meta/KycStatusResponse';
+export type { KycInfoResponse } from './Meta/KycInfoResponse';
 export type { Pong } from './Meta/Pong';
@@ -8,0 +9,0 @@ export type { XrplTransaction } from './Meta/XrplTransaction';

package.json

 {
   "name": "xumm-sdk",
-  "version": "0.4.6",
+  "version": "0.5.0",
   "description": "Interact with the Xumm Developer API",
@@ -5,0 +5,0 @@ "main": "dist/src/index.js",

README.md

@@ -115,2 +115,5 @@ # XUMM SDK (JS/TS) [![npm version](https://badge.fury.io/js/xumm-sdk.svg)](https://www.npmjs.com/xumm-sdk) [![GitHub Actions NodeJS status](https://github.com/XRPL-Labs/XUMM-SDK/workflows/NodeJS/badge.svg?branch=master)](https://github.com/XRPL-Labs/XUMM-SDK/actions) [![GitHub Actions Deno status](https://github.com/XRPL-Labs/XUMM-SDK/workflows/Deno/badge.svg?branch=master)](https://github.com/XRPL-Labs/XUMM-SDK/actions)
 
+Alternatively, KYC status can be retrieved for an XPRL account address: the address selected in
+XUMM when the session KYC was initiated by.
+
 ```typescript
@@ -120,2 +123,7 @@ const kycStatus = await Sdk.getKycStatus('00000000-0000-0000-0000-000000000000')
 
+... or using an account address:
+```typescript
+const kycStatus = await Sdk.getKycStatus('rwu1dgaUq8DCj3ZLFXzRbc1Aco5xLykMMQ')
+```
+
 Returns [`<keyof PossibleKycStatuses>`](https://github.com/XRPL-Labs/XUMM-SDK/blob/master/src/types/Meta/KycStatusResponse.ts#L1).
@@ -122,0 +130,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

57730

increased by1.53%

Number of package files

57

increased by3.64%

Lines of code

947

increased by1.39%

Number of lines in readme file

397

increased by2.06%

No dependency changes