@imbricate/core 3.20.0 → 3.20.2

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

@@ -5,7 +5,9 @@
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { ImbricatePropertyKey } from "../../property/definition";
+import { IImbricateProperty } from "../../property/interface";
 import { ImbricatePropertyRecord } from "../../property/map";
+import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "../../property/type";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
@@ -17,8 +19,10 @@ export declare abstract class ImbricateDocumentFullFeatureWithActionBase impleme
     readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
     abstract getProperties(): ImbricateDocumentGetPropertiesOutcome;
     abstract getProperty(key: ImbricatePropertyKey): ImbricateDocumentGetPropertyOutcome;
+    abstract putProperty<T extends IMBRICATE_PROPERTY_TYPE>(property: IImbricateProperty<T>, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
     abstract mergeProperties(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
     abstract replaceProperties(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentPutPropertyOutcome>;
+    abstract createProperty<T extends IMBRICATE_PROPERTY_TYPE>(propertyKey: ImbricatePropertyKey, propertyType: T, propertyValue: ImbricatePropertyValueObject<T>): IImbricateProperty<T>;
     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

@@ -5,7 +5,9 @@
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
 import { ImbricatePropertyKey } from "../property/definition";
+import { IImbricateProperty } from "../property/interface";
 import { ImbricatePropertyRecord } from "../property/map";
+import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "../property/type";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "./feature";
 import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentGetPropertiesOutcome, ImbricateDocumentGetPropertyOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "./outcome";
@@ -38,6 +40,18 @@ export interface IImbricateDocument {
      * @returns the property of the document
      */
     getProperty(propertyKey: ImbricatePropertyKey): ImbricateDocumentGetPropertyOutcome;
+    /**
+     * Put a property to the document
+     *
+     * RequireFeature: DOCUMENT_PUT_PROPERTY
+     *
+     * @param property the property to put
+     * @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<T extends IMBRICATE_PROPERTY_TYPE>(property: IImbricateProperty<T>, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
     /**
      * Merge a property to the document
      *
@@ -62,6 +76,15 @@ export interface IImbricateDocument {
      *  Symbol: S_Document_PutProperty_InvalidKey - if the key is invalid
      */
     replaceProperties(properties: ImbricatePropertyRecord, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<ImbricateDocumentPutPropertyOutcome>;
+    /**
+     * Create a property of the document
+     *
+     * @param propertyKey the key of the property
+     * @param propertyType the type of the property
+     *
+     * @returns the property of the document
+     */
+    createProperty<T extends IMBRICATE_PROPERTY_TYPE>(propertyKey: ImbricatePropertyKey, propertyType: T, propertyValue: ImbricatePropertyValueObject<T>): IImbricateProperty<T>;
     /**
      * Put annotation to the document, optional
      *

package/package.json

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

package/property/base-class/full-feature-with-action.d.ts

@@ -13,6 +13,7 @@ export declare abstract class ImbricatePropertyFullFeatureWithActionBase<T exten
     abstract readonly propertyType: T;
     abstract readonly propertyValue: ImbricatePropertyValueObject<T>;
     readonly supportedFeatures: IMBRICATE_PROPERTY_FEATURE[];
+    abstract cloneWithValue(value: ImbricatePropertyValueObject<T>): IImbricateProperty<T>;
     abstract queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     abstract executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

package/property/interface.d.ts

@@ -24,6 +24,14 @@ export interface IImbricateProperty<T extends IMBRICATE_PROPERTY_TYPE> {
      * Supported features of the property
      */
     readonly supportedFeatures: IMBRICATE_PROPERTY_FEATURE[];
+    /**
+     * Clone the property with the new value
+     *
+     * @param value the new value
+     *
+     * @returns the cloned property
+     */
+    cloneWithValue(value: ImbricatePropertyValueObject<T>): IImbricateProperty<T>;
     /**
      * Query the property actions
      *