@snowtop/ent 0.2.4 → 0.2.5

package/action/experimental_action.d.ts

@@ -1,10 +1,11 @@
 import { Orchestrator } from "./orchestrator";
-import { Viewer, Ent, Data } from "../core/base";
+import { Viewer, Ent, Data, Context } from "../core/base";
 import { Action, WriteOperation, Builder, Trigger, Observer, Changeset, Validator } from "./action";
 export interface ActionOptions<TEnt extends Ent<TViewer>, TViewer extends Viewer, TData extends Data, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
     existingEnt: TExistingEnt;
     input?: TData;
     operation?: WriteOperation;
+    viewerForEntLoad?(data: Data, ctx?: Context<TViewer>): TViewer | Promise<TViewer>;
 }
 type MaybeNull<T extends Ent> = T | null;
 type TMaybleNullableEnt<T extends Ent> = T | MaybeNull<T>;
@@ -23,10 +24,12 @@ export declare class BaseAction<TEnt extends Ent<TViewer>, TViewer extends Viewe
     builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TExistingEnt>;
     builder: EntBuilder<TEnt, TViewer, TInput, TExistingEnt>;
     private input;
+    options: ActionOptions<TEnt, TViewer, TInput, TExistingEnt>;
     getPrivacyPolicy(): import("../core/base").PrivacyPolicy<Ent<Viewer<Ent<any> | null, import("../core/base").ID | null>>, Viewer<Ent<any> | null, import("../core/base").ID | null>>;
     getTriggers(): Trigger<TEnt, EntBuilder<TEnt, TViewer, TInput, TExistingEnt>, TViewer, TInput, TExistingEnt>[];
     getObservers(): Observer<TEnt, EntBuilder<TEnt, TViewer, TInput, TExistingEnt>, TViewer, TInput, TExistingEnt>[];
     getValidators(): Validator<TEnt, EntBuilder<TEnt, TViewer, TInput, TExistingEnt>, TViewer, TInput, TExistingEnt>[];
+    viewerForEntLoad(data: Data, context?: Context<TViewer> | undefined): TViewer | Promise<TViewer>;
     constructor(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TExistingEnt>, options: ActionOptions<TEnt, TViewer, TInput, TExistingEnt>);
     static createBuilder<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>>(viewer: Viewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TExistingEnt>, options: ActionOptions<TEnt, TViewer, TInput, TExistingEnt>): Builder<TEnt>;
     /**
@@ -44,7 +47,7 @@ export interface BuilderConstructor<TEnt extends Ent<TViewer>, TViewer extends V
     new (viewer: TViewer, operation: WriteOperation, action: Action<TEnt, any, TViewer, TInput, TExistingEnt>, existingEnt: TExistingEnt): EntBuilder<TEnt, TViewer, TInput, TExistingEnt>;
 }
 export declare function updateRawObject<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TEnt>, existingEnt: TEnt, input: TInput): Promise<TEnt>;
-export declare function getSimpleEditAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TEnt>, existingEnt: TEnt, input: TInput): BaseAction<TEnt, TViewer, TInput, TEnt>;
-export declare function getSimpleDeleteAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TEnt>, existingEnt: TEnt, input: TInput): BaseAction<TEnt, TViewer, TInput, TEnt>;
-export declare function getSimpleInsertAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, null>, input: TInput): BaseAction<TEnt, TViewer, TInput, null>;
+export declare function getSimpleEditAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TEnt>, existingEnt: TEnt, input: TInput, opts?: Omit<ActionOptions<TEnt, TViewer, TInput, TEnt>, "operation" | "input" | "existingEnt">): BaseAction<TEnt, TViewer, TInput, TEnt>;
+export declare function getSimpleDeleteAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, TEnt>, existingEnt: TEnt, input: TInput, opts?: Omit<ActionOptions<TEnt, TViewer, TInput, null>, "operation" | "input" | "existingEnt">): BaseAction<TEnt, TViewer, TInput, TEnt>;
+export declare function getSimpleInsertAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput, null>, input: TInput, opts?: Omit<ActionOptions<TEnt, TViewer, TInput, null>, "operation" | "input" | "existingEnt">): BaseAction<TEnt, TViewer, TInput, null>;
 export {};

package/action/experimental_action.js

@@ -16,6 +16,12 @@ class BaseAction {
     getValidators() {
         return [];
     }
+    viewerForEntLoad(data, context) {
+        if (this.options.viewerForEntLoad) {
+            return this.options.viewerForEntLoad(data, context);
+        }
+        return this.viewer;
+    }
     constructor(viewer, builderCtr, options) {
         this.viewer = viewer;
         this.builderCtr = builderCtr;
@@ -30,6 +36,7 @@ class BaseAction {
         }
         this.input = options?.input || {};
         this.builder = new builderCtr(viewer, operation, this, options.existingEnt);
+        this.options = options;
     }
     static createBuilder(viewer, builderCtr, options) {
         let action = new BaseAction(viewer, builderCtr, options);
@@ -93,27 +100,30 @@ exports.updateRawObject = updateRawObject;
 // does do field validation
 // useful to batch a bunch of writes together with BaseAction.bulkAction
 // note that only editable fields in the builder can be passed here
-function getSimpleEditAction(viewer, builderCtr, existingEnt, input) {
+function getSimpleEditAction(viewer, builderCtr, existingEnt, input, opts) {
     return new BaseAction(viewer, builderCtr, {
         existingEnt: existingEnt,
         operation: action_1.WriteOperation.Edit,
         input,
+        ...opts,
     });
 }
 exports.getSimpleEditAction = getSimpleEditAction;
-function getSimpleDeleteAction(viewer, builderCtr, existingEnt, input) {
+function getSimpleDeleteAction(viewer, builderCtr, existingEnt, input, opts) {
     return new BaseAction(viewer, builderCtr, {
         existingEnt: existingEnt,
         operation: action_1.WriteOperation.Delete,
         input,
+        ...opts,
     });
 }
 exports.getSimpleDeleteAction = getSimpleDeleteAction;
-function getSimpleInsertAction(viewer, builderCtr, input) {
+function getSimpleInsertAction(viewer, builderCtr, input, opts) {
     return new BaseAction(viewer, builderCtr, {
         operation: action_1.WriteOperation.Insert,
         input,
         existingEnt: null,
+        ...opts,
     });
 }
 exports.getSimpleInsertAction = getSimpleInsertAction;

package/action/orchestrator.d.ts

@@ -73,6 +73,14 @@ export declare class Orchestrator<TEnt extends Ent<TViewer>, TInput extends Data
     private getSQLStatementOperation;
     private getWriteOpForSQLStamentOp;
     getPossibleUnsafeEntForPrivacy(): Promise<TEnt>;
+    /**
+     * 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
+     * PS contrasted with getValidatedFields() which returns the format that would be written to the db
+     * i.e. includes lists which have been converted to JSON strings, etc
+     */
     getEditedData(): Promise<Data>;
     /**
      * @returns validated and formatted fields that would be written to the db

package/action/orchestrator.js

@@ -93,6 +93,7 @@ class Orchestrator {
         this.edgeSet = new Set();
         this.edges = new Map();
         this.conditionalEdges = new Map();
+        this.validatedFields = null;
         this.changesets = [];
         this.dependencies = new Map();
         this.fieldsToResolve = [];
@@ -401,10 +402,14 @@ class Orchestrator {
         const { schemaFields, editedData } = await this.memoizedGetFields();
         return this.getEntForPrivacyPolicyImpl(schemaFields, editedData, this.options.viewer);
     }
-    // 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
+    /**
+     * 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
+     * PS contrasted with getValidatedFields() which returns the format that would be written to the db
+     * i.e. includes lists which have been converted to JSON strings, etc
+     */
     async getEditedData() {
         const { editedData } = await this.memoizedGetFields();
         return editedData;
@@ -519,7 +524,7 @@ class Orchestrator {
         return errors;
     }
     async triggers(action, builder, triggers) {
-        let groups = [];
+        const groups = [];
         let lastArray = 0;
         let prevWasArray = false;
         for (let i = 0; i < triggers.length; i++) {
@@ -696,29 +701,12 @@ class Orchestrator {
                 data[dbKey] = value;
             }
             if (defaultValue !== undefined) {
-                // Format defaults early so JSON/list defaults are DB-ready in edited data.
-                let formattedDefaultValue = defaultValue;
-                if (defaultValue !== null && !this.isBuilder(defaultValue) && field.format) {
-                    let valid = true;
-                    if (field.valid) {
-                        valid = field.valid(defaultValue);
-                        if ((0, types_1.isPromise)(valid)) {
-                            valid = await valid;
-                        }
-                    }
-                    if (valid) {
-                        formattedDefaultValue = field.format(defaultValue);
-                        if ((0, types_1.isPromise)(formattedDefaultValue)) {
-                            formattedDefaultValue = await formattedDefaultValue;
-                        }
-                    }
-                }
                 updateInput = true;
                 if (updateOnlyIfOther) {
-                    defaultData[dbKey] = formattedDefaultValue;
+                    defaultData[dbKey] = defaultValue;
                 }
                 else {
-                    data[dbKey] = formattedDefaultValue;
+                    data[dbKey] = defaultValue;
                 }
                 this.defaultFieldsByFieldName[fieldName] = defaultValue;
                 this.defaultFieldsByTSName[this.getInputKey(fieldName)] = defaultValue;

package/package.json

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