unconventional 0.0.1 → 0.0.2

package/README.md

@@ -1,4 +1,5 @@
 # unconventional
-A complete server built on Cloudflare Pages Functions
+A complete backend server built on Cloudflare Pages Functions and hono.
+Includes routing, database connection, middleware, cors, and error handling out of the box!
 
 COMING SOON!

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

@@ -0,0 +1,36 @@
+/// <reference types="@cloudflare/workers-types" />
+import { Context } from "hono";
+import { BaseHandler, Env } from "../types/api.types";
+import BaseModel from "./base.model";
+import { ControllerMethodOptions, ControllerOptions, DownloadMethodOptions, I, PI, RequestContext } from "./base.options";
+import BaseService from "./base.service";
+export default abstract class AbstractBaseController<M extends typeof BaseModel, E extends Env = Env> {
+    protected _model: M;
+    protected _service: BaseService<M>;
+    protected _pageLimitDefault: number;
+    protected _pageLimitMax: number;
+    protected _options: ControllerOptions;
+    constructor(model: M, options?: ControllerOptions);
+    create(options?: ControllerMethodOptions<M, E>): BaseHandler<E>;
+    createMany(options?: ControllerMethodOptions<M, E, PI<M>[], I<M>[]>): BaseHandler<E>;
+    get(options?: ControllerMethodOptions<M, E> & DownloadMethodOptions<M, E>): BaseHandler<E>;
+    getAll(options?: ControllerMethodOptions<M, E, any, I<M>[]>): BaseHandler<E>;
+    update(options?: ControllerMethodOptions<M, E>): BaseHandler<E>;
+    updateMany(options?: ControllerMethodOptions<M, E, PI<M>[], I<M>[]>): BaseHandler<E>;
+    delete(options?: ControllerMethodOptions<M, E>): BaseHandler<E>;
+    deleteMany(options?: ControllerMethodOptions<M, E, PI<M>[], I<M>[]>): BaseHandler<E>;
+    private _create;
+    private _createMany;
+    private _get;
+    private _getAll;
+    private _update;
+    private _updateMany;
+    private _delete;
+    private _deleteMany;
+    protected getRequestContext<T extends PI<M> | PI<M>[] = PI<M>>(ctx: Context<E>, hasBody?: boolean): Promise<RequestContext<M, E, T>>;
+    protected getCache(ctx: Context, controllerLevel: boolean | undefined, routeLevel: boolean | undefined): KVNamespace | undefined;
+    protected abstract maskPrivateFields(req: RequestContext<M, E>, response: InstanceType<M> | InstanceType<M>[]): Promise<void>;
+    protected abstract removeSystemFields<T extends PI<M> | PI<M>[] = PI<M>>(req: RequestContext<M, E, T>): void;
+    protected abstract preventIDOR<T extends PI<M> | PI<M>[] = PI<M>>(req: RequestContext<M, E, T>): Promise<void>;
+}
+//# sourceMappingURL=abstractbase.controller.d.ts.map

package/dist/core/abstractbase.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractbase.controller.d.ts","sourceRoot":"","sources":["../../src/core/abstractbase.controller.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAc,WAAW,EAAE,GAAG,EAAS,MAAM,oBAAoB,CAAC;AACzE,OAAO,SAAS,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,CAAC,EAAE,EAAE,EAAE,cAAc,EAAiB,MAAM,gBAAgB,CAAC;AACzI,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAGzC,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,sBAAsB,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG;IAClG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IACpB,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACnC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAM;IACzC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAO;IACtC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAM;gBAI/B,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAM1C,MAAM,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAC/D,UAAU,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IACpF,GAAG,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAC1F,MAAM,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAC5E,MAAM,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAC/D,UAAU,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IACpF,MAAM,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAC/D,UAAU,CAAC,OAAO,CAAC,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;YAO7E,OAAO;YAwCP,WAAW;YAyCX,IAAI;YA0CJ,OAAO;YAsCP,OAAO;YA+BP,WAAW;YA6BX,OAAO;YA0BP,WAAW;cA0BT,iBAAiB,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,OAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAoBhJ,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS;IAMhI,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAG7H,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI;IAG5G,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAE/G"}

package/dist/core/abstractbase.controller.js

@@ -0,0 +1,198 @@
+import { BaseEnvKey, Query } from "../types/api.types";
+import BaseService from "./base.service";
+export default class AbstractBaseController {
+    _model;
+    _service;
+    _pageLimitDefault = 12;
+    _pageLimitMax = 100;
+    _options = {};
+    constructor(model, options) {
+        this._model = model;
+        this._service = new BaseService(model);
+        this._options = options || {};
+    }
+    create(options) { return this._create.bind(this, options); }
+    createMany(options) { return this._createMany.bind(this, options); }
+    get(options) { return this._get.bind(this, options); }
+    getAll(options) { return this._getAll.bind(this, options); }
+    update(options) { return this._update.bind(this, options); }
+    updateMany(options) { return this._updateMany.bind(this, options); }
+    delete(options) { return this._delete.bind(this, options); }
+    deleteMany(options) { return this._deleteMany.bind(this, options); }
+    async _create(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx);
+        await this.preventIDOR(reqContext);
+        if (options?.before)
+            await options.before(reqContext);
+        const isPrivileged = ctx.get(BaseEnvKey.isPrivileged);
+        if (this._model.ownerField && !(reqContext.body[this._model.ownerField] && isPrivileged)) {
+            const ownerId = ctx.get(BaseEnvKey.ownerId);
+            if (ownerId && this._model.ownerField)
+                reqContext.body[this._model.ownerField] = ownerId;
+        }
+        const config = {
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL,
+            upsertConfig: {
+                constraint: options?.upsertContraint
+            }
+        };
+        let response = await this._service.create(reqContext.body, config);
+        if (options?.after)
+            await options.after(reqContext, response);
+        return ctx.json(response);
+    }
+    async _createMany(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx);
+        await this.preventIDOR(reqContext);
+        if (options?.before)
+            await options.before(reqContext);
+        const isPrivileged = ctx.get(BaseEnvKey.isPrivileged);
+        reqContext.body.forEach(x => {
+            if (this._model.ownerField && !(x[this._model.ownerField] && isPrivileged)) {
+                const ownerId = ctx.get(BaseEnvKey.ownerId);
+                if (ownerId && this._model.ownerField)
+                    x[this._model.ownerField] = ownerId;
+            }
+        });
+        const config = {
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL,
+            upsertConfig: {
+                constraint: options?.upsertContraint
+            }
+        };
+        let response = await this._service.createMany(reqContext.body, config);
+        if (options?.after)
+            await options.after(reqContext, response);
+        return ctx.json(response);
+    }
+    async _get(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx, false);
+        if (options?.before)
+            await options.before(reqContext);
+        const identifier = reqContext.params.id;
+        const config = {
+            expand: reqContext.queries[Query.Expand] || undefined,
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL
+        };
+        let response = await this._service.get(identifier, config);
+        if (options?.after)
+            await options.after(reqContext, response);
+        await this.maskPrivateFields(reqContext, response);
+        if (options?.download) {
+            const downloadRes = await options.download(reqContext, response);
+            const headers = {
+                'Content-Type': 'application/octet-stream',
+                'content-disposition': `attachment; filename=${downloadRes.filename}`
+            };
+            return ctx.body(downloadRes.buffer, 200, headers);
+        }
+        else
+            return ctx.json(response);
+    }
+    async _getAll(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx, false);
+        if (options?.before)
+            await options.before(reqContext);
+        const queryParams = reqContext.queries;
+        let limit = parseInt(queryParams.limit) || this._pageLimitDefault;
+        if (limit > this._pageLimitMax && !options?.limitOverride)
+            limit = this._pageLimitMax;
+        let response = await this._service.getAll({
+            limit: limit,
+            cursor: queryParams.cursor,
+            sort: queryParams.orderBy,
+            filter: queryParams.filter,
+            expand: reqContext.queries[Query.Expand] || undefined,
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL
+        });
+        if (options?.after)
+            await options.after(reqContext, response);
+        await this.maskPrivateFields(reqContext, response);
+        return ctx.json(response);
+    }
+    async _update(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx);
+        await this.preventIDOR(reqContext);
+        this.removeSystemFields(reqContext);
+        if (options?.before)
+            await options.before(reqContext);
+        const identifier = reqContext.params.id;
+        const config = {
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL
+        };
+        let response = await this._service.update(identifier, reqContext.body, config);
+        if (options?.after)
+            await options.after(reqContext, response);
+        return ctx.json(response);
+    }
+    async _updateMany(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx);
+        await this.preventIDOR(reqContext);
+        this.removeSystemFields(reqContext);
+        if (options?.before)
+            await options.before(reqContext);
+        const config = {
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL
+        };
+        let response = await this._service.updateMany(reqContext.body, config);
+        if (options?.after)
+            await options.after(reqContext, response);
+        return ctx.json(response);
+    }
+    async _delete(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx);
+        if (options?.before)
+            await options.before(reqContext);
+        const identifier = reqContext.params.id;
+        const config = {
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL
+        };
+        let response = await this._service.delete(identifier, config);
+        if (options?.after)
+            await options.after(reqContext, response);
+        return ctx.json({ success: !!response });
+    }
+    async _deleteMany(options, ctx) {
+        const reqContext = await this.getRequestContext(ctx);
+        if (options?.before)
+            await options.before(reqContext);
+        const config = {
+            filter: reqContext.queries.filter,
+            cache: this.getCache(ctx, this._options.cache, options?.cache),
+            cacheTTL: this._options.cacheTTL ?? options?.cacheTTL
+        };
+        let response = await this._service.deleteMany(config);
+        if (options?.after)
+            await options.after(reqContext, response);
+        return ctx.json({ success: !!response });
+    }
+    async getRequestContext(ctx, hasBody = true) {
+        let body = {};
+        if (hasBody) {
+            try {
+                body = await ctx.req.json();
+            }
+            catch (e) { }
+        }
+        return {
+            headers: ctx.req.raw.headers,
+            waitUntil: ctx.executionCtx.waitUntil,
+            body: body,
+            params: ctx.req.param(),
+            queries: ctx.req.query(),
+            env: ctx.env,
+            get: (key) => { return ctx.get(key); }
+        };
+    }
+    getCache(ctx, controllerLevel, routeLevel) {
+        const useCache = routeLevel ?? controllerLevel;
+        return useCache ? ctx.env.CACHE : undefined;
+    }
+}

package/dist/core/api-error.d.ts

@@ -0,0 +1,29 @@
+import { StatusCode } from "hono/utils/http-status";
+export declare class APIError extends Error {
+    data?: any;
+    internalProperties?: any;
+    readonly statusCode: StatusCode;
+    readonly name: string;
+    constructor(name: string, message: string, statusCode: StatusCode, data?: any, internalProperties?: any);
+    static errBadRequest(message: string, data?: any, internalProperties?: any): APIError;
+    static errInvalidQueryParameter(message: string, data?: any, internalProperties?: any): APIError;
+    static errMissingBody(data?: any, internalProperties?: any): APIError;
+    static errInvalidBody(data?: any, internalProperties?: any): APIError;
+    static errInvalidParameterValue(message: string, data?: any, internalProperties?: any): APIError;
+    static errInvalidHeaderParameter(message: string, data?: any, internalProperties?: any): APIError;
+    static errUnauthorized(data?: any, internalProperties?: any): APIError;
+    static errInvalidAccessToken(data?: any, internalProperties?: any): APIError;
+    static errInvalidIdToken(data?: any, internalProperties?: any): APIError;
+    static errInvalidAuthToken(message?: string, data?: any, internalProperties?: any): APIError;
+    static errInvalidSessionToken(message?: string, data?: any, internalProperties?: any): APIError;
+    static errPermissionDenied(message?: string, data?: any, internalProperties?: any): APIError;
+    static errAlreadyExists(data?: any, internalProperties?: any): APIError;
+    static errNotFound(message?: string, data?: any, internalProperties?: any): APIError;
+    static errResourceCreationFailed(message: string, data?: any, internalProperties?: any): APIError;
+    static errResourceUpdateFailed(message: string, data?: any, internalProperties?: any): APIError;
+    static errResourceDeletionFailed(message: string, data?: any, internalProperties?: any): APIError;
+    static errFailedDependency(message?: string, data?: any, internalProperties?: any): APIError;
+    static errTemporarilyUnavailable(message?: string, data?: any, internalProperties?: any): APIError;
+    static errServerError(data?: any, internalProperties?: any): APIError;
+}
+//# sourceMappingURL=api-error.d.ts.map

package/dist/core/api-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-error.d.ts","sourceRoot":"","sources":["../../src/core/api-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD,qBAAa,QAAS,SAAQ,KAAK;IAQxB,IAAI,CAAC;IACL,kBAAkB,CAAC;IAR5B,SAAgB,UAAU,EAAG,UAAU,CAAC;IACxC,SAAgB,IAAI,EAAG,MAAM,CAAC;gBAG5B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,UAAU,EACf,IAAI,CAAC,KAAK,EACV,kBAAkB,CAAC,KAAK;WAQnB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAGnE,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG9E,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAGnD,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAGnD,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG9E,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG/E,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAGpD,qBAAqB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG1D,iBAAiB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAGtD,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAI1E,sBAAsB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAI7E,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAI1E,gBAAgB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAGrD,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAIlE,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG/E,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG7E,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG/E,mBAAmB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAG1E,yBAAyB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;WAGhF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,EAAE,GAAG;CASlE"}

package/dist/core/api-error.js

@@ -0,0 +1,78 @@
+export class APIError extends Error {
+    data;
+    internalProperties;
+    statusCode;
+    name;
+    constructor(name, message, statusCode, data, internalProperties) {
+        super();
+        this.data = data;
+        this.internalProperties = internalProperties;
+        this.name = name;
+        this.statusCode = statusCode;
+        this.message = message;
+    }
+    static errBadRequest(message, data, internalProperties) {
+        return new APIError('BadRequest', message, 400, data, internalProperties);
+    }
+    static errInvalidQueryParameter(message, data, internalProperties) {
+        return new APIError('InvalidQueryParameter', message, 400, data, internalProperties);
+    }
+    static errMissingBody(data, internalProperties) {
+        return new APIError('MissingBody', 'Missing Data in Request Body.', 400, data, internalProperties);
+    }
+    static errInvalidBody(data, internalProperties) {
+        return new APIError('InvalidBody', 'Invalid Request Body.', 422, data, internalProperties);
+    }
+    static errInvalidParameterValue(message, data, internalProperties) {
+        return new APIError('InvalidParameterValue', message, 400, data, internalProperties);
+    }
+    static errInvalidHeaderParameter(message, data, internalProperties) {
+        return new APIError('InvalidHeaderParameter', message, 400, data, internalProperties);
+    }
+    static errUnauthorized(data, internalProperties) {
+        return new APIError('Unauthorized', 'Client Authorization Failed.', 401, data, internalProperties);
+    }
+    static errInvalidAccessToken(data, internalProperties) {
+        return new APIError('InvalidAccessToken', 'Invalid authentication token', 401, data, internalProperties);
+    }
+    static errInvalidIdToken(data, internalProperties) {
+        return new APIError('InvalidIdToken', 'Invalid Id Token', 401, data, internalProperties);
+    }
+    static errInvalidAuthToken(message, data, internalProperties) {
+        message = message ? message : 'Invalid Auth Token';
+        return new APIError('InvalidAuthToken', message, 401, data, internalProperties);
+    }
+    static errInvalidSessionToken(message, data, internalProperties) {
+        message = message ? message : 'Invalid Session Token';
+        return new APIError('InvalidAuthToken', message, 401, data, internalProperties);
+    }
+    static errPermissionDenied(message, data, internalProperties) {
+        message = message ? message : "You don't have permission to perform this action.";
+        return new APIError('Forbidden', message, 403, data, internalProperties);
+    }
+    static errAlreadyExists(data, internalProperties) {
+        return new APIError('AlreadyExists', 'Requested resource already exists', 409, data, internalProperties);
+    }
+    static errNotFound(message, data, internalProperties) {
+        message = message ? message : 'Requested resource does not exist';
+        return new APIError('Resource not found', message, 404, data, internalProperties);
+    }
+    static errResourceCreationFailed(message, data, internalProperties) {
+        return new APIError('ResourceCreationFailed', message, 409, data, internalProperties);
+    }
+    static errResourceUpdateFailed(message, data, internalProperties) {
+        return new APIError('ResourceUpdateFailed', message, 409, data, internalProperties);
+    }
+    static errResourceDeletionFailed(message, data, internalProperties) {
+        return new APIError('ResourceDeletionFailed', message, 409, data, internalProperties);
+    }
+    static errFailedDependency(message, data, internalProperties) {
+        return new APIError('FailedDependency', message || 'Try again later.', 424, data, internalProperties);
+    }
+    static errTemporarilyUnavailable(message, data, internalProperties) {
+        return new APIError('ServiceTemporarilyUnavailable', message || 'Try again later.', 503, data, internalProperties);
+    }
+    static errServerError(data, internalProperties) {
+        return new APIError('Internal Server Error', 'Request could not be carried out.', 500, data, internalProperties);
+    }
+}

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

@@ -0,0 +1,16 @@
+/// <reference types="@cloudflare/workers-types" />
+import BaseModel from "./base.model";
+export default class BaseCache {
+    private static kvKeySizeLimit;
+    static get<T>(cache: KVNamespace, key: string): Promise<T | null>;
+    static set<T>(cache: KVNamespace, key: string, value: T, ttl?: number): Promise<void>;
+    static delete(cache: KVNamespace, key: string): Promise<void>;
+    static setModel<T extends BaseModel>(cache: KVNamespace, model: T, modifier?: object, ttl?: number): Promise<void>;
+    static getModel<U extends typeof BaseModel>(cache: KVNamespace, model: U, identifier: string | number, modifier?: object): Promise<InstanceType<U> | null>;
+    static clearModel<T extends BaseModel>(cache: KVNamespace, model: T | undefined): Promise<void>;
+    static setPage<T extends BaseModel>(cache: KVNamespace, page: T[], modifier?: object, ttl?: number): Promise<void>;
+    static getPage<U extends typeof BaseModel>(cache: KVNamespace, model: U, modifier?: object): Promise<InstanceType<U>[] | null>;
+    static clearPage<T extends typeof BaseModel>(cache: KVNamespace, model: T): Promise<void>;
+    private static getModifier;
+}
+//# sourceMappingURL=base.cache.d.ts.map

package/dist/core/base.cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.cache.d.ts","sourceRoot":"","sources":["../../src/core/base.cache.ts"],"names":[],"mappings":";AAGA,OAAO,SAAS,MAAM,cAAc,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,MAAM,CAAC,cAAc,CAAO;WAEhB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;WAS1D,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,GAAE,MAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;WAI/F,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;WAOtD,QAAQ,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;WAc3G,QAAQ,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;WAOnJ,UAAU,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;WA+BxF,OAAO,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;WAS3G,OAAO,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;WAOvH,SAAS,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;mBAWjF,WAAW;CAGjC"}

package/dist/core/base.cache.js

@@ -0,0 +1,72 @@
+import { CachePrefix, DefaultCacheTTL } from "../types/api.types";
+import { isEmpty } from "../utils/array.utils";
+import { sha256 } from "../utils/crypto.utils";
+export default class BaseCache {
+    static kvKeySizeLimit = 512;
+    static async get(cache, key) {
+        if (key.length > this.kvKeySizeLimit)
+            return null;
+        const response = await cache.get(key);
+        if (!response)
+            return null;
+        return JSON.parse(response);
+    }
+    static async set(cache, key, value, ttl = DefaultCacheTTL) {
+        key.length <= this.kvKeySizeLimit && await cache.put(key, JSON.stringify(value), { expirationTtl: ttl });
+    }
+    static async delete(cache, key) {
+        key.length <= this.kvKeySizeLimit && await cache.delete(key);
+    }
+    static async setModel(cache, model, modifier, ttl) {
+        const identifier = model?.$id();
+        if (!identifier)
+            return;
+        const modifierTag = await this.getModifier(modifier);
+        await this.set(cache, `${CachePrefix.Record}${model.constructor.name}:${identifier.toString()}:${modifierTag}`, model, ttl);
+        if (model.$key()) {
+            await this.set(cache, `${CachePrefix.Record}${model.constructor.name}:${model.$key()}:${modifierTag}`, model, ttl);
+        }
+    }
+    static async getModel(cache, model, identifier, modifier) {
+        const modifierTag = await this.getModifier(modifier);
+        return await this.get(cache, `${CachePrefix.Record}${model.name}:${identifier.toString()}:${modifierTag}`);
+    }
+    static async clearModel(cache, model) {
+        if (!model)
+            return;
+        const identifier = model?.$id();
+        if (!identifier)
+            return;
+        const idList = await cache.list({ prefix: `${CachePrefix.Record}${model.constructor.name}:${identifier.toString()}` });
+        const idPromises = idList.keys.map(async (key) => {
+            await this.delete(cache, key.name);
+        });
+        let keyPromises = [];
+        if (model.$key()) {
+            const keyList = await cache.list({ prefix: `${CachePrefix.Record}${model.constructor.name}:${model.$key()}` });
+            keyPromises = keyList.keys.map(async (key) => {
+                await this.delete(cache, key.name);
+            });
+        }
+        await Promise.all([...idPromises, ...keyPromises]);
+    }
+    static async setPage(cache, page, modifier, ttl) {
+        if (!page.length)
+            return;
+        const modifierTag = await this.getModifier(modifier);
+        await this.set(cache, `${CachePrefix.Page}${page[0].constructor.name}:${modifierTag}`, page, ttl);
+    }
+    static async getPage(cache, model, modifier) {
+        const modifierTag = await this.getModifier(modifier);
+        return await this.get(cache, `${CachePrefix.Page}${model.name}:${modifierTag}`);
+    }
+    static async clearPage(cache, model) {
+        const list = await cache.list({ prefix: `${CachePrefix.Page}${model.name}` });
+        Promise.all(list.keys.map(async (key) => {
+            await this.delete(cache, key.name);
+        }));
+    }
+    static async getModifier(modifier) {
+        return modifier && !isEmpty(modifier) ? await sha256(JSON.stringify(modifier)) : "";
+    }
+}

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

@@ -0,0 +1,40 @@
+import { DB } from "../types/db.types";
+import { IndexSummary, PropSummary } from "../types/decorator.types";
+import { FilterConfig, PageConfig, UpsertConfig } from "./base.options";
+interface BaseModelSchema {
+    indexes: IndexSummary[];
+    props: PropSummary;
+    timestamped?: boolean;
+}
+export declare class Document {
+    static schema: BaseModelSchema;
+}
+export default class BaseModel extends Document {
+    static collection: string;
+    static idField: string;
+    static keyField?: string;
+    static ownerField?: string;
+    static db: DB;
+    id: number;
+    static create<T extends typeof BaseModel>(this: T, data: Partial<InstanceType<T>>, upsertConfig?: UpsertConfig<T>): Promise<InstanceType<T> | null>;
+    static createMany<T extends typeof BaseModel>(this: T, data: Partial<InstanceType<T>>[], upsertConfig?: UpsertConfig<T>): Promise<InstanceType<T>[] | null>;
+    static findById<T extends typeof BaseModel>(this: T, id: string | number, config?: FilterConfig): Promise<InstanceType<T> | null>;
+    static findOne<T extends typeof BaseModel>(this: T, config: FilterConfig): Promise<InstanceType<T> | null>;
+    static findMany<T extends typeof BaseModel>(this: T, config?: PageConfig & FilterConfig): Promise<Array<InstanceType<T>>>;
+    static update<T extends typeof BaseModel>(this: T, id: string | number, data: Partial<InstanceType<T>>): Promise<InstanceType<T> | null>;
+    static updateMany<T extends typeof BaseModel>(this: T, data: Partial<InstanceType<T>>[]): Promise<InstanceType<T>[] | null>;
+    static delete<T extends typeof BaseModel>(this: T, id: string): 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 fromDatabaseJson<T extends typeof BaseModel>(this: T, json: object): InstanceType<T>;
+    private static addDefaults;
+    $id(): any;
+    $key(): any;
+    $owner(): any;
+}
+export declare abstract class TimeStamped extends BaseModel {
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export {};
+//# sourceMappingURL=base.model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"base.model.d.ts","sourceRoot":"","sources":["../../src/core/base.model.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,EAAE,EAAa,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGxE,UAAU,eAAe;IACvB,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,KAAK,EAAE,WAAW,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,qBAAa,QAAQ;IACnB,OAAc,MAAM,EAAE,eAAe,CAA8B;CACpE;AAED,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC7C,OAAc,UAAU,EAAE,MAAM,CAAC;IACjC,OAAc,OAAO,EAAE,MAAM,CAAQ;IACrC,OAAc,QAAQ,CAAC,EAAE,MAAM,CAAC;IAChC,OAAc,UAAU,CAAC,EAAE,MAAM,CAAC;IAClC,OAAc,EAAE,EAAE,EAAE,CAAC;IAGnB,EAAE,EAAG,MAAM,CAAC;WAEM,MAAM,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;WAoB5I,UAAU,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;WAmBpJ,QAAQ,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;WAY1H,OAAO,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;WAYnG,QAAQ,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;WAelH,MAAM,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;WAkBjI,UAAU,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;WAepH,MAAM,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;WAcxF,UAAU,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;WAazG,KAAK,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;WAaxE,gBAAgB,CAAC,CAAC,SAAS,OAAO,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC;IAMlG,OAAO,CAAC,MAAM,CAAC,WAAW;IAWnB,GAAG;IACH,IAAI;IACJ,MAAM;CACd;AAED,8BACsB,WAAY,SAAQ,SAAS;IAE1C,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB,SAAS,CAAC,EAAE,IAAI,CAAC;CACzB"}