@imbricate/core 3.16.0 → 3.17.0

package/document/base-class/essential-readonly.d.ts

@@ -7,11 +7,11 @@ import { DocumentAnnotations, ImbricateDocumentAuditOptions } from "../definitio
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
 import { ImbricateDocumentPutPropertyOutcome } from "../outcome";
-import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "../property";
+import { DocumentProperties } from "../property";
 import { ImbricateDocumentEssentialBase } from "./essential";
 export declare abstract class ImbricateDocumentEssentialReadonlyBase extends ImbricateDocumentEssentialBase implements IImbricateDocument {
     readonly annotations: DocumentAnnotations;
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
-    putProperty(_key: DocumentPropertyKey, _value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    putProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    mergeProperty(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    replaceProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
 }

package/document/base-class/essential-readonly.js

@@ -15,10 +15,10 @@ class ImbricateDocumentEssentialReadonlyBase extends essential_1.ImbricateDocume
         this.annotations = {};
         this.supportedFeatures = [];
     }
-    putProperty(_key, _value, _auditOptions) {
+    mergeProperty(_properties, _auditOptions) {
         throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
     }
-    putProperties(_properties, _auditOptions) {
+    replaceProperties(_properties, _auditOptions) {
         throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
     }
 }

package/document/base-class/full-feature-readonly.d.ts

@@ -7,12 +7,12 @@ import { DocumentAnnotationValue, DocumentEditRecord, ImbricateDocumentAuditOpti
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
 import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
-import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "../property";
+import { DocumentProperties } from "../property";
 import { ImbricateDocumentFullFeatureBase } from "./full-feature";
 export declare abstract class ImbricateDocumentFullFeatureReadonlyBase extends ImbricateDocumentFullFeatureBase implements IImbricateDocument {
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
-    putProperty(_key: DocumentPropertyKey, _value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    putProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    mergeProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    replaceProperties(_properties: DocumentProperties, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
     putAnnotation(_namespace: string, _identifier: string, _value: DocumentAnnotationValue, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutAnnotationOutcome>;
     deleteAnnotation(_namespace: string, _identifier: string, _auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
     addEditRecords(_records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;

package/document/base-class/full-feature-readonly.js

@@ -16,10 +16,10 @@ class ImbricateDocumentFullFeatureReadonlyBase extends full_feature_1.ImbricateD
             feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_EDIT_RECORD,
         ];
     }
-    putProperty(_key, _value, _auditOptions) {
+    mergeProperties(_properties, _auditOptions) {
         throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
     }
-    putProperties(_properties, _auditOptions) {
+    replaceProperties(_properties, _auditOptions) {
         throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY);
     }
     putAnnotation(_namespace, _identifier, _value, _auditOptions) {

package/document/base-class/full-feature.d.ts

@@ -7,15 +7,15 @@ import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, Imbri
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
 import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
-import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "../property";
+import { DocumentProperties } from "../property";
 export declare abstract class ImbricateDocumentFullFeatureBase implements IImbricateDocument {
     abstract readonly uniqueIdentifier: string;
     abstract readonly documentVersion: string;
     abstract readonly properties: DocumentProperties;
     abstract readonly annotations: DocumentAnnotations;
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
-    abstract putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
-    abstract putProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    abstract mergeProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    abstract replaceProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
     abstract putAnnotation(namespace: string, identifier: string, value: DocumentAnnotationValue, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutAnnotationOutcome>;
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;

package/document/interface.d.ts

@@ -6,7 +6,7 @@
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "./feature";
 import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "./outcome";
-import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
+import { DocumentProperties } from "./property";
 export interface IImbricateDocument {
     /**
      * Unique identifier of the database
@@ -29,20 +29,19 @@ export interface IImbricateDocument {
      */
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
     /**
-     * Update a property from the document
+     * Merge a property to the document
      *
      * RequireFeature: DOCUMENT_PUT_PROPERTY
      *
-     * @param key key of the property
-     * @param value value of the property
+     * @param properties properties of the document
      * @param auditOptions audit options of the document
      *
      * @returns a promise of the outcome of the put property
      *  Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
      */
-    putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
+    mergeProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
     /**
-     * Put and replace all properties of the document, optional
+     * Replace all properties of the document
      *
      * RequireFeature: DOCUMENT_PUT_PROPERTIES
      *
@@ -52,7 +51,7 @@ export interface IImbricateDocument {
      * @returns a promise of the outcome of the put properties
      *  Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
      */
-    putProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
+    replaceProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
     /**
      * Put annotation to the document, optional
      *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",