@storm-software/pulumi-tools 0.7.4 → 0.7.6

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.7.6 (2025-01-29)
+
+### Bug Fixes
+
+- **unbuild:** Resolved issue applying plugins ([21459fd0](https://github.com/storm-software/storm-ops/commit/21459fd0))
+
+## 0.7.5 (2025-01-29)
+
+### Miscellaneous
+
+- **monorepo:** Regenerate README markdown files ([5e0520b1](https://github.com/storm-software/storm-ops/commit/5e0520b1))
+
 ## 0.7.4 (2025-01-23)
 
 ### Bug Fixes

package/README.md

@@ -1,7 +1,503 @@
-# pulumi-tools
+<!-- START header -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" width="100%" alt="Storm Software" /></div>
+<br />
+
+<div align="center">
+<b>
+<a href="https://stormsoftware.com" target="_blank">Website</a>  •
+<a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a>  •
+<a href="https://discord.gg/MQ6YVzakM5">Discord</a>  •  <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a>  •  <a href="https://stormsoftware.com/contact" target="_blank">Contact</a>  •
+<a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
+</b>
+</div>
+
+<br />
+This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
+<br />
+
+<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.7.5-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 -->
+
+> [!IMPORTANT] 
+> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<div align="center">
+<b>Be sure to ⭐ this repository on <a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> so you can keep up to date on any daily progress!</b>
+</div>
+
+<br />
+
+<!-- START doctoc -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Storm Pulumi Tools](#storm-pulumi-tools)
+  - [Installing](#installing)
+  - [Executors](#executors)
+  - [Pulumi `config` Command Executor](#pulumi-config-command-executor)
+    - [Example](#example)
+    - [Options](#options)
+  - [Pulumi `import` Command Executor](#pulumi-import-command-executor)
+    - [Example](#example-1)
+    - [Options](#options-1)
+  - [Pulumi `preview` Command Executor](#pulumi-preview-command-executor)
+    - [Example](#example-2)
+    - [Options](#options-2)
+  - [Pulumi `refresh` Command Executor](#pulumi-refresh-command-executor)
+    - [Example](#example-3)
+    - [Options](#options-3)
+  - [Pulumi `up` Command Executor](#pulumi-up-command-executor)
+    - [Example](#example-4)
+    - [Options](#options-4)
+  - [Generators](#generators)
+  - [Init Storm Pulumi Tools Plugin](#init-storm-pulumi-tools-plugin)
+    - [Options](#options-5)
+  - [Building](#building)
+  - [Running unit tests](#running-unit-tests)
+  - [Storm Workspaces](#storm-workspaces)
+  - [Roadmap](#roadmap)
+  - [Support](#support)
+  - [License](#license)
+  - [Changelog](#changelog)
+  - [Contributing](#contributing)
+  - [Contributors](#contributors)
+
+<!-- END doctoc -->
+
+<br />
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END header -->
+
+# Storm Pulumi Tools
+
+A package containing tools and base classes for the
+[Pulumi Infrastructure as Code package](https://www.pulumi.com/) to be used in a
+Storm workspace. It includes various [Nx](https://nx.dev) generators and
+executors for common development tasks.
 
 This library was generated with [Nx](https://nx.dev).
 
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D @storm-software/pulumi-tools
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D @storm-software/pulumi-tools
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D @storm-software/pulumi-tools
+```
+
+</details>
+
+## Executors
+
+The following executors are available in this package to invoke common tasks for
+the workspace's projects:
+
+<!-- START executors -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+## Pulumi `config` Command Executor
+
+Run the \`config\` command using the workspaces Pulumi IoC CLI
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:config
+```
+
+**Please note:** _The config executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| stack      | `string`    | The target stack to use, if specified.     |     | 
+ | root      | `string`    | The working directory to run Pulumi commands from, if specified.     |     | 
+ | **action \***    | `string`    |     |     | 
+ | path      | `boolean`    |     |     | 
+ | secret      | `boolean`    |     |     | 
+ | name      | `string`    |     |     | 
+ | value      | `string`    |     |     | 
+
+
+**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ 
+
+
+
+## Pulumi `import` Command Executor
+
+Run the \`import\` command using the workspaces Pulumi IoC CLI
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:import
+```
+
+**Please note:** _The import executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| stack      | `string`    | The target stack to use, if specified.     |     | 
+ | root      | `string`    | The working directory to run Pulumi commands from, if specified.     |     | 
+ | **target \***    | `string`    |     |     | 
+ | name      | `string`    |     |     | 
+ | **id \***    | `string`    |     |     | 
+
+
+**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ 
+
+
+
+## Pulumi `preview` Command Executor
+
+Run the \`preview\` command using the workspaces Pulumi IoC CLI
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:preview
+```
+
+**Please note:** _The preview executor should be included in the desired projects's `project.json` file._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| stack      | `string`    | The target stack to use, if specified.     |     | 
+ | root      | `string`    | The working directory to run Pulumi commands from, if specified.     |     | 
+ | expectNoChanges      | `boolean`    |     |     | 
+
+
+
+
+## Pulumi `refresh` Command Executor
+
+Run the \`refresh\` command using the workspaces Pulumi IoC CLI
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:refresh
+```
+
+**Please note:** _The refresh executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| stack      | `string`    | The target stack to use, if specified.     |     | 
+ | root      | `string`    | The working directory to run Pulumi commands from, if specified.     |     | 
+ | **skipPreview \***    | `boolean`    | A boolean flag to skip the preview step.     |     | 
+ | **yes \***    | `boolean`    | A boolean flag to automatically approve the refresh.     |     | 
+
+
+**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ 
+
+
+
+## Pulumi `up` Command Executor
+
+Run the \`up\` command using the workspaces Pulumi IoC CLI
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:up
+```
+
+**Please note:** _The up executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| stack      | `string`    | The target stack to use, if specified.     |     | 
+ | root      | `string`    | The working directory to run Pulumi commands from, if specified.     |     | 
+ | **skipPreview \***    | `boolean`    | A boolean flag to skip the preview step.     |     | 
+ | **yes \***    | `boolean`    | A boolean flag to automatically approve the \`up\` command.     |     | 
+ | **suppressOutputs \***    | `boolean`    | A boolean flag to suppress outputs in the \`up\` command.     |     | 
+ | **json \***    | `boolean`    | A boolean flag to output the \`up\` command as JSON.     |     | 
+
+
+**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ 
+
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END executors -->
+
+## Generators
+
+The following generators are available with this package to assist in workspace
+management:
+
+<!-- START generators -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+## Init Storm Pulumi Tools Plugin
+
+Init Storm Pulumi Tools Plugin.
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| **name \***    | `string`    |     |     | 
+ | tags      | `string`    | Add tags to the project (used for linting)     |     | 
+ | directory      | `string`    | A directory where the project is placed     |     | 
+ | provider      | `string`    | Your cloud provider     |     | 
+
+
+**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ 
+
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END generators -->
+
 ## Building
 
 Run `nx build pulumi-tools` to build the library.
+
+## Running unit tests
+
+Run `nx test pulumi-tools` to execute the unit tests via
+[Jest](https://jestjs.io).
+
+<!-- START footer -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+## Storm Workspaces
+
+Storm workspaces are built using
+<a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools
+for monorepos, which helps you develop like Google, Facebook, and Microsoft.
+Building on top of Nx, the Open System provides a set of tools and patterns that
+help you scale your monorepo to many teams while keeping the codebase
+maintainable.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Roadmap
+
+See the [open issues](https://github.com/storm-software/storm-ops/issues) for a
+list of proposed features (and known issues).
+
+- [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
+  (Add your votes using the 👍 reaction)
+- [Top Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
+  (Add your votes using the 👍 reaction)
+- [Newest Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Support
+
+Reach out to the maintainer at one of the following places:
+
+- [Contact](https://stormsoftware.com/contact)
+- [GitHub discussions](https://github.com/storm-software/storm-ops/discussions)
+- <support@stormsoftware.com>
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## License
+
+This project is licensed under the **Apache License 2.0**. Feel free to edit and
+distribute this template as you like.
+
+See [LICENSE](LICENSE) for more information.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Changelog
+
+This project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along
+with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)
+file
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Contributing
+
+First off, thanks for taking the time to contribute! Contributions are what
+makes the open-source community such an amazing place to learn, inspire, and
+create. Any contributions you make will benefit everybody else and are **greatly
+appreciated**.
+
+Please try to create bug reports that are:
+
+- _Reproducible._ Include steps to reproduce the problem.
+- _Specific._ Include as much detail as possible: which version, what
+  environment, etc.
+- _Unique._ Do not duplicate existing opened issues.
+- _Scoped to a Single Bug._ One bug per report.
+
+Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
+
+You can use
+[markdownlint-cli](https://github.com/storm-software/storm-ops/markdownlint-cli)
+to check for common markdown style inconsistency.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Contributors
+
+Thanks goes to these wonderful people
+([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.com"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td align="center" size="13px" colspan="7">
+        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg" alt="All Contributors">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the
+[all-contributors](https://github.com/all-contributors/all-contributors)
+specification. Contributions of any kind welcome!
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+<hr />
+<br />
+
+<div align="center">
+<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" alt="Storm Software" />
+</div>
+<br />
+
+<div align="center">
+<a href="https://stormsoftware.com" target="_blank">Website</a>  •  <a href="https://stormsoftware.com/contact" target="_blank">Contact</a>  •  <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a>  •  <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a>  •  <a href="https://github.com/storm-software" target="_blank">GitHub</a>  •  <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
+</div>
+
+<div align="center">
+<b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
+</div>
+<br />
+
+Storm Software is an open source software development organization and creator
+of Acidic, StormStack and StormCloud.
+
+Our mission is to make software development more accessible. Our ideal future is
+one where anyone can create software without years of prior development
+experience serving as a barrier to entry. We hope to achieve this via LLMs,
+Generative AI, and intuitive, high-level data modeling/programming languages.
+
+Join us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,
+receive release notifications, ask questions, and get involved.
+
+If this sounds interesting, and you would like to help us in creating the next
+generation of development tools, please reach out on our
+[website](https://stormsoftware.com/contact) or join our
+[Slack](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)
+channel!
+
+<br />
+
+<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
+<br />
+<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
+
+<br />
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+<br />
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END footer -->

package/dist/{chunk-G7PDZ2WM.js → chunk-32GFYKQ3.js}

@@ -1,9 +1,9 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkH64Q27JPjs = require('./chunk-H64Q27JP.js');
+var _chunkXXWYXYXWjs = require('./chunk-XXWYXYXW.js');
 
 // src/executors/refresh/executor.ts
-var executor_default = _chunkH64Q27JPjs.withPulumiExecutor.call(void 0, "refresh", (options) => [
+var executor_default = _chunkXXWYXYXWjs.withPulumiExecutor.call(void 0, "refresh", (options) => [
   "--suppress-progress",
   options.stack && `--stack=${options.stack}`,
   options.skipPreview && "--skip-preview",

package/dist/{chunk-H7HAPX23.js → chunk-6DP5HHF5.js}

@@ -1,9 +1,9 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkH64Q27JPjs = require('./chunk-H64Q27JP.js');
+var _chunkXXWYXYXWjs = require('./chunk-XXWYXYXW.js');
 
 // src/executors/preview/executor.ts
-var executor_default = _chunkH64Q27JPjs.withPulumiExecutor.call(void 0, "preview", (options) => [
+var executor_default = _chunkXXWYXYXWjs.withPulumiExecutor.call(void 0, "preview", (options) => [
   options.stack && `--stack=${options.stack}`,
   options.expectNoChanges && "--expect-no-changes"
 ]);

package/dist/{chunk-IS6HXL7I.mjs → chunk-ARPHB535.mjs}

@@ -1,6 +1,6 @@
 import {
   withPulumiExecutor
-} from "./chunk-7AYGEMWQ.mjs";
+} from "./chunk-PZVSIXQ3.mjs";
 
 // src/executors/refresh/executor.ts
 var executor_default = withPulumiExecutor("refresh", (options) => [

package/dist/{chunk-S4O5AGOW.mjs → chunk-B5MURCIC.mjs}

@@ -1,6 +1,6 @@
 import {
   withPulumiExecutor
-} from "./chunk-7AYGEMWQ.mjs";
+} from "./chunk-PZVSIXQ3.mjs";
 
 // src/executors/config/executor.ts
 var executor_default = withPulumiExecutor("config", (options) => [

package/dist/{chunk-4TARI6WS.mjs → chunk-CXWKMDJU.mjs}

@@ -1,6 +1,6 @@
 import {
   withPulumiExecutor
-} from "./chunk-7AYGEMWQ.mjs";
+} from "./chunk-PZVSIXQ3.mjs";
 
 // src/executors/up/executor.ts
 var executor_default = withPulumiExecutor("up", (options) => [