@appfunnel-dev/sdk 2.0.0-canary.10 → 2.0.0-canary.12

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 import { ReactNode, ComponentType, ButtonHTMLAttributes } from 'react';
-import { V as VariableValue, a as VariableConfig, A as Acquisition, O as Offering, D as Direction, F as FunnelContext, R as RuntimeExperiment, b as FunnelSnapshot, c as FunnelDefinition, d as buildContext, e as OfferingInput, P as PageMeta, f as PageContext } from './manifest-B3Tdab0M.cjs';
-export { B as BrowserContext, g as BuildContextOptions, C as ClickIdContext, h as CompileInput, i as Condition, j as ConditionOp, k as DeviceContext, E as EdgeCondition, l as ExperimentArm, m as ExperimentResolution, n as FlowPage, o as FunnelLocales, p as FunnelManifest, G as Gate, I as IdentityContext, q as Interval, L as LocaleContext, M as ManifestEdge, r as ManifestPage, s as ManifestValidation, t as Money, u as OsContext, v as PageType, w as Predicate, x as ResolvedOffering, y as Route, S as SessionContext, z as SystemContext, U as UtmContext, H as assignVariant, J as bucketingSeed, K as buildAcquisition, N as buildCatalog, Q as compileManifest, T as currencyExponent, W as defineFunnel, X as definePage, Y as entryGuard, Z as evaluateCondition, _ as evaluateGate, $ as expectedPathLength, a0 as fnv1a, a1 as formatMoney, a2 as formatOffering, a3 as hashToUnit, a4 as isRtl, a5 as isVariantKey, a6 as nextPage, a7 as outgoingKeys, a8 as pageMeta, a9 as parseSlotKey, aa as pickByWeight, ab as resolveExperiments, ac as resolveLocale, ad as resolveOffering, ae as resolveRoute } from './manifest-B3Tdab0M.cjs';
+import { V as VariableValue, a as VariableConfig, A as Acquisition, O as Offering, D as Direction, F as FunnelContext, R as RuntimeExperiment, b as FunnelSnapshot, c as FunnelDefinition, d as buildContext, e as OfferingInput, P as PageMeta, f as PageContext, G as GroupProgress } from './manifest-CTt2LlUV.cjs';
+export { B as BrowserContext, g as BuildContextOptions, C as ClickIdContext, h as CompileInput, i as Condition, j as ConditionOp, k as DeviceContext, E as EdgeCondition, l as ExperimentArm, m as ExperimentResolution, n as FlowPage, o as FunnelLocales, p as FunnelManifest, q as Gate, I as IdentityContext, r as Interval, L as LocaleContext, M as ManifestEdge, s as ManifestPage, t as ManifestValidation, u as Money, v as OsContext, w as PageComponent, x as PageGroup, y as PageType, z as Predicate, H as ResolvedOffering, J as Route, S as SessionContext, K as SystemContext, U as UtmContext, N as assignVariant, Q as bucketingSeed, T as buildAcquisition, W as buildCatalog, X as compileManifest, Y as currencyExponent, Z as defineFunnel, _ as definePage, $ as entryGuard, a0 as evaluateCondition, a1 as evaluateGate, a2 as expectedPathLength, a3 as fnv1a, a4 as formatMoney, a5 as formatOffering, a6 as groupProgress, a7 as hashToUnit, a8 as isRtl, a9 as isVariantKey, aa as nextPage, ab as outgoingKeys, ac as pageMeta, ad as parseSlotKey, ae as pickByWeight, af as resolveExperiments, ag as resolveLocale, ah as resolveOffering, ai as resolveRoute } from './manifest-CTt2LlUV.cjs';
 import { NavSnapshot } from './protocol.cjs';
 import { a as CheckoutDriver, C as CheckoutDriverContext } from './checkout-DBp4bCpC.cjs';
 export { b as Checkout, c as CheckoutCallbacks, d as CheckoutHandle, e as CheckoutProps, f as CheckoutRequest, g as CheckoutResult, h as CheckoutResume, i as CheckoutStatus, F as FailureModalProps, j as FailureRoute, M as MockDriverOptions, O as OnFailedMap, U as Upsell, k as UpsellProps, l as UseCheckoutOptions, m as createMockDriver, n as driverWithEmail, u as useCheckout } from './checkout-DBp4bCpC.cjs';
@@ -618,6 +618,21 @@ declare function FunnelView({ pages, initialKey, trustInitialKey, layout, fallba
 declare function useNavigation(): NavigationState;
 /** `usePage()` — the current page's read-only context, reactive to navigation. */
 declare function usePage(): PageContext;
+/**
+ * `useGroupProgress()` — the visitor-routed, branch-aware grouped-progress structure
+ * for a grouped `<ProgressBar>`: ordered {@link PageGroup} segments (from `meta.group`),
+ * the `activeIndex` of the current group (`-1` when the current page is ungrouped), and
+ * the active group's within-group `activeFraction` (0–1). Counts only the pages THIS
+ * visitor will actually visit given their answers (see {@link groupProgress}). A funnel
+ * with no `group` keys yields `{ groups: [], activeIndex: -1, activeFraction: 0 }`.
+ * Must be used inside `<FunnelView>`.
+ *
+ * Each segment's `key` is the **slug identifier** from {@link PageMeta.group}, NOT a
+ * display string — resolve it to a label in your funnel code, e.g.
+ * `const GROUP_LABELS = { profile: 'My Profile' }; GROUP_LABELS[group.key]` or
+ * `t(`groups.${group.key}`)`. This keeps grouping stable across copy and locale changes.
+ */
+declare function useGroupProgress(): GroupProgress;
 
 /**
  * Funnel asset map: logical name (e.g. `logo.svg`) → content-addressed CDN URL,
@@ -1094,4 +1109,4 @@ interface ScriptProps {
  */
 declare function Script({ src, strategy, id, async, defer, nonce, attributes, onLoad, onError, }: ScriptProps): null;
 
-export { Acquisition, type AppfunnelBusApi, AssetsContext, AssetsProvider, Back, type BackProps, type BusAccessors, type BusEvent, type CatalogEvent, CheckoutDriver, CheckoutDriverContext, Choice, type ChoiceOption, type ChoiceProps, type CreateFunnelTreeInput, Direction, EVENT_CATALOG, type EventMeta, type EventSource, type Formatters, type Funnel, type FunnelBus, FunnelContext, FunnelDefinition, type FunnelEventDataMap, FunnelProvider, type FunnelProviderProps, FunnelSnapshot, FunnelToaster, FunnelView, type KnownFunnelEvent, type MessageCatalog, Modal, type ModalHandler, type ModalHocProps, type ModalProps, type ModalState, type MountModule, type MountOpts, Namespace, type NavigationState, Next, type NextProps, Offering, OfferingInput, PageContext, PageMeta, type PageModule, type PlatformTrackingConfig, type PluralCategory, RuntimeExperiment, type RuntimePage, Script, type ScriptProps, Sheet, type SheetProps, type SheetSide, type TFunction, type Tracker, type Translation, VariableStore, attachBus, buildContext, createBus, createConsoleTracker, createFunnelStore, createFunnelTree, createPlatformTracker, defineModal, hideModal, integrationEvents, isIntegrationEvent, isTrackableEvent, newEventId, registerModal, removeModal, showModal, unregisterModal, useActiveLocale, useAsset, useAssets, useClickIds, useContextValue, useData, useDevice, useExperiment, useField, useFunnel, useLocale, useModal, useNavigation, useOffering, useOfferings, usePage, useResponse, useSystem, useTracker, useTranslation, useUserAttribute, useUtm, withBus };
+export { Acquisition, type AppfunnelBusApi, AssetsContext, AssetsProvider, Back, type BackProps, type BusAccessors, type BusEvent, type CatalogEvent, CheckoutDriver, CheckoutDriverContext, Choice, type ChoiceOption, type ChoiceProps, type CreateFunnelTreeInput, Direction, EVENT_CATALOG, type EventMeta, type EventSource, type Formatters, type Funnel, type FunnelBus, FunnelContext, FunnelDefinition, type FunnelEventDataMap, FunnelProvider, type FunnelProviderProps, FunnelSnapshot, FunnelToaster, FunnelView, GroupProgress, type KnownFunnelEvent, type MessageCatalog, Modal, type ModalHandler, type ModalHocProps, type ModalProps, type ModalState, type MountModule, type MountOpts, Namespace, type NavigationState, Next, type NextProps, Offering, OfferingInput, PageContext, PageMeta, type PageModule, type PlatformTrackingConfig, type PluralCategory, RuntimeExperiment, type RuntimePage, Script, type ScriptProps, Sheet, type SheetProps, type SheetSide, type TFunction, type Tracker, type Translation, VariableStore, attachBus, buildContext, createBus, createConsoleTracker, createFunnelStore, createFunnelTree, createPlatformTracker, defineModal, hideModal, integrationEvents, isIntegrationEvent, isTrackableEvent, newEventId, registerModal, removeModal, showModal, unregisterModal, useActiveLocale, useAsset, useAssets, useClickIds, useContextValue, useData, useDevice, useExperiment, useField, useFunnel, useGroupProgress, useLocale, useModal, useNavigation, useOffering, useOfferings, usePage, useResponse, useSystem, useTracker, useTranslation, useUserAttribute, useUtm, withBus };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 import { ReactNode, ComponentType, ButtonHTMLAttributes } from 'react';
-import { V as VariableValue, a as VariableConfig, A as Acquisition, O as Offering, D as Direction, F as FunnelContext, R as RuntimeExperiment, b as FunnelSnapshot, c as FunnelDefinition, d as buildContext, e as OfferingInput, P as PageMeta, f as PageContext } from './manifest-B3Tdab0M.js';
-export { B as BrowserContext, g as BuildContextOptions, C as ClickIdContext, h as CompileInput, i as Condition, j as ConditionOp, k as DeviceContext, E as EdgeCondition, l as ExperimentArm, m as ExperimentResolution, n as FlowPage, o as FunnelLocales, p as FunnelManifest, G as Gate, I as IdentityContext, q as Interval, L as LocaleContext, M as ManifestEdge, r as ManifestPage, s as ManifestValidation, t as Money, u as OsContext, v as PageType, w as Predicate, x as ResolvedOffering, y as Route, S as SessionContext, z as SystemContext, U as UtmContext, H as assignVariant, J as bucketingSeed, K as buildAcquisition, N as buildCatalog, Q as compileManifest, T as currencyExponent, W as defineFunnel, X as definePage, Y as entryGuard, Z as evaluateCondition, _ as evaluateGate, $ as expectedPathLength, a0 as fnv1a, a1 as formatMoney, a2 as formatOffering, a3 as hashToUnit, a4 as isRtl, a5 as isVariantKey, a6 as nextPage, a7 as outgoingKeys, a8 as pageMeta, a9 as parseSlotKey, aa as pickByWeight, ab as resolveExperiments, ac as resolveLocale, ad as resolveOffering, ae as resolveRoute } from './manifest-B3Tdab0M.js';
+import { V as VariableValue, a as VariableConfig, A as Acquisition, O as Offering, D as Direction, F as FunnelContext, R as RuntimeExperiment, b as FunnelSnapshot, c as FunnelDefinition, d as buildContext, e as OfferingInput, P as PageMeta, f as PageContext, G as GroupProgress } from './manifest-CTt2LlUV.js';
+export { B as BrowserContext, g as BuildContextOptions, C as ClickIdContext, h as CompileInput, i as Condition, j as ConditionOp, k as DeviceContext, E as EdgeCondition, l as ExperimentArm, m as ExperimentResolution, n as FlowPage, o as FunnelLocales, p as FunnelManifest, q as Gate, I as IdentityContext, r as Interval, L as LocaleContext, M as ManifestEdge, s as ManifestPage, t as ManifestValidation, u as Money, v as OsContext, w as PageComponent, x as PageGroup, y as PageType, z as Predicate, H as ResolvedOffering, J as Route, S as SessionContext, K as SystemContext, U as UtmContext, N as assignVariant, Q as bucketingSeed, T as buildAcquisition, W as buildCatalog, X as compileManifest, Y as currencyExponent, Z as defineFunnel, _ as definePage, $ as entryGuard, a0 as evaluateCondition, a1 as evaluateGate, a2 as expectedPathLength, a3 as fnv1a, a4 as formatMoney, a5 as formatOffering, a6 as groupProgress, a7 as hashToUnit, a8 as isRtl, a9 as isVariantKey, aa as nextPage, ab as outgoingKeys, ac as pageMeta, ad as parseSlotKey, ae as pickByWeight, af as resolveExperiments, ag as resolveLocale, ah as resolveOffering, ai as resolveRoute } from './manifest-CTt2LlUV.js';
 import { NavSnapshot } from './protocol.js';
 import { a as CheckoutDriver, C as CheckoutDriverContext } from './checkout-ClaO5IYV.js';
 export { b as Checkout, c as CheckoutCallbacks, d as CheckoutHandle, e as CheckoutProps, f as CheckoutRequest, g as CheckoutResult, h as CheckoutResume, i as CheckoutStatus, F as FailureModalProps, j as FailureRoute, M as MockDriverOptions, O as OnFailedMap, U as Upsell, k as UpsellProps, l as UseCheckoutOptions, m as createMockDriver, n as driverWithEmail, u as useCheckout } from './checkout-ClaO5IYV.js';
@@ -618,6 +618,21 @@ declare function FunnelView({ pages, initialKey, trustInitialKey, layout, fallba
 declare function useNavigation(): NavigationState;
 /** `usePage()` — the current page's read-only context, reactive to navigation. */
 declare function usePage(): PageContext;
+/**
+ * `useGroupProgress()` — the visitor-routed, branch-aware grouped-progress structure
+ * for a grouped `<ProgressBar>`: ordered {@link PageGroup} segments (from `meta.group`),
+ * the `activeIndex` of the current group (`-1` when the current page is ungrouped), and
+ * the active group's within-group `activeFraction` (0–1). Counts only the pages THIS
+ * visitor will actually visit given their answers (see {@link groupProgress}). A funnel
+ * with no `group` keys yields `{ groups: [], activeIndex: -1, activeFraction: 0 }`.
+ * Must be used inside `<FunnelView>`.
+ *
+ * Each segment's `key` is the **slug identifier** from {@link PageMeta.group}, NOT a
+ * display string — resolve it to a label in your funnel code, e.g.
+ * `const GROUP_LABELS = { profile: 'My Profile' }; GROUP_LABELS[group.key]` or
+ * `t(`groups.${group.key}`)`. This keeps grouping stable across copy and locale changes.
+ */
+declare function useGroupProgress(): GroupProgress;
 
 /**
  * Funnel asset map: logical name (e.g. `logo.svg`) → content-addressed CDN URL,
@@ -1094,4 +1109,4 @@ interface ScriptProps {
  */
 declare function Script({ src, strategy, id, async, defer, nonce, attributes, onLoad, onError, }: ScriptProps): null;
 
-export { Acquisition, type AppfunnelBusApi, AssetsContext, AssetsProvider, Back, type BackProps, type BusAccessors, type BusEvent, type CatalogEvent, CheckoutDriver, CheckoutDriverContext, Choice, type ChoiceOption, type ChoiceProps, type CreateFunnelTreeInput, Direction, EVENT_CATALOG, type EventMeta, type EventSource, type Formatters, type Funnel, type FunnelBus, FunnelContext, FunnelDefinition, type FunnelEventDataMap, FunnelProvider, type FunnelProviderProps, FunnelSnapshot, FunnelToaster, FunnelView, type KnownFunnelEvent, type MessageCatalog, Modal, type ModalHandler, type ModalHocProps, type ModalProps, type ModalState, type MountModule, type MountOpts, Namespace, type NavigationState, Next, type NextProps, Offering, OfferingInput, PageContext, PageMeta, type PageModule, type PlatformTrackingConfig, type PluralCategory, RuntimeExperiment, type RuntimePage, Script, type ScriptProps, Sheet, type SheetProps, type SheetSide, type TFunction, type Tracker, type Translation, VariableStore, attachBus, buildContext, createBus, createConsoleTracker, createFunnelStore, createFunnelTree, createPlatformTracker, defineModal, hideModal, integrationEvents, isIntegrationEvent, isTrackableEvent, newEventId, registerModal, removeModal, showModal, unregisterModal, useActiveLocale, useAsset, useAssets, useClickIds, useContextValue, useData, useDevice, useExperiment, useField, useFunnel, useLocale, useModal, useNavigation, useOffering, useOfferings, usePage, useResponse, useSystem, useTracker, useTranslation, useUserAttribute, useUtm, withBus };
+export { Acquisition, type AppfunnelBusApi, AssetsContext, AssetsProvider, Back, type BackProps, type BusAccessors, type BusEvent, type CatalogEvent, CheckoutDriver, CheckoutDriverContext, Choice, type ChoiceOption, type ChoiceProps, type CreateFunnelTreeInput, Direction, EVENT_CATALOG, type EventMeta, type EventSource, type Formatters, type Funnel, type FunnelBus, FunnelContext, FunnelDefinition, type FunnelEventDataMap, FunnelProvider, type FunnelProviderProps, FunnelSnapshot, FunnelToaster, FunnelView, GroupProgress, type KnownFunnelEvent, type MessageCatalog, Modal, type ModalHandler, type ModalHocProps, type ModalProps, type ModalState, type MountModule, type MountOpts, Namespace, type NavigationState, Next, type NextProps, Offering, OfferingInput, PageContext, PageMeta, type PageModule, type PlatformTrackingConfig, type PluralCategory, RuntimeExperiment, type RuntimePage, Script, type ScriptProps, Sheet, type SheetProps, type SheetSide, type TFunction, type Tracker, type Translation, VariableStore, attachBus, buildContext, createBus, createConsoleTracker, createFunnelStore, createFunnelTree, createPlatformTracker, defineModal, hideModal, integrationEvents, isIntegrationEvent, isTrackableEvent, newEventId, registerModal, removeModal, showModal, unregisterModal, useActiveLocale, useAsset, useAssets, useClickIds, useContextValue, useData, useDevice, useExperiment, useField, useFunnel, useGroupProgress, useLocale, useModal, useNavigation, useOffering, useOfferings, usePage, useResponse, useSystem, useTracker, useTranslation, useUserAttribute, useUtm, withBus };