declastruct 1.0.0

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

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const domain_objects_1 = require("domain-objects");
+const buildReferenceTo_1 = require("./buildReferenceTo");
+const getByReference_1 = require("./getByReference");
+const getReferenceTo_1 = require("./getReferenceTo");
+const log = console;
+class CNCMachine extends domain_objects_1.DomainObject {
+}
+CNCMachine.primary = ['uuid'];
+CNCMachine.unique = ['serialNumber'];
+const exampleMachine = new CNCMachine({
+    uuid: 'de0e34ca-ce61-4884-ace5-093a1a32ff92',
+    serialNumber: '821',
+    size: 'big',
+    location: 'basement',
+});
+const cncMachineRemoteStateInterface = {
+    for: CNCMachine.name,
+    findByPrimary: async ({ uuid }) => {
+        if (uuid === exampleMachine.uuid)
+            return exampleMachine;
+        return null;
+    },
+    findByUnique: async ({ serialNumber }) => {
+        if (serialNumber === exampleMachine.serialNumber)
+            return exampleMachine;
+        return null;
+    },
+    create: () => Promise.reject(new Error('todo')),
+    destroy: () => Promise.reject(new Error('todo')),
+};
+const exampleContext = {
+    log,
+    providers: [
+        {
+            agentOptions: {},
+            interfaces: {
+                [cncMachineRemoteStateInterface.for]: cncMachineRemoteStateInterface,
+            }, // TODO: fix types to make this assertion not needed
+            hooks: {},
+        },
+    ],
+    resources: [], // no resources needed in context for this test
+};
+// todo: remove the declastruct references in favor of domain-object references
+describe.skip('getByReference', () => {
+    it('should be able to find by autogenerated reference', async () => {
+        const autogeneratedReference = (0, getReferenceTo_1.getRef)(exampleMachine);
+        const resource = await (0, getByReference_1.getByReference)({
+            reference: autogeneratedReference,
+        }, exampleContext);
+        expect(resource).toBeInstanceOf(CNCMachine);
+    });
+    it('should be able to find by manually built primary key reference', async () => {
+        const primaryKeyReference = (0, buildReferenceTo_1.buildRef)(CNCMachine, {
+            uuid: exampleMachine.uuid,
+        });
+        const resource = await (0, getByReference_1.getByReference)({
+            reference: primaryKeyReference,
+        }, exampleContext);
+        expect(resource).toBeInstanceOf(CNCMachine);
+    });
+    it('should be able to find by manually built unique key reference', async () => {
+        const uniqueKeyReference = (0, buildReferenceTo_1.buildRef)(CNCMachine, {
+            serialNumber: exampleMachine.serialNumber,
+        });
+        const resource = await (0, getByReference_1.getByReference)({
+            reference: uniqueKeyReference,
+        }, exampleContext);
+        expect(resource).toBeInstanceOf(CNCMachine);
+    });
+    it('should return null if the resource does not exist in remote state by primary key', async () => {
+        const primaryKeyReference = (0, buildReferenceTo_1.buildRef)(CNCMachine, {
+            uuid: '__RANDO_UUID__',
+        });
+        const resource = await (0, getByReference_1.getByReference)({
+            reference: primaryKeyReference,
+        }, exampleContext);
+        expect(resource).toEqual(null);
+    });
+    it('should return null if the resource does not exist in remote state by unique key', async () => {
+        const uniqueKeyReference = (0, buildReferenceTo_1.buildRef)(CNCMachine, {
+            serialNumber: '__RANDO_SERIAL_NUMBER__',
+        });
+        const resource = await (0, getByReference_1.getByReference)({
+            reference: uniqueKeyReference,
+        }, exampleContext);
+        expect(resource).toEqual(null);
+    });
+});
+//# sourceMappingURL=getByReference.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getByReference.test.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getByReference.test.ts"],"names":[],"mappings":";;AAAA,mDAA8C;AAQ9C,yDAA8C;AAC9C,qDAAkD;AAClD,qDAA0C;AAE1C,MAAM,GAAG,GAAG,OAAO,CAAC;AAQpB,MAAM,UAAW,SAAQ,6BAAwB;;AACjC,kBAAO,GAAG,CAAC,MAAM,CAAC,CAAC;AACnB,iBAAM,GAAG,CAAC,cAAc,CAAC,CAAC;AAQ1C,MAAM,cAAc,GAAG,IAAI,UAAU,CAAC;IACpC,IAAI,EAAE,sCAAsC;IAC5C,YAAY,EAAE,KAAK;IACnB,IAAI,EAAE,KAAK;IACX,QAAQ,EAAE,UAAU;CACrB,CAAyB,CAAC;AAE3B,MAAM,8BAA8B,GAMhC;IACF,GAAG,EAAE,UAAU,CAAC,IAAI;IACpB,aAAa,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;QAChC,IAAI,IAAI,KAAK,cAAc,CAAC,IAAI;YAAE,OAAO,cAAc,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,YAAY,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;QACvC,IAAI,YAAY,KAAK,cAAc,CAAC,YAAY;YAAE,OAAO,cAAc,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/C,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;CACjD,CAAC;AAEF,MAAM,cAAc,GAA2C;IAC7D,GAAG;IACH,SAAS,EAAE;QACT;YACE,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE;gBACV,CAAC,8BAA8B,CAAC,GAAG,CAAC,EAAE,8BAA8B;aACpB,EAAE,oDAAoD;YACxG,KAAK,EAAE,EAAE;SACV;KACF;IACD,SAAS,EAAE,EAAE,EAAE,+CAA+C;CAC/D,CAAC;AAEF,+EAA+E;AAC/E,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,sBAAsB,GAAwB,IAAA,uBAAM,EAAC,cAAc,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EACnC;YACE,SAAS,EAAE,sBAAsB;SAClC,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,mBAAmB,GAAwB,IAAA,2BAAQ,EAAC,UAAU,EAAE;YACpE,IAAI,EAAE,cAAc,CAAC,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EACnC;YACE,SAAS,EAAE,mBAAmB;SAC/B,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,kBAAkB,GAAwB,IAAA,2BAAQ,EAAC,UAAU,EAAE;YACnE,YAAY,EAAE,cAAc,CAAC,YAAY;SAC1C,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EACnC;YACE,SAAS,EAAE,kBAAkB;SAC9B,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,mBAAmB,GAAwB,IAAA,2BAAQ,EAAC,UAAU,EAAE;YACpE,IAAI,EAAE,gBAAgB;SACvB,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EACnC;YACE,SAAS,EAAE,mBAAmB;SAC/B,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;QAC/F,MAAM,kBAAkB,GAAwB,IAAA,2BAAQ,EAAC,UAAU,EAAE;YACnE,YAAY,EAAE,yBAAyB;SACxC,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EACnC;YACE,SAAS,EAAE,kBAAkB;SAC9B,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,6 @@
+import { DeclaredResource } from '../../../domain/DeclaredResource';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare const getByReferencedPrimaryKey: <R extends DeclaredResource, P extends keyof R>({ referenceOf, primaryKey, }: {
+    referenceOf: string;
+    primaryKey: Required<Pick<R, P>>;
+}, context: DeclastructContext) => Promise<Required<R> | null>;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getByReferencedPrimaryKey = void 0;
+const getProviderContextFromGlobalContextForResourceClass_1 = require("../provider/getProviderContextFromGlobalContextForResourceClass");
+const getProviderResourceRemoteStateInterfaceFromContextForResourceClass_1 = require("../provider/getProviderResourceRemoteStateInterfaceFromContextForResourceClass");
+const getByReferencedPrimaryKey = ({ referenceOf, primaryKey, }, context) => {
+    // lookup the interface
+    const persistanceInterface = (0, getProviderResourceRemoteStateInterfaceFromContextForResourceClass_1.getProviderResourceRemoteStateInterfaceFromContextForResourceClass)({
+        resourceClassName: referenceOf,
+    }, context);
+    // lookup the provider context
+    const providerContext = (0, getProviderContextFromGlobalContextForResourceClass_1.getProviderContextFromGlobalContextForResourceClass)({ resourceClassName: referenceOf }, context);
+    // find by primary
+    return persistanceInterface.findByPrimary(primaryKey, providerContext);
+};
+exports.getByReferencedPrimaryKey = getByReferencedPrimaryKey;
+//# sourceMappingURL=getByReferencedPrimaryKey.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getByReferencedPrimaryKey.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getByReferencedPrimaryKey.ts"],"names":[],"mappings":";;;AAEA,yIAAsI;AACtI,uKAAoK;AAE7J,MAAM,yBAAyB,GAAG,CAIvC,EACE,WAAW,EACX,UAAU,GAIX,EACD,OAA2B,EAC3B,EAAE;IACF,uBAAuB;IACvB,MAAM,oBAAoB,GACxB,IAAA,uIAAkE,EAMhE;QACE,iBAAiB,EAAE,WAAW;KAC/B,EACD,OAAO,CACR,CAAC;IAEJ,8BAA8B;IAC9B,MAAM,eAAe,GAAG,IAAA,yGAAmD,EACzE,EAAE,iBAAiB,EAAE,WAAW,EAAE,EAClC,OAAO,CACR,CAAC;IAEF,kBAAkB;IAClB,OAAO,oBAAoB,CAAC,aAAa,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACzE,CAAC,CAAC;AAnCW,QAAA,yBAAyB,6BAmCpC"}

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

@@ -0,0 +1,7 @@
+import { VisualogicContext } from 'visualogic';
+import { DeclaredResource } from '../../../domain/DeclaredResource';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare const getByReferencedUniqueKey: <R extends DeclaredResource, U extends keyof R>({ referenceOf, uniqueKey, }: {
+    referenceOf: string;
+    uniqueKey: Required<Pick<R, U>>;
+}, context: DeclastructContext & VisualogicContext) => Promise<Required<R> | null>;

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

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getByReferencedUniqueKey = void 0;
+const getProviderContextFromGlobalContextForResourceClass_1 = require("../provider/getProviderContextFromGlobalContextForResourceClass");
+const getProviderResourceRemoteStateInterfaceFromContextForResourceClass_1 = require("../provider/getProviderResourceRemoteStateInterfaceFromContextForResourceClass");
+const getByReferencedUniqueKey = async ({ referenceOf, uniqueKey, }, context) => {
+    // lookup the interface
+    // const stopwatchOne = startDurationStopwatch(
+    //   {
+    //     for: `getByReferencedUniqueKey.ofClass::${referenceOf}.getInterface`,
+    //     log: { level: LogLevel.INFO, threshold: { milliseconds: 1 } },
+    //   },
+    //   context,
+    // );
+    const persistanceInterface = (0, getProviderResourceRemoteStateInterfaceFromContextForResourceClass_1.getProviderResourceRemoteStateInterfaceFromContextForResourceClass)({
+        resourceClassName: referenceOf,
+    }, context);
+    // stopwatchOne.stop();
+    // lookup the provider context
+    // const stopwatchTwo = startDurationStopwatch(
+    //   {
+    //     for: `getByReferencedUniqueKey.ofClass::${referenceOf}.getContext`,
+    //     log: { level: LogLevel.INFO, threshold: { milliseconds: 1 } },
+    //   },
+    //   context,
+    // );
+    const providerContext = (0, getProviderContextFromGlobalContextForResourceClass_1.getProviderContextFromGlobalContextForResourceClass)({ resourceClassName: referenceOf }, context);
+    // stopwatchTwo.stop();
+    // find by unique
+    // const stopwatchThree = startDurationStopwatch(
+    //   {
+    //     for: `getByReferencedUniqueKey.ofClass::${referenceOf}:persistanceInterface.findByUnique`,
+    //     log: { level: LogLevel.INFO, threshold: { milliseconds: 1 } },
+    //   },
+    //   context,
+    // );
+    const result = await persistanceInterface.findByUnique(uniqueKey, providerContext);
+    // stopwatchThree.stop();
+    return result;
+};
+exports.getByReferencedUniqueKey = getByReferencedUniqueKey;
+//# sourceMappingURL=getByReferencedUniqueKey.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getByReferencedUniqueKey.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getByReferencedUniqueKey.ts"],"names":[],"mappings":";;;AAIA,yIAAsI;AACtI,uKAAoK;AAE7J,MAAM,wBAAwB,GAAG,KAAK,EAI3C,EACE,WAAW,EACX,SAAS,GAIV,EACD,OAA+C,EAC/C,EAAE;IACF,uBAAuB;IACvB,+CAA+C;IAC/C,MAAM;IACN,4EAA4E;IAC5E,qEAAqE;IACrE,OAAO;IACP,aAAa;IACb,KAAK;IACL,MAAM,oBAAoB,GACxB,IAAA,uIAAkE,EAMhE;QACE,iBAAiB,EAAE,WAAW;KAC/B,EACD,OAAO,CACR,CAAC;IACJ,uBAAuB;IAEvB,8BAA8B;IAC9B,+CAA+C;IAC/C,MAAM;IACN,0EAA0E;IAC1E,qEAAqE;IACrE,OAAO;IACP,aAAa;IACb,KAAK;IACL,MAAM,eAAe,GAAG,IAAA,yGAAmD,EACzE,EAAE,iBAAiB,EAAE,WAAW,EAAE,EAClC,OAAO,CACR,CAAC;IACF,uBAAuB;IAEvB,iBAAiB;IACjB,iDAAiD;IACjD,MAAM;IACN,iGAAiG;IACjG,qEAAqE;IACrE,OAAO;IACP,aAAa;IACb,KAAK;IACL,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,YAAY,CACpD,SAAS,EACT,eAAe,CAChB,CAAC;IACF,yBAAyB;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AA/DW,QAAA,wBAAwB,4BA+DnC"}

package/dist/logic/tools/reference/getPrimaryKeyByReference.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';
+/**
+ * tactic: gets the primary key of a resource by reference
+ * strategy
+ * - if reference is identified by primary key, then return it
+ * - if reference is identified by unique key, then get the resource by reference, and build the primary key from it
+ * usecase
+ * - speed up unique key resolution by returning it from the reference if already present, preventing redundant downstream calls
+ */
+export declare const getPrimaryKeyByReference: <T extends DeclaredResource, P extends keyof T, U extends keyof T>({ reference, }: {
+    reference: DeclaredResourceReference<T, P, U>;
+}, context: DeclastructContext & VisualogicContext) => Promise<Required<Pick<T, P>>>;

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

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrimaryKeyByReference = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const error_fns_2 = require("@ehmpathy/error-fns");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const buildPrimaryKeyTo_1 = require("./buildPrimaryKeyTo");
+const getByReference_1 = require("./getByReference");
+/**
+ * tactic: gets the primary key of a resource by reference
+ * strategy
+ * - if reference is identified by primary key, then return it
+ * - if reference is identified by unique key, then get the resource by reference, and build the primary key from it
+ * usecase
+ * - speed up unique key resolution by returning it from the reference if already present, preventing redundant downstream calls
+ */
+const getPrimaryKeyByReference = async ({ reference, }, context) => {
+    // if reference is by primary key, return the value
+    if (reference.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.PRIMARY_KEY)
+        return reference.identifiedBy.value;
+    // if reference is by unique key, get the resource by reference and build the primary key from it
+    if (reference.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY) {
+        const resource = await (0, getByReference_1.getByReference)({ reference }, context);
+        if (!resource)
+            throw new error_fns_1.BadRequestError(
+            // todo: make this a typed error
+            'could not find resource by unique-key reference to getPrimaryKeyByReference', { reference });
+        return (0, buildPrimaryKeyTo_1.buildPrimaryKeyTo)(resource.constructor, resource);
+    }
+    // otherwise, resource reference was declared incorrectly. this should not happen due to types
+    throw new error_fns_2.UnexpectedCodePathError('invalid resource reference declaration', {
+        reference,
+    });
+};
+exports.getPrimaryKeyByReference = getPrimaryKeyByReference;
+//# sourceMappingURL=getPrimaryKeyByReference.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getPrimaryKeyByReference.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getPrimaryKeyByReference.ts"],"names":[],"mappings":";;;AAAA,mDAAsD;AACtD,mDAA8D;AAI9D,yFAGmD;AAEnD,2DAAwD;AACxD,qDAAkD;AAElD;;;;;;;GAOG;AACI,MAAM,wBAAwB,GAAG,KAAK,EAK3C,EACE,SAAS,GAGV,EACD,OAA+C,EAChB,EAAE;IACjC,mDAAmD;IACnD,IACE,SAAS,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,WAAW;QAE3E,OAAO,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC;IAEtC,iGAAiG;IACjG,IACE,SAAS,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,UAAU,EAC1E,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EAAC,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,2BAAe;YACvB,gCAAgC;YAChC,6EAA6E,EAC7E,EAAE,SAAS,EAAE,CACd,CAAC;QACJ,OAAO,IAAA,qCAAiB,EAAC,QAAQ,CAAC,WAAkB,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED,8FAA8F;IAC9F,MAAM,IAAI,mCAAuB,CAAC,wCAAwC,EAAE;QAC1E,SAAS;KACV,CAAC,CAAC;AACL,CAAC,CAAC;AApCW,QAAA,wBAAwB,4BAoCnC"}

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

@@ -0,0 +1,18 @@
+import { DomainObject } from 'domain-objects';
+import { DeclaredResourceReference } from '../../../domain/DeclaredResourceReference';
+export declare class CanNotReferenceDeclaredResourceError extends Error {
+    constructor({ resource, reason, }: {
+        resource: DomainObject<any>;
+        reason: string;
+    });
+}
+/**
+ * returns a reference to a resource
+ * - uses the primary key if possible
+ * - uses the unique key otherwise
+ *
+ * note
+ * - this is a convinience wrapper for the function `buildReferenceTo`
+ */
+export declare const getReferenceTo: <T extends DomainObject<any>, P extends keyof T, U extends keyof T>(resource: T) => DeclaredResourceReference<T, P, U>;
+export { getReferenceTo as getRef };

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

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRef = exports.getReferenceTo = exports.CanNotReferenceDeclaredResourceError = void 0;
+const domain_objects_1 = require("domain-objects");
+const buildReferenceTo_1 = require("./buildReferenceTo");
+class CanNotReferenceDeclaredResourceError extends Error {
+    constructor({ resource, reason, }) {
+        super(`
+Can not reference declared resource ${resource.constructor?.name
+            ? `of class '${resource.constructor.name}'`
+            : ''} because ${reason}.
+
+resource
+${JSON.stringify(resource, null, 2)}
+    `.trim());
+    }
+}
+exports.CanNotReferenceDeclaredResourceError = CanNotReferenceDeclaredResourceError;
+/**
+ * returns a reference to a resource
+ * - uses the primary key if possible
+ * - uses the unique key otherwise
+ *
+ * note
+ * - this is a convinience wrapper for the function `buildReferenceTo`
+ */
+const getReferenceTo = (resource) => {
+    // confirm that it is an instance of a domain object
+    if (!(resource instanceof domain_objects_1.DomainObject))
+        throw new CanNotReferenceDeclaredResourceError({
+            resource,
+            reason: 'the resource is not an instance of a DomainObject class',
+        });
+    // confirm that it is an instance of a domain entity
+    if (!(resource instanceof domain_objects_1.DomainEntity))
+        throw new CanNotReferenceDeclaredResourceError({
+            resource,
+            reason: 'the resource is not an instance of a DomainEntity class. only Entities have distinct state of their own',
+        });
+    // try to build the reference
+    try {
+        return (0, buildReferenceTo_1.buildReferenceTo)(resource.constructor, resource);
+    }
+    catch (error) {
+        if (error instanceof buildReferenceTo_1.CanNotBuildReferenceError)
+            throw new CanNotReferenceDeclaredResourceError({
+                resource,
+                reason: 'neither the primary key nor unique key is present in the resource',
+            });
+        throw error; // otherwise, forward the error
+    }
+};
+exports.getReferenceTo = getReferenceTo;
+exports.getRef = exports.getReferenceTo;
+//# sourceMappingURL=getReferenceTo.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getReferenceTo.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getReferenceTo.ts"],"names":[],"mappings":";;;AAAA,mDAA4D;AAG5D,yDAG4B;AAE5B,MAAa,oCAAqC,SAAQ,KAAK;IAC7D,YAAY,EACV,QAAQ,EACR,MAAM,GAIP;QACC,KAAK,CACH;sCAEE,QAAQ,CAAC,WAAW,EAAE,IAAI;YACxB,CAAC,CAAC,aAAa,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG;YAC3C,CAAC,CAAC,EACN,YAAY,MAAM;;;EAGtB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;KAC9B,CAAC,IAAI,EAAE,CACP,CAAC;IACJ,CAAC;CACF;AArBD,oFAqBC;AACD;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAW5B,QAAW,EACyB,EAAE;IACtC,oDAAoD;IACpD,IAAI,CAAC,CAAC,QAAQ,YAAY,6BAAY,CAAC;QACrC,MAAM,IAAI,oCAAoC,CAAC;YAC7C,QAAQ;YACR,MAAM,EAAE,yDAAyD;SAClE,CAAC,CAAC;IAEL,oDAAoD;IACpD,IAAI,CAAC,CAAC,QAAQ,YAAY,6BAAY,CAAC;QACrC,MAAM,IAAI,oCAAoC,CAAC;YAC7C,QAAQ;YACR,MAAM,EACJ,yGAAyG;SAC5G,CAAC,CAAC;IAEL,6BAA6B;IAC7B,IAAI,CAAC;QACH,OAAO,IAAA,mCAAgB,EAAC,QAAQ,CAAC,WAAkB,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,IAAI,KAAK,YAAY,4CAAyB;YAC5C,MAAM,IAAI,oCAAoC,CAAC;gBAC7C,QAAQ;gBACR,MAAM,EACJ,mEAAmE;aACtE,CAAC,CAAC;QACL,MAAM,KAAK,CAAC,CAAC,+BAA+B;IAC9C,CAAC;AACH,CAAC,CAAC;AAxCW,QAAA,cAAc,kBAwCzB;AAEyB,iBA1Cd,sBAAc,CA0CM"}

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

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

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

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const domain_objects_1 = require("domain-objects");
+const buildReferenceTo_1 = require("./buildReferenceTo");
+const getReferenceTo_1 = require("./getReferenceTo");
+// todo: remove the declastruct references in favor of domain-object references
+describe.skip('getReferenceTo', () => {
+    it('should throw a helpful error if the resource is not an instance of a domain object', () => {
+        try {
+            (0, getReferenceTo_1.getReferenceTo)({ name: 'bob', age: 21 });
+            throw new Error('should not reach here');
+        }
+        catch (error) {
+            expect(error).toBeInstanceOf(getReferenceTo_1.CanNotReferenceDeclaredResourceError);
+            expect(error.message).toContain('resource is not an instance of a');
+            expect(error).toMatchSnapshot();
+        }
+    });
+    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 {
+            (0, getReferenceTo_1.getReferenceTo)(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 {
+            (0, getReferenceTo_1.getReferenceTo)(new CNCMachine({
+                serialNumber: '821',
+                size: 'big',
+                location: 'basement',
+            }));
+            throw new Error('should not reach here');
+        }
+        catch (error) {
+            expect(error).toBeInstanceOf(getReferenceTo_1.CanNotReferenceDeclaredResourceError);
+            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, getReferenceTo_1.getReferenceTo)(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 reference by primary key if posible', () => {
+        class CNCMachine extends domain_objects_1.DomainObject {
+        }
+        CNCMachine.primary = ['uuid'];
+        CNCMachine.unique = ['serialNumber'];
+        const reference = (0, getReferenceTo_1.getReferenceTo)(new CNCMachine({
+            uuid: 'de0e34ca-ce61-4884-ace5-093a1a32ff92',
+            serialNumber: '821',
+            size: 'big',
+            location: 'basement',
+        }));
+        expect(reference).toEqual({
+            referenceOf: 'CNCMachine',
+            identifiedBy: {
+                key: 'PRIMARY_KEY',
+                value: { uuid: 'de0e34ca-ce61-4884-ace5-093a1a32ff92' },
+            },
+        });
+        expect(reference).toMatchSnapshot(); // log for viewing
+    });
+});
+//# sourceMappingURL=getReferenceTo.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getReferenceTo.test.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getReferenceTo.test.ts"],"names":[],"mappings":";;AAAA,mDAA8C;AAE9C,yDAA+E;AAC/E,qDAG0B;AAE1B,+EAA+E;AAC/E,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAC5F,IAAI,CAAC;YACH,IAAA,+BAAc,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,qDAAoC,CAAC,CAAC;YACnE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;YACpE,MAAM,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,CAAC;QAClC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE;QAOjF,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,CAAC;YACH,IAAA,+BAAc,EACZ,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;QAEjC,IAAI,CAAC;YACH,IAAA,+BAAc,EACZ,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,qDAAoC,CAAC,CAAC;YACnE,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;QAE1C,MAAM,SAAS,GAAG,IAAA,+BAAc,EAC9B,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;QAE1C,MAAM,SAAS,GAAG,IAAA,+BAAc,EAC9B,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,aAAa;gBAClB,KAAK,EAAE,EAAE,IAAI,EAAE,sCAAsC,EAAE;aACxD;SACF,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,kBAAkB;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/logic/tools/reference/getUniqueKeyByReference.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';
+/**
+ * tactic: gets the unique key of a resource by reference
+ * strategy
+ * - if reference is identified by unique key, then return it
+ * - if reference is identified by primary key, then get the resource by reference, and build the unique key from it
+ * usecase
+ * - speed up unique key resolution by returning it from the reference if already present, preventing redundant downstream calls
+ */
+export declare const getUniqueKeyByReference: <T extends DeclaredResource, P extends keyof T, U extends keyof T>({ reference, }: {
+    reference: DeclaredResourceReference<T, P, U>;
+}, context: DeclastructContext & VisualogicContext) => Promise<Required<Pick<T, U>>>;

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

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUniqueKeyByReference = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const error_fns_2 = require("@ehmpathy/error-fns");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const buildUniqueKeyTo_1 = require("./buildUniqueKeyTo");
+const getByReference_1 = require("./getByReference");
+/**
+ * tactic: gets the unique key of a resource by reference
+ * strategy
+ * - if reference is identified by unique key, then return it
+ * - if reference is identified by primary key, then get the resource by reference, and build the unique key from it
+ * usecase
+ * - speed up unique key resolution by returning it from the reference if already present, preventing redundant downstream calls
+ */
+const getUniqueKeyByReference = async ({ reference, }, context) => {
+    // if reference is by unique key, return the value
+    if (reference.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY)
+        return reference.identifiedBy.value;
+    // if reference is by primary key, get the resource by reference and build the primary key from it
+    if (reference.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.PRIMARY_KEY) {
+        const resource = await (0, getByReference_1.getByReference)({ reference }, context);
+        if (!resource)
+            throw new error_fns_1.BadRequestError(
+            // todo: make this a typed error
+            'could not find resource by primary-key reference to getUniqueKeyByReference', { reference });
+        return (0, buildUniqueKeyTo_1.buildUniqueKeyTo)(resource.constructor, resource);
+    }
+    // otherwise, resource reference was declared incorrectly. this should not happen due to types
+    throw new error_fns_2.UnexpectedCodePathError('invalid resource reference declaration', {
+        reference,
+    });
+};
+exports.getUniqueKeyByReference = getUniqueKeyByReference;
+//# sourceMappingURL=getUniqueKeyByReference.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getUniqueKeyByReference.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/getUniqueKeyByReference.ts"],"names":[],"mappings":";;;AAAA,mDAAsD;AACtD,mDAA8D;AAI9D,yFAGmD;AAEnD,yDAAsD;AACtD,qDAAkD;AAElD;;;;;;;GAOG;AACI,MAAM,uBAAuB,GAAG,KAAK,EAK1C,EACE,SAAS,GAGV,EACD,OAA+C,EAChB,EAAE;IACjC,kDAAkD;IAClD,IACE,SAAS,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,UAAU;QAE1E,OAAO,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC;IAEtC,kGAAkG;IAClG,IACE,SAAS,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,WAAW,EAC3E,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EAAC,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,2BAAe;YACvB,gCAAgC;YAChC,6EAA6E,EAC7E,EAAE,SAAS,EAAE,CACd,CAAC;QACJ,OAAO,IAAA,mCAAgB,EAAC,QAAQ,CAAC,WAAkB,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED,8FAA8F;IAC9F,MAAM,IAAI,mCAAuB,CAAC,wCAAwC,EAAE;QAC1E,SAAS;KACV,CAAC,CAAC;AACL,CAAC,CAAC;AApCW,QAAA,uBAAuB,2BAoClC"}

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

@@ -0,0 +1,6 @@
+import { DeclaredResourceReference, DeclaredResourceReferenceKeyType } from '../../../domain/DeclaredResourceReference';
+export declare const isPrimaryKeyReference: <T, P extends keyof T, U extends keyof T>(ref: DeclaredResourceReference<T, P, U>) => ref is DeclaredResourceReference<T, P, U> & {
+    identifiedBy: {
+        key: DeclaredResourceReferenceKeyType.PRIMARY_KEY;
+    };
+};

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPrimaryKeyReference = void 0;
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const isPrimaryKeyReference = (ref) => ref.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.PRIMARY_KEY;
+exports.isPrimaryKeyReference = isPrimaryKeyReference;
+//# sourceMappingURL=isPrimaryKeyReference.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isPrimaryKeyReference.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/isPrimaryKeyReference.ts"],"names":[],"mappings":";;;AAAA,yFAGmD;AAE5C,MAAM,qBAAqB,GAAG,CAWnC,GAAuC,EAGvC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,WAAW,CAAC;AAd9D,QAAA,qBAAqB,yBAcyC"}

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

@@ -0,0 +1,6 @@
+import { DeclaredResourceReference, DeclaredResourceReferenceKeyType } from '../../../domain/DeclaredResourceReference';
+export declare const isUniqueKeyReference: <T, P extends keyof T, U extends keyof T>(ref: DeclaredResourceReference<T, P, U>) => ref is DeclaredResourceReference<T, P, U> & {
+    identifiedBy: {
+        key: DeclaredResourceReferenceKeyType.UNIQUE_KEY;
+    };
+};

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUniqueKeyReference = void 0;
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const isUniqueKeyReference = (ref) => ref.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY;
+exports.isUniqueKeyReference = isUniqueKeyReference;
+//# sourceMappingURL=isUniqueKeyReference.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isUniqueKeyReference.js","sourceRoot":"","sources":["../../../../src/logic/tools/reference/isUniqueKeyReference.ts"],"names":[],"mappings":";;;AAAA,yFAGmD;AAE5C,MAAM,oBAAoB,GAAG,CAWlC,GAAuC,EAGvC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,UAAU,CAAC;AAd7D,QAAA,oBAAoB,wBAcyC"}

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "declastruct",
+  "author": "ehmpathy",
+  "description": "Add declarative control to any resource constructs. Declare, plan, and apply within an observable pit-of-success.",
+  "version": "1.0.0",
+  "repository": "ehmpathy/declastruct",
+  "homepage": "https://github.com/ehmpathy/declastruct",
+  "keywords": [
+    "role",
+    "organization",
+    "crew",
+    "agent"
+  ],
+  "bugs": "https://github.com/ehmpathy/declastruct/issues",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "build:ts": "tsc -p ./tsconfig.build.json",
+    "commit:with-cli": "npx cz",
+    "fix:format:prettier": "prettier --write '**/*.ts' --config ./prettier.config.js",
+    "fix:format": "npm run fix:format:prettier",
+    "fix:lint": "eslint -c ./.eslintrc.js src/**/*.ts --fix",
+    "build:clean": "rm dist/ -rf",
+    "build:compile": "tsc -p ./tsconfig.build.json",
+    "build": "npm run build:clean && npm run build:compile",
+    "test:commits": "LAST_TAG=$(git describe --tags --abbrev=0 @^ 2> /dev/null || git rev-list --max-parents=0 HEAD) && npx commitlint --from $LAST_TAG --to HEAD --verbose",
+    "test:types": "tsc -p ./tsconfig.build.json --noEmit",
+    "test:format:prettier": "prettier --parser typescript --check 'src/**/*.ts' --config ./prettier.config.js",
+    "test:format": "npm run test:format:prettier",
+    "test:lint:deps": "npx depcheck -c ./depcheckrc.yml",
+    "test:lint:eslint": "eslint -c ./.eslintrc.js src/**/*.ts",
+    "test:lint": "npm run test:lint:eslint && npm run test:lint:deps",
+    "test:unit": "jest -c ./jest.unit.config.ts --forceExit --verbose --passWithNoTests $([ -z $THOROUGH ] && echo '--changedSince=main')",
+    "test:integration": "jest -c ./jest.integration.config.ts --forceExit --verbose --passWithNoTests $([ -z $THOROUGH ] && echo '--changedSince=main')",
+    "test:acceptance:locally": "npm run build && LOCALLY=true jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests",
+    "test": "npm run test:commits && npm run test:types && npm run test:format && npm run test:lint && npm run test:unit && npm run test:integration && npm run test:acceptance:locally",
+    "test:acceptance": "npm run build && jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests",
+    "prepush": "npm run test && npm run build",
+    "prepublish": "npm run build",
+    "preversion": "npm run prepush",
+    "postversion": "git push origin HEAD --tags --no-verify",
+    "postinstall": "[ -d .git ] && npm run prepare:husky || exit 0",
+    "prepare:husky": "npx husky install && chmod ug+x .husky/*"
+  },
+  "dependencies": {
+    "@ehmpathy/error-fns": "1.3.7",
+    "@ehmpathy/number-fns": "1.0.1",
+    "bottleneck": "2.19.5",
+    "chalk": "5.4.1",
+    "deep-object-diff": "1.1.9",
+    "domain-objects": "0.24.3",
+    "flattie": "1.1.1",
+    "indent-string": "5.0.0",
+    "jest-diff": "30.0.2",
+    "joi": "17.13.3",
+    "ora": "5.4.1",
+    "simple-in-memory-cache": "0.4.0",
+    "type-fns": "1.19.0",
+    "uuid-fns": "1.0.0",
+    "visualogic": "1.3.2",
+    "with-simple-caching": "0.14.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "19.3.0",
+    "@commitlint/config-conventional": "13.1.0",
+    "@trivago/prettier-plugin-sort-imports": "4.3.0",
+    "@tsconfig/node-lts-strictest": "18.12.1",
+    "@types/jest": "29.2.4",
+    "@typescript-eslint/eslint-plugin": "7.8.0",
+    "@typescript-eslint/parser": "7.8.0",
+    "core-js": "3.26.1",
+    "cz-conventional-changelog": "3.3.0",
+    "declapract": "0.12.0",
+    "declapract-typescript-ehmpathy": "0.39.5",
+    "depcheck": "1.4.3",
+    "eslint": "8.56.0",
+    "eslint-config-airbnb-typescript": "18.0.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "husky": "8.0.3",
+    "jest": "29.3.1",
+    "prettier": "2.8.1",
+    "simple-leveled-log-methods": "0.4.1",
+    "ts-jest": "29.1.3",
+    "ts-node": "10.9.2",
+    "typescript": "5.4.5"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  }
+}