@aws/cloudformation-validate 1.5.1-beta → 1.7.0-beta

package/README.md

@@ -1,31 +1,46 @@
-# CloudFormation Validate WASM Bindings
+# CloudFormation Validate for Node.js
 
-WASM bindings for [`cloudformation-validate`](https://github.com/aws-cloudformation/cloudformation-validate). Compiles
-the full validation pipeline —
-template parser, schema validator, Rego engine, and CEL engine — into a single `.wasm` module for Node.js.
+Validate AWS CloudFormation templates from JavaScript or TypeScript and catch schema violations, security risks, and
+best-practice findings before deployment — in your editor, build, or CI.
 
-All WASM objects must be explicitly freed via `.free()` to release memory.
+- **Offline** — all rules and resource schemas are bundled.
+- **Fast** — sub-second validation per template.
 
-For a complete, runnable example, see
-[examples](https://github.com/aws-cloudformation/cloudformation-validate/tree/main/src/bindings-wasm/examples).
+## Installation
 
-## Engine
+Available on [npm](https://www.npmjs.com/package/@aws/cloudformation-validate) as `@aws/cloudformation-validate`.
 
-`RegoEngine` and `CelEngine` both implement the `Engine` interface. They are interchangeable — both produce identical
-diagnostics for the same template and config.
+```bash
+npm install @aws/cloudformation-validate
+```
+
+## Quick start
+
+Engines, models, and validators hold off-heap memory — call `.free()` when done with each object:
 
 ```typescript
-import { RegoEngine, CelEngine, TemplateFile } from "@aws/cloudformation-validate";
+import { RegoEngine, TemplateFile } from "@aws/cloudformation-validate";
 
 const engine = new RegoEngine();
-const report = engine.validateStandard(new TemplateFile("template.yaml"));
-
-for (const d of report.diagnostics) {
-    console.log(`[${d.severity}] ${d.ruleId}: ${d.message}`);
+try {
+    const report = engine.validateStandard(new TemplateFile("template.yaml"));
+    for (const d of report.diagnostics) {
+        console.log(`[${d.severity}] ${d.ruleId}: ${d.message}`);
+    }
+} finally {
+    engine.free();
 }
-engine.free();
 ```
 
+Each diagnostic identifies the rule, severity, affected resource and property, and source location — see
+[StandardDiagnostic](#standarddiagnostic). A complete, runnable project is in
+[examples](https://github.com/aws-cloudformation/cloudformation-validate/tree/main/src/bindings-wasm/examples).
+
+## Engine
+
+`RegoEngine` and `CelEngine` both implement the `Engine` interface and are interchangeable — they produce identical
+diagnostics for the same template and config.
+
 ### `Engine` interface
 
 | Method                                | Returns          | Description                                                                                                      |
@@ -34,22 +49,62 @@ engine.free();
 | `validateDetailed(template, config?)` | `DetailedReport` | Validates and returns diagnostics with documentation URLs, rule descriptions, phase tags, and `ViolationContext` |
 | `listRules()`                         | `RuleInfo[]`     | Returns metadata for every built-in and loaded custom rule                                                       |
 | `engineName()`                        | `string`         | `"rego"` or `"cel"`                                                                                              |
-| `free()`                              | `void`           | Releases WASM memory                                                                                             |
+| `free()`                              | `void`           | Releases the engine's off-heap memory                                                                            |
 
 ### `EngineConfig`
 
-Passed to the constructor. All fields optional, default to empty arrays.
+Passed to the constructor. All fields are optional; omitted rule arrays are empty and an omitted
+`schemaValidatorConfig` uses only the bundled schemas.
 
 ```typescript
 interface EngineConfig {
-    customRules?: ExternalRuleSource[];  // engine-native rules (Rego for RegoEngine, CEL for CelEngine)
-    guardRules?: ExternalRuleSource[];   // CloudFormation Guard DSL rules — translated internally by each engine
+    customRules?: RuleSource[];                       // engine-native rules (Rego for RegoEngine, CEL for CelEngine)
+    guardRules?: RuleSource[];                        // CloudFormation Guard DSL rules — translated internally
+    schemaValidatorConfig?: SchemaValidatorConfig;   // schema validation and overlay configuration
+}
+
+interface SchemaValidatorConfig {
+    additionalSchemas?: SchemaSource[];   // resource provider schemas merged over the bundled schemas
+}
+
+type RuleSource = ExternalRuleSource | RuleFile;
+type SchemaSource = AdditionalSchemaSource | SchemaFile;
+
+class RuleFile {
+    constructor(path: string);   // rule file read from disk; the path becomes the rule source name
+}
+
+class SchemaFile {
+    constructor(path: string, typeName?: string); // schema file; typeName defaults to the value inside the JSON
 }
 
 interface ExternalRuleSource {
     name: string;     // identifier shown in diagnostics (e.g. file path)
     content: string;  // full rule source text
 }
+
+interface AdditionalSchemaSource {
+    typeName?: string; // omit to use the typeName inside the schema JSON
+    schema: string;    // complete resource provider schema JSON
+}
+```
+
+Pass a `RuleFile` to load a rule from disk — the same pattern as `TemplateFile` for templates — or an
+`ExternalRuleSource` when you already have the rule text in memory. `SchemaFile` does the same for an additional
+resource provider schema. Its optional constructor `typeName` may be omitted when the schema JSON contains its own
+`typeName`.
+
+The generated `AdditionalSchemaSource` record exposes `typeName` as an optional field. Omit it (or leave the
+`SchemaFile` constructor argument unset) for an in-memory schema whose JSON already contains its own `typeName`.
+
+```typescript
+const engine = new CelEngine({
+    customRules: [new RuleFile("rules/s3_encryption.json")],
+    guardRules: [new RuleFile("rules/compliance.guard")],
+    schemaValidatorConfig: {
+        additionalSchemas: [new SchemaFile("schemas/aws-lambda-function.json")],
+    },
+});
 ```
 
 ## ValidateConfig
@@ -90,13 +145,15 @@ interface RuleFilterConfig {
     idRanges?: IdRange[];              // numeric ranges, e.g. { prefix: "E", start: 3000, end: 3099 }
     idPatterns?: string[];             // regex patterns matched against rule IDs
     resourceIds?: ResourceIdFilter[];  // a rule (or every rule) on a logical resource ID
+    logicalIds?: LogicalIdFilter[];    // a rule (or every rule) on a named template entity
     resourceTypes?: ResourceTypeFilter[]; // a rule (or every rule) on a resource type
     services?: ServiceFilter[];        // a rule (or every rule) on a service, e.g. "AWS::AutoScaling"
 }
 
-// resourceIds / resourceTypes / services each carry an optional ruleId:
+// resourceIds / logicalIds / resourceTypes / services each carry an optional ruleId:
 // set it to scope the filter to one rule, or omit it for every rule on the target.
 interface ResourceIdFilter   { ruleId?: string; resourceId: string; }
+interface LogicalIdFilter    { ruleId?: string; logicalId: string; entityType?: EntityType; }
 interface ResourceTypeFilter { ruleId?: string; resourceType: string; }
 interface ServiceFilter      { ruleId?: string; service: string; }
 ```
@@ -104,6 +161,11 @@ interface ServiceFilter      { ruleId?: string; service: string; }
 The `service` is matched verbatim against the `service-provider::service-name` prefix of the resource type — its first
 two `::`-delimited segments (e.g. `AWS::AutoScaling` in `AWS::AutoScaling::LaunchConfiguration`).
 
+The `resourceIds` dimension matches only diagnostics attributed to a resource; `logicalIds` additionally matches
+diagnostics on parameters, outputs, mappings, conditions, and template rules (for resource diagnostics the two carry
+the same value). An optional `entityType` scopes a `LogicalIdFilter` to entities of one type, so `MyThing` as a
+`"Parameter"` is matched without touching a same-named entity of another type.
+
 ### PseudoParameterOverrides
 
 Override CloudFormation pseudo-parameters used during intrinsic function resolution. All fields optional — when
@@ -185,7 +247,7 @@ interface StandardReport {
 ```
 
 `DetailedReport` has the same structure but its diagnostics include additional fields: `documentationUrl`,
-`ruleDescription`, `phase` (`PARSE` | `SCHEMA` | `LINT`), `section`, and `context` (`ViolationContext` with
+`ruleDescription`, `phase` (`PARSE` | `SCHEMA` | `LINT`), and `context` (`ViolationContext` with
 `actualValue`, `expectedConstraint`, `resolutionSource`, etc.).
 
 ### StandardDiagnostic
@@ -196,9 +258,8 @@ interface StandardDiagnostic {
     severity: Severity;                // "FATAL" | "ERROR" | "WARN" | "INFO" | "DEBUG"
     message: string;
     source: RuleOrigin;                // "SCHEMA" | "CFN_LINT" | "ENGINE" | "CUSTOM" | "GUARD"
-    resourceId?: string;               // logical resource ID
-    resourceType?: string;             // e.g. "AWS::S3::Bucket"
-    propertyPath?: string;             // e.g. "Properties/BucketName"
+    entity?: Entity;                   // the named template entity the finding targets, if any
+    propertyPath?: string;             // e.g. "Properties.BucketName", or section-absolute like "Parameters/MyParam/Type"
     suggestedFix?: string;
     category?: string;
     startLine?: number;
@@ -208,4 +269,15 @@ interface StandardDiagnostic {
     relatedResources?: RelatedResource[];
     conditionScenario?: Record<string, boolean>;  // condition truth assignment that triggers this diagnostic
 }
+
+// The named template entity a diagnostic is attributed to. The entity type is the
+// singular form of the top-level template section the entity is declared in.
+interface Entity {
+    logicalId: string;                 // logical ID as declared in the template
+    entityType: EntityType;
+    resourceType?: string;             // CloudFormation type, when the entity is a resource whose type is known
+}
+
+type EntityType = "Resource" | "Parameter" | "Output" | "Mapping" | "Metadata"
+                | "Rule" | "Condition" | "Transform" | "FormatVersion" | "Description";
 ```

package/THIRD-PARTY-LICENSES.txt

@@ -84,7 +84,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ******************************
 
 anyhow
-1.0.103 <https://github.com/dtolnay/anyhow>
+1.0.104 <https://github.com/dtolnay/anyhow>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -3445,7 +3445,7 @@ the following restrictions:
 ******************************
 
 futures-core
-0.3.32 <https://github.com/rust-lang/futures-rs>
+0.3.33 <https://github.com/rust-lang/futures-rs>
                               Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/
@@ -3653,7 +3653,7 @@ limitations under the License.
 ******************************
 
 futures-task
-0.3.32 <https://github.com/rust-lang/futures-rs>
+0.3.33 <https://github.com/rust-lang/futures-rs>
                               Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/
@@ -3861,7 +3861,7 @@ limitations under the License.
 ******************************
 
 futures-util
-0.3.32 <https://github.com/rust-lang/futures-rs>
+0.3.33 <https://github.com/rust-lang/futures-rs>
                               Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/
@@ -6789,7 +6789,7 @@ limitations under the License.
 ******************************
 
 memchr
-2.8.2 <https://github.com/BurntSushi/memchr>
+2.8.3 <https://github.com/BurntSushi/memchr>
 The MIT License (MIT)
 
 Copyright (c) 2015 Andrew Gallant
@@ -7361,7 +7361,7 @@ SOFTWARE.
 ******************************
 
 num-bigint
-0.4.7 <https://github.com/rust-num/num-bigint>
+0.4.8 <https://github.com/rust-num/num-bigint>
                               Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/
@@ -8968,7 +8968,7 @@ limitations under the License.
 ******************************
 
 proc-macro2
-1.0.106 <https://github.com/dtolnay/proc-macro2>
+1.0.107 <https://github.com/dtolnay/proc-macro2>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -9047,7 +9047,7 @@ limitations under the License.
 ******************************
 
 quote
-1.0.46 <https://github.com/dtolnay/quote>
+1.0.47 <https://github.com/dtolnay/quote>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -9126,7 +9126,7 @@ limitations under the License.
 ******************************
 
 rand
-0.9.4 <https://github.com/rust-random/rand>
+0.9.5 <https://github.com/rust-random/rand>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -9477,7 +9477,7 @@ APPENDIX: How to apply the Apache License to your work.
 ******************************
 
 regex
-1.12.4 <https://github.com/rust-lang/regex>
+1.13.1 <https://github.com/rust-lang/regex>
                               Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/
@@ -9684,7 +9684,7 @@ limitations under the License.
 ******************************
 
 regex-automata
-0.4.14 <https://github.com/rust-lang/regex>
+0.4.16 <https://github.com/rust-lang/regex>
                               Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/
@@ -10752,7 +10752,7 @@ limitations under the License.
 ******************************
 
 serde
-1.0.228 <https://github.com/serde-rs/serde>
+1.0.229 <https://github.com/serde-rs/serde>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -10858,7 +10858,7 @@ SOFTWARE.
 ******************************
 
 serde_core
-1.0.228 <https://github.com/serde-rs/serde>
+1.0.229 <https://github.com/serde-rs/serde>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -10937,7 +10937,7 @@ limitations under the License.
 ******************************
 
 serde_derive
-1.0.228 <https://github.com/serde-rs/serde>
+1.0.229 <https://github.com/serde-rs/serde>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -11095,7 +11095,7 @@ limitations under the License.
 ******************************
 
 serde_json
-1.0.150 <https://github.com/serde-rs/json>
+1.0.151 <https://github.com/serde-rs/json>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -11491,7 +11491,7 @@ limitations under the License.
 ******************************
 
 spin
-0.9.8 <https://github.com/mvdnes/spin-rs.git>
+0.9.9 <https://github.com/mvdnes/spin-rs.git>
 The MIT License (MIT)
 
 Copyright (c) 2014 Mathijs van de Nes
@@ -11517,7 +11517,86 @@ SOFTWARE.
 ******************************
 
 syn
-2.0.118 <https://github.com/dtolnay/syn>
+2.0.119 <https://github.com/dtolnay/syn>
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+******************************
+
+syn
+3.0.3 <https://github.com/dtolnay/syn>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -11675,7 +11754,7 @@ limitations under the License.
 ******************************
 
 thiserror
-2.0.18 <https://github.com/dtolnay/thiserror>
+2.0.19 <https://github.com/dtolnay/thiserror>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -11833,7 +11912,7 @@ limitations under the License.
 ******************************
 
 thiserror-impl
-2.0.18 <https://github.com/dtolnay/thiserror>
+2.0.19 <https://github.com/dtolnay/thiserror>
 Apache License
 Version 2.0, January 2004
 http://www.apache.org/licenses/
@@ -12276,7 +12355,7 @@ THE SOFTWARE.
 ******************************
 
 uuid
-1.23.4 <https://github.com/uuid-rs/uuid>
+1.24.0 <https://github.com/uuid-rs/uuid>
                               Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/
@@ -13923,7 +14002,7 @@ END OF TERMS AND CONDITIONS
 ******************************
 
 zerocopy
-0.8.52 <https://github.com/google/zerocopy>
+0.8.55 <https://github.com/google/zerocopy>
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -14131,7 +14210,7 @@ zerocopy
 ******************************
 
 zmij
-1.0.21 <https://github.com/dtolnay/zmij>
+1.0.23 <https://github.com/dtolnay/zmij>
 Permission is hereby granted, free of charge, to any
 person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the

package/bindings_wasm.d.ts

@@ -191,6 +191,18 @@ export interface DiagnosticResource {
      * Property paths containing ${...} text that is not an Fn::Sub variable and is left as a literal.
      */
     unsubstitutedVariables: PathVariable[];
+    /**
+     * Fn::Sub map keys not referenced in the template string, each with its path and the unused key name.
+     */
+    unusedSubKeys: PathVariable[];
+    /**
+     * Property values that are a raw pseudo-parameter string instead of using Ref, each with its path and the pseudo-parameter name.
+     */
+    rawPseudoParams: PathVariable[];
+    /**
+     * Property paths containing a {{resolve:secretsmanager:...}} dynamic reference.
+     */
+    secretsmanagerRefPaths: string[];
     /**
      * References whose target does not resolve to any resource or parameter, each with its path and unresolved target.
      */
@@ -235,6 +247,7 @@ export interface RuleFilterConfig {
      */
     idPatterns?: string[];
     resourceIds?: ResourceIdFilter[];
+    logicalIds?: LogicalIdFilter[];
     resourceTypes?: ResourceTypeFilter[];
     services?: ServiceFilter[];
 }
@@ -257,6 +270,31 @@ export interface DiagnosticCondition {
     mutexWith?: string[];
 }
 
+/**
+ * A single additional CloudFormation resource provider schema to overlay on top
+ * of the bundled schemas.
+ *
+ * `type_name` identifies the resource type (e.g., `\"AWS::Lambda::Function\"`).
+ * When absent (`None`), the `typeName` field inside the schema JSON is used
+ * instead. When both are present they must agree.
+ *
+ * `schema` is the complete resource provider schema as a JSON string, in the
+ * standard CloudFormation registry format.
+ */
+export interface AdditionalSchemaSource {
+    /**
+     * The resource type name (e.g., `\"AWS::Lambda::Function\"`). When absent, the
+     * `typeName` field of the schema JSON is used instead. When both are
+     * present they must agree.
+     */
+    typeName?: string;
+    /**
+     * The complete resource provider schema as a JSON string, in the standard
+     * CloudFormation registry format.
+     */
+    schema: string;
+}
+
 /**
  * A single assertion within a template rule.
  */
@@ -386,6 +424,25 @@ export interface ResolvedResource {
     diagnostics: ResourceDiagnostics;
 }
 
+/**
+ * A top-level CloudFormation template section, as documented in the template
+ * anatomy (<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>).
+ *
+ * This is the canonical, single definition of the section names — section
+ * constants in other crates derive from it.
+ */
+export type TopLevelSection =
+    | 'Resources'
+    | 'Parameters'
+    | 'Outputs'
+    | 'Mappings'
+    | 'Metadata'
+    | 'Rules'
+    | 'Conditions'
+    | 'Transform'
+    | 'FormatVersion'
+    | 'Description';
+
 /**
  * Advanced introspection view of a parsed CloudFormation template: its reference graph,
  * conditions, and resolved resources and outputs.
@@ -547,6 +604,19 @@ export interface RelatedResource {
     message: string;
 }
 
+/**
+ * Configuration for constructing a [`SchemaValidator`] with optional overlay
+ * schemas. Bindings and the CLI use this to build the validator separately from
+ * the rule engine.
+ */
+export interface SchemaValidatorConfig {
+    /**
+     * Additional CloudFormation resource provider schemas to merge on top of the
+     * bundled schemas before schema validation.
+     */
+    additionalSchemas?: AdditionalSchemaSource[];
+}
+
 /**
  * Controls the level of detail in validation output.
  */
@@ -661,6 +731,18 @@ export interface ResourceDiagnostics {
      * Occurrences of ${...} placeholders outside an Fn::Sub that will not be substituted; each pairs the property path with the placeholder text.
      */
     unsubstitutedVariables: PathValuePair[];
+    /**
+     * Fn::Sub map keys not referenced in the template string; each pairs the property path with the unused key name.
+     */
+    unusedSubKeys: PathValuePair[];
+    /**
+     * Property values that are a raw pseudo-parameter string (e.g. \"AWS::Region\") instead of using Ref.
+     */
+    rawPseudoParams: PathValuePair[];
+    /**
+     * Property paths containing a {{resolve:secretsmanager:...}} dynamic reference.
+     */
+    secretsmanagerRefPaths: string[];
     /**
      * References whose target is not a defined resource, parameter, or pseudo parameter; each pairs the property path with the missing target name.
      */
@@ -705,6 +787,19 @@ export interface ResourceIdFilter {
     resourceId: string;
 }
 
+/**
+ * Suppress a rule for a specific named template entity — a resource,
+ * parameter, output, mapping, condition, or template rule — identified by its
+ * logical ID. An absent `rule_id` scopes the filter to every rule on that
+ * entity; an absent `entity_type` scopes it to entities of every type with
+ * that logical ID.
+ */
+export interface LogicalIdFilter {
+    ruleId?: string;
+    logicalId: string;
+    entityType?: EntityType;
+}
+
 /**
  * Suppress a rule for a specific resource type. An absent `rule_id` scopes the
  * filter to every rule on that type.
@@ -729,6 +824,43 @@ export interface ServiceFilter {
     service: string;
 }
 
+/**
+ * The kind of template entity a diagnostic targets — the singular form of the
+ * top-level section the entity is declared in. Every documented section has a
+ * variant; the ones whose children are addressable by logical ID (resources,
+ * parameters, outputs, mappings, conditions, rules, and metadata keys) are
+ * the ones diagnostics attribute findings to today.
+ */
+export type EntityType =
+    | 'Resource'
+    | 'Parameter'
+    | 'Output'
+    | 'Mapping'
+    | 'Metadata'
+    | 'Rule'
+    | 'Condition'
+    | 'Transform'
+    | 'FormatVersion'
+    | 'Description';
+
+/**
+ * The named template entity a diagnostic is attributed to, when it targets
+ * one. The entity type is the singular form of the top-level template
+ * section the entity is declared in.
+ */
+export interface Entity {
+    /**
+     * Logical ID of the entity as declared in the template.
+     */
+    logicalId: string;
+    entityType: EntityType;
+    /**
+     * CloudFormation resource type, when the entity is a resource whose type
+     * is known.
+     */
+    resourceType?: string;
+}
+
 /**
  * The template resource a diagnostic is attributed to, when it targets one.
  */
@@ -810,7 +942,7 @@ export interface PseudoParameterOverrides {
 export type RuleOrigin = 'SCHEMA' | 'CFN_LINT' | 'ENGINE' | 'CUSTOM' | 'GUARD';
 
 /**
- *r" A single validation finding with its resource and source location flattened into individual fields.
+ *r" A single validation finding with its source location flattened into individual fields.
  */
 export interface StandardDiagnostic {
     /**
@@ -824,10 +956,9 @@ export interface StandardDiagnostic {
      */
     source: RuleOrigin;
     /**
-     * Logical ID of the resource this finding targets, if any.
+     * The named template entity this finding targets — a resource, parameter, output, mapping, condition, or template rule — if any.
      */
-    resourceId?: string;
-    resourceType?: string;
+    entity?: Entity;
     /**
      * Path to the offending property within the resource, such as \'Properties.Name\'.
      */
@@ -863,10 +994,9 @@ export interface DetailedDiagnostic {
      */
     source: RuleOrigin;
     /**
-     * Logical ID of the resource this finding targets, if any.
+     * The named template entity this finding targets — a resource, parameter, output, mapping, condition, or template rule — if any.
      */
-    resourceId?: string;
-    resourceType?: string;
+    entity?: Entity;
     /**
      * Path to the offending property within the resource, such as \'Properties.Name\'.
      */
@@ -888,10 +1018,6 @@ export interface DetailedDiagnostic {
     documentationUrl?: string;
     ruleDescription?: string;
     phase?: Phase;
-    /**
-     *r" Top-level template section the finding falls under, such as 'Resources' or 'Parameters'.
-     */
-    section?: string;
     context?: ViolationContext;
 }
 
@@ -904,6 +1030,13 @@ export interface EngineConfig {
      * Guard DSL rules as raw source text, usable regardless of the selected engine.
      */
     guardRules?: ExternalRuleSource[];
+    /**
+     * Optional schema validator configuration. A standalone engine derives its
+     * schema-aware rule metadata from this config. Language APIs also use it to
+     * construct the schema validator bundled with the engine, so both components
+     * observe the same additional schemas.
+     */
+    schemaValidatorConfig?: SchemaValidatorConfig;
 }
 
 export interface MapEntry {
@@ -984,7 +1117,7 @@ export class WasmSchemaValidator {
     free(): void;
     [Symbol.dispose](): void;
     listRules(): any;
-    constructor();
+    constructor(config: SchemaValidatorConfig);
     schemaCount(): number;
     validate(model: WasmSemanticModel, region?: string | null): any;
 }

package/bindings_wasm.js

@@ -193,9 +193,15 @@ class WasmSchemaValidator {
         }
         return takeFromExternrefTable0(ret[0]);
     }
-    constructor() {
-        const ret = wasm.wasmschemavalidator_new();
-        this.__wbg_ptr = ret;
+    /**
+     * @param {SchemaValidatorConfig} config
+     */
+    constructor(config) {
+        const ret = wasm.wasmschemavalidator_new(config);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0];
         WasmSchemaValidatorFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }

package/bindings_wasm_bg.wasm.d.ts

@@ -46,7 +46,7 @@ export const wasmregoengine_validateStandard: (
     f: number,
 ) => [number, number, number];
 export const wasmschemavalidator_listRules: (a: number) => [number, number, number];
-export const wasmschemavalidator_new: () => number;
+export const wasmschemavalidator_new: (a: any) => [number, number, number];
 export const wasmschemavalidator_schemaCount: (a: number) => number;
 export const wasmschemavalidator_validate: (a: number, b: number, c: number, d: number) => [number, number, number];
 export const wasmsemanticmodel_conditions: (a: number) => [number, number, number];

package/index.d.ts

@@ -1,7 +1,8 @@
 import type {
     DetailedReport,
     DiagnosticModel,
-    EngineConfig,
+    AdditionalSchemaSource,
+    ExternalRuleSource,
     ParameterInfo,
     ResolvedOutput,
     ResolvedResource,
@@ -17,11 +18,14 @@ export type {
     RuleOrigin,
     IdRange,
     ResourceIdFilter,
+    LogicalIdFilter,
     ResourceTypeFilter,
     ServiceFilter,
     RuleFilterConfig,
     RuleInfo,
     SourceSpan,
+    Entity,
+    EntityType,
     ResourceRef,
     RelatedResource,
     ViolationContext,
@@ -34,9 +38,9 @@ export type {
     StandardReport,
     DetailedReport,
     PseudoParameterOverrides,
-    EngineConfig,
     ValidateConfig,
     ExternalRuleSource,
+    AdditionalSchemaSource,
     ResolvedValue,
     RefKind,
     ParameterInfo,
@@ -87,6 +91,46 @@ export declare class TemplateFile {
     constructor(path: string);
     readBytes(): Uint8Array;
 }
+export declare class RuleFile {
+    readonly path: string;
+    constructor(path: string);
+    readContent(): string;
+}
+export type RuleSource = ExternalRuleSource | RuleFile;
+/**
+ * A CloudFormation resource provider schema loaded from a file, for use as an
+ * overlay. `typeName` may be omitted to use the `typeName` inside the file.
+ */
+export declare class SchemaFile {
+    readonly path: string;
+    readonly typeName?: string | undefined;
+    constructor(path: string, typeName?: string | undefined);
+    readContent(): string;
+}
+export type SchemaSource = AdditionalSchemaSource | SchemaFile;
+export interface EngineConfig {
+    /** Engine-native rules (Rego for RegoEngine, CEL for CelEngine). */
+    customRules?: RuleSource[];
+    /** CloudFormation Guard DSL rules, usable with either engine. */
+    guardRules?: RuleSource[];
+    /**
+     * Optional schema validator configuration. When present, the engine derives
+     * overlay-aware metadata from the configured additional schemas.
+     */
+    schemaValidatorConfig?: SchemaValidatorConfig;
+}
+/**
+ * Configuration for the schema validator. Additional schemas are merged on top
+ * of the bundled CloudFormation provider schemas before schema validation.
+ */
+export interface SchemaValidatorConfig {
+    /**
+     * Additional CloudFormation resource provider schemas to merge on top of the
+     * bundled schemas. Each overlay extends or overrides the bundled schema for
+     * its resource type.
+     */
+    additionalSchemas?: SchemaSource[];
+}
 export declare class TemplateModel {
     private readonly inner;
     constructor(template: TemplateFile);
@@ -103,6 +147,7 @@ export declare class TemplateModel {
 }
 export declare class SchemaValidator {
     private readonly inner;
+    constructor(config?: SchemaValidatorConfig);
     listRules(): RuleInfo[];
     schemaCount(): number;
     validate(template: TemplateFile, region?: string): StandardDiagnostic[];

package/index.js

@@ -4,6 +4,8 @@ exports.CelEngine =
     exports.RegoEngine =
     exports.SchemaValidator =
     exports.TemplateModel =
+    exports.SchemaFile =
+    exports.RuleFile =
     exports.TemplateFile =
         void 0;
 exports.version = version;
@@ -18,6 +20,53 @@ class TemplateFile {
     }
 }
 exports.TemplateFile = TemplateFile;
+class RuleFile {
+    constructor(path) {
+        this.path = path;
+    }
+    readContent() {
+        return (0, fs_1.readFileSync)(this.path, 'utf8');
+    }
+}
+exports.RuleFile = RuleFile;
+/**
+ * A CloudFormation resource provider schema loaded from a file, for use as an
+ * overlay. `typeName` may be omitted to use the `typeName` inside the file.
+ */
+class SchemaFile {
+    constructor(path, typeName) {
+        this.path = path;
+        this.typeName = typeName;
+    }
+    readContent() {
+        return (0, fs_1.readFileSync)(this.path, 'utf8');
+    }
+}
+exports.SchemaFile = SchemaFile;
+function toExternalRuleSources(sources) {
+    return (sources ?? []).map((source) =>
+        source instanceof RuleFile ? { name: source.path, content: source.readContent() } : source,
+    );
+}
+function toAdditionalSchemas(sources) {
+    return (sources ?? []).map((source) =>
+        source instanceof SchemaFile ? { typeName: source.typeName, schema: source.readContent() } : source,
+    );
+}
+function toWasmEngineConfig(config) {
+    return {
+        customRules: toExternalRuleSources(config?.customRules),
+        guardRules: toExternalRuleSources(config?.guardRules),
+        schemaValidatorConfig: config?.schemaValidatorConfig
+            ? toWasmSchemaValidatorConfig(config.schemaValidatorConfig)
+            : undefined,
+    };
+}
+function toWasmSchemaValidatorConfig(config) {
+    return {
+        additionalSchemas: toAdditionalSchemas(config?.additionalSchemas),
+    };
+}
 class TemplateModel {
     constructor(template) {
         this.inner = bridge.WasmSemanticModel.parse(template.readBytes());
@@ -55,8 +104,8 @@ class TemplateModel {
 }
 exports.TemplateModel = TemplateModel;
 class SchemaValidator {
-    constructor() {
-        this.inner = new bridge.WasmSchemaValidator();
+    constructor(config) {
+        this.inner = new bridge.WasmSchemaValidator(toWasmSchemaValidatorConfig(config));
     }
     listRules() {
         return this.inner.listRules();
@@ -80,7 +129,7 @@ exports.SchemaValidator = SchemaValidator;
 function createEngineClass(WasmClass) {
     return class {
         constructor(config) {
-            this.inner = new WasmClass(config ?? {});
+            this.inner = new WasmClass(toWasmEngineConfig(config));
         }
         validateStandard(template, config) {
             return this.inner.validateStandard(template.readBytes(), config ?? {}, template.path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws/cloudformation-validate",
-  "version": "1.5.1-beta",
+  "version": "1.7.0-beta",
   "description": "AWS CloudFormation Validate",
   "keywords": [
     "aws",