@funnelsgrove/runtime 0.7.2 → 0.7.4

package/README.md

@@ -20,6 +20,7 @@ documented in [`docs/product-specs/funnel-template-runtime.md`](../../docs/produ
 - funnel context, flow controller, and generic runtime UI primitives
 - funnel-scoped state/storage helpers
 - browser-safe API client helpers used by funnels
+- reactive browser query-string access through `useBrowserLocationSearch`
 - subscription handoff and subscription management screens whose copy stays funnel-local
 - test-mode developer info surfaces for funnel preview tooling
 
@@ -54,6 +55,9 @@ documented in [`docs/product-specs/funnel-template-runtime.md`](../../docs/produ
 - Do not import `@funnelsgrove/payments` or `@funnelsgrove/analytics` here for checkout or transport orchestration.
 - Runtime UI must be generic and copy-injectable.
 - Browser-only values must resolve after mount when SSR hydration can be affected.
+- Funnel code must not copy `useSyncExternalStore`/`popstate` query-string hooks. Use
+  `useBrowserLocationSearch`; the shared controller also notifies it after
+  `history.pushState` and `history.replaceState` navigation.
 - Keep env mapping centralized in `config/env.config.ts`.
 
 ## Build, Test, Publish

package/dist/index.d.ts

@@ -18,6 +18,7 @@ export * from './runtime/funnel-runtime.js';
 export type { FunnelNavigationOutcome, FunnelStepExitReason, } from './runtime/funnel-step-lifecycle.js';
 export * from './runtime/posthog-flags.js';
 export * from './runtime/use-funnel-flow-controller.js';
+export * from './runtime/use-browser-location-search.js';
 export { useStepChoices } from './runtime/use-step-choices.js';
 export type { FunnelStepChoices } from './runtime/use-step-choices.js';
 export * from './runtime/preview-bridge.js';

package/dist/index.js

@@ -20,6 +20,7 @@ export * from './runtime/funnel-step-metadata.validation.js';
 export * from './runtime/funnel-runtime.js';
 export * from './runtime/posthog-flags.js';
 export * from './runtime/use-funnel-flow-controller.js';
+export * from './runtime/use-browser-location-search.js';
 export { useStepChoices } from './runtime/use-step-choices.js';
 export * from './runtime/preview-bridge.js';
 export * from './runtime/preview-definition-overrides.js';

package/dist/runtime/browser-helpers.d.ts

@@ -1,8 +1,10 @@
 export declare const canUseDom: () => boolean;
+export declare const FUNNEL_LOCATION_CHANGE_EVENT = "funnel:location-change";
 export declare const readWindowStorageValue: (storageKey: string) => string | null;
 export declare const writeWindowStorageValue: (storageKey: string, value: string) => void;
 export declare const removeWindowStorageValue: (storageKey: string) => void;
 export declare const dispatchWindowCustomEvent: <Detail>(eventType: string, detail: Detail) => void;
+export declare const dispatchFunnelLocationChange: () => void;
 export declare const buildHostedStepLocation: (input: {
     currentHref: string;
     stepPath: string;

package/dist/runtime/browser-helpers.js

@@ -1,6 +1,7 @@
 export const canUseDom = () => {
     return typeof window !== 'undefined';
 };
+export const FUNNEL_LOCATION_CHANGE_EVENT = 'funnel:location-change';
 export const readWindowStorageValue = (storageKey) => {
     if (!canUseDom()) {
         return null;
@@ -42,6 +43,14 @@ export const dispatchWindowCustomEvent = (eventType, detail) => {
         detail,
     }));
 };
+export const dispatchFunnelLocationChange = () => {
+    if (!canUseDom()) {
+        return;
+    }
+    dispatchWindowCustomEvent(FUNNEL_LOCATION_CHANGE_EVENT, {
+        href: window.location.href,
+    });
+};
 const getHostedFunnelBaseSegments = (pathname) => {
     const pathSegments = pathname.split('/').filter(Boolean);
     if (pathSegments[0] === 'published' && pathSegments[1] === 'f' && pathSegments[2]) {

package/dist/runtime/use-browser-location-search.d.ts

@@ -0,0 +1,2 @@
+export declare const getBrowserLocationSearch: () => string;
+export declare const useBrowserLocationSearch: () => string;

package/dist/runtime/use-browser-location-search.js

@@ -0,0 +1,20 @@
+'use client';
+import { useSyncExternalStore } from 'react';
+import { FUNNEL_LOCATION_CHANGE_EVENT } from './browser-helpers.js';
+const subscribeToBrowserLocationSearch = (onStoreChange) => {
+    if (typeof window === 'undefined') {
+        return () => undefined;
+    }
+    window.addEventListener('popstate', onStoreChange);
+    window.addEventListener(FUNNEL_LOCATION_CHANGE_EVENT, onStoreChange);
+    return () => {
+        window.removeEventListener('popstate', onStoreChange);
+        window.removeEventListener(FUNNEL_LOCATION_CHANGE_EVENT, onStoreChange);
+    };
+};
+export const getBrowserLocationSearch = () => {
+    return typeof window === 'undefined' ? '' : window.location.search;
+};
+export const useBrowserLocationSearch = () => {
+    return useSyncExternalStore(subscribeToBrowserLocationSearch, getBrowserLocationSearch, () => '');
+};

package/dist/runtime/use-funnel-flow-controller.js

@@ -4,7 +4,7 @@ import { writeStepChoice } from '../sdk/userAnswers.js';
 import { apiService } from '../services/api.service.js';
 import { logger } from '../services/logger.js';
 import { FUNNEL_ID, POSTHOG_API_HOST, POSTHOG_PROJECT_API_KEY, PROJECT_ID, } from '../services/runtime-api.config.js';
-import { buildHostedStepLocation, dispatchWindowCustomEvent, } from './browser-helpers.js';
+import { buildHostedStepLocation, dispatchFunnelLocationChange, dispatchWindowCustomEvent, } from './browser-helpers.js';
 import { isPreviewStepLockRequested, resolveNextStepFromContext, shouldRunAutoAdvanceTimer, } from './funnel-flow.js';
 import { usePreviewBridge } from './preview-bridge.js';
 import { resolveExperimentAssignment, resolveForcedExperimentAssignment, } from './experiment-assignment.js';
@@ -422,6 +422,7 @@ export function useFunnelFlowController({ api = apiService, analytics, stepContr
             else {
                 window.history.pushState({ stepId: safeStepId }, '', nextLocation);
             }
+            dispatchFunnelLocationChange();
         }
         setActiveStepId(safeStepId);
     }, [getPathForStep]);

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

@@ -1,11 +1,9 @@
 import type { FunnelExperimentDefinition } from '../config/funnel.experiments.types.js';
 import type { GeneratedOfferSet } from '../runtime/offer-set-runtime.js';
 export type FunnelRuntimeConfig = {
-    schemaVersion: number;
+    schemaVersion: 2;
     funnelId: string;
     projectId: string;
-    /** Present only on historical schema-v1 artifacts. */
-    plans?: unknown[];
     offerSets: unknown[];
     experiments: unknown[];
 };
@@ -21,7 +19,7 @@ export type PublishedFunnelRuntimeConfig = {
     revisionId: string;
     sourceDeploymentId: string;
     sourceVersionId: string;
-    schemaVersion: number;
+    schemaVersion: 2;
     publishedAt: string;
     config: FunnelRuntimeConfig;
 };

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

@@ -25,20 +25,7 @@ const deepFreeze = (value) => {
     }
     return value;
 };
-const getLegacyPlanById = (plans, projectBillingPlanId) => {
-    var _a;
-    return (projectBillingPlanId
-        ? (_a = plans.find((plan) => pickString(plan, 'id') === projectBillingPlanId)) !== null && _a !== void 0 ? _a : null
-        : null);
-};
-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, mode, legacyPlan = null) => {
-    var _a, _b;
+const buildPlanModeConfig = (item, mode) => {
     const metadata = isRecord(item.metadata) ? item.metadata : {};
     const directMappings = isRecord(item.providerMappingsByMode)
         ? item.providerMappingsByMode
@@ -51,20 +38,16 @@ const buildPlanModeConfig = (item, mode, legacyPlan = null) => {
         : isRecord(metadataMappings[mode])
             ? metadataMappings[mode]
             : {};
-    const legacyMapping = getLegacyProviderMapping(legacyPlan, mode);
     const prefix = mode === 'test' ? 'test' : 'live';
     const providerPlanId = (pickString(item, `${prefix}ProviderPlanId`, `${prefix}_provider_plan_id`)
-        || pickString(modeMapping, 'providerPlanId')
-        || (legacyMapping ? pickString(legacyMapping, 'providerPlanId', 'provider_plan_id') : null));
+        || pickString(modeMapping, 'providerPlanId'));
     if (!providerPlanId) {
         return null;
     }
-    const amountMinor = (_a = pickNumber(modeMapping, 'amountCents')) !== null && _a !== void 0 ? _a : (legacyMapping ? pickNumber(legacyMapping, 'amountMinor', 'amount_minor') : null);
-    const interval = pickString(modeMapping, 'billingInterval')
-        || (legacyMapping ? pickString(legacyMapping, 'interval') : null);
-    const intervalCount = (_b = pickNumber(modeMapping, 'billingIntervalCount')) !== null && _b !== void 0 ? _b : (legacyMapping ? pickNumber(legacyMapping, 'intervalCount', 'interval_count') : null);
-    const currency = pickString(modeMapping, 'currency')
-        || (legacyMapping ? pickString(legacyMapping, 'currency') : null);
+    const amountMinor = pickNumber(modeMapping, 'amountCents');
+    const interval = pickString(modeMapping, 'billingInterval');
+    const intervalCount = pickNumber(modeMapping, 'billingIntervalCount');
+    const currency = pickString(modeMapping, 'currency');
     const amountMajor = amountMinor === null ? null : amountMinor / 100;
     const priceLabel = pickString(modeMapping, 'priceLabel') || (amountMajor === null
         ? null
@@ -90,7 +73,6 @@ const buildPlanModeConfig = (item, mode, legacyPlan = null) => {
                 }).format(amountMajor)} today` })), (interval ? { billingInterval: interval } : {})), (intervalCount === null ? {} : { billingIntervalCount: intervalCount }));
 };
 const normalizePublishedOfferSets = (config) => {
-    const legacyPlans = readRecordArray(config.plans);
     return readRecordArray(config.offerSets).map((offerSet) => {
         var _a;
         const key = pickString(offerSet, 'key');
@@ -105,15 +87,12 @@ 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 legacyPlan = getLegacyPlanById(legacyPlans, projectBillingPlanId);
-            const testMapping = buildPlanModeConfig(item, 'test', legacyPlan);
-            const liveMapping = buildPlanModeConfig(item, 'live', legacyPlan);
+            const testMapping = buildPlanModeConfig(item, 'test');
+            const liveMapping = buildPlanModeConfig(item, 'live');
             const title = pickString(item, 'title', 'displayNameOverride', 'display_name_override')
-                || pickString(metadata, 'title', 'publicPlanName', 'public_plan_name')
-                || (legacyPlan ? pickString(legacyPlan, 'displayName', 'display_name') : null);
+                || pickString(metadata, 'title', 'publicPlanName', 'public_plan_name');
             const description = pickString(item, 'description')
-                || pickString(metadata, 'description')
-                || (legacyPlan ? pickString(legacyPlan, 'description') : null);
+                || pickString(metadata, 'description');
             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')
@@ -251,14 +230,13 @@ const parsePublishedRuntimeConfig = (value) => {
     if (typeof value.revisionId !== 'string'
         || typeof value.sourceDeploymentId !== 'string'
         || typeof value.sourceVersionId !== 'string'
-        || typeof value.schemaVersion !== 'number'
+        || value.schemaVersion !== 2
         || typeof value.publishedAt !== 'string'
-        || (schemaVersion !== 1 && schemaVersion !== 2)
+        || schemaVersion !== 2
         || typeof config.funnelId !== 'string'
         || typeof config.projectId !== 'string'
         || !Array.isArray(config.offerSets)
-        || !Array.isArray(config.experiments)
-        || (schemaVersion === 1 && !Array.isArray(config.plans))) {
+        || !Array.isArray(config.experiments)) {
         throw new Error('Funnel runtime config response is invalid');
     }
     return value;

package/dist/services/funnel-sdk.service.d.ts

@@ -212,10 +212,12 @@ export type FunnelSdkCreateOneTimePaymentIntentResponse = {
 };
 export type FunnelSdkChargeOneClickPaymentInput = {
     planId: string;
+    providerPlanId?: string | null;
     amountCents: number;
     analyticsMetadata?: Record<string, unknown> | null;
     checkoutSessionId?: string | null;
     currency?: string | null;
+    description?: string | null;
     environment?: FunnelSdkRuntimeMode;
     idempotencyKey?: string | null;
     runtimeConfig?: FunnelSdkRuntimeConfigOverrides;

package/dist/services/funnel-sdk.service.js

@@ -329,8 +329,10 @@ class FunnelSdkService {
             runtimeConfig: input.runtimeConfig,
             body: {
                 planId: input.planId,
+                providerPlanId: input.providerPlanId,
                 amountCents: input.amountCents,
                 currency: input.currency,
+                description: input.description,
                 analyticsMetadata: input.analyticsMetadata,
                 user_id: input.userId,
                 stripe_customer_id: input.stripeCustomerId,

package/package.json

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