@snowtop/ent 0.1.0-alpha10 → 0.1.0-alpha101

package/action/orchestrator.js

@@ -1,13 +1,40 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 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 camel_case_1 = require("camel-case");
 const privacy_1 = require("../core/privacy");
 const executor_1 = require("./executor");
 const logger_1 = require("../core/logger");
+const memoizee_1 = __importDefault(require("memoizee"));
+const clause = __importStar(require("../core/clause"));
 var edgeDirection;
 (function (edgeDirection) {
     edgeDirection[edgeDirection["inboundEdge"] = 0] = "inboundEdge";
@@ -63,6 +90,11 @@ class Orchestrator {
         this.viewer = options.viewer;
         this.actualOperation = this.options.operation;
         this.existingEnt = this.options.builder.existingEnt;
+        this.memoizedGetFields = (0, memoizee_1.default)(this.getFieldsInfo.bind(this));
+    }
+    // don't type this because we don't care
+    __getOptions() {
+        return this.options;
     }
     addEdge(edge, op) {
         this.edgeSet.add(edge.edgeType);
@@ -148,6 +180,10 @@ class Orchestrator {
                 if (this.actualOperation === action_1.WriteOperation.Edit && !this.existingEnt) {
                     throw new Error(`existing ent required with operation ${this.actualOperation}`);
                 }
+                if (this.options.expressions &&
+                    this.actualOperation !== action_1.WriteOperation.Edit) {
+                    throw new Error(`expressions are only supported in edit operations for now`);
+                }
                 const opts = {
                     fields: this.validatedFields,
                     tableName: this.options.tableName,
@@ -155,6 +191,8 @@ class Orchestrator {
                     key: this.options.key,
                     loadEntOptions: this.options.loaderOptions,
                     placeholderID: this.options.builder.placeholderID,
+                    whereClause: clause.Eq(this.options.key, this.existingEnt?.id),
+                    expressions: this.options.expressions,
                 };
                 if (this.logValues) {
                     opts.fieldsToLog = this.logValues;
@@ -208,7 +246,7 @@ class Orchestrator {
                     ops.push(edgeOp);
                     const edgeData = edgeDatas.get(edgeType);
                     if (!edgeData) {
-                        throw new Error(`could not load edge data for ${edgeType}`);
+                        throw new Error(`could not load edge data for '${edgeType}'`);
                     }
                     if (edgeData.symmetricEdge) {
                         ops.push(edgeOp.symmetricEdge());
@@ -269,9 +307,28 @@ class Orchestrator {
         if (this.actualOperation !== action_1.WriteOperation.Insert) {
             return this.existingEnt;
         }
-        const { editedData } = await this.getFieldsInfo();
+        const { editedData } = await this.memoizedGetFields();
         return this.getEntForPrivacyPolicyImpl(editedData);
     }
+    // this gets the fields that were explicitly set plus any default or transformed values
+    // mainly exists to get default fields e.g. default id to be used in triggers
+    // NOTE: this API may change in the future
+    // doesn't work to get ids for autoincrement keys
+    async getEditedData() {
+        const { editedData } = await this.memoizedGetFields();
+        return editedData;
+    }
+    /**
+     * @returns validated and formatted fields that would be written to the db
+     * throws an error if called before valid() or validX() has been called
+     */
+    getValidatedFields() {
+        if (this.validatedFields === null) {
+            throw new Error(`trying to call getValidatedFields before validating fields`);
+        }
+        return this.validatedFields;
+    }
+    // Note: this is memoized. call memoizedGetFields instead
     async getFieldsInfo() {
         const action = this.options.action;
         const builder = this.options.builder;
@@ -290,7 +347,7 @@ class Orchestrator {
                     throw new Error(`existing ent required with operation ${this.actualOperation}`);
                 }
         }
-        const { schemaFields, editedData } = await this.getFieldsInfo();
+        const { schemaFields, editedData } = await this.memoizedGetFields();
         const action = this.options.action;
         const builder = this.options.builder;
         // this runs in following phases:
@@ -299,55 +356,104 @@ class Orchestrator {
         // * triggers
         // * validators
         let privacyPolicy = action?.getPrivacyPolicy();
+        let privacyError = null;
         if (privacyPolicy) {
-            await (0, privacy_1.applyPrivacyPolicyX)(this.options.viewer, privacyPolicy, this.getEntForPrivacyPolicyImpl(editedData), this.throwError.bind(this));
+            try {
+                await (0, privacy_1.applyPrivacyPolicyX)(this.options.viewer, privacyPolicy, this.getEntForPrivacyPolicyImpl(editedData), this.throwError.bind(this));
+            }
+            catch (err) {
+                privacyError = err;
+            }
+        }
+        // privacyError should return first since it's less confusing
+        if (privacyError !== null) {
+            return [privacyError];
         }
         // have to run triggers which update fields first before field and other validators
         // so running this first to build things up
-        let triggers = action?.triggers;
-        if (triggers) {
-            await this.triggers(action, builder, triggers);
+        if (action?.getTriggers) {
+            await this.triggers(action, builder, action.getTriggers());
+        }
+        let validators = [];
+        if (action?.getValidators) {
+            validators = action.getValidators();
         }
-        let validators = action?.validators || [];
         // not ideal we're calling this twice. fix...
         // needed for now. may need to rewrite some of this?
         const editedFields2 = await this.options.editedFields();
-        await Promise.all([
+        const [errors, errs2] = await Promise.all([
             this.formatAndValidateFields(schemaFields, editedFields2),
             this.validators(validators, action, builder),
         ]);
+        errors.push(...errs2);
+        return errors;
     }
     async triggers(action, builder, triggers) {
-        await Promise.all(triggers.map(async (trigger) => {
-            let ret = await trigger.changeset(builder, action.getInput());
-            if (Array.isArray(ret)) {
-                ret = await Promise.all(ret);
-            }
-            if (Array.isArray(ret)) {
-                for (const v of ret) {
-                    if (typeof v === "object") {
-                        this.changesets.push(v);
-                    }
+        let groups = [];
+        let lastArray = 0;
+        let prevWasArray = false;
+        for (let i = 0; i < triggers.length; i++) {
+            let t = triggers[i];
+            if (Array.isArray(t)) {
+                if (!prevWasArray) {
+                    // @ts-ignore
+                    groups.push(triggers.slice(lastArray, i));
                 }
+                groups.push(t);
+                prevWasArray = true;
+                lastArray++;
             }
-            else if (ret) {
-                this.changesets.push(ret);
+            else {
+                if (i === triggers.length - 1) {
+                    // @ts-ignore
+                    groups.push(triggers.slice(lastArray, i + 1));
+                }
+                prevWasArray = false;
             }
-        }));
+        }
+        for (const triggers of groups) {
+            await Promise.all(triggers.map(async (trigger) => {
+                let ret = await trigger.changeset(builder, action.getInput());
+                if (Array.isArray(ret)) {
+                    ret = await Promise.all(ret);
+                }
+                if (Array.isArray(ret)) {
+                    for (const v of ret) {
+                        if (typeof v === "object") {
+                            this.changesets.push(v);
+                        }
+                    }
+                }
+                else if (ret) {
+                    this.changesets.push(ret);
+                }
+            }));
+        }
     }
     async validators(validators, action, builder) {
-        let promises = [];
-        validators.forEach((validator) => {
-            let res = validator.validate(builder, action.getInput());
-            if (res) {
-                promises.push(res);
+        const errors = [];
+        await Promise.all(validators.map(async (v) => {
+            try {
+                const r = await v.validate(builder, action.getInput());
+                if (r instanceof Error) {
+                    errors.push(r);
+                }
             }
-        });
-        await Promise.all(promises);
+            catch (err) {
+                errors.push(err);
+            }
+        }));
+        return errors;
     }
     isBuilder(val) {
         return val.placeholderID !== undefined;
     }
+    getInputKey(k) {
+        return this.options.fieldInfo[k].inputKey;
+    }
+    getStorageKey(k) {
+        return this.options.fieldInfo[k].dbCol;
+    }
     async getFieldsWithDefaultValues(builder, schemaFields, editedFields, action) {
         let data = {};
         let defaultData = {};
@@ -357,24 +463,30 @@ class Orchestrator {
         // 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;
+        let transformed = null;
+        const sqlOp = this.getSQLStatementOperation();
         if (action?.transformWrite) {
             transformed = await action.transformWrite({
-                viewer: builder.viewer,
-                op: this.getSQLStatementOperation(),
+                builder,
+                input,
+                op: sqlOp,
                 data: editedFields,
-                existingEnt: this.existingEnt,
             });
         }
         else if (!this.disableTransformations) {
             transformed = (0, schema_1.getTransformedUpdateOp)(this.options.schema, {
-                viewer: builder.viewer,
-                op: this.getSQLStatementOperation(),
+                builder,
+                input,
+                op: sqlOp,
                 data: editedFields,
-                existingEnt: this.existingEnt,
             });
         }
         if (transformed) {
+            if (sqlOp === schema_1.SQLStatementOperation.Insert && sqlOp !== transformed.op) {
+                if (!transformed.existingEnt) {
+                    throw new Error(`cannot transform an insert operation without providing an existing ent`);
+                }
+            }
             if (transformed.data) {
                 updateInput = true;
                 for (const k in transformed.data) {
@@ -386,17 +498,23 @@ class Orchestrator {
                     if (field.format) {
                         val = field.format(transformed.data[k]);
                     }
-                    let dbKey = (0, schema_1.getStorageKey)(field, k);
-                    data[dbKey] = val;
-                    this.defaultFieldsByTSName[(0, camel_case_1.camelCase)(k)] = val;
+                    data[this.getStorageKey(k)] = val;
+                    this.defaultFieldsByTSName[this.getInputKey(k)] = val;
                     // hmm do we need this?
                     // TODO how to do this for local tests?
                     // this.defaultFieldsByFieldName[k] = val;
                 }
             }
+            if (transformed.changeset) {
+                const ct = await transformed.changeset();
+                this.changesets.push(ct);
+            }
             this.actualOperation = this.getWriteOpForSQLStamentOp(transformed.op);
             if (transformed.existingEnt) {
+                // @ts-ignore
                 this.existingEnt = transformed.existingEnt;
+                // modify existing ent in builder. it's readonly in generated ents but doesn't apply here
+                builder.existingEnt = transformed.existingEnt;
             }
         }
         // transforming before doing default fields so that we don't create a new id
@@ -404,7 +522,7 @@ class Orchestrator {
         for (const [fieldName, field] of schemaFields) {
             let value = editedFields.get(fieldName);
             let defaultValue = undefined;
-            let dbKey = (0, schema_1.getStorageKey)(field, fieldName);
+            let dbKey = this.getStorageKey(fieldName);
             if (value === undefined) {
                 if (this.actualOperation === action_1.WriteOperation.Insert) {
                     if (field.defaultToViewerOnCreate && field.defaultValueOnCreate) {
@@ -432,8 +550,7 @@ class Orchestrator {
                 updateInput = true;
                 defaultData[dbKey] = defaultValue;
                 this.defaultFieldsByFieldName[fieldName] = defaultValue;
-                // TODO related to #510. we need this logic to be consistent so do this all in TypeScript or get it from go somehow
-                this.defaultFieldsByTSName[(0, camel_case_1.camelCase)(fieldName)] = defaultValue;
+                this.defaultFieldsByTSName[this.getInputKey(fieldName)] = defaultValue;
             }
         }
         // if there's data changing, add data
@@ -459,7 +576,7 @@ class Orchestrator {
         // now format and validate...
         if (value === null) {
             if (!field.nullable) {
-                throw new Error(`field ${fieldName} set to null for non-nullable field`);
+                return new Error(`field ${fieldName} set to null for non-nullable field`);
             }
         }
         else if (value === undefined) {
@@ -470,14 +587,14 @@ class Orchestrator {
                 // server default allowed
                 field.serverDefault === undefined &&
                 this.actualOperation === action_1.WriteOperation.Insert) {
-                throw new Error(`required field ${fieldName} not set`);
+                return new Error(`required field ${fieldName} not set`);
             }
         }
         else if (this.isBuilder(value)) {
             if (field.valid) {
                 const valid = await field.valid(value);
                 if (!valid) {
-                    throw new Error(`invalid field ${fieldName} with value ${value}`);
+                    return new Error(`invalid field ${fieldName} with value ${value}`);
                 }
             }
             // keep track of dependencies to resolve
@@ -490,66 +607,110 @@ class Orchestrator {
                 // TODO this could be async. handle this better
                 const valid = await field.valid(value);
                 if (!valid) {
-                    throw new Error(`invalid field ${fieldName} with value ${value}`);
+                    return new Error(`invalid field ${fieldName} with value ${value}`);
                 }
             }
             if (field.format) {
-                // TODO this could be async e.g. password. handle this better
-                value = await Promise.resolve(field.format(value));
+                value = await field.format(value);
             }
         }
         return value;
     }
     async formatAndValidateFields(schemaFields, editedFields) {
+        const errors = [];
         const op = this.actualOperation;
         if (op === action_1.WriteOperation.Delete) {
-            return;
+            return [];
         }
         // build up data to be saved...
         let data = {};
         let logValues = {};
+        let needsFullDataChecks = [];
         for (const [fieldName, field] of schemaFields) {
             let value = editedFields.get(fieldName);
+            if (field.validateWithFullData) {
+                needsFullDataChecks.push(fieldName);
+            }
             if (value === undefined && op === action_1.WriteOperation.Insert) {
                 // null allowed
                 value = this.defaultFieldsByFieldName[fieldName];
             }
-            let dbKey = (0, schema_1.getStorageKey)(field, fieldName);
-            value = await this.transformFieldValue(fieldName, field, dbKey, value);
+            let dbKey = this.getStorageKey(fieldName);
+            let ret = await this.transformFieldValue(fieldName, field, dbKey, value);
+            if (ret instanceof Error) {
+                errors.push(ret);
+            }
+            else {
+                value = ret;
+            }
             if (value !== undefined) {
                 data[dbKey] = value;
                 logValues[dbKey] = field.logValue(value);
             }
         }
+        for (const fieldName of needsFullDataChecks) {
+            const field = schemaFields.get(fieldName);
+            let value = editedFields.get(fieldName);
+            // @ts-ignore...
+            // type hackery because it's hard
+            const v = await field.validateWithFullData(value, this.options.builder);
+            if (!v) {
+                if (value === undefined) {
+                    errors.push(new Error(`field ${fieldName} set to undefined when it can't be nullable`));
+                }
+                else {
+                    errors.push(new Error(`field ${fieldName} set to null when it can't be nullable`));
+                }
+            }
+        }
         //  we ignored default values while editing.
         // if we're editing and there's data, add default values
         if (op === action_1.WriteOperation.Edit && this.hasData(data)) {
             for (const fieldName in this.defaultFieldsByFieldName) {
                 const defaultValue = this.defaultFieldsByFieldName[fieldName];
                 let field = schemaFields.get(fieldName);
-                let dbKey = (0, schema_1.getStorageKey)(field, fieldName);
+                let dbKey = this.getStorageKey(fieldName);
                 // no value, let's just default
                 if (data[dbKey] === undefined) {
-                    const value = await this.transformFieldValue(fieldName, field, dbKey, defaultValue);
-                    data[dbKey] = value;
-                    logValues[dbKey] = field.logValue(value);
+                    const ret = await this.transformFieldValue(fieldName, field, dbKey, defaultValue);
+                    if (ret instanceof Error) {
+                        errors.push(ret);
+                    }
+                    else {
+                        data[dbKey] = ret;
+                        logValues[dbKey] = field.logValue(ret);
+                    }
                 }
             }
         }
         this.validatedFields = data;
         this.logValues = logValues;
+        return errors;
     }
     async valid() {
-        try {
-            await this.validate();
-        }
-        catch (e) {
-            (0, logger_1.log)("error", e);
+        const errors = await this.validate();
+        if (errors.length) {
+            errors.map((err) => (0, logger_1.log)("error", err));
             return false;
         }
         return true;
     }
     async validX() {
+        const errors = await this.validate();
+        if (errors.length) {
+            // just throw the first one...
+            // TODO we should ideally throw all of them
+            throw errors[0];
+        }
+    }
+    /**
+     * @experimental API that's not guaranteed to remain in the future which returns
+     * a list of errors encountered
+     * 0 errors indicates valid
+     * NOTE that this currently doesn't catch errors returned by validators().
+     * If those throws, this still throws and doesn't return them
+     */
+    async validWithErrors() {
         return this.validate();
     }
     async build() {
@@ -557,6 +718,7 @@ class Orchestrator {
         await this.validX();
         let ops = [this.buildMainOp()];
         await this.buildEdgeOps(ops);
+        // TODO throw if we try and create a new changeset after previously creating one
         return new EntChangeset(this.options.viewer, this.options.builder.placeholderID, this.options.loaderOptions.ent, ops, this.dependencies, this.changesets, this.options);
     }
     async viewerForEntLoad(data) {
@@ -564,7 +726,7 @@ class Orchestrator {
         if (!action || !action.viewerForEntLoad) {
             return this.options.viewer;
         }
-        return action.viewerForEntLoad(data);
+        return action.viewerForEntLoad(data, action.builder.viewer.context);
     }
     async returnedRow() {
         if (this.mainOp && this.mainOp.returnedRow) {
@@ -599,6 +761,9 @@ class Orchestrator {
     }
 }
 exports.Orchestrator = Orchestrator;
+function randomNum() {
+    return Math.random().toString(10).substring(2);
+}
 class EntChangeset {
     constructor(viewer, placeholderID, ent, operations, dependencies, changesets, options) {
         this.viewer = viewer;
@@ -609,6 +774,9 @@ class EntChangeset {
         this.changesets = changesets;
         this.options = options;
     }
+    static changesetFrom(builder, ops) {
+        return new EntChangeset(builder.viewer, `$ent.idPlaceholderID$ ${randomNum()}-${builder.ent.name}`, builder.ent, ops);
+    }
     executor() {
         if (this._executor) {
             return this._executor;

package/action/privacy.d.ts

@@ -2,11 +2,11 @@ import { Builder } from "./action";
 import { Viewer, ID, Ent, PrivacyResult, PrivacyPolicyRule } from "../core/base";
 export declare class DenyIfBuilder implements PrivacyPolicyRule {
     private id?;
-    constructor(id?: ID | Builder<Ent> | undefined);
+    constructor(id?: ID | Builder<Ent<Viewer<Ent<any> | null, ID | null>>, any, Ent<Viewer<Ent<any> | null, ID | null>> | null> | undefined);
     apply(_v: Viewer, _ent: Ent): Promise<PrivacyResult>;
 }
 export declare class AllowIfBuilder implements PrivacyPolicyRule {
     private id?;
-    constructor(id?: ID | Builder<Ent> | undefined);
+    constructor(id?: ID | Builder<Ent<Viewer<Ent<any> | null, ID | null>>, any, Ent<Viewer<Ent<any> | null, ID | null>> | null> | undefined);
     apply(_v: Viewer, _ent: Ent): Promise<PrivacyResult>;
 }

package/action/relative_value.d.ts

@@ -0,0 +1,47 @@
+import { Clause } from "../core/clause";
+export interface RelativeFieldValue<T = BigInt | number> {
+    delta: T;
+    sqlExpression: (col: string) => Clause;
+    eval: (curr: T) => T;
+}
+export interface RelativeNumberValue<T> {
+    add?: T;
+    subtract?: T;
+    divide?: T;
+    multiply?: T;
+    modulo?: T;
+}
+declare function addNumber(delta: number): RelativeFieldValue<number>;
+declare function addNumber(delta: BigInt): RelativeFieldValue<BigInt>;
+declare function subtractNumber(delta: number): RelativeFieldValue<number>;
+declare function subtractNumber(delta: BigInt): RelativeFieldValue<BigInt>;
+declare function multiplyNumber(delta: number): RelativeFieldValue<number>;
+declare function multiplyNumber(delta: BigInt): RelativeFieldValue<BigInt>;
+declare function divideNumber(delta: number): RelativeFieldValue<number>;
+declare function divideNumber(delta: BigInt): RelativeFieldValue<BigInt>;
+declare function moduloNumber(delta: number): RelativeFieldValue<number>;
+declare function moduloNumber(delta: BigInt): RelativeFieldValue<BigInt>;
+export declare const NumberOps: {
+    addNumber: typeof addNumber;
+    moduloNumber: typeof moduloNumber;
+    divideNumber: typeof divideNumber;
+    subtractNumber: typeof subtractNumber;
+    multiplyNumber: typeof multiplyNumber;
+};
+export declare function convertRelativeInput(rel: RelativeNumberValue<BigInt>, col: string, existing: BigInt): {
+    value: BigInt;
+    clause: Clause;
+};
+export declare function convertRelativeInput(rel: RelativeNumberValue<number>, col: string, existing: number): {
+    value: number;
+    clause: Clause;
+};
+export declare function maybeConvertRelativeInputPlusExpressions(rel: number | RelativeNumberValue<number>, col: string, existing: number, expressions: Map<string, Clause>): number;
+export declare function maybeConvertRelativeInputPlusExpressions(rel: number | RelativeNumberValue<number> | undefined, col: string, existing: number, expressions: Map<string, Clause>): number | undefined;
+export declare function maybeConvertRelativeInputPlusExpressions(rel: number | RelativeNumberValue<number> | null, col: string, existing: number | null, expressions: Map<string, Clause>): number | null;
+export declare function maybeConvertRelativeInputPlusExpressions(rel: number | RelativeNumberValue<number> | null | undefined, col: string, existing: number | null, expressions: Map<string, Clause>): number | undefined | null;
+export declare function maybeConvertRelativeInputPlusExpressions(rel: BigInt | RelativeNumberValue<BigInt>, col: string, existing: BigInt, expressions: Map<string, Clause>): BigInt;
+export declare function maybeConvertRelativeInputPlusExpressions(rel: BigInt | RelativeNumberValue<BigInt> | undefined, col: string, existing: BigInt, expressions: Map<string, Clause>): BigInt | undefined;
+export declare function maybeConvertRelativeInputPlusExpressions(rel: BigInt | RelativeNumberValue<BigInt> | null, col: string, existing: BigInt | null, expressions: Map<string, Clause>): BigInt | null;
+export declare function maybeConvertRelativeInputPlusExpressions(rel: BigInt | RelativeNumberValue<BigInt> | null | undefined, col: string, existing: BigInt | null, expressions: Map<string, Clause>): BigInt | null | undefined;
+export {};