@workleap/logrocket 1.2.7 → 2.0.0

package/dist/logRocketTypes.js

@@ -1,7 +0,0 @@
-
-;// CONCATENATED MODULE: ./src/logRocketTypes.ts
-// Typings are not exposed by the library, copied from the LogRocket package.
-
-
-
-//# sourceMappingURL=logRocketTypes.js.map

package/dist/logRocketTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"logRocketTypes.js","sources":["webpack://@workleap/logrocket/./src/logRocketTypes.ts"],"sourcesContent":["import type LogRocket from \"logrocket\";\n\n// Typings are not exposed by the library.\nexport type LogRocketSdkOptions = NonNullable<Parameters<(typeof LogRocket)[\"init\"]>[1]>;\n\n// Typings are not exposed by the library, copied from the LogRocket package.\nexport interface LogRocketRequest {\n    reqId: string;\n    url: string;\n    headers: {\n        [key: string]: string | null | undefined;\n    };\n    body?: string;\n    method: string;\n    referrer?: string;\n    mode?: string;\n    credentials?: string;\n}\n\n// Typings are not exposed by the library, copied from the LogRocket package.\nexport interface LogRocketResponse {\n    reqId: string;\n    status?: number;\n    headers: {\n        [key: string]: string | null | undefined;\n    };\n    body?: string;\n    method: string;\n    url?: string;\n}\n"],"names":[],"mappings":";;AAmBA,6EAA6E;AAU5E"}

package/dist/registerLogRocketInstrumentation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"registerLogRocketInstrumentation.js","sources":["webpack://@workleap/logrocket/./src/registerLogRocketInstrumentation.ts"],"sourcesContent":["import { createCompositeLogger, type RootLogger } from \"@workleap/logging\";\nimport { createBootstrappingStore, createTelemetryContext } from \"@workleap/telemetry\";\nimport LogRocket from \"logrocket\";\nimport LogrocketFuzzySanitizer from \"logrocket-fuzzy-search-sanitizer\";\nimport { applyTransformers, type LogRocketSdkOptionsTransformer } from \"./applyTransformers.ts\";\nimport { DeviceIdTrait, TelemetryIdTrait } from \"./createDefaultUserTraits.ts\";\nimport { createRequestSanitizer } from \"./createRequestSanitizer.ts\";\nimport { createResponseSanitizer } from \"./createResponseSanitizer.ts\";\nimport { createUrlSanitizer } from \"./createUrlSanitizer.ts\";\nimport { HasExecutedGuard } from \"./HasExecutedGuard.ts\";\nimport type { LogRocketSdkOptions } from \"./logRocketTypes.ts\";\n\nexport const IsRegisteredVariableName = \"__WLP_LOGROCKET_INSTRUMENTATION_IS_REGISTERED__\";\nexport const RegisterGetSessionUrlFunctionName = \"__WLP_LOGROCKET_INSTRUMENTATION_REGISTER_GET_SESSION_URL_LISTENER__\";\n\nconst DefaultPrivateFieldNames = [\n    \"email\",\n    \"personalEmail\",\n    \"phoneNumber\",\n    \"password\",\n    \"firstName\",\n    \"lastName\",\n    \"givenName\",\n    \"fullName\",\n    \"gender\",\n    \"timeZone\",\n    \"birthday\"\n];\n\nconst DefaultPrivateQueryParameterNames = [\n    \"token\",\n    \"email\",\n    \"password\"\n];\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface RegisterLogRocketInstrumentationOptions {\n    /**\n     * A root hostname to track sessions across subdomains. Set this option to capture traffic from all subdomains under one session: https://docs.logrocket.com/reference/roothostname.\n     */\n    rootHostname?: LogRocketSdkOptions[\"rootHostname\"];\n    /**\n     * Names of additional fields to exclude from session replays. These fields will be removed from network requests, responses using a fuzzy-matching algorithm.\n     */\n    privateFieldNames?: string[];\n    /**\n     * Names of additional fields to exclude from session replays. These fields will be removed from query parameters using a fuzzy-matching algorithm.\n     */\n    privateQueryParameterNames?: string[];\n    /**\n     * Indicates whether or not debug information should be logged to the console.\n     */\n    verbose?: boolean;\n    /**\n     * The logger instances that will output messages.\n     */\n    loggers?: RootLogger[];\n    /**\n     * Hooks to transform the resulting LogRocket SDK options.\n     */\n    transformers?: LogRocketSdkOptionsTransformer[];\n}\n\n// The function return type is mandatory, otherwise we got an error TS4058.\nexport function getLogRocketSdkOptions(userOptions: RegisterLogRocketInstrumentationOptions, logger: RootLogger): LogRocketSdkOptions {\n    const {\n        rootHostname = \"workleap.com\",\n        privateFieldNames = [],\n        privateQueryParameterNames = [],\n        verbose = false,\n        transformers = []\n    } = userOptions;\n\n    const mergedPrivateFieldNames = DefaultPrivateFieldNames.concat(privateFieldNames);\n    const mergedPrivateQueryParameterNames = DefaultPrivateQueryParameterNames.concat(privateQueryParameterNames);\n\n    // The \"LogrocketFuzzySearch.setup\" code is awkward. For now, we prefer to play it safe and call it once here, then forward the sanitize functions\n    // to the appropriate factories.\n    // No clue why the \"setup\" method is not available. This package is shady.\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    const { requestSanitizer: fuzzyRequestSanitizer, responseSanitizer: fuzzyResponseSanitizer } = LogrocketFuzzySanitizer.setup(mergedPrivateFieldNames);\n\n    const sdkOptions = {\n        console: {\n            // Prevent console logs from being visible in LogRocket session replays and leaking PII.\n            // To capture logs in a session replay, use the LogRocketLogger class.\n            isEnabled: false\n        },\n        rootHostname,\n        dom: {\n            textSanitizer: true,\n            inputSanitizer: true\n        },\n        network: {\n            requestSanitizer: createRequestSanitizer(fuzzyRequestSanitizer),\n            responseSanitizer: createResponseSanitizer(fuzzyResponseSanitizer)\n        },\n        browser: {\n            urlSanitizer: createUrlSanitizer(mergedPrivateQueryParameterNames)\n        },\n        shouldDebugLog: verbose\n    } satisfies LogRocketSdkOptions;\n\n    return applyTransformers(sdkOptions, transformers, {\n        verbose,\n        logger\n    });\n}\n\nconst registrationGuard = new HasExecutedGuard();\n\n// This function should only be used by tests.\nexport function __resetRegistrationGuard() {\n    registrationGuard.reset();\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport function registerLogRocketInstrumentation(appId: string, options: RegisterLogRocketInstrumentationOptions = {}) {\n    const {\n        verbose = false,\n        loggers = []\n    } = options;\n\n    const logger = createCompositeLogger(verbose, loggers);\n\n    registrationGuard.throw(\"[logrocket] The LogRocket instrumentation has already been registered. Did you call the \\\"registerLogRocketInstrumentation\\\" function twice?\");\n\n    const sdkOptions = getLogRocketSdkOptions(options, logger);\n\n    // Session starts anonymously when LogRocket.init() is called.\n    LogRocket.init(appId, sdkOptions);\n\n    const telemetryContext = createTelemetryContext(logger);\n\n    // LogRocket maintains the same session even if the user starts as anonymous and later becomes identified via LogRocket.identify().\n    // If LogRocket.identify is called multiple times during a recording, you can search for any of the identified users in the session.\n    LogRocket.identify(telemetryContext.deviceId, {\n        [DeviceIdTrait]: telemetryContext.deviceId,\n        [TelemetryIdTrait]: telemetryContext.telemetryId\n    });\n\n    LogRocket.getSessionURL(url => {\n        logger\n            .withText(\"[logrocket] Session replay URL is now available:\")\n            .withText(url)\n            .debug();\n    });\n\n    // Indicates to the host applications that logrocket has been initialized.\n    // It's useful in cases where an \"add-on\", like the platform widgets needs\n    // to know whether or not the host application is using LogRocket.\n    // While there are ways that the host application could tell to an \"add-on\" if\n    // it's using LogRocket or not, doing it this way is transparent for the consumer,\n    // which is great for DX.\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    globalThis[IsRegisteredVariableName] = true;\n\n    // While consumers could directly call LogRocket.getSessionURL, by doing it this way,\n    // it allow consumers to not take a direct dependency on the \"logrocket\" package.\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore\n    globalThis[RegisterGetSessionUrlFunctionName] = listener => {\n        LogRocket.getSessionURL(listener);\n    };\n\n    const bootstrappingStore = createBootstrappingStore(logger);\n    // Let the other telemetry libraries know that LogRocket instrumentation is ready.\n    bootstrappingStore.dispatch({ type: \"logrocket-ready\" });\n\n    logger.information(\"[logrocket] LogRocket instrumentation is registered.\");\n}\n"],"names":["createCompositeLogger","createBootstrappingStore","createTelemetryContext","LogRocket","LogrocketFuzzySanitizer","applyTransformers","DeviceIdTrait","TelemetryIdTrait","createRequestSanitizer","createResponseSanitizer","createUrlSanitizer","HasExecutedGuard","IsRegisteredVariableName","RegisterGetSessionUrlFunctionName","DefaultPrivateFieldNames","DefaultPrivateQueryParameterNames","getLogRocketSdkOptions","userOptions","logger","rootHostname","privateFieldNames","privateQueryParameterNames","verbose","transformers","mergedPrivateFieldNames","mergedPrivateQueryParameterNames","fuzzyRequestSanitizer","fuzzyResponseSanitizer","sdkOptions","registrationGuard","__resetRegistrationGuard","registerLogRocketInstrumentation","appId","options","loggers","telemetryContext","url","globalThis","listener","bootstrappingStore"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAA2E;AACY;AACrD;AACqC;AACyB;AACjB;AACV;AACE;AACV;AACJ;AAGlD,MAAMY,2BAA2B,kDAAkD;AACnF,MAAMC,oCAAoC,sEAAsE;AAEvH,MAAMC,2BAA2B;IAC7B;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;CACH;AAED,MAAMC,oCAAoC;IACtC;IACA;IACA;CACH;AAgCD,2EAA2E;AACpE,SAASC,uBAAuBC,WAAoD,EAAEC,MAAkB;IAC3G,MAAM,EACFC,eAAe,cAAc,EAC7BC,oBAAoB,EAAE,EACtBC,6BAA6B,EAAE,EAC/BC,UAAU,KAAK,EACfC,eAAe,EAAE,EACpB,GAAGN;IAEJ,MAAMO,0BAA0BV,yBAAyB,MAAM,CAACM;IAChE,MAAMK,mCAAmCV,kCAAkC,MAAM,CAACM;IAElF,kJAAkJ;IAClJ,gCAAgC;IAChC,0EAA0E;IAC1E,6DAA6D;IAC7D,aAAa;IACb,MAAM,EAAE,kBAAkBK,qBAAqB,EAAE,mBAAmBC,sBAAsB,EAAE,GAAGvB,sCAA6B,CAACoB;IAE7H,MAAMI,aAAa;QACf,SAAS;YACL,wFAAwF;YACxF,sEAAsE;YACtE,WAAW;QACf;QACAT;QACA,KAAK;YACD,eAAe;YACf,gBAAgB;QACpB;QACA,SAAS;YACL,kBAAkBX,sBAAsBA,CAACkB;YACzC,mBAAmBjB,uBAAuBA,CAACkB;QAC/C;QACA,SAAS;YACL,cAAcjB,kBAAkBA,CAACe;QACrC;QACA,gBAAgBH;IACpB;IAEA,OAAOjB,iBAAiBA,CAACuB,YAAYL,cAAc;QAC/CD;QACAJ;IACJ;AACJ;AAEA,MAAMW,oBAAoB,IAAIlB,gBAAgBA;AAE9C,8CAA8C;AACvC,SAASmB;IACZD,kBAAkB,KAAK;AAC3B;AAEA;;CAEC,GACM,SAASE,iCAAiCC,KAAa,EAAEC,UAAmD,CAAC,CAAC;IACjH,MAAM,EACFX,UAAU,KAAK,EACfY,UAAU,EAAE,EACf,GAAGD;IAEJ,MAAMf,SAASlB,qBAAqBA,CAACsB,SAASY;IAE9CL,kBAAkB,KAAK,CAAC;IAExB,MAAMD,aAAaZ,uBAAuBiB,SAASf;IAEnD,8DAA8D;IAC9Df,cAAc,CAAC6B,OAAOJ;IAEtB,MAAMO,mBAAmBjC,sBAAsBA,CAACgB;IAEhD,mIAAmI;IACnI,oIAAoI;IACpIf,kBAAkB,CAACgC,iBAAiB,QAAQ,EAAE;QAC1C,CAAC7B,aAAaA,CAAC,EAAE6B,iBAAiB,QAAQ;QAC1C,CAAC5B,gBAAgBA,CAAC,EAAE4B,iBAAiB,WAAW;IACpD;IAEAhC,uBAAuB,CAACiC,CAAAA;QACpBlB,OACK,QAAQ,CAAC,oDACT,QAAQ,CAACkB,KACT,KAAK;IACd;IAEA,0EAA0E;IAC1E,0EAA0E;IAC1E,kEAAkE;IAClE,8EAA8E;IAC9E,kFAAkF;IAClF,yBAAyB;IACzB,6DAA6D;IAC7D,aAAa;IACbC,UAAU,CAACzB,yBAAyB,GAAG;IAEvC,qFAAqF;IACrF,iFAAiF;IACjF,6DAA6D;IAC7D,aAAa;IACbyB,UAAU,CAACxB,kCAAkC,GAAGyB,CAAAA;QAC5CnC,uBAAuB,CAACmC;IAC5B;IAEA,MAAMC,qBAAqBtC,wBAAwBA,CAACiB;IACpD,kFAAkF;IAClFqB,mBAAmB,QAAQ,CAAC;QAAE,MAAM;IAAkB;IAEtDrB,OAAO,WAAW,CAAC;AACvB"}

package/src/HasExecutedGuard.ts

@@ -1,19 +0,0 @@
-export class HasExecutedGuard {
-    #hasExecuted: boolean = false;
-
-    throw(message: string) {
-        if (this.#hasExecuted) {
-            throw new Error(message);
-        }
-
-        this.#hasExecuted = true;
-    }
-
-    get hasExecuted() {
-        return this.#hasExecuted;
-    }
-
-    reset() {
-        this.#hasExecuted = false;
-    }
-}

package/src/createDefaultUserTraits.ts

@@ -1,160 +0,0 @@
-import { getTelemetryContext } from "@workleap/telemetry";
-import { isDefined } from "./assertions.ts";
-
-/**
- * @see {@link https://workleap.github.io/wl-telemetry}
- */
-export interface LogRocketIdentification {
-    userId: string;
-    organizationId: string;
-    organizationName: string;
-    isMigratedToWorkleap: boolean;
-    isAdmin: boolean;
-    isOrganizationCreator?: boolean;
-    isExecutive?: {
-        wov?: boolean;
-        lms?: boolean;
-        onb?: boolean;
-        sks?: boolean;
-        wpm?: boolean;
-        pbd?: boolean;
-        cmp?: boolean;
-    };
-    isCollaborator?: {
-        wov?: boolean;
-        lms?: boolean;
-        onb?: boolean;
-        sks?: boolean;
-        wpm?: boolean;
-        pbd?: boolean;
-        cmp?: boolean;
-    };
-    isReportingManager?: boolean;
-    isTeamManager?: boolean;
-    planCode?: {
-        wov?: string;
-        lms?: string;
-        onb?: string;
-        sks?: string;
-        wpm?: string;
-        pbd?: string;
-        cmp?: string;
-    };
-}
-
-/**
- * @see {@link https://workleap.github.io/wl-telemetry}
- */
-export interface LogRocketUserTraits extends Record<string, unknown> {
-    "User Id": string;
-    "Organization Id": string;
-    "Organization Name": string;
-    "Is Migrated To Workleap": boolean;
-    "Is Admin": boolean;
-    "Device Id": string;
-    "Telemetry Id": string;
-    "Is Organization Creator"?: boolean;
-    "Is Executive"?: boolean;
-    "Is Executive - Officevibe"?: boolean;
-    "Is Executive - LMS"?: boolean;
-    "Is Executive - Onboarding"?: boolean;
-    "Is Executive - Skills"?: boolean;
-    "Is Executive - Performance"?: boolean;
-    "Is Executive - Pingboard"?: boolean;
-    "Is Collaborator"?: boolean;
-    "Is Collaborator - Officevibe"?: boolean;
-    "Is Collaborator - LMS"?: boolean;
-    "Is Collaborator - Onboarding"?: boolean;
-    "Is Collaborator - Skills"?: boolean;
-    "Is Collaborator - Performance"?: boolean;
-    "Is Collaborator - Pingboard"?: boolean;
-    "Is Reporting Manager"?: boolean;
-    "Is Team Manager"?: boolean;
-    "Plan Code - Officevibe"?: string;
-    "Plan Code - LMS"?: string;
-    "Plan Code - Onboarding"?: string;
-    "Plan Code - Skills"?: string;
-    "Plan Code - Performance"?: string;
-    "Plan Code - Pingboard"?: string;
-}
-
-export const DeviceIdTrait = "Device Id";
-export const TelemetryIdTrait = "Telemetry Id";
-
-/**
- * Create the default user traits for a WLP user.
- * @see {@link https://workleap.github.io/wl-telemetry}
- */
-export function createDefaultUserTraits(identification: LogRocketIdentification) {
-    const {
-        userId,
-        organizationId,
-        organizationName,
-        isMigratedToWorkleap,
-        isOrganizationCreator,
-        isAdmin,
-        isExecutive,
-        isCollaborator,
-        isReportingManager,
-        isTeamManager,
-        planCode
-    } = identification;
-
-    const isExecutiveInAnyProduct = Boolean(
-        isExecutive?.wov ||
-        isExecutive?.lms ||
-        isExecutive?.onb ||
-        isExecutive?.sks ||
-        isExecutive?.wpm ||
-        isExecutive?.pbd ||
-        isExecutive?.cmp
-    );
-
-    const isCollaboratorInAnyProduct = Boolean(
-        isCollaborator?.wov ||
-        isCollaborator?.lms ||
-        isCollaborator?.onb ||
-        isCollaborator?.sks ||
-        isCollaborator?.wpm ||
-        isCollaborator?.pbd ||
-        isCollaborator?.cmp
-    );
-
-    const telemetryContext = getTelemetryContext();
-
-    return {
-        "User Id": userId,
-        "Organization Id": organizationId,
-        "Organization Name": organizationName,
-        "Is Migrated To Workleap": isMigratedToWorkleap,
-        "Is Admin": isAdmin,
-        [DeviceIdTrait]: telemetryContext ? telemetryContext.deviceId : "N/A",
-        [TelemetryIdTrait]: telemetryContext ? telemetryContext.telemetryId : "N/A",
-        ...(isDefined(isOrganizationCreator) && { "Is Organization Creator": isOrganizationCreator }),
-        ...(isExecutiveInAnyProduct && { "Is Executive": true }),
-        ...(isDefined(isExecutive?.wov) && { "Is Executive - Officevibe": isExecutive.wov }),
-        ...(isDefined(isExecutive?.lms) && { "Is Executive - LMS": isExecutive.lms }),
-        ...(isDefined(isExecutive?.onb) && { "Is Executive - Onboarding": isExecutive.onb }),
-        ...(isDefined(isExecutive?.sks) && { "Is Executive - Skills": isExecutive.sks }),
-        ...(isDefined(isExecutive?.wpm) && { "Is Executive - Performance": isExecutive.wpm }),
-        ...(isDefined(isExecutive?.pbd) && { "Is Executive - Pingboard": isExecutive.pbd }),
-        ...(isDefined(isExecutive?.cmp) && { "Is Executive - Compensation": isExecutive.cmp }),
-        ...(isCollaboratorInAnyProduct && { "Is Collaborator": isCollaboratorInAnyProduct }),
-        ...(isDefined(isCollaborator?.wov) && { "Is Collaborator - Officevibe": isCollaborator.wov }),
-        ...(isDefined(isCollaborator?.lms) && { "Is Collaborator - LMS": isCollaborator.lms }),
-        ...(isDefined(isCollaborator?.onb) && { "Is Collaborator - Onboarding": isCollaborator.onb }),
-        ...(isDefined(isCollaborator?.sks) && { "Is Collaborator - Skills": isCollaborator.sks }),
-        ...(isDefined(isCollaborator?.wpm) && { "Is Collaborator - Performance": isCollaborator.wpm }),
-        ...(isDefined(isCollaborator?.pbd) && { "Is Collaborator - Pingboard": isCollaborator.pbd }),
-        ...(isDefined(isCollaborator?.cmp) && { "Is Collaborator - Compensation": isCollaborator.cmp }),
-        ...(isDefined(isReportingManager) && { "Is Reporting Manager": isReportingManager }),
-        ...(isDefined(isTeamManager) && { "Is Team Manager": isTeamManager }),
-        ...(isDefined(planCode?.wov) && { "Plan Code - Officevibe": planCode.wov }),
-        ...(isDefined(planCode?.lms) && { "Plan Code - LMS": planCode.lms }),
-        ...(isDefined(planCode?.onb) && { "Plan Code - Onboarding": planCode.onb }),
-        ...(isDefined(planCode?.sks) && { "Plan Code - Skills": planCode.sks }),
-        ...(isDefined(planCode?.wpm) && { "Plan Code - Performance": planCode.wpm }),
-        ...(isDefined(planCode?.pbd) && { "Plan Code - Pingboard": planCode.pbd }),
-        ...(isDefined(planCode?.cmp) && { "Plan Code - Compensation": planCode.cmp })
-    } satisfies LogRocketUserTraits;
-}

package/src/index.ts

@@ -1,6 +0,0 @@
-export type { LogRocketSdkOptionsTransformer } from "./applyTransformers.ts";
-export { createDefaultUserTraits, type LogRocketIdentification, type LogRocketUserTraits } from "./createDefaultUserTraits.ts";
-export { LogRocketLogger, LogRocketLoggerScope } from "./LogRocketLogger.ts";
-export type * from "./logRocketTypes.ts";
-export { registerLogRocketInstrumentation } from "./registerLogRocketInstrumentation.ts";
-