Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

TanstackQueryDevtools.tsx

160 lines4.2 KB

1import { render } from 'solid-js/web'
2import { createSignal, lazy } from 'solid-js'
3import { setupStyleSheet } from './utils'
4import type {
5 QueryClient,
6 onlineManager as TOnlineManager,
7} from '@tanstack/query-core'
8import type { DevtoolsComponentType } from './Devtools'
9import type {
10 DevtoolsButtonPosition,
11 DevtoolsErrorType,
12 DevtoolsPosition,
13 QueryDevtoolsProps,
14 Theme,
15} from './contexts'
16import type { Signal } from 'solid-js'
17​
18export interface TanstackQueryDevtoolsConfig extends QueryDevtoolsProps {
19 styleNonce?: string
20 shadowDOMTarget?: ShadowRoot
22​
23class TanstackQueryDevtools {
24 #client: Signal<QueryClient>
25 #onlineManager: typeof TOnlineManager
26 #queryFlavor: string
27 #version: string
28 #isMounted = false
29 #styleNonce?: string
30 #shadowDOMTarget?: ShadowRoot
31 #buttonPosition: Signal<DevtoolsButtonPosition | undefined>
32 #position: Signal<DevtoolsPosition | undefined>
33 #initialIsOpen: Signal<boolean | undefined>
34 #errorTypes: Signal<Array<DevtoolsErrorType> | undefined>
35 #hideDisabledQueries: Signal<boolean | undefined>
36 #Component: DevtoolsComponentType | undefined
37 #theme: Signal<Theme | undefined>
38 #dispose?: () => void
39​
40 constructor(config: TanstackQueryDevtoolsConfig) {
41 const {
42 client,
43 queryFlavor,
44 version,
45 onlineManager,
46 buttonPosition,
47 position,
48 initialIsOpen,
49 errorTypes,
50 styleNonce,
51 shadowDOMTarget,
52 hideDisabledQueries,
53 theme,
54 } = config
55 this.#client = createSignal(client)
56 this.#queryFlavor = queryFlavor
57 this.#version = version
58 this.#onlineManager = onlineManager
59 this.#styleNonce = styleNonce
60 this.#shadowDOMTarget = shadowDOMTarget
61 this.#buttonPosition = createSignal(buttonPosition)
62 this.#position = createSignal(position)
63 this.#initialIsOpen = createSignal(initialIsOpen)
64 this.#errorTypes = createSignal(errorTypes)
65 this.#hideDisabledQueries = createSignal(hideDisabledQueries)
66 this.#theme = createSignal(theme)
67 }
68​
69 setButtonPosition(position: DevtoolsButtonPosition) {
70 this.#buttonPosition[1](position)
71 }
72​
73 setPosition(position: DevtoolsPosition) {
74 this.#position[1](position)
75 }
76​
77 setInitialIsOpen(isOpen: boolean) {
78 this.#initialIsOpen[1](isOpen)
79 }
80​
81 setErrorTypes(errorTypes: Array<DevtoolsErrorType>) {
82 this.#errorTypes[1](errorTypes)
83 }
84​
85 setClient(client: QueryClient) {
86 this.#client[1](client)
87 }
88​
89 setTheme(theme?: Theme) {
90 this.#theme[1](theme)
91 }
92​
93 mount<T extends HTMLElement>(el: T) {
94 if (this.#isMounted) {
95 throw new Error('Devtools is already mounted')
96 }
97 const dispose = render(() => {
98 const [btnPosition] = this.#buttonPosition
99 const [pos] = this.#position
100 const [isOpen] = this.#initialIsOpen
101 const [errors] = this.#errorTypes
102 const [hideDisabledQueries] = this.#hideDisabledQueries
103 const [queryClient] = this.#client
104 const [theme] = this.#theme
105 let Devtools: DevtoolsComponentType
106​
107 if (this.#Component) {
108 Devtools = this.#Component
109 } else {
110 Devtools = lazy(() => import('./DevtoolsComponent'))
111 this.#Component = Devtools
112 }
113​
114 setupStyleSheet(this.#styleNonce, this.#shadowDOMTarget)
115 return (
116 <Devtools
117 queryFlavor={this.#queryFlavor}
118 version={this.#version}
119 onlineManager={this.#onlineManager}
120 shadowDOMTarget={this.#shadowDOMTarget}
121 {...{
122 get client() {
123 return queryClient()
124 },
125 get buttonPosition() {
126 return btnPosition()
127 },
128 get position() {
129 return pos()
130 },
131 get initialIsOpen() {
132 return isOpen()
133 },
134 get errorTypes() {
135 return errors()
136 },
137 get hideDisabledQueries() {
138 return hideDisabledQueries()
139 },
140 get theme() {
141 return theme()
142 },
143 }}
144 />
145 )
146 }, el)
147 this.#isMounted = true
148 this.#dispose = dispose
149 }
150​
151 unmount() {
152 if (!this.#isMounted) {
153 throw new Error('Devtools is not mounted')
154 }
155 this.#dispose?.()
156 this.#isMounted = false
157 }
159​
160export { TanstackQueryDevtools }