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

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

@@ -1,10 +1,8 @@
-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 { Bucket, BucketSettings, Cluster, Collection, CollectionSpec, ExistsOptions, GetOptions, InsertOptions, QueryOptions, QueryResult, QueryMetaData, RemoveOptions, ReplaceOptions, Scope, ScopeSpec, UpsertOptions } from "couchbase";
+import type { CbConnectionLike } from "../connection";
+import type { DbExecOpt, DbRepoDirectOpt, DbRepoLike, DbRepoOpt, DbRepoProps } from "@samet-it/be-db-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, StrKey } from "@leyyo/common";
+import type { IgnoreFieldsByType, KeyValue, ReplaceType, StrKey } from "@leyyo/common";
 /**
  * Couchbase repository (collection) interface
  *
@@ -18,9 +16,47 @@ import type { KeyValue, StrKey } from "@leyyo/common";
  * - 6-`KEYS`: keys to autocomplete, def: keys of {@link Entity}
  * - 7-`DIMS`: dimensions for presentation layer {@link DefDims}
  * */
-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> {
+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, QueryMetaData, ENT, ID, URN, VIEW, PAIR, PORTION, KEYS, DIMS> {
     /** @inheritDoc */
     get props(): Readonly<CbRepoProps<ENT, ID>>;
+    /**
+     * Shortcut to {@link CbConnectionLike}
+     * */
+    get conn(): CbConnectionLike;
+    /**
+     * Shortcut to {@link CbConnProps#cluster}
+     * */
+    get cluster(): Cluster;
+    /**
+     * Bucket instance
+     *
+     * @type {Bucket}
+     * */
+    get bucket(): Bucket & CbRepoPropsPart<BucketSettings>;
+    /**
+     * Scope instance
+     *
+     * @type {Scope}
+     * */
+    get scope(): Scope & CbRepoPropsPart<ScopeSpec>;
+    /**
+     * Collection instance
+     *
+     * @type {Collection}
+     * */
+    get collection(): Collection & CbRepoPropsPart<CollectionSpec>;
+    /**
+     * 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;
     /** @inheritDoc */
     insert(doc: ENT, opt?: CbInsertOpt | string, ignoreCheck?: boolean): Promise<string>;
     /** @inheritDoc */
@@ -72,6 +108,24 @@ export interface CbRepoOpt<ENT extends Entity<ID>, ID extends KeyValue = KeyValu
      * @type {string}
      * */
     collectionName?: string;
+    /**
+     * Bucket instance
+     *
+     * @type {Bucket}
+     * */
+    bucket: Bucket & CbRepoPropsPart<BucketSettings>;
+    /**
+     * Scope instance
+     *
+     * @type {Scope}
+     * */
+    scope: Scope & CbRepoPropsPart<ScopeSpec>;
+    /**
+     * Collection instance
+     *
+     * @type {Collection}
+     * */
+    collection: Collection & CbRepoPropsPart<CollectionSpec>;
     /**
      * Create indices when it's started
      *
@@ -87,18 +141,6 @@ export interface CbRepoOpt<ENT extends Entity<ID>, ID extends KeyValue = KeyValu
  * - 1-`ID`: id type {@link KeyValue}
  * */
 export interface CbRepoProps<ENT extends Entity<ID>, ID extends KeyValue = KeyValue> extends CbRepoOpt<ENT, ID>, DbRepoProps<CbConnectionLike, ENT, ID> {
-    /**
-     * Cluster
-     *
-     * @type {Cluster}
-     * */
-    cluster: Cluster;
-    /**
-     * Full collection address
-     *
-     * @type {string}
-     * */
-    full: string;
     /**
      * Bucket instance
      *
@@ -140,20 +182,21 @@ export interface CbRepoPropsPart<SPEC> {
  * - 3-`DIMS`: dimensions for presentation layer {@link DefDims}
  * - 4-`R`: ??
  * */
-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
-     * */
-    name?: string;
-    /**
-     * Overridable method to easy use
-     * */
-    toUrnTuple?: DbRepoToUrnTuple<URN>;
+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>, DbRepoDirectOpt<ENT, ID, URN, DIMS, R> {
+}
+/**
+ * General result for mutable queries to return key
+ * */
+export interface CbResultX {
     /**
-     * Overridable method to easy use
+     * It should be `meta().id`
      * */
-    toDim?: DbRepoToDim<R, ENT, ID, DIMS>;
+    x: string;
 }
+/**
+ * Couchbase query option
+ * */
+export type CbExecOpt = DbExecOpt & QueryOptions;
 /**
  * Couchbase insert query option
  * */
@@ -178,12 +221,3 @@ 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/dist/repo/index.types.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+// endregion query-options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-couchbase-common",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "Couchbase common component",
   "keywords": [
     "Couchbase"
@@ -40,6 +40,7 @@
     "@babel/preset-env": "^7.28.0",
     "@babel/preset-typescript": "^7.27.1",
     "@eslint/js": "^9.33.0",
+    "@types/express": "^5.0.6",
     "@types/jest": "^30.0.0",
     "@types/node": "^24.2.1",
     "@typescript-eslint/eslint-plugin": "^8.39.1",
@@ -66,13 +67,13 @@
     }
   },
   "dependencies": {
-    "@leyyo/common": "^1.2.3",
-    "@leyyo/env": "^1.2.1",
+    "@leyyo/common": "^1.2.4",
+    "@leyyo/env": "^1.2.5",
     "@leyyo/query": "^1.2.1",
     "@leyyo/type": "^1.1.1",
-    "@samet-it/be-base-common": "^1.1.3",
-    "@samet-it/be-cache-common": "^1.1.3",
-    "@samet-it/be-db-common": "^1.1.4",
+    "@samet-it/be-base-common": "^1.1.5",
+    "@samet-it/be-cache-common": "^1.1.10",
+    "@samet-it/be-db-common": "^1.1.9",
     "couchbase": "^4.6.0"
   }
 }