@storm-software/terraform-tools 0.45.2 → 0.45.4

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.45.4 (2025-01-17)
+
+### Bug Fixes
+
+- **unbuild:** Update package to use `tsup-node` to exclude bundles ([cf712b2a](https://github.com/storm-software/storm-ops/commit/cf712b2a))
+
+## 0.45.3 (2025-01-16)
+
+### Bug Fixes
+
+- **workspace-tools:** Added additional externals to the package list
+  ([5d4a063f](https://github.com/storm-software/storm-ops/commit/5d4a063f))
+
+### Miscellaneous
+
+- **monorepo:** Regenerate the README markdown files
+  ([e911945a](https://github.com/storm-software/storm-ops/commit/e911945a))
+
 ## 0.45.2 (2025-01-16)
 
 ### Miscellaneous

package/README.md

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.45.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.45.4-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
@@ -40,26 +40,21 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
 ## Table of Contents
 
 - [Storm Terraform Tools](#storm-terraform-tools)
   - [Installing](#installing)
   - [Executors](#executors)
-  - [Terraform `plan` Command Executor](#terraform-plan-command-executor)
+  - [plan](#plan)
     - [Example](#example)
-    - [Options](#options)
-  - [Terraform `apply` Command Executor](#terraform-apply-command-executor)
+  - [apply](#apply)
     - [Example](#example-1)
-    - [Options](#options-1)
-  - [Terraform `output` Command Executor](#terraform-output-command-executor)
+  - [output](#output)
     - [Example](#example-2)
-  - [Terraform `destroy` Command Executor](#terraform-destroy-command-executor)
+  - [destroy](#destroy)
     - [Example](#example-3)
-    - [Options](#options-2)
   - [Generators](#generators)
-  - [Init Storm Terraform Tools Plugin](#init-storm-terraform-tools-plugin)
-    - [Options](#options-3)
+  - [init](#init)
   - [Building](#building)
   - [Running unit tests](#running-unit-tests)
   - [Storm Workspaces](#storm-workspaces)
@@ -122,7 +117,7 @@ the workspace's projects:
 <!-- markdownlint-disable -->
 
 
-## Terraform `plan` Command Executor
+## plan
 
 Run the \`plan\` command using the workspaces Terraform IoC configuration files
 
@@ -136,18 +131,9 @@ nx run my-project:plan
 
 **Please note:** _The plan executor should be included in the desired projects's `project.json` file._ 
 
-### Options
-
-The following executor options are available:
-
-| Option    | Type   | Description   | Default   | 
-| --------- | ------ | ------------- | --------- | 
-| planFile      | `string`    | The path to the plan file to create     | "defaultplan"     | 
-
-
 
 
-## Terraform `apply` Command Executor
+## apply
 
 Run the \`apply\` command using the workspaces Terraform IoC configuration files
 
@@ -161,19 +147,9 @@ nx run my-project:apply
 
 **Please note:** _The apply executor should be included in the desired projects's `project.json` file._ 
 
-### Options
-
-The following executor options are available:
-
-| Option    | Type   | Description   | Default   | 
-| --------- | ------ | ------------- | --------- | 
-| planFile      | `string`    | The path to the plan file to create     | "defaultplan"     | 
- | autoApproval      | `boolean`    | A boolean flag to automatically approve the apply     |     | 
-
-
 
 
-## Terraform `output` Command Executor
+## output
 
 Run the \`output\` command using the workspaces Terraform IoC configuration files
 
@@ -189,7 +165,7 @@ nx run my-project:output
 
 
 
-## Terraform `destroy` Command Executor
+## destroy
 
 Run the \`destroy\` command using the workspaces Terraform IoC configuration files
 
@@ -203,15 +179,6 @@ nx run my-project:destroy
 
 **Please note:** _The destroy executor should be included in the desired projects's `project.json` file._ 
 
-### Options
-
-The following executor options are available:
-
-| Option    | Type   | Description   | Default   | 
-| --------- | ------ | ------------- | --------- | 
-| autoApproval      | `boolean`    | A boolean flag to automatically approve the destroy     |     | 
-
-
 
 
 <!-- markdownlint-restore -->
@@ -229,18 +196,9 @@ management:
 <!-- markdownlint-disable -->
 
 
-## Init Storm Terraform Tools Plugin
-
-Init Storm Terraform Tools Plugin.
-
-### Options
-
-The following executor options are available:
-
-| Option    | Type   | Description   | Default   | 
-| --------- | ------ | ------------- | --------- | 
-| skipFormat      | `boolean`    | Skip formatting files.     |     | 
+## init
 
+Initialize the `@storm-software/terraform-tools` plugin.
 
 
 

package/dist/src/base/base-terraform-executor.d.ts

@@ -0,0 +1,98 @@
+
+// Generated by @storm-software/untyped
+// Do not edit this file directly
+
+export interface BaseTerraformExecutorSchema {
+ /**
+  * Backend Config
+  * 
+  * The backend configuration
+  * 
+ */
+ backendConfig?: Array<any>,
+
+ /**
+  * Auto Approval
+  * 
+  * Whether to auto-approve the plan
+  * 
+  * @default false
+ */
+ autoApproval?: boolean,
+
+ /**
+  * Plan File
+  * 
+  * The plan file
+  * 
+  * @default "plan.out"
+  * 
+  * @format path
+ */
+ planFile?: string,
+
+ /**
+  * Format Write
+  * 
+  * Whether to format the files before writing
+  * 
+  * @default false
+ */
+ formatWrite?: boolean,
+
+ /**
+  * Upgrade
+  * 
+  * Whether to upgrade the modules
+  * 
+  * @default false
+ */
+ upgrade?: boolean,
+
+ /**
+  * Migrate State
+  * 
+  * Whether to migrate the state
+  * 
+  * @default false
+ */
+ migrateState?: boolean,
+
+ /**
+  * Lock
+  * 
+  * Whether to lock the state
+  * 
+  * @default false
+ */
+ lock?: boolean,
+
+ /**
+  * Var File
+  * 
+  * The variable file
+  * 
+  * @default "variables.tf"
+  * 
+  * @format path
+ */
+ varFile?: string,
+
+ /**
+  * Var String
+  * 
+  * The variable string
+  * 
+ */
+ varString?: string,
+
+ /**
+  * Reconfigure
+  * 
+  * Whether to reconfigure the state
+  * 
+  * @default false
+ */
+ reconfigure?: boolean,
+}
+

package/dist/src/base/base-terraform-executor.schema.json

@@ -0,0 +1,93 @@
+{
+  "title": "Base Terraform Executor",
+  "description": "A base type definition for a Terraform executor schema",
+  "id": "#",
+  "properties": {
+    "backendConfig": {
+      "title": "Backend Config",
+      "type": "array",
+      "description": "The backend configuration",
+      "id": "#backendConfig",
+      "default": [],
+      "items": {
+        "type": "any"
+      }
+    },
+    "autoApproval": {
+      "title": "Auto Approval",
+      "type": "boolean",
+      "description": "Whether to auto-approve the plan",
+      "id": "#autoApproval",
+      "default": false
+    },
+    "planFile": {
+      "title": "Plan File",
+      "format": "path",
+      "description": "The plan file",
+      "type": "string",
+      "id": "#planFile",
+      "default": "plan.out"
+    },
+    "formatWrite": {
+      "title": "Format Write",
+      "type": "boolean",
+      "description": "Whether to format the files before writing",
+      "id": "#formatWrite",
+      "default": false
+    },
+    "upgrade": {
+      "title": "Upgrade",
+      "type": "boolean",
+      "description": "Whether to upgrade the modules",
+      "id": "#upgrade",
+      "default": false
+    },
+    "migrateState": {
+      "title": "Migrate State",
+      "type": "boolean",
+      "description": "Whether to migrate the state",
+      "id": "#migrateState",
+      "default": false
+    },
+    "lock": {
+      "title": "Lock",
+      "type": "boolean",
+      "description": "Whether to lock the state",
+      "id": "#lock",
+      "default": false
+    },
+    "varFile": {
+      "title": "Var File",
+      "format": "path",
+      "type": "string",
+      "description": "The variable file",
+      "id": "#varFile",
+      "default": "variables.tf"
+    },
+    "varString": {
+      "title": "Var String",
+      "type": "string",
+      "description": "The variable string",
+      "id": "#varString"
+    },
+    "reconfigure": {
+      "title": "Reconfigure",
+      "type": "boolean",
+      "description": "Whether to reconfigure the state",
+      "id": "#reconfigure",
+      "default": false
+    }
+  },
+  "type": "object",
+  "default": {
+    "backendConfig": [],
+    "autoApproval": false,
+    "planFile": "plan.out",
+    "formatWrite": false,
+    "upgrade": false,
+    "migrateState": false,
+    "lock": false,
+    "varFile": "variables.tf",
+    "reconfigure": false
+  }
+}

package/docs/api/base/base-terraform-executor.md

@@ -0,0 +1,105 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Base Terraform Executor
+
+## `backendConfig`
+- **Type**: `array`
+- **Default**: `[]`
+
+> Backend Config
+
+
+The backend configuration
+
+
+## `autoApproval`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Auto Approval
+
+
+Whether to auto-approve the plan
+
+
+## `planFile`
+- **Type**: `string`
+- **Default**: `"plan.out"`
+
+> Plan File
+
+
+The plan file
+
+
+## `formatWrite`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Format Write
+
+
+Whether to format the files before writing
+
+
+## `upgrade`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Upgrade
+
+
+Whether to upgrade the modules
+
+
+## `migrateState`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Migrate State
+
+
+Whether to migrate the state
+
+
+## `lock`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Lock
+
+
+Whether to lock the state
+
+
+## `varFile`
+- **Type**: `string`
+- **Default**: `"variables.tf"`
+
+> Var File
+
+
+The variable file
+
+
+## `varString`
+- **Type**: `string`
+
+> Var String
+
+
+The variable string
+
+
+## `reconfigure`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Reconfigure
+
+
+Whether to reconfigure the state
+
+

package/executors.json

@@ -1,45 +1,45 @@
 {
   "executors": {
     "plan": {
-      "implementation": "./src/executors/plan/executor",
-      "schema": "./src/executors/plan/schema.json",
+      "implementation": "./dist/src/executors/plan/executor",
+      "schema": "./dist/src/executors/plan/schema.json",
       "description": "Run the `plan` command using the workspaces Terraform IoC configuration files"
     },
     "apply": {
-      "implementation": "./src/executors/apply/executor",
-      "schema": "./src/executors/apply/schema.json",
+      "implementation": "./dist/src/executors/apply/executor",
+      "schema": "./dist/src/executors/apply/schema.json",
       "description": "Run the `apply` command using the workspaces Terraform IoC configuration files"
     },
     "output": {
-      "implementation": "./src/executors/output/executor",
-      "schema": "./src/executors/output/schema.json",
+      "implementation": "./dist/src/executors/output/executor",
+      "schema": "./dist/src/executors/output/schema.json",
       "description": "Run the `output` command using the workspaces Terraform IoC configuration files"
     },
     "destroy": {
-      "implementation": "./src/executors/destroy/executor",
-      "schema": "./src/executors/destroy/schema.json",
+      "implementation": "./dist/src/executors/destroy/executor",
+      "schema": "./dist/src/executors/destroy/schema.json",
       "description": "Run the `destroy` command using the workspaces Terraform IoC configuration files"
     }
   },
   "builders": {
     "plan": {
-      "implementation": "./src/executors/plan/executor",
-      "schema": "./src/executors/plan/schema.json",
+      "implementation": "./dist/src/executors/plan/executor",
+      "schema": "./dist/src/executors/plan/schema.json",
       "description": "Run the `plan` command using the workspaces Terraform IoC configuration files"
     },
     "apply": {
-      "implementation": "./src/executors/apply/executor",
-      "schema": "./src/executors/apply/schema.json",
+      "implementation": "./dist/src/executors/apply/executor",
+      "schema": "./dist/src/executors/apply/schema.json",
       "description": "Run the `apply` command using the workspaces Terraform IoC configuration files"
     },
     "output": {
-      "implementation": "./src/executors/output/executor",
-      "schema": "./src/executors/output/schema.json",
+      "implementation": "./dist/src/executors/output/executor",
+      "schema": "./dist/src/executors/output/schema.json",
       "description": "Run the `output` command using the workspaces Terraform IoC configuration files"
     },
     "destroy": {
-      "implementation": "./src/executors/destroy/executor",
-      "schema": "./src/executors/destroy/schema.json",
+      "implementation": "./dist/src/executors/destroy/executor",
+      "schema": "./dist/src/executors/destroy/schema.json",
       "description": "Run the `destroy` command using the workspaces Terraform IoC configuration files"
     }
   }

package/generators.json

@@ -4,8 +4,8 @@
   "version": "0.0.1",
   "generators": {
     "init": {
-      "factory": "./src/generators/init/init#initGenerator",
-      "schema": "./src/generators/init/schema.json",
+      "factory": "./dist/src/generators/init/init#initGenerator",
+      "schema": "./dist/src/generators/init/schema.json",
       "description": "Initialize the `@storm-software/terraform-tools` plugin.",
       "aliases": ["ng-add"],
       "internal": true

package/package.json

@@ -1 +1 @@
-{"name":"@storm-software/terraform-tools","version":"0.45.2","type":"commonjs","description":"Tools for managing Terraform infrastructure within a Nx workspace.","repository":{"type":"github","url":"https://github.com/storm-software/storm-ops","directory":"packages/terraform-tools"},"homepage":"https://stormsoftware.com","bugs":"https://github.com/storm-software/storm-ops/issues","author":{"name":"Storm Software","email":"contact@stormsoftware.com","url":"https://stormsoftware.com"},"license":"Apache-2.0","private":false,"main":"./index.js","exports":{".":"./index.js","./package.json":"./package.json","./generators.json":"./generators.json","./generators/*/schema.json":"./src/generators/*/schema.json","./executors.json":"./executors.json","./executors/*/schema.json":"./src/executors/*/schema.json","./plugins":"./src/plugins/index.js","./utils":"./src/utils/index.js"},"typings":"./declarations.d.ts","keywords":["iac","infrastructure","monorepo","storm","storm-ops","storm-stack","sullivanpj","terraform"],"peerDependencies":{"@nx/devkit":"^20.3.1","@nx/workspace":"^20.3.1","nx":"^20.3.1"},"peerDependenciesMeta":{"@nx/devkit":{"optional":false},"@nx/workspace":{"optional":false},"nx":{"optional":false}},"dependencies":{"shelljs":"^0.8.5","tslib":"^2.6.3"},"devDependencies":{"@nx/devkit":"^20.3.1","@nx/workspace":"^20.3.1","@types/node":"^22.10.2","nx":"^20.3.1"},"publishConfig":{"access":"public"},"executors":"./executors.json","generators":"./generators.json"}
+{"name":"@storm-software/terraform-tools","version":"0.45.4","description":"Tools for managing Terraform infrastructure within a Nx workspace.","repository":{"type":"github","url":"https://github.com/storm-software/storm-ops","directory":"packages/terraform-tools"},"homepage":"https://stormsoftware.com","bugs":"https://github.com/storm-software/storm-ops/issues","author":{"name":"Storm Software","email":"contact@stormsoftware.com","url":"https://stormsoftware.com"},"license":"Apache-2.0","private":false,"main":"dist/index.js","module":"dist/index.mjs","exports":{"./package.json":"./package.json","./docs/*":"./docs/*","./migrations.json":"./migrations.json","./executors.json":"./executors.json","./executors/*/schema.json":"./dist/src/executors/*/schema.json","./generators.json":"./generators.json","./generators/*/schema.json":"./dist/src/generators/*/schema.json",".":{"import":{"types":"./dist/index.d.mts","default":"./dist/index.mjs"},"require":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"default":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"./index":{"import":{"types":"./dist/index.d.mts","default":"./dist/index.mjs"},"require":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"default":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"./executors":{"import":{"types":"./dist/executors.d.mts","default":"./dist/executors.mjs"},"require":{"types":"./dist/executors.d.ts","default":"./dist/executors.js"},"default":{"types":"./dist/executors.d.ts","default":"./dist/executors.js"}},"./generators":{"import":{"types":"./dist/generators.d.mts","default":"./dist/generators.mjs"},"require":{"types":"./dist/generators.d.ts","default":"./dist/generators.js"},"default":{"types":"./dist/generators.d.ts","default":"./dist/generators.js"}},"./base":{"import":{"types":"./dist/src/base/index.d.mts","default":"./dist/src/base/index.mjs"},"require":{"types":"./dist/src/base/index.d.ts","default":"./dist/src/base/index.js"},"default":{"types":"./dist/src/base/index.d.ts","default":"./dist/src/base/index.js"}},"./base/*":{"import":{"types":"./dist/src/base/*.d.mts","default":"./dist/src/base/*.mjs"},"require":{"types":"./dist/src/base/*.d.ts","default":"./dist/src/base/*.js"},"default":{"types":"./dist/src/base/*.d.ts","default":"./dist/src/base/*.js"}},"./executors/*/executor.js":"./dist/src/executors/*/executor.js","./generators/*/init.js":"./dist/src/generators/*/init.js"},"typings":"dist/index.d.ts","keywords":["iac","infrastructure","monorepo","storm","storm-ops","storm-stack","sullivanpj","terraform"],"peerDependencies":{"@nx/devkit":"^20.3.1","@storm-software/workspace-tools":"workspace:*","nx":"^20.3.1"},"peerDependenciesMeta":{"@nx/devkit":{"optional":false},"@storm-software/workspace-tools":{"optional":false},"nx":{"optional":false}},"dependencies":{"@storm-software/workspace-tools":"workspace:*","shelljs":"^0.8.5","tslib":"^2.6.3"},"devDependencies":{"@nx/devkit":"^20.3.1","@types/node":"^22.10.2","nx":"^20.3.1","tsup":"8.3.5","untyped":"^1.5.2"},"publishConfig":{"access":"public"},"executors":"./executors.json","generators":"./generators.json"}

package/index.d.ts

@@ -1 +0,0 @@
-export * from "./src";