@imbricate/core 2.3.0 → 2.4.0

package/author/definition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @author WMXPY
+ * @namespace Author
+ * @description Definition
+ */
+export type ImbricateAuthorAttributes = Record<string, string>;
+export type ImbricateAuthor = {
+    readonly avatar?: string;
+    readonly displayName?: string;
+    readonly identifier: string;
+    readonly attributes: ImbricateAuthorAttributes;
+};

package/author/definition.js

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

package/collection/base.d.ts

@@ -29,4 +29,5 @@ export declare abstract class ImbricateCollectionBase implements IImbricateColle
     listDirectories(_directories: string[]): PromiseOr<string[]>;
     searchPages(_keyword: string, _config: ImbricateSearchPageConfig): PromiseOr<ImbricatePageSearchResult[]>;
     queryPages(_query: ImbricatePageQuery, _config: ImbricatePageQueryConfig): PromiseOr<IImbricatePage[]>;
+    listSupportedVariants(): Promise<ImbricatePageVariant[]>;
 }

package/collection/base.js

@@ -50,5 +50,8 @@ class ImbricateCollectionBase {
     queryPages(_query, _config) {
         throw not_implemented_1.ImbricateNotImplemented.create("QueryPages", definition_2.IMBRICATE_COLLECTION_CAPABILITY_KEY.LIST_PAGES);
     }
+    listSupportedVariants() {
+        throw not_implemented_1.ImbricateNotImplemented.create("ListSupportedVariants", definition_2.IMBRICATE_COLLECTION_CAPABILITY_KEY.LIST_SUPPORTED_VARIANTS);
+    }
 }
 exports.ImbricateCollectionBase = ImbricateCollectionBase;

package/collection/definition.d.ts

@@ -11,6 +11,7 @@ export declare enum IMBRICATE_COLLECTION_CAPABILITY_KEY {
     RETITLE_PAGE = "imbricate.collection.page.retitle",
     DELETE_PAGE = "imbricate.collection.page.delete",
     GET_PAGE = "imbricate.collection.page.get",
-    LIST_PAGES = "imbricate.collection.page.list"
+    LIST_PAGES = "imbricate.collection.page.list",
+    LIST_SUPPORTED_VARIANTS = "imbricate.collection.page.list-supported-variants"
 }
 export declare const ImbricateCollectionCapabilityList: IMBRICATE_COLLECTION_CAPABILITY_KEY[];

package/collection/definition.js

@@ -14,6 +14,7 @@ var IMBRICATE_COLLECTION_CAPABILITY_KEY;
     IMBRICATE_COLLECTION_CAPABILITY_KEY["DELETE_PAGE"] = "imbricate.collection.page.delete";
     IMBRICATE_COLLECTION_CAPABILITY_KEY["GET_PAGE"] = "imbricate.collection.page.get";
     IMBRICATE_COLLECTION_CAPABILITY_KEY["LIST_PAGES"] = "imbricate.collection.page.list";
+    IMBRICATE_COLLECTION_CAPABILITY_KEY["LIST_SUPPORTED_VARIANTS"] = "imbricate.collection.page.list-supported-variants";
 })(IMBRICATE_COLLECTION_CAPABILITY_KEY || (exports.IMBRICATE_COLLECTION_CAPABILITY_KEY = IMBRICATE_COLLECTION_CAPABILITY_KEY = {}));
 exports.ImbricateCollectionCapabilityList = [
     IMBRICATE_COLLECTION_CAPABILITY_KEY.CREATE_PAGE,
@@ -22,4 +23,5 @@ exports.ImbricateCollectionCapabilityList = [
     IMBRICATE_COLLECTION_CAPABILITY_KEY.DELETE_PAGE,
     IMBRICATE_COLLECTION_CAPABILITY_KEY.GET_PAGE,
     IMBRICATE_COLLECTION_CAPABILITY_KEY.LIST_PAGES,
+    IMBRICATE_COLLECTION_CAPABILITY_KEY.LIST_SUPPORTED_VARIANTS,
 ];

package/collection/interface.d.ts

@@ -24,4 +24,5 @@ export interface IImbricateCollection {
     listDirectories(directories: string[]): PromiseOr<string[]>;
     searchPages(keyword: string, config: ImbricateSearchPageConfig): PromiseOr<ImbricatePageSearchResult[]>;
     queryPages(query: ImbricatePageQuery, config: ImbricatePageQueryConfig): PromiseOr<IImbricatePage[]>;
+    listSupportedVariants(): PromiseOr<ImbricatePageVariant[]>;
 }

package/index.d.ts

@@ -2,6 +2,7 @@
  * @author WMXPY
  * @description Index
  */
+export * from "./author/definition";
 export * from "./binary-storage/base";
 export * from "./binary-storage/definition";
 export * from "./binary-storage/interface";

package/index.js

@@ -18,6 +18,7 @@ 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("./author/definition"), exports);
 __exportStar(require("./binary-storage/base"), exports);
 __exportStar(require("./binary-storage/definition"), exports);
 __exportStar(require("./binary-storage/interface"), exports);

package/package.json

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

package/page/definition.d.ts

@@ -3,6 +3,7 @@
  * @namespace Page
  * @description Definition
  */
+import { ImbricateAuthor } from "../author/definition";
 import { ImbricateCapability } from "../capability/definition";
 import { ImbricatePageVariant } from "../page-variant/definition";
 import { IMBRICATE_SEARCH_RESULT_TYPE, ImbricateSearchResult, ImbricateSearchSnippet } from "../search/snippet";
@@ -16,7 +17,7 @@ export type ImbricatePageSnapshot = {
     readonly variant: ImbricatePageVariant;
 };
 export type ImbricatePageHistoryRecord = {
-    readonly author: string;
+    readonly author: ImbricateAuthor;
     readonly digest: string;
     readonly updatedAt: Date;
 };

package/script/definition.d.ts

@@ -3,6 +3,7 @@
  * @namespace Script
  * @description Definition
  */
+import { ImbricateAuthor } from "../author/definition";
 import { ImbricateCapability } from "../capability/definition";
 import { ImbricateScriptVariant } from "../script-variant/definition";
 import { IMBRICATE_SEARCH_RESULT_TYPE, ImbricateSearchResult, ImbricateSearchSnippet } from "../search/snippet";
@@ -15,7 +16,7 @@ export type ImbricateScriptSnapshot = {
     readonly variant: ImbricateScriptVariant;
 };
 export type ImbricateScriptHistoryRecord = {
-    readonly author: string;
+    readonly author: ImbricateAuthor;
     readonly digest: string;
     readonly updatedAt: Date;
 };

package/script-manager/base.d.ts

@@ -26,4 +26,5 @@ export declare abstract class ImbricateScriptManagerBase implements IImbricateSc
     listScripts(): PromiseOr<ImbricateScriptSnapshot[]>;
     searchScripts(_keyword: string, _config: ImbricateSearchScriptConfig): PromiseOr<ImbricateScriptSearchResult[]>;
     queryScripts(_query: ImbricateScriptQuery, _config: ImbricateScriptQueryConfig): PromiseOr<IImbricateScript[]>;
+    listSupportedVariants(): Promise<ImbricateScriptVariant[]>;
 }

package/script-manager/base.js

@@ -47,5 +47,8 @@ class ImbricateScriptManagerBase {
     queryScripts(_query, _config) {
         throw not_implemented_1.ImbricateNotImplemented.create("QueryScripts", definition_2.IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.LIST_SCRIPTS);
     }
+    listSupportedVariants() {
+        throw not_implemented_1.ImbricateNotImplemented.create("ListSupportedVariants", definition_2.IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.LIST_SUPPORTED_VARIANTS);
+    }
 }
 exports.ImbricateScriptManagerBase = ImbricateScriptManagerBase;

package/script-manager/definition.d.ts

@@ -12,6 +12,7 @@ export declare enum IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY {
     DELETE_SCRIPT = "imbricate.script-manager.delete",
     GET_SCRIPT = "imbricate.script-manager.get",
     LIST_SCRIPTS = "imbricate.script-manager.list",
-    EXECUTE_SCRIPT_SNIPPET = "imbricate.script-manager.execute-script-snippet"
+    EXECUTE_SCRIPT_SNIPPET = "imbricate.script-manager.execute-script-snippet",
+    LIST_SUPPORTED_VARIANTS = "imbricate.script-manager.list-supported-variants"
 }
 export declare const ImbricateScriptManagerCapabilityList: IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY[];

package/script-manager/definition.js

@@ -15,6 +15,7 @@ var IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY;
     IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY["GET_SCRIPT"] = "imbricate.script-manager.get";
     IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY["LIST_SCRIPTS"] = "imbricate.script-manager.list";
     IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY["EXECUTE_SCRIPT_SNIPPET"] = "imbricate.script-manager.execute-script-snippet";
+    IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY["LIST_SUPPORTED_VARIANTS"] = "imbricate.script-manager.list-supported-variants";
 })(IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY || (exports.IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY = IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY = {}));
 exports.ImbricateScriptManagerCapabilityList = [
     IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.CREATE_SCRIPT,
@@ -24,4 +25,5 @@ exports.ImbricateScriptManagerCapabilityList = [
     IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.GET_SCRIPT,
     IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.LIST_SCRIPTS,
     IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.EXECUTE_SCRIPT_SNIPPET,
+    IMBRICATE_SCRIPT_MANAGER_CAPABILITY_KEY.LIST_SUPPORTED_VARIANTS,
 ];

package/script-manager/interface.d.ts

@@ -40,4 +40,5 @@ export interface IImbricateScriptManager {
     listScripts(): PromiseOr<ImbricateScriptSnapshot[]>;
     searchScripts(keyword: string, config: ImbricateSearchScriptConfig): PromiseOr<ImbricateScriptSearchResult[]>;
     queryScripts(query: ImbricateScriptQuery, config: ImbricateScriptQueryConfig): PromiseOr<IImbricateScript[]>;
+    listSupportedVariants(): PromiseOr<ImbricateScriptVariant[]>;
 }