@imbricate/core 3.4.0 → 3.6.0

package/database/definition.d.ts

@@ -31,3 +31,13 @@ export type DatabaseEditRecord = {
     readonly author: ImbricateAuthor;
     readonly operations: DatabaseEditOperation[];
 };
+export type ImbricateDatabaseAuditOptions = {
+    /**
+     * Do not add edit record, this is controlled an function may vary by origin
+     */
+    readonly noEditRecord?: boolean;
+    /**
+     * Use this author to add edit record, this is controlled an function may vary by origin
+     */
+    readonly author?: ImbricateAuthor;
+};

package/database/interface.d.ts

@@ -5,7 +5,7 @@
  */
 import { IImbricateDocument } from "../document/interface";
 import { DocumentProperties } from "../document/property";
-import { DatabaseEditRecord, ImbricateDocumentQuery } from "./definition";
+import { DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
 import { ImbricateDatabaseSchema } from "./schema";
 export interface IImbricateDatabase {
     /**
@@ -25,24 +25,23 @@ export interface IImbricateDatabase {
      *  Existing documents will still be kept, and stays unchanged
      *
      * @param schema schema of the database
-     * @param noEditRecord do not add edit record, optional
+     * @param auditOptions audit options of the database
      *
      * @returns a promise of the updated schema
      *  Note: if the origin supports Document Edit Record, the edit record will be added by default
      *  If you do not want to add the edit record, set `noEditRecord` to true
      */
-    putSchema(schema: ImbricateDatabaseSchema, noEditRecord?: boolean): PromiseLike<void>;
+    putSchema(schema: ImbricateDatabaseSchema, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<void>;
     /**
      * Create a new document in the database
      *  If origin supports Document Edit Record, the edit record will be added by default
      *
      * @param properties properties of the document
-     * @param uniqueIdentifier unique identifier of the document, optional
-     *  if not provided, a unique identifier will be generated
+     * @param auditOptions audit options of the document
      *
      * @returns a promise of the created document
      */
-    createDocument(properties: DocumentProperties, uniqueIdentifier?: string): PromiseLike<IImbricateDocument>;
+    createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDocument>;
     /**
      * Get one document from the database
      *

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.IMBRISCRIPT ? {} : 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/definition.d.ts

@@ -16,3 +16,13 @@ export type DocumentEditRecord = {
     readonly author: ImbricateAuthor;
     readonly operations: DocumentEditOperation[];
 };
+export type ImbricateDocumentAuditOptions = {
+    /**
+     * Do not add edit record, this is controlled an function may vary by origin
+     */
+    readonly noEditRecord?: boolean;
+    /**
+     * Use this author to add edit record, this is controlled an function may vary by origin
+     */
+    readonly author?: ImbricateAuthor;
+};

package/document/interface.d.ts

@@ -3,7 +3,7 @@
  * @namespace Document
  * @description Interface
  */
-import { DocumentEditRecord } from "./definition";
+import { DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
 import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
 export interface IImbricateDocument {
     /**
@@ -19,26 +19,24 @@ export interface IImbricateDocument {
      *
      * @param key key of the property
      * @param value value of the property
-     * @param noEditRecord do not add edit record, optional
-     *  Default to false, if set to true, the edit record will not be added to the document
+     * @param auditOptions audit options of the document
      *
      * @returns a promise of the edit records of the document
      *  Note: the edit records will not be added to the document if `noEditRecord` is true,
      *  Call `addEditRecords` to add the edit records manually.
      */
-    putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, noEditRecord?: boolean): PromiseLike<DocumentEditRecord[]>;
+    putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<DocumentEditRecord[]>;
     /**
      * Put and replace all properties of the document
      *
      * @param properties properties of the document
-     * @param noEditRecord do not add edit record, optional
-     *  Default to false, if set to true, the edit record will not be added to the document
+     * @param auditOptions audit options of the document
      *
      * @returns a promise of the edit records of the document
      *  Note: the edit records will not be added to the document if `noEditRecord` is true,
      *  Call `addEditRecords` to add the edit records manually.
      */
-    putProperties(properties: DocumentProperties, noEditRecord?: boolean): PromiseLike<DocumentEditRecord[]>;
+    putProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<DocumentEditRecord[]>;
     /**
      * Add edit records to the document, optional
      *  This method is optional, if not implemented, means the origin

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/triage-base.d.ts

@@ -22,6 +22,7 @@ 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;

package/document/property/triage-base.js

@@ -41,6 +41,10 @@ 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;

package/document/property.d.ts

@@ -23,6 +23,10 @@ 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
@@ -64,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.IMBRISCRIPT ? 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,10 @@ 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

package/document/validate.js

@@ -65,6 +65,12 @@ 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`;

package/index.d.ts

@@ -10,6 +10,7 @@ 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";

package/index.js

@@ -26,6 +26,7 @@ __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);

package/package.json

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