@snowtop/ent 0.1.0-alpha65 → 0.1.0-alpha68

package/core/clause.d.ts

@@ -99,4 +99,8 @@ export declare function TsVectorPlainToTsQuery(col: string, val: string | TsQuer
 export declare function TsVectorPhraseToTsQuery(col: string, val: string | TsQuery): Clause;
 export declare function TsVectorWebsearchToTsQuery(col: string, val: string | TsQuery): Clause;
 export declare function sensitiveValue(val: any): SensitiveValue;
+export declare function JSONObjectFieldKeyASJSON(col: string, field: string): string;
+export declare function JSONObjectFieldKeyAsText(col: string, field: string): string;
+declare type predicate = "==" | ">" | "<" | "!=" | ">=" | "<=";
+export declare function JSONPathValuePredicate(dbCol: string, path: string, val: any, pred: predicate): Clause;
 export {};

package/core/clause.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sensitiveValue = exports.TsVectorWebsearchToTsQuery = exports.TsVectorPhraseToTsQuery = exports.TsVectorPlainToTsQuery = exports.TsVectorColTsQuery = exports.WebsearchToTsQuery = exports.PhraseToTsQuery = exports.PlainToTsQuery = exports.TsQuery = exports.In = exports.Or = exports.AndOptional = exports.And = exports.LessEq = exports.GreaterEq = exports.Less = exports.Greater = exports.NotEq = exports.Eq = exports.ArrayNotEq = exports.ArrayEq = exports.PostgresArrayNotOverlaps = exports.PostgresArrayOverlaps = exports.PostgresArrayNotContains = exports.PostgresArrayNotContainsValue = exports.PostgresArrayContains = exports.PostgresArrayContainsValue = void 0;
+exports.JSONPathValuePredicate = exports.JSONObjectFieldKeyAsText = exports.JSONObjectFieldKeyASJSON = exports.sensitiveValue = exports.TsVectorWebsearchToTsQuery = exports.TsVectorPhraseToTsQuery = exports.TsVectorPlainToTsQuery = exports.TsVectorColTsQuery = exports.WebsearchToTsQuery = exports.PhraseToTsQuery = exports.PlainToTsQuery = exports.TsQuery = exports.In = exports.Or = exports.AndOptional = exports.And = exports.LessEq = exports.GreaterEq = exports.Less = exports.Greater = exports.NotEq = exports.Eq = exports.ArrayNotEq = exports.ArrayEq = exports.PostgresArrayNotOverlaps = exports.PostgresArrayOverlaps = exports.PostgresArrayNotContains = exports.PostgresArrayNotContainsValue = exports.PostgresArrayContains = exports.PostgresArrayContainsValue = void 0;
 const db_1 = __importStar(require("./db"));
 function isSensitive(val) {
     return (val !== null &&
@@ -559,3 +559,55 @@ function sensitiveValue(val) {
     };
 }
 exports.sensitiveValue = sensitiveValue;
+// These don't return Clauses but return helpful things that can be passed to clauses
+// https://www.postgresql.org/docs/12/functions-json.html#FUNCTIONS-JSON-OP-TABLE
+// see test in db_clause.test.ts
+// unclear best time to use this...
+function JSONObjectFieldKeyASJSON(col, field) {
+    return `${col}->'${field}'`;
+}
+exports.JSONObjectFieldKeyASJSON = JSONObjectFieldKeyASJSON;
+function JSONObjectFieldKeyAsText(col, field) {
+    return `${col}->>'${field}'`;
+}
+exports.JSONObjectFieldKeyAsText = JSONObjectFieldKeyAsText;
+class jSONPathValuePredicateClause {
+    constructor(col, path, value, pred) {
+        this.col = col;
+        this.path = path;
+        this.value = value;
+        this.pred = pred;
+    }
+    clause(idx) {
+        if (db_1.default.getDialect() !== db_1.Dialect.Postgres) {
+            throw new Error(`not supported`);
+        }
+        return `${this.col} @@ $${idx}`;
+    }
+    columns() {
+        return [this.col];
+    }
+    wrap(val) {
+        return `${this.path} ${this.pred} ${JSON.stringify(val)}`;
+    }
+    values() {
+        if (isSensitive(this.value)) {
+            return [this.wrap(this.value.value())];
+        }
+        return [this.wrap(this.value)];
+    }
+    logValues() {
+        if (isSensitive(this.value)) {
+            return [this.wrap(this.value.logValue())];
+        }
+        return [this.wrap(this.value)];
+    }
+    instanceKey() {
+        return `${this.col}${this.path}${rawValue(this.value)}${this.pred}`;
+    }
+}
+// https://www.postgresql.org/docs/12/functions-json.html#FUNCTIONS-JSON-OP-TABLE
+function JSONPathValuePredicate(dbCol, path, val, pred) {
+    return new jSONPathValuePredicateClause(dbCol, path, val, pred);
+}
+exports.JSONPathValuePredicate = JSONPathValuePredicate;

package/core/ent.js

@@ -254,9 +254,10 @@ function isParameterizedQuery(opts) {
  *  }) // doesn't change the query
  */
 async function loadCustomData(options, query, context) {
-    //loaderFactory not here...
-    //  options.
     function getClause(cls) {
+        if (options.clause && options.loaderFactory?.options?.clause) {
+            throw new Error(`cannot pass both options.clause && optsions.loaderFactory.options.clause`);
+        }
         let optClause = options.clause || options.loaderFactory?.options?.clause;
         if (typeof optClause === "function") {
             optClause = optClause();

package/core/privacy.js

@@ -451,11 +451,8 @@ async function applyPrivacyPolicy(v, policy, ent) {
 exports.applyPrivacyPolicy = applyPrivacyPolicy;
 // this will throw an exception if fails or return error | null?
 async function applyPrivacyPolicyX(v, policy, ent, throwErr) {
-    // right now we apply all at same time. todo: be smart about this in the future
-    const results = await Promise.all(policy.rules.map((rule) => rule.apply(v, ent)));
-    for (let i = 0; i < results.length; i++) {
-        const res = results[i];
-        const rule = policy.rules[i];
+    for (const rule of policy.rules) {
+        const res = await rule.apply(v, ent);
         if (res.result == privacyResult.Allow) {
             return true;
         }

package/index.d.ts

@@ -26,6 +26,9 @@ declare const query: {
     PostgresArrayNotContains: typeof q.PostgresArrayNotContains;
     PostgresArrayOverlaps: typeof q.PostgresArrayOverlaps;
     PostgresArrayNotOverlaps: typeof q.PostgresArrayNotOverlaps;
+    JSONPathValuePredicate: typeof q.JSONPathValuePredicate;
+    JSONObjectFieldKeyASJSON: typeof q.JSONObjectFieldKeyASJSON;
+    JSONObjectFieldKeyAsText: typeof q.JSONObjectFieldKeyAsText;
     TsQuery: typeof q.TsQuery;
     PlainToTsQuery: typeof q.PlainToTsQuery;
     PhraseToTsQuery: typeof q.PhraseToTsQuery;

package/index.js

@@ -123,6 +123,9 @@ const query = {
     PostgresArrayNotContains: q.PostgresArrayNotContains,
     PostgresArrayOverlaps: q.PostgresArrayOverlaps,
     PostgresArrayNotOverlaps: q.PostgresArrayNotOverlaps,
+    JSONPathValuePredicate: q.JSONPathValuePredicate,
+    JSONObjectFieldKeyASJSON: q.JSONObjectFieldKeyASJSON,
+    JSONObjectFieldKeyAsText: q.JSONObjectFieldKeyAsText,
     TsQuery: q.TsQuery,
     PlainToTsQuery: q.PlainToTsQuery,
     PhraseToTsQuery: q.PhraseToTsQuery,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snowtop/ent",
-  "version": "0.1.0-alpha65",
+  "version": "0.1.0-alpha68",
   "description": "snowtop ent framework",
   "main": "index.js",
   "types": "index.d.ts",

package/schema/schema.d.ts

@@ -133,6 +133,10 @@ export interface ImportType {
     type: string;
     [x: string]: any;
 }
+export interface ConvertType {
+    path: string;
+    function: string;
+}
 declare type EnumMap = {
     [key: string]: string;
 };
@@ -200,6 +204,7 @@ export interface FieldOptions {
     polymorphic?: boolean | PolymorphicOptions;
     privacyPolicy?: PrivacyPolicy | (() => PrivacyPolicy);
     getDerivedFields?(name: string): FieldMap;
+    convert?: ConvertType;
     [x: string]: any;
 }
 export interface PolymorphicOptions {