@abyss-project/commons-front-core 8.0.0 → 8.1.0

package/dist/rum/abyss-main-session-path.d.ts

@@ -0,0 +1,13 @@
+/** The route of a RUM session page in abyss-main's front. */
+export declare const ABYSS_MAIN_RUM_SESSION_ROUTE: "/org/:orgId/project/:projectId/application/:applicationId/monitor/rum/sessions/:sessionId";
+/** The Monitor application a session belongs to, in abyss-main's front. */
+export interface AbyssMainRumSessionContext {
+    orgId: string;
+    projectId: string;
+    applicationId: string;
+}
+/**
+ * The path of a session page; `t` (seconds since the start of the session, floored, never
+ * negative) opens it at that instant (§35.8). The session id is URI-encoded.
+ */
+export declare const abyssMainRumSessionPath: ({ orgId, projectId, applicationId }: AbyssMainRumSessionContext, sessionId: string, t?: number) => string;

package/dist/rum/abyss-main-session-path.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rum/feedback-ticket.d.ts

@@ -9,6 +9,13 @@ export interface AbyssRumFeedbackTicket {
     appName: string;
     /** The Monitor page of the session at the instant of the feedback. */
     sessionUrl: (sessionId: string, offsetMs: number) => string;
+    /**
+     * The language the front is read in at the instant of the feedback (`fr`, `en-GB`…): the
+     * language of the intake's follow-up e-mails. Read at each feedback, so a language switched after
+     * start is followed. Without it, or for a language the intake does not speak, none is sent and the
+     * intake uses its default.
+     */
+    locale?: () => string | undefined;
 }
 /** The signed-in user of the front, when there is one: the reporter of last resort. */
 export interface FeedbackAccount {

package/dist/rum/index.d.ts

@@ -1,2 +1,7 @@
 export * from './AbyssRumProvider';
 export type { AbyssRumFeedbackTicket } from './feedback-ticket';
+export { createRouteResolver } from './route-resolver';
+export { ABYSS_MAIN_RUM_SESSION_ROUTE, abyssMainRumSessionPath, } from './abyss-main-session-path';
+export type { AbyssMainRumSessionContext } from './abyss-main-session-path';
+export { buildAbyssRumProviderConfig } from './rum-provider-config';
+export type { AbyssRumProviderConfigInput } from './rum-provider-config';

package/dist/rum/route-resolver.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The SDK's `routeResolver` over the front's full route templates. The templates are ranked as
+ * react-router ranks its routes: a static segment beats a parameter, a parameter beats a splat, so
+ * the most precise template wins whatever the order of the list. A URL no template matches resolves
+ * to its own `pathname` (the SDK masks it).
+ */
+export declare const createRouteResolver: (patterns: readonly string[]) => ((location: Location) => string);

package/dist/rum/route-resolver.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rum/rum-provider-config.d.ts

@@ -0,0 +1,39 @@
+import { AbyssRumProviderConfig } from './AbyssRumProvider';
+/** The raw config values of a front's RUM; an empty string counts as not set. */
+export interface AbyssRumProviderConfigInput {
+    /** Public RUM token of the front's environment (`VITE_ABYSS_MONITOR_RUM_TOKEN`). */
+    token: string | undefined;
+    /** The Monitor application of the front's API. */
+    applicationId: string | undefined;
+    /** Monitor's API URL; only its origin is kept. */
+    monitorApiUrl: string | undefined;
+    /** The front's own API URL: the relay, and an instrumented origin. */
+    apiUrl: string | undefined;
+    /** abyss-main's API URL: an instrumented origin (the same as `apiUrl` for abyss-main's front). */
+    mainApiUrl: string | undefined;
+    /** `true` for a front that calls Monitor's API itself (abyss-main's): Monitor is instrumented too. */
+    instrumentMonitorApi?: boolean;
+    /** Commit SHA of the build (`VITE_RELEASE`); empty: the sessions carry no release. */
+    release: string | undefined;
+    /** The front's full route templates, as its router mounts them (`/org/:orgId/boards/:boardId`). */
+    routeTemplates: readonly string[];
+    /** Product name, in the title of a feedback ticket (`AbyssCloud`). */
+    appName: string;
+    /** abyss-main's front URL, where the session page lives; only its origin is kept. */
+    mainFrontUrl: string | undefined;
+    /** Slug of the Internal Tickets intake the feedback is filed in. */
+    feedbackIntakeSlug: string | undefined;
+    /** Section of that intake. */
+    feedbackSectionId: string | undefined;
+    /** Organization of the Monitor application, in the session page's path. */
+    organizationId: string | undefined;
+    /** Project of the Monitor application, in the session page's path. */
+    projectId: string | undefined;
+    /** The front's current language, read at each feedback (see `AbyssRumFeedbackTicket.locale`). */
+    locale?: () => string | undefined;
+}
+/**
+ * The provider's options, `null` when the token, the application, Monitor's API, the front's API or
+ * abyss-main's API is not set (nothing to install).
+ */
+export declare const buildAbyssRumProviderConfig: (input: AbyssRumProviderConfigInput) => AbyssRumProviderConfig | null;

package/dist/rum/rum-provider-config.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/commons-front-core",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "Front Core package of AbyssProject",
   "main": "dist/index.js",
   "module": "./dist/index.js",
@@ -80,7 +80,7 @@
     "react-is": "^18.0.0 || ^19.0.0",
     "react-router-dom": "^6.15.0",
     "zustand": "^5.0.0",
-    "@abyss-project/main": "15.1.0"
+    "@abyss-project/main": "15.2.0"
   },
   "peerDependenciesMeta": {
     "@abyss-project/capacitor-auth": {
@@ -130,7 +130,7 @@
     "use-debounce": "^10.0.5",
     "uuid": "^9.0.0",
     "yup": "^0.32.11",
-    "@abyss-project/main": "15.1.0"
+    "@abyss-project/main": "15.2.0"
   },
   "devDependencies": {
     "@abyss-project/cloud": "^2.4.0",