@concordiq/error-sdk 1.0.0 → 1.0.1

package/package.json

@@ -1,10 +1,31 @@
 {
   "name": "@concordiq/error-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
+  "private": false,
   "description": "Error monitoring SDK",
-  "main": "src/index.js",
   "type": "module",
-  "keywords": ["errors", "monitoring", "logging"],
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "keywords": [
+    "errors",
+    "monitoring",
+    "logging"
+  ],
   "author": "Arowolo",
-  "license": "MIT"
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "types": "./src/index.d.ts"
+    }
+  },
+  "files": [
+    "src"
+  ],
+  "dependencies": {
+    "node-fetch": "^3.3.2"
+  },
+  "peerDependencies": {
+    "express": "^4 || ^5"
+  }
 }

package/readMe.md

@@ -1,13 +1,27 @@
+# @concordiq/error-sdk
+
+Official ConcordIQ Error Tracking SDK for Node.js and Express.
+
+---
+
+## Installation
+
+```bash
 npm install @concordiq/error-sdk
 
+```
+## Initialization
+
+```javascript and typescript
+Initialize once when your app starts:
+```
 
-`Controller`
-import ErrorSDK from "@arosebine/error-sdk";
+import ErrorSDK from "@concordiq/error-sdk";
 
 ErrorSDK.init({
-  Authorization: "Bearer coiq-6ddfeede1d57a268f7131ef0597624200a8a02b7",
+  apiKey: "PROJECT_API_KEY",
 
-  endpoint: "https://concordiq.onrender.com/api/v1/ingest/events",
+  endpoint: "https://api.mysaas.com/ingest",
 
   env: "production",
 
@@ -15,51 +29,51 @@ ErrorSDK.init({
 });
 
 
-`
+
+## Manual Error Capture
+
+Use inside controllers or services:
+
+---
 try {
   processPayment();
 } catch (err) {
   ErrorSDK.capture(err, {
-    message: err.message,
-    stack: err.stack,
-    type: "crash"
+    userId: 22,
+    orderId: 991
   });
 }
-`
-
-
-`Express.Js `
-export function expressHandler() {
-  return (err, req, res, next) => {
-    import("./index.js").then(sdk => {
-      sdk.default.capture(err, {
-        url: req.originalUrl,
-        method: req.method,
-        user: req.user?.id
-      });
-    });
-
-    next(err);
-  };
-}
 
-app.use(ErrorSDK.expressMiddleware());
 
 
 
-`To publish it`
-npm login
-npm publish --access public
+## Express.js Integration
 
+Automatically capture all server errors.
+import express from "express";
+import ErrorSDK from "@concordiq/error-sdk";
+----
+const app = express();
 
+app.use("/pay", (req, res) => {
+  throw new Error("Payment failed");
+});
 
-`To Test it Locally`
-import ErrorSDK from "./src/index.js";
+/**
+ * Must be last middleware
+ */
+app.use(ErrorSDK.expressMiddleware());
 
-ErrorSDK.init({
-  apiKey: "test123",
-  endpoint: "http://localhost:4000/ingest"
-});
 
-throw new Error("Test Crash");
 
+## Features:
+
+1. Manual error tracking
+
+2. Express middleware
+
+3. Global crash handling
+
+4. TypeScript support
+
+5. Lightweight

package/src/client.js

@@ -1,19 +1,22 @@
 import fetch from "node-fetch";
 
-export async function sendError(apiKey, url, payload) {
+/**
+ * Send error to ConcordIQ API
+ */
+export async function sendError(apiKey, endpoint, payload) {
   try {
-    await fetch(url, {
+    await fetch(endpoint, {
       method: "POST",
 
       headers: {
         "Content-Type": "application/json",
-        "x-api-key": apiKey
+        Authorization: apiKey
       },
 
       body: JSON.stringify(payload)
     });
   } catch (err) {
-    // Never crash client app
-    console.error("SDK Send Failed:", err.message);
+    // Avoid crashing user app
+    console.error("[ErrorSDK] Failed to send error:", err);
   }
-}
+}

package/src/handlers.js

@@ -1,32 +1,14 @@
-import { sendError } from "./client.js";
-
-export function attachHandlers(config) {
-  // Promise errors
-  process.on("unhandledRejection", err => {
-    report(err, config);
+import { capture } from "./index.js";
+
+/**
+ * Attach process-level handlers
+ */
+export function attachHandlers() {
+  process.on("uncaughtException", (err) => {
+    capture(err);
   });
 
-  // Crash errors
-  process.on("uncaughtException", err => {
-    report(err, config);
+  process.on("unhandledRejection", (err) => {
+    capture(err);
   });
-}
-
-function report(err, config) {
-  const payload = {
-    message: err.message,
-    stack: err.stack,
-    type: "system",
-
-    service: config.service,
-    env: config.env,
-
-    timestamp: new Date()
-  };
-
-  sendError(
-    config.apiKey,
-    config.endpoint,
-    payload
-  );
-}
+}

package/src/index.d.ts

@@ -0,0 +1,30 @@
+import { Request, Response, NextFunction } from "express";
+
+export interface ErrorSDKOptions {
+    apiKey: string;
+    endpoint?: string;
+    env?: string;
+    service?: string;
+}
+
+export function init(options: ErrorSDKOptions): void;
+
+export function capture(
+    error: any,
+    extra?: Record<string, any>
+): Promise<void>;
+
+export function expressMiddleware(): (
+    err: any,
+    req: Request,
+    res: Response,
+    next: NextFunction
+) => void;
+
+declare const ErrorSDK: {
+    init: typeof init;
+    capture: typeof capture;
+    expressMiddleware: typeof expressMiddleware;
+};
+
+export default ErrorSDK;

package/src/index.js

@@ -1,12 +1,16 @@
-import { attachHandlers } from "./handlers.js";
+import { expressMiddleware } from "./middleware.js";
 import { sendError } from "./client.js";
+import { attachHandlers } from "./handlers.js";
 import { getMeta } from "./utils.js";
 
 let config = null;
 
+/**
+ * Initialize SDK
+ */
 function init(options) {
-  if (!options.apiKey) {
-    throw new Error("apiKey required");
+  if (!options?.apiKey) {
+    throw new Error("apiKey is required");
   }
 
   config = {
@@ -14,7 +18,7 @@ function init(options) {
 
     endpoint:
       options.endpoint ||
-      "https://api.yoursaas.com/ingest",
+      "https://concordiq.onrender.com/api/v1/ingest/events",
 
     env: options.env || "production",
 
@@ -24,12 +28,16 @@ function init(options) {
   attachHandlers(config);
 }
 
+/**
+ * Capture error manually
+ */
 async function capture(error, extra = {}) {
   if (!config) return;
 
   const payload = {
-    message: error.message || error,
-    stack: error.stack,
+    message: error?.message || String(error),
+
+    stack: error?.stack,
 
     type: "manual",
 
@@ -41,7 +49,7 @@ async function capture(error, extra = {}) {
       ...extra
     },
 
-    timestamp: new Date()
+    timestamp: new Date().toISOString()
   };
 
   await sendError(
@@ -51,7 +59,14 @@ async function capture(error, extra = {}) {
   );
 }
 
-export default {
+export {
   init,
-  capture
+  capture,
+  expressMiddleware
 };
+
+export default {
+  init,
+  capture,
+  expressMiddleware
+};

package/src/middleware.js

@@ -0,0 +1,16 @@
+import { capture } from "./index.js";
+
+/**
+ * Express error middleware
+ */
+export function expressMiddleware() {
+  return function (err, req, res, next) {
+    capture(err, {
+      url: req.originalUrl,
+      method: req.method,
+      ip: req.ip
+    });
+
+    next(err);
+  };
+}

package/src/utils.js

@@ -1,9 +1,14 @@
 import os from "os";
 
+/**
+ * Collect runtime metadata
+ */
 export function getMeta() {
   return {
-    host: os.hostname(),
-    platform: process.platform,
+    platform: os.platform() || process.platform,
+    arch: os.arch(),
+    nodeVersion: process.version,
+    hostname: os.hostname(),
     memory: process.memoryUsage().rss
   };
-}
+}