@imbricate/core 3.29.0 → 3.30.1

package/database/schema.d.ts

@@ -17,6 +17,12 @@ export type ImbricateDatabaseSchemaPropertyOptionsLabelOption = {
     readonly labelName: string;
     readonly labelColor: string;
 };
+export type ImbricateDatabaseSchemaPropertyOptionsBinary = {
+    /**
+     * Allow multiple binary files
+     */
+    readonly allowMultiple: boolean;
+};
 export type ImbricateDatabaseSchemaPropertyOptionsLabel = {
     /**
      * Allow multiple labels
@@ -38,7 +44,7 @@ export type ImbricateDatabaseSchemaPropertyOptionsReference = {
      */
     readonly databases: ImbricateDatabaseSchemaPropertyOptionsReferenceDatabase[];
 };
-export type ImbricateDatabaseSchemaPropertyOptions<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BOOLEAN ? {} : T extends IMBRICATE_PROPERTY_TYPE.STRING ? {} : T extends IMBRICATE_PROPERTY_TYPE.NUMBER ? {} : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? {} : T extends IMBRICATE_PROPERTY_TYPE.JSON ? {} : T extends IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT ? {} : T extends IMBRICATE_PROPERTY_TYPE.DATE ? {} : T extends IMBRICATE_PROPERTY_TYPE.LABEL ? ImbricateDatabaseSchemaPropertyOptionsLabel : T extends IMBRICATE_PROPERTY_TYPE.REFERENCE ? ImbricateDatabaseSchemaPropertyOptionsReference : never;
+export type ImbricateDatabaseSchemaPropertyOptions<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BINARY ? ImbricateDatabaseSchemaPropertyOptionsBinary : T extends IMBRICATE_PROPERTY_TYPE.BOOLEAN ? {} : T extends IMBRICATE_PROPERTY_TYPE.STRING ? {} : T extends IMBRICATE_PROPERTY_TYPE.NUMBER ? {} : T extends IMBRICATE_PROPERTY_TYPE.MARKDOWN ? {} : T extends IMBRICATE_PROPERTY_TYPE.JSON ? {} : T extends IMBRICATE_PROPERTY_TYPE.IMBRISCRIPT ? {} : T extends IMBRICATE_PROPERTY_TYPE.DATE ? {} : T extends IMBRICATE_PROPERTY_TYPE.LABEL ? ImbricateDatabaseSchemaPropertyOptionsLabel : T extends IMBRICATE_PROPERTY_TYPE.REFERENCE ? ImbricateDatabaseSchemaPropertyOptionsReference : never;
 export type ImbricateDatabaseSchemaPropertyForCreation<T extends IMBRICATE_PROPERTY_TYPE> = {
     readonly propertyName: string;
     readonly propertyType: T;

package/database/schema.js

@@ -25,18 +25,48 @@ const validateImbricateSchemaProperty = (property) => {
     if (!Object.values(type_1.IMBRICATE_PROPERTY_TYPE).includes(property.propertyType)) {
         return "Property type must be a valid type";
     }
+    // IMBRICATE_PROPERTY_TYPE SWITCH
     switch (property.propertyType) {
+        case type_1.IMBRICATE_PROPERTY_TYPE.BINARY: {
+            if (typeof property.propertyOptions !== "object") {
+                return "Property options must be an object";
+            }
+            const propertyOptions = property.propertyOptions;
+            if (typeof propertyOptions.allowMultiple !== "boolean") {
+                return "Property options allowMultiple must be a boolean";
+            }
+            break;
+        }
+        case type_1.IMBRICATE_PROPERTY_TYPE.LABEL: {
+            if (typeof property.propertyOptions !== "object") {
+                return "Property options must be an object";
+            }
+            const propertyOptions = property.propertyOptions;
+            if (typeof propertyOptions.allowMultiple !== "boolean") {
+                return "Property options allowMultiple must be a boolean";
+            }
+            if (!Array.isArray(propertyOptions.labelOptions)) {
+                return "Property options labelOptions must be an array";
+            }
+            for (const labelOption of propertyOptions.labelOptions) {
+                if (typeof labelOption.labelIdentifier !== "string") {
+                    return "Property options labelOptions labelIdentifier must be a string";
+                }
+            }
+            break;
+        }
         case type_1.IMBRICATE_PROPERTY_TYPE.REFERENCE: {
             if (typeof property.propertyOptions !== "object") {
                 return "Property options must be an object";
             }
-            if (typeof property.propertyOptions.allowMultiple !== "boolean") {
+            const propertyOptions = property.propertyOptions;
+            if (typeof propertyOptions.allowMultiple !== "boolean") {
                 return "Property options allowMultiple must be a boolean";
             }
-            if (!Array.isArray(property.propertyOptions.databases)) {
+            if (!Array.isArray(propertyOptions.databases)) {
                 return "Property options databases must be an array";
             }
-            for (const database of property.propertyOptions.databases) {
+            for (const database of propertyOptions.databases) {
                 if (typeof database.originUniqueIdentifier !== "string") {
                     return "Database originUniqueIdentifier must be a string";
                 }

package/document/property/default-value.js

@@ -10,6 +10,7 @@ const type_1 = require("../../property/type");
 // IMBRICATE_PROPERTY_TYPE SWITCH
 const getImbricateDefaultValueOfProperty = (type) => {
     switch (type) {
+        case type_1.IMBRICATE_PROPERTY_TYPE.BINARY: return [];
         case type_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN: return false;
         case type_1.IMBRICATE_PROPERTY_TYPE.STRING: return "";
         case type_1.IMBRICATE_PROPERTY_TYPE.NUMBER: return 0;

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

@@ -20,6 +20,7 @@ export declare class ImbricateDocumentPropertyTriageBase<Result> {
      * @returns triage manager
      */
     forPropertyKey<T extends IMBRICATE_PROPERTY_TYPE>(propertyKey: ImbricatePropertyKey, triageFunction: ImbricatePropertyTriageFunction<T, Result>): this;
+    forBinary(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.BINARY, Result>): this;
     forBoolean(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.BOOLEAN, Result>): this;
     forString(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.STRING, Result>): this;
     forNumber(triageFunction: ImbricatePropertyTriageFunction<IMBRICATE_PROPERTY_TYPE.NUMBER, Result>): this;

package/document/property/triage-base.js

@@ -25,6 +25,10 @@ class ImbricateDocumentPropertyTriageBase {
         this._triageFunctionsByKey.set(propertyKey, triageFunction);
         return this;
     }
+    forBinary(triageFunction) {
+        this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.BINARY, triageFunction);
+        return this;
+    }
     forBoolean(triageFunction) {
         this._triageFunctionsByType.set(type_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN, triageFunction);
         return this;

package/package.json

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

package/property/type.d.ts

@@ -11,6 +11,11 @@ export declare enum IMBRICATE_PROPERTY_TYPE {
      * BOOLEAN - boolean, store as boolean
      */
     BOOLEAN = "BOOLEAN",
+    /**
+     * BINARY - binary, store as a list of static object unique identifier
+     *  Note: Binary is always stored as an array, even if it is a single static object identifier
+     */
+    BINARY = "BINARY",
     /**
      * STRING - string, store as plain text
      */
@@ -53,4 +58,4 @@ export type ImbricatePropertyValueObjectReference = {
     readonly databaseUniqueIdentifier: string;
     readonly documentUniqueIdentifier: string;
 };
-export type ImbricatePropertyValueObject<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 ? ImbricatePropertyValueObjectReference[] : never;
+export type ImbricatePropertyValueObject<T extends IMBRICATE_PROPERTY_TYPE> = T extends IMBRICATE_PROPERTY_TYPE.BINARY ? string[] : 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 ? ImbricatePropertyValueObjectReference[] : never;

package/property/type.js

@@ -15,6 +15,11 @@ var IMBRICATE_PROPERTY_TYPE;
      * BOOLEAN - boolean, store as boolean
      */
     IMBRICATE_PROPERTY_TYPE["BOOLEAN"] = "BOOLEAN";
+    /**
+     * BINARY - binary, store as a list of static object unique identifier
+     *  Note: Binary is always stored as an array, even if it is a single static object identifier
+     */
+    IMBRICATE_PROPERTY_TYPE["BINARY"] = "BINARY";
     /**
      * STRING - string, store as plain text
      */

package/property/validate.js

@@ -41,6 +41,12 @@ const validateImbricateProperties = (properties, schema, allowExtraProperties =
         }
         // IMBRICATE_PROPERTY_TYPE SWITCH
         switch (property.propertyType) {
+            case type_1.IMBRICATE_PROPERTY_TYPE.BINARY: {
+                if (!Array.isArray(property.propertyValue)) {
+                    return `Property ${key} value must be an array of string`;
+                }
+                break;
+            }
             case type_1.IMBRICATE_PROPERTY_TYPE.BOOLEAN: {
                 if (typeof property.propertyValue !== "boolean") {
                     return `Property ${key} value must be a boolean`;