@fabasoad/sarif-to-slack 0.1.0 → 0.2.0

package/src/SlackMessageBuilder.ts

@@ -1,8 +1,10 @@
 import { AnyBlock } from '@slack/types'
-import { HeaderBlock, ContextBlock } from '@slack/types/dist/block-kit/blocks'
+import { ContextBlock, HeaderBlock } from '@slack/types/dist/block-kit/blocks'
+import { TextObject } from '@slack/types/dist/block-kit/composition-objects'
 import { IncomingWebhook } from '@slack/webhook'
-import type { Run, Result, ReportingDescriptor } from 'sarif'
-import { Sarif, SlackMessage } from './types'
+import { FooterType, Sarif, SlackMessage } from './types'
+import type { ReportingDescriptor, Result, Run } from 'sarif'
+import { LIB_VERSION } from './version'
 
 /**
  * Options for the SlackMessageBuilder.
@@ -61,14 +63,14 @@ export class SlackMessageBuilder implements SlackMessage {
     this.runId = process.env.GITHUB_RUN_ID
   }
 
-  withFooter(footer?: string): void {
-    const repoName = 'fabasoad/sarif-to-slack-action'
+  withFooter(text?: string, type?: FooterType): void {
+    const repoName = 'fabasoad/sarif-to-slack'
+    const element: TextObject = text
+      ? { type: type || FooterType.PLAIN_TEXT, text }
+      : { type: FooterType.MARKDOWN, text: `Generated by <${this.gitHubServerUrl}/${repoName}|@${repoName}@${LIB_VERSION}>` }
     this.footer = {
       type: 'context',
-      elements: [{
-        type: footer ? 'plain_text' : 'mrkdwn',
-        text: footer || `Generated by <${this.gitHubServerUrl}/${repoName}|${repoName}>`
-      }],
+      elements: [element],
     }
   }
 

package/src/index.ts

@@ -9,9 +9,9 @@
  *
  * @example
  * ```typescript
- * import { SarifToSlackService } from 'sarif-to-slack';
+ * import { SarifToSlackService, FooterType } from '@fabasoad/sarif-to-slack';
  *
- * const service = new SarifToSlackService({
+ * const service = await SarifToSlackService.create({
  *   webhookUrl: 'https://hooks.slack.com/services/your/webhook/url',
  *   sarifPath: 'path/to/your/sarif/file.sarif',
  *   logLevel: 'info',
@@ -24,6 +24,7 @@
  *   },
  *   footer: {
  *     include: true,
+ *     type: FooterType.PLAIN_TEXT,
  *     value: 'Generated by @fabasoad/sarif-to-slack'
  *   },
  *   actor: {
@@ -43,8 +44,10 @@
  */
 export { SarifToSlackService } from './SarifToSlackService'
 export {
-  IncludeAwareProps,
-  IncludeAwareWithValueProps,
+  FooterOptions,
+  FooterType,
+  IncludeAwareOptions,
+  IncludeAwareWithValueOptions,
   LogLevel,
   Sarif,
   SarifToSlackServiceOptions,

package/src/types.ts

@@ -62,7 +62,7 @@ export enum LogLevel {
  * in the Slack message.
  * @public
  */
-export type IncludeAwareProps = {
+export type IncludeAwareOptions = {
   include: boolean
 }
 
@@ -71,10 +71,28 @@ export type IncludeAwareProps = {
  * in the Slack message, along with an optional value.
  * @public
  */
-export type IncludeAwareWithValueProps = IncludeAwareProps & {
+export type IncludeAwareWithValueOptions = IncludeAwareOptions & {
   value?: string
 }
 
+/**
+ * Enum representing the type of footer in a Slack message.
+ * @public
+ */
+export enum FooterType {
+  PLAIN_TEXT = 'plain_text',
+  MARKDOWN = 'mrkdwn'
+}
+
+/**
+ * Options for the footer of a Slack message. "type" is ignored if "value" is
+ * not defined.
+ * @public
+ */
+export type FooterOptions = IncludeAwareWithValueOptions & {
+  type?: FooterType
+}
+
 /**
  * Options for the SarifToSlackService.
  * @public
@@ -87,8 +105,8 @@ export type SarifToSlackServiceOptions = {
   iconUrl?: string,
   color?: string,
   logLevel?: LogLevel | string,
-  header?: IncludeAwareWithValueProps,
-  footer?: IncludeAwareWithValueProps,
-  actor?: IncludeAwareWithValueProps,
-  run?: IncludeAwareProps,
+  header?: IncludeAwareWithValueOptions,
+  footer?: FooterOptions,
+  actor?: IncludeAwareWithValueOptions,
+  run?: IncludeAwareOptions,
 }

package/src/version.ts

@@ -0,0 +1,3 @@
+// This file is autogenerated by scripts/save-version.sh
+// Do not edit it manually!
+export const LIB_VERSION = '0.2.0'

package/tsconfig.json

@@ -1,21 +1,35 @@
 {
   "$schema": "http://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "target": "es2024",
-    "module": "commonjs",
+    "allowSyntheticDefaultImports": true,
+    "alwaysStrict": true,
+    "baseUrl": ".",
     "declaration": true,
-    "sourceMap": true,
+    "declarationDir": "dist",
     "declarationMap": true,
-    "stripInternal": true,
-    "types": ["node", "jest"],
+    "downlevelIteration": true,
+    "emitDecoratorMetadata": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSourceMap": true,
+    "lib": ["es2024"],
+    "module": "es2022",
+    "moduleResolution": "node",
     "newLine": "lf",
-    "lib": [
-      "es2024"
-    ],
-    "outDir": "lib"
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "outDir": "dist",
+    "skipLibCheck": true,
+    "strict": true,
+    "stripInternal": true,
+    "target": "es2024",
+    "typeRoots": ["node_modules/@types", "@types"],
+    "types": ["node", "jest"]
   },
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": ["node_modules", "tests"]
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "tests"]
 }