@imbricate/core 3.6.2 → 3.7.0

package/database/definition.d.ts

@@ -19,18 +19,37 @@ export type ImbricateDocumentQuery = {
  * Edit record type of the document
  */
 export declare enum IMBRICATE_DATABASE_EDIT_TYPE {
-    PUT_SCHEMA = "PUT_SCHEMA"
+    PUT_SCHEMA = "PUT_SCHEMA",
+    PUT_ANNOTATION = "PUT_ANNOTATION",
+    DELETE_ANNOTATION = "DELETE_ANNOTATION"
 }
-export type DatabaseEditOperation = {
-    readonly action: IMBRICATE_DATABASE_EDIT_TYPE;
-    readonly value: ImbricateDatabaseSchema;
+export type DatabaseEditOperationPutAnnotation = {
+    readonly annotationNamespace: string;
+    readonly annotationIdentifier: string;
+    readonly data: any;
+};
+export type DatabaseEditOperationDeleteAnnotation = {
+    readonly annotationNamespace: string;
+    readonly annotationIdentifier: string;
+};
+export type DatabaseEditOperationValue<T extends IMBRICATE_DATABASE_EDIT_TYPE> = T extends IMBRICATE_DATABASE_EDIT_TYPE.PUT_SCHEMA ? ImbricateDatabaseSchema : T extends IMBRICATE_DATABASE_EDIT_TYPE.PUT_ANNOTATION ? DatabaseEditOperationPutAnnotation : T extends IMBRICATE_DATABASE_EDIT_TYPE.DELETE_ANNOTATION ? DatabaseEditOperationDeleteAnnotation : never;
+export type DatabaseEditOperation<T extends IMBRICATE_DATABASE_EDIT_TYPE> = {
+    readonly action: T;
+    readonly value: DatabaseEditOperationValue<T>;
 };
 export type DatabaseEditRecord = {
     readonly uniqueIdentifier: string;
     readonly editAt: Date;
-    readonly operations: DatabaseEditOperation[];
+    readonly operations: Array<DatabaseEditOperation<IMBRICATE_DATABASE_EDIT_TYPE>>;
     readonly author?: ImbricateAuthor;
 };
+export type DatabaseAnnotations = Record<DatabaseAnnotationKey, DatabaseAnnotationValue>;
+export type DatabaseAnnotationKey = string;
+export type DatabaseAnnotationValue = {
+    readonly namespace: string;
+    readonly identifier: string;
+    readonly data: any;
+};
 export type ImbricateDatabaseAuditOptions = {
     /**
      * Do not add edit record, this is controlled an function may vary by origin

package/database/definition.js

@@ -12,4 +12,6 @@ exports.IMBRICATE_DATABASE_EDIT_TYPE = void 0;
 var IMBRICATE_DATABASE_EDIT_TYPE;
 (function (IMBRICATE_DATABASE_EDIT_TYPE) {
     IMBRICATE_DATABASE_EDIT_TYPE["PUT_SCHEMA"] = "PUT_SCHEMA";
+    IMBRICATE_DATABASE_EDIT_TYPE["PUT_ANNOTATION"] = "PUT_ANNOTATION";
+    IMBRICATE_DATABASE_EDIT_TYPE["DELETE_ANNOTATION"] = "DELETE_ANNOTATION";
 })(IMBRICATE_DATABASE_EDIT_TYPE || (exports.IMBRICATE_DATABASE_EDIT_TYPE = IMBRICATE_DATABASE_EDIT_TYPE = {}));

package/database/interface.d.ts

@@ -3,9 +3,10 @@
  * @namespace Database
  * @description Interface
  */
+import { ImbricateDocumentAuditOptions } from "../document/definition";
 import { IImbricateDocument } from "../document/interface";
 import { DocumentProperties } from "../document/property";
-import { DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
+import { DatabaseAnnotations, DatabaseEditRecord, ImbricateDatabaseAuditOptions, ImbricateDocumentQuery } from "./definition";
 import { ImbricateDatabaseSchema } from "./schema";
 export interface IImbricateDatabase {
     /**
@@ -20,6 +21,10 @@ export interface IImbricateDatabase {
      * Schema of the database
      */
     readonly schema: ImbricateDatabaseSchema;
+    /**
+     * Annotations of the database
+     */
+    readonly annotations: DatabaseAnnotations;
     /**
      * Put and replace the schema of the database
      *  Existing documents will still be kept, and stays unchanged
@@ -41,7 +46,7 @@ export interface IImbricateDatabase {
      *
      * @returns a promise of the created document
      */
-    createDocument(properties: DocumentProperties, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDocument>;
+    createDocument(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<IImbricateDocument>;
     /**
      * Get one document from the database
      *
@@ -58,6 +63,46 @@ export interface IImbricateDatabase {
      * @returns a promise of the documents in the database
      */
     queryDocuments(query: ImbricateDocumentQuery): PromiseLike<IImbricateDocument[]>;
+    /**
+     * Count documents in the database
+     *
+     * @param query query of the documents
+     *
+     * @returns a promise of the count of the documents in the database
+     */
+    countDocuments(query: ImbricateDocumentQuery): PromiseLike<number>;
+    /**
+     * Remove a document from the database
+     *
+     * @param uniqueIdentifier unique identifier of the document
+     * @param auditOptions audit options of the document
+     */
+    removeDocument(uniqueIdentifier: string, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<void>;
+    /**
+     * put annotation to the database
+     *
+     * @param namespace namespace of the annotation
+     * @param identifier identifier of the annotation
+     * @param value value of the annotation
+     * @param auditOptions audit options of the database
+     *
+     * @returns a promise of the edit records of the database
+     *  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 in audit options
+     */
+    putAnnotation(namespace: string, identifier: string, value: any, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<DatabaseEditRecord[]>;
+    /**
+     * Delete annotation from the database
+     *
+     * @param namespace namespace of the annotation
+     * @param identifier identifier of the annotation
+     * @param auditOptions audit options of the database
+     *
+     * @returns a promise of the edit records of the database
+     *  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 in audit options
+     */
+    deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<DatabaseEditRecord[]>;
     /**
      * Add edit records to the database, optional
      *  This method is optional, if not implemented, means the origin

package/database/manager.d.ts

@@ -3,6 +3,7 @@
  * @namespace Database
  * @description Manager
  */
+import { ImbricateDatabaseAuditOptions } from "./definition";
 import { IImbricateDatabase } from "./interface";
 import { ImbricateDatabaseSchemaForCreation } from "./schema";
 export interface IImbricateDatabaseManager {
@@ -25,10 +26,16 @@ export interface IImbricateDatabaseManager {
      *
      * @param databaseName name of the database
      * @param schema schema of the database
-     * @param uniqueIdentifier unique identifier of the database, optional
-     *  if not provided, a unique identifier will be generated
+     * @param auditOptions audit options of the database
      *
      * @returns a promise of the created database
      */
-    createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, uniqueIdentifier?: string): PromiseLike<IImbricateDatabase>;
+    createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<IImbricateDatabase>;
+    /**
+     * Remove a database from the origin
+     *
+     * @param uniqueIdentifier unique identifier of the database
+     * @param auditOptions audit options of deletion
+     */
+    removeDatabase(uniqueIdentifier: string, auditOptions?: ImbricateDatabaseAuditOptions): PromiseLike<void>;
 }

package/document/definition.d.ts

@@ -4,18 +4,46 @@
  * @description Definition
  */
 import { ImbricateAuthor } from "../author/definition";
-import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_DOCUMENT_EDIT_TYPE, IMBRICATE_PROPERTY_TYPE } from "./property";
-export type DocumentEditOperation = {
+import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
+/**
+ * Edit record type of the document
+ */
+export declare enum IMBRICATE_DOCUMENT_EDIT_TYPE {
+    PUT_PROPERTY = "PUT_PROPERTY",
+    PUT_ANNOTATION = "PUT_ANNOTATION",
+    DELETE_ANNOTATION = "DELETE_ANNOTATION"
+}
+export type DocumentEditOperationValuePutProperty = {
     readonly key: DocumentPropertyKey;
-    readonly action: IMBRICATE_DOCUMENT_EDIT_TYPE;
     readonly value: DocumentPropertyValue<IMBRICATE_PROPERTY_TYPE>;
 };
+export type DocumentEditOperationPutAnnotation = {
+    readonly annotationNamespace: string;
+    readonly annotationIdentifier: string;
+    readonly data: any;
+};
+export type DocumentEditOperationDeleteAnnotation = {
+    readonly annotationNamespace: string;
+    readonly annotationIdentifier: string;
+};
+export type DocumentEditOperationValue<T extends IMBRICATE_DOCUMENT_EDIT_TYPE> = T extends IMBRICATE_DOCUMENT_EDIT_TYPE.PUT_PROPERTY ? DocumentEditOperationValuePutProperty : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.PUT_ANNOTATION ? DocumentEditOperationPutAnnotation : T extends IMBRICATE_DOCUMENT_EDIT_TYPE.DELETE_ANNOTATION ? DocumentEditOperationDeleteAnnotation : never;
+export type DocumentEditOperation<T extends IMBRICATE_DOCUMENT_EDIT_TYPE> = {
+    readonly action: T;
+    readonly value: DocumentEditOperationValue<T>;
+};
 export type DocumentEditRecord = {
     readonly uniqueIdentifier: string;
     readonly editAt: Date;
-    readonly operations: DocumentEditOperation[];
+    readonly operations: Array<DocumentEditOperation<IMBRICATE_DOCUMENT_EDIT_TYPE>>;
     readonly author?: ImbricateAuthor;
 };
+export type DocumentAnnotations = Record<DocumentAnnotationKey, DocumentAnnotationValue>;
+export type DocumentAnnotationKey = string;
+export type DocumentAnnotationValue = {
+    readonly namespace: string;
+    readonly identifier: string;
+    readonly data: any;
+};
 export type ImbricateDocumentAuditOptions = {
     /**
      * Do not add edit record, this is controlled an function may vary by origin

package/document/definition.js

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

package/document/interface.d.ts

@@ -3,7 +3,7 @@
  * @namespace Document
  * @description Interface
  */
-import { DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
+import { DocumentAnnotations, DocumentEditRecord, ImbricateDocumentAuditOptions } from "./definition";
 import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_PROPERTY_TYPE } from "./property";
 export interface IImbricateDocument {
     /**
@@ -14,6 +14,10 @@ export interface IImbricateDocument {
      * Properties of the document
      */
     readonly properties: DocumentProperties;
+    /**
+     * Annotations of the database
+     */
+    readonly annotations: DocumentAnnotations;
     /**
      * Update a property from the document
      *
@@ -37,6 +41,31 @@ export interface IImbricateDocument {
      *  Call `addEditRecords` to add the edit records manually.
      */
     putProperties(properties: DocumentProperties, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<DocumentEditRecord[]>;
+    /**
+     * put annotation to the document
+     *
+     * @param namespace namespace of the annotation
+     * @param identifier identifier of the annotation
+     * @param value value of the annotation
+     * @param auditOptions audit options of the document
+     *
+     * @returns a promise of the edit records of the document
+     *  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 in audit options
+     */
+    putAnnotation(namespace: string, identifier: string, value: any, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<DocumentEditRecord[]>;
+    /**
+     * Delete annotation from the document
+     *
+     * @param namespace namespace of the annotation
+     * @param identifier identifier of the annotation
+     * @param auditOptions audit options of the document
+     *
+     * @returns a promise of the edit records of the document
+     *  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 in audit options
+     */
+    deleteAnnotation(namespace: string, identifier: string, auditOptions?: ImbricateDocumentAuditOptions): PromiseLike<DocumentEditRecord[]>;
     /**
      * Add edit records to the document, optional
      *  This method is optional, if not implemented, means the origin

package/document/property.d.ts

@@ -69,9 +69,3 @@ export type DocumentPropertyValueObjectReference = {
     readonly documentUniqueIdentifier: string;
 };
 export type DocumentPropertyValueObject<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BOOLEAN ? boolean : T extends IMBRICATE_PROPERTY_TYPE.STRING ? string : T extends IMBRICATE_PROPERTY_TYPE.NUMBER ? number : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? string : T extends IMBRICATE_PROPERTY_TYPE.JSON ? string : T extends IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT ? string : T extends IMBRICATE_PROPERTY_TYPE.DATE ? string : T extends IMBRICATE_PROPERTY_TYPE.LABEL ? string[] : T extends IMBRICATE_PROPERTY_TYPE.REFERENCE ? DocumentPropertyValueObjectReference[] : never;
-/**
- * Edit record type of the document
- */
-export declare enum IMBRICATE_DOCUMENT_EDIT_TYPE {
-    PUT = "PUT"
-}

package/document/property.js

@@ -5,7 +5,7 @@
  * @description Property
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_DOCUMENT_EDIT_TYPE = exports.IMBRICATE_PROPERTY_TYPE = void 0;
+exports.IMBRICATE_PROPERTY_TYPE = void 0;
 /**
  * Document properties
  */
@@ -52,10 +52,3 @@ var IMBRICATE_PROPERTY_TYPE;
      */
     IMBRICATE_PROPERTY_TYPE["REFERENCE"] = "REFERENCE";
 })(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/index.d.ts

@@ -22,7 +22,9 @@ export * from "./loader/persistence";
 export * from "./origin/definition";
 export * from "./origin/interface";
 export * from "./origin/search";
+export * from "./static/definition";
 export * from "./static/interface";
 export * from "./static/manager";
+export * from "./text/definition";
 export * from "./text/interface";
 export * from "./text/manager";

package/index.js

@@ -38,7 +38,9 @@ __exportStar(require("./loader/persistence"), exports);
 __exportStar(require("./origin/definition"), exports);
 __exportStar(require("./origin/interface"), exports);
 __exportStar(require("./origin/search"), exports);
+__exportStar(require("./static/definition"), exports);
 __exportStar(require("./static/interface"), exports);
 __exportStar(require("./static/manager"), exports);
+__exportStar(require("./text/definition"), exports);
 __exportStar(require("./text/interface"), exports);
 __exportStar(require("./text/manager"), exports);

package/package.json

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

package/static/definition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @author WMXPY
+ * @namespace Static
+ * @description Definition
+ */
+import { ImbricateAuthor } from "../author/definition";
+export type ImbricateStaticAuditOptions = {
+    /**
+     * Static author, this is controlled an function may vary by origin
+     */
+    readonly author?: ImbricateAuthor;
+};

package/static/definition.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Static
+ * @description Definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/static/interface.d.ts

@@ -3,11 +3,16 @@
  * @namespace Static
  * @description Interface
  */
+import { ImbricateAuthor } from "../author/definition";
 export interface IImbricateStatic {
     /**
      * Unique identifier of the static object
      */
     readonly uniqueIdentifier: string;
+    /**
+     * Author of the text object
+     */
+    readonly author?: ImbricateAuthor;
     /**
      * Get the content of the static object
      *

package/static/manager.d.ts

@@ -3,6 +3,7 @@
  * @namespace Static
  * @description Manager
  */
+import { ImbricateStaticAuditOptions } from "./definition";
 import { IImbricateStatic } from "./interface";
 export interface IImbricateStaticManager {
     /**
@@ -17,10 +18,9 @@ export interface IImbricateStaticManager {
      *  Patch a new static object if you want to change the content
      *
      * @param content content of the static object, encoded in base64
-     * @param uniqueIdentifier unique identifier of the static object, optional
-     *  if not provided, a unique identifier will be generated
+     * @param auditOptions audit options of the static object
      *
      * @returns a promise of the created static object
      */
-    createInBase64(content: string, uniqueIdentifier?: string): PromiseLike<IImbricateStatic>;
+    createInBase64(content: string, auditOptions?: ImbricateStaticAuditOptions): PromiseLike<IImbricateStatic>;
 }

package/text/definition.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Definition
+ */
+import { ImbricateAuthor } from "../author/definition";
+export type ImbricateTextAuditOptions = {
+    /**
+     * Text author, this is controlled an function may vary by origin
+     */
+    readonly author?: ImbricateAuthor;
+};

package/text/definition.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Text
+ * @description Definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/text/interface.d.ts

@@ -3,11 +3,16 @@
  * @namespace Text
  * @description Interface
  */
+import { ImbricateAuthor } from "../author/definition";
 export interface IImbricateText {
     /**
      * Unique identifier of the text object
      */
     readonly uniqueIdentifier: string;
+    /**
+     * Author of the text object
+     */
+    readonly author?: ImbricateAuthor;
     /**
      * Get the content of the text object
      *

package/text/manager.d.ts

@@ -3,6 +3,7 @@
  * @namespace Text
  * @description Manager
  */
+import { ImbricateTextAuditOptions } from "./definition";
 import { IImbricateText } from "./interface";
 export interface IImbricateTextManager {
     /**
@@ -17,10 +18,9 @@ export interface IImbricateTextManager {
      *  Patch a new text object if you want to change the content
      *
      * @param content content of the text
-     * @param uniqueIdentifier unique identifier of the text object, optional
-     *  if not provided, a unique identifier will be generated
+     * @param auditOptions audit options of the text
      *
      * @returns a promise of the text object
      */
-    createText(content: string, uniqueIdentifier?: string): PromiseLike<IImbricateText>;
+    createText(content: string, auditOptions?: ImbricateTextAuditOptions): PromiseLike<IImbricateText>;
 }