montycat 1.1.1 → 1.1.2

package/dist/classes/generic.js

@@ -230,7 +230,6 @@ class GenericKV {
         };
         return await runQuery(this, JSON.stringify(query));
     }
-    // how to make it available for TS only ?
     /**
      * Enforces a schema on the store.
      * @param schema - The schema to enforce. Should be an instance of the Schema class.
@@ -239,15 +238,15 @@ class GenericKV {
      */
     static async enforceSchema(schema) {
         function parseType(fieldType) {
-            switch (fieldType) {
-                case "String": return "String";
-                case "Number": return "Number";
-                case "Boolean": return "Boolean";
-                case "Array": return "Array";
-                case "Object": return "Object";
-                case "Pointer": return "Pointer";
-                case "Timestamp": return "Timestamp";
-                default: throw new TypeError(`Unsupported field type: ${fieldType}`);
+            switch (fieldType.getType()) {
+                case "String": return ["String", fieldType.getNullable()];
+                case "Number": return ["Number", fieldType.getNullable()];
+                case "Boolean": return ["Boolean", fieldType.getNullable()];
+                case "Array": return ["Array", fieldType.getNullable()];
+                case "Object": return ["Object", fieldType.getNullable()];
+                case "Pointer": return ["Pointer", fieldType.getNullable()];
+                case "Timestamp": return ["Timestamp", fieldType.getNullable()];
+                default: throw new TypeError(`Unsupported field type: ${fieldType.getType()}`);
             }
         }
         let schemaTypes = {};

package/dist/core/schema.d.ts

@@ -43,7 +43,7 @@ interface TimestampRangeConfig {
  */
 declare class Schema {
     [key: string]: any;
-    static metadata: Record<string, string> | null;
+    static metadata: Record<string, Field> | null;
     constructor(properties: {
         [key: string]: any;
     });
@@ -90,4 +90,20 @@ declare class Timestamp {
         };
     };
 }
-export { Schema, Pointer, Timestamp };
+/**
+ * Field class
+ * @class
+ * @param fieldType - The type of the field
+ * @param nullable - Whether the field is nullable // default is false
+ * @returns The field object
+ * @example
+ * const field = new Field('String', true);
+ */
+declare class Field {
+    fieldType: string;
+    nullable: boolean;
+    constructor(fieldType: string, nullable?: boolean);
+    getType(): string;
+    getNullable(): boolean;
+}
+export { Schema, Pointer, Timestamp, Field };

package/dist/core/schema.js

@@ -110,4 +110,27 @@ class Timestamp {
         }
     };
 }
-export { Schema, Pointer, Timestamp };
+/**
+ * Field class
+ * @class
+ * @param fieldType - The type of the field
+ * @param nullable - Whether the field is nullable // default is false
+ * @returns The field object
+ * @example
+ * const field = new Field('String', true);
+ */
+class Field {
+    fieldType;
+    nullable;
+    constructor(fieldType, nullable = false) {
+        this.fieldType = fieldType;
+        this.nullable = nullable;
+    }
+    getType() {
+        return this.fieldType;
+    }
+    getNullable() {
+        return this.nullable;
+    }
+}
+export { Schema, Pointer, Timestamp, Field };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import { Engine, ValidPermissions } from "./core/engine.js";
 import Keyspace from "./core/store.js";
-import { Pointer, Timestamp, Schema } from "./core/schema.js";
-export { Engine, ValidPermissions, Keyspace, Pointer, Timestamp, Schema };
+import { Pointer, Timestamp, Schema, Field } from "./core/schema.js";
+export { Engine, ValidPermissions, Keyspace, Pointer, Timestamp, Schema, Field };

package/dist/index.js

@@ -1,4 +1,4 @@
 import { Engine, ValidPermissions } from "./core/engine.js";
 import Keyspace from "./core/store.js";
-import { Pointer, Timestamp, Schema } from "./core/schema.js";
-export { Engine, ValidPermissions, Keyspace, Pointer, Timestamp, Schema };
+import { Pointer, Timestamp, Schema, Field } from "./core/schema.js";
+export { Engine, ValidPermissions, Keyspace, Pointer, Timestamp, Schema, Field };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "montycat",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A Node.js client for Montycat, NoSQL database utilizing Data Mesh architecture.",
   "type": "module",
   "main": "dist/index.js",