@jitar-plugins/database 0.0.1

package/README.md

@@ -0,0 +1,45 @@
+
+# Database | Jitar Plugins
+
+This package provides plugins for integrating the [The Shelf database package](https://github.com/MaskingTechnology/theshelf/tree/main/packages/database) in Jitar applications.
+
+It contains a single health check for checking the database health.
+
+## Installation
+
+```bash
+npm install @theshelf/database @jitar-plugins/database
+```
+
+## Usage
+
+Follow the following steps to configure and use the provided health check.
+
+### Step 1 - Configure the health check
+
+```ts
+// src/health/databaseHealthCheck.ts
+
+import database from '@theshelf/database';
+import { DatabaseHealthCheck } from '@jitar-plugins/database';
+
+export default new DatabaseHealthCheck(database);
+```
+
+### Step 2 - Activate the health check
+
+With the health check in place, it needs to be activated by registering it to the worker / standalone service.
+
+```json
+/* services/some-worker.json */
+{
+    "url": "http://example.com:3000",
+    "healthChecks": [ /* add health checks here */
+        "./health/databaseHealthCheck"
+    ],
+    "worker":
+    {
+        /* service configuration */
+    }
+}
+```

package/dist/DatabaseHealthCheck.d.ts

@@ -0,0 +1,9 @@
+import type { HealthCheck } from 'jitar';
+import type { Database } from '@theshelf/database';
+export default class DatabaseHealthCheck implements HealthCheck {
+    #private;
+    constructor(database: Database);
+    get name(): string;
+    get timeout(): number;
+    isHealthy(): Promise<boolean>;
+}

package/dist/DatabaseHealthCheck.js

@@ -0,0 +1,13 @@
+export default class DatabaseHealthCheck {
+    #database;
+    #name = 'database';
+    #timeout = 5000;
+    constructor(database) {
+        this.#database = database;
+    }
+    get name() { return this.#name; }
+    get timeout() { return this.#timeout; }
+    async isHealthy() {
+        return this.#database.connected;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { default as DatabaseHealthCheck } from './DatabaseHealthCheck';

package/dist/index.js

@@ -0,0 +1 @@
+export { default as DatabaseHealthCheck } from './DatabaseHealthCheck';

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@jitar-plugins/database",
+  "private": false,
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "lint": "eslint",
+    "review": "npm run build && npm run lint",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
+  "exports": "./dist/index.js",
+  "peerDependencies": {
+    "@theshelf/database": "^0.0.2",
+    "jitar": "^0.10.3"
+  }
+}