@imbricate/core 3.17.0 → 3.18.0

package/common/action.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @author WMXPY
+ * @namespace Common
+ * @description Action
+ */
+import { IETF_LOCALE } from "@sudoo/locale";
+import { HTTP_RESPONSE_CODE } from "@sudoo/magic";
+import { CommonActionOutcomeSymbol, CommonOutcomeSymbol } from "./outcome";
+export declare enum IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE {
+    STRING = "STRING"
+}
+export type ImbricateOriginActionParameterType = {
+    readonly type: IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE;
+};
+export type ImbricateOriginActionParameter = {
+    readonly parameterKey: string;
+    readonly getParameterName: (locale: IETF_LOCALE) => string;
+    readonly parameterType: ImbricateOriginActionParameterType;
+};
+export declare enum IMBRICATE_ORIGIN_ACTION_APPEARANCE {
+    DEFAULT = "DEFAULT",
+    IMPORTANT = "IMPORTANT",
+    SUCCESS = "SUCCESS",
+    WARNING = "WARNING",
+    DANGER = "DANGER"
+}
+export type ImbricateOriginAction = {
+    readonly actionIdentifier: string;
+    readonly getActionName: (locale: IETF_LOCALE) => string;
+    readonly parameters: ImbricateOriginActionParameter[];
+    readonly appearance?: IMBRICATE_ORIGIN_ACTION_APPEARANCE;
+    readonly disabled?: boolean;
+};
+export type ImbricateOriginActionInput = {
+    readonly actionIdentifier: string;
+    readonly parameters: Record<string, any>;
+};
+export type ImbricateOriginActionResultReference = {};
+export type ImbricateOriginActionResultOutput = {
+    readonly content: string;
+};
+export type ImbricateOriginActionOutcome = {
+    readonly response: HTTP_RESPONSE_CODE;
+    readonly outputs: ImbricateOriginActionResultOutput[];
+    readonly references: ImbricateOriginActionResultReference[];
+} | CommonOutcomeSymbol | CommonActionOutcomeSymbol;

package/common/action.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Common
+ * @description Action
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_ORIGIN_ACTION_APPEARANCE = exports.IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE = void 0;
+var IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE;
+(function (IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE) {
+    IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE["STRING"] = "STRING";
+})(IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE || (exports.IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE = IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE = {}));
+var IMBRICATE_ORIGIN_ACTION_APPEARANCE;
+(function (IMBRICATE_ORIGIN_ACTION_APPEARANCE) {
+    IMBRICATE_ORIGIN_ACTION_APPEARANCE["DEFAULT"] = "DEFAULT";
+    IMBRICATE_ORIGIN_ACTION_APPEARANCE["IMPORTANT"] = "IMPORTANT";
+    IMBRICATE_ORIGIN_ACTION_APPEARANCE["SUCCESS"] = "SUCCESS";
+    IMBRICATE_ORIGIN_ACTION_APPEARANCE["WARNING"] = "WARNING";
+    IMBRICATE_ORIGIN_ACTION_APPEARANCE["DANGER"] = "DANGER";
+})(IMBRICATE_ORIGIN_ACTION_APPEARANCE || (exports.IMBRICATE_ORIGIN_ACTION_APPEARANCE = IMBRICATE_ORIGIN_ACTION_APPEARANCE = {}));

package/common/definition.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @author WMXPY
+ * @namespace Common
+ * @description Definition
+ */
+export declare enum IMBRICATE_QUERY_COMPARE_CONDITION {
+    EQUAL = "EQUAL",
+    EXIST = "EXIST"
+}
+export declare enum IMBRICATE_QUERY_ATTRIBUTE {
+    VALUE = "VALUE"
+}
+export declare enum IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET {
+    PROPERTY_TYPE = "PROPERTY_TYPE",
+    PROPERTY_VALUE = "PROPERTY_VALUE"
+}

package/common/definition.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Common
+ * @description Definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = exports.IMBRICATE_QUERY_ATTRIBUTE = exports.IMBRICATE_QUERY_COMPARE_CONDITION = void 0;
+var IMBRICATE_QUERY_COMPARE_CONDITION;
+(function (IMBRICATE_QUERY_COMPARE_CONDITION) {
+    IMBRICATE_QUERY_COMPARE_CONDITION["EQUAL"] = "EQUAL";
+    IMBRICATE_QUERY_COMPARE_CONDITION["EXIST"] = "EXIST";
+})(IMBRICATE_QUERY_COMPARE_CONDITION || (exports.IMBRICATE_QUERY_COMPARE_CONDITION = IMBRICATE_QUERY_COMPARE_CONDITION = {}));
+var IMBRICATE_QUERY_ATTRIBUTE;
+(function (IMBRICATE_QUERY_ATTRIBUTE) {
+    IMBRICATE_QUERY_ATTRIBUTE["VALUE"] = "VALUE";
+})(IMBRICATE_QUERY_ATTRIBUTE || (exports.IMBRICATE_QUERY_ATTRIBUTE = IMBRICATE_QUERY_ATTRIBUTE = {}));
+var IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET;
+(function (IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET) {
+    IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET["PROPERTY_TYPE"] = "PROPERTY_TYPE";
+    IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET["PROPERTY_VALUE"] = "PROPERTY_VALUE";
+})(IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET || (exports.IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = {}));

package/common/export.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @author WMXPY
+ * @namespace Common
+ * @description Export
+ */
+export * from "./action";
+export * from "./definition";
+export * from "./outcome";

package/common/export.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Common
+ * @description Export
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./action"), exports);
+__exportStar(require("./definition"), exports);
+__exportStar(require("./outcome"), exports);

package/common/outcome.d.ts

@@ -8,3 +8,7 @@ export declare const S_Common_Origin_ConnectionTimeout: unique symbol;
 export declare const S_Common_Origin_NotAuthorized: unique symbol;
 export type CommonOutcomeSymbol = typeof S_Common_Origin_ConnectionFail | typeof S_Common_Origin_ConnectionTimeout | typeof S_Common_Origin_NotAuthorized;
 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 CommonActionOutcomeSymbolList: CommonActionOutcomeSymbol[];

package/common/outcome.js

@@ -5,7 +5,7 @@
  * @description Outcome
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonOutcomeSymbolList = exports.S_Common_Origin_NotAuthorized = exports.S_Common_Origin_ConnectionTimeout = exports.S_Common_Origin_ConnectionFail = void 0;
+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.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");
@@ -14,3 +14,9 @@ exports.CommonOutcomeSymbolList = [
     exports.S_Common_Origin_ConnectionTimeout,
     exports.S_Common_Origin_NotAuthorized,
 ];
+exports.S_Action_ActionNotFound = Symbol("Action_ActionNotFound");
+exports.S_Action_ActionParameterNotFound = Symbol("Action_ActionParameterNotFound");
+exports.CommonActionOutcomeSymbolList = [
+    exports.S_Action_ActionNotFound,
+    exports.S_Action_ActionParameterNotFound,
+];

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

@@ -0,0 +1,32 @@
+/**
+ * @author WMXPY
+ * @namespace Database_BaseClass
+ * @description Full Feature With Action
+ */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { DocumentProperties } from "../../document/property";
+import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
+import { IMBRICATE_DATABASE_FEATURE } from "../feature";
+import { IImbricateDatabase } from "../interface";
+import { ImbricateDatabaseAddEditRecordsOutcome, ImbricateDatabaseCountDocumentsOutcome, ImbricateDatabaseCreateDocumentOutcome, ImbricateDatabaseDeleteAnnotationOutcome, ImbricateDatabaseGetDocumentOutcome, ImbricateDatabaseGetEditRecordsOutcome, ImbricateDatabasePutAnnotationOutcome, ImbricateDatabasePutSchemaOutcome, ImbricateDatabaseQueryDocumentsOutcome, ImbricateDatabaseRemoveDocumentOutcome } from "../outcome";
+import { ImbricateDatabaseSchema } from "../schema";
+export declare abstract class ImbricateDatabaseFullFeatureWithActionBase implements IImbricateDatabase {
+    abstract readonly uniqueIdentifier: string;
+    abstract readonly databaseName: string;
+    abstract readonly databaseVersion: string;
+    abstract readonly schema: ImbricateDatabaseSchema;
+    abstract readonly annotations: DatabaseAnnotations;
+    readonly supportedFeatures: IMBRICATE_DATABASE_FEATURE[];
+    abstract putSchema(schema: ImbricateDatabaseSchema, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutSchemaOutcome>;
+    abstract createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseCreateDocumentOutcome>;
+    abstract getDocument(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseGetDocumentOutcome>;
+    abstract queryDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseQueryDocumentsOutcome>;
+    abstract countDocuments(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseCountDocumentsOutcome>;
+    abstract removeDocument(uniqueIdentifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseRemoveDocumentOutcome>;
+    abstract putAnnotation(namespace: string, identifier: string, value: DatabaseAnnotationValue, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabasePutAnnotationOutcome>;
+    abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseDeleteAnnotationOutcome>;
+    abstract addEditRecords(records: DatabaseEditRecord[]): PromiseLike<ImbricateDatabaseAddEditRecordsOutcome>;
+    abstract getEditRecords(): PromiseLike<ImbricateDatabaseGetEditRecordsOutcome>;
+    abstract getOriginActions(): ImbricateOriginAction[];
+    abstract executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
+}

package/database/base-class/full-feature-with-action.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Database_BaseClass
+ * @description Full Feature With Action
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateDatabaseFullFeatureWithActionBase = void 0;
+const feature_1 = require("../feature");
+class ImbricateDatabaseFullFeatureWithActionBase {
+    constructor() {
+        this.supportedFeatures = [
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_PUT_SCHEMA,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_CREATE_DOCUMENT,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_DELETE_DOCUMENT,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_PUT_ANNOTATION,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_DELETE_ANNOTATION,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_GET_DOCUMENT,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_PUT_EDIT_RECORD,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_GET_EDIT_RECORD,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_GET_ORIGIN_ACTIONS,
+            feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_EXECUTE_ORIGIN_ACTION,
+        ];
+    }
+}
+exports.ImbricateDatabaseFullFeatureWithActionBase = ImbricateDatabaseFullFeatureWithActionBase;

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

@@ -3,13 +3,15 @@
  * @namespace Database_BaseClass
  * @description Full Feature
  */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { DocumentProperties } from "../../document/property";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
 import { IMBRICATE_DATABASE_FEATURE } from "../feature";
 import { IImbricateDatabase } from "../interface";
 import { ImbricateDatabaseAddEditRecordsOutcome, ImbricateDatabaseCountDocumentsOutcome, ImbricateDatabaseCreateDocumentOutcome, ImbricateDatabaseDeleteAnnotationOutcome, ImbricateDatabaseGetDocumentOutcome, ImbricateDatabaseGetEditRecordsOutcome, ImbricateDatabasePutAnnotationOutcome, ImbricateDatabasePutSchemaOutcome, ImbricateDatabaseQueryDocumentsOutcome, ImbricateDatabaseRemoveDocumentOutcome } from "../outcome";
 import { ImbricateDatabaseSchema } from "../schema";
-export declare abstract class ImbricateDatabaseFullFeatureBase implements IImbricateDatabase {
+import { ImbricateDatabaseFullFeatureWithActionBase } from "./full-feature-with-action";
+export declare abstract class ImbricateDatabaseFullFeatureBase extends ImbricateDatabaseFullFeatureWithActionBase implements IImbricateDatabase {
     abstract readonly uniqueIdentifier: string;
     abstract readonly databaseName: string;
     abstract readonly databaseVersion: string;
@@ -26,4 +28,6 @@ export declare abstract class ImbricateDatabaseFullFeatureBase implements IImbri
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DatabaseEditRecord[]): PromiseLike<ImbricateDatabaseAddEditRecordsOutcome>;
     abstract getEditRecords(): PromiseLike<ImbricateDatabaseGetEditRecordsOutcome>;
+    getOriginActions(): ImbricateOriginAction[];
+    executeOriginAction(_input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

package/database/base-class/full-feature.js

@@ -6,9 +6,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImbricateDatabaseFullFeatureBase = void 0;
+const feature_not_supported_1 = require("../../error/database/feature-not-supported");
 const feature_1 = require("../feature");
-class ImbricateDatabaseFullFeatureBase {
+const full_feature_with_action_1 = require("./full-feature-with-action");
+class ImbricateDatabaseFullFeatureBase extends full_feature_with_action_1.ImbricateDatabaseFullFeatureWithActionBase {
     constructor() {
+        super(...arguments);
         this.supportedFeatures = [
             feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_PUT_SCHEMA,
             feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_CREATE_DOCUMENT,
@@ -20,5 +23,11 @@ class ImbricateDatabaseFullFeatureBase {
             feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_GET_EDIT_RECORD,
         ];
     }
+    getOriginActions() {
+        throw feature_not_supported_1.ImbricateDatabaseFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_GET_ORIGIN_ACTIONS);
+    }
+    executeOriginAction(_input) {
+        throw feature_not_supported_1.ImbricateDatabaseFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_EXECUTE_ORIGIN_ACTION);
+    }
 }
 exports.ImbricateDatabaseFullFeatureBase = ImbricateDatabaseFullFeatureBase;

package/database/definition.d.ts

@@ -4,18 +4,8 @@
  * @description Definition
  */
 import { ImbricateAuthor } from "../author/definition";
+import { IMBRICATE_QUERY_ATTRIBUTE, IMBRICATE_QUERY_COMPARE_CONDITION, IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET } from "../common/definition";
 import { ImbricateDatabaseSchema } from "./schema";
-export declare enum IMBRICATE_QUERY_COMPARE_CONDITION {
-    EQUAL = "EQUAL",
-    EXIST = "EXIST"
-}
-export declare enum IMBRICATE_QUERY_ATTRIBUTE {
-    VALUE = "VALUE"
-}
-export declare enum IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET {
-    PROPERTY_TYPE = "PROPERTY_TYPE",
-    PROPERTY_VALUE = "PROPERTY_VALUE"
-}
 export type ImbricateDocumentQueryPropertyFilter = {
     readonly propertyIdentifier: string;
     readonly target: IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET;
@@ -61,7 +51,7 @@ export type DatabaseEditOperationDeleteAnnotation = {
     readonly annotationIdentifier: string;
 };
 export type DatabaseEditOperationResolveConflict = {
-    readonly conflicetedEditRecords: string[];
+    readonly conflictedEditRecords: string[];
 };
 export type DatabaseEditOperationValue<T extends IMBRICATE_DATABASE_EDIT_TYPE> = T extends IMBRICATE_DATABASE_EDIT_TYPE.PUT_SCHEMA ? ImbricateDatabaseSchema : T extends IMBRICATE_DATABASE_EDIT_TYPE.PUT_ANNOTATION ? DatabaseEditOperationPutAnnotation : T extends IMBRICATE_DATABASE_EDIT_TYPE.DELETE_ANNOTATION ? DatabaseEditOperationDeleteAnnotation : T extends IMBRICATE_DATABASE_EDIT_TYPE.RESOLVE_CONFLICT ? DatabaseEditOperationResolveConflict : never;
 /**

package/database/definition.js

@@ -5,21 +5,7 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_DATABASE_EDIT_TYPE = exports.IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = exports.IMBRICATE_QUERY_ATTRIBUTE = exports.IMBRICATE_QUERY_COMPARE_CONDITION = void 0;
-var IMBRICATE_QUERY_COMPARE_CONDITION;
-(function (IMBRICATE_QUERY_COMPARE_CONDITION) {
-    IMBRICATE_QUERY_COMPARE_CONDITION["EQUAL"] = "EQUAL";
-    IMBRICATE_QUERY_COMPARE_CONDITION["EXIST"] = "EXIST";
-})(IMBRICATE_QUERY_COMPARE_CONDITION || (exports.IMBRICATE_QUERY_COMPARE_CONDITION = IMBRICATE_QUERY_COMPARE_CONDITION = {}));
-var IMBRICATE_QUERY_ATTRIBUTE;
-(function (IMBRICATE_QUERY_ATTRIBUTE) {
-    IMBRICATE_QUERY_ATTRIBUTE["VALUE"] = "VALUE";
-})(IMBRICATE_QUERY_ATTRIBUTE || (exports.IMBRICATE_QUERY_ATTRIBUTE = IMBRICATE_QUERY_ATTRIBUTE = {}));
-var IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET;
-(function (IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET) {
-    IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET["PROPERTY_TYPE"] = "PROPERTY_TYPE";
-    IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET["PROPERTY_VALUE"] = "PROPERTY_VALUE";
-})(IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET || (exports.IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = {}));
+exports.IMBRICATE_DATABASE_EDIT_TYPE = void 0;
 /**
  * Edit record type of the document
  */

package/database/export.d.ts

@@ -8,6 +8,7 @@ export * from "./base-class/essential-readonly";
 export * from "./base-class/exclude-annotation";
 export * from "./base-class/full-feature";
 export * from "./base-class/full-feature-readonly";
+export * from "./base-class/full-feature-with-action";
 export * from "./definition";
 export * from "./feature";
 export * from "./interface";

package/database/export.js

@@ -24,6 +24,7 @@ __exportStar(require("./base-class/essential-readonly"), exports);
 __exportStar(require("./base-class/exclude-annotation"), exports);
 __exportStar(require("./base-class/full-feature"), exports);
 __exportStar(require("./base-class/full-feature-readonly"), exports);
+__exportStar(require("./base-class/full-feature-with-action"), exports);
 __exportStar(require("./definition"), exports);
 __exportStar(require("./feature"), exports);
 __exportStar(require("./interface"), exports);

package/database/feature.d.ts

@@ -11,6 +11,8 @@ export declare enum IMBRICATE_DATABASE_FEATURE {
     DATABASE_PUT_ANNOTATION = "DATABASE_PUT_ANNOTATION",
     DATABASE_DELETE_ANNOTATION = "DATABASE_DELETE_ANNOTATION",
     DATABASE_PUT_EDIT_RECORD = "DATABASE_PUT_EDIT_RECORD",
-    DATABASE_GET_EDIT_RECORD = "DATABASE_GET_EDIT_RECORD"
+    DATABASE_GET_EDIT_RECORD = "DATABASE_GET_EDIT_RECORD",
+    DATABASE_GET_ORIGIN_ACTIONS = "DATABASE_GET_ORIGIN_ACTIONS",
+    DATABASE_EXECUTE_ORIGIN_ACTION = "DATABASE_EXECUTE_ORIGIN_ACTION"
 }
 export declare const checkImbricateDatabaseFeatureSupported: (features: IMBRICATE_DATABASE_FEATURE[], feature: IMBRICATE_DATABASE_FEATURE) => boolean;

package/database/feature.js

@@ -16,6 +16,8 @@ var IMBRICATE_DATABASE_FEATURE;
     IMBRICATE_DATABASE_FEATURE["DATABASE_DELETE_ANNOTATION"] = "DATABASE_DELETE_ANNOTATION";
     IMBRICATE_DATABASE_FEATURE["DATABASE_PUT_EDIT_RECORD"] = "DATABASE_PUT_EDIT_RECORD";
     IMBRICATE_DATABASE_FEATURE["DATABASE_GET_EDIT_RECORD"] = "DATABASE_GET_EDIT_RECORD";
+    IMBRICATE_DATABASE_FEATURE["DATABASE_GET_ORIGIN_ACTIONS"] = "DATABASE_GET_ORIGIN_ACTIONS";
+    IMBRICATE_DATABASE_FEATURE["DATABASE_EXECUTE_ORIGIN_ACTION"] = "DATABASE_EXECUTE_ORIGIN_ACTION";
 })(IMBRICATE_DATABASE_FEATURE || (exports.IMBRICATE_DATABASE_FEATURE = IMBRICATE_DATABASE_FEATURE = {}));
 const checkImbricateDatabaseFeatureSupported = (features, feature) => {
     return features.includes(feature);

package/database/interface.d.ts

@@ -3,6 +3,7 @@
  * @namespace Database
  * @description Interface
  */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
 import { DocumentProperties } from "../document/property";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
 import { IMBRICATE_DATABASE_FEATURE } from "./feature";
@@ -158,4 +159,18 @@ export interface IImbricateDatabase {
      *  Symbol: S_GetEditRecords_NotFound - if the edit records are not found
      */
     getEditRecords(): PromiseLike<ImbricateDatabaseGetEditRecordsOutcome>;
+    /**
+     * Get the database actions
+     *
+     * @returns the database actions
+     */
+    getOriginActions(): ImbricateOriginAction[];
+    /**
+     * Execute the database action
+     *
+     * @param input the input of the action
+     *
+     * @returns the result of the action
+     */
+    executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

package/database/validate.js

@@ -6,7 +6,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateImbricateDocumentQuery = void 0;
-const definition_1 = require("./definition");
+const definition_1 = require("../common/definition");
 /**
  * Validate imbricate document query
  *

package/database-manager/base-class/full-feature.d.ts

@@ -3,14 +3,14 @@
  * @namespace DatabaseManager
  * @description Full Feature
  */
-import { ImbricateDatabaseAuditOptions } from "../../database/definition";
+import { ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../../database/definition";
 import { ImbricateDatabaseSchemaForCreation } from "../../database/schema";
 import { IImbricateDatabaseManager } from "../database-manager";
 import { IMBRICATE_DATABASE_MANAGER_FEATURE } from "../feature";
-import { ImbricateDatabaseManagerCreateDatabaseOutcome, ImbricateDatabaseManagerGetDatabaseOutcome, ImbricateDatabaseManagerListDatabasesOutcome, ImbricateDatabaseManagerRemoveDatabaseOutcome } from "../outcome";
+import { ImbricateDatabaseManagerCreateDatabaseOutcome, ImbricateDatabaseManagerGetDatabaseOutcome, ImbricateDatabaseManagerQueryDatabasesOutcome, ImbricateDatabaseManagerRemoveDatabaseOutcome } from "../outcome";
 export declare abstract class ImbricateDatabaseManagerFullFeatureBase implements IImbricateDatabaseManager {
     readonly supportedFeatures: IMBRICATE_DATABASE_MANAGER_FEATURE[];
-    abstract listDatabases(): PromiseLike<ImbricateDatabaseManagerListDatabasesOutcome>;
+    abstract queryDatabases(query: ImbricateDocumentQuery): PromiseLike<ImbricateDatabaseManagerQueryDatabasesOutcome>;
     abstract getDatabase(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseManagerGetDatabaseOutcome>;
     abstract createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseManagerCreateDatabaseOutcome>;
     abstract removeDatabase(uniqueIdentifier: string): PromiseLike<ImbricateDatabaseManagerRemoveDatabaseOutcome>;

package/database-manager/database-manager.d.ts

@@ -5,8 +5,9 @@
  */
 import { ImbricateDatabaseAuditOptions } from "../database/definition";
 import { ImbricateDatabaseSchemaForCreation } from "../database/schema";
+import { ImbricateDatabaseQuery } from "./definition";
 import { IMBRICATE_DATABASE_MANAGER_FEATURE } from "./feature";
-import { ImbricateDatabaseManagerCreateDatabaseOutcome, ImbricateDatabaseManagerGetDatabaseOutcome, ImbricateDatabaseManagerListDatabasesOutcome, ImbricateDatabaseManagerRemoveDatabaseOutcome } from "./outcome";
+import { ImbricateDatabaseManagerCreateDatabaseOutcome, ImbricateDatabaseManagerGetDatabaseOutcome, ImbricateDatabaseManagerQueryDatabasesOutcome, ImbricateDatabaseManagerRemoveDatabaseOutcome } from "./outcome";
 export interface IImbricateDatabaseManager {
     /**
      * Supported features of the database manager
@@ -18,7 +19,7 @@ export interface IImbricateDatabaseManager {
      * @returns a promise of the databases in the origin
      *  Symbol: S_DatabaseManager_ListDatabases_Stale - if the databases are stale
      */
-    listDatabases(): PromiseLike<ImbricateDatabaseManagerListDatabasesOutcome>;
+    queryDatabases(query: ImbricateDatabaseQuery): PromiseLike<ImbricateDatabaseManagerQueryDatabasesOutcome>;
     /**
      * Get one database from the origin
      *

package/database-manager/definition.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @author WMXPY
+ * @namespace DatabaseManager
+ * @description Definition
+ */
+import { IMBRICATE_QUERY_ATTRIBUTE, IMBRICATE_QUERY_COMPARE_CONDITION } from "../common/definition";
+export type ImbricateDatabaseQueryAnnotationFilter = {
+    readonly namespace: string;
+    readonly identifier: string;
+    readonly attribute: IMBRICATE_QUERY_ATTRIBUTE;
+    readonly condition: IMBRICATE_QUERY_COMPARE_CONDITION;
+    readonly value: any;
+};
+/**
+ * Query of the database
+ *
+ * @param limit limit of the query
+ * @param skip skip of the query
+ */
+export type ImbricateDatabaseQuery = {
+    readonly limit?: number;
+    readonly skip?: number;
+    readonly annotationFilters?: ImbricateDatabaseQueryAnnotationFilter[];
+};

package/database-manager/definition.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace DatabaseManager
+ * @description Definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/database-manager/export.d.ts

@@ -6,5 +6,6 @@
 export * from "./base-class/full-feature";
 export * from "./base-class/readonly";
 export * from "./database-manager";
+export * from "./definition";
 export * from "./feature";
 export * from "./outcome";

package/database-manager/export.js

@@ -22,5 +22,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./base-class/full-feature"), exports);
 __exportStar(require("./base-class/readonly"), exports);
 __exportStar(require("./database-manager"), exports);
+__exportStar(require("./definition"), exports);
 __exportStar(require("./feature"), exports);
 __exportStar(require("./outcome"), exports);

package/database-manager/outcome.d.ts

@@ -5,14 +5,14 @@
  */
 import { CommonOutcomeSymbol } from "../common/outcome";
 import { IImbricateDatabase } from "../database/interface";
-export declare const S_DatabaseManager_ListDatabases_Stale: unique symbol;
-export declare const S_DatabaseManager_ListDatabases_Unknown: unique symbol;
-export type ImbricateDatabaseManagerListDatabasesOutcomeSymbol = typeof S_DatabaseManager_ListDatabases_Stale | typeof S_DatabaseManager_ListDatabases_Unknown;
-export declare const ImbricateDatabaseManagerListDatabasesOutcomeSymbolList: ImbricateDatabaseManagerListDatabasesOutcomeSymbol[];
-export declare const rebuildImbricateDatabaseManagerListDatabasesSymbol: (symbolDescription: string) => CommonOutcomeSymbol | ImbricateDatabaseManagerListDatabasesOutcomeSymbol;
-export type ImbricateDatabaseManagerListDatabasesOutcome = {
+export declare const S_DatabaseManager_QueryDatabases_Stale: unique symbol;
+export declare const S_DatabaseManager_QueryDatabases_Unknown: unique symbol;
+export type ImbricateDatabaseManagerQueryDatabasesOutcomeSymbol = typeof S_DatabaseManager_QueryDatabases_Stale | typeof S_DatabaseManager_QueryDatabases_Unknown;
+export declare const ImbricateDatabaseManagerQueryDatabasesOutcomeSymbolList: ImbricateDatabaseManagerQueryDatabasesOutcomeSymbol[];
+export declare const rebuildImbricateDatabaseManagerQueryDatabasesSymbol: (symbolDescription: string) => CommonOutcomeSymbol | ImbricateDatabaseManagerQueryDatabasesOutcomeSymbol;
+export type ImbricateDatabaseManagerQueryDatabasesOutcome = {
     readonly databases: IImbricateDatabase[];
-} | CommonOutcomeSymbol | ImbricateDatabaseManagerListDatabasesOutcomeSymbol;
+} | CommonOutcomeSymbol | ImbricateDatabaseManagerQueryDatabasesOutcomeSymbol;
 export declare const S_DatabaseManager_GetDatabase_NotFound: unique symbol;
 export declare const S_DatabaseManager_GetDatabase_Unknown: unique symbol;
 export type ImbricateDatabaseManagerGetDatabaseOutcomeSymbol = typeof S_DatabaseManager_GetDatabase_NotFound | typeof S_DatabaseManager_GetDatabase_Unknown;

package/database-manager/outcome.js

@@ -5,16 +5,16 @@
  * @description Outcome
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rebuildImbricateDatabaseManagerRemoveDatabaseSymbol = exports.ImbricateDatabaseManagerRemoveDatabaseOutcomeSymbolList = exports.S_DatabaseManager_RemoveDatabase_Unknown = exports.S_DatabaseManager_RemoveDatabase_NotFound = exports.rebuildImbricateDatabaseManagerCreateDatabaseSymbol = exports.ImbricateDatabaseManagerCreateDatabaseOutcomeSymbolList = exports.S_DatabaseManager_CreateDatabase_Unknown = exports.S_DatabaseManager_CreateDatabase_InvalidSchema = exports.S_DatabaseManager_CreateDatabase_DatabaseNameDuplicated = exports.S_DatabaseManager_CreateDatabase_IdentifierDuplicated = exports.rebuildImbricateDatabaseManagerGetDatabaseSymbol = exports.ImbricateDatabaseManagerGetDatabaseOutcomeSymbolList = exports.S_DatabaseManager_GetDatabase_Unknown = exports.S_DatabaseManager_GetDatabase_NotFound = exports.rebuildImbricateDatabaseManagerListDatabasesSymbol = exports.ImbricateDatabaseManagerListDatabasesOutcomeSymbolList = exports.S_DatabaseManager_ListDatabases_Unknown = exports.S_DatabaseManager_ListDatabases_Stale = void 0;
+exports.rebuildImbricateDatabaseManagerRemoveDatabaseSymbol = exports.ImbricateDatabaseManagerRemoveDatabaseOutcomeSymbolList = exports.S_DatabaseManager_RemoveDatabase_Unknown = exports.S_DatabaseManager_RemoveDatabase_NotFound = exports.rebuildImbricateDatabaseManagerCreateDatabaseSymbol = exports.ImbricateDatabaseManagerCreateDatabaseOutcomeSymbolList = exports.S_DatabaseManager_CreateDatabase_Unknown = exports.S_DatabaseManager_CreateDatabase_InvalidSchema = exports.S_DatabaseManager_CreateDatabase_DatabaseNameDuplicated = exports.S_DatabaseManager_CreateDatabase_IdentifierDuplicated = exports.rebuildImbricateDatabaseManagerGetDatabaseSymbol = exports.ImbricateDatabaseManagerGetDatabaseOutcomeSymbolList = exports.S_DatabaseManager_GetDatabase_Unknown = exports.S_DatabaseManager_GetDatabase_NotFound = exports.rebuildImbricateDatabaseManagerQueryDatabasesSymbol = exports.ImbricateDatabaseManagerQueryDatabasesOutcomeSymbolList = exports.S_DatabaseManager_QueryDatabases_Unknown = exports.S_DatabaseManager_QueryDatabases_Stale = void 0;
 const rebuild_symbol_1 = require("../util/rebuild-symbol");
-// Manager List Databases
-exports.S_DatabaseManager_ListDatabases_Stale = Symbol("DatabaseManager_ListDatabases_Stale");
-exports.S_DatabaseManager_ListDatabases_Unknown = Symbol("DatabaseManager_ListDatabases_Unknown");
-exports.ImbricateDatabaseManagerListDatabasesOutcomeSymbolList = [
-    exports.S_DatabaseManager_ListDatabases_Stale,
-    exports.S_DatabaseManager_ListDatabases_Unknown,
+// Manager Query Databases
+exports.S_DatabaseManager_QueryDatabases_Stale = Symbol("DatabaseManager_QueryDatabases_Stale");
+exports.S_DatabaseManager_QueryDatabases_Unknown = Symbol("DatabaseManager_QueryDatabases_Unknown");
+exports.ImbricateDatabaseManagerQueryDatabasesOutcomeSymbolList = [
+    exports.S_DatabaseManager_QueryDatabases_Stale,
+    exports.S_DatabaseManager_QueryDatabases_Unknown,
 ];
-exports.rebuildImbricateDatabaseManagerListDatabasesSymbol = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(exports.ImbricateDatabaseManagerListDatabasesOutcomeSymbolList, exports.S_DatabaseManager_ListDatabases_Unknown);
+exports.rebuildImbricateDatabaseManagerQueryDatabasesSymbol = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(exports.ImbricateDatabaseManagerQueryDatabasesOutcomeSymbolList, exports.S_DatabaseManager_QueryDatabases_Unknown);
 // Manager Get Database
 exports.S_DatabaseManager_GetDatabase_NotFound = Symbol("DatabaseManager_GetDatabase_NotFound");
 exports.S_DatabaseManager_GetDatabase_Unknown = Symbol("DatabaseManager_GetDatabase_Unknown");

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

@@ -0,0 +1,26 @@
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Full Feature
+ */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
+import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
+import { IImbricateDocument } from "../interface";
+import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
+import { DocumentProperties } from "../property";
+export declare abstract class ImbricateDocumentFullFeatureWithActionBase implements IImbricateDocument {
+    abstract readonly uniqueIdentifier: string;
+    abstract readonly documentVersion: string;
+    abstract readonly properties: DocumentProperties;
+    abstract readonly annotations: DocumentAnnotations;
+    readonly supportedFeatures: IMBRICATE_DOCUMENT_FEATURE[];
+    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>;
+    abstract getEditRecords(): Promise<ImbricateDocumentGetEditRecordsOutcome>;
+    abstract getOriginActions(): ImbricateOriginAction[];
+    abstract executeOriginAction(input: ImbricateOriginActionInput): Promise<ImbricateOriginActionOutcome>;
+}

package/document/base-class/full-feature-with-action.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Full Feature
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateDocumentFullFeatureWithActionBase = void 0;
+const feature_1 = require("../feature");
+class ImbricateDocumentFullFeatureWithActionBase {
+    constructor() {
+        this.supportedFeatures = [
+            feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY,
+            feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_ANNOTATION,
+            feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_DELETE_ANNOTATION,
+            feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_EDIT_RECORD,
+            feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_EDIT_RECORD,
+            feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_ORIGIN_ACTIONS,
+            feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_EXECUTE_ORIGIN_ACTION,
+        ];
+    }
+}
+exports.ImbricateDocumentFullFeatureWithActionBase = ImbricateDocumentFullFeatureWithActionBase;

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

@@ -3,12 +3,14 @@
  * @namespace Document
  * @description Full Feature
  */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
 import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "../outcome";
 import { DocumentProperties } from "../property";
-export declare abstract class ImbricateDocumentFullFeatureBase implements IImbricateDocument {
+import { ImbricateDocumentFullFeatureWithActionBase } from "./full-feature-with-action";
+export declare abstract class ImbricateDocumentFullFeatureBase extends ImbricateDocumentFullFeatureWithActionBase implements IImbricateDocument {
     abstract readonly uniqueIdentifier: string;
     abstract readonly documentVersion: string;
     abstract readonly properties: DocumentProperties;
@@ -20,4 +22,6 @@ export declare abstract class ImbricateDocumentFullFeatureBase implements IImbri
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;
     abstract getEditRecords(): Promise<ImbricateDocumentGetEditRecordsOutcome>;
+    getOriginActions(): ImbricateOriginAction[];
+    executeOriginAction(_input: ImbricateOriginActionInput): Promise<ImbricateOriginActionOutcome>;
 }

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

@@ -6,9 +6,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImbricateDocumentFullFeatureBase = void 0;
+const feature_not_supported_1 = require("../../error/document/feature-not-supported");
 const feature_1 = require("../feature");
-class ImbricateDocumentFullFeatureBase {
+const full_feature_with_action_1 = require("./full-feature-with-action");
+class ImbricateDocumentFullFeatureBase extends full_feature_with_action_1.ImbricateDocumentFullFeatureWithActionBase {
     constructor() {
+        super(...arguments);
         this.supportedFeatures = [
             feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_PROPERTY,
             feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_PUT_ANNOTATION,
@@ -17,5 +20,11 @@ class ImbricateDocumentFullFeatureBase {
             feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_EDIT_RECORD,
         ];
     }
+    getOriginActions() {
+        throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_ORIGIN_ACTIONS);
+    }
+    executeOriginAction(_input) {
+        throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_EXECUTE_ORIGIN_ACTION);
+    }
 }
 exports.ImbricateDocumentFullFeatureBase = ImbricateDocumentFullFeatureBase;

package/document/export.d.ts

@@ -9,6 +9,7 @@ export * from "./base-class/exclude-annotation";
 export * from "./base-class/exclude-edit-records";
 export * from "./base-class/full-feature";
 export * from "./base-class/full-feature-readonly";
+export * from "./base-class/full-feature-with-action";
 export * from "./definition";
 export * from "./feature";
 export * from "./interface";

package/document/export.js

@@ -25,6 +25,7 @@ __exportStar(require("./base-class/exclude-annotation"), exports);
 __exportStar(require("./base-class/exclude-edit-records"), exports);
 __exportStar(require("./base-class/full-feature"), exports);
 __exportStar(require("./base-class/full-feature-readonly"), exports);
+__exportStar(require("./base-class/full-feature-with-action"), exports);
 __exportStar(require("./definition"), exports);
 __exportStar(require("./feature"), exports);
 __exportStar(require("./interface"), exports);

package/document/feature.d.ts

@@ -8,6 +8,8 @@ export declare enum IMBRICATE_DOCUMENT_FEATURE {
     DOCUMENT_PUT_ANNOTATION = "DOCUMENT_PUT_ANNOTATION",
     DOCUMENT_DELETE_ANNOTATION = "DOCUMENT_DELETE_ANNOTATION",
     DOCUMENT_PUT_EDIT_RECORD = "DOCUMENT_PUT_EDIT_RECORD",
-    DOCUMENT_GET_EDIT_RECORD = "DOCUMENT_GET_EDIT_RECORD"
+    DOCUMENT_GET_EDIT_RECORD = "DOCUMENT_GET_EDIT_RECORD",
+    DOCUMENT_GET_ORIGIN_ACTIONS = "DOCUMENT_GET_ORIGIN_ACTIONS",
+    DOCUMENT_EXECUTE_ORIGIN_ACTION = "DOCUMENT_EXECUTE_ORIGIN_ACTION"
 }
 export declare const checkImbricateDocumentFeatureSupported: (features: IMBRICATE_DOCUMENT_FEATURE[], feature: IMBRICATE_DOCUMENT_FEATURE) => boolean;

package/document/feature.js

@@ -13,6 +13,8 @@ var IMBRICATE_DOCUMENT_FEATURE;
     IMBRICATE_DOCUMENT_FEATURE["DOCUMENT_DELETE_ANNOTATION"] = "DOCUMENT_DELETE_ANNOTATION";
     IMBRICATE_DOCUMENT_FEATURE["DOCUMENT_PUT_EDIT_RECORD"] = "DOCUMENT_PUT_EDIT_RECORD";
     IMBRICATE_DOCUMENT_FEATURE["DOCUMENT_GET_EDIT_RECORD"] = "DOCUMENT_GET_EDIT_RECORD";
+    IMBRICATE_DOCUMENT_FEATURE["DOCUMENT_GET_ORIGIN_ACTIONS"] = "DOCUMENT_GET_ORIGIN_ACTIONS";
+    IMBRICATE_DOCUMENT_FEATURE["DOCUMENT_EXECUTE_ORIGIN_ACTION"] = "DOCUMENT_EXECUTE_ORIGIN_ACTION";
 })(IMBRICATE_DOCUMENT_FEATURE || (exports.IMBRICATE_DOCUMENT_FEATURE = IMBRICATE_DOCUMENT_FEATURE = {}));
 const checkImbricateDocumentFeatureSupported = (features, feature) => {
     return features.includes(feature);

package/document/interface.d.ts

@@ -3,6 +3,7 @@
  * @namespace Document
  * @description Interface
  */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "./feature";
 import { ImbricateDocumentAddEditRecordsOutcome, ImbricateDocumentDeleteAnnotationOutcome, ImbricateDocumentGetEditRecordsOutcome, ImbricateDocumentPutAnnotationOutcome, ImbricateDocumentPutPropertyOutcome } from "./outcome";
@@ -106,4 +107,18 @@ export interface IImbricateDocument {
      *  Symbol: S_Document_GetEditRecords_NotFound - if the edit records are not found
      */
     getEditRecords(): PromiseLike<ImbricateDocumentGetEditRecordsOutcome>;
+    /**
+     * Get the document actions
+     *
+     * @returns the document actions
+     */
+    getOriginActions(): ImbricateOriginAction[];
+    /**
+     * Execute the document action
+     *
+     * @param input the input of the action
+     *
+     * @returns the result of the action
+     */
+    executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

package/index.d.ts

@@ -3,7 +3,7 @@
  * @description Index
  */
 export * from "./author/export";
-export * from "./common/outcome";
+export * from "./common/export";
 export * from "./database-manager/export";
 export * from "./database/export";
 export * from "./document/export";

package/index.js

@@ -19,7 +19,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./author/export"), exports);
-__exportStar(require("./common/outcome"), exports);
+__exportStar(require("./common/export"), exports);
 __exportStar(require("./database-manager/export"), exports);
 __exportStar(require("./database/export"), exports);
 __exportStar(require("./document/export"), exports);

package/origin/base-class/essential.js

@@ -13,12 +13,12 @@ class ImbricateOriginEssentialBase extends full_feature_1.ImbricateOriginFullFea
     constructor() {
         super(...arguments);
         this.supportedFeatures = [
-            feature_1.IMBRICATE_ORIGIN_FEATURE.DATABASE_MANAGER,
-            feature_1.IMBRICATE_ORIGIN_FEATURE.TEXT_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_DATABASE_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_TEXT_MANAGER,
         ];
     }
     getStaticManager() {
-        throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.STATIC_MANAGER);
+        throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_STATIC_MANAGER);
     }
     search(_keyword) {
         throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_SEARCH);

package/origin/base-class/exclude-static.js

@@ -13,13 +13,13 @@ class ImbricateOriginExcludeStaticBase extends full_feature_1.ImbricateOriginFul
     constructor() {
         super(...arguments);
         this.supportedFeatures = [
-            feature_1.IMBRICATE_ORIGIN_FEATURE.DATABASE_MANAGER,
-            feature_1.IMBRICATE_ORIGIN_FEATURE.TEXT_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_DATABASE_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_TEXT_MANAGER,
             feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_SEARCH,
         ];
     }
     getStaticManager() {
-        throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.STATIC_MANAGER);
+        throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_STATIC_MANAGER);
     }
 }
 exports.ImbricateOriginExcludeStaticBase = ImbricateOriginExcludeStaticBase;

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

@@ -0,0 +1,24 @@
+/**
+ * @author WMXPY
+ * @namespace Origin
+ * @description Full Feature
+ */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { IImbricateDatabaseManager } from "../../database-manager/database-manager";
+import { IImbricateStaticManager } from "../../static-manager/static-manager";
+import { IImbricateTextManager } from "../../text-manager/text-manager";
+import { OriginPayload } from "../definition";
+import { IMBRICATE_ORIGIN_FEATURE } from "../feature";
+import { IImbricateOrigin } from "../interface";
+import { ImbricateOriginSearchOutcome } from "../outcome";
+export declare abstract class ImbricateOriginFullFeatureWithActionBase implements IImbricateOrigin {
+    abstract readonly uniqueIdentifier: string;
+    abstract readonly payloads: OriginPayload;
+    readonly supportedFeatures: IMBRICATE_ORIGIN_FEATURE[];
+    abstract getDatabaseManager(): IImbricateDatabaseManager;
+    abstract getTextManager(): IImbricateTextManager;
+    abstract getStaticManager(): IImbricateStaticManager;
+    abstract search(keyword: string): PromiseLike<ImbricateOriginSearchOutcome>;
+    abstract getOriginActions(): ImbricateOriginAction[];
+    abstract executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
+}

package/origin/base-class/full-feature-with-action.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Origin
+ * @description Full Feature
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateOriginFullFeatureWithActionBase = void 0;
+const feature_1 = require("../feature");
+class ImbricateOriginFullFeatureWithActionBase {
+    constructor() {
+        this.supportedFeatures = [
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_DATABASE_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_TEXT_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_STATIC_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_SEARCH,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_GET_ORIGIN_ACTIONS,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_EXECUTE_ORIGIN_ACTION,
+        ];
+    }
+}
+exports.ImbricateOriginFullFeatureWithActionBase = ImbricateOriginFullFeatureWithActionBase;

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

@@ -3,19 +3,14 @@
  * @namespace Origin
  * @description Full Feature
  */
-import { IImbricateDatabaseManager } from "../../database-manager/database-manager";
-import { IImbricateStaticManager } from "../../static-manager/static-manager";
-import { IImbricateTextManager } from "../../text-manager/text-manager";
-import { OriginPayload } from "../definition";
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { IMBRICATE_ORIGIN_FEATURE } from "../feature";
 import { IImbricateOrigin } from "../interface";
 import { ImbricateOriginSearchOutcome } from "../outcome";
-export declare abstract class ImbricateOriginFullFeatureBase implements IImbricateOrigin {
-    abstract readonly uniqueIdentifier: string;
-    abstract readonly payloads: OriginPayload;
+import { ImbricateOriginFullFeatureWithActionBase } from "./full-feature-with-action";
+export declare abstract class ImbricateOriginFullFeatureBase extends ImbricateOriginFullFeatureWithActionBase implements IImbricateOrigin {
     readonly supportedFeatures: IMBRICATE_ORIGIN_FEATURE[];
-    abstract getDatabaseManager(): IImbricateDatabaseManager;
-    abstract getTextManager(): IImbricateTextManager;
-    abstract getStaticManager(): IImbricateStaticManager;
     abstract search(keyword: string): PromiseLike<ImbricateOriginSearchOutcome>;
+    getOriginActions(): ImbricateOriginAction[];
+    executeOriginAction(_input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

package/origin/base-class/full-feature.js

@@ -6,15 +6,24 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImbricateOriginFullFeatureBase = void 0;
+const feature_not_supported_1 = require("../../error/origin/feature-not-supported");
 const feature_1 = require("../feature");
-class ImbricateOriginFullFeatureBase {
+const full_feature_with_action_1 = require("./full-feature-with-action");
+class ImbricateOriginFullFeatureBase extends full_feature_with_action_1.ImbricateOriginFullFeatureWithActionBase {
     constructor() {
+        super(...arguments);
         this.supportedFeatures = [
-            feature_1.IMBRICATE_ORIGIN_FEATURE.DATABASE_MANAGER,
-            feature_1.IMBRICATE_ORIGIN_FEATURE.TEXT_MANAGER,
-            feature_1.IMBRICATE_ORIGIN_FEATURE.STATIC_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_DATABASE_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_TEXT_MANAGER,
+            feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_STATIC_MANAGER,
             feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_SEARCH,
         ];
     }
+    getOriginActions() {
+        throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_GET_ORIGIN_ACTIONS);
+    }
+    executeOriginAction(_input) {
+        throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_EXECUTE_ORIGIN_ACTION);
+    }
 }
 exports.ImbricateOriginFullFeatureBase = ImbricateOriginFullFeatureBase;

package/origin/export.d.ts

@@ -6,6 +6,7 @@
 export * from "./base-class/essential";
 export * from "./base-class/exclude-static";
 export * from "./base-class/full-feature";
+export * from "./base-class/full-feature-with-action";
 export * from "./definition";
 export * from "./interface";
 export * from "./outcome";

package/origin/export.js

@@ -22,6 +22,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./base-class/essential"), exports);
 __exportStar(require("./base-class/exclude-static"), exports);
 __exportStar(require("./base-class/full-feature"), exports);
+__exportStar(require("./base-class/full-feature-with-action"), exports);
 __exportStar(require("./definition"), exports);
 __exportStar(require("./interface"), exports);
 __exportStar(require("./outcome"), exports);

package/origin/feature.d.ts

@@ -4,9 +4,11 @@
  * @description Feature
  */
 export declare enum IMBRICATE_ORIGIN_FEATURE {
-    DATABASE_MANAGER = "DATABASE_MANAGER",
-    TEXT_MANAGER = "TEXT_MANAGER",
-    STATIC_MANAGER = "STATIC_MANAGER",
-    ORIGIN_SEARCH = "ORIGIN_SEARCH"
+    ORIGIN_DATABASE_MANAGER = "ORIGIN_DATABASE_MANAGER",
+    ORIGIN_TEXT_MANAGER = "ORIGIN_TEXT_MANAGER",
+    ORIGIN_STATIC_MANAGER = "ORIGIN_STATIC_MANAGER",
+    ORIGIN_SEARCH = "ORIGIN_SEARCH",
+    ORIGIN_GET_ORIGIN_ACTIONS = "ORIGIN_GET_ORIGIN_ACTIONS",
+    ORIGIN_EXECUTE_ORIGIN_ACTION = "ORIGIN_EXECUTE_ORIGIN_ACTION"
 }
 export declare const checkImbricateOriginFeatureSupported: (features: IMBRICATE_ORIGIN_FEATURE[], feature: IMBRICATE_ORIGIN_FEATURE) => boolean;

package/origin/feature.js

@@ -8,10 +8,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkImbricateOriginFeatureSupported = exports.IMBRICATE_ORIGIN_FEATURE = void 0;
 var IMBRICATE_ORIGIN_FEATURE;
 (function (IMBRICATE_ORIGIN_FEATURE) {
-    IMBRICATE_ORIGIN_FEATURE["DATABASE_MANAGER"] = "DATABASE_MANAGER";
-    IMBRICATE_ORIGIN_FEATURE["TEXT_MANAGER"] = "TEXT_MANAGER";
-    IMBRICATE_ORIGIN_FEATURE["STATIC_MANAGER"] = "STATIC_MANAGER";
+    IMBRICATE_ORIGIN_FEATURE["ORIGIN_DATABASE_MANAGER"] = "ORIGIN_DATABASE_MANAGER";
+    IMBRICATE_ORIGIN_FEATURE["ORIGIN_TEXT_MANAGER"] = "ORIGIN_TEXT_MANAGER";
+    IMBRICATE_ORIGIN_FEATURE["ORIGIN_STATIC_MANAGER"] = "ORIGIN_STATIC_MANAGER";
     IMBRICATE_ORIGIN_FEATURE["ORIGIN_SEARCH"] = "ORIGIN_SEARCH";
+    IMBRICATE_ORIGIN_FEATURE["ORIGIN_GET_ORIGIN_ACTIONS"] = "ORIGIN_GET_ORIGIN_ACTIONS";
+    IMBRICATE_ORIGIN_FEATURE["ORIGIN_EXECUTE_ORIGIN_ACTION"] = "ORIGIN_EXECUTE_ORIGIN_ACTION";
 })(IMBRICATE_ORIGIN_FEATURE || (exports.IMBRICATE_ORIGIN_FEATURE = IMBRICATE_ORIGIN_FEATURE = {}));
 const checkImbricateOriginFeatureSupported = (features, feature) => {
     return features.includes(feature);

package/origin/interface.d.ts

@@ -3,6 +3,7 @@
  * @namespace Origin
  * @description Interface
  */
+import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
 import { IImbricateDatabaseManager } from "../database-manager/database-manager";
 import { IImbricateStaticManager } from "../static-manager/static-manager";
 import { IImbricateTextManager } from "../text-manager/text-manager";
@@ -61,4 +62,18 @@ export interface IImbricateOrigin {
      *  Symbol: S_Origin_Search_InvalidKeyword - if the keyword is invalid
      */
     search(keyword: string): PromiseLike<ImbricateOriginSearchOutcome>;
+    /**
+     * Get the origin actions
+     *
+     * @returns the origin actions
+     */
+    getOriginActions(): ImbricateOriginAction[];
+    /**
+     * Execute the origin action
+     *
+     * @param input the input of the action
+     *
+     * @returns the result of the action
+     */
+    executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "3.17.0",
+  "version": "3.18.0",
   "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",
@@ -17,5 +17,9 @@
   "bugs": {
     "url": "https://github.com/Imbricate/Imbricate/issues"
   },
-  "homepage": "https://imbricate.io"
+  "homepage": "https://imbricate.io",
+  "dependencies": {
+    "@sudoo/locale": "^2.0.0",
+    "@sudoo/magic": "^1.9.0"
+  }
 }