unconventional 1.14.2 → 1.15.0

package/dist/core/base.model.js

@@ -71,22 +71,26 @@ class BaseModel extends Document {
         return response ? this.fromDatabaseJson(response) : null;
     }
     static async findOne(config) {
+        const where = (0, db_utils_1.getWhere)(this, config?.filter);
+        const expand = (0, db_utils_1.expandRelationalFilters)(this, where, (0, db_utils_1.getExpand)(this, config?.expand));
         const response = await this.db.fetch({
             action: db_types_1.SqlAction.Select,
             type: unconventional_pg_queries_1.OneOrMany.One,
             table: this.collection,
-            expand: (0, db_utils_1.getExpand)(this, config?.expand),
-            where: (0, db_utils_1.getWhere)(this, config?.filter)
+            expand,
+            where
         });
         return response ? this.fromDatabaseJson(response) : null;
     }
     static async findMany(config) {
+        const where = (0, db_utils_1.getWhere)(this, config?.filter);
+        const expand = (0, db_utils_1.expandRelationalFilters)(this, where, (0, db_utils_1.getExpand)(this, config?.expand));
         const response = await this.db.fetch({
             action: db_types_1.SqlAction.Select,
             type: unconventional_pg_queries_1.OneOrMany.Many,
             table: this.collection,
-            expand: (0, db_utils_1.getExpand)(this, config?.expand),
-            where: (0, db_utils_1.getWhere)(this, config?.filter),
+            expand,
+            where,
             order: (0, db_utils_1.getOrder)(this, config?.sort),
             page: (0, db_utils_1.getPage)(this, config?.cursor),
             limit: config?.limit
@@ -139,11 +143,14 @@ class BaseModel extends Document {
         return this.fromDatabaseJson(result);
     }
     static async deleteMany(config) {
+        const where = (0, db_utils_1.getWhere)(this, config?.filter);
+        const expand = (0, db_utils_1.expandRelationalFilters)(this, where, (0, db_utils_1.getExpand)(this, config?.expand));
         const response = await this.db.fetch({
             action: db_types_1.SqlAction.Delete,
             type: unconventional_pg_queries_1.OneOrMany.Many,
             table: this.collection,
-            where: (0, db_utils_1.getWhere)(this, config?.filter)
+            expand,
+            where
         });
         if (!response)
             return null;

package/dist/utils/db.utils.d.ts

@@ -12,3 +12,5 @@ export declare function getReturn<T extends typeof BaseModel>(model: T): string[
 export declare function getConflict<T extends typeof BaseModel>(model: T, action: ConflictResolution, constraint?: Array<keyof InstanceType<T>>): SqlConflict | undefined;
 /** A type-safe way to build filter strings */
 export declare function buildFilter<T>(field: keyof T, operator: SqlWhereOperator, value?: any): string;
+/** Creates expansions for relational filters */
+export declare function expandRelationalFilters<T extends typeof BaseModel>(model: T, wheres: SqlWhere[], expand: Record<string, Expansion>): Record<string, Expansion>;

package/dist/utils/db.utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildFilter = exports.getConflict = exports.getReturn = exports.getPage = exports.getOrder = exports.getWhere = exports.getExpand = void 0;
+exports.expandRelationalFilters = exports.buildFilter = exports.getConflict = exports.getReturn = exports.getPage = exports.getOrder = exports.getWhere = exports.getExpand = void 0;
 const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const db_types_1 = require("../types/db.types");
 const decorator_types_1 = require("../types/decorator.types");
@@ -64,6 +64,7 @@ function getWhere(model, filterString) {
             let field = filter.substring(0, filter.indexOf(operator)).trim();
             let value = filter.substring(filter.indexOf(operator) + operator.length).trim();
             let jsonPath = [];
+            let relationPath = undefined;
             // Handle IS NULL and IS NOT NULL, which don't have values
             if (operator.startsWith('IS')) {
                 value = null;
@@ -71,13 +72,28 @@ function getWhere(model, filterString) {
             // Handle JSON path
             if (field.includes('.')) {
                 jsonPath = field.split('.');
-                field = jsonPath.shift();
+                const target = jsonPath.shift();
+                // Split relational fields into relation and field. e.g. 'user.name' -> 'user' and 'name'
+                // Otherwise, assume json
+                const relation = propSummary[target]?.relation;
+                if (relation) {
+                    if (jsonPath.length !== 1)
+                        throw api_error_1.APIError.errInvalidQueryParameter(`Invalid filter: '${field}'. Relation filters must be in the format: 'relation.field'`);
+                    const relationModel = (0, api_utils_1.getRelationModel)(relation);
+                    if (!relationModel.schema.props[jsonPath[0]])
+                        throw api_error_1.APIError.errInvalidQueryParameter(`Invalid filter: '${field}'.`);
+                    relationPath = target;
+                    field = jsonPath.shift();
+                }
+                else {
+                    field = target;
+                }
             }
-            if (!propSummary[field])
+            if (!relationPath && !propSummary[field])
                 throw api_error_1.APIError.errInvalidQueryParameter(`Invalid filter: '${field}'`);
             if (!value && !db_types_1.NullSqlOperators.includes(operator))
                 throw api_error_1.APIError.errInvalidQueryParameter(`Invalid value in filter: '${value}'`);
-            wheres.push({ field, jsonPath, operator: operator, value, andOr });
+            wheres.push({ field, jsonPath, relationPath, operator: operator, value, andOr });
         });
     }
     return wheres;
@@ -149,3 +165,10 @@ function buildFilter(field, operator, value) {
     return `${field} ${operator} ${formatted}`;
 }
 exports.buildFilter = buildFilter;
+/** Creates expansions for relational filters */
+function expandRelationalFilters(model, wheres, expand) {
+    const missingExpansions = wheres.flatMap(where => (where.relationPath && !expand[where.relationPath]) ? [where.relationPath] : []);
+    const addedExpansions = getExpand(model, missingExpansions.join(','));
+    return { ...expand, ...addedExpansions };
+}
+exports.expandRelationalFilters = expandRelationalFilters;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unconventional",
-  "version": "1.14.2",
+  "version": "1.15.0",
   "description": "A complete server built on Cloudflare Workers/Pages",
   "keywords": [
     "cloudflare",
@@ -45,7 +45,7 @@
   },
   "peerDependencies": {
     "hono": "^4",
-    "unconventional-pg-queries": "^1.1.0"
+    "unconventional-pg-queries": "^1.4.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": "^1.0.0"
+    "unconventional-pg-queries": "^1.4.0"
   }
 }