@imbricate/core 3.27.1 → 3.28.0

package/document/definition.d.ts

@@ -4,7 +4,7 @@
  * @description Definition
  */
 import { ImbricateAuthor } from "../author/definition";
-import { ImbricatePropertyKey } from "../property/definition";
+import { ImbricatePropertyKey, ImbricatePropertyVariant } from "../property/definition";
 import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "../property/type";
 /**
  * Edit record type of the document
@@ -19,6 +19,7 @@ export type DocumentEditOperationValuePutProperty<T extends IMBRICATE_PROPERTY_T
     readonly key: ImbricatePropertyKey;
     readonly type: T;
     readonly value: ImbricatePropertyValueObject<T>;
+    readonly variant: ImbricatePropertyVariant;
 };
 export type DocumentEditOperationPutAnnotation = {
     readonly annotationNamespace: string;

package/package.json

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

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

@@ -4,7 +4,7 @@
  * @description Full Feature
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
-import { ImbricatePropertyKey } from "../definition";
+import { ImbricatePropertyKey, ImbricatePropertyVariant } from "../definition";
 import { IMBRICATE_PROPERTY_FEATURE } from "../feature";
 import { IImbricateProperty } from "../interface";
 import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "../type";
@@ -12,6 +12,7 @@ export declare abstract class ImbricatePropertyFullFeatureWithActionBase<T exten
     abstract readonly propertyKey: ImbricatePropertyKey;
     abstract readonly propertyType: T;
     abstract readonly propertyValue: ImbricatePropertyValueObject<T>;
+    abstract readonly propertyVariant: ImbricatePropertyVariant;
     readonly supportedFeatures: IMBRICATE_PROPERTY_FEATURE[];
     abstract queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     abstract executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;

package/property/definition.d.ts

@@ -7,3 +7,7 @@
  * Imbricate property key, which should match schema properties unique identifier
  */
 export type ImbricatePropertyKey = string;
+/**
+ * Imbricate property variant, which should match schema property variants unique identifier
+ */
+export type ImbricatePropertyVariant = string | null;

package/property/interface.d.ts

@@ -4,7 +4,7 @@
  * @description Interface
  */
 import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
-import { ImbricatePropertyKey } from "./definition";
+import { ImbricatePropertyKey, ImbricatePropertyVariant } from "./definition";
 import { IMBRICATE_PROPERTY_FEATURE } from "./feature";
 import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "./type";
 export interface IImbricateProperty<T extends IMBRICATE_PROPERTY_TYPE> {
@@ -20,6 +20,10 @@ export interface IImbricateProperty<T extends IMBRICATE_PROPERTY_TYPE> {
      * Property value
      */
     readonly propertyValue: ImbricatePropertyValueObject<T>;
+    /**
+     * Property variant
+     */
+    readonly propertyVariant: ImbricatePropertyVariant;
     /**
      * Supported features of the property
      */

package/property/map.d.ts

@@ -3,9 +3,9 @@
  * @namespace Property
  * @description Map
  */
-import { ImbricatePropertyKey } from "./definition";
+import { ImbricatePropertyKey, ImbricatePropertyVariant } from "./definition";
 import { IImbricateProperty } from "./interface";
 import { IMBRICATE_PROPERTY_TYPE, ImbricatePropertyValueObject } from "./type";
 export type ImbricatePropertyRecord = Record<ImbricatePropertyKey, IImbricateProperty<IMBRICATE_PROPERTY_TYPE>>;
-export type ImbricatePropertyGenerator<T extends IMBRICATE_PROPERTY_TYPE> = (propertyKey: ImbricatePropertyKey, propertyType: T, propertyValue: ImbricatePropertyValueObject<T>) => IImbricateProperty<T>;
+export type ImbricatePropertyGenerator<T extends IMBRICATE_PROPERTY_TYPE> = (propertyKey: ImbricatePropertyKey, propertyType: T, propertyValue: ImbricatePropertyValueObject<T>, propertyVariant: ImbricatePropertyVariant) => IImbricateProperty<T>;
 export type ImbricatePropertiesDrafter = (generator: ImbricatePropertyGenerator<IMBRICATE_PROPERTY_TYPE>) => Array<IImbricateProperty<IMBRICATE_PROPERTY_TYPE>>;