@samet-it/be-db-common 1.0.11 → 1.1.1

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

@@ -3,7 +3,7 @@ import type { DbConnectionBase, DbExecOpt } from "../connection";
 import type { DefDims, Portion, View } from "@samet-it/be-base-common";
 import type { QueryAny, QueryRegular } from "@leyyo/query";
 import type { CacheConnectionLike, CacheChannelLike } from "@samet-it/be-cache-common";
-import type { Fnc, KeyValue, StrKey } from "@leyyo/common";
+import type { KeyValue, StrKey } from "@leyyo/common";
 /**
  * Urn delimiter literals (options)
  * */
@@ -391,7 +391,6 @@ export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt
      *
      * @param {Entity} doc - document object
      * @param {string?} dim - dimension, default: `def`
-     * @param {boolean?} ignoreCheck - ignores to check input
      * @return {Promise<IdDocLike>} - dim object
      * @async
      * */
@@ -501,20 +500,22 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
     /**
      * Model version
      *
-     * @default `1.0.0`
-     * @type {string}
+     * @default 1
+     * @type {number}
      * */
     version?: number;
     /**
      * Urn delimiter
      *
-     * @default `,` -- use comma
+     * @default ","
      * @type {UrnDelimiter}
      * */
     urnDelimiter?: UrnDelimiter;
     /**
      * Urn prefix, like domain:subdomain
      *
+     * @example domain:subdomain
+     *
      * @type {string}
      * */
     urnPrefix?: string;
@@ -522,7 +523,8 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * Id format, number or string
      * - if yes, it evaluates as integer
      * - if no, it evaluates as string, uuid etc
-     * @default `false`
+     *
+     * @default false
      * */
     useNumericId?: boolean;
     /**
@@ -531,7 +533,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it generates number - timestamp
      *
      * @fields `createdAt`, `updatedAt`
-     * @default `false`
+     * @default false
      * */
     useIsoDate?: boolean;
     /**
@@ -539,8 +541,8 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if yes, id is same with urn
      * - if no, id is not same with urn
      *
-     * @fields `_urn`
-     * @default `false`
+     * @fields `_urn`, `id`
+     * @default false
      * */
     idSame?: boolean;
     /**
@@ -549,7 +551,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it validates trash case
      *
      * @fields `_trashId`
-     * @default `false`
+     * @default false
      * */
     useSoftDelete?: boolean;
     /**
@@ -558,7 +560,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it ignores `createdAt`
      *
      * @fields `createdAt`
-     * @default `false`
+     * @default false
      * */
     useCreatedAt?: boolean;
     /**
@@ -567,7 +569,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it ignores `createdBy`
      *
      * @fields `createdBy`
-     * @default `false`
+     * @default false
      * */
     useCreatedBy?: boolean;
     /**
@@ -576,7 +578,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it builds updatedAt
      *
      * @fields `updatedAt`
-     * @default `false`
+     * @default false
      * */
     useUpdatedAt?: boolean;
     /**
@@ -585,7 +587,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it ignores `updatedBy`
      *
      * @fields `updatedBy`
-     * @default `false`
+     * @default false
      * */
     useUpdatedBy?: boolean;
     /**
@@ -594,7 +596,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it ignores `_ver`
      *
      * @fields `_ver`
-     * @default `false`
+     * @default false
      * */
     useVersion?: boolean;
     /**
@@ -603,7 +605,7 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it ignores `_rev`
      *
      * @fields `_rev`
-     * @default `false`
+     * @default false
      * */
     useRevision?: boolean;
     /**
@@ -612,27 +614,33 @@ export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
      * - if no, it ignores `_alpha`
      *
      * @fields `_alpha`
-     * @default `false`
+     *
+     * @param {Entity} doc
+     * @async
      * */
-    alphaFn?: Fnc;
+    alphaFn?: DbRepoExtensionLambda<ID, ENTITY>;
     /**
      * Manages `search` case, to power search
      * - if yes, it builds `_search`
      * - if no, it ignores `_search`
      *
-     * @fields `_alpha`
-     * @default `false`
+     * @fields `_search`
+     *
+     * @param {Entity} doc
+     * @async
      * */
-    searchFn?: Fnc;
+    searchFn?: DbRepoExtensionLambda<ID, ENTITY>;
     /**
      * Manages `irregular` case, to store irregular field which is not in model
      * - if yes, it builds `_irregular`
      * - if no, it ignores `_irregular`
      *
      * @fields `_irregular`
-     * @default `false`
+     *
+     * @param {Entity} doc
+     * @async
      * */
-    irregularFn?: Fnc;
+    irregularFn?: DbRepoExtensionLambda<ID, ENTITY>;
     /**
      * Field list which can not be set (update/replace)
      *
@@ -683,19 +691,62 @@ export interface DbCheckKeysResult<ID extends KeyValue> {
     urns: Array<string>;
     ordered: Array<DbCheckKeysTuple<ID>>;
 }
+/**
+ * Response model during key is being checked
+ * @tuple
+ *
+ * Options
+ * - if primary(urn) => `[value (string), '_urn'];
+ * - if secondary(id) => `[value (string|number), 'id'];
+ * */
 export type DbCheckKeysTuple<ID extends KeyValue> = [string, '_urn'] | [ID, 'id'];
 /**
  * DB `$toUrnTuple` lambda
- * @function
+ *
+ * @see {@link DbRepoLike#$toUrnTuple}
+ * @method
+ *
+ * @param {UrnDocLike} urnRec - an object which will be a source to generate an urn
+ * @return {UrnTuple} - tuple
  * */
 export type DbRepoToUrnTuple<URN extends UrnDocLike = UrnDocLike> = (urnRec: URN) => UrnTuple;
 /**
  * DB `toDim` lambda
- * @function
+ *
+ * @see {@link DbRepoLike#$toDim}
+ * @method
+ *
+ * @param {Entity} doc - document
+ * @param {DefDims} dim - dimension
  * */
 export type DbRepoToDim<R, ID extends KeyValue, ENTITY extends Entity<ID>, DIMS extends DefDims = DefDims> = (doc: ENTITY, dim: DIMS | undefined) => Promise<R>;
+/**
+ * Default model which contains keys
+ * */
 export interface DbIdLike {
+    /**
+     * Secondary key for an entity
+     *
+     * @type {KeyValue}
+     */
     id?: KeyValue;
-    urn?: string;
+    /**
+     * Primary key for an entity
+     *
+     * @type {string}
+     */
     _urn?: string;
+    /**
+     * Alternative usage for {@link #_urn}
+     *
+     * @type {string}
+     */
+    urn?: string;
 }
+/**
+ * Lambda to handle several extensions, ie: search, ...
+ *
+ * @param {Entity} doc - document
+ * @async
+ * */
+export type DbRepoExtensionLambda<ID extends KeyValue, ENTITY extends Entity<ID>> = (doc: ENTITY) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@samet-it/be-db-common",
-  "version": "1.0.11",
+  "version": "1.1.1",
   "description": "Backend DB Common",
   "repository": {
     "type": "git",
@@ -63,8 +63,8 @@
     }
   },
   "dependencies": {
+    "@leyyo/query": "^1.2.2",
     "@leyyo/common": "^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"