vike-solid-query 0.0.1 → 0.1.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present Joël Charles
+
+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

@@ -8,7 +8,7 @@
 Enables your Solid components to fetch data using [TanStack Query](https://tanstack.com/query/latest).
 
 > [!NOTE]
-> You'll also get [progressive rendering](https://vike.dev/streaming#progressive-rendering) and [supports](https://tanstack.com/query/latest/docs/framework/solid/reference/createQuery#usage-with-suspense) for triggering SolidJS Suspense and ErrorBoundary components when the query is in a pending or error state.
+> You'll also get [progressive rendering](https://vike.dev/streaming#progressive-rendering) and [supports](https://tanstack.com/query/latest/docs/framework/solid/reference/useQuery#usage-with-suspense) for triggering SolidJS Suspense and ErrorBoundary components when the query is in a pending or error state.
 
 [Installation](#installation)  
 [Basic usage](#basic-usage)  
@@ -20,6 +20,7 @@ Enables your Solid components to fetch data using [TanStack Query](https://tanst
 
 1. `npm install @tanstack/solid-query vike-solid-query`
 2. Extend `+config.js`:
+
    ```js
    // pages/+config.js
 
@@ -36,12 +37,12 @@ Enables your Solid components to fetch data using [TanStack Query](https://tanst
 
 ## Basic usage
 
-```jsx
-import { createQuery } from "@tanstack/solid-query";
+```tsx
+import { useQuery } from "@tanstack/solid-query";
 import { Suspense } from "solid-js";
 
 const Movie = (props: { id }) => {
-    const query = createQuery(() => ({
+    const query = useQuery(() => ({
         queryKey: ["movies", props.id],
         queryFn: () =>
         fetch(`https://brillout.github.io/star-wars/api/films/${props.id}.json`)
@@ -58,34 +59,38 @@ const Movie = (props: { id }) => {
 
 ## `QueryBoundary`
 
-```jsx
-// Define loading fallback
+```tsx
+// Define the loading fallback
 <QueryBoundary query={query} loadingFallback={Loading}>
     {(data) => <div>{data.something}</div>}
 </QueryBoundary>
-// Define loading and error fallback 
+// Define the loading and error fallback 
 <QueryBoundary query={query} loadingFallback={Loading} errorFallback={Error}>
     {(data) => <div>{data.something}</div>}
 </QueryBoundary>
-// Define loading, error and not found fallback 
+// Define the loading, error and not found fallback 
 <QueryBoundary query={query} loadingFallback={Loading} errorFallback={Error} notFoundFallback={NotFound}>
     {(data) => <div>{data.something}</div>}
 </QueryBoundary>
 ```
 
-> [!NOTE] Types
-> `query: CreateQueryResult<T, Error>;`  
-> `loadingFallback?: JSX.Element;`  
-> `notFoundFallback?: JSX.Element;`  
-> `errorFallback?: JSX.Element | ((err: any, reset: () => void) => JSX.Element);`  
-> `children: (data: Exclude<T, null | false | undefined>) => JSX.Element;`
+**Types :**
+```js
+query: UseQueryResult<T, Error>;  
+loadingFallback?: JSX.Element;  
+notFoundFallback?: JSX.Element;  
+errorFallback?: JSX.Element | ((err: any, reset: () => void) => JSX.Element);  
+children: (data: Exclude<T, null | false | undefined>) => JSX.Element;
+```
 
 ```tsx
-import { createQuery } from "@tanstack/solid-query";
+// Movie.tsx
+
+import { useQuery } from "@tanstack/solid-query";
 import { QueryBoundary } from "vike-solid-query";
 
 function Movie(props: { id: string }) {
-  const query = createQuery(() => ({
+  const query = useQuery(() => ({
     queryKey: ["movies", props.id],
     queryFn: () =>
         fetch(`https://brillout.github.io/star-wars/api/films/${props.id}.json`)
@@ -124,15 +129,15 @@ function Movie(props: { id: string }) {
 
 To set tags such as `<title>` and `<meta name="description">` based on fetched data, you can use [`<Config>`, `<Head>`, and `useConfig()`](https://vike.dev/useConfig).
 
-```js
-import { createQuery } from "@tanstack/solid-query";
+```tsx
+import { useQuery } from "@tanstack/solid-query";
 import { Config } from 'vike-solid/Config'
 import { Head } from 'vike-solid/Head'
 import { QueryBoundary } from "vike-solid-query";
 import { For } from "solid-js";
 
 function Movies() {
-  const query = createQuery(() => ({
+  const query = useQuery(() => ({
     queryKey: ["movies"],
     queryFn: () => fetch('https://star-wars.brillout.com/api/films.json')
   }));
@@ -181,5 +186,5 @@ export default {
 ## See also
 
 - [Example](https://github.com/vikejs/vike-solid/tree/main/examples/solid-query)
-- [TanStack Query > CreateQuery > Usage with Suspense](https://tanstack.com/query/latest/docs/framework/solid/reference/createQuery#usage-with-suspense)
+- [TanStack Query > useQuery > Usage with Suspense](https://tanstack.com/query/latest/docs/framework/solid/reference/useQuery#usage-with-suspense)
 - [Vike > Data Fetching](https://vike.dev/data-fetching)

package/dist/{src/QueryBoundary.d.ts → index.d.ts}

@@ -1,7 +1,8 @@
-import type { CreateQueryResult } from "@tanstack/solid-query";
-import type { JSX } from "solid-js";
-export interface QueryBoundaryProps<T = unknown> {
-    query: CreateQueryResult<T, Error>;
+import { UseQueryResult } from '@tanstack/solid-query';
+import { JSX } from 'solid-js';
+
+interface QueryBoundaryProps<T = unknown> {
+    query: UseQueryResult<T, Error>;
     /**
      * Triggered when the data is initially loading.
      */
@@ -23,4 +24,7 @@ export interface QueryBoundaryProps<T = unknown> {
  * Convenience wrapper that handles suspense and errors for queries. Makes the results of query.data available to
  * children (as a render prop) in a type-safe way.
  */
-export declare function QueryBoundary<T>(props: QueryBoundaryProps<T>): JSX.Element;
+declare function QueryBoundary<T>(props: QueryBoundaryProps<T>): JSX.Element;
+
+export { QueryBoundary };
+export type { QueryBoundaryProps };

package/dist/index.js

@@ -0,0 +1,66 @@
+import { delegateEvents, createComponent, getNextElement, memo, template, runHydrationEvents, insert } from 'solid-js/web';
+import { ErrorBoundary, Suspense, Switch, Match } from 'solid-js';
+
+var _tmpl$ = /*#__PURE__*/template(`<div><div class=query-boundary-error></div><button>Retry`),
+  _tmpl$2 = /*#__PURE__*/template(`<div>Not Found,`),
+  _tmpl$3 = /*#__PURE__*/template(`<button>Refetch`);
+/**
+ * Convenience wrapper that handles suspense and errors for queries. Makes the results of query.data available to
+ * children (as a render prop) in a type-safe way.
+ */
+function QueryBoundary(props) {
+  return createComponent(ErrorBoundary, {
+    get fallback() {
+      return memo(() => !!props.errorFallback)() ? props.errorFallback : (err, reset) => (() => {
+        var _el$ = getNextElement(_tmpl$),
+          _el$2 = _el$.firstChild,
+          _el$3 = _el$2.nextSibling;
+        insert(_el$2, () => err.toString());
+        _el$3.$$click = async () => {
+          reset();
+          await props.query.refetch();
+        };
+        runHydrationEvents();
+        return _el$;
+      })();
+    },
+    get children() {
+      return createComponent(Suspense, {
+        get fallback() {
+          return props.loadingFallback;
+        },
+        get children() {
+          return createComponent(Switch, {
+            get children() {
+              return [createComponent(Match, {
+                get when() {
+                  return memo(() => !!!props.query.isFetching)() && !props.query.data;
+                },
+                get children() {
+                  return memo(() => !!props.notFoundFallback)() ? props.notFoundFallback : [getNextElement(_tmpl$2), (() => {
+                    var _el$5 = getNextElement(_tmpl$3);
+                    _el$5.$$click = async () => {
+                      await props.query.refetch();
+                    };
+                    runHydrationEvents();
+                    return _el$5;
+                  })()];
+                }
+              }), createComponent(Match, {
+                get when() {
+                  return props.query.data;
+                },
+                get children() {
+                  return props.children(props.query.data);
+                }
+              })];
+            }
+          });
+        }
+      });
+    }
+  });
+}
+delegateEvents(["click"]);
+
+export { QueryBoundary };

package/dist/integration/Wrapper.d.ts

@@ -1,7 +1,7 @@
 import { JSX } from 'solid-js';
 
 declare function Wrapper(props: {
-    children: JSX.Element;
+    children?: JSX.Element;
 }): JSX.Element;
 
 export { Wrapper as default };

package/dist/integration/{+config.js → config.js}

@@ -1,7 +1,7 @@
-var _config = {
+var config = {
   name: "vike-solid-query",
   require: {
-    "vike-solid": ">=0.7.3"
+    "vike-solid": ">=0.7.4"
   },
   Wrapper: "import:vike-solid-query/__internal/integration/Wrapper:default",
   queryClientConfig: {
@@ -21,4 +21,4 @@ var _config = {
   }
 };
 
-export { _config as default };
+export { config as default };

package/dist/server.js

@@ -0,0 +1,47 @@
+import { createComponent, ssr, ssrHydrationKey, escape } from 'solid-js/web';
+import { ErrorBoundary, Suspense, Switch, Match } from 'solid-js';
+
+var _tmpl$ = ["<div", "><div class=\"query-boundary-error\">", "</div><button>Retry</button></div>"],
+  _tmpl$2 = ["<div", ">Not Found,</div>"],
+  _tmpl$3 = ["<button", ">Refetch</button>"];
+/**
+ * Convenience wrapper that handles suspense and errors for queries. Makes the results of query.data available to
+ * children (as a render prop) in a type-safe way.
+ */
+function QueryBoundary(props) {
+  return createComponent(ErrorBoundary, {
+    get fallback() {
+      return props.errorFallback ? props.errorFallback : (err, reset) => ssr(_tmpl$, ssrHydrationKey(), escape(err.toString()));
+    },
+    get children() {
+      return createComponent(Suspense, {
+        get fallback() {
+          return props.loadingFallback;
+        },
+        get children() {
+          return createComponent(Switch, {
+            get children() {
+              return [createComponent(Match, {
+                get when() {
+                  return !props.query.isFetching && !props.query.data;
+                },
+                get children() {
+                  return props.notFoundFallback ? props.notFoundFallback : [ssr(_tmpl$2, ssrHydrationKey()), ssr(_tmpl$3, ssrHydrationKey())];
+                }
+              }), createComponent(Match, {
+                get when() {
+                  return props.query.data;
+                },
+                get children() {
+                  return props.children(props.query.data);
+                }
+              })];
+            }
+          });
+        }
+      });
+    }
+  });
+}
+
+export { QueryBoundary };

package/package.json

@@ -1,44 +1,51 @@
 {
   "name": "vike-solid-query",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "type": "module",
-  "scripts": {
-    "dev": "rollup -c rollup.config.js --watch",
-    "dev:typecheck": "tsc --noEmit --watch",
-    "build": "rollup -c rollup.config.js && tsc",
-    "release": "LANG=en_US release-me patch",
-    "release:minor": "LANG=en_US release-me minor",
-    "release:commit": "LANG=en_US release-me commit"
+  "main": "./dist/server.js",
+  "typings": "dist/index.d.ts",
+  "module": "./dist/server.js",
+  "types": "./dist/index.d.ts",
+  "browser": {
+    "./dist/server.js": "./dist/index.js"
+  },
+  "exports": {
+    ".": {
+      "browser": "./dist/index.js",
+      "node": "./dist/server.js",
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./config": "./dist/integration/config.js",
+    "./__internal/integration/Wrapper": {
+      "solid": "./dist/integration/Wrapper.js",
+      "import": {
+        "types": "./dist/integration/Wrapper.d.ts",
+        "default": "./dist/integration/Wrapper.js"
+      }
+    }
   },
   "peerDependencies": {
     "@tanstack/solid-query": ">=5.0.0",
     "solid-js": "^1.8.7",
-    "vike-solid": ">=0.7.3"
+    "vike-solid": "^0.7.12"
   },
   "devDependencies": {
-    "@brillout/release-me": "^0.4.0",
-    "@rollup/plugin-babel": "6.0.4",
-    "@rollup/plugin-node-resolve": "15.2.3",
-    "@tanstack/solid-query": "^5.52.2",
-    "rimraf": "^6.0.1",
-    "rollup": "^4.21.2",
-    "rollup-plugin-dts": "6.1.1",
-    "solid-js": "^1.8.22",
-    "tsup": "^8.2.4",
-    "typescript": "^5.5.4",
-    "vike": "^0.4.193",
-    "vike-solid": "^0.7.3",
-    "vite": "5.4.2"
-  },
-  "exports": {
-    ".": "./dist/src/index.js",
-    "./config": "./dist/integration/+config.js",
-    "./__internal/integration/Wrapper": "./dist/integration/Wrapper.js"
+    "@brillout/release-me": "^0.4.8",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@tanstack/solid-query": "^5.85.3",
+    "rollup": "^4.46.3",
+    "rollup-plugin-dts": "^6.2.3",
+    "solid-js": "^1.9.9",
+    "typescript": "^5.9.2",
+    "vike": "^0.4.237",
+    "vike-solid": "0.7.12"
   },
   "typesVersions": {
     "*": {
       "config": [
-        "dist/integration/+config.d.ts"
+        "dist/integration/config.d.ts"
       ],
       "__internal/integration/Wrapper": [
         "dist/integration/Wrapper.d.ts"
@@ -49,5 +56,14 @@
     "dist/"
   ],
   "repository": "github:vikejs/vike-solid",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "scripts": {
+    "dev": "rollup -c rollup.config.js --watch",
+    "dev:typecheck": "tsc --noEmit --watch",
+    "build": "tsc --noEmit && rollup -c rollup.config.js",
+    "release": "LANG=en_US release-me patch",
+    "release:minor": "LANG=en_US release-me minor",
+    "release:commit": "LANG=en_US release-me commit",
+    "test:types": "tsc --noEmit"
+  }
+}

package/dist/src/QueryBoundary.jsx

@@ -1,37 +0,0 @@
-import { ErrorBoundary, Match, Suspense, Switch } from "solid-js";
-/**
- * Convenience wrapper that handles suspense and errors for queries. Makes the results of query.data available to
- * children (as a render prop) in a type-safe way.
- */
-export function QueryBoundary(props) {
-    return (<ErrorBoundary fallback={props.errorFallback
-            ? props.errorFallback
-            : (err, reset) => (<div>
-                <div class="query-boundary-error">{err.toString()}</div>
-                <button onClick={async () => {
-                    reset();
-                    await props.query.refetch();
-                }}>
-                  Retry
-                </button>
-              </div>)}>
-      <Suspense fallback={props.loadingFallback}>
-        <Switch>
-          <Match when={!props.query.isFetching && !props.query.data}>
-            {props.notFoundFallback ? (props.notFoundFallback) : (<>
-                <div>Not Found,</div>
-                <button onClick={async () => {
-                await props.query.refetch();
-            }}>
-                  Refetch
-                </button>
-              </>)}
-          </Match>
-
-          <Match when={props.query.data}>
-            {props.children(props.query.data)}
-          </Match>
-        </Switch>
-      </Suspense>
-    </ErrorBoundary>);
-}

package/dist/src/index.d.ts

@@ -1 +0,0 @@
-export { QueryBoundary } from "./QueryBoundary";

package/dist/src/index.js

@@ -1 +0,0 @@
-export { QueryBoundary } from "./QueryBoundary";