@imbricate/core 1.16.1 → 1.17.0

package/capability/definition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @author WMXPY
+ * @namespace Capability
+ * @description Definition
+ */
+export declare enum IMBRICATE_CAPABILITY_EFFECT {
+    ALLOW = "ALLOW",
+    DENY = "DENY"
+}
+export type ImbricateCapability = {
+    readonly effect: IMBRICATE_CAPABILITY_EFFECT;
+};

package/capability/definition.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Capability
+ * @description Definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_CAPABILITY_EFFECT = void 0;
+var IMBRICATE_CAPABILITY_EFFECT;
+(function (IMBRICATE_CAPABILITY_EFFECT) {
+    IMBRICATE_CAPABILITY_EFFECT["ALLOW"] = "ALLOW";
+    IMBRICATE_CAPABILITY_EFFECT["DENY"] = "DENY";
+})(IMBRICATE_CAPABILITY_EFFECT || (exports.IMBRICATE_CAPABILITY_EFFECT = IMBRICATE_CAPABILITY_EFFECT = {}));

package/collection/definition.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @author WMXPY
+ * @namespace Collection
+ * @description Definition
+ */
+import { ImbricateCapability } from "../capability/definition";
+export type ImbricateCollectionCapability = Record<IMBRICATE_COLLECTION_CAPABILITY_KEY, ImbricateCapability>;
+export declare enum IMBRICATE_COLLECTION_CAPABILITY_KEY {
+    CREATE_PAGE = "imbricate.collection.page.create",
+    PUT_PAGE = "imbricate.collection.page.put",
+    RETITLE_PAGE = "imbricate.collection.page.retitle",
+    DELETE_PAGE = "imbricate.collection.page.delete",
+    GET_PAGE = "imbricate.collection.page.get",
+    LIST_PAGES = "imbricate.collection.page.list"
+}

package/collection/definition.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Collection
+ * @description Definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_COLLECTION_CAPABILITY_KEY = void 0;
+var IMBRICATE_COLLECTION_CAPABILITY_KEY;
+(function (IMBRICATE_COLLECTION_CAPABILITY_KEY) {
+    IMBRICATE_COLLECTION_CAPABILITY_KEY["CREATE_PAGE"] = "imbricate.collection.page.create";
+    IMBRICATE_COLLECTION_CAPABILITY_KEY["PUT_PAGE"] = "imbricate.collection.page.put";
+    IMBRICATE_COLLECTION_CAPABILITY_KEY["RETITLE_PAGE"] = "imbricate.collection.page.retitle";
+    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 || (exports.IMBRICATE_COLLECTION_CAPABILITY_KEY = IMBRICATE_COLLECTION_CAPABILITY_KEY = {}));

package/collection/interface.d.ts

@@ -7,10 +7,11 @@ import { PromiseOr } from "../definition/promise";
 import { ImbricatePageMetadata, ImbricatePageSearchResult, ImbricatePageSnapshot } from "../page/definition";
 import { IImbricatePage } from "../page/interface";
 import { ImbricatePageQuery, ImbricatePageQueryConfig, ImbricateSearchPageConfig } from "../query/page";
+import { ImbricateCollectionCapability } from "./definition";
 export interface IImbricateOriginCollection {
     readonly collectionName: string;
     readonly description?: string;
-    readonly includeInSearch: boolean;
+    readonly capabilities: ImbricateCollectionCapability;
     createPage(directories: string[], title: string, initialContent: string): PromiseOr<IImbricatePage>;
     putPage(pageMetadata: ImbricatePageMetadata, content: string): PromiseOr<IImbricatePage>;
     retitlePage(identifier: string, newTitle: string): PromiseOr<void>;

package/index.d.ts

@@ -2,6 +2,8 @@
  * @author WMXPY
  * @description Index
  */
+export * from "./capability/definition";
+export * from "./collection/definition";
 export * from "./collection/interface";
 export * from "./collection/least-common-identifier";
 export * from "./definition/listable";

package/index.js

@@ -18,6 +18,8 @@ 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("./capability/definition"), exports);
+__exportStar(require("./collection/definition"), exports);
 __exportStar(require("./collection/interface"), exports);
 __exportStar(require("./collection/least-common-identifier"), exports);
 __exportStar(require("./definition/listable"), exports);

package/origin/definition.d.ts

@@ -3,6 +3,21 @@
  * @namespace Origin
  * @description Definition
  */
+import { ImbricateCapability } from "../capability/definition";
+export type ImbricateOriginCapability = Record<IMBRICATE_ORIGIN_CAPABILITY_KEY, ImbricateCapability>;
+export declare enum IMBRICATE_ORIGIN_CAPABILITY_KEY {
+    CREATE_COLLECTION = "imbricate.origin.collection.create",
+    RENAME_COLLECTION = "imbricate.origin.collection.rename",
+    DELETE_COLLECTION = "imbricate.origin.collection.delete",
+    GET_COLLECTION = "imbricate.origin.collection.get",
+    LIST_COLLECTIONS = "imbricate.origin.collection.list",
+    CREATE_SCRIPT = "imbricate.origin.script.create",
+    PUT_SCRIPT = "imbricate.origin.script.put",
+    RENAME_SCRIPT = "imbricate.origin.script.rename",
+    DELETE_SCRIPT = "imbricate.origin.script.delete",
+    GET_SCRIPT = "imbricate.origin.script.get",
+    LIST_SCRIPTS = "imbricate.origin.script.list"
+}
 export declare enum IMBRICATE_DIGEST_ALGORITHM {
     MD5 = "MD5",
     SHA1 = "SHA1",

package/origin/definition.js

@@ -5,7 +5,21 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_DIGEST_ALGORITHM = void 0;
+exports.IMBRICATE_DIGEST_ALGORITHM = exports.IMBRICATE_ORIGIN_CAPABILITY_KEY = void 0;
+var IMBRICATE_ORIGIN_CAPABILITY_KEY;
+(function (IMBRICATE_ORIGIN_CAPABILITY_KEY) {
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["CREATE_COLLECTION"] = "imbricate.origin.collection.create";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["RENAME_COLLECTION"] = "imbricate.origin.collection.rename";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["DELETE_COLLECTION"] = "imbricate.origin.collection.delete";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["GET_COLLECTION"] = "imbricate.origin.collection.get";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["LIST_COLLECTIONS"] = "imbricate.origin.collection.list";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["CREATE_SCRIPT"] = "imbricate.origin.script.create";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["PUT_SCRIPT"] = "imbricate.origin.script.put";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["RENAME_SCRIPT"] = "imbricate.origin.script.rename";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["DELETE_SCRIPT"] = "imbricate.origin.script.delete";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["GET_SCRIPT"] = "imbricate.origin.script.get";
+    IMBRICATE_ORIGIN_CAPABILITY_KEY["LIST_SCRIPTS"] = "imbricate.origin.script.list";
+})(IMBRICATE_ORIGIN_CAPABILITY_KEY || (exports.IMBRICATE_ORIGIN_CAPABILITY_KEY = IMBRICATE_ORIGIN_CAPABILITY_KEY = {}));
 var IMBRICATE_DIGEST_ALGORITHM;
 (function (IMBRICATE_DIGEST_ALGORITHM) {
     IMBRICATE_DIGEST_ALGORITHM["MD5"] = "MD5";

package/origin/interface.d.ts

@@ -9,18 +9,17 @@ import { IImbricateFunctionManager } from "../function/interface";
 import { ImbricateScriptQuery, ImbricateScriptQueryConfig, ImbricateSearchScriptConfig } from "../query/script";
 import { ImbricateScriptMetadata, ImbricateScriptSearchResult, ImbricateScriptSnapshot } from "../script/definition";
 import { IImbricateScript } from "../script/interface";
-import { ImbricateOriginMetadata } from "./definition";
+import { ImbricateOriginCapability, ImbricateOriginMetadata } from "./definition";
 export interface IImbricateOrigin {
     readonly metadata: ImbricateOriginMetadata;
     readonly payloads: Record<string, any>;
+    readonly capabilities: ImbricateOriginCapability;
     getFunctionManger(): IImbricateFunctionManager;
     createCollection(collectionName: string, description?: string): PromiseOr<void>;
     renameCollection(collectionName: string, newCollectionName: string): PromiseOr<void>;
     deleteCollection(collectionName: string): PromiseOr<void>;
     hasCollection(collectionName: string): PromiseOr<boolean>;
     getCollection(collectionName: string): PromiseOr<IImbricateOriginCollection | null>;
-    includeCollectionInSearch(collectionName: string): PromiseOr<void>;
-    excludeCollectionInSearch(collectionName: string): PromiseOr<void>;
     listCollections(): PromiseOr<IImbricateOriginCollection[]>;
     createScript(scriptName: string, initialScript: string, description?: string): PromiseOr<IImbricateScript>;
     putScript(scriptMetadata: ImbricateScriptMetadata, script: string): PromiseOr<IImbricateScript>;

package/package.json

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

package/page/definition.d.ts

@@ -3,7 +3,17 @@
  * @namespace Page
  * @description Definition
  */
+import { ImbricateCapability } from "../capability/definition";
 import { IMBRICATE_SEARCH_RESULT_TYPE, ImbricateSearchResult, ImbricateSearchSnippet } from "../search/snippet";
+export type ImbricatePageCapability = Record<IMBRICATE_PAGE_CAPABILITY_KEY, ImbricateCapability>;
+export declare enum IMBRICATE_PAGE_CAPABILITY_KEY {
+    READ = "imbricate.page.read",
+    WRITE = "imbricate.page.write",
+    READ_ATTRIBUTE = "imbricate.page.attribute.read",
+    WRITE_ATTRIBUTE = "imbricate.page.attribute.write",
+    UPDATE_METADATA = "imbricate.page.metadata.update",
+    UPDATE_HISTORY_RECORD = "imbricate.page.history.update"
+}
 export type ImbricatePageAttributes = Record<string, string>;
 export type ImbricatePageSearchResult = ImbricateSearchResult<IMBRICATE_SEARCH_RESULT_TYPE.PAGE>;
 export type ImbricatePageSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_RESULT_TYPE.PAGE>;

package/page/definition.js

@@ -5,3 +5,13 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_PAGE_CAPABILITY_KEY = void 0;
+var IMBRICATE_PAGE_CAPABILITY_KEY;
+(function (IMBRICATE_PAGE_CAPABILITY_KEY) {
+    IMBRICATE_PAGE_CAPABILITY_KEY["READ"] = "imbricate.page.read";
+    IMBRICATE_PAGE_CAPABILITY_KEY["WRITE"] = "imbricate.page.write";
+    IMBRICATE_PAGE_CAPABILITY_KEY["READ_ATTRIBUTE"] = "imbricate.page.attribute.read";
+    IMBRICATE_PAGE_CAPABILITY_KEY["WRITE_ATTRIBUTE"] = "imbricate.page.attribute.write";
+    IMBRICATE_PAGE_CAPABILITY_KEY["UPDATE_METADATA"] = "imbricate.page.metadata.update";
+    IMBRICATE_PAGE_CAPABILITY_KEY["UPDATE_HISTORY_RECORD"] = "imbricate.page.history.update";
+})(IMBRICATE_PAGE_CAPABILITY_KEY || (exports.IMBRICATE_PAGE_CAPABILITY_KEY = IMBRICATE_PAGE_CAPABILITY_KEY = {}));

package/page/interface.d.ts

@@ -4,7 +4,7 @@
  * @description Interface
  */
 import { PromiseOr } from "../definition/promise";
-import { ImbricatePageAttributes, ImbricatePageHistoryRecord } from "./definition";
+import { ImbricatePageAttributes, ImbricatePageCapability, ImbricatePageHistoryRecord } from "./definition";
 export interface IImbricatePage {
     readonly title: string;
     readonly directories: string[];
@@ -14,6 +14,7 @@ export interface IImbricatePage {
     readonly description?: string;
     readonly createdAt: Date;
     readonly updatedAt: Date;
+    readonly capabilities: ImbricatePageCapability;
     readContent(): PromiseOr<string>;
     writeContent(content: string): PromiseOr<void>;
     readAttributes(): PromiseOr<ImbricatePageAttributes>;

package/script/definition.d.ts

@@ -3,7 +3,18 @@
  * @namespace Script
  * @description Definition
  */
+import { ImbricateCapability } from "../capability/definition";
 import { IMBRICATE_SEARCH_RESULT_TYPE, ImbricateSearchResult, ImbricateSearchSnippet } from "../search/snippet";
+export type ImbricateScriptCapability = Record<IMBRICATE_SCRIPT_CAPABILITY_KEY, ImbricateCapability>;
+export declare enum IMBRICATE_SCRIPT_CAPABILITY_KEY {
+    READ = "imbricate.script.read",
+    WRITE = "imbricate.script.write",
+    READ_ATTRIBUTE = "imbricate.script.attribute.read",
+    WRITE_ATTRIBUTE = "imbricate.script.attribute.write",
+    UPDATE_METADATA = "imbricate.script.metadata.update",
+    UPDATE_HISTORY_RECORD = "imbricate.script.history.update",
+    EXECUTE = "imbricate.script.execute"
+}
 export type ImbricateScriptAttributes = Record<string, string>;
 export type ImbricateScriptSearchResult = ImbricateSearchResult<IMBRICATE_SEARCH_RESULT_TYPE.SCRIPT>;
 export type ImbricateScriptSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_RESULT_TYPE.SCRIPT>;

package/script/definition.js

@@ -5,3 +5,14 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_SCRIPT_CAPABILITY_KEY = void 0;
+var IMBRICATE_SCRIPT_CAPABILITY_KEY;
+(function (IMBRICATE_SCRIPT_CAPABILITY_KEY) {
+    IMBRICATE_SCRIPT_CAPABILITY_KEY["READ"] = "imbricate.script.read";
+    IMBRICATE_SCRIPT_CAPABILITY_KEY["WRITE"] = "imbricate.script.write";
+    IMBRICATE_SCRIPT_CAPABILITY_KEY["READ_ATTRIBUTE"] = "imbricate.script.attribute.read";
+    IMBRICATE_SCRIPT_CAPABILITY_KEY["WRITE_ATTRIBUTE"] = "imbricate.script.attribute.write";
+    IMBRICATE_SCRIPT_CAPABILITY_KEY["UPDATE_METADATA"] = "imbricate.script.metadata.update";
+    IMBRICATE_SCRIPT_CAPABILITY_KEY["UPDATE_HISTORY_RECORD"] = "imbricate.script.history.update";
+    IMBRICATE_SCRIPT_CAPABILITY_KEY["EXECUTE"] = "imbricate.script.execute";
+})(IMBRICATE_SCRIPT_CAPABILITY_KEY || (exports.IMBRICATE_SCRIPT_CAPABILITY_KEY = IMBRICATE_SCRIPT_CAPABILITY_KEY = {}));

package/script/interface.d.ts

@@ -7,7 +7,7 @@ import { MarkedResult } from "@sudoo/marked";
 import { PromiseOr } from "../definition/promise";
 import { SandboxExecuteConfig, SandboxExecuteParameter } from "../sandbox/definition/config";
 import { SandboxFeature } from "../sandbox/feature/feature";
-import { ImbricateScriptAttributes, ImbricateScriptHistoryRecord } from "./definition";
+import { ImbricateScriptAttributes, ImbricateScriptCapability, ImbricateScriptHistoryRecord } from "./definition";
 export interface IImbricateScript {
     readonly scriptName: string;
     readonly identifier: string;
@@ -16,6 +16,7 @@ export interface IImbricateScript {
     readonly description?: string;
     readonly createdAt: Date;
     readonly updatedAt: Date;
+    readonly capabilities: ImbricateScriptCapability;
     readScript(): PromiseOr<string>;
     writeScript(script: string): PromiseOr<void>;
     readAttributes(): PromiseOr<ImbricateScriptAttributes>;