@snowtop/ent 0.1.0-alpha2 → 0.1.0-alpha25

package/action/action.d.ts

@@ -1,19 +1,22 @@
 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",
     Delete = "delete"
 }
-export interface Builder<T extends Ent> {
-    existingEnt?: T;
-    ent: EntConstructor<T>;
+declare type MaybeNull<T extends Ent> = T | null;
+declare type TMaybleNullableEnt<T extends Ent> = T | MaybeNull<T>;
+export interface Builder<TEnt extends Ent<TViewer>, TViewer extends Viewer = Viewer, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
+    existingEnt: TExistingEnt;
+    ent: EntConstructor<TEnt, TViewer>;
     placeholderID: ID;
-    readonly viewer: Viewer;
-    build(): Promise<Changeset<T>>;
+    readonly viewer: TViewer;
+    build(): Promise<Changeset>;
     operation: WriteOperation;
-    editedEnt?(): Promise<T | null>;
+    editedEnt?(): Promise<TEnt | null>;
     nodeType: string;
 }
 export interface Executor extends Iterable<DataOperation>, Iterator<DataOperation> {
@@ -24,38 +27,39 @@ export interface Executor extends Iterable<DataOperation>, Iterator<DataOperatio
     postFetch?(queryer: Queryer, context?: Context): Promise<void>;
     executeObservers?(): Promise<void>;
 }
-export interface Changeset<T extends Ent> {
+export interface Changeset {
     executor(): Executor;
     viewer: Viewer;
     placeholderID: ID;
-    changesets?: Changeset<Ent>[];
+    changesets?: Changeset[];
     dependencies?: Map<ID, Builder<Ent>>;
 }
-export declare type TriggerReturn = void | Promise<Changeset<Ent> | void | (Changeset<Ent> | void)[]> | Promise<Changeset<Ent>>[];
-export interface Trigger<TBuilder extends Builder<Ent>, TData extends Data> {
-    changeset(builder: TBuilder, input: TData): TriggerReturn;
+export declare type TriggerReturn = void | Promise<Changeset | void | (Changeset | void)[]> | Promise<Changeset>[];
+export interface Trigger<TEnt extends Ent<TViewer>, TBuilder extends Builder<TEnt, TViewer, TExistingEnt>, TViewer extends Viewer = Viewer, TInput extends Data = Data, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
+    changeset(builder: TBuilder, input: TInput): TriggerReturn;
 }
-export interface Observer<TBuilder extends Builder<Ent>, TData extends Data> {
-    observe(builder: TBuilder, input: TData): void | Promise<void>;
+export interface Observer<TEnt extends Ent<TViewer>, TBuilder extends Builder<TEnt, TViewer, TExistingEnt>, TViewer extends Viewer = Viewer, TInput extends Data = Data, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
+    observe(builder: TBuilder, input: TInput): void | Promise<void>;
 }
-export interface Validator<TBuilder extends Builder<Ent>, TData extends Data> {
-    validate(builder: TBuilder, input: TData): Promise<void> | void;
+export interface Validator<TEnt extends Ent<TViewer>, TBuilder extends Builder<TEnt, TViewer, TExistingEnt>, TViewer extends Viewer = Viewer, TInput extends Data = Data, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
+    validate(builder: TBuilder, input: TInput): Promise<void> | void;
 }
-export interface Action<TEnt extends Ent, TBuilder extends Builder<TEnt>, TData extends Data> {
+export interface Action<TEnt extends Ent<TViewer>, TBuilder extends Builder<TEnt, TViewer, TExistingEnt>, TViewer extends Viewer = Viewer, TInput extends Data = Data, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
     readonly viewer: Viewer;
-    changeset(): Promise<Changeset<TEnt>>;
+    changeset(): Promise<Changeset>;
     builder: TBuilder;
     getPrivacyPolicy(): PrivacyPolicy<TEnt>;
-    triggers?: Trigger<TBuilder, TData>[];
-    observers?: Observer<TBuilder, TData>[];
-    validators?: Validator<TBuilder, TData>[];
-    getInput(): TData;
+    getTriggers?(): Trigger<TEnt, TBuilder, TViewer, TInput, TExistingEnt>[];
+    getObservers?(): Observer<TEnt, TBuilder, TViewer, TInput, TExistingEnt>[];
+    getValidators?(): Validator<TEnt, TBuilder, TViewer, TInput, TExistingEnt>[];
+    getInput(): TInput;
+    transformWrite?: (stmt: UpdateOperation<TEnt>) => Promise<TransformedUpdateOperation<TEnt>> | TransformedUpdateOperation<TEnt> | null;
     valid(): Promise<boolean>;
     validX(): Promise<void>;
-    viewerForEntLoad?(data: Data): Viewer | Promise<Viewer>;
+    viewerForEntLoad?(data: Data): TViewer | Promise<TViewer>;
 }
-export declare function saveBuilder<T extends Ent>(builder: Builder<T>): Promise<void>;
-export declare function saveBuilderX<T extends Ent>(builder: Builder<T>): Promise<void>;
+export declare function saveBuilder<TEnt extends Ent<TViewer>, TViewer extends Viewer>(builder: Builder<TEnt, TViewer>): Promise<void>;
+export declare function saveBuilderX<TEnt extends Ent<TViewer>, TViewer extends Viewer>(builder: Builder<TEnt, TViewer>): Promise<void>;
 interface Orchestrator {
     addOutboundEdge<T2 extends Ent>(id2: ID | Builder<T2>, edgeType: string, nodeType: string, options?: AssocEdgeInputOptions): void;
     removeOutboundEdge(id2: ID, edgeType: string): void;

package/action/executor.d.ts

@@ -1,4 +1,4 @@
-import { ID, Data, Ent, Viewer, Context } from "../core/base";
+import { ID, Ent, Viewer, Context, Data } from "../core/base";
 import { DataOperation } from "../core/ent";
 import { Changeset, Executor } from "../action/action";
 import { Builder } from "../action";
@@ -10,7 +10,7 @@ export declare class ListBasedExecutor<T extends Ent> implements Executor {
     private operations;
     private options?;
     private idx;
-    constructor(viewer: Viewer, placeholderID: ID, operations: DataOperation<T>[], options?: OrchestratorOptions<T, Data> | undefined);
+    constructor(viewer: Viewer, placeholderID: ID, operations: DataOperation<T>[], options?: OrchestratorOptions<T, Viewer<Ent<any> | null, ID | null>, Data, T | null> | undefined);
     private lastOp;
     private createdEnt;
     resolveValue(val: ID): Ent | null;
@@ -29,7 +29,7 @@ export declare class ComplexExecutor<T extends Ent> implements Executor {
     private lastOp;
     private allOperations;
     private executors;
-    constructor(viewer: Viewer, placeholderID: ID, operations: DataOperation[], dependencies: Map<ID, Builder<T>>, changesets: Changeset<T>[], options?: OrchestratorOptions<T, Data>);
+    constructor(viewer: Viewer, placeholderID: ID, operations: DataOperation[], dependencies: Map<ID, Builder<T>>, changesets: Changeset[], options?: OrchestratorOptions<T, Viewer, Data>);
     [Symbol.iterator](): this;
     private handleCreatedEnt;
     next(): IteratorResult<DataOperation<Ent>>;
@@ -39,4 +39,4 @@ export declare class ComplexExecutor<T extends Ent> implements Executor {
     preFetch?(queryer: Queryer, context: Context): Promise<void>;
     postFetch?(queryer: Queryer, context: Context): Promise<void>;
 }
-export declare function executeOperations(executor: Executor, context?: Context, trackOps?: true): Promise<DataOperation<Ent>[]>;
+export declare function executeOperations(executor: Executor, context?: Context, trackOps?: true): Promise<DataOperation<Ent<Viewer<Ent<any> | null, ID | null>>>[]>;

package/action/executor.js

@@ -47,11 +47,11 @@ class ListBasedExecutor {
     }
     async executeObservers() {
         const action = this.options?.action;
-        if (!this.options || !action || !action.observers) {
+        if (!this.options || !action || !action.getObservers) {
             return;
         }
         const builder = this.options.builder;
-        await Promise.all(action.observers.map(async (observer) => {
+        await Promise.all(action.getObservers().map(async (observer) => {
             await observer.observe(builder, action.getInput());
         }));
     }

package/action/experimental_action.d.ts

@@ -5,36 +5,37 @@ export interface ActionOptions<T extends Ent, TData extends Data> {
     input?: TData;
     operation?: WriteOperation;
 }
-interface EntBuilder<T extends Ent> extends Builder<T> {
+interface EntBuilder<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data> extends Builder<TEnt, TViewer> {
     valid(): Promise<boolean>;
     validX(): Promise<void>;
     save(): Promise<void>;
     saveX(): Promise<void>;
-    editedEnt(): Promise<T | null>;
-    editedEntX(): Promise<T>;
+    editedEnt(): Promise<TEnt | null>;
+    editedEntX(): Promise<TEnt>;
+    getInput(): TInput;
 }
-export declare class BaseAction<TEnt extends Ent, TData extends Data> implements Action<TEnt, EntBuilder<TEnt>, TData> {
-    viewer: Viewer;
-    builderCtr: BuilderConstructor<TEnt, TData>;
-    builder: EntBuilder<TEnt>;
+export declare class BaseAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data> implements Action<TEnt, EntBuilder<TEnt, TViewer, TInput>, TViewer, TInput> {
+    viewer: TViewer;
+    builderCtr: BuilderConstructor<TEnt, TViewer, TInput>;
+    builder: EntBuilder<TEnt, TViewer, TInput>;
     private input;
-    triggers: Trigger<EntBuilder<TEnt>, TData>[];
-    observers: Observer<EntBuilder<TEnt>, TData>[];
-    validators: Validator<EntBuilder<TEnt>, TData>[];
-    getPrivacyPolicy(): import("../core/base").PrivacyPolicy<Ent>;
-    constructor(viewer: Viewer, builderCtr: BuilderConstructor<TEnt, TData>, options?: ActionOptions<TEnt, TData> | null);
-    static createBuilder<TEnt extends Ent, TData extends Data>(viewer: Viewer, builderCtr: BuilderConstructor<TEnt, TData>, options?: ActionOptions<TEnt, TData> | null): Builder<TEnt>;
-    static bulkAction<TEnt extends Ent, TData extends Data>(ent: TEnt, builderCtr: BuilderConstructor<TEnt, TData>, ...actions: Action<Ent, Builder<Ent>, Data>[]): BaseAction<TEnt, TData>;
-    changeset(): Promise<Changeset<TEnt>>;
+    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>, TViewer, TInput>[];
+    getObservers(): Observer<TEnt, EntBuilder<TEnt, TViewer, TInput>, TViewer, TInput>[];
+    getValidators(): Validator<TEnt, EntBuilder<TEnt, TViewer, TInput>, TViewer, TInput>[];
+    constructor(viewer: TViewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput>, options?: ActionOptions<TEnt, TInput> | null);
+    static createBuilder<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: Viewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput>, options?: ActionOptions<TEnt, TInput> | null): Builder<TEnt>;
+    static bulkAction<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(ent: TEnt, builderCtr: BuilderConstructor<TEnt, TViewer, TInput>, ...actions: Action<Ent, Builder<Ent, any>>[]): BaseAction<TEnt, TViewer, TInput>;
+    changeset(): Promise<Changeset>;
     valid(): Promise<boolean>;
     validX(): Promise<void>;
     save(): Promise<TEnt | null>;
     saveX(): Promise<TEnt>;
-    getInput(): TData;
+    getInput(): TInput;
 }
-interface BuilderConstructor<TEnt extends Ent, TData extends Data> {
-    new (viewer: Viewer, operation: WriteOperation, action: Action<TEnt, EntBuilder<TEnt>, TData>, existingEnt?: TEnt | undefined): EntBuilder<TEnt>;
+interface BuilderConstructor<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data> {
+    new (viewer: TViewer, operation: WriteOperation, action: Action<TEnt, EntBuilder<TEnt, TViewer, TInput>, TViewer, TInput>, existingEnt: TEnt | null): EntBuilder<TEnt, TViewer, TInput>;
 }
-export declare function updateRawObject<TEnt extends Ent, TInput extends Data>(viewer: Viewer, builderCtr: BuilderConstructor<TEnt, TInput>, existingEnt: TEnt, input: TInput): Promise<TEnt>;
-export declare function getSimpleEditAction<TEnt extends Ent, TInput extends Data>(viewer: Viewer, builderCtr: BuilderConstructor<TEnt, TInput>, existingEnt: TEnt, input: TInput): Action<TEnt, Builder<TEnt>, TInput>;
+export declare function updateRawObject<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data>(viewer: Viewer, builderCtr: BuilderConstructor<TEnt, TViewer, TInput>, 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>, existingEnt: TEnt, input: TInput): Action<TEnt, Builder<TEnt, TViewer>, TViewer, TInput>;
 export {};

package/action/experimental_action.js

@@ -7,9 +7,6 @@ class BaseAction {
     constructor(viewer, builderCtr, options) {
         this.viewer = viewer;
         this.builderCtr = builderCtr;
-        this.triggers = [];
-        this.observers = [];
-        this.validators = [];
         let operation = options?.operation;
         if (!operation) {
             if (options?.existingEnt) {
@@ -20,11 +17,20 @@ class BaseAction {
             }
         }
         this.input = options?.input || {};
-        this.builder = new builderCtr(viewer, operation, this, options?.existingEnt || undefined);
+        this.builder = new builderCtr(viewer, operation, this, options?.existingEnt || null);
     }
     getPrivacyPolicy() {
         return privacy_1.AlwaysAllowPrivacyPolicy;
     }
+    getTriggers() {
+        return [];
+    }
+    getObservers() {
+        return [];
+    }
+    getValidators() {
+        return [];
+    }
     static createBuilder(viewer, builderCtr, options) {
         let action = new BaseAction(viewer, builderCtr, options);
         return action.builder;
@@ -35,7 +41,7 @@ class BaseAction {
         let action = new BaseAction(ent.viewer, builderCtr, {
             existingEnt: ent,
         });
-        action.triggers = [
+        action.getTriggers = () => [
             {
                 changeset: () => {
                     return actions.map((action) => action.changeset());

package/action/orchestrator.d.ts

@@ -1,19 +1,22 @@
 import { ID, Data, Ent, Viewer, EntConstructor, LoadEntOptions } from "../core/base";
 import { AssocEdgeInputOptions, DataOperation } from "../core/ent";
-import { SchemaInputType } from "../schema/schema";
+import { SchemaInputType, FieldInfoMap } from "../schema/schema";
 import { Changeset, Executor } from "../action/action";
 import { WriteOperation, Builder, Action } from "../action";
-export interface OrchestratorOptions<TEnt extends Ent, TData extends Data> {
+declare type MaybeNull<T extends Ent> = T | null;
+declare type TMaybleNullableEnt<T extends Ent> = T | MaybeNull<T>;
+export interface OrchestratorOptions<TEnt extends Ent<TViewer>, TViewer extends Viewer, TInput extends Data, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
     viewer: Viewer;
     operation: WriteOperation;
     tableName: string;
-    loaderOptions: LoadEntOptions<TEnt>;
+    loaderOptions: LoadEntOptions<TEnt, TViewer>;
     key: string;
-    builder: Builder<TEnt>;
-    action?: Action<TEnt, Builder<TEnt>, TData>;
+    builder: Builder<TEnt, TViewer, TExistingEnt>;
+    action?: Action<TEnt, Builder<TEnt, TViewer>, TViewer, TInput>;
     schema: SchemaInputType;
-    editedFields(): Map<string, any>;
-    updateInput?: (data: TData) => void;
+    editedFields(): Map<string, any> | Promise<Map<string, any>>;
+    updateInput?: (data: TInput) => void;
+    fieldInfo: FieldInfoMap;
 }
 interface edgeInputDataOpts {
     edgeType: string;
@@ -28,7 +31,7 @@ export declare enum edgeDirection {
     inboundEdge = 0,
     outboundEdge = 1
 }
-export declare class Orchestrator<TEnt extends Ent, TData extends Data> {
+export declare class Orchestrator<TEnt extends Ent<TViewer>, TInput extends Data, TViewer extends Viewer, TExistingEnt extends TMaybleNullableEnt<TEnt> = MaybeNull<TEnt>> {
     private options;
     private edgeSet;
     private edges;
@@ -41,10 +44,15 @@ export declare class Orchestrator<TEnt extends Ent, TData extends Data> {
     viewer: Viewer;
     private defaultFieldsByFieldName;
     private defaultFieldsByTSName;
-    constructor(options: OrchestratorOptions<TEnt, TData>);
+    private actualOperation;
+    private existingEnt;
+    private disableTransformations;
+    private memoizedGetFields;
+    constructor(options: OrchestratorOptions<TEnt, TViewer, TInput, TExistingEnt>);
     private addEdge;
-    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;
+    setDisableTransformations(val: boolean): void;
+    addInboundEdge<T2 extends Ent>(id1: ID | Builder<T2, any>, edgeType: string, nodeType: string, options?: AssocEdgeInputOptions): void;
+    addOutboundEdge<T2 extends Ent>(id2: ID | Builder<T2, any>, edgeType: string, nodeType: string, options?: AssocEdgeInputOptions): void;
     removeInboundEdge(id1: ID, edgeType: string): void;
     removeOutboundEdge(id2: ID, edgeType: string): void;
     getInputEdges(edgeType: string, op: WriteOperation): EdgeInputData[];
@@ -53,11 +61,18 @@ export declare class Orchestrator<TEnt extends Ent, TData extends Data> {
     private getEdgeOperation;
     private buildEdgeOps;
     private throwError;
-    private getEntForPrivacyPolicy;
+    private getEntForPrivacyPolicyImpl;
+    private getSQLStatementOperation;
+    private getWriteOpForSQLStamentOp;
+    getPossibleUnsafeEntForPrivacy(): Promise<TEnt>;
+    getEditedData(): Promise<Data>;
+    private getFieldsInfo;
     private validate;
     private triggers;
     private validators;
     private isBuilder;
+    private getInputKey;
+    private getStorageKey;
     private getFieldsWithDefaultValues;
     private hasData;
     private transformFieldValue;
@@ -70,16 +85,16 @@ export declare class Orchestrator<TEnt extends Ent, TData extends Data> {
     editedEnt(): Promise<TEnt | null>;
     editedEntX(): Promise<TEnt>;
 }
-export declare class EntChangeset<T extends Ent> implements Changeset<T> {
+export declare class EntChangeset<T extends Ent> implements Changeset {
     viewer: Viewer;
     readonly placeholderID: ID;
     readonly ent: EntConstructor<T>;
     operations: DataOperation[];
-    dependencies?: Map<ID, Builder<Ent>> | undefined;
-    changesets?: Changeset<Ent>[] | undefined;
+    dependencies?: Map<ID, Builder<Ent<Viewer<Ent<any> | null, ID | null>>, Viewer<Ent<any> | null, ID | null>, Ent<Viewer<Ent<any> | null, ID | null>> | null>> | undefined;
+    changesets?: Changeset[] | undefined;
     private options?;
     private _executor;
-    constructor(viewer: Viewer, placeholderID: ID, ent: EntConstructor<T>, operations: DataOperation[], dependencies?: Map<ID, Builder<Ent>> | undefined, changesets?: Changeset<Ent>[] | undefined, options?: OrchestratorOptions<T, Data> | undefined);
+    constructor(viewer: Viewer, placeholderID: ID, ent: EntConstructor<T>, operations: DataOperation[], dependencies?: Map<ID, Builder<Ent<Viewer<Ent<any> | null, ID | null>>, Viewer<Ent<any> | null, ID | null>, Ent<Viewer<Ent<any> | null, ID | null>> | null>> | undefined, changesets?: Changeset[] | undefined, options?: OrchestratorOptions<T, Viewer<Ent<any> | null, ID | null>, Data, MaybeNull<T>> | undefined);
     executor(): Executor;
 }
 export {};