@osaas/client-db 0.5.5 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/lib/index.d.ts +6 -2
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +5 -3
- package/lib/index.js.map +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -15,11 +15,13 @@ npm install --save @osaas/client-db
|
|
|
15
15
|
Example code creating a Valkey database and use a Redis client to connect with it
|
|
16
16
|
|
|
17
17
|
```javascript
|
|
18
|
+
import { Context } from '@osaas/client-core';
|
|
18
19
|
import { setupDatabase } from '@osaas/client-db';
|
|
19
20
|
import Redis from 'ioredis';
|
|
20
21
|
|
|
21
22
|
async function main() {
|
|
22
|
-
const
|
|
23
|
+
const ctx = new Context();
|
|
24
|
+
const dbUrl = await setupDatabase(ctx, 'valkey', 'myvalkey', {
|
|
23
25
|
password: 'secret'
|
|
24
26
|
});
|
|
25
27
|
const client = new Redis(dbUrl);
|
package/lib/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
/** @module @osaas/client-db */
|
|
2
|
+
import { Context } from '@osaas/client-core';
|
|
2
3
|
export { ValkeyDb } from './valkey';
|
|
3
4
|
export type DatabaseType = 'valkey' | 'postgres' | 'mariadb' | 'clickhouse' | 'couchdb';
|
|
4
5
|
export declare const DatabaseTypeToServiceId: Record<DatabaseType, string>;
|
|
@@ -21,16 +22,19 @@ export interface DatabaseOpts {
|
|
|
21
22
|
* Create a database instance if it does not exists
|
|
22
23
|
* and return the connection URL.
|
|
23
24
|
*
|
|
25
|
+
* @param {Context} ctx The Open Source Cloud configuration context.
|
|
24
26
|
* @param {DatabaseType} type The type of the database.
|
|
25
27
|
* @param {string} name The name of the database instance.
|
|
26
28
|
* @param {DatabaseOpts} opts The options for the database.
|
|
27
29
|
* @returns The connection URL for the database.
|
|
28
30
|
*
|
|
29
31
|
* @example
|
|
32
|
+
* import { Context } from '@osaas/client-core';
|
|
30
33
|
* import { setupDatabase } from '@osaas/client-db';
|
|
31
34
|
* import Redis from 'ioredis';
|
|
32
35
|
*
|
|
33
|
-
* const
|
|
36
|
+
* const ctx = new Context();
|
|
37
|
+
* const dbUrl = await setupDatabase(ctx, 'valkey', 'myvalkey', { password: 'secret' });
|
|
34
38
|
* const client = new Redis(dbUrl);
|
|
35
39
|
* try {
|
|
36
40
|
* await client.subscribe('messages');
|
|
@@ -42,5 +46,5 @@ export interface DatabaseOpts {
|
|
|
42
46
|
* console.error('Error:', err);
|
|
43
47
|
* }
|
|
44
48
|
*/
|
|
45
|
-
export declare function setupDatabase(type: DatabaseType, name: string, opts: DatabaseOpts): Promise<string>;
|
|
49
|
+
export declare function setupDatabase(ctx: Context, type: DatabaseType, name: string, opts: DatabaseOpts): Promise<string>;
|
|
46
50
|
//# sourceMappingURL=index.d.ts.map
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAE/B,OAAO,EAAE,OAAO,EAAuB,MAAM,oBAAoB,CAAC;AAmBlE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,YAAY,mBAmInB"}
|
package/lib/index.js
CHANGED
|
@@ -38,16 +38,19 @@ exports.DatabaseTypeToProtocol = {
|
|
|
38
38
|
* Create a database instance if it does not exists
|
|
39
39
|
* and return the connection URL.
|
|
40
40
|
*
|
|
41
|
+
* @param {Context} ctx The Open Source Cloud configuration context.
|
|
41
42
|
* @param {DatabaseType} type The type of the database.
|
|
42
43
|
* @param {string} name The name of the database instance.
|
|
43
44
|
* @param {DatabaseOpts} opts The options for the database.
|
|
44
45
|
* @returns The connection URL for the database.
|
|
45
46
|
*
|
|
46
47
|
* @example
|
|
48
|
+
* import { Context } from '@osaas/client-core';
|
|
47
49
|
* import { setupDatabase } from '@osaas/client-db';
|
|
48
50
|
* import Redis from 'ioredis';
|
|
49
51
|
*
|
|
50
|
-
* const
|
|
52
|
+
* const ctx = new Context();
|
|
53
|
+
* const dbUrl = await setupDatabase(ctx, 'valkey', 'myvalkey', { password: 'secret' });
|
|
51
54
|
* const client = new Redis(dbUrl);
|
|
52
55
|
* try {
|
|
53
56
|
* await client.subscribe('messages');
|
|
@@ -59,8 +62,7 @@ exports.DatabaseTypeToProtocol = {
|
|
|
59
62
|
* console.error('Error:', err);
|
|
60
63
|
* }
|
|
61
64
|
*/
|
|
62
|
-
async function setupDatabase(type, name, opts) {
|
|
63
|
-
const ctx = new client_core_1.Context();
|
|
65
|
+
async function setupDatabase(ctx, type, name, opts) {
|
|
64
66
|
let instance;
|
|
65
67
|
switch (type) {
|
|
66
68
|
case 'valkey':
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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
|
|
1
|
+
{"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;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,KAAK,UAAU,aAAa,CACjC,GAAY,EACZ,IAAkB,EAClB,IAAY,EACZ,IAAkB;IAElB,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,CAAC;YACd,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,KAAK,YAAY,CAAC,CAAC;YACjB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAClC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,SAAS,CAAC;YAC1C,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;YACnC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;SACvB;QACD;YACE,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;KACzD;AACH,CAAC;AAvID,sCAuIC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@osaas/client-db",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "Open Source Cloud Client SDK database library",
|
|
5
5
|
"author": "Eyevinn Open Source Cloud <osc@eyevinn.se>",
|
|
6
6
|
"homepage": "https://www.osaas.io",
|
|
@@ -25,13 +25,13 @@
|
|
|
25
25
|
"test": "jest --passWithNoTests"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@osaas/client-core": "^0.16.
|
|
29
|
-
"@osaas/client-services": "^0.11.
|
|
28
|
+
"@osaas/client-core": "^0.16.1",
|
|
29
|
+
"@osaas/client-services": "^0.11.2",
|
|
30
30
|
"chalk": "4.1.2",
|
|
31
31
|
"ioredis": "^5.5.0"
|
|
32
32
|
},
|
|
33
33
|
"publishConfig": {
|
|
34
34
|
"access": "public"
|
|
35
35
|
},
|
|
36
|
-
"gitHead": "
|
|
36
|
+
"gitHead": "b83e71d41bde719c3efe6974795e8e429c948b54"
|
|
37
37
|
}
|