@imbricate/core 3.0.2 → 3.0.4

package/database/definition.d.ts

@@ -3,6 +3,8 @@
  * @namespace Database
  * @description Definition
  */
+import { ImbricateAuthor } from "../author/definition";
+import { ImbricateDatabaseSchema } from "./schema";
 /**
  * Query of the document
  *
@@ -13,3 +15,19 @@ export type ImbricateDocumentQuery = {
     readonly limit?: number;
     readonly skip?: number;
 };
+/**
+ * Edit record type of the document
+ */
+export declare enum IMBRICATE_DATABASE_EDIT_TYPE {
+    PUT_SCHEMA = "PUT_SCHEMA"
+}
+export type DatabaseEditOperation = {
+    readonly action: IMBRICATE_DATABASE_EDIT_TYPE;
+    readonly value: ImbricateDatabaseSchema;
+};
+export type DatabaseEditRecord = {
+    readonly uniqueIdentifier: string;
+    readonly editAt: Date;
+    readonly author: ImbricateAuthor;
+    readonly operations: DatabaseEditOperation[];
+};

package/database/definition.js

@@ -5,3 +5,11 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMBRICATE_DATABASE_EDIT_TYPE = void 0;
+/**
+ * Edit record type of the document
+ */
+var IMBRICATE_DATABASE_EDIT_TYPE;
+(function (IMBRICATE_DATABASE_EDIT_TYPE) {
+    IMBRICATE_DATABASE_EDIT_TYPE["PUT_SCHEMA"] = "PUT_SCHEMA";
+})(IMBRICATE_DATABASE_EDIT_TYPE || (exports.IMBRICATE_DATABASE_EDIT_TYPE = IMBRICATE_DATABASE_EDIT_TYPE = {}));

package/database/interface.d.ts

@@ -5,7 +5,7 @@
  */
 import { IImbricateDocument } from "../document/interface";
 import { DocumentProperties } from "../document/property";
-import { ImbricateDocumentQuery } from "./definition";
+import { DatabaseEditRecord, ImbricateDocumentQuery } from "./definition";
 import { ImbricateDatabaseSchema } from "./schema";
 export interface IImbricateDatabase {
     /**
@@ -20,6 +20,18 @@ export interface IImbricateDatabase {
      * Schema of the database
      */
     readonly schema: ImbricateDatabaseSchema;
+    /**
+     * Put and replace the schema of the database
+     *  Existing documents will still be kept, and stays unchanged
+     *
+     * @param schema schema of the database
+     * @param noEditRecord do not add edit record, optional
+     *
+     * @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>;
     /**
      * Create a new document in the database
      *  If origin supports Document Edit Record, the edit record will be added by default
@@ -47,4 +59,22 @@ export interface IImbricateDatabase {
      * @returns a promise of the documents in the database
      */
     queryDocuments(query: ImbricateDocumentQuery): PromiseLike<IImbricateDocument[]>;
+    /**
+     * Add edit records to the database, 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 database edit records
+     */
+    addEditRecords?(records: DatabaseEditRecord[]): PromiseLike<void>;
+    /**
+     * Get edit records of the database, 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 database
+     */
+    getEditRecords?(): PromiseLike<DatabaseEditRecord[]>;
 }

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
@@ -22,7 +22,7 @@ export interface IImbricateDocument {
      *  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, noEditRecord?: boolean): PromiseLike<DocumentEditRecord[]>;
+    putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, noEditRecord?: boolean): PromiseLike<DocumentEditRecord[]>;
     /**
      * Put and replace all properties of the document
      *

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

@@ -16,12 +16,13 @@ export declare enum IMBRICATE_PROPERTY_TYPE {
 /**
  * Document properties
  */
-export type DocumentProperties = Record<DocumentPropertyKey, DocumentPropertyValue>;
+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
  */

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/package.json

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