@tolinax/ayoune-interfaces 2026.22.0 → 2026.23.0

package/data/modelNames.d.ts

@@ -20,7 +20,9 @@ export declare enum aMN {
     AdvertiserWeeklyDomainKPIsByIndustries = "AdvertiserWeeklyDomainKPIsByIndustries",
     AdwordsLogs = "AdwordsLogs",
     AffClicks = "AffClicks",
+    AffiliateAttributions = "AffiliateAttributions",
     AffiliateCampaigns = "AffiliateCampaigns",
+    AffiliatePayouts = "AffiliatePayouts",
     Affiliates = "Affiliates",
     AffViews = "AffViews",
     Agencies = "Agencies",
@@ -299,6 +301,7 @@ export declare enum aMN {
     FormSubmissions = "FormSubmissions",
     FormViews = "FormViews",
     FractureMessages = "FractureMessages",
+    FXRates = "FXRates",
     Generations = "Generations",
     GlobalChecks = "GlobalChecks",
     GlobalKPIs = "GlobalKPIs",
@@ -630,6 +633,7 @@ export declare enum aMN {
     Websites = "Websites",
     WebsiteTemplates = "WebsiteTemplates",
     WhatsappLogs = "WhatsappLogs",
+    WidgetEmbedSites = "WidgetEmbedSites",
     Widgets = "Widgets",
     WikiPages = "WikiPages",
     Wizards = "Wizards",

package/data/modelNames.js

@@ -24,7 +24,9 @@ var aMN;
     aMN["AdvertiserWeeklyDomainKPIsByIndustries"] = "AdvertiserWeeklyDomainKPIsByIndustries";
     aMN["AdwordsLogs"] = "AdwordsLogs";
     aMN["AffClicks"] = "AffClicks";
+    aMN["AffiliateAttributions"] = "AffiliateAttributions";
     aMN["AffiliateCampaigns"] = "AffiliateCampaigns";
+    aMN["AffiliatePayouts"] = "AffiliatePayouts";
     aMN["Affiliates"] = "Affiliates";
     aMN["AffViews"] = "AffViews";
     aMN["Agencies"] = "Agencies";
@@ -303,6 +305,7 @@ var aMN;
     aMN["FormSubmissions"] = "FormSubmissions";
     aMN["FormViews"] = "FormViews";
     aMN["FractureMessages"] = "FractureMessages";
+    aMN["FXRates"] = "FXRates";
     aMN["Generations"] = "Generations";
     aMN["GlobalChecks"] = "GlobalChecks";
     aMN["GlobalKPIs"] = "GlobalKPIs";
@@ -634,6 +637,7 @@ var aMN;
     aMN["Websites"] = "Websites";
     aMN["WebsiteTemplates"] = "WebsiteTemplates";
     aMN["WhatsappLogs"] = "WhatsappLogs";
+    aMN["WidgetEmbedSites"] = "WidgetEmbedSites";
     aMN["Widgets"] = "Widgets";
     aMN["WikiPages"] = "WikiPages";
     aMN["Wizards"] = "Wizards";

package/data/modelsAndRights.js

@@ -762,6 +762,16 @@ const modelsAndRights = [
         allowDuplicate: false,
         updateBy: "_id",
     },
+    {
+        plural: "AffiliateAttributions",
+        singular: "AffiliateAttribution",
+        module: "affiliate",
+        right: "affiliate.attributions",
+        readOnly: true,
+        importable: false,
+        allowDuplicate: false,
+        updateBy: "_id",
+    },
     {
         plural: "AffiliateCampaigns",
         singular: "AffiliateCampaign",
@@ -772,6 +782,16 @@ const modelsAndRights = [
         allowDuplicate: true,
         updateBy: "_id",
     },
+    {
+        plural: "AffiliatePayouts",
+        singular: "AffiliatePayout",
+        module: "affiliate",
+        right: "affiliate.payouts",
+        readOnly: false,
+        importable: false,
+        allowDuplicate: false,
+        updateBy: "_id",
+    },
     {
         plural: "Affiliates",
         singular: "Affiliate",
@@ -3269,6 +3289,16 @@ const modelsAndRights = [
         allowDuplicate: false,
         updateBy: "_id",
     },
+    {
+        plural: "FXRates",
+        singular: "FXRate",
+        module: "accounting",
+        right: "accounting.fxrates",
+        readOnly: true,
+        importable: false,
+        allowDuplicate: false,
+        updateBy: "_id",
+    },
     {
         plural: "Generations",
         singular: "Generation",
@@ -6383,6 +6413,16 @@ const modelsAndRights = [
         allowDuplicate: false,
         updateBy: "_id",
     },
+    {
+        plural: "WidgetEmbedSites",
+        singular: "WidgetEmbedSite",
+        module: "marketing",
+        right: "marketing.widgetembedsites",
+        readOnly: true,
+        importable: false,
+        allowDuplicate: false,
+        updateBy: "_id",
+    },
     {
         plural: "Widgets",
         singular: "Widget",

package/interfaces/IAffClick.d.ts

@@ -13,4 +13,14 @@ export interface IAffClick extends IaYOUneTrackingParams, IGeoIPLocationTracking
     cust_id?: string;
     cust_id2?: string;
     datetime?: Date;
+    /**
+     * Settlement that consumed this click. Set by `worker-payouts` to make
+     * settlement runs idempotent — a click already stamped is skipped on re-runs.
+     */
+    _settlementID?: ObjectId;
+    /**
+     * ISO 4217 currency snapshot at click time. Locked even if the customer
+     * changes their default currency later.
+     */
+    currency?: string;
 }

package/interfaces/IAffiliate.d.ts

@@ -1,11 +1,139 @@
 import { IDefaultFields } from "./IDefaultFields";
+/**
+ * Payout configuration on the affiliate. The affiliate picks one method on signup;
+ * admins may override during approval. The payments domain `worker-payouts` reads
+ * this subdoc to decide whether to enqueue a SEPA CSV row or a Stripe Connect transfer.
+ */
+export interface IAffiliatePayoutConfig {
+    /** Picked execution path */
+    method?: "sepa-csv" | "stripe-connect";
+    iban?: string;
+    bic?: string;
+    accountholder?: string;
+    stripeConnectAccountId?: string;
+    paypalEmail?: string;
+    /** Minimum amount before a payout is generated (in `currency`) */
+    threshold?: number;
+    /** Payout currency (ISO 4217) — may differ from the click/conversion currency */
+    currency?: string;
+    /** When automatic settlements are generated for this affiliate */
+    schedule?: "weekly" | "monthly" | "quarterly" | "manual";
+    taxid?: string;
+    ustid?: string;
+    ustidValid?: boolean;
+}
+/**
+ * KYC subdoc on the affiliate. Documents themselves live in the platform's existing
+ * `Documents` collection (`IDocument`) and are uploaded via `platform/uploads/` with
+ * state `affiliate.kyc.upload`. The IDs are stored here for fast access; the reviewer
+ * UI in the SDUI admin loads the actual files via the existing media pipeline.
+ */
+export interface IAffiliateKYCConfig {
+    status?: "not-started" | "submitted" | "in-review" | "approved" | "rejected";
+    /** References into the `Documents` collection (IDocument._id) */
+    documents?: ObjectId[];
+    submittedAt?: Date;
+    reviewedAt?: Date;
+    /** Reviewer (User who approved/rejected) */
+    reviewedBy?: ObjectId;
+    /** Free-form reason captured when status === "rejected" */
+    rejectionReason?: string;
+}
+/**
+ * Affiliate / Partner profile.
+ *
+ * Polymorphic identity: an affiliate row references one of three subject types via
+ * `subjectType` + `_subjectID`. The default is `consumer` — affiliate login is the
+ * existing consumer login flow (`Consumers.getAuthenticated`). The other two values
+ * exist to mirror the `IaYOUneTrackingParams.ayoune_aff_type` enum the tracking
+ * system already emits, so staff-affiliate and B2B-tenant-affiliate scenarios are
+ * supported without schema duplication.
+ *
+ * MLM hierarchy: up to 7 levels deep. `parent_affiliate` points at the recruiter,
+ * `tier_level` is the depth from the root (1..7), `ancestors[]` is a materialized
+ * path for fast tree queries (no recursive lookups at commission-cascade time).
+ *
+ * All legacy fields (`name`, `type`, `key`, `token`, `created`) remain optional so
+ * pre-existing rows continue to read without migration. New rows should populate
+ * the structured fields instead.
+ */
 export interface IAffiliate extends IDefaultFields {
     _customerID: ObjectId;
     _clientID?: ObjectId[];
     _subID?: ObjectId[];
+    /** Which collection `_subjectID` points at. Defaults to "consumer" for new rows. */
+    subjectType?: "consumer" | "user" | "customer";
+    /** Reference into Consumers | Users | aYOUneCustomers depending on subjectType */
+    _subjectID?: ObjectId;
+    /** Auto-generated slug; affiliate may customize once. Unique per `_customerID`. */
+    code?: string;
+    /** Set to true after the affiliate's first manual customization of `code`. */
+    codeLocked?: boolean;
+    /** Lifecycle. Two-step approval: pending-email → pending-approval → active */
+    status?: "pending-email" | "pending-approval" | "active" | "suspended" | "terminated";
+    /** Free-form tier label for display. Real commission tiers live on `_commissionGroupID`. */
+    tier?: string;
+    /** The affiliate that recruited this one. Null for root affiliates. */
+    parent_affiliate?: ObjectId;
+    /** Depth from the root (1..7). Computed at create/move time. */
+    tier_level?: number;
+    /**
+     * Materialized ancestor path for O(1) MLM cascade lookups. Order: closest
+     * ancestor first. Length matches `tier_level - 1`. Capped at 7.
+     */
+    ancestors?: ObjectId[];
+    email?: string;
+    phone?: string;
+    company?: string;
+    website?: string;
+    /** Affiliate's preferred display + payout currency (ISO 4217) */
+    preferredCurrency?: string;
+    /**
+     * "consumer" = portal login via consumer-app session cookie (default).
+     * "apiKey" = server-to-server access via `key`+`token` (the legacy fields below).
+     * "both" = either is accepted.
+     */
+    authMethod?: "consumer" | "apiKey" | "both";
+    /** Reference into CommissionGroups (kept in `config` module per CLAUDE.md). */
+    _commissionGroupID?: ObjectId;
+    /** Default sub_id stamped onto the affiliate's tracking links if not overridden */
+    defaultSubId?: string;
+    /** Default ad placement label */
+    defaultAdplace?: string;
+    /** Where the affiliate's tracking links land if no campaign override is present */
+    landingUrl?: string;
+    /** Extra query params to append to landing URLs */
+    landingParams?: any;
+    /** Domains the affiliate is allowed to embed widgets on */
+    allowedEmbedDomains?: string[];
+    payout?: IAffiliatePayoutConfig;
+    kyc?: IAffiliateKYCConfig;
+    approvedAt?: Date;
+    /** User._id of the admin who approved the application */
+    approvedBy?: ObjectId;
+    lastActiveAt?: Date;
+    emailVerifiedAt?: Date;
+    /** Hashed verification token (never store the raw token) */
+    emailVerificationToken?: string;
+    /** When the current verification token expires */
+    emailVerificationExpiresAt?: Date;
+    /**
+     * Free-form name for legacy rows. New rows should use the affiliate's email/code/profile
+     * fields instead. Kept optional for back-compat with pre-2026 documents.
+     */
     name?: string;
+    /**
+     * Legacy type field. Original STOREFire installs default this to the literal
+     * string "STOREFire"; new rows leave it blank. Retained for back-compat with
+     * existing reads.
+     *
+     * @deprecated Use `subjectType` instead — `type` carries no behaviour in the new system.
+     */
     type?: string;
+    /** Legacy API key for server-to-server access (paired with `token`) */
     key?: string;
+    /** Legacy API secret for server-to-server access (paired with `key`) */
     token?: string;
+    /** Legacy creation timestamp; new rows use IDefaultFields.createdAt */
     created?: Date;
 }

package/interfaces/IAffiliateAttribution.d.ts

@@ -0,0 +1,48 @@
+import { IDefaultFields } from "./IDefaultFields";
+/**
+ * Per-visitor affiliate attribution record. Created when a visitor lands on a
+ * customer's site via an affiliate tracking link (`?ayoune_aff=XYZ`) and an
+ * `ayoune_aff_attribution` cookie is dropped.
+ *
+ * The cookie carries the random `cookieToken`; the server resolves it back to
+ * this row when a conversion fires. Idempotency-friendly: TTL-indexed on
+ * `expiresAt` so MongoDB cleans up stale rows automatically.
+ *
+ * Behaviour by `attributionMode`:
+ * - `last-click`: a new affiliate click overwrites the existing attribution (latest wins).
+ * - `first-click`: an existing non-expired attribution is preserved (first wins).
+ * - `session`: typically not persisted (session-only cookie), but may be stored
+ *    for analytics with a very short `expiresAt`.
+ *
+ * Resolution priority comes from `IWebsite.partnerProgram.attribution*` plus
+ * any per-campaign override on `IAffiliateCampaign.attribution*`.
+ */
+export interface IAffiliateAttribution extends IDefaultFields {
+    _customerID: ObjectId;
+    _clientID?: ObjectId[];
+    _subID?: ObjectId[];
+    /** Affiliate that gets credited for the eventual conversion */
+    _affiliateID: ObjectId;
+    /** Optional campaign context if the click carried `ayoune_campaign` */
+    _campaignID?: ObjectId;
+    /**
+     * Visitor identifier. Typically the value of `ayoune_fp` (FingerprintJS visitor ID)
+     * or another stable per-browser fingerprint.
+     */
+    visitorId: string;
+    /**
+     * Random server-issued token also stored in the `ayoune_aff_attribution`
+     * cookie. Used as the lookup key at conversion time.
+     */
+    cookieToken: string;
+    /** Attribution behaviour at the time the row was created */
+    attributionMode: "last-click" | "first-click" | "session";
+    /** TTL field — MongoDB drops the row after this date */
+    expiresAt: Date;
+    /** When the attribution was first established for this visitor */
+    firstSeenAt?: Date;
+    /** Most recent click that touched this attribution (last-click mode bumps this) */
+    lastTouchAt?: Date;
+    /** When a conversion claimed this attribution (null until consumed) */
+    consumedAt?: Date;
+}

package/interfaces/IAffiliateAttribution.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IAffiliateCampaign.d.ts

@@ -31,4 +31,8 @@ export interface IAffiliateCampaign extends IDefaultFields {
     banner_15?: string;
     banner_16?: string;
     banner_17?: string;
+    /** Override the attribution window (days) for this specific campaign */
+    attributionWindow?: number;
+    /** Override the attribution mode for this specific campaign */
+    attributionMode?: "last-click" | "first-click" | "session";
 }

package/interfaces/IAffiliatePayout.d.ts

@@ -0,0 +1,51 @@
+import { IDefaultFields } from "./IDefaultFields";
+/**
+ * An outgoing payment attempt for a single approved CommissionSettlement.
+ *
+ * Created by the payments domain `worker-payouts` when a settlement is approved.
+ * Carries multi-currency state captured at payout time so the payment is reproducible
+ * even if FX rates change later.
+ *
+ * Method-specific fields:
+ * - `sepa-csv`: payouts are batched into a daily CSV; `exportBatchId` links them.
+ * - `stripe-connect`: `transactionRef` holds the Stripe Transfer ID; webhook updates status.
+ */
+export interface IAffiliatePayout extends IDefaultFields {
+    _customerID: ObjectId;
+    _clientID?: ObjectId[];
+    _subID?: ObjectId[];
+    _affiliateID: ObjectId;
+    /** Settlement this payout is paying out (1:1) */
+    _settlementID: ObjectId;
+    /** Amount paid in the payout currency */
+    amount: number;
+    /** Payout currency (ISO 4217) — affiliate's preferred currency */
+    currency: string;
+    /** Original commission amount before FX conversion */
+    sourceAmount?: number;
+    /** Original currency (the click/conversion currency) */
+    sourceCurrency?: string;
+    /** Applied FX conversion rate (1 sourceCurrency = fxRate × currency) */
+    fxRate?: number;
+    /** Date of the FX rate snapshot used for conversion */
+    fxRateDate?: Date;
+    /** Payment method picked from the affiliate's payout config */
+    method: "sepa-csv" | "stripe-connect";
+    /** Lifecycle status */
+    status: "queued" | "sent" | "failed" | "completed";
+    /** Provider-specific reference: Stripe Transfer ID, SEPA end-to-end ID, etc. */
+    transactionRef?: string;
+    /** When the worker first attempted the payout */
+    attemptedAt?: Date;
+    /** When the payout reached terminal completion (or failure) */
+    completedAt?: Date;
+    /** Raw provider response captured for debugging */
+    providerResponse?: any;
+    /** Error message when status === "failed" */
+    error?: string;
+    /**
+     * For sepa-csv method: identifier of the daily export batch this payout belongs to.
+     * The actual CSV is stored as an IDocument with category "affiliate-payout-batch".
+     */
+    exportBatchId?: string;
+}

package/interfaces/IAffiliatePayout.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/ICommissionGroup.d.ts

@@ -3,12 +3,30 @@ export interface ICommissionGroupGroup {
     group: ObjectId;
     commission: number;
 }
+/**
+ * Commission rules. Lives in the `config` module per CLAUDE.md (verified
+ * 2026-04-08); the affiliate revival reads this entity via direct DB access
+ * rather than moving it.
+ *
+ * MLM cascade: `commissionByLevel[i]` is the percentage paid to the affiliate
+ * at level `i+1` of the upline chain (index 0 = direct affiliate, index 6 = 7th
+ * level upline). The cascade walker in core's `walkAncestorChain.ts` is capped
+ * at `maxTierDepth || 7`.
+ *
+ * Legacy `commission_continuance` is retained as deprecated for back-compat
+ * with pre-2026 documents that used a single-percentage cascade model.
+ */
 export interface ICommissionGroup extends IDefaultFields {
     _customerID: ObjectId;
     _clientID?: ObjectId[];
     _subID?: ObjectId[];
     name?: string;
     commission?: number;
+    /**
+     * @deprecated Replaced by `commissionByLevel[]`. Pre-2026 rows used this single
+     * percentage as the cascade rate for every upline level. New code should read
+     * `commissionByLevel`; only fall back to this when `commissionByLevel` is empty.
+     */
     commission_continuance?: number;
     base?: string;
     active?: boolean;
@@ -16,4 +34,30 @@ export interface ICommissionGroup extends IDefaultFields {
     include_exclude?: string;
     groups?: ICommissionGroupGroup[];
     created?: Date;
+    /**
+     * Per-tier cascade percentages. Index 0 = the affiliate that owns the click
+     * (level 1 / direct), index 1..6 = levels 2..7 of the upline chain.
+     *
+     * Example: `[10, 5, 3, 2, 1, 0.5, 0.25]` pays 10% to the direct affiliate,
+     * 5% to their parent, 3% to grandparent, etc.
+     *
+     * If `commissionByLevel` is empty/undefined, `calculateCommission()` falls
+     * back to the legacy single-percentage `commission_continuance` model.
+     */
+    commissionByLevel?: number[];
+    /** Cap on cascade depth (default 7, hard cap 7). */
+    maxTierDepth?: number;
+    /** Human-readable label shown alongside the rate */
+    tierLabel?: string;
+    /** Hex color used in admin/portal badges */
+    color?: string;
+    /** Free-form description shown to affiliates choosing a tier */
+    description?: string;
+    /** Per-group payout thresholds and hold periods */
+    thresholds?: {
+        /** Minimum amount before a settlement is generated for an affiliate in this group */
+        minPayout?: number;
+        /** Days to hold a settlement before it can be marked approved */
+        holdDays?: number;
+    };
 }

package/interfaces/ICommissionSettlement.d.ts

@@ -6,12 +6,29 @@ export interface ICommissionSettlementPosition {
     commission?: number;
     payout?: number;
 }
+/**
+ * Commission settlement (Provisionsabrechnung). Lives in the `sale` module per
+ * CLAUDE.md (verified 2026-04-08); the affiliate revival reads + writes this
+ * entity via direct DB access without moving it.
+ *
+ * The affiliate `worker-payouts` job creates one settlement per
+ * `(affiliate, period, currency, tierLevel)` group. Idempotency is provided by
+ * stamping `_settlementID` onto every consumed `IAffClick` / `IShopClick` —
+ * re-running for the same period skips already-stamped clicks.
+ *
+ * Status enum (extended for the affiliate revival):
+ * `"draft" | "pending" | "approved" | "paid" | "rejected" | "hold"`.
+ */
 export interface ICommissionSettlement extends IDefaultFields {
     _customerID: ObjectId;
     _clientID?: ObjectId[];
     _subID?: ObjectId[];
     shortID: any;
     agent?: ObjectId;
+    /**
+     * Lifecycle: "draft" | "pending" | "approved" | "paid" | "rejected" | "hold"
+     * (typed as string for back-compat with existing documents).
+     */
     status?: string;
     sent?: boolean;
     from?: Date;
@@ -23,4 +40,17 @@ export interface ICommissionSettlement extends IDefaultFields {
     net_total?: number;
     tax?: number;
     total?: number;
+    /** Affiliate this settlement belongs to (null for non-affiliate settlements) */
+    _affiliateID?: ObjectId;
+    /** MLM tier this settlement represents — 1 = direct, 2..7 = upline cascade levels */
+    tierLevel?: number;
+    /** Reporting period this settlement covers */
+    period?: {
+        year: number;
+        month: number;
+    };
+    /** ISO 4217 currency of all `amount`/`commission`/`payout`/`total` fields */
+    currency?: string;
+    /** How this settlement was created (worker run vs admin manual creation) */
+    generatedBy?: "worker" | "manual";
 }

package/interfaces/IFXRate.d.ts

@@ -0,0 +1,27 @@
+import { IDefaultFields } from "./IDefaultFields";
+/**
+ * Daily FX reference rate, primarily fetched from the European Central Bank
+ * (`https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml`) by the
+ * `worker-fxrates` worker in `domains/accounting/`.
+ *
+ * ECB publishes rates against EUR (`base: "EUR"`). Triangulation via EUR is used
+ * for non-EUR-to-non-EUR conversions in `getFXRate()`.
+ *
+ * NOT multi-tenant in the usual sense — FX rates are global. The `_customerID`
+ * field on IDefaultFields is unused (typically null/undefined). A rate row is
+ * uniquely identified by `(base, currency, date)`.
+ */
+export interface IFXRate extends IDefaultFields {
+    /** Base currency the rate is published against (ECB uses "EUR") */
+    base: string;
+    /** Target currency (ISO 4217) */
+    currency: string;
+    /** 1 base = rate target */
+    rate: number;
+    /** Rate date (UTC midnight of the day the rate applies to) */
+    date: Date;
+    /** Where this rate came from */
+    source: "ecb" | "manual";
+    /** When this row was inserted */
+    fetchedAt?: Date;
+}

package/interfaces/IFXRate.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IShopClick.d.ts

@@ -13,4 +13,13 @@ export interface IShopClick extends IaYOUneTrackingParams, IGeoIPLocationTrackin
     revenueDefault?: number;
     revenueEstimated?: number;
     revenueApproved?: number;
+    /** Affiliate credited for this conversion (resolved via attribution cookie at write time) */
+    _affiliateID?: ObjectId;
+    /**
+     * Settlement that consumed this conversion. Set by `worker-payouts` to make
+     * settlement runs idempotent.
+     */
+    _settlementID?: ObjectId;
+    /** ISO 4217 currency snapshot at conversion time */
+    currency?: string;
 }

package/interfaces/ITrigger.d.ts

@@ -1,3 +1,10 @@
+/**
+ * @deprecated Replaced by IAutomationWorkflow + workflow-engine. Do NOT create new
+ * ITrigger documents — use IAutomationWorkflow with triggers[type:'event'] instead.
+ * Existing ITrigger documents continue to fire via the parallel legacy pipeline in
+ * `domains/automation/worker-automation/src/triggers/`. Scheduled removal: Q4 2026
+ * after the workflow-engine migration completes.
+ */
 import { IDefaultFields } from "./IDefaultFields";
 import { ITriggerAction } from "./ITriggerAction";
 export interface ITriggerDataFilter {

package/interfaces/ITriggerAction.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @deprecated Replaced by IAutomationWorkflow + workflow-engine. Do NOT create new
+ * ITriggerAction documents — use IAutomationWorkflow nodes/linearConfig instead.
+ * Scheduled removal: Q4 2026.
+ */
 import { IDefaultFields } from "./IDefaultFields";
 export interface ITriggerAction extends IDefaultFields {
     check_category?: string;

package/interfaces/ITriggerActions.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @deprecated Replaced by IAutomationWorkflow + workflow-engine. Do NOT create new
+ * ITriggerActions documents — use IAutomationWorkflow nodes/linearConfig instead.
+ * Scheduled removal: Q4 2026.
+ */
 import { IDefaultFields } from "./IDefaultFields";
 export interface ITriggerActions extends IDefaultFields {
     name?: string;

package/interfaces/ITriggerActionsLog.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @deprecated Log of legacy ITrigger executions. Replaced by IAutomationExecution
+ * for the new IAutomationWorkflow pipeline. Scheduled removal: Q4 2026.
+ */
 import { IDefaultFields } from "./IDefaultFields";
 export interface ITriggerActionsLog extends IDefaultFields {
     _customerID: ObjectId;

package/interfaces/ITriggerChain.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @deprecated Replaced by IAutomationWorkflow + workflow-engine. Trigger chains are
+ * expressed as edges between nodes in IAutomationWorkflow. Do NOT create new
+ * ITriggerChain documents. Scheduled removal: Q4 2026.
+ */
 import { IDefaultFields } from "./IDefaultFields";
 export interface ITriggerChainAction {
     type?: string;

package/interfaces/ITriggerGroup.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @deprecated Grouping for legacy ITrigger documents. Replaced by IAutomationWorkflow's
+ * `tags` and `folder` fields. Do NOT create new ITriggerGroup documents.
+ * Scheduled removal: Q4 2026.
+ */
 import { IDefaultFields } from "./IDefaultFields";
 export interface ITriggerGroup extends IDefaultFields {
     _customerID: ObjectId;

package/interfaces/ITriggerLog.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @deprecated Log of legacy ITrigger executions. Replaced by IAutomationExecution
+ * for the new IAutomationWorkflow pipeline. Scheduled removal: Q4 2026.
+ */
 import { IDefaultFields } from "./IDefaultFields";
 export interface ITriggerLog extends IDefaultFields {
     _customerID: ObjectId;

package/interfaces/IWebsite.d.ts

@@ -136,4 +136,49 @@ export interface IWebsite extends IDefaultFields {
             title?: string;
         };
     };
+    /**
+     * Optional embedding allowlist/blocklist enforcement for widgets shipped by
+     * `platform/widget-server`. When unset, embedding is open (matches the existing
+     * `cors: "*"` posture). Affiliates rely on open-by-default to embed on partner sites.
+     */
+    embedding?: {
+        /** If set, only these hostnames may embed widgets for this customer */
+        allowedDomains?: string[];
+        /** Hostnames that are always rejected (takes priority over allowedDomains) */
+        blockedDomains?: string[];
+        /** When true, requests without a Referer header are rejected */
+        requireReferer?: boolean;
+        /**
+         * When true, every embed observation is logged to `WidgetEmbedSites`
+         * even if it doesn't match any explicit rule (default: true).
+         */
+        logAllEmbeds?: boolean;
+    };
+    /**
+     * Per-website partner program / affiliate portal configuration.
+     * The partner portal in consumer-app reads this subdoc to gate signup,
+     * resolve the URL slug, and apply attribution defaults.
+     */
+    partnerProgram?: {
+        /** Master toggle — when false the /partnerprogram routes return 404 */
+        enabled?: boolean;
+        /**
+         * URL slug for the portal under this website. Default "partnerprogram"
+         * (consumer-app also mounts an "affiliates" alias). Override to e.g.
+         * "partner" or "werden-sie-partner".
+         */
+        slug?: string;
+        /** When true, /partnerprogram/register is mounted */
+        allowSignup?: boolean;
+        /** When true, signups skip manual admin approval (default: false) */
+        autoApprove?: boolean;
+        /** When true, affiliates must complete KYC before payouts are released */
+        requireKyc?: boolean;
+        /** Default attribution window in days. Per-campaign overrides on IAffiliateCampaign. */
+        attributionWindow?: number;
+        /** Default attribution mode applied to new attributions */
+        attributionMode?: "last-click" | "first-click" | "session";
+        /** Whether attribution is scoped per-website or shared across the whole customer */
+        attributionScope?: "per-website" | "per-customer";
+    };
 }

package/interfaces/IWidgetEmbedSite.d.ts

@@ -0,0 +1,30 @@
+import { IDefaultFields } from "./IDefaultFields";
+/**
+ * Rollup of where a customer's widgets are being embedded across third-party sites.
+ *
+ * Populated by the `worker-embed-sites` rollup job (every 15 min) from `Views` documents
+ * that carry `ayoune_embed_domain`. One row per `(_customerID, domain)`.
+ *
+ * Powers the partner portal "sites where your widgets appear" view and the admin
+ * SDUI screen that lets staff tag domains as allowed/blocked or link them to a
+ * specific affiliate.
+ */
+export interface IWidgetEmbedSite extends IDefaultFields {
+    _customerID: ObjectId;
+    _clientID?: ObjectId[];
+    _subID?: ObjectId[];
+    /** Hostname of the embedding page (e.g. "partner.example.com") */
+    domain: string;
+    /** When this domain was first observed embedding any widget */
+    firstSeenAt?: Date;
+    /** Most recent observation */
+    lastSeenAt?: Date;
+    /** Total view count across all widgets on this domain */
+    viewCount?: number;
+    /** Distinct widget types observed on this domain (e.g. ["cta", "form", "ratings"]) */
+    widgetTypes?: string[];
+    /** Optional link to the affiliate that owns the embedding relationship */
+    _affiliateID?: ObjectId;
+    /** Admin classification: observed (default), allowed (allowlisted), blocked (blocklisted) */
+    status?: "observed" | "allowed" | "blocked";
+}

package/interfaces/IWidgetEmbedSite.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IaYOUneTrackingParams.d.ts

@@ -213,6 +213,14 @@ export interface IaYOUneTrackingParams extends IFingerprintData {
     ayoune_partner?: string;
     ayoune_aff?: string;
     ayoune_aff_type?: "user" | "customer" | "consumer";
+    /** Hostname of the third-party page that embedded the widget firing this hit */
+    ayoune_embed_domain?: string;
+    /** Full URL of the embedding page (when accessible) */
+    ayoune_embed_url?: string;
+    /** document.title of the embedding page (when accessible) */
+    ayoune_embed_title?: string;
+    /** Referrer at the embedding page level (separate from the in-iframe referrer) */
+    ayoune_embed_referrer?: string;
     ayoune_actions?: any[];
     ayoune_params?: any[];
     ayoune_ref?: string;

package/interfaces/index.d.ts

@@ -18,7 +18,9 @@ export * from "./IAdvertiserAPI";
 export * from "./IAdwordsLog";
 export * from "./IAffClick";
 export * from "./IAffiliate";
+export * from "./IAffiliateAttribution";
 export * from "./IAffiliateCampaign";
+export * from "./IAffiliatePayout";
 export * from "./IAffView";
 export * from "./IAgency";
 export * from "./IAgendaJob";
@@ -318,6 +320,7 @@ export * from "./IFormSubmission";
 export * from "./IFormView";
 export * from "./IFractureMessage";
 export * from "./IFreeFields";
+export * from "./IFXRate";
 export * from "./IGeneration";
 export * from "./IGeoIPLocationTracking";
 export * from "./IGlobalCheck";
@@ -679,6 +682,7 @@ export * from "./IWebsiteTemplate";
 export * from "./IPageBlock";
 export * from "./IWhatsappLog";
 export * from "./IWidget";
+export * from "./IWidgetEmbedSite";
 export * from "./IWikiPage";
 export * from "./IWizard";
 export * from "./IWorkCenter";

package/interfaces/index.js

@@ -34,7 +34,9 @@ __exportStar(require("./IAdvertiserAPI"), exports);
 __exportStar(require("./IAdwordsLog"), exports);
 __exportStar(require("./IAffClick"), exports);
 __exportStar(require("./IAffiliate"), exports);
+__exportStar(require("./IAffiliateAttribution"), exports);
 __exportStar(require("./IAffiliateCampaign"), exports);
+__exportStar(require("./IAffiliatePayout"), exports);
 __exportStar(require("./IAffView"), exports);
 __exportStar(require("./IAgency"), exports);
 __exportStar(require("./IAgendaJob"), exports);
@@ -334,6 +336,7 @@ __exportStar(require("./IFormSubmission"), exports);
 __exportStar(require("./IFormView"), exports);
 __exportStar(require("./IFractureMessage"), exports);
 __exportStar(require("./IFreeFields"), exports);
+__exportStar(require("./IFXRate"), exports);
 __exportStar(require("./IGeneration"), exports);
 __exportStar(require("./IGeoIPLocationTracking"), exports);
 __exportStar(require("./IGlobalCheck"), exports);
@@ -695,6 +698,7 @@ __exportStar(require("./IWebsiteTemplate"), exports);
 __exportStar(require("./IPageBlock"), exports);
 __exportStar(require("./IWhatsappLog"), exports);
 __exportStar(require("./IWidget"), exports);
+__exportStar(require("./IWidgetEmbedSite"), exports);
 __exportStar(require("./IWikiPage"), exports);
 __exportStar(require("./IWizard"), exports);
 __exportStar(require("./IWorkCenter"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-interfaces",
-  "version": "2026.22.0",
+  "version": "2026.23.0",
   "description": "Houses TypeScript interfaces for aYOUne",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",