@salesforce/telemetry 6.6.7 → 6.7.1

package/lib/exported.d.ts

@@ -2,4 +2,4 @@ import { TelemetryReporter } from './telemetryReporter';
 export * from './telemetryReporter';
 export { isEnabled } from './enabledCheck';
 export default TelemetryReporter;
-export type { Attributes, O11ySchema, O11yBatchingConfig, PdpEvent } from './types';
+export type { Attributes, O11ySchema, O11yBatchingConfig, PdpEvent, TelemetryOptions } from './types';

package/lib/o11yReporter.js

@@ -16,10 +16,17 @@ exports.O11yReporter = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/* eslint-disable-next-line @typescript-eslint/triple-slash-reference -- needed so dynamic import('o11y_schema/sf_pdp') is typed when test tsconfig compiles */
+/// <reference path="../types/o11y_schema_sf_pdp.d.ts" />
 const o11y_reporter_1 = require("@salesforce/o11y-reporter");
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore o11y_schema/sf_pdp.d.ts is not a valid module
-const sf_pdp_1 = require("o11y_schema/sf_pdp");
+// o11y_schema is ESM-only; load via dynamic import() so it works when telemetry is required as CJS
+let pdpEventSchemaPromise = null;
+async function getPdpEventSchema() {
+    if (!pdpEventSchemaPromise) {
+        pdpEventSchemaPromise = import('o11y_schema/sf_pdp').then((m) => m.pdpEventSchema);
+    }
+    return pdpEventSchemaPromise;
+}
 const baseReporter_1 = require("./baseReporter");
 const utils_1 = require("./utils");
 class O11yReporter extends baseReporter_1.BaseReporter {
@@ -33,7 +40,10 @@ class O11yReporter extends baseReporter_1.BaseReporter {
         super(options);
         this.extensionName = options.extensionName ?? options.project;
         this.service = o11y_reporter_1.O11yService.getInstance(this.extensionName);
-        this.initialized = this.service.initialize(this.extensionName, options.o11yUploadEndpoint);
+        const dynamicO11yUploadEndpointPath = options.dynamicO11yUploadEndpoint
+            ? options.dynamicO11yUploadEndpoint
+            : undefined;
+        this.initialized = this.service.initialize(this.extensionName, options.o11yUploadEndpoint, options.getConnectionFn, dynamicO11yUploadEndpointPath ? { dynamicO11yUploadEndpointPath } : undefined);
         this.commonProperties = this.buildO11yCommonProperties(options.commonProperties);
     }
     async init() {
@@ -116,7 +126,8 @@ class O11yReporter extends baseReporter_1.BaseReporter {
      */
     async sendPdpEvent(event) {
         await this.initialized;
-        this.service.logEventWithSchema(event, sf_pdp_1.pdpEventSchema);
+        const schema = await getPdpEventSchema();
+        this.service.logEventWithSchema(event, schema);
         if (!this._batchingEnabled) {
             await this.service.forceFlush();
         }

package/lib/types.d.ts

@@ -1,4 +1,5 @@
 import { Env } from '@salesforce/kit';
+import { Connection as O11yConnection } from '@salesforce/o11y-reporter';
 export type Properties = {
     [key: string]: string;
 };
@@ -96,6 +97,21 @@ export type TelemetryOptions = {
     project: string;
     key: string;
     commonProperties?: Properties;
+    /**
+     * Optional getConnection function used at upload time to resolve endpoint and token from the current org.
+     * If getConnection is missing or fails, uploads use the static o11yUploadEndpoint (no auth).
+     * E.g.,
+     * ```
+     * Connection.create({
+     *   authInfo: await AuthInfo.create({ username: 'myAdminUsername' })
+     * })
+     * ```
+     * or
+     * ```
+     * WorkspaceContextUtil.getInstance().getConnection()
+     * ```
+     */
+    getConnectionFn?: () => Promise<O11yConnection>;
     contextTags?: Properties;
     env?: Env;
     gdprSensitiveKeys?: string[];
@@ -103,6 +119,11 @@ export type TelemetryOptions = {
     sessionId?: string;
     waitForConnection?: boolean;
     o11yUploadEndpoint?: string;
+    /**
+     * Optional path appended to the org instance URL for the dynamic endpoint.
+     * Default: /services/data/v65.0/connect/proxy/ui-telemetry.
+     */
+    dynamicO11yUploadEndpoint?: string;
     enableO11y?: boolean;
     enableAppInsights?: boolean;
     extensionName?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/telemetry",
-  "version": "6.6.7",
+  "version": "6.7.1",
   "description": "Library for telemetry reporting to Application Insights and O11y",
   "main": "lib/exported",
   "exports": {