1.5.1

README.md

@@ -4,14 +4,16 @@
 
 Asynchronous state management made simple.
 
-Most of the use cases of [TanStack Query](https://tanstack.com/query/latest/) are covered with a similar API, TanStack Query comes in at most ~2 MB while Qwery comes in at most ~220 kB.
+Most of the use cases of [TanStack Query](https://tanstack.com/query/latest/) are covered with a similar API while being 60% lighter.
 
 Documentation: [Wiki](https://github.com/nmathew98/qwery/wiki/1.-Introduction)
 
 ## Frameworks
 
 -   React ✅
 -   Vue ✅
+-   Svelte ✅
+-   Solid ✅
 
 ## Features
 

lerna.json

@@ -1,6 +1,6 @@
 {
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "packages": [
     "packages/*"
   ],

packages/react/README.md

@@ -4,7 +4,11 @@
 
 Asynchronous state management in React made simple.
 
-Most of the use cases of [React Query](https://tanstack.com/query/latest/) are covered with a similar API, React Query comes in at ~2 MB while React Qwery comes in at ~220 kB.
+Most of the use cases of [React Query](https://tanstack.com/query/latest/) are covered with a similar API while being 65% lighter.
+
+React Query bundle size: [56.6 kB minified](https://bundlephobia.com/package/@tanstack/react-query)
+
+React Qwery bundle size: [19.7 kB minified](https://bundlephobia.com/package/@b.s/react-qwery)
 
 Documentation: [Wiki](https://github.com/nmathew98/qwery/wiki/1.-Introduction)
 

packages/react/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@b.s/react-qwery",
-	"version": "1.5.0",
+	"version": "1.5.1",
 	"type": "module",
 	"repository": {
 		"type": "git",

packages/solid/.eslintrc.cjs

@@ -0,0 +1,21 @@
+module.exports = {
+	root: true,
+	env: { browser: true, es2020: true },
+	extends: [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/recommended",
+		"prettier",
+	],
+	ignorePatterns: ["dist", ".eslintrc.cjs"],
+	parser: "@typescript-eslint/parser",
+	plugins: ["prettier"],
+	rules: {
+		"prettier/prettier": ["error", { usePrettierrc: true }],
+		"@typescript-eslint/no-explicit-any": 0,
+		eqeqeq: ["error", "always"],
+		"@typescript-eslint/no-unused-vars": [
+			"error",
+			{ argsIgnorePattern: "^_" },
+		],
+	},
+};

packages/solid/.gitignore

@@ -0,0 +1,26 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.tgz

packages/solid/.prettierignore

@@ -0,0 +1,3 @@
+coverage/**
+dist/**
+pnpm-lock.yaml

packages/solid/.prettierrc.json

@@ -0,0 +1,14 @@
+{
+	"tabWidth": 4,
+	"useTabs": true,
+	"semi": true,
+	"singleQuote": false,
+	"quoteProps": "as-needed",
+	"trailingComma": "all",
+	"bracketSpacing": true,
+	"bracketSameLine": true,
+	"arrowParens": "avoid",
+	"endOfLine": "lf",
+	"embeddedLanguageFormatting": "auto",
+	"printWidth": 80
+}

packages/solid/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018
+
+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.

packages/solid/README.md

@@ -0,0 +1,147 @@
+![Tests](https://github.com/nmathew98/qwery/actions/workflows/main.yml/badge.svg)
+
+## About
+
+Asynchronous state management in Solid made simple.
+
+Most of the use cases of [Solid Query](https://tanstack.com/query/latest/) are covered with a similar API while being 65% lighter.
+
+Solid Query bundle size: [54.6 kB minified](https://bundlephobia.com/package/@tanstack/solid-query)
+
+Solid Qwery bundle size: [19 kB minified](https://bundlephobia.com/package/@b.s/solid-qwery)
+
+Documentation: [Wiki](https://github.com/nmathew98/qwery/wiki/1.-Introduction)
+
+## Features
+
+-   CJS + ESM ✅
+-   Lightweight ✅
+-   Simple and easy to use ✅
+-   Retry mechanism ✅
+-   Caching (with support for async caches) ✅
+-   Automatic garbage collection ✅
+-   Remember page scroll ✅
+-   Distributed transactions (with [txn](https://www.npmjs.com/package/@b.s/txn)) ✅
+-   Structural sharing ✅
+-   Subscriptions ✅
+-   Polling ✅
+-   Sync updates between tabs with [Broadcast Channel](https://developer.mozilla.org/en-US/docs/Web/API/Broadcast_Channel_API) ✅
+-   Determine network status ✅
+-   Query cancellation ✅
+-   Suspense ✅
+-   SSR support ✅
+
+## Usage
+
+### Client-side rendering
+
+```typescript
+const { data, dispatch } = useQwery({
+	initialValue: INITIAL_VALUE,
+	onChange: onChangeData,
+});
+
+// or
+
+const { data, dispatch } = useQwery({
+	initialValue: () => fetch(API),
+	onChange: onChangeData,
+});
+
+// or
+
+const { data, dispatch } = useQwery({
+	queryKey: "test-data", // Anything with a `toString` method is supported
+	onChange: onChangeData,
+	broadcast: true, // Query key must be set to enable broadcasting updates between tabs
+});
+
+// or (Suspense)
+
+const { data, dispatch } = await useQwery({
+	initialValue: () => fetch(API),
+	onChange: onChangeData,
+	suspense: true,
+});
+```
+
+To opt into caching, provide Qwery context with `provideQweryContext`.
+
+To set cached data ahead of time (prefetching):
+
+```typescript
+const qweryContext = useQweryContext();
+
+qweryContext?.setCachedValue(queryKey)(prefetchedData);
+```
+
+To invalidate cached data:
+
+```typescript
+const qweryContext = useQweryContext();
+
+qweryContext?.makeInvalidateCachedValue(queryKey)(prefetchedData);
+```
+
+To use subscriptions:
+
+```typescript
+// Assuming its an array of records
+const subscribe = async dispatch => {
+	const generator = createAsyncGenerator();
+
+	for await (const nextValue of subscription) {
+		dispatch(previousValue => {
+			previousValue.push(nextValue);
+		});
+	}
+};
+
+const { data, dispatch } = useQwery({
+	initialValue: () => fetch(API),
+	onChange: onChangeData,
+	subscribe: subscribe,
+});
+```
+
+In a similar vein, for polling:
+
+```typescript
+// Assuming its an array of records
+const subscribe = dispatch => {
+	const poll = setInterval(async () => {
+		const result = await fetch(API);
+
+		// Determine the changes and dispatch only the changes
+		// for references to remain stable if it is an array of records
+		dispatch(result);
+	}, 5000);
+
+	return () => clearInterval(poll);
+};
+
+const { data, dispatch } = useQwery({
+	initialValue: () => fetch(API),
+	onChange: onChangeData,
+	subscribe: subscribe,
+});
+```
+
+### Server-side rendering
+
+```typescript
+const { data, dispatch } = useQwery({
+	initialValue: INITIAL_VALUE, // Must be provided otherwise `data` is `undefined`
+	onChange: onChangeData,
+});
+```
+
+More information in:
+
+-   `src/e2e`
+
+## Contributions
+
+-   Contributions are welcome, just make a pull request
+
+**_"Man's duality, life and its formalities"_**

packages/solid/package.json

@@ -0,0 +1,69 @@
+{
+	"name": "@b.s/solid-qwery",
+	"version": "1.5.1",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/nmathew98/qwery"
+	},
+	"main": "./dist/solid-qwery.umd.cjs",
+	"module": "./dist/solid-qwery.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		"import": "./dist/solid-qwery.js",
+		"require": "./dist/solid-qwery.umd.cjs",
+		"types": "./dist/index.d.ts"
+	},
+	"description": "Simple composable async state management utilities for SolidJS",
+	"license": "MIT",
+	"keywords": [
+		"crdt",
+		"solid",
+		"query",
+		"asynchronous",
+		"state",
+		"management",
+		"utilities",
+		"composable",
+		"database",
+		"universal",
+		"distributed",
+		"transaction",
+		"saga"
+	],
+	"files": [
+		"dist",
+		"LICENSE",
+		"package.json",
+		"pnpm-lock.yaml",
+		"README.md",
+		"tsconfig.json",
+		"tsconfig.node.json"
+	],
+	"scripts": {
+		"dev": "vite",
+		"build": "tsc && vite build",
+		"clean": "rm -f *.tgz && rm -rf dist",
+		"lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+		"format": "prettier .  --write",
+		"preview": "vite preview",
+		"test": "vitest run --passWithNoTests",
+		"test.watch": "vitest --passWithNoTests --watch",
+		"pack": "pnpm pack"
+	},
+	"dependencies": {
+		"@b.s/incremental": "^2.1.4",
+		"@b.s/txn": "^1.0.4"
+	},
+	"peerDependencies": {
+		"solid-js": "^1.8.15"
+	},
+	"devDependencies": {
+		"@b.s/qwery-shared": "link:../shared",
+		"typescript": "^5.2.2",
+		"vite": "^5.1.4",
+		"vite-plugin-dts": "^3.7.3",
+		"vite-plugin-solid": "^2.10.1",
+		"vitest": "^1.3.1"
+	}
+}

packages/solid/src/context/index.tsx

@@ -0,0 +1,34 @@
+import { createContext, type Component, type ParentProps } from "solid-js";
+import { createCacheProvider } from "@b.s/incremental";
+import {
+	ExecutionEnvironment,
+	useExecutionEnvironment,
+} from "../use-execution-environment";
+import type { QweryProviderProps } from "./types";
+import type { CacheProvider } from "@b.s/incremental";
+import { createNoOpCache } from "@b.s/qwery-shared";
+
+export const QweryContext = createContext<CacheProvider>(Object.create(null));
+
+export const QweryProvider: Component<
+	ParentProps<QweryProviderProps>
+> = props => {
+	const { executionEnvironment } = useExecutionEnvironment();
+
+	const createContextValue = () => {
+		if (
+			executionEnvironment === ExecutionEnvironment.Server &&
+			!props.store
+		) {
+			return createCacheProvider(createNoOpCache());
+		}
+
+		return createCacheProvider(props.store);
+	};
+
+	return (
+		<QweryContext.Provider value={createContextValue()}>
+			{props.children}
+		</QweryContext.Provider>
+	);
+};

packages/solid/src/context/types.ts

@@ -0,0 +1,5 @@
+import type { CacheStore } from "@b.s/incremental";
+
+export interface QweryProviderProps {
+	store?: CacheStore;
+}