@ttoss/logger 0.6.12 → 0.7.0

package/README.md

@@ -1,119 +1,98 @@
 # @ttoss/logger
 
-A simple module to configure and send notifications to services like Discord from your applications.
+Send notifications to Discord, Slack, or any custom endpoint from your applications.
 
 ## Installation
 
-Install the package via pnpm:
-
 ```bash
 pnpm add @ttoss/logger
 ```
 
-## Usage
-
-The `@ttoss/logger` module allows you to configure a logger and send notifications to external services, such as Discord, with ease. It also provides basic methods for local console logging.
-
-### Configuration
-
-First, configure the logger with the necessary parameters, such as a Discord webhook URL:
+## Quick Start
 
 ```ts
-import { configureLogger } from '@ttoss/logger';
+import { configureLogger, notify, log } from '@ttoss/logger';
 
+// Configure once at app startup
 configureLogger({
-  discordWebhookUrl: 'https://discord.com/api/webhooks/your-webhook-here',
-  project: 'My project',
+  project: 'My App',
+  discordWebhookUrl: 'https://discord.com/api/webhooks/xxx',
 });
-```
-
-### Sending Notifications
 
-Use the `notify` method to send messages to the configured services:
-
-```ts
-import { notify } from '@ttoss/logger';
+// Send notifications
+await notify({ type: 'error', message: 'Something went wrong!' });
+await notify({ type: 'info', title: 'Deploy', message: 'v1.2.0 released' });
 
-await notify({
-  type: 'error',
-  message: 'Hello! This is a notification for Discord.',
-});
+// Local console logging
+log.info('Server started');
+log.warn('High memory usage');
+log.error('Database connection failed');
 ```
 
-### Local Logging
+## Custom Endpoints
 
-For console logs, use the `log` object:
+Send notifications to any platform by providing a custom formatter:
 
 ```ts
-import { log } from '@ttoss/logger';
+configureLogger({
+  project: 'My App',
+  discordWebhookUrl: 'https://discord.com/api/webhooks/xxx',
+  customEndpoints: [
+    {
+      url: 'https://hooks.slack.com/services/xxx',
+      formatBody: ({ notification, project }) => ({
+        text: `[${project}] ${notification.type}: ${notification.message}`,
+      }),
+    },
+    {
+      url: 'https://my-api.com/alerts',
+      headers: { Authorization: 'Bearer token' },
+      method: 'PUT',
+      formatBody: ({ notification }) => ({
+        severity: notification.type,
+        message: notification.message,
+      }),
+    },
+  ],
+});
+```
 
-log.info('Useful information');
+### CustomEndpoint Options
 
-log.warn('Important warning');
-
-log.error('Critical error');
-```
+| Property     | Type                         | Description                                                        |
+| ------------ | ---------------------------- | ------------------------------------------------------------------ |
+| `url`        | `string`                     | Endpoint URL (required)                                            |
+| `formatBody` | `function`                   | Formats the request body (required)                                |
+| `headers`    | `Record<string, string>`     | Custom headers (default: `{ 'Content-Type': 'application/json' }`) |
+| `method`     | `'POST' \| 'PUT' \| 'PATCH'` | HTTP method (default: `'POST'`)                                    |
+| `name`       | `string`                     | Optional identifier for debugging                                  |
 
 ## API
 
-### `configureLogger(params)`
-
-Configures the logger with notification sending options.
+### `configureLogger(config)`
 
-- **Parameters**:
-  - `params.discordWebhookUrl` (string): The Discord webhook URL.
-  - `params.project` (string): The project identifier to prefix notifications.
+| Parameter           | Type                                 | Description                           |
+| ------------------- | ------------------------------------ | ------------------------------------- |
+| `project`           | `string`                             | Project name for notification context |
+| `discordWebhookUrl` | `string`                             | Discord webhook URL                   |
+| `customEndpoints`   | `CustomEndpoint \| CustomEndpoint[]` | Custom notification endpoints         |
 
 ### `notify(notification)`
 
-Sends a notification to the configured services.
-
-- **Parameters**:
-  - `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`
-
-Object with methods for local logging:
-
-- `log.warn(message)`: Displays a warning in the console.
-- `log.error(message)`: Displays an error in the console.
-- `log.info(message)`: Displays an info message in the console.
-
-## Complete Example
-
-```ts
-import { configureLogger, notify, log } from '@ttoss/logger';
-
-// Configure the logger
-
-configureLogger({
-  discordWebhookUrl: 'https://discord.com/api/webhooks/your-webhook-here',
-});
-
-// Send a notification
-
-await notify({
-  type: 'info',
-  message: 'Application started successfully!',
-});
+| Parameter | Type                          | Description           |
+| --------- | ----------------------------- | --------------------- |
+| `type`    | `'info' \| 'warn' \| 'error'` | Notification severity |
+| `message` | `string`                      | Notification content  |
+| `title`   | `string`                      | Optional title        |
+| `log`     | `boolean`                     | Also log to console   |
 
-// Local logs
+### `notifyError({ error, title?, log? })`
 
-log.info('Starting the server...');
+Convenience method for error notifications that extracts the message from Error objects.
 
-log.warn('Low memory.');
-
-log.error('Failed to connect to the database.');
-```
-
-## Notes
+### `log`
 
-- Currently, support is limited to Discord via webhooks, but more services will be added in the future.
-- Ensure the `discordWebhookUrl` is valid to avoid silent failures.
+Console logging methods: `log.info()`, `log.warn()`, `log.error()`
 
 ## License
 

package/dist/esm/index.js

@@ -39,6 +39,30 @@ var sendNotificationToDiscord = /* @__PURE__ */__name(async ({
     body
   });
 }, "sendNotificationToDiscord");
+var sendToCustomEndpoint = /* @__PURE__ */__name(async ({
+  notification,
+  endpoint,
+  project
+}) => {
+  const body = endpoint.formatBody({
+    notification,
+    project
+  });
+  await fetch(endpoint.url, {
+    method: endpoint.method || "POST",
+    headers: {
+      "Content-Type": "application/json",
+      ...(endpoint.headers ?? {})
+    },
+    body: JSON.stringify(body)
+  });
+}, "sendToCustomEndpoint");
+var getCustomEndpointsArray = /* @__PURE__ */__name(endpoints => {
+  if (!endpoints) {
+    return [];
+  }
+  return Array.isArray(endpoints) ? endpoints : [endpoints];
+}, "getCustomEndpointsArray");
 var notify = /* @__PURE__ */__name(async notification => {
   if (notification.log) {
     const message = [notification.title, notification.message].join(": ");
@@ -47,13 +71,23 @@ var notify = /* @__PURE__ */__name(async notification => {
   if (!setup?.project) {
     return;
   }
+  const promises = [];
   if (setup?.discordWebhookUrl) {
-    await sendNotificationToDiscord({
+    promises.push(sendNotificationToDiscord({
       notification,
       url: setup.discordWebhookUrl,
       project: setup.project
-    });
+    }));
+  }
+  const customEndpoints = getCustomEndpointsArray(setup.customEndpoints);
+  for (const endpoint of customEndpoints) {
+    promises.push(sendToCustomEndpoint({
+      notification,
+      endpoint,
+      project: setup.project
+    }));
   }
+  await Promise.all(promises);
 }, "notify");
 var getErrorMessage = /* @__PURE__ */__name(error => {
   if (error instanceof Error) {
@@ -72,4 +106,4 @@ var notifyError = /* @__PURE__ */__name(async notification => {
     log: notification.log
   });
 }, "notifyError");
-export { configureLogger, log, notify, notifyError, sendNotificationToDiscord };
+export { configureLogger, log, notify, notifyError };

package/dist/index.d.mts

@@ -19,16 +19,47 @@ type NotificationMessage = {
     message: string;
     log?: boolean;
 };
+/**
+ * Custom endpoint configuration for sending notifications to any platform.
+ */
+type CustomEndpoint = {
+    /**
+     * The URL of the endpoint to send notifications to.
+     */
+    url: string;
+    /**
+     * Optional name to identify this endpoint (useful for debugging).
+     */
+    name?: string;
+    /**
+     * Function to format the notification message for this specific endpoint.
+     * Receives the notification and project name, returns a plain object to be JSON serialized as the request body.
+     * Must return a value of type Record<string, unknown>.
+     */
+    formatBody: (params: {
+        notification: NotificationMessage;
+        project: string;
+    }) => Record<string, unknown>;
+    /**
+     * Optional custom headers for the request.
+     * Defaults to { 'Content-Type': 'application/json' }
+     */
+    headers?: Record<string, string>;
+    /**
+     * HTTP method to use. Defaults to 'POST'.
+     */
+    method?: 'POST' | 'PUT' | 'PATCH';
+};
 type Configuration = {
     discordWebhookUrl?: string;
     project?: string;
+    /**
+     * Custom endpoints to send notifications to.
+     * Can be a single endpoint or an array of endpoints.
+     */
+    customEndpoints?: CustomEndpoint | CustomEndpoint[];
 };
 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;
@@ -36,4 +67,4 @@ declare const notifyError: (notification: {
     log?: boolean;
 }) => Promise<void>;
 
-export { configureLogger, log, notify, notifyError, sendNotificationToDiscord };
+export { type CustomEndpoint, configureLogger, log, notify, notifyError };

package/dist/index.d.ts

@@ -19,16 +19,47 @@ type NotificationMessage = {
     message: string;
     log?: boolean;
 };
+/**
+ * Custom endpoint configuration for sending notifications to any platform.
+ */
+type CustomEndpoint = {
+    /**
+     * The URL of the endpoint to send notifications to.
+     */
+    url: string;
+    /**
+     * Optional name to identify this endpoint (useful for debugging).
+     */
+    name?: string;
+    /**
+     * Function to format the notification message for this specific endpoint.
+     * Receives the notification and project name, returns a plain object to be JSON serialized as the request body.
+     * Must return a value of type Record<string, unknown>.
+     */
+    formatBody: (params: {
+        notification: NotificationMessage;
+        project: string;
+    }) => Record<string, unknown>;
+    /**
+     * Optional custom headers for the request.
+     * Defaults to { 'Content-Type': 'application/json' }
+     */
+    headers?: Record<string, string>;
+    /**
+     * HTTP method to use. Defaults to 'POST'.
+     */
+    method?: 'POST' | 'PUT' | 'PATCH';
+};
 type Configuration = {
     discordWebhookUrl?: string;
     project?: string;
+    /**
+     * Custom endpoints to send notifications to.
+     * Can be a single endpoint or an array of endpoints.
+     */
+    customEndpoints?: CustomEndpoint | CustomEndpoint[];
 };
 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;
@@ -36,4 +67,4 @@ declare const notifyError: (notification: {
     log?: boolean;
 }) => Promise<void>;
 
-export { configureLogger, log, notify, notifyError, sendNotificationToDiscord };
+export { type CustomEndpoint, configureLogger, log, notify, notifyError };

package/dist/index.js

@@ -34,8 +34,7 @@ __export(index_exports, {
   configureLogger: () => configureLogger,
   log: () => log,
   notify: () => notify,
-  notifyError: () => notifyError,
-  sendNotificationToDiscord: () => sendNotificationToDiscord
+  notifyError: () => notifyError
 });
 module.exports = __toCommonJS(index_exports);
 var log = {
@@ -71,6 +70,30 @@ var sendNotificationToDiscord = /* @__PURE__ */__name(async ({
     body
   });
 }, "sendNotificationToDiscord");
+var sendToCustomEndpoint = /* @__PURE__ */__name(async ({
+  notification,
+  endpoint,
+  project
+}) => {
+  const body = endpoint.formatBody({
+    notification,
+    project
+  });
+  await fetch(endpoint.url, {
+    method: endpoint.method || "POST",
+    headers: {
+      "Content-Type": "application/json",
+      ...(endpoint.headers ?? {})
+    },
+    body: JSON.stringify(body)
+  });
+}, "sendToCustomEndpoint");
+var getCustomEndpointsArray = /* @__PURE__ */__name(endpoints => {
+  if (!endpoints) {
+    return [];
+  }
+  return Array.isArray(endpoints) ? endpoints : [endpoints];
+}, "getCustomEndpointsArray");
 var notify = /* @__PURE__ */__name(async notification => {
   if (notification.log) {
     const message = [notification.title, notification.message].join(": ");
@@ -79,13 +102,23 @@ var notify = /* @__PURE__ */__name(async notification => {
   if (!setup?.project) {
     return;
   }
+  const promises = [];
   if (setup?.discordWebhookUrl) {
-    await sendNotificationToDiscord({
+    promises.push(sendNotificationToDiscord({
       notification,
       url: setup.discordWebhookUrl,
       project: setup.project
-    });
+    }));
+  }
+  const customEndpoints = getCustomEndpointsArray(setup.customEndpoints);
+  for (const endpoint of customEndpoints) {
+    promises.push(sendToCustomEndpoint({
+      notification,
+      endpoint,
+      project: setup.project
+    }));
   }
+  await Promise.all(promises);
 }, "notify");
 var getErrorMessage = /* @__PURE__ */__name(error => {
   if (error instanceof Error) {
@@ -109,6 +142,5 @@ var notifyError = /* @__PURE__ */__name(async notification => {
   configureLogger,
   log,
   notify,
-  notifyError,
-  sendNotificationToDiscord
+  notifyError
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/logger",
-  "version": "0.6.12",
+  "version": "0.7.0",
   "description": "A simple module to configure and send notifications to services like Discord from your applications.",
   "license": "MIT",
   "contributors": [],
@@ -23,8 +23,8 @@
   "devDependencies": {
     "jest": "^30.2.0",
     "tsup": "^8.5.1",
-    "@ttoss/config": "^1.35.12",
-    "@ttoss/test-utils": "^4.0.1"
+    "@ttoss/test-utils": "^4.0.1",
+    "@ttoss/config": "^1.35.12"
   },
   "keywords": [],
   "publishConfig": {