fix(service-worker): fix npm package exports and types (#696)

CODEOWNERS

@@ -1,2 +1,2 @@
-* @saikumarrs @MoumitaM
+* @saikumarrs @MoumitaM @bardisg
 /integrations/ @utsabc @ItsSudip @shrouti1507

README.md

@@ -303,7 +303,7 @@ You can start adding integrations of your choice for sending the data through th
 RudderStack JS SDK can be used in Chrome Extensions with manifest v3, both as a content script or as a background script 
 service worker. 
 
-For examples and specific details look into [Chrome Extensions Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/master/tests/chrome-extension/USAGE.md)
+For examples and specific details look into [Chrome Extensions Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/production/tests/chrome-extension/USAGE.md)
 
 ## Contribute
 

dist/rudder-sdk-js/package.json

@@ -5,11 +5,17 @@
   "main": "index.js",
   "module": "index.es.js",
   "exports": {
-    ".": {
-      "service-worker": "./service-worker/index.es.js"
+    ".": "./index.js",
+    "./service-worker": "./service-worker/index.js",
+    "./service-worker/index.es": "./service-worker/index.es.js"
+  },
+  "typesVersions": {
+    "*": {
+      ".": ["index.d.ts"],
+      "service-worker": ["service-worker/index.d.ts"],
+      "service-worker/index.es": ["service-worker/index.d.ts"]
     }
   },
-  "types": "index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

service-worker/index.d.ts

@@ -1,4 +1,6 @@
-export default Analytics;
+export {
+    Analytics
+};
 
 /**
  * Represents a generic object in the APIs
@@ -11,6 +13,7 @@ export interface apiObject {
     | boolean
     | undefined
     | apiObject
+    | unknown
     | (string | number | boolean | apiObject)[];
 }
 

tests/chrome-extension/USAGE.md

@@ -47,10 +47,18 @@ You can react to events that are available in background scripts via the [Chrome
 
 Here is an example to track url changes.
 
-Sample background script:
+Sample background script imports:
 
-    # file copied from node_modules/rudder-sdk-js/service-worker/index.es.js
+    # In case file is copied from node_modules/rudder-sdk-js/service-worker/index.es.js in extension resources folder
     import { Analytics } from "./rudderAnalytics.js";
+
+    # In case the package is imported directly as umd and then bundled in the background script
+    import { Analytics } from "rudder-sdk-js/service-worker";
+
+    # In case the package is imported directly as es-module and then bundled in the background script
+    import { Analytics } from "rudder-sdk-js/service-worker/index.es"; 
+
+Sample background script:
 
     const rudderClient = new Analytics("<writeKey>","<dataPlaneURL>/v1/batch");