@mochabug/adaptkit 1.0.0-rc.24 → 1.0.0-rc.25

package/README.md

@@ -1,82 +1,87 @@
-# @mochabug/adaptkit : The Magical CLI for Mochabug Adapt Plugin Development!
+# @mochabug/adaptkit
 
-Welcome to **@mochabug/adaptkit**! Prepare to embark on a whimsical adventure filled with creativity and efficiency! @mochabug/adaptkit is a powerful CLI tool designed to help you *effortlessly* develop and manage plugins for the Mochabug Adapt platform. With @mochabug/adaptkit, you can:
+**@mochabug/adaptkit** is the official CLI tool for developing and managing plugins for the Mochabug Adapt platform. Built with Node.js 22 compatibility, adaptkit streamlines the entire plugin development workflow.
 
-- 🌈 Create enchanting template projects for plugin development
-- 🧙‍♂️ Emulate your plugins in a cloud environment with just a flick of your wand
-- 🧚 Add and modify vertices to your plugin project with ease
-- 🌟 Automagically handle tedious tasks that often bog down software development
+## Key Features
 
-## Magical Vertices: Your Plugin Building Blocks 🔮
+- Create new plugin projects with scaffolding
+- Add vertices (tasks) to existing plugins
+- Emulate plugins locally for testing
+- Publish plugins to the Mochabug Adapt platform
+- Manage plugin versioning with semantic versioning
 
-Vertices, also known as tasks, are the building blocks of your plugins. Each plugin consists of one or more vertices. A vertex in @mochabug/adaptkit consists of two parts: an Executor and an optional Configurator. 
+## Plugin Architecture
 
-- **Executor**: A mandatory part that performs tasks. It can have different types:
-  - **Action**: Performs tasks without interacting with external systems
-  - **Cron Trigger**: Triggers actions at specified intervals, like clockwork
-  - **External Trigger**: Activates tasks from an external endpoint, bringing the magic to the outside world
-  - **Browser**: Runs tasks within a browser, where requests end up on the external endpoint
+Plugins are composed of **vertices** - the fundamental building blocks that define tasks. Each vertex consists of:
 
-- **Configurator**: An optional part that customizes the behavior of the executor. Configurators interact with users on the Mochabug Adapt platform, making them "external" by nature.
+### Executor (Required)
+The core logic that performs tasks. Available types:
+- **Action** - Performs tasks without external system interactions
+- **Cron Trigger** - Executes tasks at scheduled intervals
+- **External Trigger** - Responds to external endpoint events
+- **Browser** - Runs tasks within a browser environment
 
-## Getting Started 🚀
+### Configurator (Optional)
+Provides UI for customizing executor behavior on the Mochabug Adapt platform.
 
-To start your magical journey with @mochabug/adaptkit, install the package using the following incantation:
+## Installation
 
 ```bash
 npm install -g @mochabug/adaptkit
 ```
 
-## Usage 🪄
-
-With @mochabug/adaptkit installed, you can now wield your newfound powers to develop and manage your plugin projects! Here's a guide to help you harness the magic:
-
-1. **Create a template project for plugin development**
+## Commands
 
+### Initialize a Plugin Project
 ```bash
-adaptkit --init
+adaptkit init
 ```
+Creates a new plugin with `manifest.json`, executor/configurator templates, and schema files.
 
-This command generates a `manifest.json` file, Executor and Configurator templates, and .cue schema files with information about your plugin.
-
-2. **Emulate your plugins in the cloud environment**
-
+### Add Vertices to Your Plugin
 ```bash
-adaptkit --emulate
+adaptkit add
 ```
+Interactively adds new vertices to your existing plugin project.
 
-Test your plugin's sorcery in a controlled environment by emulating its behavior in the cloud.
-
-In order to do this you need to have docker installed and run the emulator locally using the following command:
+### Emulate Plugin Locally
+```bash
+adaptkit emulate
+```
+Test your plugin in a local environment. Requires the Mochabug Adapt sandbox:
 
 ```bash
 docker run --rm -it -p 51001:51001 -p 51002:51002 -p 51003:51003 -p 51004:51004 -p 51005:51005 mochabug/adaptsandbox:latest
 ```
 
-Note: The 5 ports is required to simulate the different vertex types as well as the graphical interface together with the publish endpoint of adaptkit.
-
-1. **Add and modify vertices**
+The 5 ports simulate different vertex types, the graphical interface, and the adaptkit publish endpoint.
 
+### Publish to Mochabug Adapt
 ```bash
-adaptkit --add-vertex [vertexType] [vertexName]
+adaptkit publish
 ```
+Deploy your plugin to the Mochabug Adapt platform for production use.
 
-Easily add or modify vertices to your plugin project by specifying the vertex type and name.
-
-4. **Publish your plugin to the Mochabug Adapt platform**
-
+### Version Management
 ```bash
-adaptkit --publish
+adaptkit version --patch  # Increment patch version
+adaptkit version --minor  # Increment minor version
+adaptkit version --major  # Increment major version
 ```
+Updates the semantic version in your plugin's `manifest.json`.
+
+## Node.js 22 Compatibility
+
+Adaptkit is built with full Node.js 22 support, leveraging modern JavaScript features and native ES modules for optimal performance and compatibility.
 
-Share your magical creation with the world by publishing your plugin to the Mochabug Adapt platform.
+## Documentation
 
-## Documentation 📚
+For comprehensive documentation and API references, visit [Mochabug Developer Portal](https://developers.mochabug.com).
 
-For a more comprehensive spellbook on how to use @mochabug/adaptkit and unlock the full potential of our captivating plugin system for Mochabug Adapt, visit our [documentation](https://developers.mochabug.com).
+## Contributing
 
-## Contribute 🤝
+We welcome community contributions! Please [open an issue](https://github.com/mochabug/adaptkit/issues) or [submit a pull request](https://github.com/mochabug/adaptkit/pulls) on GitHub.
 
-@mochabug/adaptkit s is a community-driven, open-source project, and we warmly welcome your contributions! If you have an idea for a new type, a bug report, or would like to help with documentation, please [open an issue](https://github.com/mochabug/mochabug/issues) or [submit a pull request](https://github.com/mochabug/mochabug/pulls).
+## License
 
-## A Magical Journey Awaits! 🍄
+Apache License 2.0

package/assets/tsconf.json

@@ -10,8 +10,7 @@
         ],
         "moduleResolution": "Bundler",
         "types": [
-            "node",
-            "@mochabug/adapt-plugin-typings"
+            "node"
         ],
         "resolveJsonModule": true,
         "allowJs": true,

package/bin/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // <define:__PACKAGE_JSON__>
-var define_PACKAGE_JSON_default = { name: "@mochabug/adaptkit", version: "1.0.0-rc.24" };
+var define_PACKAGE_JSON_default = { name: "@mochabug/adaptkit", version: "1.0.0-rc.25" };
 
 // node_modules/@bufbuild/protobuf/dist/esm/is-message.js
 function isMessage(arg, schema) {
@@ -5084,7 +5084,7 @@ async function init(dir) {
   const installSpinner = ora2("Setting up npm packages...").start();
   try {
     await execPromise2(
-      "npm install --save-dev @mochabug/adapt-plugin-typings @mochabug/adapt-plugin-builder typescript @types/node",
+      "npm install --save-dev @mochabug/adapt-plugin-builder typescript @types/node",
       {
         cwd
       }