@antelopejs/interface-database-decorators 0.0.2

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2025-present - AntelopeJS Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,42 @@
+![Database decorators](.github/social-card.png)
+
+# Interface Database Decorators
+
+<div align="center">
+<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge&labelColor=000000"></a>
+<a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
+<a href="./docs/1.introduction.md"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
+</div>
+
+A structured framework for implementing database operations using TypeScript decorators. Interface Database Decorators offers a flexible, object-oriented approach to defining database tables, models, and operations with full type safety.
+
+## Installation
+
+```bash
+ajs module imports add database-decorators@beta
+```
+
+## Documentation
+
+Detailed documentation is available in the `docs` directory:
+
+- [Introduction](./docs/1.introduction.md) - Overview and basic concepts
+- [Table Definitions](./docs/2.table-definitions.md) - Defining database tables with decorators
+- [Table Modifiers](./docs/3.table-modifiers.md) - Table modifiers for encryption, hashing, and localization
+- [Data Models](./docs/4.data-models.md) - Creating and using data models
+- [Parameter Decoration](./docs/5.parameter-decoration.md) - Parameter decorators for API controllers
+
+## Current Status
+
+This is the development version (`beta`) of the Interface Database Decorators. It is currently in pre-release stage and may undergo changes before the final release. The interface is not considered stable for production use without understanding that breaking changes may occur.
+
+## Versions
+
+| Version | Link                                                                                                                            | Status                                        |
+| ------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
+| beta    | [database-decorators@beta](https://github.com/AntelopeJS/database-decorators/tree/main/output/database-decorators/beta) | Waiting validation from community to go in v1 |
+| 1       | _Not yet released_                                                                                                              | Planned stable release                        |
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

package/dist/antelope.test.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@antelopejs/interface-core/config").ConfigInput;
+export default _default;

package/dist/antelope.test.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("@antelopejs/interface-core/config");
+const mongodb_memory_server_core_1 = require("mongodb-memory-server-core");
+let mongod;
+exports.default = (0, config_1.defineConfig)({
+    name: "interface-database-decorators-test",
+    cacheFolder: ".antelope/cache",
+    modules: {
+        mongodb: {
+            source: {
+                type: "local",
+                path: "../mongodb",
+                installCommand: ["pnpm install", "npx tsc"],
+            },
+        },
+        database_decorators: {
+            source: {
+                type: "local",
+                path: "../database-decorators",
+                installCommand: ["pnpm install", "npx tsc"],
+            },
+        },
+        api: {
+            source: {
+                type: "local",
+                path: "../api",
+                installCommand: ["pnpm install", "npx tsc"],
+            },
+            config: {
+                servers: [{ protocol: "http", host: "127.0.0.1", port: 5010 }],
+            },
+        },
+    },
+    test: {
+        folder: "dist/tests",
+        async setup() {
+            mongod = await mongodb_memory_server_core_1.MongoMemoryServer.create();
+            return {
+                modules: {
+                    mongodb: {
+                        config: { url: mongod.getUri() },
+                    },
+                },
+            };
+        },
+        async cleanup() {
+            await mongod.stop();
+        },
+    },
+});
+//# sourceMappingURL=antelope.test.js.map

package/dist/antelope.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"antelope.test.js","sourceRoot":"","sources":["../src/antelope.test.ts"],"names":[],"mappings":";;AAAA,8DAAiE;AACjE,2EAA+D;AAE/D,IAAI,MAAyB,CAAC;AAE9B,kBAAe,IAAA,qBAAY,EAAC;IAC1B,IAAI,EAAE,oCAAoC;IAC1C,WAAW,EAAE,iBAAiB;IAC9B,OAAO,EAAE;QACP,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,YAAY;gBAClB,cAAc,EAAE,CAAC,cAAc,EAAE,SAAS,CAAC;aAC5C;SACF;QACD,mBAAmB,EAAE;YACnB,MAAM,EAAE;gBACN,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,wBAAwB;gBAC9B,cAAc,EAAE,CAAC,cAAc,EAAE,SAAS,CAAC;aAC5C;SACF;QACD,GAAG,EAAE;YACH,MAAM,EAAE;gBACN,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE,CAAC,cAAc,EAAE,SAAS,CAAC;aAC5C;YACD,MAAM,EAAE;gBACN,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;aAC/D;SACF;KACF;IACD,IAAI,EAAE;QACJ,MAAM,EAAE,YAAY;QACpB,KAAK,CAAC,KAAK;YACT,MAAM,GAAG,MAAM,8CAAiB,CAAC,MAAM,EAAE,CAAC;YAC1C,OAAO;gBACL,OAAO,EAAE;oBACP,OAAO,EAAE;wBACP,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE;qBACjC;iBACF;aACF,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,OAAO;YACX,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACtB,CAAC;KACF;CACF,CAAC,CAAC"}

package/dist/common.d.ts

@@ -0,0 +1,22 @@
+export type Constructible<T = object, A extends unknown[] = unknown[]> = new (...args: A) => T;
+export type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends Array<infer U1> ? Array<DeepPartial<U1>> : T[K] extends ReadonlyArray<infer U2> ? ReadonlyArray<DeepPartial<U2>> : T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
+export type DatumGeneratorOutput = Record<string, unknown> | Array<Record<string, unknown>> | undefined;
+export type DatumGenerator = (tableClass: Constructible) => DatumGeneratorOutput | Promise<DatumGeneratorOutput>;
+export interface MetadataClass<TMetadata> extends Constructible<TMetadata> {
+    key: symbol;
+}
+/**
+ * Table class Metadata.
+ */
+export declare class DatumStaticMetadata {
+    static key: symbol;
+    tableName?: string;
+    schemaName?: string;
+    readonly indexes: Record<string, Array<string>>;
+    primary: string;
+    generator?: DatumGenerator;
+    addIndex(key: string, group: string): void;
+}
+export declare function getMetadata<TMetadata, TTarget extends object>(target: TTarget, metadataClass: MetadataClass<TMetadata>, inherit?: boolean): TMetadata;

package/dist/common.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatumStaticMetadata = void 0;
+exports.getMetadata = getMetadata;
+/**
+ * Table class Metadata.
+ */
+class DatumStaticMetadata {
+    static key = Symbol();
+    tableName;
+    schemaName;
+    indexes = {};
+    primary = "_id";
+    generator;
+    addIndex(key, group) {
+        if (!(group in this.indexes)) {
+            this.indexes[group] = [];
+        }
+        this.indexes[group].push(key);
+    }
+}
+exports.DatumStaticMetadata = DatumStaticMetadata;
+function getMetadata(target, metadataClass, inherit = true) {
+    const existingMetadata = Reflect.getOwnMetadata(metadataClass.key, target);
+    if (existingMetadata) {
+        return existingMetadata;
+    }
+    const prototype = Object.getPrototypeOf(target);
+    const inheritedMetadata = inherit && prototype
+        ? Reflect.getOwnMetadata(metadataClass.key, prototype)
+        : undefined;
+    const metadata = inheritedMetadata ?? new metadataClass(target);
+    Reflect.defineMetadata(metadataClass.key, metadata, target);
+    return metadata;
+}
+//# sourceMappingURL=common.js.map

package/dist/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":";;;AA8CA,kCAsBC;AA1CD;;GAEG;AACH,MAAa,mBAAmB;IACvB,MAAM,CAAC,GAAG,GAAG,MAAM,EAAE,CAAC;IAEtB,SAAS,CAAU;IACnB,UAAU,CAAU;IACX,OAAO,GAAkC,EAAE,CAAC;IACrD,OAAO,GAAW,KAAK,CAAC;IACxB,SAAS,CAAkB;IAElC,QAAQ,CAAC,GAAW,EAAE,KAAa;QACjC,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;;AAdH,kDAeC;AAED,SAAgB,WAAW,CACzB,MAAe,EACf,aAAuC,EACvC,UAAmB,IAAI;IAEvB,MAAM,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAE5D,CAAC;IACd,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAmB,CAAC;IAClE,MAAM,iBAAiB,GACrB,OAAO,IAAI,SAAS;QAClB,CAAC,CAAE,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,CAEtC;QAChB,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,QAAQ,GAAG,iBAAiB,IAAI,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IAChE,OAAO,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC5D,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/database.d.ts

@@ -0,0 +1,2 @@
+import { type SchemaOptions } from "@antelopejs/interface-database";
+export declare function CreateDatabaseSchemaInstance(schemaId: string, instanceId?: string, options?: SchemaOptions): Promise<void>;

package/dist/database.js

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateDatabaseSchemaInstance = CreateDatabaseSchemaInstance;
+const node_assert_1 = __importDefault(require("node:assert"));
+const interface_database_1 = require("@antelopejs/interface-database");
+const common_1 = require("./common");
+const common_2 = require("./modifiers/common");
+const schema_1 = require("./schema");
+async function CreateDatabaseSchemaInstance(schemaId, instanceId, options) {
+    const tables = (0, schema_1.getTablesForSchema)(schemaId);
+    (0, node_assert_1.default)(tables, `No tables registered for schema '${schemaId}'`);
+    const definition = buildSchemaDefinition(tables);
+    const schema = new interface_database_1.Schema(schemaId, definition, options);
+    await schema.createInstance(instanceId);
+    await insertAllFixtureData(schema, instanceId, tables);
+}
+function buildSchemaDefinition(tables) {
+    const definition = {};
+    for (const [tableName, tableClass] of Object.entries(tables)) {
+        const metadata = (0, common_1.getMetadata)(tableClass, common_1.DatumStaticMetadata);
+        const indexes = {};
+        for (const [group, fields] of Object.entries(metadata.indexes)) {
+            indexes[group] = {
+                fields: fields.length === 1 && fields[0] === group ? undefined : fields,
+            };
+        }
+        definition[tableName] = { fields: {}, indexes };
+    }
+    return definition;
+}
+async function insertAllFixtureData(schema, instanceId, tables) {
+    await Promise.all(Object.entries(tables).map(([tableName, tableClass]) => {
+        const metadata = (0, common_1.getMetadata)(tableClass, common_1.DatumStaticMetadata);
+        return insertFixtureData(schema, instanceId, tableName, tableClass, metadata.generator);
+    }));
+}
+async function insertFixtureData(schema, instanceId, tableName, tableClass, generator) {
+    if (!generator) {
+        return;
+    }
+    const count = await schema.instance(instanceId).table(tableName).count();
+    if (count > 0) {
+        return;
+    }
+    const fixtureData = await generator(tableClass);
+    const rows = toFixtureRows(fixtureData, tableClass);
+    if (rows.length === 0) {
+        return;
+    }
+    const payload = rows.length === 1 ? rows[0] : rows;
+    await schema.instance(instanceId).table(tableName).insert(payload);
+}
+function toFixtureRows(fixtureData, tableClass) {
+    const entries = fixtureData
+        ? Array.isArray(fixtureData)
+            ? fixtureData
+            : [fixtureData]
+        : [];
+    return entries.filter(isTableEntry).map((entry) => {
+        const instance = (0, common_2.fromPlainData)(entry, tableClass);
+        (0, common_2.triggerEvent)(instance, "insert");
+        return (0, common_2.toDatabase)(instance);
+    });
+}
+function isTableEntry(value) {
+    return typeof value === "object" && value !== null;
+}
+//# sourceMappingURL=database.js.map

package/dist/database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.js","sourceRoot":"","sources":["../src/database.ts"],"names":[],"mappings":";;;;;AAiBA,oEAaC;AA9BD,8DAAiC;AAEjC,uEAIwC;AAGxC,qCAA4D;AAC5D,+CAA6E;AAC7E,qCAA8C;AAMvC,KAAK,UAAU,4BAA4B,CAChD,QAAgB,EAChB,UAAmB,EACnB,OAAuB;IAEvB,MAAM,MAAM,GAAG,IAAA,2BAAkB,EAAC,QAAQ,CAAC,CAAC;IAC5C,IAAA,qBAAM,EAAC,MAAM,EAAE,oCAAoC,QAAQ,GAAG,CAAC,CAAC;IAEhE,MAAM,UAAU,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,IAAI,2BAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACzD,MAAM,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAExC,MAAM,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,qBAAqB,CAAC,MAAwB;IACrD,MAAM,UAAU,GAAqB,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7D,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,UAAU,EAAE,4BAAmB,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAoC,EAAE,CAAC;QACpD,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/D,OAAO,CAAC,KAAK,CAAC,GAAG;gBACf,MAAM,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;aACxE,CAAC;QACJ,CAAC;QACD,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;IAClD,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,MAAmB,EACnB,UAA8B,EAC9B,MAAwB;IAExB,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,EAAE;QACrD,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,UAAU,EAAE,4BAAmB,CAAC,CAAC;QAC9D,OAAO,iBAAiB,CACtB,MAAM,EACN,UAAU,EACV,SAAS,EACT,UAAU,EACV,QAAQ,CAAC,SAAS,CACnB,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,MAAmB,EACnB,UAA8B,EAC9B,SAAiB,EACjB,UAAwB,EACxB,SAA2C;IAE3C,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;IACzE,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,OAAO;IACT,CAAC;IACD,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACpD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IACD,MAAM,OAAO,GAAQ,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,MAAM,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,aAAa,CACpB,WAAiC,EACjC,UAAwB;IAExB,MAAM,OAAO,GAAG,WAAW;QACzB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC;YAC1B,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,CAAC,WAAW,CAAC;QACjB,CAAC,CAAC,EAAE,CAAC;IACP,OAAO,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAChD,MAAM,QAAQ,GAAG,IAAA,sBAAa,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAClD,IAAA,qBAAY,EAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACjC,OAAO,IAAA,mBAAU,EAAC,QAAQ,CAAe,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import "reflect-metadata";
+export * from "./common";
+export * from "./database";
+export * from "./model";
+export * from "./modifiers";
+export * from "./schema";
+export * from "./table";

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+__exportStar(require("./common"), exports);
+__exportStar(require("./database"), exports);
+__exportStar(require("./model"), exports);
+__exportStar(require("./modifiers"), exports);
+__exportStar(require("./schema"), exports);
+__exportStar(require("./table"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/dist/model.d.ts

@@ -0,0 +1,101 @@
+import { type RequestContext } from "@antelopejs/interface-api";
+import { type Class } from "@antelopejs/interface-core/decorators";
+import type * as DatabaseDev from "@antelopejs/interface-database";
+import { type Constructible, type DeepPartial } from "./common";
+export type DataModel<T = any> = {
+    readonly schemaName: string;
+    new (database: DatabaseDev.SchemaInstance<any>): {
+        readonly database: DatabaseDev.SchemaInstance<any>;
+        readonly table: DatabaseDev.Table<T>;
+    };
+    fromDatabase(obj: any): T | undefined;
+    fromPlainData(obj: any): T;
+};
+/**
+ * Utility Class factory to create a basic Data Model with 1 table.
+ *
+ * @param dataType Database Table class
+ * @param tableName Table name in Database
+ */
+export declare function BasicDataModel<T extends object>(dataType: Constructible<T>, tableName?: string): {
+    new (database: DatabaseDev.SchemaInstance<any>): {
+        /**
+         * AQL Table reference.
+         */
+        readonly table: DatabaseDev.Table<T>;
+        readonly database: DatabaseDev.SchemaInstance<any>;
+        /**
+         * Get a single element from the table using its primary key.
+         *
+         * @param id Primary key value
+         * @returns Table class instance
+         */
+        get(id: string): PromiseLike<T | undefined>;
+        /**
+         * Get multiple elements from the table using a given index.
+         *
+         * @param index Index name
+         * @param keys Index value(s)
+         * @returns Array of Table class instances.
+         */
+        getBy(index: keyof T, ...keys: any[]): PromiseLike<T[]>;
+        /**
+         * Get all the elements from the table.
+         *
+         * @returns Array of Table class instances.
+         */
+        getAll(): PromiseLike<T[]>;
+        /**
+         * Insert some data into the table.
+         *
+         * @param obj Table class instance or plain data
+         * @param options Insert options
+         * @returns Insert result
+         */
+        insert(obj: DeepPartial<T> | Array<DeepPartial<T>>): Promise<string[]>;
+        /**
+         * Updates a single element in the table.
+         *
+         * @param id Primary key value
+         * @param obj Table class instance or plain data
+         * @param options Update options
+         * @returns Update result
+         */
+        update(id: string, obj: DeepPartial<T>): Promise<number>;
+        update(obj: DeepPartial<T>): Promise<number>;
+        /**
+         * Delete an element from the table.
+         *
+         * @param id Primary key value
+         * @returns Delete result
+         */
+        delete(id: string): Promise<number>;
+    };
+    readonly schemaName: string;
+    /**
+     * Converts some plain data into an instance of the Table class.
+     *
+     * @param obj Plain data object containing the table fields
+     * @returns Table class instance
+     */
+    fromPlainData(obj: any): T;
+    /**
+     * Converts an object acquired from the database into a Table class instance.
+     *
+     * @param obj Object resulting from a database get
+     * @returns Table class instance
+     */
+    fromDatabase(obj: any): T | undefined;
+    /**
+     * Converts a Table class instance into an object fit to be inserted in the database.
+     *
+     * @param obj Table class instance
+     * @returns Database-ready data
+     */
+    toDatabase(obj: any): Record<string, any>;
+};
+export declare function GetModel<M extends InstanceType<DataModel>>(cl: DataModel & Class<M>, instanceId?: string): M;
+export declare const Model: (cl: DataModel<any> & Class<{
+    readonly database: DatabaseDev.SchemaInstance<any>;
+    readonly table: DatabaseDev.Table<any>;
+}>, instanceIdOrCallback?: string | ((ctx: RequestContext) => string | undefined) | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator & import("@antelopejs/interface-core/decorators").ParameterDecorator;