@frak-labs/core-sdk 1.1.5-beta.9494f1aa → 1.1.5-beta.a4f314da
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/rewards.cjs +1 -1
- package/dist/rewards.cjs.map +1 -1
- package/dist/rewards.d.cts +33 -4
- package/dist/rewards.d.ts +33 -4
- package/dist/rewards.js +1 -1
- package/dist/rewards.js.map +1 -1
- package/package.json +2 -2
- package/src/rewards/format.ts +2 -2
- package/src/rewards/index.ts +2 -0
- package/src/rewards/select.test.ts +70 -1
- package/src/rewards/select.ts +73 -8
package/dist/rewards.cjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./getCurrencyAmountKey-h2eOiYzv.cjs`);function t(e){return Array.isArray(e)?e:e.conditions}function n(e){if(typeof e==`number`)return e;if(typeof e==`string`&&e.trim()!==``){let t=Number(e);return Number.isFinite(t)?t:void 0}}function r(e,i,a){let o=[];for(let s of t(e)){if(`logic`in s){o.push(...r(s,i,a));continue}if(s.field===i&&a.has(s.operator)){let e=n(s.value);e!=null&&o.push(e)}}return o}const i=new Set([`gt`,`gte`,`between`]),a=new Set([`gt`,`gte`]);function o(e){let t=r(e,`purchase.amount`,i);return t.length>0?Math.min(...t):void 0}function s(e){let t=r(e,`time.timestamp`,a);if(t.length!==0)return new Date(Math.min(...t)*1e3)}function c(e,t){let n=Math.round((e+t)/2/10)*10;return Math.min(t,Math.max(e,n))}function l(e){return Math.max(100,e??0)}function u(e,t){return t==null?e:e<=100&&100<=t?100:c(e,t)}function d(e,t){let n=l(t);if(n<=0)return;let r=e.percent/100*n;return e.minAmount&&(r=Math.max(r,e.minAmount.eurAmount)),e.maxAmount&&(r=Math.min(r,e.maxAmount.eurAmount)),{basket:n,reward:r}}function f(e,t,n){let r=u(t,n);if(!(r<=0))return{basket:r,reward:e/100*r}}function p(e,t){switch(e.payoutType){case`fixed`:return e.amount[t];case`percentage`:return e.maxAmount?.[t]??0;case`tiered`:return e.tiers.reduce((e,n)=>`amount`in n?Math.max(e,n.amount[t]):e,0)}}function m(e){return e.payoutType===`percentage`?e.percent:e.payoutType===`tiered`?e.tiers.reduce((e,t)=>`percent`in t?Math.max(e,t.percent):e,0):0}function h(e,t){let n=p(e,t);return n>0?n:m(e)*1e-6}function g(t,n){let r=e.r(n),i=e.t(r);switch(t.payoutType){case`fixed`:return e.n(Math.round(t.amount[i]),r);case`percentage`:return`${t.percent} %`;case`tiered`:{let n=p(t,i);if(n>0)return e.n(Math.round(n),r);let a=m(t);return a>0?`${a} %`:e.n(0,r)}}}function _(t,n){if(t&&!(h(t,e.t(e.r(n)))<=0))return g(t,n)}function v(e,t){return t?e.
|
|
1
|
+
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./getCurrencyAmountKey-h2eOiYzv.cjs`);function t(e){return Array.isArray(e)?e:e.conditions}function n(e){if(typeof e==`number`)return e;if(typeof e==`string`&&e.trim()!==``){let t=Number(e);return Number.isFinite(t)?t:void 0}}function r(e,i,a){let o=[];for(let s of t(e)){if(`logic`in s){o.push(...r(s,i,a));continue}if(s.field===i&&a.has(s.operator)){let e=n(s.value);e!=null&&o.push(e)}}return o}const i=new Set([`gt`,`gte`,`between`]),a=new Set([`gt`,`gte`]);function o(e){let t=r(e,`purchase.amount`,i);return t.length>0?Math.min(...t):void 0}function s(e){let t=r(e,`time.timestamp`,a);if(t.length!==0)return new Date(Math.min(...t)*1e3)}function c(e,t){let n=Math.round((e+t)/2/10)*10;return Math.min(t,Math.max(e,n))}function l(e){return Math.max(100,e??0)}function u(e,t){return t==null?e:e<=100&&100<=t?100:c(e,t)}function d(e,t){let n=l(t);if(n<=0)return;let r=e.percent/100*n;return e.minAmount&&(r=Math.max(r,e.minAmount.eurAmount)),e.maxAmount&&(r=Math.min(r,e.maxAmount.eurAmount)),{basket:n,reward:r}}function f(e,t,n){let r=u(t,n);if(!(r<=0))return{basket:r,reward:e/100*r}}function p(e,t){switch(e.payoutType){case`fixed`:return e.amount[t];case`percentage`:return e.maxAmount?.[t]??0;case`tiered`:return e.tiers.reduce((e,n)=>`amount`in n?Math.max(e,n.amount[t]):e,0)}}function m(e){return e.payoutType===`percentage`?e.percent:e.payoutType===`tiered`?e.tiers.reduce((e,t)=>`percent`in t?Math.max(e,t.percent):e,0):0}function h(e,t){let n=p(e,t);return n>0?n:m(e)*1e-6}function g(t,n){let r=e.r(n),i=e.t(r);switch(t.payoutType){case`fixed`:return e.n(Math.round(t.amount[i]),r);case`percentage`:return`${t.percent} %`;case`tiered`:{let n=p(t,i);if(n>0)return e.n(Math.round(n),r);let a=m(t);return a>0?`${a} %`:e.n(0,r)}}}function _(t,n){if(t&&!(h(t,e.t(e.r(n)))<=0))return g(t,n)}function v(e,t){return t?e.replaceAll(`{REWARD}`,t):e.replaceAll(`{REWARD}`,``)}function y(e,t){return e.expiresAt!=null&&new Date(e.expiresAt).getTime()<=t}function b(e,t){let n=s(e.conditions);return n==null||n.getTime()<=t}function x(e,t){return t===`referee`?e.referee:e.referrer}function S(e,t,n){let r=x(e,n);return r?h(r,t):0}function C(t,n={}){let r=(n.now??new Date).getTime(),i=n.audience??`referrer`,a=e.t(e.r(n.currency)),o=(n.targetInteraction?t.filter(e=>e.interactionTypeKey===n.targetInteraction):t).filter(e=>!y(e,r)),c=o.filter(e=>b(e,r));if(c.length>0)return{campaign:c.reduce((e,t)=>S(t,a,i)>S(e,a,i)?t:e),status:`live`};let l=o.map(e=>({campaign:e,startsAt:s(e.conditions)})).filter(e=>e.startsAt!=null);if(l.length===0)return;let u=l.reduce((e,t)=>t.startsAt.getTime()<e.startsAt.getTime()?t:e);return{campaign:u.campaign,status:`upcoming`,startsAt:u.startsAt}}function w(t,n={}){let r=C(t,n);if(!r)return;let i=x(r.campaign,n.audience??`referrer`);if(!i)return;let a=_(i,n.currency);if(!a)return;let s=o(r.campaign.conditions),c=s==null?void 0:e.n(s,n.currency),l=r.campaign.defaultLockupSeconds,u=l&&l>0?Math.round(l/86400):void 0;return{formatted:a,payoutType:i.payoutType,minPurchaseAmount:c,lockupDurationDays:u}}function T(e,t={}){return w(e,t)?.formatted}exports.applyRewardPlaceholder=v,exports.buildPercentageExample=d,exports.buildTierExample=f,exports.extractMinPurchaseAmount=o,exports.extractStartDate=s,exports.formatBestReward=T,exports.formatEstimatedReward=g,exports.formatRewardOrHide=_,exports.getRewardValue=p,exports.pickFlatBasket=l,exports.pickTierBasket=u,exports.selectBestReward=w,exports.selectDisplayCampaign=C;
|
|
2
2
|
//# sourceMappingURL=rewards.cjs.map
|
package/dist/rewards.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rewards.cjs","names":["getSupportedCurrency","getCurrencyAmountKey","formatAmount","getCurrencyAmountKey","getSupportedCurrency"],"sources":["../src/rewards/conditions.ts","../src/rewards/example.ts","../src/rewards/value.ts","../src/rewards/format.ts","../src/rewards/select.ts"],"sourcesContent":["import type { ConditionGroup, RuleCondition, RuleConditions } from \"../types\";\n\ntype ConditionNode = RuleCondition | ConditionGroup;\n\nfunction conditionNodes(conditions: RuleConditions): ConditionNode[] {\n return Array.isArray(conditions) ? conditions : conditions.conditions;\n}\n\nfunction conditionValueToNumber(\n value: RuleCondition[\"value\"]\n): number | undefined {\n if (typeof value === \"number\") return value;\n if (typeof value === \"string\" && value.trim() !== \"\") {\n const parsed = Number(value);\n return Number.isFinite(parsed) ? parsed : undefined;\n }\n return undefined;\n}\n\n// Conditions arrive as a flat list or recursive groups; collect every numeric\n// value whose field + operator match, descending into nested groups.\nfunction collectConditionValues(\n conditions: RuleConditions,\n field: string,\n operators: ReadonlySet<RuleCondition[\"operator\"]>\n): number[] {\n const values: number[] = [];\n for (const node of conditionNodes(conditions)) {\n if (\"logic\" in node) {\n values.push(...collectConditionValues(node, field, operators));\n continue;\n }\n if (node.field === field && operators.has(node.operator)) {\n const value = conditionValueToNumber(node.value);\n if (value != null) values.push(value);\n }\n }\n return values;\n}\n\nconst MIN_PURCHASE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n \"between\",\n]);\nconst START_DATE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n]);\n\nexport function extractMinPurchaseAmount(\n conditions: RuleConditions\n): number | undefined {\n const values = collectConditionValues(\n conditions,\n \"purchase.amount\",\n MIN_PURCHASE_OPERATORS\n );\n return values.length > 0 ? Math.min(...values) : undefined;\n}\n\n// The business app encodes a campaign start as a `time.timestamp >= <unix s>`\n// rule condition; the endpoint returns it verbatim inside `conditions`.\nexport function extractStartDate(conditions: RuleConditions): Date | undefined {\n const values = collectConditionValues(\n conditions,\n \"time.timestamp\",\n START_DATE_OPERATORS\n );\n if (values.length === 0) return undefined;\n return new Date(Math.min(...values) * 1000);\n}\n","import type { EstimatedReward } from \"../types\";\n\ntype PercentageReward = Extract<EstimatedReward, { payoutType: \"percentage\" }>;\n\n// Reference order total used to turn a \"% of basket\" reward into a concrete\n// example amount. The campaign's minimum purchase overrides it when higher.\nconst REFERENCE_BASKET = 100;\n\nexport type RewardExample = {\n basket: number;\n reward: number;\n};\n\nfunction roundWithinRange(min: number, max: number): number {\n const rounded = Math.round((min + max) / 2 / 10) * 10;\n return Math.min(max, Math.max(min, rounded));\n}\n\nexport function pickFlatBasket(minPurchase: number | undefined): number {\n return Math.max(REFERENCE_BASKET, minPurchase ?? 0);\n}\n\n// Basket for a percentage tier: the reference when it sits inside the tier\n// range, a round number within the range otherwise, or the lower bound for an\n// open-ended (uncapped) top tier.\nexport function pickTierBasket(\n minValue: number,\n maxValue: number | undefined\n): number {\n if (maxValue == null) return minValue;\n if (minValue <= REFERENCE_BASKET && REFERENCE_BASKET <= maxValue) {\n return REFERENCE_BASKET;\n }\n return roundWithinRange(minValue, maxValue);\n}\n\nexport function buildPercentageExample(\n reward: PercentageReward,\n minPurchase: number | undefined\n): RewardExample | undefined {\n const basket = pickFlatBasket(minPurchase);\n if (basket <= 0) return undefined;\n let amount = (reward.percent / 100) * basket;\n if (reward.minAmount) amount = Math.max(amount, reward.minAmount.eurAmount);\n if (reward.maxAmount) amount = Math.min(amount, reward.maxAmount.eurAmount);\n return { basket, reward: amount };\n}\n\nexport function buildTierExample(\n percent: number,\n minValue: number,\n maxValue: number | undefined\n): RewardExample | undefined {\n const basket = pickTierBasket(minValue, maxValue);\n if (basket <= 0) return undefined;\n return { basket, reward: (percent / 100) * basket };\n}\n","import type { EstimatedReward, TokenAmountType } from \"../types\";\n\n/**\n * Comparable fiat value of a single reward, used to rank rewards against each\n * other.\n *\n * - `fixed` → the token amount in the requested currency\n * - `tiered` → the highest token amount across tiers\n * - `percentage` → the capped (`maxAmount`) value when present, otherwise `0`\n * (an uncapped percentage has no comparable fiat value)\n */\nexport function getRewardValue(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n switch (reward.payoutType) {\n case \"fixed\":\n return reward.amount[key];\n case \"percentage\":\n return reward.maxAmount?.[key] ?? 0;\n case \"tiered\":\n return reward.tiers.reduce(\n (max, tier) =>\n \"amount\" in tier ? Math.max(max, tier.amount[key]) : max,\n 0\n );\n }\n}\n\n/**\n * Highest percent a reward exposes: the flat `percentage` percent, or the\n * richest percent across `tiered` tiers, or `0` when it carries none.\n *\n * Shared by {@link getRewardRank} (to weight a percentage-only reward) and\n * `formatEstimatedReward` (to render it as `\"X %\"`), so the value the UI ranks\n * by and the value it prints stay derived from one tier traversal.\n */\nexport function maxRewardPercent(reward: EstimatedReward): number {\n if (reward.payoutType === \"percentage\") return reward.percent;\n if (reward.payoutType === \"tiered\") {\n return reward.tiers.reduce(\n (max, tier) =>\n \"percent\" in tier ? Math.max(max, tier.percent) : max,\n 0\n );\n }\n return 0;\n}\n\n// A reward with no money value (an uncapped percentage, or a percent-only\n// tier set) still renders as \"X %\", so it is worth surfacing. We give it a\n// positive ranking weight derived from its percent but scaled far below any\n// real-money reward, so the two invariants the UI relies on hold: (1) a reward\n// with real money always outranks a percentage-only reward, and (2) a\n// percentage-only reward still outranks a zero-value reward. Together they\n// guarantee the reward the ranking picks is always one we can display.\nconst PERCENT_ONLY_RANK_WEIGHT = 1e-6;\n\n/**\n * Ranking weight used to pick the single most attractive reward to surface.\n *\n * Mirrors {@link getRewardValue} (money value) but lifts a percentage-only\n * reward to a tiny positive weight instead of `0`, so it is never buried\n * behind a zero-value reward when choosing what to display.\n */\nexport function getRewardRank(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n const value = getRewardValue(reward, key);\n if (value > 0) return value;\n return maxRewardPercent(reward) * PERCENT_ONLY_RANK_WEIGHT;\n}\n","import type { Currency, EstimatedReward } from \"../types\";\nimport { formatAmount } from \"../utils/format/formatAmount\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { getRewardRank, getRewardValue, maxRewardPercent } from \"./value\";\n\n/**\n * Format an {@link EstimatedReward} into a human-readable string.\n *\n * - `fixed` → e.g. `\"5 €\"`\n * - `percentage` → e.g. `\"10 %\"`\n * - `tiered` → the richest tier: max token amount (e.g. `\"50 €\"`) or, when\n * tiers only carry percentages, the max percent (e.g. `\"10 %\"`)\n *\n * Percentages are always rendered as a `\"X %\"` string: the backend never sends\n * a reference basket, so the reward cannot be resolved to a concrete amount\n * here. Callers that need a worked example use the `example` helpers instead.\n */\nexport function formatEstimatedReward(\n reward: EstimatedReward,\n currency?: Currency\n): string {\n const supportedCurrency = getSupportedCurrency(currency);\n const key = getCurrencyAmountKey(supportedCurrency);\n\n switch (reward.payoutType) {\n case \"fixed\":\n return formatAmount(\n Math.round(reward.amount[key]),\n supportedCurrency\n );\n\n case \"percentage\":\n return `${reward.percent} %`;\n\n case \"tiered\": {\n const maxAmount = getRewardValue(reward, key);\n if (maxAmount > 0) {\n return formatAmount(Math.round(maxAmount), supportedCurrency);\n }\n const maxPercent = maxRewardPercent(reward);\n if (maxPercent > 0) {\n return `${maxPercent} %`;\n }\n return formatAmount(0, supportedCurrency);\n }\n }\n}\n\n/**\n * Format a reward for display, or return `undefined` when it is not worth\n * advertising. Callers rely on `undefined` to hide a badge / fall back to\n * other copy.\n *\n * A reward is hidden only when it carries no displayable value — a `fixed` or\n * `tiered` reward whose money value is `0` (e.g. an unknown token price). An\n * uncapped percentage always renders as `\"X %\"`, since the percent itself is\n * meaningful even without a money value.\n */\nexport function formatRewardOrHide(\n reward: EstimatedReward | undefined,\n currency?: Currency\n): string | undefined {\n if (!reward) return undefined;\n const key = getCurrencyAmountKey(getSupportedCurrency(currency));\n if (getRewardRank(reward, key) <= 0) return undefined;\n return formatEstimatedReward(reward, currency);\n}\n\n/**\n * Replace the `{REWARD}` placeholder in a text string with a reward value.\n * If no reward is provided, returns the text with `{REWARD}` stripped.\n */\nexport function applyRewardPlaceholder(\n text: string,\n reward: string | undefined\n): string {\n return reward\n ? text.replace(\"{REWARD}\", reward)\n : text.replace(\"{REWARD}\", \"\");\n}\n","import type { InteractionTypeKey } from \"../constants/interactionTypes\";\nimport type { Currency, MerchantReward, TokenAmountType } from \"../types\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { extractStartDate } from \"./conditions\";\nimport { formatRewardOrHide } from \"./format\";\nimport { getRewardRank } from \"./value\";\n\n/** Reward side a surface cares about: the sharer (`referrer`) or the referred\n * user (`referee`). Drives both campaign ranking and which side is displayed. */\nexport type RewardAudience = \"referrer\" | \"referee\";\n\nexport type DisplayCampaign = {\n campaign: MerchantReward;\n status: \"live\" | \"upcoming\";\n startsAt?: Date;\n};\n\nexport type SelectDisplayCampaignOptions = {\n /** Reference \"now\" for expiry / start gating; defaults to the current time. */\n now?: Date;\n /** Currency the ranking is expressed in; defaults to EUR. */\n currency?: Currency;\n /** When set, only campaigns triggered by this interaction are considered. */\n targetInteraction?: InteractionTypeKey;\n /** Reward side to rank campaigns by; defaults to `\"referrer\"`. */\n audience?: RewardAudience;\n};\n\nfunction isExpired(campaign: MerchantReward, nowMs: number): boolean {\n return (\n campaign.expiresAt != null &&\n new Date(campaign.expiresAt).getTime() <= nowMs\n );\n}\n\nfunction hasStarted(campaign: MerchantReward, nowMs: number): boolean {\n const startsAt = extractStartDate(campaign.conditions);\n return startsAt == null || startsAt.getTime() <= nowMs;\n}\n\nfunction audienceReward(campaign: MerchantReward, audience: RewardAudience) {\n return audience === \"referee\" ? campaign.referee : campaign.referrer;\n}\n\nfunction campaignRank(\n campaign: MerchantReward,\n key: keyof TokenAmountType,\n audience: RewardAudience\n): number {\n const reward = audienceReward(campaign, audience);\n return reward ? getRewardRank(reward, key) : 0;\n}\n\n/**\n * Pick the single campaign a merchant surface should display.\n *\n * Filters out expired (and, when `targetInteraction` is set, non-matching)\n * campaigns, then prefers the highest-ranked *live* campaign — ranked by the\n * `audience` reward side in the requested currency. When none has started yet\n * it falls back to the soonest-starting upcoming campaign (the endpoint does\n * not gate on the start-date condition, so future-start campaigns come\n * through).\n */\nexport function selectDisplayCampaign(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): DisplayCampaign | undefined {\n const nowMs = (options.now ?? new Date()).getTime();\n const audience = options.audience ?? \"referrer\";\n const key = getCurrencyAmountKey(getSupportedCurrency(options.currency));\n\n const matching = options.targetInteraction\n ? rewards.filter(\n (campaign) =>\n campaign.interactionTypeKey === options.targetInteraction\n )\n : rewards;\n const active = matching.filter((campaign) => !isExpired(campaign, nowMs));\n\n const live = active.filter((campaign) => hasStarted(campaign, nowMs));\n if (live.length > 0) {\n const best = live.reduce((a, b) =>\n campaignRank(b, key, audience) > campaignRank(a, key, audience)\n ? b\n : a\n );\n return { campaign: best, status: \"live\" };\n }\n\n const upcoming = active\n .map((campaign) => ({\n campaign,\n startsAt: extractStartDate(campaign.conditions),\n }))\n .filter(\n (entry): entry is { campaign: MerchantReward; startsAt: Date } =>\n entry.startsAt != null\n );\n if (upcoming.length === 0) return undefined;\n\n const soonest = upcoming.reduce((a, b) =>\n b.startsAt.getTime() < a.startsAt.getTime() ? b : a\n );\n return {\n campaign: soonest.campaign,\n status: \"upcoming\",\n startsAt: soonest.startsAt,\n };\n}\n\n/**\n * Headline reward string for a merchant: picks the best campaign for `options`\n * and formats its `audience`-side reward, or returns `undefined` when there is\n * nothing worth showing.\n *\n * Single entry point shared by every \"headline reward\" surface (share button,\n * wallet modal, sharing/install screens) so they all show the same number for\n * a given merchant.\n */\nexport function formatBestReward(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): string | undefined {\n const selected = selectDisplayCampaign(rewards, options);\n if (!selected) return undefined;\n const reward = audienceReward(\n selected.campaign,\n options.audience ?? \"referrer\"\n );\n return formatRewardOrHide(reward, options.currency);\n}\n"],"mappings":"0HAIA,SAAS,EAAe,EAA6C,CACjE,OAAO,MAAM,QAAQ,CAAU,EAAI,EAAa,EAAW,UAC/D,CAEA,SAAS,EACL,EACkB,CAClB,GAAI,OAAO,GAAU,SAAU,OAAO,EACtC,GAAI,OAAO,GAAU,UAAY,EAAM,KAAK,IAAM,GAAI,CAClD,IAAM,EAAS,OAAO,CAAK,EAC3B,OAAO,OAAO,SAAS,CAAM,EAAI,EAAS,IAAA,EAC9C,CAEJ,CAIA,SAAS,EACL,EACA,EACA,EACQ,CACR,IAAM,EAAmB,CAAC,EAC1B,IAAK,IAAM,KAAQ,EAAe,CAAU,EAAG,CAC3C,GAAI,UAAW,EAAM,CACjB,EAAO,KAAK,GAAG,EAAuB,EAAM,EAAO,CAAS,CAAC,EAC7D,QACJ,CACA,GAAI,EAAK,QAAU,GAAS,EAAU,IAAI,EAAK,QAAQ,EAAG,CACtD,IAAM,EAAQ,EAAuB,EAAK,KAAK,EAC3C,GAAS,MAAM,EAAO,KAAK,CAAK,CACxC,CACJ,CACA,OAAO,CACX,CAEA,MAAM,EAAiE,IAAI,IAAI,CAC3E,KACA,MACA,SACJ,CAAC,EACK,EAA+D,IAAI,IAAI,CACzE,KACA,KACJ,CAAC,EAED,SAAgB,EACZ,EACkB,CAClB,IAAM,EAAS,EACX,EACA,kBACA,CACJ,EACA,OAAO,EAAO,OAAS,EAAI,KAAK,IAAI,GAAG,CAAM,EAAI,IAAA,EACrD,CAIA,SAAgB,EAAiB,EAA8C,CAC3E,IAAM,EAAS,EACX,EACA,iBACA,CACJ,EACI,KAAO,SAAW,EACtB,OAAO,IAAI,KAAK,KAAK,IAAI,GAAG,CAAM,EAAI,GAAI,CAC9C,CC1DA,SAAS,EAAiB,EAAa,EAAqB,CACxD,IAAM,EAAU,KAAK,OAAO,EAAM,GAAO,EAAI,EAAE,EAAI,GACnD,OAAO,KAAK,IAAI,EAAK,KAAK,IAAI,EAAK,CAAO,CAAC,CAC/C,CAEA,SAAgB,EAAe,EAAyC,CACpE,OAAO,KAAK,IAAI,IAAkB,GAAe,CAAC,CACtD,CAKA,SAAgB,EACZ,EACA,EACM,CAKN,OAJI,GAAY,KAAa,EACzB,GAAY,KAAoB,KAAoB,EAC7C,IAEJ,EAAiB,EAAU,CAAQ,CAC9C,CAEA,SAAgB,EACZ,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,CAAW,EACzC,GAAI,GAAU,EAAG,OACjB,IAAI,EAAU,EAAO,QAAU,IAAO,EAGtC,OAFI,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACtE,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACnE,CAAE,SAAQ,OAAQ,CAAO,CACpC,CAEA,SAAgB,EACZ,EACA,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,EAAU,CAAQ,EAC5C,QAAU,GACd,MAAO,CAAE,SAAQ,OAAS,EAAU,IAAO,CAAO,CACtD,CC7CA,SAAgB,EACZ,EACA,EACM,CACN,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAO,EAAO,OAAO,GACzB,IAAK,aACD,OAAO,EAAO,YAAY,IAAQ,EACtC,IAAK,SACD,OAAO,EAAO,MAAM,QACf,EAAK,IACF,WAAY,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EAAI,EACzD,CACJ,CACR,CACJ,CAUA,SAAgB,EAAiB,EAAiC,CAS9D,OARI,EAAO,aAAe,aAAqB,EAAO,QAClD,EAAO,aAAe,SACf,EAAO,MAAM,QACf,EAAK,IACF,YAAa,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EACtD,CACJ,EAEG,CACX,CAkBA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAQ,EAAe,EAAQ,CAAG,EAExC,OADI,EAAQ,EAAU,EACf,EAAiB,CAAM,EAAI,IACtC,CCtDA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAoBA,EAAAA,EAAqB,CAAQ,EACjD,EAAMC,EAAAA,EAAqB,CAAiB,EAElD,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAOC,EAAAA,EACH,KAAK,MAAM,EAAO,OAAO,EAAI,EAC7B,CACJ,EAEJ,IAAK,aACD,MAAO,GAAG,EAAO,QAAQ,IAE7B,IAAK,SAAU,CACX,IAAM,EAAY,EAAe,EAAQ,CAAG,EAC5C,GAAI,EAAY,EACZ,OAAOA,EAAAA,EAAa,KAAK,MAAM,CAAS,EAAG,CAAiB,EAEhE,IAAM,EAAa,EAAiB,CAAM,EAI1C,OAHI,EAAa,EACN,GAAG,EAAW,IAElBA,EAAAA,EAAa,EAAG,CAAiB,CAC5C,CACJ,CACJ,CAYA,SAAgB,EACZ,EACA,EACkB,CACb,MAED,IAAc,EADND,EAAAA,EAAqBD,EAAAA,EAAqB,CAAQ,CAClC,CAAC,GAAK,GAClC,OAAO,EAAsB,EAAQ,CAAQ,CACjD,CAMA,SAAgB,EACZ,EACA,EACM,CACN,OAAO,EACD,EAAK,QAAQ,WAAY,CAAM,EAC/B,EAAK,QAAQ,WAAY,EAAE,CACrC,CCnDA,SAAS,EAAU,EAA0B,EAAwB,CACjE,OACI,EAAS,WAAa,MACtB,IAAI,KAAK,EAAS,SAAS,EAAE,QAAQ,GAAK,CAElD,CAEA,SAAS,EAAW,EAA0B,EAAwB,CAClE,IAAM,EAAW,EAAiB,EAAS,UAAU,EACrD,OAAO,GAAY,MAAQ,EAAS,QAAQ,GAAK,CACrD,CAEA,SAAS,EAAe,EAA0B,EAA0B,CACxE,OAAO,IAAa,UAAY,EAAS,QAAU,EAAS,QAChE,CAEA,SAAS,EACL,EACA,EACA,EACM,CACN,IAAM,EAAS,EAAe,EAAU,CAAQ,EAChD,OAAO,EAAS,EAAc,EAAQ,CAAG,EAAI,CACjD,CAYA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACd,CAC3B,IAAM,GAAS,EAAQ,KAAO,IAAI,MAAQ,QAAQ,EAC5C,EAAW,EAAQ,UAAY,WAC/B,EAAMG,EAAAA,EAAqBC,EAAAA,EAAqB,EAAQ,QAAQ,CAAC,EAQjE,GANW,EAAQ,kBACnB,EAAQ,OACH,GACG,EAAS,qBAAuB,EAAQ,iBAChD,EACA,GACkB,OAAQ,GAAa,CAAC,EAAU,EAAU,CAAK,CAAC,EAElE,EAAO,EAAO,OAAQ,GAAa,EAAW,EAAU,CAAK,CAAC,EACpE,GAAI,EAAK,OAAS,EAMd,MAAO,CAAE,SALI,EAAK,QAAQ,EAAG,IACzB,EAAa,EAAG,EAAK,CAAQ,EAAI,EAAa,EAAG,EAAK,CAAQ,EACxD,EACA,CAEY,EAAG,OAAQ,MAAO,EAG5C,IAAM,EAAW,EACZ,IAAK,IAAc,CAChB,WACA,SAAU,EAAiB,EAAS,UAAU,CAClD,EAAE,EACD,OACI,GACG,EAAM,UAAY,IAC1B,EACJ,GAAI,EAAS,SAAW,EAAG,OAE3B,IAAM,EAAU,EAAS,QAAQ,EAAG,IAChC,EAAE,SAAS,QAAQ,EAAI,EAAE,SAAS,QAAQ,EAAI,EAAI,CACtD,EACA,MAAO,CACH,SAAU,EAAQ,SAClB,OAAQ,WACR,SAAU,EAAQ,QACtB,CACJ,CAWA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACvB,CAClB,IAAM,EAAW,EAAsB,EAAS,CAAO,EAClD,KAKL,OAAO,EAJQ,EACX,EAAS,SACT,EAAQ,UAAY,UAEO,EAAG,EAAQ,QAAQ,CACtD"}
|
|
1
|
+
{"version":3,"file":"rewards.cjs","names":["getSupportedCurrency","getCurrencyAmountKey","formatAmount","getCurrencyAmountKey","getSupportedCurrency","formatAmount"],"sources":["../src/rewards/conditions.ts","../src/rewards/example.ts","../src/rewards/value.ts","../src/rewards/format.ts","../src/rewards/select.ts"],"sourcesContent":["import type { ConditionGroup, RuleCondition, RuleConditions } from \"../types\";\n\ntype ConditionNode = RuleCondition | ConditionGroup;\n\nfunction conditionNodes(conditions: RuleConditions): ConditionNode[] {\n return Array.isArray(conditions) ? conditions : conditions.conditions;\n}\n\nfunction conditionValueToNumber(\n value: RuleCondition[\"value\"]\n): number | undefined {\n if (typeof value === \"number\") return value;\n if (typeof value === \"string\" && value.trim() !== \"\") {\n const parsed = Number(value);\n return Number.isFinite(parsed) ? parsed : undefined;\n }\n return undefined;\n}\n\n// Conditions arrive as a flat list or recursive groups; collect every numeric\n// value whose field + operator match, descending into nested groups.\nfunction collectConditionValues(\n conditions: RuleConditions,\n field: string,\n operators: ReadonlySet<RuleCondition[\"operator\"]>\n): number[] {\n const values: number[] = [];\n for (const node of conditionNodes(conditions)) {\n if (\"logic\" in node) {\n values.push(...collectConditionValues(node, field, operators));\n continue;\n }\n if (node.field === field && operators.has(node.operator)) {\n const value = conditionValueToNumber(node.value);\n if (value != null) values.push(value);\n }\n }\n return values;\n}\n\nconst MIN_PURCHASE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n \"between\",\n]);\nconst START_DATE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n]);\n\nexport function extractMinPurchaseAmount(\n conditions: RuleConditions\n): number | undefined {\n const values = collectConditionValues(\n conditions,\n \"purchase.amount\",\n MIN_PURCHASE_OPERATORS\n );\n return values.length > 0 ? Math.min(...values) : undefined;\n}\n\n// The business app encodes a campaign start as a `time.timestamp >= <unix s>`\n// rule condition; the endpoint returns it verbatim inside `conditions`.\nexport function extractStartDate(conditions: RuleConditions): Date | undefined {\n const values = collectConditionValues(\n conditions,\n \"time.timestamp\",\n START_DATE_OPERATORS\n );\n if (values.length === 0) return undefined;\n return new Date(Math.min(...values) * 1000);\n}\n","import type { EstimatedReward } from \"../types\";\n\ntype PercentageReward = Extract<EstimatedReward, { payoutType: \"percentage\" }>;\n\n// Reference order total used to turn a \"% of basket\" reward into a concrete\n// example amount. The campaign's minimum purchase overrides it when higher.\nconst REFERENCE_BASKET = 100;\n\nexport type RewardExample = {\n basket: number;\n reward: number;\n};\n\nfunction roundWithinRange(min: number, max: number): number {\n const rounded = Math.round((min + max) / 2 / 10) * 10;\n return Math.min(max, Math.max(min, rounded));\n}\n\nexport function pickFlatBasket(minPurchase: number | undefined): number {\n return Math.max(REFERENCE_BASKET, minPurchase ?? 0);\n}\n\n// Basket for a percentage tier: the reference when it sits inside the tier\n// range, a round number within the range otherwise, or the lower bound for an\n// open-ended (uncapped) top tier.\nexport function pickTierBasket(\n minValue: number,\n maxValue: number | undefined\n): number {\n if (maxValue == null) return minValue;\n if (minValue <= REFERENCE_BASKET && REFERENCE_BASKET <= maxValue) {\n return REFERENCE_BASKET;\n }\n return roundWithinRange(minValue, maxValue);\n}\n\nexport function buildPercentageExample(\n reward: PercentageReward,\n minPurchase: number | undefined\n): RewardExample | undefined {\n const basket = pickFlatBasket(minPurchase);\n if (basket <= 0) return undefined;\n let amount = (reward.percent / 100) * basket;\n if (reward.minAmount) amount = Math.max(amount, reward.minAmount.eurAmount);\n if (reward.maxAmount) amount = Math.min(amount, reward.maxAmount.eurAmount);\n return { basket, reward: amount };\n}\n\nexport function buildTierExample(\n percent: number,\n minValue: number,\n maxValue: number | undefined\n): RewardExample | undefined {\n const basket = pickTierBasket(minValue, maxValue);\n if (basket <= 0) return undefined;\n return { basket, reward: (percent / 100) * basket };\n}\n","import type { EstimatedReward, TokenAmountType } from \"../types\";\n\n/**\n * Comparable fiat value of a single reward, used to rank rewards against each\n * other.\n *\n * - `fixed` → the token amount in the requested currency\n * - `tiered` → the highest token amount across tiers\n * - `percentage` → the capped (`maxAmount`) value when present, otherwise `0`\n * (an uncapped percentage has no comparable fiat value)\n */\nexport function getRewardValue(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n switch (reward.payoutType) {\n case \"fixed\":\n return reward.amount[key];\n case \"percentage\":\n return reward.maxAmount?.[key] ?? 0;\n case \"tiered\":\n return reward.tiers.reduce(\n (max, tier) =>\n \"amount\" in tier ? Math.max(max, tier.amount[key]) : max,\n 0\n );\n }\n}\n\n/**\n * Highest percent a reward exposes: the flat `percentage` percent, or the\n * richest percent across `tiered` tiers, or `0` when it carries none.\n *\n * Shared by {@link getRewardRank} (to weight a percentage-only reward) and\n * `formatEstimatedReward` (to render it as `\"X %\"`), so the value the UI ranks\n * by and the value it prints stay derived from one tier traversal.\n */\nexport function maxRewardPercent(reward: EstimatedReward): number {\n if (reward.payoutType === \"percentage\") return reward.percent;\n if (reward.payoutType === \"tiered\") {\n return reward.tiers.reduce(\n (max, tier) =>\n \"percent\" in tier ? Math.max(max, tier.percent) : max,\n 0\n );\n }\n return 0;\n}\n\n// A reward with no money value (an uncapped percentage, or a percent-only\n// tier set) still renders as \"X %\", so it is worth surfacing. We give it a\n// positive ranking weight derived from its percent but scaled far below any\n// real-money reward, so the two invariants the UI relies on hold: (1) a reward\n// with real money always outranks a percentage-only reward, and (2) a\n// percentage-only reward still outranks a zero-value reward. Together they\n// guarantee the reward the ranking picks is always one we can display.\nconst PERCENT_ONLY_RANK_WEIGHT = 1e-6;\n\n/**\n * Ranking weight used to pick the single most attractive reward to surface.\n *\n * Mirrors {@link getRewardValue} (money value) but lifts a percentage-only\n * reward to a tiny positive weight instead of `0`, so it is never buried\n * behind a zero-value reward when choosing what to display.\n */\nexport function getRewardRank(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n const value = getRewardValue(reward, key);\n if (value > 0) return value;\n return maxRewardPercent(reward) * PERCENT_ONLY_RANK_WEIGHT;\n}\n","import type { Currency, EstimatedReward } from \"../types\";\nimport { formatAmount } from \"../utils/format/formatAmount\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { getRewardRank, getRewardValue, maxRewardPercent } from \"./value\";\n\n/**\n * Format an {@link EstimatedReward} into a human-readable string.\n *\n * - `fixed` → e.g. `\"5 €\"`\n * - `percentage` → e.g. `\"10 %\"`\n * - `tiered` → the richest tier: max token amount (e.g. `\"50 €\"`) or, when\n * tiers only carry percentages, the max percent (e.g. `\"10 %\"`)\n *\n * Percentages are always rendered as a `\"X %\"` string: the backend never sends\n * a reference basket, so the reward cannot be resolved to a concrete amount\n * here. Callers that need a worked example use the `example` helpers instead.\n */\nexport function formatEstimatedReward(\n reward: EstimatedReward,\n currency?: Currency\n): string {\n const supportedCurrency = getSupportedCurrency(currency);\n const key = getCurrencyAmountKey(supportedCurrency);\n\n switch (reward.payoutType) {\n case \"fixed\":\n return formatAmount(\n Math.round(reward.amount[key]),\n supportedCurrency\n );\n\n case \"percentage\":\n return `${reward.percent} %`;\n\n case \"tiered\": {\n const maxAmount = getRewardValue(reward, key);\n if (maxAmount > 0) {\n return formatAmount(Math.round(maxAmount), supportedCurrency);\n }\n const maxPercent = maxRewardPercent(reward);\n if (maxPercent > 0) {\n return `${maxPercent} %`;\n }\n return formatAmount(0, supportedCurrency);\n }\n }\n}\n\n/**\n * Format a reward for display, or return `undefined` when it is not worth\n * advertising. Callers rely on `undefined` to hide a badge / fall back to\n * other copy.\n *\n * A reward is hidden only when it carries no displayable value — a `fixed` or\n * `tiered` reward whose money value is `0` (e.g. an unknown token price). An\n * uncapped percentage always renders as `\"X %\"`, since the percent itself is\n * meaningful even without a money value.\n */\nexport function formatRewardOrHide(\n reward: EstimatedReward | undefined,\n currency?: Currency\n): string | undefined {\n if (!reward) return undefined;\n const key = getCurrencyAmountKey(getSupportedCurrency(currency));\n if (getRewardRank(reward, key) <= 0) return undefined;\n return formatEstimatedReward(reward, currency);\n}\n\n/**\n * Replace the `{REWARD}` placeholder in a text string with a reward value.\n * If no reward is provided, returns the text with `{REWARD}` stripped.\n */\nexport function applyRewardPlaceholder(\n text: string,\n reward: string | undefined\n): string {\n return reward\n ? text.replaceAll(\"{REWARD}\", reward)\n : text.replaceAll(\"{REWARD}\", \"\");\n}\n","import type { InteractionTypeKey } from \"../constants/interactionTypes\";\nimport type {\n Currency,\n EstimatedReward,\n MerchantReward,\n TokenAmountType,\n} from \"../types\";\nimport { formatAmount } from \"../utils/format/formatAmount\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { extractMinPurchaseAmount, extractStartDate } from \"./conditions\";\nimport { formatRewardOrHide } from \"./format\";\nimport { getRewardRank } from \"./value\";\n\n/** Reward side a surface cares about: the sharer (`referrer`) or the referred\n * user (`referee`). Drives both campaign ranking and which side is displayed. */\nexport type RewardAudience = \"referrer\" | \"referee\";\n\nexport type DisplayCampaign = {\n campaign: MerchantReward;\n status: \"live\" | \"upcoming\";\n startsAt?: Date;\n};\n\nexport type SelectDisplayCampaignOptions = {\n /** Reference \"now\" for expiry / start gating; defaults to the current time. */\n now?: Date;\n /** Currency the ranking is expressed in; defaults to EUR. */\n currency?: Currency;\n /** When set, only campaigns triggered by this interaction are considered. */\n targetInteraction?: InteractionTypeKey;\n /** Reward side to rank campaigns by; defaults to `\"referrer\"`. */\n audience?: RewardAudience;\n};\n\nfunction isExpired(campaign: MerchantReward, nowMs: number): boolean {\n return (\n campaign.expiresAt != null &&\n new Date(campaign.expiresAt).getTime() <= nowMs\n );\n}\n\nfunction hasStarted(campaign: MerchantReward, nowMs: number): boolean {\n const startsAt = extractStartDate(campaign.conditions);\n return startsAt == null || startsAt.getTime() <= nowMs;\n}\n\nfunction audienceReward(campaign: MerchantReward, audience: RewardAudience) {\n return audience === \"referee\" ? campaign.referee : campaign.referrer;\n}\n\nfunction campaignRank(\n campaign: MerchantReward,\n key: keyof TokenAmountType,\n audience: RewardAudience\n): number {\n const reward = audienceReward(campaign, audience);\n return reward ? getRewardRank(reward, key) : 0;\n}\n\n/**\n * Pick the single campaign a merchant surface should display.\n *\n * Filters out expired (and, when `targetInteraction` is set, non-matching)\n * campaigns, then prefers the highest-ranked *live* campaign — ranked by the\n * `audience` reward side in the requested currency. When none has started yet\n * it falls back to the soonest-starting upcoming campaign (the endpoint does\n * not gate on the start-date condition, so future-start campaigns come\n * through).\n */\nexport function selectDisplayCampaign(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): DisplayCampaign | undefined {\n const nowMs = (options.now ?? new Date()).getTime();\n const audience = options.audience ?? \"referrer\";\n const key = getCurrencyAmountKey(getSupportedCurrency(options.currency));\n\n const matching = options.targetInteraction\n ? rewards.filter(\n (campaign) =>\n campaign.interactionTypeKey === options.targetInteraction\n )\n : rewards;\n const active = matching.filter((campaign) => !isExpired(campaign, nowMs));\n\n const live = active.filter((campaign) => hasStarted(campaign, nowMs));\n if (live.length > 0) {\n const best = live.reduce((a, b) =>\n campaignRank(b, key, audience) > campaignRank(a, key, audience)\n ? b\n : a\n );\n return { campaign: best, status: \"live\" };\n }\n\n const upcoming = active\n .map((campaign) => ({\n campaign,\n startsAt: extractStartDate(campaign.conditions),\n }))\n .filter(\n (entry): entry is { campaign: MerchantReward; startsAt: Date } =>\n entry.startsAt != null\n );\n if (upcoming.length === 0) return undefined;\n\n const soonest = upcoming.reduce((a, b) =>\n b.startsAt.getTime() < a.startsAt.getTime() ? b : a\n );\n return {\n campaign: soonest.campaign,\n status: \"upcoming\",\n startsAt: soonest.startsAt,\n };\n}\n\n/**\n * The single reward a merchant surface should display: its formatted string\n * plus the `payoutType` of the underlying reward, so surfaces can adapt their\n * presentation (e.g. hide percentage rewards, prefix tiered ones with \"Up to\").\n */\nexport type BestReward = {\n /** Display-ready reward string (e.g. `\"5 €\"`, `\"10 %\"`). */\n formatted: string;\n /** Payout type of the selected reward. */\n payoutType: EstimatedReward[\"payoutType\"];\n /**\n * Minimum purchase amount gating the reward, formatted with the requested\n * currency (e.g. `\"10 €\"`), or `undefined` when the campaign sets no\n * minimum.\n */\n minPurchaseAmount?: string;\n /**\n * Whole-day lockup applied before the reward settles, or `undefined` when\n * the campaign has no lockup.\n */\n lockupDurationDays?: number;\n};\n\n/**\n * Pick the best campaign for `options` and resolve its `audience`-side reward\n * to a formatted string plus its `payoutType`, or `undefined` when there is\n * nothing worth showing.\n *\n * Single entry point shared by every \"headline reward\" surface (share button,\n * wallet modal, sharing/install screens) so they all show the same number for\n * a given merchant and can branch on the payout type.\n */\nexport function selectBestReward(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): BestReward | undefined {\n const selected = selectDisplayCampaign(rewards, options);\n if (!selected) return undefined;\n const reward = audienceReward(\n selected.campaign,\n options.audience ?? \"referrer\"\n );\n if (!reward) return undefined;\n const formatted = formatRewardOrHide(reward, options.currency);\n if (!formatted) return undefined;\n\n const minPurchase = extractMinPurchaseAmount(selected.campaign.conditions);\n const minPurchaseAmount =\n minPurchase != null\n ? formatAmount(minPurchase, options.currency)\n : undefined;\n\n const lockupSeconds = selected.campaign.defaultLockupSeconds;\n const lockupDurationDays =\n lockupSeconds && lockupSeconds > 0\n ? Math.round(lockupSeconds / 86_400)\n : undefined;\n\n return {\n formatted,\n payoutType: reward.payoutType,\n minPurchaseAmount,\n lockupDurationDays,\n };\n}\n\n/**\n * Headline reward string for a merchant: picks the best campaign for `options`\n * and formats its `audience`-side reward, or returns `undefined` when there is\n * nothing worth showing.\n *\n * Thin wrapper over {@link selectBestReward} for callers that only need the\n * formatted string.\n */\nexport function formatBestReward(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): string | undefined {\n return selectBestReward(rewards, options)?.formatted;\n}\n"],"mappings":"0HAIA,SAAS,EAAe,EAA6C,CACjE,OAAO,MAAM,QAAQ,CAAU,EAAI,EAAa,EAAW,UAC/D,CAEA,SAAS,EACL,EACkB,CAClB,GAAI,OAAO,GAAU,SAAU,OAAO,EACtC,GAAI,OAAO,GAAU,UAAY,EAAM,KAAK,IAAM,GAAI,CAClD,IAAM,EAAS,OAAO,CAAK,EAC3B,OAAO,OAAO,SAAS,CAAM,EAAI,EAAS,IAAA,EAC9C,CAEJ,CAIA,SAAS,EACL,EACA,EACA,EACQ,CACR,IAAM,EAAmB,CAAC,EAC1B,IAAK,IAAM,KAAQ,EAAe,CAAU,EAAG,CAC3C,GAAI,UAAW,EAAM,CACjB,EAAO,KAAK,GAAG,EAAuB,EAAM,EAAO,CAAS,CAAC,EAC7D,QACJ,CACA,GAAI,EAAK,QAAU,GAAS,EAAU,IAAI,EAAK,QAAQ,EAAG,CACtD,IAAM,EAAQ,EAAuB,EAAK,KAAK,EAC3C,GAAS,MAAM,EAAO,KAAK,CAAK,CACxC,CACJ,CACA,OAAO,CACX,CAEA,MAAM,EAAiE,IAAI,IAAI,CAC3E,KACA,MACA,SACJ,CAAC,EACK,EAA+D,IAAI,IAAI,CACzE,KACA,KACJ,CAAC,EAED,SAAgB,EACZ,EACkB,CAClB,IAAM,EAAS,EACX,EACA,kBACA,CACJ,EACA,OAAO,EAAO,OAAS,EAAI,KAAK,IAAI,GAAG,CAAM,EAAI,IAAA,EACrD,CAIA,SAAgB,EAAiB,EAA8C,CAC3E,IAAM,EAAS,EACX,EACA,iBACA,CACJ,EACI,KAAO,SAAW,EACtB,OAAO,IAAI,KAAK,KAAK,IAAI,GAAG,CAAM,EAAI,GAAI,CAC9C,CC1DA,SAAS,EAAiB,EAAa,EAAqB,CACxD,IAAM,EAAU,KAAK,OAAO,EAAM,GAAO,EAAI,EAAE,EAAI,GACnD,OAAO,KAAK,IAAI,EAAK,KAAK,IAAI,EAAK,CAAO,CAAC,CAC/C,CAEA,SAAgB,EAAe,EAAyC,CACpE,OAAO,KAAK,IAAI,IAAkB,GAAe,CAAC,CACtD,CAKA,SAAgB,EACZ,EACA,EACM,CAKN,OAJI,GAAY,KAAa,EACzB,GAAY,KAAoB,KAAoB,EAC7C,IAEJ,EAAiB,EAAU,CAAQ,CAC9C,CAEA,SAAgB,EACZ,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,CAAW,EACzC,GAAI,GAAU,EAAG,OACjB,IAAI,EAAU,EAAO,QAAU,IAAO,EAGtC,OAFI,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACtE,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACnE,CAAE,SAAQ,OAAQ,CAAO,CACpC,CAEA,SAAgB,EACZ,EACA,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,EAAU,CAAQ,EAC5C,QAAU,GACd,MAAO,CAAE,SAAQ,OAAS,EAAU,IAAO,CAAO,CACtD,CC7CA,SAAgB,EACZ,EACA,EACM,CACN,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAO,EAAO,OAAO,GACzB,IAAK,aACD,OAAO,EAAO,YAAY,IAAQ,EACtC,IAAK,SACD,OAAO,EAAO,MAAM,QACf,EAAK,IACF,WAAY,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EAAI,EACzD,CACJ,CACR,CACJ,CAUA,SAAgB,EAAiB,EAAiC,CAS9D,OARI,EAAO,aAAe,aAAqB,EAAO,QAClD,EAAO,aAAe,SACf,EAAO,MAAM,QACf,EAAK,IACF,YAAa,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EACtD,CACJ,EAEG,CACX,CAkBA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAQ,EAAe,EAAQ,CAAG,EAExC,OADI,EAAQ,EAAU,EACf,EAAiB,CAAM,EAAI,IACtC,CCtDA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAoBA,EAAAA,EAAqB,CAAQ,EACjD,EAAMC,EAAAA,EAAqB,CAAiB,EAElD,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAOC,EAAAA,EACH,KAAK,MAAM,EAAO,OAAO,EAAI,EAC7B,CACJ,EAEJ,IAAK,aACD,MAAO,GAAG,EAAO,QAAQ,IAE7B,IAAK,SAAU,CACX,IAAM,EAAY,EAAe,EAAQ,CAAG,EAC5C,GAAI,EAAY,EACZ,OAAOA,EAAAA,EAAa,KAAK,MAAM,CAAS,EAAG,CAAiB,EAEhE,IAAM,EAAa,EAAiB,CAAM,EAI1C,OAHI,EAAa,EACN,GAAG,EAAW,IAElBA,EAAAA,EAAa,EAAG,CAAiB,CAC5C,CACJ,CACJ,CAYA,SAAgB,EACZ,EACA,EACkB,CACb,MAED,IAAc,EADND,EAAAA,EAAqBD,EAAAA,EAAqB,CAAQ,CAClC,CAAC,GAAK,GAClC,OAAO,EAAsB,EAAQ,CAAQ,CACjD,CAMA,SAAgB,EACZ,EACA,EACM,CACN,OAAO,EACD,EAAK,WAAW,WAAY,CAAM,EAClC,EAAK,WAAW,WAAY,EAAE,CACxC,CC7CA,SAAS,EAAU,EAA0B,EAAwB,CACjE,OACI,EAAS,WAAa,MACtB,IAAI,KAAK,EAAS,SAAS,EAAE,QAAQ,GAAK,CAElD,CAEA,SAAS,EAAW,EAA0B,EAAwB,CAClE,IAAM,EAAW,EAAiB,EAAS,UAAU,EACrD,OAAO,GAAY,MAAQ,EAAS,QAAQ,GAAK,CACrD,CAEA,SAAS,EAAe,EAA0B,EAA0B,CACxE,OAAO,IAAa,UAAY,EAAS,QAAU,EAAS,QAChE,CAEA,SAAS,EACL,EACA,EACA,EACM,CACN,IAAM,EAAS,EAAe,EAAU,CAAQ,EAChD,OAAO,EAAS,EAAc,EAAQ,CAAG,EAAI,CACjD,CAYA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACd,CAC3B,IAAM,GAAS,EAAQ,KAAO,IAAI,MAAQ,QAAQ,EAC5C,EAAW,EAAQ,UAAY,WAC/B,EAAMG,EAAAA,EAAqBC,EAAAA,EAAqB,EAAQ,QAAQ,CAAC,EAQjE,GANW,EAAQ,kBACnB,EAAQ,OACH,GACG,EAAS,qBAAuB,EAAQ,iBAChD,EACA,GACkB,OAAQ,GAAa,CAAC,EAAU,EAAU,CAAK,CAAC,EAElE,EAAO,EAAO,OAAQ,GAAa,EAAW,EAAU,CAAK,CAAC,EACpE,GAAI,EAAK,OAAS,EAMd,MAAO,CAAE,SALI,EAAK,QAAQ,EAAG,IACzB,EAAa,EAAG,EAAK,CAAQ,EAAI,EAAa,EAAG,EAAK,CAAQ,EACxD,EACA,CAEY,EAAG,OAAQ,MAAO,EAG5C,IAAM,EAAW,EACZ,IAAK,IAAc,CAChB,WACA,SAAU,EAAiB,EAAS,UAAU,CAClD,EAAE,EACD,OACI,GACG,EAAM,UAAY,IAC1B,EACJ,GAAI,EAAS,SAAW,EAAG,OAE3B,IAAM,EAAU,EAAS,QAAQ,EAAG,IAChC,EAAE,SAAS,QAAQ,EAAI,EAAE,SAAS,QAAQ,EAAI,EAAI,CACtD,EACA,MAAO,CACH,SAAU,EAAQ,SAClB,OAAQ,WACR,SAAU,EAAQ,QACtB,CACJ,CAkCA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACnB,CACtB,IAAM,EAAW,EAAsB,EAAS,CAAO,EACvD,GAAI,CAAC,EAAU,OACf,IAAM,EAAS,EACX,EAAS,SACT,EAAQ,UAAY,UACxB,EACA,GAAI,CAAC,EAAQ,OACb,IAAM,EAAY,EAAmB,EAAQ,EAAQ,QAAQ,EAC7D,GAAI,CAAC,EAAW,OAEhB,IAAM,EAAc,EAAyB,EAAS,SAAS,UAAU,EACnE,EACF,GAAe,KAET,IAAA,GADAC,EAAAA,EAAa,EAAa,EAAQ,QAAQ,EAG9C,EAAgB,EAAS,SAAS,qBAClC,EACF,GAAiB,EAAgB,EAC3B,KAAK,MAAM,EAAgB,KAAM,EACjC,IAAA,GAEV,MAAO,CACH,YACA,WAAY,EAAO,WACnB,oBACA,oBACJ,CACJ,CAUA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACvB,CAClB,OAAO,EAAiB,EAAS,CAAO,GAAG,SAC/C"}
|
package/dist/rewards.d.cts
CHANGED
|
@@ -75,13 +75,42 @@ type SelectDisplayCampaignOptions = {
|
|
|
75
75
|
*/
|
|
76
76
|
declare function selectDisplayCampaign(rewards: readonly MerchantReward[], options?: SelectDisplayCampaignOptions): DisplayCampaign | undefined;
|
|
77
77
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
78
|
+
* The single reward a merchant surface should display: its formatted string
|
|
79
|
+
* plus the `payoutType` of the underlying reward, so surfaces can adapt their
|
|
80
|
+
* presentation (e.g. hide percentage rewards, prefix tiered ones with "Up to").
|
|
81
|
+
*/
|
|
82
|
+
type BestReward = {
|
|
83
|
+
/** Display-ready reward string (e.g. `"5 €"`, `"10 %"`). */formatted: string; /** Payout type of the selected reward. */
|
|
84
|
+
payoutType: EstimatedReward["payoutType"];
|
|
85
|
+
/**
|
|
86
|
+
* Minimum purchase amount gating the reward, formatted with the requested
|
|
87
|
+
* currency (e.g. `"10 €"`), or `undefined` when the campaign sets no
|
|
88
|
+
* minimum.
|
|
89
|
+
*/
|
|
90
|
+
minPurchaseAmount?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Whole-day lockup applied before the reward settles, or `undefined` when
|
|
93
|
+
* the campaign has no lockup.
|
|
94
|
+
*/
|
|
95
|
+
lockupDurationDays?: number;
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* Pick the best campaign for `options` and resolve its `audience`-side reward
|
|
99
|
+
* to a formatted string plus its `payoutType`, or `undefined` when there is
|
|
80
100
|
* nothing worth showing.
|
|
81
101
|
*
|
|
82
102
|
* Single entry point shared by every "headline reward" surface (share button,
|
|
83
103
|
* wallet modal, sharing/install screens) so they all show the same number for
|
|
84
|
-
* a given merchant.
|
|
104
|
+
* a given merchant and can branch on the payout type.
|
|
105
|
+
*/
|
|
106
|
+
declare function selectBestReward(rewards: readonly MerchantReward[], options?: SelectDisplayCampaignOptions): BestReward | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* Headline reward string for a merchant: picks the best campaign for `options`
|
|
109
|
+
* and formats its `audience`-side reward, or returns `undefined` when there is
|
|
110
|
+
* nothing worth showing.
|
|
111
|
+
*
|
|
112
|
+
* Thin wrapper over {@link selectBestReward} for callers that only need the
|
|
113
|
+
* formatted string.
|
|
85
114
|
*/
|
|
86
115
|
declare function formatBestReward(rewards: readonly MerchantReward[], options?: SelectDisplayCampaignOptions): string | undefined;
|
|
87
116
|
//#endregion
|
|
@@ -97,5 +126,5 @@ declare function formatBestReward(rewards: readonly MerchantReward[], options?:
|
|
|
97
126
|
*/
|
|
98
127
|
declare function getRewardValue(reward: EstimatedReward, key: keyof TokenAmountType): number;
|
|
99
128
|
//#endregion
|
|
100
|
-
export { type DisplayCampaign, type RewardAudience, type RewardExample, type SelectDisplayCampaignOptions, applyRewardPlaceholder, buildPercentageExample, buildTierExample, extractMinPurchaseAmount, extractStartDate, formatBestReward, formatEstimatedReward, formatRewardOrHide, getRewardValue, pickFlatBasket, pickTierBasket, selectDisplayCampaign };
|
|
129
|
+
export { type BestReward, type DisplayCampaign, type RewardAudience, type RewardExample, type SelectDisplayCampaignOptions, applyRewardPlaceholder, buildPercentageExample, buildTierExample, extractMinPurchaseAmount, extractStartDate, formatBestReward, formatEstimatedReward, formatRewardOrHide, getRewardValue, pickFlatBasket, pickTierBasket, selectBestReward, selectDisplayCampaign };
|
|
101
130
|
//# sourceMappingURL=rewards.d.cts.map
|
package/dist/rewards.d.ts
CHANGED
|
@@ -75,13 +75,42 @@ type SelectDisplayCampaignOptions = {
|
|
|
75
75
|
*/
|
|
76
76
|
declare function selectDisplayCampaign(rewards: readonly MerchantReward[], options?: SelectDisplayCampaignOptions): DisplayCampaign | undefined;
|
|
77
77
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
78
|
+
* The single reward a merchant surface should display: its formatted string
|
|
79
|
+
* plus the `payoutType` of the underlying reward, so surfaces can adapt their
|
|
80
|
+
* presentation (e.g. hide percentage rewards, prefix tiered ones with "Up to").
|
|
81
|
+
*/
|
|
82
|
+
type BestReward = {
|
|
83
|
+
/** Display-ready reward string (e.g. `"5 €"`, `"10 %"`). */formatted: string; /** Payout type of the selected reward. */
|
|
84
|
+
payoutType: EstimatedReward["payoutType"];
|
|
85
|
+
/**
|
|
86
|
+
* Minimum purchase amount gating the reward, formatted with the requested
|
|
87
|
+
* currency (e.g. `"10 €"`), or `undefined` when the campaign sets no
|
|
88
|
+
* minimum.
|
|
89
|
+
*/
|
|
90
|
+
minPurchaseAmount?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Whole-day lockup applied before the reward settles, or `undefined` when
|
|
93
|
+
* the campaign has no lockup.
|
|
94
|
+
*/
|
|
95
|
+
lockupDurationDays?: number;
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* Pick the best campaign for `options` and resolve its `audience`-side reward
|
|
99
|
+
* to a formatted string plus its `payoutType`, or `undefined` when there is
|
|
80
100
|
* nothing worth showing.
|
|
81
101
|
*
|
|
82
102
|
* Single entry point shared by every "headline reward" surface (share button,
|
|
83
103
|
* wallet modal, sharing/install screens) so they all show the same number for
|
|
84
|
-
* a given merchant.
|
|
104
|
+
* a given merchant and can branch on the payout type.
|
|
105
|
+
*/
|
|
106
|
+
declare function selectBestReward(rewards: readonly MerchantReward[], options?: SelectDisplayCampaignOptions): BestReward | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* Headline reward string for a merchant: picks the best campaign for `options`
|
|
109
|
+
* and formats its `audience`-side reward, or returns `undefined` when there is
|
|
110
|
+
* nothing worth showing.
|
|
111
|
+
*
|
|
112
|
+
* Thin wrapper over {@link selectBestReward} for callers that only need the
|
|
113
|
+
* formatted string.
|
|
85
114
|
*/
|
|
86
115
|
declare function formatBestReward(rewards: readonly MerchantReward[], options?: SelectDisplayCampaignOptions): string | undefined;
|
|
87
116
|
//#endregion
|
|
@@ -97,5 +126,5 @@ declare function formatBestReward(rewards: readonly MerchantReward[], options?:
|
|
|
97
126
|
*/
|
|
98
127
|
declare function getRewardValue(reward: EstimatedReward, key: keyof TokenAmountType): number;
|
|
99
128
|
//#endregion
|
|
100
|
-
export { type DisplayCampaign, type RewardAudience, type RewardExample, type SelectDisplayCampaignOptions, applyRewardPlaceholder, buildPercentageExample, buildTierExample, extractMinPurchaseAmount, extractStartDate, formatBestReward, formatEstimatedReward, formatRewardOrHide, getRewardValue, pickFlatBasket, pickTierBasket, selectDisplayCampaign };
|
|
129
|
+
export { type BestReward, type DisplayCampaign, type RewardAudience, type RewardExample, type SelectDisplayCampaignOptions, applyRewardPlaceholder, buildPercentageExample, buildTierExample, extractMinPurchaseAmount, extractStartDate, formatBestReward, formatEstimatedReward, formatRewardOrHide, getRewardValue, pickFlatBasket, pickTierBasket, selectBestReward, selectDisplayCampaign };
|
|
101
130
|
//# sourceMappingURL=rewards.d.ts.map
|
package/dist/rewards.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{n as e,r as t,t as n}from"./getCurrencyAmountKey-DQcwjJiB.js";function r(e){return Array.isArray(e)?e:e.conditions}function i(e){if(typeof e==`number`)return e;if(typeof e==`string`&&e.trim()!==``){let t=Number(e);return Number.isFinite(t)?t:void 0}}function a(e,t,n){let o=[];for(let s of r(e)){if(`logic`in s){o.push(...a(s,t,n));continue}if(s.field===t&&n.has(s.operator)){let e=i(s.value);e!=null&&o.push(e)}}return o}const o=new Set([`gt`,`gte`,`between`]),s=new Set([`gt`,`gte`]);function c(e){let t=a(e,`purchase.amount`,o);return t.length>0?Math.min(...t):void 0}function l(e){let t=a(e,`time.timestamp`,s);if(t.length!==0)return new Date(Math.min(...t)*1e3)}function u(e,t){let n=Math.round((e+t)/2/10)*10;return Math.min(t,Math.max(e,n))}function d(e){return Math.max(100,e??0)}function f(e,t){return t==null?e:e<=100&&100<=t?100:u(e,t)}function p(e,t){let n=d(t);if(n<=0)return;let r=e.percent/100*n;return e.minAmount&&(r=Math.max(r,e.minAmount.eurAmount)),e.maxAmount&&(r=Math.min(r,e.maxAmount.eurAmount)),{basket:n,reward:r}}function m(e,t,n){let r=f(t,n);if(!(r<=0))return{basket:r,reward:e/100*r}}function h(e,t){switch(e.payoutType){case`fixed`:return e.amount[t];case`percentage`:return e.maxAmount?.[t]??0;case`tiered`:return e.tiers.reduce((e,n)=>`amount`in n?Math.max(e,n.amount[t]):e,0)}}function g(e){return e.payoutType===`percentage`?e.percent:e.payoutType===`tiered`?e.tiers.reduce((e,t)=>`percent`in t?Math.max(e,t.percent):e,0):0}function _(e,t){let n=h(e,t);return n>0?n:g(e)*1e-6}function v(r,i){let a=t(i),o=n(a);switch(r.payoutType){case`fixed`:return e(Math.round(r.amount[o]),a);case`percentage`:return`${r.percent} %`;case`tiered`:{let t=h(r,o);if(t>0)return e(Math.round(t),a);let n=g(r);return n>0?`${n} %`:e(0,a)}}}function y(e,r){if(e&&!(_(e,n(t(r)))<=0))return v(e,r)}function b(e,t){return t?e.
|
|
1
|
+
import{n as e,r as t,t as n}from"./getCurrencyAmountKey-DQcwjJiB.js";function r(e){return Array.isArray(e)?e:e.conditions}function i(e){if(typeof e==`number`)return e;if(typeof e==`string`&&e.trim()!==``){let t=Number(e);return Number.isFinite(t)?t:void 0}}function a(e,t,n){let o=[];for(let s of r(e)){if(`logic`in s){o.push(...a(s,t,n));continue}if(s.field===t&&n.has(s.operator)){let e=i(s.value);e!=null&&o.push(e)}}return o}const o=new Set([`gt`,`gte`,`between`]),s=new Set([`gt`,`gte`]);function c(e){let t=a(e,`purchase.amount`,o);return t.length>0?Math.min(...t):void 0}function l(e){let t=a(e,`time.timestamp`,s);if(t.length!==0)return new Date(Math.min(...t)*1e3)}function u(e,t){let n=Math.round((e+t)/2/10)*10;return Math.min(t,Math.max(e,n))}function d(e){return Math.max(100,e??0)}function f(e,t){return t==null?e:e<=100&&100<=t?100:u(e,t)}function p(e,t){let n=d(t);if(n<=0)return;let r=e.percent/100*n;return e.minAmount&&(r=Math.max(r,e.minAmount.eurAmount)),e.maxAmount&&(r=Math.min(r,e.maxAmount.eurAmount)),{basket:n,reward:r}}function m(e,t,n){let r=f(t,n);if(!(r<=0))return{basket:r,reward:e/100*r}}function h(e,t){switch(e.payoutType){case`fixed`:return e.amount[t];case`percentage`:return e.maxAmount?.[t]??0;case`tiered`:return e.tiers.reduce((e,n)=>`amount`in n?Math.max(e,n.amount[t]):e,0)}}function g(e){return e.payoutType===`percentage`?e.percent:e.payoutType===`tiered`?e.tiers.reduce((e,t)=>`percent`in t?Math.max(e,t.percent):e,0):0}function _(e,t){let n=h(e,t);return n>0?n:g(e)*1e-6}function v(r,i){let a=t(i),o=n(a);switch(r.payoutType){case`fixed`:return e(Math.round(r.amount[o]),a);case`percentage`:return`${r.percent} %`;case`tiered`:{let t=h(r,o);if(t>0)return e(Math.round(t),a);let n=g(r);return n>0?`${n} %`:e(0,a)}}}function y(e,r){if(e&&!(_(e,n(t(r)))<=0))return v(e,r)}function b(e,t){return t?e.replaceAll(`{REWARD}`,t):e.replaceAll(`{REWARD}`,``)}function x(e,t){return e.expiresAt!=null&&new Date(e.expiresAt).getTime()<=t}function S(e,t){let n=l(e.conditions);return n==null||n.getTime()<=t}function C(e,t){return t===`referee`?e.referee:e.referrer}function w(e,t,n){let r=C(e,n);return r?_(r,t):0}function T(e,r={}){let i=(r.now??new Date).getTime(),a=r.audience??`referrer`,o=n(t(r.currency)),s=(r.targetInteraction?e.filter(e=>e.interactionTypeKey===r.targetInteraction):e).filter(e=>!x(e,i)),c=s.filter(e=>S(e,i));if(c.length>0)return{campaign:c.reduce((e,t)=>w(t,o,a)>w(e,o,a)?t:e),status:`live`};let u=s.map(e=>({campaign:e,startsAt:l(e.conditions)})).filter(e=>e.startsAt!=null);if(u.length===0)return;let d=u.reduce((e,t)=>t.startsAt.getTime()<e.startsAt.getTime()?t:e);return{campaign:d.campaign,status:`upcoming`,startsAt:d.startsAt}}function E(t,n={}){let r=T(t,n);if(!r)return;let i=C(r.campaign,n.audience??`referrer`);if(!i)return;let a=y(i,n.currency);if(!a)return;let o=c(r.campaign.conditions),s=o==null?void 0:e(o,n.currency),l=r.campaign.defaultLockupSeconds,u=l&&l>0?Math.round(l/86400):void 0;return{formatted:a,payoutType:i.payoutType,minPurchaseAmount:s,lockupDurationDays:u}}function D(e,t={}){return E(e,t)?.formatted}export{b as applyRewardPlaceholder,p as buildPercentageExample,m as buildTierExample,c as extractMinPurchaseAmount,l as extractStartDate,D as formatBestReward,v as formatEstimatedReward,y as formatRewardOrHide,h as getRewardValue,d as pickFlatBasket,f as pickTierBasket,E as selectBestReward,T as selectDisplayCampaign};
|
|
2
2
|
//# sourceMappingURL=rewards.js.map
|
package/dist/rewards.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rewards.js","names":[],"sources":["../src/rewards/conditions.ts","../src/rewards/example.ts","../src/rewards/value.ts","../src/rewards/format.ts","../src/rewards/select.ts"],"sourcesContent":["import type { ConditionGroup, RuleCondition, RuleConditions } from \"../types\";\n\ntype ConditionNode = RuleCondition | ConditionGroup;\n\nfunction conditionNodes(conditions: RuleConditions): ConditionNode[] {\n return Array.isArray(conditions) ? conditions : conditions.conditions;\n}\n\nfunction conditionValueToNumber(\n value: RuleCondition[\"value\"]\n): number | undefined {\n if (typeof value === \"number\") return value;\n if (typeof value === \"string\" && value.trim() !== \"\") {\n const parsed = Number(value);\n return Number.isFinite(parsed) ? parsed : undefined;\n }\n return undefined;\n}\n\n// Conditions arrive as a flat list or recursive groups; collect every numeric\n// value whose field + operator match, descending into nested groups.\nfunction collectConditionValues(\n conditions: RuleConditions,\n field: string,\n operators: ReadonlySet<RuleCondition[\"operator\"]>\n): number[] {\n const values: number[] = [];\n for (const node of conditionNodes(conditions)) {\n if (\"logic\" in node) {\n values.push(...collectConditionValues(node, field, operators));\n continue;\n }\n if (node.field === field && operators.has(node.operator)) {\n const value = conditionValueToNumber(node.value);\n if (value != null) values.push(value);\n }\n }\n return values;\n}\n\nconst MIN_PURCHASE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n \"between\",\n]);\nconst START_DATE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n]);\n\nexport function extractMinPurchaseAmount(\n conditions: RuleConditions\n): number | undefined {\n const values = collectConditionValues(\n conditions,\n \"purchase.amount\",\n MIN_PURCHASE_OPERATORS\n );\n return values.length > 0 ? Math.min(...values) : undefined;\n}\n\n// The business app encodes a campaign start as a `time.timestamp >= <unix s>`\n// rule condition; the endpoint returns it verbatim inside `conditions`.\nexport function extractStartDate(conditions: RuleConditions): Date | undefined {\n const values = collectConditionValues(\n conditions,\n \"time.timestamp\",\n START_DATE_OPERATORS\n );\n if (values.length === 0) return undefined;\n return new Date(Math.min(...values) * 1000);\n}\n","import type { EstimatedReward } from \"../types\";\n\ntype PercentageReward = Extract<EstimatedReward, { payoutType: \"percentage\" }>;\n\n// Reference order total used to turn a \"% of basket\" reward into a concrete\n// example amount. The campaign's minimum purchase overrides it when higher.\nconst REFERENCE_BASKET = 100;\n\nexport type RewardExample = {\n basket: number;\n reward: number;\n};\n\nfunction roundWithinRange(min: number, max: number): number {\n const rounded = Math.round((min + max) / 2 / 10) * 10;\n return Math.min(max, Math.max(min, rounded));\n}\n\nexport function pickFlatBasket(minPurchase: number | undefined): number {\n return Math.max(REFERENCE_BASKET, minPurchase ?? 0);\n}\n\n// Basket for a percentage tier: the reference when it sits inside the tier\n// range, a round number within the range otherwise, or the lower bound for an\n// open-ended (uncapped) top tier.\nexport function pickTierBasket(\n minValue: number,\n maxValue: number | undefined\n): number {\n if (maxValue == null) return minValue;\n if (minValue <= REFERENCE_BASKET && REFERENCE_BASKET <= maxValue) {\n return REFERENCE_BASKET;\n }\n return roundWithinRange(minValue, maxValue);\n}\n\nexport function buildPercentageExample(\n reward: PercentageReward,\n minPurchase: number | undefined\n): RewardExample | undefined {\n const basket = pickFlatBasket(minPurchase);\n if (basket <= 0) return undefined;\n let amount = (reward.percent / 100) * basket;\n if (reward.minAmount) amount = Math.max(amount, reward.minAmount.eurAmount);\n if (reward.maxAmount) amount = Math.min(amount, reward.maxAmount.eurAmount);\n return { basket, reward: amount };\n}\n\nexport function buildTierExample(\n percent: number,\n minValue: number,\n maxValue: number | undefined\n): RewardExample | undefined {\n const basket = pickTierBasket(minValue, maxValue);\n if (basket <= 0) return undefined;\n return { basket, reward: (percent / 100) * basket };\n}\n","import type { EstimatedReward, TokenAmountType } from \"../types\";\n\n/**\n * Comparable fiat value of a single reward, used to rank rewards against each\n * other.\n *\n * - `fixed` → the token amount in the requested currency\n * - `tiered` → the highest token amount across tiers\n * - `percentage` → the capped (`maxAmount`) value when present, otherwise `0`\n * (an uncapped percentage has no comparable fiat value)\n */\nexport function getRewardValue(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n switch (reward.payoutType) {\n case \"fixed\":\n return reward.amount[key];\n case \"percentage\":\n return reward.maxAmount?.[key] ?? 0;\n case \"tiered\":\n return reward.tiers.reduce(\n (max, tier) =>\n \"amount\" in tier ? Math.max(max, tier.amount[key]) : max,\n 0\n );\n }\n}\n\n/**\n * Highest percent a reward exposes: the flat `percentage` percent, or the\n * richest percent across `tiered` tiers, or `0` when it carries none.\n *\n * Shared by {@link getRewardRank} (to weight a percentage-only reward) and\n * `formatEstimatedReward` (to render it as `\"X %\"`), so the value the UI ranks\n * by and the value it prints stay derived from one tier traversal.\n */\nexport function maxRewardPercent(reward: EstimatedReward): number {\n if (reward.payoutType === \"percentage\") return reward.percent;\n if (reward.payoutType === \"tiered\") {\n return reward.tiers.reduce(\n (max, tier) =>\n \"percent\" in tier ? Math.max(max, tier.percent) : max,\n 0\n );\n }\n return 0;\n}\n\n// A reward with no money value (an uncapped percentage, or a percent-only\n// tier set) still renders as \"X %\", so it is worth surfacing. We give it a\n// positive ranking weight derived from its percent but scaled far below any\n// real-money reward, so the two invariants the UI relies on hold: (1) a reward\n// with real money always outranks a percentage-only reward, and (2) a\n// percentage-only reward still outranks a zero-value reward. Together they\n// guarantee the reward the ranking picks is always one we can display.\nconst PERCENT_ONLY_RANK_WEIGHT = 1e-6;\n\n/**\n * Ranking weight used to pick the single most attractive reward to surface.\n *\n * Mirrors {@link getRewardValue} (money value) but lifts a percentage-only\n * reward to a tiny positive weight instead of `0`, so it is never buried\n * behind a zero-value reward when choosing what to display.\n */\nexport function getRewardRank(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n const value = getRewardValue(reward, key);\n if (value > 0) return value;\n return maxRewardPercent(reward) * PERCENT_ONLY_RANK_WEIGHT;\n}\n","import type { Currency, EstimatedReward } from \"../types\";\nimport { formatAmount } from \"../utils/format/formatAmount\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { getRewardRank, getRewardValue, maxRewardPercent } from \"./value\";\n\n/**\n * Format an {@link EstimatedReward} into a human-readable string.\n *\n * - `fixed` → e.g. `\"5 €\"`\n * - `percentage` → e.g. `\"10 %\"`\n * - `tiered` → the richest tier: max token amount (e.g. `\"50 €\"`) or, when\n * tiers only carry percentages, the max percent (e.g. `\"10 %\"`)\n *\n * Percentages are always rendered as a `\"X %\"` string: the backend never sends\n * a reference basket, so the reward cannot be resolved to a concrete amount\n * here. Callers that need a worked example use the `example` helpers instead.\n */\nexport function formatEstimatedReward(\n reward: EstimatedReward,\n currency?: Currency\n): string {\n const supportedCurrency = getSupportedCurrency(currency);\n const key = getCurrencyAmountKey(supportedCurrency);\n\n switch (reward.payoutType) {\n case \"fixed\":\n return formatAmount(\n Math.round(reward.amount[key]),\n supportedCurrency\n );\n\n case \"percentage\":\n return `${reward.percent} %`;\n\n case \"tiered\": {\n const maxAmount = getRewardValue(reward, key);\n if (maxAmount > 0) {\n return formatAmount(Math.round(maxAmount), supportedCurrency);\n }\n const maxPercent = maxRewardPercent(reward);\n if (maxPercent > 0) {\n return `${maxPercent} %`;\n }\n return formatAmount(0, supportedCurrency);\n }\n }\n}\n\n/**\n * Format a reward for display, or return `undefined` when it is not worth\n * advertising. Callers rely on `undefined` to hide a badge / fall back to\n * other copy.\n *\n * A reward is hidden only when it carries no displayable value — a `fixed` or\n * `tiered` reward whose money value is `0` (e.g. an unknown token price). An\n * uncapped percentage always renders as `\"X %\"`, since the percent itself is\n * meaningful even without a money value.\n */\nexport function formatRewardOrHide(\n reward: EstimatedReward | undefined,\n currency?: Currency\n): string | undefined {\n if (!reward) return undefined;\n const key = getCurrencyAmountKey(getSupportedCurrency(currency));\n if (getRewardRank(reward, key) <= 0) return undefined;\n return formatEstimatedReward(reward, currency);\n}\n\n/**\n * Replace the `{REWARD}` placeholder in a text string with a reward value.\n * If no reward is provided, returns the text with `{REWARD}` stripped.\n */\nexport function applyRewardPlaceholder(\n text: string,\n reward: string | undefined\n): string {\n return reward\n ? text.replace(\"{REWARD}\", reward)\n : text.replace(\"{REWARD}\", \"\");\n}\n","import type { InteractionTypeKey } from \"../constants/interactionTypes\";\nimport type { Currency, MerchantReward, TokenAmountType } from \"../types\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { extractStartDate } from \"./conditions\";\nimport { formatRewardOrHide } from \"./format\";\nimport { getRewardRank } from \"./value\";\n\n/** Reward side a surface cares about: the sharer (`referrer`) or the referred\n * user (`referee`). Drives both campaign ranking and which side is displayed. */\nexport type RewardAudience = \"referrer\" | \"referee\";\n\nexport type DisplayCampaign = {\n campaign: MerchantReward;\n status: \"live\" | \"upcoming\";\n startsAt?: Date;\n};\n\nexport type SelectDisplayCampaignOptions = {\n /** Reference \"now\" for expiry / start gating; defaults to the current time. */\n now?: Date;\n /** Currency the ranking is expressed in; defaults to EUR. */\n currency?: Currency;\n /** When set, only campaigns triggered by this interaction are considered. */\n targetInteraction?: InteractionTypeKey;\n /** Reward side to rank campaigns by; defaults to `\"referrer\"`. */\n audience?: RewardAudience;\n};\n\nfunction isExpired(campaign: MerchantReward, nowMs: number): boolean {\n return (\n campaign.expiresAt != null &&\n new Date(campaign.expiresAt).getTime() <= nowMs\n );\n}\n\nfunction hasStarted(campaign: MerchantReward, nowMs: number): boolean {\n const startsAt = extractStartDate(campaign.conditions);\n return startsAt == null || startsAt.getTime() <= nowMs;\n}\n\nfunction audienceReward(campaign: MerchantReward, audience: RewardAudience) {\n return audience === \"referee\" ? campaign.referee : campaign.referrer;\n}\n\nfunction campaignRank(\n campaign: MerchantReward,\n key: keyof TokenAmountType,\n audience: RewardAudience\n): number {\n const reward = audienceReward(campaign, audience);\n return reward ? getRewardRank(reward, key) : 0;\n}\n\n/**\n * Pick the single campaign a merchant surface should display.\n *\n * Filters out expired (and, when `targetInteraction` is set, non-matching)\n * campaigns, then prefers the highest-ranked *live* campaign — ranked by the\n * `audience` reward side in the requested currency. When none has started yet\n * it falls back to the soonest-starting upcoming campaign (the endpoint does\n * not gate on the start-date condition, so future-start campaigns come\n * through).\n */\nexport function selectDisplayCampaign(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): DisplayCampaign | undefined {\n const nowMs = (options.now ?? new Date()).getTime();\n const audience = options.audience ?? \"referrer\";\n const key = getCurrencyAmountKey(getSupportedCurrency(options.currency));\n\n const matching = options.targetInteraction\n ? rewards.filter(\n (campaign) =>\n campaign.interactionTypeKey === options.targetInteraction\n )\n : rewards;\n const active = matching.filter((campaign) => !isExpired(campaign, nowMs));\n\n const live = active.filter((campaign) => hasStarted(campaign, nowMs));\n if (live.length > 0) {\n const best = live.reduce((a, b) =>\n campaignRank(b, key, audience) > campaignRank(a, key, audience)\n ? b\n : a\n );\n return { campaign: best, status: \"live\" };\n }\n\n const upcoming = active\n .map((campaign) => ({\n campaign,\n startsAt: extractStartDate(campaign.conditions),\n }))\n .filter(\n (entry): entry is { campaign: MerchantReward; startsAt: Date } =>\n entry.startsAt != null\n );\n if (upcoming.length === 0) return undefined;\n\n const soonest = upcoming.reduce((a, b) =>\n b.startsAt.getTime() < a.startsAt.getTime() ? b : a\n );\n return {\n campaign: soonest.campaign,\n status: \"upcoming\",\n startsAt: soonest.startsAt,\n };\n}\n\n/**\n * Headline reward string for a merchant: picks the best campaign for `options`\n * and formats its `audience`-side reward, or returns `undefined` when there is\n * nothing worth showing.\n *\n * Single entry point shared by every \"headline reward\" surface (share button,\n * wallet modal, sharing/install screens) so they all show the same number for\n * a given merchant.\n */\nexport function formatBestReward(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): string | undefined {\n const selected = selectDisplayCampaign(rewards, options);\n if (!selected) return undefined;\n const reward = audienceReward(\n selected.campaign,\n options.audience ?? \"referrer\"\n );\n return formatRewardOrHide(reward, options.currency);\n}\n"],"mappings":"qEAIA,SAAS,EAAe,EAA6C,CACjE,OAAO,MAAM,QAAQ,CAAU,EAAI,EAAa,EAAW,UAC/D,CAEA,SAAS,EACL,EACkB,CAClB,GAAI,OAAO,GAAU,SAAU,OAAO,EACtC,GAAI,OAAO,GAAU,UAAY,EAAM,KAAK,IAAM,GAAI,CAClD,IAAM,EAAS,OAAO,CAAK,EAC3B,OAAO,OAAO,SAAS,CAAM,EAAI,EAAS,IAAA,EAC9C,CAEJ,CAIA,SAAS,EACL,EACA,EACA,EACQ,CACR,IAAM,EAAmB,CAAC,EAC1B,IAAK,IAAM,KAAQ,EAAe,CAAU,EAAG,CAC3C,GAAI,UAAW,EAAM,CACjB,EAAO,KAAK,GAAG,EAAuB,EAAM,EAAO,CAAS,CAAC,EAC7D,QACJ,CACA,GAAI,EAAK,QAAU,GAAS,EAAU,IAAI,EAAK,QAAQ,EAAG,CACtD,IAAM,EAAQ,EAAuB,EAAK,KAAK,EAC3C,GAAS,MAAM,EAAO,KAAK,CAAK,CACxC,CACJ,CACA,OAAO,CACX,CAEA,MAAM,EAAiE,IAAI,IAAI,CAC3E,KACA,MACA,SACJ,CAAC,EACK,EAA+D,IAAI,IAAI,CACzE,KACA,KACJ,CAAC,EAED,SAAgB,EACZ,EACkB,CAClB,IAAM,EAAS,EACX,EACA,kBACA,CACJ,EACA,OAAO,EAAO,OAAS,EAAI,KAAK,IAAI,GAAG,CAAM,EAAI,IAAA,EACrD,CAIA,SAAgB,EAAiB,EAA8C,CAC3E,IAAM,EAAS,EACX,EACA,iBACA,CACJ,EACI,KAAO,SAAW,EACtB,OAAO,IAAI,KAAK,KAAK,IAAI,GAAG,CAAM,EAAI,GAAI,CAC9C,CC1DA,SAAS,EAAiB,EAAa,EAAqB,CACxD,IAAM,EAAU,KAAK,OAAO,EAAM,GAAO,EAAI,EAAE,EAAI,GACnD,OAAO,KAAK,IAAI,EAAK,KAAK,IAAI,EAAK,CAAO,CAAC,CAC/C,CAEA,SAAgB,EAAe,EAAyC,CACpE,OAAO,KAAK,IAAI,IAAkB,GAAe,CAAC,CACtD,CAKA,SAAgB,EACZ,EACA,EACM,CAKN,OAJI,GAAY,KAAa,EACzB,GAAY,KAAoB,KAAoB,EAC7C,IAEJ,EAAiB,EAAU,CAAQ,CAC9C,CAEA,SAAgB,EACZ,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,CAAW,EACzC,GAAI,GAAU,EAAG,OACjB,IAAI,EAAU,EAAO,QAAU,IAAO,EAGtC,OAFI,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACtE,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACnE,CAAE,SAAQ,OAAQ,CAAO,CACpC,CAEA,SAAgB,EACZ,EACA,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,EAAU,CAAQ,EAC5C,QAAU,GACd,MAAO,CAAE,SAAQ,OAAS,EAAU,IAAO,CAAO,CACtD,CC7CA,SAAgB,EACZ,EACA,EACM,CACN,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAO,EAAO,OAAO,GACzB,IAAK,aACD,OAAO,EAAO,YAAY,IAAQ,EACtC,IAAK,SACD,OAAO,EAAO,MAAM,QACf,EAAK,IACF,WAAY,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EAAI,EACzD,CACJ,CACR,CACJ,CAUA,SAAgB,EAAiB,EAAiC,CAS9D,OARI,EAAO,aAAe,aAAqB,EAAO,QAClD,EAAO,aAAe,SACf,EAAO,MAAM,QACf,EAAK,IACF,YAAa,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EACtD,CACJ,EAEG,CACX,CAkBA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAQ,EAAe,EAAQ,CAAG,EAExC,OADI,EAAQ,EAAU,EACf,EAAiB,CAAM,EAAI,IACtC,CCtDA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAoB,EAAqB,CAAQ,EACjD,EAAM,EAAqB,CAAiB,EAElD,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAO,EACH,KAAK,MAAM,EAAO,OAAO,EAAI,EAC7B,CACJ,EAEJ,IAAK,aACD,MAAO,GAAG,EAAO,QAAQ,IAE7B,IAAK,SAAU,CACX,IAAM,EAAY,EAAe,EAAQ,CAAG,EAC5C,GAAI,EAAY,EACZ,OAAO,EAAa,KAAK,MAAM,CAAS,EAAG,CAAiB,EAEhE,IAAM,EAAa,EAAiB,CAAM,EAI1C,OAHI,EAAa,EACN,GAAG,EAAW,IAElB,EAAa,EAAG,CAAiB,CAC5C,CACJ,CACJ,CAYA,SAAgB,EACZ,EACA,EACkB,CACb,MAED,IAAc,EADN,EAAqB,EAAqB,CAAQ,CAClC,CAAC,GAAK,GAClC,OAAO,EAAsB,EAAQ,CAAQ,CACjD,CAMA,SAAgB,EACZ,EACA,EACM,CACN,OAAO,EACD,EAAK,QAAQ,WAAY,CAAM,EAC/B,EAAK,QAAQ,WAAY,EAAE,CACrC,CCnDA,SAAS,EAAU,EAA0B,EAAwB,CACjE,OACI,EAAS,WAAa,MACtB,IAAI,KAAK,EAAS,SAAS,EAAE,QAAQ,GAAK,CAElD,CAEA,SAAS,EAAW,EAA0B,EAAwB,CAClE,IAAM,EAAW,EAAiB,EAAS,UAAU,EACrD,OAAO,GAAY,MAAQ,EAAS,QAAQ,GAAK,CACrD,CAEA,SAAS,EAAe,EAA0B,EAA0B,CACxE,OAAO,IAAa,UAAY,EAAS,QAAU,EAAS,QAChE,CAEA,SAAS,EACL,EACA,EACA,EACM,CACN,IAAM,EAAS,EAAe,EAAU,CAAQ,EAChD,OAAO,EAAS,EAAc,EAAQ,CAAG,EAAI,CACjD,CAYA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACd,CAC3B,IAAM,GAAS,EAAQ,KAAO,IAAI,MAAQ,QAAQ,EAC5C,EAAW,EAAQ,UAAY,WAC/B,EAAM,EAAqB,EAAqB,EAAQ,QAAQ,CAAC,EAQjE,GANW,EAAQ,kBACnB,EAAQ,OACH,GACG,EAAS,qBAAuB,EAAQ,iBAChD,EACA,GACkB,OAAQ,GAAa,CAAC,EAAU,EAAU,CAAK,CAAC,EAElE,EAAO,EAAO,OAAQ,GAAa,EAAW,EAAU,CAAK,CAAC,EACpE,GAAI,EAAK,OAAS,EAMd,MAAO,CAAE,SALI,EAAK,QAAQ,EAAG,IACzB,EAAa,EAAG,EAAK,CAAQ,EAAI,EAAa,EAAG,EAAK,CAAQ,EACxD,EACA,CAEY,EAAG,OAAQ,MAAO,EAG5C,IAAM,EAAW,EACZ,IAAK,IAAc,CAChB,WACA,SAAU,EAAiB,EAAS,UAAU,CAClD,EAAE,EACD,OACI,GACG,EAAM,UAAY,IAC1B,EACJ,GAAI,EAAS,SAAW,EAAG,OAE3B,IAAM,EAAU,EAAS,QAAQ,EAAG,IAChC,EAAE,SAAS,QAAQ,EAAI,EAAE,SAAS,QAAQ,EAAI,EAAI,CACtD,EACA,MAAO,CACH,SAAU,EAAQ,SAClB,OAAQ,WACR,SAAU,EAAQ,QACtB,CACJ,CAWA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACvB,CAClB,IAAM,EAAW,EAAsB,EAAS,CAAO,EAClD,KAKL,OAAO,EAJQ,EACX,EAAS,SACT,EAAQ,UAAY,UAEO,EAAG,EAAQ,QAAQ,CACtD"}
|
|
1
|
+
{"version":3,"file":"rewards.js","names":[],"sources":["../src/rewards/conditions.ts","../src/rewards/example.ts","../src/rewards/value.ts","../src/rewards/format.ts","../src/rewards/select.ts"],"sourcesContent":["import type { ConditionGroup, RuleCondition, RuleConditions } from \"../types\";\n\ntype ConditionNode = RuleCondition | ConditionGroup;\n\nfunction conditionNodes(conditions: RuleConditions): ConditionNode[] {\n return Array.isArray(conditions) ? conditions : conditions.conditions;\n}\n\nfunction conditionValueToNumber(\n value: RuleCondition[\"value\"]\n): number | undefined {\n if (typeof value === \"number\") return value;\n if (typeof value === \"string\" && value.trim() !== \"\") {\n const parsed = Number(value);\n return Number.isFinite(parsed) ? parsed : undefined;\n }\n return undefined;\n}\n\n// Conditions arrive as a flat list or recursive groups; collect every numeric\n// value whose field + operator match, descending into nested groups.\nfunction collectConditionValues(\n conditions: RuleConditions,\n field: string,\n operators: ReadonlySet<RuleCondition[\"operator\"]>\n): number[] {\n const values: number[] = [];\n for (const node of conditionNodes(conditions)) {\n if (\"logic\" in node) {\n values.push(...collectConditionValues(node, field, operators));\n continue;\n }\n if (node.field === field && operators.has(node.operator)) {\n const value = conditionValueToNumber(node.value);\n if (value != null) values.push(value);\n }\n }\n return values;\n}\n\nconst MIN_PURCHASE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n \"between\",\n]);\nconst START_DATE_OPERATORS: ReadonlySet<RuleCondition[\"operator\"]> = new Set([\n \"gt\",\n \"gte\",\n]);\n\nexport function extractMinPurchaseAmount(\n conditions: RuleConditions\n): number | undefined {\n const values = collectConditionValues(\n conditions,\n \"purchase.amount\",\n MIN_PURCHASE_OPERATORS\n );\n return values.length > 0 ? Math.min(...values) : undefined;\n}\n\n// The business app encodes a campaign start as a `time.timestamp >= <unix s>`\n// rule condition; the endpoint returns it verbatim inside `conditions`.\nexport function extractStartDate(conditions: RuleConditions): Date | undefined {\n const values = collectConditionValues(\n conditions,\n \"time.timestamp\",\n START_DATE_OPERATORS\n );\n if (values.length === 0) return undefined;\n return new Date(Math.min(...values) * 1000);\n}\n","import type { EstimatedReward } from \"../types\";\n\ntype PercentageReward = Extract<EstimatedReward, { payoutType: \"percentage\" }>;\n\n// Reference order total used to turn a \"% of basket\" reward into a concrete\n// example amount. The campaign's minimum purchase overrides it when higher.\nconst REFERENCE_BASKET = 100;\n\nexport type RewardExample = {\n basket: number;\n reward: number;\n};\n\nfunction roundWithinRange(min: number, max: number): number {\n const rounded = Math.round((min + max) / 2 / 10) * 10;\n return Math.min(max, Math.max(min, rounded));\n}\n\nexport function pickFlatBasket(minPurchase: number | undefined): number {\n return Math.max(REFERENCE_BASKET, minPurchase ?? 0);\n}\n\n// Basket for a percentage tier: the reference when it sits inside the tier\n// range, a round number within the range otherwise, or the lower bound for an\n// open-ended (uncapped) top tier.\nexport function pickTierBasket(\n minValue: number,\n maxValue: number | undefined\n): number {\n if (maxValue == null) return minValue;\n if (minValue <= REFERENCE_BASKET && REFERENCE_BASKET <= maxValue) {\n return REFERENCE_BASKET;\n }\n return roundWithinRange(minValue, maxValue);\n}\n\nexport function buildPercentageExample(\n reward: PercentageReward,\n minPurchase: number | undefined\n): RewardExample | undefined {\n const basket = pickFlatBasket(minPurchase);\n if (basket <= 0) return undefined;\n let amount = (reward.percent / 100) * basket;\n if (reward.minAmount) amount = Math.max(amount, reward.minAmount.eurAmount);\n if (reward.maxAmount) amount = Math.min(amount, reward.maxAmount.eurAmount);\n return { basket, reward: amount };\n}\n\nexport function buildTierExample(\n percent: number,\n minValue: number,\n maxValue: number | undefined\n): RewardExample | undefined {\n const basket = pickTierBasket(minValue, maxValue);\n if (basket <= 0) return undefined;\n return { basket, reward: (percent / 100) * basket };\n}\n","import type { EstimatedReward, TokenAmountType } from \"../types\";\n\n/**\n * Comparable fiat value of a single reward, used to rank rewards against each\n * other.\n *\n * - `fixed` → the token amount in the requested currency\n * - `tiered` → the highest token amount across tiers\n * - `percentage` → the capped (`maxAmount`) value when present, otherwise `0`\n * (an uncapped percentage has no comparable fiat value)\n */\nexport function getRewardValue(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n switch (reward.payoutType) {\n case \"fixed\":\n return reward.amount[key];\n case \"percentage\":\n return reward.maxAmount?.[key] ?? 0;\n case \"tiered\":\n return reward.tiers.reduce(\n (max, tier) =>\n \"amount\" in tier ? Math.max(max, tier.amount[key]) : max,\n 0\n );\n }\n}\n\n/**\n * Highest percent a reward exposes: the flat `percentage` percent, or the\n * richest percent across `tiered` tiers, or `0` when it carries none.\n *\n * Shared by {@link getRewardRank} (to weight a percentage-only reward) and\n * `formatEstimatedReward` (to render it as `\"X %\"`), so the value the UI ranks\n * by and the value it prints stay derived from one tier traversal.\n */\nexport function maxRewardPercent(reward: EstimatedReward): number {\n if (reward.payoutType === \"percentage\") return reward.percent;\n if (reward.payoutType === \"tiered\") {\n return reward.tiers.reduce(\n (max, tier) =>\n \"percent\" in tier ? Math.max(max, tier.percent) : max,\n 0\n );\n }\n return 0;\n}\n\n// A reward with no money value (an uncapped percentage, or a percent-only\n// tier set) still renders as \"X %\", so it is worth surfacing. We give it a\n// positive ranking weight derived from its percent but scaled far below any\n// real-money reward, so the two invariants the UI relies on hold: (1) a reward\n// with real money always outranks a percentage-only reward, and (2) a\n// percentage-only reward still outranks a zero-value reward. Together they\n// guarantee the reward the ranking picks is always one we can display.\nconst PERCENT_ONLY_RANK_WEIGHT = 1e-6;\n\n/**\n * Ranking weight used to pick the single most attractive reward to surface.\n *\n * Mirrors {@link getRewardValue} (money value) but lifts a percentage-only\n * reward to a tiny positive weight instead of `0`, so it is never buried\n * behind a zero-value reward when choosing what to display.\n */\nexport function getRewardRank(\n reward: EstimatedReward,\n key: keyof TokenAmountType\n): number {\n const value = getRewardValue(reward, key);\n if (value > 0) return value;\n return maxRewardPercent(reward) * PERCENT_ONLY_RANK_WEIGHT;\n}\n","import type { Currency, EstimatedReward } from \"../types\";\nimport { formatAmount } from \"../utils/format/formatAmount\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { getRewardRank, getRewardValue, maxRewardPercent } from \"./value\";\n\n/**\n * Format an {@link EstimatedReward} into a human-readable string.\n *\n * - `fixed` → e.g. `\"5 €\"`\n * - `percentage` → e.g. `\"10 %\"`\n * - `tiered` → the richest tier: max token amount (e.g. `\"50 €\"`) or, when\n * tiers only carry percentages, the max percent (e.g. `\"10 %\"`)\n *\n * Percentages are always rendered as a `\"X %\"` string: the backend never sends\n * a reference basket, so the reward cannot be resolved to a concrete amount\n * here. Callers that need a worked example use the `example` helpers instead.\n */\nexport function formatEstimatedReward(\n reward: EstimatedReward,\n currency?: Currency\n): string {\n const supportedCurrency = getSupportedCurrency(currency);\n const key = getCurrencyAmountKey(supportedCurrency);\n\n switch (reward.payoutType) {\n case \"fixed\":\n return formatAmount(\n Math.round(reward.amount[key]),\n supportedCurrency\n );\n\n case \"percentage\":\n return `${reward.percent} %`;\n\n case \"tiered\": {\n const maxAmount = getRewardValue(reward, key);\n if (maxAmount > 0) {\n return formatAmount(Math.round(maxAmount), supportedCurrency);\n }\n const maxPercent = maxRewardPercent(reward);\n if (maxPercent > 0) {\n return `${maxPercent} %`;\n }\n return formatAmount(0, supportedCurrency);\n }\n }\n}\n\n/**\n * Format a reward for display, or return `undefined` when it is not worth\n * advertising. Callers rely on `undefined` to hide a badge / fall back to\n * other copy.\n *\n * A reward is hidden only when it carries no displayable value — a `fixed` or\n * `tiered` reward whose money value is `0` (e.g. an unknown token price). An\n * uncapped percentage always renders as `\"X %\"`, since the percent itself is\n * meaningful even without a money value.\n */\nexport function formatRewardOrHide(\n reward: EstimatedReward | undefined,\n currency?: Currency\n): string | undefined {\n if (!reward) return undefined;\n const key = getCurrencyAmountKey(getSupportedCurrency(currency));\n if (getRewardRank(reward, key) <= 0) return undefined;\n return formatEstimatedReward(reward, currency);\n}\n\n/**\n * Replace the `{REWARD}` placeholder in a text string with a reward value.\n * If no reward is provided, returns the text with `{REWARD}` stripped.\n */\nexport function applyRewardPlaceholder(\n text: string,\n reward: string | undefined\n): string {\n return reward\n ? text.replaceAll(\"{REWARD}\", reward)\n : text.replaceAll(\"{REWARD}\", \"\");\n}\n","import type { InteractionTypeKey } from \"../constants/interactionTypes\";\nimport type {\n Currency,\n EstimatedReward,\n MerchantReward,\n TokenAmountType,\n} from \"../types\";\nimport { formatAmount } from \"../utils/format/formatAmount\";\nimport { getCurrencyAmountKey } from \"../utils/format/getCurrencyAmountKey\";\nimport { getSupportedCurrency } from \"../utils/format/getSupportedCurrency\";\nimport { extractMinPurchaseAmount, extractStartDate } from \"./conditions\";\nimport { formatRewardOrHide } from \"./format\";\nimport { getRewardRank } from \"./value\";\n\n/** Reward side a surface cares about: the sharer (`referrer`) or the referred\n * user (`referee`). Drives both campaign ranking and which side is displayed. */\nexport type RewardAudience = \"referrer\" | \"referee\";\n\nexport type DisplayCampaign = {\n campaign: MerchantReward;\n status: \"live\" | \"upcoming\";\n startsAt?: Date;\n};\n\nexport type SelectDisplayCampaignOptions = {\n /** Reference \"now\" for expiry / start gating; defaults to the current time. */\n now?: Date;\n /** Currency the ranking is expressed in; defaults to EUR. */\n currency?: Currency;\n /** When set, only campaigns triggered by this interaction are considered. */\n targetInteraction?: InteractionTypeKey;\n /** Reward side to rank campaigns by; defaults to `\"referrer\"`. */\n audience?: RewardAudience;\n};\n\nfunction isExpired(campaign: MerchantReward, nowMs: number): boolean {\n return (\n campaign.expiresAt != null &&\n new Date(campaign.expiresAt).getTime() <= nowMs\n );\n}\n\nfunction hasStarted(campaign: MerchantReward, nowMs: number): boolean {\n const startsAt = extractStartDate(campaign.conditions);\n return startsAt == null || startsAt.getTime() <= nowMs;\n}\n\nfunction audienceReward(campaign: MerchantReward, audience: RewardAudience) {\n return audience === \"referee\" ? campaign.referee : campaign.referrer;\n}\n\nfunction campaignRank(\n campaign: MerchantReward,\n key: keyof TokenAmountType,\n audience: RewardAudience\n): number {\n const reward = audienceReward(campaign, audience);\n return reward ? getRewardRank(reward, key) : 0;\n}\n\n/**\n * Pick the single campaign a merchant surface should display.\n *\n * Filters out expired (and, when `targetInteraction` is set, non-matching)\n * campaigns, then prefers the highest-ranked *live* campaign — ranked by the\n * `audience` reward side in the requested currency. When none has started yet\n * it falls back to the soonest-starting upcoming campaign (the endpoint does\n * not gate on the start-date condition, so future-start campaigns come\n * through).\n */\nexport function selectDisplayCampaign(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): DisplayCampaign | undefined {\n const nowMs = (options.now ?? new Date()).getTime();\n const audience = options.audience ?? \"referrer\";\n const key = getCurrencyAmountKey(getSupportedCurrency(options.currency));\n\n const matching = options.targetInteraction\n ? rewards.filter(\n (campaign) =>\n campaign.interactionTypeKey === options.targetInteraction\n )\n : rewards;\n const active = matching.filter((campaign) => !isExpired(campaign, nowMs));\n\n const live = active.filter((campaign) => hasStarted(campaign, nowMs));\n if (live.length > 0) {\n const best = live.reduce((a, b) =>\n campaignRank(b, key, audience) > campaignRank(a, key, audience)\n ? b\n : a\n );\n return { campaign: best, status: \"live\" };\n }\n\n const upcoming = active\n .map((campaign) => ({\n campaign,\n startsAt: extractStartDate(campaign.conditions),\n }))\n .filter(\n (entry): entry is { campaign: MerchantReward; startsAt: Date } =>\n entry.startsAt != null\n );\n if (upcoming.length === 0) return undefined;\n\n const soonest = upcoming.reduce((a, b) =>\n b.startsAt.getTime() < a.startsAt.getTime() ? b : a\n );\n return {\n campaign: soonest.campaign,\n status: \"upcoming\",\n startsAt: soonest.startsAt,\n };\n}\n\n/**\n * The single reward a merchant surface should display: its formatted string\n * plus the `payoutType` of the underlying reward, so surfaces can adapt their\n * presentation (e.g. hide percentage rewards, prefix tiered ones with \"Up to\").\n */\nexport type BestReward = {\n /** Display-ready reward string (e.g. `\"5 €\"`, `\"10 %\"`). */\n formatted: string;\n /** Payout type of the selected reward. */\n payoutType: EstimatedReward[\"payoutType\"];\n /**\n * Minimum purchase amount gating the reward, formatted with the requested\n * currency (e.g. `\"10 €\"`), or `undefined` when the campaign sets no\n * minimum.\n */\n minPurchaseAmount?: string;\n /**\n * Whole-day lockup applied before the reward settles, or `undefined` when\n * the campaign has no lockup.\n */\n lockupDurationDays?: number;\n};\n\n/**\n * Pick the best campaign for `options` and resolve its `audience`-side reward\n * to a formatted string plus its `payoutType`, or `undefined` when there is\n * nothing worth showing.\n *\n * Single entry point shared by every \"headline reward\" surface (share button,\n * wallet modal, sharing/install screens) so they all show the same number for\n * a given merchant and can branch on the payout type.\n */\nexport function selectBestReward(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): BestReward | undefined {\n const selected = selectDisplayCampaign(rewards, options);\n if (!selected) return undefined;\n const reward = audienceReward(\n selected.campaign,\n options.audience ?? \"referrer\"\n );\n if (!reward) return undefined;\n const formatted = formatRewardOrHide(reward, options.currency);\n if (!formatted) return undefined;\n\n const minPurchase = extractMinPurchaseAmount(selected.campaign.conditions);\n const minPurchaseAmount =\n minPurchase != null\n ? formatAmount(minPurchase, options.currency)\n : undefined;\n\n const lockupSeconds = selected.campaign.defaultLockupSeconds;\n const lockupDurationDays =\n lockupSeconds && lockupSeconds > 0\n ? Math.round(lockupSeconds / 86_400)\n : undefined;\n\n return {\n formatted,\n payoutType: reward.payoutType,\n minPurchaseAmount,\n lockupDurationDays,\n };\n}\n\n/**\n * Headline reward string for a merchant: picks the best campaign for `options`\n * and formats its `audience`-side reward, or returns `undefined` when there is\n * nothing worth showing.\n *\n * Thin wrapper over {@link selectBestReward} for callers that only need the\n * formatted string.\n */\nexport function formatBestReward(\n rewards: readonly MerchantReward[],\n options: SelectDisplayCampaignOptions = {}\n): string | undefined {\n return selectBestReward(rewards, options)?.formatted;\n}\n"],"mappings":"qEAIA,SAAS,EAAe,EAA6C,CACjE,OAAO,MAAM,QAAQ,CAAU,EAAI,EAAa,EAAW,UAC/D,CAEA,SAAS,EACL,EACkB,CAClB,GAAI,OAAO,GAAU,SAAU,OAAO,EACtC,GAAI,OAAO,GAAU,UAAY,EAAM,KAAK,IAAM,GAAI,CAClD,IAAM,EAAS,OAAO,CAAK,EAC3B,OAAO,OAAO,SAAS,CAAM,EAAI,EAAS,IAAA,EAC9C,CAEJ,CAIA,SAAS,EACL,EACA,EACA,EACQ,CACR,IAAM,EAAmB,CAAC,EAC1B,IAAK,IAAM,KAAQ,EAAe,CAAU,EAAG,CAC3C,GAAI,UAAW,EAAM,CACjB,EAAO,KAAK,GAAG,EAAuB,EAAM,EAAO,CAAS,CAAC,EAC7D,QACJ,CACA,GAAI,EAAK,QAAU,GAAS,EAAU,IAAI,EAAK,QAAQ,EAAG,CACtD,IAAM,EAAQ,EAAuB,EAAK,KAAK,EAC3C,GAAS,MAAM,EAAO,KAAK,CAAK,CACxC,CACJ,CACA,OAAO,CACX,CAEA,MAAM,EAAiE,IAAI,IAAI,CAC3E,KACA,MACA,SACJ,CAAC,EACK,EAA+D,IAAI,IAAI,CACzE,KACA,KACJ,CAAC,EAED,SAAgB,EACZ,EACkB,CAClB,IAAM,EAAS,EACX,EACA,kBACA,CACJ,EACA,OAAO,EAAO,OAAS,EAAI,KAAK,IAAI,GAAG,CAAM,EAAI,IAAA,EACrD,CAIA,SAAgB,EAAiB,EAA8C,CAC3E,IAAM,EAAS,EACX,EACA,iBACA,CACJ,EACI,KAAO,SAAW,EACtB,OAAO,IAAI,KAAK,KAAK,IAAI,GAAG,CAAM,EAAI,GAAI,CAC9C,CC1DA,SAAS,EAAiB,EAAa,EAAqB,CACxD,IAAM,EAAU,KAAK,OAAO,EAAM,GAAO,EAAI,EAAE,EAAI,GACnD,OAAO,KAAK,IAAI,EAAK,KAAK,IAAI,EAAK,CAAO,CAAC,CAC/C,CAEA,SAAgB,EAAe,EAAyC,CACpE,OAAO,KAAK,IAAI,IAAkB,GAAe,CAAC,CACtD,CAKA,SAAgB,EACZ,EACA,EACM,CAKN,OAJI,GAAY,KAAa,EACzB,GAAY,KAAoB,KAAoB,EAC7C,IAEJ,EAAiB,EAAU,CAAQ,CAC9C,CAEA,SAAgB,EACZ,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,CAAW,EACzC,GAAI,GAAU,EAAG,OACjB,IAAI,EAAU,EAAO,QAAU,IAAO,EAGtC,OAFI,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACtE,EAAO,YAAW,EAAS,KAAK,IAAI,EAAQ,EAAO,UAAU,SAAS,GACnE,CAAE,SAAQ,OAAQ,CAAO,CACpC,CAEA,SAAgB,EACZ,EACA,EACA,EACyB,CACzB,IAAM,EAAS,EAAe,EAAU,CAAQ,EAC5C,QAAU,GACd,MAAO,CAAE,SAAQ,OAAS,EAAU,IAAO,CAAO,CACtD,CC7CA,SAAgB,EACZ,EACA,EACM,CACN,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAO,EAAO,OAAO,GACzB,IAAK,aACD,OAAO,EAAO,YAAY,IAAQ,EACtC,IAAK,SACD,OAAO,EAAO,MAAM,QACf,EAAK,IACF,WAAY,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EAAI,EACzD,CACJ,CACR,CACJ,CAUA,SAAgB,EAAiB,EAAiC,CAS9D,OARI,EAAO,aAAe,aAAqB,EAAO,QAClD,EAAO,aAAe,SACf,EAAO,MAAM,QACf,EAAK,IACF,YAAa,EAAO,KAAK,IAAI,EAAK,EAAK,OAAO,EAAI,EACtD,CACJ,EAEG,CACX,CAkBA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAQ,EAAe,EAAQ,CAAG,EAExC,OADI,EAAQ,EAAU,EACf,EAAiB,CAAM,EAAI,IACtC,CCtDA,SAAgB,EACZ,EACA,EACM,CACN,IAAM,EAAoB,EAAqB,CAAQ,EACjD,EAAM,EAAqB,CAAiB,EAElD,OAAQ,EAAO,WAAf,CACI,IAAK,QACD,OAAO,EACH,KAAK,MAAM,EAAO,OAAO,EAAI,EAC7B,CACJ,EAEJ,IAAK,aACD,MAAO,GAAG,EAAO,QAAQ,IAE7B,IAAK,SAAU,CACX,IAAM,EAAY,EAAe,EAAQ,CAAG,EAC5C,GAAI,EAAY,EACZ,OAAO,EAAa,KAAK,MAAM,CAAS,EAAG,CAAiB,EAEhE,IAAM,EAAa,EAAiB,CAAM,EAI1C,OAHI,EAAa,EACN,GAAG,EAAW,IAElB,EAAa,EAAG,CAAiB,CAC5C,CACJ,CACJ,CAYA,SAAgB,EACZ,EACA,EACkB,CACb,MAED,IAAc,EADN,EAAqB,EAAqB,CAAQ,CAClC,CAAC,GAAK,GAClC,OAAO,EAAsB,EAAQ,CAAQ,CACjD,CAMA,SAAgB,EACZ,EACA,EACM,CACN,OAAO,EACD,EAAK,WAAW,WAAY,CAAM,EAClC,EAAK,WAAW,WAAY,EAAE,CACxC,CC7CA,SAAS,EAAU,EAA0B,EAAwB,CACjE,OACI,EAAS,WAAa,MACtB,IAAI,KAAK,EAAS,SAAS,EAAE,QAAQ,GAAK,CAElD,CAEA,SAAS,EAAW,EAA0B,EAAwB,CAClE,IAAM,EAAW,EAAiB,EAAS,UAAU,EACrD,OAAO,GAAY,MAAQ,EAAS,QAAQ,GAAK,CACrD,CAEA,SAAS,EAAe,EAA0B,EAA0B,CACxE,OAAO,IAAa,UAAY,EAAS,QAAU,EAAS,QAChE,CAEA,SAAS,EACL,EACA,EACA,EACM,CACN,IAAM,EAAS,EAAe,EAAU,CAAQ,EAChD,OAAO,EAAS,EAAc,EAAQ,CAAG,EAAI,CACjD,CAYA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACd,CAC3B,IAAM,GAAS,EAAQ,KAAO,IAAI,MAAQ,QAAQ,EAC5C,EAAW,EAAQ,UAAY,WAC/B,EAAM,EAAqB,EAAqB,EAAQ,QAAQ,CAAC,EAQjE,GANW,EAAQ,kBACnB,EAAQ,OACH,GACG,EAAS,qBAAuB,EAAQ,iBAChD,EACA,GACkB,OAAQ,GAAa,CAAC,EAAU,EAAU,CAAK,CAAC,EAElE,EAAO,EAAO,OAAQ,GAAa,EAAW,EAAU,CAAK,CAAC,EACpE,GAAI,EAAK,OAAS,EAMd,MAAO,CAAE,SALI,EAAK,QAAQ,EAAG,IACzB,EAAa,EAAG,EAAK,CAAQ,EAAI,EAAa,EAAG,EAAK,CAAQ,EACxD,EACA,CAEY,EAAG,OAAQ,MAAO,EAG5C,IAAM,EAAW,EACZ,IAAK,IAAc,CAChB,WACA,SAAU,EAAiB,EAAS,UAAU,CAClD,EAAE,EACD,OACI,GACG,EAAM,UAAY,IAC1B,EACJ,GAAI,EAAS,SAAW,EAAG,OAE3B,IAAM,EAAU,EAAS,QAAQ,EAAG,IAChC,EAAE,SAAS,QAAQ,EAAI,EAAE,SAAS,QAAQ,EAAI,EAAI,CACtD,EACA,MAAO,CACH,SAAU,EAAQ,SAClB,OAAQ,WACR,SAAU,EAAQ,QACtB,CACJ,CAkCA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACnB,CACtB,IAAM,EAAW,EAAsB,EAAS,CAAO,EACvD,GAAI,CAAC,EAAU,OACf,IAAM,EAAS,EACX,EAAS,SACT,EAAQ,UAAY,UACxB,EACA,GAAI,CAAC,EAAQ,OACb,IAAM,EAAY,EAAmB,EAAQ,EAAQ,QAAQ,EAC7D,GAAI,CAAC,EAAW,OAEhB,IAAM,EAAc,EAAyB,EAAS,SAAS,UAAU,EACnE,EACF,GAAe,KAET,IAAA,GADA,EAAa,EAAa,EAAQ,QAAQ,EAG9C,EAAgB,EAAS,SAAS,qBAClC,EACF,GAAiB,EAAgB,EAC3B,KAAK,MAAM,EAAgB,KAAM,EACjC,IAAA,GAEV,MAAO,CACH,YACA,WAAY,EAAO,WACnB,oBACA,oBACJ,CACJ,CAUA,SAAgB,EACZ,EACA,EAAwC,CAAC,EACvB,CAClB,OAAO,EAAiB,EAAS,CAAO,GAAG,SAC/C"}
|
package/package.json
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"url": "https://twitter.com/QNivelais"
|
|
12
12
|
}
|
|
13
13
|
],
|
|
14
|
-
"version": "1.1.5-beta.
|
|
14
|
+
"version": "1.1.5-beta.a4f314da",
|
|
15
15
|
"description": "Core SDK of the Frak wallet, low level library to interact directly with the frak ecosystem.",
|
|
16
16
|
"repository": {
|
|
17
17
|
"url": "https://github.com/frak-id/wallet",
|
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
"viem": "^2.x"
|
|
105
105
|
},
|
|
106
106
|
"dependencies": {
|
|
107
|
-
"@frak-labs/frame-connector": "0.2.0-beta.
|
|
107
|
+
"@frak-labs/frame-connector": "0.2.0-beta.a4f314da",
|
|
108
108
|
"@openpanel/web": "^1.4.1"
|
|
109
109
|
},
|
|
110
110
|
"devDependencies": {
|
package/src/rewards/format.ts
CHANGED
package/src/rewards/index.ts
CHANGED
|
@@ -18,10 +18,12 @@ export {
|
|
|
18
18
|
formatRewardOrHide,
|
|
19
19
|
} from "./format";
|
|
20
20
|
export {
|
|
21
|
+
type BestReward,
|
|
21
22
|
type DisplayCampaign,
|
|
22
23
|
formatBestReward,
|
|
23
24
|
type RewardAudience,
|
|
24
25
|
type SelectDisplayCampaignOptions,
|
|
26
|
+
selectBestReward,
|
|
25
27
|
selectDisplayCampaign,
|
|
26
28
|
} from "./select";
|
|
27
29
|
export { getRewardValue } from "./value";
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import { describe, expect, it } from "vitest";
|
|
2
2
|
import type { InteractionTypeKey } from "../constants/interactionTypes";
|
|
3
3
|
import type { EstimatedReward, MerchantReward, RuleConditions } from "../types";
|
|
4
|
-
import {
|
|
4
|
+
import {
|
|
5
|
+
formatBestReward,
|
|
6
|
+
selectBestReward,
|
|
7
|
+
selectDisplayCampaign,
|
|
8
|
+
} from "./select";
|
|
5
9
|
|
|
6
10
|
const NOW = new Date("2025-01-15T00:00:00Z");
|
|
7
11
|
const unix = (iso: string) => Math.floor(new Date(iso).getTime() / 1000);
|
|
@@ -210,3 +214,68 @@ describe("formatBestReward", () => {
|
|
|
210
214
|
).toBe("10 %");
|
|
211
215
|
});
|
|
212
216
|
});
|
|
217
|
+
|
|
218
|
+
describe("selectBestReward", () => {
|
|
219
|
+
it("returns undefined for an empty set", () => {
|
|
220
|
+
expect(selectBestReward([], { now: NOW })).toBeUndefined();
|
|
221
|
+
});
|
|
222
|
+
|
|
223
|
+
it("exposes the formatted reward and its payout type", () => {
|
|
224
|
+
const best = selectBestReward(
|
|
225
|
+
[campaign({ id: "c", referrer: fixedReward(50) })],
|
|
226
|
+
{ now: NOW }
|
|
227
|
+
);
|
|
228
|
+
expect(best?.formatted).toContain("50");
|
|
229
|
+
expect(best?.payoutType).toBe("fixed");
|
|
230
|
+
expect(best?.minPurchaseAmount).toBeUndefined();
|
|
231
|
+
expect(best?.lockupDurationDays).toBeUndefined();
|
|
232
|
+
});
|
|
233
|
+
|
|
234
|
+
it("surfaces the minimum purchase amount when the campaign gates on one", () => {
|
|
235
|
+
const best = selectBestReward(
|
|
236
|
+
[
|
|
237
|
+
campaign({
|
|
238
|
+
id: "c",
|
|
239
|
+
referrer: fixedReward(50),
|
|
240
|
+
conditions: [
|
|
241
|
+
{
|
|
242
|
+
field: "purchase.amount",
|
|
243
|
+
operator: "gte",
|
|
244
|
+
value: 25,
|
|
245
|
+
},
|
|
246
|
+
],
|
|
247
|
+
}),
|
|
248
|
+
],
|
|
249
|
+
{ now: NOW }
|
|
250
|
+
);
|
|
251
|
+
expect(best?.minPurchaseAmount).toContain("25");
|
|
252
|
+
});
|
|
253
|
+
|
|
254
|
+
it("surfaces the lockup duration in whole days", () => {
|
|
255
|
+
const best = selectBestReward(
|
|
256
|
+
[
|
|
257
|
+
campaign({
|
|
258
|
+
id: "c",
|
|
259
|
+
referrer: fixedReward(50),
|
|
260
|
+
defaultLockupSeconds: 7 * 86_400,
|
|
261
|
+
}),
|
|
262
|
+
],
|
|
263
|
+
{ now: NOW }
|
|
264
|
+
);
|
|
265
|
+
expect(best?.lockupDurationDays).toBe(7);
|
|
266
|
+
});
|
|
267
|
+
|
|
268
|
+
it("omits a zero lockup", () => {
|
|
269
|
+
const best = selectBestReward(
|
|
270
|
+
[
|
|
271
|
+
campaign({
|
|
272
|
+
id: "c",
|
|
273
|
+
referrer: fixedReward(50),
|
|
274
|
+
defaultLockupSeconds: 0,
|
|
275
|
+
}),
|
|
276
|
+
],
|
|
277
|
+
{ now: NOW }
|
|
278
|
+
);
|
|
279
|
+
expect(best?.lockupDurationDays).toBeUndefined();
|
|
280
|
+
});
|
|
281
|
+
});
|
package/src/rewards/select.ts
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import type { InteractionTypeKey } from "../constants/interactionTypes";
|
|
2
|
-
import type {
|
|
2
|
+
import type {
|
|
3
|
+
Currency,
|
|
4
|
+
EstimatedReward,
|
|
5
|
+
MerchantReward,
|
|
6
|
+
TokenAmountType,
|
|
7
|
+
} from "../types";
|
|
8
|
+
import { formatAmount } from "../utils/format/formatAmount";
|
|
3
9
|
import { getCurrencyAmountKey } from "../utils/format/getCurrencyAmountKey";
|
|
4
10
|
import { getSupportedCurrency } from "../utils/format/getSupportedCurrency";
|
|
5
|
-
import { extractStartDate } from "./conditions";
|
|
11
|
+
import { extractMinPurchaseAmount, extractStartDate } from "./conditions";
|
|
6
12
|
import { formatRewardOrHide } from "./format";
|
|
7
13
|
import { getRewardRank } from "./value";
|
|
8
14
|
|
|
@@ -110,23 +116,82 @@ export function selectDisplayCampaign(
|
|
|
110
116
|
}
|
|
111
117
|
|
|
112
118
|
/**
|
|
113
|
-
*
|
|
114
|
-
*
|
|
119
|
+
* The single reward a merchant surface should display: its formatted string
|
|
120
|
+
* plus the `payoutType` of the underlying reward, so surfaces can adapt their
|
|
121
|
+
* presentation (e.g. hide percentage rewards, prefix tiered ones with "Up to").
|
|
122
|
+
*/
|
|
123
|
+
export type BestReward = {
|
|
124
|
+
/** Display-ready reward string (e.g. `"5 €"`, `"10 %"`). */
|
|
125
|
+
formatted: string;
|
|
126
|
+
/** Payout type of the selected reward. */
|
|
127
|
+
payoutType: EstimatedReward["payoutType"];
|
|
128
|
+
/**
|
|
129
|
+
* Minimum purchase amount gating the reward, formatted with the requested
|
|
130
|
+
* currency (e.g. `"10 €"`), or `undefined` when the campaign sets no
|
|
131
|
+
* minimum.
|
|
132
|
+
*/
|
|
133
|
+
minPurchaseAmount?: string;
|
|
134
|
+
/**
|
|
135
|
+
* Whole-day lockup applied before the reward settles, or `undefined` when
|
|
136
|
+
* the campaign has no lockup.
|
|
137
|
+
*/
|
|
138
|
+
lockupDurationDays?: number;
|
|
139
|
+
};
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* Pick the best campaign for `options` and resolve its `audience`-side reward
|
|
143
|
+
* to a formatted string plus its `payoutType`, or `undefined` when there is
|
|
115
144
|
* nothing worth showing.
|
|
116
145
|
*
|
|
117
146
|
* Single entry point shared by every "headline reward" surface (share button,
|
|
118
147
|
* wallet modal, sharing/install screens) so they all show the same number for
|
|
119
|
-
* a given merchant.
|
|
148
|
+
* a given merchant and can branch on the payout type.
|
|
120
149
|
*/
|
|
121
|
-
export function
|
|
150
|
+
export function selectBestReward(
|
|
122
151
|
rewards: readonly MerchantReward[],
|
|
123
152
|
options: SelectDisplayCampaignOptions = {}
|
|
124
|
-
):
|
|
153
|
+
): BestReward | undefined {
|
|
125
154
|
const selected = selectDisplayCampaign(rewards, options);
|
|
126
155
|
if (!selected) return undefined;
|
|
127
156
|
const reward = audienceReward(
|
|
128
157
|
selected.campaign,
|
|
129
158
|
options.audience ?? "referrer"
|
|
130
159
|
);
|
|
131
|
-
|
|
160
|
+
if (!reward) return undefined;
|
|
161
|
+
const formatted = formatRewardOrHide(reward, options.currency);
|
|
162
|
+
if (!formatted) return undefined;
|
|
163
|
+
|
|
164
|
+
const minPurchase = extractMinPurchaseAmount(selected.campaign.conditions);
|
|
165
|
+
const minPurchaseAmount =
|
|
166
|
+
minPurchase != null
|
|
167
|
+
? formatAmount(minPurchase, options.currency)
|
|
168
|
+
: undefined;
|
|
169
|
+
|
|
170
|
+
const lockupSeconds = selected.campaign.defaultLockupSeconds;
|
|
171
|
+
const lockupDurationDays =
|
|
172
|
+
lockupSeconds && lockupSeconds > 0
|
|
173
|
+
? Math.round(lockupSeconds / 86_400)
|
|
174
|
+
: undefined;
|
|
175
|
+
|
|
176
|
+
return {
|
|
177
|
+
formatted,
|
|
178
|
+
payoutType: reward.payoutType,
|
|
179
|
+
minPurchaseAmount,
|
|
180
|
+
lockupDurationDays,
|
|
181
|
+
};
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
/**
|
|
185
|
+
* Headline reward string for a merchant: picks the best campaign for `options`
|
|
186
|
+
* and formats its `audience`-side reward, or returns `undefined` when there is
|
|
187
|
+
* nothing worth showing.
|
|
188
|
+
*
|
|
189
|
+
* Thin wrapper over {@link selectBestReward} for callers that only need the
|
|
190
|
+
* formatted string.
|
|
191
|
+
*/
|
|
192
|
+
export function formatBestReward(
|
|
193
|
+
rewards: readonly MerchantReward[],
|
|
194
|
+
options: SelectDisplayCampaignOptions = {}
|
|
195
|
+
): string | undefined {
|
|
196
|
+
return selectBestReward(rewards, options)?.formatted;
|
|
132
197
|
}
|