@quadnix/octo 0.1.0 → 0.2.0

package/README.md

@@ -1,35 +1,122 @@
 # Octo
 
-https://octo.quadnix.com/
+Infrastructure as code written as intent: you describe an app and what it needs, modules turn that
+into Terraform, and your own Terragrunt applies it. Users start at
+[octo.quadnix.com](https://octo.quadnix.com/).
 
-The open-source infrastructure management and CICD tool.
+> Octo is in `0.x`. Version `1.x` will mark it ready for production.
 
-> Disclaimer,
-> This library is still under development and is currently in version `0.x.x`.
-> We plan to release version `1.x.x` when it is deemed ready for production use.
+**This README is a set of procedures for working on the repository.** `docs/ARCHITECTURE.md`
+explains what exists, and `docs/CODING-STANDARDS.md` how to add to it.
 
-# Local Setup
+Requires Node 20 or newer, Terraform or OpenTofu 1.6 or newer, and Terragrunt 0.78 or newer. The
+integration suites also need Docker, and the e2e suites AWS credentials.
 
-## Prerequisites
+---
 
-- [Node.js](https://nodejs.org) 22 (LTS). This ships with Corepack, which provisions the
-  exact package manager the project expects — you do **not** need to install pnpm yourself.
+## A — Set up this machine
 
-## Install
-
-This repository is a [pnpm](https://pnpm.io) workspace. Corepack reads the `packageManager`
-field in the root `package.json` and uses the pnpm version pinned there, so everyone (and CI)
-runs the same version.
+Once.
 
 ```sh
-# One-time per machine: activate Corepack so the `pnpm` command uses the pinned version.
 corepack enable
-
-# Install all workspace dependencies (packages/*).
 pnpm install
+pnpm run prepare
 ```
 
-> **Note:** The documentation site under `apps/octo-docs` is an intentionally separate
-> project — it consumes the published `@quadnix/*` packages from the registry rather than the
-> local source. It is not part of the root workspace and is only installed (with its own
-> `pnpm install`, run from inside that directory) when you are working on the docs.
+`prepare` installs the pre-commit hook, which runs the format check, lint, the build with its type
+check, the circular-dependency check, the secrets spec and the docs code-block check.
+
+## B — Build, lint and test
+
+```sh
+pnpm run build
+pnpm run lint
+pnpm test
+```
+
+`octo-aws-cdk`, `octo-event-listeners`, `octo-build` and `octo-templates` import `octo` from its
+`dist`, and `octo-templates` imports `octo-aws-cdk` the same way. **Rebuild what you changed before
+testing what depends on it**, or the suite runs against the old code and still passes.
+
+`pnpm run build` also type-checks every package, tests included, through each package's
+`check:types`.
+
+`pnpm run format` writes what `pnpm run format:check` checks. Lint does not check formatting.
+
+`pnpm run lint:fix` sorts imports, members and keys. A flag passed through `pnpm run` is written
+without `--`: pnpm forwards the separator, and the script then drops the flag.
+
+## C — Run integration tests
+
+Integration specs run real Terraform; `octo-templates`' start LocalStack in Docker.
+
+```sh
+pnpm run test:integration
+```
+
+## D — Run an e2e suite
+
+**Every e2e suite reaches a live AWS account.** `octo-aws-cdk`'s plan and apply nothing;
+`octo-templates`' create real resources and tear them down.
+
+1. Copy the `.env.defaults` beside the suite to `.env` and fill in real values. `.env` is ignored.
+2. Build the packages the suite imports:
+
+   ```sh
+   npx nx run-many -t build --projects=octo,octo-event-listeners,octo-aws-cdk
+   ```
+
+3. Run one spec, by path, from its package:
+
+   ```sh
+   cd packages/octo-templates
+   NODE_OPTIONS=--experimental-vm-modules npx jest --runTestsByPath src/<template>/main.e2e-spec.ts
+   ```
+
+Never `pnpm run test:e2e` — it runs every suite live at once. Never combine `-u` with `-t`: jest then
+deletes the snapshots of every test it skipped. A template's own `README.md`, where it has one,
+holds what is particular to it.
+
+## E — Work in a worktree
+
+For a large change or a hands-free agent run:
+
+```sh
+git worktree add ../ai-worktrees/octo-worktree-<branch> -b ai/<branch>
+WORKTREE=../ai-worktrees/octo-worktree-<branch>
+find . -maxdepth 4 -name node_modules -type d ! -path "*/node_modules/*/node_modules" | \
+  while read src; do
+    mkdir -p "$WORKTREE/$(dirname $src)"
+    ln -s "$(pwd)/$src" "$WORKTREE/$src"
+  done
+```
+
+The symlinks let Nx and Jest resolve packages. Run lint and tests from inside the worktree.
+
+## F — Release
+
+1. Merge to `main` with PR titles per `.github/jobs/validate-pr-title.job.sh`. The commit type sets
+   the bump: `chore` releases nothing.
+2. Run the **Manual Release** workflow on `main`. It versions every changed package, tags, writes
+   the changelog, and publishes to npm.
+
+## Environment variables
+
+Everything outside the code that governs how this repository behaves. A suite's `.env` is read
+through `env-smart`, falling back to the `.env.defaults` beside it.
+
+| Variable                                                                                            | Set by                                        | What it does                                                                                                                                                                                                        |
+|-----------------------------------------------------------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `AWS_ACCOUNT_ID`                                                                                    | a suite's `.env`                              | The account every e2e suite plans or applies into.                                                                                                                                                                  |
+| `AWS_REGION_ID`                                                                                     | `packages/octo-aws-cdk/test/.env`             | The region the module e2es plan into. Template suites hardcode `us-east-1`.                                                                                                                                         |
+| `OCTO_DEFINITION_FILE_PATH`                                                                         | the user, or a `create-app` project's scripts | The `octo.yaml` every lifecycle command boots from. `OctoCliUtility` sets it for the CLI-driven template suites. A relative path is resolved once against the working directory, so `run-action` callbacks find it. |
+| `OCTO_JOURNAL_COMMAND_ID`                                                                           | `JournalEventListener`                        | The running command's id, set for every process it starts, so a `run-action` that Terraform starts mid-apply names that apply as `parentCommandId` in its journal.                                                  |
+| `TF_VAR_OCTO_PROJECT_ROOT`                                                                          | `TerraformUtility`, unless already set        | The working directory, so `terraform.localPath()` paths resolve inside Terragrunt's cache copy of a folder.                                                                                                         |
+| `TG_LOG_CUSTOM_FORMAT`                                                                              | `TerraformUtility`, always                    | Terragrunt's log line layout, its default without the time, since the journal records when each line arrived.                                                                                                       |
+| `TG_LOG_FORMAT`                                                                                     | `TerraformUtility`, always unset              | Unset for every Terragrunt process, so it cannot override `TG_LOG_CUSTOM_FORMAT`.                                                                                                                                   |
+| `TG_PROVIDER_CACHE`                                                                                 | `TerraformUtility`, unless already set        | `1`, so Terragrunt shares one provider cache across folders.                                                                                                                                                        |
+| `TG_TF_PATH`                                                                                        | `TerraformUtility`, from `--terraformBinary`  | Which Terraform or OpenTofu binary Terragrunt runs.                                                                                                                                                                 |
+| `NODE_OPTIONS`                                                                                      | every package's test scripts                  | `--experimental-vm-modules`, which Jest needs to run ESM. Set it yourself when running `jest` directly.                                                                                                             |
+| `OCTO_STAGE`, `OCTO_PHASE`, `OCTO_NAT`, `OCTO_TARGET`, `OCTO_WORK`, `OCTO_CASE`, `OCTO_PROBE_STATE` | you, by hand                                  | Drive the `aws-ecs-server` debugging harnesses; that template's `README.md` describes each.                                                                                                                         |
+| `GH_TOKEN`                                                                                          | a repository secret                           | Checkout and push in **Manual Release**, and the tags and GitHub releases `nx release` creates.                                                                                                                     |

package/dist/app.type.d.ts

@@ -1,8 +1,20 @@
 import type { IDependency } from './functions/dependency/dependency.js';
 import type { ANode } from './functions/node/node.abstract.js';
+import type { AccountSchema } from './models/account/account.schema.js';
+import type { AppSchema } from './models/app/app.schema.js';
+import type { DeploymentSchema } from './models/deployment/deployment.schema.js';
+import type { EnvironmentSchema } from './models/environment/environment.schema.js';
+import type { ExecutionSchema } from './models/execution/execution.schema.js';
+import type { FilesystemSchema } from './models/filesystem/filesystem.schema.js';
+import type { ImageSchema } from './models/image/image.schema.js';
 import type { IModelAction } from './models/model-action.interface.js';
 import type { AModel } from './models/model.abstract.js';
-import type { IModel, IModelReference } from './models/model.interface.js';
+import type { IModel } from './models/model.interface.js';
+import type { PipelineSchema } from './models/pipeline/pipeline.schema.js';
+import type { RegionSchema } from './models/region/region.schema.js';
+import type { ServerSchema } from './models/server/server.schema.js';
+import type { ServiceSchema } from './models/service/service.schema.js';
+import type { SubnetSchema } from './models/subnet/subnet.schema.js';
 import type { AModule } from './modules/module.abstract.js';
 import type { AAnchor } from './overlays/anchor.abstract.js';
 import type { BaseAnchorSchema } from './overlays/anchor.schema.js';
@@ -230,42 +242,136 @@ export type ObjectKeyValue<T> = {
  */
 export type Constructable<T> = new (...args: any[]) => T;
 /**
- * The model graph as written to state.
+ * A class of `T`, abstract or not, i.e. what you pass to name a family of classes.
+ *
+ * @group Types
+ */
+export type AbstractConstructable<T> = abstract new (...args: any[]) => T;
+/**
+ * An anchor as written to state.
+ *
+ * @group Types
+ */
+export type AnchorSerializedOutput = {
+    anchorId: string;
+    parent: {
+        context: string;
+        type: `${NodeType}`;
+    };
+    properties: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * The schema of each base model, by the name it registers with `@Model`.
+ */
+type BaseModelSchemas = {
+    account: AccountSchema;
+    app: AppSchema;
+    deployment: DeploymentSchema;
+    environment: EnvironmentSchema;
+    execution: ExecutionSchema;
+    filesystem: FilesystemSchema;
+    image: ImageSchema;
+    pipeline: PipelineSchema;
+    region: RegionSchema;
+    server: ServerSchema;
+    service: ServiceSchema;
+    subnet: SubnetSchema;
+};
+/**
+ * @internal
+ */
+export type ModelName = keyof BaseModelSchemas;
+/**
+ * The model graph as written to `models.json`.
+ * * `nodeName` names the base model an entry extends, and types its `model` as that base model's
+ * schema. A model's own fields beyond it are not typed.
+ * * `modules` record inputs before references resolve.
  *
  * @group Types
  */
 export type ModelSerializedOutput = {
-    anchors: (AnchorSchema<UnknownAnchor> & {
+    anchors: (AnchorSerializedOutput & {
         className: string;
-        location: IModelReference & {
-            type: NodeType;
+        location: {
+            context: string;
+            type: `${NodeType}`;
         };
     })[];
     dependencies: IDependency[];
     models: {
-        [p: string]: {
+        [context: string]: {
+            [N in ModelName]: {
+                className: string;
+                model: BaseModelSchemas[N];
+                moduleId: string;
+                nodeName: N;
+            };
+        }[ModelName];
+    };
+    modules: {
+        [moduleId: string]: {
             className: string;
-            model: IUnknownModel;
-            moduleId?: string;
+            inputs: {
+                [key: string]: unknown;
+            };
         };
     };
     overlays: {
         className: string;
-        overlay: OverlaySchema<UnknownOverlay>;
+        context: string;
+        moduleId: string;
+        overlay: {
+            anchors: AnchorSerializedOutput[];
+            overlayId: string;
+            properties: {
+                [key: string]: unknown;
+            };
+        };
     }[];
 };
 /**
- * The resource graph as written to state.
+ * A resource as written to state.
+ * * `parentSchemaTranslator` is the source of the function a child reads that parent through.
+ *
+ * @group Types
+ */
+export type ResourceSerializedSchema = {
+    localResourceId: string;
+    parents: {
+        context: string;
+        parentSchemaTranslator?: string;
+    }[];
+    properties: {
+        [key: string]: unknown;
+    };
+    resourceId: string;
+    response: {
+        [key: string]: string;
+    };
+    scope: string[];
+    tags: {
+        [key: string]: string;
+    };
+};
+/**
+ * The resource graph as written to `resources-actual.json` and `resources-old.json`.
+ * * `createdBy` is the context of the model or overlay whose action created the resource.
+ * * `models` record the context of every model and overlay whose action produced the resource.
  *
  * @group Types
  */
 export type ResourceSerializedOutput = {
     dependencies: IDependency[];
     resources: {
-        [p: string]: {
+        [context: string]: {
             className: string;
-            moduleId?: string;
-            resource: BaseResourceSchema;
+            createdBy?: string;
+            kind: 'external' | 'terraform';
+            models: string[];
+            moduleId: string;
+            resource: ResourceSerializedSchema;
         };
     };
 };
@@ -278,6 +384,22 @@ export type ResourceSerializedOutput = {
 export type TerraformFolderOutput = {
     hasExternalResources: boolean;
     moduleId: string;
+    /**
+     * The resources whose terraform state moves into this folder from another before terraform runs,
+     * each with the addresses and output names it moves from and to.
+     */
+    moves?: {
+        addresses: {
+            from: string;
+            to: string;
+        }[];
+        fromModuleId: string;
+        outputs: {
+            from: string;
+            to: string;
+        }[];
+        resourceId: string;
+    }[];
     providers: {
         accountId: string;
         blockHcl: string;
@@ -296,6 +418,10 @@ export type TerraformFolderOutput = {
  * @group Types
  */
 export type TerraformResourceOutput = {
+    /**
+     * Set when destroying the resource loses data, as its class declares.
+     */
+    destroyLosesData?: true;
     moduleId: string;
     resourceContext: string;
     resourceId: string;
@@ -314,10 +440,6 @@ export type TransactionOptions = {
     yieldResourceDiffs?: boolean;
     yieldResourceTransaction?: boolean;
 };
-/**
- * @internal
- */
-export type ModifyInterface<T, R> = Omit<T, keyof R> & R;
 /**
  * The schema of an anchor class.
  *
@@ -344,15 +466,11 @@ export type EnhancedModuleSchema<T extends UnknownModule> = {
 /**
  * @internal
  */
-export type GeneratorYieldType<T extends (...args: any) => AsyncGenerator<any, any, any>> = ReturnType<T> extends AsyncGenerator<infer Y, any, any> ? Y : never;
+export type GeneratorYieldType<T extends (...args: any) => AsyncGenerator<any>> = ReturnType<T> extends AsyncGenerator<infer Y> ? Y : never;
 /**
  * @internal
  */
 export type ModelSchema<T> = T extends AModel<infer S, any> ? S : never;
-/**
- * @internal
- */
-export type ModuleOutput<M> = M extends AModule<any, infer T> ? T : never;
 /**
  * The schema of a module class.
  *
@@ -422,3 +540,4 @@ export type UnknownOverlay = AOverlay<BaseOverlaySchema, any>;
  * @internal
  */
 export type UnknownResource = AResource<any, any>;
+export {};

package/dist/app.type.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.type.js","sourceRoot":"","sources":["../src/app.type.ts"],"names":[],"mappings":"AAeA,aAAa;AAEb;;;;;;;;GAQG;AACH,MAAM,OAAO,cAAc;IACzB;;;OAGG;IACH,YACmB,MAAuB,EACvB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAiB;QACvB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IACxB;;;OAGG;IACH,YACmB,MAAsB,EACtB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAgB;QACtB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,gBAAgB;IAC3B;;;OAGG;IACH,YACmB,MAAyB,EACjC,gBAAmD;QAD3C,WAAM,GAAN,MAAM,CAAmB;QACjC,qBAAgB,GAAhB,gBAAgB,CAAmC;IAC3D,CAAC;IAEJ;;OAEG;IACH,QAAQ,CACN,GAAG,IAAgE;QAEnE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAE9C,IACE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,YAAY,gBAAgB,CAAC;YACzE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAqB,CAAC,UAAU,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,EAC3G,CAAC;YACD,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,SAAS;QAMP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,iCAAiC;QAC/B,OAAO,IAAI,CAAC,iBAAiB,EAA4E,CAAC;IAC5G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED,kBAAkB;AAElB;;GAEG;AACH,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACvB,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,sCAAoB,CAAA;IACpB,0CAAwB,CAAA;IACxB,4CAA0B,CAAA;IAC1B,wCAAsB,CAAA;IACtB,0CAAwB,CAAA;IACxB,0CAAwB,CAAA;IACxB,iCAAe,CAAA;AACjB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB;AAgBD,eAAe;AAEf;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAiB,EAAE,QAAgB;IAC7D,OAAQ,IAAI,CAAC,WAA4B,CAAC,SAAS,KAAK,QAAQ,CAAC;AACnE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAI,KAAa;IACnC,OAAO,KAAU,CAAC;AACpB,CAAC"}
+{"version":3,"file":"app.type.js","sourceRoot":"","sources":["../src/app.type.ts"],"names":[],"mappings":"AA2BA,aAAa;AAEb;;;;;;;;GAQG;AACH,MAAM,OAAO,cAAc;IACzB;;;OAGG;IACH,YACmB,MAAuB,EACvB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAiB;QACvB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IACxB;;;OAGG;IACH,YACmB,MAAsB,EACtB,gBAAoC;QADpC,WAAM,GAAN,MAAM,CAAgB;QACtB,qBAAgB,GAAhB,gBAAgB,CAAoB;IACpD,CAAC;IAEJ;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,gBAAgB;IAC3B;;;OAGG;IACH,YACmB,MAAyB,EACjC,gBAAmD;QAD3C,WAAM,GAAN,MAAM,CAAmB;QACjC,qBAAgB,GAAhB,gBAAgB,CAAmC;IAC3D,CAAC;IAEJ;;OAEG;IACH,QAAQ,CACN,GAAG,IAAgE;QAEnE,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAE9C,IACE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,YAAY,gBAAgB,CAAC;YACzE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAqB,CAAC,UAAU,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,EAC3G,CAAC;YACD,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,SAAS;QAMP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAQ,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,iCAAiC;QAC/B,OAAO,IAAI,CAAC,iBAAiB,EAA4E,CAAC;IAC5G,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;CACF;AAED,kBAAkB;AAElB;;GAEG;AACH,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACvB,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cASX;AATD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,sCAAoB,CAAA;IACpB,0CAAwB,CAAA;IACxB,4CAA0B,CAAA;IAC1B,wCAAsB,CAAA;IACtB,0CAAwB,CAAA;IACxB,0CAAwB,CAAA;IACxB,iCAAe,CAAA;AACjB,CAAC,EATW,cAAc,KAAd,cAAc,QASzB;AAgBD,eAAe;AAEf;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAAiB,EAAE,QAAgB;IAC7D,OAAQ,IAAI,CAAC,WAA4B,CAAC,SAAS,KAAK,QAAQ,CAAC;AACnE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAI,KAAa;IACnC,OAAO,KAAU,CAAC;AACpB,CAAC"}

package/dist/decorators/model.decorator.d.ts

@@ -1,4 +1,4 @@
-import { type Constructable, type ModelSchema, type UnknownModel } from '../app.type.js';
+import { type Constructable, type ModelName, type ModelSchema, type UnknownModel } from '../app.type.js';
 /**
  * A `@Model` is a class decorator and must be placed on top of a class representing a model.
  * - A model must also extend a base model class.
@@ -15,9 +15,7 @@ import { type Constructable, type ModelSchema, type UnknownModel } from '../app.
  * @param packageName - The name of the package under which the model is registered.
  * Selecting a unique package name helps avoid collisions between same model class names across different libraries.
  * You will reuse the same package name throughout your library for different Octo components you create.
- * @param modelName - a string that uniquely represents the base model you are extending.
- * Octo provides names for each of the base models, and you must use the same name.
- * E.g. for region base model, the model name is `region`.
+ * @param modelName - The name of the base model you are extending, e.g. `region` for {@link Region}.
  * @param schema - The schema of the model.
  *
  * @returns The decorated class.
@@ -25,4 +23,4 @@ import { type Constructable, type ModelSchema, type UnknownModel } from '../app.
  * @see Definition of [Models](/docs/fundamentals/models).
  * @see {@link App}, {@link Region}, and {@link Server} for the base models you can extend.
  */
-export declare function Model<T extends UnknownModel>(packageName: string, modelName: string, schema: Constructable<ModelSchema<T>>): (constructor: any) => void;
+export declare function Model<T extends UnknownModel>(packageName: string, modelName: ModelName, schema: Constructable<ModelSchema<T>>): (constructor: any) => void;

package/dist/decorators/model.decorator.js

@@ -20,9 +20,7 @@ import { ValidationUtility } from '../utilities/validation/validation.utility.js
  * @param packageName - The name of the package under which the model is registered.
  * Selecting a unique package name helps avoid collisions between same model class names across different libraries.
  * You will reuse the same package name throughout your library for different Octo components you create.
- * @param modelName - a string that uniquely represents the base model you are extending.
- * Octo provides names for each of the base models, and you must use the same name.
- * E.g. for region base model, the model name is `region`.
+ * @param modelName - The name of the base model you are extending, e.g. `region` for {@link Region}.
  * @param schema - The schema of the model.
  *
  * @returns The decorated class.
@@ -36,9 +34,6 @@ export function Model(packageName, modelName, schema) {
         if (!ValidationUtility.validateRegex(packageName, /^[@A-Za-z][\w-]+[A-Za-z]$/)) {
             throw new Error(`Invalid package name: ${packageName}`);
         }
-        if (!ValidationUtility.validateRegex(modelName, /^[A-Za-z][\w-]+[A-Za-z]$/)) {
-            throw new Error(`Invalid model name: ${modelName}`);
-        }
         if (!(constructor.prototype instanceof AModel) || constructor.prototype instanceof AOverlay) {
             throw new Error(`Class "${constructor.name}" must extend the AModel class!`);
         }

package/dist/decorators/model.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,QAAQ,EAAqB,MAAM,gBAAgB,CAAC;AACnG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,KAAK,CACnB,WAAmB,EACnB,SAAiB,EACjB,MAAqC;IAErC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,SAAS,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC5E,MAAM,IAAI,KAAK,CAAC,uBAAuB,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;YAC5F,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,iCAAiC,CAAC,CAAC;QAC/E,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAClC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"model.decorator.js","sourceRoot":"","sources":["../../src/decorators/model.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwD,QAAQ,EAAqB,MAAM,gBAAgB,CAAC;AACnH,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gEAAgE,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,KAAK,CACnB,WAAmB,EACnB,SAAoB,EACpB,MAAqC;IAErC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC;YAC5F,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,iCAAiC,CAAC,CAAC;QAC/E,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC;QAClC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;QAEvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,CAAC,yBAAyB,EAAE,EAAE;YAC1F,yBAAyB,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/on-event.decorator.d.ts

@@ -1,4 +1,4 @@
-import type { Constructable } from '../app.type.js';
+import type { AbstractConstructable } from '../app.type.js';
 import type { Event } from '../events/index.js';
 /**
  * An `@OnEvent` is a method decorator to listen to an event.
@@ -22,4 +22,4 @@ import type { Event } from '../events/index.js';
  * @param ofType The type of event being listened to.
  * @returns The decorated method.
  */
-export declare function OnEvent(ofType: Constructable<Event<unknown>>): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export declare function OnEvent(ofType: AbstractConstructable<Event<unknown>>): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/decorators/on-event.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"on-event.decorator.js","sourceRoot":"","sources":["../../src/decorators/on-event.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,OAAO,CACrB,MAAqC;IAErC,OAAO,UAAU,MAAW,EAAE,YAAoB,EAAE,UAA8B;QAChF,YAAY,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"on-event.decorator.js","sourceRoot":"","sources":["../../src/decorators/on-event.decorator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,OAAO,CACrB,MAA6C;IAE7C,OAAO,UAAU,MAAW,EAAE,YAAoB,EAAE,UAA8B;QAChF,YAAY,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC3E,CAAC,CAAC;AACJ,CAAC"}

package/dist/decorators/resource.decorator.d.ts

@@ -1,4 +1,11 @@
 import { type Constructable, type ResourceSchema, type UnknownResource } from '../app.type.js';
+/**
+ * Every dot path through `T` that ends at a string, with `[]` after a key holding an array. Below a key
+ * typed `unknown` any path is accepted.
+ */
+type NamePath<T, Depth extends unknown[] = []> = Depth['length'] extends 6 ? never : {
+    [K in keyof T & string]-?: unknown extends T[K] ? K | `${K}.${string}` | `${K}[]` | `${K}[].${string}` : NonNullable<T[K]> extends readonly (infer E)[] ? (NonNullable<E> extends string ? `${K}[]` : never) | (NonNullable<E> extends object ? `${K}[].${NamePath<NonNullable<E>, [...Depth, unknown]>}` : never) : NonNullable<T[K]> extends string ? K : NonNullable<T[K]> extends object ? `${K}.${NamePath<NonNullable<T[K]>, [...Depth, unknown]>}` : never;
+}[keyof T & string];
 /**
  * A `@Resource` is a class decorator and must be placed on top of a class representing a resource.
  * - A resource must also extend the {@link AResource} class.
@@ -10,6 +17,30 @@ import { type Constructable, type ResourceSchema, type UnknownResource } from '.
  * export class MyResource extends AResource<MyResourceSchema, MyResource> { ... }
  * ```
  *
+ * A resource whose properties hold a name the cloud requires unique declares it in `options.uniqueProperties`, and
+ * generate refuses two values of `path` that share the values of `within`, whether they come from two
+ * resources of the class or from one.
+ *
+ * @example
+ * ```ts
+ * @Resource<MyTable>('@example', 'my-table', MyTableSchema, {
+ *   uniqueProperties: [
+ *     { path: 'tableName', within: ['accountId', 'regionId'] },
+ *     { path: 'indexes[].name', within: ['accountId', 'regionId'] },
+ *   ],
+ * })
+ * export class MyTable extends AResource<MyTableSchema, MyTable> { ... }
+ * ```
+ *
+ * A resource holding data octo cannot put back from its inputs - a table's rows, a filesystem's files -
+ * sets `options.destroyLosesData`, and every destroy terraform plans of it is reported as losing data.
+ *
+ * @example
+ * ```ts
+ * @Resource<MyTable>('@example', 'my-table', MyTableSchema, { destroyLosesData: true })
+ * export class MyTable extends AResource<MyTableSchema, MyTable> { ... }
+ * ```
+ *
  * @group Decorators
  *
  * @param packageName - The name of the package under which the resource is registered.
@@ -17,9 +48,27 @@ import { type Constructable, type ResourceSchema, type UnknownResource } from '.
  * You will reuse the same package name throughout your library for different Octo components you create.
  * @param resourceName - a string that uniquely represents the name of the resource.
  * @param schema - The schema of the resource.
+ * @param options - Optional settings of the resource.
+ * `destroyLosesData` marks the resource as holding data that is lost when it is destroyed. Validate,
+ * and apply's check for destroys, add a message to each destroy of it, whatever the cause.
+ *
+ * `uniqueProperties` lists the names the cloud requires unique, one entry per name.
+ * - `path` is a dot path through the resource's properties, with `[]` after a key holding an array.
+ *   A resource with no value at `path` is not checked.
+ * - `within` names the properties whose values form the name's domain. A resource missing one is refused.
+ *   An empty `within` makes the name unique across the app.
+ *
+ * Only resources of one class are compared with each other, and a class declaring no names is not checked.
  *
  * @returns The decorated class.
  *
  * @see Definition of [Resources](/docs/fundamentals/resources).
  */
-export declare function Resource<T extends UnknownResource>(packageName: string, resourceName: string, schema: Constructable<ResourceSchema<T>>): (constructor: any) => void;
+export declare function Resource<T extends UnknownResource>(packageName: string, resourceName: string, schema: Constructable<ResourceSchema<T>>, { destroyLosesData, uniqueProperties, }?: {
+    destroyLosesData?: boolean;
+    uniqueProperties?: {
+        path: NamePath<ResourceSchema<T>['properties']>;
+        within: (keyof ResourceSchema<T>['properties'] & string)[];
+    }[];
+}): (constructor: any) => void;
+export {};

package/dist/decorators/resource.decorator.js

@@ -14,6 +14,30 @@ import { ValidationUtility } from '../utilities/validation/validation.utility.js
  * export class MyResource extends AResource<MyResourceSchema, MyResource> { ... }
  * ```
  *
+ * A resource whose properties hold a name the cloud requires unique declares it in `options.uniqueProperties`, and
+ * generate refuses two values of `path` that share the values of `within`, whether they come from two
+ * resources of the class or from one.
+ *
+ * @example
+ * ```ts
+ * @Resource<MyTable>('@example', 'my-table', MyTableSchema, {
+ *   uniqueProperties: [
+ *     { path: 'tableName', within: ['accountId', 'regionId'] },
+ *     { path: 'indexes[].name', within: ['accountId', 'regionId'] },
+ *   ],
+ * })
+ * export class MyTable extends AResource<MyTableSchema, MyTable> { ... }
+ * ```
+ *
+ * A resource holding data octo cannot put back from its inputs - a table's rows, a filesystem's files -
+ * sets `options.destroyLosesData`, and every destroy terraform plans of it is reported as losing data.
+ *
+ * @example
+ * ```ts
+ * @Resource<MyTable>('@example', 'my-table', MyTableSchema, { destroyLosesData: true })
+ * export class MyTable extends AResource<MyTableSchema, MyTable> { ... }
+ * ```
+ *
  * @group Decorators
  *
  * @param packageName - The name of the package under which the resource is registered.
@@ -21,12 +45,23 @@ import { ValidationUtility } from '../utilities/validation/validation.utility.js
  * You will reuse the same package name throughout your library for different Octo components you create.
  * @param resourceName - a string that uniquely represents the name of the resource.
  * @param schema - The schema of the resource.
+ * @param options - Optional settings of the resource.
+ * `destroyLosesData` marks the resource as holding data that is lost when it is destroyed. Validate,
+ * and apply's check for destroys, add a message to each destroy of it, whatever the cause.
+ *
+ * `uniqueProperties` lists the names the cloud requires unique, one entry per name.
+ * - `path` is a dot path through the resource's properties, with `[]` after a key holding an array.
+ *   A resource with no value at `path` is not checked.
+ * - `within` names the properties whose values form the name's domain. A resource missing one is refused.
+ *   An empty `within` makes the name unique across the app.
+ *
+ * Only resources of one class are compared with each other, and a class declaring no names is not checked.
  *
  * @returns The decorated class.
  *
  * @see Definition of [Resources](/docs/fundamentals/resources).
  */
-export function Resource(packageName, resourceName, schema) {
+export function Resource(packageName, resourceName, schema, { destroyLosesData = false, uniqueProperties = [], } = {}) {
     const container = Container.getInstance();
     return function (constructor) {
         if (!ValidationUtility.validateRegex(packageName, /^[@A-Za-z][\w-]+[A-Za-z]$/)) {
@@ -38,10 +73,12 @@ export function Resource(packageName, resourceName, schema) {
         if (!(constructor.prototype instanceof AResource)) {
             throw new Error(`Class "${constructor.name}" must extend the AResource class!`);
         }
+        constructor.DESTROY_LOSES_DATA = destroyLosesData;
         constructor.NODE_NAME = resourceName;
         constructor.NODE_PACKAGE = packageName;
         constructor.NODE_SCHEMA = schema;
         constructor.NODE_TYPE = NodeType.RESOURCE;
+        constructor.UNIQUE_PROPERTIES = uniqueProperties.map(({ path, within }) => ({ path, within: [...within] }));
         const promise = container.get(ResourceSerializationService).then((resourceSerializationService) => {
             resourceSerializationService.registerClass(`${packageName}/${constructor.name}`, constructor);
         });

package/dist/decorators/resource.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource.decorator.js","sourceRoot":"","sources":["../../src/decorators/resource.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,QAAQ,EAA6C,MAAM,gBAAgB,CAAC;AACzG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,sEAAsE,CAAC;AACpH,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,QAAQ,CACtB,WAAmB,EACnB,YAAoB,EACpB,MAAwC;IAExC,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,YAAY,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,SAAS,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,oCAAoC,CAAC,CAAC;QAClF,CAAC;QAED,WAAW,CAAC,SAAS,GAAG,YAAY,CAAC;QACrC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAE1C,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,IAAI,CAAC,CAAC,4BAA4B,EAAE,EAAE;YAChG,4BAA4B,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"resource.decorator.js","sourceRoot":"","sources":["../../src/decorators/resource.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,QAAQ,EAA6C,MAAM,gBAAgB,CAAC;AACzG,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,sEAAsE,CAAC;AACpH,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAsBlF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,MAAM,UAAU,QAAQ,CACtB,WAAmB,EACnB,YAAoB,EACpB,MAAwC,EACxC,EACE,gBAAgB,GAAG,KAAK,EACxB,gBAAgB,GAAG,EAAE,MAOnB,EAAE;IAEN,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAE1C,OAAO,UAAU,WAAgB;QAC/B,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,WAAW,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,YAAY,EAAE,0BAA0B,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,CAAC,CAAC,WAAW,CAAC,SAAS,YAAY,SAAS,CAAC,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,UAAU,WAAW,CAAC,IAAI,oCAAoC,CAAC,CAAC;QAClF,CAAC;QAED,WAAW,CAAC,kBAAkB,GAAG,gBAAgB,CAAC;QAClD,WAAW,CAAC,SAAS,GAAG,YAAY,CAAC;QACrC,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QACvC,WAAW,CAAC,WAAW,GAAG,MAAM,CAAC;QACjC,WAAW,CAAC,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAC1C,WAAW,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5G,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,IAAI,CAAC,CAAC,4BAA4B,EAAE,EAAE;YAChG,4BAA4B,CAAC,aAAa,CAAC,GAAG,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC"}

package/dist/errors/schema.error.d.ts

@@ -5,9 +5,16 @@
  */
 export declare class SchemaError extends Error {
     readonly schemaClassName: string;
+    /**
+     * What a validator threw underneath, where this error is wrapping one. Carried as a property of
+     * its own rather than as the `Error` cause: without it a nested property's failure reads only as
+     * the name of the top-level input it arrived under, and which value failed is the whole question.
+     */
+    readonly validationError?: unknown;
     /**
      * @param message The error message.
      * @param schemaClassName The schema the value was being read as.
+     * @param validationError What a validator threw underneath, where there is one.
      */
-    constructor(message: string, schemaClassName: string);
+    constructor(message: string, schemaClassName: string, validationError?: unknown);
 }