@ttoss/logger 0.4.0 → 0.6.0

package/README.md

@@ -23,6 +23,7 @@ import { configureLogger } from '@ttoss/logger';
 
 configureLogger({
   discordWebhookUrl: 'https://discord.com/api/webhooks/your-webhook-here',
+  project: 'My project',
 });
 ```
 
@@ -33,7 +34,10 @@ Use the `notify` method to send messages to the configured services:
 ```ts
 import { notify } from '@ttoss/logger';
 
-await notify('Hello! This is a notification for Discord.');
+await notify({
+  type: 'error',
+  message: 'Hello! This is a notification for Discord.',
+});
 ```
 
 ### Local Logging
@@ -58,13 +62,17 @@ Configures the logger with notification sending options.
 
 - **Parameters**:
   - `params.discordWebhookUrl` (string): The Discord webhook URL.
+  - `params.project` (string): The project identifier to prefix notifications.
 
-### `notify(message)`
+### `notify(notification)`
 
 Sends a notification to the configured services.
 
 - **Parameters**:
-  - `message` (string): The message to send.
+  - `notification` (object): The notification to send, with the following properties:
+    - `type` ('info' | 'warn' | 'error'): The type of the notification.
+    - `title` (string, optional): The title of the notification.
+    - `message` (string): The main message content.
 - **Returns**: A Promise that resolves when the sending is complete.
 
 ### `log`
@@ -88,7 +96,10 @@ configureLogger({
 
 // Send a notification
 
-await notify('Application started successfully!');
+await notify({
+  type: 'info',
+  message: 'Application started successfully!',
+});
 
 // Local logs
 

package/dist/esm/index.js

@@ -1,33 +1,70 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 
 // src/index.ts
+var log = {
+  warn: console.warn,
+  error: console.error,
+  info: console.info
+};
 var setup = null;
 var configureLogger = params => {
   setup = params;
 };
 var sendNotificationToDiscord = async ({
-  message,
-  url
+  notification,
+  url,
+  project
 }) => {
+  const embedMessage = {
+    embeds: [{
+      title: notification.title || `${notification.type.toUpperCase()} from ${project}`,
+      description: notification.message,
+      color: notification.type === "error" ? 16711680 : notification.type === "warn" ? 16776960 : 65280,
+      footer: {
+        text: `Project: ${project}`
+      }
+    }]
+  };
+  const body = JSON.stringify(embedMessage);
   await fetch(url, {
     method: "POST",
     headers: {
       "Content-Type": "application/json"
     },
-    body: JSON.stringify(message)
+    body
   });
 };
-var notify = async message => {
+var notify = async notification => {
+  if (notification.log) {
+    const message = [notification.title, notification.message].join(": ");
+    log[notification.type](message);
+  }
+  if (!setup?.project) {
+    return;
+  }
   if (setup?.discordWebhookUrl) {
     await sendNotificationToDiscord({
-      message,
-      url: setup.discordWebhookUrl
+      notification,
+      url: setup.discordWebhookUrl,
+      project: setup.project
     });
   }
 };
-var log = {
-  warn: console.warn,
-  error: console.error,
-  info: console.info
+var getErrorMessage = error => {
+  if (error instanceof Error) {
+    return error.message;
+  }
+  if (typeof error === "string") {
+    return error;
+  }
+  return "Unknown error:" + JSON.stringify(error);
+};
+var notifyError = async notification => {
+  return notify({
+    type: "error",
+    message: getErrorMessage(notification.error),
+    title: notification.title,
+    log: notification.log
+  });
 };
-export { configureLogger, log, notify, sendNotificationToDiscord };
+export { configureLogger, log, notify, notifyError, sendNotificationToDiscord };

package/dist/index.d.mts

@@ -1,12 +1,4 @@
-type Setup = {
-    discordWebhookUrl?: string;
-};
-declare const configureLogger: (params: Setup) => void;
-declare const sendNotificationToDiscord: ({ message, url, }: {
-    message: string;
-    url: string;
-}) => Promise<void>;
-declare const notify: (message: string) => Promise<void>;
+type NotificationType = 'info' | 'warn' | 'error';
 declare const log: {
     warn: {
         (...data: any[]): void;
@@ -21,5 +13,27 @@ declare const log: {
         (message?: any, ...optionalParams: any[]): void;
     };
 };
+type NotificationMessage = {
+    type: NotificationType;
+    title?: string;
+    message: string;
+    log?: boolean;
+};
+type Configuration = {
+    discordWebhookUrl?: string;
+    project?: string;
+};
+declare const configureLogger: (params: Configuration) => void;
+declare const sendNotificationToDiscord: ({ notification, url, project, }: {
+    notification: NotificationMessage;
+    url: string;
+    project: string;
+}) => Promise<void>;
+declare const notify: (notification: NotificationMessage) => Promise<void>;
+declare const notifyError: (notification: {
+    error: unknown;
+    title?: string;
+    log?: boolean;
+}) => Promise<void>;
 
-export { configureLogger, log, notify, sendNotificationToDiscord };
+export { configureLogger, log, notify, notifyError, sendNotificationToDiscord };

package/dist/index.d.ts

@@ -1,12 +1,4 @@
-type Setup = {
-    discordWebhookUrl?: string;
-};
-declare const configureLogger: (params: Setup) => void;
-declare const sendNotificationToDiscord: ({ message, url, }: {
-    message: string;
-    url: string;
-}) => Promise<void>;
-declare const notify: (message: string) => Promise<void>;
+type NotificationType = 'info' | 'warn' | 'error';
 declare const log: {
     warn: {
         (...data: any[]): void;
@@ -21,5 +13,27 @@ declare const log: {
         (message?: any, ...optionalParams: any[]): void;
     };
 };
+type NotificationMessage = {
+    type: NotificationType;
+    title?: string;
+    message: string;
+    log?: boolean;
+};
+type Configuration = {
+    discordWebhookUrl?: string;
+    project?: string;
+};
+declare const configureLogger: (params: Configuration) => void;
+declare const sendNotificationToDiscord: ({ notification, url, project, }: {
+    notification: NotificationMessage;
+    url: string;
+    project: string;
+}) => Promise<void>;
+declare const notify: (notification: NotificationMessage) => Promise<void>;
+declare const notifyError: (notification: {
+    error: unknown;
+    title?: string;
+    log?: boolean;
+}) => Promise<void>;
 
-export { configureLogger, log, notify, sendNotificationToDiscord };
+export { configureLogger, log, notify, notifyError, sendNotificationToDiscord };

package/dist/index.js

@@ -30,42 +30,81 @@ __export(index_exports, {
   configureLogger: () => configureLogger,
   log: () => log,
   notify: () => notify,
+  notifyError: () => notifyError,
   sendNotificationToDiscord: () => sendNotificationToDiscord
 });
 module.exports = __toCommonJS(index_exports);
+var log = {
+  warn: console.warn,
+  error: console.error,
+  info: console.info
+};
 var setup = null;
 var configureLogger = params => {
   setup = params;
 };
 var sendNotificationToDiscord = async ({
-  message,
-  url
+  notification,
+  url,
+  project
 }) => {
+  const embedMessage = {
+    embeds: [{
+      title: notification.title || `${notification.type.toUpperCase()} from ${project}`,
+      description: notification.message,
+      color: notification.type === "error" ? 16711680 : notification.type === "warn" ? 16776960 : 65280,
+      footer: {
+        text: `Project: ${project}`
+      }
+    }]
+  };
+  const body = JSON.stringify(embedMessage);
   await fetch(url, {
     method: "POST",
     headers: {
       "Content-Type": "application/json"
     },
-    body: JSON.stringify(message)
+    body
   });
 };
-var notify = async message => {
+var notify = async notification => {
+  if (notification.log) {
+    const message = [notification.title, notification.message].join(": ");
+    log[notification.type](message);
+  }
+  if (!setup?.project) {
+    return;
+  }
   if (setup?.discordWebhookUrl) {
     await sendNotificationToDiscord({
-      message,
-      url: setup.discordWebhookUrl
+      notification,
+      url: setup.discordWebhookUrl,
+      project: setup.project
     });
   }
 };
-var log = {
-  warn: console.warn,
-  error: console.error,
-  info: console.info
+var getErrorMessage = error => {
+  if (error instanceof Error) {
+    return error.message;
+  }
+  if (typeof error === "string") {
+    return error;
+  }
+  return "Unknown error:" + JSON.stringify(error);
+};
+var notifyError = async notification => {
+  return notify({
+    type: "error",
+    message: getErrorMessage(notification.error),
+    title: notification.title,
+    log: notification.log
+  });
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   configureLogger,
   log,
   notify,
+  notifyError,
   sendNotificationToDiscord
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/logger",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "A simple module to configure and send notifications to services like Discord from your applications.",
   "license": "MIT",
   "contributors": [],
@@ -23,7 +23,8 @@
   "devDependencies": {
     "jest": "^29.7.0",
     "tsup": "^8.3.5",
-    "@ttoss/config": "^1.35.2"
+    "@ttoss/config": "^1.35.2",
+    "@ttoss/test-utils": "^2.1.22"
   },
   "keywords": [],
   "publishConfig": {