couchdb-web-node-plugin 1.0.593 → 1.0.595

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "couchdb-web-node-plugin",
-  "version": "1.0.593",
+  "version": "1.0.595",
   "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

@@ -61,7 +61,7 @@ export interface SelectionMapping {
     label: string;
     value: unknown;
 }
-export interface PropertySpecification<Type = unknown> {
+export interface PropertySpecification<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> {
     allowedRoles?: AllowedRoles | null;
     computed?: boolean;
     arrayConstraintExecution?: Constraint | null;
@@ -102,9 +102,10 @@ export interface PropertySpecification<Type = unknown> {
     index?: boolean | null;
     oldName?: Array<string> | null | string;
     value?: null | Type;
+    additionalSpecifications?: AdditionalSpecifications;
 }
-export interface FileSpecification<Type = Attachment> extends PropertySpecification<Type> {
-    fileName?: PropertySpecification<string>;
+export interface FileSpecification<Type = Attachment, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> extends PropertySpecification<Type, AdditionalSpecifications> {
+    fileName?: PropertySpecification<string, AdditionalSpecifications>;
 }
 export interface BaseModel {
     _allowedRoles?: AllowedRoles | null;
@@ -120,8 +121,8 @@ export interface BaseModel {
     _onUpdateExecution?: null | string;
     _onUpdateExpression?: null | string;
 }
-export type Model<Type = unknown> = BaseModel & Mapping<PropertySpecification<Type>>;
-export type Models = Mapping<Model>;
+export type Model<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> = BaseModel & Mapping<PropertySpecification<Type, AdditionalSpecifications>>;
+export type Models<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> = Mapping<Model<Type, AdditionalSpecifications>>;
 export type UpdateStrategy = '' | 'fillUp' | 'incremental' | 'migrate';
 export type DocumentContent = Array<DocumentContent> | PlainObject | Primitive;
 export type DocumentStrategyMeta = {
@@ -174,17 +175,17 @@ export interface PropertyNameConfiguration {
     };
     validatedDocumentsCache: string;
 }
-export interface BaseModelConfiguration<Type = unknown> {
+export interface BaseModelConfiguration<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> {
     dateTimeFormat: 'iso' | 'iso8601' | 'number';
     property: {
-        defaultSpecification: PropertySpecification<Type>;
+        defaultSpecification: PropertySpecification<Type, AdditionalSpecifications>;
         name: PropertyNameConfiguration;
     };
     updateStrategy: UpdateStrategy;
 }
-export interface ModelConfiguration<Type = unknown> extends BaseModelConfiguration<Type> {
+export interface ModelConfiguration<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> extends BaseModelConfiguration<Type, AdditionalSpecifications> {
     autoMigrationPath: string;
-    entities: Models;
+    entities: Models<Type, AdditionalSpecifications>;
     triggerInitialCompaction: boolean;
     updateConfiguration: boolean;
     updateValidation: boolean;
@@ -310,7 +311,7 @@ export interface CompilationErrorData<S = Mapping<unknown>> extends EvaluationEr
 export interface RuntimeErrorData<S = Mapping<unknown>> extends EvaluationErrorData<S> {
     runtime: string;
 }
-export interface BasicScope<Type = unknown> {
+export interface BasicScope<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> {
     attachmentWithPrefixExists: (namePrefix: string) => boolean;
     checkDocument: (newDocument: PartialFullDocument, oldDocument: PartialFullDocument | null, parentNames: Array<string>) => CheckedDocumentResult;
     getFileNameByPrefix: (prefix?: string, attachments?: Attachments) => null | string;
@@ -321,16 +322,16 @@ export interface BasicScope<Type = unknown> {
     revisionName: string;
     specialNames: SpecialPropertyNames;
     typeName: string;
-    modelConfiguration: BaseModelConfiguration<Type>;
-    models: Models;
+    modelConfiguration: BaseModelConfiguration<Type, AdditionalSpecifications>;
+    models: Models<Type, AdditionalSpecifications>;
     now: Date;
     nowUTCTimestamp: number;
     securitySettings: Partial<SecuritySettings>;
     userContext: Partial<UserContext>;
 }
-export interface CommonScope<Type> {
-    checkPropertyContent: (newValue: unknown, name: string, propertySpecification: PropertySpecification<Type>, oldValue: unknown) => CheckedPropertyResult;
-    model: Model<Type>;
+export interface CommonScope<Type, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> {
+    checkPropertyContent: (newValue: unknown, name: string, propertySpecification: PropertySpecification<Type, AdditionalSpecifications>, oldValue: unknown) => CheckedPropertyResult;
+    model: Model<Type, AdditionalSpecifications>;
     modelName: string;
     type: Array<string> | string;
     newDocument: Attachments | PartialFullDocument;
@@ -338,11 +339,11 @@ export interface CommonScope<Type> {
     parentNames: Array<string>;
     pathDescription: string;
 }
-export interface PropertyScope<Type = unknown> extends CommonScope<Type> {
+export interface PropertyScope<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> extends CommonScope<Type, AdditionalSpecifications> {
     name: string;
     newValue: Type;
     oldValue: Type;
-    propertySpecification: PropertySpecification<Type>;
+    propertySpecification: PropertySpecification<Type, AdditionalSpecifications>;
 }
 export interface EvaluationResult<T = unknown, S = BasicScope<T> & CommonScope<T>> {
     code: string;
@@ -359,15 +360,15 @@ export interface CheckedPropertyResult extends CheckedResult {
 export interface CheckedDocumentResult extends CheckedResult {
     newDocument: PartialFullDocument;
 }
-export type Migrator<Type = unknown> = (document: Document, scope: {
+export type Migrator<Type = unknown, AdditionalSpecifications extends Mapping<unknown> = Mapping<unknown>> = (document: Document, scope: {
     configuration: Configuration;
     databaseHelper: DatabaseHelper;
     Tools: typeof Tools;
     idName: string;
     typeName: string;
     migrater: Mapping<Migrator<Type>>;
-    models: Models;
-    modelConfiguration: ModelConfiguration<Type>;
+    models: Models<Type, AdditionalSpecifications>;
+    modelConfiguration: ModelConfiguration<Type, AdditionalSpecifications>;
     selfFilePath: string;
     services: Services;
 }) => Document | null;