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

package/{index-BkFZlfit.d.ts → iac/SimpleCFT.d.ts}

@@ -1,5 +1,3 @@
-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
  *
@@ -7,13 +5,14 @@ import { C as CloudFormationTemplate, R as ResourcePackApplier, P as ParameterIn
  * packs, patches, and parameters, then read the resulting `template` or render
  * it as JSON/YAML.
  */
-
+import { CloudFormationTemplate } from "./types/IaCTypes";
+import { ParameterGroup, ParameterInfo, ResourcePackApplier } from "./utils";
 /**
  * A function used to apply a modification to a SimpleCFT instance.
  *
  * @param simpleCFT - SimpleCFT instance to modify.
  * */
-type SimpleCFTModification = (simpleCFT: SimpleCFT) => void;
+export type SimpleCFTModification = (simpleCFT: SimpleCFT) => void;
 /**
  * The basis for your stack template.
  * Apply packs, patches, parameters and parameter groups.
@@ -35,7 +34,7 @@ type SimpleCFTModification = (simpleCFT: SimpleCFT) => void;
  * console.log(template.toString());
  * ```
  */
-declare class SimpleCFT {
+export declare class SimpleCFT {
     template: CloudFormationTemplate;
     /**
      * Create a SimpleCFT template wrapper.
@@ -45,7 +44,7 @@ declare class SimpleCFT {
     constructor(template?: CloudFormationTemplate);
     /**
      * Apply a pack with configuration to the stack template.
-     * @see {@link IaC} for an example.
+     * @see `@resistdesign/voltra/iac` and `@resistdesign/voltra/iac/packs` for examples.
      * */
     applyPack: <ParamsType>(pack: ResourcePackApplier<ParamsType>, params: ParamsType) => this;
     /**
@@ -91,22 +90,3 @@ declare class SimpleCFT {
      * */
     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 };

package/iac/index.d.ts

@@ -1,2 +1,40 @@
-export { i as Packs, b as Utils } from '../index-DcvJOZ_c.js';
-export { a as SimpleCFT, S as SimpleCFTModification } from '../index-BkFZlfit.js';
+/**
+ * @packageDocumentation
+ *
+ * Infrastructure-as-code entrypoint.
+ *
+ * Import from the IaC subpath only:
+ * ```ts
+ * import { SimpleCFT } from "@resistdesign/voltra/iac";
+ * import { addDNS } from "@resistdesign/voltra/iac/packs";
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { SimpleCFT } from "@resistdesign/voltra/iac";
+ * import { addDNS } from "@resistdesign/voltra/iac/packs";
+ *
+ * const cft = new SimpleCFT().applyPack(addDNS, {
+ *   hostedZoneIdParameterName: "<YOUR_INFO_HERE>",
+ *   domainNameParameterName: "<YOUR_INFO_HERE>",
+ *   localUIDevelopmentDomainName: "<YOUR_INFO_HERE>",
+ *   localUIDevelopmentIPAddress: "<YOUR_INFO_HERE>",
+ * });
+ *
+ * console.log(cft.template);
+ * ```
+ *
+ * Use flat exports for reusable resource packs and template helpers.
+ *
+ * See also: `@resistdesign/voltra/iac/packs` for direct pack imports.
+ */
+/**
+ * @category iac
+ * @group Core
+ */
+export * from "./SimpleCFT";
+/**
+ * @category iac
+ * @group Utilities
+ */
+export * from "./utils";