@khanacademy/wonder-blocks-timing 2.1.0 → 2.1.2

package/CHANGELOG.md

@@ -1,11 +1,31 @@
 # @khanacademy/wonder-blocks-timing
 
+## 2.1.2
+
+### Patch Changes
+
+-   d816af08: Update build and test configs use TypeScript
+-   3891f544: Update babel config to include plugins that Storybook needed
+-   0d28bb1c: Configured TypeScript
+-   3d05f764: Fix HOCs and other type errors
+-   c2ec4902: Update eslint configuration, fix lint
+-   2983c05b: Include 'types' field in package.json
+-   77ff6a66: Generate Flow types from TypeScript types
+-   ec8d4b7f: Fix miscellaneous TypeScript errors
+
+## 2.1.1
+
+### Patch Changes
+
+-   91cb727c: Remove file extensions from imports
+
 ## 2.1.0
+
 ### Minor Changes
 
-- 029b4810: Adds `useInterval()` hook that mimics the behavior of `ActionScheduler`'s
-  `interval()` method.
-- c57cd770: Rename `useInterval` and `useTimeout` to `useScheduledInterval`
-  and `useScheduledTimeout` respectively.
-- 29766c8e: Add `useInterval` and `useTimeout` hooks to provide a simple API for
-  using intervals and timeouts.
+-   029b4810: Adds `useInterval()` hook that mimics the behavior of `ActionScheduler`'s
+    `interval()` method.
+-   c57cd770: Rename `useInterval` and `useTimeout` to `useScheduledInterval`
+    and `useScheduledTimeout` respectively.
+-   29766c8e: Add `useInterval` and `useTimeout` hooks to provide an API for
+    using intervals and timeouts.

package/dist/components/action-scheduler-provider.d.ts

@@ -0,0 +1,26 @@
+import * as React from "react";
+import ActionScheduler from "../util/action-scheduler";
+import type { IScheduleActions } from "../util/types";
+type Props = {
+    /**
+     * A function that, when given an instance of `IScheduleActions` will
+     * render a `React.Node`.
+     */
+    children: (arg1: IScheduleActions) => React.ReactElement;
+};
+/**
+ * A provider component that passes our action scheduling API to its children
+ * and ensures that all scheduled actions are cleared on unmount.
+ *
+ * ```jsx
+ * <ActionSchedulerProvider>
+ *     {schedule => this.renderThingThatNeedsTimers(schedule)}
+ * </ActionSchedulerProvider>
+ * ```
+ */
+export default class ActionSchedulerProvider extends React.Component<Props> {
+    componentWillUnmount(): void;
+    _actionScheduler: ActionScheduler;
+    render(): React.ReactElement;
+}
+export {};

package/dist/components/action-scheduler-provider.js.flow

@@ -0,0 +1,35 @@
+/**
+ * Flowtype definitions for action-scheduler-provider
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import ActionScheduler from "../util/action-scheduler";
+import type { IScheduleActions } from "../util/types";
+declare type Props = {
+  /**
+   * A function that, when given an instance of `IScheduleActions` will
+   * render a `React.Node`.
+   */
+  children: (arg1: IScheduleActions) => React.Element<>,
+  ...
+};
+/**
+ * A provider component that passes our action scheduling API to its children
+ * and ensures that all scheduled actions are cleared on unmount.
+ *
+ * ```jsx
+ * <ActionSchedulerProvider>
+ *     {schedule => this.renderThingThatNeedsTimers(schedule)}
+ * </ActionSchedulerProvider>
+ * ```
+ */
+declare export default class ActionSchedulerProvider
+  mixins React.Component<Props>
+{
+  componentWillUnmount(): void;
+  _actionScheduler: ActionScheduler;
+  render(): React.Element<>;
+}

package/dist/components/with-action-scheduler.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import type { WithActionSchedulerProps } from "../util/types";
+type WithoutActionScheduler<T> = Omit<T, "schedule">;
+/**
+ * A higher order component that attaches the given component to an
+ * `IScheduleActions` instance. Any actions scheduled will automatically be
+ * cleared on unmount.
+ *
+ * @template TOwnProps The own props of the component being rendered, without
+ * the additional action scheduler prop. To attach the additional prop to
+ * these props use the `WithActionScheduler` type.
+ */
+export default function withActionScheduler<Props extends WithActionSchedulerProps>(WrappedComponent: React.ComponentType<Props>): React.ForwardRefExoticComponent<React.PropsWithoutRef<WithoutActionScheduler<Props>> & React.RefAttributes<unknown>>;
+export {};

package/dist/components/with-action-scheduler.js.flow

@@ -0,0 +1,26 @@
+/**
+ * Flowtype definitions for with-action-scheduler
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import type { WithActionSchedulerProps } from "../util/types";
+declare type WithoutActionScheduler<T> = $Diff<T, { schedule: any }>;
+/**
+ * A higher order component that attaches the given component to an
+ * `IScheduleActions` instance. Any actions scheduled will automatically be
+ * cleared on unmount.
+ * @template The own props of the component being rendered, without
+ * the additional action scheduler prop. To attach the additional prop to
+ * these props use the `WithActionScheduler` type.
+ */
+declare export default function withActionScheduler<
+  Props: WithActionSchedulerProps
+>(
+  WrappedComponent: React.ComponentType<Props>
+): React.ForwardRefExoticComponent<{
+  ...React.PropsWithoutRef<WithoutActionScheduler<Props>>,
+  ...React.RefAttributes<mixed>,
+}>;