couchdb-web-node-plugin 1.0.518 → 1.0.521

package/type.d.ts

@@ -0,0 +1,394 @@
+/// <reference types="pouchdb-core" />
+/// <reference types="pouchdb-find" />
+/// <reference types="pouchdb-mapreduce" />
+/// <reference types="pouchdb-replication" />
+/// <reference types="pouchdb-adapter-cordova-sqlite" />
+/// <reference types="pouchdb-adapter-fruitdown" />
+/// <reference types="pouchdb-adapter-http" />
+/// <reference types="pouchdb-adapter-idb" />
+/// <reference types="pouchdb-adapter-leveldb" />
+/// <reference types="pouchdb-adapter-localstorage" />
+/// <reference types="pouchdb-adapter-memory" />
+/// <reference types="pouchdb-adapter-websql" />
+/// <reference types="node" />
+import { ChildProcess } from 'child_process';
+import Tools from 'clientnode';
+import { AnyFunction, Mapping, PlainObject, Primitive, ProcessCloseReason } from 'clientnode/type';
+import { PluginAPI } from 'web-node';
+import { Configuration as BaseConfiguration, Plugin, PluginHandler as BasePluginHandler, Service as BaseService, ServicePromises as BaseServicePromises, Services as BaseServices } from 'web-node/type';
+import DatabaseHelper from './databaseHelper';
+export declare type Attachments = PouchDB.Core.Attachments;
+export declare type FullAttachment = PouchDB.Core.FullAttachment;
+export declare type StubAttachment = PouchDB.Core.StubAttachment;
+export declare type ChangesMeta = PouchDB.Core.ChangesMeta;
+export declare type ChangesResponseChange<Type = unknown> = PouchDB.Core.ChangesResponseChange<Type>;
+export declare type ChangesStream<Type = unknown> = PouchDB.Core.Changes<Type>;
+export declare type ChangesStreamOptions = PouchDB.Core.ChangesOptions;
+export declare type Connection = PouchDB.Database;
+export declare type Connector = PouchDB.Static;
+export declare type DatabaseConnectorConfiguration = PouchDB.Configuration.RemoteDatabaseConfiguration;
+export declare type DatabaseError = PouchDB.Core.Error;
+export declare type DatabaseFetch = PouchDB.Core.Options['fetch'];
+export declare type DatabaseResponse = PouchDB.Core.Response;
+export declare type DeleteIndexOptions = PouchDB.Find.DeleteIndexOptions;
+export declare type Document<Type = PlainObject> = PouchDB.Core.Document<Type>;
+export declare type ExistingDocument<Type = PlainObject> = PouchDB.Core.ExistingDocument<Type>;
+export declare type DocumentGetMeta = PouchDB.Core.GetMeta;
+export declare type DocumentIDMeta = PouchDB.Core.IdMeta;
+export declare type DocumentRevisionIDMeta = PouchDB.Core.RevisionIdMeta;
+export declare type Index = PouchDB.Find.Index;
+export declare type DatabasePlugin = AnyFunction;
+export declare type AllowedRoles = (Array<string> | string | {
+    read?: Array<string> | string;
+    write?: Array<string> | string;
+});
+export interface NormalizedAllowedRoles {
+    read: Array<string>;
+    write: Array<string>;
+}
+export interface NormalizedAllowedModelRoles extends NormalizedAllowedRoles {
+    properties: Mapping<NormalizedAllowedRoles>;
+}
+export declare type AllowedModelRolesMapping = Mapping<NormalizedAllowedModelRoles>;
+export interface Constraint {
+    description?: null | string;
+    evaluation: string;
+}
+export declare type Type = string | 'any' | 'boolean' | 'integer' | 'number' | 'string' | 'DateTime';
+export declare type TypeSpecification = Array<Type> | Type;
+export declare type ConstraintKey = 'arrayConstraintExecution' | 'arrayConstraintExpression' | 'conflictingConstraintExecution' | 'conflictingConstraintExpression' | 'constraintExecution' | 'constraintExpression';
+export interface SelectionMapping {
+    label: string;
+    value: unknown;
+}
+export interface PropertySpecification {
+    allowedRoles?: AllowedRoles | null;
+    arrayConstraintExecution?: Constraint | null;
+    arrayConstraintExpression?: Constraint | null;
+    conflictingConstraintExecution?: Constraint | null;
+    conflictingConstraintExpression?: Constraint | null;
+    constraintExecution?: Constraint | null;
+    constraintExpression?: Constraint | null;
+    contentTypeRegularExpressionPattern?: null | string;
+    default?: unknown;
+    emptyEqualsToNull?: boolean | null;
+    index?: boolean | null;
+    invertedContentTypeRegularExpressionPattern?: null | string;
+    invertedRegularExpressionPattern?: null | string;
+    maximum?: null | number;
+    maximumAggregatedSize?: null | number;
+    maximumLength?: null | number;
+    maximumNumber?: null | number;
+    maximumSize?: null | number;
+    minimum?: null | number;
+    minimumAggregatedSize?: null | number;
+    minimumLength?: null | number;
+    minimumNumber?: null | number;
+    minimumSize?: null | number;
+    mutable?: boolean | null;
+    nullable?: boolean | null;
+    onCreateExecution?: null | string;
+    onCreateExpression?: null | string;
+    oldName?: Array<string> | null | string;
+    onUpdateExecution?: null | string;
+    onUpdateExpression?: null | string;
+    regularExpressionPattern?: null | string;
+    selection?: Array<unknown> | Array<SelectionMapping> | Mapping<unknown> | null;
+    trim?: boolean | null;
+    type?: TypeSpecification | null;
+    value?: unknown;
+    writable?: boolean | null;
+}
+export interface FileSpecification extends PropertySpecification {
+    fileName?: PropertySpecification;
+}
+export interface BaseModel {
+    _allowedRoles?: AllowedRoles | null;
+    _attachments?: Mapping<FileSpecification> | null;
+    _constraintExecutions?: Array<Constraint> | Constraint | null;
+    _constraintExpressions?: Array<Constraint> | Constraint | null;
+    _createExecution?: null | string;
+    _createExpression?: null | string;
+    _extends?: Array<string> | null | string;
+    _maximumAggregatedSize?: null | number;
+    _minimumAggregatedSize?: null | number;
+    _oldType?: Array<string> | null | string;
+    _onUpdateExecution?: null | string;
+    _onUpdateExpression?: null | string;
+}
+export declare type Model = BaseModel & Mapping<PropertySpecification>;
+export declare type Models = Mapping<Model>;
+export declare const PrimitiveTypes: readonly ["boolean", "DateTime", "integer", "number", "string"];
+export declare type UpdateStrategy = '' | 'fillUp' | 'incremental' | 'migrate';
+export declare type DocumentContent = Array<DocumentContent> | PlainObject<Primitive> | Primitive;
+export declare type DocumentStrategyMeta = {
+    _updateStrategy?: UpdateStrategy;
+};
+export declare type DocumentTypeMeta = {
+    '-type': string;
+};
+export declare type BaseDocument = ChangesMeta & DocumentGetMeta & DocumentIDMeta & DocumentRevisionIDMeta & DocumentStrategyMeta & DocumentTypeMeta;
+export declare type FullDocument = BaseDocument & PlainObject;
+export declare type PartialFullDocument = Partial<BaseDocument> & PlainObject;
+export interface SpecialPropertyNames {
+    additional: '_additional';
+    allowedRoles: '_allowedRoles';
+    attachment: '_attachments';
+    conflict: '_conflicts';
+    deleted: '_deleted';
+    deletedConflict: '_deleted_conflict';
+    extend: '_extends';
+    id: '_id';
+    revision: '_rev';
+    revisions: '_revisions';
+    revisionsInformation: '_revs_info';
+    strategy: '_updateStrategy';
+    type: keyof DocumentTypeMeta;
+    constraint: {
+        execution: string;
+        expression: string;
+    };
+    create: {
+        execution: string;
+        expression: string;
+    };
+    designDocumentNamePrefix: string;
+    localSequence: string;
+    maximumAggregatedSize: string;
+    minimumAggregatedSize: string;
+    oldType: string;
+    update: {
+        execution: string;
+        expression: string;
+    };
+}
+export interface PropertyNameConfiguration {
+    reserved: Array<string>;
+    special: SpecialPropertyNames;
+    typeRegularExpressionPattern: {
+        private: string;
+        public: string;
+    };
+    validatedDocumentsCache: string;
+}
+export interface BaseModelConfiguration {
+    dateTimeFormat: 'iso' | 'iso8601' | 'number';
+    property: {
+        defaultSpecification: PropertySpecification;
+        name: PropertyNameConfiguration;
+    };
+    updateStrategy: UpdateStrategy;
+}
+export interface ModelConfiguration extends BaseModelConfiguration {
+    autoMigrationPath: string;
+    entities: Models;
+    triggerInitialCompaction: boolean;
+    updateConfiguration: boolean;
+    updateValidation: boolean;
+}
+export interface UserContext {
+    db: string;
+    name?: string;
+    roles: Array<string>;
+}
+export interface DatabaseUserConfiguration {
+    names: Array<string>;
+    roles: Array<string>;
+}
+export interface Runner {
+    adminUserConfigurationPath: string;
+    arguments?: Array<string> | null | string;
+    binaryFilePath?: null | string;
+    configurationFile?: null | {
+        content: string;
+        path: string;
+    };
+    environment?: null | Mapping;
+    location: Array<string> | string;
+    name: Array<string> | string;
+}
+export interface SecuritySettings {
+    admins: DatabaseUserConfiguration;
+    members: DatabaseUserConfiguration;
+    _validatedDocuments?: Set<string>;
+}
+export declare type ConnectorConfiguration = DatabaseConnectorConfiguration & {
+    fetch?: (RequestInit & {
+        timeout: number;
+    }) | null;
+};
+export declare type Configuration<ConfigurationType = Mapping<unknown>> = BaseConfiguration<{
+    couchdb: {
+        attachAutoRestarter: boolean;
+        backend: {
+            configuration: PlainObject;
+            prefixes: Array<string>;
+        };
+        binary: {
+            memoryInMegaByte: string;
+            nodePath: string;
+            runner: Array<Runner>;
+        };
+        changesStream: ChangesStreamOptions;
+        connector: ConnectorConfiguration;
+        createGenericFlatIndex: boolean;
+        databaseName: string;
+        debug: boolean;
+        ensureAdminPresence: boolean;
+        ensureSecuritySettingsPresence: boolean;
+        ensureUserPresence: boolean;
+        ignoreNoChangeError: boolean;
+        local: boolean;
+        maximumRepresentationLength: number;
+        maximumRepresentationTryLength: number;
+        model: ModelConfiguration;
+        path: string;
+        security: SecuritySettings;
+        url: string;
+        user: {
+            name: string;
+            password: string;
+        };
+    };
+}> & ConfigurationType;
+export interface Service extends BaseService {
+    name: 'couchdb';
+    promise: null | Promise<ProcessCloseReason>;
+}
+export declare type ServicePromises<ServicePromiseType = Mapping<unknown>> = BaseServicePromises<{
+    couchdb: Promise<ProcessCloseReason>;
+}> & ServicePromiseType;
+export declare type Services<ServiceType = Mapping<unknown>> = BaseServices<{
+    couchdb: {
+        connection: Connection;
+        connector: Connector;
+        server: {
+            process: ChildProcess;
+            reject: (_value: ProcessCloseReason) => void;
+            resolve: (_reason: ProcessCloseReason) => void;
+            restart: (_services: Services, _configuration: Configuration, _plugins: Array<Plugin>, _pluginAPI: typeof PluginAPI) => Promise<void>;
+            runner: Runner;
+            start: (_services: Services, _configuration: Configuration) => Promise<void>;
+            stop: (_services: Services, _configuration: Configuration) => Promise<void>;
+        };
+    };
+}> & ServiceType;
+export interface PluginHandler extends BasePluginHandler {
+    /**
+     * Hook after each data change.
+     * @param _changesStream - Stream of database changes.
+     * @param _services - List of other web-node plugin services.
+     * @param _configuration - Configuration object extended by each plugin
+     * specific configuration.
+     * @param _plugins - Topological sorted list of plugins.
+     * @param _pluginAPI - Plugin api reference.
+     *
+     * @returns Given entry files.
+     */
+    couchdbInitializeChangesStream?(_changesStream: ChangesStream, _services: Services, _configuration: Configuration, _plugins: Array<Plugin>, _pluginAPI: typeof PluginAPI): ChangesStream;
+    /**
+     * Hook after each data base restart.
+     * @param _services - List of other web-node plugin services.
+     * @param _configuration - Configuration object extended by each plugin
+     * specific configuration.
+     * @param _plugins - Topological sorted list of plugins.
+     * @param _pluginAPI - Plugin api reference.
+     *
+     * @returns Given entry files.
+     */
+    restartCouchdb?(_services: Services, _configuration: Configuration, _plugins: Array<Plugin>, _pluginAPI: typeof PluginAPI): Services;
+}
+export interface EmptyEvaluationExceptionData {
+    empty: string;
+}
+export declare type EmptyEvaluationException = Exception<EmptyEvaluationExceptionData>;
+export interface EvaluationExceptionData<S = Mapping<unknown>> {
+    code: string;
+    error: Error;
+    scope: S;
+}
+export interface CompilationExceptionData<S = Mapping<unknown>> extends EvaluationExceptionData<S> {
+    compilation: string;
+}
+export interface RuntimeExceptionData<S = Mapping<unknown>> extends EvaluationExceptionData<S> {
+    runtime: string;
+}
+export declare type EvaluationException<S = Mapping<unknown>> = Exception<EvaluationExceptionData<S>>;
+export interface BasicScope {
+    attachmentWithPrefixExists: (_namePrefix: string) => boolean;
+    checkDocument: (_newDocument: PartialFullDocument, _oldDocument: PartialFullDocument | null, _parentNames: Array<string>) => CheckedDocumentResult;
+    getFileNameByPrefix: (_prefix?: string, _attachments?: Attachments) => null | string;
+    serialize: (_value: unknown) => string;
+    id: string;
+    revision: string;
+    idName: string;
+    revisionName: string;
+    specialNames: SpecialPropertyNames;
+    typeName: string;
+    modelConfiguration: BaseModelConfiguration;
+    models: Models;
+    now: Date;
+    nowUTCTimestamp: number;
+    securitySettings: Partial<SecuritySettings>;
+    userContext: Partial<UserContext>;
+}
+export interface CommonScope {
+    checkPropertyContent: (_newValue: unknown, _name: string, _propertySpecification: PropertySpecification, _oldValue: unknown) => CheckedPropertyResult;
+    model: Model;
+    modelName: string;
+    type: string;
+    newDocument: Attachments | PartialFullDocument;
+    oldDocument: Attachments | null | PartialFullDocument;
+    parentNames: Array<string>;
+    pathDescription: string;
+}
+export interface PropertyScope extends CommonScope {
+    name: string;
+    newValue: unknown;
+    oldValue: unknown;
+    propertySpecification: PropertySpecification;
+}
+export interface EvaluationResult<T = unknown, S = BasicScope & CommonScope> {
+    code: string;
+    result: T;
+    scope: S;
+}
+export declare type Evaluate<R = unknown, P = unknown> = (..._parameters: Array<P>) => R;
+export interface CheckedResult {
+    changedPath: Array<string>;
+}
+export interface CheckedPropertyResult extends CheckedResult {
+    newValue: unknown;
+}
+export interface CheckedDocumentResult extends CheckedResult {
+    newDocument: PartialFullDocument;
+}
+export declare type Exception<DataType = Mapping<unknown>> = {
+    message: string;
+    name: string;
+} & DataType;
+export declare type Migrator = (document: Document, scope: {
+    configuration: Configuration;
+    databaseHelper: DatabaseHelper;
+    tools: typeof Tools;
+    idName: string;
+    typeName: string;
+    migrater: Mapping<Migrator>;
+    models: Models;
+    modelConfiguration: ModelConfiguration;
+    selfFilePath: string;
+    services: Services;
+}) => Document | null;
+export declare type DateRepresentationType = Date | null | number | string;
+export declare type User = BaseDocument & {
+    password: string;
+    roles: Array<string>;
+};
+export interface Interval {
+    end: number;
+    start: number;
+}
+export interface Location {
+    latitude: number;
+    longitude: number;
+}