@starklabs/forge 1.3.25-builtin-configs.0 → 2.0.0

package/dist/testing/createTestForge.d.ts

@@ -0,0 +1,44 @@
+import type { ForgeOptions } from "../config/ForgeOptions.js";
+import { Forge } from "../core/Forge.js";
+import type { ForgeDependencies } from "../core/ServiceFactory.js";
+import { InMemoryDataSource } from "./InMemoryDataSource.js";
+import { FakeEmailProvider, FakeStorage } from "./fakes.js";
+import { FakeOAuthServer } from "./FakeOAuthServer.js";
+import { TestClient } from "./TestClient.js";
+export interface TestForge {
+    forge: Forge;
+    client: TestClient;
+    data: InMemoryDataSource;
+    email: FakeEmailProvider;
+    storage: FakeStorage;
+    /** Fake Google/GitHub servers behind the built-in OAuth providers. */
+    oauth: FakeOAuthServer;
+    url: string;
+    /** A fresh client with its own cookie jar (another browser). */
+    newClient(): TestClient;
+    close(): Promise<void>;
+}
+export declare const TEST_JWT_SECRET = "test-secret-test-secret-test-secret-0123456789";
+/** A ready-to-use auth configuration for tests. */
+export declare const testAuthConfig: (overrides?: Record<string, unknown>) => {
+    mode: "builtin";
+    signupMode: "credentials";
+    loginMode: "credentials";
+    returnAccessToken: boolean;
+    returnRefreshToken: boolean;
+    mongooseConfig: {
+        model: string;
+        schema: {
+            name: import("../fields/unified.types.js").UnifiedField;
+            email: import("../fields/unified.types.js").UnifiedField;
+            password: import("../fields/unified.types.js").UnifiedField;
+            role: never;
+        };
+    };
+};
+/**
+ * Boots a complete Forge app on a random port with an in-memory database,
+ * a fake mailer and fake file storage. Always `await close()` when done.
+ */
+export declare const createTestForge: (options?: ForgeOptions, extraDependencies?: ForgeDependencies) => Promise<TestForge>;
+//# sourceMappingURL=createTestForge.d.ts.map

package/dist/testing/createTestForge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTestForge.d.ts","sourceRoot":"","sources":["../../src/testing/createTestForge.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,iBAAiB,CAAC;IACzB,OAAO,EAAE,WAAW,CAAC;IACrB,sEAAsE;IACtE,KAAK,EAAE,eAAe,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,gEAAgE;IAChE,SAAS,IAAI,UAAU,CAAC;IACxB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,eAAO,MAAM,eAAe,mDAAmD,CAAC;AAEhF,mDAAmD;AACnD,eAAO,MAAM,cAAc,eAAe,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;UACzD,SAAS;gBACH,aAAa;eACd,aAAa;;;;QAItB,KAAK;QACL,MAAM;YACJ,IAAI;YACJ,KAAK;YACL,QAAQ;YACR,IAAI,EAAuC,KAAK;;;CAIpD,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,eAAe,aAAmB,YAAY,sBAA0B,iBAAiB,KAAQ,OAAO,CAAC,SAAS,CAuC9H,CAAC"}

package/dist/testing/createTestForge.js

@@ -0,0 +1,65 @@
+import { Forge } from "../core/Forge.js";
+import { generateMasterKey } from "../security/CryptoVault.js";
+import fields from "../fields/unified.fields.js";
+import { InMemoryDataSource } from "./InMemoryDataSource.js";
+import { FakeEmailProvider, FakeStorage } from "./fakes.js";
+import { FakeOAuthServer } from "./FakeOAuthServer.js";
+import { TestClient } from "./TestClient.js";
+export const TEST_JWT_SECRET = "test-secret-test-secret-test-secret-0123456789";
+/** A ready-to-use auth configuration for tests. */
+export const testAuthConfig = (overrides = {}) => ({
+    mode: "builtin",
+    signupMode: "credentials",
+    loginMode: "credentials",
+    returnAccessToken: true,
+    returnRefreshToken: true,
+    mongooseConfig: {
+        model: "User",
+        schema: {
+            name: fields.requiredString,
+            email: fields.email,
+            password: fields.password,
+            role: { type: String, default: "user" },
+        },
+    },
+    ...overrides,
+});
+/**
+ * Boots a complete Forge app on a random port with an in-memory database,
+ * a fake mailer and fake file storage. Always `await close()` when done.
+ */
+export const createTestForge = async (options = {}, extraDependencies = {}) => {
+    // An option that is `undefined` (for example `process.env.JWT_SECRET` in a test run) must not wipe out a test default.
+    const given = Object.fromEntries(Object.entries(options).filter(([, value]) => value !== undefined));
+    const data = new InMemoryDataSource();
+    const email = new FakeEmailProvider();
+    const storage = new FakeStorage();
+    const oauth = new FakeOAuthServer();
+    const forge = new Forge({
+        ENV: "test",
+        port: 0,
+        isOffline: true,
+        jwtSecret: TEST_JWT_SECRET,
+        masterKey: await generateMasterKey(),
+        authMaxReqLimit: 10_000,
+        maxReqLimit: 100_000,
+        systemEmailSender: "Forge Tests <noreply@forge.test>",
+        builtinConfig: { email: { companyName: "Forge", companyUrl: "https://forge.test", companyAddress: "1 Test St", supportEmail: "help@forge.test", unsubscribeUrl: "https://forge.test/unsub" } },
+        ...given,
+    }, { dataSource: data, emailProvider: email, storageProviders: [storage], fetch: oauth.fetch, ...extraDependencies });
+    const server = await forge.start();
+    const url = `http://127.0.0.1:${server.address().port}`;
+    const base = `${url}${forge.config.apiPrefix}`;
+    return {
+        forge,
+        client: new TestClient(base),
+        data,
+        email,
+        storage,
+        oauth,
+        url: base,
+        newClient: () => new TestClient(base),
+        close: () => forge.stop(),
+    };
+};
+//# sourceMappingURL=createTestForge.js.map

package/dist/testing/createTestForge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTestForge.js","sourceRoot":"","sources":["../../src/testing/createTestForge.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,MAAM,MAAM,6BAA6B,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAgB7C,MAAM,CAAC,MAAM,eAAe,GAAG,gDAAgD,CAAC;AAEhF,mDAAmD;AACnD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAS,GAA4B,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1E,IAAI,EAAE,SAAkB;IACxB,UAAU,EAAE,aAAsB;IAClC,SAAS,EAAE,aAAsB;IACjC,iBAAiB,EAAE,IAAI;IACvB,kBAAkB,EAAE,IAAI;IACxB,cAAc,EAAE;QACd,KAAK,EAAE,MAAM;QACb,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC,cAAc;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAW;SACjD;KACF;IACD,GAAG,SAAS;CACb,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,OAAO,GAAiB,EAAE,EAAE,iBAAiB,GAAsB,EAAE,EAAsB,EAAE;IACjI,uHAAuH;IACvH,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAiB,CAAC;IACrH,MAAM,IAAI,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,IAAI,iBAAiB,EAAE,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;IAEpC,MAAM,KAAK,GAAG,IAAI,KAAK,CACrB;QACE,GAAG,EAAE,MAAM;QACX,IAAI,EAAE,CAAC;QACP,SAAS,EAAE,IAAI;QACf,SAAS,EAAE,eAAe;QAC1B,SAAS,EAAE,MAAM,iBAAiB,EAAE;QACpC,eAAe,EAAE,MAAM;QACvB,WAAW,EAAE,OAAO;QACpB,iBAAiB,EAAE,kCAAkC;QACrD,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,0BAA0B,EAAE,EAAE;QAC9L,GAAG,KAAK;KACT,EACD,EAAE,UAAU,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,iBAAiB,EAAE,CAClH,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;IACnC,MAAM,GAAG,GAAG,oBAAqB,MAAM,CAAC,OAAO,EAAkB,CAAC,IAAI,EAAE,CAAC;IACzE,MAAM,IAAI,GAAG,GAAG,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;IAE/C,OAAO;QACL,KAAK;QACL,MAAM,EAAE,IAAI,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI;QACJ,KAAK;QACL,OAAO;QACP,KAAK;QACL,GAAG,EAAE,IAAI;QACT,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC;QACrC,KAAK,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE;KAC1B,CAAC;AACJ,CAAC,CAAC"}

package/dist/testing/fakes.d.ts

@@ -0,0 +1,36 @@
+import type { EmailProvider, OutgoingEmail } from "../email/EmailProvider.js";
+import type { IncomingFile, StorageProvider } from "../upload/StorageProvider.js";
+import type { StoreFile } from "../types/StoreFile.js";
+import type { UploadType } from "../types/upload.js";
+/** Collects e-mails instead of sending them. */
+export declare class FakeEmailProvider implements EmailProvider {
+    readonly sent: OutgoingEmail[];
+    /** Make the next `send` fail, to test error handling. */
+    failNext: boolean;
+    send(email: OutgoingEmail): Promise<void>;
+    lastTo(address: string): OutgoingEmail | undefined;
+    /** The `token` of the magic link in the last e-mail sent to `address`. */
+    lastMagicToken(address: string): string;
+    /** The 6-digit code in the last e-mail sent to `address`. */
+    lastCode(address: string): string;
+}
+/** Keeps "uploaded" files in a map. */
+export declare class FakeStorage implements StorageProvider {
+    readonly name: "cloudinary";
+    readonly files: Map<string, StoreFile>;
+    readonly removed: string[];
+    failNext: boolean;
+    upload(file: IncomingFile, { type }: {
+        type: UploadType;
+    }): Promise<StoreFile>;
+    remove(file: Pick<StoreFile, "storageKey">): Promise<void>;
+}
+/** The smallest buffers that pass Forge's content sniffing. */
+export declare const sample: {
+    png: () => Buffer;
+    jpeg: () => Buffer;
+    pdf: () => Buffer;
+    /** Claims to be an image but is an HTML/script payload. */
+    fakeImage: () => Buffer;
+};
+//# sourceMappingURL=fakes.d.ts.map

package/dist/testing/fakes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fakes.d.ts","sourceRoot":"","sources":["../../src/testing/fakes.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,gDAAgD;AAChD,qBAAa,iBAAkB,YAAW,aAAa;IACrD,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,CAAM;IACpC,yDAAyD;IACzD,QAAQ,UAAS;IAEX,IAAI,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAM9C;IAED,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAEjD;IAED,0EAA0E;IAC1E,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAKtC;IAED,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAKhC;CACF;AAED,uCAAuC;AACvC,qBAAa,WAAY,YAAW,eAAe;IACjD,QAAQ,CAAC,IAAI,EAAG,YAAY,CAAU;IACtC,QAAQ,CAAC,KAAK,yBAAgC;IAC9C,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAM;IAChC,QAAQ,UAAS;IAEX,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAgBnF;IAEK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAG/D;CACF;AAED,+DAA+D;AAC/D,eAAO,MAAM,MAAM;IACjB,GAAG,QAAM,MAAM;IACf,IAAI,QAAM,MAAM;IAChB,GAAG,QAAM,MAAM;IACf,2DAA2D;IAC3D,SAAS,QAAM,MAAM;CACtB,CAAC"}

package/dist/testing/fakes.js

@@ -0,0 +1,70 @@
+import { newObjectId } from "../utils/ids.js";
+/** Collects e-mails instead of sending them. */
+export class FakeEmailProvider {
+    sent = [];
+    /** Make the next `send` fail, to test error handling. */
+    failNext = false;
+    async send(email) {
+        if (this.failNext) {
+            this.failNext = false;
+            throw new Error("simulated provider failure");
+        }
+        this.sent.push(email);
+    }
+    lastTo(address) {
+        return [...this.sent].reverse().find((e) => e.to.toLowerCase() === address.toLowerCase());
+    }
+    /** The `token` of the magic link in the last e-mail sent to `address`. */
+    lastMagicToken(address) {
+        const html = this.lastTo(address)?.html ?? "";
+        const match = /[?&]token=([A-Za-z0-9_-]+)/.exec(html);
+        if (!match?.[1])
+            throw new Error(`No magic-link e-mail found for ${address}`);
+        return match[1];
+    }
+    /** The 6-digit code in the last e-mail sent to `address`. */
+    lastCode(address) {
+        const html = this.lastTo(address)?.html ?? "";
+        const match = /verification code is (\d{6})/.exec(html);
+        if (!match?.[1])
+            throw new Error(`No code e-mail found for ${address}`);
+        return match[1];
+    }
+}
+/** Keeps "uploaded" files in a map. */
+export class FakeStorage {
+    name = "cloudinary";
+    files = new Map();
+    removed = [];
+    failNext = false;
+    async upload(file, { type }) {
+        if (this.failNext) {
+            this.failNext = false;
+            throw new Error("simulated storage failure");
+        }
+        const key = `fake/${newObjectId()}`;
+        const stored = {
+            url: `https://files.example.test/${key}`,
+            storageKey: key,
+            bytes: file.size,
+            format: file.mimetype.split("/")[1] ?? "bin",
+            mimeType: file.mimetype,
+            resourceType: type,
+        };
+        this.files.set(key, stored);
+        return stored;
+    }
+    async remove(file) {
+        this.files.delete(file.storageKey);
+        this.removed.push(file.storageKey);
+    }
+}
+/** The smallest buffers that pass Forge's content sniffing. */
+export const sample = {
+    png: () => Buffer.concat([Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]), Buffer.alloc(16)]),
+    jpeg: () => Buffer.concat([Buffer.from([0xff, 0xd8, 0xff, 0xe0]), Buffer.alloc(16)]),
+    pdf: () => Buffer.from("%PDF-1.7\n%âãÏÓ\n1 0 obj\n"),
+    /** Claims to be an image but is an HTML/script payload. */
+    fakeImage: () => Buffer.from("<html><script>alert(1)</script></html>"),
+};
+//# sourceMappingURL=fakes.js.map

package/dist/testing/fakes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fakes.js","sourceRoot":"","sources":["../../src/testing/fakes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAM9C,gDAAgD;AAChD,MAAM,OAAO,iBAAiB;IACnB,IAAI,GAAoB,EAAE,CAAC;IACpC,yDAAyD;IACzD,QAAQ,GAAG,KAAK,CAAC;IAEjB,KAAK,CAAC,IAAI,CAAC,KAAoB;QAC7B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,OAAe;QACpB,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED,0EAA0E;IAC1E,cAAc,CAAC,OAAe;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,gCAAgC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;QAC9E,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,6DAA6D;IAC7D,QAAQ,CAAC,OAAe;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QAC9C,MAAM,KAAK,GAAG,8BAA8B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;QACxE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;CACF;AAED,uCAAuC;AACvC,MAAM,OAAO,WAAW;IACb,IAAI,GAAG,YAAqB,CAAC;IAC7B,KAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IACrC,OAAO,GAAa,EAAE,CAAC;IAChC,QAAQ,GAAG,KAAK,CAAC;IAEjB,KAAK,CAAC,MAAM,CAAC,IAAkB,EAAE,EAAE,IAAI,EAAwB;QAC7D,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,GAAG,GAAG,QAAQ,WAAW,EAAE,EAAE,CAAC;QACpC,MAAM,MAAM,GAAc;YACxB,GAAG,EAAE,8BAA8B,GAAG,EAAE;YACxC,UAAU,EAAE,GAAG;YACf,KAAK,EAAE,IAAI,CAAC,IAAI;YAChB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK;YAC5C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,YAAY,EAAE,IAAI;SACnB,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAmC;QAC9C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;CACF;AAED,+DAA+D;AAC/D,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,GAAG,EAAE,GAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IACnH,IAAI,EAAE,GAAW,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5F,GAAG,EAAE,GAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC;IAC5D,2DAA2D;IAC3D,SAAS,EAAE,GAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC;CAC/E,CAAC"}

package/dist/testing/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./InMemoryRepository.js";
+export * from "./InMemoryDataSource.js";
+export * from "./fakes.js";
+export * from "./FakeOAuthServer.js";
+export * from "./TestClient.js";
+export * from "./createTestForge.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC"}

package/dist/testing/index.js

@@ -0,0 +1,7 @@
+export * from "./InMemoryRepository.js";
+export * from "./InMemoryDataSource.js";
+export * from "./fakes.js";
+export * from "./FakeOAuthServer.js";
+export * from "./TestClient.js";
+export * from "./createTestForge.js";
+//# sourceMappingURL=index.js.map

package/dist/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC"}

package/dist/types/ActionHandler.d.ts

@@ -0,0 +1,66 @@
+import type { Request } from "express";
+import type { Model } from "mongoose";
+import type { Repository } from "../data/Repository.js";
+import type { EmailActionTemplate } from "./EmailActionTemplate.js";
+/** Operations that can trigger actions. */
+export type ActionOperation = "read" | "readAll" | "create" | "createBulk" | "update" | "remove" | "removeMultiple" | "removeAll" | "addFile" | "updateFile" | "deleteFile";
+/** Context provided to Forge actions before or after a route operation. */
+export interface ActionContext {
+    /** Express request. */
+    req: Request;
+    /** Authenticated user, if any. */
+    user?: Request["user"];
+    /** Collection route segment, e.g. `"products"`. */
+    route: string;
+    /** Operation being performed. */
+    operation: ActionOperation;
+    /** Model name, e.g. `"Product"`. */
+    model: string;
+    /** Mongoose model (available when the default MongoDB data source is used). */
+    Model?: Model<any> | undefined;
+    /** Framework-agnostic data access for the model. */
+    repository?: Repository | undefined;
+    /**
+     * Data access for any model of the app, by the model name of its collection, for example
+     * `ctx.repositoryOf("Product")`. It works with the in-memory data source of `createTestForge` too, and throws a
+     * `ConfigurationError` when no collection declares that model. The documents are raw: sanitise them before they
+     * reach a response.
+     */
+    repositoryOf: (model: string) => Repository;
+    /** Data associated with the current request. */
+    data?: {
+        owner?: string | undefined;
+        body?: Record<string, unknown> | undefined;
+        files?: unknown;
+        encrypted?: Record<string, unknown> | undefined;
+        hashed?: Record<string, unknown> | undefined;
+    };
+    /** Document(s) affected by the operation (already sanitised). */
+    item?: unknown;
+    /**
+     * The data that will be sent to the client. In `after` actions a
+     * `customAction` may return a replacement.
+     */
+    result?: unknown;
+}
+/** Executes custom developer-defined logic. */
+export interface CustomAction {
+    customAction: (context: ActionContext) => Promise<unknown> | unknown;
+}
+/** Sends an e-mail through Forge's configured provider. */
+export interface EmailAction {
+    emailAction: {
+        /** Sender, or `"system-email-sender"` to use `systemEmailSender`. */
+        from: "system-email-sender" | (string & {});
+        to: string | ((context: ActionContext) => string | Promise<string>);
+        type: "template" | "raw";
+        /** Raw HTML body when `type` is `"raw"`. It is sent as-is: never put user input in it. */
+        rawBody?: string;
+        template?: EmailActionTemplate;
+        subject: string | ((context: ActionContext) => string);
+    };
+}
+export type Action = CustomAction | EmailAction;
+/** @deprecated Use {@link ActionContext}. */
+export type CreateContext = ActionContext;
+//# sourceMappingURL=ActionHandler.d.ts.map

package/dist/types/ActionHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionHandler.d.ts","sourceRoot":"","sources":["../../src/types/ActionHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,2CAA2C;AAC3C,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,gBAAgB,GAChB,WAAW,GACX,SAAS,GACT,YAAY,GACZ,YAAY,CAAC;AAEjB,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC5B,uBAAuB;IACvB,GAAG,EAAE,OAAO,CAAC;IAEb,kCAAkC;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvB,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IAEd,iCAAiC;IACjC,SAAS,EAAE,eAAe,CAAC;IAE3B,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IAEd,+EAA+E;IAC/E,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE/B,oDAAoD;IACpD,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAEpC;;;;;OAKG;IACH,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC;IAE5C,gDAAgD;IAChD,IAAI,CAAC,EAAE;QACL,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;QAC3C,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;QAChD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;KAC9C,CAAC;IAEF,iEAAiE;IACjE,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,+CAA+C;AAC/C,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;CACtE;AAED,2DAA2D;AAC3D,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE;QACX,qEAAqE;QACrE,IAAI,EAAE,qBAAqB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;QAC5C,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACpE,IAAI,EAAE,UAAU,GAAG,KAAK,CAAC;QACzB,0FAA0F;QAC1F,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;QAC/B,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,CAAC,CAAC;KACxD,CAAC;CACH;AAED,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,WAAW,CAAC;AAEhD,6CAA6C;AAC7C,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC"}

package/dist/types/ActionHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionHandler.js","sourceRoot":"","sources":["../../src/types/ActionHandler.ts"],"names":[],"mappings":""}

package/dist/types/AuthenticatedUser.d.ts

@@ -0,0 +1,6 @@
+/** The identity attached to `req.user` by the authentication middleware. */
+export interface AuthenticatedUser {
+    _id: string;
+    role?: string | undefined;
+}
+//# sourceMappingURL=AuthenticatedUser.d.ts.map

package/dist/types/AuthenticatedUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticatedUser.d.ts","sourceRoot":"","sources":["../../src/types/AuthenticatedUser.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B"}

package/dist/types/AuthenticatedUser.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AuthenticatedUser.js.map

package/dist/types/AuthenticatedUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticatedUser.js","sourceRoot":"","sources":["../../src/types/AuthenticatedUser.ts"],"names":[],"mappings":""}

package/dist/types/Collection.d.ts

@@ -0,0 +1,44 @@
+import type { MongooseField } from "../fields/mongoose.fields.js";
+import type { UnifiedField } from "../fields/unified.types.js";
+import type { ZodType } from "zod";
+import type { Route } from "./Route.js";
+export type { Route } from "./Route.js";
+/** A database field: a Mongoose field or a combined `{ mongoose, zod }` field. */
+export type SchemaField = MongooseField | UnifiedField;
+/** All database fields of a model. */
+export type CollectionSchema = Record<string, SchemaField>;
+/** A validation rule: a Zod type or a combined `{ mongoose, zod }` field. */
+export type ValidationField = ZodType | UnifiedField;
+/** Named groups of validation rules, referenced from `Route.validation`. */
+export type CollectionValidations = Record<string, Record<string, ValidationField>>;
+/** The feature a collection implements. */
+export type CollectionType = "auth" | "health" | "crud" | "account" | "admin";
+/**
+ * Configuration for one backend feature.
+ *
+ * @example
+ * ```ts
+ * collection({
+ *   type: "crud",
+ *   route: "products",
+ *   model: "Product",
+ *   schema: { name: fields.requiredString, price: fields.requiredNumber },
+ *   routes: [{ method: "get", path: "/", handler: "readAll", auth: "public" }],
+ * });
+ * ```
+ */
+export interface Collection {
+    type: CollectionType;
+    /** URL segment, e.g. `"products"` -> `/api/v1/products`. */
+    route: string;
+    routes: Route[];
+    /** Model name (singular, capitalised). */
+    model?: string;
+    schema?: CollectionSchema;
+    validations?: CollectionValidations;
+}
+export type MongooseSchema = CollectionSchema;
+export type MongooseObj = CollectionSchema;
+export type ValidationsObj = CollectionValidations;
+export type ReqType = CollectionType;
+//# sourceMappingURL=Collection.d.ts.map

package/dist/types/Collection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.d.ts","sourceRoot":"","sources":["../../src/types/Collection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,YAAY,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,kFAAkF;AAClF,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,YAAY,CAAC;AAEvD,sCAAsC;AACtC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3D,6EAA6E;AAC7E,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,YAAY,CAAC;AAErD,4EAA4E;AAC5E,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;AAEpF,2CAA2C;AAC3C,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;AAE9E;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,WAAW,CAAC,EAAE,qBAAqB,CAAC;CACrC;AAGD,MAAM,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAC9C,MAAM,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAC3C,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAC;AACnD,MAAM,MAAM,OAAO,GAAG,cAAc,CAAC"}

package/dist/types/Collection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Collection.js","sourceRoot":"","sources":["../../src/types/Collection.ts"],"names":[],"mappings":""}

package/dist/types/EmailActionTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmailActionTemplate.d.ts","sourceRoot":"","sources":["../../src/types/EmailActionTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,KAAK,EACV,+BAA+B,EAC/B,+BAA+B,EAC/B,+BAA+B,EAC/B,6BAA6B,EAC7B,8BAA8B,EAC9B,8BAA8B,EAC9B,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,yBAAyB,EACzB,wBAAwB,EACxB,2BAA2B,EAC3B,0BAA0B,EAC1B,4BAA4B,EAC5B,4BAA4B,EAC5B,8BAA8B,EAC9B,wBAAwB,EACxB,8BAA8B,EAC9B,2BAA2B,EAC3B,+BAA+B,EAC/B,2BAA2B,EAC3B,6BAA6B,EAC7B,+BAA+B,EAC/B,kCAAkC,EAClC,+BAA+B,EAC/B,6BAA6B,EAC7B,uCAAuC,EACvC,gCAAgC,EAChC,iCAAiC,EACjC,8BAA8B,EAC9B,8BAA8B,EAC9B,+BAA+B,EAC/B,wBAAwB,EACxB,yBAAyB,EACzB,8BAA8B,EAC9B,sCAAsC,EACtC,oCAAoC,EACpC,oCAAoC,EACpC,8BAA8B,EAC9B,+BAA+B,EAC/B,4BAA4B,EAC5B,8BAA8B,EAC9B,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,mBAAmB,GAC3B,aAAa,GACb,aAAa,GACb,YAAY,GACZ,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,YAAY,GACZ,UAAU,CAAC;AAEf,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,aAAa,CAAC;IACpB,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,YAAY,CAAC,EAAE,IAAI,CAAC,6BAA6B,EAAE,mBAAmB,CAAC,CAAC;IACxE,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,WAAW,CAAC,EAAE,IAAI,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;IACtE,WAAW,CAAC,EAAE,IAAI,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;IACtE,YAAY,CAAC,EAAE,IAAI,CAAC,6BAA6B,EAAE,mBAAmB,CAAC,CAAC;IACxE,QAAQ,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,mBAAmB,CAAC,CAAC;IAChE,OAAO,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;IAC9D,UAAU,CAAC,EAAE,IAAI,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAC;IACpE,SAAS,CAAC,EAAE,IAAI,CAAC,0BAA0B,EAAE,mBAAmB,CAAC,CAAC;IAClE,WAAW,CAAC,EAAE,IAAI,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;IACtE,WAAW,CAAC,EAAE,IAAI,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;IACtE,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,OAAO,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;IAC9D,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,UAAU,CAAC,EAAE,IAAI,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAC;IACpE,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,UAAU,CAAC,EAAE,IAAI,CAAC,2BAA2B,EAAE,mBAAmB,CAAC,CAAC;IACpE,YAAY,CAAC,EAAE,IAAI,CAAC,6BAA6B,EAAE,mBAAmB,CAAC,CAAC;IACxE,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,iBAAiB,CAAC,EAAE,IAAI,CACtB,kCAAkC,EAClC,mBAAmB,CACpB,CAAC;IACF,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,YAAY,CAAC,EAAE,IAAI,CAAC,6BAA6B,EAAE,mBAAmB,CAAC,CAAC;IACxE,sBAAsB,CAAC,EAAE,IAAI,CAC3B,uCAAuC,EACvC,mBAAmB,CACpB,CAAC;IACF,eAAe,CAAC,EAAE,IAAI,CAAC,gCAAgC,EAAE,mBAAmB,CAAC,CAAC;IAC9E,gBAAgB,CAAC,EAAE,IAAI,CACrB,iCAAiC,EACjC,mBAAmB,CACpB,CAAC;IACF,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,OAAO,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;IAC9D,QAAQ,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,mBAAmB,CAAC,CAAC;IAChE,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,qBAAqB,CAAC,EAAE,IAAI,CAC1B,sCAAsC,EACtC,mBAAmB,CACpB,CAAC;IACF,mBAAmB,CAAC,EAAE,IAAI,CACxB,oCAAoC,EACpC,mBAAmB,CACpB,CAAC;IACF,mBAAmB,CAAC,EAAE,IAAI,CACxB,oCAAoC,EACpC,mBAAmB,CACpB,CAAC;IACF,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,cAAc,CAAC,EAAE,IAAI,CAAC,+BAA+B,EAAE,mBAAmB,CAAC,CAAC;IAC5E,WAAW,CAAC,EAAE,IAAI,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;IACtE,aAAa,CAAC,EAAE,IAAI,CAAC,8BAA8B,EAAE,mBAAmB,CAAC,CAAC;IAC1E,WAAW,CAAC,EAAE,IAAI,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;IACtE,YAAY,CAAC,EAAE,IAAI,CAAC,6BAA6B,EAAE,mBAAmB,CAAC,CAAC;IACxE,OAAO,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;CAC/D"}

package/dist/types/EmailActionTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmailActionTemplate.js","sourceRoot":"","sources":["../../src/types/EmailActionTemplate.ts"],"names":[],"mappings":""}

package/dist/types/Route.d.ts

@@ -0,0 +1,100 @@
+import type { Action } from "./ActionHandler.js";
+import type { Handler } from "./handlers.js";
+import type { RoutePath } from "./Routepath.js";
+import type { Upload } from "./upload.js";
+export type { Handler } from "./handlers.js";
+/** Supported HTTP request methods for endpoints. */
+export type RouteMethod = "get" | "post" | "put" | "patch" | "delete";
+/**
+ * Who may call an endpoint. (This is an *access level*, not a user role: roles are things like
+ * `"editor"` or `"admin"`, and are matched by `Route.roles`.)
+ *
+ * - `public`: anyone.
+ * - `authenticated`: any logged-in user.
+ * - `admin`: only users whose role is one of `adminRoles`.
+ * - `admin-or-owner`: admins, or the owner of the targeted resource.
+ */
+export type AccessLevel = "admin" | "admin-or-owner" | "authenticated" | "public";
+/** @deprecated Renamed to {@link AccessLevel}: it describes who may call a route, not a user's role. */
+export type AuthRole = AccessLevel;
+/** Authentication mode used by `login` / `signup`. */
+export type AuthMode = "credentials" | "otp";
+/** Database options for a route. */
+export interface RouteDbConfig {
+    /**
+     * Schema field to populate: it must be declared with a `ref` to a model of the app. Separate several fields with a
+     * space. Only `read` and `readAll` return populated documents. Set to `false` to disable.
+     * @example "owner"
+     * @example "owner product"
+     */
+    populate?: string | false;
+    /**
+     * Which fields of the populated documents to return (the same list for every populated field). It lists what to
+     * include: a name that starts with `-` or `+` is refused at startup.
+     * Defaults to `"_id"` so e-mail addresses and other personal data of
+     * referenced documents are never exposed by accident.
+     * @example "_id name"
+     */
+    populateSelect?: string;
+    /**
+     * Fields removed from the JSON response. Include `"_id"` to drop the id.
+     * Prefix with `!` to opt back in to a field hidden by default
+     * (credentials, tokens and other secrets can never be un-hidden).
+     */
+    hiddenFields?: string[];
+    /** Body key holding the list of ids for batch operations. */
+    targetField?: string;
+    /** Maximum number of items accepted by `createBulk`. */
+    maxBulkSize?: number;
+}
+/**
+ * Defines a single endpoint inside a collection.
+ *
+ * @example
+ * ```ts
+ * { method: "get", path: "/:id", handler: "read", auth: "admin-or-owner",
+ *   validation: false, config: { populate: "owner", hiddenFields: ["__v"] } }
+ * ```
+ */
+export interface Route {
+    method: RouteMethod;
+    path: RoutePath | (string & {});
+    handler: Handler;
+    /**
+     * Validation key defined in the collection's `validations`, or `false` when
+     * the handler needs no request body.
+     */
+    validation?: string | boolean;
+    /** Who may call this route. Defaults to `"authenticated"` for non-auth modules. */
+    auth?: AccessLevel;
+    /**
+     * Restrict the route to users whose role is one of these (checked after `auth`, so both must pass).
+     * Matching is exact and case-sensitive, and admins are **not** implicitly included: list `"admin"`
+     * yourself if admins may call it. Needs a signed-in user, so it cannot be used with `auth: "public"`
+     * or `"admin"` (use `adminRoles` for that).
+     *
+     * @example roles: ["editor", "moderator", "admin"]
+     */
+    roles?: string[];
+    /** `"self"` means the document itself is the owner (e.g. a User). */
+    ownership?: "self" | "owner";
+    config?: RouteDbConfig;
+    /** Multipart upload settings. */
+    files?: Upload[];
+    /** Authentication mode for login/signup routes. */
+    mode?: AuthMode;
+    /** Body fields sealed with the master key before saving. Suffix `?` = optional. */
+    encryptedFields?: string[];
+    /** Encrypted fields returned in plain text. Suffix `?` = optional. */
+    decryptedFields?: string[];
+    /** Body fields hashed (Argon2id) before saving. Suffix `?` = optional. */
+    hashedFields?: string[];
+    /** Hooks around the handler. */
+    actions?: {
+        /** Run before the operation. Throw to abort. */
+        before?: Action[];
+        /** Run after the operation. A `customAction` return value replaces the response data. */
+        after?: Action[];
+    };
+}
+//# sourceMappingURL=Route.d.ts.map

package/dist/types/Route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../../src/types/Route.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,YAAY,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,oDAAoD;AACpD,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEtE;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,gBAAgB,GAAG,eAAe,GAAG,QAAQ,CAAC;AAElF,wGAAwG;AACxG,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC;AAEnC,sDAAsD;AACtD,MAAM,MAAM,QAAQ,GAAG,aAAa,GAAG,KAAK,CAAC;AAE7C,oCAAoC;AACpC,MAAM,WAAW,aAAa;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE1B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACpB,MAAM,EAAE,WAAW,CAAC;IACpB,IAAI,EAAE,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAChC,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAE9B,mFAAmF;IACnF,IAAI,CAAC,EAAE,WAAW,CAAC;IAEnB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7B,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,mDAAmD;IACnD,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB,mFAAmF;IACnF,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B,sEAAsE;IACtE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,gCAAgC;IAChC,OAAO,CAAC,EAAE;QACR,gDAAgD;QAChD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,yFAAyF;QACzF,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;CACH"}

package/dist/types/Route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Route.js","sourceRoot":"","sources":["../../src/types/Route.ts"],"names":[],"mappings":""}

package/dist/types/Routepath.d.ts

@@ -0,0 +1,2 @@
+export type RoutePath = "/" | "/:id" | "/update/:id" | "/delete/:id" | "/signup" | "/login" | "/logout" | "/refresh-token" | "/forgot-password" | "/reset-password" | "/methods" | "/magic-link" | "/magic-link/verify" | "/mfa" | "/mfa/totp/setup" | "/mfa/totp/enable" | "/mfa/verify" | "/mfa/disable" | "/mfa/recovery-codes" | "/oauth/providers" | "/oauth/:provider" | "/oauth/:provider/callback" | "/verify-otp" | "/resend-otp" | "/me" | "/role" | "/check" | "/:id/addFile" | "/:id/updateFile" | "/:id/deleteFile";
+//# sourceMappingURL=Routepath.d.ts.map

package/dist/types/Routepath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Routepath.d.ts","sourceRoot":"","sources":["../../src/types/Routepath.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACjB,GAAG,GACH,MAAM,GACN,aAAa,GACb,aAAa,GACb,SAAS,GACT,QAAQ,GACR,SAAS,GACT,gBAAgB,GAChB,kBAAkB,GAClB,iBAAiB,GACjB,UAAU,GACV,aAAa,GACb,oBAAoB,GACpB,MAAM,GACN,iBAAiB,GACjB,kBAAkB,GAClB,aAAa,GACb,cAAc,GACd,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,2BAA2B,GAC3B,aAAa,GACb,aAAa,GACb,KAAK,GACL,OAAO,GACP,QAAQ,GACR,cAAc,GACd,iBAAiB,GACjB,iBAAiB,CAAC"}

package/dist/types/Routepath.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Routepath.js.map

package/dist/types/Routepath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Routepath.js","sourceRoot":"","sources":["../../src/types/Routepath.ts"],"names":[],"mappings":""}

package/dist/types/StoreFile.d.ts

@@ -0,0 +1,12 @@
+/** Metadata about a file persisted in a storage provider. */
+export interface StoreFile {
+    url: string;
+    storageKey: string;
+    width?: number | undefined;
+    height?: number | undefined;
+    bytes: number;
+    format: string;
+    mimeType?: string | undefined;
+    resourceType: string;
+}
+//# sourceMappingURL=StoreFile.d.ts.map

package/dist/types/StoreFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoreFile.d.ts","sourceRoot":"","sources":["../../src/types/StoreFile.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/dist/types/StoreFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoreFile.js","sourceRoot":"","sources":["../../src/types/StoreFile.ts"],"names":[],"mappings":""}

package/dist/types/email/account.created.type.d.ts

@@ -0,0 +1,10 @@
+import type { CommonEmailPlaceholders } from "./static-config.type.js";
+import type { AutoDerivedEmailFields } from "../../email/utils/auto-fields.type.js";
+import type { ActionContext } from "../ActionHandler.js";
+export type AccountCreatedEmailPlaceholders = CommonEmailPlaceholders & Pick<AutoDerivedEmailFields, "currentYear"> & {
+    userName: "there" | (object & string) | ((context: ActionContext) => string);
+    userEmail: string | ((context: ActionContext) => string);
+    dashboardUrl: string;
+    unsubscribeUrl: string;
+};
+//# sourceMappingURL=account.created.type.d.ts.map

package/dist/types/email/account.created.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.created.type.d.ts","sourceRoot":"","sources":["../../../src/types/email/account.created.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,MAAM,MAAM,+BAA+B,GAAG,uBAAuB,GACnE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,GAAG;IAC9C,QAAQ,EAAE,OAAO,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,CAAC,CAAC;IAC7E,SAAS,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,CAAC,CAAC;IACzD,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC"}

package/dist/types/email/account.created.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.created.type.js","sourceRoot":"","sources":["../../../src/types/email/account.created.type.ts"],"names":[],"mappings":""}

package/dist/types/email/account.deleted.type.d.ts

@@ -0,0 +1,10 @@
+import type { CommonEmailPlaceholders } from "./static-config.type.js";
+import type { AutoDerivedEmailFields } from "../../email/utils/auto-fields.type.js";
+import type { ActionContext } from "../ActionHandler.js";
+export type AccountDeletedEmailPlaceholders = CommonEmailPlaceholders & Pick<AutoDerivedEmailFields, "currentYear"> & {
+    userName: "there" | (object & string) | ((context: ActionContext) => string);
+    deletionDate: "current-date" | ({} & string);
+    userEmail: string | ((context: ActionContext) => string);
+    unsubscribeUrl: string;
+};
+//# sourceMappingURL=account.deleted.type.d.ts.map

package/dist/types/email/account.deleted.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.deleted.type.d.ts","sourceRoot":"","sources":["../../../src/types/email/account.deleted.type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,MAAM,MAAM,+BAA+B,GAAG,uBAAuB,GACnE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,GAAG;IAC5C,QAAQ,EACJ,OAAO,GACP,CAAC,MAAM,GAAG,MAAM,CAAC,GACjB,CAAC,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,CAAC,CAAC;IACzC,YAAY,EAAE,cAAc,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC;IAC7C,SAAS,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,aAAa,KAAK,MAAM,CAAC,CAAC;IACzD,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC"}

package/dist/types/email/account.deleted.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.deleted.type.js","sourceRoot":"","sources":["../../../src/types/email/account.deleted.type.ts"],"names":[],"mappings":""}