@tanstack/angular-query-devtools 5.0.0-rc.0 → 5.0.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -31,6 +31,7 @@ const injectDevtoolsPanel = (injectDevtoolsPanelFn) => {
|
|
|
31
31
|
const {
|
|
32
32
|
client = injectedClient,
|
|
33
33
|
errorTypes = [],
|
|
34
|
+
theme = "system",
|
|
34
35
|
styleNonce,
|
|
35
36
|
shadowDOMTarget,
|
|
36
37
|
onClose,
|
|
@@ -51,6 +52,7 @@ const injectDevtoolsPanel = (injectDevtoolsPanelFn) => {
|
|
|
51
52
|
position: "bottom",
|
|
52
53
|
initialIsOpen: true,
|
|
53
54
|
errorTypes,
|
|
55
|
+
theme,
|
|
54
56
|
styleNonce,
|
|
55
57
|
shadowDOMTarget,
|
|
56
58
|
onClose,
|
|
@@ -63,6 +65,7 @@ const injectDevtoolsPanel = (injectDevtoolsPanelFn) => {
|
|
|
63
65
|
} else if (devtools && hostElement) {
|
|
64
66
|
devtools.setClient(client);
|
|
65
67
|
devtools.setErrorTypes(errorTypes);
|
|
68
|
+
devtools.setTheme(theme);
|
|
66
69
|
onClose && devtools.setOnClose(onClose);
|
|
67
70
|
} else if (devtools && !hostElement) {
|
|
68
71
|
unmount();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inject-devtools-panel.mjs","sources":["../../src/devtools-panel/inject-devtools-panel.ts"],"sourcesContent":["import {\n DestroyRef,\n PLATFORM_ID,\n assertInInjectionContext,\n computed,\n effect,\n inject,\n untracked,\n} from '@angular/core'\nimport { QueryClient, onlineManager } from '@tanstack/query-core'\nimport { isPlatformBrowser } from '@angular/common'\nimport type { TanstackQueryDevtoolsPanel } from '@tanstack/query-devtools'\nimport type { DevtoolsPanelOptions, InjectDevtoolsPanel } from './types'\n\n/**\n * Inject a TanStack Query devtools panel and render it in the DOM.\n *\n * Devtools panel allows programmatic control over the devtools, for example if you want to render\n * the devtools as part of your own devtools.\n *\n * Consider `withDevtools` instead if you don't need this.\n * @param injectDevtoolsPanelFn - A function that returns devtools panel options.\n * @returns DevtoolsPanelRef\n * @see https://tanstack.com/query/v5/docs/framework/angular/devtools\n */\nexport const injectDevtoolsPanel: InjectDevtoolsPanel = (\n injectDevtoolsPanelFn: () => DevtoolsPanelOptions,\n) => {\n assertInInjectionContext(injectDevtoolsPanel)\n const destroyRef = inject(DestroyRef)\n const isBrowser = isPlatformBrowser(inject(PLATFORM_ID))\n const injectedClient = inject(QueryClient, { optional: true })\n\n const queryOptions = computed(injectDevtoolsPanelFn)\n let devtools: TanstackQueryDevtoolsPanel | null = null\n let optionsEffect: ReturnType<typeof effect> | undefined\n let manuallyDestroyed = false\n let loadGeneration = 0\n\n const unmount = () => {\n devtools?.unmount()\n devtools = null\n }\n\n const destroy = () => {\n if (manuallyDestroyed) return\n\n manuallyDestroyed = true\n loadGeneration++\n optionsEffect?.destroy()\n unmount()\n }\n\n if (!isBrowser)\n return {\n destroy,\n }\n\n optionsEffect = effect(() => {\n const generation = ++loadGeneration\n const {\n client = injectedClient,\n errorTypes = [],\n styleNonce,\n shadowDOMTarget,\n onClose,\n hostElement,\n } = queryOptions()\n\n untracked(() => {\n if (!client) throw new Error('No QueryClient found')\n if (!devtools && hostElement) {\n import('@tanstack/query-devtools')\n .then((queryDevtools) => {\n if (\n manuallyDestroyed ||\n destroyRef.destroyed ||\n generation !== loadGeneration\n ) {\n return\n }\n\n devtools = new queryDevtools.TanstackQueryDevtoolsPanel({\n client,\n queryFlavor: 'Angular Query',\n version: '5',\n buttonPosition: 'bottom-left',\n position: 'bottom',\n initialIsOpen: true,\n errorTypes,\n styleNonce,\n shadowDOMTarget,\n onClose,\n onlineManager,\n })\n devtools.mount(hostElement.nativeElement)\n })\n .catch((error) => {\n console.error('Failed to load @tanstack/query-devtools.', error)\n })\n } else if (devtools && hostElement) {\n devtools.setClient(client)\n devtools.setErrorTypes(errorTypes)\n onClose && devtools.setOnClose(onClose)\n } else if (devtools && !hostElement) {\n unmount()\n }\n })\n })\n\n destroyRef.onDestroy(destroy)\n\n return {\n destroy,\n }\n}\n"],"names":[],"mappings":";;;AAyBO,MAAM,sBAA2C,CACtD,0BACG;AACH,2BAAyB,mBAAmB;AAC5C,QAAM,aAAa,OAAO,UAAU;AACpC,QAAM,YAAY,kBAAkB,OAAO,WAAW,CAAC;AACvD,QAAM,iBAAiB,OAAO,aAAa,EAAE,UAAU,MAAM;AAE7D,QAAM,eAAe,SAAS,qBAAqB;AACnD,MAAI,WAA8C;AAClD,MAAI;AACJ,MAAI,oBAAoB;AACxB,MAAI,iBAAiB;AAErB,QAAM,UAAU,MAAM;AACpB,yCAAU;AACV,eAAW;AAAA,EACb;AAEA,QAAM,UAAU,MAAM;AACpB,QAAI,kBAAmB;AAEvB,wBAAoB;AACpB;AACA,mDAAe;AACf,YAAA;AAAA,EACF;AAEA,MAAI,CAAC;AACH,WAAO;AAAA,MACL;AAAA,IAAA;AAGJ,kBAAgB,OAAO,MAAM;AAC3B,UAAM,aAAa,EAAE;AACrB,UAAM;AAAA,MACJ,SAAS;AAAA,MACT,aAAa,CAAA;AAAA,MACb;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IAAA,IACE,aAAA;AAEJ,cAAU,MAAM;AACd,UAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,sBAAsB;AACnD,UAAI,CAAC,YAAY,aAAa;AAC5B,eAAO,0BAA0B,EAC9B,KAAK,CAAC,kBAAkB;AACvB,cACE,qBACA,WAAW,aACX,eAAe,gBACf;AACA;AAAA,UACF;AAEA,qBAAW,IAAI,cAAc,2BAA2B;AAAA,YACtD;AAAA,YACA,aAAa;AAAA,YACb,SAAS;AAAA,YACT,gBAAgB;AAAA,YAChB,UAAU;AAAA,YACV,eAAe;AAAA,YACf;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,CACD;AACD,mBAAS,MAAM,YAAY,aAAa;AAAA,QAC1C,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,kBAAQ,MAAM,4CAA4C,KAAK;AAAA,QACjE,CAAC;AAAA,MACL,WAAW,YAAY,aAAa;AAClC,iBAAS,UAAU,MAAM;AACzB,iBAAS,cAAc,UAAU;AACjC,mBAAW,SAAS,WAAW,OAAO;AAAA,MACxC,WAAW,YAAY,CAAC,aAAa;AACnC,gBAAA;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,aAAW,UAAU,OAAO;AAE5B,SAAO;AAAA,IACL;AAAA,EAAA;AAEJ;"}
|
|
1
|
+
{"version":3,"file":"inject-devtools-panel.mjs","sources":["../../src/devtools-panel/inject-devtools-panel.ts"],"sourcesContent":["import {\n DestroyRef,\n PLATFORM_ID,\n assertInInjectionContext,\n computed,\n effect,\n inject,\n untracked,\n} from '@angular/core'\nimport { QueryClient, onlineManager } from '@tanstack/query-core'\nimport { isPlatformBrowser } from '@angular/common'\nimport type { TanstackQueryDevtoolsPanel } from '@tanstack/query-devtools'\nimport type { DevtoolsPanelOptions, InjectDevtoolsPanel } from './types'\n\n/**\n * Inject a TanStack Query devtools panel and render it in the DOM.\n *\n * Devtools panel allows programmatic control over the devtools, for example if you want to render\n * the devtools as part of your own devtools.\n *\n * Consider `withDevtools` instead if you don't need this.\n * @param injectDevtoolsPanelFn - A function that returns devtools panel options.\n * @returns DevtoolsPanelRef\n * @see https://tanstack.com/query/v5/docs/framework/angular/devtools\n */\nexport const injectDevtoolsPanel: InjectDevtoolsPanel = (\n injectDevtoolsPanelFn: () => DevtoolsPanelOptions,\n) => {\n assertInInjectionContext(injectDevtoolsPanel)\n const destroyRef = inject(DestroyRef)\n const isBrowser = isPlatformBrowser(inject(PLATFORM_ID))\n const injectedClient = inject(QueryClient, { optional: true })\n\n const queryOptions = computed(injectDevtoolsPanelFn)\n let devtools: TanstackQueryDevtoolsPanel | null = null\n let optionsEffect: ReturnType<typeof effect> | undefined\n let manuallyDestroyed = false\n let loadGeneration = 0\n\n const unmount = () => {\n devtools?.unmount()\n devtools = null\n }\n\n const destroy = () => {\n if (manuallyDestroyed) return\n\n manuallyDestroyed = true\n loadGeneration++\n optionsEffect?.destroy()\n unmount()\n }\n\n if (!isBrowser)\n return {\n destroy,\n }\n\n optionsEffect = effect(() => {\n const generation = ++loadGeneration\n const {\n client = injectedClient,\n errorTypes = [],\n theme = 'system',\n styleNonce,\n shadowDOMTarget,\n onClose,\n hostElement,\n } = queryOptions()\n\n untracked(() => {\n if (!client) throw new Error('No QueryClient found')\n if (!devtools && hostElement) {\n import('@tanstack/query-devtools')\n .then((queryDevtools) => {\n if (\n manuallyDestroyed ||\n destroyRef.destroyed ||\n generation !== loadGeneration\n ) {\n return\n }\n\n devtools = new queryDevtools.TanstackQueryDevtoolsPanel({\n client,\n queryFlavor: 'Angular Query',\n version: '5',\n buttonPosition: 'bottom-left',\n position: 'bottom',\n initialIsOpen: true,\n errorTypes,\n theme,\n styleNonce,\n shadowDOMTarget,\n onClose,\n onlineManager,\n })\n devtools.mount(hostElement.nativeElement)\n })\n .catch((error) => {\n console.error('Failed to load @tanstack/query-devtools.', error)\n })\n } else if (devtools && hostElement) {\n devtools.setClient(client)\n devtools.setErrorTypes(errorTypes)\n devtools.setTheme(theme)\n onClose && devtools.setOnClose(onClose)\n } else if (devtools && !hostElement) {\n unmount()\n }\n })\n })\n\n destroyRef.onDestroy(destroy)\n\n return {\n destroy,\n }\n}\n"],"names":[],"mappings":";;;AAyBO,MAAM,sBAA2C,CACtD,0BACG;AACH,2BAAyB,mBAAmB;AAC5C,QAAM,aAAa,OAAO,UAAU;AACpC,QAAM,YAAY,kBAAkB,OAAO,WAAW,CAAC;AACvD,QAAM,iBAAiB,OAAO,aAAa,EAAE,UAAU,MAAM;AAE7D,QAAM,eAAe,SAAS,qBAAqB;AACnD,MAAI,WAA8C;AAClD,MAAI;AACJ,MAAI,oBAAoB;AACxB,MAAI,iBAAiB;AAErB,QAAM,UAAU,MAAM;AACpB,yCAAU;AACV,eAAW;AAAA,EACb;AAEA,QAAM,UAAU,MAAM;AACpB,QAAI,kBAAmB;AAEvB,wBAAoB;AACpB;AACA,mDAAe;AACf,YAAA;AAAA,EACF;AAEA,MAAI,CAAC;AACH,WAAO;AAAA,MACL;AAAA,IAAA;AAGJ,kBAAgB,OAAO,MAAM;AAC3B,UAAM,aAAa,EAAE;AACrB,UAAM;AAAA,MACJ,SAAS;AAAA,MACT,aAAa,CAAA;AAAA,MACb,QAAQ;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IAAA,IACE,aAAA;AAEJ,cAAU,MAAM;AACd,UAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,sBAAsB;AACnD,UAAI,CAAC,YAAY,aAAa;AAC5B,eAAO,0BAA0B,EAC9B,KAAK,CAAC,kBAAkB;AACvB,cACE,qBACA,WAAW,aACX,eAAe,gBACf;AACA;AAAA,UACF;AAEA,qBAAW,IAAI,cAAc,2BAA2B;AAAA,YACtD;AAAA,YACA,aAAa;AAAA,YACb,SAAS;AAAA,YACT,gBAAgB;AAAA,YAChB,UAAU;AAAA,YACV,eAAe;AAAA,YACf;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UAAA,CACD;AACD,mBAAS,MAAM,YAAY,aAAa;AAAA,QAC1C,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,kBAAQ,MAAM,4CAA4C,KAAK;AAAA,QACjE,CAAC;AAAA,MACL,WAAW,YAAY,aAAa;AAClC,iBAAS,UAAU,MAAM;AACzB,iBAAS,cAAc,UAAU;AACjC,iBAAS,SAAS,KAAK;AACvB,mBAAW,SAAS,WAAW,OAAO;AAAA,MACxC,WAAW,YAAY,CAAC,aAAa;AACnC,gBAAA;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,aAAW,UAAU,OAAO;AAE5B,SAAO;AAAA,IACL;AAAA,EAAA;AAEJ;"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DevtoolsErrorType } from '@tanstack/query-devtools';
|
|
1
|
+
import { DevtoolsErrorType, Theme } from '@tanstack/query-devtools';
|
|
2
2
|
import { ElementRef } from '@angular/core';
|
|
3
3
|
import { QueryClient } from '@tanstack/query-core';
|
|
4
4
|
/**
|
|
@@ -19,6 +19,11 @@ export interface DevtoolsPanelOptions {
|
|
|
19
19
|
* Use this so you can define custom errors that can be shown in the devtools.
|
|
20
20
|
*/
|
|
21
21
|
errorTypes?: Array<DevtoolsErrorType>;
|
|
22
|
+
/**
|
|
23
|
+
* The theme of the devtools panel.
|
|
24
|
+
* @default 'system'
|
|
25
|
+
*/
|
|
26
|
+
theme?: Theme;
|
|
22
27
|
/**
|
|
23
28
|
* 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.
|
|
24
29
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/angular-query-devtools",
|
|
3
|
-
"version": "5.0.0-rc.
|
|
3
|
+
"version": "5.0.0-rc.1",
|
|
4
4
|
"description": "Developer tools to interact with and visualize the TanStack Angular Query cache",
|
|
5
5
|
"author": "Arnoud de Vries",
|
|
6
6
|
"license": "MIT",
|
|
@@ -60,6 +60,6 @@
|
|
|
60
60
|
"peerDependencies": {
|
|
61
61
|
"@angular/common": ">=20.1.0",
|
|
62
62
|
"@angular/core": ">=20.1.0",
|
|
63
|
-
"@tanstack/angular-query": "^5.0.0-rc.
|
|
63
|
+
"@tanstack/angular-query": "^5.0.0-rc.1"
|
|
64
64
|
}
|
|
65
65
|
}
|