@concordiq/error-sdk 1.0.4 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@concordiq/error-sdk",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "private": false,
   "description": "Error monitoring SDK",
   "type": "module",

package/readMe.md

@@ -69,6 +69,157 @@ app.use(ErrorSDK.expressMiddleware());
 
 
 
+✅ Default Import (Most Common)
+import ErrorSDK from "@concordiq/error-sdk";
+
+
+ErrorSDK.init({...});
+
+
+
+✅ Named Import (Tree-shaking)
+import { init, capture } from "@concordiq/error-sdk";
+
+init({...});
+
+
+
+✅ CommonJS
+const ErrorSDK = require("@concordiq/error-sdk");
+
+
+
+✅ Dynamic Import
+const sdk = await import("@concordiq/error-sdk");
+
+
+
+
+#
+import express, {
+  Request,
+  Response,
+  NextFunction
+} from "express";
+
+
+
+import ErrorSDK from "@concordiq/error-sdk";
+
+const app = express();
+
+/**
+ * Initialize once (on app startup)
+ */
+
+
+ErrorSDK.init({
+  apiKey: "coiq-6ddfeede1d57a268f7131ef0597624200a8a02b7",
+
+  endpoint: "https://concordiq.onrender.com/api/v1/ingest/events",
+
+  env: "production",
+
+  service: "payment-api"
+});
+
+
+/**
+ * Express error handler (optional custom)
+ */
+
+
+export function expressHandler() {
+  return (
+    err: Error,
+    req: Request,
+    res: Response,
+    next: NextFunction
+  ) => {
+    ErrorSDK.capture(err, {
+      url: req.originalUrl,
+      method: req.method,
+      user: (req as any).user?.id
+    });
+
+    next(err);
+  };
+}
+
+/**
+ * Register middleware (MUST be last)
+ */
+
+
+app.use(ErrorSDK.expressMiddleware());
+
+console.log("ErrorSDK loaded:", ErrorSDK);
+#
+
+
+
+`✅ Basic Usage in a Controller/Services (Recommended Way):`
+``using this SDK inside controllers/services is actually the best practice, especially for business-logic errors.``
+
+import { Request, Response, NextFunction } from "express";
+import ErrorSDK from "@concordiq/error-sdk";
+
+export const createPayment = async (
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  try {
+    // Your logic
+    const { amount } = req.body;
+
+    if (!amount) {
+      throw new Error("Amount is required");
+    }
+
+    // Simulate error
+    if (amount < 100) {
+      throw new Error("Minimum payment is 100");
+    }
+
+    res.status(201).json({
+      success: true,
+      message: "Payment created"
+    });
+
+  } catch (err) {
+    /**
+     * Capture error manually
+     */
+    ErrorSDK.capture(err as Error, {
+      controller: "createPayment",
+      user: (req as any).user?.id,
+      body: req.body
+    });
+
+    /**
+     * Pass to global handler
+     */
+    next(err);
+  }
+};
+
+
+`✅ Why This SDK Is Best for you:`
+
+`This gives you:`
+
+`✔ Controller name`
+`✔ User info`
+`✔ Request data`
+`✔ Business context`
+`✔ Stack trace`
+`✔ Global error handling`
+
+`Your dashboard becomes very useful.`
+
+
+
 ## Features:
 
 1. Manual error tracking