@raytio/core 11.2.0 → 11.3.0

package/CHANGELOG.md

@@ -13,6 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 11.3.0 (2023-12-05)
+
+- Migrate to the v3 API for instances
+
 ## 11.2.0 (2023-07-03)
 
 - Support key rotation

package/README.md

@@ -20,6 +20,7 @@ If you wish to use `@raytio/core` directly, an example of configuring polyfills
 
 - [SafeHarbourObj](#safeharbourobj)
 - [SafeHarbourResult](#safeharbourresult)
+- [ServerRelationship](#serverrelationship)
 - [VerDetails](#verdetails)
 
 ### Functions
@@ -27,9 +28,10 @@ If you wish to use `@raytio/core` directly, an example of configuring polyfills
 - [calcSafeHarbourScore](#calcsafeharbourscore)
 - [calculateScore](#calculatescore)
 - [checkJsonSignature](#checkjsonsignature)
-- [cleanInstance](#cleaninstance)
 - [convertInstanceToRuleInput](#convertinstancetoruleinput)
+- [convertServerRelationship](#convertserverrelationship)
 - [createAA](#createaa)
+- [createHashedNId](#createhashednid)
 - [decryptSharedData](#decryptshareddata)
 - [evaluateRule](#evaluaterule)
 - [expandSchema](#expandschema)
@@ -37,6 +39,8 @@ If you wish to use `@raytio/core` directly, an example of configuring polyfills
 - [findSuitableLocale](#findsuitablelocale)
 - [fromCognitoAttributes](#fromcognitoattributes)
 - [getAADecryptor](#getaadecryptor)
+- [getAAPublicKey](#getaapublickey)
+- [getMissingDataForInstance](#getmissingdataforinstance)
 - [getNidFromUrn](#getnidfromurn)
 - [getOwnRealVerifications](#getownrealverifications)
 - [getPOVerification](#getpoverification)
@@ -77,6 +81,14 @@ the response from [calcSafeHarbourScore](#calcsafeharbourscore)
 
 ___
 
+### ServerRelationship
+
+Ƭ **ServerRelationship**: `Omit`<`Relationship`, ``"p_id"`` \| ``"start"`` \| ``"end"``\> & { `from_id`: `NId` ; `id`: `PId`  } & { `to_id`: `NId`  } \| { `to_i_id`: `IId`  }
+
+This type represents the relationship format returned by the Postgres API
+
+___
+
 ### VerDetails
 
 Ƭ **VerDetails**: `Object`
@@ -108,7 +120,7 @@ from different sources. For information, refer to the
 | `data.person` | `ProfileObject` |
 | `data.profileObjects` | `ProfileObject`[] |
 | `data.realVers` | `RealVer`[] |
-| `data.getSchema` | (`schemaName`: `string`) => `Promise`<`Schema`\> |
+| `data.getSchema` | (`schemaName`: `SchemaName`) => `Promise`<`Schema`\> |
 
 #### Returns
 
@@ -158,43 +170,41 @@ or `getSomeoneElsesRealVerifications` instead.
 
 ___
 
-### cleanInstance
-
-▸ **cleanInstance**(`instance`): `Instance`
-
-The API response from share/v2/access_application/instance/:iId
-returns a complicated hashed_n_id format, so you need to clean up
-the API response using this function as soon as possible.
+### convertInstanceToRuleInput
 
-We relace `hashed_n_id`s with a string `HASHED::{NId}::{AId}`
+▸ **convertInstanceToRuleInput**(`POs`, `realVers`, `getSchema`): `Promise`<`RuleData`\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `instance` | `Instance` |
+| `POs` | `ProfileObject`[] |
+| `realVers` | `RealVer`[] |
+| `getSchema` | (`schemaName`: `SchemaName`) => `Promise`<`Schema`\> |
 
 #### Returns
 
-`Instance`
+`Promise`<`RuleData`\>
 
 ___
 
-### convertInstanceToRuleInput
+### convertServerRelationship
 
-▸ **convertInstanceToRuleInput**(`POs`, `realVers`, `getSchema`): `Promise`<`RuleData`\>
+▸ **convertServerRelationship**(`serverRelationship`): `Relationship`
+
+Converts relationship type used by the server into the (Urn format) type used by the client
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `POs` | `ProfileObject`[] |
-| `realVers` | `RealVer`[] |
-| `getSchema` | (`schemaName`: `string`) => `Promise`<`Schema`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `serverRelationship` | [`ServerRelationship`](#serverrelationship) | relationship type used in the server |
 
 #### Returns
 
-`Promise`<`RuleData`\>
+`Relationship`
+
+a Relationship (client-side type) that is equivalent to the inputted serverRelationship value
 
 ___
 
@@ -226,6 +236,29 @@ as well as the `userDoc` data which is stored in the user's cognito attributes.
 
 ___
 
+### createHashedNId
+
+▸ **createHashedNId**(`nId`, `aId`): `NId`
+
+the API returns hashed NIds in a separate field,
+which breaks the whole app. So, we move the hashed ID into
+the normal `n_id` field, and use a different format.
+
+This was first introduced in #1048
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `nId` | `NId` |
+| `aId` | `AId` |
+
+#### Returns
+
+`NId`
+
+___
+
 ### decryptSharedData
 
 ▸ **decryptSharedData**(`«destructured»`): `Promise`<{ `applicationDecryptor`: `ApplicationDataEncryptorI` ; `instance`: `Instance`  }\>
@@ -304,7 +337,7 @@ ___
 
 ### findSchemaLabel
 
-▸ **findSchemaLabel**(`labels`): `undefined` \| `string`
+▸ **findSchemaLabel**(`labels`): `undefined` \| `SchemaName`
 
 Finds the label (on a profile object) which is the schema name
 
@@ -316,7 +349,7 @@ Finds the label (on a profile object) which is the schema name
 
 #### Returns
 
-`undefined` \| `string`
+`undefined` \| `SchemaName`
 
 ___
 
@@ -361,7 +394,7 @@ ___
 
 ### getAADecryptor
 
-▸ **getAADecryptor**(`«destructured»`): `Promise`<{ `decryptor`: `ApplicationEncryptor` ; `publicKeyNId`: `NId`  }\>
+▸ **getAADecryptor**(`«destructured»`): `Promise`<{ `decryptor`: `ApplicationEncryptor` ; `publicKeyId`: `KId`  }\>
 
 Fetchs the public and private keys for an Access Application, then initializes
 the [https://npm.im/@raytio/maxcryptor|Maxcryptor](https://npm.im/@raytio/maxcryptor|Maxcryptor)'s `ApplicationEncryptor`.
@@ -378,18 +411,69 @@ the [https://npm.im/@raytio/maxcryptor|Maxcryptor](https://npm.im/@raytio/maxcry
 
 #### Returns
 
-`Promise`<{ `decryptor`: `ApplicationEncryptor` ; `publicKeyNId`: `NId`  }\>
+`Promise`<{ `decryptor`: `ApplicationEncryptor` ; `publicKeyId`: `KId`  }\>
 
 an `ApplicationEncryptor` and the public key of the Access Application
 
 ___
 
+### getAAPublicKey
+
+▸ **getAAPublicKey**(`«destructured»`): `Promise`<`PublicKeyNode`\>
+
+Fetches the Public Key Information for an Access Application
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `aId` | `AId` |
+| › `apiToken` | `string` |
+| › `apiUrl` | `string` |
+
+#### Returns
+
+`Promise`<`PublicKeyNode`\>
+
+the id and Key information of the Applications Public Key
+
+___
+
+### getMissingDataForInstance
+
+▸ **getMissingDataForInstance**(`«destructured»`): `Promise`<`Instance`\>
+
+the new API doesn't return the whole instance at once,
+so we have to make several additional API requests.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `apiToken` | `string` |
+| › `apiUrl` | `string` |
+| › `instanceWithoutData` | `InstanceWithoutData` |
+
+#### Returns
+
+`Promise`<`Instance`\>
+
+___
+
 ### getNidFromUrn
 
-▸ **getNidFromUrn**(`urn`): `NId`
+▸ **getNidFromUrn**<`IDType`\>(`urn`): `IDType`
 
 two overloads - if you provide undefined, you might get undefined back
 
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `IDType` | `NId` |
+
 #### Parameters
 
 | Name | Type |
@@ -398,12 +482,18 @@ two overloads - if you provide undefined, you might get undefined back
 
 #### Returns
 
-`NId`
+`IDType`
 
-▸ **getNidFromUrn**(`urn`): `undefined` \| `NId`
+▸ **getNidFromUrn**<`IDType`\>(`urn`): `undefined` \| `IDType`
 
 two overloads - if you provide undefined, you might get undefined back
 
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `IDType` | `NId` |
+
 #### Parameters
 
 | Name | Type |
@@ -412,7 +502,7 @@ two overloads - if you provide undefined, you might get undefined back
 
 #### Returns
 
-`undefined` \| `NId`
+`undefined` \| `IDType`
 
 ___
 
@@ -646,7 +736,7 @@ ___
 
 ### someEncrypted
 
-▸ **someEncrypted**<`T`, `K`\>(`...args`): `number`
+▸ **someEncrypted**<`T`\>(`...args`): `number`
 
 Given a profile object's properties, returns the number
 of properties that are encryted.
@@ -656,7 +746,6 @@ of properties that are encryted.
 | Name | Type |
 | :------ | :------ |
 | `T` | extends `object` |
-| `K` | extends `string` \| `number` \| `symbol` |
 
 #### Parameters
 

package/dist/accessApplication/api/__tests__/fetchKeysForSubmission.test.d.ts

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

package/dist/accessApplication/api/__tests__/fetchKeysForSubmission.test.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetchKeysForSubmission_1 = require("../fetchKeysForSubmission");
+vi.spyOn(global, "fetch").mockResolvedValueOnce({
+    json: async () => [
+        { aain_id: "n1", field_name: "f1", key_data: 1 },
+        { aain_id: "n1", field_name: "f2", key_data: 1 },
+        { aain_id: "n2", field_name: "f2", key_data: 3 },
+        { aain_id: "n3", field_name: "f1", key_data: 4 },
+        { aain_id: "n3", field_name: "f2", key_data: 5 },
+        { aain_id: "n3", field_name: "f3", key_data: 6 },
+    ],
+});
+describe("fetchKeysForSubmission", () => {
+    it("converts the hashed_n_id format into n_id", async () => {
+        expect(await (0, fetchKeysForSubmission_1.fetchKeysForSubmission)({
+            iId: "i1",
+            apiToken: "apiToken",
+            apiUrl: "apiUrl",
+        })).toStrictEqual({
+            n1: { f1: 1, f2: 1 },
+            n2: { f2: 3 },
+            n3: { f1: 4, f2: 5, f3: 6 },
+        });
+        expect(fetch).toHaveBeenCalledTimes(1);
+        expect(fetch).toHaveBeenNthCalledWith(1, "apiUrl/db/v1/dsm_access_application_instance_node_keys?aai_id=eq.i1", { headers: { Authorization: "Bearer apiToken" } });
+    });
+});

package/dist/accessApplication/api/__tests__/fetchPOsOrAOsForSubmission.test.d.ts

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

package/dist/accessApplication/api/__tests__/fetchPOsOrAOsForSubmission.test.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetchPOsOrAOsForSubmission_1 = require("../fetchPOsOrAOsForSubmission");
+vi.spyOn(global, "fetch").mockResolvedValueOnce({
+    json: async () => [
+        { n_id: "n1", properties: { a: 1 }, aa_id: "a1", aai_id: "i1" },
+        { hashed_n_id: "n2", properties: { b: 2 }, aa_id: "a2", aai_id: "i2" },
+    ],
+});
+describe("fetchPOsOrAOsForSubmission", () => {
+    it("converts the hashed_n_id format into n_id", async () => {
+        expect(await (0, fetchPOsOrAOsForSubmission_1.fetchPOsOrAOsForSubmission)({ iId: "i1", apiToken: "apiToken", apiUrl: "apiUrl" }, "AOs")).toStrictEqual([
+            { n_id: "n1", properties: { a: 1 }, isFromSubmission: ["a1", "i1"] },
+            {
+                n_id: "HASHED::n2::a2",
+                properties: { b: 2 },
+                isFromSubmission: ["a2", "i2"],
+            },
+        ]);
+        expect(fetch).toHaveBeenCalledTimes(1);
+        expect(fetch).toHaveBeenNthCalledWith(1, "apiUrl/db/v1/dsm_access_application_instance_application_objects?aai_id=eq.i1", { headers: { Authorization: "Bearer apiToken" } });
+    });
+});

package/dist/accessApplication/api/__tests__/fetchRelationshipsForSubmission.test.d.ts

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

package/dist/accessApplication/api/__tests__/fetchRelationshipsForSubmission.test.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fetchRelationshipsForSubmission_1 = require("../fetchRelationshipsForSubmission");
+vi.spyOn(global, "fetch").mockResolvedValueOnce({
+    json: async () => [
+        { id: "p1", from_id: "n1", to_id: "n2" },
+        { id: "p1", from_id: "n1", to_i_id: "n2" },
+    ],
+});
+describe("fetchRelationshipsForSubmission", () => {
+    it("converts the hashed_n_id format into n_id", async () => {
+        expect(await (0, fetchRelationshipsForSubmission_1.fetchRelationshipsForSubmission)({
+            iId: "i1",
+            apiToken: "apiToken",
+            apiUrl: "apiUrl",
+        })).toStrictEqual([
+            {
+                p_id: "p1",
+                start: "urn:profile_object:n1",
+                end: "urn:profile_object:n2",
+            },
+            { p_id: "p1", start: "urn:profile_object:n1", end: "urn:instance:n2" },
+        ]);
+        expect(fetch).toHaveBeenCalledTimes(1);
+        expect(fetch).toHaveBeenNthCalledWith(1, "apiUrl/db/v1/dsm_access_application_instance_node_relationships?aai_id=eq.i1", { headers: { Authorization: "Bearer apiToken" } });
+    });
+});

package/dist/accessApplication/api/__tests__/getMissingDataForInstance.test.d.ts

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

package/dist/accessApplication/api/__tests__/getMissingDataForInstance.test.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getMissingDataForInstance_1 = require("../getMissingDataForInstance");
+vi.mock("../fetchKeysForSubmission", () => ({
+    fetchKeysForSubmission: async () => [3, 4],
+}));
+vi.mock("../fetchPOsOrAOsForSubmission", () => ({
+    fetchPOsOrAOsForSubmission: async () => [1, 2],
+}));
+vi.mock("../fetchRelationshipsForSubmission", () => ({
+    fetchRelationshipsForSubmission: async () => [5, 6],
+}));
+describe("getMissingDataForInstance", () => {
+    it("converts the hashed_n_id format into n_id", async () => {
+        expect(await (0, getMissingDataForInstance_1.getMissingDataForInstance)({
+            instanceWithoutData: {
+                id: "i1",
+                confirmation_code: "ABC123",
+            },
+            apiToken: "apiToken",
+            apiUrl: "apiUrl",
+        })).toStrictEqual({
+            confirmation_code: "ABC123",
+            id: "i1",
+            keys: [3, 4],
+            profile_objects: [1, 2, 1, 2],
+            relationships: [5, 6],
+        });
+    });
+});

package/dist/accessApplication/api/fetchKeysForSubmission.d.ts

@@ -0,0 +1,12 @@
+import type { IId, NId2 } from "@raytio/types";
+export declare function fetchKeysForSubmission({ apiToken, apiUrl, iId, }: {
+    apiUrl: string;
+    apiToken: string;
+    iId: IId;
+}): Promise<{
+    [nId2: NId2]: {
+        [fieldName: string]: {
+            data: string;
+        };
+    };
+}>;

package/dist/accessApplication/api/fetchKeysForSubmission.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchKeysForSubmission = void 0;
+const util_1 = require("../../util");
+async function fetchKeysForSubmission({ apiToken, apiUrl, iId, }) {
+    var _a;
+    const keys = await fetch(`${apiUrl}/db/v1/dsm_access_application_instance_node_keys?aai_id=eq.${iId}`, { headers: { Authorization: `Bearer ${apiToken}` } }).then(util_1.handleResponse);
+    const keysObject = {};
+    for (const key of keys) {
+        /* eslint-disable fp/no-mutation -- much more logical written like this */
+        keysObject[_a = key.aain_id] || (keysObject[_a] = {});
+        keysObject[key.aain_id][key.field_name] = key.key_data;
+    }
+    return keysObject;
+}
+exports.fetchKeysForSubmission = fetchKeysForSubmission;

package/dist/accessApplication/api/fetchPOsOrAOsForSubmission.d.ts

@@ -0,0 +1,6 @@
+import type { IId, ProfileObject } from "@raytio/types";
+export declare function fetchPOsOrAOsForSubmission({ iId, apiUrl, apiToken }: {
+    iId: IId;
+    apiUrl: string;
+    apiToken: string;
+}, type: "POs" | "AOs"): Promise<ProfileObject[]>;

package/dist/accessApplication/api/fetchPOsOrAOsForSubmission.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchPOsOrAOsForSubmission = void 0;
+const ramda_1 = require("ramda");
+const util_1 = require("../../util");
+const general_1 = require("../../general");
+const API_URLS = {
+    POs: "dsm_access_application_instance_nodes",
+    AOs: "dsm_access_application_instance_application_objects",
+};
+async function fetchPOsOrAOsForSubmission({ iId, apiUrl, apiToken }, type) {
+    const POsforAA = await fetch(`${apiUrl}/db/v1/${API_URLS[type]}?aai_id=eq.${iId}`, { headers: { Authorization: `Bearer ${apiToken}` } }).then(util_1.handleResponse);
+    /**
+     * the backend finally includes the aId and iId properties,
+     * but we already have our own system for accessing this data
+     * since we've needed it for the past few years.
+     *
+     * additionally, we relace the weird `hashed_n_id` format with
+     * the result from {@link createHashedNId}, because that's what we've
+     * always done.
+     */
+    const cleanedPOs = POsforAA.map((PO) => (Object.assign(Object.assign({}, (0, ramda_1.omit)(["aa_id", "aai_id", "hashed_n_id"], PO)), { n_id: PO.n_id || (0, general_1.createHashedNId)(PO.hashed_n_id, PO.aa_id), isFromSubmission: [PO.aa_id, PO.aai_id] }))).filter(PO => PO.properties !== null && PO.properties !== undefined);
+    return cleanedPOs;
+}
+exports.fetchPOsOrAOsForSubmission = fetchPOsOrAOsForSubmission;

package/dist/accessApplication/api/fetchRelationshipsForSubmission.d.ts

@@ -0,0 +1,6 @@
+import type { IId, Relationship } from "@raytio/types";
+export declare function fetchRelationshipsForSubmission({ iId, apiUrl, apiToken, }: {
+    iId: IId;
+    apiUrl: string;
+    apiToken: string;
+}): Promise<Relationship[]>;

package/dist/accessApplication/api/fetchRelationshipsForSubmission.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchRelationshipsForSubmission = void 0;
+const util_1 = require("../../util");
+const legacy_1 = require("./legacy");
+async function fetchRelationshipsForSubmission({ iId, apiUrl, apiToken, }) {
+    const relationships = await fetch(`${apiUrl}/db/v1/dsm_access_application_instance_node_relationships?aai_id=eq.${iId}`, { headers: { Authorization: `Bearer ${apiToken}` } }).then(util_1.handleResponse);
+    return relationships.map(legacy_1.convertServerRelationship);
+}
+exports.fetchRelationshipsForSubmission = fetchRelationshipsForSubmission;

package/dist/accessApplication/api/getMissingDataForInstance.d.ts

@@ -0,0 +1,10 @@
+import type { Instance, InstanceWithoutData } from "@raytio/types";
+/**
+ * the new API doesn't return the whole instance at once,
+ * so we have to make several additional API requests.
+ */
+export declare const getMissingDataForInstance: ({ apiToken, apiUrl, instanceWithoutData, }: {
+    apiToken: string;
+    apiUrl: string;
+    instanceWithoutData: InstanceWithoutData;
+}) => Promise<Instance>;

package/dist/accessApplication/api/getMissingDataForInstance.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMissingDataForInstance = void 0;
+const fetchKeysForSubmission_1 = require("./fetchKeysForSubmission");
+const fetchPOsOrAOsForSubmission_1 = require("./fetchPOsOrAOsForSubmission");
+const fetchRelationshipsForSubmission_1 = require("./fetchRelationshipsForSubmission");
+/**
+ * the new API doesn't return the whole instance at once,
+ * so we have to make several additional API requests.
+ */
+const getMissingDataForInstance = async ({ apiToken, apiUrl, instanceWithoutData, }) => {
+    const options = {
+        apiToken,
+        apiUrl,
+        iId: instanceWithoutData.id,
+    };
+    // these 4 can be requested in parallel. Ideally the backend
+    // would do this work for us like the old API used to.
+    const [POs, AOs, relationships, keys] = await Promise.all([
+        (0, fetchPOsOrAOsForSubmission_1.fetchPOsOrAOsForSubmission)(options, "POs"),
+        (0, fetchPOsOrAOsForSubmission_1.fetchPOsOrAOsForSubmission)(options, "AOs"),
+        (0, fetchRelationshipsForSubmission_1.fetchRelationshipsForSubmission)(options),
+        (0, fetchKeysForSubmission_1.fetchKeysForSubmission)(options),
+    ]);
+    return Object.assign(Object.assign({}, instanceWithoutData), { profile_objects: [...POs, ...AOs], relationships,
+        keys });
+};
+exports.getMissingDataForInstance = getMissingDataForInstance;

package/dist/accessApplication/api/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./legacy";
+export * from "./getMissingDataForInstance";

package/dist/accessApplication/api/index.js

@@ -0,0 +1,18 @@
+"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("./legacy"), exports);
+__exportStar(require("./getMissingDataForInstance"), exports);

package/dist/accessApplication/api/legacy/__tests__/convertRelationships.test.d.ts

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

package/dist/accessApplication/api/legacy/__tests__/convertRelationships.test.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ramda_1 = require("ramda");
+const convertRelationships_1 = require("../convertRelationships");
+const relationship = {
+    p_id: "PId",
+    start_date: "",
+    end_date: "",
+    start: "urn:profile_object:1",
+    end: "urn:profile_object:2",
+    type: "IS_RELATED_TO",
+    active: true,
+    properties: undefined,
+};
+const serverRelationship = {
+    id: "PId",
+    start_date: "",
+    end_date: "",
+    active: true,
+    from_id: `1`,
+    to_id: `2`,
+    to_i_id: null,
+    type: "IS_RELATED_TO",
+    properties: undefined,
+};
+describe("convertServerRelationship", () => {
+    it("Converts fields in PO relationship", () => {
+        expect((0, convertRelationships_1.convertServerRelationship)(serverRelationship)).toStrictEqual(relationship);
+    });
+    it("Converts fields in instance/crust relationship", () => {
+        // Same Ids with Instance and PO to_ids swapped
+        const instanceServerRelationship = Object.assign(Object.assign({}, (0, ramda_1.omit)(["to_id", "to_i_id"], serverRelationship)), { to_i_id: "2" });
+        // Replacing Urn prepend text
+        const instanceRelationship = Object.assign(Object.assign({}, (0, ramda_1.omit)(["end"], relationship)), { end: "urn:instance:2" });
+        expect((0, convertRelationships_1.convertServerRelationship)(instanceServerRelationship)).toStrictEqual(instanceRelationship);
+    });
+});

package/dist/accessApplication/api/legacy/convertRelationships.d.ts

@@ -0,0 +1,16 @@
+import type { IId, NId, PId, Relationship } from "@raytio/types";
+/** This type represents the relationship format returned by the Postgres API */
+export type ServerRelationship = Omit<Relationship, "p_id" | "start" | "end"> & {
+    id: PId;
+    from_id: NId;
+} & ({
+    to_id: NId;
+} | {
+    to_i_id: IId;
+});
+/**
+ * Converts relationship type used by the server into the (Urn format) type used by the client
+ * @param serverRelationship relationship type used in the server
+ * @returns a Relationship (client-side type) that is equivalent to the inputted serverRelationship value
+ */
+export declare function convertServerRelationship(serverRelationship: ServerRelationship): Relationship;

package/dist/accessApplication/api/legacy/convertRelationships.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertServerRelationship = void 0;
+const ramda_1 = require("ramda");
+/**
+ * Converts relationship type used by the server into the (Urn format) type used by the client
+ * @param serverRelationship relationship type used in the server
+ * @returns a Relationship (client-side type) that is equivalent to the inputted serverRelationship value
+ */
+function convertServerRelationship(serverRelationship) {
+    const { id, from_id } = serverRelationship;
+    /**
+     * This functionality is similar to LinkToCrust, but in this case the API has already worked out
+     * which instance the PO links to (if any) so we simply convert it into a {@link Urn}
+     */
+    const end = "to_id" in serverRelationship
+        ? `urn:profile_object:${serverRelationship.to_id}`
+        : `urn:instance:${serverRelationship.to_i_id}`;
+    return Object.assign({ p_id: id, start: `urn:profile_object:${from_id}`, end }, (0, ramda_1.omit)(["id", "from_id", "to_id", "to_i_id"], serverRelationship));
+}
+exports.convertServerRelationship = convertServerRelationship;

package/dist/accessApplication/api/legacy/index.d.ts

@@ -0,0 +1 @@
+export * from "./convertRelationships";