unconventional 1.12.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/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/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.12.0",
+  "version": "1.13.0",
   "description": "A complete server built on Cloudflare Workers/Pages",
   "keywords": [
     "cloudflare",