reactotron-redux - npm Package Compare versions

Comparing version 3.1.5 to 3.1.6

CHANGELOG.md

@@ -5,2 +5,9 @@ # Changelog
 
+### [3.1.6](https://github.com/infinitered/reactotron/compare/reactotron-redux@3.1.5...reactotron-redux@3.1.6) (2024-01-17)
+
+
+### Bug Fixes
+
+* **reactotron-redux:** Typescript fixes for reactotron-redux interface ([#1404](https://github.com/infinitered/reactotron/issues/1404) by @Jpoliachik) ([5dacbd9](https://github.com/infinitered/reactotron/commit/5dacbd9525bae74a70ce6b0ab9e9cc6b8778f708))
+
 ### [3.1.5](https://github.com/infinitered/reactotron/compare/reactotron-redux@3.1.4...reactotron-redux@3.1.5) (2024-01-09)
@@ -7,0 +14,0 @@

dist/types/src/index.d.ts

 import type { ReactotronCore } from "reactotron-core-client";
 import { PluginConfig } from "./pluginConfig";
-declare function reactotronRedux<Client extends ReactotronCore = ReactotronCore>(pluginConfig?: PluginConfig): (reactotron: Client) => {
+declare function reactotronRedux(pluginConfig?: PluginConfig): <Client extends ReactotronCore = ReactotronCore>(reactotron: Client) => {
     onCommand: ({ type, payload }: {
@@ -16,3 +16,3 @@ type: string;
 };
-export type ReactotronReduxPlugin<Client extends ReactotronCore = ReactotronCore> = ReturnType<typeof reactotronRedux<Client>>;
+export type ReactotronReduxPlugin = ReturnType<typeof reactotronRedux>;
 export { reactotronRedux };

dist/types/src/testHelpers.d.ts

 import type { InferFeatures, Reactotron } from "reactotron-core-client";
 import type { ReactotronReduxPlugin } from ".";
-export declare const defaultReactotronMock: Reactotron & InferFeatures<Reactotron, ReactotronReduxPlugin<Reactotron>>;
+export declare const defaultReactotronMock: Reactotron & InferFeatures<Reactotron, ReactotronReduxPlugin>;

package.json

 {
   "name": "reactotron-redux",
-  "version": "3.1.5",
+  "version": "3.1.6",
   "description": "A Reactotron plugin for Redux.",
@@ -5,0 +5,0 @@ "author": "Infinite Red",

README.md

 # reactotron-redux
 
-Find the docs located [here](https://github.com/infinitered/reactotron/blob/master/docs/plugin-redux.md)
+Find the docs located [here](https://docs.infinite.red/reactotron/plugins/redux/)

src/index.ts

@@ -1,2 +0,2 @@
-import type { Plugin, Reactotron, ReactotronCore } from "reactotron-core-client"
+import type { Plugin, ReactotronCore } from "reactotron-core-client"
 
@@ -9,5 +9,3 @@ import createCommandHander from "./commandHandler"
 
-function reactotronRedux<Client extends ReactotronCore = ReactotronCore>(
-  pluginConfig: PluginConfig = {}
-) {
+function reactotronRedux(pluginConfig: PluginConfig = {}) {
   const mergedPluginConfig: PluginConfig = {
@@ -28,5 +26,9 @@ ...pluginConfig,
 
-  return (reactotron: Client) => {
+  function plugin<Client extends ReactotronCore = ReactotronCore>(reactotron: Client) {
     return {
+      // Fires when we receive a command from the Reactotron app.
       onCommand: createCommandHander(reactotron, mergedPluginConfig, onReduxStoreCreation),
+
+      // All keys in this object will be attached to the main Reactotron instance
+      // and available to be called directly.
       features: {
@@ -42,10 +44,10 @@ createEnhancer: createEnhancer(reactotron, mergedPluginConfig, handleStoreCreation),
       },
-    } satisfies Plugin<Reactotron>
+    } satisfies Plugin<Client>
   }
+
+  return plugin
 }
 
-export type ReactotronReduxPlugin<Client extends ReactotronCore = ReactotronCore> = ReturnType<
-  typeof reactotronRedux<Client>
->
+export type ReactotronReduxPlugin = ReturnType<typeof reactotronRedux>
 
 export { reactotronRedux }

src/testHelpers.ts

 import type { InferFeatures, Reactotron } from "reactotron-core-client"
 import type { ReactotronReduxPlugin } from "."
 
-export const defaultReactotronMock: Reactotron &
-  InferFeatures<Reactotron, ReactotronReduxPlugin<Reactotron>> = {
-  startTimer: jest.fn(),
-  configure: jest.fn(),
-  close: jest.fn(),
-  connect: jest.fn(),
-  send: jest.fn(),
-  display: jest.fn(),
-  use: jest.fn(),
-  onCustomCommand: jest.fn(),
-  clear: jest.fn(),
-  apiResponse: jest.fn(),
-  benchmark: jest.fn(),
-  debug: jest.fn(),
-  error: jest.fn(),
-  image: jest.fn(),
-  log: jest.fn(),
-  logImportant: jest.fn(),
-  plugins: [],
-  options: {},
-  repl: jest.fn(),
-  stateActionComplete: jest.fn(),
-  stateBackupResponse: jest.fn(),
-  stateKeysResponse: jest.fn(),
-  stateValuesChange: jest.fn(),
-  stateValuesResponse: jest.fn(),
-  warn: jest.fn(),
-  createEnhancer: jest.fn(),
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore shhhhhh -- this is a private API
-  reduxStore: jest.fn(),
-  setReduxStore: jest.fn(),
-}
+export const defaultReactotronMock: Reactotron & InferFeatures<Reactotron, ReactotronReduxPlugin> =
+  {
+    startTimer: jest.fn(),
+    configure: jest.fn(),
+    close: jest.fn(),
+    connect: jest.fn(),
+    send: jest.fn(),
+    display: jest.fn(),
+    use: jest.fn(),
+    onCustomCommand: jest.fn(),
+    clear: jest.fn(),
+    apiResponse: jest.fn(),
+    benchmark: jest.fn(),
+    debug: jest.fn(),
+    error: jest.fn(),
+    image: jest.fn(),
+    log: jest.fn(),
+    logImportant: jest.fn(),
+    plugins: [],
+    options: {},
+    repl: jest.fn(),
+    stateActionComplete: jest.fn(),
+    stateBackupResponse: jest.fn(),
+    stateKeysResponse: jest.fn(),
+    stateValuesChange: jest.fn(),
+    stateValuesResponse: jest.fn(),
+    warn: jest.fn(),
+    createEnhancer: jest.fn(),
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore shhhhhh -- this is a private API
+    reduxStore: jest.fn(),
+    setReduxStore: jest.fn(),
+  }

No alert changes

Improved metrics

Total package byte prevSize

66366

0.75%

No dependency changes