declastruct 1.0.0 → 1.1.0

package/dist/logic/commands/command.apply.js

@@ -1,77 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyChanges = void 0;
-/* eslint-disable @typescript-eslint/no-loop-func */
-const number_fns_1 = require("@ehmpathy/number-fns");
-const chalk_1 = __importDefault(require("chalk"));
-const ora_1 = __importDefault(require("ora"));
-const DeclastructChangeProposal_1 = require("../../domain/DeclastructChangeProposal");
-const executeProposal_1 = require("../actions/execute/executeProposal");
-const getColoredProposalTitle_1 = require("../actions/propose/getColoredProposalTitle");
-/**
- * applies the planned actions required to update the remote state to match the declared state
- */
-const applyChanges = async ({ proposals, }, context) => {
-    console.log(chalk_1.default.bold(chalk_1.default.white(`🦾 applying...`)));
-    // apply each plan, in parallel, up to max concurrency
-    for (const proposal of proposals) {
-        await (async () => {
-            // if no change, dont even mention it
-            if (proposal.action === DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING)
-                return;
-            // if cant apply, notify we're skipping
-            const canApply = [
-                DeclastructChangeProposal_1.DeclastructChangeProposalAction.CREATE,
-                DeclastructChangeProposal_1.DeclastructChangeProposalAction.UPDATE, // TODO: re-enable updates once we fix the permadiffs on the resources (also, add an easy way for users to say 'only create')
-            ].includes(proposal.action);
-            if (!canApply) {
-                console.log(`  ${chalk_1.default.bold(chalk_1.default.yellow('↓'))} ${(0, getColoredProposalTitle_1.getColoredProposalTitle)({
-                    proposal,
-                })}`); // tslint:disable-line no-console
-                return;
-            }
-            // if can apply, then try to apply
-            const spinner = (0, ora_1.default)({
-                text: `${(0, getColoredProposalTitle_1.getColoredProposalTitle)({
-                    proposal,
-                })}`,
-                indent: 2,
-            }).start();
-            const startTimeInMilliseconds = new Date().getTime();
-            const getDurationInSeconds = () => {
-                const endTimeInMilliseconds = new Date().getTime();
-                const durationInMilliseconds = endTimeInMilliseconds - startTimeInMilliseconds;
-                const durationInSeconds = (0, number_fns_1.roundToHundredths)(durationInMilliseconds / 1e3);
-                return durationInSeconds;
-            };
-            const interval = setInterval(() => {
-                spinner.text = `${(0, getColoredProposalTitle_1.getColoredProposalTitle)({
-                    proposal,
-                })} at ${getDurationInSeconds()} sec`;
-            }, 1000);
-            try {
-                await (0, executeProposal_1.executeProposal)({ proposal }, context);
-                await spinner.stopAndPersist({
-                    symbol: chalk_1.default.bold(chalk_1.default.green('✔')),
-                    text: `${(0, getColoredProposalTitle_1.getColoredProposalTitle)({
-                        proposal,
-                    })} ${chalk_1.default.gray(`took ${getDurationInSeconds()} sec`)}`,
-                });
-            }
-            catch (error) {
-                await spinner.stopAndPersist({
-                    symbol: chalk_1.default.bold(chalk_1.default.red('x')),
-                });
-                throw error;
-            }
-            finally {
-                clearInterval(interval);
-            }
-        })();
-    }
-};
-exports.applyChanges = applyChanges;
-//# sourceMappingURL=command.apply.js.map

package/dist/logic/commands/command.apply.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"command.apply.js","sourceRoot":"","sources":["../../../src/logic/commands/command.apply.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAoD;AACpD,qDAAyD;AACzD,kDAA0B;AAC1B,8CAAsB;AAEtB,sFAGgD;AAEhD,wEAAqE;AACrE,wFAAqF;AAErF;;GAEG;AACI,MAAM,YAAY,GAAG,KAAK,EAC/B,EACE,SAAS,GAGV,EACD,OAA2B,EACZ,EAAE;IACjB,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEvD,sDAAsD;IACtD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,KAAK,IAAI,EAAE;YAChB,qCAAqC;YACrC,IAAI,QAAQ,CAAC,MAAM,KAAK,2DAA+B,CAAC,UAAU;gBAChE,OAAO;YAET,uCAAuC;YACvC,MAAM,QAAQ,GAAG;gBACf,2DAA+B,CAAC,MAAM;gBACtC,2DAA+B,CAAC,MAAM,EAAE,6HAA6H;aACtK,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5B,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAO,CAAC,GAAG,CACT,KAAK,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,IAAA,iDAAuB,EAAC;oBAC5D,QAAQ;iBACT,CAAC,EAAE,CACL,CAAC,CAAC,iCAAiC;gBACpC,OAAO;YACT,CAAC;YAED,kCAAkC;YAClC,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC;gBAClB,IAAI,EAAE,GAAG,IAAA,iDAAuB,EAAC;oBAC/B,QAAQ;iBACT,CAAC,EAAE;gBACJ,MAAM,EAAE,CAAC;aACV,CAAC,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,uBAAuB,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACrD,MAAM,oBAAoB,GAAG,GAAG,EAAE;gBAChC,MAAM,qBAAqB,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACnD,MAAM,sBAAsB,GAC1B,qBAAqB,GAAG,uBAAuB,CAAC;gBAClD,MAAM,iBAAiB,GAAG,IAAA,8BAAiB,EACzC,sBAAsB,GAAG,GAAG,CAC7B,CAAC;gBACF,OAAO,iBAAiB,CAAC;YAC3B,CAAC,CAAC;YACF,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;gBAChC,OAAO,CAAC,IAAI,GAAG,GAAG,IAAA,iDAAuB,EAAC;oBACxC,QAAQ;iBACT,CAAC,OAAO,oBAAoB,EAAE,MAAM,CAAC;YACxC,CAAC,EAAE,IAAI,CAAC,CAAC;YACT,IAAI,CAAC;gBACH,MAAM,IAAA,iCAAe,EAAC,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;gBAC7C,MAAM,OAAO,CAAC,cAAc,CAAC;oBAC3B,MAAM,EAAE,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACpC,IAAI,EAAE,GAAG,IAAA,iDAAuB,EAAC;wBAC/B,QAAQ;qBACT,CAAC,IAAI,eAAK,CAAC,IAAI,CAAC,QAAQ,oBAAoB,EAAE,MAAM,CAAC,EAAE;iBACzD,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,MAAM,OAAO,CAAC,cAAc,CAAC;oBAC3B,MAAM,EAAE,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;iBACnC,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;YACd,CAAC;oBAAS,CAAC;gBACT,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC;AACH,CAAC,CAAC;AAvEW,QAAA,YAAY,gBAuEvB"}

package/dist/logic/commands/command.plan.d.ts

@@ -1,13 +0,0 @@
-import { VisualogicContext } from 'visualogic';
-import { DeclaredResource } from '../../domain/DeclaredResource';
-import { DeclastructChangeProposal } from '../../domain/DeclastructChangeProposal';
-import { DeclastructContext } from '../../domain/DeclastructContext';
-/**
- * shows
- * - the differences between the remote state and declared state
- * - the actions proposed to update the remote state to match the declared state // TODO
- */
-export declare const planChanges: ({ resources, inFullDetail, }: {
-    resources: DeclaredResource[];
-    inFullDetail: boolean;
-}, context: DeclastructContext & VisualogicContext) => Promise<DeclastructChangeProposal<DeclaredResource>[]>;

package/dist/logic/commands/command.plan.js

@@ -1,155 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.planChanges = void 0;
-const number_fns_1 = require("@ehmpathy/number-fns");
-const bottleneck_1 = __importDefault(require("bottleneck"));
-const chalk_1 = __importDefault(require("chalk"));
-const indent_string_1 = __importDefault(require("indent-string"));
-const ora_1 = __importDefault(require("ora"));
-const type_fns_1 = require("type-fns");
-const DeclastructChangeProposal_1 = require("../../domain/DeclastructChangeProposal");
-const getColoredActionToken_1 = require("../actions/propose/getColoredActionToken");
-const getColoredProposalTitle_1 = require("../actions/propose/getColoredProposalTitle");
-const proposeChangeForResource_1 = require("../actions/propose/proposeChangeForResource");
-const bottleneck = new bottleneck_1.default({ maxConcurrent: 1 });
-const countTimesActionRequired = ({ proposals, action, }) => proposals
-    .filter((proposal) => proposal.action === action)
-    .reduce((summary, thisProposal) => {
-    const currentTotal = summary.total;
-    const currentCountPerThisResource = summary.perResource[thisProposal.forResourceClassName] ?? 0;
-    return {
-        total: currentTotal + 1,
-        perResource: {
-            ...summary.perResource,
-            [thisProposal.forResourceClassName]: currentCountPerThisResource + 1,
-        },
-    };
-}, {
-    total: 0,
-    perResource: {},
-});
-/**
- * shows
- * - the differences between the remote state and declared state
- * - the actions proposed to update the remote state to match the declared state // TODO
- */
-const planChanges = async ({ resources, inFullDetail, }, context) => {
-    console.log(chalk_1.default.bold(chalk_1.default.white(`🔬 planning...`)));
-    const startTimeInMillisecondsCumulative = new Date().getTime();
-    const proposals = await Promise.all(
-    // TODO: dedupe ora spinner + timer between plan and apply
-    resources.map(async (resource, index) => bottleneck.schedule(async () => {
-        if (index > 0 && index % 100 == 0)
-            console.log(`${chalk_1.default.bold(chalk_1.default.gray('[PLANNING]'))} at resource ${index}/${resources.length}\n`);
-        const actionTitle = `${chalk_1.default.bold(chalk_1.default.gray('[PLANNING]'))} ${chalk_1.default.bold(resource.constructor.name)}`;
-        let spinner = null;
-        const startTimeInMilliseconds = new Date().getTime();
-        const getDurationInSeconds = () => {
-            const endTimeInMilliseconds = new Date().getTime();
-            const durationInMilliseconds = endTimeInMilliseconds - startTimeInMilliseconds;
-            const durationInSeconds = (0, number_fns_1.roundToHundredths)(durationInMilliseconds / 1e3);
-            return durationInSeconds;
-        };
-        const interval = setInterval(() => {
-            if (!spinner)
-                spinner = (0, ora_1.default)({
-                    text: actionTitle,
-                    indent: 2,
-                }).start(); // start after first interval timeout passes, so that instaplans dont noise up the output
-            spinner.text = `${actionTitle} at ${getDurationInSeconds()} sec`;
-        }, 100);
-        try {
-            const proposal = await (0, proposeChangeForResource_1.proposeChangeForResource)({ resource }, context);
-            await spinner?.stopAndPersist({
-                symbol: chalk_1.default.bold(chalk_1.default.green('✔')),
-                text: `${actionTitle} ${chalk_1.default.gray(`took ${getDurationInSeconds()} sec`)}`,
-            });
-            return proposal;
-        }
-        catch (error) {
-            await spinner?.stopAndPersist({
-                symbol: chalk_1.default.bold(chalk_1.default.red('x')),
-            });
-            throw error;
-        }
-        finally {
-            // console.log(`fin at ${getDurationInSeconds()} sec`);
-            clearInterval(interval); // note: this will prevent any plans that took less than a second from appearing ever w/ spinner
-        }
-    })));
-    const endTimeInMillisecondsCumulative = new Date().getTime();
-    const durationInMillisecondsCumulative = endTimeInMillisecondsCumulative - startTimeInMillisecondsCumulative;
-    const durationInSecondsCumulative = (0, number_fns_1.roundToHundredths)(durationInMillisecondsCumulative / 1e3);
-    console.log(`${chalk_1.default.bold(chalk_1.default.gray('[PLANNING]'))} took ${durationInSecondsCumulative} sec total\n`);
-    // if full detail was requested, enumerate each change
-    let output = [];
-    if (inFullDetail) {
-        // filter out nochange plans
-        const proposalsWithChange = proposals.filter((proposal) => proposal.action !== DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING);
-        if (!proposalsWithChange.length) {
-            console.log(`\n${chalk_1.default.bold('Everything is up to date 🎉')}. No changes proposed.`);
-            return proposals; // exit here if no changes proposed
-        }
-        // define plans output
-        output = proposalsWithChange // skip plans that have no change
-            .map((proposal) => {
-            // define plan header
-            const header = `  * ${(0, getColoredProposalTitle_1.getColoredProposalTitle)({ proposal })}`;
-            // define the diff
-            const diff = proposal.difference
-                ? `\n${(0, indent_string_1.default)(proposal.difference, 6)}\n`
-                : '';
-            // append to output
-            return header + diff;
-        });
-    }
-    // define the plans summary
-    const stats = {
-        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING]: countTimesActionRequired({
-            proposals,
-            action: DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING,
-        }),
-        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.CREATE]: countTimesActionRequired({
-            proposals,
-            action: DeclastructChangeProposal_1.DeclastructChangeProposalAction.CREATE,
-        }),
-        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.UPDATE]: countTimesActionRequired({
-            proposals,
-            action: DeclastructChangeProposal_1.DeclastructChangeProposalAction.UPDATE,
-        }),
-        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.REPLACE]: countTimesActionRequired({
-            proposals,
-            action: DeclastructChangeProposal_1.DeclastructChangeProposalAction.REPLACE,
-        }),
-        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.DESTROY]: countTimesActionRequired({
-            proposals,
-            action: DeclastructChangeProposal_1.DeclastructChangeProposalAction.DESTROY,
-        }),
-    };
-    const statsToSummaryRows = Object.entries(stats)
-        .filter((entry) => entry[1].total > 0)
-        .map(([action, counts]) => [
-        `  * ${(0, getColoredActionToken_1.getColoredActionToken)({
-            action: action,
-        })} ${counts.total}`,
-        // display counts per resource for all actions except "no change"
-        ...(action === DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING
-            ? []
-            : Object.entries(counts.perResource).map(([resourceName, resourceCount]) => `    * ${resourceCount} ${resourceName}`)),
-    ].join('\n'));
-    const statsOutput = [
-        inFullDetail ? chalk_1.default.bold(chalk_1.default.white('👀 summary...')) : undefined,
-        ...statsToSummaryRows,
-    ]
-        .filter(type_fns_1.isPresent)
-        .join('\n');
-    // display the output in one statement to make it easier on testing
-    console.log([...output, statsOutput, ''].join('\n')); // tslint:disable-line no-console
-    // and return the proposals
-    return proposals;
-};
-exports.planChanges = planChanges;
-//# sourceMappingURL=command.plan.js.map

package/dist/logic/commands/command.plan.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"command.plan.js","sourceRoot":"","sources":["../../../src/logic/commands/command.plan.ts"],"names":[],"mappings":";;;;;;AAAA,qDAAyD;AACzD,4DAAoC;AACpC,kDAA0B;AAC1B,kEAAyC;AACzC,8CAAsB;AACtB,uCAAqC;AAIrC,sFAGgD;AAEhD,oFAAiF;AACjF,wFAAqF;AACrF,0FAAuF;AAEvF,MAAM,UAAU,GAAG,IAAI,oBAAU,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC,CAAC;AAQxD,MAAM,wBAAwB,GAAG,CAAC,EAChC,SAAS,EACT,MAAM,GAIP,EAAE,EAAE,CACH,SAAS;KACN,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC;KAChD,MAAM,CACL,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE;IACxB,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;IACnC,MAAM,2BAA2B,GAC/B,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAC9D,OAAO;QACL,KAAK,EAAE,YAAY,GAAG,CAAC;QACvB,WAAW,EAAE;YACX,GAAG,OAAO,CAAC,WAAW;YACtB,CAAC,YAAY,CAAC,oBAAoB,CAAC,EACjC,2BAA2B,GAAG,CAAC;SAClC;KACF,CAAC;AACJ,CAAC,EACD;IACE,KAAK,EAAE,CAAC;IACR,WAAW,EAAE,EAAE;CACiC,CACnD,CAAC;AAEN;;;;GAIG;AACI,MAAM,WAAW,GAAG,KAAK,EAC9B,EACE,SAAS,EACT,YAAY,GAIb,EACD,OAA+C,EACS,EAAE;IAC1D,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,iCAAiC,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAC/D,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG;IACjC,0DAA0D;IAC1D,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,CACtC,UAAU,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;QAC7B,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,IAAI,CAAC;YAC/B,OAAO,CAAC,GAAG,CACT,GAAG,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,gBAAgB,KAAK,IAC1D,SAAS,CAAC,MACZ,IAAI,CACL,CAAC;QACJ,MAAM,WAAW,GAAG,GAAG,eAAK,CAAC,IAAI,CAC/B,eAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CACzB,IAAI,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,IAAI,OAAO,GAAmB,IAAsB,CAAC;QACrD,MAAM,uBAAuB,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACrD,MAAM,oBAAoB,GAAG,GAAG,EAAE;YAChC,MAAM,qBAAqB,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACnD,MAAM,sBAAsB,GAC1B,qBAAqB,GAAG,uBAAuB,CAAC;YAClD,MAAM,iBAAiB,GAAG,IAAA,8BAAiB,EACzC,sBAAsB,GAAG,GAAG,CAC7B,CAAC;YACF,OAAO,iBAAiB,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YAChC,IAAI,CAAC,OAAO;gBACV,OAAO,GAAG,IAAA,aAAG,EAAC;oBACZ,IAAI,EAAE,WAAW;oBACjB,MAAM,EAAE,CAAC;iBACV,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,yFAAyF;YACvG,OAAO,CAAC,IAAI,GAAG,GAAG,WAAW,OAAO,oBAAoB,EAAE,MAAM,CAAC;QACnE,CAAC,EAAE,GAAG,CAAC,CAAC;QACR,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAA,mDAAwB,EAC7C,EAAE,QAAQ,EAAE,EACZ,OAAO,CACR,CAAC;YACF,MAAM,OAAO,EAAE,cAAc,CAAC;gBAC5B,MAAM,EAAE,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpC,IAAI,EAAE,GAAG,WAAW,IAAI,eAAK,CAAC,IAAI,CAChC,QAAQ,oBAAoB,EAAE,MAAM,CACrC,EAAE;aACJ,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,OAAO,EAAE,cAAc,CAAC;gBAC5B,MAAM,EAAE,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aACnC,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,uDAAuD;YACvD,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,gGAAgG;QAC3H,CAAC;IACH,CAAC,CAAC,CACH,CACF,CAAC;IACF,MAAM,+BAA+B,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAC7D,MAAM,gCAAgC,GACpC,+BAA+B,GAAG,iCAAiC,CAAC;IACtE,MAAM,2BAA2B,GAAG,IAAA,8BAAiB,EACnD,gCAAgC,GAAG,GAAG,CACvC,CAAC;IACF,OAAO,CAAC,GAAG,CACT,GAAG,eAAK,CAAC,IAAI,CACX,eAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CACzB,SAAS,2BAA2B,cAAc,CACpD,CAAC;IAEF,sDAAsD;IACtD,IAAI,MAAM,GAAa,EAAE,CAAC;IAC1B,IAAI,YAAY,EAAE,CAAC;QACjB,4BAA4B;QAC5B,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAC1C,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,MAAM,KAAK,2DAA+B,CAAC,UAAU,CACjE,CAAC;QACF,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC;YAChC,OAAO,CAAC,GAAG,CACT,KAAK,eAAK,CAAC,IAAI,CAAC,6BAA6B,CAAC,wBAAwB,CACvE,CAAC;YACF,OAAO,SAAS,CAAC,CAAC,mCAAmC;QACvD,CAAC;QAED,sBAAsB;QACtB,MAAM,GAAG,mBAAmB,CAAC,iCAAiC;aAC3D,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,qBAAqB;YACrB,MAAM,MAAM,GAAG,OAAO,IAAA,iDAAuB,EAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;YAE9D,kBAAkB;YAClB,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU;gBAC9B,CAAC,CAAC,KAAK,IAAA,uBAAY,EAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI;gBAC/C,CAAC,CAAC,EAAE,CAAC;YAEP,mBAAmB;YACnB,OAAO,MAAM,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,2BAA2B;IAC3B,MAAM,KAAK,GAAiB;QAC1B,CAAC,2DAA+B,CAAC,UAAU,CAAC,EAAE,wBAAwB,CAAC;YACrE,SAAS;YACT,MAAM,EAAE,2DAA+B,CAAC,UAAU;SACnD,CAAC;QACF,CAAC,2DAA+B,CAAC,MAAM,CAAC,EAAE,wBAAwB,CAAC;YACjE,SAAS;YACT,MAAM,EAAE,2DAA+B,CAAC,MAAM;SAC/C,CAAC;QACF,CAAC,2DAA+B,CAAC,MAAM,CAAC,EAAE,wBAAwB,CAAC;YACjE,SAAS;YACT,MAAM,EAAE,2DAA+B,CAAC,MAAM;SAC/C,CAAC;QACF,CAAC,2DAA+B,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC;YAClE,SAAS;YACT,MAAM,EAAE,2DAA+B,CAAC,OAAO;SAChD,CAAC;QACF,CAAC,2DAA+B,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC;YAClE,SAAS;YACT,MAAM,EAAE,2DAA+B,CAAC,OAAO;SAChD,CAAC;KACH,CAAC;IACF,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SAC7C,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;SACrC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CACxB;QACE,OAAO,IAAA,6CAAqB,EAAC;YAC3B,MAAM,EAAE,MAAyC;SAClD,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE;QAEpB,iEAAiE;QACjE,GAAG,CAAC,MAAM,KAAK,2DAA+B,CAAC,UAAU;YACvD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CACpC,CAAC,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,EAAE,CAChC,SAAS,aAAa,IAAI,YAAY,EAAE,CAC3C,CAAC;KACP,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;IACJ,MAAM,WAAW,GAAG;QAClB,YAAY,CAAC,CAAC,CAAC,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACnE,GAAG,kBAAkB;KACtB;SACE,MAAM,CAAC,oBAAS,CAAC;SACjB,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,mEAAmE;IACnE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,iCAAiC;IAEvF,2BAA2B;IAC3B,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAnKW,QAAA,WAAW,eAmKtB"}

package/dist/logic/commands/execute.d.ts

@@ -1,15 +0,0 @@
-import { VisualogicContext } from 'visualogic';
-import { DeclaredResource } from '../../domain/DeclaredResource';
-import { DeclastructProvider } from '../../domain/DeclastructProvider';
-export declare enum DeclastructCommandOption {
-    PLAN = "PLAN",
-    APPLY = "APPLY"
-}
-/**
- * a utility for safely executing a command
- */
-export declare const executeCommand: ({ option, resources, providers, }: {
-    option: DeclastructCommandOption;
-    resources: DeclaredResource[];
-    providers: DeclastructProvider<any>[];
-}, { log }: VisualogicContext) => Promise<void>;

package/dist/logic/commands/execute.js

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeCommand = exports.DeclastructCommandOption = void 0;
-const error_fns_1 = require("@ehmpathy/error-fns");
-const chalk_1 = __importDefault(require("chalk"));
-const createDeclastructContext_1 = require("../tools/context/createDeclastructContext");
-const destroyDeclastructContext_1 = require("../tools/context/destroyDeclastructContext");
-const command_apply_1 = require("./command.apply");
-const command_plan_1 = require("./command.plan");
-var DeclastructCommandOption;
-(function (DeclastructCommandOption) {
-    DeclastructCommandOption["PLAN"] = "PLAN";
-    DeclastructCommandOption["APPLY"] = "APPLY";
-})(DeclastructCommandOption || (exports.DeclastructCommandOption = DeclastructCommandOption = {}));
-/**
- * a utility for safely executing a command
- */
-const executeCommand = async ({ option, resources, providers, }, { log }) => {
-    // create the context
-    console.log(`🔑 ${chalk_1.default.bold(chalk_1.default.white('initializing...'))} ${chalk_1.default.gray(`(${providers.length} providers, ${resources.length} resources)`)}`);
-    console.log('');
-    const context = await (0, createDeclastructContext_1.createDeclastructContext)({ providers, resources, log });
-    // execute the command safely
-    let hadError = false;
-    try {
-        // handle the plan command
-        if (option === DeclastructCommandOption.PLAN) {
-            await (0, command_plan_1.planChanges)({ resources, inFullDetail: true }, context);
-            return;
-        }
-        // handle the apply command
-        if (option === DeclastructCommandOption.APPLY) {
-            const proposals = await (0, command_plan_1.planChanges)({ resources, inFullDetail: false }, context);
-            await (0, command_apply_1.applyChanges)({ proposals }, context);
-            return;
-        }
-        // throw on unexpected
-        throw new error_fns_1.UnexpectedCodePathError('unsupported option was selected', {
-            option,
-        });
-    }
-    catch (error) {
-        // track that there was an error
-        hadError = true;
-        // log the error
-        console.error(error);
-        // and pass it on up
-        throw error;
-    }
-    finally {
-        console.log(`🧹 cleaning up...`);
-        await (0, destroyDeclastructContext_1.destroyDeclastructContext)({ context }); // todo: actually destroy when can destroy only the instantiated providers (not the preinstantiated ones)
-        if (hadError)
-            console.log(`\n🚨 experienced an error\n`);
-        else
-            console.log(`🎉 done!`);
-    }
-};
-exports.executeCommand = executeCommand;
-//# sourceMappingURL=execute.js.map

package/dist/logic/commands/execute.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"execute.js","sourceRoot":"","sources":["../../../src/logic/commands/execute.ts"],"names":[],"mappings":";;;;;;AAAA,mDAA8D;AAC9D,kDAA0B;AAK1B,wFAAqF;AACrF,0FAAuF;AACvF,mDAA+C;AAC/C,iDAA6C;AAE7C,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,2CAAe,CAAA;AACjB,CAAC,EAHW,wBAAwB,wCAAxB,wBAAwB,QAGnC;AAED;;GAEG;AACI,MAAM,cAAc,GAAG,KAAK,EACjC,EACE,MAAM,EACN,SAAS,EACT,SAAS,GAKV,EACD,EAAE,GAAG,EAAqB,EACX,EAAE;IACjB,qBAAqB;IACrB,OAAO,CAAC,GAAG,CACT,MAAM,eAAK,CAAC,IAAI,CAAC,eAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,IAAI,eAAK,CAAC,IAAI,CAC5D,IAAI,SAAS,CAAC,MAAM,eAAe,SAAS,CAAC,MAAM,aAAa,CACjE,EAAE,CACJ,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,MAAM,OAAO,GAAG,MAAM,IAAA,mDAAwB,EAAC,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;IAE9E,6BAA6B;IAC7B,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,CAAC;QACH,0BAA0B;QAC1B,IAAI,MAAM,KAAK,wBAAwB,CAAC,IAAI,EAAE,CAAC;YAC7C,MAAM,IAAA,0BAAW,EAAC,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,2BAA2B;QAC3B,IAAI,MAAM,KAAK,wBAAwB,CAAC,KAAK,EAAE,CAAC;YAC9C,MAAM,SAAS,GAAG,MAAM,IAAA,0BAAW,EACjC,EAAE,SAAS,EAAE,YAAY,EAAE,KAAK,EAAE,EAClC,OAAO,CACR,CAAC;YACF,MAAM,IAAA,4BAAY,EAAC,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;YAC3C,OAAO;QACT,CAAC;QAED,sBAAsB;QACtB,MAAM,IAAI,mCAAuB,CAAC,iCAAiC,EAAE;YACnE,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,gCAAgC;QAChC,QAAQ,GAAG,IAAI,CAAC;QAEhB,gBAAgB;QAChB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAErB,oBAAoB;QACpB,MAAM,KAAK,CAAC;IACd,CAAC;YAAS,CAAC;QACT,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACjC,MAAM,IAAA,qDAAyB,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,yGAAyG;QACvJ,IAAI,QAAQ;YAAE,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;;YACpD,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC,CAAC;AA3DW,QAAA,cAAc,kBA2DzB"}

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

@@ -1,16 +0,0 @@
-import { VisualogicContext } from 'visualogic';
-import { DeclaredResourceReference } from '../../../domain/DeclaredResourceReference';
-import { DeclastructContext } from '../../../domain/DeclastructContext';
-/**
- * create a string representation of the reference which can be easily and intuitively understood
- *
- * example
- * - name:'default',campaign.name:'abcd',campaign.account.name:'xyz'
- *
- * relevance
- * - references, especially unique references, are difficult to read (lots of nesting and metadata; lots of noise)
- * - we need to be able to display a succinct, easy to read, high signal string for a reference to display in diffs
- */
-export declare const castReferenceToGrokableString: ({ reference, }: {
-    reference: DeclaredResourceReference<any, any, any>;
-}, context: DeclastructContext & VisualogicContext) => Promise<string>;

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

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.castReferenceToGrokableString = void 0;
-const domain_objects_1 = require("domain-objects");
-const flattie_1 = require("flattie");
-const simple_in_memory_cache_1 = require("simple-in-memory-cache");
-const type_fns_1 = require("type-fns");
-const with_simple_caching_1 = require("with-simple-caching");
-const resolveReferenceToCommonComparableForm_1 = require("./resolveReferenceToCommonComparableForm");
-/**
- * create a string representation of the reference which can be easily and intuitively understood
- *
- * example
- * - name:'default',campaign.name:'abcd',campaign.account.name:'xyz'
- *
- * relevance
- * - references, especially unique references, are difficult to read (lots of nesting and metadata; lots of noise)
- * - we need to be able to display a succinct, easy to read, high signal string for a reference to display in diffs
- */
-exports.castReferenceToGrokableString = (0, with_simple_caching_1.withSimpleCaching)(async ({ reference, }, context) => {
-    // resolve the reference to common-comparable-form, which will resolve all of references into unique keys
-    const comparableReference = await (0, resolveReferenceToCommonComparableForm_1.resolveReferenceToCommonComparableForm)({ reference }, context);
-    // now, flatten the reference object (i.e., `{ campaign: { account: { name: 'name' } } }` => `{ campaign.account.name: 'name' }`)
-    const flat = (0, flattie_1.flattie)(comparableReference);
-    // now, remove the noise from the keys
-    const highSignalFlat = Object.fromEntries(Object.entries(flat)
-        .map(([key, value]) => {
-        // if the key ends with a metadata attribute, skip it
-        if (key.includes('referenceOf'))
-            return null;
-        if (key.includes('identifiedBy.key'))
-            return null;
-        // otherwise, strip out the metadata parts in the key
-        const highSignalKey = key.replace(/identifiedBy.value./g, '');
-        // and return the new key value pair
-        return [highSignalKey, value];
-    })
-        .filter(type_fns_1.isPresent) // skip the nulls
-        .sort((a, b) => {
-        // count how many layers away the value is from the root object for each of these keys
-        const layersAwayA = a[0].split('.').length;
-        const layersAwayB = b[0].split('.').length;
-        // sort the keys that are "closer" to the root object first (i.e., things that describe the object directly should go before things that describe a nested reference; that way, the most specific, and least likely to repeat across different resources, attribute is first)
-        return layersAwayA < layersAwayB ? -1 : 1;
-    }));
-    // now, convert that high signal flat object into a string
-    const grokableString = [
-        reference.referenceOf, // prefixed by what its referencing
-        ...Object.entries(highSignalFlat).map(([key, value]) => [
-            key,
-            JSON.stringify(value)
-                .replace(/'/g, "\\'")
-                .replace(/^"/g, "'")
-                .replace(/"$/g, "'"), // replace the surrounding `"` with `'` for better display in the console (since in console the string is typically already shown inside of `"`, so we get a lot of `\"` otherwise)
-        ].join(':')),
-    ].join('.');
-    return grokableString;
-}, {
-    cache: (0, simple_in_memory_cache_1.createCache)({
-        expiration: { seconds: 300 }, // todo: set this to "infinite", since grokable references are deterministic; they never change for a given input
-    }),
-    serialize: {
-        key: ({ forInput }) => (0, domain_objects_1.serialize)(forInput[0]), // omit context
-    },
-});
-//# sourceMappingURL=castReferenceToGrokableString.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"castReferenceToGrokableString.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/castReferenceToGrokableString.ts"],"names":[],"mappings":";;;AAAA,mDAA2C;AAC3C,qCAAkC;AAClC,mEAAqD;AACrD,uCAAqC;AAErC,6DAAwD;AAIxD,qGAAkG;AAElG;;;;;;;;;GASG;AACU,QAAA,6BAA6B,GAAG,IAAA,uCAAiB,EAC5D,KAAK,EACH,EACE,SAAS,GAGV,EACD,OAA+C,EAC/C,EAAE;IACF,yGAAyG;IACzG,MAAM,mBAAmB,GAAG,MAAM,IAAA,+EAAsC,EACtE,EAAE,SAAS,EAAE,EACb,OAAO,CACR,CAAC;IAEF,iIAAiI;IACjI,MAAM,IAAI,GAAG,IAAA,iBAAO,EAAC,mBAAmB,CAAC,CAAC;IAE1C,sCAAsC;IACtC,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CACvC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,qDAAqD;QACrD,IAAI,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC;YAAE,OAAO,IAAI,CAAC;QAC7C,IAAI,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAAE,OAAO,IAAI,CAAC;QAElD,qDAAqD;QACrD,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;QAE9D,oCAAoC;QACpC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC;SACD,MAAM,CAAC,oBAAS,CAAC,CAAC,iBAAiB;SACnC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACb,sFAAsF;QACtF,MAAM,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;QAC3C,MAAM,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;QAE3C,6QAA6Q;QAC7Q,OAAO,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,CACL,CAAC;IAEF,0DAA0D;IAC1D,MAAM,cAAc,GAAG;QACrB,SAAS,CAAC,WAAW,EAAE,mCAAmC;QAC1D,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACrD;YACE,GAAG;YACH,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;iBAClB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;iBACpB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;iBACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,mLAAmL;SAC5M,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ;KACF,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACZ,OAAO,cAAc,CAAC;AACxB,CAAC,EACD;IACE,KAAK,EAAE,IAAA,oCAAW,EAAC;QACjB,UAAU,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,iHAAiH;KAChJ,CAAC;IACF,SAAS,EAAE;QACT,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,IAAA,0BAAS,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,eAAe;KAC/D;CACF,CACF,CAAC"}

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

@@ -1,111 +0,0 @@
-"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 castReferenceToGrokableString_1 = require("./castReferenceToGrokableString");
-const { exampleContext, exampleMachine, CNCMachine, exampleRegistration, CNCMachineRegistration, } = (0, getExampleContext_1.getExampleContext)();
-describe('castReferenceToGrokableString', () => {
-    describe('shallow', () => {
-        it('should be able to cast a shallow unique key reference to grokable string', async () => {
-            const reference = (0, __1.buildRef)(CNCMachine, {
-                serialNumber: exampleMachine.serialNumber,
-            });
-            const string = await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference }, exampleContext);
-            console.log(string);
-            expect(string).toEqual(`CNCMachine.serialNumber:'821'`);
-        });
-    });
-    describe('nested', () => {
-        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 = ['address'];
-        Spaceport.updatable = ['spaceships'];
-        Spaceport.nested = {
-            address: Address,
-            spaceships: DeclaredResourceReference_1.DeclaredResourceReference,
-        };
-        class HumanAgent extends domain_objects_1.DomainEntity {
-        }
-        HumanAgent.primary = ['uuid'];
-        HumanAgent.unique = ['birthCode'];
-        class Captain extends domain_objects_1.DomainEntity {
-        }
-        Captain.primary = ['uuid'];
-        Captain.unique = ['agent', 'ship'];
-        Captain.nested = {
-            agent: DeclaredResourceReference_1.DeclaredResourceReference,
-            ship: DeclaredResourceReference_1.DeclaredResourceReference,
-        };
-        it('should be able to cast a unique key based on referenced entities to a grokable string', async () => {
-            // instantiate them
-            const ship = new Spaceship({
-                serialNumber: '__SHIP_A__',
-                fuelQuantity: 9001,
-                passengers: 21,
-            });
-            const bob = new HumanAgent({
-                birthCode: '821',
-                name: 'Bobby Tables', // https://xkcd.com/327/
-            });
-            const captain = new Captain({
-                agent: (0, __1.getRef)(bob),
-                ship: (0, __1.getRef)(ship),
-            });
-            const string = await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference: (0, __1.getRef)(captain) }, exampleContext);
-            expect(string).toEqual(`Captain.agent.birthCode:'821'.ship.serialNumber:'__SHIP_A__'`);
-        });
-        it('should be able to cast a unique key based on valueobject to a grokable string', async () => {
-            // instantiate them
-            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 string = await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference: (0, __1.getRef)(spaceport) }, exampleContext);
-            expect(string).toEqual(`Spaceport.address.galaxy:'Milky Way'.address.solarSystem:'Sun'.address.planet:'Earth'.address.continent:'North America'`);
-        });
-        it('should be able to get a grokable string for a primary key reference to a multi-layer nested unique key resource', async () => {
-            const primaryKeyRef = (0, __1.buildRef)(CNCMachineRegistration, {
-                uuid: exampleRegistration.uuid,
-            });
-            const string = await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference: primaryKeyRef }, exampleContext);
-            expect(string).toEqual(`CNCMachineRegistration.machine.serialNumber:'821'`);
-        });
-        it('should be able to get a grokable string for a unique key reference w/ a nested primary key reference', async () => {
-            const uniqueKeyRef = (0, __1.buildRef)(CNCMachineRegistration, {
-                machine: (0, __1.buildRef)(CNCMachine, {
-                    uuid: exampleMachine.uuid,
-                }),
-            });
-            const string = await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference: uniqueKeyRef }, exampleContext);
-            expect(string).toEqual(`CNCMachineRegistration.machine.serialNumber:'821'`);
-        });
-    });
-});
-//# sourceMappingURL=castReferenceToGrokableString.test.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"castReferenceToGrokableString.test.js","sourceRoot":"","sources":["../../../../src/logic/tools/compare/castReferenceToGrokableString.test.ts"],"names":[],"mappings":";;AAAA,mDAA6D;AAE7D,gCAA4C;AAC5C,kFAIoD;AACpD,yFAAsF;AACtF,mFAAgF;AAEhF,MAAM,EACJ,cAAc,EACd,cAAc,EACd,UAAU,EACV,mBAAmB,EACnB,sBAAsB,GACvB,GAAG,IAAA,qCAAiB,GAAE,CAAC;AAExB,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,SAAS,GAAwB,IAAA,YAAQ,EAAC,UAAU,EAAE;gBAC1D,YAAY,EAAE,cAAc,CAAC,YAAY;aAC1C,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAA,6DAA6B,EAChD,EAAE,SAAS,EAAE,EACb,cAAc,CACf,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QAQtB,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,SAAS,CAAC,CAAC;QACrB,mBAAS,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3B,gBAAM,GAAG;YACrB,OAAO,EAAE,OAAO;YAChB,UAAU,EAAE,qDAAyB;SACtC,CAAC;QAOJ,MAAM,UAAW,SAAQ,6BAAwB;;QACjC,kBAAO,GAAG,CAAC,MAAM,CAAU,CAAC;QAC5B,iBAAM,GAAG,CAAC,WAAW,CAAC,CAAC;QAYvC,MAAM,OAAQ,SAAQ,6BAAqB;;QAC3B,eAAO,GAAG,CAAC,MAAM,CAAU,CAAC;QAC5B,cAAM,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC3B,cAAM,GAAG;YACrB,KAAK,EAAE,qDAAyB;YAChC,IAAI,EAAE,qDAAyB;SAChC,CAAC;QAGJ,EAAE,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;YACrG,mBAAmB;YACnB,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC;gBACzB,YAAY,EAAE,YAAY;gBAC1B,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,EAAE;aACf,CAAC,CAAC;YACH,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC;gBACzB,SAAS,EAAE,KAAK;gBAChB,IAAI,EAAE,cAAc,EAAE,wBAAwB;aAC/C,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;gBAC1B,KAAK,EAAE,IAAA,UAAM,EAAC,GAAG,CAAC;gBAClB,IAAI,EAAE,IAAA,UAAM,EAAC,IAAI,CAAC;aACnB,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAA,6DAA6B,EAChD,EAAE,SAAS,EAAE,IAAA,UAAM,EAAC,OAAO,CAAC,EAAE,EAC9B,cAAc,CACf,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CACpB,8DAA8D,CAC/D,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+EAA+E,EAAE,KAAK,IAAI,EAAE;YAC7F,mBAAmB;YACnB,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,MAAM,GAAG,MAAM,IAAA,6DAA6B,EAChD,EAAE,SAAS,EAAE,IAAA,UAAM,EAAC,SAAS,CAAC,EAAE,EAChC,cAAc,CACf,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CACpB,yHAAyH,CAC1H,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iHAAiH,EAAE,KAAK,IAAI,EAAE;YAC/H,MAAM,aAAa,GAAoC,IAAA,YAAQ,EAC7D,sBAAsB,EACtB;gBACE,IAAI,EAAE,mBAAmB,CAAC,IAAI;aAC/B,CACF,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,IAAA,6DAA6B,EAChD,EAAE,SAAS,EAAE,aAAa,EAAE,EAC5B,cAAc,CACf,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CACpB,mDAAmD,CACpD,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,sGAAsG,EAAE,KAAK,IAAI,EAAE;YACpH,MAAM,YAAY,GAAoC,IAAA,YAAQ,EAC5D,sBAAsB,EACtB;gBACE,OAAO,EAAE,IAAA,YAAQ,EAAC,UAAU,EAAE;oBAC5B,IAAI,EAAE,cAAc,CAAC,IAAI;iBAC1B,CAAC;aACH,CACF,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,IAAA,6DAA6B,EAChD,EAAE,SAAS,EAAE,YAAY,EAAE,EAC3B,cAAc,CACf,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CACpB,mDAAmD,CACpD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -1,11 +0,0 @@
-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

@@ -1,61 +0,0 @@
-"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