unconventional 0.0.5 → 0.0.6

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

@@ -1,10 +1,10 @@
 /// <reference types="@cloudflare/workers-types" />
 import { Context } from "hono";
 import { BaseHandler, Env } from "../types/api.types";
-import BaseModel from "./base.model";
+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> {
+import { BaseService } from "./base.service";
+export declare abstract class AbstractBaseController<M extends typeof BaseModel, E extends Env = Env> {
     protected _model: M;
     protected _service: BaseService<M>;
     protected _pageLimitDefault: number;

package/dist/core/abstractbase.controller.js

@@ -1,10 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractBaseController = void 0;
 const api_types_1 = require("../types/api.types");
-const base_service_1 = __importDefault(require("./base.service"));
+const base_service_1 = require("./base.service");
 class AbstractBaseController {
     _model;
     _service;
@@ -14,7 +12,7 @@ class AbstractBaseController {
     /** A controller providing CRUD endpoints for any BaseModel */
     constructor(model, options) {
         this._model = model;
-        this._service = new base_service_1.default(model);
+        this._service = new base_service_1.BaseService(model);
         this._options = options || {};
     }
     create(options) { return this._create.bind(this, options); }
@@ -286,4 +284,4 @@ class AbstractBaseController {
         return useCache ? ctx.env.CACHE : undefined;
     }
 }
-exports.default = AbstractBaseController;
+exports.AbstractBaseController = AbstractBaseController;

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

@@ -1,6 +1,6 @@
 /// <reference types="@cloudflare/workers-types" />
-import BaseModel from "./base.model";
-export default class BaseCache {
+import { BaseModel } from "./base.model";
+export declare 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>;

package/dist/core/base.cache.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCache = void 0;
 const api_types_1 = require("../types/api.types");
 const array_utils_1 = require("../utils/array.utils");
 const crypto_utils_1 = require("../utils/crypto.utils");
@@ -86,4 +87,4 @@ class BaseCache {
         return modifier && !(0, array_utils_1.isEmpty)(modifier) ? await (0, crypto_utils_1.sha256)(JSON.stringify(modifier)) : "";
     }
 }
-exports.default = BaseCache;
+exports.BaseCache = BaseCache;

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

@@ -9,7 +9,7 @@ interface BaseModelSchema {
 export declare class Document {
     static schema: BaseModelSchema;
 }
-export default class BaseModel extends Document {
+export declare class BaseModel extends Document {
     static collection: string;
     static idField: string;
     static keyField?: string;

package/dist/core/base.model.js

@@ -9,7 +9,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimeStamped = exports.Document = void 0;
+exports.TimeStamped = exports.BaseModel = exports.Document = void 0;
 const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const prop_decorator_1 = require("../decorators/prop.decorator");
 const timestamp_decorator_1 = require("../decorators/timestamp.decorator");
@@ -171,7 +171,7 @@ class BaseModel extends Document {
     $key() { return this[this.constructor['keyField']]; }
     $owner() { return this[this.constructor['ownerField']]; }
 }
-exports.default = BaseModel;
+exports.BaseModel = BaseModel;
 __decorate([
     (0, prop_decorator_1.prop)({ required: true, unique: true }),
     __metadata("design:type", Number)

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

@@ -1,7 +1,7 @@
 /// <reference types="@cloudflare/workers-types" />
 import { ConflictResolution } from "unconventional-pg-queries";
 import { Env } from "../types/api.types";
-import BaseModel from "./base.model";
+import { BaseModel } from "./base.model";
 export interface PageConfig {
     limit?: number;
     cursor?: string;

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

@@ -1,6 +1,6 @@
-import BaseModel from "./base.model";
+import { BaseModel } from "./base.model";
 import { FilterConfig, PageConfig, ServiceConfig } from "./base.options";
-export default class BaseService<M extends typeof BaseModel> {
+export declare class BaseService<M extends typeof BaseModel> {
     private model;
     /** A service providing CRUD methods for any Model */
     constructor(model: M);

package/dist/core/base.service.js

@@ -1,11 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseService = void 0;
 const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const api_error_1 = require("./api-error");
-const base_cache_1 = __importDefault(require("./base.cache"));
+const base_cache_1 = require("./base.cache");
 const db_utils_1 = require("../utils/db.utils");
 class BaseService {
     model;
@@ -28,8 +26,8 @@ class BaseService {
             throw api_error_1.APIError.errResourceCreationFailed(`Failed to create ${this.model.name}`);
         }
         else if (config?.cache) {
-            await base_cache_1.default.clearPage(config.cache, this.model);
-            await base_cache_1.default.setModel(config.cache, response, undefined, config.cacheTTL);
+            await base_cache_1.BaseCache.clearPage(config.cache, this.model);
+            await base_cache_1.BaseCache.setModel(config.cache, response, undefined, config.cacheTTL);
         }
         return response;
     }
@@ -45,8 +43,8 @@ class BaseService {
         }
         else if (config?.cache) {
             const cache = config.cache;
-            await base_cache_1.default.clearPage(cache, this.model);
-            await Promise.all(response.map(item => base_cache_1.default.setModel(cache, item, undefined, config.cacheTTL)));
+            await base_cache_1.BaseCache.clearPage(cache, this.model);
+            await Promise.all(response.map(item => base_cache_1.BaseCache.setModel(cache, item, undefined, config.cacheTTL)));
         }
         return response;
     }
@@ -59,7 +57,7 @@ class BaseService {
         const { cache, cacheTTL, ...modifiers } = config || {};
         let entity = null;
         if (cache) {
-            entity = await base_cache_1.default.getModel(cache, this.model, identifier, modifiers);
+            entity = await base_cache_1.BaseCache.getModel(cache, this.model, identifier, modifiers);
         }
         if (!entity) {
             if (!isNaN(+identifier)) {
@@ -73,7 +71,7 @@ class BaseService {
             if (!entity)
                 throw api_error_1.APIError.errNotFound(`No ${this.model.name} found with id ${identifier}`);
             if (cache) {
-                await base_cache_1.default.setModel(cache, entity, modifiers, cacheTTL);
+                await base_cache_1.BaseCache.setModel(cache, entity, modifiers, cacheTTL);
             }
         }
         return entity;
@@ -91,13 +89,13 @@ class BaseService {
         const { cache, cacheTTL, ...modifiers } = config || {};
         let page = null;
         if (cache) {
-            page = await base_cache_1.default.getPage(cache, this.model, modifiers);
+            page = await base_cache_1.BaseCache.getPage(cache, this.model, modifiers);
         }
         if (!page) {
             const limit = modifiers.limit || 12;
             page = await this.model.findMany({ limit, ...modifiers });
             if (cache) {
-                await base_cache_1.default.setPage(cache, page, modifiers, cacheTTL);
+                await base_cache_1.BaseCache.setPage(cache, page, modifiers, cacheTTL);
             }
         }
         return page;
@@ -114,8 +112,8 @@ class BaseService {
             throw api_error_1.APIError.errNotFound(`No ${this.model.name} found with id ${identifier}`);
         }
         else if (config?.cache) {
-            await base_cache_1.default.clearModel(config.cache, response);
-            await base_cache_1.default.setModel(config.cache, response, undefined, config.cacheTTL);
+            await base_cache_1.BaseCache.clearModel(config.cache, response);
+            await base_cache_1.BaseCache.setModel(config.cache, response, undefined, config.cacheTTL);
         }
         return response;
     }
@@ -131,8 +129,8 @@ class BaseService {
         }
         else if (config?.cache) {
             const cache = config.cache;
-            await Promise.all(response.map(item => base_cache_1.default.clearModel(cache, item)));
-            await Promise.all(response.map(item => base_cache_1.default.setModel(cache, item, undefined, config.cacheTTL)));
+            await Promise.all(response.map(item => base_cache_1.BaseCache.clearModel(cache, item)));
+            await Promise.all(response.map(item => base_cache_1.BaseCache.setModel(cache, item, undefined, config.cacheTTL)));
         }
         return response;
     }
@@ -147,8 +145,8 @@ class BaseService {
             throw api_error_1.APIError.errNotFound(`No ${this.model.name} found with id ${identifier}`);
         }
         else if (config?.cache) {
-            await base_cache_1.default.clearModel(config.cache, response);
-            await base_cache_1.default.clearPage(config.cache, this.model);
+            await base_cache_1.BaseCache.clearModel(config.cache, response);
+            await base_cache_1.BaseCache.clearPage(config.cache, this.model);
         }
         return response;
     }
@@ -165,10 +163,10 @@ class BaseService {
         }
         else if (config?.cache) {
             const cache = config.cache;
-            await base_cache_1.default.clearPage(config.cache, this.model);
-            await Promise.all(response.map(item => base_cache_1.default.clearModel(cache, item)));
+            await base_cache_1.BaseCache.clearPage(config.cache, this.model);
+            await Promise.all(response.map(item => base_cache_1.BaseCache.clearModel(cache, item)));
         }
         return response;
     }
 }
-exports.default = BaseService;
+exports.BaseService = BaseService;

package/dist/core/index.d.ts

@@ -4,3 +4,4 @@ export * from './base.cache';
 export * from './base.model';
 export * from './base.options';
 export * from './base.service';
+export * from './pg.driver';

package/dist/core/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./base.cache"), exports);
 __exportStar(require("./base.model"), exports);
 __exportStar(require("./base.options"), exports);
 __exportStar(require("./base.service"), exports);
+__exportStar(require("./pg.driver"), exports);

package/dist/decorators/index.decorator.d.ts

@@ -1,4 +1,4 @@
-import BaseModel from '../core/base.model';
+import { BaseModel } from '../core/base.model';
 import { IndexDefinition, IndexOptions, TypedClassDecorator } from '../types/decorator.types';
 /**
  * Defines a index for this Class which will then be added to the collection.

package/dist/decorators/prop.decorator.d.ts

@@ -1,4 +1,4 @@
-import BaseModel from '../core/base.model';
+import { BaseModel } from '../core/base.model';
 import type { PropOptions } from '../types/decorator.types';
 /**
  * Set Property Options for the property below

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

@@ -1,4 +1,4 @@
-import BaseModel from "../core/base.model";
+import { BaseModel } from "../core/base.model";
 export declare type TypedClassDecorator<T> = (target: T) => T | void;
 /** Definition of a sortable index. 1=ascending, -1=descending */
 export type IndexDefinition<T> = {
@@ -62,6 +62,10 @@ export interface PropOptions<T = any, S extends typeof BaseModel = any, P extend
     enum?: any;
     /** Give the Property a default Value */
     default?: T | (() => T);
+    /** Protect field from edits by non-privileged users */
+    system?: boolean;
+    /** Hide field in responses to non-privileged users */
+    private?: boolean;
     /** Relational field data */
     relation?: T extends typeof BaseModel ? Relation<T, S, P> : never;
 }

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

@@ -1,5 +1,5 @@
 import { ConflictResolution, Expansion, SqlConflict, SqlOrder, SqlPaginate, SqlWhere, SqlWhereOperator } from "unconventional-pg-queries";
-import BaseModel from "../core/base.model";
+import { BaseModel } from "../core/base.model";
 /** Converts a stringified list of relational fields to an array of data needed to expand those fields in a SQL environment  */
 export declare function getExpand<T extends typeof BaseModel>(model: T, expand?: string): Record<string, Expansion>;
 /** Converts a string of filters to an array of 'where' clause outlines for a SQL environment */

package/dist/utils/server.utils.js

@@ -1,11 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultErrorHandler = exports.bindDatabase = exports.defaultCors = void 0;
 const cors_1 = require("hono/cors");
-const base_model_1 = __importDefault(require("../core/base.model"));
+const base_model_1 = require("../core/base.model");
 const core_1 = require("../core");
 /** Default CORS middleware permitting all origins and methods */
 exports.defaultCors = (0, cors_1.cors)({
@@ -15,8 +12,8 @@ exports.defaultCors = (0, cors_1.cors)({
 /** Binds the database proxy to the BaseModel */
 const bindDatabase = (getDB) => {
     return async (ctx, next) => {
-        if (!base_model_1.default.db)
-            base_model_1.default.db = getDB(ctx);
+        if (!base_model_1.BaseModel.db)
+            base_model_1.BaseModel.db = getDB(ctx);
         await next();
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unconventional",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "A complete server built on Cloudflare Pages Functions",
   "keywords": [
     "cloudflare",