@raytio/core 10.0.0 → 10.0.1

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 10.0.1 (2022-07-06)
+
+- added 2 methods (`isScoreResultValid` and `isScoreConfigValid`) to verify if stored score-data is valid
+
 ## 10.0.0 (2022-04-11)
 
 - 💥 BREAKING CHANGE: `calculateScore` is now an async function, and returns extra diagnostics.

package/README.md

@@ -40,6 +40,8 @@ If you wish to use `@raytio/core` directly, an example of configuring polyfills
 - [isConditionMet](#isconditionmet)
 - [isEncrypted](#isencrypted)
 - [isEncryptedFile](#isencryptedfile)
+- [isScoreConfigValid](#isscoreconfigvalid)
+- [isScoreResultValid](#isscoreresultvalid)
 - [someEncrypted](#someencrypted)
 - [toCognitoAttributes](#tocognitoattributes)
 
@@ -373,6 +375,8 @@ ___
 
 ▸ **hashPassword**(`password`): `Promise`<`string`\>
 
+**`deprecated`** legacy feature, see #1252
+
 AWS Cognito never gets the raw password. We send them
 a hashed verison using PBKDF2 with SHA-256 and 10,000
 iterations.
@@ -451,6 +455,42 @@ true or false depending on whether the input is an encrypted Raytio file
 
 ___
 
+### isScoreConfigValid
+
+▸ `Const` **isScoreConfigValid**(`x`): x is ScoreConfig
+
+determines whether a `ScoreConfig` object is valid
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `x` | `unknown` |
+
+#### Returns
+
+x is ScoreConfig
+
+___
+
+### isScoreResultValid
+
+▸ `Const` **isScoreResultValid**(`x`): x is ScoreResult
+
+determines whether a `ScoreResult` object is valid
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `x` | `unknown` |
+
+#### Returns
+
+x is ScoreResult
+
+___
+
 ### someEncrypted
 
 ▸ `Const` **someEncrypted**<`T`, `K`\>(...`args`): `number`

package/dist/general/password.d.ts

@@ -1,4 +1,6 @@
 /**
+ * @deprecated legacy feature, see #1252
+ *
  * AWS Cognito never gets the raw password. We send them
  * a hashed verison using PBKDF2 with SHA-256 and 10,000
  * iterations.

package/dist/general/password.js

@@ -5,6 +5,8 @@ exports.hashPassword = void 0;
 /** @internal */
 const SALT = "247 213 94 9 15 236 156 48 194 177 107 216 198 215 169 239";
 /**
+ * @deprecated legacy feature, see #1252
+ *
  * AWS Cognito never gets the raw password. We send them
  * a hashed verison using PBKDF2 with SHA-256 and 10,000
  * iterations.

package/dist/rules/calculateScore.d.ts

@@ -3,7 +3,9 @@ import { RuleData, ScoreConfig } from "./types";
 export declare type ScoreResult = {
     score: number;
     category: string;
+    categoryColour: string | undefined;
     diagnostics: {
+        version: string;
         config: {
             id: string;
             rules: {

package/dist/rules/calculateScore.js

@@ -4,6 +4,7 @@ exports.calculateScore = void 0;
 const evaluateScoreCondition_1 = require("./evaluateScoreCondition");
 const helpers_1 = require("./helpers");
 const general_1 = require("../general");
+const version_1 = require("./version");
 function evaluateASTNode(node, data) {
     if (node.type === "LanguageOperator") {
         if (!node.children.length) {
@@ -58,7 +59,9 @@ async function calculateScore(ruleConfig, ruleInput) {
     return {
         score: finalScore,
         category: matchingCategories[0].name,
+        categoryColour: matchingCategories[0].colour,
         diagnostics: {
+            version: version_1.SUBMISSION_RULES_VERSION,
             config: {
                 id: await jsonId(ruleConfig),
                 rules: await Promise.all(result.map(async ({ passed }, i) => {

package/dist/rules/evaluateScoreCondition.js

@@ -21,7 +21,7 @@ function evaluateScoreCondition(node, data) {
         : (0, helpers_1.getValuesFromPath)(x.value.path, data))
         .map(valuesForArg => valuesForArg.filter(v => typeof v !== "undefined"));
     for (const [i, argType] of op.operands.entries()) {
-        if (argType !== node.values[i].type) {
+        if ((0, helpers_1.simplifyValueType)(argType) !== (0, helpers_1.simplifyValueType)(node.values[i].type)) {
             throw new TypeError(`Operator argument ${i} expected ${argType} but got ${node.values[i].type} for '${node.operator}'`);
         }
         const values = rawValues[i];

package/dist/rules/helpers/checkTypeofValue.d.ts

@@ -1,3 +1,9 @@
 import { GetTSType, ValueType } from "../types";
 /** asserts that the provided `value` meets the constaints of `type` */
 export declare function checkTypeofValue<T extends ValueType>(type: T, value: unknown): value is GetTSType<T>;
+/**
+ * Some types are effectively equivilant (e.g. n_id and string).
+ * Any exceptions defined here should use the same validator in
+ * `checkTypeofValue` above.
+ */
+export declare function simplifyValueType(type: ValueType): ValueType;

package/dist/rules/helpers/checkTypeofValue.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkTypeofValue = void 0;
+exports.simplifyValueType = exports.checkTypeofValue = void 0;
 const types_1 = require("@raytio/types");
 const symbols_1 = require("./symbols");
 const types_2 = require("../types");
@@ -34,6 +34,7 @@ function checkTypeofValue(type, value) {
             return typeof value === "number" && value in types_1.POVerification;
         case "RegEx":
             return value instanceof RegExp;
+        case "Verifier":
         case "String":
             return typeof value === "string";
         default:
@@ -41,3 +42,14 @@ function checkTypeofValue(type, value) {
     }
 }
 exports.checkTypeofValue = checkTypeofValue;
+/**
+ * Some types are effectively equivilant (e.g. n_id and string).
+ * Any exceptions defined here should use the same validator in
+ * `checkTypeofValue` above.
+ */
+function simplifyValueType(type) {
+    if (type === "Verifier")
+        return "String";
+    return type;
+}
+exports.simplifyValueType = simplifyValueType;

package/dist/rules/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./calculateScore";
 export * from "./convertInstanceToRuleInput";
+export * from "./validate";
 export * from "./types/config";
 export * from "./helpers/thresholds";
 export * from "./helpers/addInfiniteThresholdBoundaries";

package/dist/rules/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.scoreOperators = void 0;
 __exportStar(require("./calculateScore"), exports);
 __exportStar(require("./convertInstanceToRuleInput"), exports);
+__exportStar(require("./validate"), exports);
 __exportStar(require("./types/config"), exports);
 __exportStar(require("./helpers/thresholds"), exports);
 __exportStar(require("./helpers/addInfiniteThresholdBoundaries"), exports);

package/dist/rules/operators/hfield.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fieldOperators = void 0;
 exports.fieldOperators = {
     field_verifiedBy: {
-        operands: ["HField", "String"],
+        operands: ["HField", "Verifier"],
         implementation(field, verifiedBy) {
             return field.verifiedBy.includes(verifiedBy);
         },

package/dist/rules/operators/hschema.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.schemaOperators = void 0;
 exports.schemaOperators = {
     schema_verifiedBy: {
-        operands: ["HSchema", "String"],
+        operands: ["HSchema", "Verifier"],
         implementation(schema, verifiedBy) {
             return schema === null || schema === void 0 ? void 0 : schema.verifiedBy.includes(verifiedBy);
         },

package/dist/rules/types/config.d.ts

@@ -32,7 +32,7 @@ export declare type ValueRef<T> = ValueRefConst<T> | ValueRefVar;
 /** @ignore these are the LHS & RHS operands which come from variables (or constants) */
 export declare type FieldValueTypes = "Bool" | "Number" | "String" | "Date" | "Array" | "HField" | "HSchema";
 /** @ignore these are the RHS-only operands which come from constants ONLY */
-export declare type ConstValueTypes = "DateUnit" | "RegEx" | "FieldVerification" | "POVerification";
+export declare type ConstValueTypes = "DateUnit" | "RegEx" | "Verifier" | "FieldVerification" | "POVerification";
 /** @ignore full list of operands which come from variables OR constants */
 export declare type ValueType = ConstValueTypes | FieldValueTypes;
 /** @ignore */
@@ -72,6 +72,11 @@ export declare type ScoreThreshold = {
     from: number;
     to: number;
     name: string;
+    /**
+     * A hex code, including the hash.
+     * For compatibility reasons we must assume it could be missing
+     */
+    colour: string | undefined;
 };
 /** @ignore */
 export declare type Combinator = "+" | "*";

package/dist/rules/types/dataValueTypes.d.ts

@@ -16,4 +16,4 @@ export declare type HSchema = {
 };
 export declare const DATE_UNITS: readonly ["ms", "s", "m", "h", "D", "M", "W", "Y"];
 export declare type DateUnit = typeof DATE_UNITS[number];
-export declare type GetTSType<T> = T extends "Bool" ? boolean : T extends "Number" ? number : T extends "String" ? string : T extends "Date" ? Date : T extends "Array" ? unknown[] : T extends "HField" ? HField : T extends "HSchema" ? HSchema : T extends "DateUnit" ? DateUnit : T extends "RegEx" ? RegExp : T extends "FieldVerification" ? FieldVerification : T extends "POVerification" ? POVerification : never;
+export declare type GetTSType<T> = T extends "Bool" ? boolean : T extends "Number" ? number : T extends "String" ? string : T extends "Date" ? Date : T extends "Array" ? unknown[] : T extends "HField" ? HField : T extends "HSchema" ? HSchema : T extends "DateUnit" ? DateUnit : T extends "RegEx" ? RegExp : T extends "Verifier" ? NId : T extends "FieldVerification" ? FieldVerification : T extends "POVerification" ? POVerification : never;

package/dist/rules/validate.d.ts

@@ -0,0 +1,6 @@
+import { ScoreResult } from "./calculateScore";
+import { ScoreConfig } from "./types";
+/** determines whether a `ScoreResult` object is valid */
+export declare const isScoreResultValid: (x: unknown) => x is ScoreResult;
+/** determines whether a `ScoreConfig` object is valid */
+export declare const isScoreConfigValid: (x: unknown) => x is ScoreConfig;

package/dist/rules/validate.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isScoreConfigValid = exports.isScoreResultValid = void 0;
+const ramda_1 = require("ramda");
+/** @internal - separate function so that TS understands whats going on */
+const isObjectLike = (x) => typeof x === "object" && !!x && "score" in x && "category" in x;
+/** determines whether a `ScoreResult` object is valid */
+const isScoreResultValid = (x) => isObjectLike(x) &&
+    typeof x.category === "string" &&
+    typeof x.score === "number";
+exports.isScoreResultValid = isScoreResultValid;
+/** determines whether a `ScoreConfig` object is valid */
+const isScoreConfigValid = (x) => typeof x === "object" && !!x && !(0, ramda_1.isEmpty)(x) && !Array.isArray(x);
+exports.isScoreConfigValid = isScoreConfigValid;

package/dist/rules/version.d.ts

@@ -0,0 +1 @@
+export declare const SUBMISSION_RULES_VERSION = "sr1.3.0";

package/dist/rules/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUBMISSION_RULES_VERSION = void 0;
+// this must be kept in sync with ./CHANGELOG.md. See that file for more info
+exports.SUBMISSION_RULES_VERSION = "sr1.3.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raytio/core",
-  "version": "10.0.0",
+  "version": "10.0.1",
   "license": "MIT",
   "main": "index",
   "types": "index",
@@ -17,14 +17,14 @@
   },
   "dependencies": {
     "@raytio/maxcryptor": "3.1.0",
-    "@raytio/types": "6.0.1",
+    "@raytio/types": "6.0.2",
     "ramda": "0.28.0"
   },
   "devDependencies": {
-    "@types/ramda": "0.28.11",
-    "jest": "27.5.1",
+    "@types/ramda": "0.28.14",
+    "jest": "28.1.2",
     "localstorage-polyfill": "1.0.1",
-    "ts-jest": "27.1.4"
+    "ts-jest": "28.0.5"
   },
   "jest": {
     "transform": {