@koordinates/xstate-tree 4.1.6 → 4.2.0

package/README.md

@@ -185,6 +185,14 @@ These events can be added anywhere, either next to a component for component spe
 2. If they are tied to a component they need to be in the index.ts file that imports the view/selectors/actions etc and calls `createXStateTreeMachine`. If they are in the file containing those functions the index.d.ts file will not end up importing them.
 
 
+### Type helpers
+
+There are some exported type helpers for use with xstate-tree
+
+* `SelectorsFrom<TMachine>`: Takes a machine and returns the type of the selectors object
+* `ActionsFrom<TMachine>`: Takes a machine and returns the type of the actions object
+
+
 ### [Storybook](https://storybook.js.org)
 
 It is relatively simple to display xstate-tree views directly in Storybook. Since the views are plain React components that accept selectors/actions/slots/inState as props you can just import the view and render it in a Story

package/lib/xstate-tree.d.ts

@@ -26,6 +26,17 @@ export declare type Actions<TMachine extends AnyStateMachine, TSelectorsOutput,
     selectors: TSelectorsOutput;
 }) => TOut;
 
+/**
+ * @public
+ *
+ * Retrieves the actions return type from the xstate-tree machine
+ */
+export declare type ActionsFrom<TMachine extends AnyXstateTreeMachine> = TMachine extends StateMachine<any, infer TMeta, any> ? TMeta extends {
+    meta: {
+        actions: infer TOut;
+    };
+} ? TOut extends (...args: any) => any ? ReturnType<TOut> : never : never : never;
+
 /**
  * @public
  */
@@ -619,6 +630,17 @@ export declare type Selectors<TMachine extends AnyStateMachine, TOut> = (args: {
     inState: MatchesFrom<TMachine>;
 }) => TOut;
 
+/**
+ * @public
+ *
+ * Retrieves the selector return type from the xstate-tree machine
+ */
+export declare type SelectorsFrom<TMachine extends AnyXstateTreeMachine> = TMachine extends StateMachine<any, infer TMeta, any> ? TMeta extends {
+    meta: {
+        selectors: infer TOut;
+    };
+} ? TOut extends (...args: any) => any ? ReturnType<TOut> : never : never : never;
+
 /**
  * @public
  */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@koordinates/xstate-tree",
   "main": "lib/index.js",
   "types": "lib/xstate-tree.d.ts",
-  "version": "4.1.6",
+  "version": "4.2.0",
   "license": "MIT",
   "description": "Build UIs with Actors using xstate and React",
   "keywords": [