couchdb-web-node-plugin 1.0.602 → 1.0.604

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/type.d.ts +16 -16
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "couchdb-web-node-plugin",
3
- "version": "1.0.602",
3
+ "version": "1.0.604",
4
4
  "description": "A couchdb server, model instance conflict handler, rest api, authentication, session management, schema validator and model relation guarantee for webNode.",
5
5
  "keywords": [
6
6
  "api",
package/type.d.ts CHANGED
@@ -107,9 +107,9 @@ export interface PropertySpecification<Type = unknown, AdditionalSpecifications
107
107
  export interface FileSpecification<Type = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> extends PropertySpecification<Type, AdditionalSpecifications> {
108
108
  fileName?: PropertySpecification<string, AdditionalSpecifications>;
109
109
  }
110
- export interface BaseModel {
110
+ export interface BaseModel<AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> {
111
111
  _allowedRoles?: AllowedRoles | null;
112
- _attachments?: Mapping<FileSpecification> | null;
112
+ _attachments?: (Mapping<FileSpecification<AttachmentType, AdditionalSpecifications>> | null);
113
113
  _constraintExecutions?: Array<Constraint> | Constraint | null;
114
114
  _constraintExpressions?: Array<Constraint> | Constraint | null;
115
115
  _createExecution?: null | string;
@@ -121,8 +121,8 @@ export interface BaseModel {
121
121
  _onUpdateExecution?: null | string;
122
122
  _onUpdateExpression?: null | string;
123
123
  }
124
- export type Model<Type = unknown, AdditionalSpecifications extends object = Mapping<unknown>> = BaseModel & Mapping<PropertySpecification<Type, AdditionalSpecifications>>;
125
- export type Models<Type = unknown, AdditionalSpecifications extends object = Mapping<unknown>> = Mapping<Model<Type, AdditionalSpecifications>>;
124
+ export type Model<Type = unknown, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> = BaseModel<AttachmentType, AdditionalSpecifications> & Mapping<PropertySpecification<Type, AdditionalSpecifications>>;
125
+ export type Models<Type = unknown, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> = Mapping<Model<Type, AttachmentType, AdditionalSpecifications>>;
126
126
  export type UpdateStrategy = '' | 'fillUp' | 'incremental' | 'migrate';
127
127
  export type DocumentContent = Array<DocumentContent> | PlainObject | Primitive;
128
128
  export type DocumentStrategyMeta = {
@@ -183,9 +183,9 @@ export interface BaseModelConfiguration<Type = unknown, AdditionalSpecifications
183
183
  };
184
184
  updateStrategy: UpdateStrategy;
185
185
  }
186
- export interface ModelConfiguration<Type = unknown, AdditionalSpecifications extends object = Mapping<unknown>> extends BaseModelConfiguration<Type, AdditionalSpecifications> {
186
+ export interface ModelConfiguration<Type = unknown, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> extends BaseModelConfiguration<Type, AdditionalSpecifications> {
187
187
  autoMigrationPath: string;
188
- entities: Models<Type, AdditionalSpecifications>;
188
+ entities: Models<Type, AttachmentType, AdditionalSpecifications>;
189
189
  triggerInitialCompaction: boolean;
190
190
  updateConfiguration: boolean;
191
191
  updateValidation: boolean;
@@ -222,7 +222,7 @@ export type AdvancedFetchOptions = RequestInit & {
222
222
  export type ConnectorConfiguration = DatabaseConnectorConfiguration & {
223
223
  fetch?: AdvancedFetchOptions | null;
224
224
  };
225
- export interface CoreConfiguration<Type = unknown, AdditionalSpecifications extends object = Mapping<unknown>> {
225
+ export interface CoreConfiguration<Type = unknown, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> {
226
226
  attachAutoRestarter: boolean;
227
227
  backend: {
228
228
  configuration: PlainObject;
@@ -245,7 +245,7 @@ export interface CoreConfiguration<Type = unknown, AdditionalSpecifications exte
245
245
  local: boolean;
246
246
  maximumRepresentationLength: number;
247
247
  maximumRepresentationTryLength: number;
248
- model: ModelConfiguration<Type, AdditionalSpecifications>;
248
+ model: ModelConfiguration<Type, AttachmentType, AdditionalSpecifications>;
249
249
  path: string;
250
250
  security: SecuritySettings;
251
251
  skipIDDetermining: boolean;
@@ -311,7 +311,7 @@ export interface CompilationErrorData<S = Mapping<unknown>> extends EvaluationEr
311
311
  export interface RuntimeErrorData<S = Mapping<unknown>> extends EvaluationErrorData<S> {
312
312
  runtime: string;
313
313
  }
314
- export interface BasicScope<Type = unknown, AdditionalSpecifications extends object = Mapping<unknown>> {
314
+ export interface BasicScope<Type = unknown, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> {
315
315
  attachmentWithPrefixExists: (namePrefix: string) => boolean;
316
316
  checkDocument: (newDocument: PartialFullDocument, oldDocument: PartialFullDocument | null, parentNames: Array<string>) => CheckedDocumentResult;
317
317
  getFileNameByPrefix: (prefix?: string, attachments?: Attachments) => null | string;
@@ -323,15 +323,15 @@ export interface BasicScope<Type = unknown, AdditionalSpecifications extends obj
323
323
  specialNames: SpecialPropertyNames;
324
324
  typeName: string;
325
325
  modelConfiguration: BaseModelConfiguration<Type, AdditionalSpecifications>;
326
- models: Models<Type, AdditionalSpecifications>;
326
+ models: Models<Type, AttachmentType, AdditionalSpecifications>;
327
327
  now: Date;
328
328
  nowUTCTimestamp: number;
329
329
  securitySettings: Partial<SecuritySettings>;
330
330
  userContext: Partial<UserContext>;
331
331
  }
332
- export interface CommonScope<Type, AdditionalSpecifications extends object = Mapping<unknown>> {
332
+ export interface CommonScope<Type, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> {
333
333
  checkPropertyContent: (newValue: unknown, name: string, propertySpecification: PropertySpecification<Type, AdditionalSpecifications>, oldValue: unknown) => CheckedPropertyResult;
334
- model: Model<Type, AdditionalSpecifications>;
334
+ model: Model<Type, AttachmentType, AdditionalSpecifications>;
335
335
  modelName: string;
336
336
  type: Array<string> | string;
337
337
  newDocument: Attachments | PartialFullDocument;
@@ -339,7 +339,7 @@ export interface CommonScope<Type, AdditionalSpecifications extends object = Map
339
339
  parentNames: Array<string>;
340
340
  pathDescription: string;
341
341
  }
342
- export interface PropertyScope<Type = unknown, AdditionalSpecifications extends object = Mapping<unknown>> extends CommonScope<Type, AdditionalSpecifications> {
342
+ export interface PropertyScope<Type = unknown, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> extends CommonScope<Type, AttachmentType, AdditionalSpecifications> {
343
343
  name: string;
344
344
  newValue: Type;
345
345
  oldValue: Type;
@@ -360,15 +360,15 @@ export interface CheckedPropertyResult extends CheckedResult {
360
360
  export interface CheckedDocumentResult extends CheckedResult {
361
361
  newDocument: PartialFullDocument;
362
362
  }
363
- export type Migrator<Type = unknown, AdditionalSpecifications extends object = Mapping<unknown>> = (document: Document, scope: {
363
+ export type Migrator<Type = unknown, AttachmentType = Attachment, AdditionalSpecifications extends object = Mapping<unknown>> = (document: Document, scope: {
364
364
  configuration: Configuration;
365
365
  databaseHelper: DatabaseHelper;
366
366
  Tools: typeof Tools;
367
367
  idName: string;
368
368
  typeName: string;
369
369
  migrater: Mapping<Migrator<Type>>;
370
- models: Models<Type, AdditionalSpecifications>;
371
- modelConfiguration: ModelConfiguration<Type, AdditionalSpecifications>;
370
+ models: Models<Type, AttachmentType, AdditionalSpecifications>;
371
+ modelConfiguration: ModelConfiguration<Type, Attachment, AdditionalSpecifications>;
372
372
  selfFilePath: string;
373
373
  services: Services;
374
374
  }) => Document | null;