@workleap/logrocket 3.0.5 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @workleap/logrocket
 
+## 4.0.0
+
+### Major Changes
+
+- [#216](https://github.com/workleap/wl-telemetry/pull/216) [`63681db`](https://github.com/workleap/wl-telemetry/commit/63681db29d72515f435df680acb0946ee7ff9625) Thanks [@mahmoudmoravej](https://github.com/mahmoudmoravej)! - Fixed the default user traits so they can be forwarded to `LogRocket.identify` as documented, and removed the ShareGate partner program trait.
+
+  ## Breaking changes
+  - The `isInPartnerProgram` option of `LogRocketShareGateIdentification` and the `Is In Partner Program` trait it produced have been removed.
+  - `LogRocketWorkleapPlatformUserTraits` and `LogRocketShareGateUserTraits` are no longer extending `Record<string, unknown>`. The `unknown` index signature made them incompatible with LogRocket `IUserTraits` type, causing a `TS2345` error when the traits were passed to `LogRocket.identify`. They are now declared as type aliases, which means accessing an unknown trait is a compilation error rather than an `unknown` value.
+
+  ## Improvements
+  - The `microsoftUserId`, `microsoftTenantId` and `workspaceId` options of `LogRocketShareGateIdentification` are now optional. The matching traits fall back to `N/A` when no value is provided, as the correlation ids already do.
+  - `LogRocketWorkleapPlatformUserTraits` now includes the `Is Executive - Compensation`, `Is Collaborator - Compensation` and `Plan Code - Compensation` traits, which `createWorkleapPlatformDefaultUserTraits` was already returning.
+
 ## 3.0.5
 
 ### Patch Changes

package/dist/js/LogRocketInstrumentationClient.d.ts

@@ -45,7 +45,7 @@ export interface LogRocketWorkleapPlatformIdentification {
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unknown> {
+export type LogRocketWorkleapPlatformUserTraits = {
     "User Id": string;
     "Organization Id": string;
     "Organization Name": string;
@@ -61,6 +61,7 @@ export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unkn
     "Is Executive - Skills"?: boolean;
     "Is Executive - Performance"?: boolean;
     "Is Executive - Pingboard"?: boolean;
+    "Is Executive - Compensation"?: boolean;
     "Is Collaborator"?: boolean;
     "Is Collaborator - Officevibe"?: boolean;
     "Is Collaborator - LMS"?: boolean;
@@ -68,6 +69,7 @@ export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unkn
     "Is Collaborator - Skills"?: boolean;
     "Is Collaborator - Performance"?: boolean;
     "Is Collaborator - Pingboard"?: boolean;
+    "Is Collaborator - Compensation"?: boolean;
     "Is Reporting Manager"?: boolean;
     "Is Team Manager"?: boolean;
     "Plan Code - Officevibe"?: string;
@@ -76,29 +78,28 @@ export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unkn
     "Plan Code - Skills"?: string;
     "Plan Code - Performance"?: string;
     "Plan Code - Pingboard"?: string;
-}
+    "Plan Code - Compensation"?: string;
+};
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
 export interface LogRocketShareGateIdentification {
     shareGateAccountId: string;
-    microsoftUserId: string;
-    microsoftTenantId: string;
-    workspaceId: string;
-    isInPartnerProgram?: boolean;
+    microsoftUserId?: string;
+    microsoftTenantId?: string;
+    workspaceId?: string;
 }
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export interface LogRocketShareGateUserTraits extends Record<string, unknown> {
+export type LogRocketShareGateUserTraits = {
     "ShareGate Account Id": string;
     "Microsoft User Id": string;
     "Microsoft Tenant Id": string;
     "Workspace Id": string;
     "Device Id": string;
     "Telemetry Id": string;
-    "Is In Partner Program"?: boolean;
-}
+};
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
@@ -171,6 +172,5 @@ export declare class LogRocketInstrumentationClientImpl implements LogRocketInst
         "Workspace Id": string;
         "Device Id": string;
         "Telemetry Id": string;
-        "Is In Partner Program": boolean | undefined;
     };
 }

package/dist/js/LogRocketInstrumentationClient.js

@@ -114,12 +114,11 @@ const TelemetryIdTrait = "Telemetry Id";
     createShareGateDefaultUserTraits(identification) {
         return {
             "ShareGate Account Id": identification.shareGateAccountId,
-            "Microsoft User Id": identification.microsoftUserId,
-            "Microsoft Tenant Id": identification.microsoftTenantId,
-            "Workspace Id": identification.workspaceId,
+            "Microsoft User Id": identification.microsoftUserId ?? "N/A",
+            "Microsoft Tenant Id": identification.microsoftTenantId ?? "N/A",
+            "Workspace Id": identification.workspaceId ?? "N/A",
             [DeviceIdTrait]: this.#telemetryContext?.deviceId ?? "N/A",
-            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? "N/A",
-            "Is In Partner Program": identification.isInPartnerProgram
+            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? "N/A"
         };
     }
 }

package/dist/js/LogRocketInstrumentationClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"js/LogRocketInstrumentationClient.js","sources":["../../src/js/LogRocketInstrumentationClient.ts"],"sourcesContent":["import type { LogRocketInstrumentationPartialClient, TelemetryContext } from \"@workleap-telemetry/core\";\nimport LogRocket from \"logrocket\";\nimport { isDefined } from \"./assertions.ts\";\n\nexport type GetLogRocketSessionUrlListener = (sessionURL: string) => void;\n\nexport const DeviceIdTrait = \"Device Id\";\nexport const TelemetryIdTrait = \"Telemetry Id\";\n\n///////////////////////////\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketWorkleapPlatformIdentification {\n    userId: string;\n    organizationId: string;\n    organizationName: string;\n    isMigratedToWorkleap: boolean;\n    isAdmin: boolean;\n    isOrganizationCreator?: boolean;\n    isExecutive?: {\n        wov?: boolean;\n        lms?: boolean;\n        onb?: boolean;\n        sks?: boolean;\n        wpm?: boolean;\n        pbd?: boolean;\n        cmp?: boolean;\n    };\n    isCollaborator?: {\n        wov?: boolean;\n        lms?: boolean;\n        onb?: boolean;\n        sks?: boolean;\n        wpm?: boolean;\n        pbd?: boolean;\n        cmp?: boolean;\n    };\n    isReportingManager?: boolean;\n    isTeamManager?: boolean;\n    planCode?: {\n        wov?: string;\n        lms?: string;\n        onb?: string;\n        sks?: string;\n        wpm?: string;\n        pbd?: string;\n        cmp?: string;\n    };\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketWorkleapPlatformUserTraits extends Record<string, unknown> {\n    \"User Id\": string;\n    \"Organization Id\": string;\n    \"Organization Name\": string;\n    \"Is Migrated To Workleap\": boolean;\n    \"Is Admin\": boolean;\n    [DeviceIdTrait]: string;\n    [TelemetryIdTrait]: string;\n    \"Is Organization Creator\"?: boolean;\n    \"Is Executive\"?: boolean;\n    \"Is Executive - Officevibe\"?: boolean;\n    \"Is Executive - LMS\"?: boolean;\n    \"Is Executive - Onboarding\"?: boolean;\n    \"Is Executive - Skills\"?: boolean;\n    \"Is Executive - Performance\"?: boolean;\n    \"Is Executive - Pingboard\"?: boolean;\n    \"Is Collaborator\"?: boolean;\n    \"Is Collaborator - Officevibe\"?: boolean;\n    \"Is Collaborator - LMS\"?: boolean;\n    \"Is Collaborator - Onboarding\"?: boolean;\n    \"Is Collaborator - Skills\"?: boolean;\n    \"Is Collaborator - Performance\"?: boolean;\n    \"Is Collaborator - Pingboard\"?: boolean;\n    \"Is Reporting Manager\"?: boolean;\n    \"Is Team Manager\"?: boolean;\n    \"Plan Code - Officevibe\"?: string;\n    \"Plan Code - LMS\"?: string;\n    \"Plan Code - Onboarding\"?: string;\n    \"Plan Code - Skills\"?: string;\n    \"Plan Code - Performance\"?: string;\n    \"Plan Code - Pingboard\"?: string;\n}\n\n///////////////////////////\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketShareGateIdentification {\n    shareGateAccountId: string;\n    microsoftUserId: string;\n    microsoftTenantId: string;\n    workspaceId: string;\n    isInPartnerProgram?: boolean;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketShareGateUserTraits extends Record<string, unknown> {\n    \"ShareGate Account Id\": string;\n    \"Microsoft User Id\": string;\n    \"Microsoft Tenant Id\": string;\n    \"Workspace Id\": string;\n    \"Device Id\": string;\n    \"Telemetry Id\": string;\n    \"Is In Partner Program\"?: boolean;\n}\n\n///////////////////////////\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketInstrumentationClient extends LogRocketInstrumentationPartialClient {\n    /**\n     * Register a listener to receive the LogRocket session id when it's available.\n     * This method is the equivalent of the LogRocket.getSessionURL function but is\n     * particularly useful for third party libraries that doesn't want to take a dependency\n     * on `logrocket`.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    registerGetSessionUrlListener: (listener: GetLogRocketSessionUrlListener) => void;\n\n    /**\n     * Create the default user traits for a Workleap Platform user.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    createWorkleapPlatformDefaultUserTraits: (identification: LogRocketWorkleapPlatformIdentification) => LogRocketWorkleapPlatformUserTraits;\n\n    /**\n     * Create the default user traits for a ShareGate user.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    createShareGateDefaultUserTraits: (identification: LogRocketShareGateIdentification) => LogRocketShareGateUserTraits;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport class LogRocketInstrumentationClientImpl implements LogRocketInstrumentationClient {\n    readonly #telemetryContext?: TelemetryContext;\n\n    constructor(telemetryContext?: TelemetryContext) {\n        this.#telemetryContext = telemetryContext;\n    }\n\n    // IMPORTANT: If you update this method, make sure to update the LogRocketInstrumentationPartialClient\n    // interface as well in @workleap-telemetry/core.\n    registerGetSessionUrlListener(listener: GetLogRocketSessionUrlListener) {\n        LogRocket.getSessionURL(listener);\n    }\n\n    createWorkleapPlatformDefaultUserTraits(identification: LogRocketWorkleapPlatformIdentification) {\n        const {\n            userId,\n            organizationId,\n            organizationName,\n            isMigratedToWorkleap,\n            isOrganizationCreator,\n            isAdmin,\n            isExecutive,\n            isCollaborator,\n            isReportingManager,\n            isTeamManager,\n            planCode\n        } = identification;\n\n        const isExecutiveInAnyProduct = Boolean(\n            isExecutive?.wov ||\n            isExecutive?.lms ||\n            isExecutive?.onb ||\n            isExecutive?.sks ||\n            isExecutive?.wpm ||\n            isExecutive?.pbd ||\n            isExecutive?.cmp\n        );\n\n        const isCollaboratorInAnyProduct = Boolean(\n            isCollaborator?.wov ||\n            isCollaborator?.lms ||\n            isCollaborator?.onb ||\n            isCollaborator?.sks ||\n            isCollaborator?.wpm ||\n            isCollaborator?.pbd ||\n            isCollaborator?.cmp\n        );\n\n        return {\n            \"User Id\": userId,\n            \"Organization Id\": organizationId,\n            \"Organization Name\": organizationName,\n            \"Is Migrated To Workleap\": isMigratedToWorkleap,\n            \"Is Admin\": isAdmin,\n            [DeviceIdTrait]: this.#telemetryContext?.deviceId ?? \"N/A\",\n            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? \"N/A\",\n            ...(isDefined(isOrganizationCreator) && { \"Is Organization Creator\": isOrganizationCreator }),\n            ...(isExecutiveInAnyProduct && { \"Is Executive\": true }),\n            ...(isDefined(isExecutive?.wov) && { \"Is Executive - Officevibe\": isExecutive.wov }),\n            ...(isDefined(isExecutive?.lms) && { \"Is Executive - LMS\": isExecutive.lms }),\n            ...(isDefined(isExecutive?.onb) && { \"Is Executive - Onboarding\": isExecutive.onb }),\n            ...(isDefined(isExecutive?.sks) && { \"Is Executive - Skills\": isExecutive.sks }),\n            ...(isDefined(isExecutive?.wpm) && { \"Is Executive - Performance\": isExecutive.wpm }),\n            ...(isDefined(isExecutive?.pbd) && { \"Is Executive - Pingboard\": isExecutive.pbd }),\n            ...(isDefined(isExecutive?.cmp) && { \"Is Executive - Compensation\": isExecutive.cmp }),\n            ...(isCollaboratorInAnyProduct && { \"Is Collaborator\": isCollaboratorInAnyProduct }),\n            ...(isDefined(isCollaborator?.wov) && { \"Is Collaborator - Officevibe\": isCollaborator.wov }),\n            ...(isDefined(isCollaborator?.lms) && { \"Is Collaborator - LMS\": isCollaborator.lms }),\n            ...(isDefined(isCollaborator?.onb) && { \"Is Collaborator - Onboarding\": isCollaborator.onb }),\n            ...(isDefined(isCollaborator?.sks) && { \"Is Collaborator - Skills\": isCollaborator.sks }),\n            ...(isDefined(isCollaborator?.wpm) && { \"Is Collaborator - Performance\": isCollaborator.wpm }),\n            ...(isDefined(isCollaborator?.pbd) && { \"Is Collaborator - Pingboard\": isCollaborator.pbd }),\n            ...(isDefined(isCollaborator?.cmp) && { \"Is Collaborator - Compensation\": isCollaborator.cmp }),\n            ...(isDefined(isReportingManager) && { \"Is Reporting Manager\": isReportingManager }),\n            ...(isDefined(isTeamManager) && { \"Is Team Manager\": isTeamManager }),\n            ...(isDefined(planCode?.wov) && { \"Plan Code - Officevibe\": planCode.wov }),\n            ...(isDefined(planCode?.lms) && { \"Plan Code - LMS\": planCode.lms }),\n            ...(isDefined(planCode?.onb) && { \"Plan Code - Onboarding\": planCode.onb }),\n            ...(isDefined(planCode?.sks) && { \"Plan Code - Skills\": planCode.sks }),\n            ...(isDefined(planCode?.wpm) && { \"Plan Code - Performance\": planCode.wpm }),\n            ...(isDefined(planCode?.pbd) && { \"Plan Code - Pingboard\": planCode.pbd }),\n            ...(isDefined(planCode?.cmp) && { \"Plan Code - Compensation\": planCode.cmp })\n        } satisfies LogRocketWorkleapPlatformUserTraits;\n    }\n\n    createShareGateDefaultUserTraits(identification: LogRocketShareGateIdentification) {\n        return {\n            \"ShareGate Account Id\": identification.shareGateAccountId,\n            \"Microsoft User Id\": identification.microsoftUserId,\n            \"Microsoft Tenant Id\": identification.microsoftTenantId,\n            \"Workspace Id\": identification.workspaceId,\n            [DeviceIdTrait]: this.#telemetryContext?.deviceId ?? \"N/A\",\n            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? \"N/A\",\n            \"Is In Partner Program\": identification.isInPartnerProgram\n        } satisfies LogRocketShareGateUserTraits;\n    }\n}\n"],"names":["LogRocket","isDefined","DeviceIdTrait","TelemetryIdTrait","LogRocketInstrumentationClientImpl","telemetryContext","listener","identification","userId","organizationId","organizationName","isMigratedToWorkleap","isOrganizationCreator","isAdmin","isExecutive","isCollaborator","isReportingManager","isTeamManager","planCode","isExecutiveInAnyProduct","Boolean","isCollaboratorInAnyProduct"],"mappings":";;;;;AACkC;AACU;AAIrC,MAAME,aAAaA,GAAG,YAAY;AAClC,MAAMC,gBAAgBA,GAAG,eAAe;AAuI/C;;CAEC,GACM,MAAMC,kCAAkCA;IAClC,iBAAiB,CAAoB;IAE9C,YAAYC,gBAAmC,CAAE;QAC7C,IAAI,CAAC,iBAAiB,GAAGA;IAC7B;IAEA,sGAAsG;IACtG,iDAAiD;IACjD,8BAA8BC,QAAwC,EAAE;QACpEN,uBAAuB,CAACM;IAC5B;IAEA,wCAAwCC,cAAuD,EAAE;QAC7F,MAAM,EACFC,MAAM,EACNC,cAAc,EACdC,gBAAgB,EAChBC,oBAAoB,EACpBC,qBAAqB,EACrBC,OAAO,EACPC,WAAW,EACXC,cAAc,EACdC,kBAAkB,EAClBC,aAAa,EACbC,QAAQ,EACX,GAAGX;QAEJ,MAAMY,0BAA0BC,QAC5BN,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa;QAGjB,MAAMO,6BAA6BD,QAC/BL,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB;QAGpB,OAAO;YACH,WAAWP;YACX,mBAAmBC;YACnB,qBAAqBC;YACrB,2BAA2BC;YAC3B,YAAYE;YACZ,CAACX,aAAaA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY;YACrD,CAACC,gBAAgBA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,eAAe;YAC3D,GAAIF,SAASA,CAACW,0BAA0B;gBAAE,2BAA2BA;YAAsB,CAAC;YAC5F,GAAIO,2BAA2B;gBAAE,gBAAgB;YAAK,CAAC;YACvD,GAAIlB,SAASA,CAACa,aAAa,QAAQ;gBAAE,6BAA6BA,YAAY,GAAG;YAAC,CAAC;YACnF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,sBAAsBA,YAAY,GAAG;YAAC,CAAC;YAC5E,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,6BAA6BA,YAAY,GAAG;YAAC,CAAC;YACnF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,yBAAyBA,YAAY,GAAG;YAAC,CAAC;YAC/E,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,8BAA8BA,YAAY,GAAG;YAAC,CAAC;YACpF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,4BAA4BA,YAAY,GAAG;YAAC,CAAC;YAClF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,+BAA+BA,YAAY,GAAG;YAAC,CAAC;YACrF,GAAIO,8BAA8B;gBAAE,mBAAmBA;YAA2B,CAAC;YACnF,GAAIpB,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,gCAAgCA,eAAe,GAAG;YAAC,CAAC;YAC5F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,yBAAyBA,eAAe,GAAG;YAAC,CAAC;YACrF,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,gCAAgCA,eAAe,GAAG;YAAC,CAAC;YAC5F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,4BAA4BA,eAAe,GAAG;YAAC,CAAC;YACxF,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,iCAAiCA,eAAe,GAAG;YAAC,CAAC;YAC7F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,+BAA+BA,eAAe,GAAG;YAAC,CAAC;YAC3F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,kCAAkCA,eAAe,GAAG;YAAC,CAAC;YAC9F,GAAId,SAASA,CAACe,uBAAuB;gBAAE,wBAAwBA;YAAmB,CAAC;YACnF,GAAIf,SAASA,CAACgB,kBAAkB;gBAAE,mBAAmBA;YAAc,CAAC;YACpE,GAAIhB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,0BAA0BA,SAAS,GAAG;YAAC,CAAC;YAC1E,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,mBAAmBA,SAAS,GAAG;YAAC,CAAC;YACnE,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,0BAA0BA,SAAS,GAAG;YAAC,CAAC;YAC1E,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,sBAAsBA,SAAS,GAAG;YAAC,CAAC;YACtE,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,2BAA2BA,SAAS,GAAG;YAAC,CAAC;YAC3E,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,yBAAyBA,SAAS,GAAG;YAAC,CAAC;YACzE,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,4BAA4BA,SAAS,GAAG;YAAC,CAAC;QAChF;IACJ;IAEA,iCAAiCX,cAAgD,EAAE;QAC/E,OAAO;YACH,wBAAwBA,eAAe,kBAAkB;YACzD,qBAAqBA,eAAe,eAAe;YACnD,uBAAuBA,eAAe,iBAAiB;YACvD,gBAAgBA,eAAe,WAAW;YAC1C,CAACL,aAAaA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY;YACrD,CAACC,gBAAgBA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,eAAe;YAC3D,yBAAyBI,eAAe,kBAAkB;QAC9D;IACJ;AACJ"}
+{"version":3,"file":"js/LogRocketInstrumentationClient.js","sources":["../../src/js/LogRocketInstrumentationClient.ts"],"sourcesContent":["import type { LogRocketInstrumentationPartialClient, TelemetryContext } from \"@workleap-telemetry/core\";\nimport LogRocket from \"logrocket\";\nimport { isDefined } from \"./assertions.ts\";\n\nexport type GetLogRocketSessionUrlListener = (sessionURL: string) => void;\n\nexport const DeviceIdTrait = \"Device Id\";\nexport const TelemetryIdTrait = \"Telemetry Id\";\n\n///////////////////////////\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketWorkleapPlatformIdentification {\n    userId: string;\n    organizationId: string;\n    organizationName: string;\n    isMigratedToWorkleap: boolean;\n    isAdmin: boolean;\n    isOrganizationCreator?: boolean;\n    isExecutive?: {\n        wov?: boolean;\n        lms?: boolean;\n        onb?: boolean;\n        sks?: boolean;\n        wpm?: boolean;\n        pbd?: boolean;\n        cmp?: boolean;\n    };\n    isCollaborator?: {\n        wov?: boolean;\n        lms?: boolean;\n        onb?: boolean;\n        sks?: boolean;\n        wpm?: boolean;\n        pbd?: boolean;\n        cmp?: boolean;\n    };\n    isReportingManager?: boolean;\n    isTeamManager?: boolean;\n    planCode?: {\n        wov?: string;\n        lms?: string;\n        onb?: string;\n        sks?: string;\n        wpm?: string;\n        pbd?: string;\n        cmp?: string;\n    };\n}\n\n// Must remain assignable to the LogRocket \"IUserTraits\" type, otherwise the traits cannot be forwarded to\n// LogRocket.identify. Hence the type alias: an index signature would either widen the trait values beyond what\n// LogRocket accepts or forbid optional traits, while a plain interface has no implicit index signature.\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport type LogRocketWorkleapPlatformUserTraits = {\n    \"User Id\": string;\n    \"Organization Id\": string;\n    \"Organization Name\": string;\n    \"Is Migrated To Workleap\": boolean;\n    \"Is Admin\": boolean;\n    [DeviceIdTrait]: string;\n    [TelemetryIdTrait]: string;\n    \"Is Organization Creator\"?: boolean;\n    \"Is Executive\"?: boolean;\n    \"Is Executive - Officevibe\"?: boolean;\n    \"Is Executive - LMS\"?: boolean;\n    \"Is Executive - Onboarding\"?: boolean;\n    \"Is Executive - Skills\"?: boolean;\n    \"Is Executive - Performance\"?: boolean;\n    \"Is Executive - Pingboard\"?: boolean;\n    \"Is Executive - Compensation\"?: boolean;\n    \"Is Collaborator\"?: boolean;\n    \"Is Collaborator - Officevibe\"?: boolean;\n    \"Is Collaborator - LMS\"?: boolean;\n    \"Is Collaborator - Onboarding\"?: boolean;\n    \"Is Collaborator - Skills\"?: boolean;\n    \"Is Collaborator - Performance\"?: boolean;\n    \"Is Collaborator - Pingboard\"?: boolean;\n    \"Is Collaborator - Compensation\"?: boolean;\n    \"Is Reporting Manager\"?: boolean;\n    \"Is Team Manager\"?: boolean;\n    \"Plan Code - Officevibe\"?: string;\n    \"Plan Code - LMS\"?: string;\n    \"Plan Code - Onboarding\"?: string;\n    \"Plan Code - Skills\"?: string;\n    \"Plan Code - Performance\"?: string;\n    \"Plan Code - Pingboard\"?: string;\n    \"Plan Code - Compensation\"?: string;\n};\n\n///////////////////////////\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketShareGateIdentification {\n    shareGateAccountId: string;\n    microsoftUserId?: string;\n    microsoftTenantId?: string;\n    workspaceId?: string;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport type LogRocketShareGateUserTraits = {\n    \"ShareGate Account Id\": string;\n    \"Microsoft User Id\": string;\n    \"Microsoft Tenant Id\": string;\n    \"Workspace Id\": string;\n    \"Device Id\": string;\n    \"Telemetry Id\": string;\n};\n\n///////////////////////////\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport interface LogRocketInstrumentationClient extends LogRocketInstrumentationPartialClient {\n    /**\n     * Register a listener to receive the LogRocket session id when it's available.\n     * This method is the equivalent of the LogRocket.getSessionURL function but is\n     * particularly useful for third party libraries that doesn't want to take a dependency\n     * on `logrocket`.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    registerGetSessionUrlListener: (listener: GetLogRocketSessionUrlListener) => void;\n\n    /**\n     * Create the default user traits for a Workleap Platform user.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    createWorkleapPlatformDefaultUserTraits: (identification: LogRocketWorkleapPlatformIdentification) => LogRocketWorkleapPlatformUserTraits;\n\n    /**\n     * Create the default user traits for a ShareGate user.\n     * @see {@link https://workleap.github.io/wl-telemetry}\n     */\n    createShareGateDefaultUserTraits: (identification: LogRocketShareGateIdentification) => LogRocketShareGateUserTraits;\n}\n\n/**\n * @see {@link https://workleap.github.io/wl-telemetry}\n */\nexport class LogRocketInstrumentationClientImpl implements LogRocketInstrumentationClient {\n    readonly #telemetryContext?: TelemetryContext;\n\n    constructor(telemetryContext?: TelemetryContext) {\n        this.#telemetryContext = telemetryContext;\n    }\n\n    // IMPORTANT: If you update this method, make sure to update the LogRocketInstrumentationPartialClient\n    // interface as well in @workleap-telemetry/core.\n    registerGetSessionUrlListener(listener: GetLogRocketSessionUrlListener) {\n        LogRocket.getSessionURL(listener);\n    }\n\n    createWorkleapPlatformDefaultUserTraits(identification: LogRocketWorkleapPlatformIdentification) {\n        const {\n            userId,\n            organizationId,\n            organizationName,\n            isMigratedToWorkleap,\n            isOrganizationCreator,\n            isAdmin,\n            isExecutive,\n            isCollaborator,\n            isReportingManager,\n            isTeamManager,\n            planCode\n        } = identification;\n\n        const isExecutiveInAnyProduct = Boolean(\n            isExecutive?.wov ||\n            isExecutive?.lms ||\n            isExecutive?.onb ||\n            isExecutive?.sks ||\n            isExecutive?.wpm ||\n            isExecutive?.pbd ||\n            isExecutive?.cmp\n        );\n\n        const isCollaboratorInAnyProduct = Boolean(\n            isCollaborator?.wov ||\n            isCollaborator?.lms ||\n            isCollaborator?.onb ||\n            isCollaborator?.sks ||\n            isCollaborator?.wpm ||\n            isCollaborator?.pbd ||\n            isCollaborator?.cmp\n        );\n\n        return {\n            \"User Id\": userId,\n            \"Organization Id\": organizationId,\n            \"Organization Name\": organizationName,\n            \"Is Migrated To Workleap\": isMigratedToWorkleap,\n            \"Is Admin\": isAdmin,\n            [DeviceIdTrait]: this.#telemetryContext?.deviceId ?? \"N/A\",\n            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? \"N/A\",\n            ...(isDefined(isOrganizationCreator) && { \"Is Organization Creator\": isOrganizationCreator }),\n            ...(isExecutiveInAnyProduct && { \"Is Executive\": true }),\n            ...(isDefined(isExecutive?.wov) && { \"Is Executive - Officevibe\": isExecutive.wov }),\n            ...(isDefined(isExecutive?.lms) && { \"Is Executive - LMS\": isExecutive.lms }),\n            ...(isDefined(isExecutive?.onb) && { \"Is Executive - Onboarding\": isExecutive.onb }),\n            ...(isDefined(isExecutive?.sks) && { \"Is Executive - Skills\": isExecutive.sks }),\n            ...(isDefined(isExecutive?.wpm) && { \"Is Executive - Performance\": isExecutive.wpm }),\n            ...(isDefined(isExecutive?.pbd) && { \"Is Executive - Pingboard\": isExecutive.pbd }),\n            ...(isDefined(isExecutive?.cmp) && { \"Is Executive - Compensation\": isExecutive.cmp }),\n            ...(isCollaboratorInAnyProduct && { \"Is Collaborator\": isCollaboratorInAnyProduct }),\n            ...(isDefined(isCollaborator?.wov) && { \"Is Collaborator - Officevibe\": isCollaborator.wov }),\n            ...(isDefined(isCollaborator?.lms) && { \"Is Collaborator - LMS\": isCollaborator.lms }),\n            ...(isDefined(isCollaborator?.onb) && { \"Is Collaborator - Onboarding\": isCollaborator.onb }),\n            ...(isDefined(isCollaborator?.sks) && { \"Is Collaborator - Skills\": isCollaborator.sks }),\n            ...(isDefined(isCollaborator?.wpm) && { \"Is Collaborator - Performance\": isCollaborator.wpm }),\n            ...(isDefined(isCollaborator?.pbd) && { \"Is Collaborator - Pingboard\": isCollaborator.pbd }),\n            ...(isDefined(isCollaborator?.cmp) && { \"Is Collaborator - Compensation\": isCollaborator.cmp }),\n            ...(isDefined(isReportingManager) && { \"Is Reporting Manager\": isReportingManager }),\n            ...(isDefined(isTeamManager) && { \"Is Team Manager\": isTeamManager }),\n            ...(isDefined(planCode?.wov) && { \"Plan Code - Officevibe\": planCode.wov }),\n            ...(isDefined(planCode?.lms) && { \"Plan Code - LMS\": planCode.lms }),\n            ...(isDefined(planCode?.onb) && { \"Plan Code - Onboarding\": planCode.onb }),\n            ...(isDefined(planCode?.sks) && { \"Plan Code - Skills\": planCode.sks }),\n            ...(isDefined(planCode?.wpm) && { \"Plan Code - Performance\": planCode.wpm }),\n            ...(isDefined(planCode?.pbd) && { \"Plan Code - Pingboard\": planCode.pbd }),\n            ...(isDefined(planCode?.cmp) && { \"Plan Code - Compensation\": planCode.cmp })\n        } satisfies LogRocketWorkleapPlatformUserTraits;\n    }\n\n    createShareGateDefaultUserTraits(identification: LogRocketShareGateIdentification) {\n        return {\n            \"ShareGate Account Id\": identification.shareGateAccountId,\n            \"Microsoft User Id\": identification.microsoftUserId ?? \"N/A\",\n            \"Microsoft Tenant Id\": identification.microsoftTenantId ?? \"N/A\",\n            \"Workspace Id\": identification.workspaceId ?? \"N/A\",\n            [DeviceIdTrait]: this.#telemetryContext?.deviceId ?? \"N/A\",\n            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? \"N/A\"\n        } satisfies LogRocketShareGateUserTraits;\n    }\n}\n"],"names":["LogRocket","isDefined","DeviceIdTrait","TelemetryIdTrait","LogRocketInstrumentationClientImpl","telemetryContext","listener","identification","userId","organizationId","organizationName","isMigratedToWorkleap","isOrganizationCreator","isAdmin","isExecutive","isCollaborator","isReportingManager","isTeamManager","planCode","isExecutiveInAnyProduct","Boolean","isCollaboratorInAnyProduct"],"mappings":";;;;;AACkC;AACU;AAIrC,MAAME,aAAaA,GAAG,YAAY;AAClC,MAAMC,gBAAgBA,GAAG,eAAe;AA2I/C;;CAEC,GACM,MAAMC,kCAAkCA;IAClC,iBAAiB,CAAoB;IAE9C,YAAYC,gBAAmC,CAAE;QAC7C,IAAI,CAAC,iBAAiB,GAAGA;IAC7B;IAEA,sGAAsG;IACtG,iDAAiD;IACjD,8BAA8BC,QAAwC,EAAE;QACpEN,uBAAuB,CAACM;IAC5B;IAEA,wCAAwCC,cAAuD,EAAE;QAC7F,MAAM,EACFC,MAAM,EACNC,cAAc,EACdC,gBAAgB,EAChBC,oBAAoB,EACpBC,qBAAqB,EACrBC,OAAO,EACPC,WAAW,EACXC,cAAc,EACdC,kBAAkB,EAClBC,aAAa,EACbC,QAAQ,EACX,GAAGX;QAEJ,MAAMY,0BAA0BC,QAC5BN,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa,OACbA,aAAa;QAGjB,MAAMO,6BAA6BD,QAC/BL,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB,OAChBA,gBAAgB;QAGpB,OAAO;YACH,WAAWP;YACX,mBAAmBC;YACnB,qBAAqBC;YACrB,2BAA2BC;YAC3B,YAAYE;YACZ,CAACX,aAAaA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY;YACrD,CAACC,gBAAgBA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,eAAe;YAC3D,GAAIF,SAASA,CAACW,0BAA0B;gBAAE,2BAA2BA;YAAsB,CAAC;YAC5F,GAAIO,2BAA2B;gBAAE,gBAAgB;YAAK,CAAC;YACvD,GAAIlB,SAASA,CAACa,aAAa,QAAQ;gBAAE,6BAA6BA,YAAY,GAAG;YAAC,CAAC;YACnF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,sBAAsBA,YAAY,GAAG;YAAC,CAAC;YAC5E,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,6BAA6BA,YAAY,GAAG;YAAC,CAAC;YACnF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,yBAAyBA,YAAY,GAAG;YAAC,CAAC;YAC/E,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,8BAA8BA,YAAY,GAAG;YAAC,CAAC;YACpF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,4BAA4BA,YAAY,GAAG;YAAC,CAAC;YAClF,GAAIb,SAASA,CAACa,aAAa,QAAQ;gBAAE,+BAA+BA,YAAY,GAAG;YAAC,CAAC;YACrF,GAAIO,8BAA8B;gBAAE,mBAAmBA;YAA2B,CAAC;YACnF,GAAIpB,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,gCAAgCA,eAAe,GAAG;YAAC,CAAC;YAC5F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,yBAAyBA,eAAe,GAAG;YAAC,CAAC;YACrF,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,gCAAgCA,eAAe,GAAG;YAAC,CAAC;YAC5F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,4BAA4BA,eAAe,GAAG;YAAC,CAAC;YACxF,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,iCAAiCA,eAAe,GAAG;YAAC,CAAC;YAC7F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,+BAA+BA,eAAe,GAAG;YAAC,CAAC;YAC3F,GAAId,SAASA,CAACc,gBAAgB,QAAQ;gBAAE,kCAAkCA,eAAe,GAAG;YAAC,CAAC;YAC9F,GAAId,SAASA,CAACe,uBAAuB;gBAAE,wBAAwBA;YAAmB,CAAC;YACnF,GAAIf,SAASA,CAACgB,kBAAkB;gBAAE,mBAAmBA;YAAc,CAAC;YACpE,GAAIhB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,0BAA0BA,SAAS,GAAG;YAAC,CAAC;YAC1E,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,mBAAmBA,SAAS,GAAG;YAAC,CAAC;YACnE,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,0BAA0BA,SAAS,GAAG;YAAC,CAAC;YAC1E,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,sBAAsBA,SAAS,GAAG;YAAC,CAAC;YACtE,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,2BAA2BA,SAAS,GAAG;YAAC,CAAC;YAC3E,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,yBAAyBA,SAAS,GAAG;YAAC,CAAC;YACzE,GAAIjB,SAASA,CAACiB,UAAU,QAAQ;gBAAE,4BAA4BA,SAAS,GAAG;YAAC,CAAC;QAChF;IACJ;IAEA,iCAAiCX,cAAgD,EAAE;QAC/E,OAAO;YACH,wBAAwBA,eAAe,kBAAkB;YACzD,qBAAqBA,eAAe,eAAe,IAAI;YACvD,uBAAuBA,eAAe,iBAAiB,IAAI;YAC3D,gBAAgBA,eAAe,WAAW,IAAI;YAC9C,CAACL,aAAaA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY;YACrD,CAACC,gBAAgBA,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,eAAe;QAC/D;IACJ;AACJ"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@workleap/logrocket",
   "author": "Workleap",
-  "version": "3.0.5",
+  "version": "4.0.0",
   "description": "A package containing utilities for LogRocket.",
   "license": "Apache-2.0",
   "repository": {

package/src/js/LogRocketInstrumentationClient.ts

@@ -50,10 +50,13 @@ export interface LogRocketWorkleapPlatformIdentification {
     };
 }
 
+// Must remain assignable to the LogRocket "IUserTraits" type, otherwise the traits cannot be forwarded to
+// LogRocket.identify. Hence the type alias: an index signature would either widen the trait values beyond what
+// LogRocket accepts or forbid optional traits, while a plain interface has no implicit index signature.
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unknown> {
+export type LogRocketWorkleapPlatformUserTraits = {
     "User Id": string;
     "Organization Id": string;
     "Organization Name": string;
@@ -69,6 +72,7 @@ export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unkn
     "Is Executive - Skills"?: boolean;
     "Is Executive - Performance"?: boolean;
     "Is Executive - Pingboard"?: boolean;
+    "Is Executive - Compensation"?: boolean;
     "Is Collaborator"?: boolean;
     "Is Collaborator - Officevibe"?: boolean;
     "Is Collaborator - LMS"?: boolean;
@@ -76,6 +80,7 @@ export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unkn
     "Is Collaborator - Skills"?: boolean;
     "Is Collaborator - Performance"?: boolean;
     "Is Collaborator - Pingboard"?: boolean;
+    "Is Collaborator - Compensation"?: boolean;
     "Is Reporting Manager"?: boolean;
     "Is Team Manager"?: boolean;
     "Plan Code - Officevibe"?: string;
@@ -84,7 +89,8 @@ export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unkn
     "Plan Code - Skills"?: string;
     "Plan Code - Performance"?: string;
     "Plan Code - Pingboard"?: string;
-}
+    "Plan Code - Compensation"?: string;
+};
 
 ///////////////////////////
 
@@ -93,24 +99,22 @@ export interface LogRocketWorkleapPlatformUserTraits extends Record<string, unkn
  */
 export interface LogRocketShareGateIdentification {
     shareGateAccountId: string;
-    microsoftUserId: string;
-    microsoftTenantId: string;
-    workspaceId: string;
-    isInPartnerProgram?: boolean;
+    microsoftUserId?: string;
+    microsoftTenantId?: string;
+    workspaceId?: string;
 }
 
 /**
  * @see {@link https://workleap.github.io/wl-telemetry}
  */
-export interface LogRocketShareGateUserTraits extends Record<string, unknown> {
+export type LogRocketShareGateUserTraits = {
     "ShareGate Account Id": string;
     "Microsoft User Id": string;
     "Microsoft Tenant Id": string;
     "Workspace Id": string;
     "Device Id": string;
     "Telemetry Id": string;
-    "Is In Partner Program"?: boolean;
-}
+};
 
 ///////////////////////////
 
@@ -231,12 +235,11 @@ export class LogRocketInstrumentationClientImpl implements LogRocketInstrumentat
     createShareGateDefaultUserTraits(identification: LogRocketShareGateIdentification) {
         return {
             "ShareGate Account Id": identification.shareGateAccountId,
-            "Microsoft User Id": identification.microsoftUserId,
-            "Microsoft Tenant Id": identification.microsoftTenantId,
-            "Workspace Id": identification.workspaceId,
+            "Microsoft User Id": identification.microsoftUserId ?? "N/A",
+            "Microsoft Tenant Id": identification.microsoftTenantId ?? "N/A",
+            "Workspace Id": identification.workspaceId ?? "N/A",
             [DeviceIdTrait]: this.#telemetryContext?.deviceId ?? "N/A",
-            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? "N/A",
-            "Is In Partner Program": identification.isInPartnerProgram
+            [TelemetryIdTrait]: this.#telemetryContext?.telemetryId ?? "N/A"
         } satisfies LogRocketShareGateUserTraits;
     }
 }