Use string for jsonb fields in Record types

kriasoft · Apr 14, 2021 · 229771b · 229771b
1 parent e747f31
commit 229771b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/main.js b/main.js
@@ -100,10 +100,10 @@ async function updateTypes(db, options) {
   }
 }
 
-function toType(c, enums, overrides, record = false) {
+function toType(c, enums, overrides, isRecord = false) {
   var _c$default, _c$default2;
 
-  let type = ["integer", "numeric", "decimal", "bigint"].includes(c.type) ? "number" : c.type === "boolean" ? "boolean" : c.type === "jsonb" ? (_c$default = c.default) !== null && _c$default !== void 0 && _c$default.startsWith("'{") ? "Record<string, unknown>" : (_c$default2 = c.default) !== null && _c$default2 !== void 0 && _c$default2.startsWith("'[") ? "unknown[]" : "unknown" : c.type === "ARRAY" && c.udt === "_text" ? "string[]" : c.type.startsWith("timestamp") || c.type === "date" ? "Date" : "string";
+  let type = ["integer", "numeric", "decimal", "bigint"].includes(c.type) ? "number" : c.type === "boolean" ? "boolean" : c.type === "jsonb" ? isRecord ? "string" : (_c$default = c.default) !== null && _c$default !== void 0 && _c$default.startsWith("'{") ? "Record<string, unknown>" : (_c$default2 = c.default) !== null && _c$default2 !== void 0 && _c$default2.startsWith("'[") ? "unknown[]" : "unknown" : c.type === "ARRAY" && c.udt === "_text" ? "string[]" : c.type.startsWith("timestamp") || c.type === "date" ? "Date" : "string";
 
   if (c.type === "USER-DEFINED") {
     var _enums$find;
@@ -117,9 +117,9 @@ function toType(c, enums, overrides, record = false) {
     }
   }
 
-  if (type === "Date" && record) {
+  if (type === "Date" && isRecord) {
     type = "Date | string";
   }
 
-  return `${record ? "Knex.Raw | " : ""}${type}${c.nullable ? " | null" : ""}`;
+  return `${isRecord ? "Knex.Raw | " : ""}${type}${c.nullable ? " | null" : ""}`;
 }
diff --git a/main.test.ts b/main.test.ts
@@ -80,9 +80,9 @@ test("updateTypes", async function () {
       name_null?: Knex.Raw | string | null;
       roles: Knex.Raw | string[];
       roles_null?: Knex.Raw | string[] | null;
-      credentials?: Knex.Raw | Record<string, unknown>;
-      credentials_null?: Knex.Raw | unknown | null;
-      events?: Knex.Raw | unknown[];
+      credentials?: Knex.Raw | string;
+      credentials_null?: Knex.Raw | string | null;
+      events?: Knex.Raw | string;
       followers: Knex.Raw | number;
       followers_null?: Knex.Raw | number | null;
       created_at: Knex.Raw | Date | string;

diff --git a/main.ts b/main.ts
@@ -146,14 +146,16 @@ function toType(
   c: Column,
   enums: Enum[],
   overrides: Record<string, string>,
-  record = false
+  isRecord = false
 ): string {
   let type = ["integer", "numeric", "decimal", "bigint"].includes(c.type)
     ? "number"
     : c.type === "boolean"
     ? "boolean"
     : c.type === "jsonb"
-    ? c.default?.startsWith("'{")
+    ? isRecord
+      ? "string"
+      : c.default?.startsWith("'{")
       ? "Record<string, unknown>"
       : c.default?.startsWith("'[")
       ? "unknown[]"
@@ -171,9 +173,11 @@ function toType(
     }
   }
 
-  if (type === "Date" && record) {
+  if (type === "Date" && isRecord) {
     type = "Date | string";
   }
 
-  return `${record ? "Knex.Raw | " : ""}${type}${c.nullable ? " | null" : ""}`;
+  return `${isRecord ? "Knex.Raw | " : ""}${type}${
+    c.nullable ? " | null" : ""
+  }`;
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "knex-types",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Generates TypeScript definitions (types) from a (PostgreSQL) database schema.",
   "keywords": [
     "database",