couchdb-web-node-plugin 1.0.799 → 1.0.800

package/helper.d.ts

@@ -1,7 +1,16 @@
 import { Logger, Mapping, ValueOf } from 'clientnode';
-import { AllowedModelRolesMapping, AllowedRoles, Configuration, Connection, ConnectorConfiguration, CoreConfiguration, DatabaseConnectorConfiguration, DatabasePlugin, Model, ModelConfiguration, Models, NormalizedAllowedRoles, PropertySpecification, Services, SpecialPropertyNames } from './type';
+import { Express } from 'express-serve-static-core';
+import { AllowedModelRolesMapping, AllowedRoles, Configuration, Connection, Connector, ConnectorConfiguration, CoreConfiguration, DatabaseConnectorConfiguration, Model, ModelConfiguration, Models, NormalizedAllowedRoles, PropertySpecification, State, Services, SpecialPropertyNames } from './type';
 export declare const TOGGLE_LATEST_REVISION_DETERMINING: unique symbol;
 export declare const log: Logger;
+/**
+ * Determines plugin to hook into any write operations.
+ * @param configuration - This's plugin configuration object.
+ * @returns A pouchdb plugin in object style.
+ */
+export declare const getPouchDBPlugin: (configuration: CoreConfiguration) => {
+    installCouchDBWebNodePlugin: (this: Connection, description: string) => void;
+};
 export declare const removeDeprecatedIndexes: (connection: Connection<object>, models: Models, modelConfiguration: ModelConfiguration) => Promise<void>;
 /**
  * Converts internal declarative database connector configuration object
@@ -39,21 +48,51 @@ export declare const mayStripRepresentation: (object: unknown, maximumRepresenta
  * successfully.
  */
 export declare const ensureValidationDocumentPresence: (databaseConnection: Connection, documentName: string, documentData: Mapping, description: string, doLogging?: boolean, idName?: SpecialPropertyNames["id"], revisionName?: SpecialPropertyNames["revision"], designDocumentNamePrefix?: string) => Promise<void>;
-/**
- * Generates function to apply "latest/upsert" and ignore "NoChange" error
- * plugin for couchdb "bulkDocs" operations.
- * @param nativeBulkDocs - Original bulkDocs function to wrap.
- * @param configuration - Couchdb configuration object.
- * @returns Whatever bulkDocs returns.
- */
-export declare const bulkDocsFactory: (nativeBulkDocs: Connection["bulkDocs"], configuration: CoreConfiguration) => DatabasePlugin;
 /**
  * Initializes a database connection instance.
  * @param services - An object with stored service instances.
  * @param configuration - Mutable by plugins extended configuration object.
+ * @param createRemoteDatabaseIfNotExists - Indicates whether database should
+ * be created if it does not exist yet. This is only relevant for remote
+ * databases, because local ones get created automatically by pouchdb.
  * @returns Given and extended object of services.
  */
-export declare const initializeConnection: (services: Services, configuration: Configuration) => Promise<Services>;
+export declare const initializeConnection: (services: Services, configuration: Configuration, createRemoteDatabaseIfNotExists?: boolean) => Promise<Services>;
+/**
+ * Determines the effective database URL to connect to based on given
+ * configuration.
+ * @param configuration - Couchdb configuration object.
+ * @param withDatabase - Indicates whether the URL should contain the database
+ * name or not.
+ * @param withCredentials - Indicates whether the URL should contain the
+ * credentials or not.
+ * @returns The effective URL.
+ */
+export declare const getEffectiveURL: (configuration: CoreConfiguration, withDatabase?: boolean, withCredentials?: boolean) => string;
+/**
+ * Initializes an express instance connected with pouchdb.
+ * @param name - Instance name.
+ * @param state - Application state.
+ * @param connector - Database connector instance.
+ * @param configuration - Couchdb configuration object.
+ * @param pluginAPI - Plugin API to call plugin hooks.
+ * @param expressUtilities - Optional express related utilities.
+ * @returns A promise resolving to the wrapping express instance and pouchdb's
+ * express instance.
+ */
+export declare const initializeExpress: (name: string, state: State, connector: Connector, configuration: CoreConfiguration, pluginAPI: State["pluginAPI"], expressUtilities?: (typeof import("./loadExpress"))["default"]) => Promise<{
+    expressInstance: Express;
+    expressPouchDBInstance: Express;
+}>;
+/**
+ * Waits for given promise to be resolved or given timeout has been exceeded.
+ * @param promise - Promise to wait for.
+ * @param timeoutInSeconds - Timeout in seconds.
+ * @param description - Used to produce semantic logging messages.
+ * @returns A promise which will be resolved after given promise is resolved or
+ * given timeout has been exceeded.
+ */
+export declare const waitWithTimeout: (promise: Promise<unknown>, timeoutInSeconds: number, description: string) => Promise<void>;
 /**
  * Determines a mapping of all models to roles who are allowed to edit
  * corresponding model instances.