@samet-it/be-couchbase-common 1.0.17 → 1.1.2

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

@@ -0,0 +1,94 @@
+import type { Cluster, QueryMetaData, QueryOptions, QueryResult } from "couchbase";
+import type { IgnoreFieldsByType, KeyValue, ReplaceType } from "@leyyo/common";
+import type { CbRepoDef, CbRepoDirectOpt, CbRepoLike } from "../repo";
+import type { DbConnectionLike, DbConnOpt, DbConnProps, DbExecOpt } from "@samet-it/be-db-common";
+import type { DefDims, Entity, UrnDocLike, Pair, Portion, View } from "@samet-it/be-base-common";
+/**
+ * Couchbase connection interface
+ * */
+export interface CbConnectionLike extends DbConnectionLike<CbRepoDef, QueryMetaData, CbExecOpt> {
+    /** @inheritDoc */
+    get props(): Readonly<CbConnProps>;
+    /**
+     * Flatten query result to rows
+     * */
+    flatten<T>(result: QueryResult<T>): Array<T>;
+    /**
+     * Cast dates
+     * */
+    castDates<T>(given: ReplaceType<T, Date, string> | T, ...fields: Array<IgnoreFieldsByType<T, Date>>): void;
+    /**
+     * Cast dates for an array
+     * */
+    castDatesForList<T>(given: Array<ReplaceType<T, Date, string> | T>, ...fields: Array<IgnoreFieldsByType<T, Date>>): void;
+}
+/**
+ * Couchbase connection option interface
+ * */
+export interface CbConnOpt extends DbConnOpt {
+    /**
+     * Current bucket (database name)
+     *
+     * @type {string}
+     * */
+    bucketName?: string;
+    /**
+     * Current scope (schema name)
+     *
+     * @type {string}
+     * */
+    scopeName?: string;
+    /**
+     * Create indices when it's started
+     *
+     * @type {boolean}
+     * */
+    createIndices?: boolean;
+}
+/**
+ * Couchbase direct connection option interface
+ * */
+export interface CbDirectConnOpt extends CbConnOpt {
+    /**
+     * Logger name
+     *
+     * @type {string}
+     * */
+    name?: string;
+}
+/**
+ * Couchbase connection props interface
+ * */
+export interface CbConnProps extends CbConnOpt, DbConnProps {
+    /**
+     * Couchbase cluster
+     *
+     * @type {Cluster}
+     * */
+    cluster: Cluster;
+}
+/**
+ * Couchbase query option
+ * */
+export type CbExecOpt = DbExecOpt & QueryOptions;
+/**
+ * Direct connection to use outside dependency injection
+ * */
+export interface CbDirectConnectionLike extends CbConnectionLike {
+    /**
+     * Creates new direct repo without dependency injection
+     *
+     * @param {CbRepoDirectOpt} opt - options
+     * @return {CbRepoLike} - created repository
+     * */
+    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>;
+}
+export type CbIgnoreDate<T> = CbReplaceType<T, Date, string>;
+export type CbIgnoreDateKeys<T> = CbIgnoreFields<T, Date>;
+type CbIgnoreFields<T, I> = {
+    [K in keyof T]: T[K] extends I ? K : never;
+}[keyof T];
+type CbReplaceType<T, O, N> = {
+    [P in keyof T]: T[P] extends O ? N : T[P];
+};
+export {};

package/dist/filter/cb-filter-util.impl.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cbFilterUtil = void 0;
-const common_1 = require("@leyyo/common");
+const type_1 = require("@leyyo/type");
 class CbFilterUtilImpl {
     _where(opt) {
         const result = opt.whereUsed ? 'AND' : 'WHERE';
@@ -10,7 +10,7 @@ class CbFilterUtilImpl {
     }
     /** @inheritDoc */
     readOne(value, fn) {
-        if (!common_1.$is.text(value)) {
+        if (!(0, type_1.isText)(value)) {
             return undefined;
         }
         if (typeof fn === 'function') {
@@ -20,7 +20,7 @@ class CbFilterUtilImpl {
     }
     /** @inheritDoc */
     readArray(value, fn) {
-        if (!common_1.$is.text(value)) {
+        if (!(0, type_1.isText)(value)) {
             return undefined;
         }
         if (typeof fn !== 'function') {
@@ -33,7 +33,7 @@ class CbFilterUtilImpl {
     }
     /** @inheritDoc */
     readBetween(value, fn) {
-        if (!common_1.$is.text(value)) {
+        if (!(0, type_1.isText)(value)) {
             return undefined;
         }
         if (typeof fn !== 'function') {

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

@@ -1,5 +1,5 @@
-import type { CbLine } from "../line";
-import type { CbAdapterServiceLike } from "../adapter";
+import type { CbConnectionLike } from "../connection";
+import type { DbLines } from "@samet-it/be-db-common";
 export type FilterCastLambda<T> = (v: unknown) => T;
 export interface CbFilterUtil {
     /**
@@ -26,9 +26,9 @@ export interface CbFilterUtil {
      * Builds a sql for between
      * */
     sqlBetween(opt: CbFilterUtilWhereOpt, field: string, value: [unknown, unknown]): string | undefined;
-    $set(cb: CbAdapterServiceLike): void;
+    $set(cb: CbConnectionLike): void;
 }
 export interface CbFilterUtilWhereOpt {
-    lines: CbLine;
+    lines: DbLines;
     whereUsed: boolean;
 }

package/dist/index.d.ts

@@ -1,6 +1,4 @@
-export * from './adapter';
+export * from './connection';
 export * from './config';
 export * from './filter';
-export * from './line';
 export * from './repo';
-export { QueryResult as CbResult } from 'couchbase';

package/dist/index.js

@@ -14,12 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CbResult = void 0;
-__exportStar(require("./adapter"), exports);
+__exportStar(require("./connection"), exports);
 __exportStar(require("./config"), exports);
 __exportStar(require("./filter"), exports);
-__exportStar(require("./line"), exports);
 __exportStar(require("./repo"), exports);
-// noinspection JSUnusedGlobalSymbols
-var couchbase_1 = require("couchbase");
-Object.defineProperty(exports, "CbResult", { enumerable: true, get: function () { return couchbase_1.QueryResult; } });

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

@@ -0,0 +1,11 @@
+import { CbRepo } from "./cb.repo";
+import type { DefDims, Entity, Pair, Portion, UrnDocLike, View } from "@samet-it/be-base-common";
+import type { CbConnectionLike } from "../connection";
+import type { CbRepoDirectOpt } from "./index.types";
+import type { KeyValue } from "@leyyo/common";
+/**
+ * Couchbase repository direct class
+ * */
+export declare class CbDirectRepo<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>> extends CbRepo<ID, ENTITY, URN, KEYS, DIMS, PAIR, VIEW, PORTION> {
+    constructor(conn: CbConnectionLike, opt: CbRepoDirectOpt<ID, ENTITY, URN, DIMS>);
+}

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

@@ -0,0 +1,37 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CbDirectRepo = void 0;
+const cb_repo_1 = require("./cb.repo");
+const be_base_common_1 = require("@samet-it/be-base-common");
+/**
+ * Couchbase repository direct class
+ * */
+class CbDirectRepo extends cb_repo_1.CbRepo {
+    constructor(conn, opt) {
+        super(conn, opt);
+        if (opt) {
+            if (!opt.name) {
+                opt.name = this._props.urnPrefix;
+            }
+            if (typeof opt.toUrnTuple === 'function') {
+                this.$toUrnTuple = opt.toUrnTuple;
+            }
+            if (typeof opt.toDim === 'function') {
+                this.$toDim = (doc, dim) => __awaiter(this, void 0, void 0, function* () {
+                    return (yield opt.toDim(doc, dim));
+                });
+            }
+        }
+        this.logger = be_base_common_1.logger.of(`CbRepo${(opt === null || opt === void 0 ? void 0 : opt.name) ? '#' + (opt === null || opt === void 0 ? void 0 : opt.name) : ''}`);
+    }
+}
+exports.CbDirectRepo = CbDirectRepo;

package/dist/repo/cb-schema.error.d.ts

@@ -0,0 +1,4 @@
+import { DbError } from "@samet-it/be-db-common";
+export declare class CbSchemaError extends DbError {
+    constructor(field: string, value: unknown, where: string, method: string);
+}

package/dist/repo/cb-schema.error.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CbSchemaError = void 0;
+const be_db_common_1 = require("@samet-it/be-db-common");
+class CbSchemaError extends be_db_common_1.DbError {
+    constructor(field, value, where, method) {
+        super(`${field} could not be found! => ${value}`, { field, where, value, method });
+    }
+}
+exports.CbSchemaError = CbSchemaError;

package/dist/repo/cb.repo.d.ts

@@ -1,94 +1,101 @@
-import { CbAdapterService, type CbEntity, type CbExecOpt } from "../adapter";
-import { Bucket, Cluster, Collection, Scope } from "couchbase";
-import type { CbRepoDef, CbRepoLike } from "./index.types";
-import { Logger } from "@nestjs/common";
-export declare abstract class CbRepo<E extends CbEntity, ID> implements CbRepoLike<E, ID> {
-    protected colName: string;
-    protected cb: CbAdapterService;
-    private _scopeName?;
-    private _bucketName?;
-    private _tryCount;
-    private _pkIndexed;
-    protected logger: Logger;
-    /** @inheritDoc */
-    readonly fullPath: string;
-    /** @inheritDoc */
-    readonly path: string;
-    /** @inheritDoc */
-    readonly cluster: Cluster;
-    /** @inheritDoc */
-    readonly bucket: Bucket;
-    /** @inheritDoc */
-    readonly scope: Scope;
-    /** @inheritDoc */
-    readonly collection: Collection;
-    protected constructor(colName: string, cb: CbAdapterService, _scopeName?: string, _bucketName?: string);
-    private get _randomIndexName();
-    protected _indexName(name: string): string;
-    /**
-     * Fetch urn from doc as doc._urn
-     * */
-    protected _urnFromDoc(doc: Partial<E>, method: string): string;
+import type { CbConnectionLike, CbExecOpt } from "../connection";
+import type { KeyValue } from "@leyyo/common";
+import type { StrKey } from "@leyyo/common";
+import type { CbExistsOpt, CbGetOpt, CbInsertOpt, CbReplaceOpt, CbRepoDef, CbRepoProps, CbRepoLike, CbRepoOpt } from "./index.types";
+import { DbRepo } from "@samet-it/be-db-common";
+import type { DefDims, Entity, Pair, Portion, UrnDocLike, View } from "@samet-it/be-base-common";
+import type { QueryRegular } from "@leyyo/query";
+/**
+ * Couchbase repository abstract class
+ * */
+export declare abstract class CbRepo<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>> extends DbRepo<CbConnectionLike, CbExecOpt, ID, ENTITY, URN, KEYS, DIMS, PAIR, VIEW, PORTION> implements CbRepoLike<ID, ENTITY, URN, KEYS, DIMS, PAIR, VIEW, PORTION> {
+    private static _specs;
+    /** @inheritDoc */
+    protected _props: CbRepoProps<ID, ENTITY>;
+    protected constructor(conn: CbConnectionLike, opt?: CbRepoOpt<ID, ENTITY>);
     /**
-     * Check array keys as id list or urn list
+     * Check property name
+     *
+     * @param {string} value
+     * @return {string}
      * */
-    protected _checkKeys<I extends string | number = string>(keys: I[]): I[];
-    /**
-     * Build update sql as set and unset
-     * */
-    protected _updateSql<T>(urn: string, doc: T): string;
+    protected _checkName(value: string): string;
     /**
      * Execute the creation of index for one field
+     *
+     * @param {string} field - field name
+     * @param {string?} name - index name
      * */
-    protected _createIndex(field: keyof E | string, name?: string): Promise<void>;
+    protected _createIndex(field: keyof ENTITY | string, name?: string): Promise<void>;
     /**
      * Execute the creation of index for complex fields
+     *
+     * @param {Array<string>} fields - field names
+     * @param {string} name - index name
      * */
-    protected _createIndex(fields: Array<keyof E | string>, name: string): Promise<void>;
+    protected _createIndex(fields: Array<keyof ENTITY | string>, name: string): Promise<void>;
     /**
      * Execute the creation of indexes with keys
+     *
+     * @param {...Array<string>} keys - keys of model
      * */
-    protected _createMoreIndices(...keys: Array<keyof E>): Promise<void>;
+    protected _createMoreIndices(...keys: Array<keyof ENTITY>): Promise<void>;
     /**
      * Execute the creation of primary key
      * */
     protected _createPk(): Promise<void>;
+    /** @inheritDoc */
+    protected _afterConnected(): Promise<void>;
+    /**
+     * Load & check bucket by cluster
+     * */
+    private _loadBucket;
+    /**
+     * Load & check scope by bucket
+     * */
+    private _loadScope;
+    /**
+     * Load & check collection by scope
+     * */
+    private _loadCollection;
     /**
-     * Create indices
+     * Create indices in final repo
+     *
+     * can be @override
      * */
-    protected abstract _createIndices(): Promise<void>;
+    protected $createIndices(): Promise<void>;
     /** @inheritDoc */
-    get def(): CbRepoDef;
+    get $def(): CbRepoDef;
     /** @inheritDoc */
-    abstract urn(part: ID): string;
+    get props(): Readonly<CbRepoProps<ID, ENTITY>>;
     /** @inheritDoc */
-    onModuleInit(): Promise<void>;
+    $getByPrimary(key: string, p1?: CbGetOpt | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
     /** @inheritDoc */
-    urnById(id: string, p1?: string | CbExecOpt): Promise<string | undefined>;
+    $getBySecondary(key: KeyValue, p1?: CbGetOpt | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
     /** @inheritDoc */
-    existsByUrn(urn: string, p1?: string | CbExecOpt): Promise<boolean>;
+    $existsByPrimary(key: string, p1?: CbExistsOpt | string, ignoreCheck?: boolean): Promise<boolean>;
     /** @inheritDoc */
-    existsById(id: string, p1?: string | CbExecOpt): Promise<boolean>;
+    $existsBySecondary(key: KeyValue, p1?: CbExistsOpt | string, ignoreCheck?: boolean): Promise<boolean>;
     /** @inheritDoc */
-    getByUrn(urn: string, p1?: string | CbExecOpt): Promise<E | undefined>;
+    $listByPrimary(keys: string[], p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<Array<ENTITY>>;
     /** @inheritDoc */
-    getById(id: string, p1?: string | CbExecOpt): Promise<E | undefined>;
+    $listBySecondary(keys: KeyValue[], p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<Array<ENTITY>>;
     /** @inheritDoc */
-    listByUrn(urnList: string[], p1?: string | CbExecOpt): Promise<Array<E>>;
+    $filter<R = ENTITY, K2 extends string = StrKey<R>>(query: QueryRegular<K2 | KEYS | StrKey<ENTITY>>, p1?: string | CbExecOpt): Promise<Array<R>>;
     /** @inheritDoc */
-    listById(ids: string[], p1?: string | CbExecOpt): Promise<Array<E>>;
+    $insert(doc: ENTITY, p1?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    removeByUrn(urn: string, p1?: string | CbExecOpt): Promise<string>;
+    $replace(doc: ENTITY, p1?: CbReplaceOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    removeById(id: string, p1?: string | CbExecOpt): Promise<string>;
+    $updateByPrimary(key: string, doc: Partial<ENTITY>, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    insert(doc: E, p1?: string | CbExecOpt): Promise<string>;
+    $updateBySecondary(key: KeyValue, doc: Partial<ENTITY>, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    replace(doc: E, p1?: string | CbExecOpt): Promise<string>;
+    $removeByPrimary(key: string, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    upsert(doc: E, p1?: string | CbExecOpt): Promise<string>;
+    $removeBySecondary(key: KeyValue, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    update(doc: Partial<E>, p1?: string | CbExecOpt): Promise<unknown>;
+    $trashByPrimary(key: string, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    trash(doc: E, p1?: string | CbExecOpt): Promise<unknown>;
+    $trashBySecondary(key: KeyValue, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
 }