@imbricate/core 3.18.0 → 3.19.1

package/common/action.d.ts

@@ -14,7 +14,8 @@ export type ImbricateOriginActionParameterType = {
 };
 export type ImbricateOriginActionParameter = {
     readonly parameterKey: string;
-    readonly getParameterName: (locale: IETF_LOCALE) => string;
+    readonly parameterName: Record<IETF_LOCALE, string>;
+    readonly parameterDescription: Record<IETF_LOCALE, string>;
     readonly parameterType: ImbricateOriginActionParameterType;
 };
 export declare enum IMBRICATE_ORIGIN_ACTION_APPEARANCE {
@@ -26,7 +27,8 @@ export declare enum IMBRICATE_ORIGIN_ACTION_APPEARANCE {
 }
 export type ImbricateOriginAction = {
     readonly actionIdentifier: string;
-    readonly getActionName: (locale: IETF_LOCALE) => string;
+    readonly actionName: Record<IETF_LOCALE, string>;
+    readonly actionDescription: Record<IETF_LOCALE, string>;
     readonly parameters: ImbricateOriginActionParameter[];
     readonly appearance?: IMBRICATE_ORIGIN_ACTION_APPEARANCE;
     readonly disabled?: boolean;
@@ -44,3 +46,16 @@ export type ImbricateOriginActionOutcome = {
     readonly outputs: ImbricateOriginActionResultOutput[];
     readonly references: ImbricateOriginActionResultReference[];
 } | CommonOutcomeSymbol | CommonActionOutcomeSymbol;
+export declare const S_Common_QueryOriginActions_Stale: unique symbol;
+export declare const S_Common_QueryOriginActions_Unknown: unique symbol;
+export type ImbricateCommonQueryOriginActionsOutcomeSymbol = typeof S_Common_QueryOriginActions_Stale | typeof S_Common_QueryOriginActions_Unknown;
+export declare const ImbricateCommonQueryOriginActionsOutcomeSymbolList: ImbricateCommonQueryOriginActionsOutcomeSymbol[];
+export declare const rebuildImbricateCommonQueryOriginActionsSymbol: (symbolDescription: string) => CommonOutcomeSymbol | ImbricateCommonQueryOriginActionsOutcomeSymbol;
+export type ImbricateCommonQueryOriginActionsOutcome = {
+    readonly actions: ImbricateOriginAction[];
+    readonly count: number;
+} | CommonOutcomeSymbol | ImbricateCommonQueryOriginActionsOutcomeSymbol;
+export type ImbricateCommonQueryOriginActionsQuery = {
+    readonly limit?: number;
+    readonly skip?: number;
+};

package/common/action.js

@@ -5,7 +5,8 @@
  * @description Action
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-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.IMBRICATE_ORIGIN_ACTION_APPEARANCE = exports.IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE = void 0;
+const rebuild_symbol_1 = require("../util/rebuild-symbol");
 var IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE;
 (function (IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE) {
     IMBRICATE_ORIGIN_ACTION_PARAMETER_TYPE["STRING"] = "STRING";
@@ -18,3 +19,11 @@ var IMBRICATE_ORIGIN_ACTION_APPEARANCE;
     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 = {}));
+// Query Origin Actions
+exports.S_Common_QueryOriginActions_Stale = Symbol("Common_QueryOriginActions_Stale");
+exports.S_Common_QueryOriginActions_Unknown = Symbol("Common_QueryOriginActions_Unknown");
+exports.ImbricateCommonQueryOriginActionsOutcomeSymbolList = [
+    exports.S_Common_QueryOriginActions_Stale,
+    exports.S_Common_QueryOriginActions_Unknown,
+];
+exports.rebuildImbricateCommonQueryOriginActionsSymbol = (0, rebuild_symbol_1.createRebuildImbricateSymbolFunction)(exports.ImbricateCommonQueryOriginActionsOutcomeSymbolList, exports.S_Common_QueryOriginActions_Unknown);

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

@@ -3,7 +3,7 @@
  * @namespace Database_BaseClass
  * @description Full Feature With Action
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { DocumentProperties } from "../../document/property";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
 import { IMBRICATE_DATABASE_FEATURE } from "../feature";
@@ -27,6 +27,6 @@ export declare abstract class ImbricateDatabaseFullFeatureWithActionBase impleme
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DatabaseEditRecord[]): PromiseLike<ImbricateDatabaseAddEditRecordsOutcome>;
     abstract getEditRecords(): PromiseLike<ImbricateDatabaseGetEditRecordsOutcome>;
-    abstract getOriginActions(): ImbricateOriginAction[];
+    abstract queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     abstract executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

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

@@ -3,7 +3,7 @@
  * @namespace Database_BaseClass
  * @description Full Feature
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { DocumentProperties } from "../../document/property";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "../definition";
 import { IMBRICATE_DATABASE_FEATURE } from "../feature";
@@ -28,6 +28,6 @@ export declare abstract class ImbricateDatabaseFullFeatureBase extends Imbricate
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<ImbricateDatabaseDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DatabaseEditRecord[]): PromiseLike<ImbricateDatabaseAddEditRecordsOutcome>;
     abstract getEditRecords(): PromiseLike<ImbricateDatabaseGetEditRecordsOutcome>;
-    getOriginActions(): ImbricateOriginAction[];
+    queryOriginActions(_query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     executeOriginAction(_input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

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

@@ -23,7 +23,7 @@ class ImbricateDatabaseFullFeatureBase extends full_feature_with_action_1.Imbric
             feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_GET_EDIT_RECORD,
         ];
     }
-    getOriginActions() {
+    queryOriginActions(_query) {
         throw feature_not_supported_1.ImbricateDatabaseFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DATABASE_FEATURE.DATABASE_GET_ORIGIN_ACTIONS);
     }
     executeOriginAction(_input) {

package/database/interface.d.ts

@@ -3,7 +3,7 @@
  * @namespace Database
  * @description Interface
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
 import { DocumentProperties } from "../document/property";
 import { DatabaseAnnotationValue, DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
 import { IMBRICATE_DATABASE_FEATURE } from "./feature";
@@ -160,11 +160,15 @@ export interface IImbricateDatabase {
      */
     getEditRecords(): PromiseLike<ImbricateDatabaseGetEditRecordsOutcome>;
     /**
-     * Get the database actions
+     * Query the database actions
+     *
+     * @param query the query of the database actions
      *
      * @returns the database actions
+     *  Symbol: S_Common_QueryOriginActions_Stale - if the database actions are stale
+     *  Symbol: S_Common_QueryOriginActions_Unknown - if the database actions are unknown
      */
-    getOriginActions(): ImbricateOriginAction[];
+    queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     /**
      * Execute the database action
      *

package/database/outcome.d.ts

@@ -40,6 +40,7 @@ export declare const ImbricateDatabaseQueryDocumentsOutcomeSymbolList: Imbricate
 export declare const rebuildImbricateDatabaseQueryDocumentsSymbol: (symbolDescription: string) => CommonOutcomeSymbol | ImbricateDatabaseQueryDocumentsOutcomeSymbol;
 export type ImbricateDatabaseQueryDocumentsOutcome = {
     readonly documents: IImbricateDocument[];
+    readonly count: number;
 } | CommonOutcomeSymbol | ImbricateDatabaseQueryDocumentsOutcomeSymbol;
 export declare const S_Database_CountDocuments_Stale: unique symbol;
 export declare const S_Database_CountDocuments_Unknown: unique symbol;

package/database-manager/outcome.d.ts

@@ -12,6 +12,7 @@ export declare const ImbricateDatabaseManagerQueryDatabasesOutcomeSymbolList: Im
 export declare const rebuildImbricateDatabaseManagerQueryDatabasesSymbol: (symbolDescription: string) => CommonOutcomeSymbol | ImbricateDatabaseManagerQueryDatabasesOutcomeSymbol;
 export type ImbricateDatabaseManagerQueryDatabasesOutcome = {
     readonly databases: IImbricateDatabase[];
+    readonly count: number;
 } | CommonOutcomeSymbol | ImbricateDatabaseManagerQueryDatabasesOutcomeSymbol;
 export declare const S_DatabaseManager_GetDatabase_NotFound: unique symbol;
 export declare const S_DatabaseManager_GetDatabase_Unknown: unique symbol;

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

@@ -3,7 +3,7 @@
  * @namespace Document
  * @description Full Feature
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
@@ -21,6 +21,6 @@ export declare abstract class ImbricateDocumentFullFeatureWithActionBase impleme
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;
     abstract getEditRecords(): Promise<ImbricateDocumentGetEditRecordsOutcome>;
-    abstract getOriginActions(): ImbricateOriginAction[];
+    abstract queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     abstract executeOriginAction(input: ImbricateOriginActionInput): Promise<ImbricateOriginActionOutcome>;
 }

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

@@ -3,7 +3,7 @@
  * @namespace Document
  * @description Full Feature
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { DocumentAnnotationValue, DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "../definition";
 import { IMBRICATE_DOCUMENT_FEATURE } from "../feature";
 import { IImbricateDocument } from "../interface";
@@ -22,6 +22,6 @@ export declare abstract class ImbricateDocumentFullFeatureBase extends Imbricate
     abstract deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): Promise<ImbricateDocumentDeleteAnnotationOutcome>;
     abstract addEditRecords(records: DocumentEditRecord[]): Promise<ImbricateDocumentAddEditRecordsOutcome>;
     abstract getEditRecords(): Promise<ImbricateDocumentGetEditRecordsOutcome>;
-    getOriginActions(): ImbricateOriginAction[];
+    queryOriginActions(_query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     executeOriginAction(_input: ImbricateOriginActionInput): Promise<ImbricateOriginActionOutcome>;
 }

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

@@ -20,7 +20,7 @@ class ImbricateDocumentFullFeatureBase extends full_feature_with_action_1.Imbric
             feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_EDIT_RECORD,
         ];
     }
-    getOriginActions() {
+    queryOriginActions(_query) {
         throw feature_not_supported_1.ImbricateDocumentFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_DOCUMENT_FEATURE.DOCUMENT_GET_ORIGIN_ACTIONS);
     }
     executeOriginAction(_input) {

package/document/interface.d.ts

@@ -3,7 +3,7 @@
  * @namespace Document
  * @description Interface
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, 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";
@@ -108,11 +108,15 @@ export interface IImbricateDocument {
      */
     getEditRecords(): PromiseLike<ImbricateDocumentGetEditRecordsOutcome>;
     /**
-     * Get the document actions
+     * Query the document actions
+     *
+     * @param query the query of the document actions
      *
      * @returns the document actions
+     *  Symbol: S_Common_QueryOriginActions_Stale - if the document actions are stale
+     *  Symbol: S_Common_QueryOriginActions_Unknown - if the document actions are unknown
      */
-    getOriginActions(): ImbricateOriginAction[];
+    queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     /**
      * Execute the document action
      *

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

@@ -3,7 +3,7 @@
  * @namespace Origin
  * @description Full Feature
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, 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";
@@ -19,6 +19,6 @@ export declare abstract class ImbricateOriginFullFeatureWithActionBase implement
     abstract getTextManager(): IImbricateTextManager;
     abstract getStaticManager(): IImbricateStaticManager;
     abstract search(keyword: string): PromiseLike<ImbricateOriginSearchOutcome>;
-    abstract getOriginActions(): ImbricateOriginAction[];
+    abstract queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     abstract executeOriginAction(input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

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

@@ -3,7 +3,7 @@
  * @namespace Origin
  * @description Full Feature
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../../common/action";
 import { IMBRICATE_ORIGIN_FEATURE } from "../feature";
 import { IImbricateOrigin } from "../interface";
 import { ImbricateOriginSearchOutcome } from "../outcome";
@@ -11,6 +11,6 @@ import { ImbricateOriginFullFeatureWithActionBase } from "./full-feature-with-ac
 export declare abstract class ImbricateOriginFullFeatureBase extends ImbricateOriginFullFeatureWithActionBase implements IImbricateOrigin {
     readonly supportedFeatures: IMBRICATE_ORIGIN_FEATURE[];
     abstract search(keyword: string): PromiseLike<ImbricateOriginSearchOutcome>;
-    getOriginActions(): ImbricateOriginAction[];
+    queryOriginActions(_query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     executeOriginAction(_input: ImbricateOriginActionInput): PromiseLike<ImbricateOriginActionOutcome>;
 }

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

@@ -19,7 +19,7 @@ class ImbricateOriginFullFeatureBase extends full_feature_with_action_1.Imbricat
             feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_SEARCH,
         ];
     }
-    getOriginActions() {
+    queryOriginActions(_query) {
         throw feature_not_supported_1.ImbricateOriginFeatureNotSupportedError.withFeature(feature_1.IMBRICATE_ORIGIN_FEATURE.ORIGIN_GET_ORIGIN_ACTIONS);
     }
     executeOriginAction(_input) {

package/origin/interface.d.ts

@@ -3,7 +3,7 @@
  * @namespace Origin
  * @description Interface
  */
-import { ImbricateOriginAction, ImbricateOriginActionInput, ImbricateOriginActionOutcome } from "../common/action";
+import { ImbricateCommonQueryOriginActionsOutcome, ImbricateCommonQueryOriginActionsQuery, 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";
@@ -63,11 +63,15 @@ export interface IImbricateOrigin {
      */
     search(keyword: string): PromiseLike<ImbricateOriginSearchOutcome>;
     /**
-     * Get the origin actions
+     * Query the origin actions
+     *
+     * @param query the query of the origin actions
      *
      * @returns the origin actions
+     *  Symbol: S_Common_QueryOriginActions_Stale - if the origin actions are stale
+     *  Symbol: S_Common_QueryOriginActions_Unknown - if the origin actions are unknown
      */
-    getOriginActions(): ImbricateOriginAction[];
+    queryOriginActions(query: ImbricateCommonQueryOriginActionsQuery): PromiseLike<ImbricateCommonQueryOriginActionsOutcome>;
     /**
      * Execute the origin action
      *

package/package.json

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