@tanstack/preact-query-devtools 0.0.1 → 5.92.0

package/src/PreactQueryDevtoolsPanel.tsx

@@ -0,0 +1,110 @@
+import { useRef, useState, useEffect } from 'preact/hooks'
+import { onlineManager, useQueryClient } from '@tanstack/preact-query'
+import { TanstackQueryDevtoolsPanel } from '@tanstack/query-devtools'
+import type { DevtoolsErrorType, Theme } from '@tanstack/query-devtools'
+import type { QueryClient } from '@tanstack/preact-query'
+import type { JSX, VNode } from 'preact'
+
+export interface DevtoolsPanelOptions {
+  /**
+   * Use this to provide a custom QueryClient. Otherwise, the one from the
+   * nearest QueryClientProvider will be used.
+   */
+  client?: QueryClient
+  /**
+   * Custom error types to be shown in the devtools.
+   */
+  errorTypes?: Array<DevtoolsErrorType>
+  /**
+   * Use this to pass a nonce to the style tag that is added to the document
+   * head. This is useful if you are using a Content Security Policy (CSP)
+   * nonce to allow inline styles.
+   */
+  styleNonce?: string
+  /**
+   * Use this to render the devtools inside a Shadow DOM.
+   */
+  shadowDOMTarget?: ShadowRoot
+  /**
+   * Custom styles for the devtools panel container.
+   */
+  style?: JSX.CSSProperties
+  /**
+   * Callback function when the devtools panel is closed.
+   */
+  onClose?: () => unknown
+  /**
+   * Use this to hide disabled queries from the devtools panel.
+   */
+  hideDisabledQueries?: boolean
+  /**
+   * Use this to set the theme of the devtools panel.
+   * Defaults to 'system'.
+   */
+  theme?: Theme
+}
+
+export function PreactQueryDevtoolsPanel(
+  props: DevtoolsPanelOptions,
+): VNode | null {
+  const queryClient = useQueryClient(props.client)
+  const ref = useRef<HTMLDivElement>(null)
+  const {
+    errorTypes,
+    styleNonce,
+    shadowDOMTarget,
+    hideDisabledQueries,
+    theme,
+  } = props
+  const [devtools] = useState(
+    () =>
+      new TanstackQueryDevtoolsPanel({
+        client: queryClient,
+        queryFlavor: 'Preact Query',
+        version: '5',
+        onlineManager,
+        buttonPosition: 'bottom-left',
+        position: 'bottom',
+        initialIsOpen: true,
+        errorTypes,
+        styleNonce,
+        shadowDOMTarget,
+        onClose: props.onClose,
+        hideDisabledQueries,
+        theme,
+      }),
+  )
+
+  useEffect(() => {
+    devtools.setClient(queryClient)
+  }, [queryClient, devtools])
+
+  useEffect(() => {
+    devtools.setOnClose(props.onClose ?? (() => {}))
+  }, [props.onClose, devtools])
+
+  useEffect(() => {
+    devtools.setErrorTypes(errorTypes || [])
+  }, [errorTypes, devtools])
+
+  useEffect(() => {
+    devtools.setTheme(theme)
+  }, [theme, devtools])
+
+  useEffect(() => {
+    if (ref.current) {
+      devtools.mount(ref.current)
+    }
+    return () => {
+      devtools.unmount()
+    }
+  }, [devtools])
+
+  return (
+    <div
+      style={{ height: '500px', ...props.style }}
+      className="tsqd-parent-container"
+      ref={ref}
+    />
+  )
+}

package/src/index.ts

@@ -0,0 +1,18 @@
+import * as Devtools from './PreactQueryDevtools'
+import * as DevtoolsPanel from './PreactQueryDevtoolsPanel'
+
+export const PreactQueryDevtools: (typeof Devtools)['PreactQueryDevtools'] =
+  process.env.NODE_ENV !== 'development'
+    ? function () {
+        return null
+      }
+    : Devtools.PreactQueryDevtools
+
+export const PreactQueryDevtoolsPanel: (typeof DevtoolsPanel)['PreactQueryDevtoolsPanel'] =
+  process.env.NODE_ENV !== 'development'
+    ? function () {
+        return null
+      }
+    : DevtoolsPanel.PreactQueryDevtoolsPanel
+
+export type DevtoolsPanelOptions = DevtoolsPanel.DevtoolsPanelOptions

package/src/production.ts

@@ -0,0 +1,5 @@
+import * as Devtools from './PreactQueryDevtools'
+import * as DevtoolsPanel from './PreactQueryDevtoolsPanel'
+
+export const PreactQueryDevtools = Devtools.PreactQueryDevtools
+export const PreactQueryDevtoolsPanel = DevtoolsPanel.PreactQueryDevtoolsPanel

package/README.md

@@ -1,45 +0,0 @@
-# @tanstack/preact-query-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-query-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**