Migrate redux-routine package to TS (#70686)

Co-authored-by: im3dabasia <im3dabasia1@git.wordpress.org>
Co-authored-by: manzoorwanijk <manzoorwanijk@git.wordpress.org>

Author: 3 people

packages/redux-routine/README.md

@@ -65,11 +65,11 @@ Creates a Redux middleware, given an object of controls where each key is an act
 
 _Parameters_
 
--   _controls_ `Record<string, (value: import('redux').AnyAction) => Promise<boolean> | boolean>`: Object of control handlers.
+-   _controls_ `Record< string, ( value: AnyAction ) => Promise< boolean > | boolean >`: Object of control handlers.
 
 _Returns_
 
--   `import('redux').Middleware`: Co-routine runtime
+-   `Middleware`: Co-routine runtime
 
 <!-- END TOKEN(Autogenerated API docs) -->
 

packages/redux-routine/src/index.js renamed to packages/redux-routine/src/index.ts

@@ -1,3 +1,8 @@
+/**
+ * External dependencies
+ */
+import type { Middleware, AnyAction } from 'redux';
+
 /**
  * Internal dependencies
  */
@@ -12,11 +17,16 @@ import createRuntime from './runtime';
  * value of the yield assignment. If the control handler returns undefined, the
  * execution is not continued.
  *
- * @param {Record<string, (value: import('redux').AnyAction) => Promise<boolean> | boolean>} controls Object of control handlers.
+ * @param controls Object of control handlers.
  *
- * @return {import('redux').Middleware} Co-routine runtime
+ * @return Co-routine runtime
  */
-export default function createMiddleware( controls = {} ) {
+export default function createMiddleware(
+	controls: Record<
+		string,
+		( value: AnyAction ) => Promise< boolean > | boolean
+	> = {}
+): Middleware {
 	return ( store ) => {
 		const runtime = createRuntime( controls, store.dispatch );
 		return ( next ) => ( action ) => {

packages/redux-routine/src/is-action.js

@@ -0,0 +1,32 @@
+/**
+ * External dependencies
+ */
+import { isPlainObject } from 'is-plain-object';
+import type { Action } from 'redux';
+
+/**
+ * Returns true if the given object quacks like an action.
+ *
+ * @param object Object to test
+ *
+ * @return Whether object is an action.
+ */
+export function isAction( object: unknown ): object is Action {
+	return isPlainObject( object ) && typeof object.type === 'string';
+}
+
+/**
+ * Returns true if the given object quacks like an action and has a specific
+ * action type
+ *
+ * @param object       Object to test
+ * @param expectedType The expected type for the action.
+ *
+ * @return Whether object is an action and is of specific type.
+ */
+export function isActionOfType(
+	object: unknown,
+	expectedType: string
+): object is Action {
+	return isAction( object ) && object.type === expectedType;
+}

packages/redux-routine/src/is-action.ts

@@ -1,15 +1,13 @@
-/* eslint-disable jsdoc/valid-types */
 /**
  * Returns true if the given object is a generator, or false otherwise.
  *
  * @see https://www.ecma-international.org/ecma-262/6.0/#sec-generator-objects
  *
- * @param {any} object Object to test.
+ * @param object Object to test.
  *
- * @return {object is Generator} Whether object is a generator.
+ * @return Whether object is a generator.
  */
-export default function isGenerator( object ) {
-	/* eslint-enable jsdoc/valid-types */
+export default function isGenerator( object: any ): object is Generator {
 	// Check that iterator (next) and iterable (Symbol.iterator) interfaces are satisfied.
 	// These checks seem to be compatible with several generator helpers as well as the native implementation.
 	return (

packages/redux-routine/src/is-generator.js renamed to packages/redux-routine/src/is-generator.ts

@@ -0,0 +1,11 @@
+/**
+ * Add type guard for isPlainObject until the below PR gets merged:
+ *
+ * @see https://github.com/jonschlinkert/is-plain-object/pull/29
+ */
+
+declare module 'is-plain-object' {
+	export function isPlainObject(
+		value: unknown
+	): value is Record< PropertyKey, unknown >;
+}