@kivia/sdk 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # Kivia TypeScript SDK
 
-The Kivia TypeScript SDK is the official Node.js client for the Kivia observability platform. It allows Node.js developers using Express or Fastify to instantly track API request metrics, response times, and paths.
+The Kivia TypeScript SDK is the official Node.js client for the Kivia observability platform. It allows Node.js developers using Express, Fastify, or Hono to instantly track API request metrics, response times, and paths.
 
 ## Installation
 
@@ -76,3 +76,22 @@ fastify.get('/hello', async (request, reply) => {
 
 fastify.listen({ port: 3000 });
 ```
+
+## Quick Start (with Hono)
+
+```typescript
+import { Hono } from 'hono';
+import { kiviaHonoMiddleware } from '@kivia/sdk';
+
+const app = new Hono();
+
+app.use('*', kiviaHonoMiddleware({
+  apiKey: 'YOUR_KIVIA_API_KEY',
+}));
+
+app.get('/hello', (c) => {
+  return c.json({ message: 'Hello from Kivia TS SDK using Hono!' });
+});
+
+export default app;
+```

package/dist/client.d.ts

@@ -1,17 +1,23 @@
-import { DynoClientOptions } from './types';
-export declare class DynoClient {
+import { KiviaClientOptions } from './types';
+export declare class KiviaClient {
     private apiKey;
     private baseUrl;
-    constructor(options: DynoClientOptions);
+    constructor(options: KiviaClientOptions);
     /**
      * Express/Connect middleware for automatically logging requests.
      */
     logMiddleware(): (req: any, res: any, next: any) => void;
     /**
      * Fastify hook variant to be used with the 'onResponse' lifecycle hook.
-     * Usage: fastify.addHook('onResponse', dynoClient.logFastifyOnResponse());
+     * Usage: fastify.addHook('onResponse', kiviaClient.logFastifyOnResponse());
      */
     logFastifyOnResponse(): (request: any, reply: any) => Promise<void>;
+    /**
+     * Hono middleware for automatically logging requests.
+     *
+     * Usage with Hono:
+     *   app.use('*', kiviaClient.logHono());
+     */
+    logHono(): (c: any, next: any) => Promise<void>;
     private sendLog;
 }
-//# sourceMappingURL=client.d.ts.map

package/dist/client.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DynoClient = void 0;
-class DynoClient {
+exports.KiviaClient = void 0;
+class KiviaClient {
     constructor(options) {
         this.apiKey = options.apiKey;
         this.baseUrl = options.baseUrl || 'https://nginx-production-a9aa.up.railway.app/api/v1';
@@ -30,7 +30,7 @@ class DynoClient {
     }
     /**
      * Fastify hook variant to be used with the 'onResponse' lifecycle hook.
-     * Usage: fastify.addHook('onResponse', dynoClient.logFastifyOnResponse());
+     * Usage: fastify.addHook('onResponse', kiviaClient.logFastifyOnResponse());
      */
     logFastifyOnResponse() {
         return async (request, reply) => {
@@ -47,25 +47,49 @@ class DynoClient {
             this.sendLog(logEntry);
         };
     }
+    /**
+     * Hono middleware for automatically logging requests.
+     *
+     * Usage with Hono:
+     *   app.use('*', kiviaClient.logHono());
+     */
+    logHono() {
+        return async (c, next) => {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const start = Date.now();
+            await next();
+            const latency = Date.now() - start;
+            const logEntry = {
+                path: c.req.path || c.req.url,
+                status: c.res.status,
+                ip_address: ((_b = (_a = c.req).header) === null || _b === void 0 ? void 0 : _b.call(_a, 'x-forwarded-for')) ||
+                    ((_d = (_c = c.req).header) === null || _d === void 0 ? void 0 : _d.call(_c, 'x-real-ip')) ||
+                    ((_f = (_e = c.req.raw) === null || _e === void 0 ? void 0 : _e.headers) === null || _f === void 0 ? void 0 : _f['x-forwarded-for']) ||
+                    ((_h = (_g = c.req.raw) === null || _g === void 0 ? void 0 : _g.socket) === null || _h === void 0 ? void 0 : _h.remoteAddress),
+                timestamp: new Date().toISOString(),
+                latency,
+            };
+            this.sendLog(logEntry);
+        };
+    }
     async sendLog(logEntry) {
         try {
             const response = await fetch(`${this.baseUrl}/logs/create`, {
                 method: 'POST',
                 headers: {
                     'Content-Type': 'application/json',
-                    'X-dyno-api-key': this.apiKey,
+                    'X-kivia-api-key': this.apiKey,
                 },
                 body: JSON.stringify(logEntry),
             });
             if (!response.ok) {
                 const errBody = await response.text();
-                console.error(`dynosdk: log rejected (${response.status}): ${errBody}`);
+                console.error(`kiviasdk: log rejected (${response.status}): ${errBody}`);
             }
         }
         catch (error) {
-            console.error('dynosdk: failed to send log:', error);
+            console.error('kiviasdk: failed to send log:', error);
         }
     }
 }
-exports.DynoClient = DynoClient;
-//# sourceMappingURL=client.js.map
+exports.KiviaClient = KiviaClient;

package/dist/fastify.d.ts

@@ -1,7 +1,6 @@
-import { DynoClientOptions } from './types';
+import { KiviaClientOptions } from './types';
 /**
- * Fastify plugin for Dyno observability.
- * Usage: fastify.register(dynoFastifyPlugin, { apiKey: '...' })
+ * Fastify plugin for Kivia observability.
+ * Usage: fastify.register(kiviaFastifyPlugin, { apiKey: '...' })
  */
-export declare function dynoFastifyPlugin(fastify: any, options: DynoClientOptions): Promise<void>;
-//# sourceMappingURL=fastify.d.ts.map
+export declare function kiviaFastifyPlugin(fastify: any, options: KiviaClientOptions): Promise<void>;

package/dist/fastify.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dynoFastifyPlugin = dynoFastifyPlugin;
+exports.kiviaFastifyPlugin = kiviaFastifyPlugin;
 const client_1 = require("./client");
 /**
- * Fastify plugin for Dyno observability.
- * Usage: fastify.register(dynoFastifyPlugin, { apiKey: '...' })
+ * Fastify plugin for Kivia observability.
+ * Usage: fastify.register(kiviaFastifyPlugin, { apiKey: '...' })
  */
-async function dynoFastifyPlugin(fastify, options) {
-    const client = new client_1.DynoClient(options);
+async function kiviaFastifyPlugin(fastify, options) {
+    const client = new client_1.KiviaClient(options);
     fastify.addHook('onResponse', client.logFastifyOnResponse());
 }
-//# sourceMappingURL=fastify.js.map

package/dist/hono.d.ts

@@ -0,0 +1,12 @@
+import { KiviaClientOptions } from './types';
+/**
+ * Hono middleware factory for Kivia observability.
+ *
+ * Usage:
+ *   import { Hono } from 'hono';
+ *   import { kiviaHonoMiddleware } from '@kivia/sdk';
+ *
+ *   const app = new Hono();
+ *   app.use('*', kiviaHonoMiddleware({ apiKey: 'YOUR_KIVIA_API_KEY' }));
+ */
+export declare function kiviaHonoMiddleware(options: KiviaClientOptions): (c: any, next: any) => Promise<void>;

package/dist/hono.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kiviaHonoMiddleware = kiviaHonoMiddleware;
+const client_1 = require("./client");
+/**
+ * Hono middleware factory for Kivia observability.
+ *
+ * Usage:
+ *   import { Hono } from 'hono';
+ *   import { kiviaHonoMiddleware } from '@kivia/sdk';
+ *
+ *   const app = new Hono();
+ *   app.use('*', kiviaHonoMiddleware({ apiKey: 'YOUR_KIVIA_API_KEY' }));
+ */
+function kiviaHonoMiddleware(options) {
+    const client = new client_1.KiviaClient(options);
+    return client.logHono();
+}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from './types';
 export * from './client';
 export * from './fastify';
-//# sourceMappingURL=index.d.ts.map
+export * from './hono';

package/dist/index.js

@@ -17,4 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);
 __exportStar(require("./fastify"), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require("./hono"), exports);

package/dist/types.d.ts

@@ -6,11 +6,10 @@ export interface Log {
     timestamp: string;
     latency: number;
 }
-export interface DynoClientOptions {
+export interface KiviaClientOptions {
     apiKey: string;
     /**
      * Override the default production base URL.
      */
     baseUrl?: string;
 }
-//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/package.json

@@ -1,6 +1,5 @@
 {
   "name": "@kivia/sdk",
-  "version": "0.1.0",
   "description": "TypeScript SDK for the Kivia API observability platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,9 +14,18 @@
     "sdk"
   ],
   "author": "winnerx0",
+  "repository": {
+    "url": "https://github.com/kivia-observe/kivia-sdk-js"
+  },
   "license": "MIT",
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "package.json"
+  ],
   "devDependencies": {
     "@types/node": "^25.5.2",
     "typescript": "^5.4.0"
-  }
+  },
+  "version": "0.1.2"
 }

package/.github/workflows/release.yml

@@ -1,28 +0,0 @@
-name: release
-
-on:
-    push:
-        tags:
-            - "v*"
-
-jobs:
-    publish:
-        runs-on: ubuntu-latest
-        permissions:
-            contents: write
-            id-token: write
-        steps:
-            - uses: actions/checkout@v4
-            - uses: actions/setup-node@v4
-              with:
-                  node-version: "22"
-                  registry-url: "https://registry.npmjs.org"
-            - run: npm ci
-            - run: npm run build
-            - run: npm publish --provenance --access public
-              env:
-                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-            - name: Create GitHub Release
-              uses: softprops/action-gh-release@v2
-              with:
-                  generate_release_notes: true

package/dist/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAO,MAAM,SAAS,CAAC;AAEjD,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;gBAEZ,OAAO,EAAE,iBAAiB;IAKtC;;OAEG;IACI,aAAa,KACV,KAAK,GAAG,EAAE,KAAK,GAAG,EAAE,MAAM,GAAG;IAsBvC;;;OAGG;IACI,oBAAoB,KACX,SAAS,GAAG,EAAE,OAAO,GAAG;YAgB1B,OAAO;CAmBtB"}

package/dist/client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IAIrB,YAAY,OAA0B;QACpC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,qDAAqD,CAAC;IAC1F,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,OAAO,CAAC,GAAQ,EAAE,GAAQ,EAAE,IAAS,EAAE,EAAE;YACvC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAEzB,oCAAoC;YACpC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;;gBACpB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;gBAEnC,MAAM,QAAQ,GAAQ;oBACpB,IAAI,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG;oBAChC,MAAM,EAAE,GAAG,CAAC,UAAU;oBACtB,UAAU,EAAE,GAAG,CAAC,EAAE,KAAI,MAAA,GAAG,CAAC,UAAU,0CAAE,aAAa,CAAA;oBACnD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;oBACnC,OAAO;iBACR,CAAC;gBAEF,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;YAEH,IAAI,EAAE,CAAC;QACT,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,oBAAoB;QACzB,OAAO,KAAK,EAAE,OAAY,EAAE,KAAU,EAAE,EAAE;;YACxC,uEAAuE;YACvE,MAAM,OAAO,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAEpE,MAAM,QAAQ,GAAQ;gBACpB,IAAI,EAAE,OAAO,CAAC,GAAG,KAAI,MAAA,OAAO,CAAC,GAAG,0CAAE,GAAG,CAAA;gBACrC,MAAM,EAAE,KAAK,CAAC,UAAU,KAAI,MAAA,KAAK,CAAC,GAAG,0CAAE,UAAU,CAAA;gBACjD,UAAU,EAAE,OAAO,CAAC,EAAE,KAAI,MAAA,MAAA,OAAO,CAAC,GAAG,0CAAE,UAAU,0CAAE,aAAa,CAAA;gBAChE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;aAC7B,CAAC;YAEF,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,QAAa;QACjC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,cAAc,EAAE;gBAC1D,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,gBAAgB,EAAE,IAAI,CAAC,MAAM;iBAC9B;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;aAC/B,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACtC,OAAO,CAAC,KAAK,CAAC,0BAA0B,QAAQ,CAAC,MAAM,MAAM,OAAO,EAAE,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;CACF;AA3ED,gCA2EC"}

package/dist/fastify.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fastify.d.ts","sourceRoot":"","sources":["../src/fastify.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5C;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB,iBAG/E"}

package/dist/fastify.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fastify.js","sourceRoot":"","sources":["../src/fastify.ts"],"names":[],"mappings":";;AAOA,8CAGC;AAVD,qCAAsC;AAGtC;;;GAGG;AACI,KAAK,UAAU,iBAAiB,CAAC,OAAY,EAAE,OAA0B;IAC9E,MAAM,MAAM,GAAG,IAAI,mBAAU,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC;AAC/D,CAAC"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,2CAAyB;AACzB,4CAA0B"}

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/src/client.ts

@@ -1,78 +0,0 @@
-import { KiviaClientOptions, Log } from './types';
-
-export class KiviaClient {
-  private apiKey: string;
-  private baseUrl: string;
-
-  constructor(options: KiviaClientOptions) {
-    this.apiKey = options.apiKey;
-    this.baseUrl = options.baseUrl || 'https://nginx-production-a9aa.up.railway.app/api/v1';
-  }
-
-  /**
-   * Express/Connect middleware for automatically logging requests.
-   */
-  public logMiddleware() {
-    return (req: any, res: any, next: any) => {
-      const start = Date.now();
-
-      // Listen for the response to finish
-      res.on('finish', () => {
-        const latency = Date.now() - start;
-
-        const logEntry: Log = {
-          path: req.originalUrl || req.url,
-          status: res.statusCode,
-          ip_address: req.ip || req.connection?.remoteAddress,
-          timestamp: new Date().toISOString(),
-          latency,
-        };
-
-        this.sendLog(logEntry);
-      });
-
-      next();
-    };
-  }
-
-  /**
-   * Fastify hook variant to be used with the 'onResponse' lifecycle hook.
-   * Usage: fastify.addHook('onResponse', kiviaClient.logFastifyOnResponse());
-   */
-  public logFastifyOnResponse() {
-    return async (request: any, reply: any) => {
-      // reply.getResponseTime() is available in Fastify to get latency in ms
-      const latency = reply.getResponseTime ? reply.getResponseTime() : 0;
-
-      const logEntry: Log = {
-        path: request.url || request.raw?.url,
-        status: reply.statusCode || reply.raw?.statusCode,
-        ip_address: request.ip || request.raw?.connection?.remoteAddress,
-        timestamp: new Date().toISOString(),
-        latency: Math.round(latency),
-      };
-
-      this.sendLog(logEntry);
-    };
-  }
-
-  private async sendLog(logEntry: Log): Promise<void> {
-    try {
-      const response = await fetch(`${this.baseUrl}/logs/create`, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/json',
-          'X-kivia-api-key': this.apiKey,
-        },
-        body: JSON.stringify(logEntry),
-      });
-
-      if (!response.ok) {
-        const errBody = await response.text();
-        console.error(`kiviasdk: log rejected (${response.status}): ${errBody}`);
-      }
-    } catch (error) {
-      console.error('kiviasdk: failed to send log:', error);
-    }
-  }
-}

package/src/fastify.ts

@@ -1,11 +0,0 @@
-import { KiviaClient } from './client';
-import { KiviaClientOptions } from './types';
-
-/**
- * Fastify plugin for Kivia observability.
- * Usage: fastify.register(kiviaFastifyPlugin, { apiKey: '...' })
- */
-export async function kiviaFastifyPlugin(fastify: any, options: KiviaClientOptions) {
-  const client = new KiviaClient(options);
-  fastify.addHook('onResponse', client.logFastifyOnResponse());
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './types';
-export * from './client';
-export * from './fastify';

package/src/types.ts

@@ -1,16 +0,0 @@
-export interface Log {
-  id?: string;
-  path: string;
-  status: number;
-  ip_address?: string;
-  timestamp: string; // ISO 8601
-  latency: number; // milliseconds
-}
-
-export interface KiviaClientOptions {
-  apiKey: string;
-  /**
-   * Override the default production base URL.
-   */
-  baseUrl?: string;
-}

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2018",
-    "module": "commonjs",
-    "lib": ["ES2022", "DOM"],
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}