@imbricate/core 3.3.0 → 3.3.2

package/document/property/triage-base.d.ts

@@ -18,7 +18,12 @@ export declare class ImbricateDocumentPropertyTriageBase<Result> {
      * @returns triage manager
      */
     forPropertyKey<T extends IMBRICATE_PROPERTY_TYPE>(propertyKey: DocumentPropertyKey, triageFunction: DocumentPropertyTriageFunction<T, Result>): this;
+    forBoolean(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.BOOLEAN, Result>): this;
     forString(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.STRING, Result>): this;
+    forNumber(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.NUMBER, Result>): this;
     forMarkdown(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.MARKDOWN, Result>): this;
+    forDate(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.DATE, Result>): this;
+    forLabel(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.LABEL, Result>): this;
+    forReference(triageFunction: DocumentPropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.REFERENCE, Result>): this;
     protected _collect(properties: DocumentProperties): Map<DocumentPropertyKey, Result>;
 }

package/document/property/triage-base.js

@@ -7,6 +7,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImbricateDocumentPropertyTriageBase = void 0;
 const property_1 = require("../property");
+// IMBRICATE_PROPERTY_TYPE SWITCH
 class ImbricateDocumentPropertyTriageBase {
     constructor() {
         this._triageFunctionsByKey = new Map();
@@ -24,14 +25,34 @@ class ImbricateDocumentPropertyTriageBase {
         this._triageFunctionsByKey.set(propertyKey, triageFunction);
         return this;
     }
+    forBoolean(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN, triageFunction);
+        return this;
+    }
     forString(triageFunction) {
         this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.STRING, triageFunction);
         return this;
     }
+    forNumber(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.NUMBER, triageFunction);
+        return this;
+    }
     forMarkdown(triageFunction) {
         this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.MARKDOWN, triageFunction);
         return this;
     }
+    forDate(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.DATE, triageFunction);
+        return this;
+    }
+    forLabel(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.LABEL, triageFunction);
+        return this;
+    }
+    forReference(triageFunction) {
+        this._triageFunctionsByType.set(property_1.IMBRICATE_PROPERTY_TYPE.REFERENCE, triageFunction);
+        return this;
+    }
     _collect(properties) {
         const keys = Object.keys(properties);
         const result = new Map();

package/document/validate.d.ts

@@ -10,8 +10,9 @@ import { DocumentProperties } from "./property";
  *
  * @param properties properties to validate
  * @param schema database schema to validate
+ * @param allowExtraProperties allow extra properties, optional with default false
  *
  * @returns a string error message if validation failed
  *        null if validation passed
  */
-export declare const validateImbricateProperties: (properties: DocumentProperties, schema: ImbricateDatabaseSchema) => string | null;
+export declare const validateImbricateProperties: (properties: DocumentProperties, schema: ImbricateDatabaseSchema, allowExtraProperties?: boolean) => string | null;

package/document/validate.js

@@ -12,11 +12,12 @@ const property_1 = require("./property");
  *
  * @param properties properties to validate
  * @param schema database schema to validate
+ * @param allowExtraProperties allow extra properties, optional with default false
  *
  * @returns a string error message if validation failed
  *        null if validation passed
  */
-const validateImbricateProperties = (properties, schema) => {
+const validateImbricateProperties = (properties, schema, allowExtraProperties = false) => {
     if (typeof properties !== "object") {
         return "Properties must be an object";
     }
@@ -26,6 +27,9 @@ const validateImbricateProperties = (properties, schema) => {
             return each.propertyIdentifier === key;
         });
         if (!property) {
+            if (allowExtraProperties) {
+                continue;
+            }
             return `Property ${key} not found in schema`;
         }
         const value = properties[key];
@@ -35,6 +39,7 @@ const validateImbricateProperties = (properties, schema) => {
         if (value.type !== property.propertyType) {
             return `Property ${key} type must be ${property.propertyType}, but got ${value.type}`;
         }
+        // IMBRICATE_PROPERTY_TYPE SWITCH
         switch (value.type) {
             case property_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN: {
                 if (typeof value.value !== "boolean") {
@@ -60,6 +65,27 @@ const validateImbricateProperties = (properties, schema) => {
                 }
                 break;
             }
+            case property_1.IMBRICATE_PROPERTY_TYPE.DATE: {
+                if (typeof value.value !== "string") {
+                    return `Property ${key} value must be a string of date in ISO format`;
+                }
+                const date = new Date(value.value);
+                if (isNaN(date.getTime())) {
+                    return `Property ${key} value must be a string of date in ISO format`;
+                }
+                break;
+            }
+            case property_1.IMBRICATE_PROPERTY_TYPE.LABEL: {
+                if (!Array.isArray(value.value)) {
+                    return `Property ${key} value must be an array of string`;
+                }
+                for (const label of value.value) {
+                    if (typeof label !== "string") {
+                        return `Property ${key} label must be a string`;
+                    }
+                }
+                break;
+            }
             case property_1.IMBRICATE_PROPERTY_TYPE.REFERENCE: {
                 if (!Array.isArray(value.value)) {
                     return `Property ${key} value must be an array of string`;

package/origin/interface.d.ts

@@ -7,7 +7,7 @@ import { IImbricateDatabaseManager } from "../database/manager";
 import { IImbricateStaticManager } from "../static/manager";
 import { IImbricateTextManager } from "../text/manager";
 import { OriginPayload } from "./definition";
-import { ImbricateSearchItem } from "./search";
+import { ImbricateSearchResult } from "./search";
 export interface IImbricateOrigin {
     /**
      * Unique identifier of the origin
@@ -53,5 +53,5 @@ export interface IImbricateOrigin {
      * @param keyword the keyword to search
      * @returns the search
      */
-    search(keyword: string): PromiseLike<ImbricateSearchItem>;
+    search(keyword: string): PromiseLike<ImbricateSearchResult>;
 }

package/package.json

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