@antelopejs/interface-database-decorators 0.1.5 → 0.1.7

package/docs/3.table-modifiers.md

@@ -0,0 +1,403 @@
+# Table Modifiers
+
+Table modifiers transform field values as they are stored in and retrieved from the database. They enable transparent encryption, hashing, localization, and custom data transformations. Add modifiers to a table class using the `Table.with()` method.
+
+## Built-in Modifiers
+
+### EncryptionModifier
+
+The `EncryptionModifier` encrypts field values before storing them and decrypts them on retrieval. Both operations happen transparently.
+
+```typescript
+import {
+  Table,
+  Field,
+  EncryptionModifier,
+  Encrypted,
+} from "@antelopejs/interface-database-decorators";
+
+class UserCredentials extends Table.with(EncryptionModifier) {
+  @Encrypted({
+    secretKey: process.env.ENCRYPTION_KEY || "default-key",
+    algorithm: "aes-256-gcm",
+    ivSize: 16,
+  })
+  @Field("string")
+  declare creditCardNumber: string;
+
+  @Encrypted({ secretKey: process.env.ENCRYPTION_KEY || "default-key" })
+  @Field("any")
+  declare personalData: {
+    ssn: string;
+    birthDate: string;
+  };
+}
+```
+
+#### How It Works
+
+- Data is encrypted using the specified algorithm before database insertion.
+- A random initialization vector (IV) is generated for each write.
+- For authenticated encryption algorithms (e.g., `aes-256-gcm`), an auth tag is stored alongside the ciphertext.
+- On retrieval, the data is automatically decrypted.
+- Date objects are preserved through JSON serialization with a custom encoder.
+
+#### Options
+
+| Option      | Type     | Default         | Description                          |
+| ----------- | -------- | --------------- | ------------------------------------ |
+| `secretKey` | `string` | (required)      | The encryption key.                  |
+| `algorithm` | `string` | `"aes-256-gcm"` | Encryption algorithm.                |
+| `ivSize`    | `number` | `16`            | Initialization vector size in bytes. |
+
+### HashModifier
+
+The `HashModifier` stores a one-way hash of field values. Unlike encryption, hashing is irreversible -- you cannot retrieve the original value. Use this for passwords and other sensitive data that only needs equality verification.
+
+```typescript
+import {
+  Table,
+  Field,
+  HashModifier,
+  Hashed,
+} from "@antelopejs/interface-database-decorators";
+
+class User extends Table.with(HashModifier) {
+  @Field("string")
+  declare email: string;
+
+  @Hashed({ algorithm: "sha256" })
+  @Field("string")
+  declare password: string;
+
+  verifyPassword(plainPassword: string): boolean {
+    return this.testHash("password", plainPassword);
+  }
+}
+```
+
+#### How It Works
+
+- A random salt is generated and stored in the field's metadata on first write.
+- The value is hashed with the salt using the specified algorithm.
+- The `testHash` method (added by the mixin) hashes a candidate value with the stored salt and compares the result.
+
+#### Options
+
+| Option      | Type     | Default    | Description        |
+| ----------- | -------- | ---------- | ------------------ |
+| `algorithm` | `string` | `"sha256"` | Hashing algorithm. |
+
+#### Mixin Method
+
+The `HashModifier` mixin adds a `testHash` method to table instances:
+
+```typescript
+testHash(field: string, value: unknown): boolean
+```
+
+Returns `true` if `value`, when hashed, matches the stored hash for the given field.
+
+### LocalizationModifier
+
+The `LocalizationModifier` stores multiple language versions of a field value. Access a specific locale by calling `localize()` on the table instance.
+
+```typescript
+import {
+  Table,
+  Field,
+  LocalizationModifier,
+  Localized,
+} from "@antelopejs/interface-database-decorators";
+
+class Product extends Table.with(LocalizationModifier) {
+  @Field("number")
+  declare price: number;
+
+  @Localized({ fallbackLocale: "en" })
+  @Field("string")
+  declare name: string;
+
+  @Localized({ fallbackLocale: "en" })
+  @Field("string")
+  declare description: string;
+}
+```
+
+#### Usage
+
+```typescript
+const product = new Product();
+product._id = "prod-123";
+product.price = 99.99;
+
+// Set localized content
+product.localize("en").name = "Premium Headphones";
+product.localize("fr").name = "Casque Premium";
+product.localize("es").name = "Auriculares Premium";
+
+// Read localized content
+const spanish = product.localize("es");
+console.log(spanish.name); // "Auriculares Premium"
+
+// Fallback to default locale when translation is missing
+const german = product.localize("de");
+console.log(german.name); // "Premium Headphones" (fallback)
+```
+
+#### Wildcard Key
+
+The wildcard key `"*"` retrieves or sets all translations at once:
+
+```typescript
+// Get all translations
+const allNames = product.localize("*").name;
+// { en: "Premium Headphones", fr: "Casque Premium", es: "Auriculares Premium" }
+
+// Set all translations
+product.localize("*").name = {
+  en: "Premium Headphones",
+  fr: "Casque Premium",
+  es: "Auriculares Premium",
+  de: "Premium-Kopfhoerer",
+};
+```
+
+#### Options
+
+| Option           | Type     | Description                                             |
+| ---------------- | -------- | ------------------------------------------------------- |
+| `fallbackLocale` | `string` | Locale to use when the requested locale is unavailable. |
+
+#### Mixin Method
+
+The `LocalizationModifier` mixin adds a `localize` method:
+
+```typescript
+localize(locale: string, fields?: Array<keyof this>): this
+```
+
+Sets the active locale for accessing localized fields. If `fields` is provided, only those fields are unlocked for the specified locale.
+
+### AutoDateModifier
+
+The `AutoDateModifier` automatically populates timestamp fields during insert and update operations. Use the `CreationTime` and `UpdateTime` decorators to mark fields.
+
+```typescript
+import {
+  Table,
+  CreationTime,
+  UpdateTime,
+} from "@antelopejs/interface-database-decorators";
+
+class Article extends Table {
+  declare title: string;
+
+  @CreationTime()
+  declare creationDate: Date;
+
+  @UpdateTime()
+  declare updateDate: Date;
+}
+```
+
+#### How It Works
+
+- On insert, both `CreationTime` and `UpdateTime` fields are set to the current date.
+- On update, `UpdateTime` fields are refreshed while `CreationTime` fields are removed from the payload so the original creation date is preserved.
+- This is an event-only modifier: it does not transform stored values and does not require adding a mixin through `Table.with()`.
+
+## Combine Multiple Modifiers
+
+Pass multiple modifier classes to `Table.with()`:
+
+```typescript
+import {
+  Table,
+  Field,
+  EncryptionModifier,
+  HashModifier,
+  LocalizationModifier,
+  Encrypted,
+  Hashed,
+  Localized,
+} from "@antelopejs/interface-database-decorators";
+
+class UserProfile extends Table.with(
+  EncryptionModifier,
+  HashModifier,
+  LocalizationModifier,
+) {
+  @Encrypted({ secretKey: process.env.SECRET_KEY || "default-key" })
+  @Field("any")
+  declare privateInfo: {
+    address: string;
+    phoneNumber: string;
+  };
+
+  @Hashed()
+  @Field("string")
+  declare password: string;
+
+  @Localized({ fallbackLocale: "en" })
+  @Field("string")
+  declare bio: string;
+}
+```
+
+## Create Custom Modifiers
+
+### OneWayModifier
+
+A `OneWayModifier` transforms data in one direction (when writing to the database). Use it for irreversible transformations like hashing.
+
+```typescript
+import {
+  OneWayModifier,
+  MixinSymbol,
+  attachModifier,
+} from "@antelopejs/interface-database-decorators";
+import { MakePropertyDecorator } from "@antelopejs/interface-core/decorators";
+import { createHash } from "crypto";
+
+class PrefixHashModifier extends OneWayModifier<
+  string | undefined,
+  [],
+  {},
+  { algorithm?: string }
+> {
+  public readonly autolock = true;
+
+  public override lock(_locked: string | undefined, value: unknown) {
+    if (value === undefined) return undefined;
+    return createHash(this.options.algorithm || "sha256")
+      .update(JSON.stringify(value))
+      .digest("hex");
+  }
+
+  [MixinSymbol] = class {};
+}
+
+const PrefixHashed = MakePropertyDecorator(
+  (target, propertyKey, options?: { algorithm?: string }) => {
+    attachModifier(
+      target.constructor,
+      PrefixHashModifier,
+      propertyKey,
+      options || {},
+    );
+  },
+);
+```
+
+The generic parameters for `OneWayModifier<LockedType, Args, Meta, Options>` are:
+
+| Parameter    | Description                                          |
+| ------------ | ---------------------------------------------------- |
+| `LockedType` | The type stored in the database after transformation |
+| `Args`       | Additional arguments for `lock` and `test`           |
+| `Meta`       | Per-field metadata stored alongside the value        |
+| `Options`    | Configuration passed via the decorator               |
+
+### TwoWayModifier
+
+A `TwoWayModifier` extends `OneWayModifier` with an `unlock` method for reversible transformations like encryption:
+
+```typescript
+import {
+  TwoWayModifier,
+  MixinSymbol,
+  attachModifier,
+} from "@antelopejs/interface-database-decorators";
+import { MakePropertyDecorator } from "@antelopejs/interface-core/decorators";
+
+class Base64Modifier extends TwoWayModifier<
+  string,
+  [],
+  {},
+  { prefix?: string }
+> {
+  public readonly autolock = true;
+  public readonly autounlock = true;
+
+  public override lock(_locked: string | undefined, value: unknown) {
+    if (value === undefined) return undefined;
+    const prefix = this.options.prefix || "b64-";
+    return `${prefix}${Buffer.from(JSON.stringify(value)).toString("base64")}`;
+  }
+
+  public override unlock(locked: string) {
+    const prefix = this.options.prefix || "b64-";
+    const encoded = locked.substring(prefix.length);
+    return JSON.parse(Buffer.from(encoded, "base64").toString("utf8"));
+  }
+
+  public override unlockrequest(data: any) {
+    return data;
+  }
+
+  [MixinSymbol] = class {};
+}
+
+const Base64Encoded = MakePropertyDecorator(
+  (target, propertyKey, options?: { prefix?: string }) => {
+    attachModifier(
+      target.constructor,
+      Base64Modifier,
+      propertyKey,
+      options || {},
+    );
+  },
+);
+```
+
+### ContainerModifier
+
+For modifiers that store multiple values in a key-value structure (like `LocalizationModifier`), extend `ContainerModifier`. It provides built-in support for the wildcard key `"*"` for bulk operations:
+
+```typescript
+import { ContainerModifier } from "@antelopejs/interface-database-decorators";
+
+class MyContainerModifier extends ContainerModifier<{}, { fallback?: string }> {
+  // Override unlock() to add fallback behavior
+  // Override unlockrequest() for query-time data access
+}
+```
+
+## Modifier Events
+
+Modifiers can hook into the data lifecycle by implementing event handler methods. These methods are called during data conversion and database operations:
+
+| Event           | Triggered When                             |
+| --------------- | ------------------------------------------ |
+| `fromPlainData` | After converting plain data to an instance |
+| `toPlainData`   | After converting an instance to plain data |
+| `fromDatabase`  | After reading from the database            |
+| `toDatabase`    | Before writing to the database             |
+| `insert`        | Before inserting a new record              |
+| `update`        | Before updating an existing record         |
+
+```typescript
+import {
+  Modifier,
+  MixinSymbol,
+} from "@antelopejs/interface-database-decorators";
+
+class TimestampModifier extends Modifier {
+  public insert(instance: any, field: string) {
+    if (field === "createdAt" && !instance[field]) {
+      instance[field] = new Date();
+    }
+  }
+
+  public update(instance: any, field: string) {
+    if (field === "updatedAt") {
+      instance[field] = new Date();
+    }
+  }
+
+  [MixinSymbol] = class {};
+}
+```
+
+Event-only modifiers (without `lock`/`unlock`) are valid and useful for side effects like logging, validation, or auto-populating fields.

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.