@aws/cloudformation-validate 1.0.0-beta

package/bindings_wasm_bg.wasm.d.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_wasmcelengine_free: (a: number, b: number) => void;
+export const __wbg_wasmregoengine_free: (a: number, b: number) => void;
+export const __wbg_wasmschemavalidator_free: (a: number, b: number) => void;
+export const __wbg_wasmsemanticmodel_free: (a: number, b: number) => void;
+export const init: () => void;
+export const version: () => [number, number];
+export const wasmcelengine_engineName: (a: number) => [number, number];
+export const wasmcelengine_listRules: (a: number) => [number, number, number];
+export const wasmcelengine_new: (a: any) => [number, number, number];
+export const wasmcelengine_validateDetailed: (
+    a: number,
+    b: number,
+    c: number,
+    d: any,
+    e: number,
+    f: number,
+) => [number, number, number];
+export const wasmcelengine_validateStandard: (
+    a: number,
+    b: number,
+    c: number,
+    d: any,
+    e: number,
+    f: number,
+) => [number, number, number];
+export const wasmregoengine_engineName: (a: number) => [number, number];
+export const wasmregoengine_listRules: (a: number) => [number, number, number];
+export const wasmregoengine_new: (a: any) => [number, number, number];
+export const wasmregoengine_validateDetailed: (
+    a: number,
+    b: number,
+    c: number,
+    d: any,
+    e: number,
+    f: number,
+) => [number, number, number];
+export const wasmregoengine_validateStandard: (
+    a: number,
+    b: number,
+    c: number,
+    d: any,
+    e: number,
+    f: number,
+) => [number, number, number];
+export const wasmschemavalidator_listRules: (a: number) => [number, number, number];
+export const wasmschemavalidator_new: () => 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];
+export const wasmsemanticmodel_description: (a: number) => [number, number];
+export const wasmsemanticmodel_formatVersion: (a: number) => [number, number];
+export const wasmsemanticmodel_outputs: (a: number) => [number, number, number];
+export const wasmsemanticmodel_parameters: (a: number) => [number, number, number];
+export const wasmsemanticmodel_parse: (a: number, b: number) => [number, number, number];
+export const wasmsemanticmodel_resources: (a: number) => [number, number, number];
+export const wasmsemanticmodel_sourceLocation: (a: number, b: number, c: number) => [number, number, number];
+export const wasmsemanticmodel_toDiagnosticModel: (a: number) => [number, number, number];
+export const wasmsemanticmodel_transforms: (a: number) => [number, number, number];
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_start: () => void;

package/index.d.ts

@@ -0,0 +1,112 @@
+import type {
+    DetailedReport,
+    DiagnosticModel,
+    EngineConfig,
+    ParameterInfo,
+    ResolvedOutput,
+    ResolvedResource,
+    RuleInfo,
+    SourceSpan,
+    StandardDiagnostic,
+    StandardReport,
+    ValidateConfig,
+} from './bindings_wasm';
+export type {
+    Severity,
+    DetailLevel,
+    RuleOrigin,
+    IdRange,
+    ResourceIdFilter,
+    ResourceTypeFilter,
+    RuleFilterConfig,
+    RuleInfo,
+    SourceSpan,
+    ResourceRef,
+    RelatedResource,
+    ViolationContext,
+    StandardDiagnostic,
+    DetailedDiagnostic,
+    PhaseMetric,
+    PerformanceMetrics,
+    Summary,
+    ReportMetadata,
+    StandardReport,
+    DetailedReport,
+    PseudoParameterOverrides,
+    EngineConfig,
+    ValidateConfig,
+    ExternalRuleSource,
+    ResolvedValue,
+    RefKind,
+    ParameterInfo,
+    ResolvedResource,
+    ResolvedOutput,
+    ForEachExpansion,
+    ResourceDiagnostics,
+    MapEntry,
+    PathValuePair,
+    ConditionalNull,
+    ConditionalNullEntry,
+    DiagnosticModel,
+    DiagnosticTemplate,
+    DiagnosticCondition,
+    DiagnosticImplication,
+    DiagnosticMutexGroup,
+    ReferenceEdge,
+    OutgoingRef,
+    IncomingRef,
+    DiagnosticResource,
+    PathVariable,
+    DiagnosticForEachExpansion,
+    PathTarget,
+    GetAttRef,
+    DiagnosticOutput,
+    DiagnosticRule,
+    DiagnosticRuleAssertion,
+    ResolutionSource,
+} from './bindings_wasm';
+export type JsonValue =
+    | string
+    | number
+    | boolean
+    | null
+    | JsonValue[]
+    | {
+          [key: string]: JsonValue;
+      };
+export interface Engine {
+    validateStandard(template: TemplateFile, config?: ValidateConfig): StandardReport;
+    validateDetailed(template: TemplateFile, config?: ValidateConfig): DetailedReport;
+    listRules(): RuleInfo[];
+    engineName(): string;
+    free(): void;
+}
+export declare class TemplateFile {
+    readonly path: string;
+    constructor(path: string);
+    readBytes(): Uint8Array;
+}
+export declare class TemplateModel {
+    private readonly inner;
+    constructor(template: TemplateFile);
+    resources(): Record<string, ResolvedResource>;
+    parameters(): Record<string, ParameterInfo>;
+    outputs(): Record<string, ResolvedOutput>;
+    conditions(): string[];
+    transforms(): string[];
+    formatVersion(): string | undefined;
+    description(): string | undefined;
+    toDiagnosticModel(): DiagnosticModel;
+    sourceLocation(path: string): SourceSpan | null;
+    free(): void;
+}
+export declare class SchemaValidator {
+    private readonly inner;
+    listRules(): RuleInfo[];
+    schemaCount(): number;
+    validate(template: TemplateFile, region?: string): StandardDiagnostic[];
+    free(): void;
+}
+export declare const RegoEngine: new (config?: EngineConfig) => Engine;
+export declare const CelEngine: new (config?: EngineConfig) => Engine;
+export declare function version(): string;

package/index.js

@@ -0,0 +1,106 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.CelEngine =
+    exports.RegoEngine =
+    exports.SchemaValidator =
+    exports.TemplateModel =
+    exports.TemplateFile =
+        void 0;
+exports.version = version;
+const fs_1 = require('fs');
+const bridge = require('./bindings_wasm');
+class TemplateFile {
+    constructor(path) {
+        this.path = path;
+    }
+    readBytes() {
+        return (0, fs_1.readFileSync)(this.path);
+    }
+}
+exports.TemplateFile = TemplateFile;
+class TemplateModel {
+    constructor(template) {
+        this.inner = bridge.WasmSemanticModel.parse(template.readBytes());
+    }
+    resources() {
+        return this.inner.resources();
+    }
+    parameters() {
+        return this.inner.parameters();
+    }
+    outputs() {
+        return this.inner.outputs();
+    }
+    conditions() {
+        return this.inner.conditions();
+    }
+    transforms() {
+        return this.inner.transforms();
+    }
+    formatVersion() {
+        return this.inner.formatVersion();
+    }
+    description() {
+        return this.inner.description();
+    }
+    toDiagnosticModel() {
+        return this.inner.toDiagnosticModel();
+    }
+    sourceLocation(path) {
+        return this.inner.sourceLocation(path);
+    }
+    free() {
+        this.inner.free();
+    }
+}
+exports.TemplateModel = TemplateModel;
+class SchemaValidator {
+    constructor() {
+        this.inner = new bridge.WasmSchemaValidator();
+    }
+    listRules() {
+        return this.inner.listRules();
+    }
+    schemaCount() {
+        return this.inner.schemaCount();
+    }
+    validate(template, region = 'us-east-1') {
+        const model = bridge.WasmSemanticModel.parse(template.readBytes());
+        try {
+            return this.inner.validate(model, region).diagnostics;
+        } finally {
+            model.free();
+        }
+    }
+    free() {
+        this.inner.free();
+    }
+}
+exports.SchemaValidator = SchemaValidator;
+function createEngineClass(WasmClass) {
+    return class {
+        constructor(config) {
+            this.inner = new WasmClass(config ?? {});
+        }
+        validateStandard(template, config) {
+            return this.inner.validateStandard(template.readBytes(), config ?? {}, template.path);
+        }
+        validateDetailed(template, config) {
+            return this.inner.validateDetailed(template.readBytes(), config ?? {}, template.path);
+        }
+        listRules() {
+            return this.inner.listRules();
+        }
+        engineName() {
+            return this.inner.engineName();
+        }
+        free() {
+            this.inner.free();
+        }
+    };
+}
+exports.RegoEngine = createEngineClass(bridge.WasmRegoEngine);
+exports.CelEngine = createEngineClass(bridge.WasmCelEngine);
+function version() {
+    return bridge.version();
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+    "name": "@aws/cloudformation-validate",
+    "version": "1.0.0-beta",
+    "description": "AWS CloudFormation Validate",
+    "author": {
+        "name": "Amazon Web Services",
+        "url": "https://aws.amazon.com"
+    },
+    "license": "Apache-2.0",
+    "engines": {
+        "node": "^22.15.0",
+        "npm": ">=10.5.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/aws-cloudformation/cloudformation-validate"
+    },
+    "homepage": "https://github.com/aws-cloudformation/cloudformation-validate#readme",
+    "publishConfig": {
+        "access": "public",
+        "provenance": true
+    },
+    "main": "index.js",
+    "types": "index.d.ts"
+}