hide-a-bed 1.1.0 → 1.2.0

package/impl/crud.mjs

@@ -13,6 +13,7 @@ export const get = CouchGet.implement(async (config, id) => {
   const url = `${config.couch}/${id}`
   const resp = await needle('get', url, opts)
   const result = resp?.body || {}
+  result.statusCode = resp.statusCode
   if (resp.statusCode !== 200) {
     throw new Error('not found')
   }

package/index.mjs

@@ -2,6 +2,22 @@ import { bulkGet, bulkSave, bulkRemove } from './impl/bulk.mjs'
 import { get, put } from './impl/crud.mjs'
 import { query } from './impl/query.mjs'
 import { queryStream } from './impl/stream.mjs'
+import { BulkSave, BulkGet } from './schema/bulk.mjs'
+import { CouchConfig } from './schema/config.mjs'
+import { SimpleViewQuery, SimpleViewQueryResponse } from './schema/query.mjs'
+import { CouchDoc, CouchDocResponse, CouchPut, CouchGet } from './schema/crud.mjs'
 
-export { get, put, bulkGet, bulkSave, bulkRemove, query, queryStream }
+const schema = {
+  CouchConfig,
+  SimpleViewQuery,
+  SimpleViewQueryResponse,
+  BulkSave,
+  BulkGet,
+  CouchGet,
+  CouchPut,
+  CouchDoc,
+  CouchDocResponse
+}
+
+export { get, put, bulkGet, bulkSave, bulkRemove, query, queryStream, schema }
 

package/package.json

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

package/schema/bulk.mjs

@@ -1,28 +1,24 @@
 import { z } from 'zod'
+import { CouchConfig } from './config.mjs'
 
-// TODO - type this object
-export const SaveResponseSchema = z.array(z.object({
+export const BulkSaveResponseSchema = z.array(z.object({
   ok: z.boolean().nullish(),
   id: z.string(),
   rev: z.string().nullish(),
   error: z.string().nullish().describe('if an error occured, one word reason, eg conflict'),
   reason: z.string().nullish().describe('a full error message')
 }))
-/** @typedef { z.infer<typeof SaveResponseSchema> } Response */
+/** @typedef { z.infer<typeof BulkSaveResponseSchema> } Response */
 
 export const BulkSave = z.function().args(
-  z.object({
-    couch: z.string().describe('the url to the couch database')
-  }).passthrough().describe('config object'),
+  CouchConfig,
   z.array(z.object({
     _id: z.string()
   }).passthrough())
-).returns(z.promise(SaveResponseSchema))
+).returns(z.promise(BulkSaveResponseSchema))
 /** @typedef { z.infer<typeof SaveSchema> } Save */
 
 export const BulkGet = z.function().args(
-  z.object({
-    couch: z.string().describe('the url to the couch database')
-  }).passthrough().describe('config object'),
+  CouchConfig,
   z.array(z.string().describe('the ids to get'))
 )

package/schema/config.mjs

@@ -0,0 +1,4 @@
+import { z } from 'zod'
+export const CouchConfig = z.object({
+  couch: z.string().describe('the url of the couch db')
+}).passthrough().describe('The std config object')

package/schema/crud.mjs

@@ -1,4 +1,5 @@
 import { z } from 'zod'
+import { CouchConfig } from './config.mjs'
 
 export const CouchDoc = z.object({
   _id: z.string().describe('the couch doc id'),
@@ -13,10 +14,6 @@ export const CouchDocResponse = z.object({
   rev: z.string().optional().describe('the new rev of the doc')
 })
 
-export const CouchConfig = z.object({
-  couch: z.string().describe('the url of the couch db')
-}).passthrough().describe('The std config object')
-
 export const CouchPut = z.function().args(
   CouchConfig,
   CouchDoc

package/schema/query.mjs

@@ -1,4 +1,5 @@
 import { z } from 'zod'
+import { CouchConfig } from './config.mjs'
 
 export const SimpleViewQueryResponse = z.object({
   error: z.string().optional().describe('if something is wrong'),
@@ -10,12 +11,9 @@ export const SimpleViewQueryResponse = z.object({
   }))
 }).passthrough()
 
-export const SimpleViewQueryConfig = z.object({
-  couch: z.string().describe('the url of the couch db')
-}).passthrough().describe('The std config object')
 
 export const SimpleViewQuery = z.function().args(
-  SimpleViewQueryConfig,
+  CouchConfig,
   z.string().describe('the view name'),
   z.object({
     startkey: z.any().optional(),