hide-a-bed 5.0.4 → 5.1.0

package/README.md

@@ -40,9 +40,22 @@ A convience method to bind the config, so you dont need to pass it in.
 ```
 import { bindConfig } from 'hide-a-bed'
 const db = bindConfig(process.env)
-const doc = db.get('doc-123')
+const doc = await db.get('doc-123')
 ```
 
+##### Config Overrides
+
+You also can quickly change one (or more) config settings for a particular call with the db.config(options)
+
+eg
+
+```
+const doc = await db.config({ throwOnGetNotFound: true }).get('doc-id') 
+```
+
+You can pass any of [Config Options](#advanced-config-options) to db.config to override the original bindings.
+
+
 ### Document Operations
 
 #### get
@@ -412,32 +425,47 @@ const result = await query(config, view, options)
 // }
 ```
 
+Some notes on the keys. Use native js things for arrays keys, rather then strings. Eg
+
+ - ```{ startkey: ['ryan'], endkey: ['ryan', {}] }```
+ - ```{ startkey: [47, null], endkey: [48, null] }```
+ - ```{ startkey: [customerIdVar], endkey: [customerIdVar, {}] }```
+ - ```{ startkey: [teamId, userId, startTimestamp], endkey: [teamId, userId, endTimestamp] }```
+
+
+
 #### 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()
 
 const result = await query(config, view, options)
 ```
 
+Again, use js types for array keys
+
+  - ```.startkey([teamId, userId]).endkey([teamId, userId, {}])```
+  - ```.startkey([teamId, userId, startTimestamp]).endkey([teamId, userId, endTimestamp])```
+
 #### queryStream
 
 Use Cases *Streaming Data*

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/cjs/index.cjs

@@ -86,13 +86,13 @@ const schema = {
   ChangesOptions: import_changes2.ChangesOptions,
   ChangesResponse: import_changes2.ChangesResponse
 };
-const bindConfig = import_bind.Bind.implement((config) => {
+function doBind(config) {
   const retryOptions = {
     maxRetries: config.maxRetries ?? 10,
     initialDelay: config.initialDelay ?? 1e3,
     backoffFactor: config.backoffFactor ?? 2
   };
-  return {
+  const result = {
     get: config.bindWithRetry ? (0, import_retry.withRetry)(import_crud.get.bind(null, config), retryOptions) : import_crud.get.bind(null, config),
     getAtRev: config.bindWithRetry ? (0, import_retry.withRetry)(import_crud.getAtRev.bind(null, config), retryOptions) : import_crud.getAtRev.bind(null, config),
     put: config.bindWithRetry ? (0, import_retry.withRetry)(import_crud.put.bind(null, config), retryOptions) : import_crud.put.bind(null, config),
@@ -112,4 +112,15 @@ const bindConfig = import_bind.Bind.implement((config) => {
     watchDocs: import_watch.watchDocs.bind(null, config),
     changes: import_changes.changes.bind(null, config)
   };
+  return result;
+}
+const bindConfig = import_bind.Bind.implement((config) => {
+  const parsedConfig = import_config.CouchConfig.parse(config);
+  const funcs = doBind(parsedConfig);
+  const reconfig = (_overrides) => {
+    const newConfig = { ...config, ..._overrides };
+    return bindConfig(newConfig);
+  };
+  const all = { ...funcs, options: reconfig };
+  return all;
 });

package/cjs/schema/bind.cjs

@@ -18,7 +18,9 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var bind_exports = {};
 __export(bind_exports, {
-  Bind: () => Bind
+  Bind: () => Bind,
+  BindBase: () => BindBase,
+  BindReturns: () => BindReturns
 });
 module.exports = __toCommonJS(bind_exports);
 var import_zod = require("zod");
@@ -31,7 +33,7 @@ var import_stream = require("./stream.cjs");
 var import_lock = require("./sugar/lock.cjs");
 var import_changes = require("./changes.cjs");
 var import_watch = require("./sugar/watch.cjs");
-const BindReturns = import_zod.z.object({
+const BindBase = import_zod.z.object({
   bulkGet: import_bulk.BulkGetBound,
   bulkSave: import_bulk.BulkSaveBound,
   bulkRemove: import_bulk.BulkRemoveBound,
@@ -48,4 +50,8 @@ const BindReturns = import_zod.z.object({
   changes: import_changes.ChangesBound,
   watchDocs: import_watch.WatchDocsBound
 });
+const RebindOptions = import_config.CouchConfig.omit({ couch: true });
+const BindReturns = BindBase.extend({
+  options: import_zod.z.function().args(RebindOptions).returns(BindBase)
+});
 const Bind = import_zod.z.function().args(import_config.CouchConfig).returns(BindReturns);

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/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["index.mjs"],"names":[],"mappings":"oBAEmC,iBAAiB;yBAAjB,iBAAiB;oBAAjB,iBAAiB;wBADkC,iBAAiB;yBAAjB,iBAAiB;sBAMjF,kBAAkB;4BACZ,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAJP,kBAAkB;iCAAlB,kBAAkB;2BAH4B,iBAAiB;kCAAjB,iBAAiB;oCAAjB,iBAAiB;AAkDvG,uDAAuD;AACvD,yBADY,OAAO,mBAAmB,EAAE,UAAU,CA+BhD;0BAxEwB,kBAAkB;4BADhB,yBAAyB;2BAJd,uBAAuB;2BAAvB,uBAAuB;4BAOlC,qBAAqB;gCACQ,oBAAoB;wCAApB,oBAAoB;sCAEhC,qBAAqB;sBAArB,qBAAqB;yBAJoB,mBAAmB;wBAAnB,mBAAmB;2BAAnB,mBAAmB;kCAAnB,mBAAmB;oCAAnB,mBAAmB;yBAQ3B,mBAAmB;yBAAnB,mBAAmB;yBAAnB,mBAAmB;iCAAnB,mBAAmB;sBAHzD,oBAAoB;iCAApB,oBAAoB;8BAGkB,mBAAmB;qBAC5E,mBAAmB;qBAHkB,yBAAyB;0BACzD,0BAA0B;4BADM,yBAAyB;2BAAzB,yBAAyB;2BAAzB,yBAAyB;wBAH1B,sBAAsB;+BAAtB,sBAAsB;gCAAtB,sBAAsB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["index.mjs"],"names":[],"mappings":"oBAEmC,iBAAiB;yBAAjB,iBAAiB;oBAAjB,iBAAiB;wBADkC,iBAAiB;yBAAjB,iBAAiB;sBAMjF,kBAAkB;4BACZ,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAJP,kBAAkB;iCAAlB,kBAAkB;2BAH4B,iBAAiB;kCAAjB,iBAAiB;oCAAjB,iBAAiB;AAoFvG,uDAAuD;AACvD,yBADY,OAAO,mBAAmB,EAAE,UAAU,CAuBhD;0BAlGwB,kBAAkB;4BADhB,yBAAyB;2BAJd,uBAAuB;2BAAvB,uBAAuB;4BAOlC,qBAAqB;gCACQ,oBAAoB;wCAApB,oBAAoB;sCAEhC,qBAAqB;sBAArB,qBAAqB;yBAJoB,mBAAmB;wBAAnB,mBAAmB;2BAAnB,mBAAmB;kCAAnB,mBAAmB;oCAAnB,mBAAmB;yBAQ3B,mBAAmB;yBAAnB,mBAAmB;yBAAnB,mBAAmB;iCAAnB,mBAAmB;sBAHzD,oBAAoB;iCAApB,oBAAoB;8BAGkB,mBAAmB;qBAC5E,mBAAmB;qBAHkB,yBAAyB;0BACzD,0BAA0B;4BADM,yBAAyB;2BAAzB,yBAAyB;2BAAzB,yBAAyB;wBAH1B,sBAAsB;+BAAtB,sBAAsB;gCAAtB,sBAAsB"}

package/index.mjs

@@ -48,20 +48,19 @@ const schema = {
   ChangesOptions,
   ChangesResponse
 }
-
-/** @type { import('./schema/bind.mjs').BindSchema } */
-const bindConfig = Bind.implement((
-  /** @type { import('./schema/config.mjs').CouchConfigSchema } */
-  config
-) => {
+ /**
+  * @param {import('./schema/config.mjs').CouchConfigSchema } config
+  */
+function doBind(config) {
   // Default retry options
   const retryOptions = {
     maxRetries: config.maxRetries ?? 10,
     initialDelay: config.initialDelay ?? 1000,
     backoffFactor: config.backoffFactor ?? 2
   }
-
-  return {
+  
+  // Create the object without the config property first
+  const result = {
     get: config.bindWithRetry ? withRetry(get.bind(null, config), retryOptions) : get.bind(null, config),
     getAtRev: config.bindWithRetry ? withRetry(getAtRev.bind(null, config), retryOptions) : getAtRev.bind(null, config),
     put: config.bindWithRetry ? withRetry(put.bind(null, config), retryOptions) : put.bind(null, config),
@@ -80,6 +79,33 @@ const bindConfig = Bind.implement((
     watchDocs: watchDocs.bind(null, config),
     changes: changes.bind(null, config)
   }
+  
+  return result;
+}
+
+/** @type { import('./schema/bind.mjs').BindSchema } */
+const bindConfig = Bind.implement((
+  /** @type { import('./schema/config.mjs').CouchConfigSchema } */
+  config
+) => {
+  const parsedConfig = CouchConfig.parse(config)
+
+  /** @type { import('./schema/bind.mjs').BindBaseSchema } funcs */
+  const funcs = doBind(parsedConfig)
+  
+  // Add the options function that returns a new bound instance
+  // this allows the user to override some options
+  const reconfig = (
+    /** @type any  */
+    _overrides
+  ) => {
+    // override the config and return doBind again
+    const newConfig = { ...config, ..._overrides }
+    return bindConfig(newConfig)
+  }
+    /** @type { import('./schema/bind.mjs').BindReturnsSchema } */
+  const all = { ...funcs, options: reconfig }
+  return all
 })
 
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hide-a-bed",
-  "version": "5.0.4",
+  "version": "5.1.0",
   "description": "An abstraction over couchdb calls that includes easy mock/stubs with pouchdb",
   "module": "index.mjs",
   "main": "cjs/index.cjs",
@@ -57,4 +57,4 @@
     "node": "20.17.0",
     "npm": "10.8.2"
   }
-}
+}