@imbricate/core 3.0.1 → 3.0.2

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

@@ -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, 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.d.ts

@@ -3,16 +3,28 @@
  * @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

@@ -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/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.2",
   "description": "Imbricate Core, Notebook for Engineers",
   "repository": {
     "type": "git",