@naturalcycles/db-lib 10.16.0 → 10.17.1

package/dist/commondao/common.dao.model.d.ts

@@ -106,7 +106,19 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
      * and abstracts it away.
      */
     validateBM?: ValidationFunction<BM, any>;
+    /**
+     * Used by e.g Datastore.
+     */
     excludeFromIndexes?: (keyof DBM)[];
+    /**
+     * Used by e.g Firestore.
+     */
+    indexes?: CommonDaoIndexDefinition<DBM>[];
+    /**
+     * Defines the property that is used for TTL (auto-cleanup by the DB,
+     * e.g Datastore/Firestore).
+     */
+    ttl?: keyof DBM;
     /**
      * Defaults to true.
      * If set to false - load (read) operations will skip validation (and conversion).
@@ -174,6 +186,23 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
      */
     patchInTransaction?: boolean;
 }
+/**
+ * Index can be defined in simple form, just as a property name: `abc`
+ *
+ * or as an object, when non-standard index order(s) are needed.
+ */
+export type CommonDaoIndexDefinition<DBM extends BaseDBEntity> = keyof DBM | CommonDaoIndex<DBM>;
+export interface CommonDaoIndex<DBM extends BaseDBEntity> {
+    /**
+     * Name of the property to index.
+     */
+    name: keyof DBM;
+    /**
+     * Defaults to ['asc']
+     */
+    order?: CommonDaoIndexOrder[];
+}
+export type CommonDaoIndexOrder = 'asc' | 'desc' | 'array-contains';
 /**
  * All properties default to undefined.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.16.0",
+  "version": "10.17.1",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"

package/src/commondao/common.dao.model.ts

@@ -131,8 +131,21 @@ export interface CommonDaoCfg<
    */
   validateBM?: ValidationFunction<BM, any>
 
+  /**
+   * Used by e.g Datastore.
+   */
   excludeFromIndexes?: (keyof DBM)[]
 
+  /**
+   * Used by e.g Firestore.
+   */
+  indexes?: CommonDaoIndexDefinition<DBM>[]
+  /**
+   * Defines the property that is used for TTL (auto-cleanup by the DB,
+   * e.g Datastore/Firestore).
+   */
+  ttl?: keyof DBM
+
   /**
    * Defaults to true.
    * If set to false - load (read) operations will skip validation (and conversion).
@@ -214,6 +227,26 @@ export interface CommonDaoCfg<
   patchInTransaction?: boolean
 }
 
+/**
+ * Index can be defined in simple form, just as a property name: `abc`
+ *
+ * or as an object, when non-standard index order(s) are needed.
+ */
+export type CommonDaoIndexDefinition<DBM extends BaseDBEntity> = keyof DBM | CommonDaoIndex<DBM>
+
+export interface CommonDaoIndex<DBM extends BaseDBEntity> {
+  /**
+   * Name of the property to index.
+   */
+  name: keyof DBM
+  /**
+   * Defaults to ['asc']
+   */
+  order?: CommonDaoIndexOrder[]
+}
+
+export type CommonDaoIndexOrder = 'asc' | 'desc' | 'array-contains'
+
 /**
  * All properties default to undefined.
  */