bioquery-typegenerator v1.1.1

BioQueryTypeGenerator

Github Repository: https://github.com/NM711/BioQueryParserTypeGenerator

A simple type generator developed for https://github.com/NM711/BioQueryBuilder a query builder.

For postgresql and in the future, for other sql databases.

  npm install bioquery-typegenerator

Type Generation

To generate your types you must provide a sql file named BioQuerySchema.sql in your project root, which will be formatted, tokenized, and built by the package, by running:

  npx bioquery-typegenerator

Then you will see a file named database.types.ts genreated into your projects root. This file contains all your generated types.

Basic Tables Example

PSQL

 -- BioQuerySchema.sql
CREATE TABLE "user"(
  id UUID PRIMARY KEY UNIQUE DEFAULT uuid_generate_v4(),
  username VARCHAR(125) NOT NULL UNIQUE,
  password_hash TEXT NOT NULL,
  description TEXT DEFAULT NULL,
  picture TEXT DEFAULT NULL
);

CREATE TABLE "post" (
  id UUID PRIMARY KEY UNIQUE DEFAULT uuid_generate_v4(),
  author_id UUID REFERENCES "user"(id),
  title VARCHAR(255) NOT NULL,
  content TEXT DEFAULT NULL,
  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL,
  updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL,
  attachment_url VARCHAR(255) DEFAULT NULL
);

CREATE TABLE "post_comment" (
  id UUID PRIMARY KEY UNIQUE DEFAULT uuid_generate_v4(),
  author_id UUID REFERENCES "user"(id) ON DELETE CASCADE,
  post_id UUID REFERENCES "post"(id) ON DELETE CASCADE,
  content TEXT DEFAULT NULL,
  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL,
  updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL
);

TS

  // database.types.ts
  
  export interface UserTable {
  id: string
  username: string
  password_hash: string
  description?: string
  picture?: string
}
 
export interface PostTable {
  id: string
  author_id?: string
  title: string
  content?: string
  created_at: Date | string
  updated_at: Date | string
  attachment_url?: string
}
 
export interface PostCommentTable {
  id: string
  author_id?: string
  post_id?: string
  content?: string
  created_at: Date | string
  updated_at: Date | string
}

export interface Database {
  user: UserTable
  post: PostTable
  post_comment: PostCommentTable
}

Postgresql With Enum Type Example:

PSQL

CREATE TYPE "authority" AS ENUM ('OWNER', 'ADMINISTRATOR', 'MEMBER', 'CUSTOM');

TS

  export type Authority = "OWNER" | "ADMINISTRATOR" | "MEMBER" | "CUSTOM"

As you can see, instead of it being converted into a typescript enum. It is converted into a typescript string literal type.

In the future, I plan to implement conversion for other user defined types.

Postgresql With User Defined Object Types Example:

PSQL

CREATE TYPE "person_type" AS (
  first_name VARCHAR(255),
  last_name VARCHAR(255),
  age INT,
  auth "authority"
);

CREATE TABLE "post_comment" (
  id UUID PRIMARY KEY UNIQUE DEFAULT uuid_generate_v4(),
  author_id UUID REFERENCES "user"(id) ON DELETE CASCADE,
  post_id UUID REFERENCES "post"(id) ON DELETE CASCADE,
  content TEXT DEFAULT NULL,
  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL,
  updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL
  randomObj "person_type" UNIQUE
);

TS

export interface PersonType {
  first_name: string
  last_name: string
  age: number
  auth: Authority
}

export interface PostCommentTable {
  id: string
  author_id?: string
  post_id?: string
  content?: string
  created_at: Date | string
  updated_at: Date | string
  randomObj: PersonType
}

As you can see even the defined and assigned enums get generated and added to the "PersonType" user defined object type.

Flags

Kysley Mode

This feature is still in development.

  npm bioquery-typegenerator --mode kysley

OR

  npx bioquery-typegenerator -m kysley

PSQL

-- BioQuerySchema.sql
CREATE TABLE "user"(
  id UUID PRIMARY KEY UNIQUE DEFAULT uuid_generate_v4(),
  username VARCHAR(125) NOT NULL UNIQUE,
  password_hash TEXT NOT NULL,
  description TEXT DEFAULT NULL,
  picture TEXT DEFAULT NULL
);

CREATE TABLE "post" (
  id UUID PRIMARY KEY UNIQUE DEFAULT uuid_generate_v4(),
  author_id UUID REFERENCES "user"(id),
  title VARCHAR(255) NOT NULL,
  content TEXT DEFAULT NULL,
  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL,
  updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP NOT NULL,
  attachment_url VARCHAR(255) DEFAULT NULL
);

TS

// database.types.ts
export interface UserTable {
  id: string | Generated<string>
  username: string | Generated<string>
  password_hash: string | Generated<string>
  description?: string | Generated<string>
  picture?: string | Generated<string>
}
 
export interface PostTable {
  id: string | Generated<string>
  author_id?: string
  title: string | Generated<string>
  content?: string | Generated<string>
  created_at: Date | string | Generated<Date | string>
  updated_at: Date | string | Generated<Date | string>
  attachment_url?: string | Generated<string>
}

For the time being im only making use of the type from kysley, and im still implementing a way to provide an automatic import for the necessary types. But like I said above, this is still a work in progress.