@imbricate/core 1.0.0 → 1.0.1

package/definition/listable.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @author WMXPY
+ * @namespace Definition
+ * @description Listable
+ */
+export type ListableValue<T> = T | T[];

package/definition/promise.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @author WMXPY
+ * @namespace Definition
+ * @description Promise
+ */
+export type PromiseOr<T> = T | Promise<T>;

package/definition/script.d.ts

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

package/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @author WMXPY
+ * @description Index
+ */
+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 "./sandbox/feature/builder";
+export * from "./sandbox/feature/feature";
+export * from "./sandbox/sandbox";
+export * from "./search/prefix";
+export * from "./search/snippet";

package/origin/collection/interface.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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>>>;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * @author WMXPY
+ * @namespace Origin_Collection
+ * @description Least Common Identifier
+ */
+export type LeastCommonIdentifierItem = {
+    readonly key: string;
+    readonly identifier: string;
+};
+export declare const mapLeastCommonIdentifier: (identifiers: LeastCommonIdentifierItem[]) => Record<string, string>;

package/origin/interface.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @author WMXPY
+ * @namespace Origin
+ * @description Interface
+ */
+import { MarkedResult } from "@sudoo/marked";
+import { PromiseOr } from "../definition/promise";
+import { ImbricateScriptMetadata } from "../definition/script";
+import { SandboxExecuteConfig } from "../sandbox/definition/config";
+import { IImbricateOriginCollection } from "./collection/interface";
+export type ImbricateOriginMetadata = {
+    readonly type: string;
+};
+export interface IImbricateOrigin {
+    readonly metadata: ImbricateOriginMetadata;
+    readonly payloads: Record<string, any>;
+    createCollection(collectionName: string, description?: string): PromiseOr<void>;
+    hasCollection(collectionName: string): PromiseOr<boolean>;
+    getCollection(collectionName: string): PromiseOr<IImbricateOriginCollection | null>;
+    listCollections(): PromiseOr<IImbricateOriginCollection[]>;
+    removeCollection(): PromiseOr<void>;
+    createScript(scriptName: string, description?: string): PromiseOr<ImbricateScriptMetadata>;
+    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>;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imbricate/core",
   "main": "index.js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Core for Imbricate",
   "repository": {
     "type": "git",
@@ -17,13 +17,11 @@
   },
   "homepage": "https://imbricate.io",
   "dependencies": {
-    "@sudoo/io": "^1.8.0",
     "@sudoo/marked": "^3.21.4",
     "@sudoo/marked-mixin-date": "^1.0.0",
     "@sudoo/marked-mixin-json": "^1.0.0",
     "@sudoo/marked-mixin-math": "^1.4.0",
     "@sudoo/marked-mixin-object": "^1.3.0",
-    "@sudoo/marked-mixin-parse": "^1.0.0",
-    "@sudoo/uuid": "^1.1.0"
+    "@sudoo/marked-mixin-parse": "^1.0.0"
   }
 }

package/sandbox/definition/config.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @author WMXPY
+ * @namespace Sandbox_Definition
+ * @description Config
+ */
+export type SandboxExecuteConfig = Record<string, any>;

package/sandbox/definition/environment.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @author WMXPY
+ * @namespace Sandbox_Definition
+ * @description Environment
+ */
+export type SandboxEnvironmentOrigin = {
+    readonly type: string;
+};
+export type SandboxEnvironment = {
+    readonly origin: SandboxEnvironmentOrigin;
+};

package/sandbox/definition/implementation.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @author WMXPY
+ * @namespace Sandbox_Definition
+ * @description Implementation
+ */
+export type SandboxImplementation = (...args: any[]) => Promise<any> | any;

package/sandbox/feature/builder.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @author WMXPY
+ * @namespace Sandbox_Feature
+ * @description Builder
+ */
+import { SandboxImplementation } from "../definition/implementation";
+import { SandboxFeature } from "./feature";
+export declare class SandboxFeatureBuilder {
+    static fromScratch(): SandboxFeatureBuilder;
+    private _packageName;
+    private _methodName;
+    private _implementation;
+    private constructor();
+    withPackageName(packageName: string): this;
+    withMethodName(methodName: string): this;
+    withImplementation(implementation: SandboxImplementation): this;
+    build(): SandboxFeature;
+}

package/sandbox/feature/feature.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @author WMXPY
+ * @namespace Sandbox_Feature
+ * @description Feature
+ */
+import { SandboxImplementation } from "../definition/implementation";
+export declare class SandboxFeature {
+    static create(packageName: string, methodName: string, implementation: SandboxImplementation): SandboxFeature;
+    private readonly _packageName;
+    private readonly _methodName;
+    private readonly _implementation;
+    private constructor();
+    get packageName(): string;
+    get methodName(): string;
+    get implementation(): SandboxImplementation;
+}

package/sandbox/provide/feature.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @author WMXPY
+ * @namespace Sandbox_Provide
+ * @description Feature
+ */
+import { Sandbox } from "@sudoo/marked";
+import { SandboxFeature } from "../feature/feature";
+export declare const sandboxProvideFeatures: (sandbox: Sandbox, features: SandboxFeature[]) => void;

package/sandbox/sandbox.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @author WMXPY
+ * @namespace Sandbox
+ * @description Sandbox
+ */
+import { MarkedResult, Sandbox } from "@sudoo/marked";
+import { SandboxExecuteConfig } from "./definition/config";
+import { SandboxEnvironment } from "./definition/environment";
+import { SandboxFeature } from "./feature/feature";
+export declare const createSandbox: (features: SandboxFeature[]) => Sandbox;
+export declare const executeSandboxScript: (script: string, features: SandboxFeature[], environment: SandboxEnvironment, config: SandboxExecuteConfig) => Promise<MarkedResult>;

package/search/prefix.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @author WMXPY
+ * @namespace Search
+ * @description Prefix
+ */
+import { IMBRICATE_SEARCH_SNIPPET_TYPE, ImbricateSearchSnippet } from "./snippet";
+export declare const getShortPrefixOfSnippet: (snippet: ImbricateSearchSnippet<IMBRICATE_SEARCH_SNIPPET_TYPE>) => string;

package/search/snippet.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @author WMXPY
+ * @namespace Search
+ * @description Snippet
+ */
+export declare enum IMBRICATE_SEARCH_SNIPPET_TYPE {
+    PAGE = "PAGE"
+}
+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 type ImbricateSearchSnippet<T extends IMBRICATE_SEARCH_SNIPPET_TYPE> = {
+    readonly type: T;
+    readonly scope: string;
+    readonly identifier: string;
+    readonly headline: string;
+    readonly source: IMBRICATE_SEARCH_SNIPPET_SNIPPET_SOURCE<T>;
+    readonly snippet: string;
+};
+export {};