hide-a-bed 5.2.7 → 6.0.0-beta.0

package/types/output/impl/bulkSave.d.mts

@@ -0,0 +1,64 @@
+import { BulkSaveResponse, type CouchDocInput } from '../schema/couch/couch.output.schema.ts';
+import type { CouchConfigInput } from '../schema/config.mts';
+/**
+ * Bulk saves documents to CouchDB using the _bulk_docs endpoint.
+ *
+ * @see
+ * https://docs.couchdb.org/en/stable/api/database/bulk-api.html#db-bulk-docs
+ *
+ * @param {CouchConfigInput} config - The CouchDB configuration.
+ * @param {CouchDocInput[]} docs - An array of documents to save.
+ * @returns {Promise<BulkSaveResponse>} - The response from CouchDB after the bulk save operation.
+ *
+ * @throws {RetryableError} When a retryable HTTP status code is encountered or no response is received.
+ * @throws {Error} When CouchDB returns a non-retryable error payload.
+ */
+export declare const bulkSave: (config: CouchConfigInput, docs: CouchDocInput[]) => Promise<{
+    ok?: boolean | null | undefined;
+    id?: string | null | undefined;
+    rev?: string | null | undefined;
+    error?: string | null | undefined;
+    reason?: string | null | undefined;
+}[]>;
+/**
+ * Performs a bulk save of documents within a transaction context.
+ *
+ * @remarks
+ * This operation ensures that either all documents are saved successfully, or none are, maintaining data consistency.
+ * If any document fails to save, the operation will attempt to roll back all changes.
+ *
+ * The transactionId has to be unique for the lifetime of the app. It is used to prevent two processes from executing the same transaction. It is up to you to craft a transactionId that uniquely represents this transaction, and that also is the same if another process tries to generate it.
+ *
+ * Exceptions to handle:
+ *
+ * `TransactionSetupError` Thrown if the transaction document cannot be created. Usually because it already exists
+ * `TransactionVersionConflictError` Thrown if there are version conflicts with existing documents.
+ * `TransactionBulkOperationError` Thrown if the bulk save operation fails for some documents.
+ * `TransactionRollbackError` Thrown if the rollback operation fails after a transaction failure.
+ *
+ * @example
+ * ```ts
+ * const docsToSave = [
+ *  { _id: 'doc1', foo: 'bar' },
+ *  { _id: 'doc2', foo: 'baz' }
+ * ];
+ *
+ * try {
+ *  const results = await bulkSaveTransaction(config, 'unique-transaction-id', docsToSave);
+ *  console.log('Bulk save successful:', results);
+ *  } catch (error) {
+ *  console.error('Bulk save transaction failed:', error);
+ * }
+ * ```
+ *
+ * @param {CouchConfigInput} config - The CouchDB configuration.
+ * @param {string} transactionId - A unique identifier for the transaction.
+ * @param {CouchDocInput[]} docs - An array of documents to save.
+ * @returns {Promise<BulkSaveResponse>} - The transaction save results.
+ * @throws {TransactionSetupError} When the transaction document cannot be created.
+ * @throws {TransactionVersionConflictError} When there are version conflicts with existing documents.
+ * @throws {TransactionBulkOperationError} When the bulk save operation fails for some documents.
+ * @throws {TransactionRollbackError} When the rollback operation fails after a transaction failure.
+ */
+export declare const bulkSaveTransaction: (config: CouchConfigInput, transactionId: string, docs: CouchDocInput[]) => Promise<BulkSaveResponse>;
+//# sourceMappingURL=bulkSave.d.mts.map

package/types/output/impl/bulkSave.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkSave.d.mts","sourceRoot":"","sources":["../../../impl/bulkSave.mts"],"names":[],"mappings":"AAWA,OAAO,EACL,gBAAgB,EAEhB,KAAK,aAAa,EACnB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAK5D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,GAAU,QAAQ,gBAAgB,EAAE,MAAM,aAAa,EAAE;;;;;;IAuC7E,CAAA;AAYD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,gBAAgB,EACxB,eAAe,MAAM,EACrB,MAAM,aAAa,EAAE,KACpB,OAAO,CAAC,gBAAgB,CA4J1B,CAAA"}

package/types/output/impl/bulkSave.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=bulkSave.test.d.mts.map

package/types/output/impl/bulkSave.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkSave.test.d.mts","sourceRoot":"","sources":["../../../impl/bulkSave.test.mts"],"names":[],"mappings":""}

package/types/output/impl/get.d.mts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import type { CouchConfigInput } from '../schema/config.mts';
+import type { StandardSchemaV1 } from '../types/standard-schema.ts';
+import { CouchDoc } from '../schema/couch/couch.output.schema.ts';
+export type GetOptions<DocSchema extends StandardSchemaV1> = {
+    validate?: {
+        docSchema?: DocSchema;
+    };
+};
+export declare const CouchGetOptions: z.ZodObject<{
+    rev: z.ZodOptional<z.ZodString>;
+    validate: z.ZodOptional<z.ZodObject<{
+        docSchema: z.ZodOptional<z.ZodCustom<unknown, unknown>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare function get<DocSchema extends StandardSchemaV1 = typeof CouchDoc>(config: CouchConfigInput, id: string, options?: GetOptions<DocSchema>): Promise<StandardSchemaV1.InferOutput<DocSchema> | null>;
+export type GetBound = <DocSchema extends StandardSchemaV1 = typeof CouchDoc>(id: string, options?: GetOptions<DocSchema>) => Promise<StandardSchemaV1.InferOutput<DocSchema> | null>;
+export declare function getAtRev<DocSchema extends StandardSchemaV1>(config: CouchConfigInput, id: string, rev: string, options?: GetOptions<DocSchema>): Promise<StandardSchemaV1.InferOutput<DocSchema> | null>;
+export type GetAtRevBound = <DocSchema extends StandardSchemaV1 = typeof CouchDoc>(id: string, rev: string, options?: GetOptions<DocSchema> | undefined) => Promise<StandardSchemaV1.InferOutput<DocSchema> | null>;
+//# sourceMappingURL=get.d.mts.map

package/types/output/impl/get.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.d.mts","sourceRoot":"","sources":["../../../impl/get.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAI5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAA;AAEjE,MAAM,MAAM,UAAU,CAAC,SAAS,SAAS,gBAAgB,IAAI;IAC3D,QAAQ,CAAC,EAAE;QACT,SAAS,CAAC,EAAE,SAAS,CAAA;KACtB,CAAA;CACF,CAAA;AAeD,eAAO,MAAM,eAAe;;;;;iBAQ1B,CAAA;AA0EF,wBAAsB,GAAG,CAAC,SAAS,SAAS,gBAAgB,GAAG,OAAO,QAAQ,EAC5E,MAAM,EAAE,gBAAgB,EACxB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,GAC9B,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAEzD;AAED,MAAM,MAAM,QAAQ,GAAG,CAAC,SAAS,SAAS,gBAAgB,GAAG,OAAO,QAAQ,EAC1E,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,KAC5B,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAA;AAE5D,wBAAsB,QAAQ,CAAC,SAAS,SAAS,gBAAgB,EAC/D,MAAM,EAAE,gBAAgB,EACxB,EAAE,EAAE,MAAM,EACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,GAC9B,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAEzD;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,SAAS,SAAS,gBAAgB,GAAG,OAAO,QAAQ,EAC/E,EAAE,EAAE,MAAM,EACV,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,GAAG,SAAS,KACxC,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAA"}

package/types/output/impl/get.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=get.test.d.mts.map

package/types/output/impl/get.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.test.d.mts","sourceRoot":"","sources":["../../../impl/get.test.mts"],"names":[],"mappings":""}

package/types/output/impl/getDBInfo.d.mts

@@ -0,0 +1,52 @@
+import { type CouchConfigInput } from '../schema/config.mts';
+/**
+ * Fetches and returns CouchDB database information.
+ *
+ * @see {@link https://docs.couchdb.org/en/stable/api/database/common.html#get--db | CouchDB API Documentation}
+ *
+ * @param configInput - The CouchDB configuration input.
+ * @returns A promise that resolves to the CouchDB database information.
+ * @throws {RetryableError} `RetryableError` If a retryable error occurs during the request.
+ * @throws {Error} `Error` For other non-retryable errors.
+ *
+ * @example
+ * ```ts
+ * import { getDBInfo } from './impl/getDBInfo.mts';
+ *
+ * const config = { couch: 'http://localhost:5984/my-database' };
+ *
+ * getDBInfo(config)
+ *   .then(info => {
+ *     console.log('Database Info:', info);
+ *   })
+ *   .catch(err => {
+ *     console.error('Error fetching database info:', err);
+ *   });
+ * ```
+ */
+export declare const getDBInfo: (configInput: CouchConfigInput) => Promise<{
+    [x: string]: unknown;
+    db_name: string;
+    cluster?: {
+        n?: number | undefined;
+        q?: number | undefined;
+        r?: number | undefined;
+        w?: number | undefined;
+    } | undefined;
+    compact_running?: boolean | undefined;
+    disk_format_version?: number | undefined;
+    doc_count?: number | undefined;
+    doc_del_count?: number | undefined;
+    instance_start_time?: string | undefined;
+    purge_seq?: string | undefined;
+    sizes?: {
+        active?: number | undefined;
+        external?: number | undefined;
+        file?: number | undefined;
+    } | undefined;
+    update_seq?: string | number | undefined;
+    props?: {
+        partitioned?: boolean | undefined;
+    } | undefined;
+}>;
+//# sourceMappingURL=getDBInfo.d.mts.map

package/types/output/impl/getDBInfo.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDBInfo.d.mts","sourceRoot":"","sources":["../../../impl/getDBInfo.mts"],"names":[],"mappings":"AAIA,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAGzE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS,GAAU,aAAa,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;EAkC5D,CAAA"}

package/types/output/impl/getDBInfo.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getDBInfo.test.d.mts.map

package/types/output/impl/getDBInfo.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDBInfo.test.d.mts","sourceRoot":"","sources":["../../../impl/getDBInfo.test.mts"],"names":[],"mappings":""}

package/types/output/impl/patch.d.mts

@@ -0,0 +1,45 @@
+import { type CouchConfigInput } from '../schema/config.mts';
+import { z } from 'zod';
+declare const PatchProperties: z.ZodObject<{
+    _rev: z.ZodString;
+}, z.core.$loose>;
+/**
+ * Patch a CouchDB document by merging provided properties.
+ * Validates that the _rev matches before applying the patch.
+ *
+ * @param configInput - CouchDB configuration
+ * @param id - Document ID to patch
+ * @param _properties - Properties to merge into the document (must include _rev)
+ * @returns The result of the put operation
+ *
+ * @throws Error if the _rev does not match or other errors occur
+ */
+export declare const patch: (configInput: CouchConfigInput, id: string, _properties: z.infer<typeof PatchProperties>) => Promise<{
+    statusCode: number;
+    ok?: boolean | undefined;
+    error?: string | undefined;
+    id?: string | undefined;
+    rev?: string | undefined;
+}>;
+/**
+ * Patch a CouchDB document by merging provided properties.
+ * This function will retry on conflicts using an exponential backoff strategy.
+ *
+ * @remarks patchDangerously can clobber data. It will retry even if a conflict happens. There are some use cases for this, but you have been warned, hence the name.
+ *
+ * @param configInput - CouchDB configuration
+ * @param id - Document ID to patch
+ * @param properties - Properties to merge into the document
+ * @returns The result of the put operation or an error if max retries are exceeded
+ *
+ * @throws Error if max retries are exceeded or other errors occur
+ */
+export declare const patchDangerously: (configInput: CouchConfigInput, id: string, properties: Record<string, unknown>) => Promise<{
+    statusCode: number;
+    ok?: boolean | undefined;
+    error?: string | undefined;
+    id?: string | undefined;
+    rev?: string | undefined;
+} | undefined>;
+export {};
+//# sourceMappingURL=patch.d.mts.map

package/types/output/impl/patch.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.d.mts","sourceRoot":"","sources":["../../../impl/patch.mts"],"names":[],"mappings":"AAIA,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACzE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,QAAA,MAAM,eAAe;;iBAIiB,CAAA;AAEtC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,GAChB,aAAa,gBAAgB,EAC7B,IAAI,MAAM,EACV,aAAa,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC;;;;;;EAsB7C,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,GAC3B,aAAa,gBAAgB,EAC7B,IAAI,MAAM,EACV,YAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;cAkEpC,CAAA"}

package/types/output/impl/patch.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=patch.test.d.mts.map

package/types/output/impl/patch.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.test.d.mts","sourceRoot":"","sources":["../../../impl/patch.test.mts"],"names":[],"mappings":""}

package/types/output/impl/put.d.mts

@@ -0,0 +1,5 @@
+import { type CouchConfigInput } from '../schema/config.mts';
+import { CouchPutResponse, type CouchDoc } from '../schema/couch/couch.output.schema.ts';
+import { z } from 'zod';
+export declare const put: (configInput: CouchConfigInput, doc: CouchDoc) => Promise<z.infer<typeof CouchPutResponse>>;
+//# sourceMappingURL=put.d.mts.map

package/types/output/impl/put.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"put.d.mts","sourceRoot":"","sources":["../../../impl/put.mts"],"names":[],"mappings":"AAIA,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACzE,OAAO,EAAE,gBAAgB,EAAE,KAAK,QAAQ,EAAE,MAAM,wCAAwC,CAAA;AACxF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,GAAG,GACd,aAAa,gBAAgB,EAC7B,KAAK,QAAQ,KACZ,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CA4C1C,CAAA"}

package/types/output/impl/put.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=put.test.d.mts.map

package/types/output/impl/put.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"put.test.d.mts","sourceRoot":"","sources":["../../../impl/put.test.mts"],"names":[],"mappings":""}

package/types/output/impl/query.d.mts

@@ -0,0 +1,47 @@
+import { type CouchConfigInput } from '../schema/config.mts';
+import { ZodAny, ZodNever } from 'zod';
+import { ViewOptions, type ViewString } from '../schema/couch/couch.input.schema.ts';
+import type { CouchDoc, ViewQueryResponseValidated } from '../schema/couch/couch.output.schema.ts';
+import type { StandardSchemaV1 } from '../types/standard-schema.ts';
+import { type OnInvalidDocAction } from './utils/parseRows.mts';
+export declare function query<DocSchema extends StandardSchemaV1 = typeof CouchDoc, KeySchema extends StandardSchemaV1 = ZodAny, ValueSchema extends StandardSchemaV1 = ZodAny>(config: CouchConfigInput, view: ViewString, options: ViewOptions & {
+    include_docs: true;
+    validate?: {
+        onInvalidDoc?: OnInvalidDocAction;
+        docSchema?: DocSchema;
+        keySchema?: KeySchema;
+        valueSchema?: ValueSchema;
+    };
+}): Promise<ViewQueryResponseValidated<DocSchema, KeySchema, ValueSchema>>;
+export declare function query<DocSchema extends StandardSchemaV1 = ZodNever, KeySchema extends StandardSchemaV1 = ZodAny, ValueSchema extends StandardSchemaV1 = ZodAny>(config: CouchConfigInput, view: ViewString, options: ViewOptions & {
+    include_docs?: false | undefined;
+    validate?: {
+        onInvalidDoc?: OnInvalidDocAction;
+        docSchema?: DocSchema;
+        keySchema?: KeySchema;
+        valueSchema?: ValueSchema;
+    };
+}): Promise<ViewQueryResponseValidated<ZodNever, KeySchema, ValueSchema>>;
+export declare function query(config: CouchConfigInput, view: ViewString, options?: ViewOptions): Promise<ViewQueryResponseValidated<ZodNever, ZodAny, ZodAny>>;
+export type QueryBound = {
+    <DocSchema extends StandardSchemaV1 = typeof CouchDoc, KeySchema extends StandardSchemaV1 = ZodAny, ValueSchema extends StandardSchemaV1 = ZodAny>(view: ViewString, options: ViewOptions & {
+        include_docs: true;
+        validate?: {
+            onInvalidDoc?: OnInvalidDocAction;
+            docSchema?: DocSchema;
+            keySchema?: KeySchema;
+            valueSchema?: ValueSchema;
+        };
+    }): Promise<ViewQueryResponseValidated<DocSchema, KeySchema, ValueSchema>>;
+    <DocSchema extends StandardSchemaV1 = ZodNever, KeySchema extends StandardSchemaV1 = ZodAny, ValueSchema extends StandardSchemaV1 = ZodAny>(view: ViewString, options: ViewOptions & {
+        include_docs?: false | undefined;
+        validate?: {
+            onInvalidDoc?: OnInvalidDocAction;
+            docSchema?: DocSchema;
+            keySchema?: KeySchema;
+            valueSchema?: ValueSchema;
+        };
+    }): Promise<ViewQueryResponseValidated<ZodNever, KeySchema, ValueSchema>>;
+    (view: ViewString, options?: ViewOptions): Promise<ViewQueryResponseValidated<ZodNever, ZodAny, ZodAny>>;
+};
+//# sourceMappingURL=query.d.mts.map

package/types/output/impl/query.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.mts","sourceRoot":"","sources":["../../../impl/query.mts"],"names":[],"mappings":"AAGA,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACzE,OAAO,EAAK,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAA;AAIzC,OAAO,EAAE,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,uCAAuC,CAAA;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAA;AAClG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAAa,KAAK,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAE1E,wBAAsB,KAAK,CACzB,SAAS,SAAS,gBAAgB,GAAG,OAAO,QAAQ,EACpD,SAAS,SAAS,gBAAgB,GAAG,MAAM,EAC3C,WAAW,SAAS,gBAAgB,GAAG,MAAM,EAE7C,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,WAAW,GAAG;IACrB,YAAY,EAAE,IAAI,CAAA;IAClB,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,kBAAkB,CAAA;QACjC,SAAS,CAAC,EAAE,SAAS,CAAA;QACrB,SAAS,CAAC,EAAE,SAAS,CAAA;QACrB,WAAW,CAAC,EAAE,WAAW,CAAA;KAC1B,CAAA;CACF,GACA,OAAO,CAAC,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAA;AAEzE,wBAAsB,KAAK,CACzB,SAAS,SAAS,gBAAgB,GAAG,QAAQ,EAC7C,SAAS,SAAS,gBAAgB,GAAG,MAAM,EAC3C,WAAW,SAAS,gBAAgB,GAAG,MAAM,EAE7C,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,WAAW,GAAG;IACrB,YAAY,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,kBAAkB,CAAA;QACjC,SAAS,CAAC,EAAE,SAAS,CAAA;QACrB,SAAS,CAAC,EAAE,SAAS,CAAA;QACrB,WAAW,CAAC,EAAE,WAAW,CAAA;KAC1B,CAAA;CACF,GACA,OAAO,CAAC,0BAA0B,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAA;AAExE,wBAAsB,KAAK,CACzB,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AAqIhE,MAAM,MAAM,UAAU,GAAG;IACvB,CACE,SAAS,SAAS,gBAAgB,GAAG,OAAO,QAAQ,EACpD,SAAS,SAAS,gBAAgB,GAAG,MAAM,EAC3C,WAAW,SAAS,gBAAgB,GAAG,MAAM,EAE7C,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,WAAW,GAAG;QACrB,YAAY,EAAE,IAAI,CAAA;QAClB,QAAQ,CAAC,EAAE;YACT,YAAY,CAAC,EAAE,kBAAkB,CAAA;YACjC,SAAS,CAAC,EAAE,SAAS,CAAA;YACrB,SAAS,CAAC,EAAE,SAAS,CAAA;YACrB,WAAW,CAAC,EAAE,WAAW,CAAA;SAC1B,CAAA;KACF,GACA,OAAO,CAAC,0BAA0B,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAA;IACzE,CACE,SAAS,SAAS,gBAAgB,GAAG,QAAQ,EAC7C,SAAS,SAAS,gBAAgB,GAAG,MAAM,EAC3C,WAAW,SAAS,gBAAgB,GAAG,MAAM,EAE7C,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,WAAW,GAAG;QACrB,YAAY,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;QAChC,QAAQ,CAAC,EAAE;YACT,YAAY,CAAC,EAAE,kBAAkB,CAAA;YACjC,SAAS,CAAC,EAAE,SAAS,CAAA;YACrB,SAAS,CAAC,EAAE,SAAS,CAAA;YACrB,WAAW,CAAC,EAAE,WAAW,CAAA;SAC1B,CAAA;KACF,GACA,OAAO,CAAC,0BAA0B,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAA;IACxE,CACE,IAAI,EAAE,UAAU,EAChB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACjE,CAAA"}

package/types/output/impl/query.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=query.test.d.mts.map

package/types/output/impl/query.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.test.d.mts","sourceRoot":"","sources":["../../../impl/query.test.mts"],"names":[],"mappings":""}

package/types/output/impl/remove.d.mts

@@ -0,0 +1,9 @@
+import { type CouchConfigInput } from '../schema/config.mts';
+export declare const remove: (configInput: CouchConfigInput, id: string, rev: string) => Promise<{
+    statusCode: number;
+    ok?: boolean | undefined;
+    error?: string | undefined;
+    id?: string | undefined;
+    rev?: string | undefined;
+}>;
+//# sourceMappingURL=remove.d.mts.map

package/types/output/impl/remove.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove.d.mts","sourceRoot":"","sources":["../../../impl/remove.mts"],"names":[],"mappings":"AAKA,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEzE,eAAO,MAAM,MAAM,GAAU,aAAa,gBAAgB,EAAE,IAAI,MAAM,EAAE,KAAK,MAAM;;;;;;EAyDlF,CAAA"}

package/types/output/impl/remove.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=remove.test.d.mts.map

package/types/output/impl/remove.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove.test.d.mts","sourceRoot":"","sources":["../../../impl/remove.test.mts"],"names":[],"mappings":""}

package/types/output/impl/retry.d.mts

@@ -0,0 +1,32 @@
+/**
+ * Settings that control how retry attempts are scheduled.
+ */
+export interface RetryOptions {
+    /**
+     * Maximum number of retry attempts before rethrowing the original error.
+     */
+    maxRetries?: number;
+    /**
+     * Initial wait duration in milliseconds before attempting the first retry.
+     */
+    initialDelay?: number;
+    /**
+     * Multiplier applied to the delay after each retry to implement exponential backoff.
+     */
+    backoffFactor?: number;
+    /**
+     * Upper bound, in milliseconds, for the delay between retries.
+     */
+    maxDelay?: number;
+}
+type MaybePromise<T> = PromiseLike<T> | T;
+/**
+ * Wrap an async-capable function with retry semantics that respect {@link RetryableError}.
+ * @typeParam Fn - The function signature to decorate with retry handling.
+ * @param fn The function to invoke with retry support.
+ * @param options Retry tuning parameters.
+ * @returns A function mirroring `fn` that automatically retries on {@link RetryableError}.
+ */
+export declare function withRetry<Fn extends (...args: any[]) => MaybePromise<any>>(fn: Fn, options?: RetryOptions): (...args: Parameters<Fn>) => Promise<Awaited<ReturnType<Fn>>>;
+export {};
+//# sourceMappingURL=retry.d.mts.map

package/types/output/impl/retry.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.d.mts","sourceRoot":"","sources":["../../../impl/retry.mts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,KAAK,YAAY,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAEzC;;;;;;GAMG;AAEH,wBAAgB,SAAS,CAAC,EAAE,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAAC,GAAG,CAAC,EACxE,EAAE,EAAE,EAAE,EACN,OAAO,GAAE,YAAiB,GACzB,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CA2B/D"}

package/types/output/impl/retry.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=retry.test.d.mts.map

package/types/output/impl/retry.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry.test.d.mts","sourceRoot":"","sources":["../../../impl/retry.test.mts"],"names":[],"mappings":""}

package/types/output/impl/stream.d.mts

@@ -0,0 +1,13 @@
+import { type CouchConfigInput } from '../schema/config.mts';
+import type { ViewRow } from '../schema/couch/couch.output.schema.ts';
+import type { ViewOptions } from '../schema/couch/couch.input.schema.ts';
+export type OnRow = (row: ViewRow) => void;
+/**
+ * Execute a CouchDB view query and stream rows as they are received.
+ * @param rawConfig CouchDB configuration
+ * @param view The CouchDB view to query
+ * @param options Query options
+ * @param onRow Callback invoked for each row received
+ */
+export declare function queryStream(rawConfig: CouchConfigInput, view: string, options: ViewOptions | undefined, onRow: OnRow): Promise<void>;
+//# sourceMappingURL=stream.d.mts.map

package/types/output/impl/stream.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.d.mts","sourceRoot":"","sources":["../../../impl/stream.mts"],"names":[],"mappings":"AAMA,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAKzE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAA;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAA;AAOxE,MAAM,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAA;AAG1C;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,SAAS,EAAE,gBAAgB,EAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,WAAW,GAAG,SAAS,EAChC,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,IAAI,CAAC,CA4Gf"}

package/types/output/impl/stream.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=stream.test.d.mts.map

package/types/output/impl/stream.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.test.d.mts","sourceRoot":"","sources":["../../../impl/stream.test.mts"],"names":[],"mappings":""}

package/types/output/impl/sugar/lock.d.mts

@@ -0,0 +1,24 @@
+import { LockOptions } from '../../schema/sugar/lock.mts';
+import { type CouchConfigInput } from '../../schema/config.mts';
+/**
+ * Create a lock document for the specified document ID.
+ * Returns true if the lock was created, false if locking is disabled or a conflict occurred.
+ *
+ * @param configInput CouchDB configuration
+ * @param docId The document ID to lock
+ * @param lockOptions Locking options
+ *
+ * @return True if the lock was created, false otherwise
+ */
+export declare function createLock(configInput: CouchConfigInput, docId: string, lockOptions: LockOptions): Promise<boolean>;
+/**
+ * Remove the lock document for the specified document ID if owned by the caller.
+ *
+ * @param configInput CouchDB configuration
+ * @param docId The document ID to unlock
+ * @param lockOptions Locking options
+ *
+ * @return Promise that resolves when the unlock operation is complete
+ */
+export declare function removeLock(configInput: CouchConfigInput, docId: string, lockOptions: LockOptions): Promise<void>;
+//# sourceMappingURL=lock.d.mts.map

package/types/output/impl/sugar/lock.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.d.mts","sourceRoot":"","sources":["../../../../impl/sugar/lock.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAIzD,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAG5E;;;;;;;;;GASG;AACH,wBAAsB,UAAU,CAC9B,WAAW,EAAE,gBAAgB,EAC7B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,OAAO,CAAC,CAgClB;AAED;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAC9B,WAAW,EAAE,gBAAgB,EAC7B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,IAAI,CAAC,CAkCf"}

package/types/output/impl/sugar/lock.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=lock.test.d.mts.map

package/types/output/impl/sugar/lock.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.test.d.mts","sourceRoot":"","sources":["../../../../impl/sugar/lock.test.mts"],"names":[],"mappings":""}

package/types/output/impl/sugar/watch.d.mts

@@ -0,0 +1,21 @@
+import { EventEmitter } from 'events';
+import { type WatchOptionsInput } from '../../schema/sugar/watch.mts';
+import { type CouchConfigInput } from '../../schema/config.mts';
+/**
+ * Watch for changes to specified document IDs in CouchDB.
+ * Calls the onChange callback for each change detected.
+ * Returns an emitter with methods to listen for events and stop watching.
+ *
+ * @param configInput CouchDB configuration
+ * @param docIds Document ID or array of document IDs to watch
+ * @param onChange Callback function called on each change
+ * @param optionsInput Watch options
+ *
+ * @return WatchEmitter with methods to manage the watch
+ */
+export declare function watchDocs(configInput: CouchConfigInput, docIds: string | string[], onChange: (change: any) => void, optionsInput?: WatchOptionsInput): {
+    on: (event: string, listener: EventListener) => EventEmitter<[never]>;
+    removeListener: (event: string, listener: EventListener) => EventEmitter<[never]>;
+    stop: () => void;
+};
+//# sourceMappingURL=watch.d.mts.map

package/types/output/impl/sugar/watch.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch.d.mts","sourceRoot":"","sources":["../../../../impl/sugar/watch.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAGrC,OAAO,EAAgB,KAAK,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAGnF,OAAO,EAEL,KAAK,gBAAgB,EAEtB,MAAM,yBAAyB,CAAA;AAEhC;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CACvB,WAAW,EAAE,gBAAgB,EAC7B,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,EAEzB,QAAQ,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,IAAI,EAC/B,YAAY,GAAE,iBAAsB;gBAkJtB,MAAM,YAAY,aAAa;4BACnB,MAAM,YAAY,aAAa;;EAU1D"}

package/types/output/impl/sugar/watch.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=watch.test.d.mts.map

package/types/output/impl/sugar/watch.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch.test.d.mts","sourceRoot":"","sources":["../../../../impl/sugar/watch.test.mts"],"names":[],"mappings":""}

package/types/output/impl/utils/errors.d.mts

@@ -0,0 +1,78 @@
+/**
+ * Represents a network-level error emitted by Node.js or libraries such as `needle`.
+ *
+ * @public
+ */
+export interface NetworkError {
+    /**
+     * Machine-readable error code describing the network failure.
+     */
+    code: string;
+    /**
+     * Optional human-readable message supplied by the underlying library.
+     */
+    message?: string;
+}
+/**
+ * Error thrown when a requested CouchDB document cannot be found.
+ *
+ * @remarks
+ * The `docId` property exposes the identifier that triggered the failure, which is
+ * helpful for logging and retry strategies.
+ *
+ * @public
+ */
+export declare class NotFoundError extends Error {
+    /**
+     * Identifier of the missing document.
+     */
+    readonly docId: string;
+    /**
+     * Creates a new {@link NotFoundError} instance.
+     *
+     * @param docId - The identifier of the document that was not found.
+     * @param message - Optional custom error message.
+     */
+    constructor(docId: string, message?: string);
+}
+/**
+ * Error signalling that an operation can be retried due to transient conditions.
+ *
+ * @remarks
+ * Use `RetryableError.isRetryableStatusCode` and `RetryableError.handleNetworkError`
+ * to detect when a failure should trigger retry logic.
+ *
+ * @public
+ */
+export declare class RetryableError extends Error {
+    /**
+     * HTTP status code associated with the retryable failure, when available.
+     */
+    readonly statusCode?: number;
+    /**
+     * Creates a new {@link RetryableError} instance.
+     *
+     * @param message - Detailed description of the failure.
+     * @param statusCode - Optional HTTP status code corresponding to the failure.
+     */
+    constructor(message: string, statusCode?: number);
+    /**
+     * Determines whether the provided status code should be treated as retryable.
+     *
+     * @param statusCode - HTTP status code returned by CouchDB.
+     *
+     * @returns `true` if the status code is considered retryable; otherwise `false`.
+     */
+    static isRetryableStatusCode(statusCode: number | undefined): statusCode is number;
+    /**
+     * Converts low-level network errors into {@link RetryableError} instances when possible.
+     *
+     * @param err - The error thrown by the underlying HTTP client.
+     *
+     * @throws {@link RetryableError} When the error maps to a retryable network condition.
+     * @throws {*} Re-throws the original error when it cannot be mapped.
+     */
+    static handleNetworkError(err: unknown): never;
+}
+export declare function isConflictError(err: unknown): boolean;
+//# sourceMappingURL=errors.d.mts.map

package/types/output/impl/utils/errors.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.mts","sourceRoot":"","sources":["../../../../impl/utils/errors.mts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAuBD;;;;;;;;GAQG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IAEtB;;;;;OAKG;gBACS,KAAK,EAAE,MAAM,EAAE,OAAO,SAAuB;CAK1D;AAED;;;;;;;;GAQG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;IAMhD;;;;;;OAMG;IACH,MAAM,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,IAAI,MAAM;IAKlF;;;;;;;OAOG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK;CAU/C;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAIrD"}

package/types/output/impl/utils/errors.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=errors.test.d.mts.map

package/types/output/impl/utils/errors.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.test.d.mts","sourceRoot":"","sources":["../../../../impl/utils/errors.test.mts"],"names":[],"mappings":""}

package/types/output/impl/utils/logger.d.mts

@@ -0,0 +1,11 @@
+import type { CouchConfigInput } from '../../schema/config.mts';
+type LoggerMethod = (...args: unknown[]) => void;
+export type Logger = {
+    error: LoggerMethod;
+    warn: LoggerMethod;
+    info: LoggerMethod;
+    debug: LoggerMethod;
+};
+export declare function createLogger(config: CouchConfigInput): Logger;
+export {};
+//# sourceMappingURL=logger.d.mts.map

package/types/output/impl/utils/logger.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.mts","sourceRoot":"","sources":["../../../../impl/utils/logger.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,KAAK,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;AAEhD,MAAM,MAAM,MAAM,GAAG;IACnB,KAAK,EAAE,YAAY,CAAA;IACnB,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE,YAAY,CAAA;CACpB,CAAA;AAoBD,wBAAgB,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAgC7D"}

package/types/output/impl/utils/logger.test.d.mts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=logger.test.d.mts.map

package/types/output/impl/utils/logger.test.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.test.d.mts","sourceRoot":"","sources":["../../../../impl/utils/logger.test.mts"],"names":[],"mappings":""}