@imbricate/core 3.0.0 → 3.0.2

package/database/interface.d.ts

@@ -3,8 +3,8 @@
  * @namespace Database
  * @description Interface
  */
-import { DocumentProperties } from "../document/definition";
 import { IImbricateDocument } from "../document/interface";
+import { DocumentProperties } from "../document/property";
 import { ImbricateDocumentQuery } from "./definition";
 import { ImbricateDatabaseSchema } from "./schema";
 export interface IImbricateDatabase {
@@ -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/database/manager.d.ts

@@ -4,14 +4,22 @@
  * @description Manager
  */
 import { IImbricateDatabase } from "./interface";
-import { ImbricateDatabaseSchema } from "./schema";
+import { ImbricateDatabaseSchemaForCreation } from "./schema";
 export interface IImbricateDatabaseManager {
     /**
-     * Get databases from the origin
+     * List all databases in the origin
      *
      * @returns a promise of the databases in the origin
      */
-    getDatabases(): PromiseLike<IImbricateDatabase[]>;
+    listDatabases(): PromiseLike<IImbricateDatabase[]>;
+    /**
+     * Get one database from the origin
+     *
+     * @param uniqueIdentifier unique identifier of the database
+     *
+     * @returns a promise of the database, null if not found
+     */
+    getDatabase(uniqueIdentifier: string): PromiseLike<IImbricateDatabase | null>;
     /**
      * Create a new database
      *
@@ -22,5 +30,5 @@ export interface IImbricateDatabaseManager {
      *
      * @returns a promise of the created database
      */
-    createDatabase(databaseName: string, schema: ImbricateDatabaseSchema, uniqueIdentifier?: string): PromiseLike<IImbricateDatabase>;
+    createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, uniqueIdentifier?: string): PromiseLike<IImbricateDatabase>;
 }

package/database/schema.d.ts

@@ -3,12 +3,35 @@
  * @namespace Database
  * @description Schema
  */
-import { IMBRICATE_PROPERTY_TYPE } from "../document/definition";
+import { IMBRICATE_PROPERTY_TYPE } from "../document/property";
 export type ImbricateDatabaseSchemaProperty = {
     readonly propertyIdentifier: string;
+} & ImbricateDatabaseSchemaPropertyForCreation;
+export type ImbricateDatabaseSchemaPropertyForCreation = {
     readonly propertyName: string;
     readonly propertyType: IMBRICATE_PROPERTY_TYPE;
 };
 export type ImbricateDatabaseSchema = {
     readonly properties: ImbricateDatabaseSchemaProperty[];
 };
+export type ImbricateDatabaseSchemaForCreation = {
+    readonly properties: ImbricateDatabaseSchemaPropertyForCreation[];
+};
+/**
+ * Validate a schema property
+ *
+ * @param property property to validate
+ *
+ * @returns a string error message if validation failed
+ *      null if validation passed
+ */
+export declare const validateImbricateSchemaProperty: (property: ImbricateDatabaseSchemaProperty) => string | null;
+/**
+ * Validate a schema
+ *
+ * @param schema database schema to validate
+ *
+ * @returns a string error message if validation failed
+ *    null if validation passed
+ */
+export declare const validateImbricateSchema: (schema: ImbricateDatabaseSchema) => string | null;

package/database/schema.js

@@ -5,3 +5,52 @@
  * @description Schema
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateImbricateSchema = exports.validateImbricateSchemaProperty = void 0;
+const property_1 = require("../document/property");
+/**
+ * Validate a schema property
+ *
+ * @param property property to validate
+ *
+ * @returns a string error message if validation failed
+ *      null if validation passed
+ */
+const validateImbricateSchemaProperty = (property) => {
+    if (typeof property.propertyIdentifier !== "string") {
+        return "Property identifier must be a string";
+    }
+    if (typeof property.propertyName !== "string") {
+        return "Property name must be a string";
+    }
+    if (!Object.values(property_1.IMBRICATE_PROPERTY_TYPE).includes(property.propertyType)) {
+        return "Property type must be a valid type";
+    }
+    return null;
+};
+exports.validateImbricateSchemaProperty = validateImbricateSchemaProperty;
+/**
+ * Validate a schema
+ *
+ * @param schema database schema to validate
+ *
+ * @returns a string error message if validation failed
+ *    null if validation passed
+ */
+const validateImbricateSchema = (schema) => {
+    if (!Array.isArray(schema.properties)) {
+        return "Properties must be an array";
+    }
+    const propertyNames = new Set();
+    for (const property of schema.properties) {
+        const propertyValidationResult = (0, exports.validateImbricateSchemaProperty)(property);
+        if (typeof propertyValidationResult === "string") {
+            return `Invalid property ${property.propertyName}, ${propertyValidationResult}`;
+        }
+        if (propertyNames.has(property.propertyName)) {
+            return `Duplicated property name ${property.propertyName}`;
+        }
+        propertyNames.add(property.propertyName);
+    }
+    return null;
+};
+exports.validateImbricateSchema = validateImbricateSchema;

package/document/definition.d.ts

@@ -4,19 +4,7 @@
  * @description Definition
  */
 import { ImbricateAuthor } from "../author/definition";
-export declare enum IMBRICATE_PROPERTY_TYPE {
-    STRING = "STRING",
-    MARKDOWN = "MARKDOWN"
-}
-export type DocumentProperties = Record<DocumentPropertyKey, DocumentPropertyValue>;
-export type DocumentPropertyKey = string;
-export type DocumentPropertyValue = {
-    readonly type: IMBRICATE_PROPERTY_TYPE;
-    readonly value: any;
-};
-export declare enum IMBRICATE_DOCUMENT_EDIT_TYPE {
-    PUT = "PUT"
-}
+import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_DOCUMENT_EDIT_TYPE } from "./property";
 export type DocumentEditOperation = {
     readonly key: DocumentPropertyKey;
     readonly action: IMBRICATE_DOCUMENT_EDIT_TYPE;

package/document/definition.js

@@ -5,13 +5,3 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_DOCUMENT_EDIT_TYPE = exports.IMBRICATE_PROPERTY_TYPE = void 0;
-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 = {}));
-var IMBRICATE_DOCUMENT_EDIT_TYPE;
-(function (IMBRICATE_DOCUMENT_EDIT_TYPE) {
-    IMBRICATE_DOCUMENT_EDIT_TYPE["PUT"] = "PUT";
-})(IMBRICATE_DOCUMENT_EDIT_TYPE || (exports.IMBRICATE_DOCUMENT_EDIT_TYPE = IMBRICATE_DOCUMENT_EDIT_TYPE = {}));

package/document/interface.d.ts

@@ -3,7 +3,8 @@
  * @namespace Document
  * @description Interface
  */
-import { DocumentEditRecord, DocumentProperties, DocumentPropertyKey, DocumentPropertyValue } from "./definition";
+import { DocumentEditRecord } from "./definition";
+import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue } from "./property";
 export interface IImbricateDocument {
     /**
      * Unique identifier of the database
@@ -14,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, 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
      *
@@ -35,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.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @author WMXPY
+ * @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"
+}
+/**
+ * Document properties
+ */
+export type DocumentProperties = Record<DocumentPropertyKey, DocumentPropertyValue>;
+export type DocumentPropertyKey = string;
+export type DocumentPropertyValue = {
+    readonly type: IMBRICATE_PROPERTY_TYPE;
+    readonly value: any;
+};
+/**
+ * Edit record type of the document
+ */
+export declare enum IMBRICATE_DOCUMENT_EDIT_TYPE {
+    PUT = "PUT"
+}

package/document/property.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Property
+ */
+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";
+})(IMBRICATE_DOCUMENT_EDIT_TYPE || (exports.IMBRICATE_DOCUMENT_EDIT_TYPE = IMBRICATE_DOCUMENT_EDIT_TYPE = {}));

package/document/validate.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Validate
+ */
+import { ImbricateDatabaseSchema } from "../database/schema";
+import { DocumentProperties } from "./property";
+/**
+ * Validate properties with schema
+ *
+ * @param properties properties to validate
+ * @param schema database schema to validate
+ *
+ * @returns a string error message if validation failed
+ *        null if validation passed
+ */
+export declare const validateImbricateProperties: (properties: DocumentProperties, schema: ImbricateDatabaseSchema) => string | null;

package/document/validate.js

@@ -0,0 +1,55 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Validate
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateImbricateProperties = void 0;
+const property_1 = require("./property");
+/**
+ * Validate properties with schema
+ *
+ * @param properties properties to validate
+ * @param schema database schema to validate
+ *
+ * @returns a string error message if validation failed
+ *        null if validation passed
+ */
+const validateImbricateProperties = (properties, schema) => {
+    if (typeof properties !== "object") {
+        return "Properties must be an object";
+    }
+    const keys = Object.keys(properties);
+    for (const key of keys) {
+        const property = schema.properties.find((each) => {
+            return each.propertyName === key;
+        });
+        if (!property) {
+            return `Property ${key} not found in schema`;
+        }
+        const value = properties[key];
+        if (typeof value.type !== "string") {
+            return `Property ${key} type must be a string`;
+        }
+        if (value.type !== property.propertyType) {
+            return `Property ${key} type must be ${property.propertyType}, but got ${value.type}`;
+        }
+        switch (value.type) {
+            case property_1.IMBRICATE_PROPERTY_TYPE.STRING: {
+                if (typeof value.value !== "string") {
+                    return `Property ${key} value must be a string`;
+                }
+                break;
+            }
+            case property_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN: {
+                if (typeof value.value !== "string") {
+                    return `Property ${key} value must be a string of text object reference`;
+                }
+                break;
+            }
+        }
+    }
+    return null;
+};
+exports.validateImbricateProperties = validateImbricateProperties;

package/index.d.ts

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

package/index.js

@@ -25,6 +25,8 @@ __exportStar(require("./database/manager"), exports);
 __exportStar(require("./database/schema"), exports);
 __exportStar(require("./document/definition"), exports);
 __exportStar(require("./document/interface"), exports);
+__exportStar(require("./document/property"), exports);
+__exportStar(require("./document/validate"), exports);
 __exportStar(require("./loader/definition"), exports);
 __exportStar(require("./loader/origin-loader"), exports);
 __exportStar(require("./loader/persistance"), exports);

package/loader/origin-loader.d.ts

@@ -4,5 +4,26 @@
  * @description Origin Loader
  */
 import { IImbricateOrigin } from "../origin/interface";
-import { ImbricateOriginPersistance } from "./persistance";
+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

@@ -37,28 +37,56 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadImbricateOriginsFromPersistance = void 0;
+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: {
+            const originPackage = yield Promise.resolve(`${origin.originLoadValue}`).then(s => __importStar(require(s)));
+            if (typeof originPackage.default === "function") {
+                const initialized = originPackage.default.call(null, origin.originPayloads);
+                return initialized;
+            }
+            break;
+        }
+        case persistance_1.IMBRICATE_ORIGIN_LOAD_TYPE.FILE_SYSTEM: {
+            const originPackage = yield Promise.resolve(`${origin.originLoadValue}`).then(s => __importStar(require(s)));
+            if (typeof originPackage.default === "function") {
+                const initialized = originPackage.default.call(null, origin.originPayloads);
+                return initialized;
+            }
+            break;
+        }
+    }
+    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) {
-        switch (origin.originLoadType) {
-            case persistance_1.IMBRICATE_ORIGIN_LOAD_TYPE.NPM_PACKAGE: {
-                const originPackage = yield Promise.resolve(`${origin.originLoadValue}`).then(s => __importStar(require(s)));
-                if (typeof originPackage.default === "function") {
-                    const initialized = originPackage.default.call(null, origin.originPayloads);
-                    origins.push(initialized);
-                }
-                break;
-            }
-            case persistance_1.IMBRICATE_ORIGIN_LOAD_TYPE.FILE_SYSTEM: {
-                const originPackage = yield Promise.resolve(`${origin.originLoadValue}`).then(s => __importStar(require(s)));
-                if (typeof originPackage.default === "function") {
-                    const initialized = originPackage.default.call(null, origin.originPayloads);
-                    origins.push(initialized);
-                }
-                break;
-            }
+        const originInstance = yield (0, exports.loadImbricateOriginFromPersistanceOrigin)(origin);
+        if (originInstance) {
+            origins.push(originInstance);
         }
     }
     return 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.0",
+  "version": "3.0.2",
   "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",