@raytio/core 10.1.0 → 11.1.0

package/dist/verifications/safeHarbour.js

@@ -1,74 +1,67 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.calcSafeHarbourScore = exports.safeHarbourRequirementsMet = exports.getFlags = exports.filterByMutualFields = void 0;
-const ramda_1 = require("ramda");
-const types_1 = require("@raytio/types");
-const getPOVerification_1 = require("./getPOVerification");
-const schema_1 = require("../schema");
-/** @internal see #659 */
-var SafeHarbourCode;
-(function (SafeHarbourCode) {
-    SafeHarbourCode["M1"] = "M1";
-    SafeHarbourCode["M2"] = "M2";
-    SafeHarbourCode["N1"] = "N1";
-})(SafeHarbourCode || (SafeHarbourCode = {}));
-/**
- * @internal
- * we filter to only include the POs where all the mutual fields match the
- * person, i.e. we only want POs that have fName, lName, etc. with the same
- * value as the base person
- */
-function filterByMutualFields(person, profileObjects) {
-    const personFields = Object.entries(person.properties).filter(([fieldName]) => fieldName !== "n_id");
-    if (!personFields.length)
-        return [];
-    return profileObjects.filter(PO => personFields.every(([k, v]) => { var _a; return ((_a = PO.properties) === null || _a === void 0 ? void 0 : _a[k]) && (0, ramda_1.equals)(PO.properties[k], v); }));
-}
-exports.filterByMutualFields = filterByMutualFields;
-/** @internal */
-async function getFlags({ person, profileObjects, realVers, getSchema, }) {
-    const POsWithSameFields = filterByMutualFields(person, profileObjects);
-    const relevantVers = (await Promise.all(POsWithSameFields.map(async (PO) => {
-        const schemaName = (0, schema_1.findSchemaLabel)(PO.labels);
-        const schema = await getSchema(schemaName);
-        return Object.assign({ nId: PO.n_id }, (0, getPOVerification_1.getPOVerification)({
-            schema,
-            PO,
-            realVers,
-        }));
-    })))
-        .filter(v => v.status === types_1.POVerification.FullyVerified)
-        .flatMap(v => v.details.verifiers.map(verProvider => realVers.find(ver => ver.belongsToNId === v.nId &&
-        ver.provider.dataSourceNId === verProvider.dataSourceNId)))
-        .filter((x) => !!x);
-    // in case there are somehow duplicates (see #922)
-    return (0, ramda_1.uniqBy)(x => x.nID, relevantVers)
-        .filter(ver => { var _a; return (_a = ver.metadata) === null || _a === void 0 ? void 0 : _a["safeHarbourScore"]; })
-        .reduce((ac, ver) => {
-        var _a, _b;
-        const key = (_a = ver.metadata) === null || _a === void 0 ? void 0 : _a["safeHarbourScore"];
-        if ((_b = ac[key]) === null || _b === void 0 ? void 0 : _b.includes(ver.xId))
-            return ac;
-        return Object.assign(Object.assign({}, ac), { [key]: [...(ac[key] || []), ver.xId] });
-    }, {});
-}
-exports.getFlags = getFlags;
-/** @internal */
-function safeHarbourRequirementsMet(flags) {
-    const { M1 = 0, M2 = 0, N1 = 0 } = (0, ramda_1.mapObjIndexed)(xIds => xIds.length, flags);
-    // see https://bit.ly/2KKo4rF
-    const isSafe = M1 >= 2 ||
-        (M1 >= 1 && M2 >= 1) ||
-        (M1 >= 1 && N1 >= 1) ||
-        (M2 >= 1 && N1 >= 1);
-    return { isSafe, flags };
-}
-exports.safeHarbourRequirementsMet = safeHarbourRequirementsMet;
-/**
- * The Safe Harbour Score indidicates whether a person's identity has been verified
- * to the extent requried for Safe Harbour Compliance. This requires multiple verifications
- * from different sources. For information, refer to the
- * {@link https://dev-docs.rayt.io/docs/features/pep-checks Raytio Documentation}.
- */
-const calcSafeHarbourScore = (data) => getFlags(data).then(safeHarbourRequirementsMet);
-exports.calcSafeHarbourScore = calcSafeHarbourScore;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calcSafeHarbourScore = exports.safeHarbourRequirementsMet = exports.getFlags = exports.filterByMutualFields = void 0;
+const ramda_1 = require("ramda");
+const types_1 = require("@raytio/types");
+const getPOVerification_1 = require("./getPOVerification");
+const schema_1 = require("../schema");
+/**
+ * @internal
+ * we filter to only include the POs where all the mutual fields match the
+ * person, i.e. we only want POs that have fName, lName, etc. with the same
+ * value as the base person
+ */
+function filterByMutualFields(person, profileObjects) {
+    const personFields = Object.entries(person.properties).filter(([fieldName]) => fieldName !== "n_id");
+    if (!personFields.length)
+        return [];
+    return profileObjects.filter(PO => personFields.every(([k, v]) => { var _a; return ((_a = PO.properties) === null || _a === void 0 ? void 0 : _a[k]) && (0, ramda_1.equals)(PO.properties[k], v); }));
+}
+exports.filterByMutualFields = filterByMutualFields;
+/** @internal */
+async function getFlags({ person, profileObjects, realVers, getSchema, }) {
+    const POsWithSameFields = filterByMutualFields(person, profileObjects);
+    const relevantVers = (await Promise.all(POsWithSameFields.map(async (PO) => {
+        const schemaName = (0, schema_1.findSchemaLabel)(PO.labels);
+        const schema = await getSchema(schemaName);
+        return Object.assign({ nId: PO.n_id }, (0, getPOVerification_1.getPOVerification)({
+            schema,
+            PO,
+            realVers,
+        }));
+    })))
+        .filter(v => v.status === types_1.POVerification.FullyVerified)
+        .flatMap(v => v.details.verifiers.map(verProvider => realVers.find(ver => ver.belongsToNId === v.nId &&
+        ver.provider.dataSourceNId === verProvider.dataSourceNId)))
+        .filter((x) => !!x);
+    // in case there are somehow duplicates (see #922)
+    return (0, ramda_1.uniqBy)(x => x.nID, relevantVers)
+        .filter(ver => { var _a; return (_a = ver.metadata) === null || _a === void 0 ? void 0 : _a.safeHarbourScore; })
+        .reduce((ac, ver) => {
+        var _a;
+        const key = ver.metadata.safeHarbourScore;
+        if ((_a = ac[key]) === null || _a === void 0 ? void 0 : _a.includes(ver.xId))
+            return ac;
+        return Object.assign(Object.assign({}, ac), { [key]: [...(ac[key] || []), ver.xId] });
+    }, {});
+}
+exports.getFlags = getFlags;
+/** @internal */
+function safeHarbourRequirementsMet(flags) {
+    const { M1 = 0, M2 = 0, N1 = 0 } = (0, ramda_1.mapObjIndexed)(xIds => xIds.length, flags);
+    // see https://bit.ly/2KKo4rF
+    const isSafe = M1 >= 2 ||
+        (M1 >= 1 && M2 >= 1) ||
+        (M1 >= 1 && N1 >= 1) ||
+        (M2 >= 1 && N1 >= 1);
+    return { isSafe, flags };
+}
+exports.safeHarbourRequirementsMet = safeHarbourRequirementsMet;
+/**
+ * The Safe Harbour Score indidicates whether a person's identity has been verified
+ * to the extent requried for Safe Harbour Compliance. This requires multiple verifications
+ * from different sources. For information, refer to the
+ * {@link https://dev-docs.rayt.io/docs/features/pep-checks Raytio Documentation}.
+ */
+const calcSafeHarbourScore = (data) => getFlags(data).then(safeHarbourRequirementsMet);
+exports.calcSafeHarbourScore = calcSafeHarbourScore;

package/dist/verifications/verifyCheck/__tests__/getOwnRealVerifications.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/verifications/verifyCheck/__tests__/getOwnRealVerifications.test.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+const operations_1 = require("../operations");
+jest.mock("../operations");
+/**
+ * in this test case:
+ *  - there are valid verifications for fName=Max and fName=Erika, but we don't which
+ *    verification corresponds to which value.
+ *  - there is an invalid verification (tampered with) for lName=Mustermann
+ *  - there are verifications for non-existant POs and fields, which will be skipped
+ *
+ * Also note:
+ *  - the verification for fName=Max is expired
+ *  - the verification for fName=Erika is "VerifiedFalse"
+ */
+describe("getOwnRealVerifications", () => {
+    beforeAll(() => {
+        operations_1.checkOwnVerification.mockImplementation(async ({ signature }) => {
+            if (signature === "signatureForLastNameMustermannFromN2")
+                return false;
+            return true;
+        });
+    });
+    it("calls the verifyCheck function for each PO, keeping only the valid ones", async () => {
+        const profileObjects = [
+            { n_id: "n1", properties: { fName: "Max", lName: "Mustermann" } },
+            { n_id: "n2", properties: { fName: "Erika", lName: "Mustermann" } },
+        ];
+        const verifications = [
+            {
+                n_id: "nv1",
+                properties: {
+                    valid_until: "2020-08-28T23:12:35.678Z",
+                    verifications: [
+                        {
+                            signature: "signatureForFirstNameMax",
+                            data: {
+                                field: "fName",
+                                verifier_source_id: "Ministry of pike river mine re-entry",
+                                verifier_service_id: "Minister for pike river re-entry",
+                                verifier_id: "v1",
+                                verification_date: "2020-08-28T23:11:20.592912",
+                                request_div: "x1",
+                                passed: true,
+                                source_n_id: "n1",
+                            },
+                        },
+                    ],
+                },
+            },
+            {
+                n_id: "nv2",
+                properties: {
+                    verifications: [
+                        {
+                            signature: "signatureForFirstNameErika",
+                            data: {
+                                field: "fName",
+                                verifier_source_id: "Ministry of pike river mine re-entry",
+                                verifier_service_id: "Minister for pike river re-entry",
+                                verifier_id: "v1",
+                                verification_date: "2020-08-28T23:11:20.592912",
+                                request_div: "x2",
+                                passed: false,
+                                source_n_id: "n2",
+                            },
+                        },
+                    ],
+                },
+            },
+            {
+                n_id: "nv3",
+                properties: {
+                    verifications: [
+                        {
+                            signature: "signatureForLastNameMustermannFromN2",
+                            data: {
+                                field: "lName",
+                                verifier_source_id: "Ministry of pike river mine re-entry",
+                                verifier_service_id: "Minister for pike river re-entry",
+                                verifier_id: "v1",
+                                verification_date: "2020-08-28T23:11:20.592912",
+                                request_div: "x3",
+                                passed: false,
+                                source_n_id: "n2", // this ver was for lName=Mustermann in n2, so doesn't apply to lName=Mustermann in n1 !
+                            },
+                        },
+                    ],
+                },
+            },
+            {
+                n_id: "nv4",
+                properties: {
+                    verifications: [{ data: { source_n_id: "doesn't exist" } }],
+                },
+            },
+            {
+                n_id: "nv5",
+                properties: {
+                    verifications: [
+                        { data: { source_n_id: "n2", field: "doesn't exist" } },
+                    ],
+                },
+            },
+        ];
+        const realVers = await (0, __1.getOwnRealVerifications)({
+            profileObjects,
+            verifications,
+            userId: "geesepolice2002",
+        });
+        expect(operations_1.checkOwnVerification).toHaveBeenCalledTimes(3);
+        // 3 times, not 5. Because this new method doesn't need to build a big matrix of possible combinations
+        expect(realVers).toStrictEqual([
+            {
+                fieldName: "fName",
+                value: "Max",
+                belongsToNId: "n1",
+                nID: "nv1",
+                expired: new Date("2020-08-28T23:12:35.678Z"),
+                metadata: undefined,
+                provider: {
+                    dataSourceNId: "Ministry of pike river mine re-entry",
+                    date: new Date("2020-08-28T23:11:20.592Z"),
+                    serviceProviderNId: "Minister for pike river re-entry",
+                    verifierNId: "v1",
+                },
+                signature: "signatureForFirstNameMax",
+                verified: true,
+                xId: "x1",
+            },
+            {
+                fieldName: "fName",
+                value: "Erika",
+                belongsToNId: "n2",
+                nID: "nv2",
+                expired: false,
+                metadata: undefined,
+                provider: {
+                    dataSourceNId: "Ministry of pike river mine re-entry",
+                    date: new Date("2020-08-28T23:11:20.592Z"),
+                    serviceProviderNId: "Minister for pike river re-entry",
+                    verifierNId: "v1",
+                },
+                signature: "signatureForFirstNameErika",
+                verified: false,
+                xId: "x2",
+            },
+            // note how lastName is not included since it's invalid
+        ]);
+    });
+});

package/dist/verifications/verifyCheck/__tests__/getSomeoneElsesRealVerifications.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/verifications/verifyCheck/__tests__/getSomeoneElsesRealVerifications.test.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getSomeoneElsesRealVerifications_1 = require("../getSomeoneElsesRealVerifications");
+const operations_1 = require("../operations");
+jest.mock("../operations");
+const checkVerificationsResp = [
+    {
+        verified: false,
+        signature: "sig2",
+        data: {
+            field: "a",
+            value: 1,
+            verifier_source_id: "verifier_source_id",
+            verifier_service_id: "verifier_service_id",
+            verifier_id: "verifier_id",
+            date: "date",
+            request_div: "request_div",
+            passed: "passed",
+            source_n_id: "source_n_id",
+            verification_date: "2003-05-18T11:22:33.456790",
+        },
+        n_id: "my_field",
+    },
+    {
+        verified: true,
+        signature: "sig",
+        data: {
+            field: "email_address",
+            value: "jean@example.com",
+            verifier_source_id: "verifier_source_id",
+            verifier_service_id: "verifier_service_id",
+            verifier_id: "verifier_id",
+            date: "date",
+            request_div: "request_div",
+            passed: "passed",
+            source_n_id: "source_n_id",
+            verification_date: "2020-08-28T23:11:20.592912",
+            metadata: {
+                status: "pending",
+                send_code_attempts: [
+                    {
+                        channel: "email",
+                        time: "2020-08-28T23:11:24.157Z",
+                        channel_id: "abc",
+                    },
+                ],
+            },
+        },
+        n_id: "my_email",
+    },
+];
+const profileObjects = [
+    { properties: { a: 1 } },
+    { properties: { email_address: "jean@example.com" } },
+    {
+        properties: {
+            my_photo: {
+                content: "...",
+                content_type: "...",
+                n_id: "n_id_of_my_ss_File",
+            },
+        },
+    },
+];
+const verifications = [
+    {
+        n_id: "my_email",
+        properties: {
+            verifications: [
+                {
+                    data: {
+                        source: "EMAIL_ADDRESS",
+                        passed: false,
+                        request_div: "140c20e3-5146-4123-8e75-fe9064a6b71f",
+                        source_n_id: "3ec48392-4211-4c6a-92f9-50031f0f5716",
+                        verifier_source_id: "d796a383-5622-4e05-93b2-2fbe292d76fa",
+                        metadata: {
+                            url: "https://verify.twilio.com/v2/Services/VAa447486967ee88c1f59e2896f617f981/Verifications/VE398de58af34b4ef22fa24a404f30898d",
+                            send_code_attempts: [
+                                {
+                                    channel: "email",
+                                    time: "2020-08-28T23:11:24.157Z",
+                                    channel_id: "pCmrKC4qQBSC_3m3crMctA",
+                                },
+                            ],
+                            status: "pending",
+                            id: "VE398de58af34b4ef22fa24a404f30898d",
+                        },
+                        verifier_id: "d796a383-5622-4e05-93b2-2fbe292d76fa",
+                        field: "email_address",
+                        verifier_div: "7137da93-0a53-4de7-b6df-3aa4b2b8d5e6",
+                        v_id: "d6c5246c-1141-4d0a-929f-1ed0aa00b52d",
+                        verification_date: "2020-08-28T23:11:20.592912",
+                        valid_until: "2020-08-28T23:12:35.678Z",
+                    },
+                    signature: "abcdefghijklmopqrstuvwxyz",
+                },
+            ],
+            field: "email_address",
+            initiator_n_id: "3ec48392-4211-4c6a-92f9-50031f0f5716",
+            n_id: "my_email",
+        },
+        labels: ["ss_Verification", "ProfileObject"],
+        referenceList: {},
+    },
+    {
+        n_id: "my_photo",
+        properties: {
+            verifications: [
+                {
+                    data: {
+                        passed: false,
+                        request_div: "a",
+                        source_n_id: "b",
+                        verifier_source_id: "c",
+                        verifier_id: "d",
+                        field: "my_photo",
+                        verifier_div: "e",
+                        v_id: "f",
+                        verification_date: "2020-12-05T11:22:33.456789",
+                        valid_until: "2020-08-28T23:12:35.678Z",
+                    },
+                    signature: "abcdefghijklmopqrstuvwxyz",
+                },
+            ],
+            field: "my_photo",
+            initiator_n_id: "3ec48392-4211-4c6a-92f9-50031f0f5716",
+            n_id: "my_photo",
+        },
+        labels: ["ss_Verification", "ProfileObject"],
+        referenceList: {},
+    },
+];
+describe("getSomeoneElsesRealVerifications", () => {
+    beforeEach(() => {
+        jest.resetAllMocks();
+        operations_1.checkSomeoneElsesVerifications.mockResolvedValue(checkVerificationsResp);
+    });
+    it("returns an empty array if provided nothing", async () => {
+        const result = await (0, getSomeoneElsesRealVerifications_1.getSomeoneElsesRealVerifications)({
+            apiUrl: "https://example.com",
+            profileObjects: [],
+            verifications: [],
+        });
+        expect(result).toStrictEqual([]);
+        expect(operations_1.checkSomeoneElsesVerifications).not.toHaveBeenCalled();
+    });
+    it("processes the user's verifications correctly", async () => {
+        const result = await (0, getSomeoneElsesRealVerifications_1.getSomeoneElsesRealVerifications)({
+            apiUrl: "https://example.com",
+            profileObjects,
+            verifications,
+        });
+        expect(result).toStrictEqual([
+            {
+                belongsToNId: "source_n_id",
+                expired: false,
+                fieldName: "email_address",
+                metadata: {
+                    send_code_attempts: [
+                        {
+                            channel: "email",
+                            channel_id: "abc",
+                            time: "2020-08-28T23:11:24.157Z",
+                        },
+                    ],
+                    status: "pending",
+                },
+                nID: "my_email",
+                provider: {
+                    dataSourceNId: "verifier_source_id",
+                    date: new Date("2020-08-28T23:11:20.592912Z"),
+                    serviceProviderNId: "verifier_service_id",
+                    verifierNId: "verifier_id",
+                },
+                signature: "sig",
+                value: "jean@example.com",
+                verified: "passed",
+                xId: "request_div",
+            },
+        ]);
+        expect(operations_1.checkSomeoneElsesVerifications).toHaveBeenCalledTimes(1);
+        expect(operations_1.checkSomeoneElsesVerifications).toHaveBeenNthCalledWith(1, {
+            apiUrl: "https://example.com",
+            controller: undefined,
+            toVerify: [
+                {
+                    verifications: [
+                        { n_id: "my_email", signature: "abcdefghijklmopqrstuvwxyz" },
+                    ],
+                    data_to_verify: [{ value: "jean@example.com" }],
+                },
+                {
+                    verifications: [
+                        { n_id: "my_photo", signature: "abcdefghijklmopqrstuvwxyz" },
+                    ],
+                    data_to_verify: [
+                        // note how it re-created the $reference
+                        { value: { $ref: "urn:profile_object:n_id_of_my_ss_File" } },
+                    ],
+                },
+            ],
+        });
+    });
+});

package/dist/verifications/verifyCheck/getOwnRealVerifications.d.ts

@@ -1,13 +1,13 @@
-import { ProfileObject, Verification, RealVer, UId } from "@raytio/types";
-/**
- * Given a list of verifications and decrypted profile objects, this function
- * locally verifies the credibility of the signatures in the verifications.
- *
- * This function does NOT call the API, except to fetch the public key.
- * @returns a list of authentic RealVer
- */
-export declare const getOwnRealVerifications: ({ verifications, profileObjects, userId, }: {
-    verifications: Verification[];
-    profileObjects: ProfileObject[];
-    userId: UId;
-}) => Promise<RealVer[]>;
+import { ProfileObject, Verification, RealVer, UId } from "@raytio/types";
+/**
+ * Given a list of verifications and decrypted profile objects, this function
+ * locally verifies the credibility of the signatures in the verifications.
+ *
+ * This function does NOT call the API, except to fetch the public key.
+ * @returns a list of authentic RealVer
+ */
+export declare const getOwnRealVerifications: ({ verifications, profileObjects, userId, }: {
+    verifications: Verification[];
+    profileObjects: ProfileObject[];
+    userId: UId;
+}) => Promise<RealVer[]>;