unconventional 1.4.2 → 1.6.0

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

@@ -26,8 +26,14 @@ export declare class BaseModel extends Document {
     static delete<T extends typeof BaseModel>(this: T, id: string | number): Promise<InstanceType<T> | null>;
     static deleteMany<T extends typeof BaseModel>(this: T, config?: FilterConfig): Promise<InstanceType<T>[] | null>;
     static count<T extends typeof BaseModel>(this: T): Promise<number | null>;
+    static increment<T extends typeof BaseModel>(this: T, id: string | number, data: {
+        [key in keyof InstanceType<T>]: number;
+    }): 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;
+    /** Gets the field name to use for the provided identifier */
+    private static getFieldName;
     $id(): any;
     $key(): any;
     $owner(): any;

package/dist/core/base.model.js

@@ -15,6 +15,7 @@ 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");
 class Document {
     static schema = { indexes: [], props: {} };
 }
@@ -94,7 +95,7 @@ class BaseModel extends Document {
     }
     static async update(id, data) {
         const timestamp = this.schema.timestamped ? { updatedAt: new Date() } : {};
-        const targetField = isNaN(+id) ? this.keyField : this.idField;
+        const targetField = this.getFieldName(id);
         if (!targetField)
             return null;
         delete data[targetField];
@@ -123,7 +124,7 @@ class BaseModel extends Document {
         return response.map(item => this.fromDatabaseJson(item));
     }
     static async delete(id) {
-        const targetField = isNaN(+id) ? this.keyField : this.idField;
+        const targetField = this.getFieldName(id);
         if (!targetField)
             return null;
         const response = await this.db.fetch({
@@ -153,12 +154,36 @@ class BaseModel extends Document {
             action: db_types_1.SqlAction.Select,
             type: unconventional_pg_queries_1.OneOrMany.Many,
             table: this.collection,
-            count: true
+            subAction: unconventional_pg_queries_1.SubAction.Count
         });
         if (!response)
             return null;
         return response.count;
     }
+    static async increment(id, data) {
+        const targetField = this.getFieldName(id);
+        if (!targetField)
+            return null;
+        const response = await this.db.fetch({
+            action: db_types_1.SqlAction.Update,
+            type: unconventional_pg_queries_1.OneOrMany.One,
+            table: this.collection,
+            where: [{ field: targetField, operator: unconventional_pg_queries_1.SqlWhereOperator.Eq, value: id }],
+            subAction: unconventional_pg_queries_1.SubAction.Increment,
+            data
+        });
+        if (!response)
+            return null;
+        const result = Array.isArray(response) ? response[0] : response;
+        return this.fromDatabaseJson(result);
+    }
+    static async truncate() {
+        await this.db.fetch({
+            action: db_types_1.SqlAction.Truncate,
+            type: unconventional_pg_queries_1.OneOrMany.Many,
+            table: this.collection
+        });
+    }
     static fromDatabaseJson(json) {
         const model = new this();
         Object.assign(model, json);
@@ -173,6 +198,12 @@ class BaseModel extends Document {
         });
         return data;
     }
+    /** Gets the field name to use for the provided identifier */
+    static getFieldName(identifier) {
+        return !isNaN(+identifier) || (0, utils_1.isUUID)(`${identifier}`)
+            ? this.idField
+            : this.keyField || undefined;
+    }
     $id() { return this[this.constructor['idField']]; }
     $key() { return this[this.constructor['keyField']]; }
     $owner() { return this[this.constructor['ownerField']]; }

package/dist/core/base.service.js

@@ -5,6 +5,7 @@ const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const api_error_1 = require("./api-error");
 const base_cache_1 = require("./base.cache");
 const db_utils_1 = require("../utils/db.utils");
+const utils_1 = require("../utils");
 class BaseService {
     model;
     /** A service providing CRUD methods for any Model */
@@ -60,7 +61,7 @@ class BaseService {
             entity = await base_cache_1.BaseCache.getModel(cache, this.model, identifier, modifiers);
         }
         if (!entity) {
-            if (!isNaN(+identifier)) {
+            if (!isNaN(+identifier) || (0, utils_1.isUUID)(`${identifier}`)) {
                 entity = await this.model.findById(identifier, modifiers);
             }
             else {

package/dist/types/db.types.d.ts

@@ -9,7 +9,8 @@ export declare enum SqlAction {
     Select = "SELECT",
     Insert = "INSERT",
     Update = "UPDATE",
-    Delete = "DELETE"
+    Delete = "DELETE",
+    Truncate = "TRUNCATE"
 }
 export interface DBCall extends QueryDefinition {
     action: SqlAction;

package/dist/types/db.types.js

@@ -12,4 +12,5 @@ var SqlAction;
     SqlAction["Insert"] = "INSERT";
     SqlAction["Update"] = "UPDATE";
     SqlAction["Delete"] = "DELETE";
+    SqlAction["Truncate"] = "TRUNCATE";
 })(SqlAction || (exports.SqlAction = SqlAction = {}));

package/dist/utils/api.utils.d.ts

@@ -19,5 +19,7 @@ export declare function splitExpandUnit(input: string): {
 };
 /** Parse a filter string and replace clauses that reference the target field with the provided replacement. */
 export declare function replaceFilter(filter: string | string[] | undefined, target: string, replacement: string, andOr?: AndOr): string;
-/** Check if the filter has the specified target field. */
+/** Check whether the filter has the specified target field. */
 export declare function hasFilter(filter: string | string[] | undefined, target: string): boolean;
+/** Check whether a string is UUID */
+export declare function isUUID(str: string): boolean;

package/dist/utils/api.utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasFilter = exports.replaceFilter = exports.splitExpandUnit = exports.parseExpandString = void 0;
+exports.isUUID = exports.hasFilter = exports.replaceFilter = exports.splitExpandUnit = exports.parseExpandString = void 0;
 const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const db_types_1 = require("../types/db.types");
 const defaultTarget = ',';
@@ -63,10 +63,31 @@ function replaceFilter(filter, target, replacement, andOr = unconventional_pg_qu
     return otherFilters.join(' ');
 }
 exports.replaceFilter = replaceFilter;
-/** Check if the filter has the specified target field. */
+/** Check whether the filter has the specified target field. */
 function hasFilter(filter, target) {
     if (!filter)
         return false;
     return filter.split(db_types_1.andOrPattern).some(x => x.startsWith(target));
 }
 exports.hasFilter = hasFilter;
+/** Check whether a string is UUID */
+function isUUID(str) {
+    if (str.length !== 36)
+        return false;
+    for (let i = 0; i < str.length; i++) {
+        if (i === 8 || i === 13 || i === 18 || i === 23) {
+            if (str[i] !== '-')
+                return false;
+        }
+        else {
+            const charCode = str.charCodeAt(i);
+            const isDigit = charCode >= 48 && charCode <= 57; // 0-9
+            const isLowerHex = charCode >= 97 && charCode <= 102; // a-f
+            const isUpperHex = charCode >= 65 && charCode <= 70; // A-F
+            if (!isDigit && !isLowerHex && !isUpperHex)
+                return false;
+        }
+    }
+    return true;
+}
+exports.isUUID = isUUID;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unconventional",
-  "version": "1.4.2",
+  "version": "1.6.0",
   "description": "A complete server built on Cloudflare Workers/Pages",
   "keywords": [
     "cloudflare",
@@ -45,7 +45,7 @@
   },
   "peerDependencies": {
     "hono": "^4",
-    "unconventional-pg-queries": "^0.0.8"
+    "unconventional-pg-queries": "^1.0.0"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20231121.0",
@@ -53,6 +53,6 @@
     "@typescript-eslint/parser": "^5.62.0",
     "hono": "^4",
     "typescript": "^5.3.3",
-    "unconventional-pg-queries": "^0.0.8"
+    "unconventional-pg-queries": "^1.0.0"
   }
 }