@peterbud/nuxt-query 0.0.3

package/dist/module.mjs

@@ -0,0 +1,75 @@
+import { createResolver, defineNuxtModule, useLogger, addPlugin, addImports } from '@nuxt/kit';
+import { defu } from 'defu';
+import { existsSync } from 'node:fs';
+import { addCustomTab } from '@nuxt/devtools-kit';
+
+const version = "0.0.2";
+
+const DEVTOOLS_UI_ROUTE = "/__nuxt-query-client";
+const DEVTOOLS_UI_LOCAL_PORT = 3300;
+function setupDevToolsUI(nuxt, resolver) {
+  const clientPath = resolver.resolve("./client");
+  const isProductionBuild = existsSync(clientPath);
+  if (isProductionBuild) {
+    nuxt.hook("vite:serverCreated", async (server) => {
+      const sirv = await import('sirv').then((r) => r.default || r);
+      server.middlewares.use(
+        DEVTOOLS_UI_ROUTE,
+        sirv(clientPath, { dev: true, single: true })
+      );
+    });
+  } else {
+    nuxt.hook("vite:extendConfig", (config) => {
+      config.server = config.server || {};
+      config.server.proxy = config.server.proxy || {};
+      config.server.proxy[DEVTOOLS_UI_ROUTE] = {
+        target: `http://localhost:${DEVTOOLS_UI_LOCAL_PORT}${DEVTOOLS_UI_ROUTE}`,
+        changeOrigin: true,
+        followRedirects: true,
+        rewrite: (path) => path.replace(DEVTOOLS_UI_ROUTE, "")
+      };
+    });
+  }
+  addCustomTab({
+    name: "nuxt-query",
+    title: "Nuxt Query",
+    icon: "carbon:apps",
+    // iframe view
+    view: {
+      type: "iframe",
+      src: `${DEVTOOLS_UI_ROUTE}/vue-query`
+    }
+  });
+}
+
+const resolver = createResolver(import.meta.url);
+const module = defineNuxtModule({
+  meta: {
+    name: "nuxt-query",
+    configKey: "nuxtQuery",
+    version
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {
+    autoImports: false,
+    devtools: true
+  },
+  setup(options, nuxt) {
+    const logger = useLogger("nuxt-query");
+    logger.info(`Adding nuxt-query module`);
+    nuxt.options.runtimeConfig.public.nuxtQuery = defu(
+      nuxt.options.runtimeConfig.public.nuxtQuery,
+      {
+        queryClientOptions: { ...options.queryClientOptions }
+      }
+    );
+    addPlugin(resolver.resolve("./runtime/plugin"));
+    if (options.autoImports && options.autoImports.length > 0)
+      addImports(options.autoImports.map((name) => ({ name, from: "@tanstack/vue-query" })));
+    if (options.devtools)
+      setupDevToolsUI(nuxt, resolver);
+    logger.success(`Added nuxt-query module successfully.`);
+  }
+});
+
+export { module as default };

package/dist/runtime/plugin.d.ts

@@ -0,0 +1,7 @@
+import { QueryClient } from '@tanstack/vue-query';
+declare const _default: import("nuxt/app").Plugin<{
+    queryClient: QueryClient;
+}> & import("nuxt/app").ObjectPlugin<{
+    queryClient: QueryClient;
+}>;
+export default _default;

package/dist/runtime/plugin.js

@@ -0,0 +1,37 @@
+import { QueryClient, VueQueryPlugin, dehydrate, hydrate } from "@tanstack/vue-query";
+import { defineNuxtPlugin, useRuntimeConfig, useState } from "#app";
+export default defineNuxtPlugin({
+  name: "nuxt-query:plugin",
+  async setup(nuxtApp) {
+    const queryClientOptions = useRuntimeConfig().public.nuxtQuery?.queryClientOptions;
+    let queryClient;
+    let options;
+    const getPluginOptions = (queryClientParam) => {
+      queryClient = queryClientParam ?? new QueryClient(queryClientOptions);
+      options = {
+        queryClient
+      };
+    };
+    await nuxtApp.callHook("nuxt-query:configure", getPluginOptions);
+    if (!queryClient)
+      queryClient = new QueryClient(queryClientOptions);
+    if (!options)
+      options = {
+        queryClient,
+        enableDevtoolsV6Plugin: true
+      };
+    nuxtApp.vueApp.use(VueQueryPlugin, options);
+    const vueQueryState = useState("vue-query-state");
+    if (import.meta.server) {
+      nuxtApp.hooks.hook("app:rendered", () => {
+        vueQueryState.value = dehydrate(queryClient);
+      });
+    }
+    if (import.meta.client) hydrate(queryClient, vueQueryState.value);
+    return {
+      provide: {
+        queryClient
+      }
+    };
+  }
+});

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { ModuleRuntimeHooks } from './module.mjs'
+
+declare module '#app' {
+  interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
+}
+
+export { type ModuleOptions, type ModuleRuntimeHooks, default } from './module.mjs'

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@peterbud/nuxt-query",
+  "version": "0.0.3",
+  "description": "Nuxt integration for Tanstack Query",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peterbud/nuxt-query.git"
+  },
+  "author": "Peter Budai",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "keywords": [
+    "vue",
+    "nuxt",
+    "query",
+    "nuxt-module",
+    "tanstack",
+    "tanstack-query",
+    "vue-query"
+  ],
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "nuxt-module-build build && pnpm build:client",
+    "build:client": "nuxi generate client",
+    "dev": "nuxi dev playground",
+    "dev:client": "concurrently \"nuxi dev client --port 3300\" \"nuxi dev playground\"",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "pnpm lint && pnpm build && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@nuxt/devtools-kit": "^2.0.0",
+    "@nuxt/devtools-ui-kit": "^2.0.0",
+    "@nuxt/kit": "^3.15.4",
+    "@tanstack/vue-query": "^5.66.0",
+    "defu": "^6.1.4",
+    "sirv": "^3.0.1"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^2.0.0",
+    "@nuxt/eslint-config": "^1.0.1",
+    "@nuxt/module-builder": "1.0.0-alpha.1",
+    "@nuxt/schema": "^3.15.4",
+    "@nuxt/test-utils": "^3.15.4",
+    "@types/node": "latest",
+    "@unocss/nuxt": "^65.4.3",
+    "changelogen": "^0.5.7",
+    "concurrently": "^9.1.2",
+    "eslint": "^9.20.1",
+    "nuxt": "^3.15.4",
+    "typescript": "~5.6.3",
+    "vitest": "^3.0.5",
+    "vue-tsc": "^2.2.0"
+  },
+  "packageManager": "pnpm@10.2.0"
+}