@antelopejs/interface-database-decorators 0.1.4 → 0.1.6

package/docs/4.data-models.md

@@ -0,0 +1,183 @@
+# Data Models
+
+Data models provide a high-level interface for interacting with database tables. They handle conversion between database records and TypeScript class instances, and expose methods for common CRUD operations.
+
+## BasicDataModel
+
+The `BasicDataModel` function creates a model class for a specific table. It wraps the underlying AQL table with methods that automatically apply modifier transformations.
+
+```typescript
+import { BasicDataModel } from "@antelopejs/interface-database-decorators";
+import { User } from "./user.table";
+
+const UserModel = BasicDataModel(User, "users");
+```
+
+### Parameters
+
+| Parameter   | Type              | Description                                          |
+| ----------- | ----------------- | ---------------------------------------------------- |
+| `dataType`  | `Constructible<T>`| The Table class representing your table              |
+| `tableName` | `string`          | The table name in the database (optional if `@RegisterTable` is used) |
+
+When the table class has been decorated with `@RegisterTable`, the `tableName` parameter can be omitted.
+
+## Instantiate a Model
+
+A model instance requires a `SchemaInstance` from the database interface:
+
+```typescript
+import { Schema } from "@antelopejs/interface-database";
+
+const schema = Schema.get("myapp")!;
+const db = schema.instance();
+
+const userModel = new UserModel(db);
+```
+
+## CRUD Operations
+
+### Read
+
+```typescript
+// Get by primary key
+const user = await userModel.get("user-123");
+
+// Get by secondary index
+const admins = await userModel.getBy("role", "admin");
+
+// Get all documents
+const allUsers = await userModel.getAll();
+```
+
+### Create
+
+```typescript
+// Insert a single document
+const ids = await userModel.insert({
+  email: "alice@example.com",
+  name: "Alice",
+});
+
+// Insert multiple documents
+const batchIds = await userModel.insert([
+  { email: "bob@example.com", name: "Bob" },
+  { email: "carol@example.com", name: "Carol" },
+]);
+```
+
+### Update
+
+```typescript
+// Update by ID
+await userModel.update("user-123", { name: "Updated Name" });
+
+// Update by including the primary key in the object
+await userModel.update({ _id: "user-123", name: "Updated Name" });
+```
+
+> **Important:** When calling `update` without a separate ID argument, the object must include the primary key field.
+
+### Delete
+
+```typescript
+await userModel.delete("user-123");
+```
+
+## Data Conversion
+
+Data models include static methods for converting between different data representations:
+
+### `fromPlainData(obj)`
+
+Convert a plain JavaScript object into a Table class instance. Modifier transformations (like encryption and hashing) are applied during this conversion.
+
+```typescript
+const user = UserModel.fromPlainData({
+  _id: "user-123",
+  email: "user@example.com",
+  name: "John",
+});
+```
+
+### `fromDatabase(obj)`
+
+Convert a raw database record into a Table class instance. This attaches the class prototype and triggers the `fromDatabase` modifier event.
+
+```typescript
+const user = UserModel.fromDatabase(rawDbRecord);
+```
+
+### `toDatabase(obj)`
+
+Convert a Table class instance into a plain object suitable for database storage. Modifier events like `toDatabase` are triggered.
+
+```typescript
+const dbReady = UserModel.toDatabase(userInstance);
+```
+
+## Validation
+
+`Model.validate(obj)` runs every io-ts codec attached via `@Field` against the matching property of `obj`. String-token fields and properties without `@Field` are skipped.
+
+```typescript
+const result = UserModel.validate({ name: "Alice", age: 30 });
+if (!result.ok) {
+  console.error(result.errors); // [{ field: "age", message: "not number" }, ...]
+}
+```
+
+Pass `{ validate: true }` to `insert` or `update` to gate the write on validation. On failure the call throws an `Error` whose `errors` property holds the per-field details; on success the original object passes through unchanged.
+
+```typescript
+await userModel.insert({ name: "Alice", age: 30 }, { validate: true });
+await userModel.update("user-123", { name: "Bob" }, { validate: true });
+```
+
+`insert` validates every annotated codec field. `update` is partial: only fields present on the patch object are checked, so omitting fields you don't intend to modify is fine. Use `Model.validate(obj, { partial: true })` for the same patch semantics outside of `update`.
+
+## Extend BasicDataModel
+
+Extend the generated model class to add custom query methods:
+
+```typescript
+const UserModelBase = BasicDataModel(User, "users");
+
+class CustomUserModel extends UserModelBase {
+  async findActive() {
+    return this.table
+      .filter((u) => u.key("status").eq("active"))
+      .then((rows) => rows.map(CustomUserModel.fromDatabase) as User[]);
+  }
+
+  async register(email: string, name: string) {
+    const existing = await this.getBy("email", email);
+    if (existing.length > 0) {
+      throw new Error("Email already in use");
+    }
+    return this.insert({ email, name, status: "active" });
+  }
+}
+```
+
+## GetModel
+
+The `GetModel` function retrieves or creates a cached model instance for a given schema:
+
+```typescript
+import { GetModel } from "@antelopejs/interface-database-decorators";
+
+const userModel = GetModel(UserModel, "instance-id");
+```
+
+Model instances are cached by class and instance ID, so repeated calls with the same arguments return the same instance. The schema is resolved automatically from the `schemaName` property on the model class.
+
+## Modifier Integration
+
+Data models automatically apply all modifier transformations:
+
+- **On insert** - `fromPlainData` conversion is applied, the `insert` event fires, and the result is converted with `toDatabase` before writing.
+- **On update** - The same conversion pipeline applies with the `update` event.
+- **On read** - Results from `get`, `getBy`, and `getAll` are converted with `fromDatabase`.
+
+This means encrypted fields are encrypted before storage and decrypted on retrieval, hashed fields are hashed on write, and localized fields follow their configured locale behavior -- all transparently.

package/docs/5.parameter-decoration.md

@@ -0,0 +1,155 @@
+# Parameter Decoration
+
+The Database Decorators package provides the `Model` decorator for injecting data model instances into API controller methods. This decorator integrates with the `@antelopejs/interface-api` package's parameter provider system.
+
+## The Model Decorator
+
+The `Model` decorator injects a cached model instance. It can be used as either a parameter decorator or a property decorator.
+
+### Static Instance ID
+
+Pass a fixed instance ID to bind the model to a specific schema instance:
+
+```typescript
+import { Controller, Get } from "@antelopejs/interface-api";
+import { Model } from "@antelopejs/interface-database-decorators";
+import { UserModel } from "./user.model";
+
+class UsersController extends Controller("/users") {
+  @Get()
+  async listUsers(@Model(UserModel, "main") userModel: InstanceType<typeof UserModel>) {
+    return await userModel.getAll();
+  }
+}
+```
+
+### Dynamic Instance ID
+
+Pass a callback function to determine the instance ID at request time. The callback receives the request context:
+
+```typescript
+import { Controller, Get, Parameter } from "@antelopejs/interface-api";
+import { Model } from "@antelopejs/interface-database-decorators";
+import { UserModel } from "./user.model";
+
+class MultitenantController extends Controller("/tenants") {
+  @Get("/:tenantId/users")
+  async getTenantUsers(
+    @Parameter("tenantId") tenantId: string,
+    @Model(UserModel, (ctx) => `tenant-${ctx.params.tenantId}`) userModel: InstanceType<typeof UserModel>,
+  ) {
+    return await userModel.getAll();
+  }
+}
+```
+
+## Property Decoration
+
+The `Model` decorator also works as a property decorator. The model is initialized when the controller handles a request:
+
+```typescript
+import { Controller, Get, Parameter } from "@antelopejs/interface-api";
+import { Model } from "@antelopejs/interface-database-decorators";
+import { UserModel } from "./models";
+
+class UsersController extends Controller("/users") {
+  @Model(UserModel, "main")
+  private userModel!: InstanceType<typeof UserModel>;
+
+  @Get()
+  async listUsers() {
+    return await this.userModel.getAll();
+  }
+
+  @Get("/:id")
+  async getUser(@Parameter("id") id: string) {
+    return await this.userModel.get(id);
+  }
+}
+```
+
+## Model Caching
+
+The `Model` decorator uses `GetModel` internally, which caches model instances by class and instance ID. Multiple decorators referencing the same model class and instance ID share a single instance:
+
+```typescript
+import { GetModel } from "@antelopejs/interface-database-decorators";
+
+// These return the same instance
+const model1 = GetModel(UserModel, "main");
+const model2 = GetModel(UserModel, "main");
+
+// This returns a different instance
+const model3 = GetModel(UserModel, "other");
+```
+
+## Combine with API Decorators
+
+Model decorators compose naturally with other API decorators for building complete CRUD controllers:
+
+```typescript
+import { Controller, Get, Post, Put, Delete, RawBody, Parameter } from "@antelopejs/interface-api";
+import { Model } from "@antelopejs/interface-database-decorators";
+import { UserModel } from "./user.model";
+
+class UsersController extends Controller("/users") {
+  @Get()
+  async list(@Model(UserModel, "main") model: InstanceType<typeof UserModel>) {
+    return await model.getAll();
+  }
+
+  @Get("/:id")
+  async get(
+    @Parameter("id") id: string,
+    @Model(UserModel, "main") model: InstanceType<typeof UserModel>,
+  ) {
+    return await model.get(id);
+  }
+
+  @Post()
+  async create(
+    @RawBody() body: Buffer,
+    @Model(UserModel, "main") model: InstanceType<typeof UserModel>,
+  ) {
+    const data = JSON.parse(body.toString());
+    return await model.insert(data);
+  }
+
+  @Put("/:id")
+  async update(
+    @Parameter("id") id: string,
+    @RawBody() body: Buffer,
+    @Model(UserModel, "main") model: InstanceType<typeof UserModel>,
+  ) {
+    const data = JSON.parse(body.toString());
+    return await model.update(id, data);
+  }
+
+  @Delete("/:id")
+  async remove(
+    @Parameter("id") id: string,
+    @Model(UserModel, "main") model: InstanceType<typeof UserModel>,
+  ) {
+    return await model.delete(id);
+  }
+}
+```
+
+## Custom Parameter Providers
+
+For more complex injection logic, create custom parameter providers using the core API:
+
+```typescript
+import { SetParameterProvider } from "@antelopejs/interface-api";
+import { GetModel } from "@antelopejs/interface-database-decorators";
+import { MakeParameterAndPropertyDecorator } from "@antelopejs/interface-core/decorators";
+
+const CustomModel = MakeParameterAndPropertyDecorator(
+  (target, key, index, modelClass, resolver) => {
+    SetParameterProvider(target, key, index, (ctx) => {
+      const instanceId = resolver(ctx);
+      return GetModel(modelClass, instanceId);
+    });
+  },
+);
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/interface-database-decorators",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "AntelopeJS interface for database schema decorators and model definitions",
   "keywords": [
     "antelopejs",
@@ -18,7 +18,9 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "docs",
+    "skills"
   ],
   "exports": {
     ".": {
@@ -49,6 +51,10 @@
       "types": "./dist/table.d.ts",
       "default": "./dist/table.js"
     },
+    "./modifiers/autodate": {
+      "types": "./dist/modifiers/autodate.d.ts",
+      "default": "./dist/modifiers/autodate.js"
+    },
     "./modifiers/common": {
       "types": "./dist/modifiers/common.d.ts",
       "default": "./dist/modifiers/common.js"
@@ -125,6 +131,9 @@
       "table": [
         "dist/table.d.ts"
       ],
+      "modifiers/autodate": [
+        "dist/modifiers/autodate.d.ts"
+      ],
       "modifiers/common": [
         "dist/modifiers/common.d.ts"
       ],
@@ -141,6 +150,9 @@
   },
   "antelopeJs": {
     "standalone": true,
-    "test": "src/antelope.test.ts"
+    "test": "src/antelope.test.ts",
+    "skills": [
+      "./skills"
+    ]
   }
 }

package/skills/database-decorators-interface/SKILL.md

@@ -0,0 +1,99 @@
+---
+name: database-decorators-interface
+description: Provides decorator-based database table definitions for AntelopeJS - a Table base class with RegisterTable/Index/Field/Fixture/Relation decorators, field modifiers (Encrypted, Hashed, Localized, CreationTime, UpdateTime), BasicDataModel CRUD models with validation, RegisterSchema provisioning, and the Model decorator for injecting models into API controllers. Use when code imports @antelopejs/interface-database-decorators (root or /table, /schema, /database, /model, /relation, /common, /modifiers/* subpaths), or when asked to define a database table or data model class, add encrypted/hashed/localized/timestamp fields, seed fixture data, register a schema, or inject a data model into an interface-api controller.
+category: antelopejs-interface
+tags: [database, decorators, orm, models, antelopejs]
+---
+
+# Database Decorators Interface
+
+Consumer-side decorator layer on top of `@antelopejs/interface-database` (AQL). This package itself has no proxy
+points and no provider side — you never `ImplementInterface` it. All actual database access flows through
+`Schema`/`Table` from `@antelopejs/interface-database`, which must be implemented by a database module (e.g. MongoDB).
+Peer interfaces required: `@antelopejs/interface-core`, `@antelopejs/interface-api` (only for the `Model` controller decorator), `@antelopejs/interface-database`.
+
+## Imports
+
+```typescript
+import { Table, Field, Index, Fixture } from "@antelopejs/interface-database-decorators/table";
+import { RegisterTable, getTablesForSchema } from "@antelopejs/interface-database-decorators/schema";
+import { RegisterSchema } from "@antelopejs/interface-database-decorators/database";
+import { BasicDataModel, GetModel, Model } from "@antelopejs/interface-database-decorators/model";
+import { Relation } from "@antelopejs/interface-database-decorators/relation";
+import { DatumStaticMetadata, getMetadata } from "@antelopejs/interface-database-decorators/common";
+import { CreationTime, UpdateTime } from "@antelopejs/interface-database-decorators/modifiers/autodate";
+import { Encrypted, EncryptionModifier } from "@antelopejs/interface-database-decorators/modifiers/encryption";
+import { Hashed, HashModifier } from "@antelopejs/interface-database-decorators/modifiers/hash";
+import { Localized, LocalizationModifier } from "@antelopejs/interface-database-decorators/modifiers/localization";
+import { Modifier, OneWayModifier, TwoWayModifier, attachModifier, toPlainData } from "@antelopejs/interface-database-decorators/modifiers/common";
+```
+
+The package root re-exports everything above and also imports `reflect-metadata` (see gotchas).
+
+## Minimal usage
+
+```typescript
+@RegisterTable("recipes", "cookbook") // (tableName, schemaName)
+class Recipe extends Table {
+  // _id: string is inherited as the primary key
+  @Index() @Field("string")
+  declare slug: string;
+  @Field("string")
+  declare tagline: string;
+}
+
+const RecipeModel = BasicDataModel(Recipe); // table name taken from @RegisterTable
+await RegisterSchema("cookbook"); // once at startup: provisions all tables registered for "cookbook", runs fixtures
+
+const recipes = GetModel(RecipeModel); // cached per (model class, instanceId)
+await recipes.insert({ slug: "grilled-halloumi", tagline: "Smoky skewers" }, { validate: true });
+const bySlug = await recipes.getBy("slug", "grilled-halloumi");
+const one = await recipes.get(bySlug[0]._id);
+await recipes.update(one._id, { tagline: "Smoky halloumi skewers" });
+await recipes.delete(one._id);
+```
+
+Controller injection (works as parameter or property decorator; second arg is a static `InstanceId` or a
+`(ctx: RequestContext) => InstanceId | undefined` callback — returning `undefined` falls back to the default schema instance):
+
+```typescript
+class RecipesController extends Controller("/recipes") {
+  @Get()
+  async list(@Model(RecipeModel) recipes: InstanceType<typeof RecipeModel>) {
+    return recipes.getAll();
+  }
+}
+```
+
+## Field modifiers
+
+```typescript
+class Chef extends Table.with(HashModifier, EncryptionModifier, LocalizationModifier) {
+  @Hashed() declare passphrase: string;                   // one-way; test via instance.testHash("passphrase", value)
+  @Encrypted({ secretKey }) declare supplierCode: string; // transparent encrypt/decrypt (autolock + autounlock)
+  @Localized() declare motto: string;                     // read AND write via instance.localize("en", ["motto"])
+  @CreationTime() declare hiredAt: Date;                  // set on insert, stripped from updates
+  @UpdateTime() declare lastActiveAt: Date;               // refreshed on insert and update
+}
+```
+
+## Gotchas
+
+- Only the package root imports `reflect-metadata`; if you import only subpaths, ensure `reflect-metadata`
+  is loaded once before decorators run (e.g. `import "@antelopejs/interface-database-decorators"`).
+- `Hashed`, `Encrypted`, and `Localized` require the matching modifier class in `Table.with(...)`; `CreationTime`/`UpdateTime` are event-only and need no mixin.
+- Modifier ordering matters: `attachModifier` throws if you stack a modifier after a one-way modifier (e.g. anything after `@Hashed` on the same field).
+- Hashed fields cannot be read back or queried directly — only equality-tested with `testHash`.
+- Localized fields must be written through a localized instance (`instance.localize(locale).field = ...`);
+  values assigned before `localize()` are held in floating state and silently dropped on insert/update.
+- `@Relation({ to: () => Target })` is declarative metadata only: no foreign-key enforcement, consumed by introspection tooling via `RelationStaticMetadata`.
+- `Model.validate` (and `{ validate: true }` on insert/update) only checks fields whose `@Field` type is an
+  io-ts-style codec with `.decode`; plain string field tokens are skipped. Update validates with
+  `{ partial: true }` semantics.
+- `update(obj)` without an explicit id asserts that the object carries the primary key (`_id` by default).
+- `@Fixture` data is only inserted by `RegisterSchema` when the table is empty (count === 0).
+- `GetModel` caches by model class + instanceId; the same pair always returns the same instance.
+- Serialization of modified instances to plain JSON goes through `toPlainData` (auto-attached as `toJSON`).
+
+Deeper reference: this package's `docs/` chapters — Introduction, Table Definitions, Table Modifiers,
+Data Models, Parameter Decoration — and the shipped `.d.ts` files. Do not duplicate them here.