@ubiquity-os/plugin-sdk 3.0.0 → 3.1.1

package/dist/index.js

@@ -38,7 +38,7 @@ module.exports = __toCommonJS(src_exports);
 
 // src/server.ts
 var import_value2 = require("@sinclair/typebox/value");
-var import_ubiquity_os_logger2 = require("@ubiquity-os/ubiquity-os-logger");
+var import_ubiquity_os_logger3 = 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");
@@ -255,6 +255,31 @@ ${metadataContent}
   }
 };
 
+// src/error.ts
+var import_ubiquity_os_logger2 = require("@ubiquity-os/ubiquity-os-logger");
+function transformError(context2, error) {
+  let loggerError;
+  if (error instanceof AggregateError) {
+    loggerError = context2.logger.error(
+      error.errors.map((err) => {
+        if (err instanceof import_ubiquity_os_logger2.LogReturn) {
+          return err.logMessage.raw;
+        } else if (err instanceof Error) {
+          return err.message;
+        } else {
+          return err;
+        }
+      }).join("\n\n"),
+      { error }
+    );
+  } else if (error instanceof Error || error instanceof import_ubiquity_os_logger2.LogReturn) {
+    loggerError = error;
+  } else {
+    loggerError = context2.logger.error(String(error));
+  }
+  return loggerError;
+}
+
 // src/octokit.ts
 var import_core = require("@octokit/core");
 var import_plugin_paginate_rest = require("@octokit/plugin-paginate-rest");
@@ -409,7 +434,7 @@ function createPlugin(handler, manifest, options) {
       octokit: new customOctokit({ auth: inputs.authToken }),
       config: config2,
       env,
-      logger: new import_ubiquity_os_logger2.Logs(pluginOptions.logLevel),
+      logger: new import_ubiquity_os_logger3.Logs(pluginOptions.logLevel),
       commentHandler: new CommentHandler()
     };
     try {
@@ -417,12 +442,7 @@ function createPlugin(handler, manifest, options) {
       return ctx.json({ stateId: inputs.stateId, output: result ?? {} });
     } catch (error) {
       console.error(error);
-      let loggerError;
-      if (error instanceof Error || error instanceof import_ubiquity_os_logger2.LogReturn) {
-        loggerError = error;
-      } else {
-        loggerError = context2.logger.error(`Error: ${error}`);
-      }
+      const loggerError = transformError(context2, error);
       if (pluginOptions.postCommentOnError && loggerError) {
         await context2.commentHandler.postComment(context2, loggerError);
       }
@@ -436,7 +456,7 @@ function createPlugin(handler, manifest, options) {
 var core = __toESM(require("@actions/core"));
 var github2 = __toESM(require("@actions/github"));
 var import_value3 = require("@sinclair/typebox/value");
-var import_ubiquity_os_logger3 = require("@ubiquity-os/ubiquity-os-logger");
+var import_ubiquity_os_logger4 = require("@ubiquity-os/ubiquity-os-logger");
 var import_dotenv = require("dotenv");
 (0, import_dotenv.config)();
 async function createActionsPlugin(handler, options) {
@@ -501,7 +521,7 @@ async function createActionsPlugin(handler, options) {
     octokit: new customOctokit({ auth: inputs.authToken }),
     config: config2,
     env,
-    logger: new import_ubiquity_os_logger3.Logs(pluginOptions.logLevel),
+    logger: new import_ubiquity_os_logger4.Logs(pluginOptions.logLevel),
     commentHandler: new CommentHandler()
   };
   try {
@@ -510,16 +530,11 @@ async function createActionsPlugin(handler, options) {
     await returnDataToKernel(pluginGithubToken, inputs.stateId, result);
   } catch (error) {
     console.error(error);
-    let loggerError;
-    if (error instanceof Error) {
-      core.setFailed(error);
-      loggerError = context2.logger.error(`Error: ${error}`, { error });
-    } else if (error instanceof import_ubiquity_os_logger3.LogReturn) {
-      core.setFailed(error.logMessage.raw);
-      loggerError = error;
-    } else {
-      core.setFailed(`Error: ${error}`);
-      loggerError = context2.logger.error(`Error: ${error}`);
+    const loggerError = transformError(context2, error);
+    if (loggerError instanceof import_ubiquity_os_logger4.LogReturn) {
+      core.setFailed(loggerError.logMessage.diff);
+    } else if (loggerError instanceof Error) {
+      core.setFailed(loggerError);
     }
     if (pluginOptions.postCommentOnError && loggerError) {
       await context2.commentHandler.postComment(context2, loggerError);

package/dist/index.mjs

@@ -1,6 +1,6 @@
 // src/server.ts
 import { Value as Value2 } from "@sinclair/typebox/value";
-import { LogReturn as LogReturn2, Logs } from "@ubiquity-os/ubiquity-os-logger";
+import { Logs } from "@ubiquity-os/ubiquity-os-logger";
 import { Hono } from "hono";
 import { env as honoEnv } from "hono/adapter";
 import { HTTPException } from "hono/http-exception";
@@ -217,6 +217,31 @@ ${metadataContent}
   }
 };
 
+// src/error.ts
+import { LogReturn as LogReturn2 } from "@ubiquity-os/ubiquity-os-logger";
+function transformError(context2, error) {
+  let loggerError;
+  if (error instanceof AggregateError) {
+    loggerError = context2.logger.error(
+      error.errors.map((err) => {
+        if (err instanceof LogReturn2) {
+          return err.logMessage.raw;
+        } else if (err instanceof Error) {
+          return err.message;
+        } else {
+          return err;
+        }
+      }).join("\n\n"),
+      { error }
+    );
+  } else if (error instanceof Error || error instanceof LogReturn2) {
+    loggerError = error;
+  } else {
+    loggerError = context2.logger.error(String(error));
+  }
+  return loggerError;
+}
+
 // src/octokit.ts
 import { Octokit } from "@octokit/core";
 import { paginateRest } from "@octokit/plugin-paginate-rest";
@@ -379,12 +404,7 @@ function createPlugin(handler, manifest, options) {
       return ctx.json({ stateId: inputs.stateId, output: result ?? {} });
     } catch (error) {
       console.error(error);
-      let loggerError;
-      if (error instanceof Error || error instanceof LogReturn2) {
-        loggerError = error;
-      } else {
-        loggerError = context2.logger.error(`Error: ${error}`);
-      }
+      const loggerError = transformError(context2, error);
       if (pluginOptions.postCommentOnError && loggerError) {
         await context2.commentHandler.postComment(context2, loggerError);
       }
@@ -472,16 +492,11 @@ async function createActionsPlugin(handler, options) {
     await returnDataToKernel(pluginGithubToken, inputs.stateId, result);
   } catch (error) {
     console.error(error);
-    let loggerError;
-    if (error instanceof Error) {
-      core.setFailed(error);
-      loggerError = context2.logger.error(`Error: ${error}`, { error });
-    } else if (error instanceof LogReturn3) {
-      core.setFailed(error.logMessage.raw);
-      loggerError = error;
-    } else {
-      core.setFailed(`Error: ${error}`);
-      loggerError = context2.logger.error(`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);

package/dist/manifest.d.mts

@@ -2,10 +2,26 @@ import * as _sinclair_typebox from '@sinclair/typebox';
 import { Static } from '@sinclair/typebox';
 
 declare const runEvent: _sinclair_typebox.TUnion<_sinclair_typebox.TLiteral<"branch_protection_configuration" | "branch_protection_configuration.disabled" | "branch_protection_configuration.enabled" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "custom_property" | "custom_property.created" | "custom_property.deleted" | "custom_property.updated" | "custom_property_values" | "custom_property_values.updated" | "delete" | "dependabot_alert" | "dependabot_alert.auto_dismissed" | "dependabot_alert.auto_reopened" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.closed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.reopened" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "merge_group.destroyed" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "personal_access_token_request" | "personal_access_token_request.approved" | "personal_access_token_request.cancelled" | "personal_access_token_request.created" | "personal_access_token_request.denied" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2" | "projects_v2.closed" | "projects_v2.created" | "projects_v2.deleted" | "projects_v2.edited" | "projects_v2.reopened" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "projects_v2_status_update" | "projects_v2_status_update.created" | "projects_v2_status_update.deleted" | "projects_v2_status_update.edited" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_advisory" | "repository_advisory.published" | "repository_advisory.reported" | "repository_dispatch" | "repository_dispatch.sample.collected" | "repository_import" | "repository_ruleset" | "repository_ruleset.created" | "repository_ruleset.deleted" | "repository_ruleset.edited" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.validated" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "security_and_analysis" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "status" | "sub_issues" | "sub_issues.parent_issue_added" | "sub_issues.parent_issue_removed" | "sub_issues.sub_issue_added" | "sub_issues.sub_issue_removed" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">[]>;
+declare const exampleCommandExecutionSchema: _sinclair_typebox.TObject<{
+    commandInvocation: _sinclair_typebox.TString;
+    githubContext: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+    expectedToolCallResult: _sinclair_typebox.TObject<{
+        function: _sinclair_typebox.TString;
+        parameters: _sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>;
+    }>;
+}>;
 declare const commandSchema: _sinclair_typebox.TObject<{
     description: _sinclair_typebox.TString;
     "ubiquity:example": _sinclair_typebox.TString;
     parameters: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+    examples: _sinclair_typebox.TOptional<_sinclair_typebox.TArray<_sinclair_typebox.TObject<{
+        commandInvocation: _sinclair_typebox.TString;
+        githubContext: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+        expectedToolCallResult: _sinclair_typebox.TObject<{
+            function: _sinclair_typebox.TString;
+            parameters: _sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>;
+        }>;
+    }>>>;
 }>;
 declare const manifestSchema: _sinclair_typebox.TObject<{
     name: _sinclair_typebox.TString;
@@ -14,6 +30,14 @@ declare const manifestSchema: _sinclair_typebox.TObject<{
         description: _sinclair_typebox.TString;
         "ubiquity:example": _sinclair_typebox.TString;
         parameters: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+        examples: _sinclair_typebox.TOptional<_sinclair_typebox.TArray<_sinclair_typebox.TObject<{
+            commandInvocation: _sinclair_typebox.TString;
+            githubContext: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+            expectedToolCallResult: _sinclair_typebox.TObject<{
+                function: _sinclair_typebox.TString;
+                parameters: _sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>;
+            }>;
+        }>>>;
     }>>>;
     "ubiquity:listeners": _sinclair_typebox.TOptional<_sinclair_typebox.TArray<_sinclair_typebox.TUnion<_sinclair_typebox.TLiteral<"branch_protection_configuration" | "branch_protection_configuration.disabled" | "branch_protection_configuration.enabled" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "custom_property" | "custom_property.created" | "custom_property.deleted" | "custom_property.updated" | "custom_property_values" | "custom_property_values.updated" | "delete" | "dependabot_alert" | "dependabot_alert.auto_dismissed" | "dependabot_alert.auto_reopened" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.closed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.reopened" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "merge_group.destroyed" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "personal_access_token_request" | "personal_access_token_request.approved" | "personal_access_token_request.cancelled" | "personal_access_token_request.created" | "personal_access_token_request.denied" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2" | "projects_v2.closed" | "projects_v2.created" | "projects_v2.deleted" | "projects_v2.edited" | "projects_v2.reopened" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "projects_v2_status_update" | "projects_v2_status_update.created" | "projects_v2_status_update.deleted" | "projects_v2_status_update.edited" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_advisory" | "repository_advisory.published" | "repository_advisory.reported" | "repository_dispatch" | "repository_dispatch.sample.collected" | "repository_import" | "repository_ruleset" | "repository_ruleset.created" | "repository_ruleset.deleted" | "repository_ruleset.edited" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.validated" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "security_and_analysis" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "status" | "sub_issues" | "sub_issues.parent_issue_added" | "sub_issues.parent_issue_removed" | "sub_issues.sub_issue_added" | "sub_issues.sub_issue_removed" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">[]>>>;
     configuration: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
@@ -21,4 +45,4 @@ declare const manifestSchema: _sinclair_typebox.TObject<{
 }>;
 type Manifest = Static<typeof manifestSchema>;
 
-export { type Manifest, commandSchema, manifestSchema, runEvent };
+export { type Manifest, commandSchema, exampleCommandExecutionSchema, manifestSchema, runEvent };

package/dist/manifest.d.ts

@@ -2,10 +2,26 @@ import * as _sinclair_typebox from '@sinclair/typebox';
 import { Static } from '@sinclair/typebox';
 
 declare const runEvent: _sinclair_typebox.TUnion<_sinclair_typebox.TLiteral<"branch_protection_configuration" | "branch_protection_configuration.disabled" | "branch_protection_configuration.enabled" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "custom_property" | "custom_property.created" | "custom_property.deleted" | "custom_property.updated" | "custom_property_values" | "custom_property_values.updated" | "delete" | "dependabot_alert" | "dependabot_alert.auto_dismissed" | "dependabot_alert.auto_reopened" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.closed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.reopened" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "merge_group.destroyed" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "personal_access_token_request" | "personal_access_token_request.approved" | "personal_access_token_request.cancelled" | "personal_access_token_request.created" | "personal_access_token_request.denied" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2" | "projects_v2.closed" | "projects_v2.created" | "projects_v2.deleted" | "projects_v2.edited" | "projects_v2.reopened" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "projects_v2_status_update" | "projects_v2_status_update.created" | "projects_v2_status_update.deleted" | "projects_v2_status_update.edited" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_advisory" | "repository_advisory.published" | "repository_advisory.reported" | "repository_dispatch" | "repository_dispatch.sample.collected" | "repository_import" | "repository_ruleset" | "repository_ruleset.created" | "repository_ruleset.deleted" | "repository_ruleset.edited" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.validated" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "security_and_analysis" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "status" | "sub_issues" | "sub_issues.parent_issue_added" | "sub_issues.parent_issue_removed" | "sub_issues.sub_issue_added" | "sub_issues.sub_issue_removed" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">[]>;
+declare const exampleCommandExecutionSchema: _sinclair_typebox.TObject<{
+    commandInvocation: _sinclair_typebox.TString;
+    githubContext: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+    expectedToolCallResult: _sinclair_typebox.TObject<{
+        function: _sinclair_typebox.TString;
+        parameters: _sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>;
+    }>;
+}>;
 declare const commandSchema: _sinclair_typebox.TObject<{
     description: _sinclair_typebox.TString;
     "ubiquity:example": _sinclair_typebox.TString;
     parameters: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+    examples: _sinclair_typebox.TOptional<_sinclair_typebox.TArray<_sinclair_typebox.TObject<{
+        commandInvocation: _sinclair_typebox.TString;
+        githubContext: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+        expectedToolCallResult: _sinclair_typebox.TObject<{
+            function: _sinclair_typebox.TString;
+            parameters: _sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>;
+        }>;
+    }>>>;
 }>;
 declare const manifestSchema: _sinclair_typebox.TObject<{
     name: _sinclair_typebox.TString;
@@ -14,6 +30,14 @@ declare const manifestSchema: _sinclair_typebox.TObject<{
         description: _sinclair_typebox.TString;
         "ubiquity:example": _sinclair_typebox.TString;
         parameters: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+        examples: _sinclair_typebox.TOptional<_sinclair_typebox.TArray<_sinclair_typebox.TObject<{
+            commandInvocation: _sinclair_typebox.TString;
+            githubContext: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
+            expectedToolCallResult: _sinclair_typebox.TObject<{
+                function: _sinclair_typebox.TString;
+                parameters: _sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>;
+            }>;
+        }>>>;
     }>>>;
     "ubiquity:listeners": _sinclair_typebox.TOptional<_sinclair_typebox.TArray<_sinclair_typebox.TUnion<_sinclair_typebox.TLiteral<"branch_protection_configuration" | "branch_protection_configuration.disabled" | "branch_protection_configuration.enabled" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "custom_property" | "custom_property.created" | "custom_property.deleted" | "custom_property.updated" | "custom_property_values" | "custom_property_values.updated" | "delete" | "dependabot_alert" | "dependabot_alert.auto_dismissed" | "dependabot_alert.auto_reopened" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.closed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.reopened" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "merge_group.destroyed" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "personal_access_token_request" | "personal_access_token_request.approved" | "personal_access_token_request.cancelled" | "personal_access_token_request.created" | "personal_access_token_request.denied" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2" | "projects_v2.closed" | "projects_v2.created" | "projects_v2.deleted" | "projects_v2.edited" | "projects_v2.reopened" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "projects_v2_status_update" | "projects_v2_status_update.created" | "projects_v2_status_update.deleted" | "projects_v2_status_update.edited" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_advisory" | "repository_advisory.published" | "repository_advisory.reported" | "repository_dispatch" | "repository_dispatch.sample.collected" | "repository_import" | "repository_ruleset" | "repository_ruleset.created" | "repository_ruleset.deleted" | "repository_ruleset.edited" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.validated" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "security_and_analysis" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "status" | "sub_issues" | "sub_issues.parent_issue_added" | "sub_issues.parent_issue_removed" | "sub_issues.sub_issue_added" | "sub_issues.sub_issue_removed" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">[]>>>;
     configuration: _sinclair_typebox.TOptional<_sinclair_typebox.TRecord<_sinclair_typebox.TString, _sinclair_typebox.TAny>>;
@@ -21,4 +45,4 @@ declare const manifestSchema: _sinclair_typebox.TObject<{
 }>;
 type Manifest = Static<typeof manifestSchema>;
 
-export { type Manifest, commandSchema, manifestSchema, runEvent };
+export { type Manifest, commandSchema, exampleCommandExecutionSchema, manifestSchema, runEvent };

package/dist/manifest.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var manifest_exports = {};
 __export(manifest_exports, {
   commandSchema: () => commandSchema,
+  exampleCommandExecutionSchema: () => exampleCommandExecutionSchema,
   manifestSchema: () => manifestSchema,
   runEvent: () => runEvent
 });
@@ -28,10 +29,19 @@ module.exports = __toCommonJS(manifest_exports);
 var import_typebox = require("@sinclair/typebox");
 var import_webhooks = require("@octokit/webhooks");
 var runEvent = import_typebox.Type.Union(import_webhooks.emitterEventNames.map((o) => import_typebox.Type.Literal(o)));
+var exampleCommandExecutionSchema = import_typebox.Type.Object({
+  commandInvocation: import_typebox.Type.String({ minLength: 1 }),
+  githubContext: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())),
+  expectedToolCallResult: import_typebox.Type.Object({
+    function: import_typebox.Type.String({ minLength: 1 }),
+    parameters: import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())
+  })
+});
 var commandSchema = import_typebox.Type.Object({
   description: import_typebox.Type.String({ minLength: 1 }),
   "ubiquity:example": import_typebox.Type.String({ minLength: 1 }),
-  parameters: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any()))
+  parameters: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any())),
+  examples: import_typebox.Type.Optional(import_typebox.Type.Array(exampleCommandExecutionSchema, { default: [] }))
 });
 var manifestSchema = import_typebox.Type.Object({
   name: import_typebox.Type.String({ minLength: 1 }),
@@ -44,6 +54,7 @@ var manifestSchema = import_typebox.Type.Object({
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   commandSchema,
+  exampleCommandExecutionSchema,
   manifestSchema,
   runEvent
 });

package/dist/manifest.mjs

@@ -2,10 +2,19 @@
 import { Type as T } from "@sinclair/typebox";
 import { emitterEventNames } from "@octokit/webhooks";
 var runEvent = T.Union(emitterEventNames.map((o) => T.Literal(o)));
+var exampleCommandExecutionSchema = T.Object({
+  commandInvocation: T.String({ minLength: 1 }),
+  githubContext: T.Optional(T.Record(T.String(), T.Any())),
+  expectedToolCallResult: T.Object({
+    function: T.String({ minLength: 1 }),
+    parameters: T.Record(T.String(), T.Any())
+  })
+});
 var commandSchema = T.Object({
   description: T.String({ minLength: 1 }),
   "ubiquity:example": T.String({ minLength: 1 }),
-  parameters: T.Optional(T.Record(T.String(), T.Any()))
+  parameters: T.Optional(T.Record(T.String(), T.Any())),
+  examples: T.Optional(T.Array(exampleCommandExecutionSchema, { default: [] }))
 });
 var manifestSchema = T.Object({
   name: T.String({ minLength: 1 }),
@@ -17,6 +26,7 @@ var manifestSchema = T.Object({
 });
 export {
   commandSchema,
+  exampleCommandExecutionSchema,
   manifestSchema,
   runEvent
 };

package/dist/signature.d.mts

@@ -1,3 +1,34 @@
+import { EmitterWebhookEventName, EmitterWebhookEvent } from '@octokit/webhooks';
+import * as _sinclair_typebox from '@sinclair/typebox';
+import { StaticDecode } from '@sinclair/typebox';
+
+declare const commandCallSchema: _sinclair_typebox.TUnion<[_sinclair_typebox.TNull, _sinclair_typebox.TObject<{
+    name: _sinclair_typebox.TString;
+    parameters: _sinclair_typebox.TUnknown;
+}>]>;
+type CommandCall = StaticDecode<typeof commandCallSchema>;
+
+declare class PluginInput<T extends EmitterWebhookEventName = EmitterWebhookEventName> {
+    private _privateKey;
+    stateId: string;
+    eventName: T;
+    eventPayload: EmitterWebhookEvent<T>["payload"];
+    settings: unknown;
+    authToken: string;
+    ref: string;
+    command: CommandCall;
+    constructor(privateKey: string, stateId: string, eventName: T, eventPayload: EmitterWebhookEvent<T>["payload"], settings: unknown, authToken: string, ref: string, command: CommandCall);
+    getInputs(): Promise<{
+        signature: string;
+        stateId: string;
+        eventName: T;
+        eventPayload: string;
+        settings: string;
+        authToken: string;
+        ref: string;
+        command: string;
+    }>;
+}
 interface Inputs {
     stateId: unknown;
     eventName: unknown;
@@ -10,4 +41,4 @@ interface Inputs {
 declare function verifySignature(publicKeyPem: string, inputs: Inputs, signature: string): Promise<boolean>;
 declare function signPayload(payload: string, privateKey: string): Promise<string>;
 
-export { signPayload, verifySignature };
+export { PluginInput, signPayload, verifySignature };

package/dist/signature.d.ts

@@ -1,3 +1,34 @@
+import { EmitterWebhookEventName, EmitterWebhookEvent } from '@octokit/webhooks';
+import * as _sinclair_typebox from '@sinclair/typebox';
+import { StaticDecode } from '@sinclair/typebox';
+
+declare const commandCallSchema: _sinclair_typebox.TUnion<[_sinclair_typebox.TNull, _sinclair_typebox.TObject<{
+    name: _sinclair_typebox.TString;
+    parameters: _sinclair_typebox.TUnknown;
+}>]>;
+type CommandCall = StaticDecode<typeof commandCallSchema>;
+
+declare class PluginInput<T extends EmitterWebhookEventName = EmitterWebhookEventName> {
+    private _privateKey;
+    stateId: string;
+    eventName: T;
+    eventPayload: EmitterWebhookEvent<T>["payload"];
+    settings: unknown;
+    authToken: string;
+    ref: string;
+    command: CommandCall;
+    constructor(privateKey: string, stateId: string, eventName: T, eventPayload: EmitterWebhookEvent<T>["payload"], settings: unknown, authToken: string, ref: string, command: CommandCall);
+    getInputs(): Promise<{
+        signature: string;
+        stateId: string;
+        eventName: T;
+        eventPayload: string;
+        settings: string;
+        authToken: string;
+        ref: string;
+        command: string;
+    }>;
+}
 interface Inputs {
     stateId: unknown;
     eventName: unknown;
@@ -10,4 +41,4 @@ interface Inputs {
 declare function verifySignature(publicKeyPem: string, inputs: Inputs, signature: string): Promise<boolean>;
 declare function signPayload(payload: string, privateKey: string): Promise<string>;
 
-export { signPayload, verifySignature };
+export { PluginInput, signPayload, verifySignature };

package/dist/signature.js

@@ -20,10 +20,47 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/signature.ts
 var signature_exports = {};
 __export(signature_exports, {
+  PluginInput: () => PluginInput,
   signPayload: () => signPayload,
   verifySignature: () => verifySignature
 });
 module.exports = __toCommonJS(signature_exports);
+var PluginInput = class {
+  _privateKey;
+  stateId;
+  eventName;
+  eventPayload;
+  settings;
+  authToken;
+  ref;
+  command;
+  constructor(privateKey, stateId, eventName, eventPayload, settings, authToken, ref, command) {
+    this._privateKey = privateKey;
+    this.stateId = stateId;
+    this.eventName = eventName;
+    this.eventPayload = eventPayload;
+    this.settings = settings;
+    this.authToken = authToken;
+    this.ref = ref;
+    this.command = command;
+  }
+  async getInputs() {
+    const inputs = {
+      stateId: this.stateId,
+      eventName: this.eventName,
+      eventPayload: JSON.stringify(this.eventPayload),
+      settings: JSON.stringify(this.settings),
+      authToken: this.authToken,
+      ref: this.ref,
+      command: JSON.stringify(this.command)
+    };
+    const signature = await signPayload(JSON.stringify(inputs), this._privateKey);
+    return {
+      ...inputs,
+      signature
+    };
+  }
+};
 async function verifySignature(publicKeyPem, inputs, signature) {
   try {
     const inputsOrdered = {
@@ -77,6 +114,7 @@ async function signPayload(payload, privateKey) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  PluginInput,
   signPayload,
   verifySignature
 });

package/dist/signature.mjs

@@ -1,4 +1,40 @@
 // src/signature.ts
+var PluginInput = class {
+  _privateKey;
+  stateId;
+  eventName;
+  eventPayload;
+  settings;
+  authToken;
+  ref;
+  command;
+  constructor(privateKey, stateId, eventName, eventPayload, settings, authToken, ref, command) {
+    this._privateKey = privateKey;
+    this.stateId = stateId;
+    this.eventName = eventName;
+    this.eventPayload = eventPayload;
+    this.settings = settings;
+    this.authToken = authToken;
+    this.ref = ref;
+    this.command = command;
+  }
+  async getInputs() {
+    const inputs = {
+      stateId: this.stateId,
+      eventName: this.eventName,
+      eventPayload: JSON.stringify(this.eventPayload),
+      settings: JSON.stringify(this.settings),
+      authToken: this.authToken,
+      ref: this.ref,
+      command: JSON.stringify(this.command)
+    };
+    const signature = await signPayload(JSON.stringify(inputs), this._privateKey);
+    return {
+      ...inputs,
+      signature
+    };
+  }
+};
 async function verifySignature(publicKeyPem, inputs, signature) {
   try {
     const inputsOrdered = {
@@ -51,6 +87,7 @@ async function signPayload(payload, privateKey) {
   return btoa(String.fromCharCode(...new Uint8Array(signature)));
 }
 export {
+  PluginInput,
   signPayload,
   verifySignature
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubiquity-os/plugin-sdk",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "description": "SDK for plugin support.",
   "author": "Ubiquity DAO",
   "license": "MIT",