@samet-it/be-couchbase-common 1.0.16 → 1.1.1

package/README.md

@@ -8,7 +8,7 @@
 \___/\____/\__,_/\___/_/ /_/_.___/\__,_/____/\___/   \___/\____/_/ /_/ /_/_/ /_/ /_/\____/_/ /_/ 
 ```
 <!-- https://patorjk.com/software/taag/#p=display&f=Slant&t=couchbase+common&x=none&v=4&h=3&w=80&we=false -->
-- `EN`: Use it for Couchbase connections
+- `EN`: Use it for couchbase connections
 - `TR`: Couchbase bağlantıları için bu bileşeni kullanınız
 
 ## Prerequisite
@@ -28,7 +28,7 @@ npm i @samet-it/be-couchbase-common
 ```
 
 ## Environments
-- [CouchbaseCommon](./src/config/couchbase-common.config.ts)
+- [CouchbaseCommonConf](./src/config/couchbase-common.config.ts)
 
 | Name                | Type    | Default | Required | Secret | Description                                 |
 |---------------------|---------|---------|----------|--------|---------------------------------------------|
@@ -39,14 +39,13 @@ npm i @samet-it/be-couchbase-common
 | `CB_SCOPE`          | string  |         | ✅        |        | Scope/Schema Name                           |
 | `CB_CREATE_INDICES` | boolean | _false_ |          |        | Does it create the indices when it deploys? |
 
-
 ## Contents
-- [CbAdapterService](./src/adapter/cb-adapter.service.ts) - Injectable service
-- [CbAdapterModule](./src/adapter/cb-adapter.module.ts) - Nestjs Module
-- [couchbaseCommonConfig](./src/config/couchbase-common.config.ts) - config
-- [cbFilterUtil](./src/filter/cb-filter-util.impl.ts) - query filter utility
-- [cbLine()](./src/line/cb-line.impl.ts) - sql line utility
-- [CbRepo](./src/repo/cb.repo.ts) - abstract repository
+- `abstract` [CbConnection](src/connection/cb.connection.ts) - abstract connection class
+- `class` [CbDirectConnection](src/connection/cb-direct.connection.ts) - Direct connection
+- `function` [cbConnection()](src/connection/cb-connection.fn.ts) - Connection function
+- `abstract` [CbRepo](./src/repo/cb.repo.ts) - abstract repository
+- `class` [CbDirectRepo](./src/repo/cb-direct.repo.ts) - direct repository
+- `instance` [cbFilterUtil](./src/filter/cb-filter-util.impl.ts) - query filter utility
 
 
 ## Development
@@ -64,8 +63,9 @@ git clone https://github.com/samet-digital/be-couchbase-common.git -b developmen
 
 ## Dependencies
 - `@samet-it/be-base-common`:  **samet** base common
+- `@samet-it/be-db-common`:  **samet** db common
+- `@samet-it/be-cache-common`:  **samet** cache common
 - `@leyyo/*`: leyyo utilities
-- `@nestjs/*`: nestjs framework
 - `couchbase`: couchbase client
 
 ## Commands

package/dist/config/couchbase-common.config.d.ts

@@ -1,2 +1,6 @@
 import type { CouchbaseCommonConf } from "./index.types";
-export declare const couchbaseCommonConfig: import("@leyyo/env").EnvScopeRuntime<CouchbaseCommonConf>;
+/**
+ * Couchbase common config
+ * @config
+ * */
+export declare const couchbaseCommonConfig: import("@leyyo/env").EnvScopeRuntime<CouchbaseCommonConf, "CB", undefined>;

package/dist/config/couchbase-common.config.js

@@ -2,13 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.couchbaseCommonConfig = void 0;
 const env_1 = require("@leyyo/env");
+/**
+ * Couchbase common config
+ * @config
+ * */
 exports.couchbaseCommonConfig = env_1.envCore.configure
-    .scope('CouchbaseCommon')
-    .begin
-    .field('CB_HOST').text().required().end
-    .field('CB_USER').text().required().end
-    .field('CB_PASS').text().required().end
-    .field('CB_BUCKET').text().required().end
-    .field('CB_SCOPE').text().required().end
-    .field('CB_CREATE_INDICES').boolean().def(false).end
-    .end;
+    .scope('CouchbaseCommon', 'CB')
+    .start()
+    .field('PROTOCOL').text().def('couchbase').end()
+    .field('HOST').text().required().end()
+    .field('PORT').integer().end()
+    .field('USER').text().required().end()
+    .field('PASS').text().required().end()
+    .field('BUCKET').text().required().end()
+    .field('SCOPE').text().required().end()
+    .field('CREATE_INDICES').boolean().def(false).end()
+    .finish();

package/dist/config/index.types.d.ts

@@ -1,31 +1,35 @@
 import type { EnvBase } from "@leyyo/env";
-export declare namespace NodeJS {
-    interface ProcessEnv extends CouchbaseCommonConf {
-    }
-}
 export interface CouchbaseCommonConf extends EnvBase {
     /**
-     * DB Host
+     * Protocol
+     * */
+    readonly PROTOCOL: string;
+    /**
+     * Host name or ip address
+     * */
+    readonly HOST: string;
+    /**
+     * Port number
      * */
-    readonly CB_HOST: string;
+    readonly PORT: number;
     /**
-     * DB User
+     * Username
      * */
-    readonly CB_USER: string;
+    readonly USER: string;
     /**
-     * DB Password
+     * Password
      * */
-    readonly CB_PASS: string;
+    readonly PASS: string;
     /**
      * Current bucket (database name)
      * */
-    readonly CB_BUCKET: string;
+    readonly BUCKET: string;
     /**
      * Current scope (schema name)
      * */
-    readonly CB_SCOPE: string;
+    readonly SCOPE: string;
     /**
      * Create indices when it's started
      * */
-    readonly CB_CREATE_INDICES: boolean;
+    readonly CREATE_INDICES: boolean;
 }

package/dist/connection/cb-connection.fn.d.ts

@@ -0,0 +1,8 @@
+import type { CbDirectConnectionLike, CbDirectConnOpt } from "./index.types";
+/**
+ * Crete new couchbase connection
+ *
+ * @param {CbDirectConnOpt?} opt - option
+ * @return {CbDirectConnectionLike} - new connection instance
+ * */
+export declare function cbConnection(opt?: CbDirectConnOpt): CbDirectConnectionLike;

package/dist/connection/cb-connection.fn.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cbConnection = cbConnection;
+const cb_direct_connection_1 = require("./cb-direct.connection");
+// noinspection JSUnusedGlobalSymbols
+/**
+ * Crete new couchbase connection
+ *
+ * @param {CbDirectConnOpt?} opt - option
+ * @return {CbDirectConnectionLike} - new connection instance
+ * */
+function cbConnection(opt) {
+    return new cb_direct_connection_1.CbDirectConnection(opt);
+}

package/dist/connection/cb-direct.connection.d.ts

@@ -0,0 +1,13 @@
+import { CbConnection } from "./cb.connection";
+import type { DefDims, Entity, UrnDocLike, Pair, Portion, View } from "@samet-it/be-base-common";
+import { type CbRepoDirectOpt, type CbRepoLike } from "../repo";
+import type { CbDirectConnectionLike, CbDirectConnOpt } from "./index.types";
+import type { KeyValue } from "@leyyo/common";
+/**
+ * Couchbase connection direct class
+ * */
+export declare class CbDirectConnection extends CbConnection implements CbDirectConnectionLike {
+    constructor(opt?: CbDirectConnOpt);
+    /** @inheritDoc */
+    newRepo<ID extends KeyValue, ENTITY extends Entity<ID>, URN extends UrnDocLike, KEYS extends string = string, DIMS extends DefDims = DefDims, PAIR extends Pair<ID> = Pair<ID>, VIEW extends View<ID> = View<ID>, PORTION extends Portion<ID> = Portion<ID>, R = unknown>(opt: CbRepoDirectOpt<ID, ENTITY, URN, DIMS, R>): CbRepoLike<ID, ENTITY, URN, KEYS, DIMS, PAIR, VIEW, PORTION>;
+}

package/dist/connection/cb-direct.connection.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CbDirectConnection = void 0;
+const cb_connection_1 = require("./cb.connection");
+const be_base_common_1 = require("@samet-it/be-base-common");
+const repo_1 = require("../repo");
+// noinspection JSUnusedGlobalSymbols
+/**
+ * Couchbase connection direct class
+ * */
+class CbDirectConnection extends cb_connection_1.CbConnection {
+    constructor(opt) {
+        super(opt);
+        this.logger = be_base_common_1.logger.of(`CbConnection${(opt === null || opt === void 0 ? void 0 : opt.name) ? '#' + (opt === null || opt === void 0 ? void 0 : opt.name) : ''}`);
+    }
+    /** @inheritDoc */
+    newRepo(opt) {
+        return new repo_1.CbDirectRepo(this, opt);
+    }
+}
+exports.CbDirectConnection = CbDirectConnection;

package/dist/connection/cb.connection.d.ts

@@ -0,0 +1,35 @@
+import type { QueryResult, QueryMetaData } from 'couchbase';
+import { type IgnoreFieldsByType, type ReplaceType } from "@leyyo/common";
+import { DbConnection, type DbLines } from "@samet-it/be-db-common";
+import type { CbConnectionLike, CbConnOpt, CbExecOpt, CbConnProps } from "./index.types";
+import type { CbRepoDef } from "../repo";
+import type { DbQueryResultMore, DbQueryResultOne } from "@samet-it/be-db-common";
+/**
+ * Couchbase connection abstract class
+ * */
+export declare abstract class CbConnection extends DbConnection<CbRepoDef, QueryMetaData, CbExecOpt> implements CbConnectionLike {
+    /** {@inheritDoc} */
+    protected _props: CbConnProps;
+    protected constructor(opt?: CbConnOpt);
+    protected _readEnv(): void;
+    /** {@inheritDoc} */
+    get props(): Readonly<CbConnProps>;
+    /** {@inheritDoc} */
+    field(field: string): string;
+    /** {@inheritDoc} */
+    value(value: unknown): string;
+    /** {@inheritDoc} */
+    flatten<T>(result: QueryResult<T>): Array<T>;
+    /** {@inheritDoc} */
+    castDates<T>(given: ReplaceType<T, Date, string> | T, ...fields: Array<IgnoreFieldsByType<T, Date>>): void;
+    /** {@inheritDoc} */
+    castDatesForList<T>(given: Array<ReplaceType<T, Date, string> | T>, ...fields: Array<IgnoreFieldsByType<T, Date>>): void;
+    /** {@inheritDoc} */
+    more<T>(repo: CbRepoDef, lines: string | DbLines, p1?: string | CbExecOpt): Promise<DbQueryResultMore<T, QueryMetaData>>;
+    /** {@inheritDoc} */
+    one<T>(repo: CbRepoDef, lines: string | DbLines, p1?: string | CbExecOpt): Promise<DbQueryResultOne<T, QueryMetaData>>;
+    /** {@inheritDoc} */
+    connect(): Promise<boolean>;
+    /** {@inheritDoc} */
+    ping(next?: boolean): Promise<boolean>;
+}

package/dist/{adapter/cb-adapter.service.js → connection/cb.connection.js}

@@ -16,12 +16,6 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
 var __importStar = (this && this.__importStar) || (function () {
     var ownKeys = function(o) {
         ownKeys = Object.getOwnPropertyNames || function (o) {
@@ -39,9 +33,6 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -52,61 +43,48 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CbAdapterService = void 0;
+exports.CbConnection = void 0;
 const couchbase = __importStar(require("couchbase"));
-const common_1 = require("@nestjs/common");
 const config_1 = require("../config");
-const common_2 = require("@leyyo/common");
-// noinspection JSUnusedGlobalSymbols
-let CbAdapterService = class CbAdapterService {
-    constructor() {
-        this._CLEAR_ERROR_INTERVAL = 1000 * 60 * 60 * 24; // daily
-        this._nativeErrors = new Map();
-        this.logger = new common_1.Logger(this.constructor.name);
-        this._clearErrors();
+const common_1 = require("@leyyo/common");
+const filter_1 = require("../filter");
+const be_db_common_1 = require("@samet-it/be-db-common");
+const type_1 = require("@leyyo/type");
+/**
+ * Couchbase connection abstract class
+ * */
+class CbConnection extends be_db_common_1.DbConnection {
+    // endregion protected-property
+    constructor(opt) {
+        super(opt);
+        filter_1.cbFilterUtil.$set(this);
+        this._readEnv();
     }
-    /**
-     * Clear native errors
-     * */
-    _clearErrors() {
-        this._nativeErrors.clear();
-        setTimeout(() => this._clearErrors(), this._CLEAR_ERROR_INTERVAL);
-    }
-    /**
-     * Ping to DB
-     * */
-    _ping() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.exec(this._cluster.ping(), { name: 'ping' });
-            }
-            catch (err) {
-                this.logger.warn(`Ping error => [${err.name}: ${err.message}]`);
-            }
-            setTimeout(() => this._ping(), 30000);
-        });
-    }
-    _checkError(err, opt) {
-        var _a, _b, _c;
-        let size = 1;
-        if (!this._nativeErrors.has(err)) {
-            this._nativeErrors.set(err, size);
-        }
-        else {
-            size = this._nativeErrors.get(err) + 1;
-            this._nativeErrors.set(err, size);
-        }
-        if ((_a = opt === null || opt === void 0 ? void 0 : opt.ignoredErrors) === null || _a === void 0 ? void 0 : _a.includes(err)) {
-            this.logger.warn(`[${size}] ${(_b = opt.name) !== null && _b !== void 0 ? _b : 'Ignored error'} => [${err.name}: ${err.message}]`);
-            return;
+    // region protected-method
+    _readEnv() {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const { _props: props } = this;
+        let env = config_1.couchbaseCommonConfig.valueShort;
+        if (props.envVariant) {
+            env = config_1.couchbaseCommonConfig.configure.getVariation(props.envVariant).valueShort;
         }
-        this.logger.error(`[${size}] ${(_c = opt.name) !== null && _c !== void 0 ? _c : 'Database error'} => [${err.name}: ${err.message}]`, JSON.stringify(err.context));
-        throw err;
+        props.protocol = (_a = props.protocol) !== null && _a !== void 0 ? _a : env.PROTOCOL;
+        props.host = (_b = props.host) !== null && _b !== void 0 ? _b : env.HOST;
+        props.port = (_c = props.port) !== null && _c !== void 0 ? _c : env.PORT;
+        props.username = (_d = props.username) !== null && _d !== void 0 ? _d : env.USER;
+        props.password = (_e = props.password) !== null && _e !== void 0 ? _e : env.PASS;
+        props.bucketName = (_f = props.bucketName) !== null && _f !== void 0 ? _f : env.BUCKET;
+        props.scopeName = (_g = props.scopeName) !== null && _g !== void 0 ? _g : env.SCOPE;
+        props.createIndices = (_h = props.createIndices) !== null && _h !== void 0 ? _h : env.CREATE_INDICES;
     }
+    // endregion protected-method
+    // region getter
     /** {@inheritDoc} */
-    f(field) {
-        return this.field(field);
+    get props() {
+        return this._props;
     }
+    // endregion getter
+    // region field-value
     /** {@inheritDoc} */
     field(field) {
         field = field.trim();
@@ -115,9 +93,7 @@ let CbAdapterService = class CbAdapterService {
         }
         return field.startsWith('`') ? field : `\`${field}\``;
     }
-    v(value) {
-        return this.value(value);
-    }
+    /** {@inheritDoc} */
     value(value) {
         var _a;
         switch (typeof value) {
@@ -129,7 +105,7 @@ let CbAdapterService = class CbAdapterService {
                 return value ? `true` : 'false';
             case "object":
                 if (value) {
-                    return common_2.$dev.secureJson(value, true);
+                    return (0, common_1.secureJson)(value);
                 }
                 else {
                     return 'null';
@@ -150,27 +126,8 @@ let CbAdapterService = class CbAdapterService {
         }
         return [];
     }
-    /** {@inheritDoc} */
-    rows(rows) {
-        if (rows && Array.isArray(rows) && (rows.length > 0)) {
-            return rows.filter(row => row['_trashId'] === undefined);
-        }
-        return [];
-    }
-    /** {@inheritDoc} */
-    row(row) {
-        if (row && row['_trashId'] === undefined) {
-            return row;
-        }
-        return undefined;
-    }
-    /** {@inheritDoc} */
-    first(rows) {
-        if (rows && Array.isArray(rows) && (rows.length > 0)) {
-            return rows[0];
-        }
-        return undefined;
-    }
+    // endregion field-value
+    // region transcoders
     /** {@inheritDoc} */
     castDates(given, ...fields) {
         if (fields.length < 1) {
@@ -198,35 +155,18 @@ let CbAdapterService = class CbAdapterService {
         const arr = given;
         arr.forEach(item => this.castDates(item, ...fields));
     }
-    buildOpt(p1, name) {
-        const opt = typeof p1 === 'string' ? { name: p1 } : Object.assign({}, p1);
-        if (typeof opt.name === undefined && typeof name !== undefined) {
-            opt.name = name;
-        }
-        opt.name = opt.name ? `[${opt.name}]` : '';
-        return opt;
-    }
+    // endregion transcoders
+    // region query
     /** {@inheritDoc} */
-    exec(fn, p1) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const opt = this.buildOpt(p1);
-            try {
-                return yield fn;
-            }
-            catch (err) {
-                this._checkError(err, opt);
-                return undefined;
-            }
-        });
-    }
-    more(repo, sql, p1) {
+    more(repo, lines, p1) {
         return __awaiter(this, void 0, void 0, function* () {
             const opt = this.buildOpt(p1);
+            const sql = (0, type_1.isObjectValid)(lines) ? lines.end() : lines;
             if (opt.printSql) {
-                this.logger.log(`${repo.path} > SQL${opt.name}`, sql);
+                this.logger.log(`${repo.props.path} > SQL${opt.name}`, sql);
             }
             try {
-                const result = yield repo.scope.query(sql, opt);
+                const result = yield repo.props.scope.query(sql, opt);
                 return {
                     success: true,
                     rows: result.rows,
@@ -234,7 +174,7 @@ let CbAdapterService = class CbAdapterService {
                 };
             }
             catch (err) {
-                this._checkError(err, opt);
+                this.checkError(err, Object.assign(Object.assign({}, opt), { sql }));
                 return {
                     success: false,
                     rows: [],
@@ -243,14 +183,16 @@ let CbAdapterService = class CbAdapterService {
             }
         });
     }
-    one(repo, sql, p1) {
+    /** {@inheritDoc} */
+    one(repo, lines, p1) {
         return __awaiter(this, void 0, void 0, function* () {
             const opt = this.buildOpt(p1);
+            const sql = (0, type_1.isObjectValid)(lines) ? lines.end() : lines;
             if (opt.printSql) {
-                this.logger.log(`${repo.path} > SQL${opt.name}`, sql);
+                this.logger.log(`${repo.props.path} > SQL${opt.name}`, sql);
             }
             try {
-                const result = yield repo.scope.query(sql, opt);
+                const result = yield repo.props.scope.query(sql, opt);
                 return {
                     success: true,
                     row: (Array.isArray(result.rows) && result.rows.length > 0) ? result.rows[0] : undefined,
@@ -258,7 +200,7 @@ let CbAdapterService = class CbAdapterService {
                 };
             }
             catch (err) {
-                this._checkError(err, opt);
+                this.checkError(err, Object.assign(Object.assign({}, opt), { sql }));
                 return {
                     success: false,
                     row: undefined,
@@ -267,32 +209,62 @@ let CbAdapterService = class CbAdapterService {
             }
         });
     }
+    // endregion query
+    // region connect
     /** {@inheritDoc} */
-    connectDb() {
+    connect() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this._connected) {
-                return this._cluster;
+            const { _props: props } = this;
+            if (props.isConnected) {
+                return true;
             }
-            const opt = config_1.couchbaseCommonConfig.raw;
             try {
-                this._cluster = yield couchbase.connect(`couchbase://${opt.CB_HOST}`, {
-                    username: opt.CB_USER,
-                    password: opt.CB_PASS,
+                props.cluster = yield couchbase.connect(`${props.protocol}://${props.host}`, {
+                    username: props.username,
+                    password: props.password,
                 });
-                this._connected = true;
+                props.isConnected = true;
                 this.logger.log('Connected');
-                setTimeout(() => this._ping(), 30000);
-                return this._cluster;
+                setTimeout(() => this.ping(true).then(), 30000);
             }
             catch (e) {
-                this.logger.error(`Connection error => [${e.name}: ${e.message}]`);
+                this.checkError(e, { name: 'connection' });
                 throw e;
             }
+            if (props.isFirst === undefined) {
+                if (this._onFirstConnected.length > 0) {
+                    yield Promise.all(this._onFirstConnected);
+                    this._onFirstConnected = [];
+                }
+                props.isFirst = false;
+            }
+            if (this._onConnected.length > 0) {
+                this._onConnected.forEach(fn => {
+                    fn().then().catch(e => {
+                        this.logger.error(`OnConnected <${e.name}> ${e.message}`);
+                    });
+                });
+            }
+            return true;
         });
     }
-};
-exports.CbAdapterService = CbAdapterService;
-exports.CbAdapterService = CbAdapterService = __decorate([
-    (0, common_1.Injectable)(),
-    __metadata("design:paramtypes", [])
-], CbAdapterService);
+    /** {@inheritDoc} */
+    ping(next) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { _props: props } = this;
+            let result = false;
+            try {
+                yield this.exec(props.cluster.ping(), { name: 'ping' });
+                result = true;
+            }
+            catch (err) {
+                this.checkError(err, { name: 'ping', silent: true });
+            }
+            if (next) {
+                setTimeout(() => this.ping(true).then(), 30000);
+            }
+            return result;
+        });
+    }
+}
+exports.CbConnection = CbConnection;

package/dist/connection/index.d.ts

@@ -0,0 +1,4 @@
+export * from './index.types';
+export * from './cb.connection';
+export * from './cb-connection.fn';
+export * from './cb-direct.connection';

package/dist/{adapter → connection}/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./index.types"), exports);
-__exportStar(require("./cb-adapter.service"), exports);
-__exportStar(require("./cb-adapter.module"), exports);
+__exportStar(require("./cb.connection"), exports);
+__exportStar(require("./cb-connection.fn"), exports);
+__exportStar(require("./cb-direct.connection"), exports);