@resistdesign/voltra 3.0.0-alpha.16 → 3.0.0-alpha.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -44,7 +44,7 @@ export declare class SimpleCFT {
44
44
  constructor(template?: CloudFormationTemplate);
45
45
  /**
46
46
  * Apply a pack with configuration to the stack template.
47
- * @see {@link IaC} for an example.
47
+ * @see `@resistdesign/voltra/iac` and `@resistdesign/voltra/iac/packs` for examples.
48
48
  * */
49
49
  applyPack: <ParamsType>(pack: ResourcePackApplier<ParamsType>, params: ParamsType) => this;
50
50
  /**
package/iac/index.d.ts CHANGED
@@ -5,14 +5,16 @@
5
5
  *
6
6
  * Import from the IaC subpath only:
7
7
  * ```ts
8
- * import * as IaC from "@resistdesign/voltra/iac";
8
+ * import { SimpleCFT } from "@resistdesign/voltra/iac";
9
+ * import { addDNS } from "@resistdesign/voltra/iac/packs";
9
10
  * ```
10
11
  *
11
12
  * @example
12
13
  * ```ts
13
- * import * as IaC from "@resistdesign/voltra/iac";
14
+ * import { SimpleCFT } from "@resistdesign/voltra/iac";
15
+ * import { addDNS } from "@resistdesign/voltra/iac/packs";
14
16
  *
15
- * const cft = new IaC.SimpleCFT().applyPack(IaC.Packs.addDNS, {
17
+ * const cft = new SimpleCFT().applyPack(addDNS, {
16
18
  * hostedZoneIdParameterName: "<YOUR_INFO_HERE>",
17
19
  * domainNameParameterName: "<YOUR_INFO_HERE>",
18
20
  * localUIDevelopmentDomainName: "<YOUR_INFO_HERE>",
@@ -22,17 +24,17 @@
22
24
  * console.log(cft.template);
23
25
  * ```
24
26
  *
25
- * Use {@link Packs} for reusable resource packs, {@link Utils} for template
26
- * helpers, and {@link SimpleCFT} for fluent template composition.
27
+ * Use flat exports for reusable resource packs and template helpers.
27
28
  *
28
29
  * See also: `@resistdesign/voltra/iac/packs` for direct pack imports.
29
30
  */
30
31
  /**
31
- * Use packs for easily building infrastructure with reusable components.
32
+ * @category iac
33
+ * @group Core
32
34
  */
33
- export * as Packs from "./packs";
35
+ export * from "./SimpleCFT";
34
36
  /**
35
- * Utilities allow for easy modification and extension of infrastructure templates.
37
+ * @category iac
38
+ * @group Utilities
36
39
  */
37
- export * as Utils from "./utils";
38
- export * from "./SimpleCFT";
40
+ export * from "./utils";