nukak

nukak is a powerful ORM, ideated to be fast, secure, and easy to use. Inspired by other ORMs such as TypeORM and MongoDB driver, and has been designed with JSON syntax to squeeze all the power from TypeScript & modern JavaScript.

 

Features

• Type-safe queries: TypeScript auto-completes and validate the queries while coding.
• Context-aware queries: TypeScript infers the appropriate operators and fields based on each part of a query.
• Serializable queries: the syntax is 100% valid JSON allowing the queries to be transported across platforms with ease.
• High performance: the generated queries are fast, safe, and human-readable.
• Combines the best elements of OOP (Object Oriented Programming) and FP (Functional Programming).
• Declarative and imperative transactions for flexibility.
• Modern Pure ESM packages. ESM is natively supported by Node.js 12 and later.
• soft-delete, virtual fields, repositories, connection pooling for scalability.
• Supports the Data Mapper pattern for maintainability.
• Transparent support for inheritance between entities.
• Support for projection, filtering, sorting, and other operations on any level of the query, including relations and their fields.
• Unified syntax across Databases: providing a standard API and transparently transforming queries according to the configured database.

 

Install

1. Install the core package:

   npm install nukak --save
   

2. Install one of the specific adapters for your database:

Database	Driver	Nukak Adapter
MySQL	mysql2	nukak-mysql
MariaDB	mariadb	nukak-maria
SQLite	sqlite sqlite3	nukak-sqlite
PostgreSQL	pg	nukak-postgres
MongoDB	mongodb	nukak-mongo

For example, for Postgres:

npm install pg nukak-postgres --save

1. Additionally, your tsconfig.json may need the following flags:

   "target": "es2020",
   "experimentalDecorators": true,
   "emitDecoratorMetadata": true
   

 

Configure

A default querier-pool can be set in any of the bootstrap files of your app (e.g. in the server.ts).

import { setQuerierPool } from 'nukak';
import { PgQuerierPool } from 'nukak-postgres';

export const querierPool = new PgQuerierPool(
  {
    host: 'localhost',
    user: 'theUser',
    password: 'thePassword',
    database: 'theDatabase',
  },
  // optionally, a logger can be passed to log the generated SQL queries
  { logger: console.log }
);

// the default querier pool that `nukak` will use
setQuerierPool(querierPool);

 

Define the entities

Take any dump class (aka DTO) and annotate it with the decorators from nukak/entity.

import { v4 as uuidv4 } from 'uuid';
import { Id, Field, Entity } from 'nukak/entity';

@Entity()
export class User {
  @Id({ onInsert: uuidv4 })
  id?: string;
  @Field()
  name?: string;
  @Field()
  email?: string;
  @Field()
  password?: string;
}

 

Manipulate the data

import { getQuerier } from 'nukak';
import { User } from './shared/models/index.js';

async function findLastUsers(limit = 10) {
  const querier = await getQuerier();
  const users = await querier.findMany(User, {
    $project: ['id', 'name', 'email'],
    $sort: { createdAt: -1 },
    $limit: limit,
  });
  await querier.release();
  return users;
}

async function createUser(body: User) {
  const querier = await getQuerier();
  const id = await querier.insertOne(User, body);
  await querier.release();
  return id;
}

 

Learn more about nukak at its website https://nukak.org