@decaf-ts/for-pouch 0.2.7 → 0.2.9

package/lib/index.cjs

@@ -24,7 +24,7 @@ __exportStar(require("./types.cjs"), exports);
 __exportStar(require("./adapter.cjs"), exports);
 /**
  * @description A TypeScript adapter for PouchDB integration
- * @summary This module provides a repository pattern implementation for PouchDB, allowing for easy database operations with TypeScript type safety. It exports constants, repository classes, types, and adapters for working with PouchDB.
+ * @summary Provides a repository-pattern implementation backed by PouchDB, exposing the {@link PouchAdapter} to interface with databases, the {@link PouchRepository} for typed data access, configuration {@link module:for-pouch|constants} like {@link PouchFlavour} and {@link DefaultLocalStoragePath}, and related {@link module:for-pouch|types}. This module wires up decorators on load to support created/updated-by fields.
  * @module for-pouch
  */
 /**
@@ -33,5 +33,5 @@ __exportStar(require("./adapter.cjs"), exports);
  * @const VERSION
  * @memberOf module:for-pouch
  */
-exports.VERSION = "0.2.7";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSwyQ0FBeUM7QUFFekMsc0JBQVksQ0FBQyxVQUFVLEVBQUUsQ0FBQztBQUUxQixrREFBNEI7QUFDNUIsd0RBQWtDO0FBQ2xDLDhDQUF3QjtBQUN4Qiw2QkFBNkI7QUFDN0IsZ0RBQTBCO0FBRTFCOzs7O0dBSUc7QUFFSDs7Ozs7R0FLRztBQUNVLFFBQUEsT0FBTyxHQUFHLGFBQWEsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFBvdWNoQWRhcHRlciB9IGZyb20gXCIuL2FkYXB0ZXJcIjtcblxuUG91Y2hBZGFwdGVyLmRlY29yYXRpb24oKTtcblxuZXhwb3J0ICogZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9Qb3VjaFJlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG4vLyBsZWZ0IHRvIHRoZSBlbmQgb24gcHVycG9zZVxuZXhwb3J0ICogZnJvbSBcIi4vYWRhcHRlclwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBBIFR5cGVTY3JpcHQgYWRhcHRlciBmb3IgUG91Y2hEQiBpbnRlZ3JhdGlvblxuICogQHN1bW1hcnkgVGhpcyBtb2R1bGUgcHJvdmlkZXMgYSByZXBvc2l0b3J5IHBhdHRlcm4gaW1wbGVtZW50YXRpb24gZm9yIFBvdWNoREIsIGFsbG93aW5nIGZvciBlYXN5IGRhdGFiYXNlIG9wZXJhdGlvbnMgd2l0aCBUeXBlU2NyaXB0IHR5cGUgc2FmZXR5LiBJdCBleHBvcnRzIGNvbnN0YW50cywgcmVwb3NpdG9yeSBjbGFzc2VzLCB0eXBlcywgYW5kIGFkYXB0ZXJzIGZvciB3b3JraW5nIHdpdGggUG91Y2hEQi5cbiAqIEBtb2R1bGUgZm9yLXBvdWNoXG4gKi9cblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gUGFja2FnZSB2ZXJzaW9uIGlkZW50aWZpZXJcbiAqIEBzdW1tYXJ5IFN0b3JlcyB0aGUgY3VycmVudCB2ZXJzaW9uIG9mIHRoZSBmb3ItcG91Y2ggcGFja2FnZVxuICogQGNvbnN0IFZFUlNJT05cbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLXBvdWNoXG4gKi9cbmV4cG9ydCBjb25zdCBWRVJTSU9OID0gXCIjI1ZFUlNJT04jI1wiO1xuIl19
+exports.VERSION = "0.2.9";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSwyQ0FBeUM7QUFFekMsc0JBQVksQ0FBQyxVQUFVLEVBQUUsQ0FBQztBQUUxQixrREFBNEI7QUFDNUIsd0RBQWtDO0FBQ2xDLDhDQUF3QjtBQUN4Qiw2QkFBNkI7QUFDN0IsZ0RBQTBCO0FBRTFCOzs7O0dBSUc7QUFFSDs7Ozs7R0FLRztBQUNVLFFBQUEsT0FBTyxHQUFHLGFBQWEsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFBvdWNoQWRhcHRlciB9IGZyb20gXCIuL2FkYXB0ZXJcIjtcblxuUG91Y2hBZGFwdGVyLmRlY29yYXRpb24oKTtcblxuZXhwb3J0ICogZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9Qb3VjaFJlcG9zaXRvcnlcIjtcbmV4cG9ydCAqIGZyb20gXCIuL3R5cGVzXCI7XG4vLyBsZWZ0IHRvIHRoZSBlbmQgb24gcHVycG9zZVxuZXhwb3J0ICogZnJvbSBcIi4vYWRhcHRlclwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBBIFR5cGVTY3JpcHQgYWRhcHRlciBmb3IgUG91Y2hEQiBpbnRlZ3JhdGlvblxuICogQHN1bW1hcnkgUHJvdmlkZXMgYSByZXBvc2l0b3J5LXBhdHRlcm4gaW1wbGVtZW50YXRpb24gYmFja2VkIGJ5IFBvdWNoREIsIGV4cG9zaW5nIHRoZSB7QGxpbmsgUG91Y2hBZGFwdGVyfSB0byBpbnRlcmZhY2Ugd2l0aCBkYXRhYmFzZXMsIHRoZSB7QGxpbmsgUG91Y2hSZXBvc2l0b3J5fSBmb3IgdHlwZWQgZGF0YSBhY2Nlc3MsIGNvbmZpZ3VyYXRpb24ge0BsaW5rIG1vZHVsZTpmb3ItcG91Y2h8Y29uc3RhbnRzfSBsaWtlIHtAbGluayBQb3VjaEZsYXZvdXJ9IGFuZCB7QGxpbmsgRGVmYXVsdExvY2FsU3RvcmFnZVBhdGh9LCBhbmQgcmVsYXRlZCB7QGxpbmsgbW9kdWxlOmZvci1wb3VjaHx0eXBlc30uIFRoaXMgbW9kdWxlIHdpcmVzIHVwIGRlY29yYXRvcnMgb24gbG9hZCB0byBzdXBwb3J0IGNyZWF0ZWQvdXBkYXRlZC1ieSBmaWVsZHMuXG4gKiBAbW9kdWxlIGZvci1wb3VjaFxuICovXG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIFBhY2thZ2UgdmVyc2lvbiBpZGVudGlmaWVyXG4gKiBAc3VtbWFyeSBTdG9yZXMgdGhlIGN1cnJlbnQgdmVyc2lvbiBvZiB0aGUgZm9yLXBvdWNoIHBhY2thZ2VcbiAqIEBjb25zdCBWRVJTSU9OXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1wb3VjaFxuICovXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IFwiIyNWRVJTSU9OIyNcIjtcbiJdfQ==

package/lib/index.d.ts

@@ -4,7 +4,7 @@ export * from "./types";
 export * from "./adapter";
 /**
  * @description A TypeScript adapter for PouchDB integration
- * @summary This module provides a repository pattern implementation for PouchDB, allowing for easy database operations with TypeScript type safety. It exports constants, repository classes, types, and adapters for working with PouchDB.
+ * @summary Provides a repository-pattern implementation backed by PouchDB, exposing the {@link PouchAdapter} to interface with databases, the {@link PouchRepository} for typed data access, configuration {@link module:for-pouch|constants} like {@link PouchFlavour} and {@link DefaultLocalStoragePath}, and related {@link module:for-pouch|types}. This module wires up decorators on load to support created/updated-by fields.
  * @module for-pouch
  */
 /**
@@ -13,4 +13,4 @@ export * from "./adapter";
  * @const VERSION
  * @memberOf module:for-pouch
  */
-export declare const VERSION = "0.2.7";
+export declare const VERSION = "0.2.9";

package/lib/types.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBGbGFncyBzcGVjaWZpYyB0byBQb3VjaERCIHJlcG9zaXRvcnkgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgRXh0ZW5kcyB0aGUgYmFzZSByZXBvc2l0b3J5IGZsYWdzIHdpdGggUG91Y2hEQi1zcGVjaWZpYyBwcm9wZXJ0aWVzLlxuICogVGhlc2UgZmxhZ3MgYXJlIHVzZWQgdG8gcGFzcyBhZGRpdGlvbmFsIGluZm9ybWF0aW9uIGR1cmluZyByZXBvc2l0b3J5IG9wZXJhdGlvbnMuXG4gKiBAaW50ZXJmYWNlIFBvdWNoRmxhZ3NcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLXBvdWNoXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUG91Y2hGbGFncyBleHRlbmRzIFJlcG9zaXRvcnlGbGFncyB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gVW5pcXVlIGlkZW50aWZpZXIgZm9yIHRoZSBjdXJyZW50IHVzZXIgb3Igb3BlcmF0aW9uXG4gICAqL1xuICBVVUlEOiBzdHJpbmc7XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IFJlcG9zaXRvcnlGbGFncyB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBGbGFncyBzcGVjaWZpYyB0byBQb3VjaERCIHJlcG9zaXRvcnkgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgRXh0ZW5kcyB0aGUgYmFzZSByZXBvc2l0b3J5IGZsYWdzIHdpdGggUG91Y2hEQi1zcGVjaWZpYyBwcm9wZXJ0aWVzLlxuICogVGhlc2UgZmxhZ3MgYXJlIHVzZWQgdG8gcGFzcyBhZGRpdGlvbmFsIGluZm9ybWF0aW9uIGR1cmluZyByZXBvc2l0b3J5IG9wZXJhdGlvbnMuXG4gKiBAaW50ZXJmYWNlIFBvdWNoRmxhZ3NcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLXBvdWNoXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUG91Y2hGbGFncyBleHRlbmRzIFJlcG9zaXRvcnlGbGFncyB7XG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gVW5pcXVlIGlkZW50aWZpZXIgZm9yIHRoZSBjdXJyZW50IHVzZXIgb3Igb3BlcmF0aW9uXG4gICAqL1xuICBVVUlEOiBzdHJpbmc7XG59XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIENvbmZpZ3VyYXRpb24gb3B0aW9ucyBmb3IgaW5pdGlhbGl6aW5nIGEgUG91Y2hEQiBhZGFwdGVyXG4gKiBAc3VtbWFyeSBEZWZpbmVzIGNvbm5lY3Rpb24gY3JlZGVudGlhbHMsIGxvY2FsIHN0b3JhZ2Ugb3B0aW9ucywgZGF0YWJhc2UgbmFtZSwgYW5kIGEgbGlzdCBvZiBQb3VjaERCIHBsdWdpbnMgdG8gcmVnaXN0ZXIgYmVmb3JlIGNsaWVudCBjcmVhdGlvbi5cbiAqIEB0ZW1wbGF0ZVxuICogQHByb3BlcnR5IHtzdHJpbmd9IFt1c2VyXSAtIFVzZXJuYW1lIGZvciByZW1vdGUgSFRUUC9TIGNvbm5lY3Rpb25zXG4gKiBAcHJvcGVydHkge3N0cmluZ30gW3Bhc3N3b3JkXSAtIFBhc3N3b3JkIGZvciByZW1vdGUgSFRUUC9TIGNvbm5lY3Rpb25zXG4gKiBAcHJvcGVydHkge3N0cmluZ30gW2hvc3RdIC0gSG9zdCAoYW5kIG9wdGlvbmFsIHBvcnQpIG9mIHRoZSByZW1vdGUgQ291Y2hEQi1jb21wYXRpYmxlIHNlcnZlclxuICogQHByb3BlcnR5IHsoXCJodHRwXCJ8XCJodHRwc1wiKX0gW3Byb3RvY29sXSAtIE5ldHdvcmsgcHJvdG9jb2wgdG8gdXNlIHdoZW4gY29ubmVjdGluZyByZW1vdGVseVxuICogQHByb3BlcnR5IHtudW1iZXJ9IFtwb3J0XSAtIE9wdGlvbmFsIGV4cGxpY2l0IHBvcnQgbnVtYmVyOyBpZiBwcm92aWRlZCBtYXkgYmUgcGFydCBvZiBob3N0IGluc3RlYWRcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBkYk5hbWUgLSBEYXRhYmFzZSBuYW1lIHVzZWQgaW4gdGhlIFVSTCBvciBsb2NhbCBwYXRoXG4gKiBAcHJvcGVydHkge3N0cmluZ30gW3N0b3JhZ2VQYXRoXSAtIFJlbGF0aXZlIGJhc2UgcGF0aCBmb3IgbG9jYWwgZGF0YWJhc2VzOyBkZWZhdWx0cyB0byB7QGxpbmsgRGVmYXVsdExvY2FsU3RvcmFnZVBhdGh9XG4gKiBAcHJvcGVydHkge2FueVtdfSBwbHVnaW5zIC0gTGlzdCBvZiBQb3VjaERCIHBsdWdpbnMgKG1vZHVsZXMpIHRvIHJlZ2lzdGVyIHdpdGggdGhlIGNsaWVudFxuICogQHR5cGVEZWYgUG91Y2hDb25maWdcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Zm9yLXBvdWNoXG4gKi9cbmV4cG9ydCB0eXBlIFBvdWNoQ29uZmlnID0ge1xuICB1c2VyPzogc3RyaW5nO1xuICBwYXNzd29yZD86IHN0cmluZztcbiAgaG9zdD86IHN0cmluZztcbiAgcHJvdG9jb2w/OiBcImh0dHBcIiB8IFwiaHR0cHNcIjtcbiAgcG9ydD86IG51bWJlcjtcbiAgZGJOYW1lOiBzdHJpbmc7XG4gIHN0b3JhZ2VQYXRoPzogc3RyaW5nO1xuICBwbHVnaW5zOiBhbnlbXTtcbn07XG4iXX0=

package/lib/types.d.ts

@@ -12,3 +12,28 @@ export interface PouchFlags extends RepositoryFlags {
      */
     UUID: string;
 }
+/**
+ * @description Configuration options for initializing a PouchDB adapter
+ * @summary Defines connection credentials, local storage options, database name, and a list of PouchDB plugins to register before client creation.
+ * @template
+ * @property {string} [user] - Username for remote HTTP/S connections
+ * @property {string} [password] - Password for remote HTTP/S connections
+ * @property {string} [host] - Host (and optional port) of the remote CouchDB-compatible server
+ * @property {("http"|"https")} [protocol] - Network protocol to use when connecting remotely
+ * @property {number} [port] - Optional explicit port number; if provided may be part of host instead
+ * @property {string} dbName - Database name used in the URL or local path
+ * @property {string} [storagePath] - Relative base path for local databases; defaults to {@link DefaultLocalStoragePath}
+ * @property {any[]} plugins - List of PouchDB plugins (modules) to register with the client
+ * @typeDef PouchConfig
+ * @memberOf module:for-pouch
+ */
+export type PouchConfig = {
+    user?: string;
+    password?: string;
+    host?: string;
+    protocol?: "http" | "https";
+    port?: number;
+    dbName: string;
+    storagePath?: string;
+    plugins: any[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/for-pouch",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "decaf-ts persistence adapter for PouchDB",
   "type": "module",
   "exports": {
@@ -29,6 +29,7 @@
     "coverage": "rimraf ./workdocs/reports/data/*.json && npm run test:all -- --coverage --config=./workdocs/reports/jest.coverage.config.ts",
     "lint": "eslint .",
     "lint-fix": "eslint --fix .",
+    "prepare-pr": "npm run lint-fix && npm run build:prod && npm run coverage && npm run docs",
     "prepare-release": "npm run lint-fix && npm run build:prod && npm run coverage && npm run docs",
     "release": "./bin/tag-release.sh",
     "clean-publish": "npx clean-publish",
@@ -125,7 +126,9 @@
     "@decaf-ts/decorator-validation": "latest",
     "@decaf-ts/for-couchdb": "latest",
     "@decaf-ts/injectable-decorators": "latest",
+    "@decaf-ts/logging": "latest",
     "@decaf-ts/reflection": "latest",
+    "@decaf-ts/transactional-decorators": "latest",
     "pouchdb-core": "^9.0.0",
     "pouchdb-find": "^9.0.0"
   }