@tanstack/preact-pacer-devtools 0.0.1 → 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tanner Linsley
+
+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/README.md

@@ -1,45 +1,165 @@
-# @tanstack/preact-pacer-devtools
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@tanstack/preact-pacer-devtools`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+<div align="center">
+  <img src="./media/header_pacer.png" >
+</div>
+
+<br />
+
+<div align="center">
+	<a href="https://www.npmjs.com/package/@tanstack/pacer" target="\_parent">
+	  <img alt="" src="https://img.shields.io/npm/dm/@tanstack/pacer.svg" alt="npm downloads" />
+	</a>
+- <a href="https://github.com/TanStack/pacer" target="\_parent">
+	  <img alt="" src="https://img.shields.io/github/stars/TanStack/pacer.svg?style=social&label=Star" alt="GitHub stars" />
+	</a>
+	<a href="https://bundlephobia.com/result?p=@tanstack/react-pacer@latest" target="\_parent">
+  <img alt="" src="https://badgen.net/bundlephobia/minzip/@tanstack/react-pacer@latest" alt="Bundle size" />
+</a>
+</div>
+
+<div align="center">
+<a href="#badge">
+  <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+</a>
+	<a href="#badge">
+		<img src="https://img.shields.io/github/v/release/tanstack/pacer" alt="Release"/>
+	</a>
+	<a href="https://twitter.com/tan_stack">
+		<img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" alt="Follow @TanStack"/>
+	</a>
+</div>
+
+<div align="center">
+  
+### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+</div>
+
+# TanStack Pacer
+
+A lightweight timing and scheduling library for debouncing, throttling, rate limiting, queuing, and batching.
+
+> [!NOTE]
+> TanStack Pacer is currently mostly a client-side only library, but it is being designed to be able to potentially be used on the server-side as well.
+
+- **Debouncing**
+  - Delay execution until after a period of inactivity for when you only care about the last execution in a sequence.
+  - Synchronous or Asynchronous Debounce utilities with promise support and error handling
+  - Control of leading, trailing, and enabled options
+- **Throttling**
+  - Smoothly limit the rate at which a function can fire
+  - Synchronous or Asynchronous Throttle utilities with promise support and error handling
+  - Control of leading, trailing, and enabled options.
+- **Rate Limiting**
+  - Limit the rate at which a function can fire over a period of time
+  - Synchronous or Asynchronous Rate Limiting utilities with promise support and error handling
+  - Fixed or Sliding Window variations of Rate Limiting
+- **Queuing**
+  - Queue functions to be executed in a specific order
+  - Choose from FIFO, LIFO, and Priority queue implementations
+  - Control processing speed with configurable wait times or concurrency limits
+  - Manage queue execution with start/stop capabilities
+  - Expire items from the queue after a configurable duration
+- **Batching**
+  - Chunk up multiple operations into larger batches to reduce total back-and-forth operations
+  - Batch by time period, batch size, whichever comes first, or a custom condition to trigger batch executions
+- **Async or Sync Variations**
+  - Choose between synchronous and asynchronous versions of each utility
+  - Optional error, success, and settled handling for async variations
+  - Retry and Abort support for async variations
+- **State Management**
+  - Uses TanStack Store under the hood for state management with fine-grained reactivity
+  - Easily integrate with your own state management library of choice
+  - Persist state to local or session storage for some utilities like rate limiting and queuing
+- **Convenient Hooks**
+  - Reduce boilerplate code with pre-built hooks like `useDebouncedCallback`, `useThrottledValue`, and `useQueuedState`, and more.
+  - Multiple layers of abstraction to choose from depending on your use case.
+  - Works with each framework's default state management solutions, or with whatever custom state management library that you prefer.
+- **Type Safety**
+  - Full type safety with TypeScript that makes sure that your functions will always be called with the correct arguments
+  - Generics for flexible and reusable utilities
+- **Framework Adapters**
+  - React, Solid, and more
+- **Tree Shaking**
+  - We, of course, get tree-shaking right for your applications by default, but we also provide extra deep imports for each utility, making it easier to embed these utilities into your libraries without increasing the bundle-phobia reports of your library.
+
+### <a href="https://tanstack.com/pacer">Read the docs →</b></a>
+
+<br />
+
+> [!NOTE]
+> You may know **TanSack Pacer** by our adapter names, too!
+>
+> - [**React Pacer**](https://tanstack.com/pacer/latest/docs/framework/react/react-pacer)
+> - [**Preact Pacer**](https://tanstack.com/pacer/latest/docs/framework/preact/preact-pacer)
+> - [**Solid Pacer**](https://tanstack.com/pacer/latest/docs/framework/solid/solid-pacer)
+> - Angular Pacer - needs a contributor!
+> - Svelte Pacer - needs a contributor!
+> - Vue Pacer - needs a contributor!
+
+## Get Involved
+
+- We welcome issues and pull requests!
+- Participate in [GitHub discussions](https://github.com/TanStack/pacer/discussions)
+- Chat with the community on [Discord](https://discord.com/invite/WrRKjPJ)
+- See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions
+
+## Partners
+
+<table align="center">
+  <tr>
+    <td>
+      <a href="https://www.coderabbit.ai/?via=tanstack&dub_id=aCcEEdAOqqutX6OS" >
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/coderabbit-dark-CMcuvjEy.svg" height="40" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" />
+          <img src="https://tanstack.com/assets/coderabbit-light-DVMJ2jHi.svg" height="40" alt="CodeRabbit" />
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="https://www.cloudflare.com?utm_source=tanstack">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="https://tanstack.com/assets/cloudflare-white-DQDB7UaL.svg" height="60" />
+          <source media="(prefers-color-scheme: light)" srcset="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" />
+          <img src="https://tanstack.com/assets/cloudflare-black-CPufaW0B.svg" height="60" alt="Cloudflare" />
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="https://www.unkey.com/?utm_source=tanstack">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="./media/unkey_dark.svg" height="60" />
+          <source media="(prefers-color-scheme: light)" srcset="./media/unkey_logo.svg" height="60" />
+          <img src="./media/unkey_logo.svg" height="60" alt="Unkey"/>
+        </picture>
+      </a>
+    </td>
+  </tr>
+</table>
+
+<div align="center">
+<img src="./media/partner_logo.svg" alt="Pacer & you?" height="65">
+<p>
+We're looking for TanStack Pacer Partners to join our mission! Partner with us to push the boundaries of TanStack Pacer and build amazing things together.
+</p>
+<a href="mailto:partners@tanstack.com?subject=TanStack Pacer Partnership"><b>LET'S CHAT</b></a>
+</div>
+
+</div>
+
+## Explore the TanStack Ecosystem
+
+- <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
+- <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
+- <a href="https://github.com/tanstack/devtools"><b>TanStack DevTools</b></a> – Unified devtools panel
+- <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
+- <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching
+- <a href="https://github.com/tanstack/ranger"><b>TanStack Ranger</b></a> – Range & slider primitives
+- <a href="https://github.com/tanstack/router"><b>TanStack Router</b></a> – Type‑safe routing, caching & URL state
+- <a href="https://github.com/tanstack/router"><b>TanStack Start</b></a> – Full‑stack SSR & streaming
+- <a href="https://github.com/tanstack/store"><b>TanStack Store</b></a> – Reactive data store
+- <a href="https://github.com/tanstack/table"><b>TanStack Table</b></a> – Headless datagrids
+- <a href="https://github.com/tanstack/virtual"><b>TanStack Virtual</b></a> – Virtualized rendering
+
+… and more at <a href="https://tanstack.com"><b>TanStack.com »</b></a>
+
+<!-- USE THE FORCE LUKE -->

package/dist/PreactPacerDevtools.d.ts

@@ -0,0 +1,9 @@
+import { DevtoolsPanelProps } from "@tanstack/devtools-utils/preact";
+import * as preact1 from "preact";
+
+//#region src/PreactPacerDevtools.d.ts
+interface PacerDevtoolsPreactInit extends DevtoolsPanelProps {}
+declare const PacerDevtoolsPanel: (props: DevtoolsPanelProps | undefined) => preact1.JSX.Element, PacerDevtoolsPanelNoOp: (_props: DevtoolsPanelProps | undefined) => preact1.JSX.Element;
+//#endregion
+export { PacerDevtoolsPanel, PacerDevtoolsPreactInit };
+//# sourceMappingURL=PreactPacerDevtools.d.ts.map

package/dist/PreactPacerDevtools.js

@@ -0,0 +1,9 @@
+import { createPreactPanel } from "@tanstack/devtools-utils/preact";
+import { PacerDevtoolsCore } from "@tanstack/pacer-devtools";
+
+//#region src/PreactPacerDevtools.tsx
+const [PacerDevtoolsPanel, PacerDevtoolsPanelNoOp] = createPreactPanel(PacerDevtoolsCore);
+
+//#endregion
+export { PacerDevtoolsPanel, PacerDevtoolsPanelNoOp };
+//# sourceMappingURL=PreactPacerDevtools.js.map

package/dist/PreactPacerDevtools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreactPacerDevtools.js","names":[],"sources":["../src/PreactPacerDevtools.tsx"],"sourcesContent":["import { createPreactPanel } from '@tanstack/devtools-utils/preact'\nimport { PacerDevtoolsCore } from '@tanstack/pacer-devtools'\nimport type { DevtoolsPanelProps } from '@tanstack/devtools-utils/preact'\n\nexport interface PacerDevtoolsPreactInit extends DevtoolsPanelProps {}\n\nconst [PacerDevtoolsPanel, PacerDevtoolsPanelNoOp] =\n  createPreactPanel(PacerDevtoolsCore)\n\nexport { PacerDevtoolsPanel, PacerDevtoolsPanelNoOp }\n"],"mappings":";;;;AAMA,MAAM,CAAC,oBAAoB,0BACzB,kBAAkB,kBAAkB"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { PacerDevtoolsPreactInit } from "./PreactPacerDevtools.js";
+import * as _tanstack_devtools_utils_preact0 from "@tanstack/devtools-utils/preact";
+import * as preact0 from "preact";
+
+//#region src/index.d.ts
+declare const PacerDevtoolsPanel: (props: _tanstack_devtools_utils_preact0.DevtoolsPanelProps | undefined) => preact0.JSX.Element;
+declare const pacerDevtoolsPlugin: () => {
+  render: (_el: HTMLElement, theme: "light" | "dark") => preact0.JSX.Element;
+  name: string;
+  id?: string;
+  defaultOpen?: boolean;
+};
+//#endregion
+export { PacerDevtoolsPanel, type PacerDevtoolsPreactInit, pacerDevtoolsPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,12 @@
+'use client';
+
+import { PacerDevtoolsPanel as PacerDevtoolsPanel$1, PacerDevtoolsPanelNoOp } from "./PreactPacerDevtools.js";
+import { pacerDevtoolsNoOpPlugin, pacerDevtoolsPlugin as pacerDevtoolsPlugin$1 } from "./plugin.js";
+
+//#region src/index.ts
+const PacerDevtoolsPanel = process.env.NODE_ENV !== "development" ? PacerDevtoolsPanelNoOp : PacerDevtoolsPanel$1;
+const pacerDevtoolsPlugin = process.env.NODE_ENV !== "development" ? pacerDevtoolsNoOpPlugin : pacerDevtoolsPlugin$1;
+
+//#endregion
+export { PacerDevtoolsPanel, pacerDevtoolsPlugin };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["Devtools.PacerDevtoolsPanelNoOp","Devtools.PacerDevtoolsPanel","plugin.pacerDevtoolsNoOpPlugin","plugin.pacerDevtoolsPlugin"],"sources":["../src/index.ts"],"sourcesContent":["'use client'\n\nimport * as Devtools from './PreactPacerDevtools'\nimport * as plugin from './plugin'\n\nexport const PacerDevtoolsPanel =\n  process.env.NODE_ENV !== 'development'\n    ? Devtools.PacerDevtoolsPanelNoOp\n    : Devtools.PacerDevtoolsPanel\n\nexport const pacerDevtoolsPlugin =\n  process.env.NODE_ENV !== 'development'\n    ? plugin.pacerDevtoolsNoOpPlugin\n    : plugin.pacerDevtoolsPlugin\n\nexport type { PacerDevtoolsPreactInit } from './PreactPacerDevtools'\n"],"mappings":";;;;;;AAKA,MAAa,qBACX,QAAQ,IAAI,aAAa,gBACrBA,yBACAC;AAEN,MAAa,sBACX,QAAQ,IAAI,aAAa,gBACrBC,0BACAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,17 @@
+import * as preact3 from "preact";
+
+//#region src/plugin.d.ts
+declare const pacerDevtoolsPlugin: () => {
+    render: (_el: HTMLElement, theme: "light" | "dark") => preact3.JSX.Element;
+    name: string;
+    id?: string;
+    defaultOpen?: boolean;
+  }, pacerDevtoolsNoOpPlugin: () => {
+    render: (_el: HTMLElement, _theme: "light" | "dark") => preact3.JSX.Element;
+    name: string;
+    id?: string;
+    defaultOpen?: boolean;
+  };
+//#endregion
+export { pacerDevtoolsPlugin };
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.js

@@ -0,0 +1,12 @@
+import { PacerDevtoolsPanel } from "./PreactPacerDevtools.js";
+import { createPreactPlugin } from "@tanstack/devtools-utils/preact";
+
+//#region src/plugin.tsx
+const [pacerDevtoolsPlugin, pacerDevtoolsNoOpPlugin] = createPreactPlugin({
+	name: "TanStack Pacer",
+	Component: PacerDevtoolsPanel
+});
+
+//#endregion
+export { pacerDevtoolsNoOpPlugin, pacerDevtoolsPlugin };
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","names":[],"sources":["../src/plugin.tsx"],"sourcesContent":["import { createPreactPlugin } from '@tanstack/devtools-utils/preact'\nimport { PacerDevtoolsPanel } from './PreactPacerDevtools'\n\nconst [pacerDevtoolsPlugin, pacerDevtoolsNoOpPlugin] = createPreactPlugin({\n  name: 'TanStack Pacer',\n  Component: PacerDevtoolsPanel,\n})\n\nexport { pacerDevtoolsPlugin, pacerDevtoolsNoOpPlugin }\n"],"mappings":";;;;AAGA,MAAM,CAAC,qBAAqB,2BAA2B,mBAAmB;CACxE,MAAM;CACN,WAAW;CACZ,CAAC"}

package/dist/production.d.ts

@@ -0,0 +1,3 @@
+import { PacerDevtoolsPanel, PacerDevtoolsPreactInit } from "./PreactPacerDevtools.js";
+import { pacerDevtoolsPlugin } from "./plugin.js";
+export { PacerDevtoolsPanel, type PacerDevtoolsPreactInit, pacerDevtoolsPlugin };

package/dist/production.js

@@ -0,0 +1,6 @@
+'use client';
+
+import { PacerDevtoolsPanel } from "./PreactPacerDevtools.js";
+import { pacerDevtoolsPlugin } from "./plugin.js";
+
+export { PacerDevtoolsPanel, pacerDevtoolsPlugin };

package/package.json

@@ -1,10 +1,65 @@
 {
   "name": "@tanstack/preact-pacer-devtools",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @tanstack/preact-pacer-devtools",
+  "version": "0.5.0",
+  "description": "Preact adapter for devtools for Pacer.",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/pacer.git",
+    "directory": "packages/pacer"
+  },
+  "homepage": "https://tanstack.com/pacer",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "preact",
+    "debounce",
+    "throttle",
+    "rate-limit",
+    "queuer",
+    "queue",
+    "pacer"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./production": "./dist/production.js",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist/",
+    "src"
+  ],
+  "peerDependencies": {
+    "preact": ">=10.0.0"
+  },
+  "dependencies": {
+    "@tanstack/devtools-utils": "^0.1.0",
+    "@tanstack/pacer-devtools": "1.1.0"
+  },
+  "devDependencies": {
+    "@preact/preset-vite": "^2.10.2",
+    "@testing-library/preact": "^3.2.4",
+    "preact": "^10.28.0"
+  },
+  "main": "./dist/index.js",
+  "scripts": {
+    "clean": "premove ./build ./dist",
+    "lint:fix": "eslint ./src --fix",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc",
+    "test:build": "publint --strict",
+    "build": "tsdown"
+  }
+}

package/src/PreactPacerDevtools.tsx

@@ -0,0 +1,10 @@
+import { createPreactPanel } from '@tanstack/devtools-utils/preact'
+import { PacerDevtoolsCore } from '@tanstack/pacer-devtools'
+import type { DevtoolsPanelProps } from '@tanstack/devtools-utils/preact'
+
+export interface PacerDevtoolsPreactInit extends DevtoolsPanelProps {}
+
+const [PacerDevtoolsPanel, PacerDevtoolsPanelNoOp] =
+  createPreactPanel(PacerDevtoolsCore)
+
+export { PacerDevtoolsPanel, PacerDevtoolsPanelNoOp }

package/src/index.ts

@@ -0,0 +1,16 @@
+'use client'
+
+import * as Devtools from './PreactPacerDevtools'
+import * as plugin from './plugin'
+
+export const PacerDevtoolsPanel =
+  process.env.NODE_ENV !== 'development'
+    ? Devtools.PacerDevtoolsPanelNoOp
+    : Devtools.PacerDevtoolsPanel
+
+export const pacerDevtoolsPlugin =
+  process.env.NODE_ENV !== 'development'
+    ? plugin.pacerDevtoolsNoOpPlugin
+    : plugin.pacerDevtoolsPlugin
+
+export type { PacerDevtoolsPreactInit } from './PreactPacerDevtools'

package/src/plugin.tsx

@@ -0,0 +1,9 @@
+import { createPreactPlugin } from '@tanstack/devtools-utils/preact'
+import { PacerDevtoolsPanel } from './PreactPacerDevtools'
+
+const [pacerDevtoolsPlugin, pacerDevtoolsNoOpPlugin] = createPreactPlugin({
+  name: 'TanStack Pacer',
+  Component: PacerDevtoolsPanel,
+})
+
+export { pacerDevtoolsPlugin, pacerDevtoolsNoOpPlugin }

package/src/production.ts

@@ -0,0 +1,7 @@
+'use client'
+
+export { PacerDevtoolsPanel } from './PreactPacerDevtools'
+
+export type { PacerDevtoolsPreactInit } from './PreactPacerDevtools'
+
+export { pacerDevtoolsPlugin } from './plugin'