@antelopejs/interface-database-decorators 0.1.6 → 0.1.7

package/package.json

@@ -1,27 +1,63 @@
 {
   "name": "@antelopejs/interface-database-decorators",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "AntelopeJS interface for database schema decorators and model definitions",
   "keywords": [
     "antelopejs",
-    "interface",
     "database",
     "decorators",
+    "interface",
     "orm"
   ],
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AntelopeJS/interface-database-decorators.git"
   },
-  "license": "Apache-2.0",
-  "packageManager": "pnpm@10.6.5",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
   "files": [
     "dist",
     "docs",
     "skills"
   ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "common": [
+        "dist/common.d.ts"
+      ],
+      "database": [
+        "dist/database.d.ts"
+      ],
+      "model": [
+        "dist/model.d.ts"
+      ],
+      "relation": [
+        "dist/relation.d.ts"
+      ],
+      "schema": [
+        "dist/schema.d.ts"
+      ],
+      "table": [
+        "dist/table.d.ts"
+      ],
+      "modifiers/autodate": [
+        "dist/modifiers/autodate.d.ts"
+      ],
+      "modifiers/common": [
+        "dist/modifiers/common.d.ts"
+      ],
+      "modifiers/encryption": [
+        "dist/modifiers/encryption.d.ts"
+      ],
+      "modifiers/hash": [
+        "dist/modifiers/hash.d.ts"
+      ],
+      "modifiers/localization": [
+        "dist/modifiers/localization.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -73,81 +109,54 @@
     },
     "./package.json": "./package.json"
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "scripts": {
     "build": "rimraf dist && tsc",
-    "format": "biome format --write .",
-    "lint:fix": "biome check --write .",
-    "lint": "biome check .",
+    "format": "oxfmt .",
+    "lint:fix": "oxlint --fix",
+    "lint": "oxlint",
     "prepack": "pnpm run build",
     "release": "pnpm run lint && pnpm run prepack && release-it",
-    "test": "pnpm run build && ajs module test ."
+    "test": "pnpm run build && ajs module test .",
+    "format:check": "oxfmt --check .",
+    "knip": "knip"
   },
   "dependencies": {
     "randomstring": "^1.3.1",
     "reflect-metadata": "^0.2.2"
   },
   "devDependencies": {
-    "@antelopejs/interface-api": "^0.0.5",
-    "@antelopejs/interface-core": "^0.0.5",
-    "@antelopejs/interface-database": "^0.1.3",
-    "@biomejs/biome": "2.3.2",
+    "@antelopejs/core": "^1.9.1",
+    "@antelopejs/interface-api": "^0.0.13",
+    "@antelopejs/interface-core": "^0.1.1",
+    "@antelopejs/interface-database": "^0.1.8",
+    "@antelopejs/tooling-configs": "^0.0.6",
     "@types/chai": "^4.3.20",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.19.15",
     "@types/randomstring": "^1.3.0",
     "@types/semver": "^7.7.1",
     "chai": "^4.5.0",
+    "eslint-plugin-perfectionist": "^5.11.0",
+    "knip": "^6.34.0",
     "mongodb-memory-server-core": "^10.4.3",
+    "oxfmt": "^0.66.0",
+    "oxlint": "1.81.0",
+    "oxlint-tsgolint": "^7.0.2001",
     "release-it": "^19.2.4",
     "release-it-changelogen": "^0.1.0",
     "rimraf": "^6.1.3",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@antelopejs/interface-api": ">=0.0.3 <1.0.0",
-    "@antelopejs/interface-core": ">=0.0.3 <1.0.0",
-    "@antelopejs/interface-database": ">=0.1.1 <1.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "typesVersions": {
-    "*": {
-      "common": [
-        "dist/common.d.ts"
-      ],
-      "database": [
-        "dist/database.d.ts"
-      ],
-      "model": [
-        "dist/model.d.ts"
-      ],
-      "relation": [
-        "dist/relation.d.ts"
-      ],
-      "schema": [
-        "dist/schema.d.ts"
-      ],
-      "table": [
-        "dist/table.d.ts"
-      ],
-      "modifiers/autodate": [
-        "dist/modifiers/autodate.d.ts"
-      ],
-      "modifiers/common": [
-        "dist/modifiers/common.d.ts"
-      ],
-      "modifiers/encryption": [
-        "dist/modifiers/encryption.d.ts"
-      ],
-      "modifiers/hash": [
-        "dist/modifiers/hash.d.ts"
-      ],
-      "modifiers/localization": [
-        "dist/modifiers/localization.d.ts"
-      ]
-    }
+    "@antelopejs/interface-api": ">=0.0.13 <1.0.0",
+    "@antelopejs/interface-core": ">=0.1.1 <1.0.0",
+    "@antelopejs/interface-database": ">=0.1.8 <1.0.0"
   },
+  "packageManager": "pnpm@10.6.5",
   "antelopeJs": {
     "standalone": true,
     "test": "src/antelope.test.ts",

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

@@ -15,17 +15,50 @@ Peer interfaces required: `@antelopejs/interface-core`, `@antelopejs/interface-a
 ## Imports
 
 ```typescript
-import { Table, Field, Index, Fixture } from "@antelopejs/interface-database-decorators/table";
-import { RegisterTable, getTablesForSchema } from "@antelopejs/interface-database-decorators/schema";
+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 {
+  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";
+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).
@@ -36,7 +69,8 @@ The package root re-exports everything above and also imports `reflect-metadata`
 @RegisterTable("recipes", "cookbook") // (tableName, schemaName)
 class Recipe extends Table {
   // _id: string is inherited as the primary key
-  @Index() @Field("string")
+  @Index()
+  @Field("string")
   declare slug: string;
   @Field("string")
   declare tagline: string;
@@ -46,7 +80,10 @@ const RecipeModel = BasicDataModel(Recipe); // table name taken from @RegisterTa
 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 });
+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" });
@@ -68,12 +105,16 @@ class RecipesController extends Controller("/recipes") {
 ## Field modifiers
 
 ```typescript
-class Chef extends Table.with(HashModifier, EncryptionModifier, LocalizationModifier) {
-  @Hashed() declare passphrase: string;                   // one-way; test via instance.testHash("passphrase", value)
+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
+  @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
 }
 ```
 
@@ -91,6 +132,9 @@ class Chef extends Table.with(HashModifier, EncryptionModifier, LocalizationModi
   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).
+- Indexes are scoped to the schema instance. Add `@Index({ crossInstance: true })` only for indexes also queried
+  across all instances (`CROSS_INSTANCE`); it never changes results, only speed. On a group, one member setting it
+  applies it to the whole group.
 - `@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`).