unconventional 1.11.0 → 1.13.0

package/dist/core/abstractbase.middleware.d.ts

@@ -0,0 +1,21 @@
+import { BaseModel } from "./base.model";
+/** A predicate that matches a model to a given condition */
+export type ModelPredicate = (model: typeof BaseModel) => boolean;
+/** Middleware base class with methods that can find the ancestors of a model */
+export declare class AbstractBaseMiddleware<M extends typeof BaseModel> {
+    protected model: M;
+    constructor(model: M);
+    /**
+     * Finds an ancestor that matches the predicate
+     * @param id - The ID of the model to find the ancestor for
+     * @param predicate - The predicate to match the ancestor
+     * @returns The ancestor that matches the predicate or null if no ancestor is found
+     */
+    findAncestor(id: string | number, predicate: ModelPredicate): Promise<any | null>;
+    /**
+     * Builds the relation path to reach an ancestor that matches the predicate
+     * @param predicate - The predicate to match the ancestor
+     * @returns The relation path (e.g. ['comments', 'post', 'user']) to the ancestor or null if no ancestor is found
+     */
+    protected buildAncestralPath(predicate: ModelPredicate): string[] | null;
+}

package/dist/core/abstractbase.middleware.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractBaseMiddleware = void 0;
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+/** Middleware base class with methods that can find the ancestors of a model */
+class AbstractBaseMiddleware {
+    model;
+    constructor(model) {
+        this.model = model;
+    }
+    /**
+     * Finds an ancestor that matches the predicate
+     * @param id - The ID of the model to find the ancestor for
+     * @param predicate - The predicate to match the ancestor
+     * @returns The ancestor that matches the predicate or null if no ancestor is found
+     */
+    async findAncestor(id, predicate) {
+        const expansion = this.buildAncestralPath(predicate);
+        if (!expansion)
+            return null;
+        const result = await this.model.findById(id, {
+            expand: (0, utils_1.buildExpansionString)(expansion)
+        });
+        if (!result)
+            return null;
+        // Navigate through the expanded chain to get the owner
+        return expansion.reduce((obj, key) => obj?.[key], result);
+    }
+    /**
+     * Builds the relation path to reach an ancestor that matches the predicate
+     * @param predicate - The predicate to match the ancestor
+     * @returns The relation path (e.g. ['comments', 'post', 'user']) to the ancestor or null if no ancestor is found
+     */
+    buildAncestralPath(predicate) {
+        let currentModel = this.model;
+        const path = [];
+        const visited = new Set();
+        while (!visited.has(currentModel)) {
+            // Found model that matches predicate
+            if (predicate(currentModel)) {
+                return path;
+            }
+            visited.add(currentModel);
+            // Find first BelongsTo relation
+            const belongsToRelation = Object.entries(currentModel.schema.props)
+                .find(([_, prop]) => prop.relation?.type === types_1.RelationType.BelongsTo);
+            if (!belongsToRelation)
+                return null;
+            const [relationKey, prop] = belongsToRelation;
+            const parentModel = (0, utils_1.getRelationModel)(prop.relation.model);
+            path.push(relationKey);
+            currentModel = parentModel;
+        }
+        return null; // Circular reference found or no matching owner
+    }
+}
+exports.AbstractBaseMiddleware = AbstractBaseMiddleware;

package/dist/core/base.model.js

@@ -210,11 +210,19 @@ class BaseModel extends Document {
             return;
         const dataArray = Array.isArray(data) ? data : [data];
         const propSummary = Object.entries(this.schema.props);
-        for (const item of dataArray) {
+        for (let item of dataArray) {
             for (const [key, options] of propSummary) {
                 // Mask private fields. Skip 1st level if relationsOnly.
-                if (!relationsOnly && options.private && key in item) {
-                    item[key] = undefined;
+                if (!relationsOnly && key in item && options.private != null) {
+                    if (Array.isArray(item[key])) {
+                        item[key] = item[key].filter(rel => !(0, utils_1.evaluate)(options.private, item, rel));
+                        if (item[key].length === 0)
+                            continue;
+                    }
+                    else if ((0, utils_1.evaluate)(options.private, item, item[key])) {
+                        item[key] = undefined;
+                        continue;
+                    }
                 }
                 // Mask private fields in relations
                 if (options.relation && item[key]) {

package/dist/core/index.d.ts

@@ -1,4 +1,5 @@
 export * from './abstractbase.controller';
+export * from './abstractbase.middleware';
 export * from './api-error';
 export * from './base.cache';
 export * from './base.model';

package/dist/core/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./abstractbase.controller"), exports);
+__exportStar(require("./abstractbase.middleware"), exports);
 __exportStar(require("./api-error"), exports);
 __exportStar(require("./base.cache"), exports);
 __exportStar(require("./base.model"), exports);

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

@@ -63,9 +63,9 @@ export interface PropOptions<T = any, S extends typeof BaseModel = any, P extend
     /** Give the Property a default Value */
     default?: T | (() => T);
     /** Protect field from edits by non-privileged users */
-    system?: boolean;
+    system?: boolean | ((model: InstanceType<S>, field: T extends typeof BaseModel ? InstanceType<T> : T) => boolean);
     /** Hide field in responses to non-privileged users */
-    private?: boolean;
+    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;
 }

package/dist/utils/array.utils.d.ts

@@ -2,3 +2,5 @@
 export declare const equalArrays: <T>(a: T[], b: T[]) => boolean;
 /** Checks whether an object has no keys and/or the value for every key is undefined */
 export declare function isEmpty(obj: any): boolean;
+/** Evaluate a direct or functional value */
+export declare function evaluate<T, F extends (...args: any[]) => T>(value: T | F | undefined, ...args: Parameters<F>): T | undefined;

package/dist/utils/array.utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEmpty = exports.equalArrays = void 0;
+exports.evaluate = exports.isEmpty = exports.equalArrays = void 0;
 /** Compares two arrays and returns true if they contain the same elements, regardless of order */
 const equalArrays = (a, b) => {
     if (a.length !== b.length)
@@ -26,3 +26,8 @@ function isEmpty(obj) {
     return true;
 }
 exports.isEmpty = isEmpty;
+/** Evaluate a direct or functional value */
+function evaluate(value, ...args) {
+    return value instanceof Function ? value(...args) : value;
+}
+exports.evaluate = evaluate;

package/dist/utils/middleware.utils.d.ts

@@ -5,3 +5,8 @@ import { BaseHandler, Env } from "../types/api.types";
  * the logical OR of their results.
  */
 export declare function Or<E extends Env = Env, P extends string = any, I extends Input = Input, T extends BaseHandler<E, P, I> | MiddlewareHandler<E, P, I> = MiddlewareHandler<E, P, I>>(...methods: Array<T>): MiddlewareHandler<E, P, I>;
+/**
+ * Converts an array of relation paths into a nested expansion string
+ * @example buildExpansionString(['comments', 'post', 'user']) => 'comments[post[user]]'
+ */
+export declare function buildExpansionString(path: string[]): string;

package/dist/utils/middleware.utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Or = void 0;
+exports.buildExpansionString = exports.Or = void 0;
 /**
  * Combines any number of RequestHandlers into one function that performs
  * the logical OR of their results.
@@ -16,3 +16,11 @@ function Or(...methods) {
     };
 }
 exports.Or = Or;
+/**
+ * Converts an array of relation paths into a nested expansion string
+ * @example buildExpansionString(['comments', 'post', 'user']) => 'comments[post[user]]'
+ */
+function buildExpansionString(path) {
+    return path.reduceRight((acc, curr) => acc ? `${curr}[${acc}]` : curr, '');
+}
+exports.buildExpansionString = buildExpansionString;

package/dist/utils/server.utils.d.ts

@@ -1,7 +1,12 @@
+/// <reference types="@cloudflare/workers-types" />
 import { DBFactory } from "../types";
+import { Context } from "hono";
+import { HTTPResponseError } from "hono/types";
 /** Default CORS middleware permitting all origins and methods */
 export declare const defaultCors: import("hono").MiddlewareHandler;
 /** Binds the database proxy to the BaseModel */
 export declare const bindDatabase: (getDB: DBFactory) => (ctx: any, next: any) => Promise<void>;
 /** Catches and formats errors in a standard way */
-export declare const defaultErrorHandler: (err: any, ctx: any) => any;
+export declare const defaultErrorHandler: (err: Error | HTTPResponseError, ctx: Context) => Response & import("hono").TypedResponse<{
+    error: string;
+}, import("hono/utils/http-status").StatusCode, "json">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unconventional",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "description": "A complete server built on Cloudflare Workers/Pages",
   "keywords": [
     "cloudflare",
@@ -39,9 +39,9 @@
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs",
     "docs:serve": "vitepress serve docs",
-    "release:major": "changelog -M && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major && git push origin && git push origin --tags",
-    "release:minor": "changelog -m && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor && git push origin && git push origin --tags",
-    "release:patch": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags"
+    "release:major": "changelog -M && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major",
+    "release:minor": "changelog -m && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor",
+    "release:patch": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch"
   },
   "peerDependencies": {
     "hono": "^4",