@funnelsgrove/runtime 0.6.0 → 0.7.0

package/dist/config/funnel.experiments.types.d.ts

@@ -15,7 +15,7 @@ type FunnelRouteExperimentVariantDefinition = {
 };
 type FunnelPricingExperimentVariantDefinition = {
     variantKey?: string;
-    offerSetKey: string;
+    offerSetId: string;
     label?: string;
     trafficPercent: number;
 };

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

@@ -101,6 +101,8 @@ export type OfferSetRuntimePlanOverrides = {
 };
 export type OfferSetRuntimeInput<TPlan extends Record<string, unknown>> = {
     offerSets: readonly GeneratedOfferSet[];
+    offerSetId?: string;
+    /** @deprecated Prefer the immutable offerSetId. */
     offerSetKey?: string;
     baseCatalogsByMode?: Partial<Record<RuntimeMode, Record<string, TPlan>>>;
     fallbackDiscounts?: readonly OfferSetRuntimeDiscount[];
@@ -116,7 +118,7 @@ export type OfferSetRuntimeResult<TPlan extends Record<string, unknown>> = {
     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 findGeneratedOfferSet: (offerSets: readonly GeneratedOfferSet[], offerSetKey?: string, offerSetId?: 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> = Record<string, unknown>>(input: OfferSetRuntimeInput<TPlan>) => OfferSetRuntimeResult<TPlan>;

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

@@ -58,10 +58,10 @@ const getSortedItemsByKind = (offerSet, kind) => {
         return leftPosition - rightPosition;
     })) !== null && _a !== void 0 ? _a : []);
 };
-export const findGeneratedOfferSet = (offerSets, offerSetKey) => {
-    var _a, _b;
+export const findGeneratedOfferSet = (offerSets, offerSetKey, offerSetId) => {
+    var _a, _b, _c;
     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);
+    return ((_c = (_b = (_a = activeOfferSets.find((offerSet) => offerSet.id === offerSetId)) !== null && _a !== void 0 ? _a : activeOfferSets.find((offerSet) => offerSet.key === offerSetKey)) !== null && _b !== void 0 ? _b : activeOfferSets[0]) !== null && _c !== void 0 ? _c : null);
 };
 const resolveCatalogKey = (baseCatalog, funnelPlanKey) => {
     var _a;
@@ -248,7 +248,7 @@ export const buildGeneratedOfferSetDiscountList = (offerSet, mode, fallbackDisco
 };
 export const resolveGeneratedOfferSetRuntime = (input) => {
     var _a, _b, _c, _d, _e, _f;
-    const offerSet = findGeneratedOfferSet(input.offerSets, input.offerSetKey);
+    const offerSet = findGeneratedOfferSet(input.offerSets, input.offerSetKey, input.offerSetId);
     const baseCatalogsByMode = {
         test: (_b = (_a = input.baseCatalogsByMode) === null || _a === void 0 ? void 0 : _a.test) !== null && _b !== void 0 ? _b : {},
         live: (_d = (_c = input.baseCatalogsByMode) === null || _c === void 0 ? void 0 : _c.live) !== null && _d !== void 0 ? _d : {},

package/dist/services/funnel-runtime-config.d.ts

@@ -4,7 +4,8 @@ export type FunnelRuntimeConfig = {
     schemaVersion: number;
     funnelId: string;
     projectId: string;
-    plans: unknown[];
+    /** Present only on historical schema-v1 artifacts. */
+    plans?: unknown[];
     offerSets: unknown[];
     experiments: unknown[];
 };

package/dist/services/funnel-runtime-config.js

@@ -25,38 +25,39 @@ const deepFreeze = (value) => {
     }
     return value;
 };
-const getPlanById = (plans, projectBillingPlanId) => {
+const getLegacyPlanById = (plans, projectBillingPlanId) => {
     var _a;
     return (projectBillingPlanId
         ? (_a = plans.find((plan) => pickString(plan, 'id') === projectBillingPlanId)) !== null && _a !== void 0 ? _a : null
         : null);
 };
-const getProviderMapping = (plan, mode) => {
+const getLegacyProviderMapping = (plan, mode) => {
     var _a;
     return ((_a = readRecordArray(plan === null || plan === void 0 ? void 0 : plan.providerMappings)
         .find((mapping) => (pickString(mapping, 'environment') === mode
         && pickBoolean(mapping, 'isActive', 'is_active') !== false))) !== null && _a !== void 0 ? _a : null);
 };
-const buildPlanModeConfig = (item, plan, mode) => {
+const buildPlanModeConfig = (item, mode, legacyPlan = null) => {
     var _a, _b;
     const metadata = isRecord(item.metadata) ? item.metadata : {};
     const metadataMappings = isRecord(metadata.providerMappingsByMode)
         ? metadata.providerMappingsByMode
         : {};
     const metadataMapping = isRecord(metadataMappings[mode]) ? metadataMappings[mode] : {};
-    const planMapping = getProviderMapping(plan, mode);
+    const legacyMapping = getLegacyProviderMapping(legacyPlan, mode);
     const prefix = mode === 'test' ? 'test' : 'live';
     const providerPlanId = (pickString(item, `${prefix}ProviderPlanId`, `${prefix}_provider_plan_id`)
         || pickString(metadataMapping, 'providerPlanId')
-        || (planMapping ? pickString(planMapping, 'providerPlanId', 'provider_plan_id') : null));
+        || (legacyMapping ? pickString(legacyMapping, 'providerPlanId', 'provider_plan_id') : null));
     if (!providerPlanId) {
         return null;
     }
-    const amountMinor = (_a = pickNumber(metadataMapping, 'amountCents')) !== null && _a !== void 0 ? _a : (planMapping ? pickNumber(planMapping, 'amountMinor', 'amount_minor') : null);
+    const amountMinor = (_a = pickNumber(metadataMapping, 'amountCents')) !== null && _a !== void 0 ? _a : (legacyMapping ? pickNumber(legacyMapping, 'amountMinor', 'amount_minor') : null);
     const interval = pickString(metadataMapping, 'billingInterval')
-        || (planMapping ? pickString(planMapping, 'interval') : null);
-    const intervalCount = (_b = pickNumber(metadataMapping, 'billingIntervalCount')) !== null && _b !== void 0 ? _b : (planMapping ? pickNumber(planMapping, 'intervalCount', 'interval_count') : null);
-    const currency = planMapping ? pickString(planMapping, 'currency') : null;
+        || (legacyMapping ? pickString(legacyMapping, 'interval') : null);
+    const intervalCount = (_b = pickNumber(metadataMapping, 'billingIntervalCount')) !== null && _b !== void 0 ? _b : (legacyMapping ? pickNumber(legacyMapping, 'intervalCount', 'interval_count') : null);
+    const currency = pickString(metadataMapping, 'currency')
+        || (legacyMapping ? pickString(legacyMapping, 'currency') : null);
     const amountMajor = amountMinor === null ? null : amountMinor / 100;
     const priceLabel = pickString(metadataMapping, 'priceLabel') || (amountMajor === null
         ? null
@@ -82,7 +83,7 @@ const buildPlanModeConfig = (item, plan, mode) => {
                 }).format(amountMajor)} today` })), (interval ? { billingInterval: interval } : {})), (intervalCount === null ? {} : { billingIntervalCount: intervalCount }));
 };
 const normalizePublishedOfferSets = (config) => {
-    const plans = readRecordArray(config.plans);
+    const legacyPlans = readRecordArray(config.plans);
     return readRecordArray(config.offerSets).map((offerSet) => {
         var _a;
         const key = pickString(offerSet, 'key');
@@ -97,15 +98,15 @@ const normalizePublishedOfferSets = (config) => {
                 throw new Error(`Published runtime offer set "${key}" has an item without a plan key`);
             }
             const projectBillingPlanId = pickString(item, 'projectBillingPlanId', 'project_billing_plan_id');
-            const plan = getPlanById(plans, projectBillingPlanId);
-            const testMapping = buildPlanModeConfig(item, plan, 'test');
-            const liveMapping = buildPlanModeConfig(item, plan, 'live');
+            const legacyPlan = getLegacyPlanById(legacyPlans, projectBillingPlanId);
+            const testMapping = buildPlanModeConfig(item, 'test', legacyPlan);
+            const liveMapping = buildPlanModeConfig(item, 'live', legacyPlan);
             const title = pickString(item, 'title', 'displayNameOverride', 'display_name_override')
                 || pickString(metadata, 'title', 'publicPlanName', 'public_plan_name')
-                || (plan ? pickString(plan, 'displayName', 'display_name') : null);
+                || (legacyPlan ? pickString(legacyPlan, 'displayName', 'display_name') : null);
             const description = pickString(item, 'description')
                 || pickString(metadata, 'description')
-                || (plan ? pickString(plan, 'description') : null);
+                || (legacyPlan ? pickString(legacyPlan, 'description') : null);
             return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ funnelPlanKey }, (pickString(metadata, 'runtimePlanKey', 'planKey', 'billingPlanKey')
                 ? { runtimePlanKey: pickString(metadata, 'runtimePlanKey', 'planKey', 'billingPlanKey') }
                 : {})), (projectBillingPlanId ? { projectBillingPlanId } : {})), (pickString(item, 'testProviderPlanId', 'test_provider_plan_id')
@@ -135,7 +136,7 @@ const normalizePublishedOfferSets = (config) => {
         return Object.assign(Object.assign({}, (pickString(offerSet, 'id') ? { id: pickString(offerSet, 'id') } : {})), { key, isActive: (_a = pickBoolean(offerSet, 'isActive', 'is_active')) !== null && _a !== void 0 ? _a : true, metadata: isRecord(offerSet.metadata) ? offerSet.metadata : {}, items });
     });
 };
-const normalizePublishedExperiments = (config, publishedAt) => readRecordArray(config.experiments).map((experiment) => {
+const normalizePublishedExperiments = (config, publishedAt, offerSets) => readRecordArray(config.experiments).map((experiment) => {
     const conversionConfig = isRecord(experiment.conversionConfig)
         ? experiment.conversionConfig
         : isRecord(experiment.conversion_config)
@@ -171,16 +172,26 @@ const normalizePublishedExperiments = (config, publishedAt) => readRecordArray(c
         || pickString(experiment, 'startedAt', 'started_at')
         || publishedAt).slice(0, 10);
     if (type === 'pricing') {
-        const configuredKeys = Array.isArray(conversionConfig.offerSetKeys)
-            ? conversionConfig.offerSetKeys.map(readString).filter((value) => Boolean(value))
+        const directIds = normalizedVariants.map((variant, index) => (pickString(variants[index] || {}, 'offerSetId', 'offer_set_id')));
+        const legacyKeys = Array.isArray(conversionConfig.offerSetKeys)
+            ? conversionConfig.offerSetKeys.map(readString)
             : [
                 pickString(conversionConfig, 'controlOfferSetKey'),
                 pickString(conversionConfig, 'variantOfferSetKey'),
-            ].filter((value) => Boolean(value));
-        if (configuredKeys.length !== normalizedVariants.length) {
+            ];
+        const configuredIds = directIds.map((offerSetId, index) => {
+            var _a, _b;
+            if (offerSetId)
+                return offerSetId;
+            const legacyKey = legacyKeys[index];
+            return legacyKey
+                ? (_b = (_a = offerSets.find((offerSet) => offerSet.key === legacyKey)) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : null
+                : null;
+        });
+        if (configuredIds.some((offerSetId) => !offerSetId)) {
             throw new Error(`Published pricing experiment "${id}" does not map every variant to an offer set`);
         }
-        const pricingVariants = normalizedVariants.map((variant, index) => (Object.assign(Object.assign({ variantKey: variant.variantKey }, (variant.label ? { label: variant.label } : {})), { trafficPercent: variant.trafficPercent, offerSetKey: configuredKeys[index] })));
+        const pricingVariants = normalizedVariants.map((variant, index) => (Object.assign(Object.assign({ variantKey: variant.variantKey }, (variant.label ? { label: variant.label } : {})), { trafficPercent: variant.trafficPercent, offerSetId: configuredIds[index] })));
         return {
             id,
             name,
@@ -214,13 +225,14 @@ export const resolvePublishedFunnelRuntimeConfig = (published, options = {}) =>
         && published.sourceVersionId !== options.expectedFunnelVersionId) {
         throw new Error('Published runtime config belongs to a different funnel version');
     }
+    const offerSets = normalizePublishedOfferSets(published.config);
     return deepFreeze({
         revisionId: published.revisionId,
         sourceDeploymentId: published.sourceDeploymentId,
         sourceVersionId: published.sourceVersionId,
         publishedAt: published.publishedAt,
-        offerSets: normalizePublishedOfferSets(published.config),
-        experiments: normalizePublishedExperiments(published.config, published.publishedAt),
+        offerSets,
+        experiments: normalizePublishedExperiments(published.config, published.publishedAt, offerSets),
     });
 };
 const parsePublishedRuntimeConfig = (value) => {
@@ -228,17 +240,18 @@ const parsePublishedRuntimeConfig = (value) => {
         throw new Error('Funnel runtime config response is invalid');
     }
     const config = value.config;
+    const schemaVersion = typeof config.schemaVersion === 'number' ? config.schemaVersion : null;
     if (typeof value.revisionId !== 'string'
         || typeof value.sourceDeploymentId !== 'string'
         || typeof value.sourceVersionId !== 'string'
         || typeof value.schemaVersion !== 'number'
         || typeof value.publishedAt !== 'string'
-        || typeof config.schemaVersion !== 'number'
+        || (schemaVersion !== 1 && schemaVersion !== 2)
         || typeof config.funnelId !== 'string'
         || typeof config.projectId !== 'string'
-        || !Array.isArray(config.plans)
         || !Array.isArray(config.offerSets)
-        || !Array.isArray(config.experiments)) {
+        || !Array.isArray(config.experiments)
+        || (schemaVersion === 1 && !Array.isArray(config.plans))) {
         throw new Error('Funnel runtime config response is invalid');
     }
     return value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@funnelsgrove/runtime",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/The-Solid-Grove/funnelsgrove.git",