@royaltics/tracker-sails 0.0.1

package/README.md

@@ -0,0 +1,191 @@
+# @royaltics/tracker-sails
+
+> Sails.js hook for Royaltics Error Tracker
+
+## Features
+
+- ✅ **Sails.js Integration**: Native hook implementation
+- ✅ **Automatic Request Tracking**: Capture all HTTP requests
+- ✅ **Error Middleware**: Automatic error capture
+- ✅ **Route Filtering**: Ignore specific routes
+- ✅ **Configurable**: Full control over what gets tracked
+- ✅ **TypeScript Support**: Full type definitions
+
+## Installation
+
+```bash
+pnpm add @royaltics/tracker-sails
+# or
+npm install @royaltics/tracker-sails
+# or
+yarn add @royaltics/tracker-sails
+```
+
+## Configuration
+
+Create or update `config/errorTracker.js`:
+
+```javascript
+module.exports.errorTracker = {
+  webhookUrl: process.env.ERROR_TRACKER_WEBHOOK_URL,
+  licenseId: process.env.ERROR_TRACKER_LICENSE_ID,
+  licenseDevice: process.env.ERROR_TRACKER_DEVICE || 'sails-server',
+  licenseName: 'My Company',
+  app: 'my-sails-app',
+  version: '1.0.0',
+  
+  // Optional: Capture settings
+  captureRoutes: true,
+  captureQueries: true,
+  captureHeaders: false,
+  
+  // Optional: Filtering
+  ignoredRoutes: [
+    '/health',
+    '/metrics',
+    '^/api/internal/.*'
+  ],
+  
+  ignoredErrors: [
+    'ValidationError',
+    'NotFoundError'
+  ],
+  
+  // Optional: Advanced settings
+  enabled: true,
+  maxRetries: 3,
+  timeout: 10000,
+  flushInterval: 5000,
+  maxQueueSize: 50
+};
+```
+
+## Usage
+
+### Install the Hook
+
+In `config/hooks.js`:
+
+```javascript
+module.exports.hooks = {
+  errorTracker: require('@royaltics/tracker-sails').errorTracker
+};
+```
+
+### Automatic Error Tracking
+
+The hook automatically captures:
+
+- Uncaught exceptions
+- Unhandled promise rejections
+- Route errors
+- Request errors
+
+### Manual Error Tracking
+
+```javascript
+// In a controller or service
+module.exports = {
+  async someAction(req, res) {
+    try {
+      // Your code
+    } catch (error) {
+      sails.hooks.errorTracker.client.error(error, 'ERROR', {
+        userId: req.session.userId,
+        action: 'someAction'
+      });
+      
+      return res.serverError(error);
+    }
+  }
+};
+```
+
+### Track Custom Events
+
+```javascript
+sails.hooks.errorTracker.client.event('User registered', 'INFO', {
+  userId: user.id,
+  email: user.email
+});
+```
+
+## Configuration Options
+
+### Required
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `webhookUrl` | `string` | HTTP/HTTPS webhook URL |
+| `licenseId` | `string` | Your license ID |
+| `licenseDevice` | `string` | Device identifier |
+
+### Optional
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `licenseName` | `string` | `undefined` | License name |
+| `app` | `string` | `undefined` | Application name |
+| `version` | `string` | `undefined` | Application version |
+| `captureRoutes` | `boolean` | `false` | Capture all route requests |
+| `captureQueries` | `boolean` | `false` | Include query parameters |
+| `captureHeaders` | `boolean` | `false` | Include request headers |
+| `ignoredRoutes` | `string[]` | `[]` | Routes to ignore (regex patterns) |
+| `ignoredErrors` | `string[]` | `[]` | Errors to ignore (regex patterns) |
+| `enabled` | `boolean` | `true` | Enable/disable tracking |
+| `maxRetries` | `number` | `3` | Max retry attempts |
+| `timeout` | `number` | `10000` | Request timeout in ms |
+| `flushInterval` | `number` | `5000` | Batch flush interval in ms |
+| `maxQueueSize` | `number` | `50` | Max events before auto-flush |
+
+## Examples
+
+### Environment Variables
+
+```bash
+ERROR_TRACKER_WEBHOOK_URL=https://api.example.com/webhook
+ERROR_TRACKER_LICENSE_ID=your-license-id
+ERROR_TRACKER_DEVICE=production-server-01
+```
+
+### Ignore Health Check Routes
+
+```javascript
+module.exports.errorTracker = {
+  // ... other config
+  ignoredRoutes: [
+    '/health',
+    '/ping',
+    '/metrics',
+    '^/api/internal/.*'
+  ]
+};
+```
+
+### Capture Only Errors
+
+```javascript
+module.exports.errorTracker = {
+  // ... other config
+  captureRoutes: false,  // Don't track successful requests
+  captureQueries: true,  // But include query params in errors
+  captureHeaders: false  // Don't include headers
+};
+```
+
+## TypeScript
+
+```typescript
+import { SailsErrorTrackerConfig } from '@royaltics/tracker-sails';
+
+const config: SailsErrorTrackerConfig = {
+  webhookUrl: 'https://api.example.com/webhook',
+  licenseId: 'your-license-id',
+  licenseDevice: 'server-01',
+  captureRoutes: true
+};
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";const u=require("@royaltics/tracker");module.exports=function(e){let t;return{defaults:{__configKey__:{enabled:!0,webhookUrl:"N/A",licenseId:"",licenseDevice:"",licenseName:"",app:"sails-app",version:"",platform:"sails",maxRetries:3,timeout:1e4,flushInterval:1e4,maxQueueSize:100,headers:{}}},initialize:function(o){const i=e.config.tracker||{};if(!i.enabled)return e.log.warn("@royaltics/tracker-sails hook deactivated"),o();if(!i.webhookUrl)return e.log.error("DSN for @royaltics/tracker-sails is required in config/tracker.js"),o();try{i.debug&&e.log.info("Initializing @royaltics/tracker-sails..."),t=u.create(i),e.tracker=t,i.debug&&e.log.info("@royaltics/tracker-sails initialized successfully"),process.on("unhandledRejection",function(n){i.debug&&e.log.info("Unhandled rejection:",n),t==null||t.error(n instanceof Error?n:new Error(String(n)))}),i.captureRoutes&&c(e,t,i),i.debug&&e.log.info("@royaltics/tracker-sails initialized successfully")}catch(n){i.debug&&e.log.error("Failed to initialize @royaltics/tracker-sails:",n)}return o()},shutdown:function(o){t&&u.shutdown(),o()}}};function c(r,e,t){r.on&&(r.on("router:request",(o,i)=>{if(a(o.url,["https://sailsjs.com","https://api.royaltics.com"]))return;const n=s(o,t);e.event("Request received","INFO",{request:n})}),r.on("router:request:error",(o,i)=>{if(t.ignoredErrors||l(o,["SailsError","RoyalticsError"]))return;const n=s(i,t);e.error(o,"ERROR",{request:n})}))}function s(r,e){return{method:r.method??"UNKNOWN",url:r.url??"UNKNOWN",ip:r.ip,headers:e.captureHeaders?r.headers:void 0,query:e.captureQueries?r.query:void 0,body:e.captureQueries?r.body:void 0}}function a(r,e){return e?e.some(t=>new RegExp(t).test(r)):!1}function l(r,e){return e?e.some(t=>{const o=new RegExp(t);return o.test(r.name)||o.test(r.message)}):!1}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.js

@@ -0,0 +1,75 @@
+var c = (r, e) => () => (e || r((e = { exports: {} }).exports, e), e.exports);
+import u from "@royaltics/tracker";
+var g = c((y, a) => {
+  a.exports = function(e) {
+    let t;
+    return {
+      defaults: {
+        __configKey__: {
+          enabled: !0,
+          webhookUrl: "N/A",
+          licenseId: "",
+          licenseDevice: "",
+          licenseName: "",
+          app: "sails-app",
+          version: "",
+          platform: "sails",
+          maxRetries: 3,
+          timeout: 1e4,
+          flushInterval: 1e4,
+          maxQueueSize: 100,
+          headers: {}
+        }
+      },
+      initialize: function(o) {
+        const i = e.config.tracker || {};
+        if (!i.enabled)
+          return e.log.warn("@royaltics/tracker-sails hook deactivated"), o();
+        if (!i.webhookUrl)
+          return e.log.error("DSN for @royaltics/tracker-sails is required in config/tracker.js"), o();
+        try {
+          i.debug && e.log.info("Initializing @royaltics/tracker-sails..."), t = u.create(i), e.tracker = t, i.debug && e.log.info("@royaltics/tracker-sails initialized successfully"), process.on("unhandledRejection", function(n) {
+            i.debug && e.log.info("Unhandled rejection:", n), t == null || t.error(n instanceof Error ? n : new Error(String(n)));
+          }), i.captureRoutes && l(e, t, i), i.debug && e.log.info("@royaltics/tracker-sails initialized successfully");
+        } catch (n) {
+          i.debug && e.log.error("Failed to initialize @royaltics/tracker-sails:", n);
+        }
+        return o();
+      },
+      shutdown: function(o) {
+        t && u.shutdown(), o();
+      }
+    };
+  };
+  function l(r, e, t) {
+    r.on && (r.on("router:request", (o, i) => {
+      if (d(o.url, ["https://sailsjs.com", "https://api.royaltics.com"])) return;
+      const n = s(o, t);
+      e.event("Request received", "INFO", { request: n });
+    }), r.on("router:request:error", (o, i) => {
+      if (t.ignoredErrors || f(o, ["SailsError", "RoyalticsError"])) return;
+      const n = s(i, t);
+      e.error(o, "ERROR", { request: n });
+    }));
+  }
+  function s(r, e) {
+    return {
+      method: r.method ?? "UNKNOWN",
+      url: r.url ?? "UNKNOWN",
+      ip: r.ip,
+      headers: e.captureHeaders ? r.headers : void 0,
+      query: e.captureQueries ? r.query : void 0,
+      body: e.captureQueries ? r.body : void 0
+    };
+  }
+  function d(r, e) {
+    return e ? e.some((t) => new RegExp(t).test(r)) : !1;
+  }
+  function f(r, e) {
+    return e ? e.some((t) => {
+      const o = new RegExp(t);
+      return o.test(r.name) || o.test(r.message);
+    }) : !1;
+  }
+});
+export default g();

package/dist/types/index.d.ts

@@ -0,0 +1,30 @@
+import type { ClientConfig, ErrorTrackerClient } from '@royaltics/tracker';
+export interface SailsErrorTrackerConfig extends Omit<ClientConfig, 'platform' | 'app'> {
+    readonly captureRoutes?: boolean;
+    readonly captureQueries?: boolean;
+    readonly captureHeaders?: boolean;
+    readonly ignoredRoutes?: readonly string[];
+    readonly ignoredErrors?: readonly string[];
+}
+export interface SailsHookContext {
+    readonly sails: {
+        readonly config: {
+            readonly tracker: SailsErrorTrackerConfig;
+        };
+        readonly log: {
+            error: (message: string, ...args: unknown[]) => void;
+            warn: (message: string, ...args: unknown[]) => void;
+            info: (message: string, ...args: unknown[]) => void;
+        };
+        on?: (event: string, handler: (...args: any[]) => void) => void;
+        tracker?: ErrorTrackerClient;
+    };
+}
+export interface RequestContext {
+    readonly method: string;
+    readonly url: string;
+    readonly ip?: string;
+    readonly headers?: Record<string, string>;
+    readonly query?: Record<string, unknown>;
+    readonly body?: Record<string, unknown>;
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@royaltics/tracker-sails",
+  "version": "0.0.1",
+  "description": "Sails.js hook for Royaltics Error Tracker",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage",
+    "prepublishOnly": "npm run build",
+    "publish": "npm publish"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/royaltics-solutions/royaltics-solutions-tracker"
+  },
+  "keywords": [
+    "sails",
+    "sailsjs",
+    "tracker",
+    "monitoring",
+    "logging"
+  ],
+  "sails": {
+    "isHook": true
+  },
+  "peerDependencies": {
+    "sails": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@vitest/coverage-v8": "^1.0.0",
+    "typescript": "^5.0.0",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.0.0",
+    "vitest": "^1.0.0"
+  },
+  "dependencies": {
+    "@royaltics/tracker": "^0.0.3"
+  }
+}