@ubiquity-os/plugin-sdk 1.0.10 → 1.1.0

package/dist/octokit.js

@@ -0,0 +1,54 @@
+"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/octokit.ts
+var octokit_exports = {};
+__export(octokit_exports, {
+  customOctokit: () => customOctokit
+});
+module.exports = __toCommonJS(octokit_exports);
+var import_core = require("@octokit/core");
+var import_plugin_paginate_rest = require("@octokit/plugin-paginate-rest");
+var import_plugin_rest_endpoint_methods = require("@octokit/plugin-rest-endpoint-methods");
+var import_plugin_retry = require("@octokit/plugin-retry");
+var import_plugin_throttling = require("@octokit/plugin-throttling");
+var import_plugin_paginate_graphql = require("@octokit/plugin-paginate-graphql");
+var defaultOptions = {
+  throttle: {
+    onAbuseLimit: (retryAfter, options, octokit) => {
+      octokit.log.warn(`Abuse limit hit with "${options.method} ${options.url}", retrying in ${retryAfter} seconds.`);
+      return true;
+    },
+    onRateLimit: (retryAfter, options, octokit) => {
+      octokit.log.warn(`Rate limit hit with "${options.method} ${options.url}", retrying in ${retryAfter} seconds.`);
+      return true;
+    },
+    onSecondaryRateLimit: (retryAfter, options, octokit) => {
+      octokit.log.warn(`Secondary rate limit hit with "${options.method} ${options.url}", retrying in ${retryAfter} seconds.`);
+      return true;
+    }
+  }
+};
+var customOctokit = import_core.Octokit.plugin(import_plugin_throttling.throttling, import_plugin_retry.retry, import_plugin_paginate_rest.paginateRest, import_plugin_rest_endpoint_methods.restEndpointMethods, import_plugin_paginate_graphql.paginateGraphQL).defaults((instanceOptions) => {
+  return { ...defaultOptions, ...instanceOptions };
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  customOctokit
+});

package/dist/octokit.mjs

@@ -0,0 +1,29 @@
+// src/octokit.ts
+import { Octokit } from "@octokit/core";
+import { paginateRest } from "@octokit/plugin-paginate-rest";
+import { restEndpointMethods } from "@octokit/plugin-rest-endpoint-methods";
+import { retry } from "@octokit/plugin-retry";
+import { throttling } from "@octokit/plugin-throttling";
+import { paginateGraphQL } from "@octokit/plugin-paginate-graphql";
+var defaultOptions = {
+  throttle: {
+    onAbuseLimit: (retryAfter, options, octokit) => {
+      octokit.log.warn(`Abuse limit hit with "${options.method} ${options.url}", retrying in ${retryAfter} seconds.`);
+      return true;
+    },
+    onRateLimit: (retryAfter, options, octokit) => {
+      octokit.log.warn(`Rate limit hit with "${options.method} ${options.url}", retrying in ${retryAfter} seconds.`);
+      return true;
+    },
+    onSecondaryRateLimit: (retryAfter, options, octokit) => {
+      octokit.log.warn(`Secondary rate limit hit with "${options.method} ${options.url}", retrying in ${retryAfter} seconds.`);
+      return true;
+    }
+  }
+};
+var customOctokit = Octokit.plugin(throttling, retry, paginateRest, restEndpointMethods, paginateGraphQL).defaults((instanceOptions) => {
+  return { ...defaultOptions, ...instanceOptions };
+});
+export {
+  customOctokit
+};

package/dist/{signature.d.cts → signature.d.mts}

@@ -5,6 +5,7 @@ interface Inputs {
     authToken: unknown;
     settings: unknown;
     ref: unknown;
+    command: unknown;
 }
 declare function verifySignature(publicKeyPem: string, inputs: Inputs, signature: string): Promise<boolean>;
 declare function signPayload(payload: string, privateKey: string): Promise<string>;

package/dist/signature.d.ts

@@ -5,6 +5,7 @@ interface Inputs {
     authToken: unknown;
     settings: unknown;
     ref: unknown;
+    command: unknown;
 }
 declare function verifySignature(publicKeyPem: string, inputs: Inputs, signature: string): Promise<boolean>;
 declare function signPayload(payload: string, privateKey: string): Promise<string>;

package/dist/signature.js

@@ -1,4 +1,29 @@
+"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/signature.ts
+var signature_exports = {};
+__export(signature_exports, {
+  signPayload: () => signPayload,
+  verifySignature: () => verifySignature
+});
+module.exports = __toCommonJS(signature_exports);
 async function verifySignature(publicKeyPem, inputs, signature) {
   try {
     const inputsOrdered = {
@@ -7,7 +32,8 @@ async function verifySignature(publicKeyPem, inputs, signature) {
       eventPayload: inputs.eventPayload,
       settings: inputs.settings,
       authToken: inputs.authToken,
-      ref: inputs.ref
+      ref: inputs.ref,
+      command: inputs.command
     };
     const pemContents = publicKeyPem.replace("-----BEGIN PUBLIC KEY-----", "").replace("-----END PUBLIC KEY-----", "").trim();
     const binaryDer = Uint8Array.from(atob(pemContents), (c) => c.charCodeAt(0));
@@ -49,7 +75,8 @@ async function signPayload(payload, privateKey) {
   const signature = await crypto.subtle.sign("RSASSA-PKCS1-v1_5", _privateKey, data);
   return btoa(String.fromCharCode(...new Uint8Array(signature)));
 }
-export {
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
   signPayload,
   verifySignature
-};
+});

package/dist/{signature.cjs → signature.mjs}

@@ -1,29 +1,4 @@
-"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/signature.ts
-var signature_exports = {};
-__export(signature_exports, {
-  signPayload: () => signPayload,
-  verifySignature: () => verifySignature
-});
-module.exports = __toCommonJS(signature_exports);
 async function verifySignature(publicKeyPem, inputs, signature) {
   try {
     const inputsOrdered = {
@@ -32,7 +7,8 @@ async function verifySignature(publicKeyPem, inputs, signature) {
       eventPayload: inputs.eventPayload,
       settings: inputs.settings,
       authToken: inputs.authToken,
-      ref: inputs.ref
+      ref: inputs.ref,
+      command: inputs.command
     };
     const pemContents = publicKeyPem.replace("-----BEGIN PUBLIC KEY-----", "").replace("-----END PUBLIC KEY-----", "").trim();
     const binaryDer = Uint8Array.from(atob(pemContents), (c) => c.charCodeAt(0));
@@ -74,8 +50,7 @@ async function signPayload(payload, privateKey) {
   const signature = await crypto.subtle.sign("RSASSA-PKCS1-v1_5", _privateKey, data);
   return btoa(String.fromCharCode(...new Uint8Array(signature)));
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   signPayload,
   verifySignature
-});
+};

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@ubiquity-os/plugin-sdk",
-  "version": "1.0.10",
+  "version": "1.1.0",
   "description": "SDK for plugin support.",
   "author": "Ubiquity DAO",
   "license": "MIT",
   "engines": {
     "node": ">=20.10.0"
   },
-  "type": "module",
   "module": "dist/index.mjs",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -22,6 +21,9 @@
       ],
       "signature": [
         "dist/signature.d.ts"
+      ],
+      "octokit": [
+        "dist/octokit.d.ts"
       ]
     }
   },
@@ -45,6 +47,11 @@
       "types": "./dist/signature.d.ts",
       "import": "./dist/signature.mjs",
       "require": "./dist/signature.js"
+    },
+    "./octokit": {
+      "types": "./dist/octokit.d.ts",
+      "import": "./dist/octokit.mjs",
+      "require": "./dist/octokit.js"
     }
   },
   "files": [
@@ -80,11 +87,13 @@
     "@octokit/rest": "^21.0.2",
     "@octokit/types": "^13.6.1",
     "@octokit/webhooks": "^13.3.0",
-    "@sinclair/typebox": "^0.33.21",
     "@ubiquity-os/ubiquity-os-logger": "^1.3.2",
     "dotenv": "^16.4.5",
     "hono": "^4.6.9"
   },
+  "peerDependencies": {
+    "@sinclair/typebox": "0.34.3"
+  },
   "devDependencies": {
     "@commitlint/cli": "^18.6.1",
     "@commitlint/config-conventional": "^18.6.2",

package/dist/constants.cjs

@@ -1,58 +0,0 @@
-"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/constants.ts
-var constants_exports = {};
-__export(constants_exports, {
-  BOT_USER_ID: () => BOT_USER_ID,
-  CONFIG_FULL_PATH: () => CONFIG_FULL_PATH,
-  CONFIG_ORG_REPO: () => CONFIG_ORG_REPO,
-  DEV_CONFIG_FULL_PATH: () => DEV_CONFIG_FULL_PATH,
-  KERNEL_APP_ID: () => KERNEL_APP_ID,
-  KERNEL_PUBLIC_KEY: () => KERNEL_PUBLIC_KEY
-});
-module.exports = __toCommonJS(constants_exports);
-
-// src/types/config.ts
-var CONFIG_FULL_PATH = ".github/.ubiquity-os.config.yml";
-var DEV_CONFIG_FULL_PATH = ".github/.ubiquity-os.config.dev.yml";
-var CONFIG_ORG_REPO = ".ubiquity-os";
-
-// src/constants.ts
-var KERNEL_PUBLIC_KEY = `-----BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs96DOU+JqM8SyNXOB6u3
-uBKIFiyrcST/LZTYN6y7LeJlyCuGPqSDrWCfjU9Ph5PLf9TWiNmeM8DGaOpwEFC7
-U3NRxOSglo4plnQ5zRwIHHXvxyK400sQP2oISXymISuBQWjEIqkC9DybQrKwNzf+
-I0JHWPqmwMIw26UvVOtXGOOWBqTkk+N2+/9f8eDIJP5QQVwwszc8s1rXOsLMlVIf
-wShw7GO4E2jyK8TSJKpyjV8eb1JJMDwFhPiRrtZfQJUtDf2mV/67shQww61BH2Y/
-Plnalo58kWIbkqZoq1yJrL5sFb73osM5+vADTXVn79bkvea7W19nSkdMiarYt4Hq
-JQIDAQAB
------END PUBLIC KEY-----
-`;
-var KERNEL_APP_ID = 975031;
-var BOT_USER_ID = 178941584;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  BOT_USER_ID,
-  CONFIG_FULL_PATH,
-  CONFIG_ORG_REPO,
-  DEV_CONFIG_FULL_PATH,
-  KERNEL_APP_ID,
-  KERNEL_PUBLIC_KEY
-});

package/dist/index.d.cts

@@ -1,57 +0,0 @@
-import * as hono_types from 'hono/types';
-import { EmitterWebhookEventName, EmitterWebhookEvent } from '@octokit/webhooks';
-import { TAnySchema } from '@sinclair/typebox';
-import { Logs, LogLevel, LogReturn } from '@ubiquity-os/ubiquity-os-logger';
-import { Hono } from 'hono';
-import * as _octokit_core_dist_types_types from '@octokit/core/dist-types/types';
-import * as _octokit_plugin_paginate_graphql from '@octokit/plugin-paginate-graphql';
-import * as _octokit_plugin_rest_endpoint_methods from '@octokit/plugin-rest-endpoint-methods';
-import * as _octokit_plugin_paginate_rest from '@octokit/plugin-paginate-rest';
-import * as _octokit_request_error from '@octokit/request-error';
-import { Octokit } from '@octokit/core';
-import { Manifest } from './manifest.cjs';
-
-declare const customOctokit: typeof Octokit & _octokit_core_dist_types_types.Constructor<{
-    retry: {
-        retryRequest: (error: _octokit_request_error.RequestError, retries: number, retryAfter: number) => _octokit_request_error.RequestError;
-    };
-} & {
-    paginate: _octokit_plugin_paginate_rest.PaginateInterface;
-} & _octokit_plugin_rest_endpoint_methods.Api & _octokit_plugin_paginate_graphql.paginateGraphQLInterface>;
-
-interface Context<TConfig = unknown, TEnv = unknown, TSupportedEvents extends EmitterWebhookEventName = EmitterWebhookEventName> {
-    eventName: TSupportedEvents;
-    payload: {
-        [K in TSupportedEvents]: K extends EmitterWebhookEventName ? EmitterWebhookEvent<K> : never;
-    }[TSupportedEvents]["payload"];
-    octokit: InstanceType<typeof customOctokit>;
-    config: TConfig;
-    env: TEnv;
-    logger: Logs;
-}
-
-interface Options$1 {
-    kernelPublicKey?: string;
-    logLevel?: LogLevel;
-    postCommentOnError?: boolean;
-    settingsSchema?: TAnySchema;
-    envSchema?: TAnySchema;
-    bypassSignatureVerification?: boolean;
-}
-declare function createPlugin<TConfig = unknown, TEnv = unknown, TSupportedEvents extends EmitterWebhookEventName = EmitterWebhookEventName>(handler: (context: Context<TConfig, TEnv, TSupportedEvents>) => Promise<Record<string, unknown> | undefined>, manifest: Manifest, options?: Options$1): Hono<hono_types.BlankEnv, hono_types.BlankSchema, "/">;
-
-interface Options {
-    logLevel?: LogLevel;
-    postCommentOnError?: boolean;
-    settingsSchema?: TAnySchema;
-    envSchema?: TAnySchema;
-    kernelPublicKey?: string;
-}
-declare function createActionsPlugin<TConfig = unknown, TEnv = unknown, TSupportedEvents extends EmitterWebhookEventName = EmitterWebhookEventName>(handler: (context: Context<TConfig, TEnv, TSupportedEvents>) => Promise<Record<string, unknown> | undefined>, options?: Options): Promise<void>;
-
-/**
- * Posts a comment on a GitHub issue if the issue exists in the context payload, embedding structured metadata to it.
- */
-declare function postComment(context: Context, message: LogReturn): Promise<void>;
-
-export { type Context, createActionsPlugin, createPlugin, postComment };

package/dist/manifest.cjs

@@ -1,47 +0,0 @@
-"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/types/manifest.ts
-var manifest_exports = {};
-__export(manifest_exports, {
-  commandSchema: () => commandSchema,
-  manifestSchema: () => manifestSchema,
-  runEvent: () => runEvent
-});
-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 commandSchema = import_typebox.Type.Object({
-  description: import_typebox.Type.String({ minLength: 1 }),
-  "ubiquity:example": import_typebox.Type.String({ minLength: 1 })
-});
-var manifestSchema = import_typebox.Type.Object({
-  name: import_typebox.Type.String({ minLength: 1 }),
-  description: import_typebox.Type.Optional(import_typebox.Type.String({ default: "" })),
-  commands: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), commandSchema, { default: {} })),
-  "ubiquity:listeners": import_typebox.Type.Optional(import_typebox.Type.Array(runEvent, { default: [] })),
-  configuration: import_typebox.Type.Optional(import_typebox.Type.Record(import_typebox.Type.String(), import_typebox.Type.Any(), { default: {} }))
-});
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  commandSchema,
-  manifestSchema,
-  runEvent
-});