declastruct 1.0.0

package/dist/domain/DeclastructChangeProposal.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeclastructChangeProposal = exports.DeclastructChangeProposalAction = void 0;
+const domain_objects_1 = require("domain-objects");
+/**
+ * an action that can be proposed
+ */
+var DeclastructChangeProposalAction;
+(function (DeclastructChangeProposalAction) {
+    /**
+     * do nothing, the resource is already in the desired state
+     */
+    DeclastructChangeProposalAction["DO_NOTHING"] = "DO_NOTHING";
+    /**
+     * create a new resource
+     */
+    DeclastructChangeProposalAction["CREATE"] = "CREATE";
+    /**
+     * update an existing resource
+     */
+    DeclastructChangeProposalAction["UPDATE"] = "UPDATE";
+    /**
+     * destroy an existing resource
+     */
+    DeclastructChangeProposalAction["DESTROY"] = "DESTROY";
+    /**
+     * replace an existing resource
+     *
+     * note
+     * - this is a `delete` followed by a `create`
+     */
+    DeclastructChangeProposalAction["REPLACE"] = "REPLACE";
+})(DeclastructChangeProposalAction || (exports.DeclastructChangeProposalAction = DeclastructChangeProposalAction = {}));
+class DeclastructChangeProposal extends domain_objects_1.DomainObject {
+}
+exports.DeclastructChangeProposal = DeclastructChangeProposal;
+//# sourceMappingURL=DeclastructChangeProposal.js.map

package/dist/domain/DeclastructChangeProposal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclastructChangeProposal.js","sourceRoot":"","sources":["../../src/domain/DeclastructChangeProposal.ts"],"names":[],"mappings":";;;AAAA,mDAA8C;AAI9C;;GAEG;AACH,IAAY,+BA4BX;AA5BD,WAAY,+BAA+B;IACzC;;OAEG;IACH,4DAAyB,CAAA;IAEzB;;OAEG;IACH,oDAAiB,CAAA;IAEjB;;OAEG;IACH,oDAAiB,CAAA;IAEjB;;OAEG;IACH,sDAAmB,CAAA;IAEnB;;;;;OAKG;IACH,sDAAmB,CAAA;AACrB,CAAC,EA5BW,+BAA+B,+CAA/B,+BAA+B,QA4B1C;AAqCD,MAAa,yBACX,SAAQ,6BAA0C;CACR;AAF5C,8DAE4C"}

package/dist/domain/DeclastructContext.d.ts

@@ -0,0 +1,24 @@
+import type { LogMethods } from 'simple-leveled-log-methods';
+import { DeclaredResource } from './DeclaredResource';
+import { DeclastructProvider } from './DeclastructProvider';
+/**
+ * the declastruct context defines all of the providers and resources declared by the user
+ *
+ * note:
+ * - this is the global context available to declastruct methods
+ * - this is _not_ the provider context available to provider methods
+ */
+export interface DeclastructContext {
+    /**
+     * the providers loaded by the user
+     */
+    providers: DeclastructProvider<any>[];
+    /**
+     * all of the resources declared by the user
+     */
+    resources: DeclaredResource[];
+    /**
+     * the log context to use
+     */
+    log: LogMethods;
+}

package/dist/domain/DeclastructContext.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeclastructContext.js.map

package/dist/domain/DeclastructContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclastructContext.js","sourceRoot":"","sources":["../../src/domain/DeclastructContext.ts"],"names":[],"mappings":""}

package/dist/domain/DeclastructProvider.d.ts

@@ -0,0 +1,58 @@
+import type { LogMethods } from 'simple-leveled-log-methods';
+import { DeclaredResource } from './DeclaredResource';
+import { DeclastructProviderContext } from './DeclastructProviderContext';
+import { DeclastructProviderResourceRemoteStateInterface } from './DeclastructProviderResourceRemoteStateInterface';
+/**
+ * the class name of a declared resource
+ *
+ * note
+ * - it is just a string, but we distinguish it with its own type for clarity when defining other types
+ */
+export type DeclaredResourceClassName = string;
+/**
+ * agent options can take any shape
+ *
+ * typically, agent options include
+ * - credentials
+ * - caching mechanisms
+ * - request throttling mechanisms
+ */
+export type DeclastructProviderAgentOptions = {
+    log: LogMethods;
+};
+/**
+ * a provider exposes the agent, interfaces, and resource definitions required to declaratively manage resources
+ */
+export interface DeclastructProvider<AO extends DeclastructProviderAgentOptions> {
+    /**
+     * defines the options available to agents of this provider
+     *
+     * relevance
+     * - agents act on the behalf of the user to manage their resources
+     * - typically, agent options include
+     *   - credentials
+     *   - caching mechanisms
+     *   - request throttling mechanisms
+     */
+    agentOptions: AO;
+    /**
+     * defines the interfaces exposed by the provider for managing the remote state of resources
+     *
+     * note
+     * - specified as a "name" to "interface" lookup table, for convenient usage
+     */
+    interfaces: Record<DeclaredResourceClassName, DeclastructProviderResourceRemoteStateInterface<DeclaredResource, DeclastructProviderContext<AO>, keyof DeclaredResource, keyof DeclaredResource>>;
+    /**
+     * defines hooks that we should execute in conjunction with managing resources
+     */
+    hooks: {
+        /**
+         * a hook to run before any operations for this provider
+         */
+        beforeAll?: () => {};
+        /**
+         * a hook to run after all operations for this provider
+         */
+        afterAll?: () => {};
+    };
+}

package/dist/domain/DeclastructProvider.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeclastructProvider.js.map

package/dist/domain/DeclastructProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclastructProvider.js","sourceRoot":"","sources":["../../src/domain/DeclastructProvider.ts"],"names":[],"mappings":""}

package/dist/domain/DeclastructProviderContext.d.ts

@@ -0,0 +1,30 @@
+import type { LogMethods } from 'simple-leveled-log-methods';
+import { DeclaredResource } from './DeclaredResource';
+import { DeclastructProvider, DeclastructProviderAgentOptions } from './DeclastructProvider';
+/**
+ * defines the context in which declastruct is being run, accessible a provider
+ *
+ * specifically
+ * - the options that were inititialized for the provider
+ * - the resources that were defined for the provider
+ *
+ * note
+ * - we do not expose the full declastruct context to any provider for security
+ *   - i.e., ProviderA will never be able to see context related to ProviderB
+ *   - otherwise, MaliciousProvider may be able to access the credentials defined for CriticalProvider, and steal them
+ *   - therefore, only the information explicitly given by the user to ProviderA is accessible to ProviderA
+ */
+export interface DeclastructProviderContext<AO extends DeclastructProviderAgentOptions> {
+    /**
+     * the options instantiated for the provider itself
+     */
+    provider: DeclastructProvider<AO>;
+    /**
+     * the resources for this provider that were declared in this invocation
+     */
+    resources?: DeclaredResource[];
+    /**
+     * the log context to use
+     */
+    log: LogMethods;
+}

package/dist/domain/DeclastructProviderContext.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeclastructProviderContext.js.map

package/dist/domain/DeclastructProviderContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclastructProviderContext.js","sourceRoot":"","sources":["../../src/domain/DeclastructProviderContext.ts"],"names":[],"mappings":""}

package/dist/domain/DeclastructProviderResourceRemoteStateInterface.d.ts

@@ -0,0 +1,156 @@
+import { PickOne } from 'type-fns';
+import { DeclaredResource } from './DeclaredResource';
+import { DeclaredResourceClassName, DeclastructProviderAgentOptions } from './DeclastructProvider';
+import { DeclastructProviderContext } from './DeclastructProviderContext';
+/**
+ * an interface which enables the management of the remote state of a resource
+ * - capable of crud operations on the resource
+ * - conforms to a standard shape for interoperability
+ */
+export interface DeclastructProviderResourceRemoteStateInterface<
+/**
+ * the class of resource being managed by this dao
+ */
+R extends DeclaredResource, 
+/**
+ * the shape of options given to the agent of this resource's provider
+ */
+AO extends DeclastructProviderAgentOptions, 
+/**
+ * the names of the primary key attributes
+ */
+P extends keyof R, 
+/**
+ * the names of the unique key attributes
+ */
+U extends keyof R, 
+/**
+ * the shape of the resources search filter options
+ */
+F extends undefined | null | Record<string, any> = undefined, 
+/**
+ * the shape of the resources search sort options
+ */
+S extends undefined | Record<string, any | null> = undefined> {
+    /**
+     * the name of the resource this interface manages
+     */
+    for: DeclaredResourceClassName;
+    /**
+     * a method capable of finding the state of a resource of this class, by primary-key
+     */
+    findByPrimary: (
+    /**
+     * the primary key to lookup the resource by
+     */
+    primary: Required<Pick<R, P>>, 
+    /**
+     * the declastruct context available to interfaces of this provider
+     */
+    context: DeclastructProviderContext<AO>) => Promise<Required<R> | null>;
+    /**
+     * a method capable of finding the state of a resource of this class, by unique-key
+     */
+    findByUnique: (
+    /**
+     * the unique key to lookup the resource by
+     */
+    unique: Required<Pick<R, U>>, 
+    /**
+     * the declastruct context available to interfaces of this provider
+     */
+    context: DeclastructProviderContext<AO>) => Promise<Required<R> | null>;
+    /**
+     * a method capable of finding all instances of a resource of this class, by some filtering criteria
+     *
+     * note
+     * - may not be supported if search is not possible
+     */
+    findAll?: (
+    /**
+     * the criteria to search with
+     */
+    criteria: {
+        /**
+         * what to filter the results to list by
+         *
+         * note
+         * - if null is supported and specified, no filter will be applied
+         */
+        filter: F;
+        /**
+         * what to sort the results by
+         *
+         * note
+         * - this dictates the order of results
+         * - this dictates the offset key for pagination
+         *
+         * tip
+         * - if you're seeing "never" when trying to use this, please make sure you're using the instantiated type of the resource, not the generic type
+         */
+        sort: PickOne<{
+            /**
+             * descending sort
+             */
+            until: S;
+            /**
+             * ascending sort
+             */
+            since: S;
+        }>;
+        /**
+         * how many results to return
+         *
+         * note
+         * - combine this with the sort option to paginate results
+         */
+        limit: number;
+    }, 
+    /**
+     * the declastruct context available to interfaces of this provider
+     */
+    context: DeclastructProviderContext<AO>) => Promise<Required<R>[]>;
+    /**
+     * a method capable of creating a resource of this class
+     */
+    create: (
+    /**
+     * the state we want to create the resource with
+     */
+    resource: R, 
+    /**
+     * the declastruct context available to interfaces of this provider
+     */
+    context: DeclastructProviderContext<AO>) => Promise<Required<R>>;
+    /**
+     * a method capable of destroying a resource of this class
+     */
+    destroy: (
+    /**
+     * the primary key of the resource we want to destroy
+     */
+    primary: Required<Pick<R, P>>, 
+    /**
+     * the declastruct context available to interfaces of this provider
+     */
+    context: DeclastructProviderContext<AO>) => Promise<Required<R>>;
+    /**
+     * a method capable of creating a resource of this class
+     *
+     * note
+     * - may not be supported if resource is immutable
+     */
+    update?: (
+    /**
+     * the state we want to update the resource to
+     *
+     * note
+     * - either primary or unique key must be defined
+     * - any updatable keys defined will be persisted
+     */
+    resource: R, 
+    /**
+     * the declastruct context available to interfaces of this provider
+     */
+    context: DeclastructProviderContext<AO>) => Promise<Required<R>>;
+}

package/dist/domain/DeclastructProviderResourceRemoteStateInterface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeclastructProviderResourceRemoteStateInterface.js.map

package/dist/domain/DeclastructProviderResourceRemoteStateInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclastructProviderResourceRemoteStateInterface.js","sourceRoot":"","sources":["../../src/domain/DeclastructProviderResourceRemoteStateInterface.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './contract/sdk';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./contract/sdk"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B"}

package/dist/logic/actions/execute/canUpdateResource.d.ts

@@ -0,0 +1,5 @@
+import { DomainEntity } from 'domain-objects';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare const canUpdateResource: <R extends DomainEntity<any>>({ resource }: {
+    resource: R;
+}, context: DeclastructContext) => boolean;

package/dist/logic/actions/execute/canUpdateResource.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.canUpdateResource = void 0;
+const getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource_1 = require("../../tools/provider/getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource");
+const canUpdateResource = ({ resource }, context) => {
+    // grab the interface for the resource
+    const { remoteStateInterface } = (0, getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource_1.getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource)({ resource }, context);
+    // check if it has defined the update method
+    return !!remoteStateInterface.update;
+};
+exports.canUpdateResource = canUpdateResource;
+//# sourceMappingURL=canUpdateResource.js.map

package/dist/logic/actions/execute/canUpdateResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canUpdateResource.js","sourceRoot":"","sources":["../../../../src/logic/actions/execute/canUpdateResource.ts"],"names":[],"mappings":";;;AAGA,0LAAuL;AAEhL,MAAM,iBAAiB,GAAG,CAC/B,EAAE,QAAQ,EAAmB,EAC7B,OAA2B,EAClB,EAAE;IACX,sCAAsC;IACtC,MAAM,EAAE,oBAAoB,EAAE,GAC5B,IAAA,iJAAuE,EACrE,EAAE,QAAQ,EAAE,EACZ,OAAO,CACR,CAAC;IAEJ,4CAA4C;IAC5C,OAAO,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC;AACvC,CAAC,CAAC;AAbW,QAAA,iBAAiB,qBAa5B"}

package/dist/logic/actions/execute/executeProposal.d.ts

@@ -0,0 +1,5 @@
+import { DeclastructChangeProposal } from '../../../domain/DeclastructChangeProposal';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare const executeProposal: ({ proposal }: {
+    proposal: DeclastructChangeProposal<any>;
+}, context: DeclastructContext) => Promise<Required<any>>;

package/dist/logic/actions/execute/executeProposal.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeProposal = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const DeclastructChangeProposal_1 = require("../../../domain/DeclastructChangeProposal");
+const getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource_1 = require("../../tools/provider/getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource");
+const executeProposal = async ({ proposal }, context) => {
+    // grab the interface and context for the resource
+    const { remoteStateInterface, providerContext } = (0, getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource_1.getProviderResourceRemoteStateInterfaceExecutionDependenciesForResource)({ resource: proposal.toDesiredState ?? proposal.fromRemoteState }, context);
+    // if the proposed action was to do nothing, just return its current state
+    if (proposal.action === DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING) {
+        // look up the resource
+        const found = await remoteStateInterface.findByUnique(proposal.toDesiredState, providerContext);
+        // sanity check that the resource does really exist
+        if (!found)
+            throw new error_fns_1.UnexpectedCodePathError('proposal was to do nothing but resource does not exist. how is that possible?', { proposal, found });
+        // return the state of the resource
+        return found;
+    }
+    // if the proposed action was to create it, create it
+    if (proposal.action === DeclastructChangeProposal_1.DeclastructChangeProposalAction.CREATE) {
+        // sanity check that the entity does not already exist
+        const found = await remoteStateInterface.findByUnique(proposal.toDesiredState, providerContext);
+        if (found) {
+            // done if already found it, we must have created it as part of another operation (or the plan was wrong)
+            // console.log('    * found this resource by unique instead of creating it');
+            return found;
+        }
+        // create it
+        await remoteStateInterface.create(proposal.toDesiredState, providerContext);
+        // prove we can find it now
+        const foundNow = await remoteStateInterface.findByUnique(proposal.toDesiredState, providerContext);
+        if (!foundNow)
+            throw new error_fns_1.UnexpectedCodePathError('could not find resource after creating it', {
+                forClassName: proposal.forResourceClassName,
+                forGrokableIdentifier: proposal.forGrokableIdentifier,
+            });
+        return foundNow;
+    }
+    // if the proposed action was to update it, update it
+    if (proposal.action === DeclastructChangeProposal_1.DeclastructChangeProposalAction.UPDATE) {
+        if (!remoteStateInterface.update)
+            throw new error_fns_1.UnexpectedCodePathError(`should not have attempted to update a resource who's remote state interface does not support updates`, { resourceClassName: proposal.forResourceClassName });
+        return await remoteStateInterface.update(proposal.toDesiredState, providerContext);
+    }
+    // otherwise, throw an error, since we couldn't handle it
+    throw new error_fns_1.UnexpectedCodePathError('unsupported proposal action', {
+        proposal,
+    });
+};
+exports.executeProposal = executeProposal;
+//# sourceMappingURL=executeProposal.js.map

package/dist/logic/actions/execute/executeProposal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executeProposal.js","sourceRoot":"","sources":["../../../../src/logic/actions/execute/executeProposal.ts"],"names":[],"mappings":";;;AAAA,mDAA8D;AAE9D,yFAGmD;AAEnD,0LAAuL;AAEhL,MAAM,eAAe,GAAG,KAAK,EAClC,EAAE,QAAQ,EAAgD,EAC1D,OAA2B,EAC3B,EAAE;IACF,kDAAkD;IAClD,MAAM,EAAE,oBAAoB,EAAE,eAAe,EAAE,GAC7C,IAAA,iJAAuE,EACrE,EAAE,QAAQ,EAAE,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,eAAe,EAAE,EACjE,OAAO,CACR,CAAC;IAEJ,0EAA0E;IAC1E,IAAI,QAAQ,CAAC,MAAM,KAAK,2DAA+B,CAAC,UAAU,EAAE,CAAC;QACnE,uBAAuB;QACvB,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,YAAY,CACnD,QAAQ,CAAC,cAAc,EACvB,eAAe,CAChB,CAAC;QAEF,mDAAmD;QACnD,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,mCAAuB,CAC/B,+EAA+E,EAC/E,EAAE,QAAQ,EAAE,KAAK,EAAE,CACpB,CAAC;QAEJ,mCAAmC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qDAAqD;IACrD,IAAI,QAAQ,CAAC,MAAM,KAAK,2DAA+B,CAAC,MAAM,EAAE,CAAC;QAC/D,sDAAsD;QACtD,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,YAAY,CACnD,QAAQ,CAAC,cAAc,EACvB,eAAe,CAChB,CAAC;QACF,IAAI,KAAK,EAAE,CAAC;YACV,yGAAyG;YACzG,6EAA6E;YAC7E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,YAAY;QACZ,MAAM,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;QAE5E,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,YAAY,CACtD,QAAQ,CAAC,cAAc,EACvB,eAAe,CAChB,CAAC;QACF,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,mCAAuB,CAC/B,2CAA2C,EAC3C;gBACE,YAAY,EAAE,QAAQ,CAAC,oBAAoB;gBAC3C,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB;aACtD,CACF,CAAC;QACJ,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qDAAqD;IACrD,IAAI,QAAQ,CAAC,MAAM,KAAK,2DAA+B,CAAC,MAAM,EAAE,CAAC;QAC/D,IAAI,CAAC,oBAAoB,CAAC,MAAM;YAC9B,MAAM,IAAI,mCAAuB,CAC/B,sGAAsG,EACtG,EAAE,iBAAiB,EAAE,QAAQ,CAAC,oBAAoB,EAAE,CACrD,CAAC;QACJ,OAAO,MAAM,oBAAoB,CAAC,MAAM,CACtC,QAAQ,CAAC,cAAc,EACvB,eAAe,CAChB,CAAC;IACJ,CAAC;IAED,yDAAyD;IACzD,MAAM,IAAI,mCAAuB,CAAC,6BAA6B,EAAE;QAC/D,QAAQ;KACT,CAAC,CAAC;AACL,CAAC,CAAC;AA/EW,QAAA,eAAe,mBA+E1B"}

package/dist/logic/actions/propose/getColoredActionToken.d.ts

@@ -0,0 +1,4 @@
+import { DeclastructChangeProposalAction } from '../../../domain/DeclastructChangeProposal';
+export declare const getColoredActionToken: ({ action, }: {
+    action: DeclastructChangeProposalAction;
+}) => string;

package/dist/logic/actions/propose/getColoredActionToken.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getColoredActionToken = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const DeclastructChangeProposal_1 = require("../../../domain/DeclastructChangeProposal");
+const getColoredActionToken = ({ action, }) => {
+    // define action color
+    const actionChalk = {
+        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.CREATE]: chalk_1.default.green,
+        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING]: chalk_1.default.gray,
+        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.UPDATE]: chalk_1.default.yellow,
+        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.REPLACE]: chalk_1.default.red,
+        [DeclastructChangeProposal_1.DeclastructChangeProposalAction.DESTROY]: chalk_1.default.red,
+    }[action];
+    // return the token
+    return chalk_1.default.bold(actionChalk(`[${action}]`));
+};
+exports.getColoredActionToken = getColoredActionToken;
+//# sourceMappingURL=getColoredActionToken.js.map

package/dist/logic/actions/propose/getColoredActionToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getColoredActionToken.js","sourceRoot":"","sources":["../../../../src/logic/actions/propose/getColoredActionToken.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,yFAA4F;AAErF,MAAM,qBAAqB,GAAG,CAAC,EACpC,MAAM,GAGP,EAAE,EAAE;IACH,sBAAsB;IACtB,MAAM,WAAW,GAAG;QAClB,CAAC,2DAA+B,CAAC,MAAM,CAAC,EAAE,eAAK,CAAC,KAAK;QACrD,CAAC,2DAA+B,CAAC,UAAU,CAAC,EAAE,eAAK,CAAC,IAAI;QACxD,CAAC,2DAA+B,CAAC,MAAM,CAAC,EAAE,eAAK,CAAC,MAAM;QACtD,CAAC,2DAA+B,CAAC,OAAO,CAAC,EAAE,eAAK,CAAC,GAAG;QACpD,CAAC,2DAA+B,CAAC,OAAO,CAAC,EAAE,eAAK,CAAC,GAAG;KACrD,CAAC,MAAM,CAAC,CAAC;IAEV,mBAAmB;IACnB,OAAO,eAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC;AAhBW,QAAA,qBAAqB,yBAgBhC"}

package/dist/logic/actions/propose/getColoredProposalTitle.d.ts

@@ -0,0 +1,4 @@
+import { DeclastructChangeProposal } from '../../../domain/DeclastructChangeProposal';
+export declare const getColoredProposalTitle: ({ proposal, }: {
+    proposal: DeclastructChangeProposal<any>;
+}) => string;

package/dist/logic/actions/propose/getColoredProposalTitle.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getColoredProposalTitle = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const domain_objects_1 = require("domain-objects");
+const type_fns_1 = require("type-fns");
+const getColoredActionToken_1 = require("./getColoredActionToken");
+const getColoredProposalTitle = ({ proposal, }) => {
+    // get the action token
+    const actionToken = (0, getColoredActionToken_1.getColoredActionToken)({ action: proposal.action });
+    // define the metadata string
+    const metadata = proposal.fromRemoteState
+        ? (0, domain_objects_1.getMetadataKeys)(proposal.fromRemoteState).reduce((summary, thisMetadataKey) => ({
+            ...summary,
+            [thisMetadataKey]: proposal.toDesiredState[thisMetadataKey],
+        }), {})
+        : {};
+    const identifierAvailableWidth = 151 - 5 - actionToken.length - proposal.forResourceClassName.length - 15;
+    const identifierString = Object.values(metadata).filter(type_fns_1.isPresent).length
+        ? JSON.stringify(metadata)
+        : proposal.forGrokableIdentifier.replace(proposal.forResourceClassName, ''); // remove the classname from the identifier because its redundant, the class name is already in the title
+    const displayableIdentifierString = chalk_1.default.grey(`(${identifierString.length > identifierAvailableWidth
+        ? identifierString.slice(0, identifierAvailableWidth - 3) + '...'
+        : identifierString})`);
+    // define the header
+    const title = chalk_1.default.bold(`${actionToken} ${proposal.forResourceClassName} ${displayableIdentifierString}`);
+    // return header
+    return title;
+};
+exports.getColoredProposalTitle = getColoredProposalTitle;
+//# sourceMappingURL=getColoredProposalTitle.js.map

package/dist/logic/actions/propose/getColoredProposalTitle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getColoredProposalTitle.js","sourceRoot":"","sources":["../../../../src/logic/actions/propose/getColoredProposalTitle.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,mDAAiD;AACjD,uCAAqC;AAGrC,mEAAgE;AAEzD,MAAM,uBAAuB,GAAG,CAAC,EACtC,QAAQ,GAGT,EAAE,EAAE;IACH,uBAAuB;IACvB,MAAM,WAAW,GAAG,IAAA,6CAAqB,EAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAEvE,6BAA6B;IAC7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,eAAe;QACvC,CAAC,CAAC,IAAA,gCAAe,EAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,MAAM,CAC9C,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,CAAC,CAAC;YAC7B,GAAG,OAAO;YACV,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC;SAC5D,CAAC,EACF,EAA6C,CAC9C;QACH,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,wBAAwB,GAC5B,GAAG,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,GAAG,QAAQ,CAAC,oBAAoB,CAAC,MAAM,GAAG,EAAE,CAAC;IAC3E,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,oBAAS,CAAC,CAAC,MAAM;QACvE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QAC1B,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC,CAAC,yGAAyG;IACxL,MAAM,2BAA2B,GAAG,eAAK,CAAC,IAAI,CAC5C,IACE,gBAAgB,CAAC,MAAM,GAAG,wBAAwB;QAChD,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,EAAE,wBAAwB,GAAG,CAAC,CAAC,GAAG,KAAK;QACjE,CAAC,CAAC,gBACN,GAAG,CACJ,CAAC;IAEF,oBAAoB;IACpB,MAAM,KAAK,GAAG,eAAK,CAAC,IAAI,CACtB,GAAG,WAAW,IAAI,QAAQ,CAAC,oBAAoB,IAAI,2BAA2B,EAAE,CACjF,CAAC;IAEF,gBAAgB;IAChB,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAtCW,QAAA,uBAAuB,2BAsClC"}

package/dist/logic/actions/propose/proposeChangeForResource.d.ts

@@ -0,0 +1,7 @@
+import { VisualogicContext } from 'visualogic';
+import { DeclaredResource } from '../../../domain/DeclaredResource';
+import { DeclastructChangeProposal } from '../../../domain/DeclastructChangeProposal';
+import { DeclastructContext } from '../../../domain/DeclastructContext';
+export declare const proposeChangeForResource: <R extends DeclaredResource>({ resource: desiredState, }: {
+    resource: R;
+}, context: DeclastructContext & VisualogicContext) => Promise<DeclastructChangeProposal<R>>;

package/dist/logic/actions/propose/proposeChangeForResource.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.proposeChangeForResource = void 0;
+const DeclastructChangeProposal_1 = require("../../../domain/DeclastructChangeProposal");
+const castReferenceToGrokableString_1 = require("../../tools/compare/castReferenceToGrokableString");
+const detectDifferenceBetweenDesiredAndRemoteStateOfResource_1 = require("../../tools/compare/detectDifferenceBetweenDesiredAndRemoteStateOfResource");
+const getByReference_1 = require("../../tools/reference/getByReference");
+const getReferenceTo_1 = require("../../tools/reference/getReferenceTo");
+const canUpdateResource_1 = require("../execute/canUpdateResource");
+const proposeChangeForResource = async ({ resource: desiredState, // TODO: support deleting remote state resources, based on remoteState resource as input (i.e., specify which type the resource declaration represents, right now always desiredState)
+ }, context) => {
+    // get its current remote state
+    // const stopwatchOne = startDurationStopwatch(
+    //   {
+    //     for: `proposeChangeForResource.getByReference.ofClass::${desiredState.constructor.name}`,
+    //     log: { level: LogLevel.INFO, threshold: { milliseconds: 1 } },
+    //   },
+    //   context,
+    // );
+    const remoteState = await (0, getByReference_1.getByReference)({ reference: (0, getReferenceTo_1.getRef)(desiredState) }, context);
+    // stopwatchOne.stop();
+    // detect the difference
+    const diff = await (0, detectDifferenceBetweenDesiredAndRemoteStateOfResource_1.detectDifferenceBetweenDesiredAndRemoteStateOfResource)({
+        desiredState,
+        remoteState,
+    }, context);
+    // determine what we should do
+    const action = await (async () => {
+        // if remote and desired state are already the same, do nothing
+        if (desiredState === remoteState)
+            return DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING;
+        // if remote state is null, create it
+        if (remoteState === null)
+            return DeclastructChangeProposal_1.DeclastructChangeProposalAction.CREATE;
+        // if desired state is null, destroy it
+        if (desiredState === null)
+            return DeclastructChangeProposal_1.DeclastructChangeProposalAction.DESTROY;
+        // if there are no changes detected, do nothing
+        if (Object.values(diff.usable)
+            .map((changeType) => Object.values(changeType).length) // TODO: make the "usable" diff more usable, this is pretty ugly and convoluted
+            .every((numberOfChangesForType) => numberOfChangesForType === 0))
+            return DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING;
+        // if the resource supports update, update it
+        if (await (0, canUpdateResource_1.canUpdateResource)({ resource: desiredState }, context))
+            return DeclastructChangeProposal_1.DeclastructChangeProposalAction.UPDATE;
+        // otherwise, replace it
+        return DeclastructChangeProposal_1.DeclastructChangeProposalAction.REPLACE;
+    })();
+    // get the grokable identifier
+    const grokableIdentifier = await (0, castReferenceToGrokableString_1.castReferenceToGrokableString)({ reference: (0, getReferenceTo_1.getRef)(desiredState) }, // TODO: support desiredState  = null, remote state != null
+    context);
+    // return the proposed change
+    return new DeclastructChangeProposal_1.DeclastructChangeProposal({
+        forResourceClassName: desiredState.constructor.name,
+        forGrokableIdentifier: grokableIdentifier,
+        fromRemoteState: remoteState,
+        toDesiredState: desiredState,
+        difference: action === DeclastructChangeProposal_1.DeclastructChangeProposalAction.DO_NOTHING
+            ? null
+            : diff.displayable,
+        action,
+    });
+};
+exports.proposeChangeForResource = proposeChangeForResource;
+//# sourceMappingURL=proposeChangeForResource.js.map

package/dist/logic/actions/propose/proposeChangeForResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proposeChangeForResource.js","sourceRoot":"","sources":["../../../../src/logic/actions/propose/proposeChangeForResource.ts"],"names":[],"mappings":";;;AAGA,yFAGmD;AAEnD,qGAAkG;AAClG,uJAAoJ;AACpJ,yEAAsE;AACtE,yEAA8D;AAC9D,oEAAiE;AAE1D,MAAM,wBAAwB,GAAG,KAAK,EAC3C,EACE,QAAQ,EAAE,YAAY,EAAE,sLAAsL;EAC9L,EAClB,OAA+C,EAC/C,EAAE;IACF,+BAA+B;IAC/B,+CAA+C;IAC/C,MAAM;IACN,gGAAgG;IAChG,qEAAqE;IACrE,OAAO;IACP,aAAa;IACb,KAAK;IACL,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAc,EACtC,EAAE,SAAS,EAAE,IAAA,uBAAM,EAAC,YAAY,CAAC,EAAE,EACnC,OAAO,CACR,CAAC;IACF,uBAAuB;IAEvB,wBAAwB;IACxB,MAAM,IAAI,GAAG,MAAM,IAAA,+GAAsD,EACvE;QACE,YAAY;QACZ,WAAW;KACZ,EACD,OAAO,CACR,CAAC;IAEF,8BAA8B;IAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE;QAC/B,+DAA+D;QAC/D,IAAI,YAAY,KAAK,WAAW;YAC9B,OAAO,2DAA+B,CAAC,UAAU,CAAC;QAEpD,qCAAqC;QACrC,IAAI,WAAW,KAAK,IAAI;YAAE,OAAO,2DAA+B,CAAC,MAAM,CAAC;QAExE,uCAAuC;QACvC,IAAI,YAAY,KAAK,IAAI;YAAE,OAAO,2DAA+B,CAAC,OAAO,CAAC;QAE1E,+CAA+C;QAC/C,IACE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aACvB,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,+EAA+E;aACrI,KAAK,CAAC,CAAC,sBAAsB,EAAE,EAAE,CAAC,sBAAsB,KAAK,CAAC,CAAC;YAElE,OAAO,2DAA+B,CAAC,UAAU,CAAC;QAEpD,6CAA6C;QAC7C,IAAI,MAAM,IAAA,qCAAiB,EAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,OAAO,CAAC;YAC9D,OAAO,2DAA+B,CAAC,MAAM,CAAC;QAEhD,wBAAwB;QACxB,OAAO,2DAA+B,CAAC,OAAO,CAAC;IACjD,CAAC,CAAC,EAAE,CAAC;IAEL,8BAA8B;IAC9B,MAAM,kBAAkB,GAAG,MAAM,IAAA,6DAA6B,EAC5D,EAAE,SAAS,EAAE,IAAA,uBAAM,EAAC,YAAY,CAAC,EAAE,EAAE,2DAA2D;IAChG,OAAO,CACR,CAAC;IAEF,6BAA6B;IAC7B,OAAO,IAAI,qDAAyB,CAAI;QACtC,oBAAoB,EAAE,YAAY,CAAC,WAAW,CAAC,IAAI;QACnD,qBAAqB,EAAE,kBAAkB;QACzC,eAAe,EAAE,WAAW;QAC5B,cAAc,EAAE,YAAY;QAC5B,UAAU,EACR,MAAM,KAAK,2DAA+B,CAAC,UAAU;YACnD,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,CAAC,WAAW;QACtB,MAAM;KACP,CAAC,CAAC;AACL,CAAC,CAAC;AA3EW,QAAA,wBAAwB,4BA2EnC"}

package/dist/logic/actions/propose/proposeChangeForResource.test.d.ts

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