@funnelsgrove/runtime 0.1.36 → 0.1.38

package/dist/index.d.ts

@@ -15,6 +15,7 @@ export * from './runtime/posthog-flags.js';
 export * from './runtime/use-funnel-flow-controller.js';
 export * from './runtime/preview-bridge.js';
 export * from './runtime/preview-definition-overrides.js';
+export * from './runtime/offer-set-runtime.js';
 export * from './runtime/route-resolver.js';
 export * from './runtime/subscription-handoff.js';
 export * from './runtime/url-user-attributes.js';

package/dist/index.js

@@ -15,6 +15,7 @@ export * from './runtime/posthog-flags.js';
 export * from './runtime/use-funnel-flow-controller.js';
 export * from './runtime/preview-bridge.js';
 export * from './runtime/preview-definition-overrides.js';
+export * from './runtime/offer-set-runtime.js';
 export * from './runtime/route-resolver.js';
 export * from './runtime/subscription-handoff.js';
 export * from './runtime/url-user-attributes.js';

package/dist/runtime/offer-set-runtime.d.ts

@@ -0,0 +1,71 @@
+import type { RuntimeMode } from '../services/runtime-mode.service.js';
+export type GeneratedOfferSetItemKind = 'plan' | 'upsell' | 'downsell';
+export type GeneratedOfferSetPlanItem = {
+    readonly funnelPlanKey: string;
+    readonly projectBillingPlanId?: string | null;
+    readonly testProviderPlanId?: string | null;
+    readonly liveProviderPlanId?: string | null;
+    readonly analyticsPurchaseValue?: number | null;
+    readonly position?: number | null;
+    readonly isDefault?: boolean | null;
+    readonly displayNameOverride?: string | null;
+    readonly featuredTag?: string | null;
+    readonly oldPriceLabel?: string | null;
+    readonly metadata?: Record<string, unknown> | null;
+};
+export type GeneratedOfferSetDiscount = {
+    readonly key?: string | null;
+    readonly testProviderCouponId?: string | null;
+    readonly liveProviderCouponId?: string | null;
+    readonly position?: number | null;
+    readonly metadata?: Record<string, unknown> | null;
+};
+export type GeneratedOfferSet = {
+    readonly key: string;
+    readonly isActive?: boolean | null;
+    readonly metadata?: Record<string, unknown> | null;
+    readonly items: readonly GeneratedOfferSetPlanItem[];
+};
+export type OfferSetRuntimeDiscount = {
+    readonly stage: 'first';
+    readonly couponId: string;
+    readonly discountPercent: number;
+    readonly durationSeconds: number;
+    readonly previousDiscountPercent?: null;
+} | {
+    readonly stage: 'second';
+    readonly couponId: string;
+    readonly discountPercent: number;
+    readonly durationSeconds: number;
+    readonly previousDiscountPercent: number;
+};
+export type OfferSetRuntimePlanOverrides = {
+    projectPlanId?: string;
+    providerPlanId?: string;
+    analyticsPurchaseValue?: number;
+    title?: string;
+    featuredTag?: string;
+    oldPriceLabel?: string;
+    isDefault?: boolean;
+};
+export type OfferSetRuntimeInput<TPlan extends Record<string, unknown>> = {
+    offerSets: readonly GeneratedOfferSet[];
+    offerSetKey?: string;
+    baseCatalogsByMode: Record<RuntimeMode, Record<string, TPlan>>;
+    fallbackDiscounts?: readonly OfferSetRuntimeDiscount[];
+};
+export type OfferSetRuntimeResult<TPlan extends Record<string, unknown>> = {
+    offerSet: GeneratedOfferSet | null;
+    plansByMode: Record<RuntimeMode, Record<string, TPlan & OfferSetRuntimePlanOverrides>>;
+    planKeys: string[];
+    upsellPlanKeys: string[];
+    downsellPlanKeys: string[];
+    defaultPlanKey: string;
+    discountListsByMode: Record<RuntimeMode, readonly OfferSetRuntimeDiscount[]>;
+    getPlanCatalog: (mode: RuntimeMode) => Record<string, TPlan & OfferSetRuntimePlanOverrides>;
+    getDiscountList: (mode: RuntimeMode) => readonly OfferSetRuntimeDiscount[];
+};
+export declare const findGeneratedOfferSet: (offerSets: readonly GeneratedOfferSet[], offerSetKey?: string) => GeneratedOfferSet | null;
+export declare const applyGeneratedOfferSetToPlanCatalog: <TPlan extends Record<string, unknown>>(baseCatalog: Record<string, TPlan>, mode: RuntimeMode, offerSet: GeneratedOfferSet | null) => Record<string, TPlan & OfferSetRuntimePlanOverrides>;
+export declare const buildGeneratedOfferSetDiscountList: (offerSet: GeneratedOfferSet | null, mode: RuntimeMode, fallbackDiscounts?: readonly OfferSetRuntimeDiscount[]) => readonly OfferSetRuntimeDiscount[];
+export declare const resolveGeneratedOfferSetRuntime: <TPlan extends Record<string, unknown>>(input: OfferSetRuntimeInput<TPlan>) => OfferSetRuntimeResult<TPlan>;

package/dist/runtime/offer-set-runtime.js

@@ -0,0 +1,193 @@
+const isRecord = (value) => (typeof value === 'object' && value !== null && !Array.isArray(value));
+const readString = (value) => (typeof value === 'string' && value.trim() ? value.trim() : null);
+const normalizeCatalogLookupKey = (value) => (value
+    .trim()
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, ''));
+const readFiniteNumber = (value) => {
+    const numeric = typeof value === 'number'
+        ? value
+        : typeof value === 'string' && value.trim()
+            ? Number(value.trim())
+            : null;
+    return numeric !== null && Number.isFinite(numeric) ? numeric : null;
+};
+const readPositiveInteger = (value) => {
+    const numeric = readFiniteNumber(value);
+    return numeric !== null && numeric > 0 ? Math.round(numeric) : null;
+};
+const getOfferSetItemKind = (item) => {
+    var _a;
+    const metadata = isRecord(item.metadata) ? item.metadata : {};
+    const value = (_a = metadata.offerItemKind) !== null && _a !== void 0 ? _a : metadata.kind;
+    return value === 'upsell' || value === 'downsell' ? value : 'plan';
+};
+const getSortedItemsByKind = (offerSet, kind) => {
+    var _a;
+    return ((_a = offerSet === null || offerSet === void 0 ? void 0 : offerSet.items.filter((item) => getOfferSetItemKind(item) === kind).slice().sort((left, right) => {
+        var _a, _b;
+        const leftPosition = (_a = readFiniteNumber(left.position)) !== null && _a !== void 0 ? _a : 0;
+        const rightPosition = (_b = readFiniteNumber(right.position)) !== null && _b !== void 0 ? _b : 0;
+        return leftPosition - rightPosition;
+    })) !== null && _a !== void 0 ? _a : []);
+};
+export const findGeneratedOfferSet = (offerSets, offerSetKey) => {
+    var _a, _b;
+    const activeOfferSets = offerSets.filter((offerSet) => offerSet.isActive !== false);
+    return ((_b = (_a = activeOfferSets.find((offerSet) => offerSet.key === offerSetKey)) !== null && _a !== void 0 ? _a : activeOfferSets[0]) !== null && _b !== void 0 ? _b : null);
+};
+const readProviderPlanId = (item, mode) => (mode === 'test'
+    ? readString(item.testProviderPlanId)
+    : readString(item.liveProviderPlanId));
+const resolveCatalogKey = (baseCatalog, funnelPlanKey) => {
+    var _a;
+    const key = funnelPlanKey.trim();
+    if (!key) {
+        return null;
+    }
+    if (Object.prototype.hasOwnProperty.call(baseCatalog, key)) {
+        return key;
+    }
+    const normalizedKey = normalizeCatalogLookupKey(key);
+    return (_a = Object.keys(baseCatalog).find((catalogKey) => (normalizeCatalogLookupKey(catalogKey) === normalizedKey))) !== null && _a !== void 0 ? _a : null;
+};
+const resolveOfferItemRuntimeKey = (item, baseCatalogsByMode) => {
+    var _a, _b;
+    return (item
+        ? (_b = (_a = resolveCatalogKey(baseCatalogsByMode.test, item.funnelPlanKey)) !== null && _a !== void 0 ? _a : resolveCatalogKey(baseCatalogsByMode.live, item.funnelPlanKey)) !== null && _b !== void 0 ? _b : readString(item.funnelPlanKey)
+        : null);
+};
+export const applyGeneratedOfferSetToPlanCatalog = (baseCatalog, mode, offerSet) => {
+    var _a, _b, _c;
+    if (!offerSet) {
+        return Object.assign({}, baseCatalog);
+    }
+    const planItems = getSortedItemsByKind(offerSet, 'plan');
+    const catalogItems = [
+        ...planItems,
+        ...getSortedItemsByKind(offerSet, 'upsell'),
+        ...getSortedItemsByKind(offerSet, 'downsell'),
+    ];
+    const nextCatalog = Object.assign({}, baseCatalog);
+    const defaultPlanItem = (_a = planItems.find((item) => item.isDefault === true)) !== null && _a !== void 0 ? _a : planItems[0];
+    const defaultPlanKey = defaultPlanItem
+        ? (_b = resolveCatalogKey(nextCatalog, defaultPlanItem.funnelPlanKey)) !== null && _b !== void 0 ? _b : defaultPlanItem.funnelPlanKey
+        : '';
+    for (const item of catalogItems) {
+        const key = resolveCatalogKey(nextCatalog, item.funnelPlanKey);
+        if (!key) {
+            continue;
+        }
+        const basePlan = nextCatalog[key];
+        if (!basePlan) {
+            continue;
+        }
+        const providerPlanId = readProviderPlanId(item, mode);
+        const displayNameOverride = readString(item.displayNameOverride);
+        const featuredTag = readString(item.featuredTag);
+        const oldPriceLabel = readString(item.oldPriceLabel);
+        nextCatalog[key] = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, basePlan), (readString(item.projectBillingPlanId) ? { projectPlanId: (_c = readString(item.projectBillingPlanId)) !== null && _c !== void 0 ? _c : undefined } : {})), (providerPlanId ? { providerPlanId } : {})), (typeof item.analyticsPurchaseValue === 'number'
+            ? { analyticsPurchaseValue: item.analyticsPurchaseValue }
+            : {})), (displayNameOverride ? { title: displayNameOverride } : {})), (featuredTag ? { featuredTag } : {})), (oldPriceLabel ? { oldPriceLabel } : {})), { isDefault: getOfferSetItemKind(item) === 'plan' && key === defaultPlanKey || undefined });
+    }
+    return nextCatalog;
+};
+const getOfferSetDiscounts = (offerSet) => {
+    const metadata = isRecord(offerSet === null || offerSet === void 0 ? void 0 : offerSet.metadata) ? offerSet.metadata : {};
+    const discounts = metadata.discounts;
+    return Array.isArray(discounts)
+        ? discounts.filter((discount) => isRecord(discount))
+        : [];
+};
+const readDiscountCouponId = (discount, mode) => (mode === 'test'
+    ? readString(discount.testProviderCouponId)
+    : readString(discount.liveProviderCouponId));
+const readDiscountPercent = (discount, fallback) => {
+    var _a, _b, _c;
+    const metadata = isRecord(discount.metadata) ? discount.metadata : {};
+    return (_c = (_b = (_a = readPositiveInteger(metadata.discountPercent)) !== null && _a !== void 0 ? _a : readPositiveInteger(metadata.percentOff)) !== null && _b !== void 0 ? _b : fallback === null || fallback === void 0 ? void 0 : fallback.discountPercent) !== null && _c !== void 0 ? _c : 0;
+};
+const readDiscountDurationSeconds = (discount, fallback) => {
+    var _a, _b, _c;
+    const metadata = isRecord(discount.metadata) ? discount.metadata : {};
+    return (_c = (_b = (_a = readPositiveInteger(metadata.durationSeconds)) !== null && _a !== void 0 ? _a : readPositiveInteger(metadata.duration_seconds)) !== null && _b !== void 0 ? _b : fallback === null || fallback === void 0 ? void 0 : fallback.durationSeconds) !== null && _c !== void 0 ? _c : 0;
+};
+const isSecondDiscount = (discount, index) => {
+    var _a, _b;
+    const metadata = isRecord(discount.metadata) ? discount.metadata : {};
+    const stage = (_b = (_a = readString(metadata.stage)) !== null && _a !== void 0 ? _a : readString(metadata.offerStage)) !== null && _b !== void 0 ? _b : readString(discount.key);
+    return stage === 'second' || stage === 'downsell' || stage === 'upgraded' || index === 1;
+};
+export const buildGeneratedOfferSetDiscountList = (offerSet, mode, fallbackDiscounts = []) => {
+    var _a, _b, _c, _d, _e, _f;
+    const offerSetDiscounts = getOfferSetDiscounts(offerSet);
+    if (offerSetDiscounts.length === 0) {
+        return fallbackDiscounts;
+    }
+    const sortedDiscounts = offerSetDiscounts
+        .slice()
+        .sort((left, right) => { var _a, _b; return ((_a = readFiniteNumber(left.position)) !== null && _a !== void 0 ? _a : 0) - ((_b = readFiniteNumber(right.position)) !== null && _b !== void 0 ? _b : 0); });
+    const firstFallback = (_a = fallbackDiscounts.find((discount) => discount.stage === 'first')) !== null && _a !== void 0 ? _a : null;
+    const secondFallback = (_b = fallbackDiscounts.find((discount) => discount.stage === 'second')) !== null && _b !== void 0 ? _b : null;
+    const firstDiscount = (_c = sortedDiscounts.find((discount, index) => !isSecondDiscount(discount, index))) !== null && _c !== void 0 ? _c : sortedDiscounts[0];
+    const secondDiscount = (_e = (_d = sortedDiscounts.find((discount, index) => isSecondDiscount(discount, index))) !== null && _d !== void 0 ? _d : sortedDiscounts[1]) !== null && _e !== void 0 ? _e : sortedDiscounts[0];
+    const firstCouponId = firstDiscount ? readDiscountCouponId(firstDiscount, mode) : null;
+    const secondCouponId = secondDiscount ? readDiscountCouponId(secondDiscount, mode) : null;
+    if (!firstDiscount || !secondDiscount || !firstCouponId || !secondCouponId) {
+        return fallbackDiscounts;
+    }
+    const firstDiscountPercent = readDiscountPercent(firstDiscount, firstFallback);
+    const secondMetadata = isRecord(secondDiscount.metadata) ? secondDiscount.metadata : {};
+    return [
+        {
+            stage: 'first',
+            couponId: firstCouponId,
+            discountPercent: firstDiscountPercent,
+            durationSeconds: readDiscountDurationSeconds(firstDiscount, firstFallback),
+            previousDiscountPercent: null,
+        },
+        {
+            stage: 'second',
+            couponId: secondCouponId,
+            discountPercent: readDiscountPercent(secondDiscount, secondFallback),
+            durationSeconds: readDiscountDurationSeconds(secondDiscount, secondFallback),
+            previousDiscountPercent: (_f = readPositiveInteger(secondMetadata.previousDiscountPercent)) !== null && _f !== void 0 ? _f : firstDiscountPercent,
+        },
+    ];
+};
+export const resolveGeneratedOfferSetRuntime = (input) => {
+    var _a, _b;
+    const offerSet = findGeneratedOfferSet(input.offerSets, input.offerSetKey);
+    const planItems = getSortedItemsByKind(offerSet, 'plan');
+    const upsellItems = getSortedItemsByKind(offerSet, 'upsell');
+    const downsellItems = getSortedItemsByKind(offerSet, 'downsell');
+    const planKeys = planItems
+        .map((item) => resolveOfferItemRuntimeKey(item, input.baseCatalogsByMode))
+        .filter((key) => Boolean(key));
+    const upsellPlanKeys = upsellItems
+        .map((item) => resolveOfferItemRuntimeKey(item, input.baseCatalogsByMode))
+        .filter((key) => Boolean(key));
+    const downsellPlanKeys = (downsellItems.length > 0 ? downsellItems : planItems)
+        .map((item) => resolveOfferItemRuntimeKey(item, input.baseCatalogsByMode))
+        .filter((key) => Boolean(key));
+    const defaultPlanKey = (_b = resolveOfferItemRuntimeKey((_a = planItems.find((item) => item.isDefault === true)) !== null && _a !== void 0 ? _a : planItems[0], input.baseCatalogsByMode)) !== null && _b !== void 0 ? _b : '';
+    const plansByMode = {
+        test: applyGeneratedOfferSetToPlanCatalog(input.baseCatalogsByMode.test, 'test', offerSet),
+        live: applyGeneratedOfferSetToPlanCatalog(input.baseCatalogsByMode.live, 'live', offerSet),
+    };
+    const discountListsByMode = {
+        test: buildGeneratedOfferSetDiscountList(offerSet, 'test', input.fallbackDiscounts),
+        live: buildGeneratedOfferSetDiscountList(offerSet, 'live', input.fallbackDiscounts),
+    };
+    return {
+        offerSet,
+        plansByMode,
+        planKeys,
+        upsellPlanKeys,
+        downsellPlanKeys,
+        defaultPlanKey,
+        discountListsByMode,
+        getPlanCatalog: (mode) => plansByMode[mode],
+        getDiscountList: (mode) => discountListsByMode[mode],
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@funnelsgrove/runtime",
-  "version": "0.1.36",
+  "version": "0.1.38",
   "type": "module",
   "private": false,
   "main": "./dist/index.js",