@ubiquity-os/plugin-sdk 2.0.2 → 2.0.4

package/dist/index.d.mts

@@ -5,9 +5,9 @@ import { Logs, LogLevel, LogReturn } from '@ubiquity-os/ubiquity-os-logger';
 import { customOctokit } from './octokit.mjs';
 import { Manifest } from './manifest.mjs';
 import { TAnySchema } from '@sinclair/typebox';
+import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
 import '@octokit/core/dist-types/types';
 import '@octokit/plugin-paginate-graphql';
-import '@octokit/plugin-rest-endpoint-methods';
 import '@octokit/plugin-paginate-rest';
 import '@octokit/request-error';
 import '@octokit/core';
@@ -48,8 +48,11 @@ interface CommentOptions {
     raw?: boolean;
     updateComment?: boolean;
 }
+type WithIssueNumber<T> = T & {
+    issueNumber: number;
+};
 type PostComment = {
-    (context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<void>;
+    (context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<WithIssueNumber<RestEndpointMethodTypes["issues"]["updateComment"]["response"]["data"] | RestEndpointMethodTypes["issues"]["createComment"]["response"]["data"]> | null>;
     lastCommentId?: number;
 };
 /**

package/dist/index.d.ts

@@ -5,9 +5,9 @@ import { Logs, LogLevel, LogReturn } from '@ubiquity-os/ubiquity-os-logger';
 import { customOctokit } from './octokit.js';
 import { Manifest } from './manifest.js';
 import { TAnySchema } from '@sinclair/typebox';
+import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
 import '@octokit/core/dist-types/types';
 import '@octokit/plugin-paginate-graphql';
-import '@octokit/plugin-rest-endpoint-methods';
 import '@octokit/plugin-paginate-rest';
 import '@octokit/request-error';
 import '@octokit/core';
@@ -48,8 +48,11 @@ interface CommentOptions {
     raw?: boolean;
     updateComment?: boolean;
 }
+type WithIssueNumber<T> = T & {
+    issueNumber: number;
+};
 type PostComment = {
-    (context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<void>;
+    (context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<WithIssueNumber<RestEndpointMethodTypes["issues"]["updateComment"]["response"]["data"] | RestEndpointMethodTypes["issues"]["createComment"]["response"]["data"]> | null>;
     lastCommentId?: number;
 };
 /**

package/dist/index.js

@@ -127,17 +127,18 @@ var postComment = async function(context2, message, options = { updateComment: t
     issueNumber = context2.payload.discussion.number;
   } else {
     context2.logger.info("Cannot post comment because issue is not found in the payload.");
-    return;
+    return null;
   }
   if ("repository" in context2.payload && context2.payload.repository?.owner?.login) {
     const body = await createStructuredMetadataWithMessage(context2, message, options);
     if (options.updateComment && postComment.lastCommentId) {
-      await context2.octokit.rest.issues.updateComment({
+      const commentData = await context2.octokit.rest.issues.updateComment({
         owner: context2.payload.repository.owner.login,
         repo: context2.payload.repository.name,
         comment_id: postComment.lastCommentId,
         body
       });
+      return { ...commentData.data, issueNumber };
     } else {
       const commentData = await context2.octokit.rest.issues.createComment({
         owner: context2.payload.repository.owner.login,
@@ -146,10 +147,12 @@ var postComment = async function(context2, message, options = { updateComment: t
         body
       });
       postComment.lastCommentId = commentData.data.id;
+      return { ...commentData.data, issueNumber };
     }
   } else {
     context2.logger.info("Cannot post comment because repository is not found in the payload.", { payload: context2.payload });
   }
+  return null;
 };
 async function createStructuredMetadataWithMessage(context2, message, options) {
   let logMessage;

package/dist/index.mjs

@@ -89,17 +89,18 @@ var postComment = async function(context2, message, options = { updateComment: t
     issueNumber = context2.payload.discussion.number;
   } else {
     context2.logger.info("Cannot post comment because issue is not found in the payload.");
-    return;
+    return null;
   }
   if ("repository" in context2.payload && context2.payload.repository?.owner?.login) {
     const body = await createStructuredMetadataWithMessage(context2, message, options);
     if (options.updateComment && postComment.lastCommentId) {
-      await context2.octokit.rest.issues.updateComment({
+      const commentData = await context2.octokit.rest.issues.updateComment({
         owner: context2.payload.repository.owner.login,
         repo: context2.payload.repository.name,
         comment_id: postComment.lastCommentId,
         body
       });
+      return { ...commentData.data, issueNumber };
     } else {
       const commentData = await context2.octokit.rest.issues.createComment({
         owner: context2.payload.repository.owner.login,
@@ -108,10 +109,12 @@ var postComment = async function(context2, message, options = { updateComment: t
         body
       });
       postComment.lastCommentId = commentData.data.id;
+      return { ...commentData.data, issueNumber };
     }
   } else {
     context2.logger.info("Cannot post comment because repository is not found in the payload.", { payload: context2.payload });
   }
+  return null;
 };
 async function createStructuredMetadataWithMessage(context2, message, options) {
   let logMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubiquity-os/plugin-sdk",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "SDK for plugin support.",
   "author": "Ubiquity DAO",
   "license": "MIT",
@@ -87,7 +87,7 @@
     "@octokit/rest": "^21.0.2",
     "@octokit/types": "^13.6.1",
     "@octokit/webhooks": "^13.3.0",
-    "@ubiquity-os/ubiquity-os-logger": "^1.3.2",
+    "@ubiquity-os/ubiquity-os-logger": "^1.4.0",
     "dotenv": "^16.4.5",
     "hono": "^4.6.9"
   },