@snowtop/ent 0.1.0-alpha10 → 0.1.0-alpha101

package/schema/schema.d.ts

@@ -1,11 +1,30 @@
 import { Data, Ent, LoaderInfo, PrivacyPolicy, Viewer } from "../core/base";
-import { Builder } from "../action/action";
+import { Builder, Changeset } from "../action/action";
 import { Clause } from "../core/clause";
+import { AssocEdgeInput } from "../core/ent";
 export declare type FieldMap = {
     [key: string]: Field;
 };
+interface FieldInfo {
+    dbCol: string;
+    inputKey: string;
+}
+export type FieldInfoMap = {
+    [key: string]: FieldInfo;
+};
+export interface GlobalSchema {
+    edges?: Edge[];
+    extraEdgeFields?: FieldMap;
+    transformEdgeRead?: () => Clause;
+    transformEdgeWrite?: (stmt: EdgeUpdateOperation) => TransformedEdgeUpdateOperation | null;
+}
+type FieldOverride = Pick<FieldOptions, "nullable" | "storageKey" | "serverDefault" | "unique" | "hideFromGraphQL" | "graphqlName" | "index">;
+export type FieldOverrideMap = {
+    [key: string]: FieldOverride;
+};
 export default interface Schema {
-    fields: FieldMap | Field[];
+    fields: FieldMap;
+    fieldOverrides?: FieldOverrideMap;
     tableName?: string;
     patterns?: Pattern[];
     edges?: Edge[];
@@ -54,17 +73,19 @@ export interface AssocEdgeGroup {
     tableName?: string;
     assocEdges: AssocEdge[];
     statusEnums?: string[];
-    nullStates: string | string[];
+    viewerBased?: boolean;
+    nullStates?: string | string[];
     nullStateFn?: string;
     edgeAction?: EdgeGroupAction;
 }
-export declare type Edge = AssocEdge;
+export type Edge = AssocEdge;
 export interface Pattern {
     name: string;
-    fields: FieldMap | Field[];
+    fields: FieldMap;
+    disableMixin?: boolean;
     edges?: Edge[];
     transformRead?: () => Clause;
-    transformWrite?: <T extends Ent>(stmt: UpdateOperation<T>) => TransformedUpdateOperation<T> | undefined;
+    transformWrite?: <T extends Ent<TViewer>, TViewer extends Viewer = Viewer>(stmt: UpdateOperation<T, TViewer>) => TransformedUpdateOperation<T, TViewer> | null;
     transformsDelete?: boolean;
     transformsInsert?: boolean;
     transformsUpdate?: boolean;
@@ -74,16 +95,25 @@ export declare enum SQLStatementOperation {
     Update = "update",
     Delete = "delete"
 }
-export interface UpdateOperation<T extends Ent> {
+export interface EdgeUpdateOperation {
+    op: SQLStatementOperation;
+    edge: AssocEdgeInput;
+}
+export interface TransformedEdgeUpdateOperation {
     op: SQLStatementOperation;
-    existingEnt?: T;
-    viewer: Viewer;
+    data?: Data;
+}
+export interface UpdateOperation<TEnt extends Ent<TViewer>, TViewer extends Viewer = Viewer> {
+    op: SQLStatementOperation;
+    builder: Builder<TEnt, TViewer, any>;
+    input: Data;
     data?: Map<string, any>;
 }
-export interface TransformedUpdateOperation<T extends Ent> {
+export interface TransformedUpdateOperation<T extends Ent<TViewer>, TViewer extends Viewer = Viewer> {
     op: SQLStatementOperation;
     data?: Data;
-    existingEnt?: T;
+    existingEnt?: T | null;
+    changeset?(): Promise<Changeset> | Changeset;
 }
 export declare enum DBType {
     UUID = "UUID",
@@ -99,6 +129,7 @@ export declare enum DBType {
     JSONB = "JSONB",
     Enum = "Enum",
     StringEnum = "StringEnum",
+    IntEnum = "IntEnum",
     Date = "Date",
     Time = "Time",
     Timetz = "Timetz",
@@ -109,9 +140,16 @@ export interface ImportType {
     type: string;
     [x: string]: any;
 }
+export interface ConvertType {
+    path: string;
+    function: string;
+}
 declare type EnumMap = {
     [key: string]: string;
 };
+declare type IntEnumMap = {
+    [key: string]: number;
+};
 export interface Type {
     dbType: DBType;
     listElemType?: Type;
@@ -119,9 +157,13 @@ export interface Type {
     graphQLType?: string;
     values?: string[];
     enumMap?: EnumMap;
+    intEnumMap?: IntEnumMap;
+    deprecatedIntEnumMap?: IntEnumMap;
+    disableUnknownType?: boolean;
     importType?: ImportType;
     subFields?: FieldMap;
     unionFields?: FieldMap;
+    [x: string]: any;
 }
 export interface ForeignKey {
     schema: string;
@@ -129,8 +171,9 @@ export interface ForeignKey {
     name?: string;
     disableIndex?: boolean;
     disableBuilderType?: boolean;
+    [x: string]: any;
 }
-declare type getLoaderInfoFn = (type: string) => LoaderInfo;
+type getLoaderInfoFn = (type: string) => LoaderInfo;
 export interface InverseFieldEdge {
     name: string;
     edgeConstName?: string;
@@ -144,13 +187,16 @@ export interface FieldEdge {
     getLoaderInfoFromSchema?: getLoaderInfoFn;
     disableBuilderType?: boolean;
 }
+interface PrivateOptions {
+    exposeToActions?: boolean;
+}
 export interface FieldOptions {
     nullable?: boolean;
     storageKey?: string;
     serverDefault?: any;
     unique?: boolean;
     hideFromGraphQL?: boolean;
-    private?: boolean;
+    private?: boolean | PrivateOptions;
     sensitive?: boolean;
     graphqlName?: string;
     index?: boolean;
@@ -166,34 +212,43 @@ export interface FieldOptions {
     polymorphic?: boolean | PolymorphicOptions;
     privacyPolicy?: PrivacyPolicy | (() => PrivacyPolicy);
     getDerivedFields?(name: string): FieldMap;
+    convert?: ConvertType;
+    fetchOnDemand?: boolean;
+    dbOnly?: boolean;
     [x: string]: any;
 }
 export interface PolymorphicOptions {
+    name?: string;
     types?: string[];
     hideFromInverseGraphQL?: boolean;
     disableBuilderType?: boolean;
+    serverDefault?: any;
 }
 export interface Field extends FieldOptions {
     type: Type;
     valid?(val: any): Promise<boolean> | boolean;
+    validateWithFullData?(val: any, builder: Builder<any>): boolean | Promise<boolean>;
     format?(val: any, nested?: boolean): any;
     logValue(val: any): any;
 }
 export interface SchemaConstructor {
     new (): Schema;
 }
-export declare type SchemaInputType = Schema | SchemaConstructor;
+export type SchemaInputType = Schema | SchemaConstructor;
 export declare function getSchema(value: SchemaInputType): Schema;
 export declare function getFields(value: SchemaInputType): Map<string, Field>;
+/**
+ * @deprecated should only be used by tests
+ */
 export declare function getStorageKey(field: Field, fieldName: string): string;
-export declare function getFieldsWithPrivacy(value: SchemaInputType): Map<string, PrivacyPolicy>;
+export declare function getFieldsWithPrivacy(value: SchemaInputType, fieldMap: FieldInfoMap): Map<string, PrivacyPolicy>;
 export declare function getTransformedReadClause(value: SchemaInputType): Clause | undefined;
 interface objectLoaderOptions {
     clause?: () => Clause | undefined;
     instanceKey?: string;
 }
 export declare function getObjectLoaderProperties(value: SchemaInputType, tableName: string): objectLoaderOptions | undefined;
-export declare function getTransformedUpdateOp<T extends Ent>(value: SchemaInputType, stmt: UpdateOperation<T>): TransformedUpdateOperation<T> | undefined;
+export declare function getTransformedUpdateOp<TEnt extends Ent<TViewer>, TViewer extends Viewer>(value: SchemaInputType, stmt: UpdateOperation<TEnt, TViewer>): TransformedUpdateOperation<TEnt> | null;
 export declare enum ActionOperation {
     Create = 1,
     Edit = 2,
@@ -203,8 +258,8 @@ export declare enum ActionOperation {
     RemoveEdge = 32,
     EdgeGroup = 64
 }
-declare type actionFieldType = "ID" | "Boolean" | "Int" | "Float" | "String" | "Time" | "Object";
-declare type NullableListOptions = "contents" | "contentsAndList";
+type actionFieldType = "ID" | "Boolean" | "Int" | "Float" | "String" | "Time" | "Object";
+type NullableListOptions = "contents" | "contentsAndList";
 export interface ActionField {
     name: string;
     type: actionFieldType;
@@ -212,6 +267,8 @@ export interface ActionField {
     list?: boolean;
     actionName?: string;
     excludedFields?: string[];
+    hideFromGraphQL?: boolean;
+    [x: string]: any;
 }
 export interface Action {
     operation: ActionOperation;
@@ -225,6 +282,7 @@ export interface Action {
     optionalFields?: string[];
     requiredFields?: string[];
     noFields?: boolean;
+    [x: string]: any;
 }
 export declare const NoFields = "__NO_FIELDS__";
 export declare function requiredField(field: string): string;
@@ -235,6 +293,7 @@ export interface Constraint {
     columns: string[];
     fkey?: ForeignKeyInfo;
     condition?: string;
+    [x: string]: any;
 }
 export interface FullTextWeight {
     A?: string[];
@@ -248,17 +307,21 @@ export interface FullText {
     languageColumn?: string;
     indexType?: "gin" | "gist";
     weights?: FullTextWeight;
+    [x: string]: any;
 }
 export interface Index {
     name: string;
     columns: string[];
     unique?: boolean;
     fulltext?: FullText;
+    indexType?: "gin" | "btree";
+    [x: string]: any;
 }
 export interface ForeignKeyInfo {
     tableName: string;
     ondelete?: "RESTRICT" | "CASCADE" | "SET NULL" | "SET DEFAULT" | "NO ACTION";
     columns: string[];
+    [x: string]: any;
 }
 export declare enum ConstraintType {
     PrimaryKey = "primary",

package/schema/schema.js

@@ -35,6 +35,7 @@ var DBType;
     DBType["JSONB"] = "JSONB";
     DBType["Enum"] = "Enum";
     DBType["StringEnum"] = "StringEnum";
+    DBType["IntEnum"] = "IntEnum";
     DBType["Date"] = "Date";
     DBType["Time"] = "Time";
     DBType["Timetz"] = "Timetz";
@@ -55,21 +56,11 @@ exports.getSchema = getSchema;
 function getFields(value) {
     const schema = getSchema(value);
     function addFields(fields) {
-        if (Array.isArray(fields)) {
-            for (const field of fields) {
-                const name = field.name;
-                if (!name) {
-                    throw new Error(`name required`);
-                }
-                if (field.getDerivedFields !== undefined) {
-                    addFields(field.getDerivedFields(name));
-                }
-                m.set(name, field);
-            }
-            return;
-        }
         for (const name in fields) {
             const field = fields[name];
+            if (field.dbOnly) {
+                continue;
+            }
             if (field.getDerivedFields !== undefined) {
                 addFields(field.getDerivedFields(name));
             }
@@ -86,12 +77,15 @@ function getFields(value) {
     return m;
 }
 exports.getFields = getFields;
+/**
+ * @deprecated should only be used by tests
+ */
 function getStorageKey(field, fieldName) {
     return field.storageKey || (0, snake_case_1.snakeCase)(fieldName);
 }
 exports.getStorageKey = getStorageKey;
 // returns a mapping of storage key to field privacy
-function getFieldsWithPrivacy(value) {
+function getFieldsWithPrivacy(value, fieldMap) {
     const schema = getSchema(value);
     function addFields(fields) {
         if (Array.isArray(fields)) {
@@ -111,9 +105,14 @@ function getFieldsWithPrivacy(value) {
                     else {
                         privacyPolicy = field.privacyPolicy;
                     }
-                    m.set(getStorageKey(field, name), privacyPolicy);
+                    const info = fieldMap[name];
+                    if (!info) {
+                        throw new Error(`field with name ${name} not passed in fieldMap`);
+                    }
+                    m.set(info.dbCol, privacyPolicy);
                 }
             }
+            return;
         }
         for (const name in fields) {
             const field = fields[name];
@@ -128,7 +127,11 @@ function getFieldsWithPrivacy(value) {
                 else {
                     privacyPolicy = field.privacyPolicy;
                 }
-                m.set(getStorageKey(field, name), privacyPolicy);
+                const info = fieldMap[name];
+                if (!info) {
+                    throw new Error(`field with name ${name} not passed in fieldMap`);
+                }
+                m.set(info.dbCol, privacyPolicy);
             }
         }
     }
@@ -167,13 +170,14 @@ exports.getObjectLoaderProperties = getObjectLoaderProperties;
 function getTransformedUpdateOp(value, stmt) {
     const schema = getSchema(value);
     if (!schema.patterns) {
-        return;
+        return null;
     }
     for (const p of schema.patterns) {
         if (p.transformWrite) {
             return p.transformWrite(stmt);
         }
     }
+    return null;
 }
 exports.getTransformedUpdateOp = getTransformedUpdateOp;
 // this maps to ActionOperation in ent/action.go
@@ -197,6 +201,9 @@ var ActionOperation;
     // RemoveEdge is used to provide the ability to remove an edge in an AssociationEdge.
     ActionOperation[ActionOperation["RemoveEdge"] = 32] = "RemoveEdge";
     // EdgeGroup is used to provide the ability to edit an edge group in an AssociationEdgeGroup.
+    // if you want to clear this edge group e.g. any set edge with id1 and id2,
+    // you should create a custom action that takes the id as an action only field,
+    // and then calls `clearEdgeTypeInGroup` in a trigger to clear
     ActionOperation[ActionOperation["EdgeGroup"] = 64] = "EdgeGroup";
 })(ActionOperation = exports.ActionOperation || (exports.ActionOperation = {}));
 // sentinel that indicates an action has no fields

package/schema/struct_field.d.ts

@@ -6,12 +6,22 @@ export interface StructOptions extends FieldOptions {
     graphQLType?: string;
     jsonNotJSONB?: boolean;
 }
+interface allStructOptions extends StructOptions {
+    jsonAsList?: boolean;
+}
 export declare class StructField extends BaseField implements Field {
     private options;
     type: Type;
-    constructor(options: StructOptions);
+    constructor(options: allStructOptions);
+    formatImpl(obj: any, nested?: boolean): string | Object;
     format(obj: any, nested?: boolean): string | Object;
+    private validImpl;
     valid(obj: any): Promise<boolean>;
 }
 export declare function StructType(options: StructOptions): StructField & StructOptions;
+/**
+ * @deprecated use StructTypeAsList
+ */
 export declare function StructListType(options: StructOptions): ListField;
+export declare function StructTypeAsList(options: allStructOptions): StructField & allStructOptions;
+export {};

package/schema/struct_field.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StructListType = exports.StructType = exports.StructField = void 0;
+exports.StructTypeAsList = exports.StructListType = exports.StructType = exports.StructField = void 0;
+const camel_case_1 = require("camel-case");
 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();
@@ -17,28 +17,31 @@ class StructField extends field_1.BaseField {
         if (options.jsonNotJSONB) {
             this.type.dbType = schema_1.DBType.JSON;
         }
+        if (options?.jsonAsList) {
+            this.type.listElemType = {
+                dbType: schema_1.DBType.JSONB,
+            };
+        }
     }
-    // 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) {
+    formatImpl(obj, nested) {
         if (!(obj instanceof Object)) {
             throw new Error("valid was not called");
         }
         let ret = {};
         for (const k in this.options.fields) {
+            const field = this.options.fields[k];
+            // check two values
+            // store in dbKey format
             // 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;
+            let dbKey = (0, schema_1.getStorageKey)(field, k);
+            let camelKey = (0, camel_case_1.camelCase)(k);
+            let val = obj[camelKey];
+            if (val === undefined && obj[dbKey] !== undefined) {
+                val = obj[dbKey];
             }
             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);
@@ -47,13 +50,23 @@ class StructField extends field_1.BaseField {
                 ret[dbKey] = val;
             }
         }
-        // don't json.stringify if nested
+        // don't json.stringify if nested or list
         if (nested) {
             return ret;
         }
         return JSON.stringify(ret);
     }
-    async valid(obj) {
+    format(obj, nested) {
+        if (Array.isArray(obj) && this.options.jsonAsList) {
+            const ret = obj.map((v) => this.formatImpl(v, true));
+            if (nested) {
+                return ret;
+            }
+            return JSON.stringify(ret);
+        }
+        return this.formatImpl(obj, nested);
+    }
+    async validImpl(obj) {
         if (!(obj instanceof Object)) {
             return false;
         }
@@ -63,12 +76,11 @@ class StructField extends field_1.BaseField {
         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;
+            let dbKey = (0, schema_1.getStorageKey)(field, k);
+            let camelKey = (0, camel_case_1.camelCase)(k);
+            let val = obj[camelKey];
+            if (val === undefined && obj[dbKey] !== undefined) {
+                val = obj[dbKey];
             }
             if (val === undefined || val === null) {
                 // nullable, nothing to do here
@@ -89,6 +101,19 @@ class StructField extends field_1.BaseField {
         const ret = await Promise.all(promises);
         return ret.every((v) => v);
     }
+    async valid(obj) {
+        if (this.options.jsonAsList) {
+            if (!Array.isArray(obj)) {
+                return false;
+            }
+            const valid = await Promise.all(obj.map((v) => this.validImpl(v)));
+            return valid.every((b) => b);
+        }
+        if (!(obj instanceof Object)) {
+            return false;
+        }
+        return this.validImpl(obj);
+    }
 }
 exports.StructField = StructField;
 function StructType(options) {
@@ -96,7 +121,18 @@ function StructType(options) {
     return Object.assign(result, options);
 }
 exports.StructType = StructType;
+/**
+ * @deprecated use StructTypeAsList
+ */
 function StructListType(options) {
     return new field_1.ListField(StructType(options), options);
 }
 exports.StructListType = StructListType;
+function StructTypeAsList(options) {
+    let result = new StructField({
+        ...options,
+        jsonAsList: true,
+    });
+    return Object.assign(result, options);
+}
+exports.StructTypeAsList = StructTypeAsList;

package/scripts/custom_compiler.js

@@ -2,7 +2,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -193,7 +197,7 @@ class Compiler {
                     }
                     relPath = path.relative(
                     // just because of how imports work. it's relative from directory not current path
-                    path.dirname(fullPath), path.join(text.substr(0, idx).replace(r, str.substr(0, strIdx)), text.substr(idx)));
+                    path.dirname(fullPath), path.join(text.substring(0, idx).replace(r, str.substring(0, strIdx)), text.substring(idx)));
                     // if file ends with "..", we've reached a case where we're trying to
                     // import something like foo/contact(.ts) from within foo/contact/bar/baz/page.ts
                     // and we're confused about it so we need to detect that case and handle it
@@ -204,7 +208,7 @@ class Compiler {
                             let text2 = text + ".ts";
                             relPath = path.relative(
                             // just because of how imports work. it's relative from directory not current path
-                            path.dirname(fullPath), path.join(text2.substr(0, idx).replace(r, str.substr(0, strIdx)), text2.substr(idx)));
+                            path.dirname(fullPath), path.join(text2.substring(0, idx).replace(r, str.substring(0, strIdx)), text2.substring(idx)));
                         }
                     }
                     if (!relPath.startsWith("..")) {
@@ -213,7 +217,7 @@ class Compiler {
                     // tsc removes this by default so we need to also do it
                     let tsIdx = relPath.indexOf(".ts");
                     if (tsIdx !== -1) {
-                        relPath = relPath.substr(0, tsIdx);
+                        relPath = relPath.substring(0, tsIdx);
                     }
                     return relPath;
                 }
@@ -225,7 +229,7 @@ class Compiler {
                     let relPath = checkPath(paths, text);
                     if (relPath) {
                         // update the node...
-                        return typescript_1.default.updateImportDeclaration(importNode, importNode.decorators, importNode.modifiers, importNode.importClause, typescript_1.default.createLiteral(relPath));
+                        return typescript_1.default.factory.updateImportDeclaration(importNode, importNode.decorators, importNode.modifiers, importNode.importClause, typescript_1.default.factory.createStringLiteral(relPath), importNode.assertClause);
                     }
                 }
                 if (node.kind === typescript_1.default.SyntaxKind.ExportDeclaration) {
@@ -235,7 +239,7 @@ class Compiler {
                         let relPath = checkPath(paths, text);
                         if (relPath) {
                             // update the node...
-                            return typescript_1.default.updateExportDeclaration(exportNode, exportNode.decorators, exportNode.modifiers, exportNode.exportClause, typescript_1.default.createLiteral(relPath), exportNode.isTypeOnly);
+                            return typescript_1.default.updateExportDeclaration(exportNode, exportNode.decorators, exportNode.modifiers, exportNode.exportClause, typescript_1.default.factory.createStringLiteral(relPath), exportNode.isTypeOnly);
                         }
                     }
                 }