@imbricate/core 3.27.0 → 3.28.0

package/common/action.d.ts

@@ -46,6 +46,7 @@ export declare enum IMBRICATE_ORIGIN_ACTION_RESULT_STATUS {
     BAD_INPUT = "BAD_INPUT",
     INTERNAL_ERROR = "INTERNAL_ERROR"
 }
+export declare const rebuildImbricateOriginActionOutcomeSymbol: (symbolDescription: string) => CommonOutcomeSymbol | CommonActionOutcomeSymbol;
 export type ImbricateOriginActionOutcome = {
     readonly response: IMBRICATE_ORIGIN_ACTION_RESULT_STATUS;
     readonly outputs: ImbricateOriginActionResultOutput[];

package/common/action.js

@@ -5,8 +5,9 @@
  * @description Action
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rebuildImbricateCommonQueryOriginActionsSymbol = exports.ImbricateCommonQueryOriginActionsOutcomeSymbolList = exports.S_Common_QueryOriginActions_Unknown = exports.S_Common_QueryOriginActions_Stale = exports.IMBRICATE_ORIGIN_ACTION_RESULT_STATUS = exports.IMBRICATE_ORIGIN_ACTION_APPEARANCE = exports.IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE = void 0;
+exports.rebuildImbricateCommonQueryOriginActionsSymbol = exports.ImbricateCommonQueryOriginActionsOutcomeSymbolList = exports.S_Common_QueryOriginActions_Unknown = exports.S_Common_QueryOriginActions_Stale = exports.rebuildImbricateOriginActionOutcomeSymbol = exports.IMBRICATE_ORIGIN_ACTION_RESULT_STATUS = exports.IMBRICATE_ORIGIN_ACTION_APPEARANCE = exports.IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE = void 0;
 const rebuild_symbol_1 = require("../util/rebuild-symbol");
+const outcome_1 = require("./outcome");
 var IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE;
 (function (IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE) {
     IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE["STRING"] = "STRING";
@@ -25,6 +26,7 @@ var IMBRICATE_ORIGIN_ACTION_RESULT_STATUS;
     IMBRICATE_ORIGIN_ACTION_RESULT_STATUS["BAD_INPUT"] = "BAD_INPUT";
     IMBRICATE_ORIGIN_ACTION_RESULT_STATUS["INTERNAL_ERROR"] = "INTERNAL_ERROR";
 })(IMBRICATE_ORIGIN_ACTION_RESULT_STATUS || (exports.IMBRICATE_ORIGIN_ACTION_RESULT_STATUS = IMBRICATE_ORIGIN_ACTION_RESULT_STATUS = {}));
+exports.rebuildImbricateOriginActionOutcomeSymbol = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(outcome_1.CommonActionOutcomeSymbolList, outcome_1.S_Action_ActionResultStatusUnknown);
 // Query Origin Actions
 exports.S_Common_QueryOriginActions_Stale = Symbol("Common_QueryOriginActions_Stale");
 exports.S_Common_QueryOriginActions_Unknown = Symbol("Common_QueryOriginActions_Unknown");

package/common/outcome.d.ts

@@ -10,5 +10,6 @@ export type CommonOutcomeSymbol = typeof S_Common_Origin_ConnectionFail | typeof
 export declare const CommonOutcomeSymbolList: CommonOutcomeSymbol[];
 export declare const S_Action_ActionNotFound: unique symbol;
 export declare const S_Action_ActionParameterNotFound: unique symbol;
-export type CommonActionOutcomeSymbol = typeof S_Action_ActionNotFound | typeof S_Action_ActionParameterNotFound;
+export declare const S_Action_ActionResultStatusUnknown: unique symbol;
+export type CommonActionOutcomeSymbol = typeof S_Action_ActionNotFound | typeof S_Action_ActionParameterNotFound | typeof S_Action_ActionResultStatusUnknown;
 export declare const CommonActionOutcomeSymbolList: CommonActionOutcomeSymbol[];

package/common/outcome.js

@@ -5,7 +5,7 @@
  * @description Outcome
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonActionOutcomeSymbolList = exports.S_Action_ActionParameterNotFound = exports.S_Action_ActionNotFound = exports.CommonOutcomeSymbolList = exports.S_Common_Origin_NotAuthorized = exports.S_Common_Origin_ConnectionTimeout = exports.S_Common_Origin_ConnectionFail = void 0;
+exports.CommonActionOutcomeSymbolList = exports.S_Action_ActionResultStatusUnknown = exports.S_Action_ActionParameterNotFound = exports.S_Action_ActionNotFound = exports.CommonOutcomeSymbolList = exports.S_Common_Origin_NotAuthorized = exports.S_Common_Origin_ConnectionTimeout = exports.S_Common_Origin_ConnectionFail = void 0;
 exports.S_Common_Origin_ConnectionFail = Symbol("Common_Origin_ConnectionFail");
 exports.S_Common_Origin_ConnectionTimeout = Symbol("Common_Origin_ConnectionTimeout");
 exports.S_Common_Origin_NotAuthorized = Symbol("Common_Origin_NotAuthorized");
@@ -16,7 +16,9 @@ exports.CommonOutcomeSymbolList = [
 ];
 exports.S_Action_ActionNotFound = Symbol("Action_ActionNotFound");
 exports.S_Action_ActionParameterNotFound = Symbol("Action_ActionParameterNotFound");
+exports.S_Action_ActionResultStatusUnknown = Symbol("Action_ActionResultStatusUnknown");
 exports.CommonActionOutcomeSymbolList = [
     exports.S_Action_ActionNotFound,
     exports.S_Action_ActionParameterNotFound,
+    exports.S_Action_ActionResultStatusUnknown,
 ];

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.0",
+  "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>>;