@tanstack/react-query-devtools 5.0.0-alpha.25 → 5.0.0-alpha.27

package/src/styledComponents.ts

@@ -1,126 +0,0 @@
-import { styled } from './utils'
-
-export const Panel = styled(
-  'div',
-  (_props, theme) => ({
-    fontSize: 'clamp(12px, 1.5vw, 14px)',
-    fontFamily: `sans-serif`,
-    display: 'flex',
-    backgroundColor: theme.background,
-    color: theme.foreground,
-  }),
-  {
-    '(max-width: 700px)': {
-      flexDirection: 'column',
-    },
-    '(max-width: 600px)': {
-      fontSize: '.9em',
-      // flexDirection: 'column',
-    },
-  },
-)
-
-Panel.displayName = 'Panel'
-
-export const ActiveQueryPanel = styled(
-  'div',
-  () => ({
-    flex: '1 1 500px',
-    display: 'flex',
-    flexDirection: 'column',
-    overflow: 'auto',
-    height: '100%',
-  }),
-  {
-    '(max-width: 700px)': (_props, theme) => ({
-      borderTop: `2px solid ${theme.gray}`,
-    }),
-  },
-)
-
-ActiveQueryPanel.displayName = 'ActiveQueryPanel'
-
-export const Button = styled('button', (props, theme) => ({
-  appearance: 'none',
-  fontSize: '.9em',
-  fontWeight: 'bold',
-  background: theme.gray,
-  border: '0',
-  borderRadius: '.3em',
-  color: 'white',
-  padding: '.5em',
-  opacity: props.disabled ? '.5' : undefined,
-  cursor: 'pointer',
-}))
-
-Button.displayName = 'Button'
-
-export const QueryKeys = styled('span', {
-  display: 'flex',
-  flexWrap: 'wrap',
-  gap: '0.5em',
-  fontSize: '0.9em',
-})
-
-QueryKeys.displayName = 'QueryKeys'
-
-export const QueryKey = styled('span', {
-  display: 'inline-flex',
-  alignItems: 'center',
-  padding: '.2em .4em',
-  fontWeight: 'bold',
-  textShadow: '0 0 10px black',
-  borderRadius: '.2em',
-})
-
-QueryKey.displayName = 'QueryKey'
-
-export const Code = styled('code', {
-  fontSize: '.9em',
-  color: 'inherit',
-  background: 'inherit',
-})
-
-Code.displayName = 'Code'
-
-export const Input = styled('input', (_props, theme) => ({
-  backgroundColor: theme.inputBackgroundColor,
-  border: 0,
-  borderRadius: '.2em',
-  color: theme.inputTextColor,
-  fontSize: '.9em',
-  lineHeight: `1.3`,
-  padding: '.3em .4em',
-}))
-
-Input.displayName = 'Input'
-
-export const Select = styled(
-  'select',
-  (_props, theme) => ({
-    display: `inline-block`,
-    fontSize: `.9em`,
-    fontFamily: `sans-serif`,
-    fontWeight: 'normal',
-    lineHeight: `1.3`,
-    padding: `.3em 1.5em .3em .5em`,
-    height: 'auto',
-    border: 0,
-    borderRadius: `.2em`,
-    appearance: `none`,
-    WebkitAppearance: 'none',
-    backgroundColor: theme.inputBackgroundColor,
-    backgroundImage: `url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='100' height='100' fill='%23444444'><polygon points='0,25 100,25 50,75'/></svg>")`,
-    backgroundRepeat: `no-repeat`,
-    backgroundPosition: `right .55em center`,
-    backgroundSize: `.65em auto, 100%`,
-    color: theme.inputTextColor,
-  }),
-  {
-    '(max-width: 500px)': {
-      display: 'none',
-    },
-  },
-)
-
-Select.displayName = 'Select'

package/src/theme.tsx

@@ -1,33 +0,0 @@
-'use client'
-import * as React from 'react'
-
-export const defaultTheme = {
-  background: '#0b1521',
-  backgroundAlt: '#132337',
-  foreground: 'white',
-  gray: '#3f4e60',
-  grayAlt: '#222e3e',
-  inputBackgroundColor: '#fff',
-  inputTextColor: '#000',
-  success: '#00ab52',
-  danger: '#ff0085',
-  active: '#006bff',
-  paused: '#8c49eb',
-  warning: '#ffb200',
-} as const
-
-export type Theme = typeof defaultTheme
-interface ProviderProps {
-  theme: Theme
-  children?: React.ReactNode
-}
-
-const ThemeContext = React.createContext(defaultTheme)
-
-export function ThemeProvider({ theme, ...rest }: ProviderProps) {
-  return <ThemeContext.Provider value={theme} {...rest} />
-}
-
-export function useTheme() {
-  return React.useContext(ThemeContext)
-}

package/src/types.ts

@@ -1,12 +0,0 @@
-import type { Query, DefaultError } from '@tanstack/react-query'
-
-export interface DevToolsErrorType {
-  /**
-   * The name of the error.
-   */
-  name: string
-  /**
-   * How the error is initialized.
-   */
-  initializer: (query: Query) => DefaultError
-}

package/src/useLocalStorage.ts

@@ -1,52 +0,0 @@
-import * as React from 'react'
-
-const getItem = (key: string): unknown => {
-  try {
-    const itemValue = localStorage.getItem(key)
-    if (typeof itemValue === 'string') {
-      return JSON.parse(itemValue)
-    }
-    return undefined
-  } catch {
-    return undefined
-  }
-}
-
-export default function useLocalStorage<T>(
-  key: string,
-  defaultValue: T | undefined,
-): [T | undefined, (newVal: T | ((prevVal: T) => T)) => void] {
-  const [value, setValue] = React.useState<T>()
-
-  React.useEffect(() => {
-    const initialValue = getItem(key) as T | undefined
-
-    if (typeof initialValue === 'undefined' || initialValue === null) {
-      setValue(
-        typeof defaultValue === 'function' ? defaultValue() : defaultValue,
-      )
-    } else {
-      setValue(initialValue)
-    }
-  }, [defaultValue, key])
-
-  const setter = React.useCallback(
-    (updater: any) => {
-      setValue((old) => {
-        let newVal = updater
-
-        if (typeof updater == 'function') {
-          newVal = updater(old)
-        }
-        try {
-          localStorage.setItem(key, JSON.stringify(newVal))
-        } catch {}
-
-        return newVal
-      })
-    },
-    [key],
-  )
-
-  return [value, setter]
-}

package/src/useMediaQuery.ts

@@ -1,34 +0,0 @@
-import * as React from 'react'
-
-export default function useMediaQuery(query: string): boolean | undefined {
-  // Keep track of the preference in state, start with the current match
-  const [isMatch, setIsMatch] = React.useState(() => {
-    if (typeof window !== 'undefined') {
-      return window.matchMedia(query).matches
-    }
-    return
-  })
-
-  // Watch for changes
-  React.useEffect(() => {
-    if (typeof window !== 'undefined') {
-      // Create a matcher
-      const matcher = window.matchMedia(query)
-
-      // Create our handler
-      const onChange = ({ matches }: { matches: boolean }) =>
-        setIsMatch(matches)
-
-      // Listen for changes
-      matcher.addListener(onChange)
-
-      return () => {
-        // Stop listening for changes
-        matcher.removeListener(onChange)
-      }
-    }
-    return
-  }, [isMatch, query, setIsMatch])
-
-  return isMatch
-}

package/src/useSubscribeToQueryCache.ts

@@ -1,26 +0,0 @@
-import React from 'react'
-import type { QueryCache } from '@tanstack/react-query'
-import { notifyManager } from '@tanstack/react-query'
-
-const useSubscribeToQueryCache = <T>(
-  queryCache: QueryCache,
-  getSnapshot: () => T,
-  skip: boolean = false,
-): T => {
-  return React.useSyncExternalStore(
-    React.useCallback(
-      (onStoreChange) => {
-        if (!skip)
-          return queryCache.subscribe(notifyManager.batchCalls(onStoreChange))
-        return () => {
-          return
-        }
-      },
-      [queryCache, skip],
-    ),
-    getSnapshot,
-    getSnapshot,
-  )
-}
-
-export default useSubscribeToQueryCache

package/src/utils.ts

@@ -1,319 +0,0 @@
-import * as React from 'react'
-import type { Query } from '@tanstack/react-query'
-import SuperJSON from 'superjson'
-
-import type { Theme } from './theme'
-import { useTheme } from './theme'
-import useMediaQuery from './useMediaQuery'
-
-type StyledComponent<T> = T extends 'button'
-  ? React.DetailedHTMLProps<
-      React.ButtonHTMLAttributes<HTMLButtonElement>,
-      HTMLButtonElement
-    >
-  : T extends 'input'
-  ? React.DetailedHTMLProps<
-      React.InputHTMLAttributes<HTMLInputElement>,
-      HTMLInputElement
-    >
-  : T extends 'select'
-  ? React.DetailedHTMLProps<
-      React.SelectHTMLAttributes<HTMLSelectElement>,
-      HTMLSelectElement
-    >
-  : T extends keyof HTMLElementTagNameMap
-  ? React.HTMLAttributes<HTMLElementTagNameMap[T]>
-  : never
-
-export function getQueryStatusColor({
-  queryState,
-  observerCount,
-  isStale,
-  theme,
-}: {
-  queryState: Query['state']
-  observerCount: number
-  isStale: boolean
-  theme: Theme
-}) {
-  return queryState.fetchStatus === 'fetching'
-    ? theme.active
-    : !observerCount
-    ? theme.gray
-    : queryState.fetchStatus === 'paused'
-    ? theme.paused
-    : isStale
-    ? theme.warning
-    : theme.success
-}
-
-export function getQueryStatusLabel(query: Query) {
-  return query.state.fetchStatus === 'fetching'
-    ? 'fetching'
-    : !query.getObserversCount()
-    ? 'inactive'
-    : query.state.fetchStatus === 'paused'
-    ? 'paused'
-    : query.isStale()
-    ? 'stale'
-    : 'fresh'
-}
-
-type Styles =
-  | React.CSSProperties
-  | ((props: Record<string, any>, theme: Theme) => React.CSSProperties)
-
-export function styled<T extends keyof HTMLElementTagNameMap>(
-  type: T,
-  newStyles: Styles,
-  queries: Record<string, Styles> = {},
-) {
-  return React.forwardRef<HTMLElementTagNameMap[T], StyledComponent<T>>(
-    ({ style, ...rest }, ref) => {
-      const theme = useTheme()
-
-      const mediaStyles = Object.entries(queries).reduce(
-        (current, [key, value]) => {
-          // eslint-disable-next-line react-hooks/rules-of-hooks
-          return useMediaQuery(key)
-            ? {
-                ...current,
-                ...(typeof value === 'function' ? value(rest, theme) : value),
-              }
-            : current
-        },
-        {},
-      )
-
-      return React.createElement(type, {
-        ...rest,
-        style: {
-          ...(typeof newStyles === 'function'
-            ? newStyles(rest, theme)
-            : newStyles),
-          ...style,
-          ...mediaStyles,
-        },
-        ref,
-      })
-    },
-  )
-}
-
-export function useIsMounted() {
-  const mountedRef = React.useRef(false)
-  const isMounted = React.useCallback(() => mountedRef.current, [])
-
-  React.useEffect(() => {
-    mountedRef.current = true
-    return () => {
-      mountedRef.current = false
-    }
-  }, [])
-
-  return isMounted
-}
-
-/**
- * Displays a string regardless the type of the data
- * @param {unknown} value Value to be stringified
- * @param {boolean} beautify Formats json to multiline
- */
-export const displayValue = (value: unknown, beautify: boolean = false) => {
-  const { json } = SuperJSON.serialize(value)
-
-  return JSON.stringify(json, null, beautify ? 2 : undefined)
-}
-
-// Sorting functions
-type SortFn = (a: Query, b: Query) => number
-
-const getStatusRank = (q: Query) =>
-  q.state.fetchStatus !== 'idle'
-    ? 0
-    : !q.getObserversCount()
-    ? 3
-    : q.isStale()
-    ? 2
-    : 1
-
-const queryHashSort: SortFn = (a, b) => a.queryHash.localeCompare(b.queryHash)
-
-const dateSort: SortFn = (a, b) =>
-  a.state.dataUpdatedAt < b.state.dataUpdatedAt ? 1 : -1
-
-const statusAndDateSort: SortFn = (a, b) => {
-  if (getStatusRank(a) === getStatusRank(b)) {
-    return dateSort(a, b)
-  }
-
-  return getStatusRank(a) > getStatusRank(b) ? 1 : -1
-}
-
-export const sortFns: Record<string, SortFn> = {
-  'Status > Last Updated': statusAndDateSort,
-  'Query Hash': queryHashSort,
-  'Last Updated': dateSort,
-}
-
-export const minPanelSize = 70
-export const defaultPanelSize = 500
-export const sides: Record<Side, Side> = {
-  top: 'bottom',
-  bottom: 'top',
-  left: 'right',
-  right: 'left',
-}
-
-export type Corner = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
-export type Side = 'left' | 'right' | 'top' | 'bottom'
-/**
- * Check if the given side is vertical (left/right)
- */
-export function isVerticalSide(side: Side) {
-  return ['left', 'right'].includes(side)
-}
-/**
- * Get the opposite side, eg 'left' => 'right'. 'top' => 'bottom', etc
- */
-export function getOppositeSide(side: Side): Side {
-  return sides[side]
-}
-/**
- * Given as css prop it will return a sided css prop based on a given side
- * Example given `border` and `right` it return `borderRight`
- */
-export function getSidedProp<T extends string>(prop: T, side: Side) {
-  return `${prop}${
-    side.charAt(0).toUpperCase() + side.slice(1)
-  }` as `${T}${Capitalize<Side>}`
-}
-
-export interface SidePanelStyleOptions {
-  /**
-   * Position of the panel
-   * Defaults to 'bottom'
-   */
-  position?: Side
-  /**
-   * Staring height for the panel, it is set if the position is horizontal eg 'top' or 'bottom'
-   * Defaults to 500
-   */
-  height?: number
-  /**
-   * Staring width for the panel, it is set if the position is vertical eg 'left' or 'right'
-   * Defaults to 500
-   */
-  width?: number
-  /**
-   * RQ devtools theme
-   */
-  devtoolsTheme: Theme
-  /**
-   * Sets the correct transition and visibility styles
-   */
-  isOpen?: boolean
-  /**
-   * If the panel is resizing set to true to apply the correct transition styles
-   */
-  isResizing?: boolean
-  /**
-   * Extra panel style passed by the user
-   */
-  panelStyle?: React.CSSProperties
-}
-
-export function getSidePanelStyle({
-  position = 'bottom',
-  height,
-  width,
-  devtoolsTheme,
-  isOpen,
-  isResizing,
-  panelStyle,
-}: SidePanelStyleOptions): React.CSSProperties {
-  const oppositeSide = getOppositeSide(position)
-  const borderSide = getSidedProp('border', oppositeSide)
-  const isVertical = isVerticalSide(position)
-
-  return {
-    ...panelStyle,
-    direction: 'ltr',
-    position: 'fixed',
-    [position]: 0,
-    [borderSide]: `1px solid ${devtoolsTheme.gray}`,
-    transformOrigin: oppositeSide,
-    boxShadow: '0 0 20px rgba(0,0,0,.3)',
-    zIndex: 99999,
-    // visibility will be toggled after transitions, but set initial state here
-    visibility: isOpen ? 'visible' : 'hidden',
-    ...(isResizing
-      ? {
-          transition: `none`,
-        }
-      : { transition: `all .2s ease` }),
-    ...(isOpen
-      ? {
-          opacity: 1,
-          pointerEvents: 'all',
-          transform: isVertical
-            ? `translateX(0) scale(1)`
-            : `translateY(0) scale(1)`,
-        }
-      : {
-          opacity: 0,
-          pointerEvents: 'none',
-          transform: isVertical
-            ? `translateX(15px) scale(1.02)`
-            : `translateY(15px) scale(1.02)`,
-        }),
-    ...(isVertical
-      ? {
-          top: 0,
-          height: '100vh',
-          maxWidth: '90%',
-          width:
-            typeof width === 'number' && width >= minPanelSize
-              ? width
-              : defaultPanelSize,
-        }
-      : {
-          left: 0,
-          width: '100%',
-          maxHeight: '90%',
-          height:
-            typeof height === 'number' && height >= minPanelSize
-              ? height
-              : defaultPanelSize,
-        }),
-  }
-}
-
-/**
- * Get resize handle style based on a given side
- */
-export function getResizeHandleStyle(
-  position: Side = 'bottom',
-): React.CSSProperties {
-  const isVertical = isVerticalSide(position)
-  const oppositeSide = getOppositeSide(position)
-  const marginSide = getSidedProp('margin', oppositeSide)
-
-  return {
-    position: 'absolute',
-    cursor: isVertical ? 'col-resize' : 'row-resize',
-    zIndex: 100000,
-    [oppositeSide]: 0,
-    [marginSide]: `-4px`,
-    ...(isVertical
-      ? {
-          top: 0,
-          height: '100%',
-          width: '4px',
-        }
-      : {
-          width: '100%',
-          height: '4px',
-        }),
-  }
-}