@reachy/audience-module 1.0.16 → 1.0.18

package/CODEOWNERS

@@ -0,0 +1 @@
+* @kenisson_melo @vitor @arthur

package/dist/builders/RfmSegmentBuilder.d.ts

@@ -0,0 +1,44 @@
+export type RfmThresholdRowLike = {
+    kind: 'r' | 'f' | string;
+    score: number;
+    min_value: number;
+    max_value: number;
+};
+export type RfmRecencyDefinition = {
+    within_days: number;
+    exclude_within_days?: number | null;
+};
+export type RfmFrequencyDefinition = {
+    op: string;
+    value: number;
+    value2?: number | null;
+};
+export type RfmSegmentDefinition = {
+    segment_key: string;
+    segment_name: string;
+    window_days: number;
+    recency: RfmRecencyDefinition;
+    frequency: RfmFrequencyDefinition;
+    criteria: any;
+};
+type ScoreRange = {
+    minScore: number;
+    maxScore: number;
+};
+export declare class RfmSegmentBuilder {
+    static getSegmentScoreRanges(segmentKey: string): {
+        r: ScoreRange;
+        f: ScoreRange;
+    } | null;
+    static getSegmentName(segmentKey: string): string;
+    static clampInt(n: number, min: number, max: number): number;
+    static buildDefinition(params: {
+        rfEventName: string;
+        windowDays: number;
+        segmentKey: string;
+        thresholds: RfmThresholdRowLike[];
+        filterCriteria?: any | null;
+    }): RfmSegmentDefinition;
+}
+export {};
+//# sourceMappingURL=RfmSegmentBuilder.d.ts.map

package/dist/builders/RfmSegmentBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RfmSegmentBuilder.d.ts","sourceRoot":"","sources":["../../src/builders/RfmSegmentBuilder.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,MAAM,CAAA;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,oBAAoB,CAAA;IAC7B,SAAS,EAAE,sBAAsB,CAAA;IACjC,QAAQ,EAAE,GAAG,CAAA;CACd,CAAA;AAED,KAAK,UAAU,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAExD,qBAAa,iBAAiB;IAC5B,MAAM,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG;QAAE,CAAC,EAAE,UAAU,CAAC;QAAC,CAAC,EAAE,UAAU,CAAA;KAAE,GAAG,IAAI;IA4BzF,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAgBjD,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAK5D,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE;QAC7B,WAAW,EAAE,MAAM,CAAA;QACnB,UAAU,EAAE,MAAM,CAAA;QAClB,UAAU,EAAE,MAAM,CAAA;QAClB,UAAU,EAAE,mBAAmB,EAAE,CAAA;QACjC,cAAc,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;KAC5B,GAAG,oBAAoB;CAgMzB"}

package/dist/builders/RfmSegmentBuilder.js

@@ -0,0 +1,232 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RfmSegmentBuilder = void 0;
+class RfmSegmentBuilder {
+    static getSegmentScoreRanges(segmentKey) {
+        const k = String(segmentKey || '').trim();
+        switch (k) {
+            case 'champions':
+                return { r: { minScore: 4, maxScore: 5 }, f: { minScore: 4, maxScore: 5 } };
+            case 'loyal_users':
+                return { r: { minScore: 3, maxScore: 3 }, f: { minScore: 4, maxScore: 5 } };
+            case 'potential_loyalists':
+                return { r: { minScore: 4, maxScore: 5 }, f: { minScore: 2, maxScore: 3 } };
+            case 'new_users':
+                return { r: { minScore: 5, maxScore: 5 }, f: { minScore: 1, maxScore: 1 } };
+            case 'promising':
+                return { r: { minScore: 4, maxScore: 4 }, f: { minScore: 1, maxScore: 1 } };
+            case 'needing_attention':
+                return { r: { minScore: 3, maxScore: 3 }, f: { minScore: 3, maxScore: 3 } };
+            case 'about_to_sleep':
+                return { r: { minScore: 3, maxScore: 3 }, f: { minScore: 1, maxScore: 2 } };
+            case 'cannot_lose_them':
+                return { r: { minScore: 1, maxScore: 2 }, f: { minScore: 5, maxScore: 5 } };
+            case 'at_risk':
+                return { r: { minScore: 1, maxScore: 2 }, f: { minScore: 3, maxScore: 4 } };
+            case 'hibernating':
+                return { r: { minScore: 1, maxScore: 2 }, f: { minScore: 1, maxScore: 2 } };
+            default:
+                return null;
+        }
+    }
+    static getSegmentName(segmentKey) {
+        const map = {
+            champions: 'Champions',
+            loyal_users: 'Loyal Users',
+            potential_loyalists: 'Potential Loyalists',
+            new_users: 'New Users',
+            promising: 'Promising',
+            needing_attention: 'Needing Attention',
+            about_to_sleep: 'About to Sleep',
+            at_risk: 'At Risk',
+            cannot_lose_them: 'Cannot Lose Them',
+            hibernating: 'Hibernating',
+        };
+        return map[String(segmentKey || '').trim()] || String(segmentKey || '').trim() || 'Segment';
+    }
+    static clampInt(n, min, max) {
+        const x = Number.isFinite(n) ? Math.trunc(n) : min;
+        return Math.max(min, Math.min(max, x));
+    }
+    static buildDefinition(params) {
+        const { rfEventName, windowDays, segmentKey, thresholds, filterCriteria } = params;
+        const ranges = this.getSegmentScoreRanges(segmentKey);
+        if (!ranges)
+            throw new Error('segment_key inválido');
+        const rMaxDays = new Map();
+        const fMinCount = new Map();
+        const fMaxCount = new Map();
+        for (const row of thresholds || []) {
+            const score = Number(row.score);
+            if (!Number.isFinite(score))
+                continue;
+            if (row.kind === 'r') {
+                const maxV = Number(row.max_value);
+                if (Number.isFinite(maxV))
+                    rMaxDays.set(score, Math.max(0, Math.trunc(maxV)));
+            }
+            else if (row.kind === 'f') {
+                const minV = Number(row.min_value);
+                const maxV = Number(row.max_value);
+                if (Number.isFinite(minV))
+                    fMinCount.set(score, Math.max(0, Math.trunc(minV)));
+                if (Number.isFinite(maxV))
+                    fMaxCount.set(score, Math.max(0, Math.trunc(maxV)));
+            }
+        }
+        const rMin = ranges.r.minScore;
+        const rMax = ranges.r.maxScore;
+        const recencyUpperRaw = (() => {
+            if (rMin <= 1)
+                return windowDays;
+            for (let s = rMin; s <= rMax; s++) {
+                const v = rMaxDays.get(s);
+                if (v != null)
+                    return v;
+            }
+            throw new Error(`Sem thresholds para recency score ${rMin}..${rMax}`);
+        })();
+        const recencyUpper = this.clampInt(recencyUpperRaw, 1, Math.max(1, windowDays));
+        const recencyLowerRaw = (() => {
+            if (rMax >= 5)
+                return null;
+            for (let s = rMax + 1; s <= 5; s++) {
+                const v = rMaxDays.get(s);
+                if (v != null)
+                    return v;
+            }
+            return null;
+        })();
+        const recencyLower = recencyLowerRaw == null ? null : this.clampInt(recencyLowerRaw, 1, Math.max(1, windowDays));
+        const fMin = ranges.f.minScore;
+        const fMax = ranges.f.maxScore;
+        let hasAnyFreqThreshold = false;
+        for (let s = fMin; s <= fMax; s++) {
+            if (fMinCount.has(s) || fMaxCount.has(s)) {
+                hasAnyFreqThreshold = true;
+                break;
+            }
+        }
+        if (!hasAnyFreqThreshold) {
+            throw new Error(`Sem thresholds para frequency score ${fMin}..${fMax}`);
+        }
+        const collectMin = () => {
+            let min = Number.POSITIVE_INFINITY;
+            for (let s = fMin; s <= fMax; s++) {
+                const v = fMinCount.get(s) ?? fMaxCount.get(s);
+                if (v == null)
+                    continue;
+                if (v < min)
+                    min = v;
+            }
+            if (!Number.isFinite(min)) {
+                throw new Error(`Sem thresholds mínimos para frequency score ${fMin}..${fMax}`);
+            }
+            return min;
+        };
+        const collectMax = () => {
+            let max = 0;
+            for (let s = fMin; s <= fMax; s++) {
+                const v = fMaxCount.get(s) ?? fMinCount.get(s);
+                if (v == null)
+                    continue;
+                if (v > max)
+                    max = v;
+            }
+            if (!(max > 0)) {
+                throw new Error(`Sem thresholds máximos para frequency score ${fMin}..${fMax}`);
+            }
+            return max;
+        };
+        const minCount = Math.max(1, Math.trunc(collectMin()));
+        const maxCount = Math.max(minCount, Math.trunc(collectMax()));
+        const frequency = (() => {
+            if (fMax === 5 && fMin >= 4)
+                return { op: '>=', value: minCount, value2: null };
+            if (fMin === 5 && fMax === 5)
+                return { op: '>=', value: minCount, value2: null };
+            if (fMin === 1 && fMax <= 2)
+                return { op: '<=', value: maxCount, value2: null };
+            if (fMin === 1 && fMax === 1)
+                return { op: '<=', value: maxCount, value2: null };
+            return { op: 'between', value: minCount, value2: maxCount };
+        })();
+        const rfmGroup = {
+            operator: 'AND',
+            rules: [
+                {
+                    kind: 'event',
+                    eventName: rfEventName,
+                    time: { unit: 'days', value: windowDays },
+                    frequency: {
+                        type: 'count',
+                        op: frequency.op,
+                        value: frequency.value,
+                        ...(frequency.op === 'between' ? { value2: frequency.value2 } : {}),
+                    },
+                },
+                {
+                    kind: 'event',
+                    eventName: rfEventName,
+                    time: { unit: 'days', value: recencyUpper },
+                },
+                ...(recencyLower
+                    ? [
+                        {
+                            kind: 'event',
+                            eventName: rfEventName,
+                            time: { unit: 'days', value: recencyLower },
+                            negate: true,
+                        },
+                    ]
+                    : []),
+            ],
+        };
+        const filterGroupsRaw = filterCriteria &&
+            typeof filterCriteria === 'object' &&
+            Array.isArray(filterCriteria.groups)
+            ? filterCriteria.groups
+            : [];
+        const mergedGroups = (() => {
+            const base = Array.isArray(filterGroupsRaw) ? [...filterGroupsRaw] : [];
+            if (base.length === 0)
+                return [rfmGroup];
+            return [...base, { ...rfmGroup, combineOperator: 'AND' }];
+        })();
+        const baseConfig = filterCriteria &&
+            typeof filterCriteria === 'object' &&
+            filterCriteria.config &&
+            typeof filterCriteria.config === 'object'
+            ? filterCriteria.config
+            : {};
+        const criteria = {
+            type: 'past-behavior',
+            groups: mergedGroups,
+            config: {
+                ...baseConfig,
+                rfm: {
+                    segment_key: segmentKey,
+                    rf_event_name: rfEventName,
+                    window_days: windowDays,
+                    recency: { within_days: recencyUpper, exclude_within_days: recencyLower },
+                    frequency: { ...frequency },
+                },
+            },
+            ...(filterCriteria &&
+                typeof filterCriteria === 'object' &&
+                filterCriteria.live_options
+                ? { live_options: filterCriteria.live_options }
+                : {}),
+        };
+        return {
+            segment_key: segmentKey,
+            segment_name: this.getSegmentName(segmentKey),
+            window_days: windowDays,
+            recency: { within_days: recencyUpper, exclude_within_days: recencyLower },
+            frequency: { op: frequency.op, value: frequency.value, value2: frequency.value2 ?? null },
+            criteria,
+        };
+    }
+}
+exports.RfmSegmentBuilder = RfmSegmentBuilder;
+//# sourceMappingURL=RfmSegmentBuilder.js.map

package/dist/builders/RfmSegmentBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RfmSegmentBuilder.js","sourceRoot":"","sources":["../../src/builders/RfmSegmentBuilder.ts"],"names":[],"mappings":";;;AA6BA,MAAa,iBAAiB;IAC5B,MAAM,CAAC,qBAAqB,CAAC,UAAkB;QAC7C,MAAM,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;QACzC,QAAQ,CAAC,EAAE,CAAC;YACV,KAAK,WAAW;gBACd,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,aAAa;gBAChB,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,qBAAqB;gBACxB,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,WAAW;gBACd,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,WAAW;gBACd,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,mBAAmB;gBACtB,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,gBAAgB;gBACnB,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,kBAAkB;gBACrB,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,SAAS;gBACZ,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E,KAAK,aAAa;gBAChB,OAAO,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAA;YAC7E;gBACE,OAAO,IAAI,CAAA;QACf,CAAC;IACH,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,UAAkB;QACtC,MAAM,GAAG,GAA2B;YAClC,SAAS,EAAE,WAAW;YACtB,WAAW,EAAE,aAAa;YAC1B,mBAAmB,EAAE,qBAAqB;YAC1C,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,WAAW;YACtB,iBAAiB,EAAE,mBAAmB;YACtC,cAAc,EAAE,gBAAgB;YAChC,OAAO,EAAE,SAAS;YAClB,gBAAgB,EAAE,kBAAkB;YACpC,WAAW,EAAE,aAAa;SAC3B,CAAA;QACD,OAAO,GAAG,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,SAAS,CAAA;IAC7F,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,CAAS,EAAE,GAAW,EAAE,GAAW;QACjD,MAAM,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;IACxC,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,MAMtB;QACC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,MAAM,CAAA;QAClF,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;QACrD,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QAEpD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAA;QAC1C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAA;QAC3C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAA;QAE3C,KAAK,MAAM,GAAG,IAAI,UAAU,IAAI,EAAE,EAAE,CAAC;YACnC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,SAAQ;YACrC,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;gBACrB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBAClC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC/E,CAAC;iBAAM,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;gBAC5B,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBAClC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBAClC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAAE,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBAC9E,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;oBAAE,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAChF,CAAC;QACH,CAAC;QAGD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAA;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAA;QAE9B,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE;YAG5B,IAAI,IAAI,IAAI,CAAC;gBAAE,OAAO,UAAU,CAAA;YAIhC,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBACzB,IAAI,CAAC,IAAI,IAAI;oBAAE,OAAO,CAAC,CAAA;YACzB,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,KAAK,IAAI,EAAE,CAAC,CAAA;QACvE,CAAC,CAAC,EAAE,CAAA;QACJ,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAA;QAE/E,MAAM,eAAe,GAAG,CAAC,GAAG,EAAE;YAC5B,IAAI,IAAI,IAAI,CAAC;gBAAE,OAAO,IAAI,CAAA;YAC1B,KAAK,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACnC,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBACzB,IAAI,CAAC,IAAI,IAAI;oBAAE,OAAO,CAAC,CAAA;YACzB,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,EAAE,CAAA;QACJ,MAAM,YAAY,GAChB,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAA;QAG7F,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAA;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAA;QAE9B,IAAI,mBAAmB,GAAG,KAAK,CAAA;QAC/B,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YAClC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzC,mBAAmB,GAAG,IAAI,CAAA;gBAC1B,MAAK;YACP,CAAC;QACH,CAAC;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,uCAAuC,IAAI,KAAK,IAAI,EAAE,CAAC,CAAA;QACzE,CAAC;QAED,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAI,GAAG,GAAG,MAAM,CAAC,iBAAiB,CAAA;YAClC,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBAC9C,IAAI,CAAC,IAAI,IAAI;oBAAE,SAAQ;gBACvB,IAAI,CAAC,GAAG,GAAG;oBAAE,GAAG,GAAG,CAAC,CAAA;YACtB,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,+CAA+C,IAAI,KAAK,IAAI,EAAE,CAAC,CAAA;YACjF,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC,CAAA;QAED,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,IAAI,GAAG,GAAG,CAAC,CAAA;YACX,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClC,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBAC9C,IAAI,CAAC,IAAI,IAAI;oBAAE,SAAQ;gBACvB,IAAI,CAAC,GAAG,GAAG;oBAAE,GAAG,GAAG,CAAC,CAAA;YACtB,CAAC;YACD,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CAAC,+CAA+C,IAAI,KAAK,IAAI,EAAE,CAAC,CAAA;YACjF,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC,CAAA;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAA;QACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAA;QAE7D,MAAM,SAAS,GAAyD,CAAC,GAAG,EAAE;YAC5E,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC;gBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;YAC/E,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC;gBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;YAChF,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC;gBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;YAC/E,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC;gBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;YAChF,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;QAC7D,CAAC,CAAC,EAAE,CAAA;QAEJ,MAAM,QAAQ,GAAQ;YACpB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE;gBAEL;oBACE,IAAI,EAAE,OAAO;oBACb,SAAS,EAAE,WAAW;oBACtB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE;oBACzC,SAAS,EAAE;wBACT,IAAI,EAAE,OAAO;wBACb,EAAE,EAAE,SAAS,CAAC,EAAE;wBAChB,KAAK,EAAE,SAAS,CAAC,KAAK;wBACtB,GAAG,CAAC,SAAS,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBACpE;iBACF;gBAED;oBACE,IAAI,EAAE,OAAO;oBACb,SAAS,EAAE,WAAW;oBACtB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE;iBAC5C;gBAED,GAAG,CAAC,YAAY;oBACd,CAAC,CAAC;wBACE;4BACE,IAAI,EAAE,OAAO;4BACb,SAAS,EAAE,WAAW;4BACtB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE;4BAC3C,MAAM,EAAE,IAAI;yBACb;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;aACR;SACF,CAAA;QAED,MAAM,eAAe,GACnB,cAAc;YACd,OAAO,cAAc,KAAK,QAAQ;YAClC,KAAK,CAAC,OAAO,CAAE,cAAsB,CAAC,MAAM,CAAC;YAC3C,CAAC,CAAE,cAAsB,CAAC,MAAM;YAChC,CAAC,CAAC,EAAE,CAAA;QAER,MAAM,YAAY,GAAG,CAAC,GAAG,EAAE;YACzB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YACvE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;YACxC,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE,GAAG,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAA;QAC3D,CAAC,CAAC,EAAE,CAAA;QAEJ,MAAM,UAAU,GACd,cAAc;YACd,OAAO,cAAc,KAAK,QAAQ;YACjC,cAAsB,CAAC,MAAM;YAC9B,OAAQ,cAAsB,CAAC,MAAM,KAAK,QAAQ;YAChD,CAAC,CAAE,cAAsB,CAAC,MAAM;YAChC,CAAC,CAAC,EAAE,CAAA;QAER,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE,eAAe;YACrB,MAAM,EAAE,YAAY;YACpB,MAAM,EAAE;gBACN,GAAG,UAAU;gBACb,GAAG,EAAE;oBACH,WAAW,EAAE,UAAU;oBACvB,aAAa,EAAE,WAAW;oBAC1B,WAAW,EAAE,UAAU;oBACvB,OAAO,EAAE,EAAE,WAAW,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE;oBACzE,SAAS,EAAE,EAAE,GAAG,SAAS,EAAE;iBAC5B;aACF;YACD,GAAG,CACD,cAAc;gBACd,OAAO,cAAc,KAAK,QAAQ;gBACjC,cAAsB,CAAC,YAAY;gBAClC,CAAC,CAAC,EAAE,YAAY,EAAG,cAAsB,CAAC,YAAY,EAAE;gBACxD,CAAC,CAAC,EAAE,CACP;SACF,CAAA;QAED,OAAO;YACL,WAAW,EAAE,UAAU;YACvB,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;YAC7C,WAAW,EAAE,UAAU;YACvB,OAAO,EAAE,EAAE,WAAW,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE;YACzE,SAAS,EAAE,EAAE,EAAE,EAAE,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,IAAI,EAAE;YACzF,QAAQ;SACT,CAAA;IACH,CAAC;CACF;AAxPD,8CAwPC"}

package/dist/engine/RfmEngine.d.ts

@@ -0,0 +1,67 @@
+export type RfmEventRow = {
+    contact_id?: string | null;
+    reachy_id?: string | null;
+    event_name?: string | null;
+    event_timestamp: string | Date;
+    event_data?: any;
+};
+export type RfmContactRow = {
+    id: string;
+    reachy_id?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    is_subscribed?: boolean | null;
+    communication_preferences?: any;
+};
+export type RfmAggregateRow = {
+    contact_id: string;
+    last_ts: Date;
+    event_count: number;
+};
+export type RfmScoredContact = RfmAggregateRow & {
+    recency_days: number;
+    r_score: 1 | 2 | 3 | 4 | 5;
+    f_score: 1 | 2 | 3 | 4 | 5;
+    segment_key: string;
+    email_ok: 0 | 1;
+    sms_ok: 0 | 1;
+};
+export type RfmPreviewSegment = {
+    segment_key: string;
+    segment_name: string;
+    users: number;
+    percent: number;
+    avm: number;
+    email_reachability: number;
+    sms_reachability: number;
+};
+export type RfmThresholdRow = {
+    kind: 'r' | 'f';
+    score: 1 | 2 | 3 | 4 | 5;
+    min_value: number;
+    max_value: number;
+};
+export type RfmComputeOptions = {
+    from: string | Date;
+    to: string | Date;
+    rfEventName: string;
+    filterContactIds?: Set<string> | string[] | null;
+};
+type PercentileCuts = [number, number, number, number];
+export declare class RfmEngine {
+    static aggregateFromEvents(contacts: RfmContactRow[], events: RfmEventRow[], opts: RfmComputeOptions): RfmAggregateRow[];
+    static scoreAggregates(contacts: RfmContactRow[], aggregates: RfmAggregateRow[], opts: Pick<RfmComputeOptions, 'to'>): {
+        scored: RfmScoredContact[];
+        r_days_cuts: PercentileCuts;
+        f_count_cuts: PercentileCuts;
+    };
+    static thresholdsFromScored(scored: RfmScoredContact[]): RfmThresholdRow[];
+    static previewFromScored(scored: RfmScoredContact[]): RfmPreviewSegment[];
+    static computeFromEvents(contacts: RfmContactRow[], events: RfmEventRow[], opts: RfmComputeOptions): {
+        segments: RfmPreviewSegment[];
+        thresholds: RfmThresholdRow[];
+        scored: RfmScoredContact[];
+    };
+}
+export {};
+//# sourceMappingURL=RfmEngine.d.ts.map

package/dist/engine/RfmEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RfmEngine.d.ts","sourceRoot":"","sources":["../../src/engine/RfmEngine.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,GAAG,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC9B,yBAAyB,CAAC,EAAE,GAAG,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,IAAI,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG;IAC/C,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC1B,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAA;IACf,MAAM,EAAE,CAAC,GAAG,CAAC,CAAA;CACd,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;IACX,kBAAkB,EAAE,MAAM,CAAA;IAC1B,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,GAAG,GAAG,GAAG,CAAA;IACf,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;CACjD,CAAA;AAED,KAAK,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;AAyItD,qBAAa,SAAS;IAOpB,MAAM,CAAC,mBAAmB,CACxB,QAAQ,EAAE,aAAa,EAAE,EACzB,MAAM,EAAE,WAAW,EAAE,EACrB,IAAI,EAAE,iBAAiB,GACtB,eAAe,EAAE;IA4DpB,MAAM,CAAC,eAAe,CACpB,QAAQ,EAAE,aAAa,EAAE,EACzB,UAAU,EAAE,eAAe,EAAE,EAC7B,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,GAClC;QAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;QAAC,WAAW,EAAE,cAAc,CAAC;QAAC,YAAY,EAAE,cAAc,CAAA;KAAE;IA+C5F,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,eAAe,EAAE;IAqD1E,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,iBAAiB,EAAE;IAmCzE,MAAM,CAAC,iBAAiB,CACtB,QAAQ,EAAE,aAAa,EAAE,EACzB,MAAM,EAAE,WAAW,EAAE,EACrB,IAAI,EAAE,iBAAiB,GACtB;QAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAC;QAAC,UAAU,EAAE,eAAe,EAAE,CAAC;QAAC,MAAM,EAAE,gBAAgB,EAAE,CAAA;KAAE;CAOhG"}