unconventional 1.9.1 → 1.10.0

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

@@ -37,6 +37,8 @@ export declare class BaseModel extends Document {
     private static addDefaults;
     /** Gets the field name to use for the provided identifier */
     private static getFieldName;
+    /** Masks private fields and in the provided data and its relations */
+    static maskPrivate<T extends typeof BaseModel>(this: T, data: InstanceType<T> | InstanceType<T>[], relationsOnly?: boolean): void;
     $id(): any;
     $key(): any;
     $owner(): any;

package/dist/core/base.model.js

@@ -204,6 +204,25 @@ class BaseModel extends Document {
             ? this.idField
             : this.keyField || undefined;
     }
+    /** Masks private fields and in the provided data and its relations */
+    static maskPrivate(data, relationsOnly = false) {
+        if (!data || typeof data !== 'object')
+            return;
+        const dataArray = Array.isArray(data) ? data : [data];
+        const propSummary = Object.entries(this.schema.props);
+        for (const 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;
+                }
+                // Mask private fields in relations
+                if (options.relation && item[key]) {
+                    (0, utils_1.getRelationModel)(options.relation).maskPrivate(item[key]);
+                }
+            }
+        }
+    }
     $id() { return this[this.constructor['idField']]; }
     $key() { return this[this.constructor['keyField']]; }
     $owner() { return this[this.constructor['ownerField']]; }

package/dist/utils/api.utils.d.ts

@@ -1,4 +1,6 @@
 import { AndOr } from "unconventional-pg-queries";
+import { Relation } from "../types";
+import { BaseModel } from "../core/base.model";
 /**
  * Decompose an expand-formatted string into an array of its parts.
  * @example
@@ -23,3 +25,5 @@ export declare function replaceFilter(filter: string | string[] | undefined, tar
 export declare function hasFilter(filter: string | string[] | undefined, target: string): boolean;
 /** Check whether a string is UUID */
 export declare function isUUID(str: string): boolean;
+/** Get the model class of a relation definition */
+export declare function getRelationModel<T extends typeof BaseModel>(relation: Relation<T>): T;

package/dist/utils/api.utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUUID = exports.hasFilter = exports.replaceFilter = exports.splitExpandUnit = exports.parseExpandString = void 0;
+exports.getRelationModel = exports.isUUID = exports.hasFilter = exports.replaceFilter = exports.splitExpandUnit = exports.parseExpandString = void 0;
 const unconventional_pg_queries_1 = require("unconventional-pg-queries");
 const db_types_1 = require("../types/db.types");
 const defaultTarget = ',';
@@ -91,3 +91,8 @@ function isUUID(str) {
     return true;
 }
 exports.isUUID = isUUID;
+/** Get the model class of a relation definition */
+function getRelationModel(relation) {
+    return (relation.model.toString().startsWith('class')) ? relation.model : relation.model();
+}
+exports.getRelationModel = getRelationModel;

package/dist/utils/db.utils.js

@@ -19,7 +19,7 @@ function getExpand(model, expand) {
         const relation = propSummary[parent]?.relation;
         if (!relation)
             throw api_error_1.APIError.errInvalidQueryParameter(`Invalid expansion: ${parent}`);
-        const relationModel = (relation.model.toString().startsWith('class')) ? relation.model : relation.model();
+        const relationModel = (0, api_utils_1.getRelationModel)(relation);
         expansions[parent] = {
             type: [decorator_types_1.RelationType.HasOne, decorator_types_1.RelationType.BelongsTo].includes(relation.type) ? unconventional_pg_queries_1.OneOrMany.One : unconventional_pg_queries_1.OneOrMany.Many,
             fromTable: model.collection,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unconventional",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "description": "A complete server built on Cloudflare Workers/Pages",
   "keywords": [
     "cloudflare",