@conduit-client/salesforce-lightning-service-worker 3.2.0

package/LICENSE.txt

@@ -0,0 +1,27 @@
+*Attorney/Client Privileged + Confidential*
+
+Terms of Use for Public Code (Non-OSS)
+
+*NOTE:* Before publishing code under this license/these Terms of Use, please review https://salesforce.quip.com/WFfvAMKB18AL and confirm that you’ve completed all prerequisites described therein. *These Terms of Use may not be used or modified without input from IP and Product Legal.*
+
+*Terms of Use*
+
+Copyright 2022 Salesforce, Inc. All rights reserved. 
+
+These Terms of Use govern the download, installation, and/or use of this software provided by Salesforce, Inc. (“Salesforce”) (the “Software”), were last updated on April 15, 2022, ** and constitute a legally binding agreement between you and Salesforce. If you do not agree to these Terms of Use, do not install or use the Software. 
+ 
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the Software and derivative works subject to these Terms. These Terms shall be included in all copies or substantial portions of the Software. 
+
+Subject to the limited rights expressly granted hereunder, Salesforce reserves all rights, title, and interest in and to all intellectual property subsisting in the Software. No rights are granted to you hereunder other than as expressly set forth herein. Users residing in countries on the United States Office of Foreign Assets Control sanction list, or which are otherwise subject to a US export embargo, may not use the Software.
+ 
+Implementation of the Software may require development work, for which you are responsible. The Software may contain bugs, errors and incompatibilities and is made available on an AS IS basis without support, updates, or service level commitments. 
+ 
+Salesforce reserves the right at any time to modify, suspend, or discontinue, the Software (or any part thereof) with or without notice. You agree that Salesforce shall not be liable to you or to any third party for any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or proceeding made or brought against Salesforce by a third party arising out of or accruing from (a) your use of the Software, and (b) any application you develop with the Software that infringes any copyright, trademark, trade secret, trade dress, patent, or other intellectual property right of any person or defames any person or violates their rights of publicity or privacy (each a “Claim Against Salesforce”), and will indemnify Salesforce from any damages, attorney fees, and costs finally awarded against Salesforce as a result of, or for any amounts paid by Salesforce under a settlement approved by you in writing of, a Claim Against Salesforce, provided Salesforce (x) promptly gives you written notice of the Claim Against Salesforce, (y) gives you sole control of the defense and settlement of the Claim Against Salesforce (except that you may not settle any Claim Against Salesforce unless it unconditionally releases Salesforce of all liability), and (z) gives you all reasonable assistance, at your expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA, OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ 
+These Terms of Use shall be governed exclusively by the internal laws of the State of California, without regard to its conflicts of laws rules. Each party hereby consents to the exclusive jurisdiction of the state and federal courts located in San Francisco County, California to adjudicate any dispute arising out of or relating to these Terms of Use and the download, installation, and/or use of the Software. Except as expressly stated herein, these Terms of Use constitute the entire agreement between the parties, and supersede all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning their subject matter. No modification, amendment, or waiver of any provision of these Terms of Use shall be effective unless it is by an update to these Terms of Use that Salesforce makes available, or is in writing and signed by the party against whom the modification, amendment, or waiver is to be asserted.
+
+_*Data Privacy*_: Salesforce may collect, process, and store device, system, and other information related to your use of the Software. This information includes, but is not limited to, IP address, user metrics, and other data (“Usage Data”). Salesforce may use Usage Data for analytics, product development, and marketing purposes. You acknowledge that files generated in conjunction with the Software may contain sensitive or confidential data, and you are solely responsible for anonymizing and protecting such data.  

package/README.md

@@ -0,0 +1,135 @@
+# Salesforce Lightning Service Worker
+
+A lightweight service worker utility for Salesforce Lightning applications that provides basic service worker registration and management functionality.
+
+## Installation
+
+```bash
+npm install @conduit-client/salesforce-lightning-service-worker
+```
+
+## Usage
+
+This package exports two main functions that work together to implement service worker functionality in your application:
+
+### 1. Register the Service Worker (App Code)
+
+In your main application code, use the `registerServiceWorker` function to register your service worker:
+
+```typescript
+import { registerServiceWorker } from '@conduit-client/salesforce-lightning-service-worker';
+
+// Register service worker with module type support
+const registration = await registerServiceWorker('./sw.js', { type: 'module' });
+```
+
+**Parameters:**
+
+- `scriptUrl`: The URL path to your service worker file
+- `options`: Optional `RegistrationOptions` (e.g., `{ type: 'module' }` for ES6 module support)
+
+### 2. Create the Service Worker File
+
+You must configure your bundler to expose a statically named service worker file (without hash tokens) that calls the `createServiceWorker` function:
+
+```typescript
+// sw.js or similar
+import { createServiceWorker } from '@conduit-client/salesforce-lightning-service-worker';
+
+createServiceWorker();
+```
+
+**Important Configuration Notes:**
+
+1. **Static File Name**: The service worker file must have a static name (e.g., `sw.js`) without hash tokens to ensure consistent registration/updates
+2. **Module Type**: If using ES6 imports in your service worker, register it with `{ type: 'module' }`
+3. **Scope**: The path from which the service worker file is served establishes the scope for which the service worker will apply. For example:
+   - `/sw.js` → Controls the entire origin
+   - `/app/sw.js` → Only controls paths under `/app/`
+
+## Service Worker Features
+
+The `createServiceWorker` function sets up a basic service worker with:
+
+- **Install Handler**: Skips waiting to activate immediately
+- **Activate Handler**: Claims all clients immediately
+- **Fetch Handler**: Intercepts and logs all `fetch` requests (currently passes through all requests)
+
+## Example Implementation
+
+```typescript
+// Main app code
+import { registerServiceWorker } from '@conduit-client/salesforce-lightning-service-worker';
+
+async function initializeApp() {
+  try {
+    const registration = await registerServiceWorker('./sw.js', { type: 'module' });
+    console.log('Service worker registered:', registration?.scope);
+  } catch (error) {
+    console.error('Service worker registration failed:', error);
+  }
+}
+```
+
+```typescript
+// sw.js (served statically by your bundler)
+import { createServiceWorker } from '@conduit-client/salesforce-lightning-service-worker';
+
+createServiceWorker();
+```
+
+## Development
+
+### Running the Development Server
+
+Use the `dev` script to run and debug the service worker code:
+
+```bash
+npm run dev
+```
+
+This will:
+
+1. Build the service worker code
+2. Start a development server on port 3000
+3. Serve a test page with service worker registration
+4. Automatically open your browser
+
+### Development Features
+
+- **Live Service Worker Updates**: The development server includes automatic service worker update detection and page reloading when you make changes to the source code
+- **Test API Endpoint**: A dummy `/api/data` endpoint is configured to test fetch interception by the service worker
+- **Debug Console**: The test page includes buttons to check service worker status and test API calls
+- **TypeScript Transformation**: Service worker code is served as transformed TypeScript via Vite
+
+### Development Workflow
+
+1. Make changes to `src/index.ts` (service worker logic)
+2. The page will automatically detect service worker updates and reload
+3. Use the test page buttons to verify your changes:
+   - **Check SW Status**: View service worker registration details
+   - **Fetch API Data**: Test the `/api/data` endpoint through the service worker
+   - **Clear Output**: Clear the debug console
+
+### Development File Structure
+
+- `src/index.ts` - Main service worker code and registration utilities
+- `scripts/dev.ts` - Development server with API mock and service worker serving
+- `scripts/dev-service-worker.ts` - Entry point for the development service worker
+- `scripts/dev-test-page.html` - Test page for debugging service worker functionality
+
+### Building for Production
+
+```bash
+npm run build
+```
+
+This creates production-ready files in the `dist/` directory.
+
+## Browser Support
+
+Requires browsers with service worker support. The registration function includes feature detection and will gracefully handle unsupported browsers.
+
+---
+
+This software is provided as-is with no support provided.

package/dist/index.js

@@ -0,0 +1,29 @@
+/*!
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+function createServiceWorker({ debug } = {}) {
+  const scope = self;
+  scope.addEventListener("install", (event) => {
+    if (debug) console.log("[Service Worker] Installed");
+    event.waitUntil(scope.skipWaiting());
+  });
+  scope.addEventListener("activate", (event) => {
+    if (debug) console.log("[Service Worker] Activated");
+    event.waitUntil(scope.clients.claim());
+  });
+  scope.addEventListener("fetch", (event) => {
+    console.log("[Service Worker] Fetch intercepted for pass-through:", {
+      url: event.request.url,
+      method: event.request.method,
+      destination: event.request.destination,
+      mode: event.request.mode
+    });
+    event.respondWith(fetch(event.request));
+  });
+}
+export {
+  createServiceWorker
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["type Config = {\n    debug?: boolean;\n};\n\n/**\n * Adds event listeners for setting up service worker.\n *\n * @param debug\n */\nexport function createServiceWorker({ debug }: Config = {}) {\n    const scope = self as any as ServiceWorkerGlobalScope;\n\n    scope.addEventListener('install', (event) => {\n        if (debug) console.log('[Service Worker] Installed');\n\n        // Skip waiting to activate immediately\n        event.waitUntil(scope.skipWaiting());\n    });\n\n    scope.addEventListener('activate', (event) => {\n        if (debug) console.log('[Service Worker] Activated');\n\n        // Claim all clients immediately\n        event.waitUntil(scope.clients.claim());\n    });\n\n    scope.addEventListener('fetch', (event) => {\n        console.log('[Service Worker] Fetch intercepted for pass-through:', {\n            url: event.request.url,\n            method: event.request.method,\n            destination: event.request.destination,\n            mode: event.request.mode,\n        });\n\n        // Simply forward for now\n        event.respondWith(fetch(event.request));\n    });\n}\n"],"names":[],"mappings":";;;;;AASO,SAAS,oBAAoB,EAAE,MAAA,IAAkB,IAAI;AACxD,QAAM,QAAQ;AAEd,QAAM,iBAAiB,WAAW,CAAC,UAAU;AACzC,QAAI,MAAO,SAAQ,IAAI,4BAA4B;AAGnD,UAAM,UAAU,MAAM,aAAa;AAAA,EACvC,CAAC;AAED,QAAM,iBAAiB,YAAY,CAAC,UAAU;AAC1C,QAAI,MAAO,SAAQ,IAAI,4BAA4B;AAGnD,UAAM,UAAU,MAAM,QAAQ,MAAA,CAAO;AAAA,EACzC,CAAC;AAED,QAAM,iBAAiB,SAAS,CAAC,UAAU;AACvC,YAAQ,IAAI,wDAAwD;AAAA,MAChE,KAAK,MAAM,QAAQ;AAAA,MACnB,QAAQ,MAAM,QAAQ;AAAA,MACtB,aAAa,MAAM,QAAQ;AAAA,MAC3B,MAAM,MAAM,QAAQ;AAAA,IAAA,CACvB;AAGD,UAAM,YAAY,MAAM,MAAM,OAAO,CAAC;AAAA,EAC1C,CAAC;AACL;"}

package/dist/types/__tests__/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/csrf.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from 'axios';
+/**
+ * Enforces a valid CSRF token for all requests that modify data
+ *
+ * @param targetClient - The client to add the interceptor to
+ * @param csrfClient - The client to use for fetching CSRF tokens (should not have interceptors to avoid circular dependencies)
+ */
+export declare function csrfInterceptor(targetClient: AxiosInstance, csrfClient: AxiosInstance): void;

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+type Config = {
+    debug?: boolean;
+};
+/**
+ * Adds event listeners for setting up service worker.
+ *
+ * @param debug
+ */
+export declare function createServiceWorker({ debug }?: Config): void;
+export {};

package/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "@conduit-client/salesforce-lightning-service-worker",
+    "version": "3.2.0",
+    "private": false,
+    "description": "Service worker for accessing Salesforce data",
+    "type": "module",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/onestore",
+        "directory": "packages/@conduit-client/salesforce-lightning-service-worker"
+    },
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "main": "dist/index.js",
+    "types": "dist/types/index.d.ts",
+    "files": [
+        "dist/"
+    ],
+    "scripts": {
+        "build": "vite build && tsc --build --emitDeclarationOnly",
+        "clean": "rm -rf dist",
+        "dev": "npm run build && tsx scripts/dev.ts",
+        "test": "vitest run",
+        "test:size": "size-limit",
+        "watch": "npm run build --watch"
+    },
+    "devDependencies": {
+        "@types/express": "^4.17.17",
+        "express": "^4.18.2",
+        "tsx": "^4.7.0"
+    },
+    "size-limit": [
+        {
+            "path": "dist/index.js",
+            "limit": "344 B"
+        }
+    ]
+}