@antelopejs/interface-database-decorators 0.1.2 → 0.1.4

package/dist/index.d.ts

@@ -3,5 +3,6 @@ export * from "./common";
 export * from "./database";
 export * from "./model";
 export * from "./modifiers";
+export * from "./relation";
 export * from "./schema";
 export * from "./table";

package/dist/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./common"), exports);
 __exportStar(require("./database"), exports);
 __exportStar(require("./model"), exports);
 __exportStar(require("./modifiers"), exports);
+__exportStar(require("./relation"), exports);
 __exportStar(require("./schema"), exports);
 __exportStar(require("./table"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4BAA0B;AAE1B,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,8CAA4B;AAC5B,2CAAyB;AACzB,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4BAA0B;AAE1B,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,8CAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB;AACzB,0CAAwB"}

package/dist/relation.d.ts

@@ -0,0 +1,42 @@
+import type { Table } from "./table";
+/**
+ * Options for the {@link Relation} decorator.
+ */
+export interface RelationOptions {
+    /**
+     * Thunk returning the target Table class (lazy to allow forward references).
+     */
+    to: () => typeof Table;
+    /**
+     * Field on the target table the relation points to. Defaults to the target
+     * table's primary key.
+     */
+    toField?: string;
+    /**
+     * The decorated field holds multiple target keys (many targets per source
+     * record).
+     */
+    many?: boolean;
+}
+/**
+ * Relation Metadata.
+ */
+export declare class RelationStaticMetadata {
+    static key: symbol;
+    readonly relations: Record<string, RelationOptions>;
+}
+/**
+ * Database Table Relation decorator.
+ *
+ * Declarative metadata only: database implementations do not enforce it (no
+ * foreign key constraint, no referential validation). It is consumed by
+ * introspection tooling to expose the links between tables.
+ *
+ * Available options:
+ * - `to`: Thunk returning the target Table class.
+ * - `toField`: Target field name (defaults to the target's primary key).
+ * - `many`: Whether the field holds multiple target keys.
+ *
+ * @param options Options
+ */
+export declare const Relation: (options: RelationOptions) => import("@antelopejs/interface-core/decorators").PropertyDecorator;

package/dist/relation.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Relation = exports.RelationStaticMetadata = void 0;
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const common_1 = require("./common");
+/**
+ * Relation Metadata.
+ */
+class RelationStaticMetadata {
+    static key = Symbol();
+    relations = {};
+}
+exports.RelationStaticMetadata = RelationStaticMetadata;
+/**
+ * Database Table Relation decorator.
+ *
+ * Declarative metadata only: database implementations do not enforce it (no
+ * foreign key constraint, no referential validation). It is consumed by
+ * introspection tooling to expose the links between tables.
+ *
+ * Available options:
+ * - `to`: Thunk returning the target Table class.
+ * - `toField`: Target field name (defaults to the target's primary key).
+ * - `many`: Whether the field holds multiple target keys.
+ *
+ * @param options Options
+ */
+exports.Relation = (0, decorators_1.MakePropertyDecorator)((target, propertyKey, options) => {
+    const metadata = (0, common_1.getMetadata)(target.constructor, RelationStaticMetadata);
+    metadata.relations[String(propertyKey)] = options;
+});
+//# sourceMappingURL=relation.js.map

package/dist/relation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.js","sourceRoot":"","sources":["../src/relation.ts"],"names":[],"mappings":";;;AAAA,sEAA8E;AAC9E,qCAAuC;AAuBvC;;GAEG;AACH,MAAa,sBAAsB;IAC1B,MAAM,CAAC,GAAG,GAAG,MAAM,EAAE,CAAC;IAEb,SAAS,GAAoC,EAAE,CAAC;;AAHlE,wDAIC;AAED;;;;;;;;;;;;;GAaG;AACU,QAAA,QAAQ,GAAG,IAAA,kCAAqB,EAC3C,CAAC,MAAM,EAAE,WAAW,EAAE,OAAwB,EAAE,EAAE;IAChD,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,MAAM,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;IACzE,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,OAAO,CAAC;AACpD,CAAC,CACF,CAAC"}

package/dist/tests/relation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/relation.test.js

@@ -0,0 +1,112 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@antelopejs/interface-database-decorators/common");
+const relation_1 = require("@antelopejs/interface-database-decorators/relation");
+const table_1 = require("@antelopejs/interface-database-decorators/table");
+const chai_1 = require("chai");
+describe("Relation - Relation decorator", () => {
+    it("stores relation options in metadata", async () => StoreRelationOptionsInMetadataTest());
+    it("stores toField and many options", async () => StoreToFieldAndManyOptionsTest());
+    it("supports multiple relations on one class", async () => SupportMultipleRelationsOnOneClassTest());
+    it("resolves forward references through the thunk", async () => ResolveForwardReferencesThroughThunkTest());
+    it("keeps metadata separate between classes", async () => KeepMetadataSeparateBetweenClassesTest());
+});
+async function StoreRelationOptionsInMetadataTest() {
+    class TargetTable extends table_1.Table {
+        name;
+    }
+    class SourceTable extends table_1.Table {
+        target;
+    }
+    __decorate([
+        (0, relation_1.Relation)({ to: () => TargetTable }),
+        __metadata("design:type", String)
+    ], SourceTable.prototype, "target", void 0);
+    const metadata = (0, common_1.getMetadata)(SourceTable, relation_1.RelationStaticMetadata);
+    (0, chai_1.expect)(metadata.relations).to.have.property("target");
+    (0, chai_1.expect)(metadata.relations.target.to()).to.equal(TargetTable);
+    (0, chai_1.expect)(metadata.relations.target.toField).to.equal(undefined);
+    (0, chai_1.expect)(metadata.relations.target.many).to.equal(undefined);
+}
+async function StoreToFieldAndManyOptionsTest() {
+    class TargetTable extends table_1.Table {
+        code;
+    }
+    class SourceTable extends table_1.Table {
+        targets;
+    }
+    __decorate([
+        (0, relation_1.Relation)({ to: () => TargetTable, toField: "code", many: true }),
+        __metadata("design:type", Array)
+    ], SourceTable.prototype, "targets", void 0);
+    const metadata = (0, common_1.getMetadata)(SourceTable, relation_1.RelationStaticMetadata);
+    (0, chai_1.expect)(metadata.relations.targets.toField).to.equal("code");
+    (0, chai_1.expect)(metadata.relations.targets.many).to.equal(true);
+}
+async function SupportMultipleRelationsOnOneClassTest() {
+    class UserTable extends table_1.Table {
+        name;
+    }
+    class RoleTable extends table_1.Table {
+        label;
+    }
+    class SourceTable extends table_1.Table {
+        owner;
+        roles;
+    }
+    __decorate([
+        (0, relation_1.Relation)({ to: () => UserTable }),
+        __metadata("design:type", String)
+    ], SourceTable.prototype, "owner", void 0);
+    __decorate([
+        (0, relation_1.Relation)({ to: () => RoleTable, many: true }),
+        __metadata("design:type", Array)
+    ], SourceTable.prototype, "roles", void 0);
+    const metadata = (0, common_1.getMetadata)(SourceTable, relation_1.RelationStaticMetadata);
+    (0, chai_1.expect)(Object.keys(metadata.relations)).to.have.members(["owner", "roles"]);
+    (0, chai_1.expect)(metadata.relations.owner.to()).to.equal(UserTable);
+    (0, chai_1.expect)(metadata.relations.roles.to()).to.equal(RoleTable);
+}
+async function ResolveForwardReferencesThroughThunkTest() {
+    class SourceTable extends table_1.Table {
+        later;
+    }
+    __decorate([
+        (0, relation_1.Relation)({ to: () => LaterTable }),
+        __metadata("design:type", String)
+    ], SourceTable.prototype, "later", void 0);
+    class LaterTable extends table_1.Table {
+        name;
+    }
+    const metadata = (0, common_1.getMetadata)(SourceTable, relation_1.RelationStaticMetadata);
+    (0, chai_1.expect)(metadata.relations.later.to()).to.equal(LaterTable);
+}
+async function KeepMetadataSeparateBetweenClassesTest() {
+    class TargetTable extends table_1.Table {
+        name;
+    }
+    class FirstTable extends table_1.Table {
+        target;
+    }
+    __decorate([
+        (0, relation_1.Relation)({ to: () => TargetTable }),
+        __metadata("design:type", String)
+    ], FirstTable.prototype, "target", void 0);
+    class SecondTable extends table_1.Table {
+        other;
+    }
+    const firstMetadata = (0, common_1.getMetadata)(FirstTable, relation_1.RelationStaticMetadata);
+    const secondMetadata = (0, common_1.getMetadata)(SecondTable, relation_1.RelationStaticMetadata);
+    (0, chai_1.expect)(firstMetadata.relations).to.have.property("target");
+    (0, chai_1.expect)(secondMetadata.relations).to.not.have.property("target");
+}
+//# sourceMappingURL=relation.test.js.map

package/dist/tests/relation.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.test.js","sourceRoot":"","sources":["../../src/tests/relation.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,6EAA+E;AAC/E,iFAG4D;AAC5D,2EAAwE;AACxE,+BAA8B;AAE9B,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE,CACnD,kCAAkC,EAAE,CAAC,CAAC;IACxC,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE,CAC/C,8BAA8B,EAAE,CAAC,CAAC;IACpC,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE,CACxD,sCAAsC,EAAE,CAAC,CAAC;IAC5C,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE,CAC7D,wCAAwC,EAAE,CAAC,CAAC;IAC9C,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE,CACvD,sCAAsC,EAAE,CAAC,CAAC;AAC9C,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,kCAAkC;IAC/C,MAAM,WAAY,SAAQ,aAAK;QAC7B,IAAI,CAAU;KACf;IAED,MAAM,WAAY,SAAQ,aAAK;QAE7B,MAAM,CAAU;KACjB;IADC;QADC,IAAA,mBAAQ,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;;+CACpB;IAGlB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,WAAW,EAAE,iCAAsB,CAAC,CAAC;IAClE,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC7D,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC9D,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAC7D,CAAC;AAED,KAAK,UAAU,8BAA8B;IAC3C,MAAM,WAAY,SAAQ,aAAK;QAC7B,IAAI,CAAU;KACf;IAED,MAAM,WAAY,SAAQ,aAAK;QAE7B,OAAO,CAAY;KACpB;IADC;QADC,IAAA,mBAAQ,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;gDAC9C;IAGrB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,WAAW,EAAE,iCAAsB,CAAC,CAAC;IAClE,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5D,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC;AAED,KAAK,UAAU,sCAAsC;IACnD,MAAM,SAAU,SAAQ,aAAK;QAC3B,IAAI,CAAU;KACf;IAED,MAAM,SAAU,SAAQ,aAAK;QAC3B,KAAK,CAAU;KAChB;IAED,MAAM,WAAY,SAAQ,aAAK;QAE7B,KAAK,CAAU;QAGf,KAAK,CAAY;KAClB;IAJC;QADC,IAAA,mBAAQ,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC;;8CACnB;IAGf;QADC,IAAA,mBAAQ,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;8CAC7B;IAGnB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,WAAW,EAAE,iCAAsB,CAAC,CAAC;IAClE,IAAA,aAAM,EAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5E,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC1D,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAC5D,CAAC;AAED,KAAK,UAAU,wCAAwC;IACrD,MAAM,WAAY,SAAQ,aAAK;QAE7B,KAAK,CAAU;KAChB;IADC;QADC,IAAA,mBAAQ,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,CAAC;;8CACpB;IAGjB,MAAM,UAAW,SAAQ,aAAK;QAC5B,IAAI,CAAU;KACf;IAED,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,WAAW,EAAE,iCAAsB,CAAC,CAAC;IAClE,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAC7D,CAAC;AAED,KAAK,UAAU,sCAAsC;IACnD,MAAM,WAAY,SAAQ,aAAK;QAC7B,IAAI,CAAU;KACf;IAED,MAAM,UAAW,SAAQ,aAAK;QAE5B,MAAM,CAAU;KACjB;IADC;QADC,IAAA,mBAAQ,EAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;;8CACpB;IAGlB,MAAM,WAAY,SAAQ,aAAK;QAC7B,KAAK,CAAU;KAChB;IAED,MAAM,aAAa,GAAG,IAAA,oBAAW,EAAC,UAAU,EAAE,iCAAsB,CAAC,CAAC;IACtE,MAAM,cAAc,GAAG,IAAA,oBAAW,EAAC,WAAW,EAAE,iCAAsB,CAAC,CAAC;IACxE,IAAA,aAAM,EAAC,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC3D,IAAA,aAAM,EAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAClE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/interface-database-decorators",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "AntelopeJS interface for database schema decorators and model definitions",
   "keywords": [
     "antelopejs",
@@ -37,6 +37,10 @@
       "types": "./dist/model.d.ts",
       "default": "./dist/model.js"
     },
+    "./relation": {
+      "types": "./dist/relation.d.ts",
+      "default": "./dist/relation.js"
+    },
     "./schema": {
       "types": "./dist/schema.d.ts",
       "default": "./dist/schema.js"
@@ -73,13 +77,13 @@
     "test": "pnpm run build && ajs module test ."
   },
   "dependencies": {
-    "@antelopejs/interface-api": "^0.0.3",
-    "@antelopejs/interface-core": "^0.0.3",
-    "@antelopejs/interface-database": "^0.1.1",
     "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",
     "@types/chai": "^4.3.20",
     "@types/mocha": "^10.0.10",
@@ -93,6 +97,11 @@
     "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"
   },
@@ -107,6 +116,9 @@
       "model": [
         "dist/model.d.ts"
       ],
+      "relation": [
+        "dist/relation.d.ts"
+      ],
       "schema": [
         "dist/schema.d.ts"
       ],