@samet-it/be-couchbase-common 1.1.4 → 1.1.7

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

@@ -1,13 +1,19 @@
 import { CbConnection } from "./cb.connection";
+import { UrnDef } from "@samet-it/be-base-common";
 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";
+import type { KeyValue, StrKey } from "@leyyo/common";
 /**
  * Couchbase connection direct class
  * */
 export declare class CbDirectConnection extends CbConnection implements CbDirectConnectionLike {
+    /**
+     * Constructor
+     *
+     * @param {CbDirectConnOpt} opt - options
+     * */
     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>;
+    newRepo<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef<ID>, VIEW extends View<ID> = ENT, PAIR extends Pair<ID> = Pair<ID>, PORTION extends Portion<ID> = Portion<ID>, KEYS extends string = StrKey<ENT>, DIMS extends DefDims = DefDims, R = unknown>(opt: CbRepoDirectOpt<ENT, ID, URN, DIMS, R>): CbRepoLike<ENT, ID, URN, VIEW, PAIR, PORTION, KEYS, DIMS>;
 }

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

@@ -9,6 +9,11 @@ const repo_1 = require("../repo");
  * Couchbase connection direct class
  * */
 class CbDirectConnection extends cb_connection_1.CbConnection {
+    /**
+     * Constructor
+     *
+     * @param {CbDirectConnOpt} opt - options
+     * */
     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) : ''}`);

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

@@ -9,6 +9,11 @@ import type { DbQueryResultMore, DbQueryResultOne } from "@samet-it/be-db-common
 export declare abstract class CbConnection extends DbConnection<CbRepoLink, QueryMetaData, CbExecOpt> implements CbConnectionLike {
     /** {@inheritDoc} */
     protected _props: CbConnProps;
+    /**
+     * Constructor
+     *
+     * @param {CbConnOpt} opt - options
+     * */
     protected constructor(opt?: CbConnOpt);
     /**
      * Read configuration by variant

package/dist/connection/cb.connection.js

@@ -54,6 +54,11 @@ const type_1 = require("@leyyo/type");
  * */
 class CbConnection extends be_db_common_1.DbConnection {
     // endregion protected-property
+    /**
+     * Constructor
+     *
+     * @param {CbConnOpt} opt - options
+     * */
     constructor(opt) {
         super(opt);
         filter_1.cbFilterUtil.$set(this);

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

@@ -1,8 +1,8 @@
 import type { Cluster, QueryMetaData, QueryOptions, QueryResult, Scope } from "couchbase";
-import type { IgnoreFieldsByType, KeyValue, ReplaceType } from "@leyyo/common";
+import type { IgnoreFieldsByType, KeyValue, ReplaceType, StrKey } from "@leyyo/common";
 import type { CbRepoDirectOpt, CbRepoLike } from "../repo";
 import type { DbConnectionLike, DbConnOpt, DbConnProps, DbExecOpt, DbRepoLink } from "@samet-it/be-db-common";
-import type { DefDims, Entity, UrnDocLike, Pair, Portion, View } from "@samet-it/be-base-common";
+import type { DefDims, Entity, UrnDocLike, Pair, Portion, View, UrnDef } from "@samet-it/be-base-common";
 /**
  * Couchbase connection interface
  * */
@@ -78,10 +78,21 @@ export interface CbDirectConnectionLike extends CbConnectionLike {
     /**
      * Creates new direct repo without dependency injection
      *
+     * Generics:
+     * - 0-`ENT`: entity {@link Entity}
+     * - 1-`ID`: id type {@link KeyValue}
+     * - 2-`URN`: urn interface {@link UrnDocLike}
+     * - 3-`VIEW`: view interface for presentation layer {@link View}
+     * - 4-`PAIR`: pair interface for presentation layer {@link Pair}
+     * - 5-`PORTION`: portion interface for presentation layer {@link Portion}
+     * - 6-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+     * - 7-`DIMS`: dimensions for presentation layer {@link DefDims}
+     * - 8-`R`: ???
+     *
      * @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>;
+    newRepo<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef, VIEW extends View<ID> = ENT, PAIR extends Pair<ID> = Pair<ID>, PORTION extends Portion<ID> = Portion<ID>, KEYS extends string = StrKey<ENT>, DIMS extends DefDims = DefDims, R = unknown>(opt: CbRepoDirectOpt<ENT, ID, URN, DIMS, R>): CbRepoLike<ENT, ID, URN, VIEW, PAIR, PORTION, KEYS, DIMS>;
 }
 export type CbIgnoreDate<T> = CbReplaceType<T, Date, string>;
 export type CbIgnoreDateKeys<T> = CbIgnoreFields<T, Date>;

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

@@ -1,11 +1,27 @@
 import { CbRepo } from "./cb.repo";
-import type { DefDims, Entity, Pair, Portion, UrnDocLike, View } from "@samet-it/be-base-common";
+import type { DefDims, Entity, Pair, Portion, UrnDef, 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";
+import type { KeyValue, StrKey } from "@leyyo/common";
 /**
  * Couchbase repository direct class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`VIEW`: view interface for presentation layer {@link View}
+ * - 4-`PAIR`: pair interface for presentation layer {@link Pair}
+ * - 5-`PORTION`: portion interface for presentation layer {@link Portion}
+ * - 6-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+ * - 7-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
-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>);
+export declare class CbDirectRepo<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef<ID>, VIEW extends View<ID> = ENT, PAIR extends Pair<ID> = Pair<ID>, PORTION extends Portion<ID> = Portion<ID>, KEYS extends string = StrKey<ENT>, DIMS extends DefDims = DefDims> extends CbRepo<ENT, ID, URN, VIEW, PAIR, PORTION, KEYS, DIMS> {
+    /**
+     * Constructor
+     *
+     * @param {CbConnectionLike} conn - couchbase connection
+     * @param {CbRepoDirectOpt} opt - options
+     * */
+    constructor(conn: CbConnectionLike, opt: CbRepoDirectOpt<ENT, ID, URN, DIMS>);
 }

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

@@ -14,8 +14,24 @@ const cb_repo_1 = require("./cb.repo");
 const be_base_common_1 = require("@samet-it/be-base-common");
 /**
  * Couchbase repository direct class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`VIEW`: view interface for presentation layer {@link View}
+ * - 4-`PAIR`: pair interface for presentation layer {@link Pair}
+ * - 5-`PORTION`: portion interface for presentation layer {@link Portion}
+ * - 6-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+ * - 7-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
 class CbDirectRepo extends cb_repo_1.CbRepo {
+    /**
+     * Constructor
+     *
+     * @param {CbConnectionLike} conn - couchbase connection
+     * @param {CbRepoDirectOpt} opt - options
+     * */
     constructor(conn, opt) {
         super(conn, opt);
         if (opt) {

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

@@ -1,18 +1,34 @@
 import type { CbConnectionLike, CbExecOpt } from "../connection";
 import type { KeyValue } from "@leyyo/common";
 import type { StrKey } from "@leyyo/common";
-import type { CbExistsOpt, CbGetOpt, CbInsertOpt, CbReplaceOpt, CbRepoProps, CbRepoLike, CbRepoOpt } from "./index.types";
+import type { CbExistsOpt, CbGetOpt, CbInsertOpt, CbReplaceOpt, CbRepoProps, CbRepoLike, CbRepoOpt, CbUpsertOpt } 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 { DefDims, Entity, Pair, Portion, UrnDef, UrnDocLike, View } from "@samet-it/be-base-common";
 import type { QueryRegular } from "@leyyo/query";
 /**
  * Couchbase repository abstract class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`VIEW`: view interface for presentation layer {@link View}
+ * - 4-`PAIR`: pair interface for presentation layer {@link Pair}
+ * - 5-`PORTION`: portion interface for presentation layer {@link Portion}
+ * - 6-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+ * - 7-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
-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> {
+export declare abstract class CbRepo<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef<ID>, VIEW extends View<ID> = ENT, PAIR extends Pair<ID> = Pair<ID>, PORTION extends Portion<ID> = Portion<ID>, KEYS extends string = StrKey<ENT>, DIMS extends DefDims = DefDims> extends DbRepo<CbConnectionLike, CbExecOpt, ENT, ID, URN, VIEW, PAIR, PORTION, KEYS, DIMS> implements CbRepoLike<ENT, ID, URN, VIEW, PAIR, PORTION, KEYS, DIMS> {
     private static _specs;
     /** @inheritDoc */
-    protected _props: CbRepoProps<ID, ENTITY>;
-    protected constructor(conn: CbConnectionLike, opt?: CbRepoOpt<ID, ENTITY>);
+    protected _props: CbRepoProps<ENT, ID>;
+    /**
+     * Constructor
+     *
+     * @param {CbConnectionLike} conn - couchbase connection
+     * @param {CbRepoOpt} opt - options
+     * */
+    protected constructor(conn: CbConnectionLike, opt?: CbRepoOpt<ENT, ID>);
     /**
      * Check property name
      *
@@ -26,20 +42,20 @@ export declare abstract class CbRepo<ID extends KeyValue, ENTITY extends Entity<
      * @param {string} field - field name
      * @param {string?} name - index name
      * */
-    protected _createIndex(field: keyof ENTITY | string, name?: string): Promise<void>;
+    protected _createIndex(field: keyof ENT | 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 ENTITY | string>, name: string): Promise<void>;
+    protected _createIndex(fields: Array<keyof ENT | string>, name: string): Promise<void>;
     /**
      * Execute the creation of indexes with keys
      *
      * @param {...Array<string>} keys - keys of model
      * */
-    protected _createMoreIndices(...keys: Array<keyof ENTITY>): Promise<void>;
+    protected _createMoreIndices(...keys: Array<keyof ENT>): Promise<void>;
     /**
      * Execute the creation of primary key
      * */
@@ -65,29 +81,31 @@ export declare abstract class CbRepo<ID extends KeyValue, ENTITY extends Entity<
      * */
     protected $createIndices(): Promise<void>;
     /** @inheritDoc */
-    get props(): Readonly<CbRepoProps<ID, ENTITY>>;
+    get props(): Readonly<CbRepoProps<ENT, ID>>;
     /** @inheritDoc */
-    $getByPrimary(key: string, p1?: CbGetOpt | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
+    $getByPrimary(key: string, p1?: CbGetOpt | string, ignoreCheck?: boolean): Promise<ENT | undefined>;
     /** @inheritDoc */
-    $getBySecondary(key: KeyValue, p1?: CbGetOpt | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
+    $getBySecondary(key: KeyValue, p1?: CbGetOpt | string, ignoreCheck?: boolean): Promise<ENT | undefined>;
     /** @inheritDoc */
     $existsByPrimary(key: string, p1?: CbExistsOpt | string, ignoreCheck?: boolean): Promise<boolean>;
     /** @inheritDoc */
     $existsBySecondary(key: KeyValue, p1?: CbExistsOpt | string, ignoreCheck?: boolean): Promise<boolean>;
     /** @inheritDoc */
-    $listByPrimary(keys: string[], p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<Array<ENTITY>>;
+    $listByPrimary(keys: string[], p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
+    /** @inheritDoc */
+    $listBySecondary(keys: KeyValue[], p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<Array<ENT>>;
     /** @inheritDoc */
-    $listBySecondary(keys: KeyValue[], p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<Array<ENTITY>>;
+    $filter<R = ENT, K2 extends string = StrKey<R>>(query: QueryRegular<K2 | KEYS | StrKey<ENT>>, p1?: string | CbExecOpt): Promise<Array<R>>;
     /** @inheritDoc */
-    $filter<R = ENTITY, K2 extends string = StrKey<R>>(query: QueryRegular<K2 | KEYS | StrKey<ENTITY>>, p1?: string | CbExecOpt): Promise<Array<R>>;
+    $insert(doc: ENT, p1?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    $insert(doc: ENTITY, p1?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
+    $replace(doc: ENT, p1?: CbReplaceOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    $replace(doc: ENTITY, p1?: CbReplaceOpt | string, ignoreCheck?: boolean): Promise<string>;
+    $upsert(doc: ENT, p1?: CbUpsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    $updateByPrimary(key: string, doc: Partial<ENTITY>, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
+    $updateByPrimary(key: string, doc: Partial<ENT>, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    $updateBySecondary(key: KeyValue, doc: Partial<ENTITY>, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
+    $updateBySecondary(key: KeyValue, doc: Partial<ENT>, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
     $removeByPrimary(key: string, p1?: CbExecOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */

package/dist/repo/cb.repo.js

@@ -20,9 +20,25 @@ let F_ID;
 let F_TRASH_ID;
 /**
  * Couchbase repository abstract class
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`VIEW`: view interface for presentation layer {@link View}
+ * - 4-`PAIR`: pair interface for presentation layer {@link Pair}
+ * - 5-`PORTION`: portion interface for presentation layer {@link Portion}
+ * - 6-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+ * - 7-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
 class CbRepo extends be_db_common_1.DbRepo {
     // endregion protected-property
+    /**
+     * Constructor
+     *
+     * @param {CbConnectionLike} conn - couchbase connection
+     * @param {CbRepoOpt} opt - options
+     * */
     constructor(conn, opt) {
         var _a, _b, _c;
         super(conn, opt);
@@ -35,13 +51,13 @@ class CbRepo extends be_db_common_1.DbRepo {
         props.scopeName = (_b = props.scopeName) !== null && _b !== void 0 ? _b : conn.props.scopeName;
         props.createIndices = (_c = props.createIndices) !== null && _c !== void 0 ? _c : conn.props.createIndices;
         if (!props.bucketName) {
-            throw new be_db_common_1.DbInvalidValueError('Bucket', typeof props.bucketName, 'CbRepo', 'constructor');
+            throw new be_db_common_1.DbInvalidValueError('Bucket', { where: 'CbRepo', method: 'constructor', type: typeof props.bucketName });
         }
         if (!props.scopeName) {
-            throw new be_db_common_1.DbInvalidValueError('Scope', typeof props.scopeName, 'CbRepo', 'constructor');
+            throw new be_db_common_1.DbInvalidValueError('Scope', { where: 'CbRepo', method: 'constructor', type: typeof props.scopeName });
         }
         if (!props.collectionName) {
-            throw new be_db_common_1.DbInvalidValueError('Collection', typeof props.collectionName, 'CbRepo', 'constructor');
+            throw new be_db_common_1.DbInvalidValueError('Collection', { where: 'CbRepo', method: 'constructor', type: typeof props.collectionName });
         }
         if (!F_URN) {
             F_URN = props.conn.f('_urn');
@@ -234,11 +250,11 @@ class CbRepo extends be_db_common_1.DbRepo {
     /** @inheritDoc */
     $getByPrimary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { conn, useSoftDelete, collection, full } = this._props;
+            const opt = conn.buildOpt(p1, '$getById');
             if (!ignoreCheck) {
                 (0, type_2.assertText)(key, { field: 'id', where: 'CbRepo', method: '$getByPrimary' });
             }
-            const { conn, useSoftDelete, collection, full } = this._props;
-            const opt = conn.buildOpt(p1, '$getById');
             if (!useSoftDelete) {
                 if (!Array.isArray(opt.ignoredErrors)) {
                     opt.ignoredErrors = [];
@@ -402,18 +418,22 @@ class CbRepo extends be_db_common_1.DbRepo {
     /** @inheritDoc */
     $insert(doc, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { conn, collection, useNumericId } = this._props;
+            const { conn, collection, noInsert, useNumericId } = this._props;
+            const opt = conn.buildOpt(p1, '$insert');
+            const param = { where: 'CbRepo', method: '$insert', queryName: opt.name };
+            if (noInsert) {
+                throw new be_db_common_1.DbNotSupportedError('Insert', param);
+            }
             if (!ignoreCheck) {
-                (0, type_2.assertObject)(doc, { field: 'doc', where: 'CbRepo', method: '$insert' });
-                (0, type_2.assertText)(doc._urn, { field: 'doc._urn', where: 'CbRepo', method: '$insert' });
+                (0, type_2.assertObject)(doc, Object.assign({ field: 'doc' }, param));
+                (0, type_2.assertText)(doc._urn, Object.assign({ field: 'doc._urn' }, param));
                 if (useNumericId) {
-                    (0, type_1.assertInteger)(doc.id, { field: 'doc.id', where: 'CbRepo', method: '$insert' });
+                    (0, type_1.assertInteger)(doc.id, Object.assign({ field: 'doc.id' }, param));
                 }
                 else {
-                    (0, type_2.assertText)(doc.id, { field: 'doc.id', where: 'CbRepo', method: '$insert' });
+                    (0, type_2.assertText)(doc.id, Object.assign({ field: 'doc.id' }, param));
                 }
             }
-            const opt = conn.buildOpt(p1, '$insert');
             yield conn.exec(collection.insert(doc._urn, doc), opt);
             return doc._urn;
         });
@@ -423,33 +443,66 @@ class CbRepo extends be_db_common_1.DbRepo {
     /** @inheritDoc */
     $replace(doc, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { conn, collection, useNumericId } = this._props;
+            const { conn, collection, noUpdate, useNumericId } = this._props;
+            const opt = conn.buildOpt(p1, '$replace');
+            const param = { where: 'CbRepo', method: '$replace', queryName: opt.name };
+            if (noUpdate) {
+                throw new be_db_common_1.DbNotSupportedError('Update', param);
+            }
             if (!ignoreCheck) {
-                (0, type_2.assertObject)(doc, { field: 'doc', where: 'CbRepo', method: '$replace' });
-                (0, type_2.assertText)(doc._urn, { field: 'doc._urn', where: 'CbRepo', method: '$replace' });
+                (0, type_2.assertObject)(doc, Object.assign({ field: 'doc' }, param));
+                (0, type_2.assertText)(doc._urn, Object.assign({ field: 'doc._urn' }, param));
                 if (useNumericId) {
-                    (0, type_1.assertInteger)(doc.id, { field: 'doc.id', where: 'CbRepo', method: '$replace' });
+                    (0, type_1.assertInteger)(doc.id, Object.assign({ field: 'doc.id' }, param));
                 }
                 else {
-                    (0, type_2.assertText)(doc.id, { field: 'doc.id', where: 'CbRepo', method: '$replace' });
+                    (0, type_2.assertText)(doc.id, Object.assign({ field: 'doc.id' }, param));
                 }
             }
-            const opt = conn.buildOpt(p1, '$replace');
             yield conn.exec(collection.replace(doc._urn, doc), opt);
             return doc._urn;
         });
     }
     // endregion replace
+    // region upsert
+    /** @inheritDoc */
+    $upsert(doc, p1, ignoreCheck) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { conn, collection, noUpdate, noInsert, useNumericId } = this._props;
+            const opt = conn.buildOpt(p1, '$upsert');
+            const param = { where: 'CbRepo', method: '$upsert', queryName: opt.name };
+            if (noUpdate || noInsert) {
+                throw new be_db_common_1.DbNotSupportedError('Upsert', param);
+            }
+            if (!ignoreCheck) {
+                (0, type_2.assertObject)(doc, Object.assign({ field: 'doc' }, param));
+                (0, type_2.assertText)(doc._urn, Object.assign({ field: 'doc._urn' }, param));
+                if (useNumericId) {
+                    (0, type_1.assertInteger)(doc.id, Object.assign({ field: 'doc.id' }, param));
+                }
+                else {
+                    (0, type_2.assertText)(doc.id, Object.assign({ field: 'doc.id' }, param));
+                }
+            }
+            yield conn.exec(collection.upsert(doc._urn, doc), opt);
+            return doc._urn;
+        });
+    }
+    // endregion upsert
     // region update
     /** @inheritDoc */
     $updateByPrimary(key, doc, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { conn, full, noUpdate, useSoftDelete } = this._props;
+            const opt = conn.buildOpt(p1, '$updateByPrimary');
+            const param = { where: 'CbRepo', method: '$updateByPrimary', queryName: opt.name };
+            if (noUpdate) {
+                throw new be_db_common_1.DbNotSupportedError('Update', param);
+            }
             if (!ignoreCheck) {
-                (0, type_2.assertText)(key, { field: 'key', where: 'CbRepo', method: '$updateByPrimary' });
-                (0, type_2.assertObject)(doc, { field: 'doc', where: 'CbRepo', method: '$updateByPrimary' });
+                (0, type_2.assertText)(key, Object.assign({ field: 'key' }, param));
+                (0, type_2.assertObject)(doc, Object.assign({ field: 'doc' }, param));
             }
-            const { conn, full, useSoftDelete } = this._props;
-            const opt = conn.buildOpt(p1, '$updateByPrimary');
             const parameters = {};
             let paramId = 0;
             const set = [];
@@ -487,17 +540,21 @@ class CbRepo extends be_db_common_1.DbRepo {
     $updateBySecondary(key, doc, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const { useNumericId, useSoftDelete, conn, full } = this._props;
+            const { useNumericId, noUpdate, useSoftDelete, conn, full } = this._props;
+            const opt = conn.buildOpt(p1, '$updateBySecondary');
+            const param = { where: 'CbRepo', method: '$updateBySecondary', queryName: opt.name };
+            if (noUpdate) {
+                throw new be_db_common_1.DbNotSupportedError('Update', param);
+            }
             if (!ignoreCheck) {
                 if (useNumericId) {
-                    (0, type_1.assertInteger)(key, { field: 'key', where: 'CbRepo', method: '$updateBySecondary' });
+                    (0, type_1.assertInteger)(key, Object.assign({ field: 'key' }, param));
                 }
                 else {
-                    (0, type_2.assertText)(key, { field: 'key', where: 'CbRepo', method: '$updateBySecondary' });
+                    (0, type_2.assertText)(key, Object.assign({ field: 'key' }, param));
                 }
-                (0, type_2.assertObject)(doc, { field: 'doc', where: 'CbRepo', method: '$updateBySecondary' });
+                (0, type_2.assertObject)(doc, Object.assign({ field: 'doc' }, param));
             }
-            const opt = conn.buildOpt(p1, '$updateBySecondary');
             const parameters = {};
             let paramId = 0;
             const set = [];
@@ -536,11 +593,15 @@ class CbRepo extends be_db_common_1.DbRepo {
     /** @inheritDoc */
     $removeByPrimary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { useSoftDelete, noRemove, conn, full, collection } = this._props;
+            const opt = conn.buildOpt(p1, '$removeByPrimary');
+            const param = { where: 'CbRepo', method: '$removeByPrimary', queryName: opt.name };
+            if (noRemove) {
+                throw new be_db_common_1.DbNotSupportedError('Remove', param);
+            }
             if (!ignoreCheck) {
-                (0, type_2.assertText)(key, { field: 'key', where: 'CbRepo', method: '$removeByPrimary' });
+                (0, type_2.assertText)(key, Object.assign({ field: 'key' }, param));
             }
-            const { useSoftDelete, conn, full, collection } = this._props;
-            const opt = conn.buildOpt(p1, '$removeByPrimary');
             if (!useSoftDelete) {
                 yield conn.exec(collection.remove(key, opt), opt);
                 return key;
@@ -560,16 +621,20 @@ class CbRepo extends be_db_common_1.DbRepo {
     $removeBySecondary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const { useNumericId, useSoftDelete, conn, full } = this._props;
+            const { useNumericId, noRemove, useSoftDelete, conn, full } = this._props;
+            const opt = conn.buildOpt(p1, '$removeBySecondary');
+            const param = { where: 'CbRepo', method: '$removeBySecondary', queryName: opt.name };
+            if (noRemove) {
+                throw new be_db_common_1.DbNotSupportedError('Remove', param);
+            }
             if (!ignoreCheck) {
                 if (useNumericId) {
-                    (0, type_1.assertInteger)(key, { field: 'key', where: 'CbRepo', method: '$removeBySecondary' });
+                    (0, type_1.assertInteger)(key, Object.assign({ field: 'key' }, param));
                 }
                 else {
-                    (0, type_2.assertText)(key, { field: 'key', where: 'CbRepo', method: '$removeBySecondary' });
+                    (0, type_2.assertText)(key, Object.assign({ field: 'key' }, param));
                 }
             }
-            const opt = conn.buildOpt(p1, '$removeBySecondary');
             const lines = (0, be_db_common_1.dbLines)();
             lines
                 .add('DELETE')
@@ -586,14 +651,18 @@ class CbRepo extends be_db_common_1.DbRepo {
     /** @inheritDoc */
     $trashByPrimary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { useSoftDelete, conn, full } = this._props;
+            const { useSoftDelete, noTrash, conn, full } = this._props;
+            const opt = conn.buildOpt(p1, '$trashByPrimary');
+            const param = { where: 'CbRepo', method: '$trashByPrimary', queryName: opt.name };
+            if (noTrash) {
+                throw new be_db_common_1.DbNotSupportedError('Trash', param);
+            }
             if (!useSoftDelete) {
-                throw new be_db_common_1.DbNotSupportedError('Soft delete', 'CbRepo', '$trashByPrimary');
+                throw new be_db_common_1.DbNotSupportedError('Soft delete', param);
             }
             if (!ignoreCheck) {
-                (0, type_2.assertText)(key, { field: 'key', where: 'CbRepo', method: '$trashByPrimary' });
+                (0, type_2.assertText)(key, Object.assign({ field: 'key' }, param));
             }
-            const opt = conn.buildOpt(p1, '$trashByPrimary');
             const lines = (0, be_db_common_1.dbLines)();
             lines
                 .add(`UPDATE ${full} a`)
@@ -615,19 +684,23 @@ class CbRepo extends be_db_common_1.DbRepo {
     $trashBySecondary(key, p1, ignoreCheck) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const { useSoftDelete, useNumericId, conn, full } = this._props;
+            const { useSoftDelete, noTrash, useNumericId, conn, full } = this._props;
+            const opt = conn.buildOpt(p1, '$trashBySecondary');
+            const param = { where: 'CbRepo', method: '$trashBySecondary', queryName: opt.name };
+            if (noTrash) {
+                throw new be_db_common_1.DbNotSupportedError('Trash', param);
+            }
             if (!useSoftDelete) {
-                throw new be_db_common_1.DbNotSupportedError('Soft delete', 'CbRepo', '$trashBySecondary');
+                throw new be_db_common_1.DbNotSupportedError('Soft delete', param);
             }
             if (!ignoreCheck) {
                 if (useNumericId) {
-                    (0, type_1.assertInteger)(key, { field: 'key', where: 'CbRepo', method: '$trashBySecondary' });
+                    (0, type_1.assertInteger)(key, Object.assign({ field: 'key' }, param));
                 }
                 else {
-                    (0, type_2.assertText)(key, { field: 'key', where: 'CbRepo', method: '$trashBySecondary' });
+                    (0, type_2.assertText)(key, Object.assign({ field: 'key' }, param));
                 }
             }
-            const opt = conn.buildOpt(p1, '$trashBySecondary');
             const lines = (0, be_db_common_1.dbLines)();
             lines
                 .add(`UPDATE ${full} a`)

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

@@ -1,36 +1,40 @@
-import type { Bucket, BucketSettings, Cluster, Collection, CollectionSpec, RemoveOptions, Scope, ScopeSpec } from "couchbase";
+import type { Bucket, BucketSettings, Cluster, Collection, CollectionSpec, RemoveOptions, Scope, ScopeSpec, UpsertOptions } from "couchbase";
 import type { CbConnectionLike, CbExecOpt } from "../connection";
 import type { DbRepoLike, DbRepoOpt, DbRepoToDim, DbRepoToUrnTuple } from "@samet-it/be-db-common";
-import type { DefDims, Entity, Pair, Portion, UrnDocLike, View } from "@samet-it/be-base-common";
+import type { DefDims, Entity, Pair, Portion, UrnDef, UrnDocLike, View } from "@samet-it/be-base-common";
 import type { ExistsOptions, GetOptions, InsertOptions, ReplaceOptions } from "couchbase";
 import type { DbRepoProps } from "@samet-it/be-db-common";
-import type { KeyValue } from "@leyyo/common";
-/**
- * General result for mutable queries to return key
- * */
-export interface CbResultX {
-    /**
-     * It should be `meta().id`
-     * */
-    x: string;
-}
+import type { KeyValue, StrKey } from "@leyyo/common";
 /**
  * Couchbase repository (collection) interface
- * @abstract
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`VIEW`: view interface for presentation layer {@link View}
+ * - 4-`PAIR`: pair interface for presentation layer {@link Pair}
+ * - 5-`PORTION`: portion interface for presentation layer {@link Portion}
+ * - 6-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
+ * - 7-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
-export interface CbRepoLike<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 DbRepoLike<CbConnectionLike, CbExecOpt, ID, ENTITY, URN, KEYS, DIMS, PAIR, VIEW, PORTION> {
+export interface CbRepoLike<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef<ID>, VIEW extends View<ID> = ENT, PAIR extends Pair<ID> = Pair<ID>, PORTION extends Portion<ID> = Portion<ID>, KEYS extends string = StrKey<ENT>, DIMS extends DefDims = DefDims> extends DbRepoLike<CbConnectionLike, CbExecOpt, ENT, ID, URN, VIEW, PAIR, PORTION, KEYS, DIMS> {
+    /** @inheritDoc */
+    get props(): Readonly<CbRepoProps<ENT, ID>>;
+    /** @inheritDoc */
+    insert(doc: ENT, opt?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    get props(): Readonly<CbRepoProps<ID, ENTITY>>;
+    inserts(docs: Array<ENT>, opt?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<Array<string>>;
     /** @inheritDoc */
-    insert(doc: ENTITY, opt?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
+    $insert(doc: ENT, opt?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    inserts(docs: Array<ENTITY>, opt?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<Array<string>>;
+    replace(doc: ENT, opt?: CbReplaceOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    $insert(doc: ENTITY, opt?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
+    $replace(doc: ENT, opt?: CbReplaceOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    replace(doc: ENTITY, opt?: CbReplaceOpt | string, ignoreCheck?: boolean): Promise<string>;
+    upsert(doc: ENT, opt?: CbUpsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
-    $replace(doc: ENTITY, opt?: CbReplaceOpt | string, ignoreCheck?: boolean): Promise<string>;
+    $upsert(doc: ENT, opt?: CbUpsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
     remove(key: KeyValue, opt?: CbRemoveOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
@@ -44,8 +48,12 @@ export interface CbRepoLike<ID extends KeyValue, ENTITY extends Entity<ID>, URN
 }
 /**
  * Couchbase repository (collection) option
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
  * */
-export interface CbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> extends DbRepoOpt<ID, ENTITY> {
+export interface CbRepoOpt<ENT extends Entity<ID>, ID extends KeyValue = KeyValue> extends DbRepoOpt<ENT, ID> {
     /**
      * Bucket name
      *
@@ -73,8 +81,12 @@ export interface CbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> exten
 }
 /**
  * Couchbase repository (collection) props
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
  * */
-export interface CbRepoProps<ID extends KeyValue, ENTITY extends Entity<ID>> extends CbRepoOpt<ID, ENTITY>, DbRepoProps<CbConnectionLike, ID, ENTITY> {
+export interface CbRepoProps<ENT extends Entity<ID>, ID extends KeyValue = KeyValue> extends CbRepoOpt<ENT, ID>, DbRepoProps<CbConnectionLike, ENT, ID> {
     /**
      * Cluster
      *
@@ -108,17 +120,27 @@ export interface CbRepoProps<ID extends KeyValue, ENTITY extends Entity<ID>> ext
 }
 /**
  * Couchbase repository (collection) props part for extended usage
+ *
+ * Generics:
+ * - 0-`SPEC`: spec model
  * */
-export interface CbRepoPropsPart<S> {
+export interface CbRepoPropsPart<SPEC> {
     /**
      * Extended property to hold couchbase specs
      * */
-    readonly $spec?: S;
+    readonly $spec?: SPEC;
 }
 /**
  * Couchbase direct repository (collection) option
+ *
+ * Generics:
+ * - 0-`ENT`: entity {@link Entity}
+ * - 1-`ID`: id type {@link KeyValue}
+ * - 2-`URN`: urn interface {@link UrnDocLike}
+ * - 3-`DIMS`: dimensions for presentation layer {@link DefDims}
+ * - 4-`R`: ??
  * */
-export interface CbRepoDirectOpt<ID extends KeyValue, ENTITY extends Entity<ID>, URN extends UrnDocLike, DIMS extends DefDims = DefDims, R = unknown> extends CbRepoOpt<ID, ENTITY> {
+export interface CbRepoDirectOpt<ENT extends Entity<ID>, ID extends KeyValue = KeyValue, URN extends UrnDocLike = UrnDef<ID>, DIMS extends DefDims = DefDims, R = unknown> extends CbRepoOpt<ENT, ID> {
     /**
      * Name of logger class
      * */
@@ -130,7 +152,7 @@ export interface CbRepoDirectOpt<ID extends KeyValue, ENTITY extends Entity<ID>,
     /**
      * Overridable method to easy use
      * */
-    toDim?: DbRepoToDim<R, ID, ENTITY, DIMS>;
+    toDim?: DbRepoToDim<R, ENT, ID, DIMS>;
 }
 /**
  * Couchbase insert query option
@@ -152,3 +174,16 @@ export type CbExistsOpt = CbExecOpt & ExistsOptions;
  * Couchbase get query option
  * */
 export type CbGetOpt = CbExecOpt & GetOptions;
+/**
+ * Couchbase upsert query option
+ * */
+export type CbUpsertOpt = CbExecOpt & UpsertOptions;
+/**
+ * General result for mutable queries to return key
+ * */
+export interface CbResultX {
+    /**
+     * It should be `meta().id`
+     * */
+    x: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-couchbase-common",
-  "version": "1.1.4",
+  "version": "1.1.7",
   "description": "Couchbase common component",
   "keywords": [
     "Couchbase"
@@ -66,13 +66,13 @@
     }
   },
   "dependencies": {
-    "@leyyo/common": "^1.2.1",
+    "@leyyo/common": "^1.2.3",
     "@leyyo/env": "^1.2.1",
     "@leyyo/query": "^1.2.1",
     "@leyyo/type": "^1.1.1",
-    "@samet-it/be-base-common": "^1.1.1",
-    "@samet-it/be-cache-common": "^1.1.1",
-    "@samet-it/be-db-common": "^1.1.2",
+    "@samet-it/be-base-common": "^1.1.3",
+    "@samet-it/be-cache-common": "^1.1.3",
+    "@samet-it/be-db-common": "^1.1.4",
     "couchbase": "^4.6.0"
   }
 }