@raytio/core 10.1.0 → 11.1.0

package/dist/rules/types/index.js

@@ -1,19 +1,19 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./dataValueTypes"), exports);
-__exportStar(require("./config"), exports);
-__exportStar(require("./internal"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dataValueTypes"), exports);
+__exportStar(require("./config"), exports);
+__exportStar(require("./internal"), exports);

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

@@ -1,20 +1,20 @@
-import { HField, HSchema, GetTSType } from "./dataValueTypes";
-import { FieldValueTypes, ValueType } from "./config";
-export declare type RuleDataProperty<T extends FieldValueTypes> = {
-    type: T;
-    value: GetTSType<T>;
-    hField: HField;
-};
-export declare type RuleData = {
-    [schemaName: string]: {
-        hSchema: HSchema;
-        properties: {
-            [fieldName: string]: RuleDataProperty<FieldValueTypes>;
-        };
-    }[];
-};
-export declare type OperatorDef = {
-    /** the first operand is the LHS, all others are RHS */
-    operands: ValueType[];
-    implementation: (...args: any[]) => boolean;
-};
+import { HField, HSchema, GetTSType } from "./dataValueTypes";
+import { FieldValueTypes, ValueType } from "./config";
+export type RuleDataProperty<T extends FieldValueTypes> = {
+    type: T;
+    value: GetTSType<T>;
+    hField: HField;
+};
+export type RuleData = {
+    [schemaName: string]: {
+        hSchema: HSchema;
+        properties: {
+            [fieldName: string]: RuleDataProperty<FieldValueTypes>;
+        };
+    }[];
+};
+export type OperatorDef = {
+    /** the first operand is the LHS, all others are RHS */
+    operands: ValueType[];
+    implementation: (...args: any[]) => boolean;
+};

package/dist/rules/types/internal.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/rules/validate.d.ts

@@ -1,6 +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;
+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

@@ -1,14 +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;
+"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

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

package/dist/rules/version.js

@@ -1,5 +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";
+"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.4.0";

package/dist/schema/expandSchema/__tests__/addLoadingTimes.test.d.ts

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

package/dist/schema/expandSchema/__tests__/addLoadingTimes.test.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const addLoadingTimes_1 = require("../addLoadingTimes");
+describe("addLoadingTimes", () => {
+    it("parses loading times from the schema tags", () => {
+        const schema = {
+            name: "hi",
+            tags: [
+                "a:b",
+                "c",
+                "time:action1:20",
+                "time:action2:5",
+                "time:action3:0",
+                "time:action4:not a number",
+            ],
+        };
+        expect((0, addLoadingTimes_1.addLoadingTimes)(schema)).toStrictEqual(Object.assign(Object.assign({}, schema), { timing: {
+                action1: 20,
+                action2: 5,
+                action3: 0,
+                action4: NaN,
+            } }));
+    });
+});

package/dist/schema/expandSchema/__tests__/expandSchema.test.d.ts

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

package/dist/schema/expandSchema/__tests__/expandSchema.test.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const expandSchema_1 = require("../expandSchema");
+const fromAPI = [
+    {
+        name: "ps_Vessel",
+        start_date: "1970-01-01T00:00:00+00:00",
+        end_date: "2222-12-31T23:59:59+00:00",
+        active: true,
+        version_current: true,
+        version: "0.0.7",
+        type: "ps",
+        schema: {
+            $id: "https://api.rayt.io/graph/v1/schema/ps/ps_Vessel",
+            $schema: "http://json-schema.org/draft-07/schema#",
+            title: "Vessel/Boat",
+            description: "A schema that describes a maritime vessel",
+            i18n: {
+                "mi-NZ": {
+                    $schema: { title: "Waka" },
+                    vesselName: { title: "nga waka ingoa" },
+                },
+            },
+            tags: ["time:action1:20"],
+            required: ["vesselName"],
+            properties: {
+                manufacture_year: {
+                    allOf: [
+                        { $ref: "#/definitions/ss_birth_year_integer" },
+                        { tags: ["aaa"], priority: 700 },
+                    ],
+                },
+                vesselName: { type: "string", title: "Vessel Name", priority: 1000 },
+            },
+            definitions: {
+                ss_birth_year_integer: { $ref: "urn:schema:ss_birth_year_integer" },
+            },
+        },
+    },
+    {
+        name: "ss_birth_year_integer",
+        version: "0.0.1",
+        schema: {
+            $id: "this field often has typos. in this case its blatantly wrong",
+            $schema: "https://whatever",
+            maximum: 2022,
+            minimum: 1900,
+            tags: ["type:globally_unique_field"],
+            title: "Year of birth",
+        },
+    },
+];
+describe("expandSchema", () => {
+    it("can do the entire expansion process", () => {
+        expect((0, expandSchema_1.expandSchema)(fromAPI[0], fromAPI, ["lb-LU"])).toStrictEqual({
+            wasExpandedByClient: true,
+            // $schema was removed
+            name: "ps_Vessel",
+            title: "Vessel/Boat",
+            description: "A schema that describes a maritime vessel",
+            start_date: "1970-01-01T00:00:00+00:00",
+            end_date: "2222-12-31T23:59:59+00:00",
+            version: "0.0.7",
+            i18n: fromAPI[0].schema.i18n,
+            isProfileSchema: true,
+            isSpSchema: false,
+            properties: {
+                manufacture_year: {
+                    // $id was removed
+                    $prop: "manufacture_year",
+                    $ref: "ss_birth_year_integer",
+                    maximum: 2022,
+                    minimum: 1900,
+                    title: "Year of birth",
+                    // it merged the allOf into a single object
+                    priority: 700,
+                    tags: ["aaa", "type:globally_unique_field"],
+                },
+                vesselName: {
+                    $prop: "vesselName",
+                    // no $ref attribute
+                    priority: 1000,
+                    title: "Vessel Name",
+                    type: "string",
+                },
+            },
+            required: ["vesselName"],
+            tags: ["time:action1:20"],
+            timing: {
+                action1: 20,
+            },
+            verified_fields: undefined,
+        });
+    });
+});

package/dist/schema/expandSchema/__tests__/i18n.test.d.ts

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

package/dist/schema/expandSchema/__tests__/i18n.test.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const i18n_1 = require("../i18n");
+const DEFAULT_LOCALES = ["de-DE"]; // match what the client does in jest.setup.ts
+describe("getAllLocales", () => {
+    it("correctly expands languages with a country-componentand lowercases them", () => {
+        const expanded = (0, i18n_1.getAllLocales)([
+            "en-NZ",
+            "de-CH",
+            "be",
+            "ar-001",
+            "az-Cyrl-AZ",
+        ]);
+        expect(expanded).toStrictEqual([
+            "en-nz",
+            "en",
+            "de-ch",
+            "de",
+            "be",
+            "ar-001",
+            "ar",
+            "az-cyrl-az",
+            "az",
+        ]);
+    });
+});
+describe("findSuitableLocale", () => {
+    it("picks the most appropriate option", () => {
+        // the users's locale is `de-DE`, so it picked the most appropriate one from the options: `de-AT`
+        expect((0, i18n_1.findSuitableLocale)(["en-029", "de-AT", "fr-FR"], DEFAULT_LOCALES)).toBe("de-AT");
+    });
+});

package/dist/schema/expandSchema/__tests__/maybeUseI18n.test.d.ts

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

package/dist/schema/expandSchema/__tests__/maybeUseI18n.test.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const maybeUseI18n_1 = require("../maybeUseI18n");
+const DEFAULT_LOCALES = ["de-DE"]; // match what the client does in jest.setup.ts
+describe("maybeUseI18n", () => {
+    it("correctly applies schema-wise overrides", () => {
+        const originalSchema = {
+            schema_group: "old_schemas",
+            title: "Default title",
+            description: "default desc",
+            i18n: {
+                "de-de": {
+                    $schema: {
+                        title: "der Name dieses Schema",
+                        description: "eine Beschreibung in Deutsch",
+                    },
+                    old_schemas: {
+                        title_plural: "All the old sChema",
+                    },
+                },
+            },
+        };
+        const translatedSchema = (0, maybeUseI18n_1.maybeUseI18n)(originalSchema, DEFAULT_LOCALES);
+        expect(translatedSchema).toStrictEqual({
+            schema_group: "old_schemas",
+            group_title: "All the old sChema",
+            title: "der Name dieses Schema",
+            description: "eine Beschreibung in Deutsch",
+            clientLocale: "de-de",
+            groupNames: {},
+            properties: {},
+            i18n: originalSchema.i18n,
+        });
+    });
+    it("corretly creates a groupNames property with the correct locale", () => {
+        const originalSchema = {
+            i18n: {
+                "en-nz": {
+                    "group:DoB": { title: "Your date of birth" },
+                },
+                "fr-fr": {
+                    "group:DoB": { title: "anniversaire" },
+                },
+                "de-de": {
+                    "group:DoB": { title: "dein Geburtstag" },
+                },
+            },
+            properties: {
+                year_of_birth: {
+                    tags: ["group:DoB"],
+                },
+            },
+        };
+        const translatedSchema = (0, maybeUseI18n_1.maybeUseI18n)(originalSchema, DEFAULT_LOCALES);
+        expect(translatedSchema).toStrictEqual({
+            clientLocale: "de-de",
+            groupNames: {
+                DoB: "dein Geburtstag",
+            },
+            group_title: undefined,
+            properties: originalSchema.properties,
+            i18n: originalSchema.i18n,
+        });
+    });
+    it("correctly applies overrides to certain schema fields", () => {
+        const originalSchema = {
+            i18n: {
+                "en-029": {
+                    year_of_birth: { title: "Your year of birth" },
+                },
+                de: {
+                    // also testing whether it utilizes "de" even tho locale is "de-DE"
+                    year_of_birth: { title: "dein Geburtsjahr", randomProp: 1 },
+                },
+            },
+            properties: {
+                year_of_birth: {
+                    title: "Default field title",
+                    tags: ["group:DoB"],
+                },
+            },
+        };
+        const translatedSchema = (0, maybeUseI18n_1.maybeUseI18n)(originalSchema, DEFAULT_LOCALES);
+        expect(translatedSchema).toStrictEqual({
+            clientLocale: "de",
+            groupNames: {},
+            group_title: undefined,
+            properties: {
+                year_of_birth: {
+                    title: "dein Geburtsjahr",
+                    randomProp: 1,
+                    tags: ["group:DoB"],
+                },
+            },
+            i18n: originalSchema.i18n,
+        });
+    });
+});

package/dist/schema/expandSchema/__tests__/processSchema.test.d.ts

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