@burdenoff/fe-libs 2026.1021.11 → 2026.1021.13

package/dist/shared/events/sinks/rybbitRoutes.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Route patterns on which Rybbit must send nothing (G27).
+ *
+ * The syntax is Rybbit's own `data-skip-patterns` syntax, so one list drives
+ * both halves of the gate: RybbitSink hands it to the Rybbit script (which then
+ * sends no pageview or event while the URL matches) and applies it itself
+ * before injecting the script and before forwarding a bus event.
+ *
+ * - `*` matches one path segment: `/shared/*` matches `/shared/abc`, not `/shared/a/b`.
+ * - `**` matches any number of segments: `/share/**` matches `/share/a/b`.
+ * - `re:<regex>` is a raw regular expression tested against the pathname.
+ *
+ * Patterns are anchored at both ends, the same as Rybbit's matcher.
+ */
+/** Compile one skip pattern exactly as the Rybbit script does. */
+export declare function compileRybbitRoutePattern(pattern: string): RegExp;
+/**
+ * True when `pathname` matches any pattern. An invalid pattern never matches
+ * (Rybbit logs and skips it too), so one typo cannot silence a whole shell.
+ */
+export declare function isRybbitSkippedRoute(pathname: string | undefined, patterns: readonly string[] | undefined): boolean;

package/dist/shared/events/sinks/rybbitRoutes.js

@@ -0,0 +1,20 @@
+//#region src/shared/events/sinks/rybbitRoutes.ts
+var e = "\0DS\0", t = "\0SS\0";
+function n(n) {
+	if (n.startsWith("re:")) {
+		let e = n.slice(3);
+		if (!e) throw Error("Empty regex pattern");
+		return new RegExp(e);
+	}
+	let r = n.replace(/\*\*/g, e).replace(/\*/g, t).replace(/[.+?^${}()|[\]\\]/g, "\\$&");
+	return r = r.split(`/${e}/`).join("/(?:.+/)?"), r = r.split(e).join(".*"), r = r.split(t).join("[^/]+"), RegExp(`^${r}$`);
+}
+function r(e, t) {
+	if (!e || !t || t.length === 0) return !1;
+	for (let r of t) try {
+		if (n(r).test(e)) return !0;
+	} catch {}
+	return !1;
+}
+//#endregion
+export { n as compileRybbitRoutePattern, r as isRybbitSkippedRoute };

package/dist/shared/providers/AppShellProvider.d.ts

@@ -85,6 +85,24 @@ export interface AppShellConfig {
      * purpose is that a stranger can read it.
      */
     consentRouteDenylist?: (pathname: string) => boolean;
+    /**
+     * Extra event names this shell forwards to Rybbit (G27), ADDED to the
+     * platform allowlist (or to `observability.rybbit.allowlist` when the shell
+     * overrides it) instead of replacing it. Lets a shell ship a new product
+     * event without waiting for, or forking, the platform list. Adding a name is
+     * still the deliberate privacy act described in RYBBIT_FRONTEND_ANALYTICS.md;
+     * RybbitSink keeps stripping identifier and sensitive keys either way. Pass a
+     * module-level constant: a new array identity re-subscribes the sink.
+     */
+    rybbitEvents?: readonly BurdenoffEventName[];
+    /**
+     * Routes on which NOTHING is sent to Rybbit (G27): no script load, no
+     * pageview, no event. In Rybbit's skip-pattern syntax (`*` = one segment,
+     * `**` = any depth, `re:` = regex), e.g. `['/shared/*']` for FluidGrids'
+     * public workflow viewer. Independent of `consentRouteDenylist`, which only
+     * hides the consent prompt. Pass a module-level constant.
+     */
+    rybbitSkipRoutes?: readonly string[];
     /**
      * Maps a pathname to the tour `pageId` used when looking up tours.
      *
@@ -159,6 +177,14 @@ export interface AppShellObservabilityEnv {
  * element, they override sonner's stylesheet defaults.
  */
 export declare const RICH_TOAST_TOKEN_STYLE: CSSProperties;
+/**
+ * Adds a shell's own Rybbit event names (`AppShellConfig.rybbitEvents`, G27) to
+ * the allowlist that resolved for it, keeping the base order and dropping
+ * duplicates. With no base allowlist RybbitSink would fall back to
+ * DEFAULT_RYBBIT_ALLOWLIST, so that fallback is the base the extras extend.
+ * Returns the input unchanged when there is nothing to add.
+ */
+export declare function withShellRybbitEvents(config: AppShellObservabilityConfig, extraEvents: readonly BurdenoffEventName[] | undefined): AppShellObservabilityConfig;
 export declare function resolveAppShellObservabilityConfig(productSlug: string, env: AppShellObservabilityEnv): AppShellObservabilityConfig;
 export interface AppShellProviderProps {
     config: AppShellConfig;