@imbricate/core 1.17.0 → 1.17.2

package/capability/validate.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @author WMXPY
+ * @namespace Capability
+ * @description Validate
+ */
+import { IMBRICATE_COLLECTION_CAPABILITY_KEY } from "../collection/definition";
+import { IImbricateOriginCollection } from "../collection/interface";
+import { IMBRICATE_ORIGIN_CAPABILITY_KEY } from "../origin/definition";
+import { IImbricateOrigin } from "../origin/interface";
+import { IMBRICATE_PAGE_CAPABILITY_KEY } from "../page/definition";
+import { IImbricatePage } from "../page/interface";
+import { IMBRICATE_SCRIPT_CAPABILITY_KEY } from "../script/definition";
+import { IImbricateScript } from "../script/interface";
+import { ImbricateCapability } from "./definition";
+export declare const validateImbricateCapability: <CapabilityRecords extends Record<string, ImbricateCapability>, KeySet extends keyof CapabilityRecords>(capabilities: CapabilityRecords, capability: KeySet) => boolean;
+export declare const validateImbricateOriginCapability: (origin: IImbricateOrigin, capability: IMBRICATE_ORIGIN_CAPABILITY_KEY) => boolean;
+export declare const validateImbricateCollectionCapability: (collection: IImbricateOriginCollection, capability: IMBRICATE_COLLECTION_CAPABILITY_KEY) => boolean;
+export declare const validateImbricatePageCapability: (page: IImbricatePage, capability: IMBRICATE_PAGE_CAPABILITY_KEY) => boolean;
+export declare const validateImbricateScriptCapability: (script: IImbricateScript, capability: IMBRICATE_SCRIPT_CAPABILITY_KEY) => boolean;

package/capability/validate.js

@@ -0,0 +1,39 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Capability
+ * @description Validate
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateImbricateScriptCapability = exports.validateImbricatePageCapability = exports.validateImbricateCollectionCapability = exports.validateImbricateOriginCapability = exports.validateImbricateCapability = void 0;
+const definition_1 = require("./definition");
+const validateImbricateCapability = (capabilities, capability) => {
+    if (!capabilities) {
+        return false;
+    }
+    if (!Array.isArray(capabilities)) {
+        return false;
+    }
+    const capabilityValue = capabilities[capability];
+    if (!capabilityValue) {
+        return false;
+    }
+    return capabilityValue.effect === definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW;
+};
+exports.validateImbricateCapability = validateImbricateCapability;
+const validateImbricateOriginCapability = (origin, capability) => {
+    return (0, exports.validateImbricateCapability)(origin.capabilities, capability);
+};
+exports.validateImbricateOriginCapability = validateImbricateOriginCapability;
+const validateImbricateCollectionCapability = (collection, capability) => {
+    return (0, exports.validateImbricateCapability)(collection.capabilities, capability);
+};
+exports.validateImbricateCollectionCapability = validateImbricateCollectionCapability;
+const validateImbricatePageCapability = (page, capability) => {
+    return (0, exports.validateImbricateCapability)(page.capabilities, capability);
+};
+exports.validateImbricatePageCapability = validateImbricatePageCapability;
+const validateImbricateScriptCapability = (script, capability) => {
+    return (0, exports.validateImbricateCapability)(script.capabilities, capability);
+};
+exports.validateImbricateScriptCapability = validateImbricateScriptCapability;

package/collection/definition.d.ts

@@ -13,3 +13,4 @@ export declare enum IMBRICATE_COLLECTION_CAPABILITY_KEY {
     GET_PAGE = "imbricate.collection.page.get",
     LIST_PAGES = "imbricate.collection.page.list"
 }
+export declare const createAllAllowImbricateCollectionCapability: () => ImbricateCollectionCapability;

package/collection/definition.js

@@ -5,7 +5,8 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_COLLECTION_CAPABILITY_KEY = void 0;
+exports.createAllAllowImbricateCollectionCapability = exports.IMBRICATE_COLLECTION_CAPABILITY_KEY = void 0;
+const definition_1 = require("../capability/definition");
 var IMBRICATE_COLLECTION_CAPABILITY_KEY;
 (function (IMBRICATE_COLLECTION_CAPABILITY_KEY) {
     IMBRICATE_COLLECTION_CAPABILITY_KEY["CREATE_PAGE"] = "imbricate.collection.page.create";
@@ -15,3 +16,26 @@ var IMBRICATE_COLLECTION_CAPABILITY_KEY;
     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 = {}));
+const createAllAllowImbricateCollectionCapability = () => {
+    return {
+        [IMBRICATE_COLLECTION_CAPABILITY_KEY.CREATE_PAGE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_COLLECTION_CAPABILITY_KEY.PUT_PAGE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_COLLECTION_CAPABILITY_KEY.RETITLE_PAGE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_COLLECTION_CAPABILITY_KEY.DELETE_PAGE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_COLLECTION_CAPABILITY_KEY.GET_PAGE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_COLLECTION_CAPABILITY_KEY.LIST_PAGES]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+    };
+};
+exports.createAllAllowImbricateCollectionCapability = createAllAllowImbricateCollectionCapability;

package/index.d.ts

@@ -3,6 +3,7 @@
  * @description Index
  */
 export * from "./capability/definition";
+export * from "./capability/validate";
 export * from "./collection/definition";
 export * from "./collection/interface";
 export * from "./collection/least-common-identifier";

package/index.js

@@ -19,6 +19,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./capability/definition"), exports);
+__exportStar(require("./capability/validate"), exports);
 __exportStar(require("./collection/definition"), exports);
 __exportStar(require("./collection/interface"), exports);
 __exportStar(require("./collection/least-common-identifier"), exports);

package/origin/definition.d.ts

@@ -4,6 +4,15 @@
  * @description Definition
  */
 import { ImbricateCapability } from "../capability/definition";
+export declare enum IMBRICATE_DIGEST_ALGORITHM {
+    MD5 = "MD5",
+    SHA1 = "SHA1",
+    SHA256 = "SHA256"
+}
+export type ImbricateOriginMetadata = {
+    readonly type: string;
+    readonly digestAlgorithm: IMBRICATE_DIGEST_ALGORITHM;
+};
 export type ImbricateOriginCapability = Record<IMBRICATE_ORIGIN_CAPABILITY_KEY, ImbricateCapability>;
 export declare enum IMBRICATE_ORIGIN_CAPABILITY_KEY {
     CREATE_COLLECTION = "imbricate.origin.collection.create",
@@ -18,12 +27,4 @@ export declare enum IMBRICATE_ORIGIN_CAPABILITY_KEY {
     GET_SCRIPT = "imbricate.origin.script.get",
     LIST_SCRIPTS = "imbricate.origin.script.list"
 }
-export declare enum IMBRICATE_DIGEST_ALGORITHM {
-    MD5 = "MD5",
-    SHA1 = "SHA1",
-    SHA256 = "SHA256"
-}
-export type ImbricateOriginMetadata = {
-    readonly type: string;
-    readonly digestAlgorithm: IMBRICATE_DIGEST_ALGORITHM;
-};
+export declare const createAllAllowImbricateOriginCapability: () => ImbricateOriginCapability;

package/origin/definition.js

@@ -5,7 +5,14 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_DIGEST_ALGORITHM = exports.IMBRICATE_ORIGIN_CAPABILITY_KEY = void 0;
+exports.createAllAllowImbricateOriginCapability = exports.IMBRICATE_ORIGIN_CAPABILITY_KEY = exports.IMBRICATE_DIGEST_ALGORITHM = void 0;
+const definition_1 = require("../capability/definition");
+var IMBRICATE_DIGEST_ALGORITHM;
+(function (IMBRICATE_DIGEST_ALGORITHM) {
+    IMBRICATE_DIGEST_ALGORITHM["MD5"] = "MD5";
+    IMBRICATE_DIGEST_ALGORITHM["SHA1"] = "SHA1";
+    IMBRICATE_DIGEST_ALGORITHM["SHA256"] = "SHA256";
+})(IMBRICATE_DIGEST_ALGORITHM || (exports.IMBRICATE_DIGEST_ALGORITHM = IMBRICATE_DIGEST_ALGORITHM = {}));
 var IMBRICATE_ORIGIN_CAPABILITY_KEY;
 (function (IMBRICATE_ORIGIN_CAPABILITY_KEY) {
     IMBRICATE_ORIGIN_CAPABILITY_KEY["CREATE_COLLECTION"] = "imbricate.origin.collection.create";
@@ -20,9 +27,41 @@ var IMBRICATE_ORIGIN_CAPABILITY_KEY;
     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";
-    IMBRICATE_DIGEST_ALGORITHM["SHA1"] = "SHA1";
-    IMBRICATE_DIGEST_ALGORITHM["SHA256"] = "SHA256";
-})(IMBRICATE_DIGEST_ALGORITHM || (exports.IMBRICATE_DIGEST_ALGORITHM = IMBRICATE_DIGEST_ALGORITHM = {}));
+const createAllAllowImbricateOriginCapability = () => {
+    return {
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.CREATE_COLLECTION]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.RENAME_COLLECTION]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.DELETE_COLLECTION]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.GET_COLLECTION]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.LIST_COLLECTIONS]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.CREATE_SCRIPT]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.PUT_SCRIPT]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.RENAME_SCRIPT]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.DELETE_SCRIPT]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.GET_SCRIPT]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_ORIGIN_CAPABILITY_KEY.LIST_SCRIPTS]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+    };
+};
+exports.createAllAllowImbricateOriginCapability = createAllAllowImbricateOriginCapability;

package/package.json

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

package/page/definition.d.ts

@@ -5,15 +5,6 @@
  */
 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>;
@@ -33,3 +24,13 @@ export type ImbricatePageMetadata = {
     readonly historyRecords: ImbricatePageHistoryRecord[];
     readonly description?: string;
 } & ImbricatePageSnapshot;
+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 declare const createAllAllowImbricatePageCapability: () => ImbricatePageCapability;

package/page/definition.js

@@ -5,7 +5,8 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_PAGE_CAPABILITY_KEY = void 0;
+exports.createAllAllowImbricatePageCapability = exports.IMBRICATE_PAGE_CAPABILITY_KEY = void 0;
+const definition_1 = require("../capability/definition");
 var IMBRICATE_PAGE_CAPABILITY_KEY;
 (function (IMBRICATE_PAGE_CAPABILITY_KEY) {
     IMBRICATE_PAGE_CAPABILITY_KEY["READ"] = "imbricate.page.read";
@@ -15,3 +16,26 @@ var IMBRICATE_PAGE_CAPABILITY_KEY;
     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 = {}));
+const createAllAllowImbricatePageCapability = () => {
+    return {
+        [IMBRICATE_PAGE_CAPABILITY_KEY.READ]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_PAGE_CAPABILITY_KEY.WRITE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_PAGE_CAPABILITY_KEY.READ_ATTRIBUTE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_PAGE_CAPABILITY_KEY.WRITE_ATTRIBUTE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_PAGE_CAPABILITY_KEY.UPDATE_METADATA]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_PAGE_CAPABILITY_KEY.UPDATE_HISTORY_RECORD]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+    };
+};
+exports.createAllAllowImbricatePageCapability = createAllAllowImbricatePageCapability;

package/script/definition.d.ts

@@ -5,16 +5,6 @@
  */
 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>;
@@ -33,3 +23,14 @@ export type ImbricateScriptMetadata = {
     readonly historyRecords: ImbricateScriptHistoryRecord[];
     readonly description?: string;
 } & ImbricateScriptSnapshot;
+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 declare const createAllAllowImbricateScriptCapability: () => ImbricateScriptCapability;

package/script/definition.js

@@ -5,7 +5,8 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_SCRIPT_CAPABILITY_KEY = void 0;
+exports.createAllAllowImbricateScriptCapability = exports.IMBRICATE_SCRIPT_CAPABILITY_KEY = void 0;
+const definition_1 = require("../capability/definition");
 var IMBRICATE_SCRIPT_CAPABILITY_KEY;
 (function (IMBRICATE_SCRIPT_CAPABILITY_KEY) {
     IMBRICATE_SCRIPT_CAPABILITY_KEY["READ"] = "imbricate.script.read";
@@ -16,3 +17,29 @@ var IMBRICATE_SCRIPT_CAPABILITY_KEY;
     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 = {}));
+const createAllAllowImbricateScriptCapability = () => {
+    return {
+        [IMBRICATE_SCRIPT_CAPABILITY_KEY.READ]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_SCRIPT_CAPABILITY_KEY.WRITE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_SCRIPT_CAPABILITY_KEY.READ_ATTRIBUTE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_SCRIPT_CAPABILITY_KEY.WRITE_ATTRIBUTE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_SCRIPT_CAPABILITY_KEY.UPDATE_METADATA]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_SCRIPT_CAPABILITY_KEY.UPDATE_HISTORY_RECORD]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+        [IMBRICATE_SCRIPT_CAPABILITY_KEY.EXECUTE]: {
+            effect: definition_1.IMBRICATE_CAPABILITY_EFFECT.ALLOW,
+        },
+    };
+};
+exports.createAllAllowImbricateScriptCapability = createAllAllowImbricateScriptCapability;