@wearejh/m2-pwa-engine 0.33.1 → 0.35.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.35.0](https://github.com/WeareJH/mage-mono/compare/v0.34.0...v0.35.0) (2025-09-08)
+
+**Note:** Version bump only for package @wearejh/m2-pwa-engine
+
+
+
+
+
+# [0.34.0](https://github.com/WeareJH/mage-mono/compare/v0.33.1...v0.34.0) (2025-09-08)
+
+
+### Bug Fixes
+
+* **WOOD-2710:** ensure service work uses hashed directory ([88f67d0](https://github.com/WeareJH/mage-mono/commit/88f67d06e7caeb2e4b4406bdf878999ec774ca2d))
+
+
+
+
+
 ## [0.33.1](https://github.com/WeareJH/mage-mono/compare/v0.33.0...v0.33.1) (2025-07-01)
 
 **Note:** Version bump only for package @wearejh/m2-pwa-engine

package/README.md

@@ -1 +1,100 @@
-@wearejh/m2-pwa-user
+# @wearejh/m2-pwa-engine
+
+The core Progressive Web Application (PWA) engine for Magento 2, providing the foundational infrastructure and services needed to build modern, performant e-commerce experiences.
+
+## Overview
+
+The `m2-pwa-engine` package serves as the backbone of the Magento 2 PWA ecosystem, offering essential utilities, state management, routing, and integration capabilities that power e-commerce applications. It provides a standardized foundation that other PWA packages can build upon.
+
+## Key Features
+
+- **Redux Store Management**: Lazy access to the Redux store with proper typing
+- **Apollo GraphQL Integration**: Client configuration and provider setup for Magento GraphQL API
+- **Routing Infrastructure**: Core routing utilities and components
+- **Environment Configuration**: Multi-environment support (development, staging, production)
+- **Service Worker Support**: PWA capabilities and offline functionality
+- **TypeScript Support**: Full TypeScript definitions and type safety
+
+## Architecture
+
+```mermaid
+graph TD
+    A[m2-pwa-engine] --> B[Redux Store]
+    A --> C[Apollo Client]
+    A --> D[Router]
+    A --> E[Environment Config]
+    
+    B --> F[State Management]
+    C --> G[GraphQL API]
+    D --> H[Navigation]
+    E --> I[Multi-env Support]
+    
+    F --> J[Cart Module]
+    F --> K[User Module]
+    F --> L[Checkout Module]
+    
+    G --> M[Magento GraphQL]
+    H --> N[Page Components]
+    I --> O[staging/staging3/production]
+    
+    style A fill:#e1f5fe
+    style B fill:#f3e5f5
+    style C fill:#e8f5e8
+    style D fill:#fff3e0
+    style E fill:#fce4ec
+```
+
+## Core Concepts
+
+### State Management
+The engine provides a centralized Redux store with lazy initialization, allowing modules to register their reducers and access shared application state efficiently.
+
+### GraphQL Integration
+Built-in Apollo Client configuration enables seamless communication with Magento's GraphQL API, handling authentication, caching, and error management.
+
+### Environment Support
+The package includes configuration for multiple deployment environments:
+- Development
+- Staging (staging3 support added in v0.31.2)
+- Production
+
+### Modular Architecture
+Designed to work with companion packages:
+- [`m2-pwa-cart`](../m2-pwa-cart) - Shopping cart functionality
+- [`m2-pwa-user`](../m2-pwa-user) - User authentication and management
+- [`m2-pwa-checkout`](../m2-pwa-checkout) - Checkout process
+- [`m2-pwa-adyen`](../m2-pwa-adyen) - Adyen payment integration
+- [`m2-pwa-tools`](../m2-pwa-tools) - Development and build tools
+- [`m2-pwa-webpack`](../m2-pwa-webpack) - Webpack configuration
+
+## Installation
+
+```bash
+npm install @wearejh/m2-pwa-engine
+```
+
+## Usage
+
+The engine is typically initialized early in your application lifecycle:
+
+```typescript
+import { initializeEngine } from '@wearejh/m2-pwa-engine';
+
+// Initialize the PWA engine with your configuration
+const engine = initializeEngine({
+  apiUrl: 'https://your-magento-instance.com/graphql',
+  environment: 'production'
+});
+```
+
+## Dependencies
+
+This package works in conjunction with the broader Magento 2 PWA ecosystem and requires:
+- React for UI components
+- Redux for state management
+- Apollo Client for GraphQL communication
+- Compatible Magento 2 backend with GraphQL support
+
+## Contributing
+
+This package is part of the larger mage-mono repository. Changes should be made following the established patterns and with consideration for backward compatibility across the PWA

package/lib/runtime/effects/serviceWorkers.ts

@@ -2,7 +2,7 @@ import { EMPTY, Observable, of } from 'rxjs';
 import { ignoreElements, share, tap, mergeMap, withLatestFrom } from 'rxjs/operators';
 import { Action } from 'redux';
 
-import { RuntimeActions, RuntimeMsg } from '../runtime.register';
+import { RuntimeActions, RuntimeMsg, RuntimeEnv } from '../runtime.register';
 import { createDebug } from '../../utils/runtimeDebug';
 
 const debug = createDebug(`serviceWorkers.ts`);
@@ -16,13 +16,21 @@ const debug = createDebug(`serviceWorkers.ts`);
 export function registerServiceWorker(
     version = '__development__',
     path = '/sw.js',
+    env?: RuntimeEnv,
 ): Observable<ServiceWorkerRegistration> {
-    debug('Trying to register ', path);
+    // Use dynamic path based on asset prefix if available
+    let swPath = path;
+    if (env?.ASSET_PREFIX) {
+        swPath = `/${env.ASSET_PREFIX}/sw.js`;
+        debug('Using dynamic SW path with asset prefix:', swPath);
+    }
+
+    debug('Trying to register ', swPath);
     debug('Version', version);
 
     return Observable.create((observer) => {
         navigator.serviceWorker
-            .register(path)
+            .register(swPath)
             .then((registration) => {
                 debug('SW registered: ', registration);
                 observer.next(registration);
@@ -104,10 +112,17 @@ export function handleVersionUpdates(
  * Register the killswitch
  * @param path
  */
-export function registerKillSwitchServiceWorker(path = '/sw-killswitch.js') {
-    debug('Trying to register killswitch ', path);
+export function registerKillSwitchServiceWorker(path = '/sw-killswitch.js', env?: RuntimeEnv) {
+    // Use dynamic path based on asset prefix if available
+    let swPath = path;
+    if (env?.ASSET_PREFIX) {
+        swPath = `/${env.ASSET_PREFIX}/sw-killswitch.js`;
+        debug('Using dynamic killswitch path with asset prefix:', swPath);
+    }
+
+    debug('Trying to register killswitch ', swPath);
     navigator.serviceWorker
-        .register(path)
+        .register(swPath)
         .then(() => {
             debug('SW Killswitch registered');
         })

package/lib/runtime/epics/serviceWorker.epic.ts

@@ -34,7 +34,7 @@ export function serviceWorkerEpic(
                  * and register as normal
                  */
                 case true:
-                    const sw$ = registerServiceWorker(env.VERSION);
+                    const sw$ = registerServiceWorker(env.VERSION, '/sw.js', env);
                     /**
                      * Message stream coming out of the service worker
                      */
@@ -52,7 +52,7 @@ export function serviceWorkerEpic(
                     );
                     return merge(msgHandlers$, updates);
                 case false:
-                    return registerKillSwitchServiceWorker();
+                    return registerKillSwitchServiceWorker('/sw-killswitch.js', env);
                 default:
                     return assertUnreachable();
             }

package/lib/runtime/runtime.register.ts

@@ -25,6 +25,7 @@ export type RuntimeEnv = {
     RELEASE_STAGE: 'local' | 'develop' | 'staging' | 'staging2' | 'staging3' | 'production';
     VERSION: string;
     DOMAIN: string;
+    ASSET_PREFIX?: string;
 };
 
 export type RuntimeState = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wearejh/m2-pwa-engine",
-    "version": "0.33.1",
+    "version": "0.35.0",
     "description": "> TODO: description",
     "author": "Shane Osbourne <shane.osbourne8@gmail.com>",
     "homepage": "",
@@ -18,10 +18,10 @@
     ],
     "scripts": {},
     "dependencies": {
-        "@wearejh/m2-pwa-vars": "^0.33.1",
-        "@wearejh/swagger-rxjs": "^0.33.1",
+        "@wearejh/m2-pwa-vars": "^0.35.0",
+        "@wearejh/swagger-rxjs": "^0.35.0",
         "history": "^4.10.1",
         "loadcss": "^0.0.2"
     },
-    "gitHead": "57494895c65f690d46cb4881888cc4cefa4bccbd"
+    "gitHead": "c28fc34b4cd0b85fafe885cfdcd364f4c576e11b"
 }