@imbricate/core 2.6.2 → 3.0.1

package/author/definition.d.ts

@@ -3,10 +3,7 @@
  * @namespace Author
  * @description Definition
  */
-export type ImbricateAuthorAttributes = Record<string, string>;
 export type ImbricateAuthor = {
-    readonly avatar?: string;
-    readonly displayName?: string;
+    readonly category: string;
     readonly identifier: string;
-    readonly attributes: ImbricateAuthorAttributes;
 };

package/database/definition.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @author WMXPY
+ * @namespace Database
+ * @description Definition
+ */
+/**
+ * Query of the document
+ *
+ * @param limit limit of the query
+ * @param skip skip of the query
+ */
+export type ImbricateDocumentQuery = {
+    readonly limit?: number;
+    readonly skip?: number;
+};

package/{definition/promise.js → database/definition.js}

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

package/database/interface.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @author WMXPY
+ * @namespace Database
+ * @description Interface
+ */
+import { IImbricateDocument } from "../document/interface";
+import { DocumentProperties } from "../document/property";
+import { ImbricateDocumentQuery } from "./definition";
+import { ImbricateDatabaseSchema } from "./schema";
+export interface IImbricateDatabase {
+    /**
+     * Unique identifier of the database
+     */
+    readonly uniqueIdentifier: string;
+    readonly databaseName: string;
+    readonly schema: ImbricateDatabaseSchema;
+    /**
+     * Create a new document in the database
+     *
+     * @param properties properties of the document
+     * @param uniqueIdentifier unique identifier of the document, optional
+     *  if not provided, a unique identifier will be generated
+     *
+     * @returns a promise of the created document
+     */
+    createDocument(properties: DocumentProperties, uniqueIdentifier?: string): PromiseLike<IImbricateDocument>;
+    /**
+     * Get one document from the database
+     *
+     * @returns a promise of the documents in the database, null if not found
+     */
+    getDocument(uniqueIdentifier: string): PromiseLike<IImbricateDocument | null>;
+    /**
+     * Query documents from the database
+     *
+     * @param query query of the documents
+     *
+     * @returns a promise of the documents in the database
+     */
+    queryDocuments(query: ImbricateDocumentQuery): PromiseLike<IImbricateDocument[]>;
+}

package/{function → database}/interface.js

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

package/database/manager.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @author WMXPY
+ * @namespace Database
+ * @description Manager
+ */
+import { IImbricateDatabase } from "./interface";
+import { ImbricateDatabaseSchemaForCreation } from "./schema";
+export interface IImbricateDatabaseManager {
+    /**
+     * List all databases in the origin
+     *
+     * @returns a promise of the databases in the origin
+     */
+    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
+     *
+     * @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
+     *
+     * @returns a promise of the created database
+     */
+    createDatabase(databaseName: string, schema: ImbricateDatabaseSchemaForCreation, uniqueIdentifier?: string): PromiseLike<IImbricateDatabase>;
+}

package/database/manager.js

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

package/database/schema.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @author WMXPY
+ * @namespace Database
+ * @description Schema
+ */
+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

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Database
+ * @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

@@ -0,0 +1,18 @@
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Definition
+ */
+import { ImbricateAuthor } from "../author/definition";
+import { DocumentPropertyKey, DocumentPropertyValue, IMBRICATE_DOCUMENT_EDIT_TYPE } from "./property";
+export type DocumentEditOperation = {
+    readonly key: DocumentPropertyKey;
+    readonly action: IMBRICATE_DOCUMENT_EDIT_TYPE;
+    readonly value: DocumentPropertyValue;
+};
+export type DocumentEditRecord = {
+    readonly uniqueIdentifier: string;
+    readonly editAt: Date;
+    readonly author: ImbricateAuthor;
+    readonly operations: DocumentEditOperation[];
+};

package/{definition/listable.js → document/definition.js}

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

package/document/interface.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Interface
+ */
+import { DocumentEditRecord } from "./definition";
+import { DocumentProperties, DocumentPropertyKey, DocumentPropertyValue } from "./property";
+export interface IImbricateDocument {
+    /**
+     * Unique identifier of the database
+     */
+    readonly uniqueIdentifier: string;
+    /**
+     * Update a property from the document
+     *
+     * @param key key of the property
+     * @param value value of the property
+     *
+     * @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.
+     */
+    putProperty(key: DocumentPropertyKey, value: DocumentPropertyValue): PromiseLike<DocumentEditRecord[]>;
+    /**
+     * Put and replace all properties of the document
+     *
+     * @param properties properties of 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.
+     */
+    putProperties(properties: DocumentProperties): PromiseLike<DocumentEditRecord[]>;
+    /**
+     * Get properties from the document
+     *
+     * @returns a promise of the properties of the document
+     */
+    getProperties(): PromiseLike<DocumentProperties>;
+    /**
+     * Add edit records to the document
+     *
+     * @param records document edit records
+     */
+    addEditRecords(records: DocumentEditRecord[]): PromiseLike<void>;
+    /**
+     * Get edit records of the document
+     *
+     * @returns a promise of the edit records of the document
+     */
+    getEditRecords(): PromiseLike<DocumentEditRecord[]>;
+}

package/{trash → document}/interface.js

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

package/document/property.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @author WMXPY
+ * @namespace Document
+ * @description Property
+ */
+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"
+}

package/document/property.js

@@ -0,0 +1,17 @@
+"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;
+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/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

@@ -3,58 +3,20 @@
  * @description Index
  */
 export * from "./author/definition";
-export * from "./binary-storage/base";
-export * from "./binary-storage/definition";
-export * from "./binary-storage/interface";
-export * from "./capability/builder";
-export * from "./capability/create";
-export * from "./capability/definition";
-export * from "./capability/validate";
-export * from "./collection-manager/base";
-export * from "./collection-manager/definition";
-export * from "./collection-manager/interface";
-export * from "./collection-operation-manager/base";
-export * from "./collection-operation-manager/definition";
-export * from "./collection-operation-manager/interface";
-export * from "./collection/base";
-export * from "./collection/definition";
-export * from "./collection/interface";
-export * from "./collection/least-common-identifier";
-export * from "./definition/listable";
-export * from "./definition/promise";
-export * from "./error/imbricate-error";
-export * from "./error/not-implemented";
-export * from "./executable-manager/base";
-export * from "./executable-manager/definition";
-export * from "./executable-manager/interface";
-export * from "./execute/definition";
-export * from "./function/base";
-export * from "./function/definition";
-export * from "./function/interface";
-export * from "./operation/definition";
-export * from "./origin-operation-manager/base";
-export * from "./origin-operation-manager/definition";
-export * from "./origin-operation-manager/interface";
-export * from "./origin/base";
+export * from "./database/definition";
+export * from "./database/interface";
+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";
 export * from "./origin/definition";
 export * from "./origin/interface";
-export * from "./page-variant/definition";
-export * from "./page-variant/extension";
-export * from "./page/base";
-export * from "./page/definition";
-export * from "./page/interface";
-export * from "./query/definition";
-export * from "./query/page";
-export * from "./query/script";
-export * from "./script-manager/base";
-export * from "./script-manager/definition";
-export * from "./script-manager/interface";
-export * from "./script-variant/definition";
-export * from "./script/base";
-export * from "./script/definition";
-export * from "./script/interface";
-export * from "./search/prefix";
-export * from "./search/snippet";
-export * from "./trash/base";
-export * from "./trash/definition";
-export * from "./trash/interface";
+export * from "./static/interface";
+export * from "./static/manager";
+export * from "./text/interface";
+export * from "./text/manager";

package/index.js

@@ -19,58 +19,20 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./author/definition"), exports);
-__exportStar(require("./binary-storage/base"), exports);
-__exportStar(require("./binary-storage/definition"), exports);
-__exportStar(require("./binary-storage/interface"), exports);
-__exportStar(require("./capability/builder"), exports);
-__exportStar(require("./capability/create"), exports);
-__exportStar(require("./capability/definition"), exports);
-__exportStar(require("./capability/validate"), exports);
-__exportStar(require("./collection-manager/base"), exports);
-__exportStar(require("./collection-manager/definition"), exports);
-__exportStar(require("./collection-manager/interface"), exports);
-__exportStar(require("./collection-operation-manager/base"), exports);
-__exportStar(require("./collection-operation-manager/definition"), exports);
-__exportStar(require("./collection-operation-manager/interface"), exports);
-__exportStar(require("./collection/base"), exports);
-__exportStar(require("./collection/definition"), exports);
-__exportStar(require("./collection/interface"), exports);
-__exportStar(require("./collection/least-common-identifier"), exports);
-__exportStar(require("./definition/listable"), exports);
-__exportStar(require("./definition/promise"), exports);
-__exportStar(require("./error/imbricate-error"), exports);
-__exportStar(require("./error/not-implemented"), exports);
-__exportStar(require("./executable-manager/base"), exports);
-__exportStar(require("./executable-manager/definition"), exports);
-__exportStar(require("./executable-manager/interface"), exports);
-__exportStar(require("./execute/definition"), exports);
-__exportStar(require("./function/base"), exports);
-__exportStar(require("./function/definition"), exports);
-__exportStar(require("./function/interface"), exports);
-__exportStar(require("./operation/definition"), exports);
-__exportStar(require("./origin-operation-manager/base"), exports);
-__exportStar(require("./origin-operation-manager/definition"), exports);
-__exportStar(require("./origin-operation-manager/interface"), exports);
-__exportStar(require("./origin/base"), exports);
+__exportStar(require("./database/definition"), exports);
+__exportStar(require("./database/interface"), exports);
+__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);
 __exportStar(require("./origin/definition"), exports);
 __exportStar(require("./origin/interface"), exports);
-__exportStar(require("./page-variant/definition"), exports);
-__exportStar(require("./page-variant/extension"), exports);
-__exportStar(require("./page/base"), exports);
-__exportStar(require("./page/definition"), exports);
-__exportStar(require("./page/interface"), exports);
-__exportStar(require("./query/definition"), exports);
-__exportStar(require("./query/page"), exports);
-__exportStar(require("./query/script"), exports);
-__exportStar(require("./script-manager/base"), exports);
-__exportStar(require("./script-manager/definition"), exports);
-__exportStar(require("./script-manager/interface"), exports);
-__exportStar(require("./script-variant/definition"), exports);
-__exportStar(require("./script/base"), exports);
-__exportStar(require("./script/definition"), exports);
-__exportStar(require("./script/interface"), exports);
-__exportStar(require("./search/prefix"), exports);
-__exportStar(require("./search/snippet"), exports);
-__exportStar(require("./trash/base"), exports);
-__exportStar(require("./trash/definition"), exports);
-__exportStar(require("./trash/interface"), exports);
+__exportStar(require("./static/interface"), exports);
+__exportStar(require("./static/manager"), exports);
+__exportStar(require("./text/interface"), exports);
+__exportStar(require("./text/manager"), exports);

package/loader/definition.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @author WMXPY
+ * @namespace Loader
+ * @description Definition
+ */
+import { OriginPayload } from "../origin/definition";
+import { IImbricateOrigin } from "../origin/interface";
+export type ImbricateOriginLoader = (payload: OriginPayload) => IImbricateOrigin;

package/{query → loader}/definition.js

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

package/loader/origin-loader.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @author WMXPY
+ * @namespace Loader
+ * @description Origin Loader
+ */
+import { IImbricateOrigin } from "../origin/interface";
+import { ImbricateOriginPersistance, ImbricateOriginPersistanceOrigin } from "./persistance";
+export declare const loadImbricateOriginFromPersistanceOrigin: (origin: ImbricateOriginPersistanceOrigin) => Promise<IImbricateOrigin | null>;
+export declare const loadImbricateOriginsFromPersistance: (persistance: ImbricateOriginPersistance) => Promise<IImbricateOrigin[]>;