declastruct 1.0.0

package/dist/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.d.ts

@@ -0,0 +1,11 @@
+import { DetailedDiff } from 'deep-object-diff';
+import { DomainObject } from 'domain-objects';
+import { VisualogicContext } from 'visualogic';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare const detectDifferenceBetweenDesiredAndRemoteStateOfResource: <T extends DomainObject<any>>({ desiredState, remoteState, }: {
+    desiredState: T | null;
+    remoteState: T | null;
+}, context: DeclastructContext & VisualogicContext) => Promise<{
+    displayable: string;
+    usable: DetailedDiff;
+}>;

package/dist/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectDifferenceBetweenDesiredAndRemoteStateOfResource = void 0;
+const deep_object_diff_1 = require("deep-object-diff");
+const domain_objects_1 = require("domain-objects");
+const jest_diff_1 = require("jest-diff");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const castReferenceToGrokableString_1 = require("./castReferenceToGrokableString");
+/**
+ * recursively traverse each key of the object and grokify any references found
+ */
+const withReferencesGrokified = async ({ resource }, context) => {
+    // create a clone of the resources, which we'll mutate keys on
+    const withKeysGrokified = new resource.constructor(resource);
+    // for each key holding a reference, replace reference with grokable string
+    await Promise.all(Object.keys(resource).map(async (key) => {
+        const value = resource[key];
+        if (value instanceof DeclaredResourceReference_1.DeclaredResourceReference)
+            withKeysGrokified[key] = await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference: value }, context);
+        else if (Array.isArray(value))
+            withKeysGrokified[key] = await Promise.all(value.map(async (valueItem) => value instanceof DeclaredResourceReference_1.DeclaredResourceReference
+                ? await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference: valueItem }, context)
+                : await withReferencesGrokified({ resource: valueItem }, context)));
+        else if (value instanceof domain_objects_1.DomainObject)
+            withKeysGrokified[key] = await withReferencesGrokified({ resource: value }, context);
+    }));
+    // return the fingerprinted object
+    return withKeysGrokified;
+};
+const detectDifferenceBetweenDesiredAndRemoteStateOfResource = async ({ desiredState, remoteState, }, context) => {
+    // replace all nested references with reference fingerprints, for readability
+    const diffableDesiredState = desiredState
+        ? // remove the metadata values from the desired state for diff, since these properties dont describe the data, they are just additional data typically generated by the remote state which cant be locally declared (e.g., uuid, createdAt, etc)
+            (0, domain_objects_1.omitMetadataValues)(await withReferencesGrokified({ resource: desiredState }, context))
+        : null;
+    const diffableRemoteState = remoteState
+        ? // remove the metadata values from the remote state for diff, since these properties dont describe the data, they are just additional data typically generated by the remote state which cant be locally declared (e.g., uuid, createdAt, etc)
+            (0, domain_objects_1.omitMetadataValues)(await withReferencesGrokified({ resource: remoteState }, context))
+        : null;
+    // define a displayable difference
+    const displayableDifference = (0, jest_diff_1.diff)(diffableDesiredState ?? {}, diffableRemoteState ?? {}, {
+        omitAnnotationLines: true,
+        aAnnotation: 'Desired State',
+        bAnnotation: 'Remote State',
+        aIndicator: '+',
+        bIndicator: '-',
+    });
+    // replace the "Object {}" placeholder we have to use to represent null state, if present (since jest shows "Comparing two different types of values. Expected object but received null." if we try to use null directly)
+    const cleanedDisplayableDifference = displayableDifference
+        ?.replace('- Object {}', '- null')
+        .replace('+ Object {}', '+ null');
+    // define a usable difference
+    const usableDifference = (0, deep_object_diff_1.detailedDiff)(diffableRemoteState ?? {}, diffableDesiredState ?? {}); // TODO: improve the usable difference. use the `objectDiff` and add our own info + make a more useful type
+    // return both
+    return {
+        displayable: cleanedDisplayableDifference,
+        usable: usableDifference,
+    };
+};
+exports.detectDifferenceBetweenDesiredAndRemoteStateOfResource = detectDifferenceBetweenDesiredAndRemoteStateOfResource;
+//# sourceMappingURL=detectDifferenceBetweenDesiredAndRemoteStateOfResource.js.map

package/dist/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detectDifferenceBetweenDesiredAndRemoteStateOfResource.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.ts"],"names":[],"mappings":";;;AAAA,uDAA4E;AAC5E,mDAAkE;AAClE,yCAA6C;AAI7C,yFAAsF;AAEtF,mFAAgF;AAEhF;;GAEG;AACH,MAAM,uBAAuB,GAAG,KAAK,EACnC,EAAE,QAAQ,EAAkC,EAC5C,OAA+C,EAC/C,EAAE;IACF,8DAA8D;IAC9D,MAAM,iBAAiB,GACrB,IAAK,QAAQ,CAAC,WAAmC,CAAC,QAAQ,CAAC,CAAC;IAE9D,2EAA2E;IAC3E,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACtC,MAAM,KAAK,GAAI,QAAgB,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,YAAY,qDAAyB;YAC5C,iBAAiB,CAAC,GAAG,CAAC,GAAG,MAAM,IAAA,6DAA6B,EAC1D,EAAE,SAAS,EAAE,KAAK,EAAE,EACpB,OAAO,CACR,CAAC;aACC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YAC3B,iBAAiB,CAAC,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CACxC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAC5B,KAAK,YAAY,qDAAyB;gBACxC,CAAC,CAAC,MAAM,IAAA,6DAA6B,EACjC,EAAE,SAAS,EAAE,SAAS,EAAE,EACxB,OAAO,CACR;gBACH,CAAC,CAAC,MAAM,uBAAuB,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CACpE,CACF,CAAC;aACC,IAAI,KAAK,YAAY,6BAAY;YACpC,iBAAiB,CAAC,GAAG,CAAC,GAAG,MAAM,uBAAuB,CACpD,EAAE,QAAQ,EAAE,KAAK,EAAE,EACnB,OAAO,CACR,CAAC;IACN,CAAC,CAAC,CACH,CAAC;IAEF,kCAAkC;IAClC,OAAO,iBAAiB,CAAC;AAC3B,CAAC,CAAC;AAEK,MAAM,sDAAsD,GAAG,KAAK,EAGzE,EACE,YAAY,EACZ,WAAW,GAIZ,EACD,OAA+C,EAI9C,EAAE;IACH,6EAA6E;IAC7E,MAAM,oBAAoB,GAAG,YAAY;QACvC,CAAC,CAAC,+OAA+O;YAC/O,IAAA,mCAAkB,EAChB,MAAM,uBAAuB,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,OAAO,CAAC,CACnE;QACH,CAAC,CAAC,IAAI,CAAC;IACT,MAAM,mBAAmB,GAAG,WAAW;QACrC,CAAC,CAAC,8OAA8O;YAC9O,IAAA,mCAAkB,EAChB,MAAM,uBAAuB,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,OAAO,CAAC,CAClE;QACH,CAAC,CAAC,IAAI,CAAC;IAET,kCAAkC;IAClC,MAAM,qBAAqB,GAAW,IAAA,gBAAQ,EAC5C,oBAAoB,IAAI,EAAE,EAC1B,mBAAmB,IAAI,EAAE,EACzB;QACE,mBAAmB,EAAE,IAAI;QACzB,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,cAAc;QAC3B,UAAU,EAAE,GAAG;QACf,UAAU,EAAE,GAAG;KAChB,CACD,CAAC;IAEH,yNAAyN;IACzN,MAAM,4BAA4B,GAAG,qBAAqB;QACxD,EAAE,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC;SACjC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAEpC,6BAA6B;IAC7B,MAAM,gBAAgB,GAAG,IAAA,+BAAU,EACjC,mBAAmB,IAAI,EAAE,EACzB,oBAAoB,IAAI,EAAE,CAC3B,CAAC,CAAC,2GAA2G;IAE9G,cAAc;IACd,OAAO;QACL,WAAW,EAAE,4BAA4B;QACzC,MAAM,EAAE,gBAAgB;KACzB,CAAC;AACJ,CAAC,CAAC;AA1DW,QAAA,sDAAsD,0DA0DjE"}

package/dist/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.test.d.ts

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

package/dist/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.test.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getExampleContext_1 = require("../../../__test_assets__/getExampleContext");
+const detectDifferenceBetweenDesiredAndRemoteStateOfResource_1 = require("./detectDifferenceBetweenDesiredAndRemoteStateOfResource");
+const { exampleContext, exampleMachine, CNCMachine } = (0, getExampleContext_1.getExampleContext)();
+describe('detectDifferenceBetweenDesiredAndRemoteStateOfResource', () => {
+    it('should return a helpful displayable difference and usable difference', async () => {
+        const desiredState = exampleMachine;
+        const remoteState = new CNCMachine({
+            ...desiredState,
+            location: 'moon',
+        });
+        const difference = await (0, detectDifferenceBetweenDesiredAndRemoteStateOfResource_1.detectDifferenceBetweenDesiredAndRemoteStateOfResource)({
+            desiredState,
+            remoteState,
+        }, exampleContext);
+        expect(difference).toMatchSnapshot();
+    });
+    it('should show the case where we want to create a new resource well', async () => {
+        const desiredState = exampleMachine;
+        const remoteState = null;
+        const difference = await (0, detectDifferenceBetweenDesiredAndRemoteStateOfResource_1.detectDifferenceBetweenDesiredAndRemoteStateOfResource)({
+            desiredState,
+            remoteState,
+        }, exampleContext);
+        console.log(difference.displayable);
+        console.log(difference.usable);
+        expect(difference).toMatchSnapshot();
+    });
+});
+//# sourceMappingURL=detectDifferenceBetweenDesiredAndRemoteStateOfResource.test.js.map

package/dist/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detectDifferenceBetweenDesiredAndRemoteStateOfResource.test.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource.test.ts"],"names":[],"mappings":";;AAAA,kFAA+E;AAC/E,qIAAkI;AAElI,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAA,qCAAiB,GAAE,CAAC;AAE3E,QAAQ,CAAC,wDAAwD,EAAE,GAAG,EAAE;IACtE,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,YAAY,GAAG,cAAc,CAAC;QACpC,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC;YACjC,GAAG,YAAY;YACf,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;QACH,MAAM,UAAU,GACd,MAAM,IAAA,+GAAsD,EAC1D;YACE,YAAY;YACZ,WAAW;SACZ,EACD,cAAc,CACf,CAAC;QACJ,MAAM,CAAC,UAAU,CAAC,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAChF,MAAM,YAAY,GAAG,cAAc,CAAC;QACpC,MAAM,WAAW,GAAG,IAAI,CAAC;QACzB,MAAM,UAAU,GACd,MAAM,IAAA,+GAAsD,EAC1D;YACE,YAAY;YACZ,WAAW;SACZ,EACD,cAAc,CACf,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,CAAC,UAAU,CAAC,CAAC,eAAe,EAAE,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/logic/tools/compare/resolveReferenceToCommonComparableForm.d.ts

@@ -0,0 +1,21 @@
+import { VisualogicContext } from 'visualogic';
+import { DeclaredResourceReference } from '../../../domain/DeclaredResourceReference';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+/**
+ * resolves a reference to a common form, which any reference can be normalized to, in which it can be compared
+ * - references can only be compared in fully-expanded unique-key form
+ * - this function resolves all primary key references into fully-expanded unique-key form
+ *
+ * context
+ * - references to the same resource can be defined by primary-key or unique-key
+ * - there is no way to determine whether a unique-key reference and a primary-key reference are referring to the same resource
+ * - the unique-key reference is the only reference form which can be guaranteed to be resolvable
+ *   - a primary-key reference can always be resolved to a unique-key reference (if a resource has a primary key assigned, then it can be looked up by primary key in the remote state)
+ *   - a unique-key reference may not be resolvable into a primary-key reference (the resource may not exist yet, and so there may not exist a primary-key defined for the resource)
+ * - a unique-key may itself be composed of nested unique keys
+ *   - for example, a `GoogleAdsAdGroup` is unique per `GoogleAdsCampaign` which itself is unique per `GoogleAdsAccount`
+ *   - these nested references must each be resolved
+ */
+export declare const resolveReferenceToCommonComparableForm: <T extends DeclaredResourceReference<any, any, any>>({ reference }: {
+    reference: T;
+}, context: DeclastructContext & VisualogicContext) => Promise<T>;

package/dist/logic/tools/compare/resolveReferenceToCommonComparableForm.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveReferenceToCommonComparableForm = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const error_fns_2 = require("@ehmpathy/error-fns");
+const __1 = require("../../..");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const getByReference_1 = require("../reference/getByReference");
+const resolveReferencesToCommonComparableForm_1 = require("./resolveReferencesToCommonComparableForm");
+/**
+ * resolves a reference to a common form, which any reference can be normalized to, in which it can be compared
+ * - references can only be compared in fully-expanded unique-key form
+ * - this function resolves all primary key references into fully-expanded unique-key form
+ *
+ * context
+ * - references to the same resource can be defined by primary-key or unique-key
+ * - there is no way to determine whether a unique-key reference and a primary-key reference are referring to the same resource
+ * - the unique-key reference is the only reference form which can be guaranteed to be resolvable
+ *   - a primary-key reference can always be resolved to a unique-key reference (if a resource has a primary key assigned, then it can be looked up by primary key in the remote state)
+ *   - a unique-key reference may not be resolvable into a primary-key reference (the resource may not exist yet, and so there may not exist a primary-key defined for the resource)
+ * - a unique-key may itself be composed of nested unique keys
+ *   - for example, a `GoogleAdsAdGroup` is unique per `GoogleAdsCampaign` which itself is unique per `GoogleAdsAccount`
+ *   - these nested references must each be resolved
+ */
+const resolveReferenceToCommonComparableForm = async ({ reference }, context) => {
+    // if this is a unique key reference, resolve any nested references and return that result
+    if (reference.identifiedBy.key === DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY) {
+        const uniqueKeyValueWithNestedReferencesResolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({
+            in: reference.identifiedBy.value,
+        }, context);
+        return new DeclaredResourceReference_1.DeclaredResourceReference({
+            referenceOf: reference.referenceOf,
+            identifiedBy: {
+                key: reference.identifiedBy.key,
+                value: uniqueKeyValueWithNestedReferencesResolved,
+            },
+        });
+    }
+    // if this is a primary key reference, lookup the resource and evaluate common form from there
+    const resource = await (0, getByReference_1.getByReference)({ reference }, context);
+    if (!resource)
+        throw new error_fns_2.BadRequestError('could not find resource by primary key reference. can not resolveReferenceToCommonComparableForm', { reference });
+    const resolvedShallowReference = (0, __1.getReferenceTo)(resource); // get reference to will produce a reference that may be shallow, since it synchronously computes the deepest reference possible from the available data returned by the interface
+    if (resolvedShallowReference.identifiedBy.key !==
+        DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY // sanity check that the resolved resource reference is defined by unique key; that's what it should normalize to since it's the most common form
+    )
+        throw new error_fns_1.UnexpectedCodePathError('should have resolved a reference by unique key from resolved resource', { resource, resolvedReference: resolvedShallowReference });
+    const resolvedReference = await (0, exports.resolveReferenceToCommonComparableForm)({ reference: resolvedShallowReference }, // now resolve the reference into the deep common form
+    context);
+    return resolvedReference;
+};
+exports.resolveReferenceToCommonComparableForm = resolveReferenceToCommonComparableForm;
+//# sourceMappingURL=resolveReferenceToCommonComparableForm.js.map

package/dist/logic/tools/compare/resolveReferenceToCommonComparableForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveReferenceToCommonComparableForm.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/resolveReferenceToCommonComparableForm.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAC9D,mDAAsD;AAGtD,gCAA0C;AAC1C,yFAGmD;AAEnD,gEAA6D;AAC7D,uGAAoG;AAEpG;;;;;;;;;;;;;;GAcG;AACI,MAAM,sCAAsC,GAAG,KAAK,EAGzD,EAAE,SAAS,EAAoB,EAC/B,OAA+C,EACnC,EAAE;IACd,0FAA0F;IAC1F,IACE,SAAS,CAAC,YAAY,CAAC,GAAG,KAAK,4DAAgC,CAAC,UAAU,EAC1E,CAAC;QACD,MAAM,0CAA0C,GAC9C,MAAM,IAAA,iFAAuC,EAC3C;YACE,EAAE,EAAE,SAAS,CAAC,YAAY,CAAC,KAAK;SACjC,EACD,OAAO,CACR,CAAC;QACJ,OAAO,IAAI,qDAAyB,CAAC;YACnC,WAAW,EAAE,SAAS,CAAC,WAAW;YAClC,YAAY,EAAE;gBACZ,GAAG,EAAE,SAAS,CAAC,YAAY,CAAC,GAAG;gBAC/B,KAAK,EAAE,0CAA0C;aAClD;SACF,CAAM,CAAC;IACV,CAAC;IAED,8FAA8F;IAC9F,MAAM,QAAQ,GAAG,MAAM,IAAA,+BAAc,EAAC,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,2BAAe,CACvB,kGAAkG,EAClG,EAAE,SAAS,EAAE,CACd,CAAC;IACJ,MAAM,wBAAwB,GAAG,IAAA,kBAAc,EAAC,QAAQ,CAAC,CAAC,CAAC,kLAAkL;IAC7O,IACE,wBAAwB,CAAC,YAAY,CAAC,GAAG;QACzC,4DAAgC,CAAC,UAAU,CAAC,iJAAiJ;;QAE7L,MAAM,IAAI,mCAAuB,CAC/B,uEAAuE,EACvE,EAAE,QAAQ,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,CAC1D,CAAC;IACJ,MAAM,iBAAiB,GAAG,MAAM,IAAA,8CAAsC,EACpE,EAAE,SAAS,EAAE,wBAAwB,EAAE,EAAE,sDAAsD;IAC/F,OAAO,CACR,CAAC;IACF,OAAO,iBAAsB,CAAC;AAChC,CAAC,CAAC;AA/CW,QAAA,sCAAsC,0CA+CjD"}

package/dist/logic/tools/compare/resolveReferenceToCommonComparableForm.test.d.ts

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

package/dist/logic/tools/compare/resolveReferenceToCommonComparableForm.test.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../../..");
+const getExampleContext_1 = require("../../../__test_assets__/getExampleContext");
+const resolveReferenceToCommonComparableForm_1 = require("./resolveReferenceToCommonComparableForm");
+const { exampleContext, exampleMachine, CNCMachine } = (0, getExampleContext_1.getExampleContext)();
+describe('resolveReferenceToCommonComparableForm', () => {
+    it('should change nothing on a shallow unique key reference', async () => {
+        const original = (0, __1.buildRef)(CNCMachine, {
+            serialNumber: exampleMachine.serialNumber,
+        });
+        const resolved = await (0, resolveReferenceToCommonComparableForm_1.resolveReferenceToCommonComparableForm)({
+            reference: original,
+        }, exampleContext);
+        expect(resolved).toEqual(original);
+    });
+    it('should resolve unique key reference from primary key reference', async () => {
+        const original = (0, __1.buildRef)(CNCMachine, {
+            uuid: exampleMachine.uuid,
+        });
+        const expected = (0, __1.buildRef)(CNCMachine, {
+            serialNumber: exampleMachine.serialNumber,
+        });
+        const resolved = await (0, resolveReferenceToCommonComparableForm_1.resolveReferenceToCommonComparableForm)({
+            reference: original,
+        }, exampleContext);
+        expect(resolved).toEqual(expected);
+    });
+    it.todo('should resolve a primary key reference nested in a unique key reference to unique key form');
+});
+//# sourceMappingURL=resolveReferenceToCommonComparableForm.test.js.map

package/dist/logic/tools/compare/resolveReferenceToCommonComparableForm.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveReferenceToCommonComparableForm.test.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/resolveReferenceToCommonComparableForm.test.ts"],"names":[],"mappings":";;AAAA,gCAAoC;AACpC,kFAGoD;AACpD,qGAAkG;AAElG,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAA,qCAAiB,GAAE,CAAC;AAE3E,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;IACtD,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,QAAQ,GAAwB,IAAA,YAAQ,EAAC,UAAU,EAAE;YACzD,YAAY,EAAE,cAAc,CAAC,YAAY;SAC1C,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAA,+EAAsC,EAC3D;YACE,SAAS,EAAE,QAAQ;SACpB,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,QAAQ,GAAwB,IAAA,YAAQ,EAAC,UAAU,EAAE;YACzD,IAAI,EAAE,cAAc,CAAC,IAAI;SAC1B,CAAC,CAAC;QACH,MAAM,QAAQ,GAAwB,IAAA,YAAQ,EAAC,UAAU,EAAE;YACzD,YAAY,EAAE,cAAc,CAAC,YAAY;SAC1C,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAA,+EAAsC,EAC3D;YACE,SAAS,EAAE,QAAQ;SACpB,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,IAAI,CACL,4FAA4F,CAC7F,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/logic/tools/compare/resolveReferencesToCommonComparableForm.d.ts

@@ -0,0 +1,10 @@
+import { VisualogicContext } from 'visualogic';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+/**
+ * recursively resolves all references in the given object to their common-comparable-form
+ *
+ * see the docs on `resolveReferenceToCommonComparableForm` for more info
+ */
+export declare const resolveReferencesToCommonComparableForm: <T extends unknown>({ in: value }: {
+    in: T;
+}, context: DeclastructContext & VisualogicContext) => Promise<T>;

package/dist/logic/tools/compare/resolveReferencesToCommonComparableForm.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveReferencesToCommonComparableForm = void 0;
+const domain_objects_1 = require("domain-objects");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const resolveReferenceToCommonComparableForm_1 = require("./resolveReferenceToCommonComparableForm");
+/**
+ * recursively resolves all references in the given object to their common-comparable-form
+ *
+ * see the docs on `resolveReferenceToCommonComparableForm` for more info
+ */
+const resolveReferencesToCommonComparableForm = async ({ in: value }, context) => {
+    // if this is not an object, then do nothing to it
+    if (!Array.isArray(value) && typeof value !== 'object')
+        return value; // if this value is not an array and is not an object, then it's a literal, so no more preparation required, return it itself
+    if (value === null)
+        return value; // if its null, return it too (null is typeof 'object' in js :shrug:)
+    // if its an array, then `resolve references` on each element
+    if (Array.isArray(value))
+        return (await Promise.all(value.map((el) => (0, exports.resolveReferencesToCommonComparableForm)({ in: el }, context))));
+    // if it's a reference, then resolve the reference
+    if (value instanceof DeclaredResourceReference_1.DeclaredResourceReference)
+        return await (0, resolveReferenceToCommonComparableForm_1.resolveReferenceToCommonComparableForm)({ reference: value }, context);
+    // otherwise, it's a generic object, so resolve the references on each key
+    const object = value;
+    const resolvedObject = {};
+    for (const nestedKey of Object.keys(object)) {
+        const nestedValue = object[nestedKey];
+        const resolvedValue = await (0, exports.resolveReferencesToCommonComparableForm)({ in: nestedValue }, context);
+        resolvedObject[nestedKey] = resolvedValue;
+    }
+    // if the object was a declared resource, then instantiate it with the same constructor and return that
+    if (object instanceof domain_objects_1.DomainObject) {
+        const DomainObjectConstructor = object.constructor;
+        return new DomainObjectConstructor(resolvedObject);
+    }
+    // otherwise, return the resolved object
+    return resolvedObject;
+};
+exports.resolveReferencesToCommonComparableForm = resolveReferencesToCommonComparableForm;
+//# sourceMappingURL=resolveReferencesToCommonComparableForm.js.map

package/dist/logic/tools/compare/resolveReferencesToCommonComparableForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveReferencesToCommonComparableForm.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/resolveReferencesToCommonComparableForm.ts"],"names":[],"mappings":";;;AAAA,mDAA8C;AAG9C,yFAAsF;AAEtF,qGAAkG;AAElG;;;;GAIG;AACI,MAAM,uCAAuC,GAAG,KAAK,EAC1D,EAAE,EAAE,EAAE,KAAK,EAAa,EACxB,OAA+C,EACnC,EAAE;IACd,kDAAkD;IAClD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC,CAAC,6HAA6H;IACnM,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC,CAAC,qEAAqE;IAEvG,6DAA6D;IAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACtB,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CACvB,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACf,IAAA,+CAAuC,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,CAAC,CAC7D,CACF,CAAM,CAAC;IAEV,kDAAkD;IAClD,IAAI,KAAK,YAAY,qDAAyB;QAC5C,OAAO,MAAM,IAAA,+EAAsC,EACjD,EAAE,SAAS,EAAE,KAAK,EAAE,EACpB,OAAO,CACR,CAAC;IAEJ,0EAA0E;IAC1E,MAAM,MAAM,GAAwB,KAAY,CAAC;IACjD,MAAM,cAAc,GAAwB,EAAE,CAAC;IAC/C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;QACtC,MAAM,aAAa,GAAG,MAAM,IAAA,+CAAuC,EACjE,EAAE,EAAE,EAAE,WAAW,EAAE,EACnB,OAAO,CACR,CAAC;QACF,cAAc,CAAC,SAAS,CAAC,GAAG,aAAa,CAAC;IAC5C,CAAC;IAED,uGAAuG;IACvG,IAAI,MAAM,YAAY,6BAAY,EAAE,CAAC;QACnC,MAAM,uBAAuB,GAAG,MAAM,CAAC,WAAkC,CAAC;QAC1E,OAAO,IAAI,uBAAuB,CAAC,cAAc,CAAM,CAAC;IAC1D,CAAC;IAED,wCAAwC;IACxC,OAAO,cAAmB,CAAC;AAC7B,CAAC,CAAC;AA3CW,QAAA,uCAAuC,2CA2ClD"}

package/dist/logic/tools/compare/resolveReferencesToCommonComparableForm.test.d.ts

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

package/dist/logic/tools/compare/resolveReferencesToCommonComparableForm.test.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const domain_objects_1 = require("domain-objects");
+const __1 = require("../../..");
+const getExampleContext_1 = require("../../../__test_assets__/getExampleContext");
+const DeclaredResourceReference_1 = require("../../../domain/DeclaredResourceReference");
+const resolveReferencesToCommonComparableForm_1 = require("./resolveReferencesToCommonComparableForm");
+const { exampleContext, exampleMachine, CNCMachine, exampleRegistration, CNCMachineRegistration, } = (0, getExampleContext_1.getExampleContext)();
+describe('resolveReferencesToCommonComparableForm', () => {
+    describe('basic types', () => {
+        it('should resolve strings', async () => {
+            const original = 'hello!';
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        it('should resolve numbers', async () => {
+            const original = 821;
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        // TODO: fix this
+        it.skip('should resolve dates', async () => {
+            const original = new Date('2020-08-21 00:00:00');
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        it('should resolve undefined', async () => {
+            const original = undefined;
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        it('should resolve nulls', async () => {
+            const original = null;
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        // TODO: fix this
+        it.skip('should resolve buffers', async () => {
+            const original = Buffer.from('821');
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+    });
+    describe('arrays', () => {
+        it('should be able to resolve arrays', async () => {
+            const original = ['821', 721, 'leopard', 7, 'apple', 3];
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        it('should resolve arrays even if they have objects', async () => {
+            const original = [
+                'banana',
+                { id: 1, value: 821, meaning: 42 },
+                821,
+                { id: 0, value: undefined, meaning: null }, // should go first, because id is 0
+            ];
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+    });
+    describe('objects', () => {
+        it('should be able to resolve an object with all sorts of types', async () => {
+            const original = {
+                color: 'blue',
+                cost: 821,
+                orders: [
+                    { id: 1, value: 821, meaning: 42 },
+                    { id: 0, value: undefined, meaning: null },
+                ],
+                application: {
+                    type: 'PAINTING',
+                },
+            };
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+    });
+    describe('domain objects', () => {
+        class Spaceship extends domain_objects_1.DomainEntity {
+        }
+        Spaceship.primary = ['uuid'];
+        Spaceship.unique = ['serialNumber'];
+        Spaceship.updatable = ['serialNumber'];
+        class Address extends domain_objects_1.DomainLiteral {
+        }
+        class Spaceport extends domain_objects_1.DomainEntity {
+        }
+        Spaceport.primary = ['uuid'];
+        Spaceport.unique = ['uuid'];
+        Spaceport.updatable = ['spaceships'];
+        Spaceport.nested = {
+            address: Address,
+            spaceships: DeclaredResourceReference_1.DeclaredResourceReference,
+        };
+        // run the tests
+        it('should resolve a domain object with no nested references', async () => {
+            const ship = new Spaceship({
+                serialNumber: '__UUID__',
+                fuelQuantity: 9001,
+                passengers: 21,
+            });
+            const original = ship;
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        it('should not change nested references already in common form', async () => {
+            const shipA = new Spaceship({
+                serialNumber: '__SHIP_A__',
+                fuelQuantity: 9001,
+                passengers: 21,
+            });
+            const shipB = new Spaceship({
+                uuid: '821',
+                serialNumber: '__SHIP_B__',
+                fuelQuantity: 7000,
+                passengers: 42,
+            });
+            const spaceport = new Spaceport({
+                uuid: '__SPACEPORT_UUID__',
+                address: new Address({
+                    galaxy: 'Milky Way',
+                    solarSystem: 'Sun',
+                    planet: 'Earth',
+                    continent: 'North America',
+                }),
+                spaceships: [(0, __1.getRef)(shipA), (0, __1.getRef)(shipB)],
+            });
+            const original = spaceport;
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual(original);
+        });
+        it('should resolve each nested primary key reference to its common form', async () => {
+            const primaryKeyRef = (0, __1.buildRef)(CNCMachine, {
+                uuid: exampleMachine.uuid,
+            });
+            const uniqueKeyRef = (0, __1.buildRef)(CNCMachine, {
+                serialNumber: exampleMachine.serialNumber,
+            });
+            const original = {
+                machine: primaryKeyRef,
+            };
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).not.toEqual(original);
+            expect(resolved).toEqual({ machine: uniqueKeyRef }); // should have taken it to common form
+        });
+        it('should resolve each nested unique key reference to its common form', async () => {
+            const uniqueKeyRef = (0, __1.buildRef)(CNCMachine, {
+                serialNumber: exampleMachine.serialNumber,
+            });
+            const original = {
+                machine: uniqueKeyRef,
+            };
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).toEqual({ machine: uniqueKeyRef }); // should have taken it to common form
+        });
+        it('should resolve a primary key reference to a multi level nested unique key reference common form', async () => {
+            const primaryKeyRef = (0, __1.buildRef)(CNCMachineRegistration, {
+                uuid: exampleRegistration.uuid,
+            });
+            const uniqueKeyRef = (0, __1.buildRef)(CNCMachineRegistration, {
+                machine: (0, __1.buildRef)(CNCMachine, {
+                    serialNumber: exampleMachine.serialNumber,
+                }),
+            });
+            const original = {
+                registration: primaryKeyRef,
+            };
+            const resolved = await (0, resolveReferencesToCommonComparableForm_1.resolveReferencesToCommonComparableForm)({ in: original }, exampleContext);
+            expect(resolved).not.toEqual(original);
+            expect(resolved).toEqual({ registration: uniqueKeyRef }); // should have taken it to common form});
+        });
+    });
+});
+//# sourceMappingURL=resolveReferencesToCommonComparableForm.test.js.map

package/dist/logic/tools/compare/resolveReferencesToCommonComparableForm.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveReferencesToCommonComparableForm.test.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/resolveReferencesToCommonComparableForm.test.ts"],"names":[],"mappings":";;AAAA,mDAA6D;AAE7D,gCAA4C;AAC5C,kFAIoD;AACpD,yFAAsF;AACtF,uGAAoG;AAEpG,MAAM,EACJ,cAAc,EACd,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,sBAAsB,GACvB,GAAG,IAAA,qCAAiB,GAAE,CAAC;AAExB,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;IACvD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,MAAM,QAAQ,GAAG,QAAQ,CAAC;YAC1B,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,MAAM,QAAQ,GAAG,GAAG,CAAC;YACrB,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,iBAAiB;QACjB,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACzC,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACjD,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;YACxC,MAAM,QAAQ,GAAG,SAAS,CAAC;YAC3B,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACpC,MAAM,QAAQ,GAAG,IAAI,CAAC;YACtB,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,iBAAiB;QACjB,EAAE,CAAC,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACtB,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAC/D,MAAM,QAAQ,GAAG;gBACf,QAAQ;gBACR,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE;gBAClC,GAAG;gBACH,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,mCAAmC;aAChF,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,QAAQ,GAAG;gBACf,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE;oBACN,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE;oBAClC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;iBAC3C;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,UAAU;iBACjB;aACF,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAQ9B,MAAM,SAAU,SAAQ,6BAAuB;;QAC/B,iBAAO,GAAG,CAAC,MAAM,CAAU,CAAC;QAC5B,gBAAM,GAAG,CAAC,cAAc,CAAC,CAAC;QAC1B,mBAAS,GAAG,CAAC,cAAc,CAAC,CAAC;QAc7C,MAAM,OAAQ,SAAQ,8BAAsB;SAAsB;QAMlE,MAAM,SAAU,SAAQ,6BAAuB;;QAC/B,iBAAO,GAAG,CAAC,MAAM,CAAU,CAAC;QAC5B,gBAAM,GAAG,CAAC,MAAM,CAAC,CAAC;QAClB,mBAAS,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3B,gBAAM,GAAG;YACrB,OAAO,EAAE,OAAO;YAChB,UAAU,EAAE,qDAAyB;SACtC,CAAC;QAGJ,gBAAgB;QAChB,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC;gBACzB,YAAY,EAAE,UAAU;gBACxB,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,EAAE;aACf,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC;YACtB,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;YAC1E,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC;gBAC1B,YAAY,EAAE,YAAY;gBAC1B,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,EAAE;aACf,CAAC,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC;gBAC1B,IAAI,EAAE,KAAK;gBACX,YAAY,EAAE,YAAY;gBAC1B,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,EAAE;aACf,CAAC,CAAC;YACH,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;gBAC9B,IAAI,EAAE,oBAAoB;gBAC1B,OAAO,EAAE,IAAI,OAAO,CAAC;oBACnB,MAAM,EAAE,WAAW;oBACnB,WAAW,EAAE,KAAK;oBAClB,MAAM,EAAE,OAAO;oBACf,SAAS,EAAE,eAAe;iBAC3B,CAAC;gBACF,UAAU,EAAE,CAAC,IAAA,UAAM,EAAC,KAAK,CAAC,EAAE,IAAA,UAAM,EAAC,KAAK,CAAC,CAAC;aAC3C,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,SAAS,CAAC;YAC3B,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;YACnF,MAAM,aAAa,GAAwB,IAAA,YAAQ,EAAC,UAAU,EAAE;gBAC9D,IAAI,EAAE,cAAc,CAAC,IAAI;aAC1B,CAAC,CAAC;YACH,MAAM,YAAY,GAAwB,IAAA,YAAQ,EAAC,UAAU,EAAE;gBAC7D,YAAY,EAAE,cAAc,CAAC,YAAY;aAC1C,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG;gBACf,OAAO,EAAE,aAAa;aACvB,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,sCAAsC;QAC7F,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,oEAAoE,EAAE,KAAK,IAAI,EAAE;YAClF,MAAM,YAAY,GAAwB,IAAA,YAAQ,EAAC,UAAU,EAAE;gBAC7D,YAAY,EAAE,cAAc,CAAC,YAAY;aAC1C,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG;gBACf,OAAO,EAAE,YAAY;aACtB,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,sCAAsC;QAC7F,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,iGAAiG,EAAE,KAAK,IAAI,EAAE;YAC/G,MAAM,aAAa,GAAoC,IAAA,YAAQ,EAC7D,sBAAsB,EACtB;gBACE,IAAI,EAAE,mBAAmB,CAAC,IAAI;aAC/B,CACF,CAAC;YACF,MAAM,YAAY,GAAoC,IAAA,YAAQ,EAC5D,sBAAsB,EACtB;gBACE,OAAO,EAAE,IAAA,YAAQ,EAAC,UAAU,EAAE;oBAC5B,YAAY,EAAE,cAAc,CAAC,YAAY;iBAC1C,CAAC;aACH,CACF,CAAC;YACF,MAAM,QAAQ,GAAG;gBACf,YAAY,EAAE,aAAa;aAC5B,CAAC;YACF,MAAM,QAAQ,GAAG,MAAM,IAAA,iFAAuC,EAC5D,EAAE,EAAE,EAAE,QAAQ,EAAE,EAChB,cAAc,CACf,CAAC;YACF,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,yCAAyC;QACrG,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/logic/tools/context/createDeclastructContext.d.ts

@@ -0,0 +1,10 @@
+import type { LogMethods } from 'simple-leveled-log-methods';
+import { VisualogicContext } from 'visualogic';
+import { DeclaredResource } from '../../../domain/DeclaredResource';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+import { DeclastructProvider } from '../../../domain/DeclastructProvider';
+export declare const createDeclastructContext: ({ providers, resources, log, }: {
+    providers: DeclastructProvider<any>[];
+    resources: DeclaredResource[];
+    log: LogMethods;
+}) => DeclastructContext & VisualogicContext;

package/dist/logic/tools/context/createDeclastructContext.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDeclastructContext = void 0;
+const createDeclastructContext = ({ providers, resources, log, }) => {
+    return {
+        providers,
+        resources,
+        log,
+    };
+};
+exports.createDeclastructContext = createDeclastructContext;
+//# sourceMappingURL=createDeclastructContext.js.map

package/dist/logic/tools/context/createDeclastructContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createDeclastructContext.js","sourceRoot":"","sources":["../../../../src/logic/tools/context/createDeclastructContext.ts"],"names":[],"mappings":";;;AAOO,MAAM,wBAAwB,GAAG,CAAC,EACvC,SAAS,EACT,SAAS,EACT,GAAG,GAKJ,EAA0C,EAAE;IAC3C,OAAO;QACL,SAAS;QACT,SAAS;QACT,GAAG;KACJ,CAAC;AACJ,CAAC,CAAC;AAdW,QAAA,wBAAwB,4BAcnC"}

package/dist/logic/tools/context/destroyDeclastructContext.d.ts

@@ -0,0 +1,4 @@
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare const destroyDeclastructContext: ({ context, }: {
+    context: DeclastructContext;
+}) => Promise<void>;

package/dist/logic/tools/context/destroyDeclastructContext.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destroyDeclastructContext = void 0;
+const destroyDeclastructContext = async ({ context, }) => {
+    // run the "afterall" of each provider
+    await Promise.all(context.providers.map((provider) => provider.hooks.afterAll ? provider.hooks.afterAll() : undefined));
+    // todo: mark the context as "destroyed" so it wont be used anymore?
+};
+exports.destroyDeclastructContext = destroyDeclastructContext;
+//# sourceMappingURL=destroyDeclastructContext.js.map

package/dist/logic/tools/context/destroyDeclastructContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destroyDeclastructContext.js","sourceRoot":"","sources":["../../../../src/logic/tools/context/destroyDeclastructContext.ts"],"names":[],"mappings":";;;AAEO,MAAM,yBAAyB,GAAG,KAAK,EAAE,EAC9C,OAAO,GAGR,EAAE,EAAE;IACH,sCAAsC;IACtC,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAChE,CACF,CAAC;IAEF,oEAAoE;AACtE,CAAC,CAAC;AAbW,QAAA,yBAAyB,6BAapC"}

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

@@ -0,0 +1,4 @@
+import { VisualogicContext } from 'visualogic';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+import { DeclastructProviderContext } from '../../../domain/DeclastructProviderContext';
+export declare const castProviderContextToGlobalContext: (from: DeclastructProviderContext<any>) => DeclastructContext & VisualogicContext;

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.castProviderContextToGlobalContext = void 0;
+const castProviderContextToGlobalContext = (from) => ({
+    providers: [from.provider],
+    resources: from.resources ?? [],
+    log: from.log,
+});
+exports.castProviderContextToGlobalContext = castProviderContextToGlobalContext;
+//# sourceMappingURL=castProviderContextToGlobalContext.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"castProviderContextToGlobalContext.js","sourceRoot":"","sources":["../../../../src/logic/tools/provider/castProviderContextToGlobalContext.ts"],"names":[],"mappings":";;;AAKO,MAAM,kCAAkC,GAAG,CAChD,IAAqC,EACG,EAAE,CAAC,CAAC;IAC5C,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC1B,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,EAAE;IAC/B,GAAG,EAAE,IAAI,CAAC,GAAG;CACd,CAAC,CAAC;AANU,QAAA,kCAAkC,sCAM5C"}

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

@@ -0,0 +1,13 @@
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+import { DeclastructProviderAgentOptions } from '../../../domain/DeclastructProvider';
+import { DeclastructProviderContext } from '../../../domain/DeclastructProviderContext';
+/**
+ * defines the provider specific context for resources of a specific class, from the full context
+ *
+ * relevance
+ * - we dont share the full declastruct context to providers, due to security, becuase credentials are defined in the full context
+ * - instead, we only share the the data the user explicitly defined for a particular provider (agentOptions, resources)
+ */
+export declare const getProviderContextFromGlobalContextForResourceClass: <AO extends DeclastructProviderAgentOptions>({ resourceClassName }: {
+    resourceClassName: string;
+}, context: DeclastructContext) => DeclastructProviderContext<AO>;

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProviderContextFromGlobalContextForResourceClass = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+/**
+ * defines the provider specific context for resources of a specific class, from the full context
+ *
+ * relevance
+ * - we dont share the full declastruct context to providers, due to security, becuase credentials are defined in the full context
+ * - instead, we only share the the data the user explicitly defined for a particular provider (agentOptions, resources)
+ */
+const getProviderContextFromGlobalContextForResourceClass = ({ 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,
+        });
+    // find all of the resources managed by this provider
+    const resources = context.resources.filter((resource) => resource.constructor.name in provider.interfaces);
+    // return the context
+    return {
+        provider: provider,
+        resources,
+        log: context.log,
+    };
+};
+exports.getProviderContextFromGlobalContextForResourceClass = getProviderContextFromGlobalContextForResourceClass;
+//# sourceMappingURL=getProviderContextFromGlobalContextForResourceClass.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getProviderContextFromGlobalContextForResourceClass.js","sourceRoot":"","sources":["../../../../src/logic/tools/provider/getProviderContextFromGlobalContextForResourceClass.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAU9D;;;;;;GAMG;AACI,MAAM,mDAAmD,GAAG,CAGjE,EAAE,iBAAiB,EAAiC,EACpD,OAA2B,EACK,EAAE;IAClC,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,CAAC,sCAAsC,EAAE;YACxE,iBAAiB;SAClB,CAAC,CAAC;IAEL,qDAAqD;IACrD,MAAM,SAAS,GAAuB,OAAO,CAAC,SAAS,CAAC,MAAM,CAC5D,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,QAAQ,CAAC,UAAU,CAC/D,CAAC;IAEF,qBAAqB;IACrB,OAAO;QACL,QAAQ,EAAE,QAAmC;QAC7C,SAAS;QACT,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC;AACJ,CAAC,CAAC;AA1BW,QAAA,mDAAmD,uDA0B9D"}