@imbricate/core 3.2.0 → 3.3.0

package/database/schema.d.ts

@@ -7,7 +7,22 @@ import { IMBRICATE_PROPERTY_TYPE } from "../document/property";
 export type ImbricateDatabaseSchemaProperty<T extends IMBRICATE_PROPERTY_TYPE> = {
     readonly propertyIdentifier: string;
 } & ImbricateDatabaseSchemaPropertyForCreation<T>;
-export type ImbricateDatabaseSchemaPropertyOptions<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BOOLEAN ? {} : T extends IMBRICATE_PROPERTY_TYPE.STRING ? {} : T extends IMBRICATE_PROPERTY_TYPE.NUMBER ? {} : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? {} : T extends IMBRICATE_PROPERTY_TYPE.REFERENCE ? {
+export type ImbricateDatabaseSchemaPropertyOptionsReferenceDatabase = {
+    readonly originUniqueIdentifier: string;
+    readonly databaseUniqueIdentifier: string;
+};
+export type ImbricateDatabaseSchemaPropertyOptionsLabelOption = {
+    readonly labelIdentifier: string;
+    readonly labelName: string;
+};
+export type ImbricateDatabaseSchemaPropertyOptionsLabel = {
+    /**
+     * Allow multiple labels
+     */
+    readonly allowMultiple: boolean;
+    readonly labelOptions: ImbricateDatabaseSchemaPropertyOptionsLabelOption[];
+};
+export type ImbricateDatabaseSchemaPropertyOptionsReference = {
     /**
      * Allow multiple references
      */
@@ -16,8 +31,9 @@ export type ImbricateDatabaseSchemaPropertyOptions<T extends IMBRICATE_PROPERTY_
      * Allow references from these databases
      *  If empty, allow references from all databases
      */
-    readonly databases: string[];
-} : never;
+    readonly databases: ImbricateDatabaseSchemaPropertyOptionsReferenceDatabase[];
+};
+export type ImbricateDatabaseSchemaPropertyOptions<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BOOLEAN ? {} : T extends IMBRICATE_PROPERTY_TYPE.STRING ? {} : T extends IMBRICATE_PROPERTY_TYPE.NUMBER ? {} : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? {} : T extends IMBRICATE_PROPERTY_TYPE.DATE ? {} : T extends IMBRICATE_PROPERTY_TYPE.LABEL ? ImbricateDatabaseSchemaPropertyOptionsLabel : T extends IMBRICATE_PROPERTY_TYPE.REFERENCE ? ImbricateDatabaseSchemaPropertyOptionsReference : never;
 export type ImbricateDatabaseSchemaPropertyForCreation<T extends IMBRICATE_PROPERTY_TYPE> = {
     readonly propertyName: string;
     readonly propertyType: T;

package/database/schema.js

@@ -33,6 +33,17 @@ const validateImbricateSchemaProperty = (property) => {
             if (typeof property.propertyOptions.allowMultiple !== "boolean") {
                 return "Property options allowMultiple must be a boolean";
             }
+            if (!Array.isArray(property.propertyOptions.databases)) {
+                return "Property options databases must be an array";
+            }
+            for (const database of property.propertyOptions.databases) {
+                if (typeof database.originUniqueIdentifier !== "string") {
+                    return "Database originUniqueIdentifier must be a string";
+                }
+                if (typeof database.databaseUniqueIdentifier !== "string") {
+                    return "Database databaseUniqueIdentifier must be a string";
+                }
+            }
             break;
         }
     }

package/document/property.d.ts

@@ -23,6 +23,16 @@ export declare enum IMBRICATE_PROPERTY_TYPE {
      * MARKDOWN - markdown, store as text object unique identifier. Display as markdown
      */
     MARKDOWN = "MARKDOWN",
+    /**
+     * DATE - date, store as string in ISO format
+     *  For example - 2000-01-01T00:00:00.000Z
+     */
+    DATE = "DATE",
+    /**
+     * LABEL - label, store as a list of label id
+     *  Note: Label is always stored as an array, even if it is a single label
+     */
+    LABEL = "LABEL",
     /**
      * REFERENCE - reference, store as a list of other document unique identifier
      *  Note: Reference is always stored as an array, even if it is a single reference
@@ -44,7 +54,12 @@ export type DocumentPropertyValue<T extends IMBRICATE_PROPERTY_TYPE> = {
     readonly type: T;
     readonly value: DocumentPropertyValueObject<T>;
 };
-export type DocumentPropertyValueObject<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BOOLEAN ? boolean : T extends IMBRICATE_PROPERTY_TYPE.STRING ? string : T extends IMBRICATE_PROPERTY_TYPE.NUMBER ? number : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? string : T extends IMBRICATE_PROPERTY_TYPE.REFERENCE ? string[] : never;
+export type DocumentPropertyValueObjectReference = {
+    readonly originUniqueIdentifier: string;
+    readonly databaseUniqueIdentifier: string;
+    readonly documentUniqueIdentifier: string;
+};
+export type DocumentPropertyValueObject<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BOOLEAN ? boolean : T extends IMBRICATE_PROPERTY_TYPE.STRING ? string : T extends IMBRICATE_PROPERTY_TYPE.NUMBER ? number : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? string : T extends IMBRICATE_PROPERTY_TYPE.DATE ? string : T extends IMBRICATE_PROPERTY_TYPE.LABEL ? string[] : T extends IMBRICATE_PROPERTY_TYPE.REFERENCE ? DocumentPropertyValueObjectReference[] : never;
 /**
  * Edit record type of the document
  */

package/document/property.js

@@ -27,6 +27,16 @@ var IMBRICATE_PROPERTY_TYPE;
      * MARKDOWN - markdown, store as text object unique identifier. Display as markdown
      */
     IMBRICATE_PROPERTY_TYPE["MARKDOWN"] = "MARKDOWN";
+    /**
+     * DATE - date, store as string in ISO format
+     *  For example - 2000-01-01T00:00:00.000Z
+     */
+    IMBRICATE_PROPERTY_TYPE["DATE"] = "DATE";
+    /**
+     * LABEL - label, store as a list of label id
+     *  Note: Label is always stored as an array, even if it is a single label
+     */
+    IMBRICATE_PROPERTY_TYPE["LABEL"] = "LABEL";
     /**
      * REFERENCE - reference, store as a list of other document unique identifier
      *  Note: Reference is always stored as an array, even if it is a single reference

package/document/validate.js

@@ -65,8 +65,17 @@ const validateImbricateProperties = (properties, schema) => {
                     return `Property ${key} value must be an array of string`;
                 }
                 for (const reference of value.value) {
-                    if (typeof reference !== "string") {
-                        return `Property ${key} value must be an array of string, but got ${typeof reference}`;
+                    if (typeof reference !== "object") {
+                        return `Property ${key} reference must be an object`;
+                    }
+                    if (typeof reference.originUniqueIdentifier !== "string") {
+                        return `Property ${key} reference originUniqueIdentifier must be a string`;
+                    }
+                    if (typeof reference.databaseUniqueIdentifier !== "string") {
+                        return `Property ${key} reference databaseUniqueIdentifier must be a string`;
+                    }
+                    if (typeof reference.documentUniqueIdentifier !== "string") {
+                        return `Property ${key} reference documentUniqueIdentifier must be a string`;
                     }
                 }
                 break;

package/index.d.ts

@@ -19,6 +19,7 @@ export * from "./loader/origin-loader";
 export * from "./loader/persistence";
 export * from "./origin/definition";
 export * from "./origin/interface";
+export * from "./origin/search";
 export * from "./static/interface";
 export * from "./static/manager";
 export * from "./text/interface";

package/index.js

@@ -35,6 +35,7 @@ __exportStar(require("./loader/origin-loader"), exports);
 __exportStar(require("./loader/persistence"), exports);
 __exportStar(require("./origin/definition"), exports);
 __exportStar(require("./origin/interface"), exports);
+__exportStar(require("./origin/search"), exports);
 __exportStar(require("./static/interface"), exports);
 __exportStar(require("./static/manager"), exports);
 __exportStar(require("./text/interface"), exports);

package/origin/interface.d.ts

@@ -7,6 +7,7 @@ import { IImbricateDatabaseManager } from "../database/manager";
 import { IImbricateStaticManager } from "../static/manager";
 import { IImbricateTextManager } from "../text/manager";
 import { OriginPayload } from "./definition";
+import { ImbricateSearchItem } from "./search";
 export interface IImbricateOrigin {
     /**
      * Unique identifier of the origin
@@ -46,4 +47,11 @@ export interface IImbricateOrigin {
      * Example: close database connection, or close file system
      */
     dispose?(): PromiseLike<void>;
+    /**
+     * Search for items in the origin
+     *
+     * @param keyword the keyword to search
+     * @returns the search
+     */
+    search(keyword: string): PromiseLike<ImbricateSearchItem>;
 }

package/origin/search.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @author WMXPY
+ * @namespace Origin
+ * @description Search
+ */
+export declare enum IMBRICATE_SEARCH_TARGET_TYPE {
+    DATABASE = "DATABASE",
+    DOCUMENT = "DOCUMENT",
+    MARKDOWN = "MARKDOWN"
+}
+export type ImbricateSearchTargetSwitch<T extends IMBRICATE_SEARCH_TARGET_TYPE> = T extends IMBRICATE_SEARCH_TARGET_TYPE.DATABASE ? {
+    databaseUniqueIdentifier: string;
+} : T extends IMBRICATE_SEARCH_TARGET_TYPE.DOCUMENT ? {
+    databaseUniqueIdentifier: string;
+    documentUniqueIdentifier: string;
+} : T extends IMBRICATE_SEARCH_TARGET_TYPE.MARKDOWN ? {
+    databaseUniqueIdentifier: string;
+    documentUniqueIdentifier: string;
+    propertyUniqueIdentifier: string;
+    lineNumber: number;
+} : never;
+export type ImbricateSearchTarget<T extends IMBRICATE_SEARCH_TARGET_TYPE> = {
+    readonly type: T;
+    readonly target: ImbricateSearchTargetSwitch<T>;
+};
+export type ImbricateSearchItem = {
+    readonly target: ImbricateSearchTarget<IMBRICATE_SEARCH_TARGET_TYPE>;
+    readonly primary: string;
+    readonly secondary: string;
+};
+export type ImbricateSearchResult = {
+    readonly items: ImbricateSearchItem[];
+};

package/origin/search.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Origin
+ * @description Search
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_SEARCH_TARGET_TYPE = void 0;
+var IMBRICATE_SEARCH_TARGET_TYPE;
+(function (IMBRICATE_SEARCH_TARGET_TYPE) {
+    IMBRICATE_SEARCH_TARGET_TYPE["DATABASE"] = "DATABASE";
+    IMBRICATE_SEARCH_TARGET_TYPE["DOCUMENT"] = "DOCUMENT";
+    IMBRICATE_SEARCH_TARGET_TYPE["MARKDOWN"] = "MARKDOWN";
+})(IMBRICATE_SEARCH_TARGET_TYPE || (exports.IMBRICATE_SEARCH_TARGET_TYPE = IMBRICATE_SEARCH_TARGET_TYPE = {}));

package/package.json

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