@mochabug/adaptkit 1.0.0-rc.4 → 1.0.0-rc.41

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/build.js

@@ -1,57 +1,2 @@
-import { cloudflare } from "@cloudflare/unenv-preset";
-import { build } from 'esbuild';
-import fs from 'node:fs';
-import { defineEnv } from 'unenv';
-
-if (!process.env.PLUGINS_CDN) {
-  console.error('PLUGINS_CDN is required');
-  process.exit(1);
-}
-
-// Load the manifest.json file and read organization, name and version of the plugin
-const manifest = JSON.parse(fs.readFileSync('./manifest.json', 'utf8'));
-if (!manifest.organization || !manifest.name || !manifest.version) {
-  throw new Error('Manifest file is missing organization, name or version');
-}
-const CDN_PATH = `${process.env.PLUGINS_CDN}/${manifest.organization}/${manifest.name}/${manifest.version}`;
-
-const { env } = defineEnv({ nodeCompat: true, presets: [cloudflare] });
-
-const entryPoints = ['./src/executors']
-if (fs.existsSync('./src/configurators.ts')) {
-  entryPoints.push('./src/configurators')
-}
-
-// Set up the defines, this will automatically load ssg index.html files if they exists
-const define = {
-  PLUGINS_CDN: JSON.stringify(CDN_PATH)
-};
-if (fs.existsSync('./dist/configurator-index-html.json')) {
-  const CONFIGURATOR_INDEX_HTML = fs.readFileSync('./dist/configurator-index-html.json', 'utf8');
-  define.CONFIGURATOR_INDEX_HTML = CONFIGURATOR_INDEX_HTML;
-}
-if (fs.existsSync('./dist/executor-index-html.json')) {
-  const EXECUTOR_INDEX_HTML = fs.readFileSync('./dist/executor-index-html.json', 'utf8');
-  define.EXECUTOR_INDEX_HTML = EXECUTOR_INDEX_HTML;
-}
-
-await build({
-  entryPoints,
-  outdir: 'dist',
-  bundle: true,
-  minify: true,
-  treeShaking: true,
-  sourcemap: false,
-  splitting: false,
-  format: 'esm',
-  platform: 'node',
-  target: 'esnext',
-  tsconfig: 'tsconfig.json',
-  inject: ['./inject.js'],
-  mainFields: ["module", "main"],
-  conditions: ["workerd"],
-  external: env.external,
-  alias: env.alias,
-  publicPath: CDN_PATH,
-  define,
-});
+import { build } from '@mochabug/adapt-builder';
+build({ cdnBase: process.env.PLUGINS_CDN });

package/assets/configurator.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>The configurator</title>
+</head>
+
+<body>
+    <div id="root"><%= define.content %></div>
+</body>
+
+</html>

package/assets/configurator.ssg.tsx

@@ -12,20 +12,6 @@ import React from 'react';
 import { renderToString } from 'react-dom/server';
 import App from './configurator.App';
 
-export default function (js: string, css?: string) {
-  return `
-    <!DOCTYPE html>
-    <html lang="en">
-      <head>
-        <meta charset="utf-8" />
-        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-        <title>Title</title>
-        ${css ? `<link rel="stylesheet" href="${css}" />` : ''}
-      </head>
-      <body>
-        <div id="root">${renderToString(<App />)}</div>
-        <script type="module" src="${js}"></script>
-      </body>
-    </html>
-  `;
+export default function () {
+  return renderToString(<App />);
 }

package/assets/configurator_none.ts

@@ -1,11 +1,11 @@
 import {
-  mapErrorToHttpError,
-  RpcError
-} from '@mochabug/adapt-plugin-toolkit/api';
+  ConnectError,
+  mapConnectErrorToHttpStatus
+} from '@mochabug/adapt-sdk/api';
 import {
   ExternalConfiguratorRouter,
   InternalConfiguratorRouter
-} from '@mochabug/adapt-plugin-toolkit/router';
+} from '@mochabug/adapt-sdk/router';
 
 export default {
   external: new ExternalConfiguratorRouter()
@@ -13,8 +13,8 @@ export default {
     .useBearerAuthorization(['/api'])
     .useErrorHandling(async (e) => {
       console.error(e);
-      if (e instanceof RpcError) {
-        return new Response(null, { status: mapErrorToHttpError(e.code) });
+      if (e instanceof ConnectError) {
+        return new Response(null, { status: mapConnectErrorToHttpStatus(e) });
       }
       return new Response(null, {
         status: 500,
@@ -22,8 +22,8 @@ export default {
       });
     })
     .add('GET', '/api/config', async (_req, api) => {
-      const res = await api.getVertexConfig();
-      return new Response(JSON.stringify(res.metadata), {
+      const { metadata } = await api.getConfig('metadata');
+      return new Response(JSON.stringify(metadata), {
         headers: {
           'Content-Type': 'application/json'
         }

package/assets/configurator_react.tsx

@@ -1,11 +1,11 @@
 import {
-  mapErrorToHttpError,
-  RpcError
-} from '@mochabug/adapt-plugin-toolkit/api';
+  ConnectError,
+  mapConnectErrorToHttpStatus
+} from '@mochabug/adapt-sdk/api';
 import {
   ExternalConfiguratorRouter,
   InternalConfiguratorRouter
-} from '@mochabug/adapt-plugin-toolkit/router';
+} from '@mochabug/adapt-sdk/router';
 
 export default {
   external: new ExternalConfiguratorRouter()
@@ -13,8 +13,8 @@ export default {
     .useBearerAuthorization(['/api'])
     .useErrorHandling(async (e) => {
       console.error(e);
-      if (e instanceof RpcError) {
-        return new Response(null, { status: mapErrorToHttpError(e.code) });
+      if (e instanceof ConnectError) {
+        return new Response(null, { status: mapConnectErrorToHttpStatus(e) });
       }
       return new Response(null, {
         status: 500,
@@ -22,16 +22,19 @@ export default {
       });
     })
     .add('GET', '/api/config', async (_req, api) => {
-      const res = await api.getVertexConfig();
-      return new Response(JSON.stringify(res.metadata), {
+      const { metadata } = await api.getConfig('metadata');
+      return new Response(JSON.stringify(metadata), {
         headers: {
           'Content-Type': 'application/json'
         }
       });
     })
-    .add('GET', '{*any}', async () => {
-      return new Response(CONFIGURATOR_INDEX_HTML['___VERTEX_NAME___'], {
-        headers: { 'Content-Type': 'text/html' }
+    .add('GET', '{/*any}', async (_, api) => {
+      const res = await api.readFile(
+        'browser/___VERTEX_NAME___/configurator.html'
+      );
+      return new Response(res.content, {
+        headers: { 'Content-Type': 'text/html; charset=utf-8' }
       });
     }),
   internal: new InternalConfiguratorRouter()

package/assets/executor.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>The executor</title>
+</head>
+
+<body>
+    <div id="root"><%= define.content %></div>
+</body>
+
+</html>

package/assets/executor.ssg.tsx

@@ -12,20 +12,6 @@ import React from 'react';
 import { renderToString } from 'react-dom/server';
 import App from './executor.App';
 
-export default function (js: string, css?: string) {
-  return `
-    <!DOCTYPE html>
-    <html lang="en">
-      <head>
-        <meta charset="utf-8" />
-        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-        <title>Title</title>
-        ${css ? `<link rel="stylesheet" href="${css}" />` : ''}
-      </head>
-      <body>
-        <div id="root">${renderToString(<App />)}</div>
-        <script type="module" src="${js}"></script>
-      </body>
-    </html>
-  `;
+export default function () {
+  return renderToString(<App />);
 }

package/assets/executor_action.ts

@@ -1,22 +1,18 @@
-import { InternalExecutorRouter } from '@mochabug/adapt-plugin-toolkit/router';
+import { InternalExecutorRouter } from '@mochabug/adapt-sdk/router';
 
 export default {
   internal: new InternalExecutorRouter()
     .onStart(async (start, api, ctx) => {
       console.log('Start has been called');
       console.log(start);
-      ctx.waitUntil(api.complete('output', {}));
+      ctx.waitUntil(api.send('output', {}));
     })
     .onStop(async (stop, _api) => {
       console.log('Stop has been called');
       console.log(stop);
     })
-    .onStream(async (res, _api, name) => {
-      console.log(`Stream ${name} has been called`);
-      console.log(res);
-    })
-    .onProcedure(async (res, _api, name) => {
-      console.log(`Procedure ${name} has been called`);
+    .onExchange(async (res, _api, name) => {
+      console.log(`Exchange ${name} has been called`);
       console.log(res);
     })
 };

package/assets/{executor_cron_trigger.ts → executor_action_cron.ts}

@@ -1,4 +1,4 @@
-import { CronExecutorRouter } from '@mochabug/adapt-plugin-toolkit/router';
+import { CronExecutorRouter } from '@mochabug/adapt-sdk/router';
 
 export default {
   internal: new CronExecutorRouter()
@@ -10,17 +10,13 @@ export default {
       console.log('Stop has been called');
       console.log(stop);
     })
-    .onStream(async (res, _api, name) => {
-      console.log(`Stream ${name} has been called`);
-      console.log(res);
-    })
-    .onProcedure(async (res, _api, name) => {
-      console.log(`Procedure ${name} has been called`);
+    .onExchange(async (res, _api, name) => {
+      console.log(`Exchange ${name} has been called`);
       console.log(res);
     })
     .onCron(async (cron, api, ctx) => {
       console.log('Received cron event');
-      ctx.waitUntil(api.complete('output', {}));
+      ctx.waitUntil(api.send('output', {}));
       console.log(cron);
     })
 };

package/assets/executor_browser_none.ts

@@ -1,11 +1,11 @@
 import {
-  mapErrorToHttpError,
-  RpcError
-} from '@mochabug/adapt-plugin-toolkit/api';
+  ConnectError,
+  mapConnectErrorToHttpStatus,
+} from "@mochabug/adapt-sdk/api";
 import {
   ExternalExecutorRouter,
   InternalExecutorRouter
-} from '@mochabug/adapt-plugin-toolkit/router';
+} from '@mochabug/adapt-sdk/router';
 
 export default {
   external: new ExternalExecutorRouter()
@@ -13,8 +13,8 @@ export default {
     .useBearerAuthorization(['/api'])
     .useErrorHandling(async (e) => {
       console.error(e);
-      if (e instanceof RpcError) {
-        return new Response(null, { status: mapErrorToHttpError(e.code) });
+      if (e instanceof ConnectError) {
+        return new Response(null, { status: mapConnectErrorToHttpStatus(e) });
       }
       return new Response(null, {
         status: 500,
@@ -23,7 +23,7 @@ export default {
     })
     .add('POST', '/api/done', async (req, api, _route, ctx) => {
       const sapi = api.getSessionApi(req.headers.get('Authorization')!);
-      ctx.waitUntil(sapi.complete('output', {}));
+      ctx.waitUntil(sapi.send('output', {}));
       return new Response();
     })
     .add('GET', '{*any}', async () => {
@@ -42,12 +42,8 @@ export default {
       console.log('Stop has been called');
       console.log(stop);
     })
-    .onStream(async (res, _api, name) => {
-      console.log(`Stream ${name} has been called`);
-      console.log(res);
-    })
-    .onProcedure(async (res, _api, name) => {
-      console.log(`Procedure ${name} has been called`);
+    .onExchange(async (res, _api, name) => {
+      console.log(`Exchange ${name} has been called`);
       console.log(res);
     })
 };

package/assets/executor_browser_none_cron.ts

@@ -0,0 +1,119 @@
+import {
+  ConnectError,
+  mapConnectErrorToHttpStatus,
+} from "@mochabug/adapt-sdk/api";
+import {
+  ExternalExecutorRouter,
+  CronExecutorRouter
+} from '@mochabug/adapt-sdk/router';
+
+export default {
+  external: new ExternalExecutorRouter()
+    .useRequestLogging()
+    .useBearerAuthorization(['/api'])
+    .useErrorHandling(async (e) => {
+      console.error(e);
+      if (e instanceof ConnectError) {
+        return new Response(null, { status: mapConnectErrorToHttpStatus(e) });
+      }
+      return new Response(null, {
+        status: 500,
+        statusText: 'Internal server error'
+      });
+    })
+    .add('POST', '/api/done', async (req, api, _route, ctx) => {
+      const sapi = api.getSessionApi(req.headers.get('Authorization')!);
+      ctx.waitUntil(sapi.send('output', {}));
+      return new Response();
+    })
+    .add('GET', '{*any}', async () => {
+      return new Response(helloWorld, {
+        headers: {
+          'Content-Type': 'text/html'
+        }
+      });
+    }),
+  internal: new CronExecutorRouter()
+      .onStart(async (start, _api) => {
+        console.log('Start has been called');
+        console.log(start);
+      })
+      .onStop(async (stop, _api) => {
+        console.log('Stop has been called');
+        console.log(stop);
+      })
+      .onExchange(async (res, _api, name) => {
+        console.log(`Exchange ${name} has been called`);
+        console.log(res);
+      })
+      .onCron(async (cron, api, ctx) => {
+        console.log('Received cron event');
+        ctx.waitUntil(api.send('output', {}));
+        console.log(cron);
+      })
+};
+
+const helloWorld = `
+      <html>
+      <head>
+        <style>
+          @import url('https://fonts.googleapis.com/css2?family=Orbitron&display=swap');
+          @keyframes glow {
+            0% { text-shadow: 0 0 5px #0f0, 0 0 10px #0f0, 0 0 15px #0f0, 0 0 20px #0f0; }
+            100% { text-shadow: 0 0 10px #0f0, 0 0 20px #0f0, 0 0 30px #0f0, 0 0 40px #0f0; }
+          }
+          body {
+            background-color: #000;
+            color: #0f0;
+            font-family: 'Orbitron', sans-serif;
+            text-align: center;
+            overflow: hidden;
+            margin: 0;
+            padding: 0;
+          }
+          button {
+            position: absolute;
+            top: 50%;
+            left: 50%;
+            transform: translate(-50%, -50%);
+            background-color: #0f0;
+            border: none;
+            color: black;
+            padding: 15px 32px;
+            text-align: center;
+            text-decoration: none;
+            display: inline-block;
+            font-size: 20px;
+            margin: 4px 2px;
+            cursor: pointer;
+            transition-duration: 0.4s;
+            animation: glow 2s infinite alternate;
+            font-family: 'Orbitron', sans-serif;
+            border-radius: 15px;
+            transform: rotate(-10deg) skew(10deg, 10deg);
+          }
+        </style>
+      </head>
+      <body>
+        <button id="doneButton">Done</button>
+        <script>
+          document.getElementById('doneButton').addEventListener('click', function() {
+            const hash = window.location.hash.substring(1).trim();
+            const token = decodeURIComponent(hash); 
+            fetch('/api/done', {
+              method: 'POST',
+              headers: {
+                'Authorization': 'Bearer ' + token
+              }
+            })
+            .then(data => {
+              this.innerText = 'Done';
+            })
+            .catch(error => {
+              console.error('Error:', error);
+            });
+          });
+        </script>
+      </body>
+      </html>
+    `;

package/assets/executor_browser_react.tsx

@@ -1,11 +1,11 @@
 import {
-  mapErrorToHttpError,
-  RpcError
-} from '@mochabug/adapt-plugin-toolkit/api';
+  ConnectError,
+  mapConnectErrorToHttpStatus,
+} from "@mochabug/adapt-sdk/api";
 import {
   ExternalExecutorRouter,
   InternalExecutorRouter
-} from '@mochabug/adapt-plugin-toolkit/router';
+} from '@mochabug/adapt-sdk/router';
 
 export default {
   external: new ExternalExecutorRouter()
@@ -13,8 +13,8 @@ export default {
     .useBearerAuthorization(['/api'])
     .useErrorHandling(async (e) => {
       console.error(e);
-      if (e instanceof RpcError) {
-        return new Response(null, { status: mapErrorToHttpError(e.code) });
+      if (e instanceof ConnectError) {
+        return new Response(null, { status: mapConnectErrorToHttpStatus(e) });
       }
       return new Response(null, {
         status: 500,
@@ -23,12 +23,15 @@ export default {
     })
     .add('POST', '/api/done', async (req, api, _route, ctx) => {
       const sapi = api.getSessionApi(req.headers.get('Authorization')!);
-      ctx.waitUntil(sapi.complete('output', {}));
+      ctx.waitUntil(sapi.send('output', {}));
       return new Response();
     })
-    .add('GET', '{*any}', async () => {
-      return new Response(EXECUTOR_INDEX_HTML['___VERTEX_NAME___'], {
-        headers: { 'Content-Type': 'text/html' }
+    .add('GET', '{/*any}', async (_, api) => {
+      const res = await api.readFile(
+        'browser/___VERTEX_NAME___/executor.html'
+      );
+      return new Response(res.content, {
+        headers: { 'Content-Type': 'text/html; charset=utf-8' }
       });
     }),
   internal: new InternalExecutorRouter()
@@ -40,12 +43,8 @@ export default {
       console.log('Stop has been called');
       console.log(stop);
     })
-    .onStream(async (res, _api, name) => {
-      console.log(`Stream ${name} has been called`);
-      console.log(res);
-    })
-    .onProcedure(async (res, _api, name) => {
-      console.log(`Procedure ${name} has been called`);
+    .onExchange(async (res, _api, name) => {
+      console.log(`Exchange ${name} has been called`);
       console.log(res);
     })
 };