@antelopejs/interface-database-decorators

Database tables and data models as TypeScript classes, on top of @antelopejs/interface-database. Declare fields and indexes with decorators, then read and write rows through a typed model.

Part of AntelopeJS. Used by AntelopeJS DMS, the open-source back office for your PostgreSQL, MongoDB or RethinkDB database.

What it offers

• Table, @RegisterTable, @Field, @Index and @Fixture declare tables, indexes and seed rows; RegisterSchema provisions them.
• BasicDataModel and GetModel give each table typed CRUD methods with optional validation.
• @Encrypted, @Hashed, @Localized, @CreationTime and @UpdateTime transform field values on write and read.
• await row.setHashAsync(field, value) and await row.testHashAsync(field, value) hash a password off the event loop. Use them on a server: assigning a @Hashed field blocks the event loop for about 150 ms. See Table modifiers.
• @Model injects a model into an @antelopejs/interface-api controller.

Implementations

The package runs in your module and has no implementing module of its own. The project needs a module that implements @antelopejs/interface-database:

| Module | Notes | | ------------------------------------------------------------------ | --------- | | @antelopejs/mongodb | MongoDB | | @antelopejs/rethinkdb | RethinkDB |

Install

Add the package to the module that declares tables:

pnpm add @antelopejs/interface-database-decorators

Then add a database module to the project:

ajs project modules add @antelopejs/mongodb

Quick start

import {
  BasicDataModel,
  Field,
  GetModel,
  Index,
  RegisterSchema,
  RegisterTable,
  Table,
} from "@antelopejs/interface-database-decorators";

@RegisterTable("recipes", "cookbook")
class Recipe extends Table {
  @Index()
  @Field("string")
  declare slug: string;

  @Field("string")
  declare tagline: string;
}

class RecipeModel extends BasicDataModel(Recipe) {}

export async function construct() {
  await RegisterSchema("cookbook");
}

export async function start() {
  const recipes = GetModel(RecipeModel);
  await recipes.insert({ slug: "grilled-halloumi", tagline: "Smoky skewers" });
  const [recipe] = await recipes.getBy("slug", "grilled-halloumi");
  await recipes.update(recipe._id, { tagline: "Smoky halloumi skewers" });
}

RegisterSchema creates every table registered for the schema and inserts their fixtures. Call it once, in the module that declares the tables.

Documentation

• Introduction
• Table definitions
• Table modifiers
• Data models
• Parameter decoration

Compatibility

The package declares these @antelopejs/* peer dependencies:

| Package | Supported | Tested with | | -------------------------------- | ----------------- | ----------- | | @antelopejs/interface-api | >=0.0.15 <1.0.0 | 0.0.15 | | @antelopejs/interface-core | >=0.2.4 <1.0.0 | 0.4.0 | | @antelopejs/interface-database | >=0.1.11 <1.0.0 | 0.3.0 |

Contributing

Read CONTRIBUTING.md before you open a pull request. The local checks are:

pnpm install
pnpm lint
pnpm test

License

Apache-2.0