@antelopejs/dms-mailing 0.7.0 → 0.7.1

package/src/types/settings.ts

@@ -52,3 +52,23 @@ export const DEFAULT_CATEGORIES: TemplateCategory[] = [
     icon: "i-ph-textbox",
   },
 ];
+
+export const DEFAULT_FALLBACK_LOCALE = "en";
+
+/**
+ * The module defaults: what a tenant's settings start with, and what the
+ * settings form offers to put back ("Use default"). The sender is empty and
+ * the webhook secret is drawn per tenant, so neither has one.
+ */
+export const MODULE_DEFAULT_SETTINGS: Pick<
+  MailingSettingsValues,
+  | "fallbackLocale"
+  | "logRetentionDays"
+  | "blockOnMissingVariables"
+  | "categories"
+> = {
+  fallbackLocale: DEFAULT_FALLBACK_LOCALE,
+  logRetentionDays: 90,
+  blockOnMissingVariables: false,
+  categories: DEFAULT_CATEGORIES,
+};

package/dist/db/models/template-slugs.model.d.ts

@@ -1,27 +0,0 @@
-import { MailingTemplateSlug } from "../tables";
-export declare function templateSlugIdOf(tenantId: string, slug: string): string;
-declare const TemplateSlugModel_base: {
-    new (database: import("@antelopejs/interface-database").SchemaInstance<any>): {
-        readonly table: import("@antelopejs/interface-database").Table<MailingTemplateSlug>;
-        readonly database: import("@antelopejs/interface-database").SchemaInstance<any>;
-        get(id: string): PromiseLike<MailingTemplateSlug | undefined>;
-        getBy(index: keyof MailingTemplateSlug, ...keys: any[]): PromiseLike<MailingTemplateSlug[]>;
-        getAll(): PromiseLike<MailingTemplateSlug[]>;
-        insert(obj: import("@antelopejs/interface-database-decorators").DeepPartial<MailingTemplateSlug> | import("@antelopejs/interface-database-decorators").DeepPartial<MailingTemplateSlug>[], options?: import("@antelopejs/interface-database-decorators").ValidateOptions): Promise<string[]>;
-        update(id: string, obj: import("@antelopejs/interface-database-decorators").DeepPartial<MailingTemplateSlug>, options?: import("@antelopejs/interface-database-decorators").ValidateOptions): Promise<number>;
-        update(obj: import("@antelopejs/interface-database-decorators").DeepPartial<MailingTemplateSlug>, options?: import("@antelopejs/interface-database-decorators").ValidateOptions): Promise<number>;
-        delete(id: string): Promise<number>;
-    };
-    readonly schemaName: string;
-    readonly tableClass: import("@antelopejs/interface-database-decorators").Constructible<MailingTemplateSlug>;
-    fromPlainData(obj: any): MailingTemplateSlug;
-    fromDatabase(obj: any): MailingTemplateSlug | undefined;
-    toDatabase(obj: any): Record<string, any>;
-    validate(obj: unknown, options?: import("@antelopejs/interface-database-decorators").ValidateInputOptions): import("@antelopejs/interface-database-decorators").ValidationResult;
-};
-export declare class TemplateSlugModel extends TemplateSlugModel_base {
-    insertClaim(id: string, slug: string, templateId: string): Promise<boolean>;
-    dropClaimOf(id: string, templateId: string): Promise<void>;
-    releaseTemplates(templateIds: string[]): Promise<void>;
-}
-export {};

package/dist/db/models/template-slugs.model.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateSlugModel = void 0;
-exports.templateSlugIdOf = templateSlugIdOf;
-const node_crypto_1 = require("node:crypto");
-const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
-const tables_1 = require("../tables");
-const ID_LENGTH = 32;
-function templateSlugIdOf(tenantId, slug) {
-    return (0, node_crypto_1.createHash)("sha256")
-        .update(`${tenantId}\n${slug}`)
-        .digest("hex")
-        .slice(0, ID_LENGTH);
-}
-class TemplateSlugModel extends (0, interface_database_decorators_1.BasicDataModel)(tables_1.MailingTemplateSlug, tables_1.MAILING_TEMPLATE_SLUGS_TABLE_NAME) {
-    async insertClaim(id, slug, templateId) {
-        try {
-            await this.insert({ _id: id, slug, templateId });
-            return true;
-        }
-        catch (error) {
-            if (await this.get(id))
-                return false;
-            throw error;
-        }
-    }
-    async dropClaimOf(id, templateId) {
-        await this.table
-            .atomicMutation(id, {
-            type: "deleteIfEqual",
-            field: "templateId",
-            expectedValue: templateId,
-        })
-            .run();
-    }
-    async releaseTemplates(templateIds) {
-        if (!templateIds.length)
-            return;
-        await this.table.getAll(templateIds, "templateId").delete().run();
-    }
-}
-exports.TemplateSlugModel = TemplateSlugModel;
-//# sourceMappingURL=template-slugs.model.js.map

package/dist/db/models/template-slugs.model.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"template-slugs.model.js","sourceRoot":"","sources":["../../../src/db/models/template-slugs.model.ts"],"names":[],"mappings":";;;AAcA,4CAKC;AAnBD,6CAAyC;AACzC,6FAA2E;AAC3E,sCAGmB;AAEnB,MAAM,SAAS,GAAG,EAAE,CAAC;AAOrB,SAAgB,gBAAgB,CAAC,QAAgB,EAAE,IAAY;IAC7D,OAAO,IAAA,wBAAU,EAAC,QAAQ,CAAC;SACxB,MAAM,CAAC,GAAG,QAAQ,KAAK,IAAI,EAAE,CAAC;SAC9B,MAAM,CAAC,KAAK,CAAC;SACb,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;AACzB,CAAC;AAED,MAAa,iBAAkB,SAAQ,IAAA,8CAAc,EACnD,4BAAmB,EACnB,0CAAiC,CAClC;IAMC,KAAK,CAAC,WAAW,CACf,EAAU,EACV,IAAY,EACZ,UAAkB;QAElB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAAE,OAAO,KAAK,CAAC;YACrC,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAGD,KAAK,CAAC,WAAW,CAAC,EAAU,EAAE,UAAkB;QAC9C,MAAM,IAAI,CAAC,KAAK;aACb,cAAc,CAAC,EAAE,EAAE;YAClB,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE,YAAY;YACnB,aAAa,EAAE,UAAU;SAC1B,CAAC;aACD,GAAG,EAAE,CAAC;IACX,CAAC;IAGD,KAAK,CAAC,gBAAgB,CAAC,WAAqB;QAC1C,IAAI,CAAC,WAAW,CAAC,MAAM;YAAE,OAAO;QAChC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;IACpE,CAAC;CACF;AAvCD,8CAuCC"}

package/dist/db/tables/template-slugs.table.d.ts

@@ -1,7 +0,0 @@
-import { Table } from "@antelopejs/interface-database-decorators";
-export declare const MAILING_TEMPLATE_SLUGS_TABLE_NAME = "mailing_template_slugs";
-export declare class MailingTemplateSlug extends Table {
-    _id: string;
-    slug: string;
-    templateId: string;
-}

package/dist/db/tables/template-slugs.table.js

@@ -1,35 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MailingTemplateSlug = exports.MAILING_TEMPLATE_SLUGS_TABLE_NAME = void 0;
-const interface_database_decorators_1 = require("@antelopejs/interface-database-decorators");
-const constants_1 = require("@antelopejs/interface-dms/constants");
-exports.MAILING_TEMPLATE_SLUGS_TABLE_NAME = "mailing_template_slugs";
-let MailingTemplateSlug = class MailingTemplateSlug extends interface_database_decorators_1.Table {
-};
-exports.MailingTemplateSlug = MailingTemplateSlug;
-__decorate([
-    (0, interface_database_decorators_1.Field)("string"),
-    __metadata("design:type", String)
-], MailingTemplateSlug.prototype, "_id", void 0);
-__decorate([
-    (0, interface_database_decorators_1.Field)("string"),
-    __metadata("design:type", String)
-], MailingTemplateSlug.prototype, "slug", void 0);
-__decorate([
-    (0, interface_database_decorators_1.Index)(),
-    (0, interface_database_decorators_1.Field)("string"),
-    __metadata("design:type", String)
-], MailingTemplateSlug.prototype, "templateId", void 0);
-exports.MailingTemplateSlug = MailingTemplateSlug = __decorate([
-    (0, interface_database_decorators_1.RegisterTable)(exports.MAILING_TEMPLATE_SLUGS_TABLE_NAME, constants_1.TENANT_SCHEMA_NAME)
-], MailingTemplateSlug);
-//# sourceMappingURL=template-slugs.table.js.map

package/dist/db/tables/template-slugs.table.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"template-slugs.table.js","sourceRoot":"","sources":["../../../src/db/tables/template-slugs.table.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6FAKmD;AACnD,mEAAyE;AAE5D,QAAA,iCAAiC,GAAG,wBAAwB,CAAC;AASnE,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,qCAAK;CAW7C,CAAA;AAXY,kDAAmB;AAEtB;IADP,IAAA,qCAAK,EAAC,QAAQ,CAAC;;gDACI;AAGZ;IADP,IAAA,qCAAK,EAAC,QAAQ,CAAC;;iDACK;AAKb;IAFP,IAAA,qCAAK,GAAE;IACP,IAAA,qCAAK,EAAC,QAAQ,CAAC;;uDACW;8BAVhB,mBAAmB;IAD/B,IAAA,6CAAa,EAAC,yCAAiC,EAAE,8BAAkB,CAAC;GACxD,mBAAmB,CAW/B"}

package/dist/hooks/database-ready.d.ts

@@ -1,7 +0,0 @@
-export interface ReadyGate {
-    open(): void;
-    after<Args extends unknown[], Result>(task: (...args: Args) => Promise<Result>): (...args: Args) => Promise<Result>;
-}
-export declare function createReadyGate(): ReadyGate;
-export declare function registerDatabaseReady(): void;
-export declare const afterDatabaseReady: ReadyGate["after"];

package/dist/hooks/database-ready.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.afterDatabaseReady = void 0;
-exports.createReadyGate = createReadyGate;
-exports.registerDatabaseReady = registerDatabaseReady;
-const hooks_1 = require("@antelopejs/interface-dms/hooks");
-function createReadyGate() {
-    let open = () => undefined;
-    const opened = new Promise((resolve) => {
-        open = resolve;
-    });
-    return {
-        open: () => open(),
-        after: (task) => async (...args) => {
-            await opened;
-            return task(...args);
-        },
-    };
-}
-const databaseGate = createReadyGate();
-function registerDatabaseReady() {
-    (0, hooks_1.RegisterHook)(hooks_1.Hook.DATABASE_INITIALIZED, () => databaseGate.open());
-}
-const afterDatabaseReady = (task) => databaseGate.after(task);
-exports.afterDatabaseReady = afterDatabaseReady;
-//# sourceMappingURL=database-ready.js.map

package/dist/hooks/database-ready.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"database-ready.js","sourceRoot":"","sources":["../../src/hooks/database-ready.ts"],"names":[],"mappings":";;;AAWA,0CAcC;AAeD,sDAEC;AA1CD,2DAAqE;AAWrE,SAAgB,eAAe;IAC7B,IAAI,IAAI,GAAe,GAAG,EAAE,CAAC,SAAS,CAAC;IACvC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QAC3C,IAAI,GAAG,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,OAAO;QACL,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE;QAClB,KAAK,EACH,CAAC,IAAI,EAAE,EAAE,CACT,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;YAChB,MAAM,MAAM,CAAC;YACb,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACvB,CAAC;KACJ,CAAC;AACJ,CAAC;AAOD,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;AAQvC,SAAgB,qBAAqB;IACnC,IAAA,oBAAY,EAAC,YAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;AACrE,CAAC;AAGM,MAAM,kBAAkB,GAAuB,CAAC,IAAI,EAAE,EAAE,CAC7D,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AADd,QAAA,kBAAkB,sBACJ"}

package/dist/services/fingerprint.d.ts

@@ -1 +0,0 @@
-export declare function fingerprintOf(value: unknown): string;

package/dist/services/fingerprint.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fingerprintOf = fingerprintOf;
-const node_crypto_1 = require("node:crypto");
-function stableJson(value) {
-    if (Array.isArray(value))
-        return `[${value.map(stableJson).join(",")}]`;
-    if (value && typeof value === "object") {
-        const entries = Object.entries(value)
-            .filter(([, entry]) => entry !== undefined)
-            .sort(([left], [right]) => Number(left > right) - Number(left < right))
-            .map(([key, entry]) => `${JSON.stringify(key)}:${stableJson(entry)}`);
-        return `{${entries.join(",")}}`;
-    }
-    return JSON.stringify(value);
-}
-function fingerprintOf(value) {
-    return (0, node_crypto_1.createHash)("sha256").update(stableJson(value)).digest("hex");
-}
-//# sourceMappingURL=fingerprint.js.map

package/dist/services/fingerprint.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fingerprint.js","sourceRoot":"","sources":["../../src/services/fingerprint.ts"],"names":[],"mappings":";;AAmBA,sCAEC;AArBD,6CAAyC;AAGzC,SAAS,UAAU,CAAC,KAAc;IAChC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IACxE,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC;aAC7D,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;aAC1C,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC;aACtE,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClC,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAMD,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,IAAA,wBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACtE,CAAC"}

package/src/db/models/template-slugs.model.ts

@@ -1,61 +0,0 @@
-import { createHash } from "node:crypto";
-import { BasicDataModel } from "@antelopejs/interface-database-decorators";
-import {
-  MAILING_TEMPLATE_SLUGS_TABLE_NAME,
-  MailingTemplateSlug,
-} from "../tables";
-
-const ID_LENGTH = 32;
-
-/**
- * The id of a slug's claim, the same whoever creates the template. The tenant
- * is part of it: a driver may keep every tenant's rows in one collection,
- * where a key made of the slug alone would collide across tenants.
- */
-export function templateSlugIdOf(tenantId: string, slug: string): string {
-  return createHash("sha256")
-    .update(`${tenantId}\n${slug}`)
-    .digest("hex")
-    .slice(0, ID_LENGTH);
-}
-
-export class TemplateSlugModel extends BasicDataModel(
-  MailingTemplateSlug,
-  MAILING_TEMPLATE_SLUGS_TABLE_NAME,
-) {
-  /**
-   * Inserts the claim; false when the key is taken. Probed by state rather
-   * than by error, since the database interface exposes no typed conflict
-   * error: a claim present after a failed insert is the lost race.
-   */
-  async insertClaim(
-    id: string,
-    slug: string,
-    templateId: string,
-  ): Promise<boolean> {
-    try {
-      await this.insert({ _id: id, slug, templateId });
-      return true;
-    } catch (error) {
-      if (await this.get(id)) return false;
-      throw error;
-    }
-  }
-
-  /** Drops the claim if `templateId` still holds it, never a newer one. */
-  async dropClaimOf(id: string, templateId: string): Promise<void> {
-    await this.table
-      .atomicMutation(id, {
-        type: "deleteIfEqual",
-        field: "templateId",
-        expectedValue: templateId,
-      })
-      .run();
-  }
-
-  /** Frees the slugs the templates held. */
-  async releaseTemplates(templateIds: string[]): Promise<void> {
-    if (!templateIds.length) return;
-    await this.table.getAll(templateIds, "templateId").delete().run();
-  }
-}

package/src/db/tables/template-slugs.table.ts

@@ -1,29 +0,0 @@
-import {
-  Field,
-  Index,
-  RegisterTable,
-  Table,
-} from "@antelopejs/interface-database-decorators";
-import { TENANT_SCHEMA_NAME } from "@antelopejs/interface-dms/constants";
-
-export const MAILING_TEMPLATE_SLUGS_TABLE_NAME = "mailing_template_slugs";
-
-/**
- * The template a slug belongs to. Its id derives from the tenant and the
- * slug, so the primary key is what keeps a slug to one template: the database
- * interface declares no unique secondary index, and two creations racing
- * past the free-slug check both insert their template, but only one claim.
- */
-@RegisterTable(MAILING_TEMPLATE_SLUGS_TABLE_NAME, TENANT_SCHEMA_NAME)
-export class MailingTemplateSlug extends Table {
-  @Field("string")
-  declare _id: string;
-
-  @Field("string")
-  declare slug: string;
-
-  /** The template holding the slug; a deleted one leaves the claim free. */
-  @Index()
-  @Field("string")
-  declare templateId: string;
-}

package/src/hooks/database-ready.ts

@@ -1,47 +0,0 @@
-import { Hook, RegisterHook } from "@antelopejs/interface-dms/hooks";
-
-/** A promise opened once, and the calls that wait for it. */
-export interface ReadyGate {
-  open(): void;
-  /** `task`, run once the gate is open. */
-  after<Args extends unknown[], Result>(
-    task: (...args: Args) => Promise<Result>,
-  ): (...args: Args) => Promise<Result>;
-}
-
-export function createReadyGate(): ReadyGate {
-  let open: () => void = () => undefined;
-  const opened = new Promise<void>((resolve) => {
-    open = resolve;
-  });
-  return {
-    open: () => open(),
-    after:
-      (task) =>
-      async (...args) => {
-        await opened;
-        return task(...args);
-      },
-  };
-}
-
-/**
- * Opens once the DMS reports its schemas registered, which it does from its
- * own `start()`. Modules construct and start in parallel, so a project
- * declaring its content early waits here instead of failing.
- */
-const databaseGate = createReadyGate();
-
-/**
- * The DMS fires the hook on every start and runs a handler registered after
- * that at once: whatever the load order, the first firing opens the gate.
- * Its handlers run in series, so this one is registered first thing in
- * `construct()`, ahead of handlers that may wait on the gate.
- */
-export function registerDatabaseReady(): void {
-  RegisterHook(Hook.DATABASE_INITIALIZED, () => databaseGate.open());
-}
-
-/** `task`, run once the database is ready. */
-export const afterDatabaseReady: ReadyGate["after"] = (task) =>
-  databaseGate.after(task);

package/src/services/fingerprint.ts

@@ -1,22 +0,0 @@
-import { createHash } from "node:crypto";
-
-/** JSON with object keys sorted, so equal values always serialize alike. */
-function stableJson(value: unknown): string {
-  if (Array.isArray(value)) return `[${value.map(stableJson).join(",")}]`;
-  if (value && typeof value === "object") {
-    const entries = Object.entries(value as Record<string, unknown>)
-      .filter(([, entry]) => entry !== undefined)
-      .sort(([left], [right]) => Number(left > right) - Number(left < right))
-      .map(([key, entry]) => `${JSON.stringify(key)}:${stableJson(entry)}`);
-    return `{${entries.join(",")}}`;
-  }
-  return JSON.stringify(value);
-}
-
-/**
- * A short digest of `value` that ignores key order: what a declaration
- * remembers of what it wrote, to tell later whether a user changed it.
- */
-export function fingerprintOf(value: unknown): string {
-  return createHash("sha256").update(stableJson(value)).digest("hex");
-}