@khanacademy/wonder-blocks-timing 6.0.1 → 7.0.1

package/CHANGELOG.md

@@ -1,120 +1,143 @@
 # @khanacademy/wonder-blocks-timing
 
+## 7.0.1
+
+### Patch Changes
+
+- ee8d95a: Rollback rollup version from v4 to v2 to prevent an issue with CJS builds in unit tests
+
+## 7.0.0
+
+### Major Changes
+
+- ae9b619: Fix bug with `useTimeout` and `useInterval` `clear` function where it didn't use the provided ClearPolicy
+
+### Minor Changes
+
+- f03298f: Tooling:
+
+    - Switching to `pnpm`.
+    - Upgrading `rollup` to v4 and `@babel/runtime` to match the current webapp version.
+
+### Patch Changes
+
+- bb2a026: pnpm: Switch to workspace protocol to handle dependency versions with changesets on monorepo setup"
+
 ## 6.0.1
 
 ### Patch Changes
 
--   11a0f5c6: No functional changes. Adding prepublishOnly script.
+- 11a0f5c6: No functional changes. Adding prepublishOnly script.
 
 ## 6.0.0
 
 ### Major Changes
 
--   e6abdd17: Upgrade to React 18
+- e6abdd17: Upgrade to React 18
 
 ## 5.0.2
 
 ### Patch Changes
 
--   02a1b298: Make sure we don't package tsconfig and tsbuildinfo files
+- 02a1b298: Make sure we don't package tsconfig and tsbuildinfo files
 
 ## 5.0.1
 
 ### Patch Changes
 
--   559e82d5: Update to build tooling, generating smaller output
+- 559e82d5: Update to build tooling, generating smaller output
 
 ## 5.0.0
 
 ### Major Changes
 
--   f72f7dd4: - **[BREAKING CHANGE]** Policy types are now using enums across all APIs
-    -   **[BREAKING CHANGE]** `useScheduledTimeout` has been renamed to `useTimeout` and the original `useTimeout` has been removed. To update existing uses of `useTimeout` to the new API: if `active` was `true` just delete that argument or replace it with `{schedulingPolicy: SchedulingPolicy.Immediately}`; if `active` was `false` replace it with `{schedulingPolicy: SchedulingPolicy.OnDemand}`.
-    -   **[BREAKING CHANGE]** `useScheduledInterval` has been renamed to `useInterval` and the original `useInterval` has been removed. To update existing uses of `useInterval` to the new API: if `active` was `true` just delete that argument or replace it with `{schedulingPolicy: SchedulingPolicy.Immediately}`; if `active` was `false` replace it with `{schedulingPolicy: SchedulingPolicy.OnDemand}`.
-    -   **[NEW]** `useTimeout` now supports an optional `ActionPolicy` in the options. The default is to not reset the timeout when the `action` callback changes. This can be changed to `ActionPolicy.Reset` to reset the timeout when the `action` callback changes (it is recommended that you use `useCallback` on your `action` callback to avoid resetting the timeout everytime a component renders when using the `Reset` policy).
-    -   **[NEW]** `useInterval` now supports an optional `ActionPolicy` in the options. The default is to not reset the interval when the `action` callback changes. This can be changed to `ActionPolicy.Reset` to reset the interval when the `action` callback changes (it is recommended that you use `useCallback` on your `action` callback to avoid resetting the interval everytime a component renders when using the `Reset` policy).
-    -   **[BUGFIX]** `useTimeout` will now correctly reset the timeout when the `set` method is called, as intended.
-    -   **[BUGFIX]** `useInterval` will now correctly reset the interval when the `set` method is called, as intended.
+- f72f7dd4: - **[BREAKING CHANGE]** Policy types are now using enums across all APIs
+    - **[BREAKING CHANGE]** `useScheduledTimeout` has been renamed to `useTimeout` and the original `useTimeout` has been removed. To update existing uses of `useTimeout` to the new API: if `active` was `true` just delete that argument or replace it with `{schedulingPolicy: SchedulingPolicy.Immediately}`; if `active` was `false` replace it with `{schedulingPolicy: SchedulingPolicy.OnDemand}`.
+    - **[BREAKING CHANGE]** `useScheduledInterval` has been renamed to `useInterval` and the original `useInterval` has been removed. To update existing uses of `useInterval` to the new API: if `active` was `true` just delete that argument or replace it with `{schedulingPolicy: SchedulingPolicy.Immediately}`; if `active` was `false` replace it with `{schedulingPolicy: SchedulingPolicy.OnDemand}`.
+    - **[NEW]** `useTimeout` now supports an optional `ActionPolicy` in the options. The default is to not reset the timeout when the `action` callback changes. This can be changed to `ActionPolicy.Reset` to reset the timeout when the `action` callback changes (it is recommended that you use `useCallback` on your `action` callback to avoid resetting the timeout everytime a component renders when using the `Reset` policy).
+    - **[NEW]** `useInterval` now supports an optional `ActionPolicy` in the options. The default is to not reset the interval when the `action` callback changes. This can be changed to `ActionPolicy.Reset` to reset the interval when the `action` callback changes (it is recommended that you use `useCallback` on your `action` callback to avoid resetting the interval everytime a component renders when using the `Reset` policy).
+    - **[BUGFIX]** `useTimeout` will now correctly reset the timeout when the `set` method is called, as intended.
+    - **[BUGFIX]** `useInterval` will now correctly reset the interval when the `set` method is called, as intended.
 
 ## 4.0.2
 
 ### Patch Changes
 
--   695f2567: Provide a friendly name (for dev tools) for withActionScheduler
+- 695f2567: Provide a friendly name (for dev tools) for withActionScheduler
 
 ## 4.0.1
 
 ### Patch Changes
 
--   df9a10aa: Update state and props to be readonly in components using getDerivedStateFromProps()
+- df9a10aa: Update state and props to be readonly in components using getDerivedStateFromProps()
 
 ## 4.0.0
 
 ### Major Changes
 
--   0c2607e6: Remove ref-forwarding from withActionScheduler
+- 0c2607e6: Remove ref-forwarding from withActionScheduler
 
 ## 3.0.3
 
 ### Patch Changes
 
--   a6164ed0: Don't use React.FC<> for functional components
+- a6164ed0: Don't use React.FC<> for functional components
 
 ## 3.0.2
 
 ### Patch Changes
 
--   c20f48f3: Don't transpile classes when building bundles
+- c20f48f3: Don't transpile classes when building bundles
 
 ## 3.0.1
 
 ### Patch Changes
 
--   ccb6fe00: Miscellaneous TS type fixes
--   d4c2b18c: Fix a variety of issues with Flow types generated by flowgen
+- ccb6fe00: Miscellaneous TS type fixes
+- d4c2b18c: Fix a variety of issues with Flow types generated by flowgen
 
 ## 3.0.0
 
 ### Major Changes
 
--   1ca4d7e3: Fix minor issue with generate Flow types (this is a major bump b/c I forgot to do one after doing the TS conversion)
+- 1ca4d7e3: Fix minor issue with generate Flow types (this is a major bump b/c I forgot to do one after doing the TS conversion)
 
 ### Minor Changes
 
--   ef661acf: Export ActionScheduler
+- ef661acf: Export ActionScheduler
 
 ## 2.1.3
 
 ### Patch Changes
 
--   b5ba5568: Ensure that flow lib defs use React.ElementConfig<> isntead of JSX.LibraryManagedAttributes<>
+- b5ba5568: Ensure that flow lib defs use React.ElementConfig<> isntead of JSX.LibraryManagedAttributes<>
 
 ## 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
+- 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
+- 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 an 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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Khan Academy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/es/index.js

@@ -193,18 +193,13 @@ class ActionSchedulerProvider extends React.Component {
 }
 
 function _extends() {
-  _extends = Object.assign ? Object.assign.bind() : function (target) {
-    for (var i = 1; i < arguments.length; i++) {
-      var source = arguments[i];
-      for (var key in source) {
-        if (Object.prototype.hasOwnProperty.call(source, key)) {
-          target[key] = source[key];
-        }
-      }
+  return _extends = Object.assign ? Object.assign.bind() : function (n) {
+    for (var e = 1; e < arguments.length; e++) {
+      var t = arguments[e];
+      for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]);
     }
-    return target;
-  };
-  return _extends.apply(this, arguments);
+    return n;
+  }, _extends.apply(null, arguments);
 }
 
 function withActionScheduler(WrappedComponent) {
@@ -231,33 +226,33 @@ function useInterval(action, intervalMs, options = {}) {
     actionProxyRef.current = action;
     if (actionPolicy === ActionPolicy.Reset) {
       var _intervalRef$current;
-      (_intervalRef$current = intervalRef.current) == null ? void 0 : _intervalRef$current.set();
+      (_intervalRef$current = intervalRef.current) == null || _intervalRef$current.set();
     }
   }
   useEffect(() => {
     intervalRef.current = new Interval(() => {
-      actionProxyRef.current == null ? void 0 : actionProxyRef.current();
+      actionProxyRef.current == null || actionProxyRef.current();
     }, intervalMs, schedulePolicy);
     return () => {
       var _intervalRef$current2;
-      (_intervalRef$current2 = intervalRef.current) == null ? void 0 : _intervalRef$current2.clear(clearPolicy);
+      (_intervalRef$current2 = intervalRef.current) == null || _intervalRef$current2.clear(clearPolicy);
       intervalRef.current = null;
     };
   }, [intervalMs, clearPolicy, schedulePolicy]);
   const externalApi = useMemo(() => ({
     set: () => {
       var _intervalRef$current3;
-      (_intervalRef$current3 = intervalRef.current) == null ? void 0 : _intervalRef$current3.set();
+      (_intervalRef$current3 = intervalRef.current) == null || _intervalRef$current3.set();
     },
-    clear: policy => {
+    clear: (policy = clearPolicy) => {
       var _intervalRef$current4;
-      (_intervalRef$current4 = intervalRef.current) == null ? void 0 : _intervalRef$current4.clear(policy);
+      (_intervalRef$current4 = intervalRef.current) == null || _intervalRef$current4.clear(policy);
     },
     get isSet() {
       var _intervalRef$current$, _intervalRef$current5;
       return (_intervalRef$current$ = (_intervalRef$current5 = intervalRef.current) == null ? void 0 : _intervalRef$current5.isSet) != null ? _intervalRef$current$ : false;
     }
-  }), []);
+  }), [clearPolicy]);
   return externalApi;
 }
 
@@ -276,33 +271,33 @@ function useTimeout(action, timeoutMs, options = {}) {
     actionProxyRef.current = action;
     if (actionPolicy === ActionPolicy.Reset) {
       var _timeoutRef$current;
-      (_timeoutRef$current = timeoutRef.current) == null ? void 0 : _timeoutRef$current.set();
+      (_timeoutRef$current = timeoutRef.current) == null || _timeoutRef$current.set();
     }
   }
   useEffect(() => {
     timeoutRef.current = new Timeout(() => {
-      actionProxyRef.current == null ? void 0 : actionProxyRef.current();
+      actionProxyRef.current == null || actionProxyRef.current();
     }, timeoutMs, schedulePolicy);
     return () => {
       var _timeoutRef$current2;
-      (_timeoutRef$current2 = timeoutRef.current) == null ? void 0 : _timeoutRef$current2.clear(clearPolicy);
+      (_timeoutRef$current2 = timeoutRef.current) == null || _timeoutRef$current2.clear(clearPolicy);
       timeoutRef.current = null;
     };
   }, [timeoutMs, clearPolicy, schedulePolicy]);
   const externalApi = useMemo(() => ({
     set: () => {
       var _timeoutRef$current3;
-      (_timeoutRef$current3 = timeoutRef.current) == null ? void 0 : _timeoutRef$current3.set();
+      (_timeoutRef$current3 = timeoutRef.current) == null || _timeoutRef$current3.set();
     },
-    clear: policy => {
+    clear: (policy = clearPolicy) => {
       var _timeoutRef$current4;
-      (_timeoutRef$current4 = timeoutRef.current) == null ? void 0 : _timeoutRef$current4.clear(policy);
+      (_timeoutRef$current4 = timeoutRef.current) == null || _timeoutRef$current4.clear(policy);
     },
     get isSet() {
       var _timeoutRef$current$i, _timeoutRef$current5;
       return (_timeoutRef$current$i = (_timeoutRef$current5 = timeoutRef.current) == null ? void 0 : _timeoutRef$current5.isSet) != null ? _timeoutRef$current$i : false;
     }
-  }), []);
+  }), [clearPolicy]);
   return externalApi;
 }
 

package/dist/hooks/use-interval.d.ts

@@ -25,6 +25,8 @@ import type { IInterval, HookOptions } from "../util/types";
  * scheduling the interval, use `SchedulePolicy.OnDemand`.
  * @returns An `IInterval` API for interacting with the given interval. This
  * API is a no-op if called when not mounted. This means that any calls prior
- * to mounting or after unmounting will not have any effect.
+ * to mounting or after unmounting will not have any effect. This API is
+ * not reactive, so do not deconstruct the return value, but instead
+ * dereference it at the time of use.
  */
 export declare function useInterval(action: () => unknown, intervalMs: number, options?: HookOptions): IInterval;

package/dist/hooks/use-timeout.d.ts

@@ -25,6 +25,8 @@ import type { ITimeout, HookOptions } from "../util/types";
  * scheduling the timeout, use `SchedulePolicy.OnDemand`.
  * @returns An `ITimeout` API for interacting with the given timeout. This
  * API is a no-op if called when not mounted. This means that any calls prior
- * to mounting or after unmounting will not have any effect.
+ * to mounting or after unmounting will not have any effect. This API is
+ * not reactive, so do not deconstruct the return value, but instead
+ * dereference it at the time of use.
  */
 export declare function useTimeout(action: () => unknown, timeoutMs: number, options?: HookOptions): ITimeout;

package/dist/index.js

@@ -216,18 +216,13 @@ class ActionSchedulerProvider extends React__namespace.Component {
 }
 
 function _extends() {
-  _extends = Object.assign ? Object.assign.bind() : function (target) {
-    for (var i = 1; i < arguments.length; i++) {
-      var source = arguments[i];
-      for (var key in source) {
-        if (Object.prototype.hasOwnProperty.call(source, key)) {
-          target[key] = source[key];
-        }
-      }
+  return _extends = Object.assign ? Object.assign.bind() : function (n) {
+    for (var e = 1; e < arguments.length; e++) {
+      var t = arguments[e];
+      for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]);
     }
-    return target;
-  };
-  return _extends.apply(this, arguments);
+    return n;
+  }, _extends.apply(null, arguments);
 }
 
 function withActionScheduler(WrappedComponent) {
@@ -254,33 +249,33 @@ function useInterval(action, intervalMs, options = {}) {
     actionProxyRef.current = action;
     if (actionPolicy === ActionPolicy.Reset) {
       var _intervalRef$current;
-      (_intervalRef$current = intervalRef.current) == null ? void 0 : _intervalRef$current.set();
+      (_intervalRef$current = intervalRef.current) == null || _intervalRef$current.set();
     }
   }
   React.useEffect(() => {
     intervalRef.current = new Interval(() => {
-      actionProxyRef.current == null ? void 0 : actionProxyRef.current();
+      actionProxyRef.current == null || actionProxyRef.current();
     }, intervalMs, schedulePolicy);
     return () => {
       var _intervalRef$current2;
-      (_intervalRef$current2 = intervalRef.current) == null ? void 0 : _intervalRef$current2.clear(clearPolicy);
+      (_intervalRef$current2 = intervalRef.current) == null || _intervalRef$current2.clear(clearPolicy);
       intervalRef.current = null;
     };
   }, [intervalMs, clearPolicy, schedulePolicy]);
   const externalApi = React.useMemo(() => ({
     set: () => {
       var _intervalRef$current3;
-      (_intervalRef$current3 = intervalRef.current) == null ? void 0 : _intervalRef$current3.set();
+      (_intervalRef$current3 = intervalRef.current) == null || _intervalRef$current3.set();
     },
-    clear: policy => {
+    clear: (policy = clearPolicy) => {
       var _intervalRef$current4;
-      (_intervalRef$current4 = intervalRef.current) == null ? void 0 : _intervalRef$current4.clear(policy);
+      (_intervalRef$current4 = intervalRef.current) == null || _intervalRef$current4.clear(policy);
     },
     get isSet() {
       var _intervalRef$current$, _intervalRef$current5;
       return (_intervalRef$current$ = (_intervalRef$current5 = intervalRef.current) == null ? void 0 : _intervalRef$current5.isSet) != null ? _intervalRef$current$ : false;
     }
-  }), []);
+  }), [clearPolicy]);
   return externalApi;
 }
 
@@ -299,33 +294,33 @@ function useTimeout(action, timeoutMs, options = {}) {
     actionProxyRef.current = action;
     if (actionPolicy === ActionPolicy.Reset) {
       var _timeoutRef$current;
-      (_timeoutRef$current = timeoutRef.current) == null ? void 0 : _timeoutRef$current.set();
+      (_timeoutRef$current = timeoutRef.current) == null || _timeoutRef$current.set();
     }
   }
   React.useEffect(() => {
     timeoutRef.current = new Timeout(() => {
-      actionProxyRef.current == null ? void 0 : actionProxyRef.current();
+      actionProxyRef.current == null || actionProxyRef.current();
     }, timeoutMs, schedulePolicy);
     return () => {
       var _timeoutRef$current2;
-      (_timeoutRef$current2 = timeoutRef.current) == null ? void 0 : _timeoutRef$current2.clear(clearPolicy);
+      (_timeoutRef$current2 = timeoutRef.current) == null || _timeoutRef$current2.clear(clearPolicy);
       timeoutRef.current = null;
     };
   }, [timeoutMs, clearPolicy, schedulePolicy]);
   const externalApi = React.useMemo(() => ({
     set: () => {
       var _timeoutRef$current3;
-      (_timeoutRef$current3 = timeoutRef.current) == null ? void 0 : _timeoutRef$current3.set();
+      (_timeoutRef$current3 = timeoutRef.current) == null || _timeoutRef$current3.set();
     },
-    clear: policy => {
+    clear: (policy = clearPolicy) => {
       var _timeoutRef$current4;
-      (_timeoutRef$current4 = timeoutRef.current) == null ? void 0 : _timeoutRef$current4.clear(policy);
+      (_timeoutRef$current4 = timeoutRef.current) == null || _timeoutRef$current4.clear(policy);
     },
     get isSet() {
       var _timeoutRef$current$i, _timeoutRef$current5;
       return (_timeoutRef$current$i = (_timeoutRef$current5 = timeoutRef.current) == null ? void 0 : _timeoutRef$current5.isSet) != null ? _timeoutRef$current$i : false;
     }
-  }), []);
+  }), [clearPolicy]);
   return externalApi;
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@khanacademy/wonder-blocks-timing",
   "private": false,
-  "version": "6.0.1",
+  "version": "7.0.1",
   "design": "v1",
   "publishConfig": {
     "access": "public"
@@ -10,17 +10,16 @@
   "main": "dist/index.js",
   "module": "dist/es/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "prepublishOnly": "../../utils/publish/package-pre-publish-check.sh"
-  },
   "peerDependencies": {
     "react": "18.2.0"
   },
   "devDependencies": {
-    "@khanacademy/wb-dev-build-settings": "^2.0.0",
-    "@khanacademy/wonder-blocks-testing-core": "^2.0.1"
+    "@khanacademy/wb-dev-build-settings": "2.1.1",
+    "@khanacademy/wonder-blocks-testing-core": "2.1.1"
   },
   "author": "",
-  "license": "MIT"
+  "license": "MIT",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
 }