hide-a-bed 4.0.3 → 4.1.2

package/impl/queryBuilder.mjs

@@ -0,0 +1,99 @@
+// @ts-check
+
+/**
+ * @typedef {Object} QueryOptions
+ * @property {any} [key] - Exact key to match
+ * @property {any} [startkey] - Start of key range
+ * @property {any} [endkey] - End of key range
+ * @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 {string} [stale] - Stale parameter value
+ * @property {number} [limit] - Max number of results
+ */
+
+export class QueryBuilder {
+  /** @type {QueryOptions} */
+  #options = {}
+
+  /**
+   * @param {any} key
+   * @returns {QueryBuilder}
+   */
+  key (key) {
+    this.#options.key = key
+    return this
+  }
+
+  /**
+   * @param {any} startkey
+   * @returns {QueryBuilder}
+   */
+  startKey (startkey) {
+    this.#options.startkey = startkey
+    return this
+  }
+
+  /**
+   * @param {any} endkey
+   * @returns {QueryBuilder}
+   */
+  endKey (endkey) {
+    this.#options.endkey = endkey
+    return this
+  }
+
+  /**
+   * @param {boolean} reduce
+   * @returns {QueryBuilder}
+   */
+  reduce (reduce = true) {
+    this.#options.reduce = reduce
+    return this
+  }
+
+  /**
+   * @param {boolean} group
+   * @returns {QueryBuilder}
+   */
+  group (group = true) {
+    this.#options.group = group
+    return this
+  }
+
+  /**
+   * @param {number} level
+   * @returns {QueryBuilder}
+   */
+  groupLevel (level) {
+    this.#options.group_level = level
+    return this
+  }
+
+  /**
+   * @param {string} stale
+   * @returns {QueryBuilder}
+   */
+  stale (stale) {
+    this.#options.stale = stale
+    return this
+  }
+
+  /**
+   * @param {number} limit
+   * @returns {QueryBuilder}
+   */
+  limit (limit) {
+    this.#options.limit = limit
+    return this
+  }
+
+  /**
+   * @returns {QueryOptions}
+   */
+  build () {
+    return { ...this.#options }
+  }
+}
+
+export const createQuery = () => new QueryBuilder()

package/impl/stream.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"stream.d.mts","sourceRoot":"","sources":["stream.mjs"],"names":[],"mappings":"AAQA,uFAAuF;AACvF,0BADY,OAAO,sBAAsB,EAAE,2BAA2B,CA2DpE"}
+{"version":3,"file":"stream.d.mts","sourceRoot":"","sources":["stream.mjs"],"names":[],"mappings":"AASA,uFAAuF;AACvF,0BADY,OAAO,sBAAsB,EAAE,2BAA2B,CAqEpE"}

package/impl/stream.mjs

@@ -1,5 +1,6 @@
 // @ts-check
 import needle from 'needle'
+import { CouchConfig } from '../schema/config.mjs'
 import { queryString } from './query.mjs'
 import { RetryableError } from './errors.mjs'
 import { createLogger } from './logger.mjs'
@@ -7,11 +8,16 @@ import { createLogger } from './logger.mjs'
 import JSONStream from 'JSONStream'
 
 /** @type { import('../schema/stream.mjs').SimpleViewQueryStreamSchema } queryStream */
-export const queryStream = (config, view, options, onRow) => new Promise((resolve, reject) => {
+export const queryStream = (rawConfig, view, options, onRow) => new Promise((resolve, reject) => {
+  const config = CouchConfig.parse(rawConfig)
+  const logger = createLogger(config)
+  logger.info(`Starting view query stream: ${view}`)
+  logger.debug('Query options:', options)
 
   if (!options) options = {}
 
   const qs = queryString(options, ['key', 'startkey', 'endkey', 'reduce', 'group', 'group_level', 'stale', 'limit'])
+  logger.debug('Generated query string:', qs)
   const url = `${config.couch}/${view}?${qs.toString()}`
   const opts = {
     json: true,
@@ -30,6 +36,7 @@ export const queryStream = (config, view, options, onRow) => new Promise((resolv
   })
 
   streamer.on('error', /** @param {Error} err */ err => {
+    logger.error('Stream parsing error:', err)
     reject(new Error(`Stream parsing error: ${err.message}`))
   })
 
@@ -42,19 +49,23 @@ export const queryStream = (config, view, options, onRow) => new Promise((resolv
   })
 
   streamer.on('end', () => {
+    logger.info(`Stream completed, processed ${rowCount} rows`)
     resolve(undefined) // all work should be done in the stream
   })
 
   const req = needle.get(url, opts)
 
   req.on('response', response => {
+    logger.debug(`Received response with status code: ${response.statusCode}`)
     if (RetryableError.isRetryableStatusCode(response.statusCode)) {
+      logger.warn(`Retryable status code received: ${response.statusCode}`)
       reject(new RetryableError('retryable error during stream query', response.statusCode))
       // req.abort()
     }
   })
 
   req.on('error', err => {
+    logger.error('Network error during stream query:', err)
     try {
       RetryableError.handleNetworkError(err)
     } catch (retryErr) {

package/impl/trackedEmitter.d.mts

@@ -0,0 +1,8 @@
+export class TrackedEmitter extends EventEmitter<[never]> {
+    constructor(options: any);
+    delay: any;
+    emit(event: any, ...args: any[]): Promise<any>;
+}
+export function setupEmitter(config: any): any;
+import { EventEmitter } from 'events';
+//# sourceMappingURL=trackedEmitter.d.mts.map

package/impl/trackedEmitter.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackedEmitter.d.mts","sourceRoot":"","sources":["trackedEmitter.mjs"],"names":[],"mappings":"AAEA;IAEE,0BAGC;IADoB,WAA0B;IAG/C,+CAiBC;CACF;AAEM,+CAGN;6BAhC4B,QAAQ"}

package/impl/trackedEmitter.mjs

@@ -0,0 +1,33 @@
+import { EventEmitter } from 'events'
+
+export class TrackedEmitter extends EventEmitter {
+  // create a constructor with some options
+  constructor (options) {
+    super(options)
+    if (options.delay) this.delay = options.delay
+  }
+
+  emit (event, ...args) {
+    const listeners = this.listeners(event)
+    let completed = 0
+
+    return new Promise((resolve) => {
+      if (!listeners || listeners.length === 0) {
+        return resolve() // no listeners? no delay
+      }
+      listeners.forEach((listener) => {
+        listener(...args)
+        completed++
+        if (completed === listeners.length) {
+          if (!this.delay) resolve()
+          setTimeout(resolve, this.delay)
+        }
+      })
+    })
+  }
+}
+
+export const setupEmitter = (config) => {
+  if (!config._emitter) return ({ emit: async () => {} })
+  return config._emitter
+}

package/impl/transactionErrors.d.mts

@@ -0,0 +1,57 @@
+export class TransactionSetupError extends Error {
+    /**
+     * @param {string} message
+     * @param {Record<string, any>} details
+     */
+    constructor(message: string, details?: Record<string, any>);
+    details: Record<string, any>;
+}
+export class TransactionVersionConflictError extends Error {
+    /**
+     * @param {string[]} conflictingIds
+     */
+    constructor(conflictingIds: string[]);
+    conflictingIds: string[];
+}
+export class TransactionBulkOperationError extends Error {
+    /**
+     * @param {Array<{ok?: boolean|null, id?: string|null, rev?: string|null, error?: string|null, reason?: string|null}>} failedDocs
+     */
+    constructor(failedDocs: Array<{
+        ok?: boolean | null;
+        id?: string | null;
+        rev?: string | null;
+        error?: string | null;
+        reason?: string | null;
+    }>);
+    failedDocs: {
+        ok?: boolean | null;
+        id?: string | null;
+        rev?: string | null;
+        error?: string | null;
+        reason?: string | null;
+    }[];
+}
+export class TransactionRollbackError extends Error {
+    /**
+     * @param {string} message
+     * @param {Error} originalError
+     * @param {Array<{ok?: boolean|null, id?: string|null, rev?: string|null, error?: string|null, reason?: string|null}>} rollbackResults
+     */
+    constructor(message: string, originalError: Error, rollbackResults: Array<{
+        ok?: boolean | null;
+        id?: string | null;
+        rev?: string | null;
+        error?: string | null;
+        reason?: string | null;
+    }>);
+    originalError: Error;
+    rollbackResults: {
+        ok?: boolean | null;
+        id?: string | null;
+        rev?: string | null;
+        error?: string | null;
+        reason?: string | null;
+    }[];
+}
+//# sourceMappingURL=transactionErrors.d.mts.map

package/impl/transactionErrors.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionErrors.d.mts","sourceRoot":"","sources":["transactionErrors.mjs"],"names":[],"mappings":"AAAA;IACE;;;OAGG;IACH,qBAHW,MAAM,YACN,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAM7B;IADC,6BAAsB;CAEzB;AAED;IACE;;OAEG;IACH,4BAFW,MAAM,EAAE,EAMlB;IADC,yBAAoC;CAEvC;AAED;IACE;;OAEG;IACH,wBAFW,KAAK,CAAC;QAAC,EAAE,CAAC,EAAE,OAAO,GAAC,IAAI,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,GAAC,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAC,IAAI,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAC,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,GAAC,IAAI,CAAA;KAAC,CAAC,EAMpH;IADC;aALqB,OAAO,GAAC,IAAI;aAAO,MAAM,GAAC,IAAI;cAAQ,MAAM,GAAC,IAAI;gBAAU,MAAM,GAAC,IAAI;iBAAW,MAAM,GAAC,IAAI;QAKrF;CAE/B;AAED;IACE;;;;OAIG;IACH,qBAJW,MAAM,iBACN,KAAK,mBACL,KAAK,CAAC;QAAC,EAAE,CAAC,EAAE,OAAO,GAAC,IAAI,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,GAAC,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAC,IAAI,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAC,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,GAAC,IAAI,CAAA;KAAC,CAAC,EAOpH;IAFC,qBAAkC;IAClC;aANqB,OAAO,GAAC,IAAI;aAAO,MAAM,GAAC,IAAI;cAAQ,MAAM,GAAC,IAAI;gBAAU,MAAM,GAAC,IAAI;iBAAW,MAAM,GAAC,IAAI;QAM3E;CAEzC"}

package/impl/transactionErrors.mjs

@@ -0,0 +1,47 @@
+export class TransactionSetupError extends Error {
+  /**
+   * @param {string} message
+   * @param {Record<string, any>} details
+   */
+  constructor (message, details = {}) {
+    super(message)
+    this.name = 'TransactionSetupError'
+    this.details = details
+  }
+}
+
+export class TransactionVersionConflictError extends Error {
+  /**
+   * @param {string[]} conflictingIds
+   */
+  constructor (conflictingIds) {
+    super(`Revision mismatch for documents: ${conflictingIds.join(', ')}`)
+    this.name = 'TransactionVersionConflictError'
+    this.conflictingIds = conflictingIds
+  }
+}
+
+export class TransactionBulkOperationError extends Error {
+  /**
+   * @param {Array<{ok?: boolean|null, id?: string|null, rev?: string|null, error?: string|null, reason?: string|null}>} failedDocs
+   */
+  constructor (failedDocs) {
+    super(`Failed to save documents: ${failedDocs.map(d => d.id).join(', ')}`)
+    this.name = 'TransactionBulkOperationError'
+    this.failedDocs = failedDocs
+  }
+}
+
+export class TransactionRollbackError extends Error {
+  /**
+   * @param {string} message
+   * @param {Error} originalError
+   * @param {Array<{ok?: boolean|null, id?: string|null, rev?: string|null, error?: string|null, reason?: string|null}>} rollbackResults
+   */
+  constructor (message, originalError, rollbackResults) {
+    super(message)
+    this.name = 'TransactionRollbackError'
+    this.originalError = originalError
+    this.rollbackResults = rollbackResults
+  }
+}

package/index.d.mts

@@ -1,9 +1,8 @@
 import { get } from './impl/crud.mjs';
+import { getAtRev } from './impl/crud.mjs';
 import { put } from './impl/crud.mjs';
-import { patch } from './impl/patch.mjs';
 import { bulkGet } from './impl/bulk.mjs';
 import { bulkSave } from './impl/bulk.mjs';
-import { bulkRemove } from './impl/bulk.mjs';
 import { query } from './impl/query.mjs';
 import { queryStream } from './impl/stream.mjs';
 export namespace schema {
@@ -15,15 +14,26 @@ export namespace schema {
     export { BulkSave };
     export { BulkGet };
     export { BulkRemove };
+    export { BulkGetDictionary };
+    export { BulkSaveTransaction };
     export { CouchGet };
     export { CouchPut };
     export { CouchDoc };
     export { CouchDocResponse };
     export { Patch };
+    export { PatchDangerously };
+    export { CouchGetAtRev };
+    export { Bind };
 }
+import { patch } from './impl/patch.mjs';
+import { patchDangerously } from './impl/patch.mjs';
+import { bulkRemove } from './impl/bulk.mjs';
+import { bulkGetDictionary } from './impl/bulk.mjs';
+import { bulkSaveTransaction } from './impl/bulk.mjs';
 /** @type { import('./schema/bind.mjs').BindSchema } */
 export const bindConfig: import("./schema/bind.mjs").BindSchema;
 import { withRetry } from './impl/retry.mjs';
+import { createQuery } from './impl/queryBuilder.mjs';
 import { CouchConfig } from './schema/config.mjs';
 import { SimpleViewQuery } from './schema/query.mjs';
 import { SimpleViewQueryResponse } from './schema/query.mjs';
@@ -32,10 +42,15 @@ import { OnRow } from './schema/stream.mjs';
 import { BulkSave } from './schema/bulk.mjs';
 import { BulkGet } from './schema/bulk.mjs';
 import { BulkRemove } from './schema/bulk.mjs';
+import { BulkGetDictionary } from './schema/bulk.mjs';
+import { BulkSaveTransaction } from './schema/bulk.mjs';
 import { CouchGet } from './schema/crud.mjs';
 import { CouchPut } from './schema/crud.mjs';
 import { CouchDoc } from './schema/crud.mjs';
 import { CouchDocResponse } from './schema/crud.mjs';
 import { Patch } from './schema/patch.mjs';
-export { get, put, patch, bulkGet, bulkSave, bulkRemove, query, queryStream, withRetry };
+import { PatchDangerously } from './schema/patch.mjs';
+import { CouchGetAtRev } from './schema/crud.mjs';
+import { Bind } from './schema/bind.mjs';
+export { get, getAtRev, put, bulkGet, bulkSave, query, queryStream, patch, patchDangerously, bulkRemove, bulkGetDictionary, bulkSaveTransaction, withRetry, createQuery };
 //# sourceMappingURL=index.d.mts.map

package/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["index.mjs"],"names":[],"mappings":"oBAEyB,iBAAiB;oBAAjB,iBAAiB;sBACpB,kBAAkB;wBAFM,iBAAiB;yBAAjB,iBAAiB;2BAAjB,iBAAiB;sBAGzC,kBAAkB;4BACZ,mBAAmB;;;;;;;;;;;;;;;;AA0B/C,uDAAuD;AACvD,yBADY,OAAO,mBAAmB,EAAE,UAAU,CAsBhD;0BA/CwB,kBAAkB;4BAEhB,qBAAqB;gCACQ,oBAAoB;wCAApB,oBAAoB;sCAChC,qBAAqB;sBAArB,qBAAqB;yBAHpB,mBAAmB;wBAAnB,mBAAmB;2BAAnB,mBAAmB;yBAKF,mBAAmB;yBAAnB,mBAAmB;yBAAnB,mBAAmB;iCAAnB,mBAAmB;sBAD5D,oBAAoB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["index.mjs"],"names":[],"mappings":"oBAEmC,iBAAiB;yBAAjB,iBAAiB;oBAAjB,iBAAiB;wBADkC,iBAAiB;yBAAjB,iBAAiB;sBAGjF,kBAAkB;4BACZ,mBAAmB;;;;;;;;;;;;;;;;;;;;;sBAFP,kBAAkB;iCAAlB,kBAAkB;2BAF4B,iBAAiB;kCAAjB,iBAAiB;oCAAjB,iBAAiB;AAoCvG,uDAAuD;AACvD,yBADY,OAAO,mBAAmB,EAAE,UAAU,CA2BhD;0BAzDwB,kBAAkB;4BADhB,yBAAyB;4BAGzB,qBAAqB;gCACQ,oBAAoB;wCAApB,oBAAoB;sCAChC,qBAAqB;sBAArB,qBAAqB;yBAHoB,mBAAmB;wBAAnB,mBAAmB;2BAAnB,mBAAmB;kCAAnB,mBAAmB;oCAAnB,mBAAmB;yBAK3B,mBAAmB;yBAAnB,mBAAmB;yBAAnB,mBAAmB;iCAAnB,mBAAmB;sBADzD,oBAAoB;iCAApB,oBAAoB;8BACkB,mBAAmB;qBAC5E,mBAAmB"}

package/index.mjs

@@ -1,16 +1,17 @@
 // @ts-check */
-import { bulkGet, bulkSave, bulkRemove } from './impl/bulk.mjs'
-import { get, put } from './impl/crud.mjs'
-import { patch } from './impl/patch.mjs'
+import { bulkGet, bulkSave, bulkRemove, bulkGetDictionary, bulkSaveTransaction } from './impl/bulk.mjs'
+import { get, put, getAtRev } from './impl/crud.mjs'
+import { patch, patchDangerously } from './impl/patch.mjs'
 import { query } from './impl/query.mjs'
 import { queryStream } from './impl/stream.mjs'
+import { createQuery } from './impl/queryBuilder.mjs'
 import { withRetry } from './impl/retry.mjs'
-import { BulkSave, BulkGet, BulkRemove } from './schema/bulk.mjs'
+import { BulkSave, BulkGet, BulkRemove, BulkGetDictionary, BulkSaveTransaction } from './schema/bulk.mjs'
 import { CouchConfig } from './schema/config.mjs'
 import { SimpleViewQuery, SimpleViewQueryResponse } from './schema/query.mjs'
 import { SimpleViewQueryStream, OnRow } from './schema/stream.mjs'
-import { Patch } from './schema/patch.mjs'
-import { CouchDoc, CouchDocResponse, CouchPut, CouchGet } from './schema/crud.mjs'
+import { Patch, PatchDangerously } from './schema/patch.mjs'
+import { CouchDoc, CouchDocResponse, CouchPut, CouchGet, CouchGetAtRev } from './schema/crud.mjs'
 import { Bind } from './schema/bind.mjs'
 
 const schema = {
@@ -22,11 +23,16 @@ const schema = {
   BulkSave,
   BulkGet,
   BulkRemove,
+  BulkGetDictionary,
+  BulkSaveTransaction,
   CouchGet,
   CouchPut,
   CouchDoc,
   CouchDocResponse,
-  Patch
+  Patch,
+  PatchDangerously,
+  CouchGetAtRev,
+  Bind
 }
 
 /** @type { import('./schema/bind.mjs').BindSchema } */
@@ -43,14 +49,39 @@ const bindConfig = Bind.implement((
 
   return {
     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),
-    patch: patch.bind(null, config), // patch not included in retry
     bulkGet: config.bindWithRetry ? withRetry(bulkGet.bind(null, config), retryOptions) : bulkGet.bind(null, config),
     bulkSave: config.bindWithRetry ? withRetry(bulkSave.bind(null, config), retryOptions) : bulkSave.bind(null, config),
-    bulkRemove: config.bindWithRetry ? withRetry(bulkRemove.bind(null, config), retryOptions) : bulkRemove.bind(null, config),
     query: config.bindWithRetry ? withRetry(query.bind(null, config), retryOptions) : query.bind(null, config),
-    queryStream: config.bindWithRetry ? withRetry(queryStream.bind(null, config), retryOptions) : queryStream.bind(null, config)
+    queryStream: config.bindWithRetry ? withRetry(queryStream.bind(null, config), retryOptions) : queryStream.bind(null, config),
+    // Sugar Methods
+    patch: config.bindWithRetry ? withRetry(patch.bind(null, config), retryOptions) : patch.bind(null, config),
+    patchDangerously: patchDangerously.bind(null, config), // patchDangerously not included in retry
+    bulkRemove: config.bindWithRetry ? withRetry(bulkRemove.bind(null, config), retryOptions) : bulkRemove.bind(null, config),
+    bulkGetDictionary: config.bindWithRetry ? withRetry(bulkGetDictionary.bind(null, config), retryOptions) : bulkGetDictionary.bind(null, config),
+    bulkSaveTransaction: bulkSaveTransaction.bind(null, config)
   }
 })
 
-export { get, put, patch, bulkGet, bulkSave, bulkRemove, query, queryStream, schema, bindConfig, withRetry }
+export {
+  get,
+  getAtRev,
+  put,
+  bulkGet,
+  bulkSave,
+  query,
+  queryStream,
+  schema,
+
+  // sugar methods
+  patch,
+  patchDangerously,
+  bulkRemove,
+  bulkGetDictionary,
+  bulkSaveTransaction,
+
+  bindConfig,
+  withRetry,
+  createQuery
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hide-a-bed",
-  "version": "4.0.3",
+  "version": "4.1.2",
   "description": "An abstraction over couchdb calls that includes easy mock/stubs with pouchdb",
   "module": "index.mjs",
   "main": "cjs/index.cjs",
@@ -11,12 +11,13 @@
     "default": "./cjs/index.cjs"
   },
   "scripts": {
-    "clean": "(find . -name \"*.mts\" -type f -delete || true) && (find . -name \"*.map\" -type f -delete || true)",
+    "clean": "(find . -name \"*.mts\" -type f -delete || true) && (find . -name \"*.map\" -type f -delete || true) && (find . -name \"log.txt\" -type f -delete || true)",
     "build": "npm run clean && tsc && npm run build:cjs",
     "build:cjs": "rm -rf cjs && node build/build.mjs",
-    "test": "standard && tape tests/*.mjs",
+    "test": "node test/test.mjs",
     "lint:fix": "standard --fix",
-    "prepublish": "npm run build"
+    "prepublish": "npm run build",
+    "full": "npm run lint:fix && npm run build && npm run clean"
   },
   "repository": {
     "type": "git",
@@ -43,7 +44,11 @@
     "@types/needle": "^3.3.0",
     "esbuild": "^0.24.2",
     "glob": "^11.0.0",
+    "install": "^0.13.0",
+    "npm": "^11.1.0",
+    "pouchdb-server": "^4.2.0",
     "standard": "17.1.0",
+    "tap": "^21.0.2",
     "tape": "5.8.1",
     "typescript": "5.6.2"
   },