@salesforce/platform-sdk 12.2.0 → 12.3.1

package/dist/data/index.js

@@ -305,7 +305,7 @@ const S = "Accept-Language", ge = (t) => {
     return l(t);
   const [r, n] = t;
   return (r instanceof Request && !n?.headers ? r.headers.has(S) : new Headers(n?.headers).has(S)) ? l(t) : l(b(S, e, t));
-}, Ee = "X-SFDC-Client-Name", Se = "X-SFDC-Client-Version", Ce = "@salesforce/platform-sdk", xe = "12.2.0", De = (t) => {
+}, Ee = "X-SFDC-Client-Name", Se = "X-SFDC-Client-Version", Ce = "@salesforce/platform-sdk", xe = "12.3.1", De = (t) => {
   let e = b(Ee, Ce, t);
   return e = b(Se, xe, e), l(e);
 }, Oe = "X-CSRF-Token";

package/dist/observability/index.d.ts

@@ -0,0 +1,131 @@
+import { isInitialized } from 'o11y/orchestrator';
+/**
+ * Configuration for auto-instrumentation initialization.
+ * Extends the orchestrator config with sensible defaults.
+ */
+export interface AutoInstrumentationOptions {
+    /**
+     * Telemetry ingestion endpoint URL.
+     * @example 'https://telemetry.salesforce.com/ingest'
+     */
+    endpoint: string;
+    /**
+     * Static environment attributes attached to all telemetry events.
+     */
+    environment: {
+        /** Application name (required) */
+        appName: string;
+        /** Application version */
+        appVersion?: string;
+        /** Application experience (e.g., 'desktop', 'mobile') */
+        appExperience?: string;
+        /** Device identifier */
+        deviceId?: string;
+        /** Device model */
+        deviceModel?: string;
+        /** SDK version */
+        sdkVersion?: string;
+    };
+    /**
+     * Application namespace attached to telemetry payloads. Forwarded to the orchestrator,
+     * which applies its own default (e.g. 'sf.agentic') when omitted.
+     */
+    namespace?: string;
+    /**
+     * Use Base64-encoded JSON for upload (instead of multipart/form-data).
+     * @default false
+     */
+    useBase64Json?: boolean;
+    /**
+     * Form data key for telemetry payload (when not using Base64 JSON).
+     * @default 'telemetry'
+     */
+    formDataKey?: string;
+    /**
+     * Maximum number of unique schemas the collector will buffer.
+     * @default 10000
+     */
+    maxUniqueSchemas?: number;
+    /**
+     * Interval (in milliseconds) for periodic telemetry uploads.
+     * @default 30000
+     */
+    periodicUploadIntervalMs?: number;
+    /**
+     * Optional callback to check if a root activity is in progress.
+     * Used to defer uploads during active interactions.
+     */
+    isRootActivityInProgress?: () => boolean;
+    /**
+     * Optional logging function for internal diagnostics.
+     * @default no-op
+     */
+    log?: (...args: unknown[]) => void;
+    /**
+     * Optional error handler for upload failures.
+     */
+    onUploadError?: (error: unknown) => void;
+    /**
+     * Activate click tracking (click → interaction root-activity).
+     * Forwarded to the orchestrator, which applies its own default when omitted.
+     */
+    enableClickTracking?: boolean;
+    /**
+     * Activate SPA history/navigation tracking.
+     * Forwarded to the orchestrator, which applies its own default when omitted.
+     */
+    enableHistoryTracking?: boolean;
+    /**
+     * Activate the generic monitor suite inside `o11y/orchestrator`'s `initialize()`
+     * (PageContext, ConsoleCollector, RootActivityManager, Web Vitals, network
+     * instrumentation, History/Click monitors, initial root activity/pageview).
+     * This is a drop-in activator, so this defaults to `true` here even though the
+     * underlying SDK defaults it to `false`. Set to `false` to opt out.
+     * @default true (observability)
+     */
+    activateGenericMonitors?: boolean;
+    /**
+     * Drain the pre-init tenant-app queue (`__SF_O11Y_QUEUE__`) on initialize.
+     * Preserves the pre-266.13.0 unconditional drain, so this defaults to `true`
+     * here even though the underlying SDK now defaults it to `false`. Set to `false` to opt out.
+     * @default true (observability)
+     */
+    drainAppQueue?: boolean;
+    /**
+     * Drain the pre-init first-party queue (`__SF_O11Y_QUEUE_1P__`) on initialize.
+     * Preserves the pre-266.13.0 unconditional drain, so this defaults to `true`
+     * here even though the underlying SDK now defaults it to `false`. Set to `false` to opt out.
+     * @default true (observability)
+     */
+    drainFirstPartyQueue?: boolean;
+    /**
+     * Whether the app is running in production. Forwarded to the orchestrator as-is; the
+     * SDK applies its own default (`true`) when omitted.
+     * @default true (SDK)
+     */
+    isProduction?: boolean;
+}
+/**
+ * Initializes o11y telemetry with the provided configuration.
+ *
+ * This function is **idempotent**: calling it multiple times, or from multiple
+ * bundles on the same page, will NO-OP if telemetry is already initialized.
+ *
+ * It only maps its friendly config to an `OrchestratorConfig` and delegates to
+ * `o11y/orchestrator`'s `initialize()`. As of o11y 266.13.0, `initialize()` performs the
+ * full setup AND monitor activation when `activateGenericMonitors` is true (PageContext,
+ * ConsoleCollector, RootActivityManager, Web Vitals, network instrumentation, History/Click
+ * monitors, initial root activity/pageview, and pre-init queue draining), including all
+ * non-DOM/SSR, version-mismatch, and cross-bundle guards. The legacy `AutomaticClickTracker`
+ * is never activated.
+ *
+ * @param options - Auto-instrumentation initialization configuration
+ */
+export declare function initializeAutoInstrumentation(options: AutoInstrumentationOptions): void;
+/**
+ * Re-exports the orchestrator's `isInitialized` so callers can check init state without re-initializing.
+ *
+ * @returns `true` if telemetry has been initialized, `false` otherwise
+ */
+export { isInitialized };
+//# sourceMappingURL=index.d.ts.map

package/dist/observability/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/observability/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,OAAO,EAAc,aAAa,EAA2B,MAAM,mBAAmB,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IAC1C;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE;QACZ,kCAAkC;QAClC,OAAO,EAAE,MAAM,CAAC;QAChB,0BAA0B;QAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,wBAAwB;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,mBAAmB;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,kBAAkB;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,OAAO,CAAC;IAEzC;;;OAGG;IACH,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAEzC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CA2CvF;AAED;;;;GAIG;AACH,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/observability/index.js

@@ -0,0 +1,31 @@
+import { isInitialized as i, initialize as a } from "o11y/orchestrator";
+import { isInitialized as o } from "o11y/orchestrator";
+function c(e) {
+  if (globalThis.__SF_O11Y_AUTO_INSTALLED__ || i())
+    return;
+  const r = {
+    endpoint: e.endpoint,
+    environment: e.environment,
+    useBase64Json: e.useBase64Json,
+    formDataKey: e.formDataKey,
+    maxUniqueSchemas: e.maxUniqueSchemas,
+    periodicUploadIntervalMs: e.periodicUploadIntervalMs,
+    isRootActivityInProgress: e.isRootActivityInProgress,
+    log: e.log,
+    onUploadError: e.onUploadError,
+    // activation is now performed by the orchestrator (o11y 266.13.0+)
+    activateGenericMonitors: e.activateGenericMonitors ?? !0,
+    enableClickTracking: e.enableClickTracking,
+    enableHistoryTracking: e.enableHistoryTracking,
+    namespace: e.namespace,
+    isProduction: e.isProduction,
+    // preserve pre-266.13.0 unconditional pre-init queue draining (SDK now defaults these OFF)
+    drainAppQueue: e.drainAppQueue ?? !0,
+    drainFirstPartyQueue: e.drainFirstPartyQueue ?? !0
+  };
+  a(r);
+}
+export {
+  c as initializeAutoInstrumentation,
+  o as isInitialized
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/platform-sdk",
-  "version": "12.2.0",
+  "version": "12.3.1",
   "license": "SEE LICENSE IN LICENSE.txt",
   "type": "module",
   "main": "./dist/index.js",
@@ -46,6 +46,9 @@
       ],
       "i18n": [
         "./dist/i18n/index.d.ts"
+      ],
+      "observability": [
+        "./dist/observability/index.d.ts"
       ]
     }
   },
@@ -110,6 +113,11 @@
       "import": "./dist/i18n/index.js",
       "default": "./dist/i18n/index.js"
     },
+    "./observability": {
+      "types": "./dist/observability/index.d.ts",
+      "import": "./dist/observability/index.js",
+      "default": "./dist/observability/index.js"
+    },
     "./package.json": "./package.json"
   },
   "directories": {
@@ -139,12 +147,12 @@
     "@conduit-client/service-pubsub": "3.19.6",
     "@conduit-client/service-retry": "3.19.6",
     "@conduit-client/utils": "3.19.6",
-    "@salesforce/jsonrpc": "^12.2.0",
+    "@salesforce/jsonrpc": "^12.3.1",
     "@salesforce/sf-embedding-bridge": "2.2.5-rc.2"
   },
   "peerDependencies": {
-    "o11y": ">=260.0.0",
-    "o11y_schema": ">=264.85.0"
+    "o11y": ">=266.13.0",
+    "o11y_schema": ">=264.109.0"
   },
   "devDependencies": {
     "ts-morph": "^27.0.2",