@snowtop/ent 0.1.0-alpha2 → 0.1.0-alpha25

package/schema/struct_field.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StructListType = exports.StructType = exports.StructField = void 0;
+const field_1 = require("./field");
+const schema_1 = require("./schema");
+const camel_case_1 = require("camel-case");
+class StructField extends field_1.BaseField {
+    constructor(options) {
+        super();
+        this.options = options;
+        this.type = {
+            dbType: schema_1.DBType.JSONB,
+        };
+        this.type.subFields = options.fields;
+        this.type.type = options.tsType;
+        this.type.graphQLType = options.graphQLType || options.tsType;
+        if (options.jsonNotJSONB) {
+            this.type.dbType = schema_1.DBType.JSON;
+        }
+    }
+    // right now, we store things in the db in lowerCase format
+    // this will lead to issues if field changes.
+    // TODO: use storageKey and convert back...
+    format(obj, nested) {
+        if (!(obj instanceof Object)) {
+            throw new Error("valid was not called");
+        }
+        let ret = {};
+        for (const k in this.options.fields) {
+            // TODO more #510
+            let dbKey = (0, camel_case_1.camelCase)(k);
+            let val = obj[dbKey];
+            // for tests with snake_case
+            if (val === undefined && obj[k] !== undefined) {
+                val = obj[k];
+                dbKey = k;
+            }
+            if (val === undefined) {
+                continue;
+            }
+            const field = this.options.fields[k];
+            if (field.format) {
+                // indicate nested so this isn't JSON stringified
+                ret[dbKey] = field.format(val, true);
+            }
+            else {
+                ret[dbKey] = val;
+            }
+        }
+        // don't json.stringify if nested
+        if (nested) {
+            return ret;
+        }
+        return JSON.stringify(ret);
+    }
+    async valid(obj) {
+        if (!(obj instanceof Object)) {
+            return false;
+        }
+        let promises = [];
+        // TODO probably need to support optional fields...
+        let valid = true;
+        for (const k in this.options.fields) {
+            const field = this.options.fields[k];
+            // TODO more #510
+            let dbKey = (0, camel_case_1.camelCase)(k);
+            let val = obj[dbKey];
+            // for tests with snake_case
+            if (val === undefined && obj[k] !== undefined) {
+                val = obj[k];
+                dbKey = k;
+            }
+            if (val === undefined || val === null) {
+                // nullable, nothing to do here
+                if (field.nullable) {
+                    continue;
+                }
+                valid = false;
+                break;
+            }
+            if (!field.valid) {
+                continue;
+            }
+            promises.push(field.valid(val));
+        }
+        if (!valid) {
+            return valid;
+        }
+        const ret = await Promise.all(promises);
+        return ret.every((v) => v);
+    }
+}
+exports.StructField = StructField;
+function StructType(options) {
+    let result = new StructField(options);
+    return Object.assign(result, options);
+}
+exports.StructType = StructType;
+function StructListType(options) {
+    return new field_1.ListField(StructType(options), options);
+}
+exports.StructListType = StructListType;

package/schema/union_field.d.ts

@@ -0,0 +1,23 @@
+import { StructField } from "./struct_field";
+import { FieldOptions, Type } from "./schema";
+import { BaseField, ListField } from "./field";
+export declare type StructMap = {
+    [key: string]: StructField;
+};
+export interface UnionOptions extends FieldOptions {
+    tsType: string;
+    fields: StructMap;
+    graphQLType?: string;
+    jsonNotJSONB?: boolean;
+}
+export declare class UnionField extends BaseField implements FieldOptions {
+    private options;
+    type: Type;
+    m: Map<Object, string>;
+    constructor(options: UnionOptions);
+    format(obj: any): string | Object;
+    private validField;
+    valid(obj: any): Promise<boolean>;
+}
+export declare function UnionType(options: UnionOptions): UnionField & UnionOptions;
+export declare function UnionListType(options: UnionOptions): ListField;

package/schema/union_field.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnionListType = exports.UnionType = exports.UnionField = void 0;
+const schema_1 = require("./schema");
+const field_1 = require("./field");
+// used to know which key in the union is valid.
+// maybe there's a better way of doing this eventually
+const KEY = "___valid___key___";
+class UnionField extends field_1.BaseField {
+    constructor(options) {
+        super();
+        this.options = options;
+        this.type = {
+            dbType: schema_1.DBType.JSONB,
+        };
+        this.m = new Map();
+        this.type.unionFields = options.fields;
+        this.type.type = options.tsType;
+        this.type.graphQLType = options.graphQLType || options.tsType;
+        // TODO should throw if not nested?
+        if (options.jsonNotJSONB) {
+            this.type.dbType = schema_1.DBType.JSON;
+        }
+    }
+    format(obj) {
+        if (!(obj instanceof Object)) {
+            throw new Error("valid was not called");
+        }
+        const k = obj[KEY];
+        if (k === undefined) {
+            throw new Error(`need to call valid first`);
+        }
+        // now delete it since we don't need it anymore
+        delete obj[KEY];
+        const field = this.options.fields[k];
+        // always nested for now so pass through
+        return field.format(obj, true);
+    }
+    async validField(k, f, obj) {
+        const valid = await f.valid(obj);
+        return {
+            valid,
+            key: k,
+        };
+    }
+    async valid(obj) {
+        if (!(obj instanceof Object)) {
+            return false;
+        }
+        let promises = [];
+        for (const k in this.options.fields) {
+            const field = this.options.fields[k];
+            promises.push(this.validField(k, field, obj));
+        }
+        let lastKey;
+        let validCt = 0;
+        const ret = await Promise.all(promises);
+        for (const v of ret) {
+            if (v.valid) {
+                validCt++;
+                lastKey = v.key;
+            }
+        }
+        if (lastKey !== undefined) {
+            obj[KEY] = lastKey;
+        }
+        return validCt == 1;
+    }
+}
+exports.UnionField = UnionField;
+function UnionType(options) {
+    let result = new UnionField(options);
+    return Object.assign(result, options);
+}
+exports.UnionType = UnionType;
+function UnionListType(options) {
+    return new field_1.ListField(UnionType(options), options);
+}
+exports.UnionListType = UnionListType;

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/scripts/migrate_v0.1.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const transform_1 = require("../tsc/transform");
+const transform_schema_1 = require("../tsc/transform_schema");
+const transform_ent_1 = require("../tsc/transform_ent");
+const move_generated_1 = require("../tsc/move_generated");
+const transform_action_1 = require("../tsc/transform_action");
+const minimist_1 = __importDefault(require("minimist"));
+const ast_1 = require("../tsc/ast");
+// todo-sqlite
+//  ts-node-script --swc --project ./tsconfig.json -r tsconfig-paths/register ../../ts/src/scripts/migrate_v0.1.ts --transform_schema --old_base_class BaseEntTodoSchema --new_schema_class TodoEntSchema  --transform_path src/schema/patterns/base
+function main() {
+    const customInfo = (0, ast_1.getCustomInfo)();
+    const options = (0, minimist_1.default)(process.argv.slice(2));
+    // install 0.1.x dependencies
+    // maybe provide options to make this easier if someone wants to do this in steps to see what's happening
+    if (options.move_generated) {
+        (0, move_generated_1.moveGenerated)(customInfo.relativeImports);
+    }
+    // codegen  write-all --disable-custom-graphql
+    if (options.transform_schema) {
+        (0, transform_1.transform)(new transform_schema_1.TransformSchema(customInfo.relativeImports, options.old_base_class, options.new_schema_class, options.transform_path));
+    }
+    // codegen write-all --disable-custom-graphql
+    if (options.transform_ent) {
+        (0, transform_1.transform)(new transform_ent_1.TransformEnt());
+    }
+    if (options.transform_action) {
+        (0, transform_1.transform)(new transform_action_1.TransformAction(customInfo));
+    }
+    // codegen write-all
+}
+main();

package/scripts/read_schema.js

@@ -44,7 +44,21 @@ function main() {
         if (!match) {
             throw new Error(`non-typescript file ${p} returned by glob`);
         }
-        potentialSchemas[(0, pascal_case_1.pascalCase)(match[1])] = require(p).default;
+        let schema = match[1];
+        // convert foo_schema.ts -> foo
+        if (schema.endsWith("_schema")) {
+            schema = schema.slice(0, -7);
+        }
+        let relativePath;
+        const index = p.indexOf("src/schema");
+        if (index !== -1) {
+            relativePath = p.substring(index);
+        }
+        const s = require(p).default;
+        if (relativePath !== undefined) {
+            s.schemaPath = relativePath;
+        }
+        potentialSchemas[(0, pascal_case_1.pascalCase)(schema)] = s;
     }
     //  console.log(potentialSchemas);
     const result = (0, parse_1.parseSchema)(potentialSchemas);

package/testutils/builder.d.ts

@@ -1,14 +1,16 @@
-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";
+import { FieldMap, Schema } from "../schema";
+import { SchemaConfig } from "../schema/base_schema";
+import { FieldInfoMap } from "../schema/schema";
 export declare class User implements Ent {
     viewer: Viewer;
     data: Data;
     id: ID;
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
+    getPrivacyPolicy(): PrivacyPolicy<this>;
     firstName: string;
     constructor(viewer: Viewer, data: Data);
 }
@@ -18,7 +20,7 @@ export declare class Event implements Ent {
     id: ID;
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
+    getPrivacyPolicy(): PrivacyPolicy<this>;
     constructor(viewer: Viewer, data: Data);
 }
 export declare class Contact implements Ent {
@@ -27,7 +29,7 @@ export declare class Contact implements Ent {
     id: ID;
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
+    getPrivacyPolicy(): PrivacyPolicy<this>;
     constructor(viewer: Viewer, data: Data);
 }
 export declare class Group implements Ent {
@@ -36,7 +38,7 @@ export declare class Group implements Ent {
     id: ID;
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
+    getPrivacyPolicy(): PrivacyPolicy<this>;
     constructor(viewer: Viewer, data: Data);
 }
 export declare class Message implements Ent {
@@ -45,7 +47,7 @@ export declare class Message implements Ent {
     id: ID;
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
+    getPrivacyPolicy(): PrivacyPolicy<this>;
     constructor(viewer: Viewer, data: Data);
 }
 export declare class Address implements Ent {
@@ -54,26 +56,34 @@ export declare class Address implements Ent {
     id: ID;
     accountID: string;
     nodeType: string;
-    privacyPolicy: import("../core/base").PrivacyPolicy<Ent>;
+    getPrivacyPolicy(): PrivacyPolicy<this>;
     constructor(viewer: Viewer, data: Data);
 }
 export interface BuilderSchema<T extends Ent> extends Schema {
     ent: EntConstructor<T>;
 }
+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>): 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;
+declare type MaybeNull<T extends Ent> = T | null;
+declare 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: Viewer;
     private schema;
     operation: WriteOperation;
-    existingEnt: T | undefined;
+    existingEnt: TExistingEnt;
     ent: EntConstructor<T>;
     placeholderID: ID;
-    orchestrator: Orchestrator<T, Data>;
+    orchestrator: Orchestrator<T, Data, Viewer>;
     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>>;
+    constructor(viewer: Viewer, schema: BuilderSchema<T>, fields: Map<string, any>, operation: WriteOperation, existingEnt: TExistingEnt, action?: Action<T, SimpleBuilder<T>, Viewer, Data> | undefined);
+    getInput(): Data;
+    updateInput(input: Data): void;
+    build(): Promise<Changeset>;
     editedEnt(): Promise<T | null>;
     editedEntX(): Promise<T>;
     save(): Promise<void>;
@@ -84,18 +94,18 @@ 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);
+    getTriggers(): 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>;
     save(): Promise<T | null>;