@launchdarkly/o11y 0.0.0-stage → 1.2.0

package/dist/LDRecord.d.ts

@@ -0,0 +1,149 @@
+import { EvaluationSeriesContext } from '@launchdarkly/js-client-sdk';
+import { EvaluationSeriesData } from '@launchdarkly/js-client-sdk';
+import { Hook as Hook_2 } from '@launchdarkly/js-client-sdk';
+import { LDEvaluationReason } from '@launchdarkly/js-client-sdk';
+import { LDFlagValue } from '@launchdarkly/js-client-sdk';
+import { LDPluginEnvironmentMetadata } from '@launchdarkly/js-client-sdk';
+
+declare class BufferedClass<T extends object> {
+    protected _sdk: T;
+    protected _isLoaded: boolean;
+    protected _callBuffer: Array<Event_2>;
+    protected _capacity: number;
+    protected _droppedEvents: number;
+    protected _exceededCapacity: boolean;
+    protected _logger: Logger;
+    protected _bufferCall(method: string, args: any[]): any;
+    protected _enqueue(event: Event_2): void;
+    load(sdk: T): void;
+}
+
+declare type Event_2 = {
+    method: string;
+    args: any[];
+};
+
+/**
+ * Interface for extending SDK functionality via hooks.
+ */
+declare type Hook = Omit<Hook_2, 'afterEvaluation'> & {
+    /**
+     * This method is called during the execution of the variation method
+     * after the flag value has been determined. The method is executed synchronously.
+     *
+     * @param hookContext Contains read-only information about the evaluation
+     * being performed.
+     * @param data A record associated with each stage of hook invocations. Each
+     *  stage is called with the data of the previous stage for a series.
+     * @param detail The result of the evaluation. This value should not be
+     * modified.
+     * @returns Data to use when executing the next state of the hook in the evaluation series. It is
+     * recommended to expand the previous input into the return. This helps ensure your stage remains
+     * compatible moving forward as more stages are added.
+     * ```js
+     * return {...data, "my-new-field": /*my data/*}
+     * ```
+     */
+    afterEvaluation?(hookContext: EvaluationSeriesContext, data: EvaluationSeriesData, detail: {
+        /**
+         * The result of the flag evaluation. This will be either one of the flag's variations or
+         * the default value that was passed to `LDClient.variationDetail`.
+         */
+        value: LDFlagValue;
+        /**
+         * The index of the returned value within the flag's list of variations, e.g. 0 for the
+         * first variation-- or `null` if the default value was returned.
+         */
+        variationIndex?: number | null;
+        /**
+         * An object describing the main factor that influenced the flag evaluation value.
+         */
+        reason?: LDEvaluationReason | null;
+    }): EvaluationSeriesData;
+};
+
+declare interface LDClientMin {
+    track(key: string, data?: any, metricValue?: number): void;
+    identify(ctx: any): void;
+    addHook(hook: Hook): void;
+}
+
+export declare let LDRecord: _LDRecord;
+
+declare class _LDRecord extends BufferedClass<Record_2> implements Record_2 {
+    getSession(): SessionDetails | null;
+    start(options?: StartOptions): Promise<void>;
+    stop(): void;
+    addSessionProperties(properties: {
+        [key: string]: any;
+    }): any;
+    getRecordingState(): any;
+    snapshot(element: HTMLCanvasElement): any;
+    register(client: LDClientMin, environmentMetadata: LDPluginEnvironmentMetadata): any;
+}
+
+declare class Logger {
+    debug: boolean | undefined;
+    name: string | undefined;
+    constructor(debug?: boolean, name?: string);
+    log(...data: any[]): void;
+    warn(...data: any[]): void;
+}
+
+declare interface Record_2 {
+    /**
+     * Start the session when running in `manualStart` mode.
+     * Can be used to force start a new session.
+     * @param options the session start options.
+     */
+    start: (options?: StartOptions) => Promise<void>;
+    /**
+     * Stop the session recording.
+     */
+    stop: () => void;
+    /**
+     * Add custom session-level properties. These are attached to the current session
+     * and are searchable, but do not create timeline Track events.
+     */
+    addSessionProperties: (properties: {
+        [key: string]: any;
+    }) => void;
+    /**
+     * Snapshot an HTML <canvas> element in WebGL manual snapshotting mode.
+     * See {@link https://www.highlight.io/docs/getting-started/browser/replay-configuration/canvas#manual-snapshotting}
+     * for more information.
+     */
+    snapshot: (element: HTMLCanvasElement) => Promise<void>;
+    getSession: () => SessionDetails | null;
+    getRecordingState: () => 'NotRecording' | 'Recording';
+    register(client: LDClientMin, environmentMetadata: LDPluginEnvironmentMetadata): void;
+    getHooks?(metadata: LDPluginEnvironmentMetadata): Hook[];
+}
+
+declare interface SessionDetails {
+    /** The URL to view the session. */
+    url: string;
+    /** The URL to view the session at the time getSessionDetails was called during the session recording. */
+    urlWithTimestamp: string;
+    /** The secure ID of the session. */
+    sessionSecureID: string;
+}
+
+declare interface StartOptions {
+    /**
+     * Specifies whether console warn messages should not be created.
+     */
+    silent?: boolean;
+    /**
+     * Starts a new recording session even if one was stopped recently.
+     */
+    forceNew?: boolean;
+    /**
+     * Key to use to determine the sessionSecureID in order to override session generation logic.
+     * If a sessionKey is provided, the session will be combined with the previous session with the same key.
+     * Otherwise, the current session logic will be used to generate a sessionSecureID.
+     */
+    sessionKey?: string;
+}
+
+export { }

package/dist/LDRecord.js

@@ -0,0 +1,48 @@
+var a = (l, e, r) => new Promise((f, d) => {
+  var h = (s) => {
+    try {
+      i(r.next(s));
+    } catch (o) {
+      d(o);
+    }
+  }, u = (s) => {
+    try {
+      i(r.throw(s));
+    } catch (o) {
+      d(o);
+    }
+  }, i = (s) => s.done ? f(s.value) : Promise.resolve(s.value).then(h, u);
+  i((r = r.apply(l, e)).next());
+});
+import { B as g } from "./buffer-DIFxvF2Q.js";
+class n extends g {
+  getSession() {
+    return this._isLoaded ? this._bufferCall("getSession", []) : null;
+  }
+  start(e) {
+    return a(this, null, function* () {
+      return this._sdk.start(e);
+    });
+  }
+  stop() {
+    return this._sdk.stop();
+  }
+  addSessionProperties(e) {
+    return this._bufferCall("addSessionProperties", [e]);
+  }
+  getRecordingState() {
+    return this._isLoaded ? this._bufferCall("getRecordingState", []) : "NotRecording";
+  }
+  snapshot(e) {
+    return this._isLoaded ? this._bufferCall("snapshot", [e]) : Promise.resolve(void 0);
+  }
+  register(e, r) {
+    return this._bufferCall("register", [e, r]);
+  }
+}
+let t;
+typeof globalThis != "undefined" ? globalThis.LDRecord ? t = globalThis.LDRecord : (t = new n(), globalThis.LDRecord = t) : t = new n();
+export {
+  t as LDRecord
+};
+//# sourceMappingURL=LDRecord.js.map

package/dist/LDRecord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LDRecord.js","sources":["../src/sdk/LDRecord.ts"],"sourcesContent":["import type { Record } from '../api/record'\nimport type { SessionDetails } from '../client'\nimport type { LDClient } from '../integrations/launchdarkly'\nimport type { StartOptions } from '../client/types/types'\nimport type { LDPluginEnvironmentMetadata } from '../plugins/plugin'\nimport { BufferedClass } from './buffer'\n\nclass _LDRecord extends BufferedClass<Record> implements Record {\n\tgetSession(): SessionDetails | null {\n\t\treturn this._isLoaded ? this._bufferCall('getSession', []) : null\n\t}\n\n\tasync start(options?: StartOptions) {\n\t\t// avoid buffering the start call\n\t\treturn this._sdk.start(options)\n\t}\n\n\tstop() {\n\t\t// avoid buffering the stop call\n\t\treturn this._sdk.stop()\n\t}\n\n\taddSessionProperties(properties: { [key: string]: any }) {\n\t\treturn this._bufferCall('addSessionProperties', [properties])\n\t}\n\n\tgetRecordingState() {\n\t\treturn this._isLoaded\n\t\t\t? this._bufferCall('getRecordingState', [])\n\t\t\t: ('NotRecording' as const)\n\t}\n\n\tsnapshot(element: HTMLCanvasElement) {\n\t\treturn this._isLoaded\n\t\t\t? this._bufferCall('snapshot', [element])\n\t\t\t: Promise.resolve(undefined)\n\t}\n\n\tregister(\n\t\tclient: LDClient,\n\t\tenvironmentMetadata: LDPluginEnvironmentMetadata,\n\t) {\n\t\treturn this._bufferCall('register', [client, environmentMetadata])\n\t}\n}\n\ninterface GlobalThis {\n\tLDRecord?: _LDRecord\n}\ndeclare var globalThis: GlobalThis\n\nexport let LDRecord!: _LDRecord\nif (typeof globalThis !== 'undefined') {\n\tif (globalThis.LDRecord) {\n\t\tLDRecord = globalThis.LDRecord\n\t} else {\n\t\tLDRecord = new _LDRecord()\n\t\tglobalThis.LDRecord = LDRecord\n\t}\n} else {\n\tLDRecord = new _LDRecord()\n}\n"],"names":["_LDRecord","BufferedClass","options","__async","properties","element","client","environmentMetadata","LDRecord"],"mappings":";;;;;;;;;;;;;;;;;AAOA,MAAMA,UAAkBC,EAAwC;AAAA,EAC/D,aAAoC;AACnC,WAAO,KAAK,YAAY,KAAK,YAAY,cAAc,CAAA,CAAE,IAAI;AAAA,EAC9D;AAAA,EAEM,MAAMC,GAAwB;AAAA,WAAAC,EAAA;AAEnC,aAAO,KAAK,KAAK,MAAMD,CAAO;AAAA,IAC/B;AAAA;AAAA,EAEA,OAAO;AAEN,WAAO,KAAK,KAAK,KAAA;AAAA,EAClB;AAAA,EAEA,qBAAqBE,GAAoC;AACxD,WAAO,KAAK,YAAY,wBAAwB,CAACA,CAAU,CAAC;AAAA,EAC7D;AAAA,EAEA,oBAAoB;AACnB,WAAO,KAAK,YACT,KAAK,YAAY,qBAAqB,CAAA,CAAE,IACvC;AAAA,EACL;AAAA,EAEA,SAASC,GAA4B;AACpC,WAAO,KAAK,YACT,KAAK,YAAY,YAAY,CAACA,CAAO,CAAC,IACtC,QAAQ,QAAQ,MAAS;AAAA,EAC7B;AAAA,EAEA,SACCC,GACAC,GACC;AACD,WAAO,KAAK,YAAY,YAAY,CAACD,GAAQC,CAAmB,CAAC;AAAA,EAClE;AACD;AAOO,IAAIC;AACP,OAAO,cAAe,cACrB,WAAW,WACdA,IAAW,WAAW,YAEtBA,IAAW,IAAIR,EAAA,GACf,WAAW,WAAWQ,KAGvBA,IAAW,IAAIR,EAAA;"}