@snowtop/ent 0.1.0-alpha1 → 0.1.0-alpha100

package/testutils/builder.d.ts

@@ -1,79 +1,81 @@
-import { Ent, ID, Viewer, Data, EntConstructor } from "../core/base";
+import { Ent, ID, Viewer, Data, EntConstructor, PrivacyPolicy } from "../core/base";
 import { Orchestrator } from "../action/orchestrator";
 import { Action, Builder, Changeset, WriteOperation, Validator, Trigger, Observer } from "../action";
-import { Schema } from "../schema";
-export declare class User implements Ent {
+import { FieldMap, Schema } from "../schema";
+import { SchemaConfig, EntSchema } from "../schema/base_schema";
+import { FieldInfoMap } from "../schema/schema";
+import { Clause } from "src/core/clause";
+export declare class BaseEnt {
+    viewer: Viewer;
+    readonly data: Data;
+    readonly id: ID;
+    constructor(viewer: Viewer, data: Data);
+    getKey(): string;
+    getPrivacyPolicy(): PrivacyPolicy;
+    __setRawDBData(data: Data): void;
+}
+export declare class User extends BaseEnt implements Ent {
     viewer: Viewer;
     data: Data;
-    id: ID;
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
     firstName: string;
     constructor(viewer: Viewer, data: Data);
 }
-export declare class Event implements Ent {
-    viewer: Viewer;
-    data: Data;
-    id: ID;
+export declare class Event extends BaseEnt implements Ent {
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
-    constructor(viewer: Viewer, data: Data);
 }
-export declare class Contact implements Ent {
-    viewer: Viewer;
-    data: Data;
-    id: ID;
+export declare class Contact extends BaseEnt implements Ent {
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
-    constructor(viewer: Viewer, data: Data);
+    getPrivacyPolicy(): PrivacyPolicy<this>;
 }
-export declare class Group implements Ent {
-    viewer: Viewer;
-    data: Data;
-    id: ID;
+export declare class Group extends BaseEnt implements Ent {
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
-    constructor(viewer: Viewer, data: Data);
+    getPrivacyPolicy(): PrivacyPolicy<this>;
 }
-export declare class Message implements Ent {
-    viewer: Viewer;
-    data: Data;
-    id: ID;
+export declare class Message extends BaseEnt implements Ent {
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
-    constructor(viewer: Viewer, data: Data);
 }
-export declare class Address implements Ent {
-    viewer: Viewer;
-    data: Data;
-    id: ID;
+export declare class Address extends BaseEnt implements Ent {
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
-    constructor(viewer: Viewer, data: Data);
 }
 export interface BuilderSchema<T extends Ent> extends Schema {
     ent: EntConstructor<T>;
 }
+export declare class EntBuilderSchema<T extends Ent> extends EntSchema {
+    ent: EntConstructor<T>;
+    constructor(ent: EntConstructor<T>, cfg: SchemaConfig);
+}
+export declare function getBuilderSchema<T extends Ent>(cfg: SchemaConfig, ent: EntConstructor<T>): BuilderSchema<T>;
+export declare function getBuilderSchemaFromFields<T extends Ent>(fields: FieldMap, ent: EntConstructor<T>, opts?: Partial<Exclude<SchemaConfig, "fields">>): BuilderSchema<T>;
+export declare function getBuilderSchemaTZFromFields<T extends Ent>(fields: FieldMap, ent: EntConstructor<T>): BuilderSchema<T>;
 export declare function getSchemaName(value: BuilderSchema<Ent>): string;
 export declare function getTableName(value: BuilderSchema<Ent>): string;
-export declare class SimpleBuilder<T extends Ent> implements Builder<T> {
+export declare function getFieldInfo(value: BuilderSchema<Ent>): FieldInfoMap;
+type MaybeNull<T extends Ent> = T | null;
+type TMaybleNullableEnt<T extends Ent> = T | MaybeNull<T>;
+export declare class SimpleBuilder<T extends Ent, TExistingEnt extends TMaybleNullableEnt<T> = MaybeNull<T>> implements Builder<T, Viewer, TExistingEnt> {
     viewer: Viewer;
     private schema;
     operation: WriteOperation;
-    existingEnt: T | undefined;
-    ent: EntConstructor<T>;
+    existingEnt: TExistingEnt;
+    ent: EntConstructor<T, Viewer>;
     placeholderID: ID;
-    orchestrator: Orchestrator<T, Data>;
+    orchestrator: Orchestrator<T, Data, Viewer, TExistingEnt>;
     fields: Map<string, any>;
     nodeType: string;
-    constructor(viewer: Viewer, schema: BuilderSchema<T>, fields: Map<string, any>, operation?: WriteOperation, existingEnt?: T | undefined, action?: Action<T, SimpleBuilder<T>, Data> | undefined);
-    build(): Promise<Changeset<T>>;
+    m: Map<string, any>;
+    constructor(viewer: Viewer, schema: BuilderSchema<T>, fields: Map<string, any>, operation: WriteOperation, existingEnt: TExistingEnt, action?: Action<T, SimpleBuilder<T, TExistingEnt>, Viewer, Data, TExistingEnt> | undefined, expressions?: Map<string, Clause>);
+    getInput(): Data;
+    updateInput(input: Data): void;
+    storeData(k: string, v: any): void;
+    getStoredData(k: string): any;
+    build(): Promise<Changeset>;
     editedEnt(): Promise<T | null>;
     editedEntX(): Promise<T>;
     save(): Promise<void>;
@@ -84,20 +86,21 @@ export declare class SimpleBuilder<T extends Ent> implements Builder<T> {
 interface viewerEntLoadFunc {
     (data: Data): Viewer | Promise<Viewer>;
 }
-export declare class SimpleAction<T extends Ent> implements Action<T, SimpleBuilder<T>, Data> {
+export declare class SimpleAction<T extends Ent, TExistingEnt extends TMaybleNullableEnt<T> = MaybeNull<T>> implements Action<T, SimpleBuilder<T, TExistingEnt>, Viewer, Data, TExistingEnt> {
     viewer: Viewer;
     private fields;
-    builder: SimpleBuilder<T>;
-    validators: Validator<SimpleBuilder<T>, Data>[];
-    triggers: Trigger<SimpleBuilder<T>, Data>[];
-    observers: Observer<SimpleBuilder<T>, Data>[];
+    builder: SimpleBuilder<T, TExistingEnt>;
     viewerForEntLoad: viewerEntLoadFunc | undefined;
-    constructor(viewer: Viewer, schema: BuilderSchema<T>, fields: Map<string, any>, operation?: WriteOperation, existingEnt?: T | undefined);
-    getPrivacyPolicy(): import("../core/base").PrivacyPolicy<Ent>;
+    constructor(viewer: Viewer, schema: BuilderSchema<T>, fields: Map<string, any>, operation: WriteOperation | undefined, existingEnt: TExistingEnt, expressions?: Map<string, Clause>);
+    getTriggers(): (Trigger<T, SimpleBuilder<T>> | Array<Trigger<T, SimpleBuilder<T>>>)[];
+    getValidators(): Validator<T, SimpleBuilder<T>>[];
+    getObservers(): Observer<T, SimpleBuilder<T>>[];
+    getPrivacyPolicy(): PrivacyPolicy<Ent<Viewer<Ent<any> | null, ID | null>>, Viewer<Ent<any> | null, ID | null>>;
     getInput(): Data;
-    changeset(): Promise<Changeset<T>>;
+    changeset(): Promise<Changeset>;
     valid(): Promise<boolean>;
     validX(): Promise<void>;
+    validWithErrors(): Promise<Error[]>;
     save(): Promise<T | null>;
     saveX(): Promise<T>;
     editedEnt(): Promise<T | null>;

package/testutils/builder.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleAction = exports.SimpleBuilder = exports.getTableName = exports.getSchemaName = exports.Address = exports.Message = exports.Group = exports.Contact = exports.Event = exports.User = void 0;
+exports.SimpleAction = exports.SimpleBuilder = exports.getFieldInfo = exports.getTableName = exports.getSchemaName = exports.getBuilderSchemaTZFromFields = exports.getBuilderSchemaFromFields = exports.getBuilderSchema = exports.EntBuilderSchema = exports.Address = exports.Message = exports.Group = exports.Contact = exports.Event = exports.User = exports.BaseEnt = void 0;
 const privacy_1 = require("../core/privacy");
 const orchestrator_1 = require("../action/orchestrator");
 const action_1 = require("../action");
@@ -14,77 +14,112 @@ const snake_case_1 = require("snake-case");
 const loaders_1 = require("../core/loaders");
 const convert_1 = require("../core/convert");
 const camel_case_1 = require("camel-case");
-class User {
+const base_schema_1 = require("../schema/base_schema");
+const schema_2 = require("../schema/schema");
+class BaseEnt {
     constructor(viewer, data) {
         this.viewer = viewer;
         this.data = data;
-        this.accountID = "";
-        this.nodeType = "User";
-        this.privacyPolicy = privacy_1.AlwaysAllowPrivacyPolicy;
         this.data.created_at = (0, convert_1.convertDate)(data.created_at);
         this.data.updated_at = (0, convert_1.convertDate)(data.updated_at);
-        this.id = data.id;
-        this.firstName = data.first_name;
+        this.id = data[this.getKey()];
+    }
+    getKey() {
+        return "id";
+    }
+    getPrivacyPolicy() {
+        return privacy_1.AlwaysAllowPrivacyPolicy;
+    }
+    __setRawDBData(data) {
+        // doesn't apply here so ignore...
     }
 }
-exports.User = User;
-class Event {
+exports.BaseEnt = BaseEnt;
+class User extends BaseEnt {
     constructor(viewer, data) {
+        super(viewer, data);
         this.viewer = viewer;
         this.data = data;
         this.accountID = "";
+        this.nodeType = "User";
+        this.firstName = data.first_name;
+    }
+}
+exports.User = User;
+class Event extends BaseEnt {
+    constructor() {
+        super(...arguments);
+        this.accountID = "";
         this.nodeType = "Event";
-        this.privacyPolicy = privacy_1.AlwaysAllowPrivacyPolicy;
-        this.id = data.id;
     }
 }
 exports.Event = Event;
-class Contact {
-    constructor(viewer, data) {
-        this.viewer = viewer;
-        this.data = data;
+class Contact extends BaseEnt {
+    constructor() {
+        super(...arguments);
         this.accountID = "";
         this.nodeType = "Contact";
-        this.privacyPolicy = privacy_1.AlwaysAllowPrivacyPolicy;
-        this.data.created_at = (0, convert_1.convertDate)(data.created_at);
-        this.data.updated_at = (0, convert_1.convertDate)(data.updated_at);
-        this.id = data.id;
+    }
+    getPrivacyPolicy() {
+        return privacy_1.AlwaysAllowPrivacyPolicy;
     }
 }
 exports.Contact = Contact;
-class Group {
-    constructor(viewer, data) {
-        this.viewer = viewer;
-        this.data = data;
+class Group extends BaseEnt {
+    constructor() {
+        super(...arguments);
         this.accountID = "";
         this.nodeType = "Group";
-        this.privacyPolicy = privacy_1.AlwaysAllowPrivacyPolicy;
-        this.id = data.id;
+    }
+    getPrivacyPolicy() {
+        return privacy_1.AlwaysAllowPrivacyPolicy;
     }
 }
 exports.Group = Group;
-class Message {
-    constructor(viewer, data) {
-        this.viewer = viewer;
-        this.data = data;
+class Message extends BaseEnt {
+    constructor() {
+        super(...arguments);
         this.accountID = "";
         this.nodeType = "Message";
-        this.privacyPolicy = privacy_1.AlwaysAllowPrivacyPolicy;
-        this.id = data.id;
     }
 }
 exports.Message = Message;
-class Address {
-    constructor(viewer, data) {
-        this.viewer = viewer;
-        this.data = data;
+class Address extends BaseEnt {
+    constructor() {
+        super(...arguments);
         this.accountID = "";
         this.nodeType = "Address";
-        this.privacyPolicy = privacy_1.AlwaysAllowPrivacyPolicy;
-        this.id = data.id;
     }
 }
 exports.Address = Address;
+class EntBuilderSchema extends base_schema_1.EntSchema {
+    constructor(ent, cfg) {
+        super(cfg);
+        this.ent = ent;
+    }
+}
+exports.EntBuilderSchema = EntBuilderSchema;
+function getBuilderSchema(cfg, ent) {
+    return {
+        ...new base_schema_1.EntSchema(cfg),
+        ent,
+    };
+}
+exports.getBuilderSchema = getBuilderSchema;
+function getBuilderSchemaFromFields(fields, ent, opts) {
+    return {
+        ...new base_schema_1.EntSchema({ ...opts, fields }),
+        ent,
+    };
+}
+exports.getBuilderSchemaFromFields = getBuilderSchemaFromFields;
+function getBuilderSchemaTZFromFields(fields, ent) {
+    return {
+        ...new base_schema_1.EntSchemaWithTZ({ fields }),
+        ent,
+    };
+}
+exports.getBuilderSchemaTZFromFields = getBuilderSchemaTZFromFields;
 function getSchemaName(value) {
     return value.ent.name;
 }
@@ -96,13 +131,27 @@ exports.getTableName = getTableName;
 function randomNum() {
     return Math.random().toString(10).substring(2);
 }
+function getFieldInfo(value) {
+    const fields = (0, schema_1.getFields)(value);
+    let ret = {};
+    for (const [k, f] of fields) {
+        ret[k] = {
+            dbCol: (0, schema_2.getStorageKey)(f, k),
+            // in tests (anything using SimpleBuilder), make it be the same as the fieldName
+            inputKey: k,
+        };
+    }
+    return ret;
+}
+exports.getFieldInfo = getFieldInfo;
 // reuses orchestrator and standard things
 class SimpleBuilder {
-    constructor(viewer, schema, fields, operation = action_1.WriteOperation.Insert, existingEnt = undefined, action) {
+    constructor(viewer, schema, fields, operation = action_1.WriteOperation.Insert, existingEnt, action, expressions) {
         this.viewer = viewer;
         this.schema = schema;
         this.operation = operation;
         this.existingEnt = existingEnt;
+        this.m = new Map();
         // create dynamic placeholder
         // TODO: do we need to use this as the node when there's an existingEnt
         // same for generated builders.
@@ -128,11 +177,13 @@ class SimpleBuilder {
         this.ent = schema.ent;
         const tableName = getTableName(schema);
         this.nodeType = (0, camel_case_1.camelCase)(schema.ent.name);
+        const fieldInfo = getFieldInfo(schema);
         this.orchestrator = new orchestrator_1.Orchestrator({
             viewer: this.viewer,
             operation: operation,
             tableName: tableName,
             key,
+            fieldInfo,
             loaderOptions: {
                 loaderFactory: new loaders_1.ObjectLoaderFactory({
                     tableName: tableName,
@@ -142,15 +193,54 @@ class SimpleBuilder {
                 ent: schema.ent,
                 tableName: tableName,
                 fields: [],
+                fieldPrivacy: (0, schema_1.getFieldsWithPrivacy)(schema, fieldInfo),
             },
             builder: this,
             action: action,
+            expressions,
             schema: this.schema,
             editedFields: () => {
-                return this.fields;
+                // to simulate what we do in generated builders where we return a new Map
+                const m = new Map();
+                for (const [k, v] of this.fields) {
+                    m.set(k, v);
+                }
+                return m;
             },
+            updateInput: this.updateInput.bind(this),
         });
     }
+    getInput() {
+        let ret = {};
+        for (const [k, v] of this.fields) {
+            ret[k] = v;
+        }
+        return ret;
+    }
+    updateInput(input) {
+        const knownFields = (0, schema_1.getFields)(this.schema);
+        for (const k in input) {
+            if (knownFields.has(k)) {
+                this.fields.set(k, input[k]);
+            }
+            else {
+                // related to #510. we do camelCase to pass fields in here but fields may be snakeCase and we want that to pass in tests
+                // we do camelCase in
+                const sc = (0, snake_case_1.snakeCase)(k);
+                if (knownFields.has(sc)) {
+                    this.fields.set(sc, input[k]);
+                }
+            }
+        }
+    }
+    // store data in Builder that can be retrieved by another validator, trigger, observer later in the action
+    storeData(k, v) {
+        this.m.set(k, v);
+    }
+    // retrieve data stored in this Builder with key
+    getStoredData(k) {
+        return this.m.get(k);
+    }
     build() {
         return this.orchestrator.build();
     }
@@ -175,13 +265,19 @@ class SimpleBuilder {
 }
 exports.SimpleBuilder = SimpleBuilder;
 class SimpleAction {
-    constructor(viewer, schema, fields, operation = action_1.WriteOperation.Insert, existingEnt = undefined) {
+    constructor(viewer, schema, fields, operation = action_1.WriteOperation.Insert, existingEnt, expressions) {
         this.viewer = viewer;
         this.fields = fields;
-        this.validators = [];
-        this.triggers = [];
-        this.observers = [];
-        this.builder = new SimpleBuilder(this.viewer, schema, fields, operation, existingEnt, this);
+        this.builder = new SimpleBuilder(this.viewer, schema, fields, operation, existingEnt, this, expressions);
+    }
+    getTriggers() {
+        return [];
+    }
+    getValidators() {
+        return [];
+    }
+    getObservers() {
+        return [];
     }
     getPrivacyPolicy() {
         return privacy_1.AlwaysAllowPrivacyPolicy;
@@ -202,6 +298,9 @@ class SimpleAction {
     validX() {
         return this.builder.orchestrator.validX();
     }
+    validWithErrors() {
+        return this.builder.orchestrator.validWithErrors();
+    }
     async save() {
         await (0, action_1.saveBuilder)(this.builder);
         if (this.builder.operation !== action_1.WriteOperation.Delete) {

package/testutils/context/test_context.d.ts

@@ -1,8 +1,8 @@
 import { Context, Viewer } from "../../core/base";
 import { ContextCache } from "../../core/context";
-import { LoggedOutViewer } from "../../core/viewer";
 export declare class TestContext implements Context {
+    constructor(viewer?: Viewer);
     cache: ContextCache;
-    viewer: LoggedOutViewer;
+    viewer: Viewer;
     getViewer(): Viewer;
 }

package/testutils/context/test_context.js

@@ -4,9 +4,15 @@ exports.TestContext = void 0;
 const context_1 = require("../../core/context");
 const viewer_1 = require("../../core/viewer");
 class TestContext {
-    constructor() {
+    constructor(viewer) {
         this.cache = new context_1.ContextCache();
         this.viewer = new viewer_1.LoggedOutViewer(this);
+        if (viewer) {
+            this.viewer = viewer;
+            if (viewer.setContext !== undefined) {
+                viewer.setContext(this);
+            }
+        }
     }
     getViewer() {
         return this.viewer;

package/testutils/db/fixture.d.ts

@@ -0,0 +1,10 @@
+import { Client } from "pg";
+import { Data } from "../../core/base";
+import { Schema } from "../../schema";
+interface Options {
+    overrides?: Data;
+    client: Client;
+    tableName: string;
+}
+export declare function writeFixture(schema: Schema, opts: Options): Promise<void>;
+export {};

package/testutils/db/fixture.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeFixture = void 0;
+const schema_1 = require("../../schema");
+const value_1 = require("./value");
+const ent_1 = require("../../core/ent");
+async function writeFixture(schema, opts) {
+    const fields = (0, schema_1.getFields)(schema);
+    const d = {};
+    for (const [fieldName, field] of fields) {
+        const col = (0, schema_1.getStorageKey)(field, fieldName);
+        const val = (0, value_1.getDefaultValue)(field, col);
+        d[col] = val;
+    }
+    if (opts.overrides) {
+        for (const k in opts.overrides) {
+            d[k] = opts.overrides[k];
+        }
+    }
+    const q = (0, ent_1.buildInsertQuery)({
+        tableName: opts.tableName,
+        fields: d,
+    });
+    await opts.client.query(q[0], q[1]);
+}
+exports.writeFixture = writeFixture;

package/testutils/db/{test_db.d.ts → temp_db.d.ts}

@@ -1,6 +1,7 @@
 import { Client as PGClient } from "pg";
 import { Dialect } from "../../core/db";
 import { Database as SqliteDatabase } from "better-sqlite3";
+import { Field } from "../../schema";
 import { BuilderSchema } from "../builder";
 import { Ent } from "../../core/base";
 interface SchemaItem {
@@ -12,6 +13,7 @@ interface Column extends SchemaItem {
     primaryKey?: boolean;
     unique?: boolean;
     default?: string;
+    index?: boolean | indexOptions;
     foreignKey?: {
         table: string;
         col: string;
@@ -20,22 +22,32 @@ interface Column extends SchemaItem {
 interface Constraint extends SchemaItem {
     generate(): string;
 }
+interface Index extends SchemaItem {
+    generate(): string;
+    postCreate?(): boolean;
+}
 export interface CoreConcept {
     name: string;
     create(): string;
+    postCreate?(): string[];
     drop(): string;
 }
 export interface Table extends CoreConcept {
     columns: Column[];
     constraints?: Constraint[];
 }
-declare type options = Pick<Column, "nullable" | "primaryKey" | "default" | "foreignKey" | "unique">;
+type options = Pick<Column, "nullable" | "primaryKey" | "default" | "foreignKey" | "unique" | "index">;
 export declare function primaryKey(name: string, cols: string[]): Constraint;
 export declare function foreignKey(name: string, cols: string[], fkey: {
     table: string;
     cols: string[];
 }): Constraint;
-export declare function uniqueIndex(name: string): Constraint;
+export declare function check(name: string, condition: string): Constraint;
+interface indexOptions {
+    type?: string;
+    unique?: boolean;
+}
+export declare function index(tableName: string, cols: string[], opts?: indexOptions): Index;
 export declare function uuid(name: string, opts?: options): Column;
 export declare function text(name: string, opts?: options): Column;
 export declare function enumCol(name: string, type: string): Column;
@@ -67,23 +79,28 @@ export declare class TempDB {
     private tables;
     private dialect;
     private sqlite;
-    constructor(dialect: Dialect, tables?: CoreConcept[]);
-    constructor(tables: CoreConcept[]);
+    private setTables;
+    constructor(dialect: Dialect, tables?: CoreConcept[] | (() => CoreConcept[]));
     getDialect(): Dialect;
-    getTables(): Map<string, CoreConcept>;
-    beforeAll(): Promise<void>;
+    __getTables(): Map<string, CoreConcept>;
+    beforeAll(setupConnString?: boolean): Promise<void>;
+    createImpl(table: CoreConcept): Promise<void>;
     getSqliteClient(): SqliteDatabase;
     getPostgresClient(): PGClient;
     afterAll(): Promise<void>;
+    getDB(): string;
     dropAll(): Promise<void>;
     drop(...tables: string[]): Promise<void>;
     create(...tables: CoreConcept[]): Promise<void>;
 }
 export declare function assoc_edge_config_table(): Table;
-export declare function assoc_edge_table(name: string): Table;
-interface sqliteSetupOptions {
+export declare function assoc_edge_table(name: string, global?: boolean): Table;
+interface setupOptions {
     disableDeleteAfterEachTest?: boolean;
 }
-export declare function setupSqlite(connString: string, tables: () => Table[], opts?: sqliteSetupOptions): void;
+export declare function setupSqlite(connString: string, tables: () => Table[], opts?: setupOptions): TempDB;
+export declare function setupPostgres(tables: () => Table[], opts?: setupOptions): void;
+export declare function doSQLiteTestFromSchemas(schemas: BuilderSchema<Ent>[], doTest: () => Promise<void>, db?: string): Promise<TempDB>;
 export declare function getSchemaTable(schema: BuilderSchema<Ent>, dialect: Dialect): Table;
+export declare function getColumnFromField(fieldName: string, f: Field, dialect: Dialect): Column;
 export {};