Uranio

!uranio logo

Uranio is the lightest Typescript Object Document Mapper (ODM) for MongoDB,
Object Relational Mapping (ORM) for MySQL, and DynamoDB.\
It creates a client for querying collections/tables in a database by just parsing
the types in a repository.

It is the simplest and fastest way to query a database without the need to build
a Data Access Layer (DAL) from the defined types.

Install

Uranio uses peer dependencies for database SDKs, so you only install what you need:

$3

``bash
npm install uranio mongodb
`

$3

`bash
npm install uranio mysql2
`

$3

`bash
npm install uranio @aws-sdk/client-dynamodb @aws-sdk/util-dynamodb
`

How it works

Run:
`bash
uranio generate -d mongodb
// or
uranio generate -d mysql
`

The above command search for all interfaces in your repository that extends
the uranio.atom interface.\
For each of these interfaces it creates a method to query a collection with a
name of the interface.

For example if in your code you have:

`typescript
import uranio from 'uranio';

interface Product extends uranio.atom {
title: string;
description: string;
price: number;
}
`

then Uranio generates a method for querying a collection named products:

`typescript
import uranio from 'uranio';

const uri = process.env.MONGO_DATABASE_URI || '';
const dbName = process.env.MONGO_DATABASE_NAME || '';

const urn = uranio.MongoDBClient({uri, dbName});

// Get all products
const products = await urn.products.getAtoms({});

// Create a product
await urn.products.putAtom({
title: 'Uranio mug',
description: 'A radioactive mug for your coding breakfast',
price: 4.99
});
`

$3

When extending an interface with uranio.atom (MongoDB) this add a primary
index attribute _id to the interface, so there is no need to add it manually.

`typescript
import uranio from 'uranio';

interface Product extends uranio.atom {
title: string;
description: string;
price: number;
}
// It resolves in:
// {
// _id: string;
// title: string;
// description: string;
// price: number;
// }
`

Configuration

$3

When creating a MySQL client, you can configure additional options:

`typescript
import uranio from 'uranio';

const uri = process.env.MYSQL_DATABASE_URI || '';

// Default: UTC timezone, no connection pool
const urn = uranio.MySQLClient({ uri });

// With connection pool
const urn = uranio.MySQLClient({
uri,
usePool: true
});

// Custom timezone (default is UTC '+00:00')
const urn = uranio.MySQLClient({
uri,
usePool: true,
timezone: '+04:00' // Dubai timezone (GST)
});

// Use local server timezone
const urn = uranio.MySQLClient({
uri,
timezone: 'local'
});
`

Timezone Parameter:
- Default: '+00:00' (UTC) - All dates are stored in UTC
- Custom: Any valid timezone offset like '+04:00' (Dubai), '+09:00' (Tokyo)
- Local: 'local' - Uses the database server's timezone

The timezone setting affects how JavaScript Date objects are converted when storing to and retrieving from the database. Using UTC (default) is recommended for consistency across different timezones.

Troubleshooting

$3

If you get an error like:
`
Error: Cannot find module 'mongodb'
Error: Cannot find module 'mysql2'
Error: Cannot find module '@aws-sdk/client-dynamodb'
`

This means you haven't installed the required database SDK. Install the SDK for your chosen database:

`bash


For MongoDB

npm install mongodb

For MySQL

npm install mysql2

For DynamoDB

npm install @aws-sdk/client-dynamodb @aws-sdk/util-dynamodb
``

$3

When installing Uranio, npm may show peer dependency warnings. These are expected since Uranio supports multiple databases. You only need to install the SDK for the database you're actually using.

$3

Logo credits https://www.jacopotripodi.com/