@ubiquity-os/plugin-sdk 3.1.9 → 3.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -95,7 +95,8 @@ declare class CommentHandler {
95
95
  jsonPretty: string;
96
96
  }>;
97
97
  _formatMetadataContent(logMessage: LogReturn["logMessage"], header: string, jsonPretty: string): string;
98
- _createCommentBody(context: Context, message: LogReturn | Error, options: CommentOptions): Promise<string>;
98
+ createCommentBody(context: Context, message: LogReturn | Error, options?: Pick<CommentOptions, "raw">): Promise<string>;
99
+ private _createCommentBody;
99
100
  postComment(context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<WithIssueNumber<PostedGithubComment> | null>;
100
101
  }
101
102
 
package/dist/index.d.ts CHANGED
@@ -95,7 +95,8 @@ declare class CommentHandler {
95
95
  jsonPretty: string;
96
96
  }>;
97
97
  _formatMetadataContent(logMessage: LogReturn["logMessage"], header: string, jsonPretty: string): string;
98
- _createCommentBody(context: Context, message: LogReturn | Error, options: CommentOptions): Promise<string>;
98
+ createCommentBody(context: Context, message: LogReturn | Error, options?: Pick<CommentOptions, "raw">): Promise<string>;
99
+ private _createCommentBody;
99
100
  postComment(context: Context, message: LogReturn | Error, options?: CommentOptions): Promise<WithIssueNumber<PostedGithubComment> | null>;
100
101
  }
101
102
 
package/dist/index.js CHANGED
@@ -274,11 +274,17 @@ var CommentHandler = class _CommentHandler {
274
274
  const metadataHidden = [header, jsonPretty, "-->"].join("\n");
275
275
  return logMessage?.type === "fatal" ? [metadataVisible, metadataHidden].join("\n") : metadataHidden;
276
276
  }
277
+ /*
278
+ * Creates the body for the comment, embeds the metadata and the header hidden in the body as well.
279
+ */
280
+ async createCommentBody(context2, message, options) {
281
+ return this._createCommentBody(context2, message, options);
282
+ }
277
283
  async _createCommentBody(context2, message, options) {
278
284
  const { metadata, logMessage } = await this._processMessage(context2, message);
279
285
  const { header, jsonPretty } = await this._createMetadataContent(context2, metadata);
280
286
  const metadataContent = this._formatMetadataContent(logMessage, header, jsonPretty);
281
- return `${options.raw ? logMessage?.raw : logMessage?.diff}
287
+ return `${options?.raw ? logMessage?.raw : logMessage?.diff}
282
288
 
283
289
  ${metadataContent}
284
290
  `;
package/dist/index.mjs CHANGED
@@ -236,11 +236,17 @@ var CommentHandler = class _CommentHandler {
236
236
  const metadataHidden = [header, jsonPretty, "-->"].join("\n");
237
237
  return logMessage?.type === "fatal" ? [metadataVisible, metadataHidden].join("\n") : metadataHidden;
238
238
  }
239
+ /*
240
+ * Creates the body for the comment, embeds the metadata and the header hidden in the body as well.
241
+ */
242
+ async createCommentBody(context2, message, options) {
243
+ return this._createCommentBody(context2, message, options);
244
+ }
239
245
  async _createCommentBody(context2, message, options) {
240
246
  const { metadata, logMessage } = await this._processMessage(context2, message);
241
247
  const { header, jsonPretty } = await this._createMetadataContent(context2, metadata);
242
248
  const metadataContent = this._formatMetadataContent(logMessage, header, jsonPretty);
243
- return `${options.raw ? logMessage?.raw : logMessage?.diff}
249
+ return `${options?.raw ? logMessage?.raw : logMessage?.diff}
244
250
 
245
251
  ${metadataContent}
246
252
  `;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ubiquity-os/plugin-sdk",
3
- "version": "3.1.9",
3
+ "version": "3.1.10",
4
4
  "description": "SDK for plugin support.",
5
5
  "author": "Ubiquity DAO",
6
6
  "license": "MIT",