couchdb-web-node-plugin 1.0.823 → 2.0.824

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "couchdb-web-node-plugin",
-  "version": "1.0.823",
+  "version": "2.0.824",
   "description": "A couchdb server, model instance conflict handler, rest api, authentication, session management, schema validator and model relation guarantee for webNode.",
   "keywords": [
     "api",
@@ -96,7 +96,7 @@
     "rimraf": "^6.1.3",
     "typescript-eslint": "^8.56.1",
     "web-node": "^1.0.571",
-    "weboptimizer": "^2.0.1650"
+    "weboptimizer": "^2.0.1651"
   },
   "peerDependencies": {
     "@babel/runtime": "*",
@@ -420,7 +420,7 @@
           }
         },
         "property": {
-          "defaultSpecification": {
+          "defaultDefinition": {
             "emptyEqualsNull": true,
             "maximumAggregatedSize": 100000000,
             "minimumAggregatedSize": 0,

package/type.d.ts

@@ -74,7 +74,7 @@ export interface Constraint {
 export declare const PrimitiveTypes: readonly ["boolean", "DateTime", "integer", "number", "string"];
 export type PrimitiveType = typeof PrimitiveTypes[number];
 export type Type = boolean | number | string | Model;
-export type TypeSpecification = Array<Type> | Array<Array<Type>> | Type;
+export type TypeDefinition = Array<Type> | Array<Array<Type>> | Type;
 export type ConstraintKey = 'arrayConstraintExecution' | 'arrayConstraintExpression' | 'conflictingConstraintExecution' | 'conflictingConstraintExpression' | 'constraintExecution' | 'constraintExpression';
 export interface SelectionOption {
     label: string;
@@ -83,7 +83,7 @@ export interface SelectionOption {
 export type NormalizedSelection = Array<SelectionOption>;
 export type Selection = Array<SelectionOption> | Array<Primitive> | Mapping;
 export type Pattern = Array<RegExp | string> | RegExp | string;
-export interface BasePropertySpecification<Type, AdditionalSpecifications extends object> {
+export interface BasePropertyDefinition<Type, AdditionalDefinition extends object> {
     roles?: Roles;
     updateStrategy?: UpdateStrategy;
     preventVersionCreation?: boolean;
@@ -116,7 +116,7 @@ export interface BasePropertySpecification<Type, AdditionalSpecifications extend
     nullable?: boolean;
     writable?: boolean;
     selection?: Selection;
-    type?: TypeSpecification;
+    type?: TypeDefinition;
     emptyEqualsNull?: boolean;
     trim?: boolean;
     name?: string;
@@ -125,19 +125,19 @@ export interface BasePropertySpecification<Type, AdditionalSpecifications extend
     index?: boolean;
     oldName?: Array<string> | string;
     value?: Type;
-    additionalSpecifications?: AdditionalSpecifications;
+    additionalDefinition?: AdditionalDefinition;
 }
-export interface PropertySpecification<Type = unknown, AdditionalSpecifications extends object = object> extends BasePropertySpecification<Type, AdditionalSpecifications> {
+export interface PropertyDefinition<Type = unknown, AdditionalDefinition extends object = object> extends BasePropertyDefinition<Type, AdditionalDefinition> {
     default?: Type;
 }
-export interface FileSpecification<Type extends Attachment = Attachment, AdditionalSpecifications extends object = object> extends BasePropertySpecification<Type, AdditionalSpecifications> {
+export interface FileDefinition<Type extends Attachment = Attachment, AdditionalDefinition extends object = object> extends BasePropertyDefinition<Type, AdditionalDefinition> {
     default?: Mapping<Type>;
-    fileName?: PropertySpecification<string, AdditionalSpecifications>;
+    fileName?: PropertyDefinition<string, AdditionalDefinition>;
 }
-export interface BaseModel<AttachmentType extends Attachment = Attachment, AdditionalSpecifications extends object = object, AdditionalPropertiesType = unknown> {
-    _additional?: PropertySpecification<AdditionalPropertiesType, AdditionalSpecifications>;
+export interface BaseModel<AttachmentType extends Attachment = Attachment, AdditionalDefinition extends object = object, AdditionalPropertiesType = unknown> {
+    _additional?: PropertyDefinition<AdditionalPropertiesType, AdditionalDefinition>;
     _roles?: Roles;
-    _attachments?: Mapping<FileSpecification<AttachmentType, AdditionalSpecifications>> | null;
+    _attachments?: Mapping<FileDefinition<AttachmentType, AdditionalDefinition>> | null;
     _constraintExecutions?: Array<Constraint> | Constraint;
     _constraintExpressions?: Array<Constraint> | Constraint;
     _createExecution?: string;
@@ -149,14 +149,14 @@ export interface BaseModel<AttachmentType extends Attachment = Attachment, Addit
     _type?: Array<string> | string;
     _updateExecution?: string;
     _updateExpression?: string;
-    _id?: PropertySpecification<string, AdditionalSpecifications>;
-    _rev?: PropertySpecification<string, AdditionalSpecifications>;
+    _id?: PropertyDefinition<string, AdditionalDefinition>;
+    _rev?: PropertyDefinition<string, AdditionalDefinition>;
     _updateStrategy?: UpdateStrategy;
 }
-export type Model<Type extends object | undefined = object, AttachmentType extends Attachment = Attachment, AdditionalSpecifications extends object = object, AdditionalPropertiesType = unknown> = BaseModel<AttachmentType, AdditionalSpecifications, AdditionalPropertiesType> & {
-    [Property in keyof Type]: PropertySpecification<Type[Property] extends Array<unknown> ? (Type[Property][number] extends object | undefined ? Array<Model<Type[Property][number], AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>> : Type[Property]) : Type[Property] extends object | undefined ? (Type[Property] extends Date | undefined ? Type[Property] : Model<Type[Property], AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>) : Type[Property], AdditionalSpecifications>;
+export type Model<Type extends object | undefined = object, AttachmentType extends Attachment = Attachment, AdditionalDefinition extends object = object, AdditionalPropertiesType = unknown> = BaseModel<AttachmentType, AdditionalDefinition, AdditionalPropertiesType> & {
+    [Property in keyof Type]: PropertyDefinition<Type[Property] extends Array<unknown> ? (Type[Property][number] extends object | undefined ? Array<Model<Type[Property][number], AttachmentType, AdditionalDefinition, AdditionalPropertiesType>> : Type[Property]) : Type[Property] extends object | undefined ? (Type[Property] extends Date | undefined ? Type[Property] : Model<Type[Property], AttachmentType, AdditionalDefinition, AdditionalPropertiesType>) : Type[Property], AdditionalDefinition>;
 };
-export type Models<Type extends object = object, AttachmentType extends Attachment = Attachment, AdditionalSpecifications extends object = object, AdditionalPropertiesType = unknown> = Mapping<Model<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>>;
+export type Models<Type extends object = object, AttachmentType extends Attachment = Attachment, AdditionalDefinition extends object = object, AdditionalPropertiesType = unknown> = Mapping<Model<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>>;
 export type UpdateStrategy = 'fillUp' | 'incremental' | 'migrate' | 'replace';
 export type DocumentContent = Array<DocumentContent> | PlainObject | Primitive;
 export interface DocumentStrategyMeta {
@@ -211,17 +211,17 @@ export interface PropertyNameConfiguration {
     };
     validatedDocumentsCache: string;
 }
-export interface BaseModelConfiguration<Type, AdditionalSpecifications extends object> {
+export interface BaseModelConfiguration<Type, AdditionalDefinition extends object> {
     dateTimeFormat: 'iso' | 'iso8601' | 'number';
     property: {
-        defaultSpecification: PropertySpecification<Type, AdditionalSpecifications>;
+        defaultDefinition: PropertyDefinition<Type, AdditionalDefinition>;
         name: PropertyNameConfiguration;
     };
     updateStrategy: UpdateStrategy;
 }
-export interface ModelConfiguration<Type extends object = object, AttachmentType extends Attachment = Attachment, AdditionalSpecifications extends object = object, AdditionalPropertiesType = unknown> extends BaseModelConfiguration<Type, AdditionalSpecifications> {
+export interface ModelConfiguration<Type extends object = object, AttachmentType extends Attachment = Attachment, AdditionalDefinition extends object = object, AdditionalPropertiesType = unknown> extends BaseModelConfiguration<Type, AdditionalDefinition> {
     autoMigrationPath: string;
-    entities: Models<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>;
+    entities: Models<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>;
     triggerInitialCompaction: boolean;
     updateConfiguration: boolean;
     updateValidation: boolean;
@@ -274,7 +274,7 @@ export type ConnectorConfiguration = DatabaseConnectorConfiguration & {
         maximumRetryIntervallInSeconds: number;
     };
 };
-export interface CoreConfiguration<Type extends object = Mapping<unknown>, AttachmentType extends Attachment = Attachment, AdditionalSpecifications extends object = object, AdditionalPropertiesType = unknown> {
+export interface CoreConfiguration<Type extends object = Mapping<unknown>, AttachmentType extends Attachment = Attachment, AdditionalDefinition extends object = object, AdditionalPropertiesType = unknown> {
     attachAutoRestarter: boolean;
     closeTimeoutInSeconds: number;
     runner: {
@@ -309,7 +309,7 @@ export interface CoreConfiguration<Type extends object = Mapping<unknown>, Attac
     maximumNumberOfEntitiesInBulkOperation: number;
     maximumRepresentationLength: number;
     maximumRepresentationTryLength: number;
-    model: ModelConfiguration<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>;
+    model: ModelConfiguration<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>;
     path: string;
     skipLatestRevisionDetermining: boolean;
     url: string;
@@ -422,9 +422,9 @@ export interface CompilationErrorData<S = Mapping<unknown>> extends EvaluationEr
 export interface RuntimeErrorData<S = Mapping<unknown>> extends EvaluationErrorData<S> {
     runtime: string;
 }
-export interface BasicScope<Type extends object, AttachmentType extends Attachment, AdditionalSpecifications extends object, AdditionalPropertiesType> {
+export interface BasicScope<Type extends object, AttachmentType extends Attachment, AdditionalDefinition extends object, AdditionalPropertiesType> {
     attachmentWithPrefixExists: (namePrefix: string) => boolean;
-    checkDocument: (newDocument: PartialFullDocument<Type, AdditionalPropertiesType>, oldDocument: PartialFullDocument<Type, AdditionalPropertiesType> | null, modelName: string, model: Model<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>, parentNames: Array<string>) => CheckedDocumentResult<Type, AdditionalPropertiesType>;
+    checkDocument: (newDocument: PartialFullDocument<Type, AdditionalPropertiesType>, oldDocument: PartialFullDocument<Type, AdditionalPropertiesType> | null, modelName: string, model: Model<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>, parentNames: Array<string>) => CheckedDocumentResult<Type, AdditionalPropertiesType>;
     deepCopy: <T>(data: T) => T;
     getDateTime: (value: number | string) => Date;
     getEffectiveValue: (name: string, newDocument: PartialFullDocument<Type, AdditionalPropertiesType>, oldDocument: (null | PartialFullDocument<Type, AdditionalPropertiesType>)) => unknown;
@@ -438,17 +438,17 @@ export interface BasicScope<Type extends object, AttachmentType extends Attachme
     revisionName: string;
     specialNames: SpecialPropertyNames;
     typeName: string;
-    modelConfiguration: BaseModelConfiguration<Type, AdditionalSpecifications>;
-    models: Models<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>;
+    modelConfiguration: BaseModelConfiguration<Type, AdditionalDefinition>;
+    models: Models<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>;
     now: Date;
     nowUTCTimestamp: number;
     securitySettings: Partial<SecuritySettings>;
     userContext: Partial<UserContext>;
     originalNewDocument?: PartialFullDocument<Type, AdditionalPropertiesType>;
 }
-export interface CommonScope<ObjectType extends object, Type, AttachmentType extends Attachment, AdditionalSpecifications extends object, AdditionalPropertiesType> {
-    checkPropertyContent: (newValue: Type, name: string, propertySpecification: PropertySpecification<Type, AdditionalSpecifications>, oldValue: Type) => CheckedPropertyResult<Type>;
-    model: Model<ObjectType, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>;
+export interface CommonScope<ObjectType extends object, Type, AttachmentType extends Attachment, AdditionalDefinition extends object, AdditionalPropertiesType> {
+    checkPropertyContent: (newValue: Type, name: string, propertyDefinition: PropertyDefinition<Type, AdditionalDefinition>, oldValue: Type) => CheckedPropertyResult<Type>;
+    model: Model<ObjectType, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>;
     modelName: string;
     type: Array<string> | string;
     newDocument: PartialFullDocument<ObjectType, AdditionalPropertiesType>;
@@ -457,14 +457,14 @@ export interface CommonScope<ObjectType extends object, Type, AttachmentType ext
     pathDescription: string;
     updateStrategy: UpdateStrategy;
 }
-export interface PropertyScope<ObjectType extends object, Type, PropertyType, AttachmentType extends Attachment, AdditionalSpecifications extends object, AdditionalPropertiesType> extends CommonScope<ObjectType, PropertyType, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType> {
+export interface PropertyScope<ObjectType extends object, Type, PropertyType, AttachmentType extends Attachment, AdditionalDefinition extends object, AdditionalPropertiesType> extends CommonScope<ObjectType, PropertyType, AttachmentType, AdditionalDefinition, AdditionalPropertiesType> {
     name: string;
     newValue: Type;
     oldValue?: Type;
-    propertySpecification: PropertySpecification<Type, AdditionalSpecifications>;
+    propertyDefinition: PropertyDefinition<Type, AdditionalDefinition>;
     attachmentsTarget?: Mapping<AttachmentType | null>;
 }
-export interface EvaluationResult<ObjectType extends object, Type, PropertyType, AttachmentType extends Attachment, AdditionalSpecifications extends object, AdditionalPropertiesType, Scope = (BasicScope<ObjectType, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType> & CommonScope<ObjectType, PropertyType, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>)> {
+export interface EvaluationResult<ObjectType extends object, Type, PropertyType, AttachmentType extends Attachment, AdditionalDefinition extends object, AdditionalPropertiesType, Scope = (BasicScope<ObjectType, AttachmentType, AdditionalDefinition, AdditionalPropertiesType> & CommonScope<ObjectType, PropertyType, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>)> {
     code: string;
     result: Type;
     scope: Scope;
@@ -488,14 +488,14 @@ export interface InitializeExpressPouchDBStateData {
     expressInstance: Express;
     expressPouchDBInstance: Express;
 }
-export type Migrator<Type extends object = object, AttachmentType extends Attachment = Attachment, AdditionalSpecifications extends object = object, AdditionalPropertiesType = unknown> = (document: Document, scope: (typeof UTILITY_SCOPE & {
+export type Migrator<Type extends object = object, AttachmentType extends Attachment = Attachment, AdditionalDefinition extends object = object, AdditionalPropertiesType = unknown> = (document: Document, scope: (typeof UTILITY_SCOPE & {
     configuration: Configuration;
     databaseHelper: Mapping<unknown>;
     idName: string;
     typeName: string;
-    migrators: Mapping<Migrator<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>>;
-    models: Models<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>;
-    modelConfiguration: ModelConfiguration<Type, AttachmentType, AdditionalSpecifications, AdditionalPropertiesType>;
+    migrators: Mapping<Migrator<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>>;
+    models: Models<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>;
+    modelConfiguration: ModelConfiguration<Type, AttachmentType, AdditionalDefinition, AdditionalPropertiesType>;
     selfFilePath: string;
     services: Services;
 })) => Document | null;