Cleanup

Author: kinyoklion

packages/telemetry/browser-telemetry/__tests__/singleton/singletonMethods.test.ts

@@ -1,5 +1,6 @@
 import { Breadcrumb, LDClientTracking } from '../../src/api';
 import { BrowserTelemetry } from '../../src/api/BrowserTelemetry';
+import { BrowserTelemetryInspector } from '../../src/api/client/BrowserTelemetryInspector';
 import { getTelemetryInstance } from '../../src/singleton/singletonInstance';
 import {
   addBreadcrumb,
@@ -9,7 +10,6 @@ import {
   inspectors,
   register,
 } from '../../src/singleton/singletonMethods';
-import { BrowserTelemetryInspector } from '../../src/api/client/BrowserTelemetryInspector';
 
 jest.mock('../../src/singleton/singletonInstance');
 

packages/telemetry/browser-telemetry/src/BrowserTelemetryImpl.ts

@@ -8,6 +8,7 @@ import type { LDContext, LDEvaluationDetail } from '@launchdarkly/js-client-sdk'
 import { BreadcrumbFilter, LDClientLogging, LDClientTracking, MinLogger } from './api';
 import { Breadcrumb, FeatureManagementBreadcrumb } from './api/Breadcrumb';
 import { BrowserTelemetry } from './api/BrowserTelemetry';
+import { BrowserTelemetryInspector } from './api/client/BrowserTelemetryInspector';
 import { Collector } from './api/Collector';
 import { ErrorData } from './api/ErrorData';
 import { EventData } from './api/EventData';
@@ -18,7 +19,6 @@ import FetchCollector from './collectors/http/fetch';
 import XhrCollector from './collectors/http/xhr';
 import defaultUrlFilter from './filters/defaultUrlFilter';
 import makeInspectors from './inspectors';
-import { BrowserTelemetryInspector } from './api/client/BrowserTelemetryInspector';
 import { fallbackLogger, prefixLog } from './logging';
 import { ParsedOptions, ParsedStackOptions } from './options';
 import randomUuidV4 from './randomUuidV4';

packages/telemetry/browser-telemetry/src/api/BrowserTelemetry.ts

@@ -1,8 +1,6 @@
-import type { LDInspection } from '@launchdarkly/js-client-sdk';
-
 import { Breadcrumb } from './Breadcrumb';
-import { LDClientTracking } from './client/LDClientTracking';
 import { BrowserTelemetryInspector } from './client/BrowserTelemetryInspector';
+import { LDClientTracking } from './client/LDClientTracking';
 
 /**
  * Interface for browser-based telemetry collection in LaunchDarkly SDKs.
@@ -16,7 +14,7 @@ export interface BrowserTelemetry {
    * Returns an array of active SDK inspectors to use with SDK versions that do
    * not support hooks.
    *
-   * @returns An array of {@link LDInspection} objects.
+   * @returns An array of {@link BrowserTelemetryInspector} objects.
    */
   inspectors(): BrowserTelemetryInspector[];
 

packages/telemetry/browser-telemetry/src/api/client/BrowserTelemetryInspector.ts

@@ -1,7 +1,29 @@
-
+/**
+ * A less constrained version of the LDInspection interface in order to allow for greater compatibility between
+ * SDK versions.
+ *
+ * This interface is not intended for use by the application developer and is instead intended as a compatibility bridge
+ *  to support multiple SDK versions.
+ */
 export interface BrowserTelemetryInspector {
+  /**
+   * The telemetry package only requires flag-detail-changed inspectors and flag-used inspectors.
+   */
   type: 'flag-used' | 'flag-detail-changed';
+
+  /**
+   * The name of the inspector, used for debugging purposes.
+   */
   name: string;
+  /**
+   * Whether the inspector is synchronous.
+   */
   synchronous: boolean;
+  /**
+   * The method to call when the inspector is triggered.
+   *
+   * The typing here is intentionally loose to allow for greater compatibility between SDK versions.
+   * This function should ONLY be called by an SDK instance and not by an application developer.
+   */
   method: (...args: any[]) => void;
 }

packages/telemetry/browser-telemetry/src/inspectors.ts

@@ -1,8 +1,8 @@
 import type { LDContext, LDEvaluationDetail } from '@launchdarkly/js-client-sdk';
 
+import { BrowserTelemetryInspector } from './api/client/BrowserTelemetryInspector.js';
 import BrowserTelemetryImpl from './BrowserTelemetryImpl.js';
 import { ParsedOptions } from './options.js';
-import { BrowserTelemetryInspector } from './api/client/BrowserTelemetryInspector.js';
 
 /**
  * Create inspectors to register with an LDClient instance.

packages/telemetry/browser-telemetry/src/singleton/singletonMethods.ts

@@ -1,9 +1,7 @@
-import type { LDInspection } from '@launchdarkly/js-client-sdk';
-
 import { LDClientTracking } from '../api';
 import { Breadcrumb } from '../api/Breadcrumb';
-import { getTelemetryInstance } from './singletonInstance';
 import { BrowserTelemetryInspector } from '../api/client/BrowserTelemetryInspector';
+import { getTelemetryInstance } from './singletonInstance';
 
 /**
  * Returns an array of active SDK inspectors to use with SDK versions that do
@@ -12,7 +10,7 @@ import { BrowserTelemetryInspector } from '../api/client/BrowserTelemetryInspect
  * Telemetry must be initialized, using {@link initializeTelemetry} before calling this method.
  * If telemetry is not initialized, this method will return an empty array.
  *
- * @returns An array of {@link LDInspection} objects.
+ * @returns An array of {@link BrowserTelemetryInspector} objects.
  */
 export function inspectors(): BrowserTelemetryInspector[] {
   return getTelemetryInstance()?.inspectors() || [];