@imbricate/core 3.0.1 → 3.0.3

package/database/interface.d.ts

@@ -12,10 +12,17 @@ export interface IImbricateDatabase {
      * Unique identifier of the database
      */
     readonly uniqueIdentifier: string;
+    /**
+     * Name of the database
+     */
     readonly databaseName: string;
+    /**
+     * Schema of the database
+     */
     readonly schema: ImbricateDatabaseSchema;
     /**
      * 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
@@ -27,6 +34,8 @@ export interface IImbricateDatabase {
     /**
      * Get one document from the database
      *
+     * @param uniqueIdentifier unique identifier of the document
+     *
      * @returns a promise of the documents in the database, null if not found
      */
     getDocument(uniqueIdentifier: string): PromiseLike<IImbricateDocument | null>;

package/document/definition.d.ts

@@ -4,11 +4,11 @@
  * @description Definition
  */
 import { ImbricateAuthor } from "../author/definition";
-import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_DOCUMENT_EDIT_TYPE } from "./property";
+import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_DOCUMENT_EDIT_TYPE, IMBRICATE_PROPERTY_TYPE } from "./property";
 export type DocumentEditOperation = {
     readonly key: DocumentPropertyKey;
     readonly action: IMBRICATE_DOCUMENT_EDIT_TYPE;
-    readonly value: DocumentPropertyValue;
+    readonly value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>;
 };
 export type DocumentEditRecord = {
     readonly uniqueIdentifier: string;

package/document/interface.d.ts

@@ -4,7 +4,7 @@
  * @description Interface
  */
 import { DocumentEditRecord } from "./definition";
-import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue } from "./property";
+import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
 export interface IImbricateDocument {
     /**
      * Unique identifier of the database
@@ -15,20 +15,26 @@ 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
      *
      * @returns a promise of the edit records of the document
-     *  Note: the edit records will not be added to the document, the best practice is to call addEditRecords to add the edit records.
+     *  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): PromiseLike<DocumentEditRecord[]>;
+    putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, noEditRecord?: boolean): 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
      *
      * @returns a promise of the edit records of the document
-     *  Note: the edit records will not be added to the document, the best practice is to call addEditRecords to add the edit records.
+     *  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): PromiseLike<DocumentEditRecord[]>;
+    putProperties(properties: DocumentProperties, noEditRecord?: boolean): PromiseLike<DocumentEditRecord[]>;
     /**
      * Get properties from the document
      *
@@ -36,15 +42,21 @@ export interface IImbricateDocument {
      */
     getProperties(): PromiseLike<DocumentProperties>;
     /**
-     * Add edit records to the document
+     * Add edit records to the document, optional
+     *  This method is optional, if not implemented, means the origin
+     *  1. The origin does not support edit records
+     *  2. The origin force to add edit records when put properties
      *
      * @param records document edit records
      */
-    addEditRecords(records: DocumentEditRecord[]): PromiseLike<void>;
+    addEditRecords?(records: DocumentEditRecord[]): PromiseLike<void>;
     /**
-     * Get edit records of the document
+     * Get edit records of the document, optional
+     *  This method is optional, if not implemented, means the origin
+     *  1. The origin does not support edit records
+     *  2. The origin force to add edit records when put properties
      *
      * @returns a promise of the edit records of the document
      */
-    getEditRecords(): PromiseLike<DocumentEditRecord[]>;
+    getEditRecords?(): PromiseLike<DocumentEditRecord[]>;
 }

package/document/property/definition.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Definition
+ */
+import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "../property";
+export type DocumentPropertyTriageFunction<T extends IMBRICATE_PROPERTY_TYPE, Result> = (propertyKey: DocumentPropertyKey, value: DocumentPropertyValue<T>) => Result;

package/document/property/definition.js

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

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

@@ -0,0 +1,24 @@
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Triage Base
+ */
+import { DocumentProperties, DocumentPropertyKey, IMBRICATE_PROPERTY_TYPE } from "../property";
+import { DocumentPropertyTriageFunction } from "./definition";
+export declare class ImbricateDocumentPropertyTriageBase<Result> {
+    private readonly _triageFunctionsByKey;
+    private readonly _triageFunctionsByType;
+    protected constructor();
+    /**
+     * Set triage function for property key,
+     *  This action will override document value based triage functions
+     *
+     * @param propertyKey property key
+     * @param triageFunction triage function
+     * @returns triage manager
+     */
+    forPropertyKey<T extends IMBRICATE_PROPERTY_TYPE>(propertyKey: DocumentPropertyKey, triageFunction: DocumentPropertyTriageFunction<T, Result>): this;
+    forString(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.STRING, Result>): this;
+    forMarkdown(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.MARKDOWN, Result>): this;
+    protected _collect(properties: DocumentProperties): Map<DocumentPropertyKey, Result>;
+}

package/document/property/triage-base.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Triage Base
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateDocumentPropertyTriageBase = void 0;
+const property_1 = require("../property");
+class ImbricateDocumentPropertyTriageBase {
+    constructor() {
+        this._triageFunctionsByKey = new Map();
+        this._triageFunctionsByType = new Map();
+    }
+    /**
+     * Set triage function for property key,
+     *  This action will override document value based triage functions
+     *
+     * @param propertyKey property key
+     * @param triageFunction triage function
+     * @returns triage manager
+     */
+    forPropertyKey(propertyKey, triageFunction) {
+        this._triageFunctionsByKey.set(propertyKey, triageFunction);
+        return this;
+    }
+    forString(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.STRING, triageFunction);
+        return this;
+    }
+    forMarkdown(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN, triageFunction);
+        return this;
+    }
+    _collect(properties) {
+        const keys = Object.keys(properties);
+        const result = new Map();
+        for (const key of keys) {
+            const property = properties[key];
+            const triageFunction = this._triageFunctionsByKey.get(key);
+            if (typeof triageFunction === "function") {
+                const value = triageFunction(key, property);
+                result.set(key, value);
+                continue;
+            }
+            const typeFunction = this._triageFunctionsByType.get(property.type);
+            if (typeof typeFunction === "function") {
+                const value = typeFunction(key, property);
+                result.set(key, value);
+                continue;
+            }
+        }
+        return result;
+    }
+}
+exports.ImbricateDocumentPropertyTriageBase = ImbricateDocumentPropertyTriageBase;

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

@@ -0,0 +1,30 @@
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Triage Manager
+ */
+import { DocumentProperties, DocumentPropertyKey } from "../property";
+import { ImbricateDocumentPropertyTriageBase } from "./triage-base";
+export declare class ImbricateDocumentPropertyTriageManager<Result> extends ImbricateDocumentPropertyTriageBase<Result> {
+    static create<Result>(properties: DocumentProperties): ImbricateDocumentPropertyTriageManager<Result>;
+    private readonly _properties;
+    private constructor();
+    /**
+     * Collect the result as array
+     *
+     * @returns collected result as array
+     */
+    collectAsArray(): Result[];
+    /**
+     * Collect the result as map
+     *
+     * @returns collected result as map
+     */
+    collectAsMap(): Map<DocumentPropertyKey, Result>;
+    /**
+     * Collect the result as object
+     *
+     * @returns collected result as object
+     */
+    collectAsObject(): Record<DocumentPropertyKey, Result>;
+}

package/document/property/triage-manager.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Triage Manager
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImbricateDocumentPropertyTriageManager = void 0;
+const triage_base_1 = require("./triage-base");
+class ImbricateDocumentPropertyTriageManager extends triage_base_1.ImbricateDocumentPropertyTriageBase {
+    static create(properties) {
+        return new ImbricateDocumentPropertyTriageManager(properties);
+    }
+    constructor(properties) {
+        super();
+        this._properties = properties;
+    }
+    /**
+     * Collect the result as array
+     *
+     * @returns collected result as array
+     */
+    collectAsArray() {
+        const result = super._collect(this._properties);
+        return Array.from(result.values());
+    }
+    /**
+     * Collect the result as map
+     *
+     * @returns collected result as map
+     */
+    collectAsMap() {
+        return super._collect(this._properties);
+    }
+    /**
+     * Collect the result as object
+     *
+     * @returns collected result as object
+     */
+    collectAsObject() {
+        const result = super._collect(this._properties);
+        const keys = Array.from(result.keys());
+        const object = {};
+        for (const key of keys) {
+            object[key] = result.get(key);
+        }
+        return object;
+    }
+}
+exports.ImbricateDocumentPropertyTriageManager = ImbricateDocumentPropertyTriageManager;

package/document/property/triage.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Triage
+ */
+import { DocumentProperties } from "../property";
+import { ImbricateDocumentPropertyTriageManager } from "./triage-manager";
+export declare const triageImbricateDocumentProperties: <Result>(properties: DocumentProperties) => ImbricateDocumentPropertyTriageManager<Result>;

package/document/property/triage.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document_Property
+ * @description Triage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.triageImbricateDocumentProperties = void 0;
+const triage_manager_1 = require("./triage-manager");
+const triageImbricateDocumentProperties = (properties) => {
+    return triage_manager_1.ImbricateDocumentPropertyTriageManager.create(properties);
+};
+exports.triageImbricateDocumentProperties = triageImbricateDocumentProperties;

package/document/property.d.ts

@@ -3,16 +3,29 @@
  * @namespace Document
  * @description Property
  */
+/**
+ * Document properties
+ *
+ * STRING - string, store as plain text
+ * MARKDOWN - markdown, store as text object unique identifier. Display as markdown
+ */
 export declare enum IMBRICATE_PROPERTY_TYPE {
     STRING = "STRING",
     MARKDOWN = "MARKDOWN"
 }
-export type DocumentProperties = Record<DocumentPropertyKey, DocumentPropertyValue>;
+/**
+ * Document properties
+ */
+export type DocumentProperties = Record<DocumentPropertyKey, DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>>;
 export type DocumentPropertyKey = string;
-export type DocumentPropertyValue = {
+export type DocumentPropertyValue<T extends IMBRICATE_PROPERTY_TYPE> = {
     readonly type: IMBRICATE_PROPERTY_TYPE;
-    readonly value: any;
+    readonly value: DocumentPropertyValueObject<T>;
 };
+export type DocumentPropertyValueObject<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.STRING ? string : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? string : never;
+/**
+ * Edit record type of the document
+ */
 export declare enum IMBRICATE_DOCUMENT_EDIT_TYPE {
     PUT = "PUT"
 }

package/document/property.js

@@ -6,11 +6,20 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IMBRICATE_DOCUMENT_EDIT_TYPE = exports.IMBRICATE_PROPERTY_TYPE = void 0;
+/**
+ * Document properties
+ *
+ * STRING - string, store as plain text
+ * MARKDOWN - markdown, store as text object unique identifier. Display as markdown
+ */
 var IMBRICATE_PROPERTY_TYPE;
 (function (IMBRICATE_PROPERTY_TYPE) {
     IMBRICATE_PROPERTY_TYPE["STRING"] = "STRING";
     IMBRICATE_PROPERTY_TYPE["MARKDOWN"] = "MARKDOWN";
 })(IMBRICATE_PROPERTY_TYPE || (exports.IMBRICATE_PROPERTY_TYPE = IMBRICATE_PROPERTY_TYPE = {}));
+/**
+ * Edit record type of the document
+ */
 var IMBRICATE_DOCUMENT_EDIT_TYPE;
 (function (IMBRICATE_DOCUMENT_EDIT_TYPE) {
     IMBRICATE_DOCUMENT_EDIT_TYPE["PUT"] = "PUT";

package/index.d.ts

@@ -10,6 +10,9 @@ export * from "./database/schema";
 export * from "./document/definition";
 export * from "./document/interface";
 export * from "./document/property";
+export * from "./document/property/definition";
+export * from "./document/property/triage";
+export * from "./document/property/triage-manager";
 export * from "./document/validate";
 export * from "./loader/definition";
 export * from "./loader/origin-loader";

package/index.js

@@ -26,6 +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/definition"), exports);
+__exportStar(require("./document/property/triage"), exports);
+__exportStar(require("./document/property/triage-manager"), exports);
 __exportStar(require("./document/validate"), exports);
 __exportStar(require("./loader/definition"), exports);
 __exportStar(require("./loader/origin-loader"), exports);

package/loader/origin-loader.d.ts

@@ -5,5 +5,25 @@
  */
 import { IImbricateOrigin } from "../origin/interface";
 import { ImbricateOriginPersistance, ImbricateOriginPersistanceOrigin } from "./persistance";
+/**
+ * Load imbricate origin from persistance origin
+ *  This function will load the origin from the persistance origin
+ *  and initialize the origin with the payloads
+ *
+ * @param origin origin to persistance to load
+ *
+ * @returns a promise of the loaded origin
+ *  if the origin is not found, return null
+ */
 export declare const loadImbricateOriginFromPersistanceOrigin: (origin: ImbricateOriginPersistanceOrigin) => Promise<IImbricateOrigin | null>;
+/**
+ * Load imbricate origins from persistance
+ *  This function will load all origins from the persistance
+ *  and initialize the origins with the payloads
+ *  If the origin is not found, it will be ignored
+ *
+ * @param persistance persistance to load origins
+ *
+ * @returns a promise of the loaded origins, if the origin is not found, return empty array
+ */
 export declare const loadImbricateOriginsFromPersistance: (persistance: ImbricateOriginPersistance) => Promise<IImbricateOrigin[]>;

package/loader/origin-loader.js

@@ -39,6 +39,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadImbricateOriginsFromPersistance = exports.loadImbricateOriginFromPersistanceOrigin = void 0;
 const persistance_1 = require("./persistance");
+/**
+ * Load imbricate origin from persistance origin
+ *  This function will load the origin from the persistance origin
+ *  and initialize the origin with the payloads
+ *
+ * @param origin origin to persistance to load
+ *
+ * @returns a promise of the loaded origin
+ *  if the origin is not found, return null
+ */
 const loadImbricateOriginFromPersistanceOrigin = (origin) => __awaiter(void 0, void 0, void 0, function* () {
     switch (origin.originLoadType) {
         case persistance_1.IMBRICATE_ORIGIN_LOAD_TYPE.NPM_PACKAGE: {
@@ -61,6 +71,16 @@ const loadImbricateOriginFromPersistanceOrigin = (origin) => __awaiter(void 0, v
     return null;
 });
 exports.loadImbricateOriginFromPersistanceOrigin = loadImbricateOriginFromPersistanceOrigin;
+/**
+ * Load imbricate origins from persistance
+ *  This function will load all origins from the persistance
+ *  and initialize the origins with the payloads
+ *  If the origin is not found, it will be ignored
+ *
+ * @param persistance persistance to load origins
+ *
+ * @returns a promise of the loaded origins, if the origin is not found, return empty array
+ */
 const loadImbricateOriginsFromPersistance = (persistance) => __awaiter(void 0, void 0, void 0, function* () {
     const origins = [];
     for (const origin of persistance.origins) {

package/loader/persistance.d.ts

@@ -4,6 +4,12 @@
  * @description Persistance
  */
 import { OriginPayload } from "../origin/definition";
+/**
+ * Imbricate Origin Load Type
+ *
+ * NPM_PACKAGE - load origin from npm package, as package name
+ * FILE_SYSTEM - load origin from file system, as file path
+ */
 export declare enum IMBRICATE_ORIGIN_LOAD_TYPE {
     NPM_PACKAGE = "NPM_PACKAGE",
     FILE_SYSTEM = "FILE_SYSTEM"

package/loader/persistance.js

@@ -6,6 +6,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IMBRICATE_ORIGIN_LOAD_TYPE = void 0;
+/**
+ * Imbricate Origin Load Type
+ *
+ * NPM_PACKAGE - load origin from npm package, as package name
+ * FILE_SYSTEM - load origin from file system, as file path
+ */
 var IMBRICATE_ORIGIN_LOAD_TYPE;
 (function (IMBRICATE_ORIGIN_LOAD_TYPE) {
     IMBRICATE_ORIGIN_LOAD_TYPE["NPM_PACKAGE"] = "NPM_PACKAGE";

package/origin/interface.d.ts

@@ -39,6 +39,11 @@ export interface IImbricateOrigin {
     /**
      * Dispose the origin, optional
      * This method will be called when the origin is no longer needed
+     *
+     * If the origin needs to dispose resources, override this method
+     *  else, do not implement this method
+     *
+     * Example: close database connection, or close file system
      */
     dispose?(): PromiseLike<void>;
 }

package/package.json

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