declastruct 1.0.0 → 1.1.0

package/dist/__test_assets__/getExampleContext.d.ts

@@ -1,33 +0,0 @@
-import { DomainEntity } from 'domain-objects';
-import { VisualogicContext } from 'visualogic';
-import { DeclaredResourceReference } from '../domain/DeclaredResourceReference';
-import { DeclastructContext } from '../domain/DeclastructContext';
-interface CNCMachine {
-    uuid?: string;
-    serialNumber: string;
-    size: string;
-    location: string;
-}
-declare class CNCMachine extends DomainEntity<CNCMachine> implements CNCMachine {
-    static primary: readonly ["uuid"];
-    static unique: string[];
-}
-export type CNCMachineReference = DeclaredResourceReference<CNCMachine, 'uuid', 'serialNumber'>;
-interface CNCMachineRegistration {
-    uuid?: string;
-    machine: CNCMachineReference;
-    registeredBy: string;
-}
-declare class CNCMachineRegistration extends DomainEntity<CNCMachineRegistration> implements CNCMachineRegistration {
-    static primary: readonly ["uuid"];
-    static unique: string[];
-}
-export type CNCMachineRegistrationReference = DeclaredResourceReference<CNCMachineRegistration, 'uuid', 'machine'>;
-export declare const getExampleContext: () => {
-    exampleContext: DeclastructContext & VisualogicContext;
-    exampleMachine: Required<CNCMachine>;
-    CNCMachine: typeof CNCMachine;
-    exampleRegistration: Required<CNCMachineRegistration>;
-    CNCMachineRegistration: typeof CNCMachineRegistration;
-};
-export {};

package/dist/__test_assets__/getExampleContext.js

@@ -1,87 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExampleContext = void 0;
-const domain_objects_1 = require("domain-objects");
-const __1 = require("..");
-const DeclaredResourceReference_1 = require("../domain/DeclaredResourceReference");
-const log = console;
-class CNCMachine extends domain_objects_1.DomainEntity {
-}
-CNCMachine.primary = ['uuid'];
-CNCMachine.unique = ['serialNumber'];
-class CNCMachineRegistration extends domain_objects_1.DomainEntity {
-}
-CNCMachineRegistration.primary = ['uuid'];
-CNCMachineRegistration.unique = ['machine'];
-const exampleMachine = new CNCMachine({
-    uuid: 'de0e34ca-ce61-4884-ace5-093a1a32ff92',
-    serialNumber: '821',
-    size: 'big',
-    location: 'basement',
-});
-const exampleRegistration = new CNCMachineRegistration({
-    uuid: '9857cc32-8bcf-4291-8850-aef94c2081f9',
-    machine: (0, __1.getRef)(exampleMachine),
-    registeredBy: 'bob',
-});
-const cncMachineRemoteStateInterface = {
-    for: CNCMachine.name,
-    findByPrimary: async ({ uuid }) => {
-        if (uuid === exampleMachine.uuid)
-            return exampleMachine;
-        return null;
-    },
-    findByUnique: async ({ serialNumber }) => {
-        if (serialNumber === exampleMachine.serialNumber)
-            return exampleMachine;
-        return null;
-    },
-    create: () => Promise.reject(new Error('todo')),
-    update: () => Promise.reject(new Error('todo')),
-    destroy: () => Promise.reject(new Error('todo')),
-};
-const cncMachineRegistrationRemoteStateInterface = {
-    for: CNCMachineRegistration.name,
-    findByPrimary: async ({ uuid }) => {
-        if (uuid === exampleRegistration.uuid)
-            return exampleRegistration;
-        return null;
-    },
-    findByUnique: async ({ machine: machineRef }) => {
-        if (machineRef.identifiedBy.key ===
-            DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.PRIMARY_KEY &&
-            machineRef.identifiedBy.value.uuid === exampleMachine.uuid)
-            return exampleRegistration;
-        if (machineRef.identifiedBy.key ===
-            DeclaredResourceReference_1.DeclaredResourceReferenceKeyType.UNIQUE_KEY &&
-            machineRef.identifiedBy.value.serialNumber === exampleMachine.serialNumber)
-            return exampleRegistration;
-        return null;
-    },
-    create: () => Promise.reject(new Error('todo')),
-    destroy: () => Promise.reject(new Error('todo')),
-};
-const exampleContext = {
-    log,
-    providers: [
-        {
-            agentOptions: {},
-            interfaces: {
-                [cncMachineRemoteStateInterface.for]: cncMachineRemoteStateInterface,
-                [cncMachineRegistrationRemoteStateInterface.for]: cncMachineRegistrationRemoteStateInterface,
-            }, // TODO: fix types to make this assertion not needed
-            hooks: {},
-        },
-    ],
-    resources: [], // no resources needed in context for this test
-};
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-const getExampleContext = () => ({
-    exampleContext,
-    exampleMachine,
-    CNCMachine,
-    exampleRegistration,
-    CNCMachineRegistration,
-});
-exports.getExampleContext = getExampleContext;
-//# sourceMappingURL=getExampleContext.js.map

package/dist/__test_assets__/getExampleContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getExampleContext.js","sourceRoot":"","sources":["../../src/__test_assets__/getExampleContext.ts"],"names":[],"mappings":";;;AAAA,mDAA8C;AAG9C,0BAA4B;AAC5B,mFAG6C;AAK7C,MAAM,GAAG,GAAG,OAAO,CAAC;AAQpB,MAAM,UAAW,SAAQ,6BAAwB;;AACjC,kBAAO,GAAG,CAAC,MAAM,CAAU,CAAC;AAC5B,iBAAM,GAAG,CAAC,cAAc,CAAC,CAAC;AAa1C,MAAM,sBACJ,SAAQ,6BAAoC;;AAG9B,8BAAO,GAAG,CAAC,MAAM,CAAU,CAAC;AAC5B,6BAAM,GAAG,CAAC,SAAS,CAAC,CAAC;AAQrC,MAAM,cAAc,GAAG,IAAI,UAAU,CAAC;IACpC,IAAI,EAAE,sCAAsC;IAC5C,YAAY,EAAE,KAAK;IACnB,IAAI,EAAE,KAAK;IACX,QAAQ,EAAE,UAAU;CACrB,CAAyB,CAAC;AAE3B,MAAM,mBAAmB,GAAG,IAAI,sBAAsB,CAAC;IACrD,IAAI,EAAE,sCAAsC;IAC5C,OAAO,EAAE,IAAA,UAAM,EAAC,cAAc,CAAC;IAC/B,YAAY,EAAE,KAAK;CACpB,CAAqC,CAAC;AAEvC,MAAM,8BAA8B,GAKhC;IACF,GAAG,EAAE,UAAU,CAAC,IAAI;IACpB,aAAa,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;QAChC,IAAI,IAAI,KAAK,cAAc,CAAC,IAAI;YAAE,OAAO,cAAc,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,YAAY,EAAE,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;QACvC,IAAI,YAAY,KAAK,cAAc,CAAC,YAAY;YAAE,OAAO,cAAc,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/C,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;CACjD,CAAC;AAEF,MAAM,0CAA0C,GAK5C;IACF,GAAG,EAAE,sBAAsB,CAAC,IAAI;IAChC,aAAa,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;QAChC,IAAI,IAAI,KAAK,mBAAmB,CAAC,IAAI;YAAE,OAAO,mBAAmB,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,YAAY,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE;QAC9C,IACE,UAAU,CAAC,YAAY,CAAC,GAAG;YACzB,4DAAgC,CAAC,WAAW;YAC9C,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI;YAE1D,OAAO,mBAAmB,CAAC;QAC7B,IACE,UAAU,CAAC,YAAY,CAAC,GAAG;YACzB,4DAAgC,CAAC,UAAU;YAC7C,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,KAAK,cAAc,CAAC,YAAY;YAE1E,OAAO,mBAAmB,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;IAC/C,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;CACjD,CAAC;AAEF,MAAM,cAAc,GAA2C;IAC7D,GAAG;IACH,SAAS,EAAE;QACT;YACE,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE;gBACV,CAAC,8BAA8B,CAAC,GAAG,CAAC,EAAE,8BAA8B;gBACpE,CAAC,0CAA0C,CAAC,GAAG,CAAC,EAC9C,0CAA0C;aACI,EAAE,oDAAoD;YACxG,KAAK,EAAE,EAAE;SACV;KACF;IACD,SAAS,EAAE,EAAE,EAAE,+CAA+C;CAC/D,CAAC;AAEF,6EAA6E;AACtE,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,CAAC;IACtC,cAAc;IACd,cAAc;IACd,UAAU;IACV,mBAAmB;IACnB,sBAAsB;CACvB,CAAC,CAAC;AANU,QAAA,iBAAiB,qBAM3B"}

package/dist/contract/commands/command.apply.d.ts

@@ -1,6 +0,0 @@
-import { VisualogicContext } from 'visualogic';
-import { DeclastructCommandInput } from './utils/resolveCommandInputs';
-/**
- * applies the planned actions required to update the remote state to match the declared state
- */
-export declare const apply: (input: DeclastructCommandInput, context: VisualogicContext) => Promise<void>;

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

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.apply = void 0;
-const execute_1 = require("../../logic/commands/execute");
-const resolveCommandInputs_1 = require("./utils/resolveCommandInputs");
-/**
- * applies the planned actions required to update the remote state to match the declared state
- */
-const apply = async (input, context) => {
-    // resolve the inputs
-    const { resources, providers } = await (0, resolveCommandInputs_1.resolveCommandInputs)({ input });
-    // execute the command
-    await (0, execute_1.executeCommand)({
-        option: execute_1.DeclastructCommandOption.APPLY,
-        resources,
-        providers,
-    }, context);
-};
-exports.apply = apply;
-//# sourceMappingURL=command.apply.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"command.apply.js","sourceRoot":"","sources":["../../../src/contract/commands/command.apply.ts"],"names":[],"mappings":";;;AAEA,0DAGsC;AACtC,uEAGsC;AAEtC;;GAEG;AACI,MAAM,KAAK,GAAG,KAAK,EACxB,KAA8B,EAC9B,OAA0B,EACX,EAAE;IACjB,qBAAqB;IACrB,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,IAAA,2CAAoB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvE,sBAAsB;IACtB,MAAM,IAAA,wBAAc,EAClB;QACE,MAAM,EAAE,kCAAwB,CAAC,KAAK;QACtC,SAAS;QACT,SAAS;KACV,EACD,OAAO,CACR,CAAC;AACJ,CAAC,CAAC;AAhBW,QAAA,KAAK,SAgBhB"}

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

@@ -1,6 +0,0 @@
-import { VisualogicContext } from 'visualogic';
-import { DeclastructCommandInput } from './utils/resolveCommandInputs';
-/**
- * applies the planned actions required to update the remote state to match the declared state
- */
-export declare const plan: (input: DeclastructCommandInput, context: VisualogicContext) => Promise<void>;

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

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.plan = void 0;
-const execute_1 = require("../../logic/commands/execute");
-const resolveCommandInputs_1 = require("./utils/resolveCommandInputs");
-/**
- * applies the planned actions required to update the remote state to match the declared state
- */
-const plan = async (input, context) => {
-    // resolve the inputs
-    const { resources, providers } = await (0, resolveCommandInputs_1.resolveCommandInputs)({ input });
-    // execute the command
-    await (0, execute_1.executeCommand)({
-        option: execute_1.DeclastructCommandOption.PLAN,
-        resources,
-        providers,
-    }, context);
-};
-exports.plan = plan;
-//# sourceMappingURL=command.plan.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"command.plan.js","sourceRoot":"","sources":["../../../src/contract/commands/command.plan.ts"],"names":[],"mappings":";;;AAEA,0DAGsC;AACtC,uEAGsC;AAEtC;;GAEG;AACI,MAAM,IAAI,GAAG,KAAK,EACvB,KAA8B,EAC9B,OAA0B,EACX,EAAE;IACjB,qBAAqB;IACrB,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,IAAA,2CAAoB,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvE,sBAAsB;IACtB,MAAM,IAAA,wBAAc,EAClB;QACE,MAAM,EAAE,kCAAwB,CAAC,IAAI;QACrC,SAAS;QACT,SAAS;KACV,EACD,OAAO,CACR,CAAC;AACJ,CAAC,CAAC;AAhBW,QAAA,IAAI,QAgBf"}

package/dist/contract/commands/utils/resolveCommandInputs.d.ts

@@ -1,17 +0,0 @@
-import { DeclaredResource } from '../../../domain/DeclaredResource';
-import { DeclastructProvider } from '../../../domain/DeclastructProvider';
-export interface DeclastructCommandInput {
-    resources: DeclaredResource[] | (() => Promise<DeclaredResource[]>);
-    providers: DeclastructProvider<any>[] | (() => Promise<DeclastructProvider<any>[]>);
-}
-/**
- * a utility method for resolving the command inputs from user definition
- * - we allow users to specify the inputs directly or from a function that promises the inputs
- * - this method awaits the inputs if needed
- */
-export declare const resolveCommandInputs: ({ input, }: {
-    input: DeclastructCommandInput;
-}) => Promise<{
-    resources: DeclaredResource[];
-    providers: DeclastructProvider<any>[];
-}>;

package/dist/contract/commands/utils/resolveCommandInputs.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveCommandInputs = void 0;
-const type_fns_1 = require("type-fns");
-/**
- * a utility method for resolving the command inputs from user definition
- * - we allow users to specify the inputs directly or from a function that promises the inputs
- * - this method awaits the inputs if needed
- */
-const resolveCommandInputs = async ({ input, }) => {
-    const resources = (0, type_fns_1.isAFunction)(input.resources)
-        ? await input.resources()
-        : input.resources;
-    const providers = (0, type_fns_1.isAFunction)(input.providers)
-        ? await input.providers()
-        : input.providers;
-    return {
-        resources,
-        providers,
-    };
-};
-exports.resolveCommandInputs = resolveCommandInputs;
-//# sourceMappingURL=resolveCommandInputs.js.map

package/dist/contract/commands/utils/resolveCommandInputs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"resolveCommandInputs.js","sourceRoot":"","sources":["../../../../src/contract/commands/utils/resolveCommandInputs.ts"],"names":[],"mappings":";;;AAAA,uCAAuC;AAavC;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,KAAK,EAAE,EACzC,KAAK,GAGN,EAAE,EAAE;IACH,MAAM,SAAS,GAAuB,IAAA,sBAAW,EAAC,KAAK,CAAC,SAAS,CAAC;QAChE,CAAC,CAAC,MAAM,KAAK,CAAC,SAAS,EAAE;QACzB,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;IACpB,MAAM,SAAS,GAA+B,IAAA,sBAAW,EAAC,KAAK,CAAC,SAAS,CAAC;QACxE,CAAC,CAAC,MAAM,KAAK,CAAC,SAAS,EAAE;QACzB,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;IACpB,OAAO;QACL,SAAS;QACT,SAAS;KACV,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,oBAAoB,wBAe/B"}

package/dist/contract/sdk/refs.d.ts

@@ -1,2 +0,0 @@
-export * from '../../logic/tools/reference/getReferenceTo';
-export * from '../../logic/tools/reference/buildReferenceTo';

package/dist/contract/sdk/refs.js

@@ -1,19 +0,0 @@
-"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("../../logic/tools/reference/getReferenceTo"), exports);
-__exportStar(require("../../logic/tools/reference/buildReferenceTo"), exports);
-//# sourceMappingURL=refs.js.map

package/dist/contract/sdk/refs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"refs.js","sourceRoot":"","sources":["../../../src/contract/sdk/refs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6EAA2D;AAC3D,+EAA6D"}

package/dist/contract/sdk/sync/apply.d.ts

@@ -1,22 +0,0 @@
-import { VisualogicContext } from 'visualogic';
-import { DeclaredResource } from '../../../domain/DeclaredResource';
-import { DeclastructChangeProposal } from '../../../domain/DeclastructChangeProposal';
-import { DeclastructProvider } from '../../../domain/DeclastructProvider';
-/**
- * tactic: apply plans to synchronize resources
- * objective:
- * - synchronize the remote state of the resource to the declared state
- * impact:
- * - ensures the remote state matches the declared state
- *
- * strategy
- * - define a context for these resources
- * - apply the plan for these resources
- */
-export declare const applyPlansToSynchronize: <R extends DeclaredResource>({ resources, plans, }: {
-    resources: R[];
-    plans: DeclastructChangeProposal<R>[];
-}, { providers, log, }: {
-    providers: DeclastructProvider<any>[];
-} & VisualogicContext) => Promise<Required<R>[]>;
-export { applyPlansToSynchronize as applyPlans };

package/dist/contract/sdk/sync/apply.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyPlans = exports.applyPlansToSynchronize = void 0;
-const executeProposal_1 = require("../../../logic/actions/execute/executeProposal");
-const createDeclastructContext_1 = require("../../../logic/tools/context/createDeclastructContext");
-/**
- * tactic: apply plans to synchronize resources
- * objective:
- * - synchronize the remote state of the resource to the declared state
- * impact:
- * - ensures the remote state matches the declared state
- *
- * strategy
- * - define a context for these resources
- * - apply the plan for these resources
- */
-const applyPlansToSynchronize = async ({ resources, plans, }, { providers, log, }) => {
-    // define the context for these resources
-    const context = await (0, createDeclastructContext_1.createDeclastructContext)({
-        providers,
-        resources,
-        log,
-    });
-    // get the plan for this one resource
-    return await Promise.all(plans.map((plan) => (0, executeProposal_1.executeProposal)({ proposal: plan }, context)));
-};
-exports.applyPlansToSynchronize = applyPlansToSynchronize;
-exports.applyPlans = exports.applyPlansToSynchronize;
-//# sourceMappingURL=apply.js.map

package/dist/contract/sdk/sync/apply.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"apply.js","sourceRoot":"","sources":["../../../../src/contract/sdk/sync/apply.ts"],"names":[],"mappings":";;;AAKA,oFAAiF;AACjF,oGAAiG;AAEjG;;;;;;;;;;GAUG;AACI,MAAM,uBAAuB,GAAG,KAAK,EAC1C,EACE,SAAS,EACT,KAAK,GACqD,EAC5D,EACE,SAAS,EACT,GAAG,GAC2D,EACxC,EAAE;IAC1B,yCAAyC;IACzC,MAAM,OAAO,GAAG,MAAM,IAAA,mDAAwB,EAAC;QAC7C,SAAS;QACT,SAAS;QACT,GAAG;KACJ,CAAC,CAAC;IAEH,qCAAqC;IACrC,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,KAAK,CAAC,GAAG,CACP,CAAC,IAAI,EAAE,EAAE,CACP,IAAA,iCAAe,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,CAAyB,CACvE,CACF,CAAC;AACJ,CAAC,CAAC;AAxBW,QAAA,uBAAuB,2BAwBlC;AAGkC,qBA3BvB,+BAAuB,CA2BU"}

package/dist/contract/sdk/sync/plan.d.ts

@@ -1,22 +0,0 @@
-import { VisualogicContext } from 'visualogic';
-import { DeclaredResource } from '../../../domain/DeclaredResource';
-import { DeclastructChangeProposal } from '../../../domain/DeclastructChangeProposal';
-import { DeclastructProvider } from '../../../domain/DeclastructProvider';
-/**
- * tactic: get plan to synchronize one resource
- * objective:
- * - get a plan for synchronizing the remote state of the resource to the declared state
- * impact:
- * - enable comparing the difference between the remote state and declared state
- * - enable applying the plan to synchronize the remote state to the declared state
- *
- * strategy
- * - define a context for this one resource
- * - get the plan for this one resource
- */
-export declare const getPlansToSynchronize: <R extends DeclaredResource>({ resources }: {
-    resources: R[];
-}, { providers, log, }: {
-    providers: DeclastructProvider<any>[];
-} & VisualogicContext) => Promise<DeclastructChangeProposal<R>[]>;
-export { getPlansToSynchronize as getPlans };

package/dist/contract/sdk/sync/plan.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPlans = exports.getPlansToSynchronize = void 0;
-const proposeChangeForResource_1 = require("../../../logic/actions/propose/proposeChangeForResource");
-const createDeclastructContext_1 = require("../../../logic/tools/context/createDeclastructContext");
-/**
- * tactic: get plan to synchronize one resource
- * objective:
- * - get a plan for synchronizing the remote state of the resource to the declared state
- * impact:
- * - enable comparing the difference between the remote state and declared state
- * - enable applying the plan to synchronize the remote state to the declared state
- *
- * strategy
- * - define a context for this one resource
- * - get the plan for this one resource
- */
-const getPlansToSynchronize = async ({ resources }, { providers, log, }) => {
-    // define the context for this one resource
-    const context = await (0, createDeclastructContext_1.createDeclastructContext)({
-        providers,
-        resources,
-        log,
-    });
-    // get the plan for this one resource
-    return await Promise.all(resources.map((resource) => (0, proposeChangeForResource_1.proposeChangeForResource)({ resource }, context)));
-};
-exports.getPlansToSynchronize = getPlansToSynchronize;
-exports.getPlans = exports.getPlansToSynchronize;
-//# sourceMappingURL=plan.js.map

package/dist/contract/sdk/sync/plan.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../../../src/contract/sdk/sync/plan.ts"],"names":[],"mappings":";;;AAKA,sGAAmG;AACnG,oGAAiG;AAEjG;;;;;;;;;;;GAWG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,EAAE,SAAS,EAAsB,EACjC,EACE,SAAS,EACT,GAAG,GAC2D,EACvB,EAAE;IAC3C,2CAA2C;IAC3C,MAAM,OAAO,GAAG,MAAM,IAAA,mDAAwB,EAAC;QAC7C,SAAS;QACT,SAAS;QACT,GAAG;KACJ,CAAC,CAAC;IAEH,qCAAqC;IACrC,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzB,IAAA,mDAAwB,EAAC,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC,CAChD,CACF,CAAC;AACJ,CAAC,CAAC;AApBW,QAAA,qBAAqB,yBAoBhC;AAGgC,mBAvBrB,6BAAqB,CAuBQ"}

package/dist/domain/DeclaredResource.d.ts

@@ -1,2 +0,0 @@
-import { DomainObject } from 'domain-objects';
-export type DeclaredResource<R extends Record<string, any> = {}> = DomainObject<R>;

package/dist/domain/DeclaredResource.js.map

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

package/dist/domain/DeclaredResourceReference.d.ts

@@ -1,66 +0,0 @@
-import { DomainLiteral } from 'domain-objects';
-import Joi from 'joi';
-export declare enum DeclaredResourceReferenceKeyType {
-    PRIMARY_KEY = "PRIMARY_KEY",
-    UNIQUE_KEY = "UNIQUE_KEY"
-}
-/**
- * a value that a declared resource reference identifier specifies to identify the resource
- */
-export declare class DeclaredResourceReferenceIdentifierValue<V extends Record<string, any>> extends DomainLiteral<V> {
-}
-/**
- * an identifier for a declared resource reference
- */
-export interface DeclaredResourceReferenceIdentifier<KT extends DeclaredResourceReferenceKeyType, T, K extends keyof T> {
-    key: KT;
-    value: Required<Pick<T, K>>;
-}
-export declare class DeclaredResourceReferenceIdentifier<KT extends DeclaredResourceReferenceKeyType, T, K extends keyof T> extends DomainLiteral<DeclaredResourceReferenceIdentifier<KT, T, K>> implements DeclaredResourceReferenceIdentifier<KT, T, K> {
-    static nested: {
-        value: typeof DeclaredResourceReferenceIdentifierValue;
-    };
-}
-/**
- * a reference to a resource
- * - allows reference by primary key (i.e., can specify just the primary)
- * - allows reference by unique key (i.e., can specify the unique traits of the entity)
- */
-export interface DeclaredResourceReference<T, 
-/**
- * the names of the primary key attributes
- */
-P extends keyof T, 
-/**
- * the names of the unique key attributes
- */
-U extends keyof T> {
-    /**
-     * the class.name of the resource being referenced
-     */
-    referenceOf: string;
-    /**
-     * the mechanism used to reference
-     */
-    identifiedBy: {
-        key: DeclaredResourceReferenceKeyType.PRIMARY_KEY;
-        value: Required<Pick<T, P>>;
-    } | {
-        key: DeclaredResourceReferenceKeyType.UNIQUE_KEY;
-        value: Required<Pick<T, U>>;
-    };
-}
-export declare class DeclaredResourceReference<T, 
-/**
- * the names of the primary key attributes
- */
-P extends keyof T, 
-/**
- * the names of the unique key attributes
- */
-U extends keyof T> extends DomainLiteral<DeclaredResourceReference<T, P, U>> implements DeclaredResourceReference<T, P, U> {
-    static schema: Joi.AlternativesSchema<any>;
-    static nested: {
-        identifiedBy: typeof DeclaredResourceReferenceIdentifier;
-    };
-}

package/dist/domain/DeclaredResourceReference.js

@@ -1,42 +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.DeclaredResourceReference = exports.DeclaredResourceReferenceIdentifier = exports.DeclaredResourceReferenceIdentifierValue = exports.DeclaredResourceReferenceKeyType = void 0;
-const domain_objects_1 = require("domain-objects");
-const joi_1 = __importDefault(require("joi"));
-var DeclaredResourceReferenceKeyType;
-(function (DeclaredResourceReferenceKeyType) {
-    DeclaredResourceReferenceKeyType["PRIMARY_KEY"] = "PRIMARY_KEY";
-    DeclaredResourceReferenceKeyType["UNIQUE_KEY"] = "UNIQUE_KEY";
-})(DeclaredResourceReferenceKeyType || (exports.DeclaredResourceReferenceKeyType = DeclaredResourceReferenceKeyType = {}));
-/**
- * a value that a declared resource reference identifier specifies to identify the resource
- */
-class DeclaredResourceReferenceIdentifierValue extends domain_objects_1.DomainLiteral {
-}
-exports.DeclaredResourceReferenceIdentifierValue = DeclaredResourceReferenceIdentifierValue;
-class DeclaredResourceReferenceIdentifier extends domain_objects_1.DomainLiteral {
-}
-exports.DeclaredResourceReferenceIdentifier = DeclaredResourceReferenceIdentifier;
-DeclaredResourceReferenceIdentifier.nested = { value: DeclaredResourceReferenceIdentifierValue };
-const schema = joi_1.default.alternatives(joi_1.default.object().keys({
-    _dobj: joi_1.default.string().optional(), // may be specified if hydrating from serialized form (e.g., a cache)
-    referenceOf: joi_1.default.string().required(),
-    identifiedBy: joi_1.default.object().keys({
-        _dobj: joi_1.default.string().optional(), // may be specified if hydrating from serialized form (e.g., a cache)
-        key: joi_1.default.string()
-            .valid(...Object.values(DeclaredResourceReferenceKeyType))
-            .required(),
-        value: joi_1.default.object(),
-    }),
-}), joi_1.default.string().required());
-class DeclaredResourceReference extends domain_objects_1.DomainLiteral {
-}
-exports.DeclaredResourceReference = DeclaredResourceReference;
-DeclaredResourceReference.schema = schema;
-DeclaredResourceReference.nested = {
-    identifiedBy: DeclaredResourceReferenceIdentifier,
-};
-//# sourceMappingURL=DeclaredResourceReference.js.map

package/dist/domain/DeclaredResourceReference.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DeclaredResourceReference.js","sourceRoot":"","sources":["../../src/domain/DeclaredResourceReference.ts"],"names":[],"mappings":";;;;;;AAAA,mDAA+C;AAC/C,8CAAsB;AAEtB,IAAY,gCAGX;AAHD,WAAY,gCAAgC;IAC1C,+DAA2B,CAAA;IAC3B,6DAAyB,CAAA;AAC3B,CAAC,EAHW,gCAAgC,gDAAhC,gCAAgC,QAG3C;AAED;;GAEG;AACH,MAAa,wCAEX,SAAQ,8BAAgB;CAAG;AAF7B,4FAE6B;AAa7B,MAAa,mCAKX,SAAQ,8BAA4D;;AALtE,kFASC;AADe,0CAAM,GAAG,EAAE,KAAK,EAAE,wCAAwC,EAAE,CAAC;AAG7E,MAAM,MAAM,GAAG,aAAG,CAAC,YAAY,CAC7B,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;IAChB,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,qEAAqE;IACrG,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAC9B,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,qEAAqE;QACrG,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE;aACd,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,gCAAgC,CAAC,CAAC;aACzD,QAAQ,EAAE;QACb,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE;KACpB,CAAC;CACH,CAAC,EACF,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CACxB,CAAC;AA+CF,MAAa,yBAWX,SAAQ,8BAAiD;;AAX3D,8DAkBC;AAJe,gCAAM,GAAG,MAAM,CAAC;AAChB,gCAAM,GAAG;IACrB,YAAY,EAAE,mCAAmC;CAClD,CAAC"}

package/dist/domain/DeclastructChangeProposal.d.ts

@@ -1,61 +0,0 @@
-import { DomainObject } from 'domain-objects';
-import { DeclaredResource } from './DeclaredResource';
-/**
- * an action that can be proposed
- */
-export declare enum DeclastructChangeProposalAction {
-    /**
-     * do nothing, the resource is already in the desired state
-     */
-    DO_NOTHING = "DO_NOTHING",
-    /**
-     * create a new resource
-     */
-    CREATE = "CREATE",
-    /**
-     * update an existing resource
-     */
-    UPDATE = "UPDATE",
-    /**
-     * destroy an existing resource
-     */
-    DESTROY = "DESTROY",
-    /**
-     * replace an existing resource
-     *
-     * note
-     * - this is a `delete` followed by a `create`
-     */
-    REPLACE = "REPLACE"
-}
-/**
- * a change that declastruct has proposed in order to update the remote state to reflect the declared state
- */
-export interface DeclastructChangeProposal<R extends DeclaredResource> {
-    /**
-     * the name of the class of resource this proposal is for
-     */
-    forResourceClassName: string;
-    /**
-     * the grokable identity string of the resource this proposal is for
-     */
-    forGrokableIdentifier: string;
-    /**
-     * the remote-state the resource is currently in, from which we will be changing it
-     */
-    fromRemoteState: R | null;
-    /**
-     * the desired-state the resource should be in, to which we will be changing it
-     */
-    toDesiredState: R | null;
-    /**
-     * the action we plan to execute in order to fulfil this proposed change
-     */
-    action: DeclastructChangeProposalAction;
-    /**
-     * the displayable difference made by the change
-     */
-    difference: string | null;
-}
-export declare class DeclastructChangeProposal<R extends DeclaredResource> extends DomainObject<DeclastructChangeProposal<R>> implements DeclastructChangeProposal<R> {
-}

package/dist/domain/DeclastructChangeProposal.js

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

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

@@ -1,24 +0,0 @@
-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.map

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