@imbricate/core 3.24.1 → 3.24.3

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.
@@ -3,7 +3,7 @@
3
3
  * @namespace Database
4
4
  * @description Essential Readonly
5
5
  */
6
- import { ImbricatePropertyRecordDrafter } from "../../property/map";
6
+ import { ImbricatePropertiesDrafter } from "../../property/map";
7
7
  import { ImbricateDatabaseAuditOptions } from "../definition";
8
8
  import { IMBRICATE_DATABASE_FEATURE } from "../feature";
9
9
  import { IImbricateDatabase } from "../interface";
@@ -13,6 +13,6 @@ import { ImbricateDatabaseEssentialBase } from "./essential";
13
13
  export declare abstract class ImbricateDatabaseEssentialReadOnlyBase extends ImbricateDatabaseEssentialBase implements IImbricateDatabase {
14
14
  readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
15
15
  putSchema(_schema: ImbricateDatabaseSchema, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
16
- createDocument(_propertiesDrafter: ImbricatePropertyRecordDrafter, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
16
+ createDocument(_propertiesDrafter: ImbricatePropertiesDrafter, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
17
17
  removeDocument(_uniqueIdentifier: string, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseRemoveDocumentOutcome>;
18
18
  }
@@ -3,7 +3,7 @@
3
3
  * @namespace Database_BaseClass
4
4
  * @description Full Feature Readonly
5
5
  */
6
- import { ImbricatePropertyRecordDrafter } from "../../property/map";
6
+ import { ImbricatePropertiesDrafter } from "../../property/map";
7
7
  import { DatabaseAnnotationValue, DatabaseEditRecord, ImbricateDatabaseAuditOptions } from "../definition";
8
8
  import { IMBRICATE_DATABASE_FEATURE } from "../feature";
9
9
  import { IImbricateDatabase } from "../interface";
@@ -13,7 +13,7 @@ import { ImbricateDatabaseFullFeatureBase } from "./full-feature";
13
13
  export declare abstract class ImbricateDatabaseFullFeatureReadOnlyBase extends ImbricateDatabaseFullFeatureBase implements IImbricateDatabase {
14
14
  readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
15
15
  putSchema(_schema: ImbricateDatabaseSchema, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
16
- createDocument(_propertiesDrafter: ImbricatePropertyRecordDrafter, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
16
+ createDocument(_propertiesDrafter: ImbricatePropertiesDrafter, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
17
17
  removeDocument(_uniqueIdentifier: string, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseRemoveDocumentOutcome>;
18
18
  putAnnotation(_namespace: string, _identifier: string, _value: DatabaseAnnotationValue, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutAnnotationOutcome>;
19
19
  deleteAnnotation(_namespace: string, _identifier: string, _auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseDeleteAnnotationOutcome>;
@@ -4,7 +4,7 @@
4
4
  * @description Full Feature With Action
5
5
  */
6
6
  import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
7
- import { ImbricatePropertyRecordDrafter } from "../../property/map";
7
+ import { ImbricatePropertiesDrafter } from "../../property/map";
8
8
  import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
9
9
  import { IMBRICATE_DATABASE_FEATURE } from "../feature";
10
10
  import { IImbricateDatabase } from "../interface";
@@ -18,7 +18,7 @@ export declare abstract class ImbricateDatabaseFullFeatureWithActionBase impleme
18
18
  abstract readonly annotations: DatabaseAnnotations;
19
19
  readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
20
20
  abstract putSchema(schema: ImbricateDatabaseSchema, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
21
- abstract createDocument(propertiesDrafter: ImbricatePropertyRecordDrafter, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
21
+ abstract createDocument(propertiesDrafter: ImbricatePropertiesDrafter, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
22
22
  abstract getDocument(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseGetDocumentOutcome>;
23
23
  abstract queryDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseQueryDocumentsOutcome>;
24
24
  abstract countDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseCountDocumentsOutcome>;
@@ -4,7 +4,7 @@
4
4
  * @description Full Feature
5
5
  */
6
6
  import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
7
- import { ImbricatePropertyRecordDrafter } from "../../property/map";
7
+ import { ImbricatePropertiesDrafter } from "../../property/map";
8
8
  import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
9
9
  import { IMBRICATE_DATABASE_FEATURE } from "../feature";
10
10
  import { IImbricateDatabase } from "../interface";
@@ -19,7 +19,7 @@ export declare abstract class ImbricateDatabaseFullFeatureBase extends Imbricate
19
19
  abstract readonly annotations: DatabaseAnnotations;
20
20
  readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
21
21
  abstract putSchema(schema: ImbricateDatabaseSchema, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
22
- abstract createDocument(propertiesDrafter: ImbricatePropertyRecordDrafter, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
22
+ abstract createDocument(propertiesDrafter: ImbricatePropertiesDrafter, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
23
23
  abstract getDocument(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseGetDocumentOutcome>;
24
24
  abstract queryDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseQueryDocumentsOutcome>;
25
25
  abstract countDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseCountDocumentsOutcome>;
@@ -4,7 +4,7 @@
4
4
  * @description Interface
5
5
  */
6
6
  import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
7
- import { ImbricatePropertyRecordDrafter } from "../property/map";
7
+ import { ImbricatePropertiesDrafter } from "../property/map";
8
8
  import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
9
9
  import { IMBRICATE_DATABASE_FEATURE } from "./feature";
10
10
  import { ImbricateDatabaseAddEditRecordsOutcome, ImbricateDatabaseCountDocumentsOutcome, ImbricateDatabaseCreateDocumentOutcome, ImbricateDatabaseDeleteAnnotationOutcome, ImbricateDatabaseGetDocumentOutcome, ImbricateDatabaseGetEditRecordsOutcome, ImbricateDatabasePutAnnotationOutcome, ImbricateDatabasePutSchemaOutcome, ImbricateDatabaseQueryDocumentsOutcome, ImbricateDatabaseRemoveDocumentOutcome } from "./outcome";
@@ -59,7 +59,7 @@ export interface IImbricateDatabase {
59
59
  * @returns a promise of the outcome of the create document
60
60
  * Symbol: S_CreateDocument_IdentifierDuplicated - if the identifier is duplicated
61
61
  */
62
- createDocument(propertiesDrafter: ImbricatePropertyRecordDrafter, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
62
+ createDocument(propertiesDrafter: ImbricatePropertiesDrafter, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
63
63
  /**
64
64
  * Get one document from the database
65
65
  *
@@ -3,8 +3,7 @@
3
3
  * @namespace Document
4
4
  * @description Essential Readonly
5
5
  */
6
- import { ImbricatePropertyDrafter, ImbricatePropertyRecordDrafter } from "../../property/map";
7
- import { IMBRICATE_PROPERTY_TYPE } from "../../property/type";
6
+ import { ImbricatePropertiesDrafter } from "../../property/map";
8
7
  import { DocumentAnnotations, ImbricateDocumentAuditOptions } from "../definition";
9
8
  import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
10
9
  import { IImbricateDocument } from "../interface";
@@ -13,7 +12,6 @@ import { ImbricateDocumentEssentialBase } from "./essential";
13
12
  export declare abstract class ImbricateDocumentEssentialReadonlyBase extends ImbricateDocumentEssentialBase implements IImbricateDocument {
14
13
  readonly annotations: DocumentAnnotations;
15
14
  readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
16
- putProperty<T extends IMBRICATE_PROPERTY_TYPE>(_propertyDrafter: ImbricatePropertyDrafter<T>, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
17
- mergeProperties(_propertiesDrafter: ImbricatePropertyRecordDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
18
- replaceProperties(_propertiesDrafter: ImbricatePropertyRecordDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
15
+ mergeProperties(_propertiesDrafter: ImbricatePropertiesDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
16
+ replaceProperties(_propertiesDrafter: ImbricatePropertiesDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
19
17
  }
@@ -15,9 +15,6 @@ class ImbricateDocumentEssentialReadonlyBase extends essential_1.ImbricateDocume
15
15
  this.annotations = {};
16
16
  this.supportedFeatures = [];
17
17
  }
18
- putProperty(_propertyDrafter, _auditOptions) {
19
- throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
20
- }
21
18
  mergeProperties(_propertiesDrafter, _auditOptions) {
22
19
  throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
23
20
  }
@@ -3,8 +3,7 @@
3
3
  * @namespace Document
4
4
  * @description Full Feature Readonly
5
5
  */
6
- import { ImbricatePropertyDrafter, ImbricatePropertyRecordDrafter } from "../../property/map";
7
- import { IMBRICATE_PROPERTY_TYPE } from "../../property/type";
6
+ import { ImbricatePropertiesDrafter } from "../../property/map";
8
7
  import { DocumentAnnotationValue, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
9
8
  import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
10
9
  import { IImbricateDocument } from "../interface";
@@ -12,9 +11,8 @@ import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotati
12
11
  import { ImbricateDocumentFullFeatureBase } from "./full-feature";
13
12
  export declare abstract class ImbricateDocumentFullFeatureReadonlyBase extends ImbricateDocumentFullFeatureBase implements IImbricateDocument {
14
13
  readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
15
- putProperty<T extends IMBRICATE_PROPERTY_TYPE>(_propertyDrafter: ImbricatePropertyDrafter<T>, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
16
- mergeProperties(_propertiesDrafter: ImbricatePropertyRecordDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
17
- replaceProperties(_propertiesDrafter: ImbricatePropertyRecordDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
14
+ mergeProperties(_propertiesDrafter: ImbricatePropertiesDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
15
+ replaceProperties(_propertiesDrafter: ImbricatePropertiesDrafter, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
18
16
  putAnnotation(_namespace: string, _identifier: string, _value: DocumentAnnotationValue, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutAnnotationOutcome>;
19
17
  deleteAnnotation(_namespace: string, _identifier: string, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
20
18
  addEditRecords(_records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;
@@ -16,9 +16,6 @@ class ImbricateDocumentFullFeatureReadonlyBase extends full_feature_1.ImbricateD
16
16
  feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_EDIT_RECORD,
17
17
  ];
18
18
  }
19
- putProperty(_propertyDrafter, _auditOptions) {
20
- throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
21
- }
22
19
  mergeProperties(_propertiesDrafter, _auditOptions) {
23
20
  throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
24
21
  }
@@ -5,8 +5,7 @@
5
5
  */
6
6
  import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
7
7
  import { ImbricatePropertyKey } from "../../property/definition";
8
- import { ImbricatePropertyDrafter, ImbricatePropertyRecordDrafter } from "../../property/map";
9
- import { IMBRICATE_PROPERTY_TYPE } from "../../property/type";
8
+ import { ImbricatePropertiesDrafter } from "../../property/map";
10
9
  import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
11
10
  import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
12
11
  import { IImbricateDocument } from "../interface";
@@ -18,9 +17,8 @@ export declare abstract class ImbricateDocumentFullFeatureWithActionBase impleme
18
17
  readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
19
18
  abstract getProperties(): ImbricateDocumentGetPropertiesOutcome;
20
19
  abstract getProperty(key: ImbricatePropertyKey): ImbricateDocumentGetPropertyOutcome;
21
- abstract putProperty<T extends IMBRICATE_PROPERTY_TYPE>(propertyDrafter: ImbricatePropertyDrafter<T>, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
22
- abstract mergeProperties(propertiesDrafter: ImbricatePropertyRecordDrafter, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
23
- abstract replaceProperties(propertiesDrafter: ImbricatePropertyRecordDrafter, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
20
+ abstract mergeProperties(propertiesDrafter: ImbricatePropertiesDrafter, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
21
+ abstract replaceProperties(propertiesDrafter: ImbricatePropertiesDrafter, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
24
22
  abstract putAnnotation(namespace: string, identifier: string, value: DocumentAnnotationValue, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutAnnotationOutcome>;
25
23
  abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
26
24
  abstract addEditRecords(records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;
@@ -5,8 +5,7 @@
5
5
  */
6
6
  import { ImbricateAuthor } from "../author/definition";
7
7
  import { ImbricatePropertyKey } from "../property/definition";
8
- import { IImbricateProperty } from "../property/interface";
9
- import { IMBRICATE_PROPERTY_TYPE } from "../property/type";
8
+ import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "../property/type";
10
9
  /**
11
10
  * Edit record type of the document
12
11
  */
@@ -16,9 +15,10 @@ export declare enum IMBRICATE_DOCUMENT_EDIT_TYPE {
16
15
  DELETE_ANNOTATION = "DELETE_ANNOTATION",
17
16
  RESOLVE_CONFLICT = "RESOLVE_CONFLICT"
18
17
  }
19
- export type DocumentEditOperationValuePutProperty = {
18
+ export type DocumentEditOperationValuePutProperty<T extends IMBRICATE_PROPERTY_TYPE> = {
20
19
  readonly key: ImbricatePropertyKey;
21
- readonly value: IImbricateProperty<IMBRICATE_PROPERTY_TYPE>;
20
+ readonly type: T;
21
+ readonly value: ImbricatePropertyValueObject<T>;
22
22
  };
23
23
  export type DocumentEditOperationPutAnnotation = {
24
24
  readonly annotationNamespace: string;
@@ -32,7 +32,7 @@ export type DocumentEditOperationDeleteAnnotation = {
32
32
  export type DocumentEditOperationResolveConflict = {
33
33
  readonly conflictedEditRecords: string[];
34
34
  };
35
- export type DocumentEditOperationValue<T extends IMBRICATE_DOCUMENT_EDIT_TYPE> = T extends IMBRICATE_DOCUMENT_EDIT_TYPE.PUT_PROPERTY ? DocumentEditOperationValuePutProperty : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.PUT_ANNOTATION ? DocumentEditOperationPutAnnotation : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.DELETE_ANNOTATION ? DocumentEditOperationDeleteAnnotation : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.RESOLVE_CONFLICT ? DocumentEditOperationResolveConflict : never;
35
+ export type DocumentEditOperationValue<T extends IMBRICATE_DOCUMENT_EDIT_TYPE> = T extends IMBRICATE_DOCUMENT_EDIT_TYPE.PUT_PROPERTY ? DocumentEditOperationValuePutProperty<IMBRICATE_PROPERTY_TYPE> : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.PUT_ANNOTATION ? DocumentEditOperationPutAnnotation : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.DELETE_ANNOTATION ? DocumentEditOperationDeleteAnnotation : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.RESOLVE_CONFLICT ? DocumentEditOperationResolveConflict : never;
36
36
  export type DocumentEditOperation<T extends IMBRICATE_DOCUMENT_EDIT_TYPE> = {
37
37
  readonly action: T;
38
38
  readonly value: DocumentEditOperationValue<T>;
@@ -5,8 +5,7 @@
5
5
  */
6
6
  import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
7
7
  import { ImbricatePropertyKey } from "../property/definition";
8
- import { ImbricatePropertyDrafter, ImbricatePropertyRecordDrafter } from "../property/map";
9
- import { IMBRICATE_PROPERTY_TYPE } from "../property/type";
8
+ import { ImbricatePropertiesDrafter } from "../property/map";
10
9
  import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
11
10
  import { IMBRICATE_DOCUMENT_FEATURE } from "./feature";
12
11
  import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentGetPropertiesOutcome, ImbricateDocumentGetPropertyOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "./outcome";
@@ -39,18 +38,6 @@ export interface IImbricateDocument {
39
38
  * @returns the property of the document
40
39
  */
41
40
  getProperty(propertyKey: ImbricatePropertyKey): ImbricateDocumentGetPropertyOutcome;
42
- /**
43
- * Put a property to the document
44
- *
45
- * RequireFeature: DOCUMENT_PUT_PROPERTY
46
- *
47
- * @param propertyDrafter the property drafter to put
48
- * @param auditOptions audit options of the document
49
- *
50
- * @returns a promise of the outcome of the put property
51
- * Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
52
- */
53
- putProperty<T extends IMBRICATE_PROPERTY_TYPE>(propertyDrafter: ImbricatePropertyDrafter<T>, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
54
41
  /**
55
42
  * Merge a property to the document
56
43
  *
@@ -62,7 +49,7 @@ export interface IImbricateDocument {
62
49
  * @returns a promise of the outcome of the put property
63
50
  * Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
64
51
  */
65
- mergeProperties(propertiesDrafter: ImbricatePropertyRecordDrafter, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
52
+ mergeProperties(propertiesDrafter: ImbricatePropertiesDrafter, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
66
53
  /**
67
54
  * Replace all properties of the document
68
55
  *
@@ -74,7 +61,7 @@ export interface IImbricateDocument {
74
61
  * @returns a promise of the outcome of the put properties
75
62
  * Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
76
63
  */
77
- replaceProperties(propertiesDrafter: ImbricatePropertyRecordDrafter, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
64
+ replaceProperties(propertiesDrafter: ImbricatePropertiesDrafter, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
78
65
  /**
79
66
  * Put annotation to the document, optional
80
67
  *
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@imbricate/core",
3
3
  "main": "index.js",
4
- "version": "3.24.1",
4
+ "version": "3.24.3",
5
5
  "description": "Imbricate Core, Notebook for Engineers",
6
6
  "repository": {
7
7
  "type": "git",
package/property/map.d.ts CHANGED
@@ -8,5 +8,4 @@ import { IImbricateProperty } from "./interface";
8
8
  import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "./type";
9
9
  export type ImbricatePropertyRecord = Record<ImbricatePropertyKey, IImbricateProperty<IMBRICATE_PROPERTY_TYPE>>;
10
10
  export type ImbricatePropertyGenerator<T extends IMBRICATE_PROPERTY_TYPE> = (propertyKey: ImbricatePropertyKey, propertyType: T, propertyValue: ImbricatePropertyValueObject<T>) => IImbricateProperty<T>;
11
- export type ImbricatePropertyDrafter<T extends IMBRICATE_PROPERTY_TYPE> = (generator: ImbricatePropertyGenerator<T>) => IImbricateProperty<T>;
12
- export type ImbricatePropertyRecordDrafter = (generator: ImbricatePropertyGenerator<IMBRICATE_PROPERTY_TYPE>) => Array<IImbricateProperty<IMBRICATE_PROPERTY_TYPE>>;
11
+ export type ImbricatePropertiesDrafter = (generator: ImbricatePropertyGenerator<IMBRICATE_PROPERTY_TYPE>) => Array<IImbricateProperty<IMBRICATE_PROPERTY_TYPE>>;