declastruct 1.0.0

package/dist/logic/tools/provider/getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource.d.ts

@@ -0,0 +1,13 @@
+import { DomainEntity } from 'domain-objects';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+import { DeclastructProviderContext } from '../../../domain/DeclastructProviderContext';
+import { DeclastructProviderResourceRemoteStateInterface } from '../../../domain/DeclastructProviderResourceRemoteStateInterface';
+/**
+ * returns everything required to execute operations against the remote-state-interface for a resource
+ */
+export declare const getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource: <R extends DomainEntity<any>>({ resource }: {
+    resource: R;
+}, context: DeclastructContext) => {
+    remoteStateInterface: DeclastructProviderResourceRemoteStateInterface<R, any, any, any>;
+    providerContext: DeclastructProviderContext<any>;
+};

package/dist/logic/tools/provider/getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const domain_objects_1 = require("domain-objects");
+const getProviderContextFromGlobalContextForResourceClass_1 = require("./getProviderContextFromGlobalContextForResourceClass");
+const getProviderResourceRemoteStateInterfaceFromContextForResourceClass_1 = require("./getProviderResourceRemoteStateInterfaceFromContextForResourceClass");
+/**
+ * returns everything required to execute operations against the remote-state-interface for a resource
+ */
+const getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource = ({ resource }, context) => {
+    // sanity check that resource is a domain entity (otherwise, it cant be created)
+    if (!(resource instanceof domain_objects_1.DomainEntity))
+        throw new error_fns_1.UnexpectedCodePathError('can not createResource on a non DomainEntity object', { resource });
+    const resourceClassName = resource.constructor.name;
+    // lookup the interface
+    const remoteStateInterface = (0, getProviderResourceRemoteStateInterfaceFromContextForResourceClass_1.getProviderResourceRemoteStateInterfaceFromContextForResourceClass)({ resourceClassName }, context);
+    // lookup the provider context
+    const providerContext = (0, getProviderContextFromGlobalContextForResourceClass_1.getProviderContextFromGlobalContextForResourceClass)({ resourceClassName }, context);
+    // return the dependencies
+    return { remoteStateInterface, providerContext };
+};
+exports.getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource = getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource;
+//# sourceMappingURL=getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource.js.map

package/dist/logic/tools/provider/getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource.js","sourceRoot":"","sources":["../../../../src/logic/tools/provider/getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAC9D,mDAA8C;AAK9C,+HAA4H;AAC5H,6JAA0J;AAE1J;;GAEG;AACI,MAAM,uEAAuE,GAClF,CACE,EAAE,QAAQ,EAAmB,EAC7B,OAA2B,EAS3B,EAAE;IACF,gFAAgF;IAChF,IAAI,CAAC,CAAC,QAAQ,YAAY,6BAAY,CAAC;QACrC,MAAM,IAAI,mCAAuB,CAC/B,qDAAqD,EACrD,EAAE,QAAQ,EAAE,CACb,CAAC;IACJ,MAAM,iBAAiB,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC;IAEpD,uBAAuB;IACvB,MAAM,oBAAoB,GACxB,IAAA,uIAAkE,EAKhE,EAAE,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;IAEpC,8BAA8B;IAC9B,MAAM,eAAe,GAAG,IAAA,yGAAmD,EACzE,EAAE,iBAAiB,EAAE,EACrB,OAAO,CACR,CAAC;IAEF,0BAA0B;IAC1B,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,CAAC;AACnD,CAAC,CAAC;AAtCS,QAAA,uEAAuE,2EAsChF"}

package/dist/logic/tools/provider/getProviderResourceRemoteStateInterfaceFromContextForResourceClass.d.ts

@@ -0,0 +1,10 @@
+import { DeclaredResource } from '../../../domain/DeclaredResource';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+import { DeclastructProviderAgentOptions } from '../../../domain/DeclastructProvider';
+import { DeclastructProviderResourceRemoteStateInterface } from '../../../domain/DeclastructProviderResourceRemoteStateInterface';
+/**
+ * grabs the appropriate interface for managing resources of this class, by resource class name
+ */
+export declare const getProviderResourceRemoteStateInterfaceFromContextForResourceClass: <R extends DeclaredResource, AO extends DeclastructProviderAgentOptions, P extends keyof R, U extends keyof R>({ resourceClassName }: {
+    resourceClassName: string;
+}, context: DeclastructContext) => DeclastructProviderResourceRemoteStateInterface<R, AO, P, U>;

package/dist/logic/tools/provider/getProviderResourceRemoteStateInterfaceFromContextForResourceClass.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProviderResourceRemoteStateInterfaceFromContextForResourceClass = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+/**
+ * grabs the appropriate interface for managing resources of this class, by resource class name
+ */
+const getProviderResourceRemoteStateInterfaceFromContextForResourceClass = ({ resourceClassName }, context) => {
+    // lookup the provider for this resource
+    const provider = context.providers.find((thisProvider) => resourceClassName in thisProvider.interfaces);
+    if (!provider)
+        throw new error_fns_1.UnexpectedCodePathError('could not find provider for resource', {
+            resourceClassName,
+        });
+    // grab the interface
+    const resourceInterface = provider.interfaces[resourceClassName];
+    // return it
+    return resourceInterface;
+};
+exports.getProviderResourceRemoteStateInterfaceFromContextForResourceClass = getProviderResourceRemoteStateInterfaceFromContextForResourceClass;
+//# sourceMappingURL=getProviderResourceRemoteStateInterfaceFromContextForResourceClass.js.map

package/dist/logic/tools/provider/getProviderResourceRemoteStateInterfaceFromContextForResourceClass.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProviderResourceRemoteStateInterfaceFromContextForResourceClass.js","sourceRoot":"","sources":["../../../../src/logic/tools/provider/getProviderResourceRemoteStateInterfaceFromContextForResourceClass.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAO9D;;GAEG;AACI,MAAM,kEAAkE,GAC7E,CAME,EAAE,iBAAiB,EAAiC,EACpD,OAA2B,EACmC,EAAE;IAChE,wCAAwC;IACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CACrC,CAAC,YAAY,EAAE,EAAE,CAAC,iBAAiB,IAAI,YAAY,CAAC,UAAU,CAC/D,CAAC;IACF,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,mCAAuB,CAC/B,sCAAsC,EACtC;YACE,iBAAiB;SAClB,CACF,CAAC;IAEJ,qBAAqB;IACrB,MAAM,iBAAiB,GAAG,QAAQ,CAAC,UAAU,CAC3C,iBAAiB,CACqD,CAAC;IAEzE,YAAY;IACZ,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AA7BS,QAAA,kEAAkE,sEA6B3E"}

package/dist/logic/tools/reference/buildPrimaryKeyTo.d.ts

@@ -0,0 +1,5 @@
+import { DomainObject } from 'domain-objects';
+/**
+ * build the primary key of a resource
+ */
+export declare const buildPrimaryKeyTo: <T extends DomainObject<any>, C extends new (props: T) => T, P extends keyof T, K extends Partial<T>>(to: C, using: K) => Required<Pick<T, P>>;

package/dist/logic/tools/reference/buildPrimaryKeyTo.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPrimaryKeyTo = void 0;
+const buildReferenceTo_1 = require("./buildReferenceTo");
+const defineReferenceKeyConstituentsOf_1 = require("./defineReferenceKeyConstituentsOf");
+/**
+ * build the primary key of a resource
+ */
+const buildPrimaryKeyTo = (
+/**
+ * the class this is a reference to
+ */
+to, 
+/**
+ * the data to build the reference with
+ */
+using) => {
+    const referenceOf = to;
+    const referenceInput = using;
+    // get the primary key defs for the class
+    const { primary } = (0, defineReferenceKeyConstituentsOf_1.defineReferenceKeyConstituentsOf)({
+        class: referenceOf,
+    });
+    // assert that the resource has a primary key defined on it
+    const hasPrimaryKey = primary.every((key) => key in referenceInput);
+    if (!hasPrimaryKey)
+        throw new buildReferenceTo_1.CanNotBuildReferenceError({
+            referenceOf,
+            referenceInput,
+            reason: 'the primary key is not present in the reference input',
+        });
+    // extract the primary key value
+    const primaryKey = primary.reduce((summary, thisKeyKey) => {
+        const thisKeyValue = referenceInput[thisKeyKey];
+        return { ...summary, [thisKeyKey]: thisKeyValue };
+    }, {});
+    return primaryKey;
+};
+exports.buildPrimaryKeyTo = buildPrimaryKeyTo;
+//# sourceMappingURL=buildPrimaryKeyTo.js.map

package/dist/logic/tools/reference/buildPrimaryKeyTo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildPrimaryKeyTo.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/buildPrimaryKeyTo.ts"],"names":[],"mappings":";;;AAEA,yDAA+D;AAC/D,yFAAsF;AAEtF;;GAEG;AACI,MAAM,iBAAiB,GAAG;AAkB/B;;GAEG;AACH,EAAK;AAEL;;GAEG;AACH,KAAQ,EACc,EAAE;IACxB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,MAAM,cAAc,GAAG,KAAK,CAAC;IAE7B,yCAAyC;IACzC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,mEAAgC,EAAC;QACnD,KAAK,EAAE,WAAW;KACnB,CAAC,CAAC;IAEH,2DAA2D;IAC3D,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC;IACpE,IAAI,CAAC,aAAa;QAChB,MAAM,IAAI,4CAAyB,CAAC;YAClC,WAAW;YACX,cAAc;YACd,MAAM,EAAE,uDAAuD;SAChE,CAAC,CAAC;IAEL,gCAAgC;IAChC,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE;QACxD,MAAM,YAAY,GAChB,cAAc,CAAC,UAAyC,CAAC,CAAC;QAC5D,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IACpD,CAAC,EAAE,EAA0B,CAAC,CAAC;IAC/B,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AApDW,QAAA,iBAAiB,qBAoD5B"}

package/dist/logic/tools/reference/buildReferenceTo.d.ts

@@ -0,0 +1,28 @@
+import { DomainObject } from 'domain-objects';
+import { DeclaredResourceReference } from '../../../domain/DeclaredResourceReference';
+export declare class CanNotReferenceDeclaredResourceClassError extends Error {
+    constructor({ class: ofClass, reason, }: {
+        class: typeof DomainObject;
+        reason: string;
+    });
+}
+export declare class CanNotBuildReferenceError extends Error {
+    constructor({ referenceInput, referenceOf, reason, }: {
+        referenceInput: any;
+        referenceOf: any;
+        reason: string;
+    });
+}
+/**
+ * build a reference to a resource of a particular class using a supported key
+ * - uses the unique key if possible
+ * - uses the primary key otherwise
+ *
+ * note
+ * - we prefer unique key over primary key because
+ *   - it encodes the most information
+ *   - it is always available for resources
+ *   - it is the common comparable form of reference
+ */
+export declare const buildReferenceTo: <T extends DomainObject<any>, C extends new (props: T) => T, P extends keyof T, U extends keyof T, K extends Partial<T>>(to: C, using: K, as?: new (props: DeclaredResourceReference<T, P, U>) => DeclaredResourceReference<T, P, U>) => DeclaredResourceReference<T, P, U>;
+export { buildReferenceTo as buildRef };

package/dist/logic/tools/reference/buildReferenceTo.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildRef = exports.buildReferenceTo = exports.CanNotBuildReferenceError = exports.CanNotReferenceDeclaredResourceClassError = void 0;
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const buildPrimaryKeyTo_1 = require("./buildPrimaryKeyTo");
+const buildUniqueKeyTo_1 = require("./buildUniqueKeyTo");
+const defineReferenceClassOf_1 = require("./defineReferenceClassOf");
+const defineReferenceKeyConstituentsOf_1 = require("./defineReferenceKeyConstituentsOf");
+class CanNotReferenceDeclaredResourceClassError extends Error {
+    constructor({ class: ofClass, reason, }) {
+        super(`
+Can not reference declared resource of class '${ofClass.name}'. Instances of the class '${ofClass.name}' can not be referenced because ${reason}.
+    `.trim());
+    }
+}
+exports.CanNotReferenceDeclaredResourceClassError = CanNotReferenceDeclaredResourceClassError;
+class CanNotBuildReferenceError extends Error {
+    constructor({ referenceInput, referenceOf, reason, }) {
+        super(`
+Can not build reference ${referenceOf?.name ? `to class '${referenceOf.name}'` : ''} because ${reason}.
+
+referenceInput
+${JSON.stringify(referenceInput, null, 2)}
+    `.trim());
+    }
+}
+exports.CanNotBuildReferenceError = CanNotBuildReferenceError;
+/**
+ * build a reference to a resource of a particular class using a supported key
+ * - uses the unique key if possible
+ * - uses the primary key otherwise
+ *
+ * note
+ * - we prefer unique key over primary key because
+ *   - it encodes the most information
+ *   - it is always available for resources
+ *   - it is the common comparable form of reference
+ */
+const buildReferenceTo = (
+/**
+ * the class this is a reference to
+ */
+to, 
+/**
+ * the data to build the reference with
+ */
+using, 
+/**
+ * the class to instantiate the reference with
+ * - defaults to the generic DeclaredResourceReference class
+ * - allows using a more specific subclass if one was created
+ */
+as) => {
+    const referenceOf = to;
+    const referenceInput = using;
+    const ReferenceConstructor = as ??
+        (0, defineReferenceClassOf_1.defineReferenceClassOf)({ class: referenceOf }) ??
+        DeclaredResourceReference_1.DeclaredResourceReference; // todo: start throwing errors if reference is not explicitly declared on the source class; using DeclaredResourceError produces hydration and serialization errors for "alternatives" types
+    // get the unique and unique key defs for the class
+    const { unique, primary } = (0, defineReferenceKeyConstituentsOf_1.defineReferenceKeyConstituentsOf)({
+        class: referenceOf,
+    });
+    // if unique key is defined, reference by unique key
+    const hasUniqueKey = unique.every((key) => key in referenceInput);
+    if (hasUniqueKey)
+        return new ReferenceConstructor({
+            referenceOf: referenceOf.name,
+            identifiedBy: {
+                key: DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY,
+                value: (0, buildUniqueKeyTo_1.buildUniqueKeyTo)(referenceOf, referenceInput),
+            },
+        });
+    // if primary key is defined, reference by primary key
+    const hasPrimaryKey = primary.every((key) => key in referenceInput);
+    if (hasPrimaryKey)
+        return new ReferenceConstructor({
+            referenceOf: referenceOf.name,
+            identifiedBy: {
+                key: DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.PRIMARY_KEY,
+                value: (0, buildPrimaryKeyTo_1.buildPrimaryKeyTo)(referenceOf, referenceInput),
+            },
+        });
+    // if has neither, then the reference can not be made
+    throw new CanNotBuildReferenceError({
+        referenceOf,
+        referenceInput,
+        reason: 'neither the primary key nor unique key is present in the reference key',
+    });
+};
+exports.buildReferenceTo = buildReferenceTo;
+exports.buildRef = exports.buildReferenceTo;
+//# sourceMappingURL=buildReferenceTo.js.map

package/dist/logic/tools/reference/buildReferenceTo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildReferenceTo.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/buildReferenceTo.ts"],"names":[],"mappings":";;;AAEA,yFAGmD;AACnD,2DAAwD;AACxD,yDAAsD;AACtD,qEAAkE;AAClE,yFAAsF;AAEtF,MAAa,yCAA0C,SAAQ,KAAK;IAClE,YAAY,EACV,KAAK,EAAE,OAAO,EACd,MAAM,GAIP;QACC,KAAK,CACH;gDAC0C,OAAO,CAAC,IAAI,8BAA8B,OAAO,CAAC,IAAI,mCAAmC,MAAM;KAC1I,CAAC,IAAI,EAAE,CACP,CAAC;IACJ,CAAC;CACF;AAdD,8FAcC;AAED,MAAa,yBAA0B,SAAQ,KAAK;IAClD,YAAY,EACV,cAAc,EACd,WAAW,EACX,MAAM,GAKP;QACC,KAAK,CACH;0BAEE,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,aAAa,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EACzD,YAAY,MAAM;;;EAGtB,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;KACpC,CAAC,IAAI,EAAE,CACP,CAAC;IACJ,CAAC;CACF;AArBD,8DAqBC;AAED;;;;;;;;;;GAUG;AACI,MAAM,gBAAgB,GAAG;AAsB9B;;GAEG;AACH,EAAK;AAEL;;GAEG;AACH,KAAQ;AAER;;;;GAIG;AACH,EAEuC,EACH,EAAE;IACtC,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,MAAM,cAAc,GAAG,KAAK,CAAC;IAC7B,MAAM,oBAAoB,GACxB,EAAE;QACF,IAAA,+CAAsB,EAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QAC9C,qDAAyB,CAAC,CAAC,4LAA4L;IAEzN,mDAAmD;IACnD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,mEAAgC,EAAC;QAC3D,KAAK,EAAE,WAAW;KACnB,CAAC,CAAC;IAEH,oDAAoD;IACpD,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC;IAClE,IAAI,YAAY;QACd,OAAO,IAAI,oBAAoB,CAAC;YAC9B,WAAW,EAAE,WAAW,CAAC,IAAI;YAC7B,YAAY,EAAE;gBACZ,GAAG,EAAE,4DAAgC,CAAC,UAAU;gBAChD,KAAK,EAAE,IAAA,mCAAgB,EAAC,WAAW,EAAE,cAAc,CAAC;aACrD;SACF,CAAuC,CAAC;IAE3C,sDAAsD;IACtD,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC;IACpE,IAAI,aAAa;QACf,OAAO,IAAI,oBAAoB,CAAC;YAC9B,WAAW,EAAE,WAAW,CAAC,IAAI;YAC7B,YAAY,EAAE;gBACZ,GAAG,EAAE,4DAAgC,CAAC,WAAW;gBACjD,KAAK,EAAE,IAAA,qCAAiB,EAAC,WAAW,EAAE,cAAc,CAAC;aACtD;SACF,CAAuC,CAAC;IAE3C,qDAAqD;IACrD,MAAM,IAAI,yBAAyB,CAAC;QAClC,WAAW;QACX,cAAc;QACd,MAAM,EACJ,wEAAwE;KAC3E,CAAC,CAAC;AACL,CAAC,CAAC;AAlFW,QAAA,gBAAgB,oBAkF3B;AAE2B,mBApFhB,wBAAgB,CAoFQ"}

package/dist/logic/tools/reference/buildReferenceTo.test.d.ts

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

package/dist/logic/tools/reference/buildReferenceTo.test.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const domain_objects_1 = require("domain-objects");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const buildReferenceTo_1 = require("./buildReferenceTo");
+// todo: remove the declastruct references in favor of domain-object references
+describe.skip('getReferenceTo', () => {
+    it('should throw a helpful error the class does not have unique key defined', () => {
+        class CNCMachine extends domain_objects_1.DomainObject {
+        }
+        CNCMachine.primary = ['uuid'];
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const ref = (0, buildReferenceTo_1.buildReferenceTo)(CNCMachine, new CNCMachine({
+                serialNumber: '821',
+                size: 'big',
+                location: 'basement',
+            }));
+            throw new Error('should not reach here');
+        }
+        catch (error) {
+            expect(error).toBeInstanceOf(buildReferenceTo_1.CanNotReferenceDeclaredResourceClassError);
+            expect(error.message).toContain(`the static property 'unique' was not defined as an array of strings`);
+            expect(error).toMatchSnapshot();
+        }
+    });
+    it('should throw a helpful error the class does not have primary key defined correctly', () => {
+        class CNCMachine extends domain_objects_1.DomainObject {
+        }
+        CNCMachine.primary = 'uuid';
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const ref = (0, buildReferenceTo_1.buildReferenceTo)(CNCMachine, new CNCMachine({
+                serialNumber: '821',
+                size: 'big',
+                location: 'basement',
+            }));
+            throw new Error('should not reach here');
+        }
+        catch (error) {
+            expect(error).toBeInstanceOf(buildReferenceTo_1.CanNotReferenceDeclaredResourceClassError);
+            expect(error.message).toContain(`the static property 'primary' was not defined as an array of strings`);
+            expect(error).toMatchSnapshot();
+        }
+    });
+    it('should be able to reference by unique key', () => {
+        class CNCMachine extends domain_objects_1.DomainObject {
+        }
+        CNCMachine.primary = ['uuid'];
+        CNCMachine.unique = ['serialNumber'];
+        const reference = (0, buildReferenceTo_1.buildReferenceTo)(CNCMachine, new CNCMachine({
+            serialNumber: '821',
+            size: 'big',
+            location: 'basement',
+        }));
+        expect(reference).toEqual({
+            referenceOf: 'CNCMachine',
+            identifiedBy: {
+                key: 'UNIQUE_KEY',
+                value: { serialNumber: '821' },
+            },
+        });
+        expect(reference).toMatchSnapshot(); // log for viewing
+    });
+    it('should be able to reference by primary key', () => {
+        class CNCMachine extends domain_objects_1.DomainObject {
+        }
+        CNCMachine.primary = ['uuid'];
+        CNCMachine.unique = ['serialNumber'];
+        const reference = (0, buildReferenceTo_1.buildReferenceTo)(CNCMachine, {
+            uuid: '__UUID__',
+        });
+        expect(reference).toEqual({
+            referenceOf: 'CNCMachine',
+            identifiedBy: {
+                key: 'PRIMARY_KEY',
+                value: { uuid: '__UUID__' },
+            },
+        });
+        expect(reference).toMatchSnapshot(); // log for viewing
+    });
+    it('should reference by unique key if both are available', () => {
+        class CNCMachine extends domain_objects_1.DomainObject {
+        }
+        CNCMachine.primary = ['uuid'];
+        CNCMachine.unique = ['serialNumber'];
+        const reference = (0, buildReferenceTo_1.buildReferenceTo)(CNCMachine, new CNCMachine({
+            uuid: 'de0e34ca-ce61-4884-ace5-093a1a32ff92',
+            serialNumber: '821',
+            size: 'big',
+            location: 'basement',
+        }));
+        expect(reference).toEqual({
+            referenceOf: 'CNCMachine',
+            identifiedBy: {
+                key: 'UNIQUE_KEY',
+                value: { serialNumber: '821' },
+            },
+        });
+        expect(reference).toMatchSnapshot(); // log for viewing
+    });
+    it('should be able to instantiate with more specific reference class if one exists', () => {
+        class CNCMachine extends domain_objects_1.DomainObject {
+        }
+        CNCMachine.primary = ['uuid'];
+        CNCMachine.unique = ['serialNumber'];
+        class CNCMachineReference extends DeclaredResourceReference_1.DeclaredResourceReference {
+        }
+        const reference = (0, buildReferenceTo_1.buildReferenceTo)(CNCMachine, new CNCMachine({
+            uuid: 'de0e34ca-ce61-4884-ace5-093a1a32ff92',
+            serialNumber: '821',
+            size: 'big',
+            location: 'basement',
+        }), CNCMachineReference);
+        expect(reference).toBeInstanceOf(CNCMachineReference);
+        expect(reference).toMatchSnapshot(); // log for viewing
+    });
+});
+//# sourceMappingURL=buildReferenceTo.test.js.map

package/dist/logic/tools/reference/buildReferenceTo.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildReferenceTo.test.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/buildReferenceTo.test.ts"],"names":[],"mappings":";;AAAA,mDAA8C;AAE9C,yFAAsF;AACtF,yDAG4B;AAE5B,+EAA+E;AAC/E,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE;QAOjF,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QAOnC,IAAI,CAAC;YACH,6DAA6D;YAC7D,MAAM,GAAG,GAAwB,IAAA,mCAAgB,EAC/C,UAAU,EACV,IAAI,UAAU,CAAC;gBACb,YAAY,EAAE,KAAK;gBACnB,IAAI,EAAE,KAAK;gBACX,QAAQ,EAAE,UAAU;aACrB,CAAC,CACH,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,4DAAyC,CAAC,CAAC;YACxE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,qEAAqE,CACtE,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAO5F,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,MAAM,CAAC;QAOjC,IAAI,CAAC;YACH,6DAA6D;YAC7D,MAAM,GAAG,GAAwB,IAAA,mCAAgB,EAC/C,UAAU,EACV,IAAI,UAAU,CAAC;gBACb,YAAY,EAAE,KAAK;gBACnB,IAAI,EAAE,KAAK;gBACX,QAAQ,EAAE,UAAU;aACrB,CAAC,CACH,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,4DAAyC,CAAC,CAAC;YACxE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,sEAAsE,CACvE,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QAOnD,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QACnB,iBAAM,GAAG,CAAC,cAAc,CAAC,CAAC;QAO1C,MAAM,SAAS,GAAwB,IAAA,mCAAgB,EACrD,UAAU,EACV,IAAI,UAAU,CAAC;YACb,YAAY,EAAE,KAAK;YACnB,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,UAAU;SACrB,CAAC,CACH,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACxB,WAAW,EAAE,YAAY;YACzB,YAAY,EAAE;gBACZ,GAAG,EAAE,YAAY;gBACjB,KAAK,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE;aAC/B;SACF,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,kBAAkB;IACzD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAOpD,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QACnB,iBAAM,GAAG,CAAC,cAAc,CAAC,CAAC;QAO1C,MAAM,SAAS,GAAwB,IAAA,mCAAgB,EAAC,UAAU,EAAE;YAClE,IAAI,EAAE,UAAU;SACjB,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACxB,WAAW,EAAE,YAAY;YACzB,YAAY,EAAE;gBACZ,GAAG,EAAE,aAAa;gBAClB,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE;aAC5B;SACF,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,kBAAkB;IACzD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAO9D,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QACnB,iBAAM,GAAG,CAAC,cAAc,CAAC,CAAC;QAO1C,MAAM,SAAS,GAAwB,IAAA,mCAAgB,EACrD,UAAU,EACV,IAAI,UAAU,CAAC;YACb,IAAI,EAAE,sCAAsC;YAC5C,YAAY,EAAE,KAAK;YACnB,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,UAAU;SACrB,CAAC,CACH,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACxB,WAAW,EAAE,YAAY;YACzB,YAAY,EAAE;gBACZ,GAAG,EAAE,YAAY;gBACjB,KAAK,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE;aAC/B;SACF,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,kBAAkB;IACzD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;QAOxF,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QACnB,iBAAM,GAAG,CAAC,cAAc,CAAC,CAAC;QAE1C,MAAM,mBAAoB,SAAQ,qDAIjC;SAAG;QACJ,MAAM,SAAS,GAAG,IAAA,mCAAgB,EAChC,UAAU,EACV,IAAI,UAAU,CAAC;YACb,IAAI,EAAE,sCAAsC;YAC5C,YAAY,EAAE,KAAK;YACnB,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,UAAU;SACrB,CAAC,EACF,mBAAmB,CACpB,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;QACtD,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,kBAAkB;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/logic/tools/reference/buildUniqueKeyTo.d.ts

@@ -0,0 +1,5 @@
+import { DomainObject } from 'domain-objects';
+/**
+ * build the unique key of the resource
+ */
+export declare const buildUniqueKeyTo: <T extends DomainObject<any>, C extends new (props: T) => T, U extends keyof T, K extends Partial<T> | Required<Pick<T, U>>>(to: C, using: K) => Required<Pick<T, U>>;

package/dist/logic/tools/reference/buildUniqueKeyTo.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUniqueKeyTo = void 0;
+const buildReferenceTo_1 = require("./buildReferenceTo");
+const defineReferenceKeyConstituentsOf_1 = require("./defineReferenceKeyConstituentsOf");
+/**
+ * build the unique key of the resource
+ */
+const buildUniqueKeyTo = (
+/**
+ * the class this is a reference to
+ */
+to, 
+/**
+ * the data to build the reference with
+ */
+using) => {
+    const referenceOf = to;
+    const referenceInput = using;
+    // get the unique key defs for the class
+    const { unique } = (0, defineReferenceKeyConstituentsOf_1.defineReferenceKeyConstituentsOf)({
+        class: referenceOf,
+    });
+    // assert that the resource has a unique key defined on it
+    const hasUniqueKey = unique.every((key) => key in referenceInput);
+    if (!hasUniqueKey)
+        throw new buildReferenceTo_1.CanNotBuildReferenceError({
+            referenceOf,
+            referenceInput,
+            reason: 'the unique key is not present in the reference input',
+        });
+    // extract the unique key value
+    const uniqueKey = unique.reduce((summary, thisKeyKey) => {
+        const thisKeyValue = referenceInput[thisKeyKey];
+        return { ...summary, [thisKeyKey]: thisKeyValue };
+    }, {});
+    return uniqueKey;
+};
+exports.buildUniqueKeyTo = buildUniqueKeyTo;
+//# sourceMappingURL=buildUniqueKeyTo.js.map

package/dist/logic/tools/reference/buildUniqueKeyTo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildUniqueKeyTo.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/buildUniqueKeyTo.ts"],"names":[],"mappings":";;;AAEA,yDAA+D;AAC/D,yFAAsF;AAEtF;;GAEG;AACI,MAAM,gBAAgB,GAAG;AAkB9B;;GAEG;AACH,EAAK;AAEL;;GAEG;AACH,KAAQ,EACc,EAAE;IACxB,MAAM,WAAW,GAAG,EAAE,CAAC;IACvB,MAAM,cAAc,GAAG,KAAK,CAAC;IAE7B,wCAAwC;IACxC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,mEAAgC,EAAC;QAClD,KAAK,EAAE,WAAW;KACnB,CAAC,CAAC;IAEH,0DAA0D;IAC1D,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,cAAc,CAAC,CAAC;IAClE,IAAI,CAAC,YAAY;QACf,MAAM,IAAI,4CAAyB,CAAC;YAClC,WAAW;YACX,cAAc;YACd,MAAM,EAAE,sDAAsD;SAC/D,CAAC,CAAC;IAEL,+BAA+B;IAC/B,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE;QACtD,MAAM,YAAY,GAChB,cAAc,CAAC,UAAyC,CAAC,CAAC;QAC5D,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IACpD,CAAC,EAAE,EAA0B,CAAC,CAAC;IAC/B,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AApDW,QAAA,gBAAgB,oBAoD3B"}

package/dist/logic/tools/reference/defineReferenceClassOf.d.ts

@@ -0,0 +1,5 @@
+import { DomainObject } from 'domain-objects';
+import { DeclaredResourceReference } from '../../../domain/DeclaredResourceReference';
+export declare const defineReferenceClassOf: <T extends DomainObject<any>, C extends new (props: T) => T, P extends keyof T, U extends keyof T>({ class: ofClass, }: {
+    class: C;
+}) => (new (props: DeclaredResourceReference<T, P, U>) => DeclaredResourceReference<T, P, U>) | null;

package/dist/logic/tools/reference/defineReferenceClassOf.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineReferenceClassOf = void 0;
+const type_fns_1 = require("type-fns");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const defineReferenceKeyConstituentsOf_1 = require("./defineReferenceKeyConstituentsOf");
+const defineReferenceClassOf = ({ class: ofClass, }) => {
+    // grab the reference spec, if any
+    const referenceSpec = ofClass.reference;
+    if (!referenceSpec)
+        return null;
+    // if its a function, call it to get the reference spec
+    const referenceSpecResolved = (0, type_fns_1.isAFunction)(referenceSpec)
+        ? referenceSpec()
+        : referenceSpec;
+    // assert that the reference spec is a valid reference spec
+    if (!(referenceSpecResolved.prototype instanceof DeclaredResourceReference_1.DeclaredResourceReference))
+        throw new defineReferenceKeyConstituentsOf_1.CanNotReferenceDeclaredResourceClassError({
+            class: ofClass,
+            reason: `${ofClass.name}.reference was defined but not as an instance of DeclaredResourceReference`,
+        });
+    return referenceSpecResolved;
+};
+exports.defineReferenceClassOf = defineReferenceClassOf;
+//# sourceMappingURL=defineReferenceClassOf.js.map

package/dist/logic/tools/reference/defineReferenceClassOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineReferenceClassOf.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/defineReferenceClassOf.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAEvC,yFAAsF;AACtF,yFAA+F;AAExF,MAAM,sBAAsB,GAAG,CAiBpC,EACA,KAAK,EAAE,OAAO,GAGf,EAIQ,EAAE;IACT,kCAAkC;IAClC,MAAM,aAAa,GAAI,OAAe,CAAC,SAAS,CAAC;IACjD,IAAI,CAAC,aAAa;QAAE,OAAO,IAAI,CAAC;IAEhC,uDAAuD;IACvD,MAAM,qBAAqB,GAAG,IAAA,sBAAW,EAAC,aAAa,CAAC;QACtD,CAAC,CAAC,aAAa,EAAE;QACjB,CAAC,CAAC,aAAa,CAAC;IAElB,2DAA2D;IAC3D,IAAI,CAAC,CAAC,qBAAqB,CAAC,SAAS,YAAY,qDAAyB,CAAC;QACzE,MAAM,IAAI,4EAAyC,CAAC;YAClD,KAAK,EAAE,OAAqC;YAC5C,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,4EAA4E;SACpG,CAAC,CAAC;IAEL,OAAO,qBAAqB,CAAC;AAC/B,CAAC,CAAC;AA3CW,QAAA,sBAAsB,0BA2CjC"}

package/dist/logic/tools/reference/defineReferenceKeyConstituentsOf.d.ts

@@ -0,0 +1,13 @@
+import { DomainObject } from 'domain-objects';
+export declare class CanNotReferenceDeclaredResourceClassError extends Error {
+    constructor({ class: ofClass, reason, }: {
+        class: typeof DomainObject;
+        reason: string;
+    });
+}
+export declare const defineReferenceKeyConstituentsOf: ({ class: ofClass, }: {
+    class: any;
+}) => {
+    primary: string[];
+    unique: string[];
+};

package/dist/logic/tools/reference/defineReferenceKeyConstituentsOf.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineReferenceKeyConstituentsOf = exports.CanNotReferenceDeclaredResourceClassError = void 0;
+class CanNotReferenceDeclaredResourceClassError extends Error {
+    constructor({ class: ofClass, reason, }) {
+        super(`
+Can not reference declared resource of class '${ofClass.name}'. Instances of the class '${ofClass.name}' can not be referenced because ${reason}.
+    `.trim());
+    }
+}
+exports.CanNotReferenceDeclaredResourceClassError = CanNotReferenceDeclaredResourceClassError;
+const isArrayOfStrings = (value) => {
+    if (!value)
+        return false;
+    if (!Array.isArray(value))
+        return false;
+    return value.every((element) => typeof element === 'string');
+};
+const defineReferenceKeyConstituentsOf = ({ class: ofClass, }) => {
+    if (!isArrayOfStrings(ofClass.primary))
+        throw new CanNotReferenceDeclaredResourceClassError({
+            class: ofClass,
+            reason: `the static property 'primary' was not defined as an array of strings`,
+        });
+    if (!isArrayOfStrings(ofClass.unique))
+        throw new CanNotReferenceDeclaredResourceClassError({
+            class: ofClass,
+            reason: `the static property 'unique' was not defined as an array of strings`,
+        });
+    return {
+        primary: ofClass.primary,
+        unique: ofClass.unique,
+    };
+};
+exports.defineReferenceKeyConstituentsOf = defineReferenceKeyConstituentsOf;
+//# sourceMappingURL=defineReferenceKeyConstituentsOf.js.map

package/dist/logic/tools/reference/defineReferenceKeyConstituentsOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineReferenceKeyConstituentsOf.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/defineReferenceKeyConstituentsOf.ts"],"names":[],"mappings":";;;AAEA,MAAa,yCAA0C,SAAQ,KAAK;IAClE,YAAY,EACV,KAAK,EAAE,OAAO,EACd,MAAM,GAIP;QACC,KAAK,CACH;gDAC0C,OAAO,CAAC,IAAI,8BAA8B,OAAO,CAAC,IAAI,mCAAmC,MAAM;KAC1I,CAAC,IAAI,EAAE,CACP,CAAC;IACJ,CAAC;CACF;AAdD,8FAcC;AAED,MAAM,gBAAgB,GAAG,CAAC,KAAU,EAAqB,EAAE;IACzD,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACxC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEK,MAAM,gCAAgC,GAAG,CAAC,EAC/C,KAAK,EAAE,OAAO,GAGf,EAAE,EAAE;IACH,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC;QACpC,MAAM,IAAI,yCAAyC,CAAC;YAClD,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,sEAAsE;SAC/E,CAAC,CAAC;IACL,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC;QACnC,MAAM,IAAI,yCAAyC,CAAC;YAClD,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,qEAAqE;SAC9E,CAAC,CAAC;IACL,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,OAAmB;QACpC,MAAM,EAAE,OAAO,CAAC,MAAkB;KACnC,CAAC;AACJ,CAAC,CAAC;AAnBW,QAAA,gCAAgC,oCAmB3C"}

package/dist/logic/tools/reference/getByReference.d.ts

@@ -0,0 +1,15 @@
+import { VisualogicContext } from 'visualogic';
+import { DeclaredResource } from '../../../domain/DeclaredResource';
+import { DeclaredResourceReference } from '../../../domain/DeclaredResourceReference';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare class InvalidReferenceError extends Error {
+    constructor({ reference, }: {
+        reference: DeclaredResourceReference<any, any, any>;
+    });
+}
+/**
+ * resolves references into the referenced resource
+ */
+export declare const getByReference: <T extends DeclaredResource, P extends keyof T, U extends keyof T>({ reference, }: {
+    reference: DeclaredResourceReference<T, P, U>;
+}, context: DeclastructContext & VisualogicContext) => Promise<Required<T> | null>;

package/dist/logic/tools/reference/getByReference.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getByReference = exports.InvalidReferenceError = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const domain_objects_1 = require("domain-objects");
+const simple_in_memory_cache_1 = require("simple-in-memory-cache");
+const with_simple_caching_1 = require("with-simple-caching");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const getByReferencedPrimaryKey_1 = require("./getByReferencedPrimaryKey");
+const getByReferencedUniqueKey_1 = require("./getByReferencedUniqueKey");
+class InvalidReferenceError extends Error {
+    constructor({ reference, }) {
+        super(`Invalid reference of '${reference.referenceOf}' detected. Could not find an instance identified by ${JSON.stringify(reference.identifiedBy)}`);
+    }
+}
+exports.InvalidReferenceError = InvalidReferenceError;
+/**
+ * resolves references into the referenced resource
+ */
+exports.getByReference = (0, with_simple_caching_1.withSimpleCaching)(
+// withLogTrail(
+async ({ reference, }, context) => {
+    // if reference is by primary key, lookup the resource by primary key
+    if (reference.identifiedBy.key ===
+        DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.PRIMARY_KEY) {
+        return await (0, getByReferencedPrimaryKey_1.getByReferencedPrimaryKey)({
+            referenceOf: reference.referenceOf,
+            primaryKey: reference.identifiedBy.value,
+        }, context);
+    }
+    // if reference is by primary key, lookup the resource by primary key
+    if (reference.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY) {
+        return await (0, getByReferencedUniqueKey_1.getByReferencedUniqueKey)({
+            referenceOf: reference.referenceOf,
+            uniqueKey: reference.identifiedBy.value,
+        }, context);
+    }
+    // otherwise, resource reference was declared incorrectly. this should not happen due to types
+    throw new error_fns_1.UnexpectedCodePathError('invalid resource reference declaration', {
+        reference,
+    });
+}, 
+// {
+//   name: getResourceNameFromFileName(__filename),
+// },
+// ),
+{
+    cache: (0, simple_in_memory_cache_1.createCache)({
+        expiration: { seconds: 60 }, // cache up to 60 sec. no operation will both .get, .set, and .get again (read-after-write) within 60 sec
+    }),
+    serialize: {
+        key: ({ forInput }) => (0, domain_objects_1.serialize)(forInput[0]), // omit the context
+    },
+});
+//# sourceMappingURL=getByReference.js.map

package/dist/logic/tools/reference/getByReference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getByReference.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getByReference.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAC9D,mDAA2C;AAC3C,mEAAqD;AAErD,6DAAwD;AAGxD,yFAGmD;AAEnD,2EAAwE;AACxE,yEAAsE;AAEtE,MAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,EACV,SAAS,GAGV;QACC,KAAK,CACH,yBACE,SAAS,CAAC,WACZ,wDAAwD,IAAI,CAAC,SAAS,CACpE,SAAS,CAAC,YAAY,CACvB,EAAE,CACJ,CAAC;IACJ,CAAC;CACF;AAdD,sDAcC;AAED;;GAEG;AACU,QAAA,cAAc,GAAG,IAAA,uCAAiB;AAC7C,gBAAgB;AAChB,KAAK,EACH,EACE,SAAS,GAGV,EACD,OAA+C,EAClB,EAAE;IAC/B,qEAAqE;IACrE,IACE,SAAS,CAAC,YAAY,CAAC,GAAG;QAC1B,4DAAgC,CAAC,WAAW,EAC5C,CAAC;QACD,OAAO,MAAM,IAAA,qDAAyB,EACpC;YACE,WAAW,EAAE,SAAS,CAAC,WAAW;YAClC,UAAU,EAAE,SAAS,CAAC,YAAY,CAAC,KAAK;SACzC,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,IACE,SAAS,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,UAAU,EAC1E,CAAC;QACD,OAAO,MAAM,IAAA,mDAAwB,EACnC;YACE,WAAW,EAAE,SAAS,CAAC,WAAW;YAClC,SAAS,EAAE,SAAS,CAAC,YAAY,CAAC,KAAK;SACxC,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED,8FAA8F;IAC9F,MAAM,IAAI,mCAAuB,CAC/B,wCAAwC,EACxC;QACE,SAAS;KACV,CACF,CAAC;AACJ,CAAC;AACD,IAAI;AACJ,mDAAmD;AACnD,KAAK;AACL,KAAK;AACL;IACE,KAAK,EAAE,IAAA,oCAAW,EAAC;QACjB,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,yGAAyG;KACvI,CAAC;IACF,SAAS,EAAE;QACT,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,IAAA,0BAAS,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,mBAAmB;KACnE;CACF,CACF,CAAC"}

package/dist/logic/tools/reference/getByReference.test.d.ts

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