@resistdesign/voltra 3.0.0-alpha.3 → 3.0.0-alpha.4

package/index-BkFZlfit.d.ts

@@ -0,0 +1,112 @@
+import { C as CloudFormationTemplate, R as ResourcePackApplier, P as ParameterInfo, a as ParameterGroup, i as index$1, b as index$2 } from './index-DcvJOZ_c.js';
+
+/**
+ * @packageDocumentation
+ *
+ * Fluent builder for CloudFormation templates. Use {@link SimpleCFT} to apply
+ * packs, patches, and parameters, then read the resulting `template` or render
+ * it as JSON/YAML.
+ */
+
+/**
+ * A function used to apply a modification to a SimpleCFT instance.
+ *
+ * @param simpleCFT - SimpleCFT instance to modify.
+ * */
+type SimpleCFTModification = (simpleCFT: SimpleCFT) => void;
+/**
+ * The basis for your stack template.
+ * Apply packs, patches, parameters and parameter groups.
+ * Access the `template` property for the resulting CloudFormation template.
+ *
+ * Example:
+ * ```ts
+ * import { SimpleCFT } from "./SimpleCFT";
+ *
+ * const template = new SimpleCFT()
+ *   .addParameter({
+ *     Group: "App",
+ *     ParameterId: "AppName",
+ *     Label: "App Name",
+ *     Parameter: { Type: "String", Default: "voltra" },
+ *   })
+ *   .patch({ Description: "My stack" });
+ *
+ * console.log(template.toString());
+ * ```
+ */
+declare class SimpleCFT {
+    template: CloudFormationTemplate;
+    /**
+     * Create a SimpleCFT template wrapper.
+     *
+     * @param template - Initial CloudFormation template.
+     */
+    constructor(template?: CloudFormationTemplate);
+    /**
+     * Apply a pack with configuration to the stack template.
+     * @see {@link IaC} for an example.
+     * */
+    applyPack: <ParamsType>(pack: ResourcePackApplier<ParamsType>, params: ParamsType) => this;
+    /**
+     * Apply a patch to the stack template.
+     *
+     * @param patch - Template patch to merge.
+     * */
+    patch: (patch: Partial<CloudFormationTemplate>) => this;
+    /**
+     * Add a stack parameter including its descriptive info and an optional parameter group.
+     *
+     * @param parameter - Parameter definition and metadata.
+     * */
+    addParameter: (parameter: ParameterInfo) => this;
+    /**
+     * Add a group of stack parameters including their descriptive info and an optional parameter group.
+     *
+     * @param group - Parameter group definition.
+     * */
+    addParameterGroup: ({ Label: Group, Parameters }: ParameterGroup) => this;
+    /**
+     * Use a modification to dynamically apply various changes at once.
+     *
+     * @param modification - Modification callback to apply.
+     * */
+    modify: (modification: SimpleCFTModification) => this;
+    /**
+     * Convert the stack template to a string.
+     *
+     * @returns JSON string representation of the template.
+     * */
+    toString: () => string;
+    /**
+     * Convert the stack template to a JSON object.
+     *
+     * @returns Template JSON object.
+     * */
+    toJSON: () => CloudFormationTemplate;
+    /**
+     * Convert the stack template to a YAML string.
+     *
+     * @returns YAML string representation of the template.
+     * */
+    toYAML: () => string;
+}
+
+/**
+ * @packageDocumentation
+ *
+ * IaC exports. Use {@link Packs} for resource packs, {@link Utils} for template
+ * helpers, and {@link SimpleCFT} for fluent template composition.
+ */
+/**
+ * Use packs for easily building infrastructure with reusable components.
+ */
+
+type index_SimpleCFT = SimpleCFT;
+declare const index_SimpleCFT: typeof SimpleCFT;
+type index_SimpleCFTModification = SimpleCFTModification;
+declare namespace index {
+  export { index$1 as Packs, index_SimpleCFT as SimpleCFT, type index_SimpleCFTModification as SimpleCFTModification, index$2 as Utils };
+}
+
+export { type SimpleCFTModification as S, SimpleCFT as a, index as i };