@snowtop/ent 0.0.39 → 0.0.40-alpha5

package/action/orchestrator.d.ts

@@ -12,7 +12,7 @@ export interface OrchestratorOptions<T extends Ent, TData extends Data> {
     builder: Builder<T>;
     action?: Action<T>;
     schema: SchemaInputType;
-    editedFields(): Map<string, any>;
+    editedFields(): Map<string, any> | Promise<Map<string, any>>;
     updateInput?: (data: TData) => void;
 }
 interface edgeInputDataOpts {

package/action/orchestrator.js

@@ -4,7 +4,6 @@ exports.EntChangeset = exports.Orchestrator = exports.edgeDirection = void 0;
 const ent_1 = require("../core/ent");
 const schema_1 = require("../schema/schema");
 const action_1 = require("../action");
-const snake_case_1 = require("snake-case");
 const camel_case_1 = require("camel-case");
 const privacy_1 = require("../core/privacy");
 const executor_1 = require("./executor");
@@ -277,7 +276,8 @@ class Orchestrator {
         const builder = this.options.builder;
         // future optimization: can get schemaFields to memoize based on different values
         const schemaFields = (0, schema_1.getFields)(this.options.schema);
-        let editedData = await this.getFieldsWithDefaultValues(builder, schemaFields, action);
+        const editedFields = await this.options.editedFields();
+        let editedData = await this.getFieldsWithDefaultValues(builder, schemaFields, editedFields, action);
         // this runs in following phases:
         // * set default fields and pass to builder so the value can be checked by triggers/observers/validators
         // * privacy policy (use unsafe ent if we have it)
@@ -294,8 +294,11 @@ class Orchestrator {
             await this.triggers(action, builder, triggers);
         }
         let validators = action?.validators || [];
+        // not ideal we're calling this twice. fix...
+        // needed for now. may need to write somet of this?
+        const editedFields2 = await this.options.editedFields();
         await Promise.all([
-            this.formatAndValidateFields(schemaFields),
+            this.formatAndValidateFields(schemaFields, editedFields2),
             this.validators(validators, action, builder),
         ]);
     }
@@ -330,8 +333,7 @@ class Orchestrator {
     isBuilder(val) {
         return val.placeholderID !== undefined;
     }
-    async getFieldsWithDefaultValues(builder, schemaFields, action) {
-        const editedFields = this.options.editedFields();
+    async getFieldsWithDefaultValues(builder, schemaFields, editedFields, action) {
         let data = {};
         let defaultData = {};
         let input = action?.getInput() || {};
@@ -369,12 +371,12 @@ class Orchestrator {
                     if (field.format) {
                         val = field.format(transformed.data[k]);
                     }
-                    let dbKey = field.storageKey || (0, snake_case_1.snakeCase)(field.name);
+                    let dbKey = (0, schema_1.getStorageKey)(field);
                     data[dbKey] = val;
                     this.defaultFieldsByTSName[(0, camel_case_1.camelCase)(k)] = val;
                     // hmm do we need this?
                     // TODO how to do this for local tests?
-                    //          this.defaultFieldsByFieldName[k] = val;
+                    // this.defaultFieldsByFieldName[k] = val;
                 }
             }
             this.actualOperation = this.getWriteOpForSQLStamentOp(transformed.op);
@@ -387,7 +389,7 @@ class Orchestrator {
         for (const [fieldName, field] of schemaFields) {
             let value = editedFields.get(fieldName);
             let defaultValue = undefined;
-            let dbKey = field.storageKey || (0, snake_case_1.snakeCase)(field.name);
+            let dbKey = (0, schema_1.getStorageKey)(field);
             if (value === undefined) {
                 if (this.actualOperation === action_1.WriteOperation.Insert) {
                     if (field.defaultToViewerOnCreate && field.defaultValueOnCreate) {
@@ -483,12 +485,11 @@ class Orchestrator {
         }
         return value;
     }
-    async formatAndValidateFields(schemaFields) {
+    async formatAndValidateFields(schemaFields, editedFields) {
         const op = this.actualOperation;
         if (op === action_1.WriteOperation.Delete) {
             return;
         }
-        const editedFields = this.options.editedFields();
         // build up data to be saved...
         let data = {};
         let logValues = {};
@@ -498,7 +499,7 @@ class Orchestrator {
                 // null allowed
                 value = this.defaultFieldsByFieldName[fieldName];
             }
-            let dbKey = field.storageKey || (0, snake_case_1.snakeCase)(field.name);
+            let dbKey = (0, schema_1.getStorageKey)(field);
             value = await this.transformFieldValue(field, dbKey, value);
             if (value !== undefined) {
                 data[dbKey] = value;
@@ -511,7 +512,7 @@ class Orchestrator {
             for (const fieldName in this.defaultFieldsByFieldName) {
                 const defaultValue = this.defaultFieldsByFieldName[fieldName];
                 let field = schemaFields.get(fieldName);
-                let dbKey = field.storageKey || (0, snake_case_1.snakeCase)(field.name);
+                let dbKey = (0, schema_1.getStorageKey)(field);
                 // no value, let's just default
                 if (data[dbKey] === undefined) {
                     const value = await this.transformFieldValue(field, dbKey, defaultValue);

package/core/base.d.ts

@@ -62,7 +62,7 @@ export interface SelectBaseDataOptions extends DataOptions {
 }
 export interface SelectDataOptions extends SelectBaseDataOptions {
     key: string;
-    clause?: clause.Clause;
+    clause?: clause.Clause | (() => clause.Clause | undefined);
 }
 export interface QueryableDataOptions extends SelectBaseDataOptions, QueryDataOptions {
 }
@@ -89,9 +89,11 @@ interface LoadableEntOptions<T extends Ent> {
     ent: EntConstructor<T>;
 }
 export interface LoadEntOptions<T extends Ent> extends LoadableEntOptions<T>, SelectBaseDataOptions {
+    fieldPrivacy?: Map<string, PrivacyPolicy>;
 }
 export interface LoadCustomEntOptions<T extends Ent> extends SelectBaseDataOptions {
     ent: EntConstructor<T>;
+    fieldPrivacy?: Map<string, PrivacyPolicy>;
 }
 export interface LoaderInfo {
     tableName: string;

package/core/config.d.ts

@@ -9,6 +9,10 @@ declare enum graphQLFieldFormat {
     LOWER_CAMEL = "lowerCamel",
     SNAKE_CASE = "snake_case"
 }
+declare enum fieldPrivacyEvaluated {
+    AT_ENT_LOAD = "at_ent_load",
+    ON_DEMAND = "on_demand"
+}
 export interface Config {
     dbConnectionString?: string;
     dbFile?: string;
@@ -30,6 +34,7 @@ interface CodegenConfig {
     defaultGraphQLFieldFormat?: graphQLFieldFormat;
     schemaSQLFilePath?: boolean;
     databaseToCompareTo?: string;
+    fieldPrivacyEvaluated?: fieldPrivacyEvaluated;
 }
 interface PrettierConfig {
     custom?: boolean;

package/core/config.js

@@ -40,6 +40,11 @@ var graphQLFieldFormat;
     graphQLFieldFormat["LOWER_CAMEL"] = "lowerCamel";
     graphQLFieldFormat["SNAKE_CASE"] = "snake_case";
 })(graphQLFieldFormat || (graphQLFieldFormat = {}));
+var fieldPrivacyEvaluated;
+(function (fieldPrivacyEvaluated) {
+    fieldPrivacyEvaluated["AT_ENT_LOAD"] = "at_ent_load";
+    fieldPrivacyEvaluated["ON_DEMAND"] = "on_demand";
+})(fieldPrivacyEvaluated || (fieldPrivacyEvaluated = {}));
 function setConfig(cfg) {
     if (cfg.log) {
         (0, logger_1.setLogLevels)(cfg.log);

package/core/db.d.ts

@@ -1,5 +1,5 @@
-import { Pool, ClientConfig, PoolClient } from "pg";
-export interface Database {
+import { Pool, PoolClient, PoolConfig } from "pg";
+export interface Database extends PoolConfig {
     database?: string;
     user?: string;
     password?: string;
@@ -16,7 +16,7 @@ export declare enum Dialect {
 }
 interface DatabaseInfo {
     dialect: Dialect;
-    config: ClientConfig;
+    config: PoolConfig;
     filePath?: string;
 }
 export default class DB {

package/core/db.js

@@ -109,6 +109,8 @@ function getClientConfig(args) {
                     host: cfg.host,
                     port: cfg.port,
                     ssl: cfg.sslmode == "enable",
+                    // max, min, etc
+                    ...cfg,
                 },
             };
         }

package/core/ent.d.ts

@@ -22,8 +22,6 @@ export declare type CustomQuery = string | rawQueryOptions | clause.Clause | Que
 export declare function loadCustomData(options: SelectBaseDataOptions, query: CustomQuery, context: Context | undefined): Promise<Data[]>;
 export declare function loadDerivedEnt<T extends Ent>(viewer: Viewer, data: Data, loader: new (viewer: Viewer, data: Data) => T): Promise<T | null>;
 export declare function loadDerivedEntX<T extends Ent>(viewer: Viewer, data: Data, loader: new (viewer: Viewer, data: Data) => T): Promise<T>;
-export declare function applyPrivacyPolicyForEnt<T extends Ent>(viewer: Viewer, ent: T | null): Promise<T | null>;
-export declare function applyPrivacyPolicyForEntX<T extends Ent>(viewer: Viewer, ent: T): Promise<T>;
 export declare function loadRowX(options: LoadRowOptions): Promise<Data>;
 export declare function loadRow(options: LoadRowOptions): Promise<Data | null>;
 export declare function performRawQuery(query: string, values: any[], logValues?: any[]): Promise<Data[]>;

package/core/ent.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEdgeTypeInGroup = exports.applyPrivacyPolicyForRows = exports.applyPrivacyPolicyForRowX = exports.applyPrivacyPolicyForRow = exports.loadNodesByEdge = exports.loadEdgeForID2 = exports.loadRawEdgeCountX = exports.loadUniqueNode = exports.loadUniqueEdge = exports.loadCustomEdges = exports.loadEdges = exports.defaultEdgeQueryOptions = exports.DefaultLimit = exports.loadEdgeDatas = exports.loadEdgeData = exports.assocEdgeLoader = exports.AssocEdgeData = exports.getCursor = exports.AssocEdge = exports.DeleteNodeOperation = exports.deleteRowsSync = exports.deleteRows = exports.editRowSync = exports.editRow = exports.buildUpdateQuery = exports.createRowSync = exports.createRow = exports.buildInsertQuery = exports.EdgeOperation = exports.EditNodeOperation = exports.buildGroupQuery = exports.buildQuery = exports.loadRows = exports.performRawQuery = exports.loadRow = exports.loadRowX = exports.applyPrivacyPolicyForEntX = exports.applyPrivacyPolicyForEnt = exports.loadDerivedEntX = exports.loadDerivedEnt = exports.loadCustomData = exports.loadCustomEnts = exports.loadEntsFromClause = exports.loadEnts = exports.loadEntXFromClause = exports.loadEntFromClause = exports.loadEntXViaKey = exports.loadEntX = exports.loadEntViaKey = exports.loadEnt = void 0;
+exports.getEdgeTypeInGroup = exports.applyPrivacyPolicyForRows = exports.applyPrivacyPolicyForRowX = exports.applyPrivacyPolicyForRow = exports.loadNodesByEdge = exports.loadEdgeForID2 = exports.loadRawEdgeCountX = exports.loadUniqueNode = exports.loadUniqueEdge = exports.loadCustomEdges = exports.loadEdges = exports.defaultEdgeQueryOptions = exports.DefaultLimit = exports.loadEdgeDatas = exports.loadEdgeData = exports.assocEdgeLoader = exports.AssocEdgeData = exports.getCursor = exports.AssocEdge = exports.DeleteNodeOperation = exports.deleteRowsSync = exports.deleteRows = exports.editRowSync = exports.editRow = exports.buildUpdateQuery = exports.createRowSync = exports.createRow = exports.buildInsertQuery = exports.EdgeOperation = exports.EditNodeOperation = exports.buildGroupQuery = exports.buildQuery = exports.loadRows = exports.performRawQuery = exports.loadRow = exports.loadRowX = exports.loadDerivedEntX = exports.loadDerivedEnt = exports.loadCustomData = exports.loadCustomEnts = exports.loadEntsFromClause = exports.loadEnts = exports.loadEntXFromClause = exports.loadEntFromClause = exports.loadEntXViaKey = exports.loadEntX = exports.loadEntViaKey = exports.loadEnt = void 0;
 const db_1 = __importStar(require("./db"));
 const privacy_1 = require("./privacy");
 const clause = __importStar(require("./clause"));
@@ -139,8 +139,7 @@ async function loadEntXFromClause(viewer, options, clause) {
         context: viewer.context,
     };
     const row = await loadRowX(rowOptions);
-    const ent = new options.ent(viewer, row);
-    return await applyPrivacyPolicyForEntX(viewer, ent);
+    return await applyPrivacyPolicyForRowX(viewer, options, row);
 }
 exports.loadEntXFromClause = loadEntXFromClause;
 async function loadEnts(viewer, options, ...ids) {
@@ -207,7 +206,7 @@ async function loadCustomEnts(viewer, options, query) {
     const result = new Array(rows.length);
     await Promise.all(rows.map(async (row, idx) => {
         const ent = new options.ent(viewer, row);
-        let privacyEnt = await applyPrivacyPolicyForEnt(viewer, ent);
+        let privacyEnt = await applyPrivacyPolicyForEnt(viewer, ent, row, options);
         if (privacyEnt) {
             result[idx] = privacyEnt;
         }
@@ -253,30 +252,55 @@ exports.loadCustomData = loadCustomData;
 // Derived ents
 async function loadDerivedEnt(viewer, data, loader) {
     const ent = new loader(viewer, data);
-    return await applyPrivacyPolicyForEnt(viewer, ent);
+    return await applyPrivacyPolicyForEnt(viewer, ent, data, {
+        ent: loader,
+    });
 }
 exports.loadDerivedEnt = loadDerivedEnt;
 async function loadDerivedEntX(viewer, data, loader) {
     const ent = new loader(viewer, data);
-    return await applyPrivacyPolicyForEntX(viewer, ent);
+    return await applyPrivacyPolicyForEntX(viewer, ent, data, { ent: loader });
 }
 exports.loadDerivedEntX = loadDerivedEntX;
-async function applyPrivacyPolicyForEnt(viewer, ent) {
+// everything calls into this two so should be fine
+// TODO is there a smarter way to not instantiate two objects here?
+async function applyPrivacyPolicyForEnt(viewer, ent, data, fieldPrivacyOptions) {
     if (ent) {
         const visible = await (0, privacy_1.applyPrivacyPolicy)(viewer, ent.privacyPolicy, ent);
-        if (visible) {
-            return ent;
+        if (!visible) {
+            return null;
         }
+        return doFieldPrivacy(viewer, ent, data, fieldPrivacyOptions);
     }
     return null;
 }
-exports.applyPrivacyPolicyForEnt = applyPrivacyPolicyForEnt;
-async function applyPrivacyPolicyForEntX(viewer, ent) {
+async function applyPrivacyPolicyForEntX(viewer, ent, data, options) {
     // this will throw
     await (0, privacy_1.applyPrivacyPolicyX)(viewer, ent.privacyPolicy, ent);
+    return doFieldPrivacy(viewer, ent, data, options);
+}
+async function doFieldPrivacy(viewer, ent, data, options) {
+    if (!options.fieldPrivacy) {
+        return ent;
+    }
+    const promises = [];
+    let somethingChanged = false;
+    for (const [k, policy] of options.fieldPrivacy) {
+        promises.push((async () => {
+            const r = await (0, privacy_1.applyPrivacyPolicy)(viewer, policy, ent);
+            if (!r) {
+                data[k] = null;
+                somethingChanged = true;
+            }
+        })());
+    }
+    await Promise.all(promises);
+    if (somethingChanged) {
+        // have to create new instance
+        return new options.ent(viewer, data);
+    }
     return ent;
 }
-exports.applyPrivacyPolicyForEntX = applyPrivacyPolicyForEntX;
 function logQuery(query, logValues) {
     (0, logger_1.log)("query", {
         query: query,
@@ -322,6 +346,8 @@ async function loadRow(options) {
         return res.rows[0];
     }
     catch (e) {
+        // an example of an error being suppressed
+        // another one. TODO https://github.com/lolopinto/ent/issues/862
         (0, logger_1.log)("error", e);
         return null;
     }
@@ -453,7 +479,16 @@ class EditNodeOperation {
         const opts = loader.getOptions();
         let cls = clause.Eq(options.key, id);
         if (opts.clause) {
-            cls = clause.And(opts.clause, cls);
+            let optionClause;
+            if (typeof opts.clause === "function") {
+                optionClause = opts.clause();
+            }
+            else {
+                optionClause = opts.clause;
+            }
+            if (optionClause) {
+                cls = clause.And(optionClause, cls);
+            }
         }
         const query = buildQuery({
             fields: opts.fields.length ? opts.fields : ["*"],
@@ -1150,20 +1185,19 @@ async function applyPrivacyPolicyForRow(viewer, options, row) {
         return null;
     }
     const ent = new options.ent(viewer, row);
-    return await applyPrivacyPolicyForEnt(viewer, ent);
+    return await applyPrivacyPolicyForEnt(viewer, ent, row, options);
 }
 exports.applyPrivacyPolicyForRow = applyPrivacyPolicyForRow;
 async function applyPrivacyPolicyForRowX(viewer, options, row) {
     const ent = new options.ent(viewer, row);
-    return await applyPrivacyPolicyForEntX(viewer, ent);
+    return await applyPrivacyPolicyForEntX(viewer, ent, row, options);
 }
 exports.applyPrivacyPolicyForRowX = applyPrivacyPolicyForRowX;
 async function applyPrivacyPolicyForRows(viewer, rows, options) {
     let m = new Map();
     // apply privacy logic
     await Promise.all(rows.map(async (row) => {
-        const ent = new options.ent(viewer, row);
-        let privacyEnt = await applyPrivacyPolicyForEnt(viewer, ent);
+        let privacyEnt = await applyPrivacyPolicyForRow(viewer, options, row);
         if (privacyEnt) {
             m.set(privacyEnt.id, privacyEnt);
         }

package/core/loaders/object_loader.d.ts

@@ -14,11 +14,15 @@ export declare class ObjectLoader<T> implements Loader<T, Data | null> {
     loadMany(keys: T[]): Promise<Data[]>;
     prime(data: Data): void;
 }
+interface ObjectLoaderOptions extends SelectDataOptions {
+    instanceKey?: string;
+}
 export declare class ObjectLoaderFactory<T> implements LoaderFactory<T, Data | null> {
-    options: SelectDataOptions;
+    options: ObjectLoaderOptions;
     name: string;
     private toPrime;
-    constructor(options: SelectDataOptions);
+    constructor(options: ObjectLoaderOptions);
     createLoader(context?: Context): ObjectLoader<T>;
     addToPrime(factory: ObjectLoaderFactory<T>): void;
 }
+export {};

package/core/loaders/object_loader.js

@@ -45,7 +45,16 @@ function createDataLoader(options) {
         let col = options.key;
         let cls = clause.In(col, ...ids);
         if (options.clause) {
-            cls = clause.And(options.clause, cls);
+            let optionClause;
+            if (typeof options.clause === "function") {
+                optionClause = options.clause();
+            }
+            else {
+                optionClause = options.clause;
+            }
+            if (optionClause) {
+                cls = clause.And(optionClause, cls);
+            }
         }
         const rowOptions = {
             ...options,
@@ -119,7 +128,16 @@ class ObjectLoader {
         }
         let cls = clause.Eq(this.options.key, key);
         if (this.options.clause) {
-            cls = clause.And(this.options.clause, cls);
+            let optionClause;
+            if (typeof this.options.clause === "function") {
+                optionClause = this.options.clause();
+            }
+            else {
+                optionClause = this.options.clause;
+            }
+            if (optionClause) {
+                cls = clause.And(optionClause, cls);
+            }
         }
         const rowOptions = {
             ...this.options,
@@ -137,7 +155,16 @@ class ObjectLoader {
         }
         let cls = clause.In(this.options.key, ...keys);
         if (this.options.clause) {
-            cls = clause.And(this.options.clause, cls);
+            let optionClause;
+            if (typeof this.options.clause === "function") {
+                optionClause = this.options.clause();
+            }
+            else {
+                optionClause = this.options.clause;
+            }
+            if (optionClause) {
+                cls = clause.And(optionClause, cls);
+            }
         }
         const rowOptions = {
             ...this.options,
@@ -160,7 +187,17 @@ class ObjectLoaderFactory {
     constructor(options) {
         this.options = options;
         this.toPrime = [];
-        this.name = `${options.tableName}:${options.key}:${options.clause?.instanceKey() || ""}`;
+        // we don't wanna do it here because we want it to be delayed
+        let instanceKey = "";
+        if (typeof this.options.clause === "function") {
+            if (!options.instanceKey) {
+                throw new Error(`need to pass an instanceKey to ObjectLoader if clause is a function`);
+            }
+        }
+        else if (this.options.clause) {
+            instanceKey = this.options.clause.instanceKey();
+        }
+        this.name = `${options.tableName}:${options.key}:${instanceKey}`;
     }
     createLoader(context) {
         return (0, loader_1.getLoader)(this, () => {

package/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./core/base";
-export { loadEnt, loadCustomData, loadCustomEnts, loadEntX, loadEnts, CustomQuery, loadDerivedEnt, loadDerivedEntX, loadEntViaKey, loadEntXViaKey, applyPrivacyPolicyForEnt, applyPrivacyPolicyForEntX, performRawQuery, loadRowX, loadRow, loadRows, DataOperation, EditNodeOptions, EditNodeOperation, EdgeOperation, DeleteNodeOperation, AssocEdge, AssocEdgeInputOptions, AssocEdgeInput, AssocEdgeData, loadEdgeData, loadEdgeDatas, loadEdges, loadUniqueEdge, loadUniqueNode, loadRawEdgeCountX, loadEdgeForID2, loadNodesByEdge, getEdgeTypeInGroup, } from "./core/ent";
+export { loadEnt, loadCustomData, loadCustomEnts, loadEntX, loadEnts, CustomQuery, loadDerivedEnt, loadDerivedEntX, loadEntViaKey, loadEntXViaKey, performRawQuery, loadRowX, loadRow, loadRows, DataOperation, EditNodeOptions, EditNodeOperation, EdgeOperation, DeleteNodeOperation, AssocEdge, AssocEdgeInputOptions, AssocEdgeInput, AssocEdgeData, loadEdgeData, loadEdgeDatas, loadEdges, loadUniqueEdge, loadUniqueNode, loadRawEdgeCountX, loadEdgeForID2, loadNodesByEdge, getEdgeTypeInGroup, } from "./core/ent";
 import DB from "./core/db";
 export * from "./core/loaders";
 export { DB };

package/index.js

@@ -25,8 +25,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DenyIfViewerOutboundEdgeExistsRule = exports.DenyIfViewerInboundEdgeExistsRule = exports.DenyIfEdgeExistsRule = exports.AllowIfViewerOutboundEdgeExistsRule = exports.AllowIfViewerInboundEdgeExistsRule = exports.AllowIfEdgeExistsRule = exports.DenyIfViewerEqualsRule = exports.AllowIfViewerEqualsRule = exports.DenyIfEntPropertyIsRule = exports.AllowIfEntPropertyIsRule = exports.AllowIfViewerIsEntPropertyRule = exports.AllowIfViewerIsRule = exports.AllowIfFuncRule = exports.AllowIfViewerRule = exports.AllowIfHasIdentity = exports.DenyIfLoggedOutRule = exports.DenyIfLoggedInRule = exports.AlwaysDenyRule = exports.AlwaysAllowRule = exports.EntPrivacyError = exports.DB = exports.getEdgeTypeInGroup = exports.loadNodesByEdge = exports.loadEdgeForID2 = exports.loadRawEdgeCountX = exports.loadUniqueNode = exports.loadUniqueEdge = exports.loadEdges = exports.loadEdgeDatas = exports.loadEdgeData = exports.AssocEdgeData = exports.AssocEdge = exports.DeleteNodeOperation = exports.EdgeOperation = exports.EditNodeOperation = exports.loadRows = exports.loadRow = exports.loadRowX = exports.performRawQuery = exports.applyPrivacyPolicyForEntX = exports.applyPrivacyPolicyForEnt = exports.loadEntXViaKey = exports.loadEntViaKey = exports.loadDerivedEntX = exports.loadDerivedEnt = exports.loadEnts = exports.loadEntX = exports.loadCustomEnts = exports.loadCustomData = exports.loadEnt = void 0;
-exports.setLogLevels = exports.loadConfig = exports.LoggedOutViewer = exports.IDViewer = exports.ContextCache = exports.query = exports.AllowIfViewerHasIdentityPrivacyPolicy = exports.AllowIfViewerPrivacyPolicy = exports.AllowIfSubPolicyAllowsRule = exports.AllowIfConditionAppliesRule = exports.AlwaysDenyPrivacyPolicy = exports.AlwaysAllowPrivacyPolicy = exports.applyPrivacyPolicyX = exports.applyPrivacyPolicy = exports.DelayedResultRule = exports.DenyIfEntIsVisiblePolicy = exports.AllowIfEntIsVisiblePolicy = exports.DenyIfEntIsNotVisibleRule = exports.DenyIfEntIsVisibleRule = exports.AllowIfEntIsNotVisibleRule = exports.AllowIfEntIsVisibleRule = exports.DenyIfViewerOutboundEdgeDoesNotExistRule = exports.DenyIfViewerInboundEdgeDoesNotExistRule = exports.DenyIfEdgeDoesNotExistRule = void 0;
+exports.DenyIfViewerInboundEdgeDoesNotExistRule = exports.DenyIfEdgeDoesNotExistRule = exports.DenyIfViewerOutboundEdgeExistsRule = exports.DenyIfViewerInboundEdgeExistsRule = exports.DenyIfEdgeExistsRule = exports.AllowIfViewerOutboundEdgeExistsRule = exports.AllowIfViewerInboundEdgeExistsRule = exports.AllowIfEdgeExistsRule = exports.DenyIfViewerEqualsRule = exports.AllowIfViewerEqualsRule = exports.DenyIfEntPropertyIsRule = exports.AllowIfEntPropertyIsRule = exports.AllowIfViewerIsEntPropertyRule = exports.AllowIfViewerIsRule = exports.AllowIfFuncRule = exports.AllowIfViewerRule = exports.AllowIfHasIdentity = exports.DenyIfLoggedOutRule = exports.DenyIfLoggedInRule = exports.AlwaysDenyRule = exports.AlwaysAllowRule = exports.EntPrivacyError = exports.DB = exports.getEdgeTypeInGroup = exports.loadNodesByEdge = exports.loadEdgeForID2 = exports.loadRawEdgeCountX = exports.loadUniqueNode = exports.loadUniqueEdge = exports.loadEdges = exports.loadEdgeDatas = exports.loadEdgeData = exports.AssocEdgeData = exports.AssocEdge = exports.DeleteNodeOperation = exports.EdgeOperation = exports.EditNodeOperation = exports.loadRows = exports.loadRow = exports.loadRowX = exports.performRawQuery = exports.loadEntXViaKey = exports.loadEntViaKey = exports.loadDerivedEntX = exports.loadDerivedEnt = exports.loadEnts = exports.loadEntX = exports.loadCustomEnts = exports.loadCustomData = exports.loadEnt = void 0;
+exports.setLogLevels = exports.loadConfig = exports.LoggedOutViewer = exports.IDViewer = exports.ContextCache = exports.query = exports.AllowIfViewerHasIdentityPrivacyPolicy = exports.AllowIfViewerPrivacyPolicy = exports.AllowIfSubPolicyAllowsRule = exports.AllowIfConditionAppliesRule = exports.AlwaysDenyPrivacyPolicy = exports.AlwaysAllowPrivacyPolicy = exports.applyPrivacyPolicyX = exports.applyPrivacyPolicy = exports.DelayedResultRule = exports.DenyIfEntIsVisiblePolicy = exports.AllowIfEntIsVisiblePolicy = exports.DenyIfEntIsNotVisibleRule = exports.DenyIfEntIsVisibleRule = exports.AllowIfEntIsNotVisibleRule = exports.AllowIfEntIsVisibleRule = exports.DenyIfViewerOutboundEdgeDoesNotExistRule = void 0;
 __exportStar(require("./core/base"), exports);
 var ent_1 = require("./core/ent");
 Object.defineProperty(exports, "loadEnt", { enumerable: true, get: function () { return ent_1.loadEnt; } });
@@ -38,8 +38,6 @@ Object.defineProperty(exports, "loadDerivedEnt", { enumerable: true, get: functi
 Object.defineProperty(exports, "loadDerivedEntX", { enumerable: true, get: function () { return ent_1.loadDerivedEntX; } });
 Object.defineProperty(exports, "loadEntViaKey", { enumerable: true, get: function () { return ent_1.loadEntViaKey; } });
 Object.defineProperty(exports, "loadEntXViaKey", { enumerable: true, get: function () { return ent_1.loadEntXViaKey; } });
-Object.defineProperty(exports, "applyPrivacyPolicyForEnt", { enumerable: true, get: function () { return ent_1.applyPrivacyPolicyForEnt; } });
-Object.defineProperty(exports, "applyPrivacyPolicyForEntX", { enumerable: true, get: function () { return ent_1.applyPrivacyPolicyForEntX; } });
 Object.defineProperty(exports, "performRawQuery", { enumerable: true, get: function () { return ent_1.performRawQuery; } });
 // even these 3 need to change...
 Object.defineProperty(exports, "loadRowX", { enumerable: true, get: function () { return ent_1.loadRowX; } });
@@ -62,7 +60,7 @@ Object.defineProperty(exports, "getEdgeTypeInGroup", { enumerable: true, get: fu
 const db_1 = __importDefault(require("./core/db"));
 exports.DB = db_1.default;
 __exportStar(require("./core/loaders"), exports);
-// TODO figure out if this should be its own
+// TODO figure out if this should be its own import path e.g. @snowtop/ent/privacy
 var privacy_1 = require("./core/privacy");
 Object.defineProperty(exports, "EntPrivacyError", { enumerable: true, get: function () { return privacy_1.EntPrivacyError; } });
 Object.defineProperty(exports, "AlwaysAllowRule", { enumerable: true, get: function () { return privacy_1.AlwaysAllowRule; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snowtop/ent",
-  "version": "0.0.39",
+  "version": "0.0.40-alpha5",
   "description": "snowtop ent framework",
   "main": "index.js",
   "types": "index.d.ts",

package/parse_schema/parse.d.ts

@@ -38,10 +38,11 @@ interface ProcessedPattern {
     assocEdges: ProcessedAssocEdge[];
     fields: ProcessedField[];
 }
-declare type ProcessedField = Omit<Field, "defaultValueOnEdit" | "defaultValueOnCreate"> & {
+declare type ProcessedField = Omit<Field, "defaultValueOnEdit" | "defaultValueOnCreate" | "privacyPolicy"> & {
     hasDefaultValueOnCreate?: boolean;
     hasDefaultValueOnEdit?: boolean;
     patternName?: string;
+    hasFieldPrivacy?: boolean;
 };
 interface patternsDict {
     [key: string]: ProcessedPattern;

package/parse_schema/parse.js

@@ -7,6 +7,7 @@ function processFields(src, patternName) {
         let f = { ...field };
         f.hasDefaultValueOnCreate = field.defaultValueOnCreate != undefined;
         f.hasDefaultValueOnEdit = field.defaultValueOnEdit != undefined;
+        f.hasFieldPrivacy = field.privacyPolicy !== undefined;
         if (field.polymorphic) {
             // convert boolean into object
             // we keep boolean as an option to keep API simple

package/schema/index.d.ts

@@ -1,6 +1,6 @@
 import Schema from "./schema";
 export { Schema };
-export { Field, AssocEdge, AssocEdgeGroup, InverseAssocEdge, Edge, Pattern, DBType, Type, FieldOptions, SchemaConstructor, SchemaInputType, getFields, ActionOperation, Action, EdgeAction, NoFields, Constraint, Index, ConstraintType, ForeignKeyInfo, requiredField, optionalField, UpdateOperation, TransformedUpdateOperation, SQLStatementOperation, getTransformedReadClause, } from "./schema";
+export { Field, AssocEdge, AssocEdgeGroup, InverseAssocEdge, Edge, Pattern, DBType, Type, FieldOptions, SchemaConstructor, SchemaInputType, getFields, getFieldsWithPrivacy, ActionOperation, Action, EdgeAction, NoFields, Constraint, Index, ConstraintType, ForeignKeyInfo, requiredField, optionalField, UpdateOperation, TransformedUpdateOperation, SQLStatementOperation, getTransformedReadClause, getObjectLoaderProperties, } from "./schema";
 export { Timestamps, Node, BaseEntSchema, BaseEntSchemaWithTZ, } from "./base_schema";
 export * from "./field";
 export * from "./json_field";

package/schema/index.js

@@ -10,10 +10,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseEntSchemaWithTZ = exports.BaseEntSchema = exports.Node = exports.Timestamps = exports.getTransformedReadClause = exports.SQLStatementOperation = exports.optionalField = exports.requiredField = exports.ConstraintType = exports.NoFields = exports.ActionOperation = exports.getFields = exports.DBType = void 0;
+exports.BaseEntSchemaWithTZ = exports.BaseEntSchema = exports.Node = exports.Timestamps = exports.getObjectLoaderProperties = exports.getTransformedReadClause = exports.SQLStatementOperation = exports.optionalField = exports.requiredField = exports.ConstraintType = exports.NoFields = exports.ActionOperation = exports.getFieldsWithPrivacy = exports.getFields = exports.DBType = void 0;
 var schema_1 = require("./schema");
 Object.defineProperty(exports, "DBType", { enumerable: true, get: function () { return schema_1.DBType; } });
 Object.defineProperty(exports, "getFields", { enumerable: true, get: function () { return schema_1.getFields; } });
+Object.defineProperty(exports, "getFieldsWithPrivacy", { enumerable: true, get: function () { return schema_1.getFieldsWithPrivacy; } });
 Object.defineProperty(exports, "ActionOperation", { enumerable: true, get: function () { return schema_1.ActionOperation; } });
 Object.defineProperty(exports, "NoFields", { enumerable: true, get: function () { return schema_1.NoFields; } });
 Object.defineProperty(exports, "ConstraintType", { enumerable: true, get: function () { return schema_1.ConstraintType; } });
@@ -21,6 +22,7 @@ Object.defineProperty(exports, "requiredField", { enumerable: true, get: functio
 Object.defineProperty(exports, "optionalField", { enumerable: true, get: function () { return schema_1.optionalField; } });
 Object.defineProperty(exports, "SQLStatementOperation", { enumerable: true, get: function () { return schema_1.SQLStatementOperation; } });
 Object.defineProperty(exports, "getTransformedReadClause", { enumerable: true, get: function () { return schema_1.getTransformedReadClause; } });
+Object.defineProperty(exports, "getObjectLoaderProperties", { enumerable: true, get: function () { return schema_1.getObjectLoaderProperties; } });
 var base_schema_1 = require("./base_schema");
 Object.defineProperty(exports, "Timestamps", { enumerable: true, get: function () { return base_schema_1.Timestamps; } });
 Object.defineProperty(exports, "Node", { enumerable: true, get: function () { return base_schema_1.Node; } });

package/schema/schema.d.ts

@@ -1,4 +1,4 @@
-import { Data, Ent, LoaderInfo, Viewer } from "../core/base";
+import { Data, Ent, LoaderInfo, PrivacyPolicy, Viewer } from "../core/base";
 import { Builder } from "../action/action";
 import { Clause } from "../core/clause";
 export default interface Schema {
@@ -161,6 +161,7 @@ export interface FieldOptions {
     derivedWhenEmbedded?: boolean;
     polymorphic?: boolean | PolymorphicOptions;
     derivedFields?: Field[];
+    privacyPolicy?: PrivacyPolicy | (() => PrivacyPolicy);
 }
 export interface PolymorphicOptions {
     types?: string[];
@@ -179,7 +180,14 @@ export interface SchemaConstructor {
 export declare type SchemaInputType = Schema | SchemaConstructor;
 export declare function getSchema(value: SchemaInputType): Schema;
 export declare function getFields(value: SchemaInputType): Map<string, Field>;
+export declare function getStorageKey(field: Field): string;
+export declare function getFieldsWithPrivacy(value: SchemaInputType): Map<string, PrivacyPolicy>;
 export declare function getTransformedReadClause(value: SchemaInputType): Clause | undefined;
+interface objectLoaderOptions {
+    clause?: () => Clause | undefined;
+    instanceKey?: string;
+}
+export declare function getObjectLoaderProperties(value: SchemaInputType, tableName: string): objectLoaderOptions | undefined;
 export declare function getTransformedUpdateOp<T extends Ent>(value: SchemaInputType, stmt: UpdateOperation<T>): TransformedUpdateOperation<T> | undefined;
 export declare enum ActionOperation {
     Create = 1,

package/schema/schema.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConstraintType = exports.optionalField = exports.requiredField = exports.NoFields = exports.ActionOperation = exports.getTransformedUpdateOp = exports.getTransformedReadClause = exports.getFields = exports.getSchema = exports.DBType = exports.SQLStatementOperation = void 0;
+exports.ConstraintType = exports.optionalField = exports.requiredField = exports.NoFields = exports.ActionOperation = exports.getTransformedUpdateOp = exports.getObjectLoaderProperties = exports.getTransformedReadClause = exports.getFieldsWithPrivacy = exports.getStorageKey = exports.getFields = exports.getSchema = exports.DBType = exports.SQLStatementOperation = void 0;
+const snake_case_1 = require("snake-case");
 // we also want this transformation to exist on a per-action basis
 // if it exists on an action, we don't do the global schema transformation
 var SQLStatementOperation;
@@ -72,6 +73,41 @@ function getFields(value) {
     return m;
 }
 exports.getFields = getFields;
+function getStorageKey(field) {
+    return field.storageKey || (0, snake_case_1.snakeCase)(field.name);
+}
+exports.getStorageKey = getStorageKey;
+// returns a mapping of storage key to field privacy
+function getFieldsWithPrivacy(value) {
+    const schema = getSchema(value);
+    function addFields(fields) {
+        for (const field of fields) {
+            const derivedFields = field.derivedFields;
+            if (derivedFields !== undefined) {
+                addFields(derivedFields);
+            }
+            if (field.privacyPolicy) {
+                let privacyPolicy;
+                if (typeof field.privacyPolicy === "function") {
+                    privacyPolicy = field.privacyPolicy();
+                }
+                else {
+                    privacyPolicy = field.privacyPolicy;
+                }
+                m.set(getStorageKey(field), privacyPolicy);
+            }
+        }
+    }
+    let m = new Map();
+    if (schema.patterns) {
+        for (const pattern of schema.patterns) {
+            addFields(pattern.fields);
+        }
+    }
+    addFields(schema.fields);
+    return m;
+}
+exports.getFieldsWithPrivacy = getFieldsWithPrivacy;
 function getTransformedReadClause(value) {
     const schema = getSchema(value);
     if (!schema.patterns) {
@@ -87,6 +123,13 @@ function getTransformedReadClause(value) {
     return;
 }
 exports.getTransformedReadClause = getTransformedReadClause;
+function getObjectLoaderProperties(value, tableName) {
+    return {
+        clause: () => getTransformedReadClause(value),
+        instanceKey: `${tableName}:transformedReadClause`,
+    };
+}
+exports.getObjectLoaderProperties = getObjectLoaderProperties;
 function getTransformedUpdateOp(value, stmt) {
     const schema = getSchema(value);
     if (!schema.patterns) {

package/testutils/builder.js

@@ -147,11 +147,27 @@ class SimpleBuilder {
             action: action,
             schema: this.schema,
             editedFields: () => {
-                return this.fields;
+                // to simulate what we do in generated builders where we return a new Map
+                const m = new Map();
+                for (const [k, v] of this.fields) {
+                    m.set(k, v);
+                }
+                return m;
             },
             updateInput: (input) => {
+                const knownFields = (0, schema_1.getFields)(this.schema);
                 for (const k in input) {
-                    this.fields.set(k, input[k]);
+                    if (knownFields.has(k)) {
+                        this.fields.set(k, input[k]);
+                    }
+                    else {
+                        // related to #510. we do camelCase to pass fields in here but fields may be snakeCase and we want that to pass in tests
+                        // we do camelCase in
+                        const sc = (0, snake_case_1.snakeCase)(k);
+                        if (knownFields.has(sc)) {
+                            this.fields.set(sc, input[k]);
+                        }
+                    }
                 }
             },
         });

package/testutils/db/test_db.d.ts

@@ -71,10 +71,11 @@ export declare class TempDB {
     constructor(tables: CoreConcept[]);
     getDialect(): Dialect;
     getTables(): Map<string, CoreConcept>;
-    beforeAll(): Promise<void>;
+    beforeAll(setupConnString?: boolean): Promise<void>;
     getSqliteClient(): SqliteDatabase;
     getPostgresClient(): PGClient;
     afterAll(): Promise<void>;
+    getDB(): string;
     dropAll(): Promise<void>;
     drop(...tables: string[]): Promise<void>;
     create(...tables: CoreConcept[]): Promise<void>;

package/testutils/db/test_db.js

@@ -336,7 +336,7 @@ class TempDB {
     getTables() {
         return this.tables;
     }
-    async beforeAll() {
+    async beforeAll(setupConnString = true) {
         if (this.dialect === db_1.Dialect.Postgres) {
             const user = process.env.POSTGRES_USER || "";
             const password = process.env.POSTGRES_PASSWORD || "";
@@ -348,11 +348,17 @@ class TempDB {
             await this.client.connect();
             this.db = randomDB();
             await this.client.query(`CREATE DATABASE ${this.db}`);
-            if (user && password) {
-                process.env.DB_CONNECTION_STRING = `postgres://${user}:${password}@localhost:5432/${this.db}`;
+            if (setupConnString) {
+                if (user && password) {
+                    process.env.DB_CONNECTION_STRING = `postgres://${user}:${password}@localhost:5432/${this.db}`;
+                }
+                else {
+                    process.env.DB_CONNECTION_STRING = `postgres://localhost/${this.db}?`;
+                }
             }
             else {
-                process.env.DB_CONNECTION_STRING = `postgres://localhost/${this.db}?`;
+                // will probably be setup via loadConfig
+                delete process.env.DB_CONNECTION_STRING;
             }
             this.dbClient = new pg_1.Client({
                 host: "localhost",
@@ -397,6 +403,9 @@ class TempDB {
         await this.client.query(`DROP DATABASE ${this.db}`);
         await this.client.end();
     }
+    getDB() {
+        return this.db;
+    }
     async dropAll() {
         for (const [t, _] of this.tables) {
             await this.drop(t);