@concordiq/error-sdk 1.0.0 → 1.0.2

package/package.json

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

package/readMe.md

@@ -1,65 +1,79 @@
-npm install @concordiq/error-sdk
-
-
-`Controller`
-import ErrorSDK from "@arosebine/error-sdk";
-
-ErrorSDK.init({
-  Authorization: "Bearer coiq-6ddfeede1d57a268f7131ef0597624200a8a02b7",
-
-  endpoint: "https://concordiq.onrender.com/api/v1/ingest/events",
-
-  env: "production",
-
-  service: "payment-api"
-});
-
-
-`
-try {
-  processPayment();
-} catch (err) {
-  ErrorSDK.capture(err, {
-    message: err.message,
-    stack: err.stack,
-    type: "crash"
-  });
-}
-`
-
-
-`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
-
-
-
-`To Test it Locally`
-import ErrorSDK from "./src/index.js";
-
-ErrorSDK.init({
-  apiKey: "test123",
-  endpoint: "http://localhost:4000/ingest"
-});
-
-throw new Error("Test Crash");
-
+# @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:
+```
+
+import ErrorSDK from "@concordiq/error-sdk";
+
+ErrorSDK.init({
+  apiKey: "PROJECT_API_KEY",
+
+  endpoint: "https://api.mysaas.com/ingest",
+
+  env: "production",
+
+  service: "payment-api"
+});
+
+
+
+## Manual Error Capture
+
+Use inside controllers or services:
+
+---
+try {
+  processPayment();
+} catch (err) {
+  ErrorSDK.capture(err, {
+    userId: 22,
+    orderId: 991
+  });
+}
+
+
+
+
+## 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");
+});
+
+/**
+ * Must be last middleware
+ */
+app.use(ErrorSDK.expressMiddleware());
+
+
+
+## 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) {
-  try {
-    await fetch(url, {
-      method: "POST",
-
-      headers: {
-        "Content-Type": "application/json",
-        "x-api-key": apiKey
-      },
-
-      body: JSON.stringify(payload)
-    });
-  } catch (err) {
-    // Never crash client app
-    console.error("SDK Send Failed:", err.message);
-  }
-}
+import fetch from "node-fetch";
+
+/**
+ * Send error to ConcordIQ API
+ */
+export async function sendError(apiKey, endpoint, payload) {
+  try {
+    await fetch(endpoint, {
+      method: "POST",
+
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: apiKey
+      },
+
+      body: JSON.stringify(payload)
+    });
+  } catch (err) {
+    // 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);
-  });
-
-  // Crash errors
-  process.on("uncaughtException", err => {
-    report(err, config);
-  });
-}
-
-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
-  );
-}
+import { capture } from "./index.js";
+
+/**
+ * Attach process-level handlers
+ */
+export function attachHandlers() {
+  process.on("uncaughtException", (err) => {
+    capture(err);
+  });
+
+  process.on("unhandledRejection", (err) => {
+    capture(err);
+  });
+}

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,57 +1,72 @@
-import { attachHandlers } from "./handlers.js";
-import { sendError } from "./client.js";
-import { getMeta } from "./utils.js";
-
-let config = null;
-
-function init(options) {
-  if (!options.apiKey) {
-    throw new Error("apiKey required");
-  }
-
-  config = {
-    apiKey: options.apiKey,
-
-    endpoint:
-      options.endpoint ||
-      "https://api.yoursaas.com/ingest",
-
-    env: options.env || "production",
-
-    service: options.service || "app"
-  };
-
-  attachHandlers(config);
-}
-
-async function capture(error, extra = {}) {
-  if (!config) return;
-
-  const payload = {
-    message: error.message || error,
-    stack: error.stack,
-
-    type: "manual",
-
-    env: config.env,
-    service: config.service,
-
-    meta: {
-      ...getMeta(),
-      ...extra
-    },
-
-    timestamp: new Date()
-  };
-
-  await sendError(
-    config.apiKey,
-    config.endpoint,
-    payload
-  );
-}
-
-export default {
-  init,
-  capture
-};
+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 is required");
+  }
+
+  config = {
+    apiKey: options.apiKey,
+
+    endpoint:
+      options.endpoint ||
+      "https://concordiq.onrender.com/api/v1/ingest/events",
+
+    env: options.env || "production",
+
+    service: options.service || "app"
+  };
+
+  attachHandlers(config);
+}
+
+/**
+ * Capture error manually
+ */
+async function capture(error, extra = {}) {
+  if (!config) return;
+
+  const payload = {
+    message: error?.message || String(error),
+
+    stack: error?.stack,
+
+    type: "manual",
+
+    env: config.env,
+    service: config.service,
+
+    meta: {
+      ...getMeta(),
+      ...extra
+    },
+
+    timestamp: new Date().toISOString()
+  };
+
+  await sendError(
+    config.apiKey,
+    config.endpoint,
+    payload
+  );
+}
+
+export {
+  init,
+  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";
-
-export function getMeta() {
-  return {
-    host: os.hostname(),
-    platform: process.platform,
-    memory: process.memoryUsage().rss
-  };
-}
+import os from "os";
+
+/**
+ * Collect runtime metadata
+ */
+export function getMeta() {
+  return {
+    platform: os.platform() || process.platform,
+    arch: os.arch(),
+    nodeVersion: process.version,
+    hostname: os.hostname(),
+    memory: process.memoryUsage().rss
+  };
+}