@raytio/decrypt-helper 6.1.0 → 6.2.0

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

@@ -0,0 +1,49 @@
+import type { AId, IId, Instance, RealVer } from "@raytio/types";
+import { Config, InstanceDataToPassOn } from "../constants";
+import { FlatPO } from "../helpers";
+import { EnvConfig } from "../api";
+import { ApplicationEncryptorLike } from "../types";
+type DecryptData = {
+    apiToken: string;
+    instance: Instance;
+    encryptedInstance: Instance;
+    applicationDecryptor: ApplicationEncryptorLike;
+    realVers?: RealVer[];
+};
+export interface ProcessSubmissionInput {
+    /** The a_id of the application */
+    applicationId: AId;
+    /** The i_id of this submission */
+    instanceId: IId;
+    /** whether to enable extra logging. Default = false */
+    verbose?: boolean;
+    /**
+     * the configuration options. You can extract these from the environment
+     * variables by using @see getAndValidateConfig
+     */
+    config: Config;
+    /** You can optionally supply Instance data and an API token - for Raytio internal use */
+    _supliedConfig?: DecryptData;
+}
+export interface ProcessSubmissionOutput {
+    /** details of the submission, included the decrypted profile objects */
+    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 */
+    files: {
+        [nId: string]: [dataUrl: string, fileExtension: string];
+    };
+    /** the a_id is passed on */
+    a_id: AId;
+    /** passed down so that pdf generation has access to it */
+    client_url: string;
+    /** passed down so that pdf generation has access to it */
+    envConfig: EnvConfig;
+}
+export declare function processSubmission({ applicationId, instanceId, verbose, config, _supliedConfig, }: ProcessSubmissionInput): Promise<ProcessSubmissionOutput>;
+export {};

package/dist/public-methods/processSubmission.js

@@ -0,0 +1,128 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processSubmission = void 0;
+const ramda_1 = require("ramda");
+const core_1 = require("@raytio/core");
+const constants_1 = require("../constants");
+const helpers_1 = require("../helpers");
+const api_1 = require("../api");
+const constants_2 = require("../pdf/constants");
+function decryptStage(log, config, envConfig, instanceId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        log("Authenticating...");
+        const { apiToken, cognitoAttributes } = yield (0, api_1.signIn)(config, envConfig);
+        log("Initializing decryptor...");
+        const maxcryptor = yield (0, helpers_1.setupMaxcryptor)(config, cognitoAttributes);
+        log("Fetching submission details...");
+        const apiResp = yield (0, api_1.fetchInstanceData)(apiToken, envConfig, instanceId);
+        log("Decrypting submission details...");
+        const { instance, applicationDecryptor } = yield (0, core_1.decryptSharedData)({
+            apiToken,
+            apiUrl: envConfig.api_url,
+            instanceData: apiResp,
+            maxcryptor,
+            onCorruptedData: () => "🔒 Corrupted Data 🔒",
+        });
+        return {
+            apiToken,
+            instance,
+            applicationDecryptor,
+            encryptedInstance: apiResp,
+        };
+    });
+}
+function processSubmission({ applicationId, instanceId, verbose, config, _supliedConfig, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const log = verbose ? console.log : () => undefined;
+        try {
+            log("Fetching config...");
+            const envConfig = yield (0, api_1.fetchEnvConfig)(config.CLIENT_URL);
+            const { instance, apiToken, applicationDecryptor, encryptedInstance } = _supliedConfig ||
+                (yield decryptStage(log, config, envConfig, instanceId));
+            log("Checking verifications...");
+            const [profileObjects, verifications] = (0, helpers_1.splitPOAndVers)(instance.profile_objects);
+            const realVers = (_supliedConfig === null || _supliedConfig === void 0 ? void 0 : _supliedConfig.realVers) ||
+                (yield (0, core_1.getSomeoneElsesRealVerifications)({
+                    aId: instance.a_id,
+                    apiUrl: envConfig.api_url,
+                    profileObjects,
+                    verifications,
+                }));
+            log("Fetching relevant schema...");
+            const allSchemas = yield (0, api_1.getAllSchema)(envConfig);
+            log("Fetching access application...");
+            const AA = instance.i_id === constants_2.NULL_I_ID
+                ? undefined
+                : yield (0, api_1.fetchAA)(apiToken, envConfig, instance.a_id);
+            let score;
+            if (AA && (0, core_1.isScoreConfigValid)(AA.ruleset)) {
+                const ruleInputData = yield (0, core_1.convertInstanceToRuleInput)(instance.profile_objects, realVers, (schemaName) => __awaiter(this, void 0, void 0, function* () {
+                    const schema = allSchemas.find((x) => x.name === schemaName);
+                    if (!schema) {
+                        throw new Error(`Could not find schema “${schemaName}”`);
+                    }
+                    return schema;
+                }));
+                try {
+                    // decrypt helper never uses a stored score. We always re-calculate it.
+                    log("Calculating score...");
+                    score = yield (0, core_1.calculateScore)(AA.ruleset, ruleInputData);
+                    if (!(0, ramda_1.equals)(instance.score, score)) {
+                        // the score we calculated is different to the one that's saved on the instance.
+                        // So we save the new score.
+                        log("Saving score to instance...");
+                        // this can happen silently in the background, but we await it since so that we
+                        // abort if this fails.
+                        yield (0, api_1.updateInstanceData)(apiToken, Object.assign(Object.assign({}, encryptedInstance), { score }));
+                    }
+                }
+                catch (ex) {
+                    log(`Score calculation failed (${ex})`);
+                }
+            }
+            else {
+                log("No score rules configured on the AA.");
+            }
+            log("Fetching verification providers...");
+            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({}, 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 object = 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({}, flatPO), Object.fromEntries(object));
+            }), PODetails)));
+            log("Success!");
+            return {
+                json: Object.assign(Object.assign({}, instanceDataToPassOn), { score, profile_objects: PODetails }),
+                csv,
+                files,
+                a_id: applicationId,
+                client_url: config.CLIENT_URL,
+                envConfig,
+            };
+        }
+        catch (error) {
+            log("Processing submission failed:", error);
+            throw error; // pass on error
+        }
+    });
+}
+exports.processSubmission = processSubmission;

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

@@ -0,0 +1,2 @@
+import { ProcessSubmissionOutput } from "./processSubmission";
+export declare const saveToS3Bucket: () => (input: ProcessSubmissionOutput) => Promise<void>;

package/dist/public-methods/saveToS3Bucket.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveToS3Bucket = void 0;
+const aws_sdk_1 = __importDefault(require("aws-sdk"));
+function upload(s3, { bucketName, fileName, fileContent }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => {
+            s3.upload({
+                Bucket: bucketName,
+                Key: fileName,
+                Body: fileContent,
+            }, (error, data) => {
+                if (error)
+                    return reject(error);
+                console.log(`Uploaded ${data.Location}`);
+                return resolve(data);
+            });
+        });
+    });
+}
+const saveToS3Bucket = () => 
+// eslint-disable-next-line unicorn/consistent-function-scoping -- deliberately to future proof the SDK for options
+(input) => __awaiter(void 0, void 0, void 0, function* () {
+    console.log("Uploading data to S3...");
+    const bucketName = process.env.S3_BUCKET;
+    if (!bucketName)
+        throw new Error("S3_BUCKET is not specified");
+    const s3 = new aws_sdk_1.default.S3();
+    yield upload(s3, {
+        bucketName,
+        fileName: `${input.json.i_id}/${input.json.i_id}.csv`,
+        fileContent: input.csv,
+    });
+    yield upload(s3, {
+        bucketName,
+        fileName: `${input.json.i_id}/${input.json.i_id}.json`,
+        fileContent: JSON.stringify(input.json),
+    });
+    yield Promise.all(Object.entries(input.files).map(([nId, [dataUrl, fileExtension]]) => __awaiter(void 0, void 0, void 0, function* () {
+        yield upload(s3, {
+            bucketName,
+            fileName: `${input.json.i_id}/${nId}.${fileExtension}`,
+            fileContent: Buffer.from(dataUrl.split(",")[1], "base64"),
+        });
+    })));
+    console.log("Finished uploading data to S3.");
+});
+exports.saveToS3Bucket = saveToS3Bucket;

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

@@ -0,0 +1,2 @@
+export declare const packageDotJson: any;
+export declare const version: string;

package/dist/public-methods/version.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = exports.packageDotJson = void 0;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+exports.packageDotJson = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(__dirname, "../../package.json"), "utf8"));
+exports.version = Object.entries({
+    LANG: process.env.PDF_LANGUAGE || "default",
+    N: process.version.slice(1),
+    DH: exports.packageDotJson.version,
+    C: exports.packageDotJson.dependencies["@raytio/core"].slice(1),
+    T: exports.packageDotJson.dependencies["@raytio/types"].slice(1),
+})
+    .map((kv) => kv.join("="))
+    .join(" ");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/decrypt-helper",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "author": "Raytio",
   "description": "A helper to decrypt data shared by Raytio users",
   "main": "dist",
@@ -22,9 +22,9 @@
   },
   "dependencies": {
     "@aws-amplify/auth": "3.4.25",
-    "@raytio/core": "^11.1.0",
+    "@raytio/core": "^11.2.0",
     "@raytio/maxcryptor": "^3.1.0",
-    "@raytio/types": "^7.1.0",
+    "@raytio/types": "^7.2.0",
     "aws-sdk": "^2.754.0",
     "jsx-pdf": "^2.3.0",
     "localstorage-polyfill": "^1.0.1",
@@ -34,24 +34,24 @@
   },
   "devDependencies": {
     "@raytio/react-intl-manager": "^6.3.1",
-    "@types/jest": "^29.5.1",
+    "@types/jest": "^29.5.3",
     "@types/jest-image-snapshot": "^6.1.0",
     "@types/jsx-pdf": "^2.2.2",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^18.15.12",
+    "@types/node": "^18.16.19",
     "@types/pdfmake": "^0.2.2",
-    "@types/ramda": "^0.29.0",
+    "@types/ramda": "^0.29.3",
     "babel-preset-react-app": "^10.0.1",
-    "dotenv": "^16.0.3",
-    "eslint": "^8.38.0",
-    "eslint-config-kyle": "^11.14.2",
-    "jest": "^29.5.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.45.0",
+    "eslint-config-kyle": "^11.19.0",
+    "jest": "^29.6.1",
     "jest-image-snapshot": "^6.1.0",
     "jest-junit": "^16.0.0",
     "pdf-to-img": "^2.1.1",
-    "ts-jest": "^29.1.0",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.1.6"
   },
   "eslintConfig": {
     "extends": "kyle",