unconventional 1.17.0 → 2.0.0

package/dist/core/base.model.d.ts

@@ -9,12 +9,17 @@ interface BaseModelSchema {
         updatedField: string;
     };
 }
+export declare enum IdType {
+    Number = "number",
+    UUID = "uuid"
+}
 export declare class Document {
     static schema: BaseModelSchema;
 }
 export declare class BaseModel extends Document {
     static collection: string;
     static idField: string;
+    static idType: IdType;
     static keyField?: string;
     static ownerField?: string;
     static db: DB;
@@ -34,7 +39,7 @@ export declare class BaseModel extends Document {
     }): Promise<InstanceType<T> | null>;
     static truncate<T extends typeof BaseModel>(this: T): Promise<void>;
     static fromDatabaseJson<T extends typeof BaseModel>(this: T, json: object): InstanceType<T>;
-    private static addDefaults;
+    private static prepareData;
     /** Gets the field name to use for the provided identifier */
     private static getFieldName;
     /** Masks private fields and in the provided data and its relations */

package/dist/core/base.model.js

@@ -9,13 +9,18 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimeStamped = exports.BaseModel = exports.Document = void 0;
+exports.TimeStamped = exports.BaseModel = exports.Document = exports.IdType = void 0;
 const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const prop_decorator_1 = require("../decorators/prop.decorator");
 const timestamp_decorator_1 = require("../decorators/timestamp.decorator");
 const db_types_1 = require("../types/db.types");
 const db_utils_1 = require("../utils/db.utils");
 const utils_1 = require("../utils");
+var IdType;
+(function (IdType) {
+    IdType["Number"] = "number";
+    IdType["UUID"] = "uuid";
+})(IdType || (exports.IdType = IdType = {}));
 class Document {
     static schema = { indexes: [], props: {} };
 }
@@ -23,6 +28,7 @@ exports.Document = Document;
 class BaseModel extends Document {
     static collection;
     static idField = 'id';
+    static idType = IdType.Number;
     static keyField;
     static ownerField;
     static db;
@@ -37,7 +43,7 @@ class BaseModel extends Document {
             type: unconventional_pg_queries_1.OneOrMany.One,
             table: this.collection,
             conflict: (0, db_utils_1.getConflict)(this, upsertConfig?.action || unconventional_pg_queries_1.ConflictResolution.doUpdate, upsertConfig?.constraint),
-            data: this.addDefaults({ ...data, ...timestamp })
+            data: this.prepareData({ ...data, ...timestamp })
         });
         if (!response)
             return null;
@@ -54,7 +60,7 @@ class BaseModel extends Document {
             type: unconventional_pg_queries_1.OneOrMany.Many,
             table: this.collection,
             conflict: (0, db_utils_1.getConflict)(this, upsertConfig?.action || unconventional_pg_queries_1.ConflictResolution.doUpdate, upsertConfig?.constraint),
-            data: data.map(item => this.addDefaults({ ...item, ...timestamp }))
+            data: data.map(item => this.prepareData({ ...item, ...timestamp }))
         });
         if (!response)
             return null;
@@ -108,7 +114,7 @@ class BaseModel extends Document {
             type: unconventional_pg_queries_1.OneOrMany.One,
             table: this.collection,
             where: [{ field: targetField, operator: unconventional_pg_queries_1.SqlWhereOperator.Eq, value: id }],
-            data: { ...data, ...timestamp }
+            data: this.prepareData({ ...data, ...timestamp }, false)
         });
         if (!response)
             return null;
@@ -121,7 +127,7 @@ class BaseModel extends Document {
             action: db_types_1.SqlAction.Update,
             type: unconventional_pg_queries_1.OneOrMany.Many,
             table: this.collection,
-            data: data.map(item => ({ ...item, ...timestamp }))
+            data: data.map(item => this.prepareData({ ...item, ...timestamp }, false))
         });
         if (!response)
             return null;
@@ -196,18 +202,23 @@ class BaseModel extends Document {
         Object.assign(model, json);
         return model;
     }
-    static addDefaults(data) {
+    static prepareData(data, applyDefaults = true) {
         Object.entries(this.schema.props).forEach(([key, options]) => {
-            if (data[key] === undefined && options.default != null) {
+            // Apply default
+            if (applyDefaults && data[key] === undefined && options.default != null) {
                 const val = options.default;
                 data[key] = typeof val === "function" ? val() : val;
             }
+            // Apply preFormat
+            if (data[key] !== undefined && options.preFormat != null) {
+                data[key] = options.preFormat(data[key]);
+            }
         });
         return data;
     }
     /** Gets the field name to use for the provided identifier */
     static getFieldName(identifier) {
-        return !isNaN(+identifier) || (0, utils_1.isUUID)(`${identifier}`)
+        return (this.idType === IdType.Number && !isNaN(+identifier)) || (this.idType === IdType.UUID && (0, utils_1.isUUID)(`${identifier}`))
             ? this.idField
             : this.keyField || undefined;
     }

package/dist/core/base.service.js

@@ -4,6 +4,7 @@ exports.BaseService = void 0;
 const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const api_error_1 = require("./api-error");
 const base_cache_1 = require("./base.cache");
+const base_model_1 = require("./base.model");
 const db_utils_1 = require("../utils/db.utils");
 const utils_1 = require("../utils");
 class BaseService {
@@ -61,7 +62,7 @@ class BaseService {
             entity = await base_cache_1.BaseCache.getModel(cache, this.model, identifier, modifiers);
         }
         if (!entity) {
-            if (!isNaN(+identifier) || (0, utils_1.isUUID)(`${identifier}`)) {
+            if ((this.model.idType === base_model_1.IdType.Number && !isNaN(+identifier)) || (this.model.idType === base_model_1.IdType.UUID && (0, utils_1.isUUID)(`${identifier}`))) {
                 entity = await this.model.findById(identifier, modifiers);
             }
             else {

package/dist/types/decorator.types.d.ts

@@ -68,6 +68,8 @@ export interface PropOptions<T = any, S extends typeof BaseModel = any, P extend
     private?: boolean | ((model: InstanceType<S>, field: T extends typeof BaseModel ? InstanceType<T> : T) => boolean);
     /** Relational field data */
     relation?: T extends typeof BaseModel ? Relation<T, S, P> : never;
+    /** Format the field value before it is stored in the database */
+    preFormat?: (fieldValue: T extends typeof BaseModel ? InstanceType<T> : T) => any;
 }
 /** Type for the Values stored in the Reflection for Properties */
 export type PropSummary<Target = any, Source extends typeof BaseModel = any> = Record<keyof Source, PropOptions<Target, Source>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unconventional",
-  "version": "1.17.0",
+  "version": "2.0.0",
   "description": "A complete server built on Cloudflare Workers/Pages",
   "keywords": [
     "cloudflare",