@osaas/client-db 0.4.6 → 0.5.0

package/README.md

@@ -15,20 +15,22 @@ npm install --save @osaas/client-db
 Example code creating a Valkey database and use a Redis client to connect with it
 
 ```javascript
-import { Context, Log } from '@osaas/client-core';
-import { ValkeyDb } from '@osaas/client-db';
+import { setupDatabase } from '@osaas/client-db';
 import Redis from 'ioredis';
 
 async function main() {
-  const context = new Context();
+  const dbUrl = await setupDatabase('valkey', 'myvalkey', {
+    password: 'secret'
+  });
+  const client = new Redis(dbUrl);
   try {
-    const db = new ValkeyDb({ context, name: 'mydb' });
-    await db.init();
-    const redisUrl = await db.getRedisUrl();
-
-    const client = new Redis({ host: redisUrl.hostname, port: redisUrl.port });
+    await client.subscribe('messages');
+    console.log('Waiting for messages...');
+    client.on('message', (channel, message) => {
+      console.log(`Received message: ${message} from ${channel}`);
+    });
   } catch (err) {
-    Log().error(err);
+    console.error('Error:', err);
   }
 }
 

package/lib/index.d.ts

@@ -1,3 +1,46 @@
 /** @module @osaas/client-db */
 export { ValkeyDb } from './valkey';
+export type DatabaseType = 'valkey' | 'postgres' | 'mariadb' | 'clickhouse' | 'couchdb';
+export declare const DatabaseTypeToServiceId: Record<DatabaseType, string>;
+export declare const DatabaseTypeToPort: Record<DatabaseType, number>;
+export declare const DatabaseTypeToProtocol: Record<DatabaseType, string>;
+export interface DatabaseOpts {
+    username?: string;
+    password?: string;
+    rootPassword?: string;
+    database?: string;
+}
+/**
+ * @typedef {object} DatabaseOpts
+ * @property {string} [username] - The username for the database
+ * @property {string} [password] - The password for the database
+ * @property {string} [rootPassword] - The root password for the database
+ * @property {string} [database] - The database name
+ */
+/**
+ * Create a database instance if it does not exists
+ * and return the connection URL.
+ *
+ * @param {DatabaseType} type The type of the database.
+ * @param {string} name The name of the database instance.
+ * @param {DatabaseOpts} opts The options for the database.
+ * @returns The connection URL for the database.
+ *
+ * @example
+ * import { setupDatabase } from '@osaas/client-db';
+ * import Redis from 'ioredis';
+ *
+ * const dbUrl = await setupDatabase('valkey', 'myvalkey', { password: 'secret' });
+ * const client = new Redis(dbUrl);
+ * try {
+ *   await client.subscribe('messages');
+ *   console.log('Waiting for messages...');
+ *   client.on('message', (channel, message) => {
+ *     console.log(`Received message: ${message} from ${channel}`);
+ *   });
+ * } catch (err) {
+ *   console.error('Error:', err);
+ * }
+ */
+export declare function setupDatabase(type: DatabaseType, name: string, opts: DatabaseOpts): Promise<string>;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAE/B,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAqB/B,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,UAAU,GACV,SAAS,GACT,YAAY,GACZ,SAAS,CAAC;AAEd,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAMhE,CAAC;AACF,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAM3D,CAAC;AACF,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAM/D,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,mBA+HnB"}

package/lib/index.js

@@ -1,7 +1,175 @@
 "use strict";
 /** @module @osaas/client-db */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValkeyDb = void 0;
+exports.setupDatabase = exports.DatabaseTypeToProtocol = exports.DatabaseTypeToPort = exports.DatabaseTypeToServiceId = exports.ValkeyDb = void 0;
+const client_core_1 = require("@osaas/client-core");
+const client_services_1 = require("@osaas/client-services");
 var valkey_1 = require("./valkey");
 Object.defineProperty(exports, "ValkeyDb", { enumerable: true, get: function () { return valkey_1.ValkeyDb; } });
+exports.DatabaseTypeToServiceId = {
+    valkey: 'valkey-io-valkey',
+    postgres: 'birme-osc-postgresql',
+    mariadb: 'linuxserver-docker-mariadb',
+    clickhouse: 'clickhouse-clickhouse',
+    couchdb: 'apache-couchdb'
+};
+exports.DatabaseTypeToPort = {
+    valkey: 6379,
+    postgres: 5432,
+    mariadb: 3306,
+    clickhouse: 9000,
+    couchdb: 5984
+};
+exports.DatabaseTypeToProtocol = {
+    valkey: 'redis',
+    postgres: 'postgres',
+    mariadb: 'mysql',
+    clickhouse: 'clickhouse',
+    couchdb: 'https'
+};
+/**
+ * @typedef {object} DatabaseOpts
+ * @property {string} [username] - The username for the database
+ * @property {string} [password] - The password for the database
+ * @property {string} [rootPassword] - The root password for the database
+ * @property {string} [database] - The database name
+ */
+/**
+ * Create a database instance if it does not exists
+ * and return the connection URL.
+ *
+ * @param {DatabaseType} type The type of the database.
+ * @param {string} name The name of the database instance.
+ * @param {DatabaseOpts} opts The options for the database.
+ * @returns The connection URL for the database.
+ *
+ * @example
+ * import { setupDatabase } from '@osaas/client-db';
+ * import Redis from 'ioredis';
+ *
+ * const dbUrl = await setupDatabase('valkey', 'myvalkey', { password: 'secret' });
+ * const client = new Redis(dbUrl);
+ * try {
+ *   await client.subscribe('messages');
+ *   console.log('Waiting for messages...');
+ *   client.on('message', (channel, message) => {
+ *     console.log(`Received message: ${message} from ${channel}`);
+ *   });
+ * } catch (err) {
+ *   console.error('Error:', err);
+ * }
+ */
+async function setupDatabase(type, name, opts) {
+    const ctx = new client_core_1.Context();
+    let instance;
+    switch (type) {
+        case 'valkey':
+            instance = await (0, client_services_1.getValkeyIoValkeyInstance)(ctx, name);
+            break;
+        case 'postgres':
+            instance = await (0, client_services_1.getBirmeOscPostgresqlInstance)(ctx, name);
+            break;
+        case 'mariadb':
+            instance = await (0, client_services_1.getLinuxserverDockerMariadbInstance)(ctx, name);
+            break;
+        case 'clickhouse':
+            instance = await (0, client_services_1.getClickhouseClickhouseInstance)(ctx, name);
+            break;
+        case 'couchdb':
+            instance = await (0, client_services_1.getApacheCouchdbInstance)(ctx, name);
+            break;
+        default:
+            throw new Error(`Unsupported database type: ${type}`);
+    }
+    if (!instance) {
+        switch (type) {
+            case 'valkey':
+                {
+                    const options = {
+                        name,
+                        Password: opts.password
+                    };
+                    instance = await (0, client_services_1.createValkeyIoValkeyInstance)(ctx, options);
+                }
+                break;
+            case 'postgres':
+                {
+                    if (!opts.password) {
+                        throw new Error('Password is required for postgres');
+                    }
+                    const options = {
+                        name,
+                        PostgresUser: opts.username,
+                        PostgresPassword: opts.password,
+                        PostgresDb: opts.database
+                    };
+                    instance = await (0, client_services_1.createBirmeOscPostgresqlInstance)(ctx, options);
+                }
+                break;
+            case 'mariadb':
+                {
+                    if (!opts.rootPassword) {
+                        throw new Error('Root password is required for mariadb');
+                    }
+                    const options = {
+                        name,
+                        RootPassword: opts.rootPassword,
+                        Database: opts.database,
+                        User: opts.username,
+                        Password: opts.password
+                    };
+                    instance = await (0, client_services_1.createLinuxserverDockerMariadbInstance)(ctx, options);
+                }
+                break;
+            case 'clickhouse':
+                {
+                    const options = {
+                        name,
+                        Password: opts.password,
+                        User: opts.username,
+                        Db: opts.database
+                    };
+                    instance = await (0, client_services_1.createClickhouseClickhouseInstance)(ctx, options);
+                }
+                break;
+            case 'couchdb':
+                {
+                    if (!opts.rootPassword) {
+                        throw new Error('Root password is required for couchdb');
+                    }
+                    const options = {
+                        name,
+                        AdminPassword: opts.rootPassword
+                    };
+                    instance = await (0, client_services_1.createApacheCouchdbInstance)(ctx, options);
+                }
+                break;
+            default:
+                throw new Error(`Unsupported database type: ${type}`);
+        }
+    }
+    switch (type) {
+        case 'valkey':
+        case 'postgres':
+        case 'mariadb':
+        case 'clickhouse': {
+            const token = await ctx.getServiceAccessToken(exports.DatabaseTypeToServiceId[type]);
+            const ports = await (0, client_core_1.getPortsForInstance)(ctx, exports.DatabaseTypeToServiceId[type], name, token);
+            const port = ports.find((p) => p.internalPort === exports.DatabaseTypeToPort[type]);
+            if (port) {
+                return `${exports.DatabaseTypeToProtocol[type]}://${opts.username || 'default'}${opts.password ? ':' + opts.password : ''}@${port.externalIp}:${port.externalPort}`;
+            }
+            throw new Error('Failed to get connection URL for database');
+        }
+        case 'couchdb': {
+            const url = new URL(instance.url);
+            url.password = instance.AdminPassword;
+            url.username = 'admin';
+            return url.toString();
+        }
+        default:
+            throw new Error(`Unsupported database type: ${type}`);
+    }
+}
+exports.setupDatabase = setupDatabase;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,mCAAoC;AAA3B,kGAAA,QAAQ,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,oDAAkE;AAClE,4DAgBgC;AAEhC,mCAAoC;AAA3B,kGAAA,QAAQ,OAAA;AASJ,QAAA,uBAAuB,GAAiC;IACnE,MAAM,EAAE,kBAAkB;IAC1B,QAAQ,EAAE,sBAAsB;IAChC,OAAO,EAAE,4BAA4B;IACrC,UAAU,EAAE,uBAAuB;IACnC,OAAO,EAAE,gBAAgB;CAC1B,CAAC;AACW,QAAA,kBAAkB,GAAiC;IAC9D,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,IAAI;IACb,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,IAAI;CACd,CAAC;AACW,QAAA,sBAAsB,GAAiC;IAClE,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,OAAO;IAChB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,OAAO;CACjB,CAAC;AASF;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,aAAa,CACjC,IAAkB,EAClB,IAAY,EACZ,IAAkB;IAElB,MAAM,GAAG,GAAG,IAAI,qBAAO,EAAE,CAAC;IAC1B,IAAI,QAAQ,CAAC;IAEb,QAAQ,IAAI,EAAE;QACZ,KAAK,QAAQ;YACX,QAAQ,GAAG,MAAM,IAAA,2CAAyB,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACtD,MAAM;QACR,KAAK,UAAU;YACb,QAAQ,GAAG,MAAM,IAAA,+CAA6B,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC1D,MAAM;QACR,KAAK,SAAS;YACZ,QAAQ,GAAG,MAAM,IAAA,qDAAmC,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAChE,MAAM;QACR,KAAK,YAAY;YACf,QAAQ,GAAG,MAAM,IAAA,iDAA+B,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC5D,MAAM;QACR,KAAK,SAAS;YACZ,QAAQ,GAAG,MAAM,IAAA,0CAAwB,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACrD,MAAM;QACR;YACE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;KACzD;IACD,IAAI,CAAC,QAAQ,EAAE;QACb,QAAQ,IAAI,EAAE;YACZ,KAAK,QAAQ;gBACX;oBACE,MAAM,OAAO,GAAyB;wBACpC,IAAI;wBACJ,QAAQ,EAAE,IAAI,CAAC,QAAQ;qBACxB,CAAC;oBACF,QAAQ,GAAG,MAAM,IAAA,8CAA4B,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;iBAC7D;gBACD,MAAM;YACR,KAAK,UAAU;gBACb;oBACE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;wBAClB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;qBACtD;oBACD,MAAM,OAAO,GAA6B;wBACxC,IAAI;wBACJ,YAAY,EAAE,IAAI,CAAC,QAAQ;wBAC3B,gBAAgB,EAAE,IAAI,CAAC,QAAQ;wBAC/B,UAAU,EAAE,IAAI,CAAC,QAAQ;qBAC1B,CAAC;oBACF,QAAQ,GAAG,MAAM,IAAA,kDAAgC,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;iBACjE;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ;oBACE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;wBACtB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;qBAC1D;oBACD,MAAM,OAAO,GAAmC;wBAC9C,IAAI;wBACJ,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;wBACvB,IAAI,EAAE,IAAI,CAAC,QAAQ;wBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;qBACxB,CAAC;oBACF,QAAQ,GAAG,MAAM,IAAA,wDAAsC,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;iBACvE;gBACD,MAAM;YACR,KAAK,YAAY;gBACf;oBACE,MAAM,OAAO,GAA+B;wBAC1C,IAAI;wBACJ,QAAQ,EAAE,IAAI,CAAC,QAAQ;wBACvB,IAAI,EAAE,IAAI,CAAC,QAAQ;wBACnB,EAAE,EAAE,IAAI,CAAC,QAAQ;qBAClB,CAAC;oBACF,QAAQ,GAAG,MAAM,IAAA,oDAAkC,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;iBACnE;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ;oBACE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;wBACtB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;qBAC1D;oBACD,MAAM,OAAO,GAAwB;wBACnC,IAAI;wBACJ,aAAa,EAAE,IAAI,CAAC,YAAY;qBACjC,CAAC;oBACF,QAAQ,GAAG,MAAM,IAAA,6CAA2B,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;iBAC5D;gBACD,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;SACzD;KACF;IAED,QAAQ,IAAI,EAAE;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,UAAU,CAAC;QAChB,KAAK,SAAS,CAAC;QACf,KAAK,YAAY,CAAC,CAAC;YACjB,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAC3C,+BAAuB,CAAC,IAAI,CAAC,CAC9B,CAAC;YACF,MAAM,KAAK,GAAG,MAAM,IAAA,iCAAmB,EACrC,GAAG,EACH,+BAAuB,CAAC,IAAI,CAAC,EAC7B,IAAI,EACJ,KAAK,CACN,CAAC;YACF,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CACrB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,0BAAkB,CAAC,IAAI,CAAC,CACnD,CAAC;YACF,IAAI,IAAI,EAAE;gBACR,OAAO,GAAG,8BAAsB,CAAC,IAAI,CAAC,MACpC,IAAI,CAAC,QAAQ,IAAI,SACnB,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,CAAC,UAAU,IAC5D,IAAI,CAAC,YACP,EAAE,CAAC;aACJ;YACD,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;SAC9D;QACD,KAAK,SAAS,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAClC,GAAG,CAAC,QAAQ,GAAI,QAAgB,CAAC,aAAa,CAAC;YAC/C,GAAG,CAAC,QAAQ,GAAG,OAAO,CAAC;YACvB,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;SACvB;QACD;YACE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;KACzD;AACH,CAAC;AAlID,sCAkIC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osaas/client-db",
-  "version": "0.4.6",
+  "version": "0.5.0",
   "description": "Open Source Cloud Client SDK database library",
   "author": "Eyevinn Open Source Cloud <osc@eyevinn.se>",
   "homepage": "https://www.osaas.io",
@@ -26,11 +26,12 @@
   },
   "dependencies": {
     "@osaas/client-core": "^0.15.1",
-    "@osaas/client-services": "^0.8.0",
-    "chalk": "4.1.2"
+    "@osaas/client-services": "^0.9.0",
+    "chalk": "4.1.2",
+    "ioredis": "^5.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b41a58bd9be9c7c6b54ffd69f59ea36179792748"
+  "gitHead": "4413b4785d4361bf7e3d82908e9b81683d41eca9"
 }