@imbricate/core 1.17.1 → 1.18.0

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/interface.d.ts

@@ -10,6 +10,7 @@ import { ImbricatePageQuery, ImbricatePageQueryConfig, ImbricateSearchPageConfig
 import { ImbricateCollectionCapability } from "./definition";
 export interface IImbricateOriginCollection {
     readonly collectionName: string;
+    readonly uniqueIdentifier: string;
     readonly description?: string;
     readonly capabilities: ImbricateCollectionCapability;
     createPage(directories: string[], title: string, initialContent: string): PromiseOr<IImbricatePage>;

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

@@ -10,7 +10,6 @@ export declare enum IMBRICATE_DIGEST_ALGORITHM {
     SHA256 = "SHA256"
 }
 export type ImbricateOriginMetadata = {
-    readonly type: string;
     readonly digestAlgorithm: IMBRICATE_DIGEST_ALGORITHM;
 };
 export type ImbricateOriginCapability = Record<IMBRICATE_ORIGIN_CAPABILITY_KEY, ImbricateCapability>;

package/origin/interface.d.ts

@@ -11,6 +11,8 @@ import { ImbricateScriptMetadata, ImbricateScriptSearchResult, ImbricateScriptSn
 import { IImbricateScript } from "../script/interface";
 import { ImbricateOriginCapability, ImbricateOriginMetadata } from "./definition";
 export interface IImbricateOrigin {
+    readonly originType: string;
+    readonly uniqueIdentifier: string;
     readonly metadata: ImbricateOriginMetadata;
     readonly payloads: Record<string, any>;
     readonly capabilities: ImbricateOriginCapability;

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "1.17.1",
-  "description": "Core for Imbricate",
+  "version": "1.18.0",
+  "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Imbricate/Imbricate-Core.git"
+    "url": "git+https://github.com/Imbricate/Imbricate.git"
   },
   "keywords": [
+    "Notebook",
+    "Engineer",
     "API"
   ],
   "author": "WMXPY",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/Imbricate/Imbricate-Core/issues"
+    "url": "https://github.com/Imbricate/Imbricate/issues"
   },
   "homepage": "https://imbricate.io",
   "dependencies": {