@snowtop/ent 0.0.38 → 0.0.39-alpha4

package/action/action.d.ts

@@ -1,6 +1,7 @@
 import { Ent, EntConstructor, Viewer, ID, Data, PrivacyPolicy, Context } from "../core/base";
 import { DataOperation, AssocEdgeInputOptions } from "../core/ent";
 import { Queryer } from "../core/db";
+import { TransformedUpdateOperation, UpdateOperation } from "../schema";
 export declare enum WriteOperation {
     Insert = "insert",
     Edit = "edit",
@@ -50,6 +51,7 @@ export interface Action<T extends Ent> {
     observers?: Observer<T>[];
     validators?: Validator<T>[];
     getInput(): Data;
+    transformWrite?: (stmt: UpdateOperation<T>) => Promise<TransformedUpdateOperation<T>> | TransformedUpdateOperation<T> | undefined;
     valid(): Promise<boolean>;
     validX(): Promise<void>;
     viewerForEntLoad?(data: Data): Viewer | Promise<Viewer>;

package/action/orchestrator.d.ts

@@ -41,8 +41,12 @@ export declare class Orchestrator<T extends Ent> {
     viewer: Viewer;
     private defaultFieldsByFieldName;
     private defaultFieldsByTSName;
+    private actualOperation;
+    private existingEnt?;
+    private disableTransformations;
     constructor(options: OrchestratorOptions<T, Data>);
     private addEdge;
+    setDisableTransformations(val: boolean): void;
     addInboundEdge<T2 extends Ent>(id1: ID | Builder<T2>, edgeType: string, nodeType: string, options?: AssocEdgeInputOptions): void;
     addOutboundEdge<T2 extends Ent>(id2: ID | Builder<T2>, edgeType: string, nodeType: string, options?: AssocEdgeInputOptions): void;
     removeInboundEdge(id1: ID, edgeType: string): void;
@@ -54,6 +58,8 @@ export declare class Orchestrator<T extends Ent> {
     private buildEdgeOps;
     private throwError;
     private getEntForPrivacyPolicy;
+    private getSQLStatementOperation;
+    private getWriteOpForSQLStamentOp;
     private validate;
     private triggers;
     private validators;

package/action/orchestrator.js

@@ -62,6 +62,8 @@ class Orchestrator {
         this.defaultFieldsByFieldName = {};
         this.defaultFieldsByTSName = {};
         this.viewer = options.viewer;
+        this.actualOperation = this.options.operation;
+        this.existingEnt = this.options.builder.existingEnt;
     }
     addEdge(edge, op) {
         this.edgeSet.add(edge.edgeType);
@@ -80,6 +82,9 @@ class Orchestrator {
         m1.set(op, m2);
         this.edges.set(edge.edgeType, m1);
     }
+    setDisableTransformations(val) {
+        this.disableTransformations = val;
+    }
     addInboundEdge(id1, edgeType, nodeType, options) {
         this.addEdge(new edgeInputData({
             id: id1,
@@ -135,24 +140,27 @@ class Orchestrator {
     }
     buildMainOp() {
         // this assumes we have validated fields
-        switch (this.options.operation) {
+        switch (this.actualOperation) {
             case action_1.WriteOperation.Delete:
-                return new ent_1.DeleteNodeOperation(this.options.builder.existingEnt.id, {
+                return new ent_1.DeleteNodeOperation(this.existingEnt.id, {
                     tableName: this.options.tableName,
                 });
             default:
+                if (this.actualOperation === action_1.WriteOperation.Edit && !this.existingEnt) {
+                    throw new Error(`existing ent required with operation ${this.actualOperation}`);
+                }
                 const opts = {
                     fields: this.validatedFields,
                     tableName: this.options.tableName,
                     fieldsToResolve: this.fieldsToResolve,
                     key: this.options.key,
-                    ent: this.options.loaderOptions.ent,
+                    loadEntOptions: this.options.loaderOptions,
                     placeholderID: this.options.builder.placeholderID,
                 };
                 if (this.logValues) {
                     opts.fieldsToLog = this.logValues;
                 }
-                this.mainOp = new ent_1.EditNodeOperation(opts, this.options.builder.existingEnt);
+                this.mainOp = new ent_1.EditNodeOperation(opts, this.existingEnt);
                 return this.mainOp;
         }
     }
@@ -219,35 +227,57 @@ class Orchestrator {
         if (!privacyPolicy || !action) {
             throw new Error(`shouldn't get here if no privacyPolicy for action`);
         }
-        if (this.options.operation === action_1.WriteOperation.Insert) {
+        if (this.actualOperation === action_1.WriteOperation.Insert) {
             return new EntCannotCreateEntError(privacyPolicy, action);
         }
-        else if (this.options.operation === action_1.WriteOperation.Edit) {
-            return new EntCannotEditEntError(privacyPolicy, action, this.options.builder.existingEnt);
+        else if (this.actualOperation === action_1.WriteOperation.Edit) {
+            return new EntCannotEditEntError(privacyPolicy, action, this.existingEnt);
         }
-        return new EntCannotDeleteEntError(privacyPolicy, action, this.options.builder.existingEnt);
+        return new EntCannotDeleteEntError(privacyPolicy, action, this.existingEnt);
     }
     getEntForPrivacyPolicy(editedData) {
-        if (this.options.operation !== action_1.WriteOperation.Insert) {
-            return this.options.builder.existingEnt;
+        if (this.actualOperation !== action_1.WriteOperation.Insert) {
+            return this.existingEnt;
         }
         // we create an unsafe ent to be used for privacy policies
         return new this.options.builder.ent(this.options.builder.viewer, editedData);
     }
+    getSQLStatementOperation() {
+        switch (this.actualOperation) {
+            case action_1.WriteOperation.Edit:
+                return schema_1.SQLStatementOperation.Update;
+            case action_1.WriteOperation.Insert:
+                return schema_1.SQLStatementOperation.Insert;
+            case action_1.WriteOperation.Delete:
+                return schema_1.SQLStatementOperation.Delete;
+        }
+    }
+    getWriteOpForSQLStamentOp(op) {
+        switch (op) {
+            case schema_1.SQLStatementOperation.Update:
+                return action_1.WriteOperation.Edit;
+            case schema_1.SQLStatementOperation.Insert:
+                return action_1.WriteOperation.Insert;
+            case schema_1.SQLStatementOperation.Update:
+                return action_1.WriteOperation.Delete;
+            default:
+                throw new Error("invalid path");
+        }
+    }
     async validate() {
         // existing ent required for edit or delete operations
-        switch (this.options.operation) {
+        switch (this.actualOperation) {
             case action_1.WriteOperation.Delete:
             case action_1.WriteOperation.Edit:
-                if (!this.options.builder.existingEnt) {
-                    throw new Error("existing ent required with operation");
+                if (!this.existingEnt) {
+                    throw new Error(`existing ent required with operation ${this.actualOperation}`);
                 }
         }
         const action = this.options.action;
         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 = this.getFieldsWithDefaultValues(builder, schemaFields, action);
+        let editedData = await this.getFieldsWithDefaultValues(builder, schemaFields, 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)
@@ -300,18 +330,66 @@ class Orchestrator {
     isBuilder(val) {
         return val.placeholderID !== undefined;
     }
-    getFieldsWithDefaultValues(builder, schemaFields, action) {
+    async getFieldsWithDefaultValues(builder, schemaFields, action) {
         const editedFields = this.options.editedFields();
         let data = {};
         let defaultData = {};
         let input = action?.getInput() || {};
         let updateInput = false;
+        // transformations
+        // if action transformations. always do it
+        // if disable transformations set, don't do schema transform and just do the right thing
+        // else apply schema tranformation if it exists
+        let transformed;
+        if (action?.transformWrite) {
+            transformed = await action.transformWrite({
+                viewer: builder.viewer,
+                op: this.getSQLStatementOperation(),
+                data: editedFields,
+                existingEnt: this.existingEnt,
+            });
+        }
+        else if (!this.disableTransformations) {
+            transformed = (0, schema_1.getTransformedUpdateOp)(this.options.schema, {
+                viewer: builder.viewer,
+                op: this.getSQLStatementOperation(),
+                data: editedFields,
+                existingEnt: this.existingEnt,
+            });
+        }
+        if (transformed) {
+            if (transformed.data) {
+                updateInput = true;
+                for (const k in transformed.data) {
+                    let field = schemaFields.get(k);
+                    if (!field) {
+                        throw new Error(`tried to transform field with unknown field ${k}`);
+                    }
+                    let val = transformed.data[k];
+                    if (field.format) {
+                        val = field.format(transformed.data[k]);
+                    }
+                    let dbKey = field.storageKey || (0, snake_case_1.snakeCase)(field.name);
+                    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.actualOperation = this.getWriteOpForSQLStamentOp(transformed.op);
+            if (transformed.existingEnt) {
+                this.existingEnt = transformed.existingEnt;
+            }
+        }
+        // transforming before doing default fields so that we don't create a new id
+        // and anything that depends on the type of operations knows what it is
         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);
             if (value === undefined) {
-                if (this.options.operation === action_1.WriteOperation.Insert) {
+                if (this.actualOperation === action_1.WriteOperation.Insert) {
                     if (field.defaultToViewerOnCreate && field.defaultValueOnCreate) {
                         throw new Error(`cannot set both defaultToViewerOnCreate and defaultValueOnCreate`);
                     }
@@ -326,7 +404,7 @@ class Orchestrator {
                     }
                 }
                 if (field.defaultValueOnEdit &&
-                    this.options.operation === action_1.WriteOperation.Edit) {
+                    this.actualOperation === action_1.WriteOperation.Edit) {
                     defaultValue = field.defaultValueOnEdit(builder, input);
                 }
             }
@@ -374,7 +452,7 @@ class Orchestrator {
                 // not setting server default as we're depending on the database handling that.
                 // server default allowed
                 field.serverDefault === undefined &&
-                this.options.operation === action_1.WriteOperation.Insert) {
+                this.actualOperation === action_1.WriteOperation.Insert) {
                 throw new Error(`required field ${field.name} not set`);
             }
         }
@@ -406,7 +484,7 @@ class Orchestrator {
         return value;
     }
     async formatAndValidateFields(schemaFields) {
-        const op = this.options.operation;
+        const op = this.actualOperation;
         if (op === action_1.WriteOperation.Delete) {
             return;
         }
@@ -494,7 +572,7 @@ class Orchestrator {
         const viewer = await this.viewerForEntLoad(row);
         const ent = await (0, ent_1.applyPrivacyPolicyForRow)(viewer, this.options.loaderOptions, row);
         if (!ent) {
-            if (this.options.operation == action_1.WriteOperation.Insert) {
+            if (this.actualOperation == action_1.WriteOperation.Insert) {
                 throw new Error(`was able to create ent but not load it`);
             }
             else {

package/core/base.d.ts

@@ -62,6 +62,7 @@ export interface SelectBaseDataOptions extends DataOptions {
 }
 export interface SelectDataOptions extends SelectBaseDataOptions {
     key: string;
+    clause?: clause.Clause;
 }
 export interface QueryableDataOptions extends SelectBaseDataOptions, QueryDataOptions {
 }

package/core/clause.d.ts

@@ -12,8 +12,10 @@ declare class simpleClause implements Clause {
     protected col: string;
     private value;
     private op;
-    constructor(col: string, value: any, op: string);
+    private handleSqliteNull?;
+    constructor(col: string, value: any, op: string, handleSqliteNull?: Clause | undefined);
     clause(idx: number): string;
+    private sqliteNull;
     values(): any[];
     logValues(): any[];
     instanceKey(): string;
@@ -27,8 +29,8 @@ declare class compositeClause implements Clause {
     logValues(): any[];
     instanceKey(): string;
 }
-export declare function Eq(col: string, value: any): simpleClause;
-export declare function NotEq(col: string, value: any): simpleClause;
+export declare function Eq(col: string, value: any): Clause;
+export declare function NotEq(col: string, value: any): Clause;
 export declare function Greater(col: string, value: any): simpleClause;
 export declare function Less(col: string, value: any): simpleClause;
 export declare function GreaterEq(col: string, value: any): simpleClause;

package/core/clause.js

@@ -22,7 +22,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sensitiveValue = exports.In = exports.Or = exports.And = exports.LessEq = exports.GreaterEq = exports.Less = exports.Greater = exports.NotEq = exports.Eq = void 0;
 const db_1 = __importStar(require("./db"));
 function isSensitive(val) {
-    return (typeof val === "object" && val.logValue !== undefined);
+    return (val !== null &&
+        typeof val === "object" &&
+        val.logValue !== undefined);
 }
 function rawValue(val) {
     if (isSensitive(val)) {
@@ -31,33 +33,94 @@ function rawValue(val) {
     return val;
 }
 class simpleClause {
-    constructor(col, value, op) {
+    constructor(col, value, op, handleSqliteNull) {
         this.col = col;
         this.value = value;
         this.op = op;
+        this.handleSqliteNull = handleSqliteNull;
     }
     clause(idx) {
+        const sqliteClause = this.sqliteNull();
+        if (sqliteClause) {
+            return sqliteClause.clause(idx);
+        }
         if (db_1.default.getDialect() === db_1.Dialect.Postgres) {
             return `${this.col} ${this.op} $${idx}`;
         }
         return `${this.col} ${this.op} ?`;
     }
+    sqliteNull() {
+        if (!this.handleSqliteNull) {
+            return;
+        }
+        const dialect = db_1.default.getDialect();
+        if (this.value !== null || dialect !== db_1.Dialect.SQLite) {
+            return;
+        }
+        return this.handleSqliteNull;
+    }
     values() {
+        const sqliteClause = this.sqliteNull();
+        if (sqliteClause) {
+            return sqliteClause.values();
+        }
         if (isSensitive(this.value)) {
             return [this.value.value()];
         }
         return [this.value];
     }
     logValues() {
+        const sqliteClause = this.sqliteNull();
+        if (sqliteClause) {
+            return sqliteClause.logValues();
+        }
         if (isSensitive(this.value)) {
             return [this.value.logValue()];
         }
         return [this.value];
     }
     instanceKey() {
+        const sqliteClause = this.sqliteNull();
+        if (sqliteClause) {
+            return sqliteClause.instanceKey();
+        }
         return `${this.col}${this.op}${rawValue(this.value)}`;
     }
 }
+class isNullClause {
+    constructor(col) {
+        this.col = col;
+    }
+    clause(idx) {
+        return `${this.col} IS NULL`;
+    }
+    values() {
+        return [];
+    }
+    logValues() {
+        return [];
+    }
+    instanceKey() {
+        return `${this.col} IS NULL`;
+    }
+}
+class isNotNullClause {
+    constructor(col) {
+        this.col = col;
+    }
+    clause(idx) {
+        return `${this.col} IS NOT NULL`;
+    }
+    values() {
+        return [];
+    }
+    logValues() {
+        return [];
+    }
+    instanceKey() {
+        return `${this.col} IS NOT NULL`;
+    }
+}
 class inClause {
     constructor(col, value) {
         this.col = col;
@@ -146,11 +209,11 @@ class compositeClause {
     }
 }
 function Eq(col, value) {
-    return new simpleClause(col, value, "=");
+    return new simpleClause(col, value, "=", new isNullClause(col));
 }
 exports.Eq = Eq;
 function NotEq(col, value) {
-    return new simpleClause(col, value, "!=");
+    return new simpleClause(col, value, "!=", new isNotNullClause(col));
 }
 exports.NotEq = NotEq;
 function Greater(col, value) {

package/core/config.d.ts

@@ -15,6 +15,7 @@ export interface Config {
     db?: Database | DBDict;
     log?: logType | logType[];
     codegen?: CodegenConfig;
+    customGraphQLJSONPath?: string;
 }
 interface CodegenConfig {
     defaultEntPolicy?: PrivacyConfig;

package/core/ent.d.ts

@@ -1,5 +1,5 @@
 import { Queryer, SyncQueryer } from "./db";
-import { Viewer, Ent, ID, LoadRowsOptions, LoadRowOptions, Data, DataOptions, QueryableDataOptions, EditRowOptions, LoadEntOptions, LoadCustomEntOptions, EdgeQueryableDataOptions, Context, SelectBaseDataOptions, CreateRowOptions, QueryDataOptions, EntConstructor } from "./base";
+import { Viewer, Ent, ID, LoadRowsOptions, LoadRowOptions, Data, DataOptions, QueryableDataOptions, EditRowOptions, LoadEntOptions, LoadCustomEntOptions, EdgeQueryableDataOptions, Context, SelectBaseDataOptions, CreateRowOptions, QueryDataOptions } from "./base";
 import { Executor } from "../action/action";
 import * as clause from "./clause";
 import { Builder } from "../action";
@@ -51,7 +51,7 @@ export interface DataOperation<T extends Ent = Ent> {
 }
 export interface EditNodeOptions<T extends Ent> extends EditRowOptions {
     fieldsToResolve: string[];
-    ent: EntConstructor<T>;
+    loadEntOptions: LoadEntOptions<T>;
     placeholderID?: ID;
 }
 export declare class EditNodeOperation<T extends Ent> implements DataOperation {

package/core/ent.js

@@ -84,8 +84,54 @@ function createDataLoader(options) {
         return result;
     }, loaderOptions);
 }
+// TODO probably delete since we're going to generate it now
+// instead of passing this here.
+// async function doPerformQuery<T extends Ent>(
+//   viewer: Viewer,
+//   id: ID,
+//   options: LoadEntOptions<T>,
+// ): Promise<Data | null> {
+//   let newClause: clause.Clause | undefined = undefined;
+//   if (options.schema) {
+//     const schema = getSchema(options.schema);
+//     if (schema.patterns) {
+//       for (const p of schema.patterns) {
+//         if (p.transformRead) {
+//           newClause = p.transformRead({
+//             op: QueryOperation.Select,
+//             clause: clause.Eq("id", id),
+//           });
+//         }
+//       }
+//     }
+//   }
+//   // we want a loader if possible . we don't want this to slow
+//   // things down...
+//   // id = x and deleted_at == null
+//   if (newClause) {
+//     // loader
+//     //    return loadRow({});
+//     // TODO
+//   }
+//   // we want a deleted_at loader...
+//   return options.loaderFactory.createLoader(viewer.context).load(id);
+// }
 // Ent accessors
 async function loadEnt(viewer, id, options) {
+    let newClause;
+    // if (options.schema) {
+    //   const schema = getSchema(options.schema);
+    //   if (schema.patterns) {
+    //     for (const p of schema.patterns) {
+    //       if (p.transformRead) {
+    //         newClause = p.transformRead({
+    //           op: QueryOperation.Select,
+    //           clause: clause.Eq("id", id),
+    //         });
+    //       }
+    //     }
+    //   }
+    // }
     const row = await options.loaderFactory.createLoader(viewer.context).load(id);
     return await applyPrivacyPolicyForRow(viewer, options, row);
 }
@@ -434,6 +480,8 @@ class EditNodeOperation {
         };
         if (this.existingEnt) {
             if (this.hasData(options.fields)) {
+                // even this with returning * doesn't work if transformed...
+                // we can have a transformed flag to see if it should be returned?
                 this.row = await editRow(queryer, options, this.existingEnt.id, "RETURNING *");
             }
             else {
@@ -445,20 +493,27 @@ class EditNodeOperation {
         }
     }
     reloadRow(queryer, id, options) {
+        // TODO this isn'talways an ObjectLoader. should throw or figure out a way to get query
+        // and run this on its own...
+        const loader = this.options.loadEntOptions.loaderFactory.createLoader(options.context);
+        const opts = loader.getOptions();
+        let cls = clause.Eq(options.key, id);
+        if (opts.clause) {
+            cls = clause.And(opts.clause, cls);
+        }
         const query = buildQuery({
-            fields: ["*"],
+            fields: opts.fields.length ? opts.fields : ["*"],
             tableName: options.tableName,
-            clause: clause.Eq(options.key, id),
+            clause: cls,
         });
         // special case log here because we're not going through any of the normal
         // methods here because those are async and this is sync
         // this is the only place we're doing this so only handling here
         logQuery(query, [id]);
         const r = queryer.querySync(query, [id]);
-        if (r.rows.length !== 1) {
-            throw new Error(`couldn't reload row for ${id}`);
+        if (r.rows.length === 1) {
+            this.row = r.rows[0];
         }
-        this.row = r.rows[0];
     }
     performWriteSync(queryer, context) {
         let options = {
@@ -487,7 +542,7 @@ class EditNodeOperation {
         if (!this.row) {
             return null;
         }
-        return new this.options.ent(viewer, this.row);
+        return new this.options.loadEntOptions.ent(viewer, this.row);
     }
 }
 exports.EditNodeOperation = EditNodeOperation;

package/core/loaders/object_loader.d.ts

@@ -7,6 +7,7 @@ export declare class ObjectLoader<T> implements Loader<T, Data | null> {
     private primedLoaders;
     private memoizedInitPrime;
     constructor(options: SelectDataOptions, context?: Context | undefined, toPrime?: ObjectLoaderFactory<T>[] | undefined);
+    getOptions(): SelectDataOptions;
     private initPrime;
     load(key: T): Promise<Data | null>;
     clearAll(): void;

package/core/loaders/object_loader.js

@@ -29,6 +29,9 @@ const clause = __importStar(require("../clause"));
 const logger_1 = require("../logger");
 const loader_1 = require("./loader");
 const memoizee_1 = __importDefault(require("memoizee"));
+// optional clause...
+// so ObjectLoaderFactory and createDataLoader need to take a new optional field which is a clause that's always added here
+// and we need a disableTransform which skips loader completely and uses loadRow...
 function createDataLoader(options) {
     const loaderOptions = {};
     // if query logging is enabled, we should log what's happening with loader
@@ -40,9 +43,13 @@ function createDataLoader(options) {
             return [];
         }
         let col = options.key;
+        let cls = clause.In(col, ...ids);
+        if (options.clause) {
+            cls = clause.And(options.clause, cls);
+        }
         const rowOptions = {
             ...options,
-            clause: clause.In(col, ...ids),
+            clause: cls,
         };
         let m = new Map();
         let result = [];
@@ -77,6 +84,9 @@ class ObjectLoader {
         }
         this.memoizedInitPrime = (0, memoizee_1.default)(this.initPrime.bind(this));
     }
+    getOptions() {
+        return this.options;
+    }
     initPrime() {
         if (!this.context || !this.toPrime) {
             return;
@@ -107,9 +117,13 @@ class ObjectLoader {
             }
             return result;
         }
+        let cls = clause.Eq(this.options.key, key);
+        if (this.options.clause) {
+            cls = clause.And(this.options.clause, cls);
+        }
         const rowOptions = {
             ...this.options,
-            clause: clause.Eq(this.options.key, key),
+            clause: cls,
             context: this.context,
         };
         return await (0, ent_1.loadRow)(rowOptions);
@@ -121,9 +135,13 @@ class ObjectLoader {
         if (this.loader) {
             return await this.loader.loadMany(keys);
         }
+        let cls = clause.In(this.options.key, ...keys);
+        if (this.options.clause) {
+            cls = clause.And(this.options.clause, cls);
+        }
         const rowOptions = {
             ...this.options,
-            clause: clause.In(this.options.key, ...keys),
+            clause: cls,
             context: this.context,
         };
         return await (0, ent_1.loadRows)(rowOptions);
@@ -142,7 +160,7 @@ class ObjectLoaderFactory {
     constructor(options) {
         this.options = options;
         this.toPrime = [];
-        this.name = `${options.tableName}:${options.key}`;
+        this.name = `${options.tableName}:${options.key}:${options.clause?.instanceKey() || ""}`;
     }
     createLoader(context) {
         return (0, loader_1.getLoader)(this, () => {

package/graphql/graphql.d.ts

@@ -82,6 +82,9 @@ declare enum NullableResult {
     CONTENTS_AND_LIST = "contentsAndList",
     ITEM = "true"
 }
+export declare const knownAllowedNames: Map<string, string>;
+export declare const knownDisAllowedNames: Map<string, boolean>;
+export declare const isCustomType: (type: Type) => type is CustomType;
 export declare const addCustomType: (type: CustomType) => void;
 export declare class GQLCapture {
     private static enabled;
@@ -107,8 +110,6 @@ export declare class GQLCapture {
     static getProcessedCustomMutations(): ProcessedCustomField[];
     static getProcessedCustomQueries(): ProcessedCustomField[];
     private static getProcessedCustomFieldsImpl;
-    private static knownAllowedNames;
-    private static knownDisAllowedNames;
     private static getResultFromMetadata;
     static gqlField(options?: gqlFieldOptions): any;
     private static getCustomField;

package/graphql/graphql.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gqlFileUpload = exports.gqlConnection = exports.gqlContextType = exports.gqlMutation = exports.gqlQuery = exports.gqlObjectType = exports.gqlInputObjectType = exports.gqlArgType = exports.gqlArg = exports.gqlField = exports.GQLCapture = exports.addCustomType = exports.CustomFieldType = void 0;
+exports.gqlFileUpload = exports.gqlConnection = exports.gqlContextType = exports.gqlMutation = exports.gqlQuery = exports.gqlObjectType = exports.gqlInputObjectType = exports.gqlArgType = exports.gqlArg = exports.gqlField = exports.GQLCapture = exports.addCustomType = exports.isCustomType = exports.knownDisAllowedNames = exports.knownAllowedNames = exports.CustomFieldType = void 0;
 require("reflect-metadata");
 // export interface gqlTopLevelOptions
 //   name?: string;
@@ -20,6 +20,22 @@ var NullableResult;
     NullableResult["CONTENTS_AND_LIST"] = "contentsAndList";
     NullableResult["ITEM"] = "true";
 })(NullableResult || (NullableResult = {}));
+exports.knownAllowedNames = new Map([
+    ["Date", "Date"],
+    ["Boolean", "boolean"],
+    ["Number", "number"],
+    ["String", "string"],
+    // TODO not right to have this and Number
+    ["Int", "number"],
+    ["Float", "number"],
+    ["ID", "ID"],
+]);
+exports.knownDisAllowedNames = new Map([
+    ["Function", true],
+    ["Object", true],
+    ["Array", true],
+    ["Promise", true],
+]);
 const isArray = (type) => {
     if (typeof type === "function") {
         return false;
@@ -41,6 +57,7 @@ const isString = (type) => {
 const isCustomType = (type) => {
     return type.importPath !== undefined;
 };
+exports.isCustomType = isCustomType;
 const isGraphQLScalarType = (type) => {
     return type.serialize !== undefined;
 };
@@ -92,7 +109,7 @@ const getType = (typ, result) => {
         }
         return;
     }
-    if (isCustomType(typ)) {
+    if ((0, exports.isCustomType)(typ)) {
         result.type = typ.type;
         (0, exports.addCustomType)(typ);
         return;
@@ -197,20 +214,20 @@ class GQLCapture {
             connection = r.connection;
             type = r.type;
         }
-        if (GQLCapture.knownDisAllowedNames.has(type)) {
+        if (exports.knownDisAllowedNames.has(type)) {
             throw new Error(`${type} isn't a valid type for accessor/function/property`);
         }
         let result = {
             name: metadata.paramName || "",
             type,
-            tsType: this.knownAllowedNames.get(type) || this.customTypes.get(type)?.tsType,
+            tsType: exports.knownAllowedNames.get(type) || this.customTypes.get(type)?.tsType,
             nullable: options?.nullable,
             list: list,
             connection: connection,
             isContextArg: metadata.isContextArg,
         };
         // unknown type. we need to flag that this field needs to eventually be resolved
-        if (!GQLCapture.knownAllowedNames.has(type)) {
+        if (!exports.knownAllowedNames.has(type)) {
             if (scalarType) {
                 throw new Error(`custom scalar type ${type} is not supported this way. use CustomType syntax. see \`gqlFileUpload\` as an example`);
             }
@@ -461,22 +478,6 @@ GQLCapture.customArgs = new Map();
 GQLCapture.customInputObjects = new Map();
 GQLCapture.customObjects = new Map();
 GQLCapture.customTypes = new Map();
-GQLCapture.knownAllowedNames = new Map([
-    ["Date", "Date"],
-    ["Boolean", "boolean"],
-    ["Number", "number"],
-    ["String", "string"],
-    // TODO not right to have this and Number
-    ["Int", "number"],
-    ["Float", "number"],
-    ["ID", "ID"],
-]);
-GQLCapture.knownDisAllowedNames = new Map([
-    ["Function", true],
-    ["Object", true],
-    ["Array", true],
-    ["Promise", true],
-]);
 // User -> add -> [{name, options}, {}, {}]
 GQLCapture.argMap = new Map();
 // why is this a static class lol?

package/graphql/node_resolver.d.ts

@@ -5,7 +5,6 @@ interface Node {
     id: ID;
 }
 export interface NodeResolver {
-    encode(node: Node): string;
     decodeObj(viewer: Viewer, id: string): Promise<Node | null>;
 }
 interface loadEnt {

package/package.json

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

package/parse_schema/parse.d.ts

@@ -12,7 +12,13 @@ declare type ProcessedAssocEdge = Omit<AssocEdge, "actionOnlyFields" | "edgeActi
     patternName?: string;
     edgeActions?: OutputAction[];
 };
-declare type ProcessedSchema = Omit<Schema, "edges" | "actions" | "edgeGroups" | "fields"> & {
+interface TransformFlags {
+    transformsSelect?: boolean;
+    transformsDelete?: boolean;
+    transformsInsert?: boolean;
+    transformsUpdate?: boolean;
+}
+declare type ProcessedSchema = Omit<Schema, "edges" | "actions" | "edgeGroups" | "fields"> & TransformFlags & {
     actions: OutputAction[];
     assocEdges: ProcessedAssocEdge[];
     assocEdgeGroups: ProcessedAssocEdgeGroup[];

package/parse_schema/parse.js

@@ -78,6 +78,9 @@ function processEdgeGroups(processedSchema, edgeGroups) {
     }
 }
 function processPattern(patterns, pattern, processedSchema) {
+    let ret = {
+        ...pattern,
+    };
     const name = pattern.name;
     const fields = processFields(pattern.fields, pattern.name);
     processedSchema.fields.push(...fields);
@@ -85,6 +88,10 @@ function processPattern(patterns, pattern, processedSchema) {
         const edges = processEdges(pattern.edges, pattern.name);
         processedSchema.assocEdges.push(...edges);
     }
+    // flag transformsSelect
+    if (pattern.transformRead) {
+        ret.transformsSelect = true;
+    }
     if (patterns[name] === undefined) {
         // intentionally processing separately and not passing pattern.name
         const edges = processEdges(pattern.edges || []);
@@ -98,6 +105,7 @@ function processPattern(patterns, pattern, processedSchema) {
         // TODO ideally we want to make sure that different patterns don't have the same name
         // can't do a deepEqual check because function calls and therefore different instances in fields
     }
+    return ret;
 }
 var NullableResult;
 (function (NullableResult) {
@@ -160,7 +168,19 @@ function parseSchema(potentialSchemas) {
         // ¯\_(ツ)_/¯
         if (schema.patterns) {
             for (const pattern of schema.patterns) {
-                processPattern(patterns, pattern, processedSchema);
+                const ret = processPattern(patterns, pattern, processedSchema);
+                if (ret.transformsSelect) {
+                    if (processedSchema.transformsSelect) {
+                        throw new Error(`can only have one pattern which transforms default querying behavior`);
+                    }
+                    processedSchema.transformsSelect = true;
+                }
+                if (ret.transformsDelete) {
+                    if (processedSchema.transformsDelete) {
+                        throw new Error(`can only have one pattern which transforms default deletion behavior`);
+                    }
+                    processedSchema.transformsDelete = true;
+                }
             }
         }
         const fields = processFields(schema.fields);

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, } from "./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 { Timestamps, Node, BaseEntSchema, BaseEntSchemaWithTZ, } from "./base_schema";
 export * from "./field";
 export * from "./json_field";

package/schema/index.js

@@ -10,7 +10,7 @@ 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.optionalField = exports.requiredField = exports.ConstraintType = exports.NoFields = exports.ActionOperation = exports.getFields = exports.DBType = void 0;
+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;
 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; } });
@@ -19,6 +19,8 @@ Object.defineProperty(exports, "NoFields", { enumerable: true, get: function ()
 Object.defineProperty(exports, "ConstraintType", { enumerable: true, get: function () { return schema_1.ConstraintType; } });
 Object.defineProperty(exports, "requiredField", { enumerable: true, get: function () { return schema_1.requiredField; } });
 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; } });
 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,5 +1,6 @@
-import { Data, Ent, LoaderInfo } from "../core/base";
+import { Data, Ent, LoaderInfo, Viewer } from "../core/base";
 import { Builder } from "../action/action";
+import { Clause } from "../core/clause";
 export default interface Schema {
     fields: Field[];
     tableName?: string;
@@ -59,6 +60,27 @@ export interface Pattern {
     name: string;
     fields: Field[];
     edges?: Edge[];
+    transformRead?: () => Clause;
+    transformWrite?: <T extends Ent>(stmt: UpdateOperation<T>) => TransformedUpdateOperation<T> | undefined;
+    transformsDelete?: boolean;
+    transformsInsert?: boolean;
+    transformsUpdate?: boolean;
+}
+export declare enum SQLStatementOperation {
+    Insert = "insert",
+    Update = "update",
+    Delete = "delete"
+}
+export interface UpdateOperation<T extends Ent> {
+    op: SQLStatementOperation;
+    existingEnt?: T;
+    viewer: Viewer;
+    data?: Map<string, any>;
+}
+export interface TransformedUpdateOperation<T extends Ent> {
+    op: SQLStatementOperation;
+    data?: Data;
+    existingEnt?: T;
 }
 export declare enum DBType {
     UUID = "UUID",
@@ -155,7 +177,10 @@ export interface SchemaConstructor {
     new (): Schema;
 }
 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 getTransformedReadClause(value: SchemaInputType): Clause | undefined;
+export declare function getTransformedUpdateOp<T extends Ent>(value: SchemaInputType, stmt: UpdateOperation<T>): TransformedUpdateOperation<T> | undefined;
 export declare enum ActionOperation {
     Create = 1,
     Edit = 2,

package/schema/schema.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConstraintType = exports.optionalField = exports.requiredField = exports.NoFields = exports.ActionOperation = exports.getFields = exports.DBType = void 0;
+exports.ConstraintType = exports.optionalField = exports.requiredField = exports.NoFields = exports.ActionOperation = exports.getTransformedUpdateOp = exports.getTransformedReadClause = exports.getFields = exports.getSchema = exports.DBType = exports.SQLStatementOperation = void 0;
+// 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;
+(function (SQLStatementOperation) {
+    // transform insert e.g. to an update based on whatever logic
+    SQLStatementOperation["Insert"] = "insert";
+    // // transform select e.g. deleted_at. can't change from select to different query type
+    // // but can change the query
+    // Select = "select",
+    // e.g. change updated value
+    SQLStatementOperation["Update"] = "update";
+    // delete -> update theoretically e.g. deleted_at
+    SQLStatementOperation["Delete"] = "delete";
+})(SQLStatementOperation = exports.SQLStatementOperation || (exports.SQLStatementOperation = {}));
 // we want --strictNullChecks flag so nullable is used to type graphql, ts, db
 // should eventually generate (boolean | null) etc
 // supported db types
@@ -28,14 +42,17 @@ var DBType;
 function isSchema(value) {
     return value.fields !== undefined;
 }
-function getFields(value) {
-    let schema;
+function getSchema(value) {
     if (isSchema(value)) {
-        schema = value;
+        return value;
     }
     else {
-        schema = new value();
+        return new value();
     }
+}
+exports.getSchema = getSchema;
+function getFields(value) {
+    const schema = getSchema(value);
     function addFields(fields) {
         for (const field of fields) {
             const derivedFields = field.derivedFields;
@@ -55,6 +72,33 @@ function getFields(value) {
     return m;
 }
 exports.getFields = getFields;
+function getTransformedReadClause(value) {
+    const schema = getSchema(value);
+    if (!schema.patterns) {
+        return;
+    }
+    for (const p of schema.patterns) {
+        // e.g. discarded_at, deleted_at, etc
+        if (p.transformRead) {
+            // return clause.Eq('deleted_at', null);
+            return p.transformRead();
+        }
+    }
+    return;
+}
+exports.getTransformedReadClause = getTransformedReadClause;
+function getTransformedUpdateOp(value, stmt) {
+    const schema = getSchema(value);
+    if (!schema.patterns) {
+        return;
+    }
+    for (const p of schema.patterns) {
+        if (p.transformWrite) {
+            return p.transformWrite(stmt);
+        }
+    }
+}
+exports.getTransformedUpdateOp = getTransformedUpdateOp;
 // this maps to ActionOperation in ent/action.go
 var ActionOperation;
 (function (ActionOperation) {

package/scripts/custom_graphql.js

@@ -24,6 +24,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const glob_1 = __importDefault(require("glob"));
+const json5_1 = __importDefault(require("json5"));
 const minimist_1 = __importDefault(require("minimist"));
 const graphql_1 = require("../graphql/graphql");
 const readline = __importStar(require("readline"));
@@ -53,7 +54,103 @@ async function readInputs() {
         });
     });
 }
-async function captureCustom(filePath, filesCsv) {
+function processCustomObjects(l, gqlCapture, input) {
+    let m;
+    if (input) {
+        m = gqlCapture.getCustomInputObjects();
+    }
+    else {
+        m = gqlCapture.getCustomObjects();
+    }
+    for (const input of l) {
+        m.set(input.name, {
+            nodeName: input.graphQLName || input.name,
+            className: input.name,
+        });
+        if (input.fields) {
+            processCustomFields(input.fields, gqlCapture, input.name);
+        }
+    }
+}
+function transformArgs(f) {
+    return (f.args || []).map((v) => {
+        const ret = {
+            ...v,
+        };
+        // duplicated from getType in graphql.ts
+        if ((0, graphql_1.isCustomType)(ret.type)) {
+            ret.type = v.type.type;
+            (0, graphql_1.addCustomType)(v.type);
+        }
+        // scalar types not supported for now
+        ret.tsType = graphql_1.knownAllowedNames.get(v.type);
+        return ret;
+    });
+}
+function transformResultType(f) {
+    return f.resultType
+        ? [
+            {
+                name: "",
+                type: f.resultType,
+                tsType: graphql_1.knownAllowedNames.get(f.resultType),
+                list: f.list,
+                nullable: f.nullable,
+            },
+        ]
+        : [];
+}
+function processTopLevel(l, l2) {
+    for (const custom of l) {
+        l2.push({
+            nodeName: custom.class,
+            functionName: custom.functionName || custom.name,
+            gqlName: custom.graphQLName || custom.name,
+            fieldType: custom.fieldType,
+            args: transformArgs(custom),
+            results: transformResultType(custom),
+        });
+    }
+}
+function processCustomFields(fields, gqlCapture, nodeName) {
+    const m = gqlCapture.getCustomFields();
+    let results = [];
+    for (const f of fields) {
+        results.push({
+            nodeName: nodeName,
+            gqlName: f.graphQLName || f.name,
+            functionName: f.functionName || f.name,
+            fieldType: f.fieldType,
+            args: transformArgs(f),
+            results: transformResultType(f),
+        });
+    }
+    m.set(nodeName, results);
+}
+async function captureCustom(filePath, filesCsv, jsonPath, gqlCapture) {
+    if (jsonPath !== undefined) {
+        let json = json5_1.default.parse(fs.readFileSync(jsonPath, {
+            encoding: "utf8",
+        }));
+        if (json.fields) {
+            for (const k in json.fields) {
+                processCustomFields(json.fields[k], gqlCapture, k);
+            }
+        }
+        if (json.inputs) {
+            processCustomObjects(json.inputs, gqlCapture, true);
+        }
+        if (json.objects) {
+            processCustomObjects(json.objects, gqlCapture);
+        }
+        if (json.queries) {
+            processTopLevel(json.queries, gqlCapture.getCustomQueries());
+        }
+        if (json.mutations) {
+            processTopLevel(json.mutations, gqlCapture.getCustomMutations());
+        }
+        return;
+    }
     if (filesCsv !== undefined) {
         let files = filesCsv.split(",");
         for (let i = 0; i < files.length; i++) {
@@ -153,15 +250,25 @@ async function main() {
     if (!gqlPath) {
         throw new Error("could not find graphql path");
     }
-    const r = require(gqlPath);
-    if (!r.GQLCapture) {
-        throw new Error("could not find GQLCapture in module");
+    // use different variable  so that we use the correct GQLCapture as needed
+    // for local dev, get the one from the file system. otherwise, get the one
+    // from node_modules
+    let gqlCapture;
+    if (process.env.LOCAL_SCRIPT_PATH) {
+        const r = require("../graphql/graphql");
+        gqlCapture = r.GQLCapture;
+    }
+    else {
+        const r = require(gqlPath);
+        if (!r.GQLCapture) {
+            throw new Error("could not find GQLCapture in module");
+        }
+        gqlCapture = r.GQLCapture;
+        gqlCapture.enable(true);
     }
-    const GQLCapture = r.GQLCapture;
-    GQLCapture.enable(true);
     const [inputsRead, _, imports] = await Promise.all([
         readInputs(),
-        captureCustom(options.path, options.files),
+        captureCustom(options.path, options.files, options.json_path, gqlCapture),
         parseImports(options.path),
     ]);
     const { nodes, nodesMap } = inputsRead;
@@ -172,14 +279,14 @@ async function main() {
         }
         return result;
     }
-    GQLCapture.resolve(nodes);
-    let args = fromMap(GQLCapture.getCustomArgs());
-    let inputs = fromMap(GQLCapture.getCustomInputObjects());
-    let fields = GQLCapture.getProcessedCustomFields();
-    let queries = GQLCapture.getProcessedCustomQueries();
-    let mutations = GQLCapture.getProcessedCustomMutations();
-    let objects = fromMap(GQLCapture.getCustomObjects());
-    let customTypes = fromMap(GQLCapture.getCustomTypes());
+    gqlCapture.resolve(nodes);
+    let args = fromMap(gqlCapture.getCustomArgs());
+    let inputs = fromMap(gqlCapture.getCustomInputObjects());
+    let fields = gqlCapture.getProcessedCustomFields();
+    let queries = gqlCapture.getProcessedCustomQueries();
+    let mutations = gqlCapture.getProcessedCustomMutations();
+    let objects = fromMap(gqlCapture.getCustomObjects());
+    let customTypes = fromMap(gqlCapture.getCustomTypes());
     let classes = {};
     let allFiles = {};
     const buildClasses2 = (args) => {

package/testutils/builder.js

@@ -149,6 +149,11 @@ class SimpleBuilder {
             editedFields: () => {
                 return this.fields;
             },
+            updateInput: (input) => {
+                for (const k in input) {
+                    this.fields.set(k, input[k]);
+                }
+            },
         });
     }
     build() {