@naturalcycles/db-lib 10.17.0 → 10.17.2

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

@@ -113,8 +113,12 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
     /**
      * Used by e.g Firestore.
      */
-    indexes?: CommonDaoIndex<DBM>[];
-    ttl?: CommonDaoTTL<DBM>;
+    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).
@@ -182,28 +186,20 @@ 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[];
+    order: CommonDaoIndexOrder[];
 }
 export type CommonDaoIndexOrder = 'asc' | 'desc' | 'array-contains';
-/**
- * TTL definition - a map from Table name to an array of properties that should be used for TTL.
- * Example:
- *
- * {
- *   myTable: ['deleteAt']
- * }
- */
-export interface CommonDaoTTL<DBM extends BaseDBEntity> {
-    [table: string]: (keyof DBM)[];
-}
 /**
  * All properties default to undefined.
  */

package/package.json

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

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

@@ -139,9 +139,12 @@ export interface CommonDaoCfg<
   /**
    * Used by e.g Firestore.
    */
-  indexes?: CommonDaoIndex<DBM>[]
-
-  ttl?: CommonDaoTTL<DBM>
+  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.
@@ -224,31 +227,23 @@ 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[]
+  order: CommonDaoIndexOrder[]
 }
 
 export type CommonDaoIndexOrder = 'asc' | 'desc' | 'array-contains'
 
-/**
- * TTL definition - a map from Table name to an array of properties that should be used for TTL.
- * Example:
- *
- * {
- *   myTable: ['deleteAt']
- * }
- */
-export interface CommonDaoTTL<DBM extends BaseDBEntity> {
-  [table: string]: (keyof DBM)[]
-}
-
 /**
  * All properties default to undefined.
  */