@tanstack/vue-router-ssr-query 0.0.1 → 1.140.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,23 @@
 # @tanstack/vue-router-ssr-query
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+SSR Query integration for TanStack Vue Router.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+## Installation
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+```bash
+npm install @tanstack/vue-router-ssr-query
+```
 
-## Purpose
+## Usage
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@tanstack/vue-router-ssr-query`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+```ts
+import { setupRouterSsrQueryIntegration } from '@tanstack/vue-router-ssr-query'
+import { QueryClient } from '@tanstack/vue-query'
 
-## What is OIDC Trusted Publishing?
+const queryClient = new QueryClient()
 
-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**
+setupRouterSsrQueryIntegration({
+  router,
+  queryClient,
+})
+```

package/dist/esm/index.d.ts

@@ -0,0 +1,6 @@
+import { RouterSsrQueryOptions } from '@tanstack/router-ssr-query-core';
+import { AnyRouter } from '@tanstack/vue-router';
+export type Options<TRouter extends AnyRouter> = RouterSsrQueryOptions<TRouter> & {
+    wrapQueryClient?: boolean;
+};
+export declare function setupRouterSsrQueryIntegration<TRouter extends AnyRouter>(opts: Options<TRouter>): void;

package/dist/esm/index.js

@@ -0,0 +1,34 @@
+import * as Vue from "vue";
+import { setupCoreRouterSsrQueryIntegration } from "@tanstack/router-ssr-query-core";
+const VUE_QUERY_CLIENT = "VUE_QUERY_CLIENT";
+function setupRouterSsrQueryIntegration(opts) {
+  setupCoreRouterSsrQueryIntegration(opts);
+  if (opts.wrapQueryClient === false) {
+    return;
+  }
+  const OGWrap = opts.router.options.Wrap || ((props) => props.children);
+  opts.router.options.Wrap = (props) => {
+    return Vue.h(QueryClientProvider, {
+      client: opts.queryClient
+    }, () => Vue.h(OGWrap, null, () => props.children));
+  };
+}
+const QueryClientProvider = Vue.defineComponent({
+  name: "QueryClientProvider",
+  props: {
+    client: {
+      type: Object,
+      required: true
+    }
+  },
+  setup(props, {
+    slots
+  }) {
+    Vue.provide(VUE_QUERY_CLIENT, props.client);
+    return () => slots.default?.();
+  }
+});
+export {
+  setupRouterSsrQueryIntegration
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.tsx"],"sourcesContent":["import * as Vue from 'vue'\nimport { setupCoreRouterSsrQueryIntegration } from '@tanstack/router-ssr-query-core'\nimport type { RouterSsrQueryOptions } from '@tanstack/router-ssr-query-core'\nimport type { AnyRouter } from '@tanstack/vue-router'\nimport type { QueryClient } from '@tanstack/query-core'\n\n// Vue Query uses this string as the injection key\nconst VUE_QUERY_CLIENT = 'VUE_QUERY_CLIENT'\n\nexport type Options<TRouter extends AnyRouter> =\n  RouterSsrQueryOptions<TRouter> & {\n    wrapQueryClient?: boolean\n  }\n\nexport function setupRouterSsrQueryIntegration<TRouter extends AnyRouter>(\n  opts: Options<TRouter>,\n) {\n  setupCoreRouterSsrQueryIntegration(opts)\n\n  if (opts.wrapQueryClient === false) {\n    return\n  }\n\n  const OGWrap =\n    opts.router.options.Wrap || ((props: { children: any }) => props.children)\n\n  opts.router.options.Wrap = (props) => {\n    return Vue.h(QueryClientProvider, { client: opts.queryClient }, () =>\n      Vue.h(OGWrap, null, () => props.children),\n    )\n  }\n}\n\nconst QueryClientProvider = Vue.defineComponent({\n  name: 'QueryClientProvider',\n  props: {\n    client: {\n      type: Object as () => QueryClient,\n      required: true,\n    },\n  },\n  setup(props, { slots }) {\n    Vue.provide(VUE_QUERY_CLIENT, props.client)\n    return () => slots.default?.()\n  },\n})\n"],"names":["VUE_QUERY_CLIENT","setupRouterSsrQueryIntegration","opts","setupCoreRouterSsrQueryIntegration","wrapQueryClient","OGWrap","router","options","Wrap","props","children","Vue","h","QueryClientProvider","client","queryClient","defineComponent","name","type","Object","required","setup","slots","provide","default"],"mappings":";;AAOA,MAAMA,mBAAmB;AAOlB,SAASC,+BACdC,MACA;AACAC,qCAAmCD,IAAI;AAEvC,MAAIA,KAAKE,oBAAoB,OAAO;AAClC;AAAA,EACF;AAEA,QAAMC,SACJH,KAAKI,OAAOC,QAAQC,SAAUC,WAA6BA,MAAMC;AAEnER,OAAKI,OAAOC,QAAQC,OAAQC,WAAU;AACpC,WAAOE,IAAIC,EAAEC,qBAAqB;AAAA,MAAEC,QAAQZ,KAAKa;AAAAA,IAAY,GAAG,MAC9DJ,IAAIC,EAAEP,QAAQ,MAAM,MAAMI,MAAMC,QAAQ,CAC1C;AAAA,EACF;AACF;AAEA,MAAMG,sBAAsBF,IAAIK,gBAAgB;AAAA,EAC9CC,MAAM;AAAA,EACNR,OAAO;AAAA,IACLK,QAAQ;AAAA,MACNI,MAAMC;AAAAA,MACNC,UAAU;AAAA,IACZ;AAAA;EAEFC,MAAMZ,OAAO;AAAA,IAAEa;AAAAA,EAAM,GAAG;AACtBX,QAAIY,QAAQvB,kBAAkBS,MAAMK,MAAM;AAC1C,WAAO,MAAMQ,MAAME,UAAO;AAAA,EAC5B;AACF,CAAC;"}

package/package.json

@@ -1,10 +1,76 @@
 {
   "name": "@tanstack/vue-router-ssr-query",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @tanstack/vue-router-ssr-query",
+  "version": "1.140.0",
+  "description": "Modern and scalable routing for Vue applications",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanStack/router.git",
+    "directory": "packages/vue-router-ssr-query"
+  },
+  "homepage": "https://tanstack.com/router",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "vue",
+    "location",
+    "router",
+    "routing",
+    "async",
+    "async router",
+    "typescript"
+  ],
+  "type": "module",
+  "types": "dist/esm/index.d.ts",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "dependencies": {
+    "@tanstack/router-ssr-query-core": "1.140.0"
+  },
+  "devDependencies": {
+    "@tanstack/vue-query": "^5.92.0",
+    "@vitejs/plugin-vue-jsx": "^4.1.2",
+    "vue": "^3.5.25",
+    "@tanstack/vue-router": "1.140.0"
+  },
+  "peerDependencies": {
+    "@tanstack/query-core": ">=5.90.0",
+    "@tanstack/vue-query": ">=5.90.0",
+    "@tanstack/vue-router": ">=1.127.0",
+    "vue": "^3.3.0"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist && rimraf ./coverage",
+    "test:eslint": "eslint ./src",
+    "test:types": "pnpm run \"/^test:types:ts[0-9]{2}$/\"",
+    "test:types:ts54": "node ../../node_modules/typescript54/lib/tsc.js",
+    "test:types:ts55": "node ../../node_modules/typescript55/lib/tsc.js",
+    "test:types:ts56": "node ../../node_modules/typescript56/lib/tsc.js",
+    "test:types:ts57": "node ../../node_modules/typescript57/lib/tsc.js",
+    "test:types:ts58": "node ../../node_modules/typescript58/lib/tsc.js",
+    "test:types:ts59": "tsc",
+    "test:unit": "exit 0; vitest",
+    "test:unit:dev": "pnpm run test:unit --watch",
+    "test:build": "publint --strict && attw --ignore-rules no-resolution --pack .",
+    "build": "vite build"
+  }
+}

package/src/index.tsx

@@ -0,0 +1,46 @@
+import * as Vue from 'vue'
+import { setupCoreRouterSsrQueryIntegration } from '@tanstack/router-ssr-query-core'
+import type { RouterSsrQueryOptions } from '@tanstack/router-ssr-query-core'
+import type { AnyRouter } from '@tanstack/vue-router'
+import type { QueryClient } from '@tanstack/query-core'
+
+// Vue Query uses this string as the injection key
+const VUE_QUERY_CLIENT = 'VUE_QUERY_CLIENT'
+
+export type Options<TRouter extends AnyRouter> =
+  RouterSsrQueryOptions<TRouter> & {
+    wrapQueryClient?: boolean
+  }
+
+export function setupRouterSsrQueryIntegration<TRouter extends AnyRouter>(
+  opts: Options<TRouter>,
+) {
+  setupCoreRouterSsrQueryIntegration(opts)
+
+  if (opts.wrapQueryClient === false) {
+    return
+  }
+
+  const OGWrap =
+    opts.router.options.Wrap || ((props: { children: any }) => props.children)
+
+  opts.router.options.Wrap = (props) => {
+    return Vue.h(QueryClientProvider, { client: opts.queryClient }, () =>
+      Vue.h(OGWrap, null, () => props.children),
+    )
+  }
+}
+
+const QueryClientProvider = Vue.defineComponent({
+  name: 'QueryClientProvider',
+  props: {
+    client: {
+      type: Object as () => QueryClient,
+      required: true,
+    },
+  },
+  setup(props, { slots }) {
+    Vue.provide(VUE_QUERY_CLIENT, props.client)
+    return () => slots.default?.()
+  },
+})