@burdenoff/fe-libs 2026.1021.7 → 2026.1021.8

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.
@@ -42,7 +42,9 @@ export { TourTooltip } from './TourTooltip';
42
42
  export { useTourPlayer } from './useTourPlayer';
43
43
  export type { Tour, TourStep, TourStepMedia, TourStatus, TourUserStatus, TourUserProgressSummary, TourTriggerType, StepPlacement, MediaType, MediaPosition, DeviceType, TourPlayerState, TourPlayerActions, TourPlayerContextValue, TourPlayerProviderProps, TourTooltipProps, TourSpotlightProps, } from './types';
44
44
  export { getResponsiveSelector, detectDeviceType } from './types';
45
- export { getTourContextRank, getTourRouteCatalog, getTourRouteModules, getTourRoutePages, isTourVisibleForContext, normalizeTourPath, registerTourRouteCatalog, resolveTourTargetPath, } from './routeCatalog';
45
+ export { createTourPageIdResolver, getTourContextRank, getTourRouteCatalog, getTourRouteCatalogVersion, getTourRouteModules, getTourRoutePages, hasRegisteredTourRouteCatalog, isTourVisibleForContext, normalizeTourPath, registerTourRouteCatalog, resolveTourTargetPath, subscribeTourRouteCatalogs, } from './routeCatalog';
46
+ export { useRegisterTourRouteCatalog, useTourRouteCatalog } from './useTourRouteCatalog';
47
+ export { BIGCONSOLE_TOUR_ROUTE_CATALOG, BUILDMYIQ_TOUR_ROUTE_CATALOG, BUILT_IN_TOUR_ROUTE_CATALOGS, COLLABKIN_TOUR_ROUTE_CATALOG, FLUIDGRIDS_TOUR_ROUTE_CATALOG, getBuiltInTourRouteCatalog, INTELWATCHTOWER_TOUR_ROUTE_CATALOG, listBuiltInTourRouteCatalogProductIds, MANUFACTUREDOPS_TOUR_ROUTE_CATALOG, VIBECONTROLS_TOUR_ROUTE_CATALOG, } from './catalogs';
46
48
  export type { TourCurrentContext, TourContextTarget, TourRouteCatalogEntry, TourRouteModuleOption, TourRoutePageOption, } from './routeCatalog';
47
49
  export { withTourProgressStatus } from './progress';
48
50
  export type { TourProgressCarrier } from './progress';
@@ -6,6 +6,13 @@ export interface TourRouteCatalogEntry {
6
6
  pageLabel: string;
7
7
  path: string;
8
8
  isModuleHome?: boolean;
9
+ /**
10
+ * Other URLs that render this page, for `createTourPageIdResolver`. Each is a
11
+ * path prefix matched on segment boundaries; a `:name` segment matches any
12
+ * single segment. `path` itself always matches, so list only the extras
13
+ * (aliases, redirects, detail URLs outside `path`).
14
+ */
15
+ matchPaths?: readonly string[];
9
16
  }
10
17
  export interface TourRouteModuleOption {
11
18
  moduleId: string;
@@ -27,15 +34,36 @@ export interface TourCurrentContext {
27
34
  moduleId: string | null | undefined;
28
35
  pageId: string | null | undefined;
29
36
  }
37
+ type TourRouteCatalogListener = () => void;
38
+ /**
39
+ * Subscribes to catalog registrations and cleanups, for `useSyncExternalStore`.
40
+ * Returns the unsubscribe function.
41
+ */
42
+ export declare function subscribeTourRouteCatalogs(listener: TourRouteCatalogListener): () => void;
43
+ /** Changes whenever a catalog is registered or cleaned up. */
44
+ export declare function getTourRouteCatalogVersion(): number;
30
45
  export declare function normalizeTourPath(path: string): string;
31
46
  /**
32
47
  * Registers an app-owned route catalog for a product. Call the returned cleanup
33
48
  * function from the same React effect that registered it.
34
49
  */
35
50
  export declare function registerTourRouteCatalog(productId: string | null | undefined, entries: readonly TourRouteCatalogEntry[]): () => void;
51
+ /** Whether a shell has registered a catalog for this product. */
52
+ export declare function hasRegisteredTourRouteCatalog(productId: string | null | undefined): boolean;
36
53
  export declare function getTourRouteCatalog(productId: string | null | undefined): TourRouteCatalogEntry[];
54
+ /**
55
+ * Builds a `tourPageIdFromPath` mapper (AppShellConfig) from a route catalog.
56
+ *
57
+ * A pathname maps to the pageId of the most specific entry whose `path` or one
58
+ * of whose `matchPaths` is a segment-wise prefix of it, so
59
+ * `/workflows/insights/errors` beats `/workflows/insights`, and
60
+ * `/workflows/listing` does not match `/workflows/list`. Unmatched paths return
61
+ * `undefined`, which keeps the shell's segment-based default.
62
+ */
63
+ export declare function createTourPageIdResolver(entries: readonly TourRouteCatalogEntry[]): (pathname: string) => string | undefined;
37
64
  export declare function getTourRouteModules(productId: string | null | undefined): TourRouteModuleOption[];
38
65
  export declare function getTourRoutePages(productId: string | null | undefined, moduleId: string | null | undefined): TourRoutePageOption[];
39
66
  export declare function resolveTourTargetPath(tour: TourContextTarget): string | undefined;
40
67
  export declare function isTourVisibleForContext(tour: TourContextTarget, context: TourCurrentContext): boolean;
41
68
  export declare function getTourContextRank(tour: TourContextTarget, context: TourCurrentContext): number;
69
+ export {};