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

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

@@ -11,6 +11,9 @@ export declare abstract class CbConnection extends DbConnection<CbRepoDef, Query
     /** {@inheritDoc} */
     protected _props: CbConnProps;
     protected constructor(opt?: CbConnOpt);
+    /**
+     * Read configuration by variant
+     * */
     protected _readEnv(): void;
     /** {@inheritDoc} */
     get props(): Readonly<CbConnProps>;

package/dist/connection/cb.connection.js

@@ -1,5 +1,4 @@
 "use strict";
-// ~~console.log(__filename);
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -61,6 +60,9 @@ class CbConnection extends be_db_common_1.DbConnection {
         this._readEnv();
     }
     // region protected-method
+    /**
+     * Read configuration by variant
+     * */
     _readEnv() {
         var _a, _b, _c, _d, _e, _f, _g, _h;
         const { _props: props } = this;

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

@@ -50,7 +50,7 @@ export interface CbConnOpt extends DbConnOpt {
  * */
 export interface CbDirectConnOpt extends CbConnOpt {
     /**
-     * Log name
+     * Logger name
      *
      * @type {string}
      * */

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

@@ -8,22 +8,36 @@ import type { QueryRegular } from "@leyyo/query";
 /**
  * Couchbase repository abstract class
  * */
-export declare 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<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 property name
+     *
+     * @param {string} value
+     * @return {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 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 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 ENTITY>): Promise<void>;
     /**
@@ -32,11 +46,22 @@ export declare class CbRepo<ID extends KeyValue, ENTITY extends Entity<ID>, URN
     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 in final repo
+     *
+     * can be @override
      * */
     protected $createIndices(): Promise<void>;
     /** @inheritDoc */

package/dist/repo/cb.repo.js

@@ -50,6 +50,12 @@ class CbRepo extends be_db_common_1.DbRepo {
         }
     }
     // region protected-method
+    /**
+     * Check property name
+     *
+     * @param {string} value
+     * @return {string}
+     * */
     _checkName(value) {
         if (typeof value === 'string') {
             value = value.trim();
@@ -64,6 +70,9 @@ class CbRepo extends be_db_common_1.DbRepo {
     }
     /**
      * Execute the creation of index
+     *
+     * @param {OneOrMore<string>} p1 - field name or field names
+     * @param {string?} name - index name
      * */
     _createIndex(p1, name) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -92,6 +101,8 @@ class CbRepo extends be_db_common_1.DbRepo {
     // noinspection JSUnusedGlobalSymbols
     /**
      * Execute the creation of indexes with keys
+     *
+     * @param {...Array<string>} keys - keys of model
      * */
     _createMoreIndices(...keys) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -139,6 +150,9 @@ class CbRepo extends be_db_common_1.DbRepo {
             }
         });
     }
+    /**
+     * Load & check bucket by cluster
+     * */
     _loadBucket() {
         return __awaiter(this, void 0, void 0, function* () {
             const { _props: props } = this;
@@ -159,6 +173,9 @@ class CbRepo extends be_db_common_1.DbRepo {
             props.bucket = ins;
         });
     }
+    /**
+     * Load & check scope by bucket
+     * */
     _loadScope() {
         return __awaiter(this, void 0, void 0, function* () {
             const { _props: props } = this;
@@ -179,6 +196,9 @@ class CbRepo extends be_db_common_1.DbRepo {
             props.scope = ins;
         });
     }
+    /**
+     * Load & check collection by scope
+     * */
     _loadCollection() {
         return __awaiter(this, void 0, void 0, function* () {
             const { _props: props } = this;
@@ -195,6 +215,8 @@ class CbRepo extends be_db_common_1.DbRepo {
     }
     /**
      * Create indices in final repo
+     *
+     * can be @override
      * */
     $createIndices() {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -5,7 +5,13 @@ import type { DefDims, Entity, Pair, Portion, UrnDocLike, View } from "@samet-it
 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;
 }
 /**
@@ -110,14 +116,26 @@ export interface CbRepoProps<ID extends KeyValue, ENTITY extends Entity<ID>> ext
  * Couchbase repository (collection) props part for extended usage
  * */
 export interface CbRepoPropsPart<S> {
+    /**
+     * Extended property to hold couchbase specs
+     * */
     readonly $spec?: S;
 }
 /**
  * Couchbase direct repository (collection) option
  * */
 export interface CbRepoDirectOpt<ID extends KeyValue, ENTITY extends Entity<ID>, URN extends UrnDocLike, DIMS extends DefDims = DefDims, R = unknown> extends CbRepoOpt<ID, ENTITY> {
+    /**
+     * Name of logger class
+     * */
     name?: string;
+    /**
+     * Overridable method to easy use
+     * */
     toUrnTuple?: DbRepoToUrnTuple<URN>;
+    /**
+     * Overridable method to easy use
+     * */
     toDim?: DbRepoToDim<R, ID, ENTITY, DIMS>;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-couchbase-common",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Couchbase common component",
   "keywords": [
     "Couchbase"