oniaz-logging-system-sdk 1.0.0

package/README.md

@@ -0,0 +1,36 @@
+# Oniaz Logging System SDK
+
+Use this package from a backend application to send logs to the Logging System API.
+
+## Install
+
+```bash
+npm install oniaz-logging-system-sdk
+```
+
+## Usage
+
+```js
+import loggingSdk from "oniaz-logging-system-sdk";
+
+loggingSdk.init(
+  "your-api-key",
+  "your-application-name"
+);
+
+await loggingSdk.log({
+  message: "User signed in successfully",
+  level: "INFO",
+});
+```
+
+## Notes
+
+- `init(apiKey, applicationName)` stores the API key and application name for later requests.
+- `log(data)` sends a `POST /api/applications/:name/logs` request with `message` and `level` in the body, plus the API key in the `x-api-key` header.
+- The server validates that the API key owner also owns the application before accepting the log.
+- The SDK always sends logs to `https://oniaz-logging-system-api.vercel.app`.
+
+## API Endpoint
+
+This SDK sends logs to `https://oniaz-logging-system-api.vercel.app`.

package/index.d.ts

@@ -0,0 +1,32 @@
+export interface InitOptions {
+  fetchImpl?: typeof fetch;
+}
+
+export interface LogData {
+  message: string;
+  level: string;
+}
+
+export interface LogResponse {
+  message?: string;
+  log?: {
+    id: string;
+    applicationName: string;
+    message: string;
+    level: string;
+    count: number;
+    createdAt: string;
+    updatedAt: string;
+  };
+}
+
+export interface LogSdk {
+  init(apiKey: string, applicationName: string, options?: InitOptions): LogSdk;
+  log(logData: LogData): Promise<LogResponse | string | null>;
+}
+
+export declare const init: LogSdk["init"];
+export declare const log: LogSdk["log"];
+
+declare const api: LogSdk;
+export default api;

package/index.js

@@ -0,0 +1,105 @@
+const API_BASE_URL = "https://oniaz-logging-system-api.vercel.app";
+
+const state = {
+  apiKey: null,
+  applicationName: null,
+  fetchImpl: globalThis.fetch?.bind(globalThis) || null,
+};
+
+function assertInitialized() {
+  if (!state.apiKey || !state.applicationName) {
+    throw new Error("SDK not initialized. Call init(apiKey, applicationName) before log().");
+  }
+
+  if (!state.fetchImpl) {
+    throw new Error("No fetch implementation available. Provide one through init(..., { fetchImpl }).");
+  }
+}
+
+function buildLogUrl() {
+  return new URL(`/api/applications/${encodeURIComponent(state.applicationName)}/logs`, API_BASE_URL).toString();
+}
+
+function parseResponseBody(bodyText) {
+  if (!bodyText) {
+    return null;
+  }
+
+  try {
+    return JSON.parse(bodyText);
+  } catch {
+    return bodyText;
+  }
+}
+
+export function init(apiKey, applicationName, options = {}) {
+  if (!apiKey || typeof apiKey !== "string") {
+    throw new Error("A valid apiKey is required.");
+  }
+
+  if (!applicationName || typeof applicationName !== "string") {
+    throw new Error("A valid applicationName is required.");
+  }
+
+  state.apiKey = apiKey.trim();
+  state.applicationName = applicationName.trim();
+  state.fetchImpl = options.fetchImpl || globalThis.fetch?.bind(globalThis) || null;
+
+  return api;
+}
+
+export async function log(logData) {
+  assertInitialized();
+
+  if (!logData || typeof logData !== "object" || Array.isArray(logData)) {
+    throw new Error("log() expects a log data object.");
+  }
+
+  const payload = { ...logData };
+  const allowedKeys = ["message", "level"];
+
+  for (const key of Object.keys(payload)) {
+    if (!allowedKeys.includes(key)) {
+      throw new Error("log() only accepts message and level.");
+    }
+  }
+
+  if (typeof payload.message !== "string" || !payload.message.trim()) {
+    throw new Error("log() requires a non-empty message.");
+  }
+
+  if (typeof payload.level !== "string" || !payload.level.trim()) {
+    throw new Error("log() requires a non-empty level.");
+  }
+
+  payload.message = payload.message.trim();
+  payload.level = payload.level.trim().toUpperCase();
+
+  const response = await state.fetchImpl(buildLogUrl(), {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+      "x-api-key": state.apiKey,
+    },
+    body: JSON.stringify(payload),
+  });
+
+  const bodyText = await response.text();
+  const body = parseResponseBody(bodyText);
+
+  if (!response.ok) {
+    const error = new Error(body?.message || `Log request failed with status ${response.status}.`);
+    error.status = response.status;
+    error.response = body;
+    throw error;
+  }
+
+  return body;
+}
+
+const api = {
+  init,
+  log,
+};
+
+export default api;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "oniaz-logging-system-sdk",
+  "version": "1.0.0",
+  "description": "Server SDK for sending logs to the Logging System API.",
+  "type": "module",
+  "main": "./index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "logging",
+    "sdk",
+    "server",
+    "api"
+  ],
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  }
+}