chore(stories): add Todo workspace and User management examples; update Cleanup advanced story with renamed props and restructured code

Author: kirillbaldin

README.md

@@ -37,6 +37,13 @@ disposeTimeout();
 disposeReaction();
 ```
 
+Each public utility is also available as a package subpath:
+
+```ts
+import { cleanupReaction } from "@meded90/cleanup/cleanupReaction";
+import { cleanupTimeout } from "@meded90/cleanup/cleanupTimeout";
+```
+
 ## API
 
 - [`cleanupReaction`](./src/cleanup/cleanupReaction.ts)
@@ -54,7 +61,6 @@ disposeReaction();
 - [`cleanupRequestAnimationFrame`](./src/cleanup/cleanupRequestAnimationFrame.ts)
 - [`cleanupIdleCallback`](./src/cleanup/cleanupIdleCallback.ts)
 
-
 ## Scripts
 
 - `pnpm dev` - starts Storybook locally on port 6007.

package.json

@@ -23,6 +23,11 @@
   },
   "files": [
     "dist",
+    "src/**/*.ts",
+    "src/**/*.d.ts",
+    "!src/**/*.doc.mdx",
+    "!src/**/*.stories.tsx",
+    "!src/**/*.test.ts",
     "README.md",
     "LICENSE"
   ],
@@ -37,6 +42,76 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./cleanupAutorun": {
+      "types": "./dist/cleanup/cleanupAutorun.d.ts",
+      "import": "./dist/cleanupAutorun.js",
+      "require": "./dist/cleanupAutorun.cjs"
+    },
+    "./cleanupBodyEventListener": {
+      "types": "./dist/cleanup/cleanupEventListener.d.ts",
+      "import": "./dist/cleanupEventListener.js",
+      "require": "./dist/cleanupEventListener.cjs"
+    },
+    "./cleanupDocumentEventListener": {
+      "types": "./dist/cleanup/cleanupEventListener.d.ts",
+      "import": "./dist/cleanupEventListener.js",
+      "require": "./dist/cleanupEventListener.cjs"
+    },
+    "./cleanupEventListener": {
+      "types": "./dist/cleanup/cleanupEventListener.d.ts",
+      "import": "./dist/cleanupEventListener.js",
+      "require": "./dist/cleanupEventListener.cjs"
+    },
+    "./cleanupIdleCallback": {
+      "types": "./dist/cleanup/cleanupIdleCallback.d.ts",
+      "import": "./dist/cleanupIdleCallback.js",
+      "require": "./dist/cleanupIdleCallback.cjs"
+    },
+    "./cleanupInterval": {
+      "types": "./dist/cleanup/cleanupInterval.d.ts",
+      "import": "./dist/cleanupInterval.js",
+      "require": "./dist/cleanupInterval.cjs"
+    },
+    "./cleanupReaction": {
+      "types": "./dist/cleanup/cleanupReaction.d.ts",
+      "import": "./dist/cleanupReaction.js",
+      "require": "./dist/cleanupReaction.cjs"
+    },
+    "./cleanupReactionList": {
+      "types": "./dist/cleanup/cleanupReactionList.d.ts",
+      "import": "./dist/cleanupReactionList.js",
+      "require": "./dist/cleanupReactionList.cjs"
+    },
+    "./cleanupReactionMap": {
+      "types": "./dist/cleanup/cleanupReactionMap.d.ts",
+      "import": "./dist/cleanupReactionMap.js",
+      "require": "./dist/cleanupReactionMap.cjs"
+    },
+    "./cleanupReactionPrimitiveList": {
+      "types": "./dist/cleanup/cleanupReactionPrimitiveList.d.ts",
+      "import": "./dist/cleanupReactionPrimitiveList.js",
+      "require": "./dist/cleanupReactionPrimitiveList.cjs"
+    },
+    "./cleanupRequestAnimationFrame": {
+      "types": "./dist/cleanup/cleanupRequestAnimationFrame.d.ts",
+      "import": "./dist/cleanupRequestAnimationFrame.js",
+      "require": "./dist/cleanupRequestAnimationFrame.cjs"
+    },
+    "./cleanupSelectorEventListener": {
+      "types": "./dist/cleanup/cleanupEventListener.d.ts",
+      "import": "./dist/cleanupEventListener.js",
+      "require": "./dist/cleanupEventListener.cjs"
+    },
+    "./cleanupTimeout": {
+      "types": "./dist/cleanup/cleanupTimeout.d.ts",
+      "import": "./dist/cleanupTimeout.js",
+      "require": "./dist/cleanupTimeout.cjs"
+    },
+    "./cleanupWindowEventListener": {
+      "types": "./dist/cleanup/cleanupEventListener.d.ts",
+      "import": "./dist/cleanupEventListener.js",
+      "require": "./dist/cleanupEventListener.cjs"
+    },
     "./package.json": "./package.json"
   },
   "publishConfig": {
@@ -47,7 +122,7 @@
     "dev": "storybook dev -p 6007",
     "storybook": "storybook dev -p 6007",
     "storybook:build": "STORYBOOK_DOCS_WATCH=0 storybook build -c .storybook -o storybook-static",
-    "build": "pnpm run build:types && vp build --config vite.config.ts",
+    "build": "rm -rf dist && pnpm run build:types && vp build --config vite.config.ts",
     "build:types": "tsc -p tsconfig.build.json",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "vp test --config vitest.config.ts --run",

src/cleanup/cleanupEventListener.doc.mdx

@@ -24,7 +24,7 @@ import { Meta } from '@storybook/blocks';
 #### Source Code:
 
 ```ts
-export default function cleanupEventListener<Type extends Element | HTMLDivElement | Window | Document | null, Key extends Type extends Window ? keyof WindowEventMap : Type extends Document ? keyof DocumentEventMap : keyof HTMLElementEventMap>(type: Key, func: (event: any | void) => Disposer, ref: RefLike<Type> | Type | null, options?: boolean | AddEventListenerOptions) {
+export function cleanupEventListener<Type extends Element | HTMLDivElement | Window | Document | null, Key extends Type extends Window ? keyof WindowEventMap : Type extends Document ? keyof DocumentEventMap : keyof HTMLElementEventMap>(type: Key, func: (event: any | void) => Disposer, ref: RefLike<Type> | Type | null, options?: boolean | AddEventListenerOptions) {
     let current: Type | null = null;
     if (!ref) {
         return () => { };

src/cleanup/cleanupEventListener.ts

@@ -1,7 +1,9 @@
-import { isFunction } from "lodash";
+import lodash from "lodash";
 
 import { Disposer } from "../types/disposer";
 
+const { isFunction } = lodash;
+
 type RefLike<Type> = {
   readonly current: Type | null;
 };
@@ -17,7 +19,7 @@ type RefLike<Type> = {
  * @param options - addEventListener options.
  * @returns function for removing the listener and running cleanup.
  */
-export default function cleanupEventListener<
+export function cleanupEventListener<
   Type extends Element | HTMLDivElement | Window | Document | null,
   Key extends Type extends Window
     ? keyof WindowEventMap
@@ -115,3 +117,5 @@ export function cleanupSelectorEventListener<E extends keyof HTMLElementEventMap
 ) {
   return cleanupEventListener<Element, E>(type, func, document.querySelector(selector), options);
 }
+
+export default cleanupEventListener;

src/cleanup/cleanupIdleCallback.ts

@@ -1,6 +1,8 @@
-import { isFunction } from "lodash";
+import lodash from "lodash";
 import { action } from "mobx";
 
+const { isFunction } = lodash;
+
 type IdleHandle = number | ReturnType<typeof setTimeout>;
 
 function requestIdleCallbackSafe(

src/cleanup/cleanupInterval.ts

@@ -1,7 +1,10 @@
-import { isFunction, isString } from "lodash";
+import lodash from "lodash";
+import ms from "ms";
 
-import ms, { StringValue } from "../ms";
 import { Disposer } from "../types/disposer";
+import { StringValue } from "../types/msStringValue";
+
+const { isFunction, isString } = lodash;
 
 /**
  * Runs an async effect on an interval, cleaning up the previous result before the next call.

src/cleanup/cleanupRequestAnimationFrame.ts

@@ -1,7 +1,9 @@
-import { isFunction } from "lodash";
+import lodash from "lodash";
 
 import { Disposer } from "../types/disposer";
 
+const { isFunction } = lodash;
+
 /**
  * Setup/cleanup wrapper for requestAnimationFrame.
  * On rerun, the previous frame is cancelled and its cleanup runs.

src/cleanup/cleanupTimeout.ts

@@ -1,7 +1,10 @@
-import { isFunction, isString } from "lodash";
+import lodash from "lodash";
 import { action } from "mobx";
+import ms from "ms";
 
-import ms, { StringValue } from "../ms";
+import { StringValue } from "../types/msStringValue";
+
+const { isFunction, isString } = lodash;
 
 /**
  * Setup/cleanup wrapper for setTimeout:

src/index.ts

@@ -19,6 +19,5 @@ export type {
 } from "./cleanup/cleanupReactionPrimitiveList";
 export { cleanupRequestAnimationFrame } from "./cleanup/cleanupRequestAnimationFrame";
 export { cleanupTimeout } from "./cleanup/cleanupTimeout";
-export { default as ms } from "./ms";
-export type { StringValue } from "./ms";
 export type { Disposer, DisposerSync } from "./types/disposer";
+export type { StringValue } from "./types/msStringValue";