Integrate Alien Signals

.changeset/afraid-foxes-stand.md

@@ -0,0 +1,24 @@
+---
+'@tanstack/angular-store': minor
+'@tanstack/preact-store': minor
+'@tanstack/svelte-store': minor
+'@tanstack/react-store': minor
+'@tanstack/solid-store': minor
+'@tanstack/vue-store': minor
+'@tanstack/store': minor
+---
+
+## Breaking changes
+
+- `new Store()` is now `createStore()`
+- `new Derived()` is now a derived `createStore()`:
+  ```ts
+  const derived = createStore(() => store.state * 2)
+  ```
+- `new Effect()` removed in favor of `store.subscribe()`:
+  ```ts
+  const { unsubscribe } = store.subscribe(() => {
+    console.log(store.state)
+  })
+  ```
+- Uses [alien-signals](https://github.com/nicepkg/alien-signals) under the hood for efficient reactivity

docs/framework/angular/quick-start.md

@@ -32,10 +32,10 @@ export class AppComponent {}
 
 **store.ts**
 ```typescript
-import { Store } from '@tanstack/angular-store';
+import { createStore } from '@tanstack/angular-store';
 
 // You can instantiate the store outside of Angular components too!
-export const store = new Store({
+export const store = createStore({
   dogs: 0,
   cats: 0,
 });

docs/framework/angular/reference/functions/injectStore.md

@@ -14,7 +14,7 @@ function injectStore<TState, TSelected>(
 options?): Signal<TSelected>;
 ```
 
-Defined in: [index.ts:19](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L19)
+Defined in: [index.ts:16](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L16)
 
 ### Type Parameters
 
@@ -30,7 +30,7 @@ Defined in: [index.ts:19](https://github.com/TanStack/store/blob/main/packages/a
 
 #### store
 
-`Store`\<`TState`, `any`\>
+`Atom`\<`TState`\>
 
 #### selector?
 
@@ -53,7 +53,7 @@ function injectStore<TState, TSelected>(
 options?): Signal<TSelected>;
 ```
 
-Defined in: [index.ts:24](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L24)
+Defined in: [index.ts:21](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L21)
 
 ### Type Parameters
 
@@ -69,7 +69,7 @@ Defined in: [index.ts:24](https://github.com/TanStack/store/blob/main/packages/a
 
 #### store
 
-`Derived`\<`TState`, `any`\>
+`Atom`\<`TState`\> | `ReadonlyAtom`\<`TState`\>
 
 #### selector?
 

docs/framework/preact/quick-start.md

@@ -7,10 +7,10 @@ The basic preact app example to get started with the TanStack preact-store.
 
 ```tsx
 import { render } from "preact";
-import { Store, useStore } from "@tanstack/preact-store";
+import { createStore, useStore } from "@tanstack/preact-store";
 
 // You can instantiate the store outside of Preact components too!
-export const store = new Store({
+export const store = createStore({
   dogs: 0,
   cats: 0,
 });

docs/framework/preact/reference/functions/shallow.md

@@ -9,7 +9,7 @@ title: shallow
 function shallow<T>(objA, objB): boolean;
 ```
 
-Defined in: [index.ts:130](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L130)
+Defined in: [index.ts:116](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L116)
 
 ## Type Parameters
 

docs/framework/preact/reference/functions/useStore.md

@@ -5,80 +5,39 @@ title: useStore
 
 # Function: useStore()
 
-## Call Signature
-
-```ts
-function useStore<TState, TSelected>(
-   store, 
-   selector?, 
-   options?): TSelected;
-```
-
-Defined in: [index.ts:104](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L104)
-
-### Type Parameters
-
-#### TState
-
-`TState`
-
-#### TSelected
-
-`TSelected` = `NoInfer`\<`TState`\>
-
-### Parameters
-
-#### store
-
-`Store`\<`TState`, `any`\>
-
-#### selector?
-
-(`state`) => `TSelected`
-
-#### options?
-
-`UseStoreOptions`\<`TSelected`\>
-
-### Returns
-
-`TSelected`
-
-## Call Signature
-
 ```ts
 function useStore<TState, TSelected>(
    store, 
-   selector?, 
-   options?): TSelected;
+   selector, 
+   options): TSelected;
 ```
 
-Defined in: [index.ts:109](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L109)
+Defined in: [index.ts:100](https://github.com/TanStack/store/blob/main/packages/preact-store/src/index.ts#L100)
 
-### Type Parameters
+## Type Parameters
 
-#### TState
+### TState
 
 `TState`
 
-#### TSelected
+### TSelected
 
 `TSelected` = `NoInfer`\<`TState`\>
 
-### Parameters
+## Parameters
 
-#### store
+### store
 
-`Derived`\<`TState`, `any`\>
+`Atom`\<`TState`\> | `ReadonlyAtom`\<`TState`\>
 
-#### selector?
+### selector
 
 (`state`) => `TSelected`
 
-#### options?
+### options
 
-`UseStoreOptions`\<`TSelected`\>
+`UseStoreOptions`\<`TSelected`\> = `{}`
 
-### Returns
+## Returns
 
 `TSelected`

docs/framework/react/quick-start.md

@@ -8,10 +8,10 @@ The basic react app example to get started with the TanStack react-store.
 ```tsx
 import React from "react";
 import ReactDOM from "react-dom/client";
-import { Store, useStore } from "@tanstack/react-store";
+import { createStore, useStore } from "@tanstack/react-store";
 
 // You can instantiate the store outside of React components too!
-export const store = new Store({
+export const store = createStore({
   dogs: 0,
   cats: 0,
 });

docs/framework/react/reference/functions/shallow.md

@@ -9,7 +9,7 @@ title: shallow
 function shallow<T>(objA, objB): boolean;
 ```
 
-Defined in: [index.ts:42](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L42)
+Defined in: [index.ts:5](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L5)
 
 ## Type Parameters
 

docs/framework/react/reference/functions/useStore.md

@@ -5,80 +5,39 @@ title: useStore
 
 # Function: useStore()
 
-## Call Signature
-
-```ts
-function useStore<TState, TSelected>(
-   store, 
-   selector?, 
-   options?): TSelected;
-```
-
-Defined in: [index.ts:15](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L15)
-
-### Type Parameters
-
-#### TState
-
-`TState`
-
-#### TSelected
-
-`TSelected` = `NoInfer`\<`TState`\>
-
-### Parameters
-
-#### store
-
-`Store`\<`TState`, `any`\>
-
-#### selector?
-
-(`state`) => `TSelected`
-
-#### options?
-
-`UseStoreOptions`\<`TSelected`\>
-
-### Returns
-
-`TSelected`
-
-## Call Signature
-
 ```ts
-function useStore<TState, TSelected>(
-   store, 
-   selector?, 
-   options?): TSelected;
+function useStore<TAtom, T>(
+   atom, 
+   selector, 
+   compare): T;
 ```
 
-Defined in: [index.ts:20](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L20)
+Defined in: [useStore.ts:13](https://github.com/TanStack/store/blob/main/packages/react-store/src/useStore.ts#L13)
 
-### Type Parameters
+## Type Parameters
 
-#### TState
+### TAtom
 
-`TState`
+`TAtom` *extends* `AnyAtom` \| `undefined`
 
-#### TSelected
+### T
 
-`TSelected` = `NoInfer`\<`TState`\>
+`T`
 
-### Parameters
+## Parameters
 
-#### store
+### atom
 
-`Derived`\<`TState`, `any`\>
+`TAtom`
 
-#### selector?
+### selector
 
-(`state`) => `TSelected`
+(`snapshot`) => `T`
 
-#### options?
+### compare
 
-`UseStoreOptions`\<`TSelected`\>
+(`a`, `b`) => `boolean`
 
-### Returns
+## Returns
 
-`TSelected`
+`T`

docs/framework/solid/quick-start.md

@@ -6,12 +6,12 @@ id: quick-start
 The basic Solid app example to get started with the TanStack Solid-store.
 
 ```jsx
-import { Store, useStore } from '@tanstack/solid-store';
+import { createStore, useStore } from '@tanstack/solid-store';
 
 // You can instantiate the store outside of Solid components too!
-export const store = new Store({
-  cats: 0,
-  dogs: 0
+export const store = createStore({
+  cats: 0,
+  dogs: 0
 })
 
 export const Display = (props) => {

docs/framework/solid/reference/functions/shallow.md

@@ -9,7 +9,7 @@ title: shallow
 function shallow<T>(objA, objB): boolean;
 ```
 
-Defined in: [index.tsx:49](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L49)
+Defined in: [index.tsx:35](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L35)
 
 ## Type Parameters