@samet-it/be-db-common 1.0.11

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

@@ -0,0 +1,701 @@
+import type { Entity, IdDocLike, Pair, UrnDocLike, UrnTuple } from "@samet-it/be-base-common";
+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";
+/**
+ * Urn delimiter literals (options)
+ * */
+export type UrnDelimiter = ',' | '|' | ';' | '/';
+/**
+ * DB repository interface
+ * */
+export interface DbRepoLike<CONN extends DbConnectionBase, OPT extends DbExecOpt, ID extends KeyValue, ENTITY extends Entity<ID>, URN extends UrnDocLike, KEYS extends string, DIMS extends DefDims, PAIR extends Pair<ID>, VIEW extends View<ID>, PORTION extends Portion<ID>> {
+    /**
+     * Props on repository
+     * */
+    get props(): Readonly<DbRepoProps<CONN, ID, ENTITY>>;
+    /**
+     * Converts current instance to flatten instance with ignoring generics
+     * */
+    get $def(): DbRepoDef;
+    /**
+     * Casts current instance to given type
+     * */
+    $cast<T>(): T;
+    /**
+     * Build urn with prefix from urn object
+     *
+     * @param {UrnDocLike} urnRec - urn object
+     * @return {string} - urn
+     * */
+    toUrn(urnRec: URN): string;
+    /**
+     * Generates urn tuple
+     *
+     * @param {UrnDocLike} urnRec - urn object
+     * @return {UrnTuple} - urn tuple
+     * */
+    $toUrnTuple(urnRec: URN): UrnTuple;
+    /**
+     * Get document by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @return {Promise<Entity?>} - document
+     * @async
+     * */
+    get(key: KeyValue, opt?: OPT | string): Promise<ENTITY | undefined>;
+    /**
+     * Get document by primary key
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Entity?>} - document
+     * @async
+     * */
+    getByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
+    /**
+     * Get document by primary key without cache
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Entity?>} - document
+     * @async
+     * */
+    $getByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
+    /**
+     * Get document by secondary key
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Entity?>} - document
+     * @async
+     * */
+    getBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
+    /**
+     * Get document by secondary key without cache
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Entity?>} - document
+     * @async
+     * */
+    $getBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<ENTITY | undefined>;
+    /**
+     * Document exists by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @return {Promise<boolean>} - exists or not
+     * @async
+     * */
+    exists(key: KeyValue, opt?: OPT | string): Promise<boolean>;
+    /**
+     * Document exists by primary key
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<boolean>} - exists or not
+     * @async
+     * */
+    existsByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<boolean>;
+    /**
+     * Document exists by primary key without cache
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<boolean>} - exists or not
+     * @async
+     * */
+    $existsByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<boolean>;
+    /**
+     * Document exists by secondary key
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<boolean>} - exists or not
+     * @async
+     * */
+    existsBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<boolean>;
+    /**
+     * Document exists by secondary key without cache
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<boolean>} - exists or not
+     * @async
+     * */
+    $existsBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<boolean>;
+    /**
+     * List documents by keys (primary or secondary)
+     *
+     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Array<Entity>>} - documents
+     * @async
+     * */
+    list(keys: Array<KeyValue>, opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENTITY>>;
+    /**
+     * List documents by primary keys
+     *
+     * @param {Array<string>} keys - primary keys
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Array<Entity>>} - documents
+     * @async
+     * */
+    $listByPrimary(keys: string[], opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENTITY>>;
+    /**
+     * List documents by secondary keys
+     *
+     * @param {Array<KeyValue>} keys - secondary keys
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Array<Entity>>} - documents
+     * @async
+     * */
+    $listBySecondary(keys: Array<KeyValue>, opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<ENTITY>>;
+    /**
+     * Filter documents
+     *
+     * @param {QueryAny} query - query object
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @return {Promise<Array<Entity>>} - documents
+     * @async
+     * */
+    filter<R = ENTITY, K2 extends string = StrKey<R>>(query: QueryAny<K2 | KEYS | StrKey<ENTITY>>, opt?: OPT | string): Promise<Array<R>>;
+    $filter<R = ENTITY, K2 extends string = StrKey<R>>(query: QueryRegular<K2 | KEYS | StrKey<ENTITY>>, opt?: OPT | string): Promise<Array<R>>;
+    /**
+     * Insert document
+     *
+     * @param {Entity} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    insert(doc: ENTITY, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Inserts document
+     *
+     * @param {Entity[]} docs - documents
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    inserts(docs: Array<ENTITY>, opt?: OPT | string, ignoreCheck?: boolean): Promise<Array<string>>;
+    /**
+     * Insert document
+     *
+     * @param {Entity} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    $insert(doc: ENTITY, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Replace document
+     *
+     * @param {Entity} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    replace(doc: ENTITY, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Replace document
+     *
+     * @param {Entity} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    $replace(doc: ENTITY, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Update document by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {Entity} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<string>}
+     * @async
+     * */
+    update(key: KeyValue, doc: Partial<ENTITY>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Update document by primary key
+     *
+     * @param {string} key - primary key
+     * @param {Partial<Entity>} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<string>}
+     * @async
+     * */
+    updateByPrimary(key: string, doc: Partial<ENTITY>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Update document by primary key
+     *
+     * @param {string} key - primary key
+     * @param {Partial<Entity>} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<string>}
+     * @async
+     * */
+    $updateByPrimary(key: string, doc: Partial<ENTITY>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Update document by secondary key
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {Partial<Entity>} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<string>}
+     * @async
+     * */
+    updateBySecondary(key: KeyValue, doc: Partial<ENTITY>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Update document by secondary key
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {Partial<Entity>} doc - document
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<string>}
+     * @async
+     * */
+    $updateBySecondary(key: KeyValue, doc: Partial<ENTITY>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Set document with partial data by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {Partial<Entity>} doc - partial entity will be set
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<string>}
+     * @async
+     * */
+    set(key: KeyValue, doc: Partial<ENTITY>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Unset document for given fields
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {Array<string>} fields - fields will be unset
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<string>}
+     * @async
+     * */
+    unset(key: KeyValue, fields: Array<keyof ENTITY | string>, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Remove document (hard delete) by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @async
+     * */
+    remove(key: KeyValue, opt?: OPT | string): Promise<string>;
+    /**
+     * Remove document by primary key (hard delete)
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    removeByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Remove document by primary key (hard delete)
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    $removeByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Remove document by secondary key (hard delete)
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    removeBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Remove document by secondary key (hard delete)
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    $removeBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Trash document (soft delete) by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @async
+     * */
+    trash(key: KeyValue, opt?: OPT | string): Promise<string>;
+    /**
+     * Trash document by primary key (soft delete)
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    trashByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Trash document by primary key (soft delete)
+     *
+     * @param {string} key - primary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    $trashByPrimary(key: string, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Trash document by secondary key (soft delete)
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    trashBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Trash document by secondary key (soft delete)
+     *
+     * @param {KeyValue} key - secondary key
+     * @param {(opt?: OPT|string)?} opt - option or query name
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @async
+     * */
+    $trashBySecondary(key: KeyValue, opt?: OPT | string, ignoreCheck?: boolean): Promise<string>;
+    /**
+     * Convert a document to a dim
+     *
+     * @param {Entity} doc - document object
+     * @param {string?} dim - dimension, default: `def`
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<IdDocLike>} - dim object
+     * @async
+     * */
+    $toDim<R extends IdDocLike<ID>>(doc: ENTITY, dim?: DIMS): Promise<R>;
+    /**
+     * Get dim by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @param {string?} dim - dimension, default: `def`
+     * @return {Promise<IdDocLike>} - dim object
+     * @async
+     * */
+    getDim<R extends IdDocLike<ID>>(key: KeyValue, dim?: DIMS): Promise<R>;
+    /**
+     * List dims by keys (primary or secondary)
+     *
+     * @param {Array<string>} keys - primary or secondary keys
+     * @param {string?} dim - dimension, default: `def`
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Array<IdDocLike>>} - dim objects
+     * */
+    listDims<R extends IdDocLike<ID>>(keys: Array<KeyValue>, dim?: DIMS, ignoreCheck?: boolean): Promise<Array<R>>;
+    /**
+     * Set pair by document
+     *
+     * @param {Entity} doc - document
+     * @return {Promise<Pair>} - pair object
+     * @async
+     * */
+    $toPair(doc: ENTITY): Promise<PAIR>;
+    /**
+     * Get pair by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @return {Promise<Pair>} - pair object
+     * @async
+     * */
+    getPair(key: KeyValue): Promise<PAIR>;
+    /**
+     * List pairs by keys (primary or secondary)
+     *
+     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Array<Pair>>} - pair objects
+     * */
+    listPairs(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<PAIR>>;
+    /**
+     * Set view by document
+     *
+     * @param {Entity} doc - document
+     * @return {Promise<View>} - view object
+     * @async
+     * */
+    $toView(doc: ENTITY): Promise<VIEW>;
+    /**
+     * Get view by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @return {Promise<View>} - view object
+     * @async
+     * */
+    getView(key: KeyValue): Promise<VIEW>;
+    /**
+     * List views by keys (primary or secondary)
+     *
+     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Array<View>>} - view objects
+     * */
+    listViews(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<VIEW>>;
+    /**
+     * Set portion by document
+     *
+     * @param {Entity} doc - document
+     * @return {Promise<Portion>} - portion object
+     * @async
+     * */
+    $toPortion(doc: ENTITY): Promise<PORTION>;
+    /**
+     * Get portion by key (primary or secondary)
+     *
+     * @param {KeyValue} key - primary or secondary key
+     * @return {Promise<Portion>} - portion object
+     * @async
+     * */
+    getPortion(key: KeyValue): Promise<PORTION>;
+    /**
+     * List portions by key (primary or secondary)
+     *
+     * @param {Array<KeyValue>} keys - primary or secondary keys
+     * @param {boolean?} ignoreCheck - ignores to check input
+     * @return {Promise<Array<Portion>>} - portion objects
+     * */
+    listPortions(keys: Array<KeyValue>, ignoreCheck?: boolean): Promise<Array<PORTION>>;
+}
+export type DbRepoDef = DbRepoLike<DbConnectionBase, DbExecOpt, KeyValue, Entity, UrnDocLike, keyof Entity, DefDims, Pair, View, Portion>;
+/**
+ * DB repository option
+ * */
+export interface DbRepoOpt<ID extends KeyValue, ENTITY extends Entity<ID>> {
+    /**
+     * Cache repository
+     *
+     * @type {CacheChannelLike}
+     * */
+    cache?: CacheChannelLike<CacheConnectionLike, ID, ENTITY>;
+    /**
+     * Model version
+     *
+     * @default `1.0.0`
+     * @type {string}
+     * */
+    version?: number;
+    /**
+     * Urn delimiter
+     *
+     * @default `,` -- use comma
+     * @type {UrnDelimiter}
+     * */
+    urnDelimiter?: UrnDelimiter;
+    /**
+     * Urn prefix, like domain:subdomain
+     *
+     * @type {string}
+     * */
+    urnPrefix?: string;
+    /**
+     * Id format, number or string
+     * - if yes, it evaluates as integer
+     * - if no, it evaluates as string, uuid etc
+     * @default `false`
+     * */
+    useNumericId?: boolean;
+    /**
+     * Date format, number or iso date
+     * - if yes, it generates string - date as `yyyy-mm-dd:hh:ii:ss.lll+z`
+     * - if no, it generates number - timestamp
+     *
+     * @fields `createdAt`, `updatedAt`
+     * @default `false`
+     * */
+    useIsoDate?: boolean;
+    /**
+     * Id is same with urn or not
+     * - if yes, id is same with urn
+     * - if no, id is not same with urn
+     *
+     * @fields `_urn`
+     * @default `false`
+     * */
+    idSame?: boolean;
+    /**
+     * Ignores soft delete
+     * - if yes, it ignores trash case
+     * - if no, it validates trash case
+     *
+     * @fields `_trashId`
+     * @default `false`
+     * */
+    useSoftDelete?: boolean;
+    /**
+     * Manages `created at` case, as time by `useIsoDate`
+     * - if yes, it builds `createdAt`
+     * - if no, it ignores `createdAt`
+     *
+     * @fields `createdAt`
+     * @default `false`
+     * */
+    useCreatedAt?: boolean;
+    /**
+     * Manages `created by` case, as user
+     * - if yes, it builds `createdBy`
+     * - if no, it ignores `createdBy`
+     *
+     * @fields `createdBy`
+     * @default `false`
+     * */
+    useCreatedBy?: boolean;
+    /**
+     * Ignores updated at time
+     * - if yes, it ignores updatedAt
+     * - if no, it builds updatedAt
+     *
+     * @fields `updatedAt`
+     * @default `false`
+     * */
+    useUpdatedAt?: boolean;
+    /**
+     * Manages `updated by` case, as user
+     * - if yes, it builds `updatedBy`
+     * - if no, it ignores `updatedBy`
+     *
+     * @fields `updatedBy`
+     * @default `false`
+     * */
+    useUpdatedBy?: boolean;
+    /**
+     * Manages `version` case, data model structure
+     * - if yes, it builds `_ver`
+     * - if no, it ignores `_ver`
+     *
+     * @fields `_ver`
+     * @default `false`
+     * */
+    useVersion?: boolean;
+    /**
+     * Manages `revision` case, incrementing count
+     * - if yes, it builds `_rev`
+     * - if no, it ignores `_rev`
+     *
+     * @fields `_rev`
+     * @default `false`
+     * */
+    useRevision?: boolean;
+    /**
+     * Manages `alpha` or `slug` case, to power auto suggest
+     * - if yes, it builds `_alpha`
+     * - if no, it ignores `_alpha`
+     *
+     * @fields `_alpha`
+     * @default `false`
+     * */
+    alphaFn?: Fnc;
+    /**
+     * Manages `search` case, to power search
+     * - if yes, it builds `_search`
+     * - if no, it ignores `_search`
+     *
+     * @fields `_alpha`
+     * @default `false`
+     * */
+    searchFn?: Fnc;
+    /**
+     * 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`
+     * */
+    irregularFn?: Fnc;
+    /**
+     * Field list which can not be set (update/replace)
+     *
+     * @type {Array<string>}
+     * */
+    forbiddenSet?: Array<keyof ENTITY>;
+    /**
+     * Field list which can not be unset (clear,delete)
+     *
+     * @type {Array<string>}
+     * */
+    forbiddenUnset?: Array<keyof ENTITY>;
+}
+/**
+ * DB repository props
+ * */
+export interface DbRepoProps<CONN extends DbConnectionBase, ID extends KeyValue, ENTITY extends Entity<ID>> extends DbRepoOpt<ID, ENTITY> {
+    /**
+     * DB connection
+     *
+     * @type {DbConnectionBase}
+     * */
+    conn: CONN;
+    /**
+     * Info path, generally it will be {db}.{schema}.{table}
+     *
+     * @type {string}
+     * */
+    path: string;
+    /**
+     * Length of urn prefix
+     *
+     * @type {number}
+     * */
+    urnLength?: number;
+    /**
+     * Is connected
+     *
+     * @type {boolean}
+     * */
+    isConnected?: boolean;
+}
+/**
+ * DB keys result
+ * */
+export interface DbCheckKeysResult<ID extends KeyValue> {
+    ids: Array<ID>;
+    urns: Array<string>;
+    ordered: Array<DbCheckKeysTuple<ID>>;
+}
+export type DbCheckKeysTuple<ID extends KeyValue> = [string, '_urn'] | [ID, 'id'];
+/**
+ * DB `$toUrnTuple` lambda
+ * @function
+ * */
+export type DbRepoToUrnTuple<URN extends UrnDocLike = UrnDocLike> = (urnRec: URN) => UrnTuple;
+/**
+ * DB `toDim` lambda
+ * @function
+ * */
+export type DbRepoToDim<R, ID extends KeyValue, ENTITY extends Entity<ID>, DIMS extends DefDims = DefDims> = (doc: ENTITY, dim: DIMS | undefined) => Promise<R>;
+export interface DbIdLike {
+    id?: KeyValue;
+    urn?: string;
+    _urn?: string;
+}

package/dist/repo/index.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });