joist-codegen 0.1.536 → 1.0.0

package/build/utils.js

@@ -3,10 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sortKeys = exports.fail = exports.trueIfResolved = exports.merge = exports.mapSimpleDbType = exports.tableToEntityName = exports.isJoinTable = exports.isEnumTable = exports.isEntityTable = void 0;
+exports.sortKeys = exports.fail = exports.trueIfResolved = exports.merge = exports.mapSimpleDbTypeToTypescriptType = exports.tableToEntityName = exports.isJoinTable = exports.isEnumTable = exports.isEntityTable = exports.assertNever = void 0;
+const change_case_1 = require("change-case");
 const is_plain_object_1 = __importDefault(require("is-plain-object"));
 const pluralize_1 = __importDefault(require("pluralize"));
-const change_case_1 = require("change-case");
+function assertNever(x) {
+    throw new Error("Unexpected object: " + x);
+}
+exports.assertNever = assertNever;
 function isEntityTable(t) {
     const columnNames = t.columns.map((c) => c.name);
     return includesAllOf(columnNames, ["id", "created_at", "updated_at"]);
@@ -31,35 +35,41 @@ function includesAllOf(set, subset) {
 }
 /** Converts `projects` to `Project`. */
 function tableToEntityName(config, table) {
-    let entityName = config.__tableToEntityName[table.name];
+    let entityName = config.__tableToEntityName?.[table.name];
     if (!entityName) {
         const configEntityName = Object.entries(config.entities)
             .filter(([, conf]) => conf.tableName === table.name)
             .map(([entityName]) => entityName)[0];
-        entityName = configEntityName || change_case_1.pascalCase(pluralize_1.default.singular(table.name));
-        config.__tableToEntityName[table.name] = entityName;
+        entityName = configEntityName || (0, change_case_1.pascalCase)(pluralize_1.default.singular(table.name));
+        (config.__tableToEntityName ?? (config.__tableToEntityName = {}))[table.name] = entityName;
     }
     return entityName;
 }
 exports.tableToEntityName = tableToEntityName;
 /** Maps db types, i.e. `int`, to JS types, i.e. `number`. */
-function mapSimpleDbType(dbType) {
+function mapSimpleDbTypeToTypescriptType(dbType) {
     switch (dbType) {
-        case "bool":
+        case "boolean":
             return "boolean";
         case "int":
+        case "numeric":
             return "number";
         case "text":
+        case "citext":
+        case "character varying":
         case "varchar":
+        case "uuid":
             return "string";
-        case "timestamptz":
+        case "timestamp with time zone":
         case "date":
             return "Date";
+        case "jsonb":
+            return "Object";
         default:
-            throw new Error(`Unrecognized type ${dbType}`);
+            assertNever(dbType);
     }
 }
-exports.mapSimpleDbType = mapSimpleDbType;
+exports.mapSimpleDbTypeToTypescriptType = mapSimpleDbTypeToTypescriptType;
 function merge(a, b) {
     return [...a, ...b];
 }
@@ -78,7 +88,7 @@ function sortKeys(o) {
         .sort()
         .reduce((acc, key) => {
         const value = o[key];
-        const newValue = typeof value === "object" && is_plain_object_1.default(value) ? sortKeys(value) : value;
+        const newValue = typeof value === "object" && (0, is_plain_object_1.default)(value) ? sortKeys(value) : value;
         acc[key] = newValue;
         return acc;
     }, {});

package/build/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,sEAA4C;AAG5C,0DAAkC;AAClC,6CAAyC;AAEzC,SAAgB,aAAa,CAAC,CAAQ;IACpC,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,OAAO,aAAa,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;AACxE,CAAC;AAHD,sCAGC;AAED,SAAgB,WAAW,CAAC,CAAQ;IAClC,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,OAAO,aAAa,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAHD,kCAGC;AAED,SAAgB,WAAW,CAAC,CAAQ;IAClC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACtB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACrE,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;IAC7C,MAAM,4BAA4B,GAChC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACtF,OAAO,QAAQ,IAAI,SAAS,IAAI,CAAC,eAAe,IAAI,4BAA4B,CAAC,CAAC;AACpF,CAAC;AARD,kCAQC;AAED,SAAS,aAAa,CAAC,GAAa,EAAE,MAAgB;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;AAC5D,CAAC;AAED,wCAAwC;AACxC,SAAgB,iBAAiB,CAAC,MAAc,EAAE,KAAY;IAC5D,IAAI,UAAU,GAAG,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACxD,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;aACrD,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,IAAI,CAAC;aACnD,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,UAAU,GAAG,gBAAgB,IAAI,wBAAU,CAAC,mBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5E,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;KACrD;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAVD,8CAUC;AAED,6DAA6D;AAC7D,SAAgB,eAAe,CAAC,MAAc;IAC5C,QAAQ,MAAM,EAAE;QACd,KAAK,MAAM;YACT,OAAO,SAAS,CAAC;QACnB,KAAK,KAAK;YACR,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC;QAClB,KAAK,aAAa,CAAC;QACnB,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB;YACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,MAAM,EAAE,CAAC,CAAC;KAClD;AACH,CAAC;AAfD,0CAeC;AAED,SAAgB,KAAK,CAAI,CAAM,EAAE,CAAM;IACrC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACtB,CAAC;AAFD,sBAEC;AAED,0EAA0E;AACnE,KAAK,UAAU,cAAc,CAAC,CAAmB;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,GAAG,EAAE,CAAC,IAAI,EACV,GAAG,EAAE,CAAC,KAAK,CACZ,CAAC;AACJ,CAAC;AALD,wCAKC;AAED,SAAgB,IAAI,CAAC,OAAgB;IACnC,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC;AACvC,CAAC;AAFD,oBAEC;AAED,SAAgB,QAAQ,CAAmB,CAAI;IAC7C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;SAClB,IAAI,EAAE;SACN,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACnB,MAAM,KAAK,GAAG,CAAC,CAAC,GAAc,CAAC,CAAC;QAChC,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,yBAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAE,KAAuB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAChH,GAAG,CAAC,GAAc,CAAC,GAAG,QAAe,CAAC;QACtC,OAAO,GAAG,CAAC;IACb,CAAC,EAAG,EAAe,CAAC,CAAC;AACzB,CAAC;AATD,4BASC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,6CAAyC;AACzC,sEAA4C;AAE5C,0DAAkC;AAIlC,SAAgB,WAAW,CAAC,CAAQ;IAClC,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAAC;AAC7C,CAAC;AAFD,kCAEC;AAED,SAAgB,aAAa,CAAC,CAAQ;IACpC,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,OAAO,aAAa,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;AACxE,CAAC;AAHD,sCAGC;AAED,SAAgB,WAAW,CAAC,CAAQ;IAClC,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,OAAO,aAAa,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAHD,kCAGC;AAED,SAAgB,WAAW,CAAC,CAAQ;IAClC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACtB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACrE,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;IAC7C,MAAM,4BAA4B,GAChC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACtF,OAAO,QAAQ,IAAI,SAAS,IAAI,CAAC,eAAe,IAAI,4BAA4B,CAAC,CAAC;AACpF,CAAC;AARD,kCAQC;AAED,SAAS,aAAa,CAAC,GAAa,EAAE,MAAgB;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;AAC5D,CAAC;AAED,wCAAwC;AACxC,SAAgB,iBAAiB,CAAC,MAAc,EAAE,KAAY;IAC5D,IAAI,UAAU,GAAG,MAAM,CAAC,mBAAmB,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1D,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;aACrD,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,IAAI,CAAC;aACnD,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,UAAU,GAAG,gBAAgB,IAAI,IAAA,wBAAU,EAAC,mBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5E,CAAC,MAAM,CAAC,mBAAmB,KAA1B,MAAM,CAAC,mBAAmB,GAAK,EAAE,EAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;KAC9D;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAVD,8CAUC;AAED,6DAA6D;AAC7D,SAAgB,+BAA+B,CAAC,MAA0B;IACxE,QAAQ,MAAM,EAAE;QACd,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC;QACnB,KAAK,KAAK,CAAC;QACX,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC;QAClB,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,mBAAmB,CAAC;QACzB,KAAK,SAAS,CAAC;QACf,KAAK,MAAM;YACT,OAAO,QAAQ,CAAC;QAClB,KAAK,0BAA0B,CAAC;QAChC,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,OAAO;YACV,OAAO,QAAQ,CAAC;QAClB;YACE,WAAW,CAAC,MAAM,CAAC,CAAC;KACvB;AACH,CAAC;AArBD,0EAqBC;AAED,SAAgB,KAAK,CAAI,CAAM,EAAE,CAAM;IACrC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACtB,CAAC;AAFD,sBAEC;AAED,0EAA0E;AACnE,KAAK,UAAU,cAAc,CAAC,CAAmB;IACtD,OAAO,CAAC,CAAC,IAAI,CACX,GAAG,EAAE,CAAC,IAAI,EACV,GAAG,EAAE,CAAC,KAAK,CACZ,CAAC;AACJ,CAAC;AALD,wCAKC;AAED,SAAgB,IAAI,CAAC,OAAgB;IACnC,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC;AACvC,CAAC;AAFD,oBAEC;AAED,SAAgB,QAAQ,CAAmB,CAAI;IAC7C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;SAClB,IAAI,EAAE;SACN,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACnB,MAAM,KAAK,GAAG,CAAC,CAAC,GAAc,CAAC,CAAC;QAChC,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAA,yBAAa,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAsB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAC9G,GAAG,CAAC,GAAc,CAAC,GAAG,QAAe,CAAC;QACtC,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAc,CAAC,CAAC;AACvB,CAAC;AATD,4BASC"}

package/package.json

@@ -1,28 +1,40 @@
 {
   "name": "joist-codegen",
-  "version": "0.1.536",
+  "version": "1.0.0",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/stephenh/joist-ts.git",
+    "directory": "packages/codegen"
+  },
   "main": "build/index.js",
   "types": "build/index.d.ts",
+  "scripts": {
+    "format": "prettier --write '{schema,migrations,src}/**/*.{ts,js,tsx,jsx,graphql}'"
+  },
+  "files": [
+    "build"
+  ],
   "dependencies": {
     "@types/pluralize": "0.0.29",
     "change-case": "^4.1.1",
-    "knex": "^0.21.4",
     "is-plain-object": "^3.0.1",
-    "pg": "^8.3.0",
-    "pg-structure": "^5.10.13",
+    "joist-utils": "1.0.0-bump",
+    "knex": "^0.95.9",
+    "pg": "^8.7.1",
+    "pg-structure": "^7.13.0",
     "pluralize": "^8.0.0",
-    "ts-poet": "^3.2.2",
-    "joist-utils": "0.1.536"
+    "ts-poet": "^4.8.0"
   },
   "devDependencies": {
-    "@types/jest": "^25.2.1",
-    "@types/node": "^13.13.4",
-    "jest": "^26.1.0",
-    "prettier": "^2.0.5",
-    "ts-jest": "^26.1.1",
-    "ts-node-dev": "^1.0.0-pre.50",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^3.9.5"
+    "@swc/jest": "^0.2.16",
+    "@types/jest": "^26.0.24",
+    "@types/node": "^16.4.10",
+    "jest": "^27.0.6",
+    "prettier": "^2.5.1",
+    "prettier-plugin-organize-imports": "^2.3.4",
+    "ts-node-dev": "^1.1.8",
+    "tsconfig-paths": "^3.10.1",
+    "typescript": "^4.5.2"
   }
 }

package/jest.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  preset: "ts-jest",
-  moduleNameMapper: {
-    "^@src/(.*)": "<rootDir>/src/$1",
-  },
-  // globalSetup: "<rootDir>/src/setupTestEnv.js",
-  testMatch: ["<rootDir>/src/**/*.test.(ts|tsx)"],
-  testEnvironment: "node",
-  maxConcurrency: 1,
-};

package/package.json.bak

@@ -1,28 +0,0 @@
-{
-  "name": "joist-codegen",
-  "version": "0.1.0-bump",
-  "license": "MIT",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "dependencies": {
-    "@types/pluralize": "0.0.29",
-    "change-case": "^4.1.1",
-    "knex": "^0.21.4",
-    "is-plain-object": "^3.0.1",
-    "pg": "^8.3.0",
-    "pg-structure": "^5.10.13",
-    "pluralize": "^8.0.0",
-    "ts-poet": "^3.2.2",
-    "joist-utils": "0.1.0-bump"
-  },
-  "devDependencies": {
-    "@types/jest": "^25.2.1",
-    "@types/node": "^13.13.4",
-    "jest": "^26.1.0",
-    "prettier": "^2.0.5",
-    "ts-jest": "^26.1.1",
-    "ts-node-dev": "^1.0.0-pre.50",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^3.9.5"
-  }
-}

package/src/EntityDbMetadata.test.ts

@@ -1,42 +0,0 @@
-import { defaultConfig } from "./config";
-import { collectionName, EntityDbMetadata, makeEntity } from "./EntityDbMetadata";
-import { tableToEntityName } from "./utils";
-
-const relationDummy: any = { targetTable: { m2oRelations: [] } };
-const configDummy: any = { relationNameOverrides: {} };
-
-describe("EntityDbMetadata", () => {
-  describe("tableToEntityName", () => {
-    it("singularizes the table names", () => {
-      expect(tableToEntityName(defaultConfig, { name: "authors" } as any)).toEqual("Author");
-    });
-
-    it("uses config for the table names", () => {
-      const config = {
-        ...defaultConfig,
-        entities: { Author: { tag: "a", tableName: "TBL_ATHR" } },
-      };
-      expect(tableToEntityName(config, { name: "TBL_ATHR" } as any)).toEqual("Author");
-    });
-  });
-
-  describe("collectionName", () => {
-    it("handles base case", () => {
-      expect(collectionName(configDummy, makeEntity("Author"), makeEntity("Book"), relationDummy).fieldName).toEqual(
-        "books",
-      );
-    });
-
-    it("handles author/mentor", () => {
-      expect(collectionName(configDummy, makeEntity("Author"), makeEntity("Author"), relationDummy).fieldName).toEqual(
-        "authors",
-      );
-    });
-
-    it("handles book/book review", () => {
-      expect(
-        collectionName(configDummy, makeEntity("Book"), makeEntity("BookReview"), relationDummy).fieldName,
-      ).toEqual("reviews");
-    });
-  });
-});

package/src/EntityDbMetadata.ts

@@ -1,322 +0,0 @@
-import { camelCase } from "change-case";
-import { Column, M2MRelation, M2ORelation, O2MRelation, Table } from "pg-structure";
-import { plural, singular } from "pluralize";
-import { imp } from "ts-poet";
-import { SymbolSpec } from "ts-poet/build/SymbolSpecs";
-import { Config, isAsyncDerived, isDerived, isProtected, ormMaintainedFields, relationName } from "./config";
-import { ColumnMetaData } from "./generateEntityCodegenFile";
-import { isEnumTable, isJoinTable, mapSimpleDbType, tableToEntityName } from "./utils";
-
-// TODO Populate from config
-const columnCustomizations: Record<string, ColumnMetaData> = {};
-
-/** Codegen-time metadata about a given domain entity. */
-export type Entity = {
-  name: string;
-  /** The symbol pointing to the entity itself. */
-  type: SymbolSpec;
-  /** The name of the entity's runtime metadata const. */
-  metaName: string;
-  /** The symbol pointing to the entity's runtime metadata const. */
-  metaType: SymbolSpec;
-  /** The symbol pointing to the entity's EntityId type. */
-  idType: SymbolSpec;
-  /** The symbol pointing to the entity's Order type. */
-  orderType: SymbolSpec;
-  /** The symbol pointing to the entity's config const. */
-  configConst: SymbolSpec;
-  optsType: SymbolSpec;
-};
-
-export type PrimitiveField = {
-  fieldName: string;
-  columnName: string;
-  columnType: string;
-  columnDefault: number | boolean | string | null;
-  fieldType: string | SymbolSpec;
-  notNull: boolean;
-  derived: "orm" | "sync" | "async" | false;
-  protected: boolean;
-};
-
-export type EnumField = {
-  fieldName: string;
-  columnName: string;
-  enumName: string;
-  enumType: SymbolSpec;
-  enumDetailType: SymbolSpec;
-  notNull: boolean;
-};
-
-/** I.e. a `Book.author` reference pointing to an `Author`. */
-export type ManyToOneField = {
-  fieldName: string;
-  columnName: string;
-  otherFieldName: string;
-  otherEntity: Entity;
-  notNull: boolean;
-};
-
-/** I.e. a `Author.books` collection. */
-export type OneToManyField = {
-  fieldName: string;
-  singularName: string;
-  otherEntity: Entity;
-  otherFieldName: string;
-  otherColumnName: string;
-  otherColumnNotNull: boolean;
-};
-
-/** I.e. a `Author.image` reference when `image.author_id` is unique. */
-export type OneToOneField = {
-  fieldName: string;
-  otherEntity: Entity;
-  otherFieldName: string;
-  otherColumnName: string;
-  otherColumnNotNull: boolean;
-};
-
-export type ManyToManyField = {
-  joinTableName: string;
-  fieldName: string;
-  singularName: string;
-  columnName: string;
-  otherEntity: Entity;
-  otherFieldName: string;
-  otherColumnName: string;
-};
-
-/** Adapts the generally-great pg-structure metadata into our specific ORM types. */
-export class EntityDbMetadata {
-  entity: Entity;
-  primitives: PrimitiveField[];
-  enums: EnumField[];
-  manyToOnes: ManyToOneField[];
-  oneToManys: OneToManyField[];
-  oneToOnes: OneToOneField[];
-  manyToManys: ManyToManyField[];
-  tableName: string;
-
-  constructor(config: Config, table: Table) {
-    this.entity = makeEntity(tableToEntityName(config, table));
-    this.primitives = table.columns
-      .filter((c) => !c.isPrimaryKey && !c.isForeignKey)
-      .map((column) => newPrimitive(config, this.entity, column, table));
-    this.enums = table.m2oRelations.filter((r) => isEnumTable(r.targetTable)).map((r) => newEnumField(config, r));
-    this.manyToOnes = table.m2oRelations
-      .filter((r) => !isEnumTable(r.targetTable))
-      .filter((r) => !isMultiColumnForeignKey(r))
-      .map((r) => newManyToOneField(config, this.entity, r));
-    this.oneToManys = table.o2mRelations
-      // ManyToMany join tables also show up as OneToMany tables in pg-structure
-      .filter((r) => !isJoinTable(r.targetTable))
-      .filter((r) => !isMultiColumnForeignKey(r))
-      .filter((r) => !isOneToOneRelation(r))
-      .map((r) => newOneToMany(config, this.entity, r));
-    this.oneToOnes = table.o2mRelations
-      // ManyToMany join tables also show up as OneToMany tables in pg-structure
-      .filter((r) => !isJoinTable(r.targetTable))
-      .filter((r) => !isMultiColumnForeignKey(r))
-      .filter((r) => isOneToOneRelation(r))
-      .map((r) => newOneToOne(config, this.entity, r));
-    this.manyToManys = table.m2mRelations
-      // pg-structure is really loose on what it considers a m2m relationship, i.e. any entity
-      // that has a foreign key to us, and a foreign key to something else, is automatically
-      // considered as a join table/m2m between "us" and "something else". Filter these out
-      // by looking for only true join tables, i.e. tables with only id, fk1, and fk2.
-      .filter((r) => isJoinTable(r.joinTable))
-      .filter((r) => !isMultiColumnForeignKey(r))
-      .map((r) => newManyToManyField(config, this.entity, r));
-    this.tableName = table.name;
-  }
-
-  get name(): string {
-    return this.entity.name;
-  }
-}
-
-function isMultiColumnForeignKey(r: M2ORelation) {
-  return r.foreignKey.columns.length > 1;
-}
-
-function isOneToOneRelation(r: O2MRelation) {
-  // otherColumn will be the images.book_id in the other table
-  const otherColumn = r.foreignKey.columns[0];
-  // r.foreignKey.index is the index on _us_ (i.e. our Book primary key), so look up indexes in the target table
-  const indexes = r.targetTable.columns.find((c) => c.name == otherColumn.name)?.uniqueIndexes || [];
-  // If the column is the only column in an unique index, it's a one-to-one
-  return indexes.find((i) => i.columns.length === 1) !== undefined;
-}
-
-function newPrimitive(config: Config, entity: Entity, column: Column, table: Table): PrimitiveField {
-  const fieldName = camelCase(column.name);
-  const columnName = column.name;
-  return {
-    fieldName,
-    columnName,
-    columnType: column.type.shortName || column.type.name,
-    fieldType: mapType(table.name, columnName, column.type.shortName || column.type.name).fieldType,
-    notNull: column.notNull,
-    columnDefault: column.default,
-    derived: fieldDerived(config, entity, fieldName),
-    protected: isProtected(config, entity, fieldName),
-  };
-}
-
-function fieldDerived(config: Config, entity: Entity, fieldName: string): PrimitiveField["derived"] {
-  if (ormMaintainedFields.includes(fieldName)) {
-    return "orm";
-  } else if (isDerived(config, entity, fieldName)) {
-    return "sync";
-  } else if (isAsyncDerived(config, entity, fieldName)) {
-    return "async";
-  } else {
-    return false;
-  }
-}
-
-function newEnumField(config: Config, r: M2ORelation): EnumField {
-  const column = r.foreignKey.columns[0];
-  const columnName = column.name;
-  const fieldName = camelCase(column.name.replace("_id", ""));
-  const enumName = tableToEntityName(config, r.targetTable);
-  const enumType = imp(`${enumName}@./entities`);
-  const enumDetailType = imp(`${plural(enumName)}@./entities`);
-  const notNull = column.notNull;
-  return { fieldName, columnName, enumName, enumType, enumDetailType, notNull };
-}
-
-function newManyToOneField(config: Config, entity: Entity, r: M2ORelation): ManyToOneField {
-  const column = r.foreignKey.columns[0];
-  const columnName = column.name;
-  const fieldName = referenceName(config, entity, r);
-  const otherEntity = makeEntity(tableToEntityName(config, r.targetTable));
-  const isOneToOne = column.uniqueIndexes.find((i) => i.columns.length === 1) !== undefined;
-  const otherFieldName = isOneToOne
-    ? oneToOneName(config, otherEntity, entity)
-    : collectionName(config, otherEntity, entity, r).fieldName;
-  const notNull = column.notNull;
-  return { fieldName, columnName, otherEntity, otherFieldName, notNull };
-}
-
-function newOneToMany(config: Config, entity: Entity, r: O2MRelation): OneToManyField {
-  const column = r.foreignKey.columns[0];
-  // source == parent i.e. the reference of the foreign key column
-  // target == child i.e. the table with the foreign key column in it
-  const otherEntity = makeEntity(tableToEntityName(config, r.targetTable));
-  const { singularName, fieldName } = collectionName(config, entity, otherEntity, r);
-  const otherFieldName = referenceName(config, otherEntity, r);
-  const otherColumnName = column.name;
-  const otherColumnNotNull = column.notNull;
-  return { fieldName, singularName, otherEntity, otherFieldName, otherColumnName, otherColumnNotNull };
-}
-
-function newOneToOne(config: Config, entity: Entity, r: O2MRelation): OneToOneField {
-  const column = r.foreignKey.columns[0];
-  // source == parent i.e. the reference of the foreign key column
-  // target == child i.e. the table with the foreign key column in it
-  const otherEntity = makeEntity(tableToEntityName(config, r.targetTable));
-  const fieldName = oneToOneName(config, entity, otherEntity);
-  const otherFieldName = referenceName(config, otherEntity, r);
-  const otherColumnName = column.name;
-  const otherColumnNotNull = column.notNull;
-  return { fieldName, otherEntity, otherFieldName, otherColumnName, otherColumnNotNull };
-}
-
-function newManyToManyField(config: Config, entity: Entity, r: M2MRelation): ManyToManyField {
-  const { foreignKey, targetForeignKey, targetTable } = r;
-  const joinTableName = r.joinTable.name;
-  const otherEntity = makeEntity(tableToEntityName(config, targetTable));
-  const fieldName = relationName(
-    config,
-    entity,
-    camelCase(plural(targetForeignKey.columns[0].name.replace("_id", ""))),
-  );
-  const otherFieldName = relationName(
-    config,
-    otherEntity,
-    camelCase(plural(foreignKey.columns[0].name.replace("_id", ""))),
-  );
-  const columnName = foreignKey.columns[0].name;
-  const otherColumnName = targetForeignKey.columns[0].name;
-  const singularName = singular(fieldName);
-  return { joinTableName, fieldName, singularName, columnName, otherEntity, otherFieldName, otherColumnName };
-}
-
-export function oneToOneName(config: Config, entity: Entity, otherEntity: Entity): string {
-  return relationName(config, entity, camelCase(otherEntity.name));
-}
-
-export function referenceName(config: Config, entity: Entity, r: M2ORelation | O2MRelation): string {
-  const column = r.foreignKey.columns[0];
-  const fieldName = camelCase(column.name.replace("_id", ""));
-  return relationName(config, entity, fieldName);
-}
-
-/** Returns the collection name to use on `entity` when referring to `otherEntity`s. */
-export function collectionName(
-  config: Config,
-  entity: Entity,
-  otherEntity: Entity,
-  r: M2ORelation | O2MRelation,
-): { fieldName: string; singularName: string } {
-  // TODO Handle conflicts in names
-  // I.e. if the other side is `child.project_id`, use `children`.
-  let fieldName = otherEntity.name;
-  // check if we have multiple FKs from otherEntity --> entity and prefix with FK name if so
-  const sourceTable = r instanceof M2ORelation ? r.sourceTable : r.targetTable;
-  const targetTable = r instanceof M2ORelation ? r.targetTable : r.sourceTable;
-  if (sourceTable.m2oRelations.filter((r) => r.targetTable === targetTable).length > 1) {
-    fieldName = `${r.foreignKey.columns[0].name.replace("_id", "")}_${fieldName}`;
-  }
-  // If the other side is `book_reviews.book_id`, use `reviews`.
-  if (fieldName.length > entity.name.length) {
-    fieldName = fieldName.replace(entity.name, "");
-  }
-
-  // camelize the name
-  let singularName = camelCase(fieldName);
-  fieldName = camelCase(plural(fieldName));
-
-  // If the name is overridden, use that, but also singularize it
-  const maybeOverriddenName = relationName(config, entity, fieldName);
-  if (maybeOverriddenName !== fieldName) {
-    singularName = singular(maybeOverriddenName);
-    fieldName = maybeOverriddenName;
-  }
-
-  return { singularName, fieldName };
-}
-
-export function makeEntity(entityName: string): Entity {
-  return {
-    name: entityName,
-    type: entityType(entityName),
-    metaName: metaName(entityName),
-    metaType: metaType(entityName),
-    idType: imp(`${entityName}Id@./entities`, { definedIn: `./${entityName}Codegen` }),
-    orderType: imp(`${entityName}Order@./entities`, { definedIn: `./${entityName}Codegen` }),
-    optsType: imp(`${entityName}Opts@./entities`, { definedIn: `./${entityName}Codegen` }),
-    configConst: imp(`${camelCase(entityName)}Config@./entities`, { definedIn: `./${entityName}Codegen` }),
-  };
-}
-
-function metaName(entityName: string): string {
-  return `${camelCase(entityName)}Meta`;
-}
-
-function metaType(entityName: string): SymbolSpec {
-  return imp(`${metaName(entityName)}@./entities`);
-}
-
-function entityType(entityName: string): SymbolSpec {
-  return imp(`${entityName}@./entities`);
-}
-
-function mapType(tableName: string, columnName: string, dbColumnType: string): ColumnMetaData {
-  return (
-    columnCustomizations[`${tableName}.${columnName}`] || {
-      fieldType: mapSimpleDbType(dbColumnType),
-    }
-  );
-}

package/src/assignTags.ts

@@ -1,45 +0,0 @@
-import { snakeCase, camelCase } from "change-case";
-import { DbMetadata } from "./index";
-import { Config } from "./config";
-
-/**
- * Looks for any entities that don't have tags in `config` yet, and guesses at what a good tag would be.
- *
- * The current guess is `BookReview` -> `br`. If that guess is already taken, we use the full entity name,
- * i.e. `bookReview`. The user can then customize the tags as they want directly in `joist-codegen.json`.
- *
- * We also mutate `config` by putting the new tag into the `config`'s entity entry.
- */
-export function assignTags(config: Config, dbMetadata: DbMetadata): void {
-  const existingTags = Object.fromEntries(
-    Object.entries(config.entities).map(([name, conf]) => {
-      return [name, conf.tag];
-    }),
-  );
-
-  const existingTagNames = Object.values(existingTags);
-
-  dbMetadata.entities
-    .filter((e) => !existingTags[e.name])
-    .forEach((e) => {
-      const abbreviatedTag = guessTagName(e.name);
-      const tagName = existingTagNames.includes(abbreviatedTag) ? camelCase(e.name) : abbreviatedTag;
-      const oc = config.entities[e.name];
-      if (!oc) {
-        config.entities[e.name] = { tag: tagName };
-      } else {
-        oc.tag = tagName;
-      }
-      existingTagNames.push(tagName);
-    });
-
-  // TODO ensure tags are unique
-}
-
-/** Abbreviates `BookReview` -> `book_review` -> `br`. */
-function guessTagName(name: string): string {
-  return snakeCase(name)
-    .split("_")
-    .map((w) => w[0])
-    .join("");
-}