@imbricate/core 1.4.1 → 1.5.1

package/collection/definition.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @author WMXPY
+ * @namespace Collection
+ * @description Definition
+ */
+export declare enum IMBRICATE_COLLECTION_EVENT_TYPE {
+    PAGE_CREATED = "PAGE_CREATED"
+}
+export declare enum IMBRICATE_COLLECTION_TRIGGER_TYPE {
+    SCRIPT = "SCRIPT"
+}
+export type ImbricateCollectionEventScriptPayload = {
+    readonly scriptIdentifier: string;
+    readonly fixedParameters: Record<string, any>;
+};
+export type ImbricateCollectionEventPayload<T extends IMBRICATE_COLLECTION_TRIGGER_TYPE> = T extends IMBRICATE_COLLECTION_TRIGGER_TYPE.SCRIPT ? ImbricateCollectionEventScriptPayload : never;
+export type ImbricateCollectionEvent<T extends IMBRICATE_COLLECTION_TRIGGER_TYPE> = {
+    readonly eventType: IMBRICATE_COLLECTION_EVENT_TYPE;
+    readonly triggerType: T;
+    readonly payload: ImbricateCollectionEventPayload<T>;
+};

package/collection/definition.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Collection
+ * @description Definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_COLLECTION_TRIGGER_TYPE = exports.IMBRICATE_COLLECTION_EVENT_TYPE = void 0;
+var IMBRICATE_COLLECTION_EVENT_TYPE;
+(function (IMBRICATE_COLLECTION_EVENT_TYPE) {
+    IMBRICATE_COLLECTION_EVENT_TYPE["PAGE_CREATED"] = "PAGE_CREATED";
+})(IMBRICATE_COLLECTION_EVENT_TYPE || (exports.IMBRICATE_COLLECTION_EVENT_TYPE = IMBRICATE_COLLECTION_EVENT_TYPE = {}));
+var IMBRICATE_COLLECTION_TRIGGER_TYPE;
+(function (IMBRICATE_COLLECTION_TRIGGER_TYPE) {
+    IMBRICATE_COLLECTION_TRIGGER_TYPE["SCRIPT"] = "SCRIPT";
+})(IMBRICATE_COLLECTION_TRIGGER_TYPE || (exports.IMBRICATE_COLLECTION_TRIGGER_TYPE = IMBRICATE_COLLECTION_TRIGGER_TYPE = {}));

package/collection/interface.d.ts

@@ -4,17 +4,22 @@
  * @description Interface
  */
 import { PromiseOr } from "../definition/promise";
-import { ImbricatePageSnapshot } from "../page/definition";
+import { ImbricatePageMetadata, ImbricatePageSearchSnippet, ImbricatePageSnapshot } from "../page/definition";
 import { IImbricatePage } from "../page/interface";
-import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "../search/snippet";
-export type ImbricatePageSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE>;
+import { IMBRICATE_COLLECTION_EVENT_TYPE, IMBRICATE_COLLECTION_TRIGGER_TYPE, ImbricateCollectionEvent } from "./definition";
 export interface IImbricateOriginCollection {
     readonly collectionName: string;
     readonly description?: string;
-    listPages(): PromiseOr<ImbricatePageSnapshot[]>;
+    readonly events: Array<ImbricateCollectionEvent<IMBRICATE_COLLECTION_TRIGGER_TYPE>>;
+    attachEvent(event: ImbricateCollectionEvent<IMBRICATE_COLLECTION_TRIGGER_TYPE>): PromiseOr<void>;
+    getEventsByEventType(eventType: IMBRICATE_COLLECTION_EVENT_TYPE): PromiseOr<Array<ImbricateCollectionEvent<IMBRICATE_COLLECTION_TRIGGER_TYPE>>>;
+    triggerEvent(eventType: IMBRICATE_COLLECTION_EVENT_TYPE, payload: any): PromiseOr<void>;
     createPage(title: string, initialContent?: string): PromiseOr<IImbricatePage>;
+    putPage(pageMetadata: ImbricatePageMetadata, content: string): PromiseOr<IImbricatePage>;
+    retitlePage(identifier: string, newTitle: string): PromiseOr<void>;
     deletePage(identifier: string, title: string): PromiseOr<void>;
     hasPage(title: string): PromiseOr<boolean>;
     getPage(identifier: string): PromiseOr<IImbricatePage | null>;
+    listPages(): PromiseOr<ImbricatePageSnapshot[]>;
     searchPages(keyword: string): PromiseOr<ImbricatePageSearchSnippet[]>;
 }

package/collection/least-common-identifier.d.ts

@@ -1,6 +1,6 @@
 /**
  * @author WMXPY
- * @namespace Origin_Collection
+ * @namespace Collection
  * @description Least Common Identifier
  */
 export type LeastCommonIdentifierItem = {

package/collection/least-common-identifier.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * @author WMXPY
- * @namespace Origin_Collection
+ * @namespace Collection
  * @description Least Common Identifier
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/index.d.ts

@@ -2,10 +2,12 @@
  * @author WMXPY
  * @description Index
  */
+export * from "./collection/definition";
 export * from "./collection/interface";
 export * from "./collection/least-common-identifier";
 export * from "./definition/listable";
 export * from "./definition/promise";
+export * from "./origin/definition";
 export * from "./origin/interface";
 export * from "./page/definition";
 export * from "./page/interface";

package/index.js

@@ -18,10 +18,12 @@ 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("./collection/definition"), exports);
 __exportStar(require("./collection/interface"), exports);
 __exportStar(require("./collection/least-common-identifier"), exports);
 __exportStar(require("./definition/listable"), exports);
 __exportStar(require("./definition/promise"), exports);
+__exportStar(require("./origin/definition"), exports);
 __exportStar(require("./origin/interface"), exports);
 __exportStar(require("./page/definition"), exports);
 __exportStar(require("./page/interface"), exports);

package/origin/definition.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @author WMXPY
+ * @namespace Origin
+ * @description Definition
+ */
+import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "../search/snippet";
+export type ImbricateScriptSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE.SCRIPT>;
+export type ImbricateOriginMetadata = {
+    readonly type: string;
+};

package/origin/definition.js

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

package/origin/interface.d.ts

@@ -5,22 +5,24 @@
  */
 import { IImbricateOriginCollection } from "../collection/interface";
 import { PromiseOr } from "../definition/promise";
-import { ImbricateScriptSnapshot } from "../script/definition";
+import { ImbricateScriptMetadata, ImbricateScriptSnapshot } from "../script/definition";
 import { IImbricateScript } from "../script/interface";
-export type ImbricateOriginMetadata = {
-    readonly type: string;
-};
+import { ImbricateOriginMetadata, ImbricateScriptSearchSnippet } from "./definition";
 export interface IImbricateOrigin {
     readonly metadata: ImbricateOriginMetadata;
     readonly payloads: Record<string, any>;
     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>;
     listCollections(): PromiseOr<IImbricateOriginCollection[]>;
     createScript(scriptName: string, description?: string): PromiseOr<IImbricateScript>;
+    putScript(scriptMetadata: ImbricateScriptMetadata, script: string): PromiseOr<IImbricateScript>;
+    renameScript(identifier: string, newScriptName: string): PromiseOr<void>;
     deleteScript(identifier: string, scriptName: string): PromiseOr<void>;
     hasScript(scriptName: string): PromiseOr<boolean>;
     getScript(identifier: string): PromiseOr<IImbricateScript | null>;
     listScripts(): PromiseOr<ImbricateScriptSnapshot[]>;
+    searchPages(keyword: string): PromiseOr<ImbricateScriptSearchSnippet[]>;
 }

package/package.json

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

package/page/definition.d.ts

@@ -3,7 +3,14 @@
  * @namespace Page
  * @description Definition
  */
+import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "../search/snippet";
+export type ImbricatePageSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE>;
 export type ImbricatePageSnapshot = {
     readonly title: string;
     readonly identifier: string;
+    readonly description?: string;
 };
+export type ImbricatePageMetadata = {
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+} & ImbricatePageSnapshot;

package/script/definition.d.ts

@@ -6,4 +6,9 @@
 export type ImbricateScriptSnapshot = {
     readonly scriptName: string;
     readonly identifier: string;
+    readonly description?: string;
 };
+export type ImbricateScriptMetadata = {
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+} & ImbricateScriptSnapshot;

package/search/snippet.d.ts

@@ -4,13 +4,18 @@
  * @description Snippet
  */
 export declare enum IMBRICATE_SEARCH_SNIPPET_TYPE {
-    PAGE = "PAGE"
+    PAGE = "PAGE",
+    SCRIPT = "SCRIPT"
 }
 export declare enum IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE {
     TITLE = "TITLE",
     CONTENT = "CONTENT"
 }
-type IMBRICATE_SEARCH_SNIPPET_SNIPPET_SOURCE<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = T extends IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE ? IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE : never;
+export declare enum IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE {
+    NAME = "NAME",
+    SCRIPT = "DESCRIPTION"
+}
+type IMBRICATE_SEARCH_SNIPPET_SNIPPET_SOURCE<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = T extends IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE ? IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE : T extends IMBRICATE_SEARCH_SNIPPET_TYPE.SCRIPT ? IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE : never;
 export type ImbricateSearchSnippet<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = {
     readonly type: T;
     readonly scope: string;

package/search/snippet.js

@@ -5,13 +5,19 @@
  * @description Snippet
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE = exports.IMBRICATE_SEARCH_SNIPPET_TYPE = void 0;
+exports.IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE = exports.IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE = exports.IMBRICATE_SEARCH_SNIPPET_TYPE = void 0;
 var IMBRICATE_SEARCH_SNIPPET_TYPE;
 (function (IMBRICATE_SEARCH_SNIPPET_TYPE) {
     IMBRICATE_SEARCH_SNIPPET_TYPE["PAGE"] = "PAGE";
+    IMBRICATE_SEARCH_SNIPPET_TYPE["SCRIPT"] = "SCRIPT";
 })(IMBRICATE_SEARCH_SNIPPET_TYPE || (exports.IMBRICATE_SEARCH_SNIPPET_TYPE = IMBRICATE_SEARCH_SNIPPET_TYPE = {}));
 var IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE;
 (function (IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE) {
     IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE["TITLE"] = "TITLE";
     IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE["CONTENT"] = "CONTENT";
 })(IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE || (exports.IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE = IMBRICATE_SEARCH_SNIPPET_PAGE_SNIPPET_SOURCE = {}));
+var IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE;
+(function (IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE) {
+    IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE["NAME"] = "NAME";
+    IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE["SCRIPT"] = "DESCRIPTION";
+})(IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE || (exports.IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE = IMBRICATE_SEARCH_SNIPPET_SCRIPT_SNIPPET_SOURCE = {}));