@raytio/decrypt-helper 2.2.1 → 3.0.0

package/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 3.0.0 (2022-02-04)
+
+- 💥 BREAKING CHANGE: renamed the `USERNAME` & `PASSWORD` environment variables to `RAYTIO_USERNAME` & `RAYTIO_PASSWORD`
+- 💥 BREAKING CHANGE: removed the `READABLE_FIELD_NAMES` option
+- 💥 BREAKING CHANGE: [csv] added new columns, shifted other columns
+- 💥 BREAKING CHANGE: [json] removed some duplicate legacy fields, see #33
+- !156: various internal refactoring
+
 ## 2.2.1 (2022-02-09)
 
 - !158 include the submission score in the json and pdf

package/README.md

@@ -34,12 +34,9 @@ raytio
       // if using raytio.saveToS3Bucket, specify the ID of the bucket here
       S3_BUCKET: "",
 
-      // whether the JSON and CSV output should use readable field names instead of the field IDs
-      READABLE_FIELD_NAMES: true,
-
       // the credentials of an organization user
-      USERNAME: "...",
-      PASSWORD: "...",
+      RAYTIO_USERNAME: "...",
+      RAYTIO_PASSWORD: "...",
 
       // used when generating a PDF report, if not supplied defaults to "en-NZ" and "Pacific/Auckland"
       // for available timezone options, see the map on https://momentjs.com/timezone

package/dist/api/getFiles.js

@@ -43,7 +43,7 @@ function getFiles(profileObjects, instance, apiToken, envConfig, applicationDecr
         // [nId: NId, fieldName: string, file: RaytFile][]
         const urnOrEncryptedList = profileObjects.flatMap((PO) => {
             return Object.entries(PO.properties)
-                .filter((kv) => (0, file_1.isFile)(kv[1]))
+                .filter((kv) => (0, file_1.isFieldValueFile)(kv[1]))
                 .map(([k, v]) => {
                 return [
                     PO.n_id,

package/dist/api/signIn.js

@@ -24,11 +24,11 @@ function signIn(CONFIG, envConfig) {
             userPoolWebClientId: envConfig.cognito_web_client_id,
         });
         const userObj = yield auth_1.default.signIn({
-            username: CONFIG.USERNAME,
-            password: yield (0, core_1.hashPassword)(CONFIG.PASSWORD),
+            username: CONFIG.RAYTIO_USERNAME,
+            password: yield (0, core_1.hashPassword)(CONFIG.RAYTIO_PASSWORD),
         });
         if (userObj.challengeName === "SOFTWARE_TOKEN_MFA") {
-            throw new Error(`The configured account (${CONFIG.USERNAME}) has two factor authentication enabled. You must disable 2FA or use a different account`);
+            throw new Error(`The configured account (${CONFIG.RAYTIO_USERNAME}) has two factor authentication enabled. You must disable 2FA or use a different account`);
         }
         const user = yield auth_1.default.currentAuthenticatedUser();
         const apiToken = (_b = (_a = user.signInUserSession) === null || _a === void 0 ? void 0 : _a.idToken) === null || _b === void 0 ? void 0 : _b.jwtToken;

package/dist/constants.d.ts

@@ -11,7 +11,7 @@ export declare const ATTRIBUTE_MAP: {
 export declare const VERIFICATION_SCHEMA = "ss_Verification";
 export declare const INSTANCE_FIELDS_TO_REMOVE: readonly ["profile_objects", "relationships", "keys"];
 export declare const FIELDS_TO_REMOVE: readonly ["n_id", "document"];
-export declare const ENV_VARIABLES: readonly ["CLIENT_URL", "READABLE_FIELD_NAMES", "USERNAME", "PASSWORD"];
+export declare const ENV_VARIABLES: readonly ["CLIENT_URL", "RAYTIO_USERNAME", "RAYTIO_PASSWORD"];
 export declare type Config = Record<typeof ENV_VARIABLES[number], string>;
 export declare type InstanceDataToPassOn = Omit<Instance, typeof INSTANCE_FIELDS_TO_REMOVE[number]> & {
     score?: ScoreResult;

package/dist/constants.js

@@ -19,9 +19,8 @@ exports.INSTANCE_FIELDS_TO_REMOVE = [
 exports.FIELDS_TO_REMOVE = ["n_id", "document"];
 exports.ENV_VARIABLES = [
     "CLIENT_URL",
-    "READABLE_FIELD_NAMES",
-    "USERNAME",
-    "PASSWORD",
+    "RAYTIO_USERNAME",
+    "RAYTIO_PASSWORD",
 ];
 exports.PO_VER_TEXT_MAP = {
     [types_1.POVerification.FullyVerified]: "Fully Verified",

package/dist/helpers/__tests__/formatOutput.test.js

@@ -55,7 +55,7 @@ describe("formatOutput", () => {
     it("uses schema_group to group schema", () => __awaiter(void 0, void 0, void 0, function* () {
         const output = yield (0, formatOutput_1.formatOutput)(profileObjects, allSchemas, realVers, "[apiToken]", 
         // @ts-expect-error testing if it works with booleans not stringied bools
-        { READABLE_FIELD_NAMES: false }, Symbol.for("envConfig"));
+        Symbol.for("envConfig"));
         expect(output).toStrictEqual({
             DL: [
                 {
@@ -77,11 +77,7 @@ describe("formatOutput", () => {
                     },
                     $safeHarbour: "NOT_APPLICABLE",
                     $schemaName: "ss_nz_drivers_license",
-                    // legacy
-                    issuer: "NZTA",
-                    "issuer.verification": undefined,
-                    license_number: "DW012345",
-                    "license_number.verification": undefined,
+                    $schemaTitle: "NZ Drivers License",
                 },
                 {
                     $verification_details: Symbol.for("VerificationDetails"),
@@ -102,11 +98,7 @@ describe("formatOutput", () => {
                     },
                     $safeHarbour: "NOT_APPLICABLE",
                     $schemaName: "ss_nsw_drivers_license",
-                    // legacy
-                    city: "Sydney",
-                    "city.verification": undefined,
-                    license_number: "ABC123",
-                    "license_number.verification": undefined,
+                    $schemaTitle: "NSW Drivers License",
                 },
             ],
             ss_name: [
@@ -129,99 +121,7 @@ describe("formatOutput", () => {
                     },
                     $safeHarbour: "NOT_APPLICABLE",
                     $schemaName: "ss_name",
-                    // legacy
-                    fName: "john",
-                    "fName.verification": undefined,
-                    lName: "doe",
-                    "lName.verification": undefined,
-                },
-            ],
-        });
-    }));
-    it("doesn't use schema_group if READABLE_FIELD_NAMES is true", () => __awaiter(void 0, void 0, void 0, function* () {
-        const output = yield (0, formatOutput_1.formatOutput)(profileObjects, allSchemas, realVers, "[apiToken]", 
-        // @ts-expect-error testing if it works with booleans not stringied bools
-        { READABLE_FIELD_NAMES: true }, Symbol.for("envConfig"));
-        expect(output).toStrictEqual({
-            "NSW Drivers License": [
-                {
-                    $verification_details: Symbol.for("VerificationDetails"),
-                    $verified: types_1.POVerification.NotVerified,
-                    $shouldBeVerifiedFields: undefined,
-                    $nId: "n3",
-                    $properties: {
-                        city: {
-                            title: "city",
-                            value: "Sydney",
-                            verification: undefined,
-                        },
-                        license_number: {
-                            title: "license_number",
-                            value: "ABC123",
-                            verification: undefined,
-                        },
-                    },
-                    $safeHarbour: "NOT_APPLICABLE",
-                    $schemaName: "ss_nsw_drivers_license",
-                    // legacy
-                    city: "Sydney",
-                    "city Verification": undefined,
-                    license_number: "ABC123",
-                    "license_number Verification": undefined,
-                },
-            ],
-            "NZ Drivers License": [
-                {
-                    $verification_details: Symbol.for("VerificationDetails"),
-                    $verified: types_1.POVerification.NotVerified,
-                    $shouldBeVerifiedFields: undefined,
-                    $nId: "n2",
-                    $properties: {
-                        issuer: {
-                            title: "issuer",
-                            value: "NZTA",
-                            verification: undefined,
-                        },
-                        license_number: {
-                            title: "license_number",
-                            value: "DW012345",
-                            verification: undefined,
-                        },
-                    },
-                    $safeHarbour: "NOT_APPLICABLE",
-                    $schemaName: "ss_nz_drivers_license",
-                    // legacy
-                    issuer: "NZTA",
-                    "issuer Verification": undefined,
-                    license_number: "DW012345",
-                    "license_number Verification": undefined,
-                },
-            ],
-            "Your Name": [
-                {
-                    $verification_details: Symbol.for("VerificationDetails"),
-                    $verified: types_1.POVerification.NotVerified,
-                    $shouldBeVerifiedFields: undefined,
-                    $nId: "n1",
-                    $properties: {
-                        fName: {
-                            title: "fName",
-                            value: "john",
-                            verification: undefined,
-                        },
-                        lName: {
-                            title: "lName",
-                            value: "doe",
-                            verification: undefined,
-                        },
-                    },
-                    $safeHarbour: "NOT_APPLICABLE",
-                    $schemaName: "ss_name",
-                    // legacy
-                    fName: "john",
-                    "fName Verification": undefined,
-                    lName: "doe",
-                    "lName Verification": undefined,
+                    $schemaTitle: "Your Name",
                 },
             ],
         });

package/dist/helpers/file.d.ts

@@ -1,4 +1,5 @@
 import type { Encrypted, NId, Urn } from "@raytio/types";
+import type { FlatPO } from "./formatOutput";
 export declare type RaytFile = {
     n_id: NId;
     content: Urn | Encrypted;
@@ -6,4 +7,7 @@ export declare type RaytFile = {
     n_id: NId;
     Content: Urn | Encrypted;
 };
-export declare const isFile: (field: unknown) => field is RaytFile;
+/** checks if a field value is a file */
+export declare const isFieldValueFile: (fieldValue: unknown) => fieldValue is RaytFile;
+/** checks if a PO is a file */
+export declare const isPOFile: (PO: FlatPO) => boolean;

package/dist/helpers/file.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFile = void 0;
+exports.isPOFile = exports.isFieldValueFile = void 0;
 const core_1 = require("@raytio/core");
 const URN_PREFIX = "urn:";
 /** @internal */
 const isObject = (x) => !!x && typeof x === "object";
 /** @internal */
 const isUrnOrEncrypted = (x) => (typeof x === "string" && x.startsWith(URN_PREFIX)) || (0, core_1.isEncrypted)(x);
-const isFile = (field) => isObject(field) &&
-    (isUrnOrEncrypted(field.content) || isUrnOrEncrypted(field.Content));
-exports.isFile = isFile;
+/** checks if a field value is a file */
+const isFieldValueFile = (fieldValue) => isObject(fieldValue) &&
+    "content" in fieldValue &&
+    isUrnOrEncrypted(fieldValue.content);
+exports.isFieldValueFile = isFieldValueFile;
+/** checks if a PO is a file */
+const isPOFile = (PO) => { var _a; return (0, exports.isFieldValueFile)({ content: (_a = PO.$properties.content) === null || _a === void 0 ? void 0 : _a.value }); };
+exports.isPOFile = isPOFile;

package/dist/helpers/formatOutput.d.ts

@@ -1,13 +1,19 @@
-import type { NId, POVerification, ProfileObject, RealVer, Schema } from "@raytio/types";
+import type { FieldVerification, NId, POVerification, ProfileObject, RealVer, Schema } from "@raytio/types";
 import { ResolvedVerificationProvider, EnvConfig } from "../api";
-import { Config } from "../constants";
 export declare type FlatPO = {
     $verified: POVerification;
     $verification_details: ResolvedVerificationProvider | undefined;
     $shouldBeVerifiedFields: string[] | undefined;
     $nId: NId;
     $schemaName: string;
+    $schemaTitle: string;
+    $properties: {
+        [fieldName: string]: {
+            title: string;
+            value: unknown;
+            verification: FieldVerification;
+        };
+    };
     $safeHarbour: boolean | "NOT_APPLICABLE";
-    [schemaField: string]: any;
 };
-export declare function formatOutput(profileObjects: ProfileObject[], allSchemas: Schema[], realVers: RealVer[], apiToken: string, CONFIG: Config, envConfig: EnvConfig): Promise<Record<string, FlatPO[]>>;
+export declare function formatOutput(profileObjects: ProfileObject[], allSchemas: Schema[], realVers: RealVer[], apiToken: string, envConfig: EnvConfig): Promise<Record<string, FlatPO[]>>;

package/dist/helpers/formatOutput.js

@@ -25,10 +25,8 @@ const byPriority = (schema) => ([a], [b]) => {
     const bPriority = (_f = (_e = (_d = schema.properties) === null || _d === void 0 ? void 0 : _d[b]) === null || _e === void 0 ? void 0 : _e.priority) !== null && _f !== void 0 ? _f : Infinity;
     return aPriority - bPriority;
 };
-// TODO: clean up
-function formatOutput(profileObjects, allSchemas, realVers, apiToken, CONFIG, envConfig) {
+function formatOutput(profileObjects, allSchemas, realVers, apiToken, envConfig) {
     return __awaiter(this, void 0, void 0, function* () {
-        const readable = CONFIG.READABLE_FIELD_NAMES.toString() === "true";
         const PODetails = profileObjects.reduce((acPromise, PO) => __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             const ac = yield acPromise;
@@ -54,33 +52,24 @@ function formatOutput(profileObjects, allSchemas, realVers, apiToken, CONFIG, en
                         verification: verDetails.fieldVerifications[key],
                     } });
             }), Promise.resolve({}));
-            const thisPO = Object.assign({ 
-                // these are always included
-                $verified: verDetails.status, $verification_details: yield (0, api_1.resolveVerificationDetails)(verDetails.details.verifiers, apiToken, envConfig), $shouldBeVerifiedFields: (_b = schema.verified_fields) === null || _b === void 0 ? void 0 : _b.map((x) => typeof x === "string" ? x : x.field), 
-                // these are not included in the CSV for legacy reasons
-                $nId: PO.n_id, $schemaName: schemaName, $properties: reducedProperties, $safeHarbour: schemaName === "ss_Person_Name"
+            const thisPO = {
+                $verified: verDetails.status,
+                $verification_details: yield (0, api_1.resolveVerificationDetails)(verDetails.details.verifiers, apiToken, envConfig),
+                $shouldBeVerifiedFields: (_b = schema.verified_fields) === null || _b === void 0 ? void 0 : _b.map((x) => typeof x === "string" ? x : x.field),
+                $nId: PO.n_id,
+                $schemaName: schemaName,
+                $schemaTitle: schema.title,
+                $properties: reducedProperties,
+                $safeHarbour: schemaName === "ss_Person_Name"
                     ? (yield (0, core_1.calcSafeHarbourScore)({
                         person: PO,
                         getSchema: (name) => (0, api_1.getSchema)(envConfig, name),
                         profileObjects,
                         realVers,
                     })).isSafe
-                    : "NOT_APPLICABLE" }, Object.entries(realProps)
-                .sort(byPriority(schema))
-                .reduce((acc, [key, value]) => {
-                var _a, _b;
-                (0, types_1.assertSafeProperty)(key);
-                const title = readable
-                    ? ((_b = (_a = schema.properties) === null || _a === void 0 ? void 0 : _a[key]) === null || _b === void 0 ? void 0 : _b.title) || key
-                    : key;
-                (0, types_1.assertSafeProperty)(title);
-                const titleV = readable
-                    ? `${title} Verification`
-                    : `${title}.verification`;
-                return Object.assign(Object.assign({}, acc), { [title]: value, [titleV]: verDetails.fieldVerifications[key] });
-            }, {}));
-            const schemaTitle = (readable && schema.title) || schemaNameOrGroup;
-            return Object.assign(Object.assign({}, ac), { [schemaTitle]: [...existing, thisPO] });
+                    : "NOT_APPLICABLE",
+            };
+            return Object.assign(Object.assign({}, ac), { [schemaNameOrGroup]: [...existing, thisPO] });
         }), Promise.resolve({}));
         return PODetails;
     });

package/dist/helpers/setupMaxcryptor.js

@@ -21,7 +21,7 @@ function setupMaxcryptor(CONFIG, cognitoAttributes) {
                 return acc;
             return (0, ramda_1.assocPath)(constants_1.ATTRIBUTE_MAP[Name], JSON.parse(Value), acc);
         }, {});
-        const { encryptor: maxcryptor } = yield (0, maxcryptor_1.encryptorFromExistingUser)(userDoc, CONFIG.PASSWORD);
+        const { encryptor: maxcryptor } = yield (0, maxcryptor_1.encryptorFromExistingUser)(userDoc, CONFIG.RAYTIO_PASSWORD);
         return maxcryptor;
     });
 }

package/dist/pdf/components/Images.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="jsx-pdf" />
-import { Files } from "../types";
+import { ProcessSubmissionOutput } from "../../public-methods/processSubmission";
 export declare const Images: ({ nIds, files, }: {
     nIds: string[];
-    files: Files;
+    files: ProcessSubmissionOutput["files"];
 }) => JSX.Element;

package/dist/pdf/components/InnerTableRows.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="jsx-pdf" />
-import { Files, PdfConfig } from "../types";
+import { ProcessSubmissionOutput } from "../../public-methods/processSubmission";
+import { PdfConfig } from "../types";
 export declare const InnerTableRows: ({ key, value, imageFieldNames, config, files, color, }: {
     key: string;
     value: any;
-    files: Files;
+    files: ProcessSubmissionOutput["files"];
     config: PdfConfig;
     color: string;
     imageFieldNames: string[];

package/dist/pdf/components/POVerificationBadge.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="jsx-pdf" />
 import { POVerification } from "@raytio/types";
-import { PdfSchema } from "../types";
+import { FlatPO } from "../../helpers";
 export declare const FILE_MAP: Record<POVerification, string>;
-export declare const POVerificationBadge: ({ width, schema, }: {
+export declare const POVerificationBadge: ({ width, POs, }: {
     width: number;
-    schema: PdfSchema;
+    POs: FlatPO[];
 }) => JSX.Element;

package/dist/pdf/components/POVerificationBadge.js

@@ -18,10 +18,9 @@ exports.FILE_MAP = {
     [types_1.POVerification.Encrypted]: "not_verified_big",
     [types_1.POVerification.Loading]: "not_verified_big",
 };
-const POVerificationBadge = ({ width, schema, }) => {
-    const [, profileObjects] = schema;
+const POVerificationBadge = ({ width, POs, }) => {
     // TODO: this won't work if multiple POs of the same schema are shared
-    const { $verified, $verification_details, $shouldBeVerifiedFields, $safeHarbour, } = profileObjects[0];
+    const { $verified, $verification_details, $shouldBeVerifiedFields, $safeHarbour, } = POs[0];
     const verifiedBy = $verification_details === null || $verification_details === void 0 ? void 0 : $verification_details.verifier_id;
     return (jsx_pdf_1.default.createElement(jsx_pdf_1.default.Fragment, null,
         $shouldBeVerifiedFields && (jsx_pdf_1.default.createElement(jsx_pdf_1.default.Fragment, null,

package/dist/pdf/components/Report.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="jsx-pdf" />
 import type { AId } from "@raytio/types";
-import { Files, PdfConfig, ReportData } from "../types";
+import { PdfConfig } from "../types";
+import { ProcessSubmissionOutput } from "../../public-methods/processSubmission";
 export declare const Report: ({ data, files, config, aId, clientUrl, version, }: {
-    data: ReportData;
-    files: Files;
+    data: ProcessSubmissionOutput["json"];
+    files: ProcessSubmissionOutput["files"];
     config: PdfConfig;
     aId: AId;
     clientUrl: string;

package/dist/pdf/components/Report.js

@@ -16,7 +16,6 @@ const VerifyBox_1 = require("./VerifyBox");
 const constants_1 = require("../constants");
 const transform_1 = require("../helpers/transform");
 const Report = ({ data, files, config, aId, clientUrl, version, }) => {
-    const schemas = Object.entries(data).filter(([, val]) => Array.isArray(val) && val.length && "$verified" in val[0]);
     // The PDF is read only; there's no reason why anyone would ever need to unlock it.
     const randomToken = (0, crypto_1.randomBytes)(32).toString("base64");
     return (jsx_pdf_1.default.createElement("document", { defaultStyle: { font: "Lato", fontSize: 12 }, info: {
@@ -51,17 +50,18 @@ const Report = ({ data, files, config, aId, clientUrl, version, }) => {
                     jsx_pdf_1.default.createElement("text", null, " ")),
                 jsx_pdf_1.default.createElement("column", { width: 150 },
                     jsx_pdf_1.default.createElement(VerifyBox_1.VerifyBox, { aId: aId, iId: data.i_id, clientUrl: clientUrl }))),
-            schemas.map((schema) => {
+            Object.values(data.profile_objects).map((POs) => {
+                // for each schema
                 return (jsx_pdf_1.default.createElement("stack", { 
                     // unbreakable is off because it crashes if its too big for one page
-                    // TODO: PR to pdfmake to fix this
+                    // This is a 7-year-old issue in pdfmake (https://github.com/bpampuch/pdfmake/issues/207)
                     unbreakable: false, style: "marginY" },
-                    jsx_pdf_1.default.createElement(TableTitle_1.TableTitle, { schema: schema }),
+                    jsx_pdf_1.default.createElement(TableTitle_1.TableTitle, { POs: POs }),
                     jsx_pdf_1.default.createElement("columns", { columnGap: 15 },
                         jsx_pdf_1.default.createElement("column", { width: 80 },
-                            jsx_pdf_1.default.createElement(POVerificationBadge_1.POVerificationBadge, { width: 80, schema: schema })),
+                            jsx_pdf_1.default.createElement(POVerificationBadge_1.POVerificationBadge, { width: 80, POs: POs })),
                         jsx_pdf_1.default.createElement("column", { width: "auto" },
-                            jsx_pdf_1.default.createElement(Table_1.Table, { schema: schema, files: files, config: config })))));
+                            jsx_pdf_1.default.createElement(Table_1.Table, { POs: POs, files: files, config: config })))));
             })),
         jsx_pdf_1.default.createElement("footer", null, (currentPage, pageCount, pageSize) => (jsx_pdf_1.default.createElement("stack", { bold: true, color: "#333", fontSize: 10 },
             jsx_pdf_1.default.createElement("text", { margin: 16 },

package/dist/pdf/components/Table.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="jsx-pdf" />
-import { PdfSchema, Files, PdfConfig } from "../types";
-export declare const Table: ({ schema, files, config, }: {
-    schema: PdfSchema;
-    files: Files;
+import { PdfConfig } from "../types";
+import { FlatPO } from "../../helpers";
+import { ProcessSubmissionOutput } from "../../public-methods/processSubmission";
+export declare const Table: ({ POs, files, config, }: {
+    POs: FlatPO[];
+    files: ProcessSubmissionOutput["files"];
     config: PdfConfig;
 }) => JSX.Element;

package/dist/pdf/components/Table.js

@@ -10,36 +10,33 @@ const FieldVerificationBadge_1 = require("./FieldVerificationBadge");
 const Images_1 = require("./Images");
 const InnerTableRows_1 = require("./InnerTableRows");
 const helpers_1 = require("../../helpers");
-const Table = ({ schema, files, config, }) => {
-    const [, profileObjects] = schema;
-    /** every fieldName in this profile object */
+const Table = ({ POs, files, config, }) => {
+    /** every fieldName in these profile object */
     const fieldNames = [
-        ...new Set(profileObjects
-            .flatMap(Object.keys)
-            .filter((x) => !x.startsWith("$") &&
-            !x.endsWith(".verification") &&
-            !x.endsWith(" Verification"))),
+        ...new Set(POs.flatMap((PO) => Object.keys(PO.$properties))),
     ];
     // some or all POs in this schema are files themselves. So render the file, assuming it's an image
-    const fileNIds = profileObjects.filter(helpers_1.isFile).map((x) => x.n_id);
+    const fileNIds = POs.filter(helpers_1.isPOFile).map((x) => x.$nId);
     if (fileNIds.length)
         return jsx_pdf_1.default.createElement(Images_1.Images, { nIds: fileNIds, files: files });
-    const imageFieldNames = fieldNames.filter((x) => profileObjects.map((PO) => PO[x]).some(helpers_1.isFile));
-    return (jsx_pdf_1.default.createElement("table", { layout: "noBorders" }, fieldNames.map((fieldName) => (jsx_pdf_1.default.createElement("row", null,
-        jsx_pdf_1.default.createElement("cell", null,
-            jsx_pdf_1.default.createElement("text", { color: "#12130e" }, fieldName.replace(/_/g, " "))),
-        profileObjects.flatMap((PO) => {
-            (0, helpers_1.assertSafeProperty)(fieldName);
-            const status = PO[`${fieldName}.verification`] ||
-                PO[`${fieldName} Verification`];
-            const color = (0, general_1.verifyColour)(status);
-            // jsx-pdf currently doesn't support fragments, will make a PR at some point
-            return [
-                jsx_pdf_1.default.createElement("cell", null,
-                    jsx_pdf_1.default.createElement(FieldVerificationBadge_1.FieldVerificationBadge, { width: 10, status: status })),
-                jsx_pdf_1.default.createElement("cell", null,
-                    jsx_pdf_1.default.createElement(InnerTableRows_1.InnerTableRows, { key: fieldName, value: PO[fieldName], files: files, config: config, color: color, imageFieldNames: imageFieldNames })),
-            ];
-        }))))));
+    const imageFieldNames = fieldNames.filter((fieldName) => POs.map((PO) => PO.$properties[fieldName].value).some(helpers_1.isFieldValueFile));
+    return (jsx_pdf_1.default.createElement("table", { layout: "noBorders" }, fieldNames.map((fieldName) => {
+        var _a;
+        return (jsx_pdf_1.default.createElement("row", null,
+            jsx_pdf_1.default.createElement("cell", null,
+                jsx_pdf_1.default.createElement("text", { color: "#12130e" }, ((_a = POs.find((PO) => PO.$properties[fieldName])) === null || _a === void 0 ? void 0 : _a.$properties[fieldName].title) || fieldName)),
+            POs.flatMap((PO) => {
+                (0, helpers_1.assertSafeProperty)(fieldName);
+                const { value, verification } = PO.$properties[fieldName];
+                const color = (0, general_1.verifyColour)(verification);
+                // jsx-pdf currently doesn't support fragments, will make a PR at some point
+                return [
+                    jsx_pdf_1.default.createElement("cell", null,
+                        jsx_pdf_1.default.createElement(FieldVerificationBadge_1.FieldVerificationBadge, { width: 10, status: verification })),
+                    jsx_pdf_1.default.createElement("cell", null,
+                        jsx_pdf_1.default.createElement(InnerTableRows_1.InnerTableRows, { key: fieldName, value: value, files: files, config: config, color: color, imageFieldNames: imageFieldNames })),
+                ];
+            })));
+    })));
 };
 exports.Table = Table;

package/dist/pdf/components/TableTitle.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="jsx-pdf" />
-import { PdfSchema } from "../types";
-export declare const TableTitle: ({ schema }: {
-    schema: PdfSchema;
+import { FlatPO } from "../../helpers";
+export declare const TableTitle: ({ POs }: {
+    POs: FlatPO[];
 }) => JSX.Element;

package/dist/pdf/components/TableTitle.js

@@ -6,9 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TableTitle = void 0;
 const jsx_pdf_1 = __importDefault(require("jsx-pdf"));
 const helpers_1 = require("../../helpers");
-const TableTitle = ({ schema }) => {
-    const [schemaTitle, POs] = schema;
-    const maybeFileName = POs.some(helpers_1.isFile) && (POs[0].title || POs[0].Title);
+const TableTitle = ({ POs }) => {
+    var _a;
+    const schemaTitle = POs[0].$schemaTitle;
+    const maybeFileName = POs.some(helpers_1.isPOFile)
+        ? (_a = POs[0].$properties.title) === null || _a === void 0 ? void 0 : _a.value
+        : undefined;
     return (jsx_pdf_1.default.createElement("text", { bold: true, fontSize: 14, style: "marginBottom" }, maybeFileName || schemaTitle));
 };
 exports.TableTitle = TableTitle;

package/dist/pdf/helpers/general.js

@@ -13,16 +13,16 @@ const asset = (name) => {
 exports.asset = asset;
 const loadAsset = (name) => (0, fs_1.readFileSync)((0, exports.asset)(name), { encoding: "utf-8" });
 exports.loadAsset = loadAsset;
-// TODO: clean this up
-/* eslint-disable no-nested-ternary */
-const verifyColour = (x) => x === types_1.FieldVerification.Verified
-    ? "#12130e"
-    : x === types_1.FieldVerification.VerifiedFalse ||
-        x === types_1.POVerification.VerifiedFalse
-        ? "#fb7171"
-        : "#000";
+const verifyColour = (x) => {
+    if (x === types_1.FieldVerification.Verified)
+        return "#12130e";
+    if (x === types_1.FieldVerification.VerifiedFalse ||
+        x === types_1.POVerification.VerifiedFalse) {
+        return "#fb7171";
+    }
+    return "#000";
+};
 exports.verifyColour = verifyColour;
-/* eslint-enable no-nested-ternary */
 /**
  * Produces a date with a long month
  */

package/dist/public-methods/processSubmission.d.ts

@@ -1,5 +1,6 @@
 import type { AId, IId, Instance, ProfileObject, RealVer, Schema } from "@raytio/types";
 import { Config, InstanceDataToPassOn } from "../constants";
+import { FlatPO } from "../helpers";
 import { ApplicationEncryptorLike } from "../types";
 declare type DecryptData = {
     apiToken: string;
@@ -23,7 +24,11 @@ export interface ProcessSubmissionInput {
 }
 export interface ProcessSubmissionOutput {
     /** details of the submission, included the decrypted profile objects */
-    json: InstanceDataToPassOn & Record<string, any>;
+    json: InstanceDataToPassOn & {
+        profile_objects: {
+            [schemaName: string]: FlatPO[];
+        };
+    };
     /** A string of a CSV file containing the same data as in `json` */
     csv: string;
     /** an object of files that were attached to the submission, such as images */

package/dist/public-methods/processSubmission.js

@@ -76,34 +76,26 @@ function processSubmission({ applicationId, instanceId, verbose, config, _suplie
             else {
                 log("No score rules configured on the AA.");
             }
-            // TODO: resolve URNs if any fields are URNs
             log("Fetching verification providers...");
-            const PODetails = yield (0, helpers_1.formatOutput)(profileObjects, allSchemas, realVers, apiToken, config, envConfig);
+            const PODetails = yield (0, helpers_1.formatOutput)(profileObjects, allSchemas, realVers, apiToken, envConfig);
             log("Fetching attached files...");
             const files = yield (0, api_1.getFiles)(profileObjects, instance, apiToken, envConfig, applicationDecryptor);
             const instanceDataToPassOn = (0, ramda_1.omit)(constants_1.INSTANCE_FIELDS_TO_REMOVE, instance);
             // final outputs
-            const csv = (0, helpers_1.deepJsonToCsv)(Object.assign(Object.assign({}, (0, ramda_1.omit)(["a_id", "aa_name", "device_id", "source_ip"], instanceDataToPassOn)), (0, ramda_1.mapObjIndexed)(
-            // TODO: (semver breaking) we omit these fields because it would a breaking change for the csv format.
-            (v) => v.map((a) => {
-                // TODO: (semver breaking) map the verification enums to the text to prevent a breaking change
-                const b = Object.assign(Object.assign({}, (0, ramda_1.omit)([
-                    "$nId",
-                    "$schemaName",
-                    "$properties",
-                    "$shouldBeVerifiedFields",
-                ], a)), { $verified: constants_1.PO_VER_TEXT_MAP[a.$verified] });
-                return (0, ramda_1.mapObjIndexed)((fieldVal, fieldName) => {
-                    if (fieldName.endsWith(" Verification") ||
-                        fieldName.endsWith(".verification")) {
-                        return constants_1.FIELD_VER_TEXT_MAP[+fieldVal];
-                    }
-                    return fieldVal;
-                }, b);
+            const csv = (0, helpers_1.deepJsonToCsv)(Object.assign(Object.assign({}, instanceDataToPassOn), (0, ramda_1.mapObjIndexed)((POList) => POList.map((flatPO) => {
+                // this is a bit weird, but it prevents an even bigger breaking change for the csv format
+                const obj = Object.entries(flatPO.$properties).flatMap(([fieldName, field]) => [
+                    [fieldName, field.value],
+                    [
+                        `${fieldName}.verification`,
+                        constants_1.FIELD_VER_TEXT_MAP[field.verification],
+                    ],
+                ]);
+                return Object.assign(Object.assign(Object.assign({}, flatPO), { $verified: constants_1.PO_VER_TEXT_MAP[flatPO.$verified] }), Object.fromEntries(obj));
             }), PODetails)));
             log("Success!");
             return {
-                json: Object.assign(Object.assign(Object.assign({}, instanceDataToPassOn), { score }), PODetails),
+                json: Object.assign(Object.assign({}, instanceDataToPassOn), { score, profile_objects: PODetails }),
                 csv,
                 files,
                 a_id: applicationId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/decrypt-helper",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "author": "Raytio",
   "description": "A helper to decrypt data shared by Raytio users",
   "main": "dist",
@@ -38,19 +38,19 @@
     "@types/jest-image-snapshot": "^4.3.1",
     "@types/jsx-pdf": "^2.2.2",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^16.11.22",
+    "@types/node": "^16.11.24",
     "@types/node-fetch": "^2.5.12",
     "@types/pdfmake": "^0.1.20",
     "@types/ramda": "^0.27.64",
     "dotenv": "^16.0.0",
     "eslint": "^8.8.0",
-    "eslint-config-kyle": "^8.1.1",
-    "jest": "^27.4.7",
+    "eslint-config-kyle": "^8.3.0",
+    "jest": "^27.5.1",
     "jest-image-snapshot": "^4.5.1",
     "jest-junit": "^13.0.0",
     "pdf-to-img": "^1.2.0",
     "ts-jest": "^27.1.3",
-    "ts-node": "^10.4.0",
+    "ts-node": "^10.5.0",
     "typescript": "^4.5.5"
   },
   "eslintConfig": {