declastruct 1.0.0 → 1.1.1

package/readme.md

@@ -3,54 +3,250 @@
 ![test](https://github.com/ehmpathy/declastruct/workflows/test/badge.svg)
 ![publish](https://github.com/ehmpathy/declastruct/workflows/publish/badge.svg)
 
-Add declarative control to any resource constructs. Declare, plan, and apply within an observable pit-of-success.
+declarative control for any resource constructs, batteries included
+
+# intro
+
+Add declarative control to any resource construct. Declare, plan, and apply within an observable pit-of-success.
 
 Declare the structures you want. Plan to see the changes required. Apply to make it so 🪄
 
-# benefits
 
-- no dedicated state required
-  - looks at the source of truth directly
-  - leverages unique keys of resources to understand remote state automatically and eliminate the middleman
+## what is it?
+
+`declastruct` is a framework for managing any resource construct declaratively using TypeScript.
+
+declare what you want, plan the changes, and apply them safely — all without managing separate state files or learning a new language.
+
+works with:
+- **infrastructure** — AWS, GCP, Azure resources
+- **SaaS platforms** — Stripe customers, GitHub repos, Slack channels, etc
+- **databases** — application data models
+- **any API** — anything with a remote state you want to control
+
+think Terraform, but:
+- **no state files to manage** — compares directly against live remote state
+- **no new language to learn** — uses TypeScript and your existing domain objects
+- **pit-of-success by default** — enforces idempotency, clear unique keys, and safe operations
+- **not just infrastructure** — works with any resource construct (saas, databases, apis, etc)
+
+# usage
 
-- no new language syntax required
-  - no awkward new-language limitations
-  - reuse your existing domain language to manage your resources
+## install
 
-# features
+```sh
+npm install declastruct --save-dev
+```
 
-- flexible resource references
-  - eliminate primary-key constraint; enable declaration of resources via unique-key references
-  - eliminate single-key constraint; enable usage of whichever key is accessible
+## use
+
+### 1. **declare** your desired state ✨
+
+define resource constructs with strongly-typed domain objects:
+
+```ts
+import { getDeclastructAwsProvider, DeclaredAwsS3Bucket } from 'declastruct-aws';
+import { getDeclastructStripeProvider, DeclaredStripeCustomer } from 'declastruct-stripe';
+
+// define which providers support your resource constructs
+export const getProviders = async () => [
+  await getDeclastructAwsProvider({
+    profile: process.env.AWS_PROFILE,
+  }),
+  await getDeclastructStripeProvider({
+    apiKey: process.env.STRIPE_SECRET_KEY,
+  }),
+];
+
+// declare the resource constructs you want and their desired state
+export const getResources = async () => {
+  const bucket = DeclaredAwsS3Bucket.as({
+    name: 'your-s3-bucket',
+    versioning: true,
+    encryption: 'AES256',
+  });
+
+  const customer = DeclaredStripeCustomer.as({
+    email: 'user@example.com',
+    name: 'John Doe',
+    metadata: { source: 'app-web' },
+  });
+
+  return [bucket, customer];
+};
+```
 
-- declarative resource structures
-  - manage resource states declaratively
+### 2. **plan** the required changes 🔮
 
-- declarative persistence structures
-  - standard shape for any operation for interaction with resources
-  - plug and play handlers of resources (interface w/ many remote state stores for the same resource via prebuilt providers)
+see exactly what will change before applying:
 
-- declarative instructions
-  - declare desired state
-  - plan changes required to get to desired state
-  - apply changes to get to desired state
+```sh
+npx declastruct plan \
+  --wish provision/resources.ts \
+  --into provision/.temp/plan.json
+```
+
+output:
+```
+planned changes:
+  CREATE: DeclaredAwsS3Bucket.your-s3-bucket
+    + name: "your-s3-bucket"
+    + versioning: true
+    + encryption: "AES256"
+
+  CREATE: DeclaredStripeCustomer.user@example.com
+    + email: "user@example.com"
+    + name: "John Doe"
+    + metadata: { source: "app-web" }
+```
 
+### 3. **apply** the plan 🪄
 
-# install
+execute the plan to make your desired state reality:
 
 ```sh
-npm install -s declastruct
+npx declastruct apply --plan provision/.temp/plan.json
 ```
 
-# use
+# benefits - why declastruct?
+
+## summary
+
+✅ **stateless** — no state files to manage, compare directly against reality
+
+✅ **type-safe** — full TypeScript support with domain objects
+
+✅ **idempotent** — safe to run plans multiple times
+
+✅ **observable** — see exactly what will change before applying
+
+✅ **composable** — reuse domain objects and operations across application code and resource management
+
+✅ **pit-of-success** — enforced best practices via idempotent dao interfaces
+
+✅ **universal** — works with any resource construct (infrastructure, saas platforms, databases, apis, etc)
+
+
+## details
+
+### no state file management
+
+traditional declarative tools (like Terraform) require maintaining a separate state file that tracks what resources exist. this creates problems:
+- state files can drift from reality
+- state locking issues in team environments
+- state files must be carefully secured and backed up
+
+**declastruct eliminates state files entirely.** it compares your desired resource constructs directly against live remote state using unique keys, so the source of truth is always reality itself.
 
-### `declare`
+### use your existing domain language
 
-### `plan`
+instead of learning HCL, YAML, or another DSL:
+- declare resource constructs as TypeScript using `domain-objects`
+- reuse the same domain objects across your application code and remote resource management
+- leverage TypeScript's type safety, IDE autocomplete, and refactoring tools
+- compose and test resource definitions like any other code
+
+### enforced best practices
+
+declastruct providers follow a pit-of-success pattern that guarantees:
+
+**idempotency** — all operations can be safely retried
+- `finsert`: find-or-insert (safe create)
+- `upsert`: update-or-insert (safe update)
+- running the same plan multiple times produces the same result
+
+**explicit unique keys** — every resource declares how to uniquely identify it
+- prevents accidental duplicates
+- enables accurate comparison against live state
+- makes resource relationships clear, typesafe, and composable
+
+**observable change plans** — see exactly what will change before applying
+- diff view shows before & after for each resource
+- change actions: CREATE, UPDATE, KEEP, DESTROY
+- no surprises in production
+
+### provider ecosystem
+
+declastruct is designed to support any resource construct through adapters:
+
+**available providers:**
+- `declastruct-aws` — AWS infrastructure (S3, Lambda, RDS, EC2, etc.)
+- `declastruct-stripe` — Stripe SaaS resources (customers, subscriptions, products, etc.)
+- `declastruct-github` — Github resources (repos, branches, protection, etc.)
+- etc
+
+**build your own provider** for any resource construct (GitHub repos, Slack channels, database records, etc.) by implementing the `DeclastructDao` and `DeclastructProvider` interfaces.
+
+## use cases
+
+- **infrastructure as code** — manage AWS, GCP, Azure resources declaratively
+- **SaaS platform management** — manage Stripe customers, GitHub repos, Slack channels, etc declaratively
+- **database state management** — control database resource states declaratively
+- **api state management** — control remote resource state through api's declaratively
+- **multi-platform orchestration** — coordinate resources across different providers in one plan
+
+
+# concepts
+
+## domain
+
+### DeclastructDao
+
+the core abstraction that defines how to interact with a resource type:
+
+```ts
+interface DeclastructDao<TResource, TResourceClass, TContext> {
+  get: {
+    byUnique: (ref: RefByUnique, context) => Promise<TResource | null>;
+    byPrimary?: (ref: RefByPrimary, context) => Promise<TResource | null>;
+    byRef: (ref: Ref, context) => Promise<TResource | null>;
+  };
+  set: {
+    finsert: (resource: TResource, context) => Promise<TResource>;
+    upsert?: (resource: TResource, context) => Promise<TResource>;
+    delete?: (ref: Ref, context) => Promise<void>;
+  };
+}
+```
+
+every resource class gets a DeclastructDao that enforces safe, idempotent operations.
+
+### DeclastructProvider
+
+bundles related DAOs and provider context:
+
+```ts
+interface DeclastructProvider<TDaos, TContext> {
+  name: string;                    // provider identifier
+  daos: TDaos;                     // map of resource types to DAOs
+  context: TContext;               // auth, region, etc.
+  hooks: {
+    beforeAll: () => Promise<void>;
+    afterAll: () => Promise<void>;
+  };
+}
+```
+
+### DeclastructPlan
+
+captures the changes needed to achieve desired state:
+
+```ts
+interface DeclastructPlan {
+  changes: DeclastructChange[];    // ordered list of changes
+  createdAt: IsoTimestamp;         // when plan was created
+  hash: string;                    // fingerprint for validation
+}
+```
 
-### `apply`
+each `DeclastructChange` includes:
+- `action`: CREATE | UPDATE | KEEP | DESTROY
+- `forResource`: which resource this affects
+- `state.desired`: what you want
+- `state.remote`: what exists now
+- `state.difference`: human-readable diff
 
 
-# todo
+## inspiration
 
-swap to domain-objects.Refs
+inspired by Terraform's declarative approach, but designed to eliminate state management overhead, work with any resource construct, and leverage TypeScript's type system for safer declarative resource management.

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