main.js.map

{"version":3,"file":"main.js","names":["updateTypes","db","options","overrides","output","fs","createWriteStream","encoding","forEach","line","write","schema","split","map","x","trim","includeSchemas","excludeSchemas","reduce","acc","s","startsWith","push","exclude","prefix","enums","table","join","orderBy","select","i","key","enumName","value","replace","enumsMap","Map","columns","withSchema","whereIn","whereNotIn","raw","tableSet","Set","Array","from","tableName","schemaName","type","getType","udt","substring","default","nullable","sanitize","column","suffix","end","destroy","customTypes","defaultValue","get","name","test","JSON","stringify"],"sources":["main.ts"],"sourcesContent":["/* SPDX-FileCopyrightText: 2016-present Kriasoft <hello@kriasoft.com> */\n/* SPDX-License-Identifier: MIT */\n\nimport fs from \"fs\";\nimport { Knex } from \"knex\";\nimport { camelCase, upperFirst } from \"lodash\";\nimport type { Writable } from \"stream\";\n\nexport type Options = {\n  /**\n   * Filename or output stream where the type definitions needs to be written.\n   */\n  output: Writable | string;\n\n  /**\n   * Name overrides for enums, classes, and fields.\n   *\n   * @example\n   *   overrides: {\n   *     \"identity_provider.linkedin\": \"LinkedIn\"\n   *   }\n   */\n  overrides?: Record<string, string>;\n\n  prefix?: string;\n  suffix?: string;\n\n  /**\n   * Schemas that should be included/excluded when generating types.\n   *\n   * By default if this is null/not specified, \"public\" will be the only schema added, but if this property\n   * is specified, public will be excluded by default and has to be included in the list to be added to the output.\n   * If a schema is added by its name, i.e. 'log' all tables from that schema will be added.\n   * If a schema name is added with an exclamation mark it will be ignored, i.e. \"!log\".\n   *\n   * The table-type will be prefixed by its schema name, the table log.message will become LogMessage.\n   *\n   * @example\n   *   // This will include \"public\" and \"log\", but exclude the \"auth\" schema.\n   *   schema: [\"public\", \"log\", \"!auth\"]\n   * @default\n   *   \"public\"\n   */\n  schema?: string[] | string;\n\n  /**\n   * A comma separated list or an array of tables that should be excluded when\n   * generating types.\n   *\n   * @example\n   *   exclude: [\"migration\", \"migration_lock\"]\n   */\n  exclude?: string[] | string;\n};\n\n/**\n * Generates TypeScript definitions (types) from a PostgreSQL database schema.\n */\nexport async function updateTypes(db: Knex, options: Options): Promise<void> {\n  const overrides: Record<string, string> = options.overrides ?? {};\n  const output: Writable =\n    typeof options.output === \"string\"\n      ? fs.createWriteStream(options.output, { encoding: \"utf-8\" })\n      : options.output;\n\n  [\n    \"// The TypeScript definitions below are automatically generated.\\n\",\n    \"// Do not touch them, or risk, your modifications being lost.\\n\\n\",\n  ].forEach((line) => output.write(line));\n\n  const schema = (typeof options.schema === \"string\"\n    ? options.schema.split(\",\").map((x) => x.trim())\n    : options.schema) ?? [\"public\"];\n\n  // Schemas to include or exclude\n  const [includeSchemas, excludeSchemas] = schema.reduce(\n    (acc, s) =>\n      (acc[+s.startsWith(\"!\")].push(s) && acc) as [string[], string[]],\n    [[] as string[], [] as string[]]\n  );\n\n  // Tables to exclude\n  const exclude =\n    (typeof options.exclude === \"string\"\n      ? options.exclude.split(\",\").map((x) => x.trim())\n      : options.exclude) ?? [];\n\n  if (options.prefix) {\n    output.write(options.prefix);\n    output.write(\"\\n\\n\");\n  }\n\n  try {\n    // Fetch the list of custom enum types\n    const enums = await db\n      .table(\"pg_type\")\n      .join(\"pg_enum\", \"pg_enum.enumtypid\", \"pg_type.oid\")\n      .orderBy(\"pg_type.typname\")\n      .orderBy(\"pg_enum.enumsortorder\")\n      .select<Enum[]>(\"pg_type.typname as key\", \"pg_enum.enumlabel as value\");\n\n    // Construct TypeScript enum types\n    enums.forEach((x, i) => {\n      // The first line of enum declaration\n      if (!(enums[i - 1] && enums[i - 1].key === x.key)) {\n        const enumName = overrides[x.key] ?? upperFirst(camelCase(x.key));\n        output.write(`export enum ${enumName} {\\n`);\n      }\n\n      // Enum body\n      const key =\n        overrides[`${x.key}.${x.value}`] ??\n        upperFirst(camelCase(x.value.replace(/[.-]/g, \"_\")));\n      output.write(`  ${key} = \"${x.value}\",\\n`);\n\n      // The closing line\n      if (!(enums[i + 1] && enums[i + 1].key === x.key)) {\n        output.write(\"}\\n\\n\");\n      }\n    });\n\n    const enumsMap = new Map(\n      enums.map((x) => [\n        x.key,\n        overrides[x.key] ?? upperFirst(camelCase(x.key)),\n      ])\n    );\n\n    // Fetch the list of tables/columns\n    const columns = await db\n      .withSchema(\"information_schema\")\n      .table(\"columns\")\n      .whereIn(\"table_schema\", includeSchemas)\n      .whereNotIn(\"table_schema\", excludeSchemas)\n      .whereNotIn(\"table_name\", exclude)\n      .orderBy(\"table_schema\")\n      .orderBy(\"table_name\")\n      .orderBy(\"ordinal_position\")\n      .select<Column[]>(\n        \"table_schema as schema\",\n        \"table_name as table\",\n        \"column_name as column\",\n        db.raw(\"(is_nullable = 'YES') as nullable\"),\n        \"column_default as default\",\n        \"data_type as type\",\n        \"udt_name as udt\"\n      );\n\n    // The list of database tables as enum\n    output.write(\"export enum Table {\\n\");\n    const tableSet = new Set(\n      columns.map((x) => {\n        const schema = x.schema !== \"public\" ? `${x.schema}.` : \"\";\n        return `${schema}${x.table}`;\n      })\n    );\n    Array.from(tableSet).forEach((value) => {\n      const key = overrides[value] ?? upperFirst(camelCase(value));\n      output.write(`  ${key} = \"${value}\",\\n`);\n    });\n    output.write(\"}\\n\\n\");\n    // The list of tables as type\n    output.write(\"export type Tables = {\\n\");\n    Array.from(tableSet).forEach((key) => {\n      const value = overrides[key] ?? upperFirst(camelCase(key));\n      output.write(`  \"${key}\": ${value},\\n`);\n    });\n    output.write(\"};\\n\\n\");\n\n    // Construct TypeScript db record types\n    columns.forEach((x, i) => {\n      if (!(columns[i - 1] && columns[i - 1].table === x.table)) {\n        const tableName = overrides[x.table] ?? upperFirst(camelCase(x.table));\n        const schemaName =\n          x.schema !== \"public\" ? upperFirst(camelCase(x.schema)) : \"\";\n        output.write(`export type ${schemaName}${tableName} = {\\n`);\n      }\n\n      let type =\n        x.type === \"ARRAY\"\n          ? `${getType(x.udt.substring(1), enumsMap, x.default)}[]`\n          : getType(x.udt, enumsMap, x.default);\n\n      if (x.nullable) {\n        type += \" | null\";\n      }\n\n      output.write(`  ${sanitize(x.column)}: ${type};\\n`);\n\n      if (!(columns[i + 1] && columns[i + 1].table === x.table)) {\n        output.write(\"};\\n\\n\");\n      }\n    });\n\n    if (options.suffix) {\n      output.write(options.suffix);\n      output.write(\"\\n\");\n    }\n  } finally {\n    output.end();\n    db.destroy();\n  }\n}\n\ntype Enum = {\n  key: string;\n  value: string;\n};\n\ntype Column = {\n  table: string;\n  column: string;\n  schema: string;\n  nullable: boolean;\n  default: string | null;\n  type: string;\n  udt: string;\n};\n\nexport function getType(\n  udt: string,\n  customTypes: Map<string, string>,\n  defaultValue: string | null\n): string {\n  switch (udt) {\n    case \"bool\":\n      return \"boolean\";\n    case \"text\":\n    case \"citext\":\n    case \"money\":\n    case \"numeric\":\n    case \"int8\":\n    case \"char\":\n    case \"character\":\n    case \"bpchar\":\n    case \"varchar\":\n    case \"time\":\n    case \"tsquery\":\n    case \"tsvector\":\n    case \"uuid\":\n    case \"xml\":\n    case \"cidr\":\n    case \"inet\":\n    case \"macaddr\":\n      return \"string\";\n    case \"smallint\":\n    case \"integer\":\n    case \"int\":\n    case \"int2\":\n    case \"int4\":\n    case \"real\":\n    case \"float\":\n    case \"float4\":\n    case \"float8\":\n      return \"number\";\n    case \"date\":\n    case \"timestamp\":\n    case \"timestamptz\":\n      return \"Date\";\n    case \"json\":\n    case \"jsonb\":\n      if (defaultValue) {\n        if (defaultValue.startsWith(\"'{\")) {\n          return \"Record<string, unknown>\";\n        }\n        if (defaultValue.startsWith(\"'[\")) {\n          return \"unknown[]\";\n        }\n      }\n      return \"unknown\";\n    case \"bytea\":\n      return \"Buffer\";\n    case \"interval\":\n      return \"PostgresInterval\";\n    default:\n      return customTypes.get(udt) ?? \"unknown\";\n  }\n}\n\n/**\n * Wraps the target property identifier into quotes in case it contains any\n * invalid characters.\n *\n * @see https://developer.mozilla.org/docs/Glossary/Identifier\n */\nfunction sanitize(name: string): string {\n  return /^[a-zA-Z$_][a-zA-Z$_0-9]*$/.test(name) ? name : JSON.stringify(name);\n}\n"],"mappings":";;;;;;;;;AAGA;AAAoB;AAHpB;AACA;;AAsDA;AACA;AACA;AACO,eAAeA,WAAW,CAACC,EAAQ,EAAEC,OAAgB,EAAiB;EAAA;EAC3E,MAAMC,SAAiC,yBAAGD,OAAO,CAACC,SAAS,mEAAI,CAAC,CAAC;EACjE,MAAMC,MAAgB,GACpB,OAAOF,OAAO,CAACE,MAAM,KAAK,QAAQ,GAC9BC,WAAE,CAACC,iBAAiB,CAACJ,OAAO,CAACE,MAAM,EAAE;IAAEG,QAAQ,EAAE;EAAQ,CAAC,CAAC,GAC3DL,OAAO,CAACE,MAAM;EAEpB,CACE,oEAAoE,EACpE,mEAAmE,CACpE,CAACI,OAAO,CAAEC,IAAI,IAAKL,MAAM,CAACM,KAAK,CAACD,IAAI,CAAC,CAAC;EAEvC,MAAME,MAAM,WAAI,OAAOT,OAAO,CAACS,MAAM,KAAK,QAAQ,GAC9CT,OAAO,CAACS,MAAM,CAACC,KAAK,CAAC,GAAG,CAAC,CAACC,GAAG,CAAEC,CAAC,IAAKA,CAAC,CAACC,IAAI,EAAE,CAAC,GAC9Cb,OAAO,CAACS,MAAM,uCAAK,CAAC,QAAQ,CAAC;;EAEjC;EACA,MAAM,CAACK,cAAc,EAAEC,cAAc,CAAC,GAAGN,MAAM,CAACO,MAAM,CACpD,CAACC,GAAG,EAAEC,CAAC,KACJD,GAAG,CAAC,CAACC,CAAC,CAACC,UAAU,CAAC,GAAG,CAAC,CAAC,CAACC,IAAI,CAACF,CAAC,CAAC,IAAID,GAA4B,EAClE,CAAC,EAAE,EAAc,EAAE,CAAa,CACjC;;EAED;EACA,MAAMI,OAAO,YACV,OAAOrB,OAAO,CAACqB,OAAO,KAAK,QAAQ,GAChCrB,OAAO,CAACqB,OAAO,CAACX,KAAK,CAAC,GAAG,CAAC,CAACC,GAAG,CAAEC,CAAC,IAAKA,CAAC,CAACC,IAAI,EAAE,CAAC,GAC/Cb,OAAO,CAACqB,OAAO,yCAAK,EAAE;EAE5B,IAAIrB,OAAO,CAACsB,MAAM,EAAE;IAClBpB,MAAM,CAACM,KAAK,CAACR,OAAO,CAACsB,MAAM,CAAC;IAC5BpB,MAAM,CAACM,KAAK,CAAC,MAAM,CAAC;EACtB;EAEA,IAAI;IACF;IACA,MAAMe,KAAK,GAAG,MAAMxB,EAAE,CACnByB,KAAK,CAAC,SAAS,CAAC,CAChBC,IAAI,CAAC,SAAS,EAAE,mBAAmB,EAAE,aAAa,CAAC,CACnDC,OAAO,CAAC,iBAAiB,CAAC,CAC1BA,OAAO,CAAC,uBAAuB,CAAC,CAChCC,MAAM,CAAS,wBAAwB,EAAE,4BAA4B,CAAC;;IAEzE;IACAJ,KAAK,CAACjB,OAAO,CAAC,CAACM,CAAC,EAAEgB,CAAC,KAAK;MAAA;MACtB;MACA,IAAI,EAAEL,KAAK,CAACK,CAAC,GAAG,CAAC,CAAC,IAAIL,KAAK,CAACK,CAAC,GAAG,CAAC,CAAC,CAACC,GAAG,KAAKjB,CAAC,CAACiB,GAAG,CAAC,EAAE;QAAA;QACjD,MAAMC,QAAQ,uBAAG7B,SAAS,CAACW,CAAC,CAACiB,GAAG,CAAC,+DAAI,0BAAW,yBAAUjB,CAAC,CAACiB,GAAG,CAAC,CAAC;QACjE3B,MAAM,CAACM,KAAK,CAAE,eAAcsB,QAAS,MAAK,CAAC;MAC7C;;MAEA;MACA,MAAMD,GAAG,iBACP5B,SAAS,CAAE,GAAEW,CAAC,CAACiB,GAAI,IAAGjB,CAAC,CAACmB,KAAM,EAAC,CAAC,mDAChC,0BAAW,yBAAUnB,CAAC,CAACmB,KAAK,CAACC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;MACtD9B,MAAM,CAACM,KAAK,CAAE,KAAIqB,GAAI,OAAMjB,CAAC,CAACmB,KAAM,MAAK,CAAC;;MAE1C;MACA,IAAI,EAAER,KAAK,CAACK,CAAC,GAAG,CAAC,CAAC,IAAIL,KAAK,CAACK,CAAC,GAAG,CAAC,CAAC,CAACC,GAAG,KAAKjB,CAAC,CAACiB,GAAG,CAAC,EAAE;QACjD3B,MAAM,CAACM,KAAK,CAAC,OAAO,CAAC;MACvB;IACF,CAAC,CAAC;IAEF,MAAMyB,QAAQ,GAAG,IAAIC,GAAG,CACtBX,KAAK,CAACZ,GAAG,CAAEC,CAAC;MAAA;MAAA,OAAK,CACfA,CAAC,CAACiB,GAAG,uBACL5B,SAAS,CAACW,CAAC,CAACiB,GAAG,CAAC,iEAAI,0BAAW,yBAAUjB,CAAC,CAACiB,GAAG,CAAC,CAAC,CACjD;IAAA,EAAC,CACH;;IAED;IACA,MAAMM,OAAO,GAAG,MAAMpC,EAAE,CACrBqC,UAAU,CAAC,oBAAoB,CAAC,CAChCZ,KAAK,CAAC,SAAS,CAAC,CAChBa,OAAO,CAAC,cAAc,EAAEvB,cAAc,CAAC,CACvCwB,UAAU,CAAC,cAAc,EAAEvB,cAAc,CAAC,CAC1CuB,UAAU,CAAC,YAAY,EAAEjB,OAAO,CAAC,CACjCK,OAAO,CAAC,cAAc,CAAC,CACvBA,OAAO,CAAC,YAAY,CAAC,CACrBA,OAAO,CAAC,kBAAkB,CAAC,CAC3BC,MAAM,CACL,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB5B,EAAE,CAACwC,GAAG,CAAC,mCAAmC,CAAC,EAC3C,2BAA2B,EAC3B,mBAAmB,EACnB,iBAAiB,CAClB;;IAEH;IACArC,MAAM,CAACM,KAAK,CAAC,uBAAuB,CAAC;IACrC,MAAMgC,QAAQ,GAAG,IAAIC,GAAG,CACtBN,OAAO,CAACxB,GAAG,CAAEC,CAAC,IAAK;MACjB,MAAMH,MAAM,GAAGG,CAAC,CAACH,MAAM,KAAK,QAAQ,GAAI,GAAEG,CAAC,CAACH,MAAO,GAAE,GAAG,EAAE;MAC1D,OAAQ,GAAEA,MAAO,GAAEG,CAAC,CAACY,KAAM,EAAC;IAC9B,CAAC,CAAC,CACH;IACDkB,KAAK,CAACC,IAAI,CAACH,QAAQ,CAAC,CAAClC,OAAO,CAAEyB,KAAK,IAAK;MAAA;MACtC,MAAMF,GAAG,uBAAG5B,SAAS,CAAC8B,KAAK,CAAC,+DAAI,0BAAW,yBAAUA,KAAK,CAAC,CAAC;MAC5D7B,MAAM,CAACM,KAAK,CAAE,KAAIqB,GAAI,OAAME,KAAM,MAAK,CAAC;IAC1C,CAAC,CAAC;IACF7B,MAAM,CAACM,KAAK,CAAC,OAAO,CAAC;IACrB;IACAN,MAAM,CAACM,KAAK,CAAC,0BAA0B,CAAC;IACxCkC,KAAK,CAACC,IAAI,CAACH,QAAQ,CAAC,CAAClC,OAAO,CAAEuB,GAAG,IAAK;MAAA;MACpC,MAAME,KAAK,qBAAG9B,SAAS,CAAC4B,GAAG,CAAC,2DAAI,0BAAW,yBAAUA,GAAG,CAAC,CAAC;MAC1D3B,MAAM,CAACM,KAAK,CAAE,MAAKqB,GAAI,MAAKE,KAAM,KAAI,CAAC;IACzC,CAAC,CAAC;IACF7B,MAAM,CAACM,KAAK,CAAC,QAAQ,CAAC;;IAEtB;IACA2B,OAAO,CAAC7B,OAAO,CAAC,CAACM,CAAC,EAAEgB,CAAC,KAAK;MACxB,IAAI,EAAEO,OAAO,CAACP,CAAC,GAAG,CAAC,CAAC,IAAIO,OAAO,CAACP,CAAC,GAAG,CAAC,CAAC,CAACJ,KAAK,KAAKZ,CAAC,CAACY,KAAK,CAAC,EAAE;QAAA;QACzD,MAAMoB,SAAS,yBAAG3C,SAAS,CAACW,CAAC,CAACY,KAAK,CAAC,mEAAI,0BAAW,yBAAUZ,CAAC,CAACY,KAAK,CAAC,CAAC;QACtE,MAAMqB,UAAU,GACdjC,CAAC,CAACH,MAAM,KAAK,QAAQ,GAAG,0BAAW,yBAAUG,CAAC,CAACH,MAAM,CAAC,CAAC,GAAG,EAAE;QAC9DP,MAAM,CAACM,KAAK,CAAE,eAAcqC,UAAW,GAAED,SAAU,QAAO,CAAC;MAC7D;MAEA,IAAIE,IAAI,GACNlC,CAAC,CAACkC,IAAI,KAAK,OAAO,GACb,GAAEC,OAAO,CAACnC,CAAC,CAACoC,GAAG,CAACC,SAAS,CAAC,CAAC,CAAC,EAAEhB,QAAQ,EAAErB,CAAC,CAACsC,OAAO,CAAE,IAAG,GACvDH,OAAO,CAACnC,CAAC,CAACoC,GAAG,EAAEf,QAAQ,EAAErB,CAAC,CAACsC,OAAO,CAAC;MAEzC,IAAItC,CAAC,CAACuC,QAAQ,EAAE;QACdL,IAAI,IAAI,SAAS;MACnB;MAEA5C,MAAM,CAACM,KAAK,CAAE,KAAI4C,QAAQ,CAACxC,CAAC,CAACyC,MAAM,CAAE,KAAIP,IAAK,KAAI,CAAC;MAEnD,IAAI,EAAEX,OAAO,CAACP,CAAC,GAAG,CAAC,CAAC,IAAIO,OAAO,CAACP,CAAC,GAAG,CAAC,CAAC,CAACJ,KAAK,KAAKZ,CAAC,CAACY,KAAK,CAAC,EAAE;QACzDtB,MAAM,CAACM,KAAK,CAAC,QAAQ,CAAC;MACxB;IACF,CAAC,CAAC;IAEF,IAAIR,OAAO,CAACsD,MAAM,EAAE;MAClBpD,MAAM,CAACM,KAAK,CAACR,OAAO,CAACsD,MAAM,CAAC;MAC5BpD,MAAM,CAACM,KAAK,CAAC,IAAI,CAAC;IACpB;EACF,CAAC,SAAS;IACRN,MAAM,CAACqD,GAAG,EAAE;IACZxD,EAAE,CAACyD,OAAO,EAAE;EACd;AACF;AAiBO,SAAST,OAAO,CACrBC,GAAW,EACXS,WAAgC,EAChCC,YAA2B,EACnB;EAAA;EACR,QAAQV,GAAG;IACT,KAAK,MAAM;MACT,OAAO,SAAS;IAClB,KAAK,MAAM;IACX,KAAK,QAAQ;IACb,KAAK,OAAO;IACZ,KAAK,SAAS;IACd,KAAK,MAAM;IACX,KAAK,MAAM;IACX,KAAK,WAAW;IAChB,KAAK,QAAQ;IACb,KAAK,SAAS;IACd,KAAK,MAAM;IACX,KAAK,SAAS;IACd,KAAK,UAAU;IACf,KAAK,MAAM;IACX,KAAK,KAAK;IACV,KAAK,MAAM;IACX,KAAK,MAAM;IACX,KAAK,SAAS;MACZ,OAAO,QAAQ;IACjB,KAAK,UAAU;IACf,KAAK,SAAS;IACd,KAAK,KAAK;IACV,KAAK,MAAM;IACX,KAAK,MAAM;IACX,KAAK,MAAM;IACX,KAAK,OAAO;IACZ,KAAK,QAAQ;IACb,KAAK,QAAQ;MACX,OAAO,QAAQ;IACjB,KAAK,MAAM;IACX,KAAK,WAAW;IAChB,KAAK,aAAa;MAChB,OAAO,MAAM;IACf,KAAK,MAAM;IACX,KAAK,OAAO;MACV,IAAIU,YAAY,EAAE;QAChB,IAAIA,YAAY,CAACvC,UAAU,CAAC,IAAI,CAAC,EAAE;UACjC,OAAO,yBAAyB;QAClC;QACA,IAAIuC,YAAY,CAACvC,UAAU,CAAC,IAAI,CAAC,EAAE;UACjC,OAAO,WAAW;QACpB;MACF;MACA,OAAO,SAAS;IAClB,KAAK,OAAO;MACV,OAAO,QAAQ;IACjB,KAAK,UAAU;MACb,OAAO,kBAAkB;IAC3B;MACE,2BAAOsC,WAAW,CAACE,GAAG,CAACX,GAAG,CAAC,+DAAI,SAAS;EAAC;AAE/C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,SAASI,QAAQ,CAACQ,IAAY,EAAU;EACtC,OAAO,4BAA4B,CAACC,IAAI,CAACD,IAAI,CAAC,GAAGA,IAAI,GAAGE,IAAI,CAACC,SAAS,CAACH,IAAI,CAAC;AAC9E"}