@imbricate/core 3.0.3 → 3.1.0

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

@@ -15,11 +15,17 @@ export declare enum IMBRICATE_PROPERTY_TYPE {
 }
 /**
  * Document properties
+ *
+ * Key - Property key, which should match schema properties unique identifier
+ * Value - Property value, which should match schema properties type
  */
 export type DocumentProperties = Record<DocumentPropertyKey, DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>>;
+/**
+ * Document property key, which should match schema properties unique identifier
+ */
 export type DocumentPropertyKey = string;
 export type DocumentPropertyValue<T extends IMBRICATE_PROPERTY_TYPE> = {
-    readonly type: IMBRICATE_PROPERTY_TYPE;
+    readonly type: T;
     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;

package/document/validate.js

@@ -23,7 +23,7 @@ const validateImbricateProperties = (properties, schema) => {
     const keys = Object.keys(properties);
     for (const key of keys) {
         const property = schema.properties.find((each) => {
-            return each.propertyName === key;
+            return each.propertyIdentifier === key;
         });
         if (!property) {
             return `Property ${key} not found in schema`;

package/package.json

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