@imbricate/core 3.5.0 → 3.6.1

package/database/definition.d.ts

@@ -28,6 +28,16 @@ export type DatabaseEditOperation = {
 export type DatabaseEditRecord = {
     readonly uniqueIdentifier: string;
     readonly editAt: Date;
-    readonly author: ImbricateAuthor;
     readonly operations: DatabaseEditOperation[];
+    readonly author?: ImbricateAuthor;
+};
+export type ImbricateDatabaseAuditOptions = {
+    /**
+     * Do not add edit record, this is controlled an function may vary by origin
+     */
+    readonly noEditRecord?: boolean;
+    /**
+     * Use this author to add edit record, this is controlled an function may vary by origin
+     */
+    readonly author?: ImbricateAuthor;
 };

package/database/interface.d.ts

@@ -5,7 +5,7 @@
  */
 import { IImbricateDocument } from "../document/interface";
 import { DocumentProperties } from "../document/property";
-import { DatabaseEditRecord, ImbricateDocumentQuery } from "./definition";
+import { DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
 import { ImbricateDatabaseSchema } from "./schema";
 export interface IImbricateDatabase {
     /**
@@ -25,24 +25,23 @@ export interface IImbricateDatabase {
      *  Existing documents will still be kept, and stays unchanged
      *
      * @param schema schema of the database
-     * @param noEditRecord do not add edit record, optional
+     * @param auditOptions audit options of the database
      *
      * @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>;
+    putSchema(schema: ImbricateDatabaseSchema, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<void>;
     /**
      * 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
-     *  if not provided, a unique identifier will be generated
+     * @param auditOptions audit options of the document
      *
      * @returns a promise of the created document
      */
-    createDocument(properties: DocumentProperties, uniqueIdentifier?: string): PromiseLike<IImbricateDocument>;
+    createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDocument>;
     /**
      * Get one document from the database
      *

package/document/definition.d.ts

@@ -13,6 +13,16 @@ export type DocumentEditOperation = {
 export type DocumentEditRecord = {
     readonly uniqueIdentifier: string;
     readonly editAt: Date;
-    readonly author: ImbricateAuthor;
     readonly operations: DocumentEditOperation[];
+    readonly author?: ImbricateAuthor;
+};
+export type ImbricateDocumentAuditOptions = {
+    /**
+     * Do not add edit record, this is controlled an function may vary by origin
+     */
+    readonly noEditRecord?: boolean;
+    /**
+     * Use this author to add edit record, this is controlled an function may vary by origin
+     */
+    readonly author?: ImbricateAuthor;
 };

package/document/interface.d.ts

@@ -3,7 +3,7 @@
  * @namespace Document
  * @description Interface
  */
-import { DocumentEditRecord } from "./definition";
+import { DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
 import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
 export interface IImbricateDocument {
     /**
@@ -19,26 +19,24 @@ 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
+     * @param auditOptions audit options of the document
      *
      * @returns a promise of the edit records of the document
      *  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<IMBRICATE_PROPERTY_TYPE>, noEditRecord?: boolean): PromiseLike<DocumentEditRecord[]>;
+    putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>, auditOptions?: ImbricateDocumentAuditOptions): 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
+     * @param auditOptions audit options of the document
      *
      * @returns a promise of the edit records of the document
      *  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, noEditRecord?: boolean): PromiseLike<DocumentEditRecord[]>;
+    putProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<DocumentEditRecord[]>;
     /**
      * Add edit records to the document, optional
      *  This method is optional, if not implemented, means the origin

package/package.json

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