hide-a-bed 5.0.4 → 5.0.5

package/README.md

@@ -413,25 +413,26 @@ const result = await query(config, view, options)
 ```
 
 #### createQuery()
-Create a query builder to help construct view queries with a fluent interface.
+Create a query builder to help construct view queries with a fluent interface. Note we have stuck to couch naming conventions and not camel case.
+
 - Returns: QueryBuilder instance with methods:
   - `key(value)`: Set exact key match
-  - `startKey(value)`: Set range start key
-  - `endKey(value)`: Set range end key
+  - `startkey(value)`: Set range start key
+  - `endkey(value)`: Set range end key
   - `descending(bool)`: Set descending sort order
   - `skip(number)`: Set number of results to skip
   - `limit(number)`: Set max number of results
-  - `includeDocs(bool)`: Include full documents
+  - `include_docs(bool)`: Include full documents
   - `reduce(bool)`: Enable/disable reduce
   - `group(bool)`: Enable/disable grouping
-  - `groupLevel(number)`: Set group level
+  - `group_level(number)`: Set group level
   - `build()`: Return the constructed query options object
 
 ```javascript
 const options = createQuery()
-  .startKey('A')
-  .endKey('B')
-  .includeDocs(true)
+  .startkey('A')
+  .endkey('B')
+  .include_docs(true)
   .limit(10)
   .build()
 

package/cjs/impl/queryBuilder.cjs

@@ -41,6 +41,14 @@ class QueryBuilder {
     this.#options.startkey = startkey;
     return this;
   }
+  /**
+   * @param {any} startkey
+   * @returns {QueryBuilder}
+   */
+  startkey(startkey) {
+    this.#options.startkey = startkey;
+    return this;
+  }
   /**
    * @param {any} endkey
    * @returns {QueryBuilder}
@@ -49,6 +57,14 @@ class QueryBuilder {
     this.#options.endkey = endkey;
     return this;
   }
+  /**
+   * @param {any} endkey
+   * @returns {QueryBuilder}
+   */
+  endkey(endkey) {
+    this.#options.endkey = endkey;
+    return this;
+  }
   /**
    * @param {boolean} reduce
    * @returns {QueryBuilder}
@@ -73,6 +89,30 @@ class QueryBuilder {
     this.#options.group_level = level;
     return this;
   }
+  /**
+   * @param {number} level
+   * @returns {QueryBuilder}
+   */
+  group_level(level) {
+    this.#options.group_level = level;
+    return this;
+  }
+  /**
+   * @param {boolean} includeDocs
+   * @returns {QueryBuilder}
+   */
+  includeDocs(includeDocs = true) {
+    this.#options.include_docs = includeDocs;
+    return this;
+  }
+  /**
+   * @param {boolean} includeDocs
+   * @returns {QueryBuilder}
+   */
+  include_docs(includeDocs = true) {
+    this.#options.include_docs = includeDocs;
+    return this;
+  }
   /**
    * @param {string} stale
    * @returns {QueryBuilder}

package/impl/queryBuilder.d.mts

@@ -6,6 +6,7 @@
  * @property {boolean} [reduce] - Whether to use reduce function
  * @property {boolean} [group] - Whether to group results
  * @property {number} [group_level] - Level at which to group
+* @property {boolean} [include_docs] - Whether to include full couch docs
  * @property {string} [stale] - Stale parameter value
  * @property {number} [limit] - Max number of results
  */
@@ -20,11 +21,21 @@ export class QueryBuilder {
      * @returns {QueryBuilder}
      */
     startKey(startkey: any): QueryBuilder;
+    /**
+     * @param {any} startkey
+     * @returns {QueryBuilder}
+     */
+    startkey(startkey: any): QueryBuilder;
     /**
      * @param {any} endkey
      * @returns {QueryBuilder}
      */
     endKey(endkey: any): QueryBuilder;
+    /**
+     * @param {any} endkey
+     * @returns {QueryBuilder}
+     */
+    endkey(endkey: any): QueryBuilder;
     /**
      * @param {boolean} reduce
      * @returns {QueryBuilder}
@@ -40,6 +51,21 @@ export class QueryBuilder {
      * @returns {QueryBuilder}
      */
     groupLevel(level: number): QueryBuilder;
+    /**
+     * @param {number} level
+     * @returns {QueryBuilder}
+     */
+    group_level(level: number): QueryBuilder;
+    /**
+     * @param {boolean} includeDocs
+     * @returns {QueryBuilder}
+     */
+    includeDocs(includeDocs?: boolean): QueryBuilder;
+    /**
+     * @param {boolean} includeDocs
+     * @returns {QueryBuilder}
+     */
+    include_docs(includeDocs?: boolean): QueryBuilder;
     /**
      * @param {string} stale
      * @returns {QueryBuilder}
@@ -82,6 +108,10 @@ export type QueryOptions = {
      * - Level at which to group
      */
     group_level?: number | undefined;
+    /**
+     * - Whether to include full couch docs
+     */
+    include_docs?: boolean | undefined;
     /**
      * - Stale parameter value
      */

package/impl/queryBuilder.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"queryBuilder.d.mts","sourceRoot":"","sources":["queryBuilder.mjs"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAEH;IAIE;;;OAGG;IACH,SAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,mBAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,eAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,gBAHW,OAAO,GACL,YAAY,CAKxB;IAED;;;OAGG;IACH,cAHW,OAAO,GACL,YAAY,CAKxB;IAED;;;OAGG;IACH,kBAHW,MAAM,GACJ,YAAY,CAKxB;IAED;;;OAGG;IACH,aAHW,MAAM,GACJ,YAAY,CAKxB;IAED;;;OAGG;IACH,aAHW,MAAM,GACJ,YAAY,CAKxB;IAED;;OAEG;IACH,SAFa,YAAY,CAIxB;;CACF;AAEM,4CAA4C;;;;;UA9FrC,GAAG;;;;eACH,GAAG;;;;aACH,GAAG"}
+{"version":3,"file":"queryBuilder.d.mts","sourceRoot":"","sources":["queryBuilder.mjs"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AAEH;IAIE;;;OAGG;IACH,SAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,mBAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,mBAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,eAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,eAHW,GAAG,GACD,YAAY,CAKxB;IAED;;;OAGG;IACH,gBAHW,OAAO,GACL,YAAY,CAKxB;IAED;;;OAGG;IACH,cAHW,OAAO,GACL,YAAY,CAKxB;IAED;;;OAGG;IACH,kBAHW,MAAM,GACJ,YAAY,CAKxB;IAED;;;OAGG;IACH,mBAHW,MAAM,GACJ,YAAY,CAKxB;IAED;;;OAGG;IACH,0BAHW,OAAO,GACL,YAAY,CAKxB;IAED;;;OAGG;IACH,2BAHW,OAAO,GACL,YAAY,CAKxB;IAED;;;OAGG;IACH,aAHW,MAAM,GACJ,YAAY,CAKxB;IAED;;;OAGG;IACH,aAHW,MAAM,GACJ,YAAY,CAKxB;IAED;;OAEG;IACH,SAFa,YAAY,CAIxB;;CACF;AAEM,4CAA4C;;;;;UA5IrC,GAAG;;;;eACH,GAAG;;;;aACH,GAAG"}

package/impl/queryBuilder.mjs

@@ -8,6 +8,7 @@
  * @property {boolean} [reduce] - Whether to use reduce function
  * @property {boolean} [group] - Whether to group results
  * @property {number} [group_level] - Level at which to group
+* @property {boolean} [include_docs] - Whether to include full couch docs
  * @property {string} [stale] - Stale parameter value
  * @property {number} [limit] - Max number of results
  */
@@ -34,6 +35,15 @@ export class QueryBuilder {
     return this
   }
 
+  /**
+   * @param {any} startkey
+   * @returns {QueryBuilder}
+   */
+  startkey (startkey) {
+    this.#options.startkey = startkey
+    return this
+  }
+
   /**
    * @param {any} endkey
    * @returns {QueryBuilder}
@@ -43,6 +53,15 @@ export class QueryBuilder {
     return this
   }
 
+  /**
+   * @param {any} endkey
+   * @returns {QueryBuilder}
+   */
+  endkey (endkey) {
+    this.#options.endkey = endkey
+    return this
+  }
+
   /**
    * @param {boolean} reduce
    * @returns {QueryBuilder}
@@ -70,6 +89,33 @@ export class QueryBuilder {
     return this
   }
 
+  /**
+   * @param {number} level
+   * @returns {QueryBuilder}
+   */
+  group_level (level) {
+    this.#options.group_level = level
+    return this
+  }
+
+  /**
+   * @param {boolean} includeDocs
+   * @returns {QueryBuilder}
+   */
+  includeDocs (includeDocs = true) {
+    this.#options.include_docs = includeDocs
+    return this
+  }
+
+  /**
+   * @param {boolean} includeDocs
+   * @returns {QueryBuilder}
+   */
+  include_docs (includeDocs = true) {
+    this.#options.include_docs = includeDocs
+    return this
+  }
+
   /**
    * @param {string} stale
    * @returns {QueryBuilder}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hide-a-bed",
-  "version": "5.0.4",
+  "version": "5.0.5",
   "description": "An abstraction over couchdb calls that includes easy mock/stubs with pouchdb",
   "module": "index.mjs",
   "main": "cjs/index.cjs",