@ttoss/logger 0.3.17 → 0.5.0

package/README.md

@@ -1,57 +1,120 @@
 # @ttoss/logger
 
-Simple environment agnostic logger.
+A simple module to configure and send notifications to services like Discord from your applications.
 
-## Motivation
+## Installation
 
-Often, for debugging some piece of code, developers use console.log for it. When the application goes for production, some of these logs still appears, most because they forget to clear these logs.
-These package solves this, providing some levels of log that are emitted based on the environment of the application.
+Install the package via pnpm:
 
-## Log Levels vs Environments
+```bash
+pnpm add @ttoss/logger
+```
+
+## Usage
 
-<table>
-<thead>
-<tr><th>Log Level</th><th>Environment</th></tr>
-</thead>
-<tbody>
-<tr><td>Warn</td><td>Dev-only</td></tr>
-<tr><td>Error</td><td>All</td></tr>
-<tr><td>Info</td><td>Dev-only</td></tr>
-</tbody>
-</table>
+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.
 
-## How to use
+### Configuration
 
-Just instantiate the logger, providing the `isDev` value configuration and start to use:
+First, configure the logger with the necessary parameters, such as a Discord webhook URL:
 
 ```ts
-// createLogger.ts
+import { configureLogger } from '@ttoss/logger';
+
+configureLogger({
+  discordWebhookUrl: 'https://discord.com/api/webhooks/your-webhook-here',
+  project: 'My project',
+});
+```
 
-import { Logger } from '@ttoss/logger';
-import { config } from 'dotenv';
+### Sending Notifications
 
-config();
+Use the `notify` method to send messages to the configured services:
 
-export const createLogger = Logger(process.env.DEV === 'true');
+```ts
+import { notify } from '@ttoss/logger';
+
+await notify({
+  type: 'error',
+  message: 'Hello! This is a notification for Discord.',
+});
+```
 
-// randomFile.ts
+### Local Logging
 
-const logger = createLogger('randomFile');
+For console logs, use the `log` object:
 
-logger.warn('This will emit an warn on console');
+```ts
+import { log } from '@ttoss/logger';
 
-logger.error('This will emit a log of type error on console');
+log.info('Useful information');
 
-loggger.info('This will emit a simple log on console');
+log.warn('Important warning');
+
+log.error('Critical error');
 ```
 
-If you not pass any parameter to `Logger`, it gonna considers to be in dev environment:
+## API
+
+### `configureLogger(params)`
+
+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(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
-// createLogger.ts
+import { configureLogger, notify, log } from '@ttoss/logger';
+
+// Configure the logger
+
+configureLogger({
+  discordWebhookUrl: 'https://discord.com/api/webhooks/your-webhook-here',
+});
+
+// Send a notification
 
-import { Logger } from '@ttoss/logger';
+await notify({
+  type: 'info',
+  message: 'Application started successfully!',
+});
 
-// In dev environment, gonna log everything
-export const createLogger = Logger();
+// Local logs
+
+log.info('Starting the server...');
+
+log.warn('Low memory.');
+
+log.error('Failed to connect to the database.');
 ```
+
+## Notes
+
+- 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.
+
+## License
+
+[MIT](https://github.com/ttoss/ttoss/blob/main/LICENSE)

package/dist/esm/index.js

@@ -1,32 +1,49 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 
 // src/index.ts
-var {
-  log,
-  warn,
-  error
-} = console;
-var Logger = isDev => {
-  const devEnv = isDev !== void 0 ? isDev : true;
-  return prefix => {
-    return {
-      warn: value => {
-        if (devEnv) {
-          const now = /* @__PURE__ */new Date();
-          warn(`[${now}] - ${prefix} - ${value}`);
-        }
-      },
-      info: value => {
-        if (devEnv) {
-          const now = /* @__PURE__ */new Date();
-          log(`[${now}] - ${prefix} - ${value}`);
-        }
-      },
-      error: value => {
-        const now = /* @__PURE__ */new Date();
-        error(`[${now}] - ${prefix} - ${value}`);
+var setup = null;
+var configureLogger = params => {
+  setup = params;
+};
+var sendNotificationToDiscord = async ({
+  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
+  });
+};
+var notify = async notification => {
+  if (!setup?.project) {
+    return;
+  }
+  if (setup?.discordWebhookUrl) {
+    await sendNotificationToDiscord({
+      notification,
+      url: setup.discordWebhookUrl,
+      project: setup.project
+    });
+  }
+};
+var log = {
+  warn: console.warn,
+  error: console.error,
+  info: console.info
 };
-export { Logger };
+export { configureLogger, log, notify, sendNotificationToDiscord };

package/dist/index.d.mts

@@ -1,7 +1,33 @@
-declare const Logger: (isDev?: boolean) => (prefix: string) => {
-    warn: (value: string) => void;
-    info: (value: string) => void;
-    error: (value: string) => void;
+type NotificationType = 'info' | 'warn' | 'error';
+type NotificationMessage = {
+    type: NotificationType;
+    title?: string;
+    message: string;
+};
+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 log: {
+    warn: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
+    error: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
+    info: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
 };
 
-export { Logger };
+export { configureLogger, log, notify, sendNotificationToDiscord };

package/dist/index.d.ts

@@ -1,7 +1,33 @@
-declare const Logger: (isDev?: boolean) => (prefix: string) => {
-    warn: (value: string) => void;
-    info: (value: string) => void;
-    error: (value: string) => void;
+type NotificationType = 'info' | 'warn' | 'error';
+type NotificationMessage = {
+    type: NotificationType;
+    title?: string;
+    message: string;
+};
+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 log: {
+    warn: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
+    error: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
+    info: {
+        (...data: any[]): void;
+        (message?: any, ...optionalParams: any[]): void;
+    };
 };
 
-export { Logger };
+export { configureLogger, log, notify, sendNotificationToDiscord };

package/dist/index.js

@@ -27,38 +27,61 @@ var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  Logger: () => Logger
+  configureLogger: () => configureLogger,
+  log: () => log,
+  notify: () => notify,
+  sendNotificationToDiscord: () => sendNotificationToDiscord
 });
 module.exports = __toCommonJS(index_exports);
-var {
-  log,
-  warn,
-  error
-} = console;
-var Logger = isDev => {
-  const devEnv = isDev !== void 0 ? isDev : true;
-  return prefix => {
-    return {
-      warn: value => {
-        if (devEnv) {
-          const now = /* @__PURE__ */new Date();
-          warn(`[${now}] - ${prefix} - ${value}`);
-        }
-      },
-      info: value => {
-        if (devEnv) {
-          const now = /* @__PURE__ */new Date();
-          log(`[${now}] - ${prefix} - ${value}`);
-        }
-      },
-      error: value => {
-        const now = /* @__PURE__ */new Date();
-        error(`[${now}] - ${prefix} - ${value}`);
+var setup = null;
+var configureLogger = params => {
+  setup = params;
+};
+var sendNotificationToDiscord = async ({
+  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
+  });
+};
+var notify = async notification => {
+  if (!setup?.project) {
+    return;
+  }
+  if (setup?.discordWebhookUrl) {
+    await sendNotificationToDiscord({
+      notification,
+      url: setup.discordWebhookUrl,
+      project: setup.project
+    });
+  }
+};
+var log = {
+  warn: console.warn,
+  error: console.error,
+  info: console.info
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Logger
+  configureLogger,
+  log,
+  notify,
+  sendNotificationToDiscord
 });

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@ttoss/logger",
-  "version": "0.3.17",
-  "description": "Simple environment agnostic logger",
+  "version": "0.5.0",
+  "description": "A simple module to configure and send notifications to services like Discord from your applications.",
   "license": "MIT",
-  "contributors": [
-    "Eron Alves <eron.alves@rocketmail.com>"
-  ],
+  "contributors": [],
   "repository": {
     "type": "git",
     "url": "https://github.com/ttoss/ttoss.git",
@@ -18,12 +16,12 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "module": "dist/esm/index.js",
   "files": [
     "dist"
   ],
   "sideEffects": false,
   "devDependencies": {
+    "jest": "^29.7.0",
     "tsup": "^8.3.5",
     "@ttoss/config": "^1.35.2"
   },
@@ -33,6 +31,7 @@
     "provenance": true
   },
   "scripts": {
-    "build": "tsup"
+    "build": "tsup",
+    "test": "jest --projects tests/unit"
   }
 }