hide-a-bed 5.1.3 → 5.1.5

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').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/schema/query.cjs

@@ -42,8 +42,8 @@ const SimpleViewOptions = import_zod.z.object({
   startkey: import_zod.z.any().optional(),
   endkey: import_zod.z.any().optional(),
   descending: import_zod.z.boolean().optional().describe("sort results descending"),
-  skip: import_zod.z.number().positive().optional().describe("skip this many rows"),
-  limit: import_zod.z.number().positive().optional().describe("limit the results to this many rows"),
+  skip: import_zod.z.number().nonnegative().optional().describe("skip this many rows"),
+  limit: import_zod.z.number().nonnegative().optional().describe("limit the results to this many rows"),
   key: import_zod.z.any().optional(),
   keys: import_zod.z.array(import_zod.z.any()).optional(),
   include_docs: import_zod.z.boolean().optional().describe("join the id to the doc and return it"),

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "hide-a-bed",
-  "version": "5.1.3",
+  "version": "5.1.5",
   "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",
@@ -57,4 +58,4 @@
     "node": "20.17.0",
     "npm": "10.8.2"
   }
-}
+}

package/schema/query.mjs

@@ -20,8 +20,8 @@ export const SimpleViewOptions = z.object({
   startkey: z.any().optional(),
   endkey: z.any().optional(),
   descending: z.boolean().optional().describe('sort results descending'),
-  skip: z.number().positive().optional().describe('skip this many rows'),
-  limit: z.number().positive().optional().describe('limit the results to this many rows'),
+  skip: z.number().nonnegative().optional().describe('skip this many rows'),
+  limit: z.number().nonnegative().optional().describe('limit the results to this many rows'),
   key: z.any().optional(),
   keys: z.array(z.any()).optional(),
   include_docs: z.boolean().optional().describe('join the id to the doc and return it'),