@raytio/core 11.0.0 → 11.1.0

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 11.1.0 (2022-04-20)
+
+- Move `expandSchema` into core
+
 ## 11.0.0 (2022-04-20)
 
 - 💥 BREAKING CHANGE: Changed the input arguments of `convertInstanceToRuleInput` to only require a list of `ProfileObject`s, instead of the whole `Instance` object.

package/README.md

@@ -32,9 +32,12 @@ If you wish to use `@raytio/core` directly, an example of configuring polyfills
 - [createAA](#createaa)
 - [decryptSharedData](#decryptshareddata)
 - [evaluateRule](#evaluaterule)
+- [expandSchema](#expandschema)
 - [findSchemaLabel](#findschemalabel)
+- [findSuitableLocale](#findsuitablelocale)
 - [fromCognitoAttributes](#fromcognitoattributes)
 - [getAADecryptor](#getaadecryptor)
+- [getNidFromUrn](#getnidfromurn)
 - [getOwnRealVerifications](#getownrealverifications)
 - [getPOVerification](#getpoverification)
 - [getSomeoneElsesRealVerifications](#getsomeoneelsesrealverifications)
@@ -46,6 +49,7 @@ If you wish to use `@raytio/core` directly, an example of configuring polyfills
 - [isScoreResultValid](#isscoreresultvalid)
 - [repairDate](#repairdate)
 - [someEncrypted](#someencrypted)
+- [sortSchemaProperties](#sortschemaproperties)
 - [toCognitoAttributes](#tocognitoattributes)
 
 ## Type Aliases
@@ -275,6 +279,28 @@ evaluates an individual rule, normally you should use [calculateScore](#calculat
 
 ___
 
+### expandSchema
+
+▸ **expandSchema**(`wrappedSchema`, `allUnexpandedSchemas`, `userLocales`): `Schema`
+
+❣️ This is the main function to transform a schema from
+the JSON that the API returns, into a `Schema` object that's useful
+to the client.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `wrappedSchema` | `WrappedSchema` |
+| `allUnexpandedSchemas` | `WrappedSchema`[] |
+| `userLocales` | readonly `string`[] |
+
+#### Returns
+
+`Schema`
+
+___
+
 ### findSchemaLabel
 
 ▸ **findSchemaLabel**(`labels`): `undefined` \| `string`
@@ -293,6 +319,26 @@ Finds the label (on a profile object) which is the schema name
 
 ___
 
+### findSuitableLocale
+
+▸ **findSuitableLocale**(`options`, `langs`): `undefined` \| `string`
+
+Selects the most suitable locale to use from a list of options.
+Returns undefined if there is no language that the user speaks
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | `string`[] |
+| `langs` | readonly `string`[] |
+
+#### Returns
+
+`undefined` \| `string`
+
+___
+
 ### fromCognitoAttributes
 
 ▸ **fromCognitoAttributes**(`attributes`): `UserDoc`
@@ -337,6 +383,38 @@ an `ApplicationEncryptor` and the public key of the Access Application
 
 ___
 
+### getNidFromUrn
+
+▸ **getNidFromUrn**(`urn`): `NId`
+
+two overloads - if you provide undefined, you might get undefined back
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `urn` | \`urn:user:${string}\` \| \`urn:profile\_object:${string}\` \| \`urn:instance:${string}\` \| \`urn:schema:${string}\` \| \`urn:temp\_object:${string}\` \| \`urn:document:${string}\` |
+
+#### Returns
+
+`NId`
+
+▸ **getNidFromUrn**(`urn`): `undefined` \| `NId`
+
+two overloads - if you provide undefined, you might get undefined back
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `urn` | `undefined` \| \`urn:user:${string}\` \| \`urn:profile\_object:${string}\` \| \`urn:instance:${string}\` \| \`urn:schema:${string}\` \| \`urn:temp\_object:${string}\` \| \`urn:document:${string}\` |
+
+#### Returns
+
+`undefined` \| `NId`
+
+___
+
 ### getOwnRealVerifications
 
 ▸ **getOwnRealVerifications**(`«destructured»`): `Promise`<`RealVer`[]\>
@@ -591,6 +669,26 @@ of properties that are encryted.
 
 ___
 
+### sortSchemaProperties
+
+▸ **sortSchemaProperties**(`properties`): `Section`[]
+
+Schema properties are an object, so they need to be converted into an
+array, grouped by the group tag, and then sorted based on the `priority`
+attribute within their group.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `properties` | `Record`<`string`, `SchemaField`\> |
+
+#### Returns
+
+`Section`[]
+
+___
+
 ### toCognitoAttributes
 
 ▸ **toCognitoAttributes**(`userDoc`): `Object`

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 {};