@squide/msw 3.5.0 → 4.0.1

package/CHANGELOG.md

@@ -1,5 +1,67 @@
 # @squide/msw
 
+## 4.0.1
+
+### Patch Changes
+
+- Updated dependencies [[`bea660b`](https://github.com/workleap/wl-squide/commit/bea660bf827dd123a52f6062a7be8865dc99055b)]:
+  - @squide/core@6.1.0
+
+## 4.0.0
+
+### Major Changes
+
+- [#311](https://github.com/workleap/wl-squide/pull/311) [`cc52e8b`](https://github.com/workleap/wl-squide/commit/cc52e8bfbe9d3d215f51d12755743f17c0c69772) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Deferred registration functions now receives a runtime instance as the first argument. This new scope runtime instance should used whenever runtime access is required within a deferred registration function scope.
+
+  Before:
+
+  The `runtime` argument of the registration function is used to register the navigation item.
+
+  ```ts !#1,2,4
+  export const register: ModuleRegisterFunction<
+    FireflyRuntime,
+    unknown,
+    DeferredRegistrationData
+  > = (runtime) => {
+    return ({ featureFlags }, operation) => {
+      if (featureFlags.featureA) {
+        runtime.registerNavigationItem({
+          $id: "feature-a",
+          $label: operation === "register" ? "Feature A" : "Feature A updated",
+          to: "/feature-a",
+        });
+      }
+    };
+  };
+  ```
+
+  After:
+
+  The `deferredRuntime` argument of the **deferred** registration function is used to register the navigation item.
+
+  ```ts !#2,4
+  export const register: ModuleRegisterFunction<
+    FireflyRuntime,
+    unknown,
+    DeferredRegistrationData
+  > = (runtime) => {
+    return (deferredRuntime, { featureFlags }, operation) => {
+      if (featureFlags.featureA) {
+        deferredRuntime.registerNavigationItem({
+          $id: "feature-a",
+          $label: operation === "register" ? "Feature A" : "Feature A updated",
+          to: "/feature-a",
+        });
+      }
+    };
+  };
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`cc52e8b`](https://github.com/workleap/wl-squide/commit/cc52e8bfbe9d3d215f51d12755743f17c0c69772)]:
+  - @squide/core@6.0.0
+
 ## 3.5.0
 
 ### Minor Changes

package/dist/mswPlugin.d.ts

@@ -1,10 +1,14 @@
 import { Plugin, type Runtime } from "@squide/core";
+import type { Logger } from "@workleap/logging";
 import type { RequestHandler } from "msw";
 export declare const MswPluginName = "msw-plugin";
+export interface MswPluginRegisterRequestHandlersOptions {
+    logger?: Logger;
+}
 export declare class MswPlugin extends Plugin {
     #private;
     constructor(runtime: Runtime);
-    registerRequestHandlers(handlers: RequestHandler[]): void;
+    registerRequestHandlers(handlers: RequestHandler[], options?: MswPluginRegisterRequestHandlersOptions): void;
     get requestHandlers(): RequestHandler[];
 }
 export declare function getMswPlugin(runtime: Runtime): MswPlugin;

package/dist/mswPlugin.js

@@ -14,9 +14,10 @@ class MswPlugin extends Plugin {
     constructor(runtime){
         super(MswPluginName, runtime);
     }
-    registerRequestHandlers(handlers) {
+    registerRequestHandlers(handlers, options = {}) {
+        const { logger } = options;
         this.#requestHandlerRegistry.add(handlers);
-        this._runtime.logger.withText("[squide] The following MSW request handlers has been registered:").withObject(handlers).debug();
+        (logger ? logger : this._runtime.logger).withText("[squide] The following MSW request handlers has been registered:").withObject(handlers).debug();
     }
     get requestHandlers() {
         return this.#requestHandlerRegistry.handlers;

package/dist/mswPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"mswPlugin.js","sources":["webpack://@squide/msw/./src/mswPlugin.ts"],"sourcesContent":["import { Plugin, isNil, type Runtime } from \"@squide/core\";\nimport type { RequestHandler } from \"msw\";\nimport { RequestHandlerRegistry } from \"./requestHandlerRegistry.ts\";\n\nexport const MswPluginName = \"msw-plugin\";\n\nexport class MswPlugin extends Plugin {\n    readonly #requestHandlerRegistry = new RequestHandlerRegistry();\n\n    constructor(runtime: Runtime) {\n        super(MswPluginName, runtime);\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[]) {\n        this.#requestHandlerRegistry.add(handlers);\n\n        this._runtime.logger\n            .withText(\"[squide] The following MSW request handlers has been registered:\")\n            .withObject(handlers)\n            .debug();\n    }\n\n    get requestHandlers(): RequestHandler[] {\n        return this.#requestHandlerRegistry.handlers;\n    }\n}\n\nexport function getMswPlugin(runtime: Runtime) {\n    const plugin = runtime.getPlugin(MswPluginName);\n\n    if (isNil(plugin)) {\n        throw new Error(\"[squide] The getMswPlugin function is called but no MswPlugin instance has been registered with the runtime.\");\n    }\n\n    return plugin as MswPlugin;\n}\n"],"names":["Plugin","isNil","RequestHandlerRegistry","MswPluginName","MswPlugin","runtime","handlers","getMswPlugin","plugin","Error"],"mappings":";;;;;;;;AAA2D;AAEU;AAE9D,MAAMG,gBAAgB,aAAa;AAEnC,MAAMC,kBAAkBJ,MAAMA;IACxB,uBAAuB,GAAG,IAAIE,sBAAsBA,GAAG;IAEhE,YAAYG,OAAgB,CAAE;QAC1B,KAAK,CAACF,eAAeE;IACzB;IAEA,wBAAwBC,QAA0B,EAAE;QAChD,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAACA;QAEjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CACf,QAAQ,CAAC,oEACT,UAAU,CAACA,UACX,KAAK;IACd;IAEA,IAAI,kBAAoC;QACpC,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ;IAChD;AACJ;AAEO,SAASC,aAAaF,OAAgB;IACzC,MAAMG,SAASH,QAAQ,SAAS,CAACF;IAEjC,IAAIF,KAAKA,CAACO,SAAS;QACf,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOD;AACX"}
+{"version":3,"file":"mswPlugin.js","sources":["webpack://@squide/msw/./src/mswPlugin.ts"],"sourcesContent":["import { Plugin, isNil, type Runtime } from \"@squide/core\";\nimport type { Logger } from \"@workleap/logging\";\nimport type { RequestHandler } from \"msw\";\nimport { RequestHandlerRegistry } from \"./requestHandlerRegistry.ts\";\n\nexport const MswPluginName = \"msw-plugin\";\n\nexport interface MswPluginRegisterRequestHandlersOptions {\n    logger?: Logger;\n}\n\nexport class MswPlugin extends Plugin {\n    readonly #requestHandlerRegistry = new RequestHandlerRegistry();\n\n    constructor(runtime: Runtime) {\n        super(MswPluginName, runtime);\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: MswPluginRegisterRequestHandlersOptions = {}) {\n        const {\n            logger\n        } = options;\n\n        this.#requestHandlerRegistry.add(handlers);\n\n        (logger ? logger : this._runtime.logger)\n            .withText(\"[squide] The following MSW request handlers has been registered:\")\n            .withObject(handlers)\n            .debug();\n    }\n\n    get requestHandlers(): RequestHandler[] {\n        return this.#requestHandlerRegistry.handlers;\n    }\n}\n\nexport function getMswPlugin(runtime: Runtime) {\n    const plugin = runtime.getPlugin(MswPluginName);\n\n    if (isNil(plugin)) {\n        throw new Error(\"[squide] The getMswPlugin function is called but no MswPlugin instance has been registered with the runtime.\");\n    }\n\n    return plugin as MswPlugin;\n}\n"],"names":["Plugin","isNil","RequestHandlerRegistry","MswPluginName","MswPlugin","runtime","handlers","options","logger","getMswPlugin","plugin","Error"],"mappings":";;;;;;;;AAA2D;AAGU;AAE9D,MAAMG,gBAAgB,aAAa;AAMnC,MAAMC,kBAAkBJ,MAAMA;IACxB,uBAAuB,GAAG,IAAIE,sBAAsBA,GAAG;IAEhE,YAAYG,OAAgB,CAAE;QAC1B,KAAK,CAACF,eAAeE;IACzB;IAEA,wBAAwBC,QAA0B,EAAEC,UAAmD,CAAC,CAAC,EAAE;QACvG,MAAM,EACFC,MAAM,EACT,GAAGD;QAEJ,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAACD;QAEhCE,CAAAA,SAASA,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAK,EACjC,QAAQ,CAAC,oEACT,UAAU,CAACF,UACX,KAAK;IACd;IAEA,IAAI,kBAAoC;QACpC,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ;IAChD;AACJ;AAEO,SAASG,aAAaJ,OAAgB;IACzC,MAAMK,SAASL,QAAQ,SAAS,CAACF;IAEjC,IAAIF,KAAKA,CAACS,SAAS;QACf,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOD;AACX"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/msw",
   "author": "Workleap",
-  "version": "3.5.0",
+  "version": "4.0.1",
   "description": "Add support for MSW to @squide application shell.",
   "license": "Apache-2.0",
   "repository": {
@@ -28,20 +28,21 @@
     "README.md"
   ],
   "peerDependencies": {
-    "msw": "^2.10.4"
+    "msw": "^2.11.1"
   },
   "dependencies": {
-    "@squide/core": "5.7.0"
+    "@workleap/logging": "^1.3.0",
+    "@squide/core": "6.1.0"
   },
   "devDependencies": {
-    "@rsbuild/core": "1.4.7",
-    "@rslib/core": "0.10.6",
-    "@typescript-eslint/parser": "8.37.0",
+    "@rsbuild/core": "1.5.4",
+    "@rslib/core": "0.12.4",
+    "@typescript-eslint/parser": "8.42.0",
     "@workleap/eslint-plugin": "3.5.0",
     "@workleap/rslib-configs": "1.1.0",
     "@workleap/typescript-configs": "3.0.4",
     "eslint": "8.57.0",
-    "typescript": "5.8.3"
+    "typescript": "5.9.2"
   },
   "sideEffects": false,
   "engines": {

package/src/mswPlugin.ts

@@ -1,9 +1,14 @@
 import { Plugin, isNil, type Runtime } from "@squide/core";
+import type { Logger } from "@workleap/logging";
 import type { RequestHandler } from "msw";
 import { RequestHandlerRegistry } from "./requestHandlerRegistry.ts";
 
 export const MswPluginName = "msw-plugin";
 
+export interface MswPluginRegisterRequestHandlersOptions {
+    logger?: Logger;
+}
+
 export class MswPlugin extends Plugin {
     readonly #requestHandlerRegistry = new RequestHandlerRegistry();
 
@@ -11,10 +16,14 @@ export class MswPlugin extends Plugin {
         super(MswPluginName, runtime);
     }
 
-    registerRequestHandlers(handlers: RequestHandler[]) {
+    registerRequestHandlers(handlers: RequestHandler[], options: MswPluginRegisterRequestHandlersOptions = {}) {
+        const {
+            logger
+        } = options;
+
         this.#requestHandlerRegistry.add(handlers);
 
-        this._runtime.logger
+        (logger ? logger : this._runtime.logger)
             .withText("[squide] The following MSW request handlers has been registered:")
             .withObject(handlers)
             .debug();