@imbricate/core 1.0.2 → 1.2.0

package/collection/interface.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @author WMXPY
+ * @namespace Origin_Collection
+ * @description Interface
+ */
+import { PromiseOr } from "../definition/promise";
+import { ImbricatePageSnapshot } from "../page/definition";
+import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "../search/snippet";
+export type ImbricatePageSearchSnippet = ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE>;
+export interface IImbricateOriginCollection {
+    readonly collectionName: string;
+    readonly description?: string;
+    findScripts(...onActivities: string[]): PromiseOr<void>;
+    listPages(): PromiseOr<ImbricatePageSnapshot[]>;
+    createPage(title: string, initialContent?: string): PromiseOr<ImbricatePageSnapshot>;
+    deletePage(identifier: string, title: string): PromiseOr<void>;
+    hasPage(title: string): PromiseOr<boolean>;
+    readPage(identifier: string): PromiseOr<string | null>;
+    writePage(identifier: string, content: string): PromiseOr<void>;
+    searchPages(keyword: string): PromiseOr<ImbricatePageSearchSnippet[]>;
+}

package/index.d.ts

@@ -2,17 +2,18 @@
  * @author WMXPY
  * @description Index
  */
+export * from "./collection/interface";
+export * from "./collection/least-common-identifier";
 export * from "./definition/listable";
 export * from "./definition/promise";
-export * from "./definition/script";
-export * from "./origin/collection/interface";
-export * from "./origin/collection/least-common-identifier";
 export * from "./origin/interface";
+export * from "./page/definition";
 export * from "./sandbox/definition/config";
 export * from "./sandbox/definition/environment";
 export * from "./sandbox/definition/implementation";
 export * from "./sandbox/feature/builder";
 export * from "./sandbox/feature/feature";
 export * from "./sandbox/sandbox";
+export * from "./script/definition";
 export * from "./search/prefix";
 export * from "./search/snippet";

package/index.js

@@ -18,17 +18,18 @@ 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/interface"), exports);
+__exportStar(require("./collection/least-common-identifier"), exports);
 __exportStar(require("./definition/listable"), exports);
 __exportStar(require("./definition/promise"), exports);
-__exportStar(require("./definition/script"), exports);
-__exportStar(require("./origin/collection/interface"), exports);
-__exportStar(require("./origin/collection/least-common-identifier"), exports);
 __exportStar(require("./origin/interface"), exports);
+__exportStar(require("./page/definition"), exports);
 __exportStar(require("./sandbox/definition/config"), exports);
 __exportStar(require("./sandbox/definition/environment"), exports);
 __exportStar(require("./sandbox/definition/implementation"), exports);
 __exportStar(require("./sandbox/feature/builder"), exports);
 __exportStar(require("./sandbox/feature/feature"), exports);
 __exportStar(require("./sandbox/sandbox"), exports);
+__exportStar(require("./script/definition"), exports);
 __exportStar(require("./search/prefix"), exports);
 __exportStar(require("./search/snippet"), exports);

package/origin/interface.d.ts

@@ -4,10 +4,10 @@
  * @description Interface
  */
 import { MarkedResult } from "@sudoo/marked";
+import { IImbricateOriginCollection } from "../collection/interface";
 import { PromiseOr } from "../definition/promise";
-import { ImbricateScriptMetadata } from "../definition/script";
 import { SandboxExecuteConfig } from "../sandbox/definition/config";
-import { IImbricateOriginCollection } from "./collection/interface";
+import { ImbricateScriptSnapshot } from "../script/definition";
 export type ImbricateOriginMetadata = {
     readonly type: string;
 };
@@ -19,11 +19,11 @@ export interface IImbricateOrigin {
     getCollection(collectionName: string): PromiseOr<IImbricateOriginCollection | null>;
     listCollections(): PromiseOr<IImbricateOriginCollection[]>;
     removeCollection(): PromiseOr<void>;
-    createScript(scriptName: string, description?: string): PromiseOr<ImbricateScriptMetadata>;
+    createScript(scriptName: string, description?: string): PromiseOr<ImbricateScriptSnapshot>;
+    deleteScript(identifier: string, scriptName: string): PromiseOr<void>;
     hasScript(scriptName: string): PromiseOr<boolean>;
-    getScript(scriptIdentifier: string): PromiseOr<string | null>;
-    openScript(scriptIdentifier: string): PromiseOr<string>;
-    listScripts(): PromiseOr<ImbricateScriptMetadata[]>;
-    removeScript(scriptIdentifier: string, scriptName: string): PromiseOr<void>;
-    executeScript(scriptIdentifier: string, config: SandboxExecuteConfig): PromiseOr<MarkedResult | null>;
+    readScript(identifier: string): PromiseOr<string | null>;
+    writeScript(identifier: string, content: string): PromiseOr<string>;
+    listScripts(): PromiseOr<ImbricateScriptSnapshot[]>;
+    executeScript(identifier: string, config: SandboxExecuteConfig): PromiseOr<MarkedResult | null>;
 }

package/package.json

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

package/page/definition.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @author WMXPY
+ * @namespace Origin_Page
+ * @description Definition
+ */
+export type ImbricatePageSnapshot = {
+    readonly title: string;
+    readonly identifier: string;
+};

package/page/definition.js

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

package/{definition/script.d.ts → script/definition.d.ts}

@@ -1,9 +1,9 @@
 /**
  * @author WMXPY
- * @namespace Definition
- * @description Script
+ * @namespace Script
+ * @description Definition
  */
-export type ImbricateScriptMetadata = {
+export type ImbricateScriptSnapshot = {
     readonly scriptName: string;
     readonly identifier: string;
 };

package/{definition/script.js → script/definition.js}

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

package/origin/collection/interface.d.ts

@@ -1,22 +0,0 @@
-/**
- * @author WMXPY
- * @namespace Origin_Collection
- * @description Interface
- */
-import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "../../search/snippet";
-export type ImbricateOriginCollectionListPagesResponse = {
-    readonly title: string;
-    readonly identifier: string;
-};
-export interface IImbricateOriginCollection {
-    readonly collectionName: string;
-    readonly description?: string;
-    findScripts(...onActivities: string[]): Promise<void>;
-    listPages(): Promise<ImbricateOriginCollectionListPagesResponse[]>;
-    createPage(title: string, initialContent?: string): Promise<ImbricateOriginCollectionListPagesResponse>;
-    deletePage(identifier: string, title: string): Promise<void>;
-    openPage(title: string): Promise<void>;
-    readPage(identifier: string): Promise<string>;
-    hasPage(title: string): Promise<boolean>;
-    searchPages(keyword: string): Promise<Array<ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE.PAGE>>>;
-}