couchdb-web-node-plugin 1.0.747 → 1.0.749

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "couchdb-web-node-plugin",
-  "version": "1.0.747",
+  "version": "1.0.749",
   "description": "A couchdb server, model instance conflict handler, rest api, authentication, session management, schema validator and model relation guarantee for webNode.",
   "keywords": [
     "api",

package/type.d.ts

@@ -1,8 +1,8 @@
 import { ChildProcess } from 'child_process';
 import { AnyFunction, Mapping, PlainObject, Primitive, ProcessCloseReason, UTILITY_SCOPE } from 'clientnode';
-import { Configuration as BaseConfiguration, PluginHandler as BasePluginHandler, ServicePromises as BaseServicePromises, Services as BaseServices, ServicePromisesState as BaseServicePromisesState, ServicesState as BaseServicesState } from 'web-node/type';
-import { Server as HTTPServer } from 'http';
 import { Express } from 'express-serve-static-core';
+import { IncomingMessage as IncomingHTTPMessage, Server as HTTPServer, ServerResponse as HTTP1ServerResponse } from 'http';
+import { Configuration as BaseConfiguration, PluginHandler as BasePluginHandler, ServicePromises as BaseServicePromises, Services as BaseServices, ServicePromisesState as BaseServicePromisesState, ServicesState as BaseServicesState } from 'web-node/type';
 export type Attachment = PouchDB.Core.Attachment & {
     content_type?: PouchDB.Core.Attachment['content_type'];
     contentType?: PouchDB.Core.Attachment['content_type'];
@@ -33,6 +33,7 @@ export type DocumentGetMeta = PouchDB.Core.GetMeta;
 export type DocumentIDMeta = PouchDB.Core.IdMeta;
 export type DocumentRevisionIDMeta = PouchDB.Core.RevisionIdMeta;
 export type FindRequest<Type extends object> = PouchDB.Find.FindRequest<Type>;
+export type FindResponse<Type extends object> = PouchDB.Find.FindResponse<Type>;
 export type DeleteIndexOptions = PouchDB.Find.DeleteIndexOptions;
 export type GetOptions = PouchDB.Core.GetOptions;
 export type PutOptions = PouchDB.Core.Options;
@@ -318,13 +319,13 @@ export interface CouchDB<Type extends object = Mapping<unknown>> {
     connection: Connection<Type>;
     connector: Connector;
     server: {
-        express?: Express;
-        expressPouchDB?: Express;
+        expressInstance?: Express;
+        expressPouchDBInstance?: Express;
         process?: ChildProcess | HTTPServer;
         reject: (value: Error | ProcessCloseReason) => void;
         resolve: (reason?: ProcessCloseReason) => void;
         restart: (state: State) => Promise<void>;
-        start: (services: Services, configuration: Configuration) => Promise<void>;
+        start: (state: State) => Promise<void>;
         stop: (services: Services, configuration: Configuration) => Promise<void>;
         runner: BinaryRunner | InPlaceRunner;
     };
@@ -361,6 +362,29 @@ export interface PluginHandler extends BasePluginHandler {
      * @returns Promise resolving to nothing.
      */
     restartCouchdb?(state: State): Promise<void>;
+    /**
+     * Hook before registering pouchdb routes into the express server
+     * instance.
+     * @param state - Application state.
+     * @returns Promise resolving to find result.
+     */
+    onPouchDBFind?(state: State<{
+        request: IncomingHTTPMessage & {
+            body: FindRequest<PlainObject>;
+        };
+        response: HTTP1ServerResponse;
+        result: FindResponse<object>;
+    }>): Promise<FindResponse<object> | undefined>;
+    /**
+     * Hook before registering pouchdb routes into the express server
+     * instance.
+     * @param state - Application state.
+     * @returns Promise resolving to nothing.
+     */
+    initializeExpressPouchDB?(state: State<{
+        expressInstance: Express;
+        expressPouchDBInstance: Express;
+    }>): Promise<void>;
 }
 export interface EmptyEvaluationErrorData {
     empty: string;