@antelopejs/interface-database-decorators 0.1.11 → 0.2.0

package/dist/tests/row_forms.test.js

@@ -0,0 +1,59 @@
+"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 chai_1 = require("chai");
+const model_1 = require("../model");
+const localization_1 = require("../modifiers/localization");
+const common_1 = require("../modifiers/common");
+const table_1 = require("../table");
+class Article extends table_1.Table.with(localization_1.LocalizationModifier) {
+}
+__decorate([
+    (0, localization_1.Localized)({ fallbackLocale: "en" }),
+    __metadata("design:type", String)
+], Article.prototype, "title", void 0);
+__decorate([
+    (0, table_1.Field)("number"),
+    __metadata("design:type", Number)
+], Article.prototype, "views", void 0);
+const ArticleModel = (0, model_1.BasicDataModel)(Article, "articles");
+describe("Row forms", () => {
+    it("reads a localized field given per locale", () => {
+        const article = ArticleModel.fromPlainData({
+            title: { en: "Hello", fr: "Salut" },
+        }).localize("*");
+        (0, chai_1.expect)(article.localize("fr").title).to.equal("Salut");
+        (0, chai_1.expect)(article.localize("en").title).to.equal("Hello");
+    });
+    it("locks a value given in the plain form once its locale is known", () => {
+        const article = ArticleModel.fromPlainData({
+            title: "Bonjour",
+            views: 2,
+        }).localize("fr");
+        (0, chai_1.expect)(ArticleModel.toDatabase(article)._internal?.data.title).to.deep.equal({ fr: "Bonjour" });
+    });
+    it("leaves the locked fields out of the plain form", () => {
+        const article = ArticleModel.fromPlainData({ title: "Hi" }).localize("en");
+        const plain = (0, common_1.toPlainData)(article);
+        (0, chai_1.expect)(plain).to.deep.equal({ title: "Hi" });
+    });
+    it("gives back a stored row as an instance of its table", () => {
+        const written = ArticleModel.fromPlainData({
+            title: "Hi",
+            views: 3,
+        }).localize("en");
+        const read = (0, common_1.fromDatabase)((0, common_1.toDatabase)(written), Article);
+        (0, chai_1.expect)(read).to.be.instanceOf(Article);
+        (0, chai_1.expect)(read.views).to.equal(3);
+        (0, chai_1.expect)(read.localize("en").title).to.equal("Hi");
+    });
+});
+//# sourceMappingURL=row_forms.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"row_forms.test.js","sourceRoot":"","sources":["../../src/tests/row_forms.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+BAA8B;AAE9B,oCAA0C;AAC1C,4DAA4E;AAC5E,gDAA4E;AAC5E,oCAAwC;AAExC,MAAM,OAAQ,SAAQ,aAAK,CAAC,IAAI,CAAC,mCAAoB,CAAC;CAMrD;AAJS;IADP,IAAA,wBAAS,EAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC;;sCACd;AAGd;IADP,IAAA,aAAK,EAAC,QAAQ,CAAC;;sCACM;AAGxB,MAAM,YAAY,GAAG,IAAA,sBAAc,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAEzD,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC;YACzC,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE;SACpC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAEjB,IAAA,aAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvD,IAAA,aAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC;YACzC,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,CAAC;SACT,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAElB,IAAA,aAAM,EACJ,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CACvD,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE3E,MAAM,KAAK,GAAG,IAAA,oBAAW,EAAC,OAAO,CAAC,CAAC;QAEnC,IAAA,aAAM,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC;YACzC,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,CAAC;SACT,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAElB,MAAM,IAAI,GAAG,IAAA,qBAAY,EAAC,IAAA,mBAAU,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QAExD,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvC,IAAA,aAAM,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAA,aAAM,EAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

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

package/dist/tests/stored_metadata.test.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const table_1 = require("../table");
+const common_1 = require("../common");
+/**
+ * The table metadata as copies 0.1.8 and 0.1.9 of the package store it under
+ * the shared metadata key, before `uniqueIndexes` was added to its shape.
+ */
+class LegacyDatumStaticMetadata {
+    tableName;
+    schemaName;
+    indexes = {};
+    crossInstanceIndexes = new Set();
+    fields = {};
+    primary = "_id";
+    generator;
+    schema;
+    addIndex(key, group, isCrossInstance = false) {
+        if (!Object.hasOwn(this.indexes, group)) {
+            this.indexes[group] = [];
+        }
+        this.indexes[group].push(key);
+        if (isCrossInstance) {
+            this.crossInstanceIndexes.add(group);
+        }
+    }
+}
+function declaredByLegacyCopy(tableClass) {
+    const legacy = new LegacyDatumStaticMetadata();
+    legacy.tableName = "legacy_rows";
+    legacy.schemaName = "legacy-schema";
+    legacy.primary = "code";
+    legacy.addIndex("email", "email");
+    legacy.addIndex("name", "search", true);
+    legacy.addIndex("city", "search");
+    Reflect.defineMetadata(common_1.DatumStaticMetadata.key, legacy, tableClass);
+    return legacy;
+}
+describe("Metadata - stored by an older copy of the package", () => {
+    it("reads the metadata as the current shape", async () => {
+        class Row extends table_1.Table {
+        }
+        declaredByLegacyCopy(Row);
+        const metadata = (0, common_1.getMetadata)(Row, common_1.DatumStaticMetadata);
+        (0, chai_1.expect)(metadata).to.be.instanceOf(common_1.DatumStaticMetadata);
+        (0, chai_1.expect)([...metadata.uniqueIndexes]).to.deep.equal([]);
+        (0, chai_1.expect)(metadata.uniqueIndexes.has("email")).to.equal(false);
+    });
+    it("keeps what the older copy stored", async () => {
+        class Row extends table_1.Table {
+        }
+        declaredByLegacyCopy(Row);
+        const metadata = (0, common_1.getMetadata)(Row, common_1.DatumStaticMetadata);
+        (0, chai_1.expect)(metadata.tableName).to.equal("legacy_rows");
+        (0, chai_1.expect)(metadata.schemaName).to.equal("legacy-schema");
+        (0, chai_1.expect)(metadata.primary).to.equal("code");
+        (0, chai_1.expect)(metadata.indexes).to.deep.equal({
+            email: ["email"],
+            search: ["name", "city"],
+        });
+        (0, chai_1.expect)([...metadata.crossInstanceIndexes]).to.deep.equal(["search"]);
+    });
+    it("answers the same metadata on every read", async () => {
+        class Row extends table_1.Table {
+        }
+        declaredByLegacyCopy(Row);
+        (0, chai_1.expect)((0, common_1.getMetadata)(Row, common_1.DatumStaticMetadata)).to.equal((0, common_1.getMetadata)(Row, common_1.DatumStaticMetadata));
+    });
+    it("records a unique index declared after the older copy", async () => {
+        class Row extends table_1.Table {
+        }
+        declaredByLegacyCopy(Row);
+        (0, table_1.Index)({ unique: true })(Row.prototype, "code");
+        const metadata = (0, common_1.getMetadata)(Row, common_1.DatumStaticMetadata);
+        (0, chai_1.expect)([...metadata.uniqueIndexes]).to.deep.equal(["code"]);
+        (0, chai_1.expect)(metadata.indexes.code).to.deep.equal(["code"]);
+    });
+    it("starts a subclass from the metadata the older copy stored", async () => {
+        class Base extends table_1.Table {
+        }
+        declaredByLegacyCopy(Base);
+        class Child extends Base {
+        }
+        const metadata = (0, common_1.getMetadata)(Child, common_1.DatumStaticMetadata);
+        (0, chai_1.expect)(metadata).to.be.instanceOf(common_1.DatumStaticMetadata);
+        (0, chai_1.expect)(metadata.uniqueIndexes.has("email")).to.equal(false);
+        (0, chai_1.expect)(metadata.indexes).to.have.property("email");
+    });
+});
+//# sourceMappingURL=stored_metadata.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"stored_metadata.test.js","sourceRoot":"","sources":["../../src/tests/stored_metadata.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,oCAAwC;AACxC,sCAA6D;AAE7D;;;GAGG;AACH,MAAM,yBAAyB;IACtB,SAAS,CAAU;IACnB,UAAU,CAAU;IACX,OAAO,GAAkC,EAAE,CAAC;IAC5C,oBAAoB,GAAG,IAAI,GAAG,EAAU,CAAC;IACzC,MAAM,GAAkC,EAAE,CAAC;IACpD,OAAO,GAAW,KAAK,CAAC;IACxB,SAAS,CAAoC;IAC7C,MAAM,CAAiC;IAE9C,QAAQ,CAAC,GAAW,EAAE,KAAa,EAAE,kBAA2B,KAAK;QACnE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,UAAwB;IACpD,MAAM,MAAM,GAAG,IAAI,yBAAyB,EAAE,CAAC;IAC/C,MAAM,CAAC,SAAS,GAAG,aAAa,CAAC;IACjC,MAAM,CAAC,UAAU,GAAG,eAAe,CAAC;IACpC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACxC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAClC,OAAO,CAAC,cAAc,CAAC,4BAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IACpE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,QAAQ,CAAC,mDAAmD,EAAE,GAAG,EAAE;IACjE,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,GAAI,SAAQ,aAAK;SAAG;QAC1B,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,GAAG,EAAE,4BAAmB,CAAC,CAAC;QAEvD,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,4BAAmB,CAAC,CAAC;QACvD,IAAA,aAAM,EAAC,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,GAAI,SAAQ,aAAK;SAAG;QAC1B,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,GAAG,EAAE,4BAAmB,CAAC,CAAC;QAEvD,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACnD,IAAA,aAAM,EAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACrC,KAAK,EAAE,CAAC,OAAO,CAAC;YAChB,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;SACzB,CAAC,CAAC;QACH,IAAA,aAAM,EAAC,CAAC,GAAG,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,GAAI,SAAQ,aAAK;SAAG;QAC1B,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAE1B,IAAA,aAAM,EAAC,IAAA,oBAAW,EAAC,GAAG,EAAE,4BAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACpD,IAAA,oBAAW,EAAC,GAAG,EAAE,4BAAmB,CAAC,CACtC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,GAAI,SAAQ,aAAK;SAAG;QAC1B,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAE1B,IAAA,aAAK,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAE/C,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,GAAG,EAAE,4BAAmB,CAAC,CAAC;QACvD,IAAA,aAAM,EAAC,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,IAAK,SAAQ,aAAK;SAAG;QAC3B,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,KAAM,SAAQ,IAAI;SAAG;QAE3B,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,KAAK,EAAE,4BAAmB,CAAC,CAAC;QAEzD,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,4BAAmB,CAAC,CAAC;QACvD,IAAA,aAAM,EAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

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

package/dist/tests/subclass_schema_binding.test.js

@@ -0,0 +1,115 @@
+"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 chai_1 = require("chai");
+const interface_database_1 = require("@antelopejs/interface-database");
+const common_1 = require("../common");
+const bound_schema_1 = require("../internal/bound-schema");
+const schema_1 = require("../schema");
+const database_1 = require("../database");
+const model_1 = require("../model");
+const table_1 = require("../table");
+describe("Schema binding - subclasses of a table", () => {
+    it("binds a subclass whose model is built before RegisterSchema ran", async () => {
+        let Users = class Users extends table_1.Table {
+        };
+        __decorate([
+            (0, table_1.Field)("string"),
+            __metadata("design:type", String)
+        ], Users.prototype, "name", void 0);
+        Users = __decorate([
+            (0, schema_1.RegisterTable)("binding_users", "binding-before-schema")
+        ], Users);
+        class Admin extends Users {
+        }
+        const AdminModel = (0, model_1.BasicDataModel)(Admin);
+        await (0, database_1.RegisterSchema)("binding-before-schema");
+        const model = (0, model_1.GetModel)(AdminModel, "binding-instance");
+        (0, chai_1.expect)(model.database.build()[0]).to.deep.include({
+            stage: "schema",
+            options: { id: "binding-before-schema" },
+        });
+        (0, chai_1.expect)(Admin.table().build()[0]).to.deep.include({
+            stage: "schema",
+            options: { id: "binding-before-schema" },
+        });
+    });
+    it("binds a subclass declared after RegisterSchema ran", async () => {
+        let Users = class Users extends table_1.Table {
+        };
+        __decorate([
+            (0, table_1.Field)("string"),
+            __metadata("design:type", String)
+        ], Users.prototype, "name", void 0);
+        Users = __decorate([
+            (0, schema_1.RegisterTable)("binding_late_users", "binding-after-schema")
+        ], Users);
+        await (0, database_1.RegisterSchema)("binding-after-schema");
+        class Admin extends Users {
+        }
+        const model = (0, model_1.GetModel)((0, model_1.BasicDataModel)(Admin), "binding-instance");
+        (0, chai_1.expect)(model.database.build()[0]).to.deep.include({
+            stage: "schema",
+            options: { id: "binding-after-schema" },
+        });
+        (0, chai_1.expect)(Admin.table().build()[0]).to.deep.include({
+            stage: "schema",
+            options: { id: "binding-after-schema" },
+        });
+    });
+    it("binds a subclass that registers its own table to its own schema", async () => {
+        let Parent = class Parent extends table_1.Table {
+        };
+        __decorate([
+            (0, table_1.Field)("string"),
+            __metadata("design:type", String)
+        ], Parent.prototype, "name", void 0);
+        Parent = __decorate([
+            (0, schema_1.RegisterTable)("binding_parents", "binding-parent-schema")
+        ], Parent);
+        let Child = class Child extends Parent {
+        };
+        Child = __decorate([
+            (0, schema_1.RegisterTable)("binding_children", "binding-child-schema")
+        ], Child);
+        await (0, database_1.RegisterSchema)("binding-parent-schema");
+        await (0, database_1.RegisterSchema)("binding-child-schema");
+        (0, chai_1.expect)(Parent.table().build()[0]).to.deep.include({
+            stage: "schema",
+            options: { id: "binding-parent-schema" },
+        });
+        (0, chai_1.expect)(Child.table().build()[0]).to.deep.include({
+            stage: "schema",
+            options: { id: "binding-child-schema" },
+        });
+    });
+    it("follows the schema its parent is bound to when RegisterSchema runs again", async () => {
+        let Users = class Users extends table_1.Table {
+        };
+        __decorate([
+            (0, table_1.Field)("string"),
+            __metadata("design:type", String)
+        ], Users.prototype, "name", void 0);
+        Users = __decorate([
+            (0, schema_1.RegisterTable)("binding_rebound", "binding-rebound-schema")
+        ], Users);
+        await (0, database_1.RegisterSchema)("binding-rebound-schema");
+        class Admin extends Users {
+        }
+        const adminMetadata = (0, common_1.getMetadata)(Admin, common_1.DatumStaticMetadata);
+        const first = (0, bound_schema_1.boundSchema)(adminMetadata);
+        await (0, database_1.RegisterSchema)("binding-rebound-schema");
+        const second = interface_database_1.Schema.get("binding-rebound-schema");
+        (0, chai_1.expect)(second).to.not.equal(first);
+        (0, chai_1.expect)((0, bound_schema_1.boundSchema)(adminMetadata)).to.equal(second);
+    });
+});
+//# sourceMappingURL=subclass_schema_binding.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"subclass_schema_binding.test.js","sourceRoot":"","sources":["../../src/tests/subclass_schema_binding.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+BAA8B;AAC9B,uEAAwD;AACxD,sCAA6D;AAC7D,2DAAuD;AACvD,sCAA0C;AAC1C,0CAA6C;AAC7C,oCAAoD;AACpD,oCAAwC;AAExC,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;IACtD,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAE/E,IAAM,KAAK,GAAX,MAAM,KAAM,SAAQ,aAAK;SAGxB,CAAA;QADS;YADP,IAAA,aAAK,EAAC,QAAQ,CAAC;;2CACK;QAFjB,KAAK;YADV,IAAA,sBAAa,EAAC,eAAe,EAAE,uBAAuB,CAAC;WAClD,KAAK,CAGV;QACD,MAAM,KAAM,SAAQ,KAAK;SAAG;QAE5B,MAAM,UAAU,GAAG,IAAA,sBAAc,EAAC,KAAK,CAAC,CAAC;QACzC,MAAM,IAAA,yBAAc,EAAC,uBAAuB,CAAC,CAAC;QAE9C,MAAM,KAAK,GAAG,IAAA,gBAAQ,EAAC,UAAU,EAAE,kBAAkB,CAAC,CAAC;QACvD,IAAA,aAAM,EAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YAChD,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,uBAAuB,EAAE;SACzC,CAAC,CAAC;QACH,IAAA,aAAM,EAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YAC/C,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,uBAAuB,EAAE;SACzC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAElE,IAAM,KAAK,GAAX,MAAM,KAAM,SAAQ,aAAK;SAGxB,CAAA;QADS;YADP,IAAA,aAAK,EAAC,QAAQ,CAAC;;2CACK;QAFjB,KAAK;YADV,IAAA,sBAAa,EAAC,oBAAoB,EAAE,sBAAsB,CAAC;WACtD,KAAK,CAGV;QACD,MAAM,IAAA,yBAAc,EAAC,sBAAsB,CAAC,CAAC;QAC7C,MAAM,KAAM,SAAQ,KAAK;SAAG;QAE5B,MAAM,KAAK,GAAG,IAAA,gBAAQ,EAAC,IAAA,sBAAc,EAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC;QAClE,IAAA,aAAM,EAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YAChD,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,sBAAsB,EAAE;SACxC,CAAC,CAAC;QACH,IAAA,aAAM,EAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YAC/C,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,sBAAsB,EAAE;SACxC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAE/E,IAAM,MAAM,GAAZ,MAAM,MAAO,SAAQ,aAAK;SAGzB,CAAA;QADS;YADP,IAAA,aAAK,EAAC,QAAQ,CAAC;;4CACK;QAFjB,MAAM;YADX,IAAA,sBAAa,EAAC,iBAAiB,EAAE,uBAAuB,CAAC;WACpD,MAAM,CAGX;QAED,IAAM,KAAK,GAAX,MAAM,KAAM,SAAQ,MAAM;SAAG,CAAA;QAAvB,KAAK;YADV,IAAA,sBAAa,EAAC,kBAAkB,EAAE,sBAAsB,CAAC;WACpD,KAAK,CAAkB;QAE7B,MAAM,IAAA,yBAAc,EAAC,uBAAuB,CAAC,CAAC;QAC9C,MAAM,IAAA,yBAAc,EAAC,sBAAsB,CAAC,CAAC;QAE7C,IAAA,aAAM,EAAC,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YAChD,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,uBAAuB,EAAE;SACzC,CAAC,CAAC;QACH,IAAA,aAAM,EAAC,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YAC/C,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE,EAAE,EAAE,EAAE,sBAAsB,EAAE;SACxC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QAExF,IAAM,KAAK,GAAX,MAAM,KAAM,SAAQ,aAAK;SAGxB,CAAA;QADS;YADP,IAAA,aAAK,EAAC,QAAQ,CAAC;;2CACK;QAFjB,KAAK;YADV,IAAA,sBAAa,EAAC,iBAAiB,EAAE,wBAAwB,CAAC;WACrD,KAAK,CAGV;QACD,MAAM,IAAA,yBAAc,EAAC,wBAAwB,CAAC,CAAC;QAC/C,MAAM,KAAM,SAAQ,KAAK;SAAG;QAC5B,MAAM,aAAa,GAAG,IAAA,oBAAW,EAAC,KAAK,EAAE,4BAAmB,CAAC,CAAC;QAC9D,MAAM,KAAK,GAAG,IAAA,0BAAW,EAAC,aAAa,CAAC,CAAC;QAEzC,MAAM,IAAA,yBAAc,EAAC,wBAAwB,CAAC,CAAC;QAE/C,MAAM,MAAM,GAAG,2BAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACpD,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnC,IAAA,aAAM,EAAC,IAAA,0BAAW,EAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/tests/table.test.js

@@ -9,6 +9,7 @@ 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 node_assert_1 = require("node:assert");
 const chai_1 = require("chai");
 const common_1 = require("../modifiers/common");
 const table_1 = require("../table");
@@ -68,6 +69,21 @@ describe("Table - decorators", () => {
         (0, chai_1.expect)(metadata.indexes.user_search).to.deep.equal(["name", "email"]);
         (0, chai_1.expect)(metadata.indexes.age_range).to.deep.equal(["age"]);
     });
+    it("refuses an index on a symbol-keyed field", () => {
+        const secret = Symbol("secret");
+        const declare = () => {
+            var _a;
+            class TestTable extends table_1.Table {
+                [_a = secret];
+            }
+            __decorate([
+                (0, table_1.Index)(),
+                __metadata("design:type", String)
+            ], TestTable.prototype, _a, void 0);
+            return TestTable;
+        };
+        (0, chai_1.expect)(declare).to.throw(node_assert_1.AssertionError);
+    });
     it("creates table with fixture data", async () => {
         const testData = [
             { id: "1", name: "Test User 1" },

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

@@ -1 +1 @@
-{"version":3,"file":"table.test.js","sourceRoot":"","sources":["../../src/tests/table.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+BAA8B;AAC9B,gDAAkD;AAClD,oCAAwD;AACxD,sCAA6D;AAE7D,mDAA2D;AAE3D,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,SAAU,SAAQ,aAAK;YAE3B,IAAI,CAAU;SACf;QADC;YADC,IAAA,aAAK,GAAE;;+CACM;QAGhB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,SAAU,SAAQ,aAAK;YAE3B,KAAK,CAAU;YAGf,GAAG,CAAU;SACd;QAJC;YADC,IAAA,aAAK,GAAE;;gDACO;QAGf;YADC,IAAA,aAAK,GAAE;;8CACK;QAGf,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QACxD,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,SAAU,SAAQ,aAAK;YAE3B,IAAI,CAAU;YAGd,KAAK,CAAU;YAGf,GAAG,CAAU;SACd;QAPC;YADC,IAAA,aAAK,EAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;;+CAClB;QAGd;YADC,IAAA,aAAK,EAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;;gDACjB;QAGf;YADC,IAAA,aAAK,EAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;;8CACjB;QAGf,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACtE,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,QAAQ,GAAG;YACf,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE;SACjC,CAAC;QAGF,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,aAAK;YAC3B,IAAI,CAAU;SACf,CAAA;QAFK,SAAS;YADd,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;WAClB,SAAS,CAEd;QAED,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,SAAS;YACb,sBAAsB;gBACpB,OAAO,iCAAiC,CAAC;YAC3C,CAAC;YAED,CAAC,oBAAW,CAAC,GAAG;gBACd,UAAU;oBACR,OAAO,iBAAiB,CAAC;gBAC3B,CAAC;aACF,CAAC;SACH;QAED,MAAM,SAAU,SAAQ,aAAK,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,IAAI,CAAU;SACf;QAED,MAAM,QAAQ,GAAG,IAAI,SAAS,EAAE,CAAC;QACjC,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAChD,IAAA,aAAM,EAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;QAChE,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,EAAG,SAAQ,aAAK;SAGrB;QADS;YADP,IAAA,aAAK,EAAC,QAAQ,CAAC;;wCACK;QAEvB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,4BAAmB,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAG,SAAQ,aAAK;SAGrB;QADS;YADP,IAAA,aAAK,EAAC,IAAA,2BAAW,EAAC,2BAAW,CAAC,CAAC;;wCACX;QAEvB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,4BAAmB,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,2BAAW,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,EAAG,SAAQ,aAAK;SAIrB;QADS;YAFP,IAAA,aAAK,GAAE;YACP,IAAA,aAAK,EAAC,QAAQ,CAAC;;yCACM;QAExB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,4BAAmB,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"table.test.js","sourceRoot":"","sources":["../../src/tests/table.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,6CAA6C;AAC7C,+BAA8B;AAC9B,gDAAkD;AAClD,oCAAwD;AACxD,sCAA6D;AAE7D,mDAA2D;AAE3D,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,SAAU,SAAQ,aAAK;YAE3B,IAAI,CAAU;SACf;QADC;YADC,IAAA,aAAK,GAAE;;+CACM;QAGhB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,SAAU,SAAQ,aAAK;YAE3B,KAAK,CAAU;YAGf,GAAG,CAAU;SACd;QAJC;YADC,IAAA,aAAK,GAAE;;gDACO;QAGf;YADC,IAAA,aAAK,GAAE;;8CACK;QAGf,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QACxD,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,SAAU,SAAQ,aAAK;YAE3B,IAAI,CAAU;YAGd,KAAK,CAAU;YAGf,GAAG,CAAU;SACd;QAPC;YADC,IAAA,aAAK,EAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;;+CAClB;QAGd;YADC,IAAA,aAAK,EAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;;gDACjB;QAGf;YADC,IAAA,aAAK,EAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;;8CACjB;QAGf,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACtE,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,GAAG,EAAE;;YACnB,MAAM,SAAU,SAAQ,aAAK;gBAE3B,MAAC,MAAM,CAAC,CAAU;aACnB;YADC;gBADC,IAAA,aAAK,GAAE;;+CACU;YAEpB,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;QAEF,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,4BAAc,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,QAAQ,GAAG;YACf,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE;YAChC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE;SACjC,CAAC;QAGF,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,aAAK;YAC3B,IAAI,CAAU;SACf,CAAA;QAFK,SAAS;YADd,IAAA,eAAO,EAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;WAClB,SAAS,CAEd;QAED,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;QAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,SAAS;YACb,sBAAsB;gBACpB,OAAO,iCAAiC,CAAC;YAC3C,CAAC;YAED,CAAC,oBAAW,CAAC,GAAG;gBACd,UAAU;oBACR,OAAO,iBAAiB,CAAC;gBAC3B,CAAC;aACF,CAAC;SACH;QAED,MAAM,SAAU,SAAQ,aAAK,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,IAAI,CAAU;SACf;QAED,MAAM,QAAQ,GAAG,IAAI,SAAS,EAAE,CAAC;QACjC,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAChD,IAAA,aAAM,EAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;QAChE,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,EAAG,SAAQ,aAAK;SAGrB;QADS;YADP,IAAA,aAAK,EAAC,QAAQ,CAAC;;wCACK;QAEvB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,4BAAmB,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,EAAG,SAAQ,aAAK;SAGrB;QADS;YADP,IAAA,aAAK,EAAC,IAAA,2BAAW,EAAC,2BAAW,CAAC,CAAC;;wCACX;QAEvB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,4BAAmB,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,2BAAW,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,EAAG,SAAQ,aAAK;SAIrB;QADS;YAFP,IAAA,aAAK,GAAE;YACP,IAAA,aAAK,EAAC,QAAQ,CAAC;;yCACM;QAExB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,EAAE,EAAE,4BAAmB,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/docs/1.introduction.md

@@ -1,21 +1,25 @@
-# Define tables and work with models
+---
+title: Define tables and work with models
+description: Describe a table as a TypeScript class, register its schema, and save and read a first row through a typed model.
+mode: how-to
+---
 
 ## Overview
 
-Use `@antelopejs/interface-database-decorators` to describe tables with TypeScript classes and work with converted records through models. It builds on AQL (`@antelopejs/interface-database`) and adds field modifiers and API model injection.
+`@antelopejs/interface-database-decorators` describes tables as TypeScript classes and reads and writes converted rows through models. It builds on AQL (`@antelopejs/interface-database`) and adds field modifiers and model injection into API controllers.
 
 ## From a table class to a stored record
 
 1. **Describe the table.** Extend `Table`, declare fields and indexes, and register the class with `@RegisterTable("users", "myapp")`. See [table definitions](./2.table-definitions.md).
-2. **Bind the schema.** Import the table declarations, then call `await RegisterSchema("myapp")` from their declaring module. This requires a configured database provider and can provision tables and insert fixtures; it is not a read-only metadata operation.
-3. **Create the model.** Use `BasicDataModel(User)` and a `SchemaInstance`, or `GetModel` after the table has been bound. See [data models](./4.data-models.md).
-4. **Write and read through the model.** Model operations apply conversion and modifier events. Use `model.table` when you need to compose an AQL query yourself.
+2. **Bind the schema.** Import the table declarations, then call `await RegisterSchema("myapp")` from their declaring module. The call needs a configured database module. It provisions the tables and inserts fixtures, so it writes to the database.
+3. **Create the model.** Use `BasicDataModel(User)` with a `SchemaInstance`, or call `GetModel` once the table is bound. See [data models](./4.data-models.md).
+4. **Write and read through the model.** Model operations apply the conversions and the modifier events. To compose an AQL query yourself, use `model.table`.
 
-Keep schema IDs and instance IDs distinct: `myapp` identifies the table definitions; an instance ID selects the database instance used by a model. A table class without a schema binding cannot be resolved by `GetModel`.
+Keep schema IDs and instance IDs apart. `myapp` names the table definitions, and an instance ID selects the database instance a model uses. `GetModel` throws for a table class that `RegisterSchema` has not bound, unless a schema of the class's schema name already exists.
 
 ### Save and retrieve a note
 
-In a module with a configured database provider, import this declaration before calling `tryNote()` during initialization. Use a disposable development database: `RegisterSchema` provisions the schema, and `insert` writes data.
+In a module with a configured database module, import this declaration, then call `tryNote()` during initialization. Use a disposable development database, because `RegisterSchema` provisions the schema and `insert` writes a row.
 
 ```ts docs-check
 import {
@@ -45,7 +49,7 @@ export async function tryNote() {
 }
 ```
 
-The model uses the default instance of the schema bound to `Note`. Keep the inserted ID when extending this exercise with `update` or `delete`; each successful run inserts a new note. In an application, register the schema once during initialization rather than on each request.
+The model uses the default instance of the schema bound to `Note`. Each run inserts a new note, so keep the inserted ID if you extend this exercise with `update` or `delete`. In an application, register the schema once during initialization, not on each request.
 
 ## Choose the layer for your task
 
@@ -54,23 +58,23 @@ The model uses the default instance of the schema bound to `Note`. Keep the inse
 | Describe storage fields and indexes | [Table definitions](./2.table-definitions.md)       | Declaring a class is separate from registering its schema.       |
 | Encrypt, hash, or localize fields   | [Table modifiers](./3.table-modifiers.md)           | Conversion events determine when transformations run.            |
 | Read or write converted records     | [Data models](./4.data-models.md)                   | Reads return converted records, not chainable queries.           |
-| Select a model in an HTTP request   | [Parameter decoration](./5.parameter-decoration.md) | The instance ID selects a binding; it does not authorize access. |
+| Select a model in an HTTP request   | [Parameter decoration](./5.parameter-decoration.md) | The instance ID selects a binding. It does not authorize access. |
 
-Start without modifiers until the schema and model work together. Add validation explicitly: string-token `@Field` declarations describe storage, while codec validation requires codecs and the model's validation options.
+Start without modifiers until the schema and the model work together. Validation is opt-in. A string-token `@Field` describes storage only, and codec validation needs io-ts codecs and the model's `validate` option.
 
 ## Dependencies
 
-This package depends on the following:
+The package depends on these packages:
 
-- [**@antelopejs/interface-database**](https://github.com/AntelopeJS/interface-database) - The underlying database query interface (AQL)
-- [**@antelopejs/interface-api**](https://github.com/AntelopeJS/interface-api) - API controller integration for parameter decoration
-- [**@antelopejs/interface-core**](https://github.com/AntelopeJS/interface-core) - Core decorator utilities
-- [**reflect-metadata**](https://www.npmjs.com/package/reflect-metadata) - Metadata reflection for TypeScript decorators
-- [**randomstring**](https://www.npmjs.com/package/randomstring) - Random string generation for hash salts
+- [`@antelopejs/interface-database`](https://github.com/AntelopeJS/interface-database) is the database query interface (AQL).
+- [`@antelopejs/interface-api`](https://github.com/AntelopeJS/interface-api) provides the API controllers that `@Model` injects into.
+- [`@antelopejs/interface-core`](https://github.com/AntelopeJS/interface-core) provides the decorator factories.
+- [`reflect-metadata`](https://www.npmjs.com/package/reflect-metadata) stores the decorator metadata.
+- [`randomstring`](https://www.npmjs.com/package/randomstring) generates the salt of a `@Hashed` field that sets an `algorithm`.
 
 ## Documentation
 
-- [Table Definitions](./2.table-definitions.md) - Define database tables with the `Table` class, `Index` decorator, and `Fixture` decorator
-- [Table Modifiers](./3.table-modifiers.md) - Apply encryption, hashing, and localization modifiers to table fields, or create custom modifiers
-- [Data Models](./4.data-models.md) - Create data models with `BasicDataModel` for CRUD operations and data conversion
-- [Parameter Decoration](./5.parameter-decoration.md) - Inject model instances into API controller methods with the `Model` decorator
+- [Table definitions](./2.table-definitions.md) covers the `Table` class and the `Field`, `Index`, `Relation`, `RegisterTable`, and `Fixture` decorators.
+- [Table modifiers](./3.table-modifiers.md) covers encryption, hashing, and localization of fields, and custom modifiers.
+- [Data models](./4.data-models.md) covers `BasicDataModel`, its CRUD methods, and the data conversions.
+- [Parameter decoration](./5.parameter-decoration.md) covers the `Model` decorator, which injects a model into API controller methods.