@ubiquity-os/plugin-sdk 3.1.10 → 3.2.0

package/README.md

@@ -26,6 +26,7 @@ The `postComment` function enables users to easily post a comment to an issue, a
 To set up the project locally, `bun` is the preferred package manager.
 
 1. Install the dependencies:
+
    ```sh
    bun install
    ```
@@ -35,9 +36,9 @@ To set up the project locally, `bun` is the preferred package manager.
    bun sdk:build
    ```
 3. Link it locally to another plugin
-    ```
-    bun link
-    ```
+   ```
+   bun link
+   ```
 
 ## Scripts
 

package/dist/compression.d.mts

@@ -0,0 +1,4 @@
+declare function compressString(str: string): string;
+declare function decompressString(compressed: string): string;
+
+export { compressString, decompressString };

package/dist/compression.d.ts

@@ -0,0 +1,4 @@
+declare function compressString(str: string): string;
+declare function decompressString(compressed: string): string;
+
+export { compressString, decompressString };

package/dist/compression.js

@@ -0,0 +1,42 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/helpers/compression.ts
+var compression_exports = {};
+__export(compression_exports, {
+  compressString: () => compressString,
+  decompressString: () => decompressString
+});
+module.exports = __toCommonJS(compression_exports);
+var import_brotli = require("brotli");
+function compressString(str) {
+  const input = Buffer.from(str, "utf8");
+  const compressed = (0, import_brotli.compress)(input);
+  return Buffer.from(compressed).toString("base64");
+}
+function decompressString(compressed) {
+  const buffer = Buffer.from(compressed, "base64");
+  const decompressed = (0, import_brotli.decompress)(buffer);
+  return Buffer.from(decompressed).toString("utf8");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  compressString,
+  decompressString
+});

package/dist/compression.mjs

@@ -0,0 +1,16 @@
+// src/helpers/compression.ts
+import { compress, decompress } from "brotli";
+function compressString(str) {
+  const input = Buffer.from(str, "utf8");
+  const compressed = compress(input);
+  return Buffer.from(compressed).toString("base64");
+}
+function decompressString(compressed) {
+  const buffer = Buffer.from(compressed, "base64");
+  const decompressed = decompress(buffer);
+  return Buffer.from(decompressed).toString("utf8");
+}
+export {
+  compressString,
+  decompressString
+};

package/dist/index.d.mts

@@ -52,7 +52,7 @@ declare class CommentHandler {
     _getIssueNumber(context: Context): number | undefined;
     _getCommentId(context: Context): number | undefined;
     _extractIssueContext(context: Context): IssueContext | null;
-    _processMessage(context: Context, message: LogReturn | Error): Promise<{
+    _processMessage(context: Context, message: LogReturn | Error): {
         metadata: {
             message: string;
             name: string;
@@ -88,14 +88,14 @@ declare class CommentHandler {
             level: _ubiquity_os_ubiquity_os_logger.LogLevel;
             type: _ubiquity_os_ubiquity_os_logger.LogLevelWithOk;
         };
-    }>;
+    };
     _getInstigatorName(context: Context): string;
-    _createMetadataContent(context: Context, metadata: Metadata): Promise<{
+    _createMetadataContent(context: Context, metadata: Metadata): {
         header: string;
         jsonPretty: string;
-    }>;
+    };
     _formatMetadataContent(logMessage: LogReturn["logMessage"], header: string, jsonPretty: string): string;
-    createCommentBody(context: Context, message: LogReturn | Error, options?: Pick<CommentOptions, "raw">): Promise<string>;
+    createCommentBody(context: Context, message: LogReturn | Error, options?: Pick<CommentOptions, "raw">): string;
     private _createCommentBody;
     postComment(context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<WithIssueNumber<PostedGithubComment> | null>;
 }

package/dist/index.d.ts

@@ -52,7 +52,7 @@ declare class CommentHandler {
     _getIssueNumber(context: Context): number | undefined;
     _getCommentId(context: Context): number | undefined;
     _extractIssueContext(context: Context): IssueContext | null;
-    _processMessage(context: Context, message: LogReturn | Error): Promise<{
+    _processMessage(context: Context, message: LogReturn | Error): {
         metadata: {
             message: string;
             name: string;
@@ -88,14 +88,14 @@ declare class CommentHandler {
             level: _ubiquity_os_ubiquity_os_logger.LogLevel;
             type: _ubiquity_os_ubiquity_os_logger.LogLevelWithOk;
         };
-    }>;
+    };
     _getInstigatorName(context: Context): string;
-    _createMetadataContent(context: Context, metadata: Metadata): Promise<{
+    _createMetadataContent(context: Context, metadata: Metadata): {
         header: string;
         jsonPretty: string;
-    }>;
+    };
     _formatMetadataContent(logMessage: LogReturn["logMessage"], header: string, jsonPretty: string): string;
-    createCommentBody(context: Context, message: LogReturn | Error, options?: Pick<CommentOptions, "raw">): Promise<string>;
+    createCommentBody(context: Context, message: LogReturn | Error, options?: Pick<CommentOptions, "raw">): string;
     private _createCommentBody;
     postComment(context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<WithIssueNumber<PostedGithubComment> | null>;
 }

package/dist/index.js

@@ -39,7 +39,7 @@ module.exports = __toCommonJS(src_exports);
 // src/actions.ts
 var core = __toESM(require("@actions/core"));
 var github2 = __toESM(require("@actions/github"));
-var import_value2 = require("@sinclair/typebox/value");
+var import_value3 = require("@sinclair/typebox/value");
 var import_ubiquity_os_logger3 = require("@ubiquity-os/ubiquity-os-logger");
 var import_dotenv = require("dotenv");
 
@@ -76,7 +76,7 @@ var PluginRuntimeInfo = class _PluginRuntimeInfo {
 };
 var CfRuntimeInfo = class extends PluginRuntimeInfo {
   get version() {
-    return Promise.resolve(this._env.CLOUDFLARE_VERSION_METADATA?.id ?? "CLOUDFLARE_VERSION_METADATA");
+    return this._env.CLOUDFLARE_VERSION_METADATA?.id ?? "CLOUDFLARE_VERSION_METADATA";
   }
   get runUrl() {
     const accountId = this._env.CLOUDFLARE_ACCOUNT_ID ?? "<missing-cloudflare-account-id>";
@@ -89,7 +89,7 @@ var CfRuntimeInfo = class extends PluginRuntimeInfo {
 };
 var NodeRuntimeInfo = class extends PluginRuntimeInfo {
   get version() {
-    return Promise.resolve(import_github.default.context.sha);
+    return import_github.default.context.sha;
   }
   get runUrl() {
     return import_github.default.context.payload.repository ? `${import_github.default.context.payload.repository?.html_url}/actions/runs/${import_github.default.context.runId}` : "http://localhost";
@@ -97,7 +97,7 @@ var NodeRuntimeInfo = class extends PluginRuntimeInfo {
 };
 var DenoRuntimeInfo = class extends PluginRuntimeInfo {
   get version() {
-    return Promise.resolve(Deno.env.get("DENO_DEPLOYMENT_ID"));
+    return Deno.env.get("DENO_DEPLOYMENT_ID");
   }
   get runUrl() {
     const projectName = Deno.env.get("DENO_PROJECT_NAME");
@@ -160,6 +160,7 @@ function getPluginOptions(options) {
     settingsSchema: options?.settingsSchema,
     envSchema: options?.envSchema,
     commandSchema: options?.commandSchema,
+    // eslint-disable-next-line sonarjs/deprecation
     bypassSignatureVerification: options?.bypassSignatureVerification || false
   };
 }
@@ -235,7 +236,7 @@ var CommentHandler = class _CommentHandler {
       repo: context2.payload.repository.name
     };
   }
-  async _processMessage(context2, message) {
+  _processMessage(context2, message) {
     if (message instanceof Error) {
       const metadata2 = {
         message: message.message,
@@ -258,11 +259,11 @@ var CommentHandler = class _CommentHandler {
     }
     return context2.payload.sender?.login || _CommentHandler.HEADER_NAME;
   }
-  async _createMetadataContent(context2, metadata) {
+  _createMetadataContent(context2, metadata) {
     const jsonPretty = sanitizeMetadata(metadata);
     const instigatorName = this._getInstigatorName(context2);
     const runUrl = PluginRuntimeInfo.getInstance().runUrl;
-    const version = await PluginRuntimeInfo.getInstance().version;
+    const version = PluginRuntimeInfo.getInstance().version;
     const callingFnName = metadata.caller || "anonymous";
     return {
       header: `<!-- ${_CommentHandler.HEADER_NAME} - ${callingFnName} - ${version} - @${instigatorName} - ${runUrl}`,
@@ -277,12 +278,12 @@ var CommentHandler = class _CommentHandler {
   /*
    * Creates the body for the comment, embeds the metadata and the header hidden in the body as well.
    */
-  async createCommentBody(context2, message, options) {
+  createCommentBody(context2, message, options) {
     return this._createCommentBody(context2, message, options);
   }
-  async _createCommentBody(context2, message, options) {
-    const { metadata, logMessage } = await this._processMessage(context2, message);
-    const { header, jsonPretty } = await this._createMetadataContent(context2, metadata);
+  _createCommentBody(context2, message, options) {
+    const { metadata, logMessage } = this._processMessage(context2, message);
+    const { header, jsonPretty } = this._createMetadataContent(context2, metadata);
     const metadataContent = this._formatMetadataContent(logMessage, header, jsonPretty);
     return `${options?.raw ? logMessage?.raw : logMessage?.diff}
 
@@ -295,7 +296,7 @@ ${metadataContent}
       context2.logger.info("Cannot post comment: missing issue context in payload");
       return null;
     }
-    const body = await this._createCommentBody(context2, message, options);
+    const body = this._createCommentBody(context2, message, options);
     const { issueNumber, commentId, owner, repo } = issueContext;
     const params = { owner, repo, body, issueNumber };
     if (options.updateComment) {
@@ -335,6 +336,31 @@ function transformError(context2, error) {
   return loggerError;
 }
 
+// src/helpers/command.ts
+var import_value = require("@sinclair/typebox/value");
+function getCommand(inputs, pluginOptions) {
+  let command = null;
+  if (inputs.command && pluginOptions.commandSchema) {
+    try {
+      command = import_value.Value.Decode(pluginOptions.commandSchema, import_value.Value.Default(pluginOptions.commandSchema, inputs.command));
+    } catch (e) {
+      console.dir(...import_value.Value.Errors(pluginOptions.commandSchema, inputs.command), { depth: null });
+      throw e;
+    }
+  } else if (inputs.command) {
+    command = inputs.command;
+  }
+  return command;
+}
+
+// src/helpers/compression.ts
+var import_brotli = require("brotli");
+function compressString(str) {
+  const input = Buffer.from(str, "utf8");
+  const compressed = (0, import_brotli.compress)(input);
+  return Buffer.from(compressed).toString("base64");
+}
+
 // src/octokit.ts
 var import_core = require("@octokit/core");
 var import_plugin_paginate_graphql = require("@octokit/plugin-paginate-graphql");
@@ -404,11 +430,11 @@ var commandCallSchema = import_typebox.Type.Union([import_typebox.Type.Null(), i
 
 // src/types/util.ts
 var import_typebox2 = require("@sinclair/typebox");
-var import_value = require("@sinclair/typebox/value");
+var import_value2 = require("@sinclair/typebox/value");
 function jsonType(type) {
   return import_typebox2.Type.Transform(import_typebox2.Type.String()).Decode((value) => {
     const parsed = JSON.parse(value);
-    return import_value.Value.Decode(type, import_value.Value.Default(type, parsed));
+    return import_value2.Value.Decode(type, import_value2.Value.Default(type, parsed));
   }).Encode((value) => JSON.stringify(value));
 }
 
@@ -426,6 +452,18 @@ var inputSchema = import_typebox3.Type.Object({
 
 // src/actions.ts
 (0, import_dotenv.config)();
+async function handleError(context2, pluginOptions, error) {
+  console.error(error);
+  const loggerError = transformError(context2, error);
+  if (loggerError instanceof import_ubiquity_os_logger3.LogReturn) {
+    core.setFailed(loggerError.logMessage.diff);
+  } else if (loggerError instanceof Error) {
+    core.setFailed(loggerError);
+  }
+  if (pluginOptions.postCommentOnError && loggerError) {
+    await context2.commentHandler.postComment(context2, loggerError);
+  }
+}
 async function createActionsPlugin(handler, options) {
   const pluginOptions = getPluginOptions(options);
   const pluginGithubToken = process.env.PLUGIN_GITHUB_TOKEN;
@@ -434,7 +472,7 @@ async function createActionsPlugin(handler, options) {
     return;
   }
   const body = github2.context.payload.inputs;
-  const inputSchemaErrors = [...import_value2.Value.Errors(inputSchema, body)];
+  const inputSchemaErrors = [...import_value3.Value.Errors(inputSchema, body)];
   if (inputSchemaErrors.length) {
     console.dir(inputSchemaErrors, { depth: null });
     core.setFailed(`Error: Invalid inputs payload: ${inputSchemaErrors.map((o) => o.message).join(", ")}`);
@@ -445,13 +483,13 @@ async function createActionsPlugin(handler, options) {
     core.setFailed(`Error: Invalid signature`);
     return;
   }
-  const inputs = import_value2.Value.Decode(inputSchema, body);
+  const inputs = import_value3.Value.Decode(inputSchema, body);
   let config2;
   if (pluginOptions.settingsSchema) {
     try {
-      config2 = import_value2.Value.Decode(pluginOptions.settingsSchema, import_value2.Value.Default(pluginOptions.settingsSchema, inputs.settings));
+      config2 = import_value3.Value.Decode(pluginOptions.settingsSchema, import_value3.Value.Default(pluginOptions.settingsSchema, inputs.settings));
     } catch (e) {
-      console.dir(...import_value2.Value.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
+      console.dir(...import_value3.Value.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
       core.setFailed(`Error: Invalid settings provided.`);
       throw e;
     }
@@ -461,26 +499,16 @@ async function createActionsPlugin(handler, options) {
   let env;
   if (pluginOptions.envSchema) {
     try {
-      env = import_value2.Value.Decode(pluginOptions.envSchema, import_value2.Value.Default(pluginOptions.envSchema, process.env));
+      env = import_value3.Value.Decode(pluginOptions.envSchema, import_value3.Value.Default(pluginOptions.envSchema, process.env));
     } catch (e) {
-      console.dir(...import_value2.Value.Errors(pluginOptions.envSchema, process.env), { depth: null });
+      console.dir(...import_value3.Value.Errors(pluginOptions.envSchema, process.env), { depth: null });
       core.setFailed(`Error: Invalid environment provided.`);
       throw e;
     }
   } else {
     env = process.env;
   }
-  let command = null;
-  if (inputs.command && pluginOptions.commandSchema) {
-    try {
-      command = import_value2.Value.Decode(pluginOptions.commandSchema, import_value2.Value.Default(pluginOptions.commandSchema, inputs.command));
-    } catch (e) {
-      console.dir(...import_value2.Value.Errors(pluginOptions.commandSchema, inputs.command), { depth: null });
-      throw e;
-    }
-  } else if (inputs.command) {
-    command = inputs.command;
-  }
+  const command = getCommand(inputs, pluginOptions);
   const context2 = {
     eventName: inputs.eventName,
     payload: inputs.eventPayload,
@@ -496,16 +524,7 @@ async function createActionsPlugin(handler, options) {
     core.setOutput("result", result);
     await returnDataToKernel(pluginGithubToken, inputs.stateId, result);
   } catch (error) {
-    console.error(error);
-    const loggerError = transformError(context2, error);
-    if (loggerError instanceof import_ubiquity_os_logger3.LogReturn) {
-      core.setFailed(loggerError.logMessage.diff);
-    } else if (loggerError instanceof Error) {
-      core.setFailed(loggerError);
-    }
-    if (pluginOptions.postCommentOnError && loggerError) {
-      await context2.commentHandler.postComment(context2, loggerError);
-    }
+    await handleError(context2, pluginOptions, error);
   }
 }
 async function returnDataToKernel(repoToken, stateId, output) {
@@ -516,17 +535,25 @@ async function returnDataToKernel(repoToken, stateId, output) {
     event_type: "return-data-to-ubiquity-os-kernel",
     client_payload: {
       state_id: stateId,
-      output: output ? JSON.stringify(output) : null
+      output: output ? compressString(JSON.stringify(output)) : null
     }
   });
 }
 
 // src/server.ts
-var import_value3 = require("@sinclair/typebox/value");
+var import_value4 = require("@sinclair/typebox/value");
 var import_ubiquity_os_logger4 = require("@ubiquity-os/ubiquity-os-logger");
 var import_hono = require("hono");
 var import_adapter2 = require("hono/adapter");
 var import_http_exception = require("hono/http-exception");
+async function handleError2(context2, pluginOptions, error) {
+  console.error(error);
+  const loggerError = transformError(context2, error);
+  if (pluginOptions.postCommentOnError && loggerError) {
+    await context2.commentHandler.postComment(context2, loggerError);
+  }
+  throw new import_http_exception.HTTPException(500, { message: "Unexpected error" });
+}
 function createPlugin(handler, manifest, options) {
   const pluginOptions = getPluginOptions(options);
   const app = new import_hono.Hono();
@@ -538,7 +565,7 @@ function createPlugin(handler, manifest, options) {
       throw new import_http_exception.HTTPException(400, { message: "Content-Type must be application/json" });
     }
     const body = await ctx.req.json();
-    const inputSchemaErrors = [...import_value3.Value.Errors(inputSchema, body)];
+    const inputSchemaErrors = [...import_value4.Value.Errors(inputSchema, body)];
     if (inputSchemaErrors.length) {
       console.dir(inputSchemaErrors, { depth: null });
       throw new import_http_exception.HTTPException(400, { message: "Invalid body" });
@@ -547,13 +574,13 @@ function createPlugin(handler, manifest, options) {
     if (!pluginOptions.bypassSignatureVerification && !await verifySignature(pluginOptions.kernelPublicKey, body, signature)) {
       throw new import_http_exception.HTTPException(400, { message: "Invalid signature" });
     }
-    const inputs = import_value3.Value.Decode(inputSchema, body);
+    const inputs = import_value4.Value.Decode(inputSchema, body);
     let config2;
     if (pluginOptions.settingsSchema) {
       try {
-        config2 = import_value3.Value.Decode(pluginOptions.settingsSchema, import_value3.Value.Default(pluginOptions.settingsSchema, inputs.settings));
+        config2 = import_value4.Value.Decode(pluginOptions.settingsSchema, import_value4.Value.Default(pluginOptions.settingsSchema, inputs.settings));
       } catch (e) {
-        console.dir(...import_value3.Value.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
+        console.dir(...import_value4.Value.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
         throw e;
       }
     } else {
@@ -563,9 +590,9 @@ function createPlugin(handler, manifest, options) {
     const honoEnvironment = (0, import_adapter2.env)(ctx);
     if (pluginOptions.envSchema) {
       try {
-        env = import_value3.Value.Decode(pluginOptions.envSchema, import_value3.Value.Default(pluginOptions.envSchema, honoEnvironment));
+        env = import_value4.Value.Decode(pluginOptions.envSchema, import_value4.Value.Default(pluginOptions.envSchema, honoEnvironment));
       } catch (e) {
-        console.dir(...import_value3.Value.Errors(pluginOptions.envSchema, honoEnvironment), { depth: null });
+        console.dir(...import_value4.Value.Errors(pluginOptions.envSchema, honoEnvironment), { depth: null });
         throw e;
       }
     } else {
@@ -573,17 +600,7 @@ function createPlugin(handler, manifest, options) {
     }
     const workerName = new URL(inputs.ref).hostname.split(".")[0];
     PluginRuntimeInfo.getInstance({ ...env, CLOUDFLARE_WORKER_NAME: workerName });
-    let command = null;
-    if (inputs.command && pluginOptions.commandSchema) {
-      try {
-        command = import_value3.Value.Decode(pluginOptions.commandSchema, import_value3.Value.Default(pluginOptions.commandSchema, inputs.command));
-      } catch (e) {
-        console.log(...import_value3.Value.Errors(pluginOptions.commandSchema, inputs.command), { depth: null });
-        throw e;
-      }
-    } else if (inputs.command) {
-      command = inputs.command;
-    }
+    const command = getCommand(inputs, pluginOptions);
     const context2 = {
       eventName: inputs.eventName,
       payload: inputs.eventPayload,
@@ -598,12 +615,7 @@ function createPlugin(handler, manifest, options) {
       const result = await handler(context2);
       return ctx.json({ stateId: inputs.stateId, output: result ?? {} });
     } catch (error) {
-      console.error(error);
-      const loggerError = transformError(context2, error);
-      if (pluginOptions.postCommentOnError && loggerError) {
-        await context2.commentHandler.postComment(context2, loggerError);
-      }
-      throw new import_http_exception.HTTPException(500, { message: "Unexpected error" });
+      await handleError2(context2, pluginOptions, error);
     }
   });
   return app;

package/dist/index.mjs

@@ -1,7 +1,7 @@
 // src/actions.ts
 import * as core from "@actions/core";
 import * as github2 from "@actions/github";
-import { Value as Value2 } from "@sinclair/typebox/value";
+import { Value as Value3 } from "@sinclair/typebox/value";
 import { LogReturn as LogReturn3, Logs } from "@ubiquity-os/ubiquity-os-logger";
 import { config } from "dotenv";
 
@@ -38,7 +38,7 @@ var PluginRuntimeInfo = class _PluginRuntimeInfo {
 };
 var CfRuntimeInfo = class extends PluginRuntimeInfo {
   get version() {
-    return Promise.resolve(this._env.CLOUDFLARE_VERSION_METADATA?.id ?? "CLOUDFLARE_VERSION_METADATA");
+    return this._env.CLOUDFLARE_VERSION_METADATA?.id ?? "CLOUDFLARE_VERSION_METADATA";
   }
   get runUrl() {
     const accountId = this._env.CLOUDFLARE_ACCOUNT_ID ?? "<missing-cloudflare-account-id>";
@@ -51,7 +51,7 @@ var CfRuntimeInfo = class extends PluginRuntimeInfo {
 };
 var NodeRuntimeInfo = class extends PluginRuntimeInfo {
   get version() {
-    return Promise.resolve(github.context.sha);
+    return github.context.sha;
   }
   get runUrl() {
     return github.context.payload.repository ? `${github.context.payload.repository?.html_url}/actions/runs/${github.context.runId}` : "http://localhost";
@@ -59,7 +59,7 @@ var NodeRuntimeInfo = class extends PluginRuntimeInfo {
 };
 var DenoRuntimeInfo = class extends PluginRuntimeInfo {
   get version() {
-    return Promise.resolve(Deno.env.get("DENO_DEPLOYMENT_ID"));
+    return Deno.env.get("DENO_DEPLOYMENT_ID");
   }
   get runUrl() {
     const projectName = Deno.env.get("DENO_PROJECT_NAME");
@@ -122,6 +122,7 @@ function getPluginOptions(options) {
     settingsSchema: options?.settingsSchema,
     envSchema: options?.envSchema,
     commandSchema: options?.commandSchema,
+    // eslint-disable-next-line sonarjs/deprecation
     bypassSignatureVerification: options?.bypassSignatureVerification || false
   };
 }
@@ -197,7 +198,7 @@ var CommentHandler = class _CommentHandler {
       repo: context2.payload.repository.name
     };
   }
-  async _processMessage(context2, message) {
+  _processMessage(context2, message) {
     if (message instanceof Error) {
       const metadata2 = {
         message: message.message,
@@ -220,11 +221,11 @@ var CommentHandler = class _CommentHandler {
     }
     return context2.payload.sender?.login || _CommentHandler.HEADER_NAME;
   }
-  async _createMetadataContent(context2, metadata) {
+  _createMetadataContent(context2, metadata) {
     const jsonPretty = sanitizeMetadata(metadata);
     const instigatorName = this._getInstigatorName(context2);
     const runUrl = PluginRuntimeInfo.getInstance().runUrl;
-    const version = await PluginRuntimeInfo.getInstance().version;
+    const version = PluginRuntimeInfo.getInstance().version;
     const callingFnName = metadata.caller || "anonymous";
     return {
       header: `<!-- ${_CommentHandler.HEADER_NAME} - ${callingFnName} - ${version} - @${instigatorName} - ${runUrl}`,
@@ -239,12 +240,12 @@ var CommentHandler = class _CommentHandler {
   /*
    * Creates the body for the comment, embeds the metadata and the header hidden in the body as well.
    */
-  async createCommentBody(context2, message, options) {
+  createCommentBody(context2, message, options) {
     return this._createCommentBody(context2, message, options);
   }
-  async _createCommentBody(context2, message, options) {
-    const { metadata, logMessage } = await this._processMessage(context2, message);
-    const { header, jsonPretty } = await this._createMetadataContent(context2, metadata);
+  _createCommentBody(context2, message, options) {
+    const { metadata, logMessage } = this._processMessage(context2, message);
+    const { header, jsonPretty } = this._createMetadataContent(context2, metadata);
     const metadataContent = this._formatMetadataContent(logMessage, header, jsonPretty);
     return `${options?.raw ? logMessage?.raw : logMessage?.diff}
 
@@ -257,7 +258,7 @@ ${metadataContent}
       context2.logger.info("Cannot post comment: missing issue context in payload");
       return null;
     }
-    const body = await this._createCommentBody(context2, message, options);
+    const body = this._createCommentBody(context2, message, options);
     const { issueNumber, commentId, owner, repo } = issueContext;
     const params = { owner, repo, body, issueNumber };
     if (options.updateComment) {
@@ -297,6 +298,31 @@ function transformError(context2, error) {
   return loggerError;
 }
 
+// src/helpers/command.ts
+import { Value } from "@sinclair/typebox/value";
+function getCommand(inputs, pluginOptions) {
+  let command = null;
+  if (inputs.command && pluginOptions.commandSchema) {
+    try {
+      command = Value.Decode(pluginOptions.commandSchema, Value.Default(pluginOptions.commandSchema, inputs.command));
+    } catch (e) {
+      console.dir(...Value.Errors(pluginOptions.commandSchema, inputs.command), { depth: null });
+      throw e;
+    }
+  } else if (inputs.command) {
+    command = inputs.command;
+  }
+  return command;
+}
+
+// src/helpers/compression.ts
+import { compress, decompress } from "brotli";
+function compressString(str) {
+  const input = Buffer.from(str, "utf8");
+  const compressed = compress(input);
+  return Buffer.from(compressed).toString("base64");
+}
+
 // src/octokit.ts
 import { Octokit } from "@octokit/core";
 import { paginateGraphQL } from "@octokit/plugin-paginate-graphql";
@@ -366,11 +392,11 @@ var commandCallSchema = T.Union([T.Null(), T.Object({ name: T.String(), paramete
 
 // src/types/util.ts
 import { Type } from "@sinclair/typebox";
-import { Value } from "@sinclair/typebox/value";
+import { Value as Value2 } from "@sinclair/typebox/value";
 function jsonType(type) {
   return Type.Transform(Type.String()).Decode((value) => {
     const parsed = JSON.parse(value);
-    return Value.Decode(type, Value.Default(type, parsed));
+    return Value2.Decode(type, Value2.Default(type, parsed));
   }).Encode((value) => JSON.stringify(value));
 }
 
@@ -388,6 +414,18 @@ var inputSchema = T2.Object({
 
 // src/actions.ts
 config();
+async function handleError(context2, pluginOptions, error) {
+  console.error(error);
+  const loggerError = transformError(context2, error);
+  if (loggerError instanceof LogReturn3) {
+    core.setFailed(loggerError.logMessage.diff);
+  } else if (loggerError instanceof Error) {
+    core.setFailed(loggerError);
+  }
+  if (pluginOptions.postCommentOnError && loggerError) {
+    await context2.commentHandler.postComment(context2, loggerError);
+  }
+}
 async function createActionsPlugin(handler, options) {
   const pluginOptions = getPluginOptions(options);
   const pluginGithubToken = process.env.PLUGIN_GITHUB_TOKEN;
@@ -396,7 +434,7 @@ async function createActionsPlugin(handler, options) {
     return;
   }
   const body = github2.context.payload.inputs;
-  const inputSchemaErrors = [...Value2.Errors(inputSchema, body)];
+  const inputSchemaErrors = [...Value3.Errors(inputSchema, body)];
   if (inputSchemaErrors.length) {
     console.dir(inputSchemaErrors, { depth: null });
     core.setFailed(`Error: Invalid inputs payload: ${inputSchemaErrors.map((o) => o.message).join(", ")}`);
@@ -407,13 +445,13 @@ async function createActionsPlugin(handler, options) {
     core.setFailed(`Error: Invalid signature`);
     return;
   }
-  const inputs = Value2.Decode(inputSchema, body);
+  const inputs = Value3.Decode(inputSchema, body);
   let config2;
   if (pluginOptions.settingsSchema) {
     try {
-      config2 = Value2.Decode(pluginOptions.settingsSchema, Value2.Default(pluginOptions.settingsSchema, inputs.settings));
+      config2 = Value3.Decode(pluginOptions.settingsSchema, Value3.Default(pluginOptions.settingsSchema, inputs.settings));
     } catch (e) {
-      console.dir(...Value2.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
+      console.dir(...Value3.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
       core.setFailed(`Error: Invalid settings provided.`);
       throw e;
     }
@@ -423,26 +461,16 @@ async function createActionsPlugin(handler, options) {
   let env;
   if (pluginOptions.envSchema) {
     try {
-      env = Value2.Decode(pluginOptions.envSchema, Value2.Default(pluginOptions.envSchema, process.env));
+      env = Value3.Decode(pluginOptions.envSchema, Value3.Default(pluginOptions.envSchema, process.env));
     } catch (e) {
-      console.dir(...Value2.Errors(pluginOptions.envSchema, process.env), { depth: null });
+      console.dir(...Value3.Errors(pluginOptions.envSchema, process.env), { depth: null });
       core.setFailed(`Error: Invalid environment provided.`);
       throw e;
     }
   } else {
     env = process.env;
   }
-  let command = null;
-  if (inputs.command && pluginOptions.commandSchema) {
-    try {
-      command = Value2.Decode(pluginOptions.commandSchema, Value2.Default(pluginOptions.commandSchema, inputs.command));
-    } catch (e) {
-      console.dir(...Value2.Errors(pluginOptions.commandSchema, inputs.command), { depth: null });
-      throw e;
-    }
-  } else if (inputs.command) {
-    command = inputs.command;
-  }
+  const command = getCommand(inputs, pluginOptions);
   const context2 = {
     eventName: inputs.eventName,
     payload: inputs.eventPayload,
@@ -458,16 +486,7 @@ async function createActionsPlugin(handler, options) {
     core.setOutput("result", result);
     await returnDataToKernel(pluginGithubToken, inputs.stateId, result);
   } catch (error) {
-    console.error(error);
-    const loggerError = transformError(context2, error);
-    if (loggerError instanceof LogReturn3) {
-      core.setFailed(loggerError.logMessage.diff);
-    } else if (loggerError instanceof Error) {
-      core.setFailed(loggerError);
-    }
-    if (pluginOptions.postCommentOnError && loggerError) {
-      await context2.commentHandler.postComment(context2, loggerError);
-    }
+    await handleError(context2, pluginOptions, error);
   }
 }
 async function returnDataToKernel(repoToken, stateId, output) {
@@ -478,17 +497,25 @@ async function returnDataToKernel(repoToken, stateId, output) {
     event_type: "return-data-to-ubiquity-os-kernel",
     client_payload: {
       state_id: stateId,
-      output: output ? JSON.stringify(output) : null
+      output: output ? compressString(JSON.stringify(output)) : null
     }
   });
 }
 
 // src/server.ts
-import { Value as Value3 } from "@sinclair/typebox/value";
+import { Value as Value4 } from "@sinclair/typebox/value";
 import { Logs as Logs2 } from "@ubiquity-os/ubiquity-os-logger";
 import { Hono } from "hono";
 import { env as honoEnv } from "hono/adapter";
 import { HTTPException } from "hono/http-exception";
+async function handleError2(context2, pluginOptions, error) {
+  console.error(error);
+  const loggerError = transformError(context2, error);
+  if (pluginOptions.postCommentOnError && loggerError) {
+    await context2.commentHandler.postComment(context2, loggerError);
+  }
+  throw new HTTPException(500, { message: "Unexpected error" });
+}
 function createPlugin(handler, manifest, options) {
   const pluginOptions = getPluginOptions(options);
   const app = new Hono();
@@ -500,7 +527,7 @@ function createPlugin(handler, manifest, options) {
       throw new HTTPException(400, { message: "Content-Type must be application/json" });
     }
     const body = await ctx.req.json();
-    const inputSchemaErrors = [...Value3.Errors(inputSchema, body)];
+    const inputSchemaErrors = [...Value4.Errors(inputSchema, body)];
     if (inputSchemaErrors.length) {
       console.dir(inputSchemaErrors, { depth: null });
       throw new HTTPException(400, { message: "Invalid body" });
@@ -509,13 +536,13 @@ function createPlugin(handler, manifest, options) {
     if (!pluginOptions.bypassSignatureVerification && !await verifySignature(pluginOptions.kernelPublicKey, body, signature)) {
       throw new HTTPException(400, { message: "Invalid signature" });
     }
-    const inputs = Value3.Decode(inputSchema, body);
+    const inputs = Value4.Decode(inputSchema, body);
     let config2;
     if (pluginOptions.settingsSchema) {
       try {
-        config2 = Value3.Decode(pluginOptions.settingsSchema, Value3.Default(pluginOptions.settingsSchema, inputs.settings));
+        config2 = Value4.Decode(pluginOptions.settingsSchema, Value4.Default(pluginOptions.settingsSchema, inputs.settings));
       } catch (e) {
-        console.dir(...Value3.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
+        console.dir(...Value4.Errors(pluginOptions.settingsSchema, inputs.settings), { depth: null });
         throw e;
       }
     } else {
@@ -525,9 +552,9 @@ function createPlugin(handler, manifest, options) {
     const honoEnvironment = honoEnv(ctx);
     if (pluginOptions.envSchema) {
       try {
-        env = Value3.Decode(pluginOptions.envSchema, Value3.Default(pluginOptions.envSchema, honoEnvironment));
+        env = Value4.Decode(pluginOptions.envSchema, Value4.Default(pluginOptions.envSchema, honoEnvironment));
       } catch (e) {
-        console.dir(...Value3.Errors(pluginOptions.envSchema, honoEnvironment), { depth: null });
+        console.dir(...Value4.Errors(pluginOptions.envSchema, honoEnvironment), { depth: null });
         throw e;
       }
     } else {
@@ -535,17 +562,7 @@ function createPlugin(handler, manifest, options) {
     }
     const workerName = new URL(inputs.ref).hostname.split(".")[0];
     PluginRuntimeInfo.getInstance({ ...env, CLOUDFLARE_WORKER_NAME: workerName });
-    let command = null;
-    if (inputs.command && pluginOptions.commandSchema) {
-      try {
-        command = Value3.Decode(pluginOptions.commandSchema, Value3.Default(pluginOptions.commandSchema, inputs.command));
-      } catch (e) {
-        console.log(...Value3.Errors(pluginOptions.commandSchema, inputs.command), { depth: null });
-        throw e;
-      }
-    } else if (inputs.command) {
-      command = inputs.command;
-    }
+    const command = getCommand(inputs, pluginOptions);
     const context2 = {
       eventName: inputs.eventName,
       payload: inputs.eventPayload,
@@ -560,12 +577,7 @@ function createPlugin(handler, manifest, options) {
       const result = await handler(context2);
       return ctx.json({ stateId: inputs.stateId, output: result ?? {} });
     } catch (error) {
-      console.error(error);
-      const loggerError = transformError(context2, error);
-      if (pluginOptions.postCommentOnError && loggerError) {
-        await context2.commentHandler.postComment(context2, loggerError);
-      }
-      throw new HTTPException(500, { message: "Unexpected error" });
+      await handleError2(context2, pluginOptions, error);
     }
   });
   return app;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubiquity-os/plugin-sdk",
-  "version": "3.1.10",
+  "version": "3.2.0",
   "description": "SDK for plugin support.",
   "author": "Ubiquity DAO",
   "license": "MIT",
@@ -27,6 +27,9 @@
       ],
       "helpers": [
         "dist/helpers.d.ts"
+      ],
+      "compression": [
+        "dist/compression.d.ts"
       ]
     }
   },
@@ -60,6 +63,11 @@
       "types": "./dist/helpers.d.ts",
       "import": "./dist/helpers.mjs",
       "require": "./dist/helpers.js"
+    },
+    "./compression": {
+      "types": "./dist/compression.d.ts",
+      "import": "./dist/compression.mjs",
+      "require": "./dist/compression.js"
     }
   },
   "files": [
@@ -95,6 +103,7 @@
     "@octokit/types": "^13.8.0",
     "@octokit/webhooks": "^13.7.4",
     "@ubiquity-os/ubiquity-os-logger": "^1.4.0",
+    "brotli": "^1.3.3",
     "dotenv": "^16.4.5",
     "hono": "^4.6.9"
   },
@@ -110,7 +119,9 @@
     "@eslint/js": "^9.14.0",
     "@jest/globals": "^29.7.0",
     "@mswjs/data": "0.16.1",
+    "@types/brotli": "^1.3.4",
     "@types/node": "^20.11.19",
+    "@ubiquity-os/eslint-plugin-no-empty-strings": "^1.0.3",
     "cross-env": "^7.0.3",
     "cspell": "^8.4.0",
     "eslint": "^9.14.0",