@imbricate/core 3.7.3 → 3.8.1

package/database/definition.d.ts

@@ -5,6 +5,28 @@
  */
 import { ImbricateAuthor } from "../author/definition";
 import { ImbricateDatabaseSchema } from "./schema";
+export declare enum IMBRICATE_QUERY_COMPARE_CONDITION {
+    EQUAL = "EQUAL"
+}
+export declare enum IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET {
+    PROPERTY_TYPE = "PROPERTY_TYPE",
+    PROPERTY_VALUE = "PROPERTY_VALUE"
+}
+export type ImbricateDocumentQueryPropertyFilterCondition = {
+    readonly target: IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET;
+    readonly condition: IMBRICATE_QUERY_COMPARE_CONDITION;
+    readonly value: any;
+};
+export type ImbricateDocumentQueryPropertyFilter = {
+    readonly propertyIdentifier: string;
+    readonly conditions: ImbricateDocumentQueryPropertyFilterCondition[];
+};
+export type ImbricateDocumentQueryAnnotationFilter = {
+    readonly namespace: string;
+    readonly identifier: string;
+    readonly condition: IMBRICATE_QUERY_COMPARE_CONDITION;
+    readonly value: any;
+};
 /**
  * Query of the document
  *
@@ -14,6 +36,8 @@ import { ImbricateDatabaseSchema } from "./schema";
 export type ImbricateDocumentQuery = {
     readonly limit?: number;
     readonly skip?: number;
+    readonly propertyFilters?: ImbricateDocumentQueryPropertyFilter[];
+    readonly annotationFilters?: ImbricateDocumentQueryAnnotationFilter[];
 };
 /**
  * Edit record type of the document

package/database/definition.js

@@ -5,7 +5,16 @@
  * @description Definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMBRICATE_DATABASE_EDIT_TYPE = void 0;
+exports.IMBRICATE_DATABASE_EDIT_TYPE = exports.IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = exports.IMBRICATE_QUERY_COMPARE_CONDITION = void 0;
+var IMBRICATE_QUERY_COMPARE_CONDITION;
+(function (IMBRICATE_QUERY_COMPARE_CONDITION) {
+    IMBRICATE_QUERY_COMPARE_CONDITION["EQUAL"] = "EQUAL";
+})(IMBRICATE_QUERY_COMPARE_CONDITION || (exports.IMBRICATE_QUERY_COMPARE_CONDITION = IMBRICATE_QUERY_COMPARE_CONDITION = {}));
+var IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET;
+(function (IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET) {
+    IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET["PROPERTY_TYPE"] = "PROPERTY_TYPE";
+    IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET["PROPERTY_VALUE"] = "PROPERTY_VALUE";
+})(IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET || (exports.IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = IMBRICATE_QUERY_PROPERTY_CONDITION_TARGET = {}));
 /**
  * Edit record type of the document
  */

package/database/validate.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @author WMXPY
+ * @namespace Database
+ * @description Validate
+ */
+import { ImbricateDocumentQuery } from "./definition";
+/**
+ * Validate imbricate document query
+ *
+ * @param query query to validate
+ *
+ * @returns a string error message if validation failed
+ *        null if validation passed
+ */
+export declare const validateImbricateDocumentQuery: (query: ImbricateDocumentQuery) => string | null;

package/database/validate.js

@@ -0,0 +1,66 @@
+"use strict";
+/**
+ * @author WMXPY
+ * @namespace Database
+ * @description Validate
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateImbricateDocumentQuery = void 0;
+/**
+ * Validate imbricate document query
+ *
+ * @param query query to validate
+ *
+ * @returns a string error message if validation failed
+ *        null if validation passed
+ */
+const validateImbricateDocumentQuery = (query) => {
+    if (typeof query !== "object") {
+        return "Query must be an object";
+    }
+    if (query.limit !== undefined && typeof query.limit !== "number" && query.limit <= 0) {
+        return "Limit must be a number greater than 0 or undefined";
+    }
+    if (query.skip !== undefined && typeof query.skip !== "number" && query.skip < 0) {
+        return "Skip must be a number greater than or equal to 0 or undefined";
+    }
+    if (query.propertyFilters !== undefined) {
+        if (!Array.isArray(query.propertyFilters)) {
+            return "Property filters must be an array";
+        }
+        for (const filter of query.propertyFilters) {
+            if (typeof filter.propertyIdentifier !== "string") {
+                return "Property identifier must be a string";
+            }
+            if (!Array.isArray(filter.conditions)) {
+                return "Conditions must be an array";
+            }
+            for (const condition of filter.conditions) {
+                if (typeof condition.target !== "string") {
+                    return "Target must be a string";
+                }
+                if (typeof condition.condition !== "string") {
+                    return "Condition must be a string";
+                }
+            }
+        }
+    }
+    if (query.annotationFilters !== undefined) {
+        if (!Array.isArray(query.annotationFilters)) {
+            return "Annotation filters must be an array";
+        }
+        for (const filter of query.annotationFilters) {
+            if (typeof filter.namespace !== "string") {
+                return "Namespace must be a string";
+            }
+            if (typeof filter.identifier !== "string") {
+                return "Identifier must be a string";
+            }
+            if (typeof filter.condition !== "string") {
+                return "Condition must be a string";
+            }
+        }
+    }
+    return null;
+};
+exports.validateImbricateDocumentQuery = validateImbricateDocumentQuery;

package/index.d.ts

@@ -7,6 +7,7 @@ export * from "./database/definition";
 export * from "./database/interface";
 export * from "./database/manager";
 export * from "./database/schema";
+export * from "./database/validate";
 export * from "./document/definition";
 export * from "./document/interface";
 export * from "./document/property";

package/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./database/definition"), exports);
 __exportStar(require("./database/interface"), exports);
 __exportStar(require("./database/manager"), exports);
 __exportStar(require("./database/schema"), exports);
+__exportStar(require("./database/validate"), exports);
 __exportStar(require("./document/definition"), exports);
 __exportStar(require("./document/interface"), exports);
 __exportStar(require("./document/property"), exports);

package/package.json

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