@snowtop/ent 0.1.26 → 0.2.0-alpha.1

package/names/names.d.ts

@@ -0,0 +1,10 @@
+export declare function toDBColumnOrTable(...strs: string[]): string;
+export declare function toFilePath(s: string): string;
+export declare function toFieldName(...strs: string[]): string;
+export declare function toClassName(str: string): string;
+interface splitResult {
+    s: string;
+    type: "lower" | "upper" | "digit" | "other";
+}
+export declare function _splitCamelCase(s: string): splitResult[];
+export {};

package/names/names.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._splitCamelCase = exports.toClassName = exports.toFieldName = exports.toFilePath = exports.toDBColumnOrTable = void 0;
+const camel_case_1 = require("camel-case");
+const pascal_case_1 = require("pascal-case");
+const snake_case_1 = require("snake-case");
+// TODO tests and update functionality to match golang
+function toDBColumnOrTable(...strs) {
+    let name = "";
+    for (let i = 0; i < strs.length; i++) {
+        const s = strs[i];
+        // this is to handle userIDs -> user_ids
+        const split = _splitCamelCase(s);
+        if (split.length > 2) {
+            const last = split[split.length - 1];
+            const nextLast = split[split.length - 2];
+            if (last.s === "s" && nextLast.type === "upper") {
+                // get the first n-2 words
+                name += (0, snake_case_1.snakeCase)(split
+                    .map((v) => v.s)
+                    .slice(0, split.length - 2)
+                    .join(""));
+                name += "_";
+                // combine the last two
+                name += (0, snake_case_1.snakeCase)(nextLast.s);
+                name += last.s;
+                continue;
+            }
+        }
+        name += (0, snake_case_1.snakeCase)(s);
+        if (i !== strs.length - 1) {
+            name += "_";
+        }
+    }
+    return name;
+}
+exports.toDBColumnOrTable = toDBColumnOrTable;
+function toFilePath(s) {
+    return (0, snake_case_1.snakeCase)(s);
+}
+exports.toFilePath = toFilePath;
+function toFieldName(...strs) {
+    let name = "";
+    let hasDoneLower = false;
+    for (const s of strs) {
+        // same logic in toDBColumnOrTable
+        const split = _splitCamelCase(s);
+        if (split.length > 2) {
+            const last = split[split.length - 1];
+            const nextLast = split[split.length - 2];
+            if (last.s === "s" && nextLast.type === "upper") {
+                // get the first n-2 words
+                name += (0, camel_case_1.camelCase)(split
+                    .map((v) => v.s)
+                    .slice(0, split.length - 2)
+                    .join(""));
+                // combine the last two
+                name += (0, pascal_case_1.pascalCase)(nextLast.s);
+                name += last.s;
+                hasDoneLower = true;
+                continue;
+            }
+        }
+        if (!hasDoneLower) {
+            name += (0, camel_case_1.camelCase)(s);
+            hasDoneLower = true;
+        }
+        else {
+            name += (0, pascal_case_1.pascalCase)(s);
+        }
+    }
+    return name;
+}
+exports.toFieldName = toFieldName;
+function toClassName(str) {
+    return (0, pascal_case_1.pascalCase)(str);
+}
+exports.toClassName = toClassName;
+function isUpper(s) {
+    for (const c of s) {
+        if (!(c >= "A" && c <= "Z")) {
+            return false;
+        }
+    }
+    return true;
+}
+function isLower(s) {
+    for (const c of s) {
+        if (!(c >= "a" && c <= "z")) {
+            return false;
+        }
+    }
+    return true;
+}
+function isDigit(s) {
+    return /^\d+$/.test(s);
+}
+// ported from golang in internal/names/names.go
+function _splitCamelCase(s) {
+    const results = [];
+    let lastType;
+    let type;
+    for (let i = 0; i < s.length; i++) {
+        const c = s[i];
+        if (isLower(c)) {
+            type = "lower";
+        }
+        else if (isUpper(c)) {
+            type = "upper";
+        }
+        else if (isDigit(c)) {
+            type = "digit";
+        }
+        else {
+            type = "other";
+        }
+        if (lastType == type) {
+            results[results.length - 1].s += c;
+        }
+        else {
+            results.push({ s: c, type });
+        }
+        lastType = type;
+    }
+    // this is for handling the userIDs -> "user", "ID", "s" case
+    const isPlural = function (curr, next) {
+        return curr.length > 1 && next === "s";
+    };
+    for (let i = 0; i < results.length - 1; i++) {
+        if (isUpper(results[i].s[0]) &&
+            isLower(results[i + 1].s[0]) &&
+            !isPlural(results[i].s, results[i + 1].s)) {
+            // get last item from results[i] and add to front of results[i+1]
+            results[i + 1].s =
+                results[i].s[results[i].s.length - 1] + results[i + 1].s;
+            // now has a prefix and is not all of one case
+            results[i + 1].type = "other";
+            // remove last character from results[i]
+            results[i].s = results[i].s.slice(0, results[i].s.length - 1);
+        }
+        else if (isDigit(results[i].s[0]) && isLower(results[i + 1].s[0])) {
+            results[i].s = results[i].s + results[i + 1].s;
+            results[i].type = "other";
+            // remove
+            results[i + 1].s = "";
+            i++;
+        }
+    }
+    for (let i = 0; i < results.length; i++) {
+        if (results[i].s === "") {
+            results.splice(i, 1);
+            i--;
+        }
+    }
+    return results;
+}
+exports._splitCamelCase = _splitCamelCase;

package/package.json

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

package/schema/field.d.ts

@@ -100,7 +100,7 @@ interface PolymorphicStringOptions extends StringOptions {
 }
 export declare class PolymorphicStringField extends StringField {
     private opts;
-    private camelCaseVals;
+    private fieldNameValues;
     constructor(opts: PolymorphicStringOptions);
     validateWithFullData(val: any, b: Builder<any>): boolean;
     valid(val: any): boolean;

package/schema/field.js

@@ -25,7 +25,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UUIDListType = exports.IntegerEnumListType = exports.EnumListType = exports.DateListType = exports.TimetzListType = exports.TimeListType = exports.TimestamptzListType = exports.TimestampListType = exports.BooleanListType = exports.BigIntegerListType = exports.FloatListType = exports.IntegerListType = exports.IntListType = exports.StringListType = exports.ListField = exports.IntegerEnumType = exports.IntegerEnumField = exports.EnumType = exports.StringEnumField = exports.EnumField = exports.DateType = exports.DateField = exports.TimetzType = exports.TimeType = exports.TimeField = exports.leftPad = exports.TimestamptzType = exports.TimestampType = exports.TimestampField = exports.StringType = exports.PolymorphicStringField = exports.StringField = exports.BooleanType = exports.BooleanField = exports.FloatType = exports.FloatField = exports.BigIntegerType = exports.BigIntegerField = exports.IntegerType = exports.IntegerField = exports.NumberField = exports.UUIDType = exports.UUIDField = exports.BaseField = void 0;
 const luxon_1 = require("luxon");
-const camel_case_1 = require("camel-case");
 const types_1 = require("util/types");
 const uuid_1 = require("uuid");
 const base_1 = require("../core/base");
@@ -33,6 +32,7 @@ const db_1 = __importStar(require("../core/db"));
 const schema_1 = require("./schema");
 const global_schema_1 = require("../core/global_schema");
 const logger_1 = require("../core/logger");
+const names_1 = require("../names/names");
 class BaseField {
     logValue(val) {
         if (this.sensitive) {
@@ -328,7 +328,7 @@ class PolymorphicStringField extends StringField {
         super(opts);
         this.opts = opts;
         if (opts.types) {
-            this.camelCaseVals = opts.types.map((v) => (0, camel_case_1.camelCase)(v));
+            this.fieldNameValues = opts.types.map((v) => (0, names_1.toFieldName)(v));
         }
     }
     validateWithFullData(val, b) {
@@ -347,19 +347,19 @@ class PolymorphicStringField extends StringField {
         return true;
     }
     valid(val) {
-        if (!this.camelCaseVals) {
+        if (!this.fieldNameValues) {
             return true;
         }
-        let str = (0, camel_case_1.camelCase)(String(val));
+        let str = (0, names_1.toFieldName)(String(val));
         // allow different cases because it could be coming from different clients who don't have strong typing
-        return this.camelCaseVals.some((value) => value === str);
+        return this.fieldNameValues.some((value) => value === str);
     }
     format(val) {
-        if (!this.camelCaseVals) {
+        if (!this.fieldNameValues) {
             return val;
         }
-        const converted = (0, camel_case_1.camelCase)(String(val));
-        for (const v of this.camelCaseVals) {
+        const converted = (0, names_1.toFieldName)(String(val));
+        for (const v of this.fieldNameValues) {
             if (v === val) {
                 return val;
             }

package/schema/schema.d.ts

@@ -270,9 +270,6 @@ export interface 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, fieldInfoMap: FieldInfoMap): Map<string, PrivacyPolicy>;
 export declare function getFieldsWithEditPrivacy(value: SchemaInputType, fieldInfoMap: FieldInfoMap): Map<string, PrivacyPolicy>;

package/schema/schema.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConstraintType = exports.optionalField = exports.requiredField = exports.NoFields = exports.ActionOperation = exports.getTransformedUpdateOp = exports.getObjectLoaderProperties = exports.getTransformedReadClause = exports.getFieldsForCreateAction = exports.getFieldsWithEditPrivacy = exports.getFieldsWithPrivacy = exports.getStorageKey = exports.getFields = exports.getSchema = exports.DBType = exports.SQLStatementOperation = void 0;
-const snake_case_1 = require("snake-case");
+const names_1 = require("../names/names");
 // we also want this transformation to exist on a per-action basis
 // if it exists on an action, we don't do the global schema transformation
 var SQLStatementOperation;
@@ -79,11 +79,8 @@ 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);
+    return field.storageKey || (0, names_1.toDBColumnOrTable)(fieldName);
 }
 exports.getStorageKey = getStorageKey;
 // returns a mapping of storage key to field privacy

package/schema/struct_field.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 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 global_schema_1 = require("../core/global_schema");
 const logger_1 = require("../core/logger");
+const names_1 = require("../names/names");
 class StructField extends field_1.BaseField {
     constructor(options, jsonAsList) {
         super();
@@ -40,10 +40,14 @@ class StructField extends field_1.BaseField {
             const field = this.options.fields[k];
             // check two values
             // store in dbKey format
-            // TODO more #510
+            // check both fieldName and dbKey and store in dbKey for
+            // serialization to db
+            // we should only have if it in fieldName format for non-tests
+            // but checking for backwards compatibility and to make
+            // sure we don't break anything
             let dbKey = (0, schema_1.getStorageKey)(field, k);
-            let camelKey = (0, camel_case_1.camelCase)(k);
-            let val = obj[camelKey];
+            let fieldName = (0, names_1.toFieldName)(k);
+            let val = obj[fieldName];
             if (val === undefined && obj[dbKey] !== undefined) {
                 val = obj[dbKey];
             }
@@ -114,20 +118,19 @@ class StructField extends field_1.BaseField {
         let valid = true;
         for (const k in this.options.fields) {
             const field = this.options.fields[k];
-            // TODO more #510
             let dbKey = (0, schema_1.getStorageKey)(field, k);
-            let camelKey = (0, camel_case_1.camelCase)(k);
-            let val = obj[camelKey];
+            let fieldName = (0, names_1.toFieldName)(k);
+            let val = obj[fieldName];
             let uniqueKeyField = false;
             if (this.validateUniqueKey !== undefined &&
-                (camelKey === this.validateUniqueKey ||
+                (fieldName === this.validateUniqueKey ||
                     k === this.validateUniqueKey ||
                     dbKey === this.validateUniqueKey)) {
                 // this.validateUniqueKey = camelKey;
                 uniqueKeyField = true;
             }
             if (uniqueKeyField && this.checkUniqueKey) {
-                this.validateUniqueKey = camelKey;
+                this.validateUniqueKey = fieldName;
             }
             if (val === undefined && obj[dbKey] !== undefined) {
                 if (uniqueKeyField && this.checkUniqueKey) {

package/scripts/read_schema.js

@@ -28,10 +28,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const glob = __importStar(require("glob"));
 const path = __importStar(require("path"));
-const pascal_case_1 = require("pascal-case");
 const minimist_1 = __importDefault(require("minimist"));
 const parse_1 = require("../parse_schema/parse");
 const ast_1 = require("../tsc/ast");
+const names_1 = require("../names/names");
 function main() {
     const options = (0, minimist_1.default)(process.argv.slice(2));
     if (!options.path) {
@@ -70,7 +70,7 @@ function main() {
         if (relativePath !== undefined) {
             s.schemaPath = relativePath;
         }
-        potentialSchemas[(0, pascal_case_1.pascalCase)(schema)] = s;
+        potentialSchemas[(0, names_1.toClassName)(schema)] = s;
     }
     //  console.log(potentialSchemas);
     // NB: do not change this to async/await

package/testutils/builder.js

@@ -10,12 +10,11 @@ const action_1 = require("../action");
 const schema_1 = require("../schema");
 const db_mock_1 = require("./db_mock");
 const pluralize_1 = __importDefault(require("pluralize"));
-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");
 const base_schema_1 = require("../schema/base_schema");
 const schema_2 = require("../schema/schema");
+const names_1 = require("../names/names");
 class BaseEnt {
     constructor(viewer, data) {
         this.viewer = viewer;
@@ -157,7 +156,7 @@ function getSchemaName(value) {
 }
 exports.getSchemaName = getSchemaName;
 function getTableName(value) {
-    return (0, pluralize_1.default)((0, snake_case_1.snakeCase)(value.ent.name)).toLowerCase();
+    return (0, pluralize_1.default)((0, names_1.toDBColumnOrTable)(value.ent.name)).toLowerCase();
 }
 exports.getTableName = getTableName;
 const getDbFields = (schema) => {
@@ -217,12 +216,12 @@ class SimpleBuilder {
                 throw new Error(`no id field and multiple fields so can't deduce key. add an id field to schema`);
             }
             for (const [name, _] of fields) {
-                key = (0, snake_case_1.snakeCase)(name);
+                key = (0, names_1.toDBColumnOrTable)(name);
             }
         }
         this.ent = schema.ent;
         const tableName = getTableName(schema);
-        this.nodeType = (0, camel_case_1.camelCase)(schema.ent.name);
+        this.nodeType = (0, names_1.toFieldName)(schema.ent.name);
         const fieldInfo = getFieldInfo(schema);
         this.orchestrator = new orchestrator_1.Orchestrator({
             viewer: this.viewer,
@@ -270,9 +269,8 @@ class SimpleBuilder {
                 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);
+                // TODO: ola 2/18/2024. we may not need both anymore?
+                const sc = (0, names_1.toDBColumnOrTable)(k);
                 if (knownFields.has(sc)) {
                     this.fields.set(sc, input[k]);
                 }

package/testutils/db/temp_db.js

@@ -34,9 +34,9 @@ const better_sqlite3_1 = __importDefault(require("better-sqlite3"));
 const config_1 = require("../../core/config");
 const fs = __importStar(require("fs"));
 const schema_1 = require("../../schema");
-const snake_case_1 = require("snake-case");
 const builder_1 = require("../builder");
 const test_edge_global_schema_1 = require("../test_edge_global_schema");
+const names_1 = require("../../names/names");
 function primaryKey(name, cols) {
     return {
         name: name,
@@ -790,7 +790,7 @@ function storageKey(fieldName, f) {
     if (f.storageKey) {
         return f.storageKey;
     }
-    return (0, snake_case_1.snakeCase)(fieldName);
+    return (0, names_1.toDBColumnOrTable)(fieldName);
 }
 function isSyncClient(client) {
     return client.execSync !== undefined;

package/testutils/fake_data/test_helpers.js

@@ -4,7 +4,6 @@ exports.createAllEvents = exports.tempDBTables = exports.setupTempDB = exports.c
 const jest_date_mock_1 = require("jest-date-mock");
 const viewer_1 = require("../../core/viewer");
 const ent_1 = require("../../core/ent");
-const snake_case_1 = require("snake-case");
 const write_1 = require("../write");
 const temp_db_1 = require("../db/temp_db");
 const _1 = require(".");
@@ -15,6 +14,7 @@ const builder_1 = require("../builder");
 const action_1 = require("../../action");
 const fake_tag_1 = require("./fake_tag");
 const db_1 = require("../../core/db");
+const names_1 = require("../../names/names");
 function getContactInput(user, input) {
     return {
         firstName: "Jon",
@@ -190,7 +190,7 @@ async function createEdges() {
         await (0, write_1.createRowForTest)({
             tableName: "assoc_edge_config",
             fields: {
-                edge_table: (0, snake_case_1.snakeCase)(`${edge}_table`),
+                edge_table: (0, names_1.toDBColumnOrTable)(edge, "table"),
                 symmetric_edge: _1.SymmetricEdges.has(edge),
                 inverse_edge_type: _1.InverseEdges.get(edge) || null,
                 edge_type: edge,
@@ -206,7 +206,7 @@ async function createEdges() {
 exports.createEdges = createEdges;
 function edgeTableNames() {
     const edges = Object.values(_1.EdgeType);
-    return edges.map((edge) => (0, snake_case_1.snakeCase)(`${edge}_table`));
+    return edges.map((edge) => (0, names_1.toDBColumnOrTable)(edge, "table"));
 }
 exports.edgeTableNames = edgeTableNames;
 async function createTestEvent(user, input) {

package/testutils/soft_delete.js

@@ -33,8 +33,6 @@ class DeletedAtPattern {
     constructor() {
         this.name = "deleted_at";
         this.fields = {
-            // need this to be lowerCamelCase because we do this based on field name
-            // #510
             deletedAt: (0, field_1.TimestampType)({
                 nullable: true,
                 index: true,
@@ -95,8 +93,6 @@ class DeletedAtPatternWithExtraWrites {
     constructor() {
         this.name = "deleted_at";
         this.fields = {
-            // need this to be lowerCamelCase because we do this based on field name
-            // #510
             deletedAt: (0, field_1.TimestampType)({
                 nullable: true,
                 index: true,

package/testutils/test_edge_global_schema.js

@@ -36,8 +36,6 @@ class EdgeWithDeletedAt extends ent_1.AssocEdge {
 exports.EdgeWithDeletedAt = EdgeWithDeletedAt;
 exports.testEdgeGlobalSchema = {
     extraEdgeFields: {
-        // need this to be lowerCamelCase because we do this based on field name
-        // #510
         deletedAt: (0, schema_1.TimestampType)({
             nullable: true,
             index: true,

package/tsc/transform_action.js

@@ -31,7 +31,7 @@ const typescript_1 = __importDefault(require("typescript"));
 const ast_1 = require("../tsc/ast");
 const viewer_1 = require("../core/viewer");
 const path = __importStar(require("path"));
-const snake_case_1 = require("snake-case");
+const names_1 = require("../names/names");
 // returns input and importPath
 function getBaseFileInfo(file, classInfo, sourceFile) {
     // @ts-ignore
@@ -155,7 +155,7 @@ class TransformAction {
                 klassContents += mm.getFullText(sourceFile);
             }
         }
-        const builderPath = `src/ent/generated/${(0, snake_case_1.snakeCase)(nodeName)}/actions/${(0, snake_case_1.snakeCase)(builder)}`;
+        const builderPath = `src/ent/generated/${(0, names_1.toFilePath)(nodeName)}/actions/${(0, names_1.toFilePath)(builder)}`;
         let imports = new Map([
             [
                 (0, ast_1.transformRelative)(file, this.customInfo.viewerInfo.path, this.customInfo.relativeImports),