db-typegen v1.1.11

DB Typegen

Typescript Database ORM code generator.

Features

• Generates typescript ORM (Current supported below)
  • MongoDB
  • PostgreSQL

Prerequisite

• Node.js version >= 18

Installation

Install the package globally.

npm install -g db-typegen

or

npm install db-typegen

Setup

Create a typegen.config.json file on your project root directory

root
    -- node_modules
    |
    -- src
    |
    -- package.json
    |
    -- package-lock.json
    |
    -- typegen.config.json

Example Configuration

{
  "$schema": "./node_modules/db-typegen/schema.json",
  "architecture": "functional",
  "format": "camelCase",
  "experimentalResolvers": true,
  "splitTypings": true,
  "prettier": true,
  "postgresql": {
    "dbConfig": {
      "user": "postgres",
      "host": "localhost",
      "database": "",
      "password": "password",
      "port": 5432
    },
    "schemas": ["table_one", "table_two"],
    "path": "src/__typegen__/postgresql",
    "experimentals": {
      "relationships": true
    }
  },
  "mongodb": {
    "dbConfig": {
      "host": "localhost",
      "database": "",
      "port": 27017
    },
    "path": "src/__typegen__/mongodb",
    "experimentals": {
      "strict": true
    }
  }
}

Typegen Configuration

This document outlines the configuration schema for the typegen.config.json file used in your project.

Configuration Schema

Usage

Assuming you have completed the Setup. Enter the command on your terminal.

npx db-typegen

if installed globally, you may use

db-typegen

It should create a directory __typegen__ in the root. Custom path for the generated files can be also provided using the path on your typegen.config.json configuration.

Note It will also create a file .env.sample just copy the content if you don't have .env yet.

Limitations

When experimentalResolvers is set to true and format is camelCase there is a chance that the resolver methods will have a conflicting name e.g.

❌
// camelCase
Table: users
  column: id    -> selectUsersById
  column: __id  -> selectUsersById
  column: _id_  -> selectUsersById
  column: id__  -> selectUsersById

✅
// snake_case
Table: users
  column: id    -> select_users_by_id
  column: __id  -> select_users_by__id
  column: _id_  -> select_users_by_id_
  column: id__  -> select_users_by_id__

Changelog

1.1.10

• Added double quote delimiter for tables to avoid clashing with postgresql reserved words
• Removed insert, update and delete client schema check
• Improved experimentalResolver typings
• Improved relationships resolvers return types
• Improved insert statement return type
  • Introduced PGInsertResult<T> - { insertedCount: number; data: T[] }
• Improved update statement return type
  • Introduced PGUpdateResult<T> - { updatedCount: number; data: T[] }
• Improved delete statement return type
  • Introduced PGDeleteResult<T> - { deletedCount: number }
• Fixed db-typegen-utils import path
• Fixed undefined error on generate

1.1.2

• Removed default query logging
  • Though still shows when PGFindOptions.debug is true
• Fixed experimentalResolver methods filter args not working
  • Currently supports = by default

1.1.0

• Added support to explicit schema on typegen.config.json
  • Updated local schema table variables. Previously TABLE_NAME, now SCHEMA_TABLE_NAME
• Fixed experimentalResolvers javascript/typescript reserved words for column names
• Fixed experimentalResolvers clauses not working
• db-typegen-utils
  • Fixed select method options type suggest not working

1.0.0

• Initial release

Contributing

Raise issue or pull request on: https://github.com/chrischanF/db-typegen