@imbricate/core 3.3.4 → 3.5.0

package/database/schema.d.ts

@@ -20,6 +20,9 @@ export type ImbricateDatabaseSchemaPropertyOptionsLabel = {
      * Allow multiple labels
      */
     readonly allowMultiple: boolean;
+    /**
+     * Label Options
+     */
     readonly labelOptions: ImbricateDatabaseSchemaPropertyOptionsLabelOption[];
 };
 export type ImbricateDatabaseSchemaPropertyOptionsReference = {
@@ -33,7 +36,7 @@ export type ImbricateDatabaseSchemaPropertyOptionsReference = {
      */
     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 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.JSON ? {} : T extends IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT ? {} : 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/document/property/default-value.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Default Value
+ */
+import { DocumentPropertyValueObject, IMBRICATE_PROPERTY_TYPE } from "../property";
+export declare const getImbricateDefaultValueOfProperty: (type: IMBRICATE_PROPERTY_TYPE) => DocumentPropertyValueObject<IMBRICATE_PROPERTY_TYPE>;

package/document/property/default-value.js

@@ -0,0 +1,25 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Default Value
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImbricateDefaultValueOfProperty = void 0;
+const property_1 = require("../property");
+// IMBRICATE_PROPERTY_TYPE SWITCH
+const getImbricateDefaultValueOfProperty = (type) => {
+    switch (type) {
+        case property_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN: return false;
+        case property_1.IMBRICATE_PROPERTY_TYPE.STRING: return "";
+        case property_1.IMBRICATE_PROPERTY_TYPE.NUMBER: return 0;
+        case property_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN: return "";
+        case property_1.IMBRICATE_PROPERTY_TYPE.JSON: return "";
+        case property_1.IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT: return "";
+        case property_1.IMBRICATE_PROPERTY_TYPE.DATE: return new Date().toISOString();
+        case property_1.IMBRICATE_PROPERTY_TYPE.LABEL: return [];
+        case property_1.IMBRICATE_PROPERTY_TYPE.REFERENCE: return [];
+    }
+    return null;
+};
+exports.getImbricateDefaultValueOfProperty = getImbricateDefaultValueOfProperty;

package/document/property/primary.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Primary
+ */
+import { ImbricateDatabaseSchema } from "../../database/schema";
+import { DocumentProperties, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "../property";
+export declare const findPrimaryProperty: (schema: ImbricateDatabaseSchema, properties: DocumentProperties) => DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE> | null;

package/document/property/primary.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Primary
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findPrimaryProperty = void 0;
+const findPrimaryProperty = (schema, properties) => {
+    for (const property of schema.properties) {
+        if (property.isPrimaryKey) {
+            const value = properties[property.propertyIdentifier];
+            if (value) {
+                return value;
+            }
+        }
+    }
+    return null;
+};
+exports.findPrimaryProperty = findPrimaryProperty;

package/document/property/triage-base.d.ts

@@ -22,6 +22,8 @@ export declare class ImbricateDocumentPropertyTriageBase<Result> {
     forString(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.STRING, Result>): this;
     forNumber(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.NUMBER, Result>): this;
     forMarkdown(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.MARKDOWN, Result>): this;
+    forJson(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.JSON, Result>): this;
+    forImbriscript(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT, Result>): this;
     forDate(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.DATE, Result>): this;
     forLabel(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.LABEL, Result>): this;
     forReference(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.REFERENCE, Result>): this;

package/document/property/triage-base.js

@@ -41,6 +41,14 @@ class ImbricateDocumentPropertyTriageBase {
         this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN, triageFunction);
         return this;
     }
+    forJson(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.JSON, triageFunction);
+        return this;
+    }
+    forImbriscript(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT, triageFunction);
+        return this;
+    }
     forDate(triageFunction) {
         this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.DATE, triageFunction);
         return this;

package/document/property.d.ts

@@ -23,6 +23,15 @@ export declare enum IMBRICATE_PROPERTY_TYPE {
      * MARKDOWN - markdown, store as text object unique identifier. Display as markdown
      */
     MARKDOWN = "MARKDOWN",
+    /**
+     * JSON - json, store as text object unique identifier. Display as JSON
+     */
+    JSON = "JSON",
+    /**
+     * IMBRISCRIPT - imbricate script, store as text object unique identifier. Display as imbricate script
+     *  The script is executed in a sandbox environment, using customized javascript engine
+     */
+    IMBRISCRIPT = "IMBRISCRIPT",
     /**
      * DATE - date, store as string in ISO format
      *  For example - 2000-01-01T00:00:00.000Z
@@ -59,7 +68,7 @@ export type DocumentPropertyValueObjectReference = {
     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;
+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.JSON ? string : T extends IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT ? 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,15 @@ var IMBRICATE_PROPERTY_TYPE;
      * MARKDOWN - markdown, store as text object unique identifier. Display as markdown
      */
     IMBRICATE_PROPERTY_TYPE["MARKDOWN"] = "MARKDOWN";
+    /**
+     * JSON - json, store as text object unique identifier. Display as JSON
+     */
+    IMBRICATE_PROPERTY_TYPE["JSON"] = "JSON";
+    /**
+     * IMBRISCRIPT - imbricate script, store as text object unique identifier. Display as imbricate script
+     *  The script is executed in a sandbox environment, using customized javascript engine
+     */
+    IMBRICATE_PROPERTY_TYPE["IMBRISCRIPT"] = "IMBRISCRIPT";
     /**
      * DATE - date, store as string in ISO format
      *  For example - 2000-01-01T00:00:00.000Z

package/document/validate.js

@@ -65,6 +65,18 @@ const validateImbricateProperties = (properties, schema, allowExtraProperties =
                 }
                 break;
             }
+            case property_1.IMBRICATE_PROPERTY_TYPE.JSON: {
+                if (typeof value.value !== "string") {
+                    return `Property ${key} value must be a string of text object reference`;
+                }
+                break;
+            }
+            case property_1.IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT: {
+                if (typeof value.value !== "string") {
+                    return `Property ${key} value must be a string of text object reference`;
+                }
+                break;
+            }
             case property_1.IMBRICATE_PROPERTY_TYPE.DATE: {
                 if (typeof value.value !== "string") {
                     return `Property ${key} value must be a string of date in ISO format`;

package/index.d.ts

@@ -10,7 +10,9 @@ export * from "./database/schema";
 export * from "./document/definition";
 export * from "./document/interface";
 export * from "./document/property";
+export * from "./document/property/default-value";
 export * from "./document/property/definition";
+export * from "./document/property/primary";
 export * from "./document/property/triage";
 export * from "./document/property/triage-manager";
 export * from "./document/validate";

package/index.js

@@ -26,7 +26,9 @@ __exportStar(require("./database/schema"), exports);
 __exportStar(require("./document/definition"), exports);
 __exportStar(require("./document/interface"), exports);
 __exportStar(require("./document/property"), exports);
+__exportStar(require("./document/property/default-value"), exports);
 __exportStar(require("./document/property/definition"), exports);
+__exportStar(require("./document/property/primary"), exports);
 __exportStar(require("./document/property/triage"), exports);
 __exportStar(require("./document/property/triage-manager"), exports);
 __exportStar(require("./document/validate"), exports);

package/origin/search.d.ts

@@ -26,7 +26,20 @@ export type ImbricateSearchTarget<T extends IMBRICATE_SEARCH_TARGET_TYPE> = {
 export type ImbricateSearchItem = {
     readonly target: ImbricateSearchTarget<IMBRICATE_SEARCH_TARGET_TYPE>;
     readonly primary: string;
+    /**
+     * @description Source are optional, use for source context
+     */
+    readonly sourceDatabaseName?: string;
+    readonly sourceDocumentPrimaryKey?: string;
+    /**
+     * @description Previous are optional, use for previous context on the secondary object
+     */
+    readonly secondaryPrevious?: string[];
     readonly secondary: string;
+    /**
+     * @description Next are optional, use for next context on the secondary object
+     */
+    readonly secondaryNext?: string[];
 };
 export type ImbricateSearchResult = {
     readonly items: ImbricateSearchItem[];

package/package.json

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