@antelopejs/interface-database-decorators 0.0.2

package/dist/modifiers/encryption.d.ts

@@ -0,0 +1,37 @@
+import type * as DatabaseDev from "@antelopejs/interface-database";
+import { MixinSymbol, TwoWayModifier } from "./common";
+type Options = {
+    /** Encryption algorithm (for supported algorithms refer to {@link createCipheriv}) */
+    algorithm?: string;
+    /** Encryption key. */
+    secretKey: string;
+    /** Initialization Vector size. */
+    ivSize?: number;
+};
+type Meta = Record<string, never>;
+type LockedType = [ciphertext: string, iv: string, authTag?: string];
+/**
+ * Encryption modifier. enables the use of {@link Encrypted} on table fields.
+ *
+ * These fields are stored encrypted in the database.
+ */
+export declare class EncryptionModifier extends TwoWayModifier<LockedType, [
+], Meta, Options> {
+    readonly autolock = true;
+    lock(_locked_value: LockedType | undefined, value: unknown): LockedType;
+    readonly autounlock = true;
+    unlock([locked_value, iv_str, authTag]: LockedType): unknown;
+    unlockrequest(data: DatabaseDev.ValueProxy<LockedType>): DatabaseDev.ValueProxy<unknown>;
+    [MixinSymbol]: {
+        new (): {};
+    };
+}
+/**
+ * Mark a Database Table class field as being encrypted.
+ *
+ * @note The Table class MUST incorporate the {@link EncryptionModifier} mixin.
+ *
+ * @param options Encryption options.
+ */
+export declare const Encrypted: (options: Options) => import("@antelopejs/interface-core/decorators").PropertyDecorator;
+export {};

package/dist/modifiers/encryption.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Encrypted = exports.EncryptionModifier = void 0;
+const node_crypto_1 = require("node:crypto");
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const common_1 = require("./common");
+function date_encoder(key) {
+    return this[key] instanceof Date
+        ? {
+            value: this[key].toUTCString(),
+            type: "Date",
+        }
+        : this[key];
+}
+function date_decoder(_key, value) {
+    return value !== null &&
+        typeof value === "object" &&
+        Object.keys(value).length === 2 &&
+        Object.keys(value).includes("type") &&
+        Object.keys(value).includes("value") &&
+        value.type === "Date"
+        ? new Date(value.value)
+        : value;
+}
+/**
+ * Encryption modifier. enables the use of {@link Encrypted} on table fields.
+ *
+ * These fields are stored encrypted in the database.
+ */
+class EncryptionModifier extends common_1.TwoWayModifier {
+    autolock = true;
+    lock(_locked_value, value) {
+        const iv = (0, node_crypto_1.randomBytes)(this.options.ivSize || 16);
+        const cipher = (0, node_crypto_1.createCipheriv)(this.options.algorithm || "aes-256-gcm", this.options.secretKey, iv);
+        const encrypted = Buffer.concat([
+            cipher.update(JSON.stringify(value, date_encoder)),
+            cipher.final(),
+        ]).toString("base64");
+        let authTag;
+        try {
+            authTag =
+                "getAuthTag" in cipher
+                    ? cipher.getAuthTag().toString("base64")
+                    : undefined;
+        }
+        catch {
+            // Ignore error if getAuthTag is not available
+        }
+        return [encrypted, iv.toString("base64"), authTag];
+    }
+    autounlock = true;
+    unlock([locked_value, iv_str, authTag]) {
+        const decipher = (0, node_crypto_1.createDecipheriv)(this.options.algorithm || "aes-256-gcm", this.options.secretKey, Buffer.from(iv_str, "base64"));
+        if ("setAuthTag" in decipher && authTag) {
+            decipher.setAuthTag(Buffer.from(authTag, "base64"));
+        }
+        return JSON.parse(Buffer.concat([
+            decipher.update(Buffer.from(locked_value, "base64")),
+            decipher.final(),
+        ]).toString("utf8"), date_decoder);
+    }
+    unlockrequest(data) {
+        return data;
+    }
+    [common_1.MixinSymbol] = class {
+    };
+}
+exports.EncryptionModifier = EncryptionModifier;
+/**
+ * Mark a Database Table class field as being encrypted.
+ *
+ * @note The Table class MUST incorporate the {@link EncryptionModifier} mixin.
+ *
+ * @param options Encryption options.
+ */
+exports.Encrypted = (0, decorators_1.MakePropertyDecorator)((target, propertyKey, options) => {
+    (0, common_1.attachModifier)(target.constructor, EncryptionModifier, propertyKey, options);
+});
+//# sourceMappingURL=encryption.js.map

package/dist/modifiers/encryption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryption.js","sourceRoot":"","sources":["../../src/modifiers/encryption.ts"],"names":[],"mappings":";;;AAAA,6CAMqB;AACrB,sEAA8E;AAE9E,qCAAuE;AAavE,SAAS,YAAY,CAAY,GAAW;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,IAAI;QAC9B,CAAC,CAAC;YACE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE;YAC9B,IAAI,EAAE,MAAM;SACb;QACH,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,YAAY,CAAC,IAAY,EAAE,KAAU;IAC5C,OAAO,KAAK,KAAK,IAAI;QACnB,OAAO,KAAK,KAAK,QAAQ;QACzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;QACpC,KAAK,CAAC,IAAI,KAAK,MAAM;QACrB,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QACvB,CAAC,CAAC,KAAK,CAAC;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAa,kBAAmB,SAAQ,uBAKvC;IACU,QAAQ,GAAG,IAAI,CAAC;IAET,IAAI,CAClB,aAAqC,EACrC,KAAc;QAEd,MAAM,EAAE,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,IAAA,4BAAc,EAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,aAAa,EACvC,IAAI,CAAC,OAAO,CAAC,SAAS,EACtB,EAAE,CACH,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;YAC9B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YAClD,MAAM,CAAC,KAAK,EAAE;SACf,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEtB,IAAI,OAA2B,CAAC;QAChC,IAAI,CAAC;YACH,OAAO;gBACL,YAAY,IAAI,MAAM;oBACpB,CAAC,CAAa,MAAO,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBACrD,CAAC,CAAC,SAAS,CAAC;QAClB,CAAC;QAAC,MAAM,CAAC;YACP,8CAA8C;QAChD,CAAC;QAED,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAEQ,UAAU,GAAG,IAAI,CAAC;IAEX,MAAM,CAAC,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAa;QAChE,MAAM,QAAQ,GAAG,IAAA,8BAAgB,EAC/B,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,aAAa,EACvC,IAAI,CAAC,OAAO,CAAC,SAAS,EACtB,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAC9B,CAAC;QAEF,IAAI,YAAY,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YAC1B,QAAS,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CACf,MAAM,CAAC,MAAM,CAAC;YACZ,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YACpD,QAAQ,CAAC,KAAK,EAAE;SACjB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EACnB,YAAY,CACF,CAAC;IACf,CAAC;IAEe,aAAa,CAC3B,IAAwC;QAExC,OAAO,IAAuC,CAAC;IACjD,CAAC;IAED,CAAC,oBAAW,CAAC,GAAG;KAAQ,CAAC;CAC1B;AAjED,gDAiEC;AAED;;;;;;GAMG;AACU,QAAA,SAAS,GAAG,IAAA,kCAAqB,EAC5C,CAAC,MAAM,EAAE,WAAW,EAAE,OAAgB,EAAE,EAAE;IACxC,IAAA,uBAAc,EACZ,MAAM,CAAC,WAAW,EAClB,kBAAkB,EAClB,WAAW,EACX,OAAO,CACR,CAAC;AACJ,CAAC,CACF,CAAC"}

package/dist/modifiers/hash.d.ts

@@ -0,0 +1,41 @@
+import { MixinSymbol, OneWayModifier } from "./common";
+type Options = {
+    /** Hashing algorithm (for supported algorithms refer to {@link createHash}) */
+    algorithm?: string;
+};
+/**
+ * Hash modifier. enables the use of {@link Hashed} on table fields.
+ *
+ * Hashed fields only contain a hash of the inserted value.
+ * Because of this, you lose the ability to query the information directly.
+ * You can test equality using {@link testHash}
+ */
+export declare class HashModifier extends OneWayModifier<string | undefined, [
+], {
+    salt?: string;
+}, Options> {
+    readonly autolock = true;
+    lock(_locked_value: string | undefined, value: unknown): string | undefined;
+    [MixinSymbol]: {
+        new (): {
+            /**
+             * Test a value against the stored hash.
+             *
+             * @param field - Name of the field to test against.
+             * @param value - Value to hash and test.
+             *
+             * @returns Whether the new value is identical to the original or not.
+             */
+            testHash<This extends {}, F extends keyof This>(this: This, field: F, value: This[F]): unknown;
+        };
+    };
+}
+/**
+ * Mark a Database Table class field as being hashed.
+ *
+ * @note The Table class MUST incorporate the {@link HashModifier} mixin.
+ *
+ * @param options Hash options.
+ */
+export declare const Hashed: (options?: Options | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator;
+export {};

package/dist/modifiers/hash.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hashed = exports.HashModifier = void 0;
+const node_crypto_1 = require("node:crypto");
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const randomstring_1 = require("randomstring");
+const common_1 = require("./common");
+/**
+ * Hash modifier. enables the use of {@link Hashed} on table fields.
+ *
+ * Hashed fields only contain a hash of the inserted value.
+ * Because of this, you lose the ability to query the information directly.
+ * You can test equality using {@link testHash}
+ */
+class HashModifier extends common_1.OneWayModifier {
+    autolock = true;
+    lock(_locked_value, value) {
+        if (value === undefined) {
+            return value;
+        }
+        if (!this.meta.salt) {
+            this.meta.salt = (0, randomstring_1.generate)();
+        }
+        return (0, node_crypto_1.createHash)(this.options.algorithm || "sha256")
+            .update(this.meta.salt)
+            .update(JSON.stringify(value))
+            .digest("base64");
+    }
+    [common_1.MixinSymbol] = class {
+        /**
+         * Test a value against the stored hash.
+         *
+         * @param field - Name of the field to test against.
+         * @param value - Value to hash and test.
+         *
+         * @returns Whether the new value is identical to the original or not.
+         */
+        testHash(field, value) {
+            return (0, common_1.testValue)(this, field, value);
+        }
+    };
+}
+exports.HashModifier = HashModifier;
+/**
+ * Mark a Database Table class field as being hashed.
+ *
+ * @note The Table class MUST incorporate the {@link HashModifier} mixin.
+ *
+ * @param options Hash options.
+ */
+exports.Hashed = (0, decorators_1.MakePropertyDecorator)((target, propertyKey, options) => {
+    (0, common_1.attachModifier)(target.constructor, HashModifier, propertyKey, options || {});
+});
+//# sourceMappingURL=hash.js.map

package/dist/modifiers/hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["../../src/modifiers/hash.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,sEAA8E;AAC9E,+CAAwC;AACxC,qCAKkB;AAOlB;;;;;;GAMG;AACH,MAAa,YAAa,SAAQ,uBAKjC;IACiB,QAAQ,GAAG,IAAI,CAAC;IAEhB,IAAI,CAAC,aAAiC,EAAE,KAAc;QACpE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAA,uBAAQ,GAAE,CAAC;QAC9B,CAAC;QACD,OAAO,IAAA,wBAAU,EAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC;aAClD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;aACtB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC7B,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC;IAED,CAAC,oBAAW,CAAC,GAAG;QACd;;;;;;;WAOG;QACH,QAAQ,CAEN,KAAQ,EACR,KAAc;YAEd,OAAO,IAAA,kBAAS,EAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACvC,CAAC;KACF,CAAC;CACH;AAtCD,oCAsCC;AAED;;;;;;GAMG;AACU,QAAA,MAAM,GAAG,IAAA,kCAAqB,EACzC,CAAC,MAAM,EAAE,WAAW,EAAE,OAAiB,EAAE,EAAE;IACzC,IAAA,uBAAc,EACZ,MAAM,CAAC,WAAW,EAClB,YAAY,EACZ,WAAW,EACX,OAAO,IAAI,EAAE,CACd,CAAC;AACJ,CAAC,CACF,CAAC"}

package/dist/modifiers/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./common";
+export * from "./encryption";
+export * from "./hash";
+export * from "./localization";

package/dist/modifiers/index.js

@@ -0,0 +1,21 @@
+"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 });
+__exportStar(require("./common"), exports);
+__exportStar(require("./encryption"), exports);
+__exportStar(require("./hash"), exports);
+__exportStar(require("./localization"), exports);
+//# sourceMappingURL=index.js.map

package/dist/modifiers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/modifiers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,+CAA6B;AAC7B,yCAAuB;AACvB,iDAA+B"}

package/dist/modifiers/localization.d.ts

@@ -0,0 +1,43 @@
+import type * as DatabaseDev from "@antelopejs/interface-database";
+import { ContainerModifier, MixinSymbol } from "./common";
+type Options = {
+    /** Fallback locale to use when no value exists for the selected locale. */
+    fallbackLocale?: string;
+};
+/**
+ * Localization modifier. enables the use of {@link Localized} on table fields.
+ *
+ * Localized fields contain multiple values (one for each language).
+ * Accessing a particular value is done by first calling {@link localize} on the Table class instance.
+ * This method is added through the mixin class.
+ *
+ * See {@link ContainerModifier} for the generic modifier.
+ */
+export declare class LocalizationModifier extends ContainerModifier<Record<string, never>, Options> {
+    unlock(locked_value: Record<string, unknown>, key: string): unknown;
+    unlockrequest(data: DatabaseDev.ValueProxy<Record<string, unknown>>, _meta: DatabaseDev.ValueProxy<Record<string, never>>, key: DatabaseDev.ValueProxyOrValue<string>): DatabaseDev.ValueProxy<unknown>;
+    [MixinSymbol]: {
+        new (): {
+            /**
+             * Specify which locale to use for accessing some or all localized fields.
+             *
+             * @param locale - Locale to use to unlock the field(s).
+             * @param fields - Field names to unlock. Picks from the fields of the object this function is mixed into.
+             *
+             * @returns `this`
+             */
+            localize<This extends {
+                constructor: any;
+            }>(this: This, locale: string, fields?: Array<keyof This>): This;
+        };
+    };
+}
+/**
+ * Mark a Database Table class field as being localized.
+ *
+ * @note The Table class MUST incorporate the {@link LocalizationModifier} mixin.
+ *
+ * @param options Localization options.
+ */
+export declare const Localized: (options?: Options | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator;
+export {};

package/dist/modifiers/localization.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Localized = exports.LocalizationModifier = void 0;
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const common_1 = require("./common");
+/**
+ * Localization modifier. enables the use of {@link Localized} on table fields.
+ *
+ * Localized fields contain multiple values (one for each language).
+ * Accessing a particular value is done by first calling {@link localize} on the Table class instance.
+ * This method is added through the mixin class.
+ *
+ * See {@link ContainerModifier} for the generic modifier.
+ */
+class LocalizationModifier extends common_1.ContainerModifier {
+    unlock(locked_value, key) {
+        const unlocked = super.unlock(locked_value, key);
+        if (unlocked !== undefined) {
+            return unlocked;
+        }
+        if (this.options.fallbackLocale) {
+            return super.unlock(locked_value, this.options.fallbackLocale);
+        }
+    }
+    unlockrequest(data, _meta, key) {
+        if (this.options.fallbackLocale) {
+            return data.key(key).default(data.key(this.options.fallbackLocale));
+        }
+        return data.key(key);
+    }
+    [common_1.MixinSymbol] = class {
+        /**
+         * Specify which locale to use for accessing some or all localized fields.
+         *
+         * @param locale - Locale to use to unlock the field(s).
+         * @param fields - Field names to unlock. Picks from the fields of the object this function is mixed into.
+         *
+         * @returns `this`
+         */
+        localize(locale, fields) {
+            (0, common_1.unlock)(this, LocalizationModifier, fields, locale);
+            return this;
+        }
+    };
+}
+exports.LocalizationModifier = LocalizationModifier;
+/**
+ * Mark a Database Table class field as being localized.
+ *
+ * @note The Table class MUST incorporate the {@link LocalizationModifier} mixin.
+ *
+ * @param options Localization options.
+ */
+exports.Localized = (0, decorators_1.MakePropertyDecorator)((target, propertyKey, options) => {
+    (0, common_1.attachModifier)(target.constructor, LocalizationModifier, propertyKey, options || {});
+});
+//# sourceMappingURL=localization.js.map

package/dist/modifiers/localization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localization.js","sourceRoot":"","sources":["../../src/modifiers/localization.ts"],"names":[],"mappings":";;;AAAA,sEAA8E;AAE9E,qCAKkB;AAOlB;;;;;;;;GAQG;AACH,MAAa,oBAAqB,SAAQ,0BAGzC;IACiB,MAAM,CAAC,YAAqC,EAAE,GAAW;QACvE,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QACjD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAEe,aAAa,CAC3B,IAAqD,EACrD,KAAoD,EACpD,GAA0C;QAE1C,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,CAAC,oBAAW,CAAC,GAAG;QACd;;;;;;;WAOG;QACH,QAAQ,CAEN,MAAc,EACd,MAA0B;YAE1B,IAAA,eAAM,EAAC,IAAI,EAAE,oBAAoB,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC;CACH;AA3CD,oDA2CC;AAED;;;;;;GAMG;AACU,QAAA,SAAS,GAAG,IAAA,kCAAqB,EAC5C,CAAC,MAAM,EAAE,WAAW,EAAE,OAAiB,EAAE,EAAE;IACzC,IAAA,uBAAc,EACZ,MAAM,CAAC,WAAW,EAClB,oBAAoB,EACpB,WAAW,EACX,OAAO,IAAI,EAAE,CACd,CAAC;AACJ,CAAC,CACF,CAAC"}

package/dist/schema.d.ts

@@ -0,0 +1,4 @@
+import { type Class, type ClassDecorator } from "@antelopejs/interface-core/decorators";
+import type { Table } from "./table";
+export declare const RegisterTable: (tableName: string, schemaName: string) => ClassDecorator<typeof Table>;
+export declare function getTablesForSchema(schemaName: string): Record<string, Class<Table>> | undefined;

package/dist/schema.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegisterTable = void 0;
+exports.getTablesForSchema = getTablesForSchema;
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const common_1 = require("./common");
+const schemaTableRegistry = {};
+exports.RegisterTable = (0, decorators_1.MakeClassDecorator)((target, tableName, schemaName) => {
+    const metadata = (0, common_1.getMetadata)(target, common_1.DatumStaticMetadata);
+    metadata.tableName = tableName;
+    metadata.schemaName = schemaName;
+    if (!(schemaName in schemaTableRegistry)) {
+        schemaTableRegistry[schemaName] = {};
+    }
+    schemaTableRegistry[schemaName][tableName] =
+        target;
+});
+function getTablesForSchema(schemaName) {
+    return schemaTableRegistry[schemaName];
+}
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;AA2BA,gDAIC;AA/BD,sEAI+C;AAC/C,qCAA4D;AAG5D,MAAM,mBAAmB,GAAiD,EAAE,CAAC;AAEhE,QAAA,aAAa,GAGU,IAAA,+BAAkB,EACpD,CAAC,MAAM,EAAE,SAAiB,EAAE,UAAkB,EAAE,EAAE;IAChD,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,MAAM,EAAE,4BAAmB,CAAC,CAAC;IAC1D,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;IAEjC,IAAI,CAAC,CAAC,UAAU,IAAI,mBAAmB,CAAC,EAAE,CAAC;QACzC,mBAAmB,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;IACvC,CAAC;IACD,mBAAmB,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC;QACxC,MAAiC,CAAC;AACtC,CAAC,CACF,CAAC;AAEF,SAAgB,kBAAkB,CAChC,UAAkB;IAElB,OAAO,mBAAmB,CAAC,UAAU,CAAC,CAAC;AACzC,CAAC"}

package/dist/table.d.ts

@@ -0,0 +1,53 @@
+import { type ClassDecorator } from "@antelopejs/interface-core/decorators";
+import { type Constructible } from "./common";
+import { MixinSymbol, type MixinType } from "./modifiers/common";
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export declare const TableMetaSymbol: unique symbol;
+export declare const TableRefSymbol: unique symbol;
+export type ExtractTableMeta<T> = T extends {
+    [TableMetaSymbol]: infer Meta;
+} ? Meta extends object ? Meta : never : object;
+export interface TableClass<Base = object, Args extends any[] = [], Meta extends object | undefined = undefined> {
+    new (...args: Args): {
+        _id: string;
+    } & Base & (Meta extends object ? {
+        [TableMetaSymbol]: Meta;
+    } : object);
+    with<This extends TableClass, T extends Constructible<{
+        [MixinSymbol]: Constructible;
+    }>[] = []>(this: This, ...other: T): TableClass<InstanceType<This> & UnionToIntersection<InstanceType<MixinType<InstanceType<T[number]>>>>, ConstructorParameters<This>, ExtractTableMeta<InstanceType<This>> | ExtractTableMeta<InstanceType<T[number]>>>;
+}
+/**
+ * Database Table superclass
+ */
+export declare class Table {
+    _id: string;
+    /**
+     * Supplement the superclass with Modifier mixins.
+     *
+     * @param others List of Modifier mixin classes
+     * @returns New superclass
+     */
+    static with<This extends typeof Table, T extends Constructible<{
+        [MixinSymbol]: Constructible;
+    }>[] = []>(this: This, ...others: T): TableClass<InstanceType<This> & UnionToIntersection<InstanceType<MixinType<InstanceType<T[number]>>>>, ConstructorParameters<This>, ExtractTableMeta<InstanceType<This>> | ExtractTableMeta<InstanceType<T[number]>>>;
+}
+/**
+ * Database Table Index decorator.
+ *
+ * Available options:
+ * - `group`: Index name for multi-field indexes.
+ *
+ * @param options Options
+ */
+export declare const Index: (options?: {
+    group?: string;
+} | undefined) => import("@antelopejs/interface-core/decorators").PropertyDecorator;
+type AwaitableArray<T> = Promise<T | T[]> | T | T[];
+/**
+ * Database Table class decorator to create default data on table creation.
+ *
+ * @param generator Data generator
+ */
+export declare const Fixture: <T extends typeof Table>(generator: (p: T) => AwaitableArray<Partial<InstanceType<T>>>) => ClassDecorator<T>;
+export {};

package/dist/table.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fixture = exports.Index = exports.Table = exports.TableRefSymbol = exports.TableMetaSymbol = void 0;
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const common_1 = require("./common");
+const common_2 = require("./modifiers/common");
+exports.TableMetaSymbol = Symbol();
+exports.TableRefSymbol = Symbol();
+/**
+ * Database Table superclass
+ */
+class Table {
+    /**
+     * Supplement the superclass with Modifier mixins.
+     *
+     * @param others List of Modifier mixin classes
+     * @returns New superclass
+     */
+    static with(...others) {
+        // biome-ignore lint/complexity/noThisInStatic: intentional mixin pattern — this refers to the calling class
+        const c = class _internal_table extends this {
+        };
+        for (const mixin of others
+            .map((otherClass) => otherClass.prototype && new otherClass())
+            .map((other) => other?.[common_2.MixinSymbol])
+            .filter((mixin) => mixin?.prototype)) {
+            for (const key of Object.getOwnPropertyNames(mixin.prototype)) {
+                if (key !== "constructor" && !(key in c.prototype)) {
+                    c.prototype[key] = mixin.prototype[key];
+                }
+            }
+            for (const key of Object.getOwnPropertySymbols(mixin.prototype)) {
+                if (!(key in c.prototype)) {
+                    c.prototype[key] = mixin.prototype[key];
+                }
+            }
+        }
+        return c;
+    }
+}
+exports.Table = Table;
+/**
+ * Database Table Index decorator.
+ *
+ * Available options:
+ * - `group`: Index name for multi-field indexes.
+ *
+ * @param options Options
+ */
+exports.Index = (0, decorators_1.MakePropertyDecorator)((target, propertyKey, options) => {
+    const metadata = (0, common_1.getMetadata)(target.constructor, common_1.DatumStaticMetadata);
+    metadata.addIndex(propertyKey, options?.group || propertyKey);
+});
+/**
+ * Database Table class decorator to create default data on table creation.
+ *
+ * @param generator Data generator
+ */
+exports.Fixture = (0, decorators_1.MakeClassDecorator)((target, generator) => {
+    const metadata = (0, common_1.getMetadata)(target, common_1.DatumStaticMetadata);
+    metadata.generator = generator;
+});
+//# sourceMappingURL=table.js.map

package/dist/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../src/table.ts"],"names":[],"mappings":";;;AAAA,sEAI+C;AAC/C,qCAAgF;AAChF,+CAAiE;AAQpD,QAAA,eAAe,GAAG,MAAM,EAAE,CAAC;AAC3B,QAAA,cAAc,GAAG,MAAM,EAAE,CAAC;AAgCvC;;GAEG;AACH,MAAa,KAAK;IAGhB;;;;;OAKG;IACI,MAAM,CAAC,IAAI,CAKhB,GAAG,MAAS;QAQZ,4GAA4G;QAC5G,MAAM,CAAC,GAAG,MAAM,eAAgB,SAAS,IAAY;SAAG,CAAC;QACzD,KAAK,MAAM,KAAK,IAAI,MAAM;aACvB,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,IAAI,IAAI,UAAU,EAAE,CAAC;aAC7D,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,oBAAW,CAAC,CAAC;aACpC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC;YACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9D,IAAI,GAAG,KAAK,aAAa,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC7C,CAAC,CAAC,SAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;YACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,qBAAqB,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChE,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC;oBACpB,CAAC,CAAC,SAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACjD,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAY,CAAC,CAAC;IAChB,CAAC;CACF;AAzCD,sBAyCC;AAED;;;;;;;GAOG;AACU,QAAA,KAAK,GAAG,IAAA,kCAAqB,EACxC,CAAC,MAAM,EAAE,WAAW,EAAE,OAA4B,EAAE,EAAE;IACpD,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,MAAM,CAAC,WAAW,EAAE,4BAAmB,CAAC,CAAC;IACtE,QAAQ,CAAC,QAAQ,CACP,WAAW,EACnB,OAAO,EAAE,KAAK,IAAY,WAAW,CACtC,CAAC;AACJ,CAAC,CACF,CAAC;AAGF;;;;GAIG;AACU,QAAA,OAAO,GAEK,IAAA,+BAAkB,EAAC,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE;IAChE,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,MAAM,EAAE,4BAAmB,CAAC,CAAC;IAC1D,QAAQ,CAAC,SAAS,GAAG,SAAwD,CAAC;AAChF,CAAC,CAAC,CAAC"}

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

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

package/dist/tests/common.test.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@antelopejs/interface-database-decorators/common");
+const chai_1 = require("chai");
+describe("Common - metadata", () => {
+    it("creates metadata with default values", async () => CreateMetadataWithDefaultValuesTest());
+    it("adds index to metadata", async () => AddIndexToMetadataTest());
+    it("creates new metadata when not exists", async () => CreateNewMetadataWhenNotExistsTest());
+    it("retrieves existing metadata", async () => RetrieveExistingMetadataTest());
+    it("handles deep partial types correctly", async () => HandleDeepPartialTypesCorrectlyTest());
+    it("has schemaName undefined by default", async () => SchemaNameUndefinedByDefaultTest());
+});
+async function CreateMetadataWithDefaultValuesTest() {
+    const metadata = new common_1.DatumStaticMetadata();
+    (0, chai_1.expect)(metadata.primary).to.equal("_id");
+    (0, chai_1.expect)(metadata.indexes).to.deep.equal({});
+    (0, chai_1.expect)(metadata.generator).to.equal(undefined);
+}
+async function AddIndexToMetadataTest() {
+    const metadata = new common_1.DatumStaticMetadata();
+    metadata.addIndex("email", "user_search");
+    metadata.addIndex("name", "user_search");
+    (0, chai_1.expect)(metadata.indexes.user_search).to.deep.equal(["email", "name"]);
+}
+async function CreateNewMetadataWhenNotExistsTest() {
+    class TestClass {
+    }
+    const metadata = (0, common_1.getMetadata)(TestClass, common_1.DatumStaticMetadata);
+    (0, chai_1.expect)(metadata).to.be.instanceOf(common_1.DatumStaticMetadata);
+    (0, chai_1.expect)(metadata.primary).to.equal("_id");
+}
+async function RetrieveExistingMetadataTest() {
+    class TestClass {
+    }
+    const metadata1 = (0, common_1.getMetadata)(TestClass, common_1.DatumStaticMetadata);
+    const metadata2 = (0, common_1.getMetadata)(TestClass, common_1.DatumStaticMetadata);
+    (0, chai_1.expect)(metadata1).to.equal(metadata2);
+}
+async function HandleDeepPartialTypesCorrectlyTest() {
+    const _partial = {
+        name: "John",
+        address: {
+            street: "Main St",
+        },
+        hobbies: ["reading"],
+    };
+}
+async function SchemaNameUndefinedByDefaultTest() {
+    const metadata = new common_1.DatumStaticMetadata();
+    (0, chai_1.expect)(metadata.schemaName).to.equal(undefined);
+}
+//# sourceMappingURL=common.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.test.js","sourceRoot":"","sources":["../../src/tests/common.test.ts"],"names":[],"mappings":";;AAAA,6EAI0D;AAC1D,+BAA8B;AAE9B,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE,CACpD,mCAAmC,EAAE,CAAC,CAAC;IACzC,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE,CAAC,sBAAsB,EAAE,CAAC,CAAC;IACnE,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE,CACpD,kCAAkC,EAAE,CAAC,CAAC;IACxC,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE,CAAC,4BAA4B,EAAE,CAAC,CAAC;IAC9E,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE,CACpD,mCAAmC,EAAE,CAAC,CAAC;IACzC,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE,CACnD,gCAAgC,EAAE,CAAC,CAAC;AACxC,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,mCAAmC;IAChD,MAAM,QAAQ,GAAG,IAAI,4BAAmB,EAAE,CAAC;IAE3C,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3C,IAAA,aAAM,EAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjD,CAAC;AAED,KAAK,UAAU,sBAAsB;IACnC,MAAM,QAAQ,GAAG,IAAI,4BAAmB,EAAE,CAAC;IAE3C,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC1C,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAEzC,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,KAAK,UAAU,kCAAkC;IAC/C,MAAM,SAAS;KAAG;IAClB,MAAM,QAAQ,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;IAE7D,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,4BAAmB,CAAC,CAAC;IACvD,IAAA,aAAM,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC;AAED,KAAK,UAAU,4BAA4B;IACzC,MAAM,SAAS;KAAG;IAClB,MAAM,SAAS,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,IAAA,oBAAW,EAAC,SAAS,EAAE,4BAAmB,CAAC,CAAC;IAE9D,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAED,KAAK,UAAU,mCAAmC;IAWhD,MAAM,QAAQ,GAA0B;QACtC,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE;YACP,MAAM,EAAE,SAAS;SAClB;QACD,OAAO,EAAE,CAAC,SAAS,CAAC;KACrB,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,gCAAgC;IAC7C,MAAM,QAAQ,GAAG,IAAI,4BAAmB,EAAE,CAAC;IAC3C,IAAA,aAAM,EAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AAClD,CAAC"}

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

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