hide-a-bed 5.1.2 → 5.1.4

package/README.md

@@ -40,9 +40,23 @@ 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 services = { db } // see example below
 const doc = await db.get('doc-123')
 ```
 
+If you need to force autocompletion/type-checking, you can add the following jsdoc to help your editor
+
+```
+function doSomething (services)
+  /**  @type { import('hide-a-bed/index.mjs').DB} db */
+  const db = services.db;
+```
+
+Here is an example of compiler warnings:
+
+![jsdoc type def](docs/compiler.png)
+
+
 ##### Config Overrides
 
 You also can quickly change one (or more) config settings for a particular call with the db.config(options)

package/cjs/index.cjs

@@ -38,6 +38,7 @@ __export(index_exports, {
   withRetry: () => import_retry.withRetry
 });
 module.exports = __toCommonJS(index_exports);
+var import_zod = require("zod");
 var import_bulk = require("./impl/bulk.cjs");
 var import_crud = require("./impl/crud.cjs");
 var import_changes = require("./impl/changes.cjs");

package/index.d.mts

@@ -1,3 +1,4 @@
+export type DB = z.infer<typeof BindReturns>;
 import { get } from './impl/crud.mjs';
 import { getAtRev } from './impl/crud.mjs';
 import { put } from './impl/crud.mjs';
@@ -44,6 +45,8 @@ import { withRetry } from './impl/retry.mjs';
 import { createQuery } from './impl/queryBuilder.mjs';
 import { createLock } from './impl/sugar/lock.mjs';
 import { removeLock } from './impl/sugar/lock.mjs';
+import { z } from 'zod';
+import { BindReturns } from './schema/bind.mjs';
 import { CouchConfig } from './schema/config.mjs';
 import { SimpleViewQuery } from './schema/query.mjs';
 import { SimpleViewQueryResponse } from './schema/query.mjs';

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;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"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["index.mjs"],"names":[],"mappings":"iBA+Ge,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC;oBA5GP,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;kBAL5C,KAAK;4BAoBW,mBAAmB;4BARzB,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;qBAC/D,mBAAmB;qBAHK,yBAAyB;0BACzD,0BAA0B;4BADM,yBAAyB;2BAAzB,yBAAyB;2BAAzB,yBAAyB;wBAH1B,sBAAsB;+BAAtB,sBAAsB;gCAAtB,sBAAsB"}

package/index.mjs

@@ -1,4 +1,5 @@
 // @ts-check */
+import { z } from 'zod'
 import { bulkGet, bulkSave, bulkRemove, bulkGetDictionary, bulkSaveTransaction } from './impl/bulk.mjs'
 import { get, put, getAtRev } from './impl/crud.mjs'
 import { changes } from './impl/changes.mjs'
@@ -18,7 +19,7 @@ import { Patch, PatchDangerously } from './schema/patch.mjs'
 import { Lock, LockOptions, CreateLock, RemoveLock } from './schema/sugar/lock.mjs'
 import { WatchDocs } from './schema/sugar/watch.mjs'
 import { CouchDoc, CouchDocResponse, CouchPut, CouchGet, CouchGetAtRev } from './schema/crud.mjs'
-import { Bind } from './schema/bind.mjs'
+import { Bind, BindReturns } from './schema/bind.mjs'
 
 const schema = {
   CouchConfig,
@@ -108,6 +109,8 @@ const bindConfig = Bind.implement((
   return all
 })
 
+/** @typedef { z.infer<typeof BindReturns> } DB */
+
 export {
   get,
   getAtRev,

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "hide-a-bed",
-  "version": "5.1.2",
+  "version": "5.1.4",
   "description": "An abstraction over couchdb calls that includes easy mock/stubs with pouchdb",
   "module": "index.mjs",
   "main": "cjs/index.cjs",
   "type": "module",
+  "types": "index.d.mts",
   "exports": {
     "require": "./cjs/index.cjs",
     "import": "./index.mjs",