Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 214b500623 | |||
| 4b712de788 | |||
| ec21d49dce | |||
| 4478598f15 |
@@ -16,3 +16,5 @@ jobs:
|
|||||||
run: bun lint:tsc
|
run: bun lint:tsc
|
||||||
- name: Lint Biome
|
- name: Lint Biome
|
||||||
run: bun lint:biome
|
run: bun lint:biome
|
||||||
|
- name: Test
|
||||||
|
run: bun run test
|
||||||
|
|||||||
@@ -11,16 +11,35 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Setup Bun
|
- name: Setup Bun
|
||||||
uses: oven-sh/setup-bun@v2
|
uses: oven-sh/setup-bun@v2
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
- name: Login to Container Registry
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: docker.valverde.cloud
|
||||||
|
username: ${{ secrets.DOCKER_REGISTRY_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
|
||||||
|
|
||||||
- name: Clone repo
|
- name: Clone repo
|
||||||
uses: actions/checkout@v6
|
uses: actions/checkout@v6
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
|
|
||||||
- name: Lint TypeScript
|
- name: Lint TypeScript
|
||||||
run: bun lint:tsc
|
run: bun lint:tsc
|
||||||
- name: Lint Biome
|
- name: Lint Biome
|
||||||
run: bun lint:biome
|
run: bun lint:biome
|
||||||
|
- name: Test
|
||||||
|
run: bun run test
|
||||||
- name: Build
|
- name: Build
|
||||||
run: bun run build
|
run: bun run build
|
||||||
|
- name: Publish effect-view
|
||||||
|
uses: JS-DevTools/npm-publish@v4
|
||||||
|
with:
|
||||||
|
package: packages/effect-view
|
||||||
|
access: public
|
||||||
|
token: ${{ secrets.NPM_TOKEN }}
|
||||||
|
registry: https://registry.npmjs.org
|
||||||
- name: Publish effect-fc
|
- name: Publish effect-fc
|
||||||
uses: JS-DevTools/npm-publish@v4
|
uses: JS-DevTools/npm-publish@v4
|
||||||
with:
|
with:
|
||||||
@@ -28,3 +47,30 @@ jobs:
|
|||||||
access: public
|
access: public
|
||||||
token: ${{ secrets.NPM_TOKEN }}
|
token: ${{ secrets.NPM_TOKEN }}
|
||||||
registry: https://registry.npmjs.org
|
registry: https://registry.npmjs.org
|
||||||
|
|
||||||
|
- name: Clean before Docker build
|
||||||
|
run: |
|
||||||
|
bun clean:cache
|
||||||
|
bun clean:dist
|
||||||
|
bun clean:modules
|
||||||
|
- name: Generate Docker metadata
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
docker.valverde.cloud/thilawyn/effect-view
|
||||||
|
tags: |
|
||||||
|
type=ref,event=branch
|
||||||
|
type=ref,event=tag
|
||||||
|
type=ref,event=pr
|
||||||
|
type=sha
|
||||||
|
flavor: |
|
||||||
|
latest=true
|
||||||
|
- name: Build Docker image
|
||||||
|
uses: docker/build-push-action@v6
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./Dockerfile
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
|||||||
@@ -13,15 +13,48 @@ jobs:
|
|||||||
uses: actions/setup-node@v6
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: "24"
|
node-version: "24"
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
- name: Clone repo
|
- name: Clone repo
|
||||||
uses: actions/checkout@v6
|
uses: actions/checkout@v6
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: bun install --frozen-lockfile
|
run: bun install --frozen-lockfile
|
||||||
|
|
||||||
- name: Lint TypeScript
|
- name: Lint TypeScript
|
||||||
run: bun lint:tsc
|
run: bun lint:tsc
|
||||||
- name: Lint Biome
|
- name: Lint Biome
|
||||||
run: bun lint:biome
|
run: bun lint:biome
|
||||||
|
- name: Test
|
||||||
|
run: bun run test
|
||||||
- name: Build
|
- name: Build
|
||||||
run: bun run build
|
run: bun run build
|
||||||
- name: Pack
|
- name: Pack
|
||||||
run: bun pack
|
run: bun pack
|
||||||
|
|
||||||
|
- name: Clean before Docker build
|
||||||
|
run: |
|
||||||
|
bun clean:cache
|
||||||
|
bun clean:dist
|
||||||
|
bun clean:modules
|
||||||
|
- name: Generate Docker metadata
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
docker.valverde.cloud/thilawyn/effect-view
|
||||||
|
tags: |
|
||||||
|
type=ref,event=branch
|
||||||
|
type=ref,event=tag
|
||||||
|
type=ref,event=pr
|
||||||
|
type=sha
|
||||||
|
flavor: |
|
||||||
|
latest=true
|
||||||
|
- name: Build Docker image
|
||||||
|
uses: docker/build-push-action@v6
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./Dockerfile
|
||||||
|
push: false
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
|||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
FROM oven/bun:1.3.12-debian@sha256:1b709c9dd883fc1af38c210f7ea5222c552a8d470ea73efbd4b8fcfee798a64b AS bun
|
||||||
|
|
||||||
|
FROM node:24.18.0-trixie-slim@sha256:ae91dcc111a68c9d2d81ff2a17bda61be126426176fde6fe7d08ab13b7f50573
|
||||||
|
COPY --from=bun /usr/local/bin/bun /usr/local/bin/bunx /usr/local/bin/
|
||||||
|
COPY . /app
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
RUN bun install --frozen-lockfile && \
|
||||||
|
bun run build && \
|
||||||
|
bun clean:cache && \
|
||||||
|
bun clean:modules && \
|
||||||
|
bun install --production --frozen-lockfile
|
||||||
@@ -1,7 +1,61 @@
|
|||||||
# Effect FC Monorepo
|
<p align="center">
|
||||||
|
<a href="https://thila.dev/effect-view">
|
||||||
|
<img src="https://github.com/Thiladev/effect-view/raw/master/packages/docs/static/img/logo.svg" width="104" height="104" alt="Effect View logo" />
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
[Effect-TS](https://effect.website/) integration for React 19.2+ that allows you to write function components using Effect generators.
|
<h1 align="center">Effect View Monorepo</h1>
|
||||||
|
|
||||||
This monorepo contains:
|
<p align="center">
|
||||||
- [The `effect-fc` library](packages/effect-fc)
|
Write React components as typed Effect programs.
|
||||||
- [An example project](packages/example)
|
</p>
|
||||||
|
|
||||||
|
This repository contains Effect View, its documentation, development examples,
|
||||||
|
and supporting tooling. Effect View brings Effect's typed services, resource
|
||||||
|
safety, concurrency, and data modeling to React while keeping ordinary React
|
||||||
|
components, hooks, and JSX.
|
||||||
|
|
||||||
|
## Packages
|
||||||
|
|
||||||
|
| Package | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [`effect-view`](packages/effect-view) | The Effect View library for Effect v4 and React 19. |
|
||||||
|
| [`@effect-view/vite-plugin`](packages/vite-plugin) | Vite Fast Refresh support for Effect View components. |
|
||||||
|
| [`docs`](packages/docs) | The [Effect View documentation](https://thila.dev/effect-view), built with Docusaurus. |
|
||||||
|
| [`example`](packages/example) | Example application using Effect View and Effect v4. |
|
||||||
|
| [`effect-fc`](packages/effect-fc) | Legacy Effect v3 package. |
|
||||||
|
| [`effect-fc-example`](packages/effect-fc-example) | Example application for the legacy package. |
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
The monorepo uses [Bun](https://bun.sh/) workspaces and
|
||||||
|
[Turborepo](https://turbo.build/).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun install
|
||||||
|
```
|
||||||
|
|
||||||
|
Run checks and builds from the repository root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun run lint:tsc
|
||||||
|
bun run lint:biome
|
||||||
|
bun run test
|
||||||
|
bun run build
|
||||||
|
```
|
||||||
|
|
||||||
|
Start the Effect View example or documentation site:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun run --cwd packages/example dev
|
||||||
|
bun run --cwd packages/docs start
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
Read the documentation at
|
||||||
|
[thila.dev/effect-view](https://thila.dev/effect-view).
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](LICENSE)
|
||||||
|
|||||||
+8
-7
@@ -1,26 +1,27 @@
|
|||||||
{
|
{
|
||||||
"name": "@effect-fc/monorepo",
|
"name": "@effect-view/monorepo",
|
||||||
"packageManager": "bun@1.3.14",
|
"packageManager": "bun@1.3.14",
|
||||||
"private": true,
|
"private": true,
|
||||||
"workspaces": [
|
"workspaces": [
|
||||||
"./packages/*"
|
"./packages/*"
|
||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "turbo build",
|
|
||||||
"lint:tsc": "turbo lint:tsc",
|
"lint:tsc": "turbo lint:tsc",
|
||||||
"lint:biome": "turbo lint:biome",
|
"lint:biome": "turbo lint:biome",
|
||||||
|
"test": "turbo test",
|
||||||
|
"build": "turbo build",
|
||||||
"pack": "turbo pack",
|
"pack": "turbo pack",
|
||||||
"clean:cache": "turbo clean:cache",
|
"clean:cache": "turbo clean:cache",
|
||||||
"clean:dist": "turbo clean:dist",
|
"clean:dist": "turbo clean:dist",
|
||||||
"clean:modules": "turbo clean:modules && rm -rf node_modules"
|
"clean:modules": "turbo clean:modules && rm -rf node_modules"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "^2.4.16",
|
"@biomejs/biome": "^2.5.5",
|
||||||
"@effect/language-service": "^0.86.2",
|
"@effect/language-service": "^0.87.1",
|
||||||
"@types/bun": "^1.3.14",
|
"@types/bun": "^1.3.14",
|
||||||
"npm-check-updates": "^22.2.1",
|
"npm-check-updates": "^23.0.0",
|
||||||
"npm-sort": "^0.0.4",
|
"npm-sort": "^0.0.4",
|
||||||
"turbo": "^2.9.16",
|
"turbo": "^2.10.7",
|
||||||
"typescript": "^6.0.3"
|
"typescript": "^7.0.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,5 +4,15 @@
|
|||||||
"extends": "//",
|
"extends": "//",
|
||||||
"files": {
|
"files": {
|
||||||
"includes": ["./src/**"]
|
"includes": ["./src/**"]
|
||||||
|
},
|
||||||
|
"linter": {
|
||||||
|
"rules": {
|
||||||
|
"complexity": {
|
||||||
|
"noImportantStyles": "off"
|
||||||
|
},
|
||||||
|
"style": {
|
||||||
|
"noDescendingSpecificity": "off"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,145 @@
|
|||||||
|
---
|
||||||
|
sidebar_position: 2
|
||||||
|
title: Async
|
||||||
|
---
|
||||||
|
|
||||||
|
# Async
|
||||||
|
|
||||||
|
Effect View components run synchronously by default. Apply `Async.async` when a
|
||||||
|
component must wait for an asynchronous Effect before it can return JSX. The
|
||||||
|
component suspends while the Effect runs and accepts React Suspense props such
|
||||||
|
as `fallback`.
|
||||||
|
|
||||||
|
```tsx title="src/UserCard.tsx"
|
||||||
|
import { Effect } from "effect"
|
||||||
|
import { Async, Component } from "effect-view"
|
||||||
|
import { loadUser } from "./api"
|
||||||
|
|
||||||
|
export const UserCard = Component.make("UserCard")(
|
||||||
|
function* ({ userId }: { readonly userId: string }) {
|
||||||
|
const user = yield* Component.useOnChange(
|
||||||
|
() => loadUser(userId),
|
||||||
|
[userId],
|
||||||
|
)
|
||||||
|
|
||||||
|
return <article>{user.name}</article>
|
||||||
|
},
|
||||||
|
).pipe(Async.async)
|
||||||
|
```
|
||||||
|
|
||||||
|
Pass a fallback when rendering the component:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
const User = yield* UserCard.use
|
||||||
|
|
||||||
|
return <User userId="123" fallback={<p>Loading user...</p>} />
|
||||||
|
```
|
||||||
|
|
||||||
|
Or configure a default fallback once:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
export const UserCard = Component.make("UserCard")(
|
||||||
|
function* ({ userId }: { readonly userId: string }) {
|
||||||
|
const user = yield* Component.useOnChange(
|
||||||
|
() => loadUser(userId),
|
||||||
|
[userId],
|
||||||
|
)
|
||||||
|
|
||||||
|
return <article>{user.name}</article>
|
||||||
|
},
|
||||||
|
).pipe(
|
||||||
|
Async.async,
|
||||||
|
Async.withOptions({ defaultFallback: <p>Loading user...</p> }),
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Hook ordering
|
||||||
|
|
||||||
|
**Important:** Do not use React hooks or Effect View hook helpers after an
|
||||||
|
asynchronous computation in the component body. After the computation suspends,
|
||||||
|
the generator continuation runs outside React's synchronous render phase.
|
||||||
|
|
||||||
|
Place every hook before the first operation that may suspend:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import { useState } from "react"
|
||||||
|
|
||||||
|
const UserCard = Component.make("UserCard")(
|
||||||
|
function* ({ userId }: { readonly userId: string }) {
|
||||||
|
// Hooks and hook helpers go before asynchronous work.
|
||||||
|
const [showDetails, setShowDetails] = useState(false)
|
||||||
|
|
||||||
|
// This may suspend, so no hooks may be used after it.
|
||||||
|
const user = yield* Component.useOnChange(
|
||||||
|
() => loadUser(userId),
|
||||||
|
[userId],
|
||||||
|
)
|
||||||
|
|
||||||
|
return (
|
||||||
|
<article>
|
||||||
|
<button onClick={() => setShowDetails((value) => !value)}>
|
||||||
|
{user.name}
|
||||||
|
</button>
|
||||||
|
{showDetails && <p>{user.bio}</p>}
|
||||||
|
</article>
|
||||||
|
)
|
||||||
|
},
|
||||||
|
).pipe(Async.async)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Memoization
|
||||||
|
|
||||||
|
An async computation starts whenever its component renders. Apply
|
||||||
|
`Memoized.memoized` after `Async.async` to prevent an unrelated parent render
|
||||||
|
from restarting an async child whose props have not changed:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import { Async, Component, Memoized } from "effect-view"
|
||||||
|
|
||||||
|
export const UserCard = Component.make("UserCard")(
|
||||||
|
function* ({ userId }: { readonly userId: string }) {
|
||||||
|
const user = yield* Component.useOnChange(
|
||||||
|
() => loadUser(userId),
|
||||||
|
[userId],
|
||||||
|
)
|
||||||
|
|
||||||
|
return <article>{user.name}</article>
|
||||||
|
},
|
||||||
|
).pipe(
|
||||||
|
Async.async,
|
||||||
|
Memoized.memoized,
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
Async components compare props with `Object.is` by default and ignore the
|
||||||
|
`fallback` prop during that comparison. A changed `userId` renders the child
|
||||||
|
again, closes the previous dependency scope, and runs `loadUser` for the new
|
||||||
|
value.
|
||||||
|
|
||||||
|
If props contain immutable objects or arrays that may be recreated with the same
|
||||||
|
content, use `Equal.asEquivalence()` for full structural equality:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import { Equal } from "effect"
|
||||||
|
import { Async, Component, Memoized } from "effect-view"
|
||||||
|
|
||||||
|
export const UserCard = Component.make("UserCard")(
|
||||||
|
function* (props: { readonly user: { readonly id: string } }) {
|
||||||
|
const details = yield* Component.useOnChange(
|
||||||
|
() => loadUser(props.user.id),
|
||||||
|
[props.user.id],
|
||||||
|
)
|
||||||
|
|
||||||
|
return <article>{details.name}</article>
|
||||||
|
},
|
||||||
|
).pipe(
|
||||||
|
Async.async,
|
||||||
|
Memoized.memoized,
|
||||||
|
Memoized.withOptions({
|
||||||
|
propsEquivalence: Equal.asEquivalence(),
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
Supplying `propsEquivalence` replaces the async component's default comparison,
|
||||||
|
so `fallback` is also included in this structural comparison.
|
||||||
+139
-121
@@ -52,6 +52,14 @@ valid decoded value should go:
|
|||||||
| `MutationForm` | Yes | It is passed to a mutation when `submit` runs. |
|
| `MutationForm` | Yes | It is passed to a mutation when `submit` runs. |
|
||||||
| `LensForm` | Yes | It is written automatically to a target `Lens`. |
|
| `LensForm` | Yes | It is written automatically to a target `Lens`. |
|
||||||
|
|
||||||
|
## Create forms once
|
||||||
|
|
||||||
|
`MutationForm.service` and `LensForm.service` are Effect constructors, not
|
||||||
|
hooks. Create each root form once and keep it stable. For a component-owned
|
||||||
|
form, call the constructor inside `Component.useOnMount`; for a form shared by
|
||||||
|
multiple components, create it in an Effect service. Update the existing form's
|
||||||
|
Lenses rather than reconstructing the form during render.
|
||||||
|
|
||||||
## MutationForm: validate, then submit
|
## MutationForm: validate, then submit
|
||||||
|
|
||||||
Use `MutationForm` for registration, checkout, search, and other workflows with
|
Use `MutationForm` for registration, checkout, search, and other workflows with
|
||||||
@@ -102,9 +110,9 @@ mutation receives the schema's decoded profile, so `profile.age` is a number.
|
|||||||
Schema transformations happen before the mutation and schema issues prevent an
|
Schema transformations happen before the mutation and schema issues prevent an
|
||||||
invalid draft from being submitted.
|
invalid draft from being submitted.
|
||||||
|
|
||||||
`MutationForm.service` also starts initial validation in the current scope. Use
|
`MutationForm.service` also starts initial validation in the current scope. In
|
||||||
it inside `Component.useOnMount`, a scoped service, or another Effect scope so
|
the example above, `Component.useOnMount` keeps that validation and the form's
|
||||||
its validation and mutation work is cleaned up with its owner.
|
mutation work tied to the component that owns them.
|
||||||
|
|
||||||
## LensForm: validate, then synchronize
|
## LensForm: validate, then synchronize
|
||||||
|
|
||||||
@@ -163,124 +171,6 @@ Pass `initialEncodedValue` only when the first draft should differ from the
|
|||||||
encoded target. Otherwise `LensForm.service` obtains the initial draft by
|
encoded target. Otherwise `LensForm.service` obtains the initial draft by
|
||||||
encoding the target through the schema.
|
encoding the target through the schema.
|
||||||
|
|
||||||
## Example: local date input, UTC domain value
|
|
||||||
|
|
||||||
The encoded/decoded distinction is especially useful for dates. An HTML
|
|
||||||
`datetime-local` input produces a wall-clock string such as
|
|
||||||
`"2026-07-22T14:30"`. It contains no time-zone or UTC offset, while application
|
|
||||||
state and APIs usually need an unambiguous UTC instant.
|
|
||||||
|
|
||||||
A schema can own that entire conversion. The following schema interprets the
|
|
||||||
input in the current time zone and decodes it to `DateTime.Utc`:
|
|
||||||
|
|
||||||
```tsx title="src/DateTimeUtcFromZonedInput.ts"
|
|
||||||
import { DateTime, Effect, Option, ParseResult, Schema } from "effect"
|
|
||||||
|
|
||||||
class DateTimeUtcFromZoned extends Schema.transformOrFail(
|
|
||||||
Schema.DateTimeZonedFromSelf,
|
|
||||||
Schema.DateTimeUtcFromSelf,
|
|
||||||
{
|
|
||||||
strict: true,
|
|
||||||
decode: (input) => ParseResult.succeed(DateTime.toUtc(input)),
|
|
||||||
encode: DateTime.setZoneCurrent,
|
|
||||||
},
|
|
||||||
) {}
|
|
||||||
|
|
||||||
export class DateTimeUtcFromZonedInput extends Schema.transformOrFail(
|
|
||||||
Schema.String,
|
|
||||||
DateTimeUtcFromZoned,
|
|
||||||
{
|
|
||||||
strict: true,
|
|
||||||
decode: (input, _options, ast) =>
|
|
||||||
Effect.flatMap(DateTime.CurrentTimeZone, (timeZone) =>
|
|
||||||
Option.match(
|
|
||||||
DateTime.makeZoned(input, {
|
|
||||||
timeZone,
|
|
||||||
adjustForTimeZone: true,
|
|
||||||
}),
|
|
||||||
{
|
|
||||||
onSome: ParseResult.succeed,
|
|
||||||
onNone: () =>
|
|
||||||
ParseResult.fail(
|
|
||||||
new ParseResult.Type(
|
|
||||||
ast,
|
|
||||||
input,
|
|
||||||
"Enter a valid date and time",
|
|
||||||
),
|
|
||||||
),
|
|
||||||
},
|
|
||||||
),
|
|
||||||
),
|
|
||||||
encode: (value) =>
|
|
||||||
ParseResult.succeed(
|
|
||||||
DateTime.formatIsoZoned(value).slice(0, 16),
|
|
||||||
),
|
|
||||||
},
|
|
||||||
) {}
|
|
||||||
```
|
|
||||||
|
|
||||||
Use it like any other field schema. The form and input work with a string, but
|
|
||||||
the mutation receives UTC:
|
|
||||||
|
|
||||||
```tsx
|
|
||||||
import { DateTime, Effect, Schema } from "effect"
|
|
||||||
import { Component, Form, MutationForm, View } from "effect-view"
|
|
||||||
import { DateTimeUtcFromZonedInput } from "./DateTimeUtcFromZonedInput"
|
|
||||||
|
|
||||||
const AppointmentSchema = Schema.Struct({
|
|
||||||
startsAt: DateTimeUtcFromZonedInput,
|
|
||||||
})
|
|
||||||
|
|
||||||
const AppointmentView = Component.make("Appointment")(function* () {
|
|
||||||
const [form, startsAtField] = yield* Component.useOnMount(() =>
|
|
||||||
Effect.gen(function* () {
|
|
||||||
const form = yield* MutationForm.service({
|
|
||||||
schema: AppointmentSchema,
|
|
||||||
initialEncodedValue: { startsAt: "" },
|
|
||||||
f: ([appointment]) =>
|
|
||||||
Effect.log(
|
|
||||||
`Saving ${DateTime.formatIso(appointment.startsAt)}`,
|
|
||||||
),
|
|
||||||
})
|
|
||||||
|
|
||||||
return [form, Form.focusObjectOn(form, "startsAt")] as const
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
const startsAt = yield* Form.useInput(startsAtField)
|
|
||||||
const [canCommit] = yield* View.useAll([form.canCommit])
|
|
||||||
const runPromise = yield* Component.useRunPromise()
|
|
||||||
|
|
||||||
return (
|
|
||||||
<form
|
|
||||||
onSubmit={(event) => {
|
|
||||||
event.preventDefault()
|
|
||||||
void runPromise(form.submit)
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<input
|
|
||||||
type="datetime-local"
|
|
||||||
value={startsAt.value}
|
|
||||||
onChange={(event) =>
|
|
||||||
startsAt.setValue(event.currentTarget.value)
|
|
||||||
}
|
|
||||||
/>
|
|
||||||
<button disabled={!canCommit}>Save appointment</button>
|
|
||||||
</form>
|
|
||||||
)
|
|
||||||
})
|
|
||||||
```
|
|
||||||
|
|
||||||
The schema requires `DateTime.CurrentTimeZone`; provide
|
|
||||||
`DateTime.layerCurrentZoneLocal` in the application runtime. If the current
|
|
||||||
zone is `Europe/Paris`, for example, entering `2026-07-22T14:30` decodes to the
|
|
||||||
UTC instant `2026-07-22T12:30:00.000Z`.
|
|
||||||
|
|
||||||
Encoding works in the other direction. A `LensForm` whose target contains that
|
|
||||||
UTC instant presents `2026-07-22T14:30` to the local input. The component never
|
|
||||||
manually parses dates, applies offsets, or maintains a second representation;
|
|
||||||
the schema defines both directions and the form keeps them synchronized.
|
|
||||||
|
|
||||||
## Focus into subforms
|
## Focus into subforms
|
||||||
|
|
||||||
The root `MutationForm` or `LensForm` represents the complete schema. UI
|
The root `MutationForm` or `LensForm` represents the complete schema. UI
|
||||||
@@ -300,6 +190,16 @@ const contactForm = Form.focusObjectOn(form, "contact")
|
|||||||
const emailField = Form.focusObjectOn(contactForm, "email")
|
const emailField = Form.focusObjectOn(contactForm, "email")
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Form focus helpers also have a dual API. Pass only the key or index to get a curried function. Curried helpers can be chained
|
||||||
|
with `pipe` to focus through a deeper path:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
const emailField = form.pipe(
|
||||||
|
Form.focusObjectOn("contact"),
|
||||||
|
Form.focusObjectOn("email"),
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
`displayNameField`, `ageField`, and `emailField` can each be passed to the input
|
`displayNameField`, `ageField`, and `emailField` can each be passed to the input
|
||||||
component responsible for that field. Focusing can also be repeated:
|
component responsible for that field. Focusing can also be repeated:
|
||||||
`contactForm` represents the complete contact section, and `emailField`
|
`contactForm` represents the complete contact section, and `emailField`
|
||||||
@@ -455,3 +355,121 @@ They expose the schema pipeline as reactive Lenses and Views:
|
|||||||
The form model itself is Effect code. Effect View adds the React-facing hooks,
|
The form model itself is Effect code. Effect View adds the React-facing hooks,
|
||||||
including `Form.useInput` and `Form.useOptionalInput`, while your own component
|
including `Form.useInput` and `Form.useOptionalInput`, while your own component
|
||||||
library remains responsible for rendering controls and layout.
|
library remains responsible for rendering controls and layout.
|
||||||
|
|
||||||
|
## Example: local date input, UTC domain value
|
||||||
|
|
||||||
|
The encoded/decoded distinction is especially useful for dates. An HTML
|
||||||
|
`datetime-local` input produces a wall-clock string such as
|
||||||
|
`"2026-07-22T14:30"`. It contains no time-zone or UTC offset, while application
|
||||||
|
state and APIs usually need an unambiguous UTC instant.
|
||||||
|
|
||||||
|
A schema can own that entire conversion. The following schema interprets the
|
||||||
|
input in the current time zone and decodes it to `DateTime.Utc`:
|
||||||
|
|
||||||
|
```tsx title="src/DateTimeUtcFromZonedInput.ts"
|
||||||
|
import { DateTime, Effect, Option, ParseResult, Schema } from "effect"
|
||||||
|
|
||||||
|
class DateTimeUtcFromZoned extends Schema.transformOrFail(
|
||||||
|
Schema.DateTimeZonedFromSelf,
|
||||||
|
Schema.DateTimeUtcFromSelf,
|
||||||
|
{
|
||||||
|
strict: true,
|
||||||
|
decode: (input) => ParseResult.succeed(DateTime.toUtc(input)),
|
||||||
|
encode: DateTime.setZoneCurrent,
|
||||||
|
},
|
||||||
|
) {}
|
||||||
|
|
||||||
|
export class DateTimeUtcFromZonedInput extends Schema.transformOrFail(
|
||||||
|
Schema.String,
|
||||||
|
DateTimeUtcFromZoned,
|
||||||
|
{
|
||||||
|
strict: true,
|
||||||
|
decode: (input, _options, ast) =>
|
||||||
|
Effect.flatMap(DateTime.CurrentTimeZone, (timeZone) =>
|
||||||
|
Option.match(
|
||||||
|
DateTime.makeZoned(input, {
|
||||||
|
timeZone,
|
||||||
|
adjustForTimeZone: true,
|
||||||
|
}),
|
||||||
|
{
|
||||||
|
onSome: ParseResult.succeed,
|
||||||
|
onNone: () =>
|
||||||
|
ParseResult.fail(
|
||||||
|
new ParseResult.Type(
|
||||||
|
ast,
|
||||||
|
input,
|
||||||
|
"Enter a valid date and time",
|
||||||
|
),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
),
|
||||||
|
),
|
||||||
|
encode: (value) =>
|
||||||
|
ParseResult.succeed(
|
||||||
|
DateTime.formatIsoZoned(value).slice(0, 16),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
) {}
|
||||||
|
```
|
||||||
|
|
||||||
|
Use it like any other field schema. The form and input work with a string, but
|
||||||
|
the mutation receives UTC:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import { DateTime, Effect, Schema } from "effect"
|
||||||
|
import { Component, Form, MutationForm, View } from "effect-view"
|
||||||
|
import { DateTimeUtcFromZonedInput } from "./DateTimeUtcFromZonedInput"
|
||||||
|
|
||||||
|
const AppointmentSchema = Schema.Struct({
|
||||||
|
startsAt: DateTimeUtcFromZonedInput,
|
||||||
|
})
|
||||||
|
|
||||||
|
const AppointmentView = Component.make("Appointment")(function* () {
|
||||||
|
const [form, startsAtField] = yield* Component.useOnMount(() =>
|
||||||
|
Effect.gen(function* () {
|
||||||
|
const form = yield* MutationForm.service({
|
||||||
|
schema: AppointmentSchema,
|
||||||
|
initialEncodedValue: { startsAt: "" },
|
||||||
|
f: ([appointment]) =>
|
||||||
|
Effect.log(
|
||||||
|
`Saving ${DateTime.formatIso(appointment.startsAt)}`,
|
||||||
|
),
|
||||||
|
})
|
||||||
|
|
||||||
|
return [form, Form.focusObjectOn(form, "startsAt")] as const
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
|
||||||
|
const startsAt = yield* Form.useInput(startsAtField)
|
||||||
|
const [canCommit] = yield* View.useAll([form.canCommit])
|
||||||
|
const runPromise = yield* Component.useRunPromise()
|
||||||
|
|
||||||
|
return (
|
||||||
|
<form
|
||||||
|
onSubmit={(event) => {
|
||||||
|
event.preventDefault()
|
||||||
|
void runPromise(form.submit)
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<input
|
||||||
|
type="datetime-local"
|
||||||
|
value={startsAt.value}
|
||||||
|
onChange={(event) =>
|
||||||
|
startsAt.setValue(event.currentTarget.value)
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
<button disabled={!canCommit}>Save appointment</button>
|
||||||
|
</form>
|
||||||
|
)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
The schema requires `DateTime.CurrentTimeZone`; provide
|
||||||
|
`DateTime.layerCurrentZoneLocal` in the application runtime. If the current
|
||||||
|
zone is `Europe/Paris`, for example, entering `2026-07-22T14:30` decodes to the
|
||||||
|
UTC instant `2026-07-22T12:30:00.000Z`.
|
||||||
|
|
||||||
|
Encoding works in the other direction. A `LensForm` whose target contains that
|
||||||
|
UTC instant presents `2026-07-22T14:30` to the local input. The component never
|
||||||
|
manually parses dates, applies offsets, or maintains a second representation;
|
||||||
|
the schema defines both directions and the form keeps them synchronized.
|
||||||
|
|||||||
@@ -35,6 +35,33 @@ Effect View is not tied to React DOM. For React Native or another renderer,
|
|||||||
install that renderer instead of `react-dom` and keep the rest of the setup the
|
install that renderer instead of `react-dom` and keep the rest of the setup the
|
||||||
same.
|
same.
|
||||||
|
|
||||||
|
## Set up hot reloading with Vite
|
||||||
|
|
||||||
|
Install the Effect View Vite plugin to preserve component state while editing
|
||||||
|
Effect View components:
|
||||||
|
|
||||||
|
```bash npm2yarn
|
||||||
|
npm install --save-dev @effect-view/vite-plugin
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `effectView()` before the React plugin in your Vite configuration:
|
||||||
|
|
||||||
|
```ts title="vite.config.ts"
|
||||||
|
import { effectView } from "@effect-view/vite-plugin"
|
||||||
|
import react from "@vitejs/plugin-react"
|
||||||
|
import { defineConfig } from "vite"
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
plugins: [
|
||||||
|
effectView(),
|
||||||
|
react(),
|
||||||
|
],
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
Vite is the only bundler supported for Effect View hot reloading at the moment.
|
||||||
|
Support for other bundlers will follow.
|
||||||
|
|
||||||
## Create the runtime
|
## Create the runtime
|
||||||
|
|
||||||
`ReactRuntime` owns a managed Effect runtime. Define it at module scope from the
|
`ReactRuntime` owns a managed Effect runtime. Define it at module scope from the
|
||||||
@@ -172,51 +199,25 @@ to provide local services to a subtree.
|
|||||||
|
|
||||||
## Synchronous and asynchronous components
|
## Synchronous and asynchronous components
|
||||||
|
|
||||||
A regular Effect View component runs its body during React render. That Effect
|
A regular Effect View component runs its body during React render. Effects
|
||||||
must complete synchronously: yielding a service, reading synchronous state, or
|
executed directly by that body—including setup passed to `useOnMount`,
|
||||||
creating a scoped object is fine; sleeping, fetching, or awaiting a promise is
|
`useOnChange`, or `useLayer`—must complete synchronously every time they run.
|
||||||
not.
|
Yielding services and reading synchronous state is fine; sleeping, fetching, or
|
||||||
|
awaiting a promise is not.
|
||||||
|
|
||||||
Use `Async.async` when render genuinely depends on an asynchronous Effect. The
|
Choose the integration that matches the asynchronous work:
|
||||||
component then suspends and accepts React Suspense props such as `fallback`:
|
|
||||||
|
|
||||||
```tsx title="src/UserView.tsx"
|
- Make the component asynchronous with [`Async.async`](./async) when it must
|
||||||
import { Async, Component, Memoized } from "effect-view"
|
wait for a one-off asynchronous Effect before producing JSX. The component
|
||||||
import { loadUser } from "./api"
|
suspends while it waits.
|
||||||
|
- Use [Query](./query) for server reads that need caching, sharing, refresh, or
|
||||||
export const UserView = Component.make("UserView")(
|
invalidation.
|
||||||
function* (props: { readonly userId: string }) {
|
- Use [Mutation](./mutation) for user-triggered writes with observable pending
|
||||||
const user = yield* Component.useOnChange(
|
and error state.
|
||||||
() => loadUser(props.userId),
|
- Use `useRunPromise` or `useCallbackPromise` for asynchronous event work that
|
||||||
[props.userId],
|
does not need Mutation state.
|
||||||
)
|
- Use a post-commit hook with a scoped fiber for subscriptions or background
|
||||||
|
work tied to the component lifecycle.
|
||||||
return <h2>{user.name}</h2>
|
|
||||||
},
|
|
||||||
).pipe(
|
|
||||||
Async.async,
|
|
||||||
Async.withOptions({ defaultFallback: <p>Loading user...</p> }),
|
|
||||||
Memoized.memoized,
|
|
||||||
)
|
|
||||||
```
|
|
||||||
|
|
||||||
Use it from an Effect View parent in the usual way:
|
|
||||||
|
|
||||||
```tsx
|
|
||||||
const User = yield* UserView.use
|
|
||||||
|
|
||||||
return <User userId={selectedUserId} />
|
|
||||||
```
|
|
||||||
|
|
||||||
`Memoized.memoized` prevents an unrelated parent re-render from restarting an
|
|
||||||
async child whose props have not changed. A changed `userId` creates a new
|
|
||||||
dependency scope, cleans up the previous one, and runs `loadUser` again.
|
|
||||||
|
|
||||||
An async component's rejected Effect is handled by the nearest React error
|
|
||||||
boundary. Suspense handles waiting, not failures.
|
|
||||||
|
|
||||||
For server data that should be cached, refreshed, and shared, prefer the
|
|
||||||
[Query module](./query) over a raw async component.
|
|
||||||
|
|
||||||
## Use Effect services
|
## Use Effect services
|
||||||
|
|
||||||
@@ -294,24 +295,25 @@ const ResourceView = Component.make("Resource")(function* () {
|
|||||||
with the context already available in the component body, so the resource above
|
with the context already available in the component body, so the resource above
|
||||||
is owned by the component's root scope.
|
is owned by the component's root scope.
|
||||||
|
|
||||||
`useOnChange`, `useReactEffect`, and `useReactLayoutEffect` each create a scope
|
`useOnChange`, `useReactEffect`, and `useReactLayoutEffect` each manage their
|
||||||
that can be replaced without closing the component root scope.
|
own resources. When their dependencies change, those resources are cleaned up
|
||||||
|
and recreated while the rest of the component remains active.
|
||||||
|
|
||||||
The main lifecycle choices are:
|
The main lifecycle choices are:
|
||||||
|
|
||||||
| Hook | What it does | Scope seen by setup | Scope closes when |
|
| Hook | What it does | Scope seen by setup | Scope closes when |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| Component body | Produces the component's rendered value | Component root scope | The component unmounts |
|
| Component body | Produces the component's rendered value | Component root scope | The component unmounts |
|
||||||
| `useOnMount` | Computes and caches a value for the component instance | The same component root scope | The component unmounts |
|
| `useOnMount` | Computes and caches a value for the component instance | Component root scope | The component unmounts |
|
||||||
| `useOnChange` | Recomputes a cached value when dependencies change | A new dependency scope | Dependencies change or the component unmounts |
|
| `useOnChange` | Recomputes a cached value when dependencies change | A new dependency scope | Dependencies change or the component unmounts |
|
||||||
| `useReactEffect` | Runs a post-commit side effect | A new effect scope | Dependencies change or the component unmounts |
|
| `useReactEffect` | Runs a post-commit side effect | A new effect scope | Dependencies change or the component unmounts |
|
||||||
| `useReactLayoutEffect` | Runs a layout effect before the browser paints | A new layout-effect scope | Dependencies change or the component unmounts |
|
| `useReactLayoutEffect` | Runs a layout effect before the browser paints | A new layout-effect scope | Dependencies change or the component unmounts |
|
||||||
| `useLayer` | Builds and provides a layer context | A dependency scope created through `useOnChange` | The layer reference changes or the component unmounts |
|
| `useLayer` | Builds and provides a layer context | A new scope tied to the current layer reference | The layer reference changes or the component unmounts |
|
||||||
|
|
||||||
`useRunSync`, `useRunPromise`, `useCallbackSync`, and `useCallbackPromise` do
|
`useRunSync` and `useRunPromise` do not create a new scope. The runner they
|
||||||
not create lifecycle scopes either. They capture the component context, so an
|
return includes the component root scope in its context by default.
|
||||||
Effect invoked through them sees the component root scope unless it explicitly
|
`useCallbackSync` and `useCallbackPromise` similarly capture the component
|
||||||
provides another one.
|
context required by their Effect.
|
||||||
|
|
||||||
### useOnMount
|
### useOnMount
|
||||||
|
|
||||||
@@ -409,6 +411,21 @@ Use `Component.useRunSync` only for Effects known to complete synchronously.
|
|||||||
Use `Component.useRunPromise` for Effects that may suspend, sleep, fetch, or
|
Use `Component.useRunPromise` for Effects that may suspend, sleep, fetch, or
|
||||||
otherwise continue asynchronously.
|
otherwise continue asynchronously.
|
||||||
|
|
||||||
|
Both runners provide `Scope.Scope` by default, so they can run scoped Effects
|
||||||
|
without a type argument. When an Effect also requires application services,
|
||||||
|
declare the complete runner context explicitly:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import { Scope } from "effect"
|
||||||
|
|
||||||
|
const runPromise = yield* Component.useRunPromise<
|
||||||
|
Scope.Scope | UserRepository
|
||||||
|
>()
|
||||||
|
```
|
||||||
|
|
||||||
|
The resulting runner accepts Effects that require the component scope,
|
||||||
|
`UserRepository`, or both.
|
||||||
|
|
||||||
When a callback is passed to a memoized child or used as a dependency, use the
|
When a callback is passed to a memoized child or used as a dependency, use the
|
||||||
callback variants to preserve its identity:
|
callback variants to preserve its identity:
|
||||||
|
|
||||||
|
|||||||
@@ -30,6 +30,11 @@ Create a mutation in a component scope with `Mutation.make`. Its function can
|
|||||||
be any Effect, including one that requires services from the application
|
be any Effect, including one that requires services from the application
|
||||||
runtime:
|
runtime:
|
||||||
|
|
||||||
|
`Mutation.make` is an Effect constructor, not a hook. Create each mutation
|
||||||
|
instance once and keep it stable instead of calling `Mutation.make` again on
|
||||||
|
every render. Use `Component.useOnMount` for a component-owned mutation or
|
||||||
|
create it in an Effect service when it should be shared.
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
import { Effect } from "effect"
|
import { Effect } from "effect"
|
||||||
import { AsyncResult } from "effect/unstable/reactivity"
|
import { AsyncResult } from "effect/unstable/reactivity"
|
||||||
|
|||||||
@@ -35,7 +35,6 @@ application runtime once, alongside the services used by your query effects:
|
|||||||
|
|
||||||
```tsx title="src/runtime.ts"
|
```tsx title="src/runtime.ts"
|
||||||
import { Layer } from "effect"
|
import { Layer } from "effect"
|
||||||
import { FetchHttpClient } from "effect/unstable/http"
|
|
||||||
import { QueryClient, ReactRuntime } from "effect-view"
|
import { QueryClient, ReactRuntime } from "effect-view"
|
||||||
|
|
||||||
const AppLive = Layer.empty.pipe(
|
const AppLive = Layer.empty.pipe(
|
||||||
@@ -44,7 +43,6 @@ const AppLive = Layer.empty.pipe(
|
|||||||
defaultRefreshOnWindowFocus: true,
|
defaultRefreshOnWindowFocus: true,
|
||||||
cacheGcTime: "5 minutes",
|
cacheGcTime: "5 minutes",
|
||||||
})),
|
})),
|
||||||
Layer.provideMerge(FetchHttpClient.layer),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
export const runtime = ReactRuntime.make(AppLive)
|
export const runtime = ReactRuntime.make(AppLive)
|
||||||
@@ -52,7 +50,9 @@ export const runtime = ReactRuntime.make(AppLive)
|
|||||||
|
|
||||||
The client owns the cache and its cleanup lifecycle. Individual queries can
|
The client owns the cache and its cleanup lifecycle. Individual queries can
|
||||||
override `staleTime` and `refreshOnWindowFocus`; otherwise they inherit the
|
override `staleTime` and `refreshOnWindowFocus`; otherwise they inherit the
|
||||||
client defaults.
|
client defaults. Window-focus refresh also requires the optional
|
||||||
|
`@effect/platform-browser` package, as described under
|
||||||
|
[Staleness and cache lifetime](#staleness-and-cache-lifetime).
|
||||||
|
|
||||||
## Create a reactive query
|
## Create a reactive query
|
||||||
|
|
||||||
@@ -60,6 +60,12 @@ A query is driven by a `View` rather than by a value read during one React
|
|||||||
render. Whenever that key changes, `Query.service` checks the cache and starts
|
render. Whenever that key changes, `Query.service` checks the cache and starts
|
||||||
the query effect when necessary.
|
the query effect when necessary.
|
||||||
|
|
||||||
|
`Query.service` is an Effect constructor, not a hook. Create each query instance
|
||||||
|
once and keep it stable. In a component, the usual place is
|
||||||
|
`Component.useOnMount`; a query shared by multiple components can instead be
|
||||||
|
owned by an Effect service. Change the existing query's reactive key rather
|
||||||
|
than reconstructing the query during render.
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
import { Effect, Schema, SubscriptionRef } from "effect"
|
import { Effect, Schema, SubscriptionRef } from "effect"
|
||||||
import { HttpClient } from "effect/unstable/http"
|
import { HttpClient } from "effect/unstable/http"
|
||||||
@@ -118,9 +124,9 @@ Effect equality by default, so structurally equal Effect data types work well
|
|||||||
as query keys. Supply `keyEquivalence` when the key needs different equality
|
as query keys. Supply `keyEquivalence` when the key needs different equality
|
||||||
semantics.
|
semantics.
|
||||||
|
|
||||||
`Query.service` creates the query and starts watching its key in the current
|
`Query.service` starts watching its key in the current scope. The
|
||||||
scope. Creating it in `Component.useOnMount` keeps one query instance—and one
|
`Component.useOnMount` call above keeps both the query instance and its query
|
||||||
stable query function identity—for the component's lifetime.
|
function identity stable for the component's lifetime.
|
||||||
|
|
||||||
## Render AsyncResult
|
## Render AsyncResult
|
||||||
|
|
||||||
@@ -264,8 +270,17 @@ const query = yield* Query.service({
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
Window focus resolves the current key again, subject to the same freshness
|
Window-focus refresh depends on the optional `@effect/platform-browser`
|
||||||
check. The browser integration is ignored in non-browser environments.
|
integration. Install it in browser applications that use this behavior:
|
||||||
|
|
||||||
|
```bash npm2yarn
|
||||||
|
npm install @effect/platform-browser@beta
|
||||||
|
```
|
||||||
|
|
||||||
|
When the package is available, focusing the window resolves the current key
|
||||||
|
again, subject to the same freshness check. Without it,
|
||||||
|
`refreshOnWindowFocus` has no effect; the rest of the Query API continues to
|
||||||
|
work normally. The integration is also ignored in non-browser environments.
|
||||||
|
|
||||||
## The Effect touch
|
## The Effect touch
|
||||||
|
|
||||||
|
|||||||
@@ -12,9 +12,9 @@ subscribe to changes, and write updates back to the underlying source. A Lens
|
|||||||
can point at a whole state object or focus on one nested field inside it.
|
can point at a whole state object or focus on one nested field inside it.
|
||||||
|
|
||||||
`effect-view` re-exports the `Lens` and `View` modules from
|
`effect-view` re-exports the `Lens` and `View` modules from
|
||||||
[`effect-lens`](https://github.com/Thiladev/effect-lens) for convenience. The
|
[`effect-lens`](https://www.npmjs.com/package/effect-lens/v/beta) for convenience. The
|
||||||
core data model and transformation APIs belong to `effect-lens`, so check the
|
core data model and transformation APIs belong to `effect-lens`, so check the
|
||||||
[`effect-lens` documentation](https://github.com/Thiladev/effect-lens/tree/master/packages/effect-lens) for the full Lens/View API.
|
[`effect-lens` documentation](https://www.npmjs.com/package/effect-lens/v/beta) for the full Lens/View API.
|
||||||
|
|
||||||
The usual pattern is to create state with Effect primitives such as
|
The usual pattern is to create state with Effect primitives such as
|
||||||
`SubscriptionRef`, turn that primitive into a Lens with a matching constructor
|
`SubscriptionRef`, turn that primitive into a Lens with a matching constructor
|
||||||
@@ -219,15 +219,16 @@ interface UserProfile {
|
|||||||
readonly name: string
|
readonly name: string
|
||||||
readonly email: string
|
readonly email: string
|
||||||
readonly role: string
|
readonly role: string
|
||||||
|
readonly contact: {
|
||||||
|
readonly address: {
|
||||||
|
readonly city: string
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class ProfileState extends Context.Service<
|
class ProfileState extends Context.Service<
|
||||||
ProfileState,
|
ProfileState,
|
||||||
{
|
{ readonly profile: Lens.Lens<UserProfile> }
|
||||||
readonly profile: Lens.Lens<UserProfile>
|
|
||||||
readonly name: Lens.Lens<string>
|
|
||||||
readonly role: Lens.Lens<string>
|
|
||||||
}
|
|
||||||
>()("ProfileState") {
|
>()("ProfileState") {
|
||||||
static readonly layer = Layer.effect(
|
static readonly layer = Layer.effect(
|
||||||
ProfileState,
|
ProfileState,
|
||||||
@@ -237,20 +238,35 @@ class ProfileState extends Context.Service<
|
|||||||
name: "",
|
name: "",
|
||||||
email: "",
|
email: "",
|
||||||
role: "reader",
|
role: "reader",
|
||||||
|
contact: {
|
||||||
|
address: {
|
||||||
|
city: "",
|
||||||
|
},
|
||||||
|
},
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
const name = Lens.focusObjectOn(profile, "name")
|
|
||||||
const role = Lens.focusObjectOn(profile, "role")
|
|
||||||
|
|
||||||
return { profile, name, role } as const
|
return { profile } as const
|
||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
const ProfileNameView = Component.make("ProfileName")(function*() {
|
const ProfileNameView = Component.make("ProfileName")(function*() {
|
||||||
const state = yield* ProfileState
|
const state = yield* ProfileState
|
||||||
const [name, setName] = yield* Lens.useState(state.name)
|
const [nameLens, roleLens, cityLens] = yield* Component.useOnMount(() =>
|
||||||
const [role] = yield* View.useAll([state.role])
|
Effect.succeed([
|
||||||
|
Lens.focusObjectOn(state.profile, "name"),
|
||||||
|
Lens.focusObjectOn(state.profile, "role"),
|
||||||
|
state.profile.pipe(
|
||||||
|
Lens.focusObjectOn("contact"),
|
||||||
|
Lens.focusObjectOn("address"),
|
||||||
|
Lens.focusObjectOn("city"),
|
||||||
|
),
|
||||||
|
] as const),
|
||||||
|
)
|
||||||
|
|
||||||
|
const [name, setName] = yield* Lens.useState(nameLens)
|
||||||
|
const [role, city] = yield* View.useAll([roleLens, cityLens])
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<label>
|
<label>
|
||||||
@@ -260,15 +276,22 @@ const ProfileNameView = Component.make("ProfileName")(function*() {
|
|||||||
onChange={(event) => setName(event.currentTarget.value)}
|
onChange={(event) => setName(event.currentTarget.value)}
|
||||||
/>
|
/>
|
||||||
<span>Role: {role}</span>
|
<span>Role: {role}</span>
|
||||||
|
<span>City: {city}</span>
|
||||||
</label>
|
</label>
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
Updating the focused `name` Lens through `Lens.useState` updates the parent
|
The service owns only the root `profile` Lens. The component chooses the fields
|
||||||
`profile` Lens. The focused `role` Lens is only read, so it stays on the simpler
|
it needs, creates those focused Lenses once in `Component.useOnMount`, and
|
||||||
`View.useAll` path.
|
subscribes only to them. Updating `nameLens` through `Lens.useState` still
|
||||||
|
updates the parent `profile` Lens.
|
||||||
|
|
||||||
|
Lens focus helpers have a dual API. They can be called in data-first form, such
|
||||||
|
as `Lens.focusObjectOn(profile, "name")`, or in curried form with only the key
|
||||||
|
or index. The `cityLens` above uses the curried form with `pipe` to focus through
|
||||||
|
a deeper path without storing intermediate Lenses.
|
||||||
|
|
||||||
For focusing into nested state, deriving lenses, custom write behavior, and the
|
For focusing into nested state, deriving lenses, custom write behavior, and the
|
||||||
complete API, refer to the
|
complete API, refer to the
|
||||||
[`effect-lens` documentation](https://github.com/Thiladev/effect-lens/tree/master/packages/effect-lens).
|
[`effect-lens` documentation](https://www.npmjs.com/package/effect-lens/v/beta).
|
||||||
|
|||||||
@@ -46,11 +46,11 @@ const config: Config = {
|
|||||||
lastVersion: "current",
|
lastVersion: "current",
|
||||||
versions: {
|
versions: {
|
||||||
current: {
|
current: {
|
||||||
label: "effect-view v1",
|
label: "effect-view v0",
|
||||||
},
|
},
|
||||||
"effect-fc-1.0": {
|
"effect-fc-v0": {
|
||||||
label: "effect-fc 1.0",
|
label: "effect-fc v0",
|
||||||
path: "effect-fc/1.0",
|
path: "effect-fc/v0",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -84,6 +84,11 @@ const config: Config = {
|
|||||||
type: "docsVersionDropdown",
|
type: "docsVersionDropdown",
|
||||||
position: "right",
|
position: "right",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
href: "https://www.npmjs.com/package/effect-view",
|
||||||
|
label: "npm",
|
||||||
|
position: "right",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
href: "https://github.com/Thiladev/effect-view",
|
href: "https://github.com/Thiladev/effect-view",
|
||||||
label: "GitHub",
|
label: "GitHub",
|
||||||
|
|||||||
@@ -3,21 +3,25 @@
|
|||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
"lint:tsc": "tsc -b --noEmit",
|
||||||
|
"lint:biome": "biome lint",
|
||||||
"docusaurus": "docusaurus",
|
"docusaurus": "docusaurus",
|
||||||
"start": "docusaurus start",
|
"start": "docusaurus start",
|
||||||
"build": "docusaurus build",
|
"build": "docusaurus build --out-dir dist",
|
||||||
"swizzle": "docusaurus swizzle",
|
"swizzle": "docusaurus swizzle",
|
||||||
"deploy": "docusaurus deploy",
|
"deploy": "docusaurus deploy",
|
||||||
"clear": "docusaurus clear",
|
"clear": "docusaurus clear",
|
||||||
"serve": "docusaurus serve",
|
"serve": "docusaurus serve --dir dist",
|
||||||
"write-translations": "docusaurus write-translations",
|
"write-translations": "docusaurus write-translations",
|
||||||
"write-heading-ids": "docusaurus write-heading-ids",
|
"write-heading-ids": "docusaurus write-heading-ids",
|
||||||
"typecheck": "tsc"
|
"clean:cache": "rm -rf .turbo *.tsbuildinfo && docusaurus clear",
|
||||||
|
"clean:dist": "rm -rf dist",
|
||||||
|
"clean:modules": "rm -rf node_modules"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/core": "3.10.1",
|
"@docusaurus/core": "^3.10.2",
|
||||||
"@docusaurus/faster": "^3.10.1",
|
"@docusaurus/faster": "^3.10.2",
|
||||||
"@docusaurus/preset-classic": "3.10.1",
|
"@docusaurus/preset-classic": "^3.10.2",
|
||||||
"@mdx-js/react": "^3.1.1",
|
"@mdx-js/react": "^3.1.1",
|
||||||
"clsx": "^2.1.1",
|
"clsx": "^2.1.1",
|
||||||
"prism-react-renderer": "^2.4.1",
|
"prism-react-renderer": "^2.4.1",
|
||||||
@@ -25,9 +29,9 @@
|
|||||||
"react-dom": "^19.2.5"
|
"react-dom": "^19.2.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@docusaurus/module-type-aliases": "3.10.1",
|
"@docusaurus/module-type-aliases": "^3.10.2",
|
||||||
"@docusaurus/tsconfig": "3.10.1",
|
"@docusaurus/tsconfig": "^3.10.2",
|
||||||
"@docusaurus/types": "3.10.1",
|
"@docusaurus/types": "^3.10.2",
|
||||||
"@types/react": "^19.2.15",
|
"@types/react": "^19.2.15",
|
||||||
"@types/react-dom": "^19.2.3",
|
"@types/react-dom": "^19.2.3",
|
||||||
"typescript": "~6.0.3"
|
"typescript": "~6.0.3"
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ const sidebars: SidebarsConfig = {
|
|||||||
docsSidebar: [
|
docsSidebar: [
|
||||||
"getting-started",
|
"getting-started",
|
||||||
"state-management",
|
"state-management",
|
||||||
|
"async",
|
||||||
"query",
|
"query",
|
||||||
"mutation",
|
"mutation",
|
||||||
"forms",
|
"forms",
|
||||||
|
|||||||
@@ -72,9 +72,15 @@
|
|||||||
letter-spacing: -0.075em;
|
letter-spacing: -0.075em;
|
||||||
line-height: 0.92;
|
line-height: 0.92;
|
||||||
margin: 0;
|
margin: 0;
|
||||||
|
overflow-wrap: normal;
|
||||||
|
word-break: normal;
|
||||||
}
|
}
|
||||||
|
|
||||||
.hero h1 span {
|
.hero h1 .unbreakable {
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero h1 .heroAccent {
|
||||||
background: linear-gradient(105deg, var(--home-teal) 5%, #1a9793 48%, var(--home-amber));
|
background: linear-gradient(105deg, var(--home-teal) 5%, #1a9793 48%, var(--home-amber));
|
||||||
background-clip: text;
|
background-clip: text;
|
||||||
color: transparent;
|
color: transparent;
|
||||||
@@ -157,6 +163,26 @@
|
|||||||
padding: 0;
|
padding: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.hotReload {
|
||||||
|
align-items: center;
|
||||||
|
color: var(--home-teal);
|
||||||
|
display: inline-flex;
|
||||||
|
font-size: 0.82rem;
|
||||||
|
font-weight: 750;
|
||||||
|
gap: 0.5rem;
|
||||||
|
margin-top: 0.75rem;
|
||||||
|
text-decoration: none !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hotReload span {
|
||||||
|
color: var(--home-amber);
|
||||||
|
font-size: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hotReload:hover {
|
||||||
|
color: var(--home-teal-bright);
|
||||||
|
}
|
||||||
|
|
||||||
.codeStage {
|
.codeStage {
|
||||||
min-width: 0;
|
min-width: 0;
|
||||||
perspective: 1200px;
|
perspective: 1200px;
|
||||||
|
|||||||
@@ -100,8 +100,8 @@ export default function Home(): ReactNode {
|
|||||||
Effect View for React 19
|
Effect View for React 19
|
||||||
</div>
|
</div>
|
||||||
<h1>
|
<h1>
|
||||||
React components,
|
React <span className={styles.unbreakable}>components,</span>
|
||||||
<span> powered by Effect.</span>
|
<span className={styles.heroAccent}> powered by Effect.</span>
|
||||||
</h1>
|
</h1>
|
||||||
<p className={styles.lede}>
|
<p className={styles.lede}>
|
||||||
Bring typed services, scoped resources, reactive state, server
|
Bring typed services, scoped resources, reactive state, server
|
||||||
@@ -126,6 +126,13 @@ export default function Home(): ReactNode {
|
|||||||
<span aria-hidden="true">$</span>
|
<span aria-hidden="true">$</span>
|
||||||
<code>npm install effect-view effect@beta</code>
|
<code>npm install effect-view effect@beta</code>
|
||||||
</div>
|
</div>
|
||||||
|
<Link
|
||||||
|
className={styles.hotReload}
|
||||||
|
to="/docs/getting-started#set-up-hot-reloading-with-vite"
|
||||||
|
>
|
||||||
|
<span aria-hidden="true">↻</span>
|
||||||
|
Hot reload with Vite Fast Refresh
|
||||||
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className={styles.codeStage}>
|
<div className={styles.codeStage}>
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
[
|
[
|
||||||
"effect-fc-1.0"
|
"effect-fc-v0"
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -0,0 +1,51 @@
|
|||||||
|
# Effect FC Example
|
||||||
|
|
||||||
|
Example application for the legacy `effect-fc` package, built with React,
|
||||||
|
TypeScript, and Vite.
|
||||||
|
|
||||||
|
Currently, two official plugins are available:
|
||||||
|
|
||||||
|
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
|
||||||
|
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
|
||||||
|
|
||||||
|
## Expanding the ESLint configuration
|
||||||
|
|
||||||
|
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
|
||||||
|
|
||||||
|
- Configure the top-level `parserOptions` property like this:
|
||||||
|
|
||||||
|
```js
|
||||||
|
export default tseslint.config({
|
||||||
|
languageOptions: {
|
||||||
|
// other options...
|
||||||
|
parserOptions: {
|
||||||
|
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
||||||
|
tsconfigRootDir: import.meta.dirname,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
|
||||||
|
- Optionally add `...tseslint.configs.stylisticTypeChecked`
|
||||||
|
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
|
||||||
|
|
||||||
|
```js
|
||||||
|
// eslint.config.js
|
||||||
|
import react from 'eslint-plugin-react'
|
||||||
|
|
||||||
|
export default tseslint.config({
|
||||||
|
// Set the react version
|
||||||
|
settings: { react: { version: '18.3' } },
|
||||||
|
plugins: {
|
||||||
|
// Add the react plugin
|
||||||
|
react,
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
// other rules...
|
||||||
|
// Enable its recommended rules
|
||||||
|
...react.configs.recommended.rules,
|
||||||
|
...react.configs['jsx-runtime'].rules,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
<meta charset="UTF-8" />
|
<meta charset="UTF-8" />
|
||||||
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>Vite + React + TS</title>
|
<title>Effect FC Example</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div id="root"></div>
|
<div id="root"></div>
|
||||||
@@ -1,10 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "@effect-fc/example-next",
|
"name": "@effect-fc/example",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc -b && vite build",
|
|
||||||
"dev": "vite",
|
"dev": "vite",
|
||||||
"lint:tsc": "tsc -b --noEmit",
|
"lint:tsc": "tsc -b --noEmit",
|
||||||
"lint:biome": "biome lint",
|
"lint:biome": "biome lint",
|
||||||
@@ -23,18 +22,21 @@
|
|||||||
"globals": "^17.6.0",
|
"globals": "^17.6.0",
|
||||||
"react": "^19.2.6",
|
"react": "^19.2.6",
|
||||||
"react-dom": "^19.2.6",
|
"react-dom": "^19.2.6",
|
||||||
|
"type-fest": "^5.7.0",
|
||||||
"vite": "^8.0.16"
|
"vite": "^8.0.16"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@effect/platform-browser": "4.0.0-beta.98",
|
"@effect/platform": "^0.96.1",
|
||||||
|
"@effect/platform-browser": "^0.76.0",
|
||||||
"@radix-ui/themes": "^3.3.0",
|
"@radix-ui/themes": "^3.3.0",
|
||||||
"effect": "4.0.0-beta.98",
|
"@typed/id": "^0.17.2",
|
||||||
"effect-fc-next": "workspace:*",
|
"effect": "^3.21.2",
|
||||||
|
"effect-fc": "workspace:*",
|
||||||
"react-icons": "^5.6.0"
|
"react-icons": "^5.6.0"
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"@types/react": "^19.2.15",
|
"@types/react": "^19.2.15",
|
||||||
"effect": "4.0.0-beta.98",
|
"effect": "^3.21.2",
|
||||||
"react": "^19.2.6"
|
"react": "^19.2.6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
+3
-3
@@ -1,6 +1,6 @@
|
|||||||
import { Callout, Flex, Spinner, TextField } from "@radix-ui/themes"
|
import { Callout, Flex, Spinner, TextField } from "@radix-ui/themes"
|
||||||
import { Array, Option, Struct } from "effect"
|
import { Array, Option, Struct } from "effect"
|
||||||
import { Component, Form, View } from "effect-fc-next"
|
import { Component, Form, Subscribable } from "effect-fc"
|
||||||
import type * as React from "react"
|
import type * as React from "react"
|
||||||
|
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ export const TextFieldFormInputView = Component.make("TextFieldFormInputView")(f
|
|||||||
props: TextFieldFormInputView.Props<readonly PropertyKey[], any, any, any>
|
props: TextFieldFormInputView.Props<readonly PropertyKey[], any, any, any>
|
||||||
) {
|
) {
|
||||||
const input = yield* Form.useInput(props.form, props)
|
const input = yield* Form.useInput(props.form, props)
|
||||||
const [issues, isValidating, isCommitting] = yield* View.useAll([
|
const [issues, isValidating, isCommitting] = yield* Subscribable.useAll([
|
||||||
props.form.issues,
|
props.form.issues,
|
||||||
props.form.isValidating,
|
props.form.isValidating,
|
||||||
props.form.isCommitting,
|
props.form.isCommitting,
|
||||||
@@ -29,7 +29,7 @@ export const TextFieldFormInputView = Component.make("TextFieldFormInputView")(f
|
|||||||
value={input.value}
|
value={input.value}
|
||||||
onChange={e => input.setValue(e.target.value)}
|
onChange={e => input.setValue(e.target.value)}
|
||||||
disabled={isCommitting}
|
disabled={isCommitting}
|
||||||
{...Struct.omit(props, ["form"])}
|
{...Struct.omit(props, "form")}
|
||||||
>
|
>
|
||||||
{isValidating &&
|
{isValidating &&
|
||||||
<TextField.Slot side="right">
|
<TextField.Slot side="right">
|
||||||
+3
-3
@@ -1,6 +1,6 @@
|
|||||||
import { Callout, Flex, Spinner, Switch, TextField } from "@radix-ui/themes"
|
import { Callout, Flex, Spinner, Switch, TextField } from "@radix-ui/themes"
|
||||||
import { Array, Option, Struct } from "effect"
|
import { Array, Option, Struct } from "effect"
|
||||||
import { Component, Form, View } from "effect-fc-next"
|
import { Component, Form, Subscribable } from "effect-fc"
|
||||||
import type * as React from "react"
|
import type * as React from "react"
|
||||||
|
|
||||||
|
|
||||||
@@ -17,7 +17,7 @@ export const TextFieldOptionalFormInputView = Component.make("TextFieldOptionalF
|
|||||||
props: TextFieldOptionalFormInputView.Props<readonly PropertyKey[], any, any, any>
|
props: TextFieldOptionalFormInputView.Props<readonly PropertyKey[], any, any, any>
|
||||||
) {
|
) {
|
||||||
const input = yield* Form.useOptionalInput(props.form, props)
|
const input = yield* Form.useOptionalInput(props.form, props)
|
||||||
const [issues, isValidating, isCommitting] = yield* View.useAll([
|
const [issues, isValidating, isCommitting] = yield* Subscribable.useAll([
|
||||||
props.form.issues,
|
props.form.issues,
|
||||||
props.form.isValidating,
|
props.form.isValidating,
|
||||||
props.form.isCommitting,
|
props.form.isCommitting,
|
||||||
@@ -29,7 +29,7 @@ export const TextFieldOptionalFormInputView = Component.make("TextFieldOptionalF
|
|||||||
value={input.value}
|
value={input.value}
|
||||||
onChange={e => input.setValue(e.target.value)}
|
onChange={e => input.setValue(e.target.value)}
|
||||||
disabled={!input.enabled || isCommitting}
|
disabled={!input.enabled || isCommitting}
|
||||||
{...Struct.omit(props, ["form", "defaultValue"])}
|
{...Struct.omit(props, "form", "defaultValue")}
|
||||||
>
|
>
|
||||||
<TextField.Slot side="left">
|
<TextField.Slot side="left">
|
||||||
<Switch
|
<Switch
|
||||||
@@ -1,21 +1,24 @@
|
|||||||
import { createRouter, RouterProvider } from "@tanstack/react-router"
|
import { createRouter, RouterProvider } from "@tanstack/react-router"
|
||||||
import { ReactRuntime } from "effect-fc-next"
|
import { ReactRuntime } from "effect-fc"
|
||||||
import { StrictMode } from "react"
|
import { StrictMode } from "react"
|
||||||
import { createRoot } from "react-dom/client"
|
import { createRoot } from "react-dom/client"
|
||||||
import { routeTree } from "./routeTree.gen"
|
import { routeTree } from "./routeTree.gen"
|
||||||
import { runtime } from "./runtime"
|
import { runtime } from "./runtime"
|
||||||
|
|
||||||
|
|
||||||
const router = createRouter({ routeTree })
|
const router = createRouter({ routeTree })
|
||||||
|
|
||||||
declare module "@tanstack/react-router" {
|
declare module "@tanstack/react-router" {
|
||||||
interface Register { router: typeof router }
|
interface Register {
|
||||||
|
router: typeof router
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// biome-ignore lint/style/noNonNullAssertion: the Vite template provides this element
|
// biome-ignore lint/style/noNonNullAssertion: React entrypoint
|
||||||
createRoot(document.getElementById("root")!).render(
|
createRoot(document.getElementById("root")!).render(
|
||||||
<StrictMode>
|
<StrictMode>
|
||||||
<ReactRuntime.Provider runtime={runtime}>
|
<ReactRuntime.Provider runtime={runtime}>
|
||||||
<RouterProvider router={router} />
|
<RouterProvider router={router} />
|
||||||
</ReactRuntime.Provider>
|
</ReactRuntime.Provider>
|
||||||
</StrictMode>,
|
</StrictMode>
|
||||||
)
|
)
|
||||||
+112
-78
@@ -9,37 +9,18 @@
|
|||||||
// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified.
|
// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified.
|
||||||
|
|
||||||
import { Route as rootRouteImport } from './routes/__root'
|
import { Route as rootRouteImport } from './routes/__root'
|
||||||
import { Route as IndexRouteImport } from './routes/index'
|
|
||||||
import { Route as AsyncRouteImport } from './routes/async'
|
|
||||||
import { Route as BlankRouteImport } from './routes/blank'
|
|
||||||
import { Route as FormRouteImport } from './routes/form'
|
|
||||||
import { Route as LensformRouteImport } from './routes/lensform'
|
|
||||||
import { Route as QueryRouteImport } from './routes/query'
|
|
||||||
import { Route as ResultRouteImport } from './routes/result'
|
import { Route as ResultRouteImport } from './routes/result'
|
||||||
|
import { Route as QueryRouteImport } from './routes/query'
|
||||||
|
import { Route as FormRouteImport } from './routes/form'
|
||||||
|
import { Route as BlankRouteImport } from './routes/blank'
|
||||||
|
import { Route as AsyncRouteImport } from './routes/async'
|
||||||
|
import { Route as IndexRouteImport } from './routes/index'
|
||||||
|
import { Route as DevMemoRouteImport } from './routes/dev/memo'
|
||||||
|
import { Route as DevContextRouteImport } from './routes/dev/context'
|
||||||
|
|
||||||
const IndexRoute = IndexRouteImport.update({
|
const ResultRoute = ResultRouteImport.update({
|
||||||
id: '/',
|
id: '/result',
|
||||||
path: '/',
|
path: '/result',
|
||||||
getParentRoute: () => rootRouteImport,
|
|
||||||
} as any)
|
|
||||||
const AsyncRoute = AsyncRouteImport.update({
|
|
||||||
id: '/async',
|
|
||||||
path: '/async',
|
|
||||||
getParentRoute: () => rootRouteImport,
|
|
||||||
} as any)
|
|
||||||
const BlankRoute = BlankRouteImport.update({
|
|
||||||
id: '/blank',
|
|
||||||
path: '/blank',
|
|
||||||
getParentRoute: () => rootRouteImport,
|
|
||||||
} as any)
|
|
||||||
const FormRoute = FormRouteImport.update({
|
|
||||||
id: '/form',
|
|
||||||
path: '/form',
|
|
||||||
getParentRoute: () => rootRouteImport,
|
|
||||||
} as any)
|
|
||||||
const LensformRoute = LensformRouteImport.update({
|
|
||||||
id: '/lensform',
|
|
||||||
path: '/lensform',
|
|
||||||
getParentRoute: () => rootRouteImport,
|
getParentRoute: () => rootRouteImport,
|
||||||
} as any)
|
} as any)
|
||||||
const QueryRoute = QueryRouteImport.update({
|
const QueryRoute = QueryRouteImport.update({
|
||||||
@@ -47,9 +28,34 @@ const QueryRoute = QueryRouteImport.update({
|
|||||||
path: '/query',
|
path: '/query',
|
||||||
getParentRoute: () => rootRouteImport,
|
getParentRoute: () => rootRouteImport,
|
||||||
} as any)
|
} as any)
|
||||||
const ResultRoute = ResultRouteImport.update({
|
const FormRoute = FormRouteImport.update({
|
||||||
id: '/result',
|
id: '/form',
|
||||||
path: '/result',
|
path: '/form',
|
||||||
|
getParentRoute: () => rootRouteImport,
|
||||||
|
} as any)
|
||||||
|
const BlankRoute = BlankRouteImport.update({
|
||||||
|
id: '/blank',
|
||||||
|
path: '/blank',
|
||||||
|
getParentRoute: () => rootRouteImport,
|
||||||
|
} as any)
|
||||||
|
const AsyncRoute = AsyncRouteImport.update({
|
||||||
|
id: '/async',
|
||||||
|
path: '/async',
|
||||||
|
getParentRoute: () => rootRouteImport,
|
||||||
|
} as any)
|
||||||
|
const IndexRoute = IndexRouteImport.update({
|
||||||
|
id: '/',
|
||||||
|
path: '/',
|
||||||
|
getParentRoute: () => rootRouteImport,
|
||||||
|
} as any)
|
||||||
|
const DevMemoRoute = DevMemoRouteImport.update({
|
||||||
|
id: '/dev/memo',
|
||||||
|
path: '/dev/memo',
|
||||||
|
getParentRoute: () => rootRouteImport,
|
||||||
|
} as any)
|
||||||
|
const DevContextRoute = DevContextRouteImport.update({
|
||||||
|
id: '/dev/context',
|
||||||
|
path: '/dev/context',
|
||||||
getParentRoute: () => rootRouteImport,
|
getParentRoute: () => rootRouteImport,
|
||||||
} as any)
|
} as any)
|
||||||
|
|
||||||
@@ -58,18 +64,20 @@ export interface FileRoutesByFullPath {
|
|||||||
'/async': typeof AsyncRoute
|
'/async': typeof AsyncRoute
|
||||||
'/blank': typeof BlankRoute
|
'/blank': typeof BlankRoute
|
||||||
'/form': typeof FormRoute
|
'/form': typeof FormRoute
|
||||||
'/lensform': typeof LensformRoute
|
|
||||||
'/query': typeof QueryRoute
|
'/query': typeof QueryRoute
|
||||||
'/result': typeof ResultRoute
|
'/result': typeof ResultRoute
|
||||||
|
'/dev/context': typeof DevContextRoute
|
||||||
|
'/dev/memo': typeof DevMemoRoute
|
||||||
}
|
}
|
||||||
export interface FileRoutesByTo {
|
export interface FileRoutesByTo {
|
||||||
'/': typeof IndexRoute
|
'/': typeof IndexRoute
|
||||||
'/async': typeof AsyncRoute
|
'/async': typeof AsyncRoute
|
||||||
'/blank': typeof BlankRoute
|
'/blank': typeof BlankRoute
|
||||||
'/form': typeof FormRoute
|
'/form': typeof FormRoute
|
||||||
'/lensform': typeof LensformRoute
|
|
||||||
'/query': typeof QueryRoute
|
'/query': typeof QueryRoute
|
||||||
'/result': typeof ResultRoute
|
'/result': typeof ResultRoute
|
||||||
|
'/dev/context': typeof DevContextRoute
|
||||||
|
'/dev/memo': typeof DevMemoRoute
|
||||||
}
|
}
|
||||||
export interface FileRoutesById {
|
export interface FileRoutesById {
|
||||||
__root__: typeof rootRouteImport
|
__root__: typeof rootRouteImport
|
||||||
@@ -77,25 +85,42 @@ export interface FileRoutesById {
|
|||||||
'/async': typeof AsyncRoute
|
'/async': typeof AsyncRoute
|
||||||
'/blank': typeof BlankRoute
|
'/blank': typeof BlankRoute
|
||||||
'/form': typeof FormRoute
|
'/form': typeof FormRoute
|
||||||
'/lensform': typeof LensformRoute
|
|
||||||
'/query': typeof QueryRoute
|
'/query': typeof QueryRoute
|
||||||
'/result': typeof ResultRoute
|
'/result': typeof ResultRoute
|
||||||
|
'/dev/context': typeof DevContextRoute
|
||||||
|
'/dev/memo': typeof DevMemoRoute
|
||||||
}
|
}
|
||||||
export interface FileRouteTypes {
|
export interface FileRouteTypes {
|
||||||
fileRoutesByFullPath: FileRoutesByFullPath
|
fileRoutesByFullPath: FileRoutesByFullPath
|
||||||
fullPaths:
|
fullPaths:
|
||||||
'/' | '/async' | '/blank' | '/form' | '/lensform' | '/query' | '/result'
|
| '/'
|
||||||
|
| '/async'
|
||||||
|
| '/blank'
|
||||||
|
| '/form'
|
||||||
|
| '/query'
|
||||||
|
| '/result'
|
||||||
|
| '/dev/context'
|
||||||
|
| '/dev/memo'
|
||||||
fileRoutesByTo: FileRoutesByTo
|
fileRoutesByTo: FileRoutesByTo
|
||||||
to: '/' | '/async' | '/blank' | '/form' | '/lensform' | '/query' | '/result'
|
to:
|
||||||
|
| '/'
|
||||||
|
| '/async'
|
||||||
|
| '/blank'
|
||||||
|
| '/form'
|
||||||
|
| '/query'
|
||||||
|
| '/result'
|
||||||
|
| '/dev/context'
|
||||||
|
| '/dev/memo'
|
||||||
id:
|
id:
|
||||||
| '__root__'
|
| '__root__'
|
||||||
| '/'
|
| '/'
|
||||||
| '/async'
|
| '/async'
|
||||||
| '/blank'
|
| '/blank'
|
||||||
| '/form'
|
| '/form'
|
||||||
| '/lensform'
|
|
||||||
| '/query'
|
| '/query'
|
||||||
| '/result'
|
| '/result'
|
||||||
|
| '/dev/context'
|
||||||
|
| '/dev/memo'
|
||||||
fileRoutesById: FileRoutesById
|
fileRoutesById: FileRoutesById
|
||||||
}
|
}
|
||||||
export interface RootRouteChildren {
|
export interface RootRouteChildren {
|
||||||
@@ -103,46 +128,19 @@ export interface RootRouteChildren {
|
|||||||
AsyncRoute: typeof AsyncRoute
|
AsyncRoute: typeof AsyncRoute
|
||||||
BlankRoute: typeof BlankRoute
|
BlankRoute: typeof BlankRoute
|
||||||
FormRoute: typeof FormRoute
|
FormRoute: typeof FormRoute
|
||||||
LensformRoute: typeof LensformRoute
|
|
||||||
QueryRoute: typeof QueryRoute
|
QueryRoute: typeof QueryRoute
|
||||||
ResultRoute: typeof ResultRoute
|
ResultRoute: typeof ResultRoute
|
||||||
|
DevContextRoute: typeof DevContextRoute
|
||||||
|
DevMemoRoute: typeof DevMemoRoute
|
||||||
}
|
}
|
||||||
|
|
||||||
declare module '@tanstack/react-router' {
|
declare module '@tanstack/react-router' {
|
||||||
interface FileRoutesByPath {
|
interface FileRoutesByPath {
|
||||||
'/': {
|
'/result': {
|
||||||
id: '/'
|
id: '/result'
|
||||||
path: '/'
|
path: '/result'
|
||||||
fullPath: '/'
|
fullPath: '/result'
|
||||||
preLoaderRoute: typeof IndexRouteImport
|
preLoaderRoute: typeof ResultRouteImport
|
||||||
parentRoute: typeof rootRouteImport
|
|
||||||
}
|
|
||||||
'/async': {
|
|
||||||
id: '/async'
|
|
||||||
path: '/async'
|
|
||||||
fullPath: '/async'
|
|
||||||
preLoaderRoute: typeof AsyncRouteImport
|
|
||||||
parentRoute: typeof rootRouteImport
|
|
||||||
}
|
|
||||||
'/blank': {
|
|
||||||
id: '/blank'
|
|
||||||
path: '/blank'
|
|
||||||
fullPath: '/blank'
|
|
||||||
preLoaderRoute: typeof BlankRouteImport
|
|
||||||
parentRoute: typeof rootRouteImport
|
|
||||||
}
|
|
||||||
'/form': {
|
|
||||||
id: '/form'
|
|
||||||
path: '/form'
|
|
||||||
fullPath: '/form'
|
|
||||||
preLoaderRoute: typeof FormRouteImport
|
|
||||||
parentRoute: typeof rootRouteImport
|
|
||||||
}
|
|
||||||
'/lensform': {
|
|
||||||
id: '/lensform'
|
|
||||||
path: '/lensform'
|
|
||||||
fullPath: '/lensform'
|
|
||||||
preLoaderRoute: typeof LensformRouteImport
|
|
||||||
parentRoute: typeof rootRouteImport
|
parentRoute: typeof rootRouteImport
|
||||||
}
|
}
|
||||||
'/query': {
|
'/query': {
|
||||||
@@ -152,11 +150,46 @@ declare module '@tanstack/react-router' {
|
|||||||
preLoaderRoute: typeof QueryRouteImport
|
preLoaderRoute: typeof QueryRouteImport
|
||||||
parentRoute: typeof rootRouteImport
|
parentRoute: typeof rootRouteImport
|
||||||
}
|
}
|
||||||
'/result': {
|
'/form': {
|
||||||
id: '/result'
|
id: '/form'
|
||||||
path: '/result'
|
path: '/form'
|
||||||
fullPath: '/result'
|
fullPath: '/form'
|
||||||
preLoaderRoute: typeof ResultRouteImport
|
preLoaderRoute: typeof FormRouteImport
|
||||||
|
parentRoute: typeof rootRouteImport
|
||||||
|
}
|
||||||
|
'/blank': {
|
||||||
|
id: '/blank'
|
||||||
|
path: '/blank'
|
||||||
|
fullPath: '/blank'
|
||||||
|
preLoaderRoute: typeof BlankRouteImport
|
||||||
|
parentRoute: typeof rootRouteImport
|
||||||
|
}
|
||||||
|
'/async': {
|
||||||
|
id: '/async'
|
||||||
|
path: '/async'
|
||||||
|
fullPath: '/async'
|
||||||
|
preLoaderRoute: typeof AsyncRouteImport
|
||||||
|
parentRoute: typeof rootRouteImport
|
||||||
|
}
|
||||||
|
'/': {
|
||||||
|
id: '/'
|
||||||
|
path: '/'
|
||||||
|
fullPath: '/'
|
||||||
|
preLoaderRoute: typeof IndexRouteImport
|
||||||
|
parentRoute: typeof rootRouteImport
|
||||||
|
}
|
||||||
|
'/dev/memo': {
|
||||||
|
id: '/dev/memo'
|
||||||
|
path: '/dev/memo'
|
||||||
|
fullPath: '/dev/memo'
|
||||||
|
preLoaderRoute: typeof DevMemoRouteImport
|
||||||
|
parentRoute: typeof rootRouteImport
|
||||||
|
}
|
||||||
|
'/dev/context': {
|
||||||
|
id: '/dev/context'
|
||||||
|
path: '/dev/context'
|
||||||
|
fullPath: '/dev/context'
|
||||||
|
preLoaderRoute: typeof DevContextRouteImport
|
||||||
parentRoute: typeof rootRouteImport
|
parentRoute: typeof rootRouteImport
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -167,9 +200,10 @@ const rootRouteChildren: RootRouteChildren = {
|
|||||||
AsyncRoute: AsyncRoute,
|
AsyncRoute: AsyncRoute,
|
||||||
BlankRoute: BlankRoute,
|
BlankRoute: BlankRoute,
|
||||||
FormRoute: FormRoute,
|
FormRoute: FormRoute,
|
||||||
LensformRoute: LensformRoute,
|
|
||||||
QueryRoute: QueryRoute,
|
QueryRoute: QueryRoute,
|
||||||
ResultRoute: ResultRoute,
|
ResultRoute: ResultRoute,
|
||||||
|
DevContextRoute: DevContextRoute,
|
||||||
|
DevMemoRoute: DevMemoRoute,
|
||||||
}
|
}
|
||||||
export const routeTree = rootRouteImport
|
export const routeTree = rootRouteImport
|
||||||
._addFileChildren(rootRouteChildren)
|
._addFileChildren(rootRouteChildren)
|
||||||
+1
-6
@@ -7,7 +7,7 @@ import "../index.css"
|
|||||||
|
|
||||||
|
|
||||||
export const Route = createRootRoute({
|
export const Route = createRootRoute({
|
||||||
component: Root,
|
component: Root
|
||||||
})
|
})
|
||||||
|
|
||||||
function Root() {
|
function Root() {
|
||||||
@@ -17,11 +17,6 @@ function Root() {
|
|||||||
<Flex direction="row" justify="center" align="center" gap="2">
|
<Flex direction="row" justify="center" align="center" gap="2">
|
||||||
<Link to="/">Index</Link>
|
<Link to="/">Index</Link>
|
||||||
<Link to="/blank">Blank</Link>
|
<Link to="/blank">Blank</Link>
|
||||||
<Link to="/async">Async</Link>
|
|
||||||
<Link to="/query">Query</Link>
|
|
||||||
<Link to="/result">Result</Link>
|
|
||||||
<Link to="/form">Form</Link>
|
|
||||||
<Link to="/lensform">LensForm</Link>
|
|
||||||
</Flex>
|
</Flex>
|
||||||
</Container>
|
</Container>
|
||||||
|
|
||||||
+23
-16
@@ -1,22 +1,30 @@
|
|||||||
|
import { HttpClient } from "@effect/platform"
|
||||||
import { Container, Flex, Heading, Slider, Text, TextField } from "@radix-ui/themes"
|
import { Container, Flex, Heading, Slider, Text, TextField } from "@radix-ui/themes"
|
||||||
import { createFileRoute } from "@tanstack/react-router"
|
import { createFileRoute } from "@tanstack/react-router"
|
||||||
import { Async, Component, Memoized } from "effect-fc-next"
|
import { Array, Effect, flow, Option, Schema } from "effect"
|
||||||
|
import { Async, Component, Memoized } from "effect-fc"
|
||||||
import * as React from "react"
|
import * as React from "react"
|
||||||
import { fetchPost } from "@/post"
|
|
||||||
import { runtime } from "@/runtime"
|
import { runtime } from "@/runtime"
|
||||||
|
|
||||||
|
|
||||||
|
const Post = Schema.Struct({
|
||||||
|
userId: Schema.Int,
|
||||||
|
id: Schema.Int,
|
||||||
|
title: Schema.String,
|
||||||
|
body: Schema.String,
|
||||||
|
})
|
||||||
|
|
||||||
interface AsyncFetchPostViewProps {
|
interface AsyncFetchPostViewProps {
|
||||||
readonly id: number
|
readonly id: number
|
||||||
}
|
}
|
||||||
|
|
||||||
const AsyncFetchPostView = Component.make("AsyncFetchPostView")(function*(
|
class AsyncFetchPostView extends Component.make("AsyncFetchPostView")(function*(props: AsyncFetchPostViewProps) {
|
||||||
props: AsyncFetchPostViewProps,
|
const post = yield* Component.useOnChange(() => HttpClient.HttpClient.pipe(
|
||||||
) {
|
Effect.tap(Effect.sleep("500 millis")),
|
||||||
const post = yield* Component.useOnChange(
|
Effect.andThen(client => client.get(`https://jsonplaceholder.typicode.com/posts/${ props.id }`)),
|
||||||
() => fetchPost(props.id),
|
Effect.andThen(response => response.json),
|
||||||
[props.id],
|
Effect.andThen(Schema.decodeUnknown(Post)),
|
||||||
)
|
), [props.id])
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div>
|
<div>
|
||||||
@@ -26,9 +34,10 @@ const AsyncFetchPostView = Component.make("AsyncFetchPostView")(function*(
|
|||||||
)
|
)
|
||||||
}).pipe(
|
}).pipe(
|
||||||
Async.async,
|
Async.async,
|
||||||
Async.withOptions({ defaultFallback: <Text>Loading post...</Text> }),
|
Async.withOptions({ defaultFallback: <Text>Default fallback</Text> }),
|
||||||
Memoized.memoized,
|
Memoized.memoized,
|
||||||
)
|
) {}
|
||||||
|
|
||||||
|
|
||||||
const AsyncRouteComponent = Component.make("AsyncRouteView")(function*() {
|
const AsyncRouteComponent = Component.make("AsyncRouteView")(function*() {
|
||||||
const [text, setText] = React.useState("Typing here should not trigger a refetch of the post")
|
const [text, setText] = React.useState("Typing here should not trigger a refetch of the post")
|
||||||
@@ -41,14 +50,12 @@ const AsyncRouteComponent = Component.make("AsyncRouteView")(function*() {
|
|||||||
<Flex direction="column" align="stretch" gap="2">
|
<Flex direction="column" align="stretch" gap="2">
|
||||||
<TextField.Root
|
<TextField.Root
|
||||||
value={text}
|
value={text}
|
||||||
onChange={event => setText(event.currentTarget.value)}
|
onChange={e => setText(e.currentTarget.value)}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<Slider
|
<Slider
|
||||||
value={[id]}
|
value={[id]}
|
||||||
min={1}
|
onValueChange={flow(Array.head, Option.getOrThrow, setId)}
|
||||||
max={10}
|
|
||||||
onValueChange={([value]) => setId(value ?? 1)}
|
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<AsyncFetchPost id={id} fallback={<Text>Loading post...</Text>} />
|
<AsyncFetchPost id={id} fallback={<Text>Loading post...</Text>} />
|
||||||
@@ -56,7 +63,7 @@ const AsyncRouteComponent = Component.make("AsyncRouteView")(function*() {
|
|||||||
</Container>
|
</Container>
|
||||||
)
|
)
|
||||||
}).pipe(
|
}).pipe(
|
||||||
Component.withContext(runtime.context),
|
Component.withRuntime(runtime.context)
|
||||||
)
|
)
|
||||||
|
|
||||||
export const Route = createFileRoute("/async")({
|
export const Route = createFileRoute("/async")({
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
import { Button, Container, Flex, Text } from "@radix-ui/themes"
|
||||||
|
import { createFileRoute } from "@tanstack/react-router"
|
||||||
|
import { Console, Effect, Match, Option, ParseResult, Schema } from "effect"
|
||||||
|
import { Component, Form, SubmittableForm, Subscribable } from "effect-fc"
|
||||||
|
import { TextFieldFormInputView } from "@/lib/form/TextFieldFormInputView"
|
||||||
|
import { TextFieldOptionalFormInputView } from "@/lib/form/TextFieldOptionalFormInputView"
|
||||||
|
import { DateTimeUtcFromZonedInput } from "@/lib/schema"
|
||||||
|
import { runtime } from "@/runtime"
|
||||||
|
|
||||||
|
|
||||||
|
const email = Schema.pattern<typeof Schema.String>(
|
||||||
|
/^(?!\.)(?!.*\.\.)([A-Z0-9_+-.]*)[A-Z0-9_+-]@([A-Z0-9][A-Z0-9-]*\.)+[A-Z]{2,}$/i,
|
||||||
|
|
||||||
|
{
|
||||||
|
identifier: "email",
|
||||||
|
title: "email",
|
||||||
|
message: () => "Not an email address",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
const RegisterFormSchema = Schema.Struct({
|
||||||
|
email: Schema.String.pipe(email),
|
||||||
|
password: Schema.String.pipe(Schema.minLength(3)),
|
||||||
|
birth: Schema.OptionFromSelf(DateTimeUtcFromZonedInput),
|
||||||
|
})
|
||||||
|
|
||||||
|
const RegisterFormSubmitSchema = Schema.Struct({
|
||||||
|
email: Schema.transformOrFail(
|
||||||
|
Schema.String,
|
||||||
|
Schema.String,
|
||||||
|
{
|
||||||
|
decode: (input, _options, ast) => input !== "admin@admin.com"
|
||||||
|
? ParseResult.succeed(input)
|
||||||
|
: ParseResult.fail(new ParseResult.Type(ast, input, "This email is already in use.")),
|
||||||
|
encode: ParseResult.succeed,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
password: Schema.String,
|
||||||
|
birth: Schema.OptionFromSelf(Schema.DateTimeUtcFromSelf),
|
||||||
|
})
|
||||||
|
|
||||||
|
class RegisterFormService extends Effect.Service<RegisterFormService>()("RegisterFormService", {
|
||||||
|
scoped: Effect.gen(function*() {
|
||||||
|
const form = yield* SubmittableForm.service({
|
||||||
|
schema: RegisterFormSchema.pipe(
|
||||||
|
Schema.compose(
|
||||||
|
Schema.transformOrFail(
|
||||||
|
Schema.typeSchema(RegisterFormSchema),
|
||||||
|
Schema.typeSchema(RegisterFormSchema),
|
||||||
|
{
|
||||||
|
decode: v => Effect.andThen(Effect.sleep("500 millis"), ParseResult.succeed(v)),
|
||||||
|
encode: ParseResult.succeed,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
|
||||||
|
initialEncodedValue: { email: "", password: "", birth: Option.none() },
|
||||||
|
f: Effect.fnUntraced(function*([value]) {
|
||||||
|
yield* Effect.sleep("500 millis")
|
||||||
|
return yield* Schema.decode(RegisterFormSubmitSchema)(value)
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
|
||||||
|
return {
|
||||||
|
form,
|
||||||
|
emailField: Form.focusObjectOn(form, "email"),
|
||||||
|
passwordField: Form.focusObjectOn(form, "password"),
|
||||||
|
birthField: Form.focusObjectOn(form, "birth"),
|
||||||
|
} as const
|
||||||
|
})
|
||||||
|
}) {}
|
||||||
|
|
||||||
|
class RegisterFormView extends Component.make("RegisterFormView")(function*() {
|
||||||
|
const form = yield* RegisterFormService
|
||||||
|
const [canCommit, submitResult] = yield* Subscribable.useAll([
|
||||||
|
form.form.canCommit,
|
||||||
|
form.form.mutation.result,
|
||||||
|
])
|
||||||
|
|
||||||
|
const runPromise = yield* Component.useRunPromise()
|
||||||
|
const TextFieldFormInput = yield* TextFieldFormInputView.use
|
||||||
|
const TextFieldOptionalFormInput = yield* TextFieldOptionalFormInputView.use
|
||||||
|
|
||||||
|
yield* Component.useOnMount(() => Effect.gen(function*() {
|
||||||
|
yield* Effect.addFinalizer(() => Console.log("RegisterFormView unmounted"))
|
||||||
|
yield* Console.log("RegisterFormView mounted")
|
||||||
|
}))
|
||||||
|
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Container width="300">
|
||||||
|
<form onSubmit={e => {
|
||||||
|
e.preventDefault()
|
||||||
|
void runPromise(form.form.submit)
|
||||||
|
}}>
|
||||||
|
<Flex direction="column" gap="2">
|
||||||
|
<TextFieldFormInput
|
||||||
|
form={form.emailField}
|
||||||
|
debounce="250 millis"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<TextFieldFormInput
|
||||||
|
form={form.passwordField}
|
||||||
|
debounce="250 millis"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<TextFieldOptionalFormInput
|
||||||
|
type="datetime-local"
|
||||||
|
form={form.birthField}
|
||||||
|
defaultValue=""
|
||||||
|
/>
|
||||||
|
|
||||||
|
<Button disabled={!canCommit}>Submit</Button>
|
||||||
|
</Flex>
|
||||||
|
</form>
|
||||||
|
|
||||||
|
{Match.value(submitResult).pipe(
|
||||||
|
Match.tag("Initial", () => <></>),
|
||||||
|
Match.tag("Running", () => <Text>Submitting...</Text>),
|
||||||
|
Match.tag("Success", () => <Text>Submitted successfully!</Text>),
|
||||||
|
Match.tag("Failure", e => <Text>Error: {e.cause.toString()}</Text>),
|
||||||
|
Match.exhaustive,
|
||||||
|
)}
|
||||||
|
</Container>
|
||||||
|
)
|
||||||
|
}) {}
|
||||||
|
|
||||||
|
const RegisterPage = Component.make("RegisterPageView")(function*() {
|
||||||
|
const RegisterForm = yield* Effect.provide(
|
||||||
|
RegisterFormView.use,
|
||||||
|
yield* Component.useLayer(RegisterFormService.Default),
|
||||||
|
)
|
||||||
|
|
||||||
|
return <RegisterForm />
|
||||||
|
}).pipe(
|
||||||
|
Component.withRuntime(runtime.context)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
export const Route = createFileRoute("/form")({
|
||||||
|
component: RegisterPage
|
||||||
|
})
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
import { createFileRoute } from "@tanstack/react-router"
|
||||||
|
import { Effect } from "effect"
|
||||||
|
import { Component } from "effect-fc"
|
||||||
|
import { runtime } from "@/runtime"
|
||||||
|
import { TodosState } from "@/todo/TodosState"
|
||||||
|
import { TodosView } from "@/todo/TodosView"
|
||||||
|
|
||||||
|
|
||||||
|
const TodosStateLive = TodosState.Default("todos")
|
||||||
|
|
||||||
|
const Index = Component.make("IndexView")(function*() {
|
||||||
|
const Todos = yield* Effect.provide(
|
||||||
|
TodosView.use,
|
||||||
|
yield* Component.useLayer(TodosStateLive),
|
||||||
|
)
|
||||||
|
|
||||||
|
return <Todos />
|
||||||
|
}).pipe(
|
||||||
|
Component.withRuntime(runtime.context)
|
||||||
|
)
|
||||||
|
|
||||||
|
export const Route = createFileRoute("/")({
|
||||||
|
component: Index
|
||||||
|
})
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
import { HttpClient, type HttpClientError } from "@effect/platform"
|
||||||
|
import { Button, Container, Flex, Heading, Slider, Text } from "@radix-ui/themes"
|
||||||
|
import { createFileRoute } from "@tanstack/react-router"
|
||||||
|
import { Array, Cause, Chunk, Console, Effect, flow, Match, Option, Schema, Stream, SubscriptionRef } from "effect"
|
||||||
|
import { Component, ErrorObserver, Lens, Mutation, Query, Result, Subscribable } from "effect-fc"
|
||||||
|
import { runtime } from "@/runtime"
|
||||||
|
|
||||||
|
|
||||||
|
const Post = Schema.Struct({
|
||||||
|
userId: Schema.Int,
|
||||||
|
id: Schema.Int,
|
||||||
|
title: Schema.String,
|
||||||
|
body: Schema.String,
|
||||||
|
})
|
||||||
|
|
||||||
|
const ResultView = Component.make("ResultView")(function*() {
|
||||||
|
const runPromise = yield* Component.useRunPromise()
|
||||||
|
|
||||||
|
const [idLens, query, mutation] = yield* Component.useOnMount(() => Effect.gen(function*() {
|
||||||
|
const idLens = Lens.fromSubscriptionRef(yield* SubscriptionRef.make(1))
|
||||||
|
const key = Stream.map(idLens.changes, id => [id] as const)
|
||||||
|
|
||||||
|
const query = yield* Query.service({
|
||||||
|
key,
|
||||||
|
f: ([id]) => HttpClient.HttpClient.pipe(
|
||||||
|
Effect.tap(Effect.sleep("500 millis")),
|
||||||
|
Effect.andThen(client => client.get(`https://jsonplaceholder.typicode.com/posts/${ id }`)),
|
||||||
|
Effect.andThen(response => response.json),
|
||||||
|
Effect.andThen(Schema.decodeUnknown(Post)),
|
||||||
|
),
|
||||||
|
staleTime: "10 seconds",
|
||||||
|
})
|
||||||
|
|
||||||
|
const mutation = yield* Mutation.make({
|
||||||
|
f: ([id]: readonly [id: number]) => HttpClient.HttpClient.pipe(
|
||||||
|
Effect.tap(Effect.sleep("500 millis")),
|
||||||
|
Effect.andThen(client => client.get(`https://jsonplaceholder.typicode.com/posts/${ id }`)),
|
||||||
|
Effect.andThen(response => response.json),
|
||||||
|
Effect.andThen(Schema.decodeUnknown(Post)),
|
||||||
|
),
|
||||||
|
})
|
||||||
|
|
||||||
|
return [idLens, query, mutation] as const
|
||||||
|
}))
|
||||||
|
|
||||||
|
const [id, setId] = yield* Lens.useState(idLens)
|
||||||
|
const [queryResult, mutationResult] = yield* Subscribable.useAll([query.result, mutation.result])
|
||||||
|
|
||||||
|
yield* Component.useOnMount(() => ErrorObserver.ErrorObserver<HttpClientError.HttpClientError>().pipe(
|
||||||
|
Effect.andThen(observer => observer.subscribe),
|
||||||
|
Effect.andThen(Stream.fromQueue),
|
||||||
|
Stream.unwrapScoped,
|
||||||
|
Stream.runForEach(flow(
|
||||||
|
Cause.failures,
|
||||||
|
Chunk.findFirst(e => e._tag === "RequestError" || e._tag === "ResponseError"),
|
||||||
|
Option.match({
|
||||||
|
onSome: e => Console.log("ResultView HttpClient error", e),
|
||||||
|
onNone: () => Effect.void,
|
||||||
|
}),
|
||||||
|
)),
|
||||||
|
Effect.forkScoped,
|
||||||
|
))
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Container>
|
||||||
|
<Flex direction="column" align="center" gap="2">
|
||||||
|
<Slider
|
||||||
|
value={[id]}
|
||||||
|
onValueChange={flow(Array.head, Option.getOrThrow, setId)}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<div>
|
||||||
|
{Match.value(queryResult).pipe(
|
||||||
|
Match.tag("Running", () => <Text>Loading...</Text>),
|
||||||
|
Match.tag("Success", result => <>
|
||||||
|
<Heading>{result.value.title}</Heading>
|
||||||
|
<Text>{result.value.body}</Text>
|
||||||
|
{Result.hasRefreshingFlag(result) && <Text>Refreshing...</Text>}
|
||||||
|
</>),
|
||||||
|
Match.tag("Failure", result =>
|
||||||
|
<Text>An error has occured: {result.cause.toString()}</Text>
|
||||||
|
),
|
||||||
|
Match.orElse(() => <></>),
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<Flex direction="row" justify="center" align="center" gap="1">
|
||||||
|
<Button onClick={() => runPromise(query.refresh)}>Refresh</Button>
|
||||||
|
<Button onClick={() => runPromise(query.invalidateCache)}>Invalidate cache</Button>
|
||||||
|
</Flex>
|
||||||
|
|
||||||
|
<div>
|
||||||
|
{Match.value(mutationResult).pipe(
|
||||||
|
Match.tag("Running", () => <Text>Loading...</Text>),
|
||||||
|
Match.tag("Success", result => <>
|
||||||
|
<Heading>{result.value.title}</Heading>
|
||||||
|
<Text>{result.value.body}</Text>
|
||||||
|
{Result.hasRefreshingFlag(result) && <Text>Refreshing...</Text>}
|
||||||
|
</>),
|
||||||
|
Match.tag("Failure", result =>
|
||||||
|
<Text>An error has occured: {result.cause.toString()}</Text>
|
||||||
|
),
|
||||||
|
Match.orElse(() => <></>),
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<Flex direction="row" justify="center" align="center" gap="1">
|
||||||
|
<Button onClick={() => runPromise(Effect.andThen(Lens.get(idLens), id => mutation.mutate([id])))}>Mutate</Button>
|
||||||
|
</Flex>
|
||||||
|
</Flex>
|
||||||
|
</Container>
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
export const Route = createFileRoute("/query")({
|
||||||
|
component: Component.withRuntime(ResultView, runtime.context)
|
||||||
|
})
|
||||||
@@ -1,11 +1,10 @@
|
|||||||
|
import { FetchHttpClient } from "@effect/platform"
|
||||||
import { Clipboard, Geolocation, Permissions } from "@effect/platform-browser"
|
import { Clipboard, Geolocation, Permissions } from "@effect/platform-browser"
|
||||||
import { DateTime, Layer } from "effect"
|
import { DateTime, Layer } from "effect"
|
||||||
import { FetchHttpClient } from "effect/unstable/http"
|
import { ReactRuntime } from "effect-fc"
|
||||||
import { QueryClient, ReactRuntime } from "effect-fc-next"
|
|
||||||
|
|
||||||
|
|
||||||
export const layer = Layer.empty.pipe(
|
export const AppLive = Layer.empty.pipe(
|
||||||
Layer.provideMerge(QueryClient.layer()),
|
|
||||||
Layer.provideMerge(DateTime.layerCurrentZoneLocal),
|
Layer.provideMerge(DateTime.layerCurrentZoneLocal),
|
||||||
Layer.provideMerge(Clipboard.layer),
|
Layer.provideMerge(Clipboard.layer),
|
||||||
Layer.provideMerge(Geolocation.layer),
|
Layer.provideMerge(Geolocation.layer),
|
||||||
@@ -13,4 +12,4 @@ export const layer = Layer.empty.pipe(
|
|||||||
Layer.provideMerge(FetchHttpClient.layer),
|
Layer.provideMerge(FetchHttpClient.layer),
|
||||||
)
|
)
|
||||||
|
|
||||||
export const runtime = ReactRuntime.make(layer)
|
export const runtime = ReactRuntime.make(AppLive)
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "effect-fc-next",
|
|
||||||
"description": "Write React function components with Effect",
|
|
||||||
"version": "0.1.0-beta.0",
|
|
||||||
"type": "module",
|
|
||||||
"files": [
|
|
||||||
"./README.md",
|
|
||||||
"./dist"
|
|
||||||
],
|
|
||||||
"license": "MIT",
|
|
||||||
"repository": {
|
|
||||||
"url": "git+https://github.com/Thiladev/effect-fc.git"
|
|
||||||
},
|
|
||||||
"types": "./dist/index.d.ts",
|
|
||||||
"exports": {
|
|
||||||
".": {
|
|
||||||
"types": "./dist/index.d.ts",
|
|
||||||
"default": "./dist/index.js"
|
|
||||||
},
|
|
||||||
"./*": [
|
|
||||||
{
|
|
||||||
"types": "./dist/*/index.d.ts",
|
|
||||||
"default": "./dist/*/index.js"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"types": "./dist/*.d.ts",
|
|
||||||
"default": "./dist/*.js"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"scripts": {
|
|
||||||
"build": "tsc",
|
|
||||||
"lint:tsc": "tsc --noEmit",
|
|
||||||
"lint:biome": "biome lint",
|
|
||||||
"test": "vitest run",
|
|
||||||
"pack": "npm pack",
|
|
||||||
"clean:cache": "rm -rf .turbo tsconfig.tsbuildinfo",
|
|
||||||
"clean:dist": "rm -rf dist",
|
|
||||||
"clean:modules": "rm -rf node_modules"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@effect/platform-browser": "4.0.0-beta.98",
|
|
||||||
"@testing-library/react": "^16.3.0",
|
|
||||||
"effect": "4.0.0-beta.98",
|
|
||||||
"jsdom": "^26.1.0",
|
|
||||||
"vitest": "^3.2.4"
|
|
||||||
},
|
|
||||||
"peerDependencies": {
|
|
||||||
"@types/react": "^19.2.0",
|
|
||||||
"effect": "4.0.0-beta.98",
|
|
||||||
"react": "^19.2.0"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"@standard-schema/spec": "^1.1.0",
|
|
||||||
"effect-lens": "^2.0.0-beta.1"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
import { type Cause, Context, Effect, Layer, Option, Pipeable, Predicate, PubSub, type Scope } from "effect"
|
|
||||||
|
|
||||||
|
|
||||||
export const ErrorObserverTypeId: unique symbol = Symbol.for("@effect-fc/ErrorObserver/ErrorObserver")
|
|
||||||
export type ErrorObserverTypeId = typeof ErrorObserverTypeId
|
|
||||||
|
|
||||||
export interface ErrorObserver<in out E = never> extends Pipeable.Pipeable {
|
|
||||||
readonly [ErrorObserverTypeId]: ErrorObserverTypeId
|
|
||||||
handle<A, E1, R>(effect: Effect.Effect<A, E1, R>): Effect.Effect<A, E1, R>
|
|
||||||
readonly subscribe: Effect.Effect<PubSub.Subscription<Cause.Cause<E>>, never, Scope.Scope>
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ErrorObserver = <E = never>() => Context.Service<ErrorObserver<E>>(
|
|
||||||
"@effect-fc/ErrorObserver/ErrorObserver",
|
|
||||||
)
|
|
||||||
|
|
||||||
export class ErrorObserverImpl<in out E = never> extends Pipeable.Class implements ErrorObserver<E> {
|
|
||||||
readonly [ErrorObserverTypeId]: ErrorObserverTypeId = ErrorObserverTypeId
|
|
||||||
|
|
||||||
constructor(readonly pubsub: PubSub.PubSub<Cause.Cause<E>>) {
|
|
||||||
super()
|
|
||||||
}
|
|
||||||
|
|
||||||
get subscribe(): Effect.Effect<PubSub.Subscription<Cause.Cause<E>>, never, Scope.Scope> {
|
|
||||||
return PubSub.subscribe(this.pubsub)
|
|
||||||
}
|
|
||||||
|
|
||||||
handle<A, E1, R>(effect: Effect.Effect<A, E1, R>): Effect.Effect<A, E1, R> {
|
|
||||||
return Effect.tapCause(effect, cause => Effect.asVoid(
|
|
||||||
PubSub.publish(this.pubsub, cause as unknown as Cause.Cause<E>),
|
|
||||||
))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const isErrorObserver = (u: unknown): u is ErrorObserver<unknown> => Predicate.hasProperty(u, ErrorObserverTypeId)
|
|
||||||
|
|
||||||
export const layer: Layer.Layer<ErrorObserver> = Layer.effect(ErrorObserver())(
|
|
||||||
Effect.map(PubSub.unbounded<Cause.Cause<never>>(), pubsub => new ErrorObserverImpl(pubsub)),
|
|
||||||
)
|
|
||||||
|
|
||||||
export const handle = <A, E, R>(effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R> => Effect.flatMap(
|
|
||||||
Effect.serviceOption(ErrorObserver()),
|
|
||||||
Option.match({
|
|
||||||
onSome: observer => observer.handle(effect),
|
|
||||||
onNone: () => effect,
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
This library is in early development. While it is (almost) feature complete and mostly usable, expect bugs and quirks. Things are still being ironed out, so ideas and criticisms are more than welcome.
|
This library is in early development. While it is (almost) feature complete and mostly usable, expect bugs and quirks. Things are still being ironed out, so ideas and criticisms are more than welcome.
|
||||||
|
|
||||||
Documentation is currently being written. In the meantime, you can take a look at the `packages/example` directory.
|
Documentation is currently being written. In the meantime, you can take a look at the `packages/effect-fc-example` directory.
|
||||||
|
|
||||||
## Peer dependencies
|
## Peer dependencies
|
||||||
- `effect` 3.19+
|
- `effect` 3.19+
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "effect-fc",
|
"name": "effect-fc",
|
||||||
"description": "Write React function components with Effect",
|
"description": "Write React function components with Effect",
|
||||||
"version": "0.3.0",
|
"version": "0.3.1",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"files": [
|
"files": [
|
||||||
"./README.md",
|
"./README.md",
|
||||||
@@ -9,7 +9,7 @@
|
|||||||
],
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"repository": {
|
"repository": {
|
||||||
"url": "git+https://github.com/Thiladev/effect-fc.git"
|
"url": "git+https://github.com/Thiladev/effect-view.git"
|
||||||
},
|
},
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
"exports": {
|
"exports": {
|
||||||
@@ -29,12 +29,12 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"lint:tsc": "tsc -b --noEmit",
|
||||||
"lint:tsc": "tsc --noEmit",
|
|
||||||
"lint:biome": "biome lint",
|
"lint:biome": "biome lint",
|
||||||
"test": "vitest run",
|
"test": "vitest run",
|
||||||
|
"build": "tsc -b tsconfig.build.json",
|
||||||
"pack": "npm pack",
|
"pack": "npm pack",
|
||||||
"clean:cache": "rm -rf .turbo tsconfig.tsbuildinfo",
|
"clean:cache": "rm -rf .turbo *.tsbuildinfo",
|
||||||
"clean:dist": "rm -rf dist",
|
"clean:dist": "rm -rf dist",
|
||||||
"clean:modules": "rm -rf node_modules"
|
"clean:modules": "rm -rf node_modules"
|
||||||
},
|
},
|
||||||
@@ -50,6 +50,6 @@
|
|||||||
"react": "^19.2.0"
|
"react": "^19.2.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"effect-lens": "^0.2.0"
|
"effect-lens": "^0.2.3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+10
-6
@@ -2,8 +2,8 @@ import { render, screen, waitFor } from "@testing-library/react"
|
|||||||
import { Context, Effect, Layer } from "effect"
|
import { Context, Effect, Layer } from "effect"
|
||||||
import * as React from "react"
|
import * as React from "react"
|
||||||
import { afterEach, describe, expect, it, vi } from "vitest"
|
import { afterEach, describe, expect, it, vi } from "vitest"
|
||||||
import * as Component from "../src/Component.js"
|
import * as Component from "./Component.js"
|
||||||
import * as ReactRuntime from "../src/ReactRuntime.js"
|
import * as ReactRuntime from "./ReactRuntime.js"
|
||||||
|
|
||||||
|
|
||||||
class ValueService extends Context.Tag("ValueService")<ValueService, { readonly value: string }>() {}
|
class ValueService extends Context.Tag("ValueService")<ValueService, { readonly value: string }>() {}
|
||||||
@@ -273,6 +273,7 @@ describe("Component", () => {
|
|||||||
)
|
)
|
||||||
|
|
||||||
await screen.findByText("first")
|
await screen.findByText("first")
|
||||||
|
vi.useFakeTimers()
|
||||||
|
|
||||||
view.rerender(
|
view.rerender(
|
||||||
<runtime.context.Provider value={effectRuntime}>
|
<runtime.context.Provider value={effectRuntime}>
|
||||||
@@ -280,16 +281,19 @@ describe("Component", () => {
|
|||||||
</runtime.context.Provider>
|
</runtime.context.Provider>
|
||||||
)
|
)
|
||||||
|
|
||||||
await screen.findByText("second")
|
expect(screen.getByText("second")).toBeTruthy()
|
||||||
expect(cleanup).not.toHaveBeenCalled()
|
expect(cleanup).not.toHaveBeenCalled()
|
||||||
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 5))
|
await vi.advanceTimersByTimeAsync(19)
|
||||||
expect(cleanup).not.toHaveBeenCalled()
|
expect(cleanup).not.toHaveBeenCalled()
|
||||||
|
|
||||||
await waitFor(() => expect(cleanup).toHaveBeenCalledWith("first"), { timeout: 100 })
|
await vi.advanceTimersByTimeAsync(1)
|
||||||
|
expect(cleanup).toHaveBeenCalledWith("first")
|
||||||
|
|
||||||
view.unmount()
|
view.unmount()
|
||||||
await waitFor(() => expect(cleanup).toHaveBeenCalledWith("second"), { timeout: 100 })
|
await vi.advanceTimersByTimeAsync(20)
|
||||||
|
expect(cleanup).toHaveBeenCalledWith("second")
|
||||||
|
vi.useRealTimers()
|
||||||
await Effect.runPromise(runtime.runtime.disposeEffect)
|
await Effect.runPromise(runtime.runtime.disposeEffect)
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -2,9 +2,9 @@ import { fireEvent, render, screen, waitFor } from "@testing-library/react"
|
|||||||
import { Effect, Layer, SubscriptionRef } from "effect"
|
import { Effect, Layer, SubscriptionRef } from "effect"
|
||||||
import * as React from "react"
|
import * as React from "react"
|
||||||
import { describe, expect, it } from "vitest"
|
import { describe, expect, it } from "vitest"
|
||||||
import * as Component from "../src/Component.js"
|
import * as Component from "./Component.js"
|
||||||
import * as Lens from "../src/Lens.js"
|
import * as Lens from "./Lens.js"
|
||||||
import * as ReactRuntime from "../src/ReactRuntime.js"
|
import * as ReactRuntime from "./ReactRuntime.js"
|
||||||
|
|
||||||
|
|
||||||
const makeRuntime = async () => {
|
const makeRuntime = async () => {
|
||||||
@@ -18,6 +18,12 @@ const makeRuntime = async () => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const expectDefined = <A,>(value: A | undefined): A => {
|
||||||
|
if (value === undefined)
|
||||||
|
throw new Error("Expected value to be defined")
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
describe("Lens", () => {
|
describe("Lens", () => {
|
||||||
it("useState stays in sync with lens updates in both directions", async () => {
|
it("useState stays in sync with lens updates in both directions", async () => {
|
||||||
const { runtime, effectRuntime, dispose } = await makeRuntime()
|
const { runtime, effectRuntime, dispose } = await makeRuntime()
|
||||||
@@ -30,7 +36,7 @@ describe("Lens", () => {
|
|||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<div>{value}</div>
|
<div>{value}</div>
|
||||||
<button onClick={() => setValue(previous => previous + 1)}>increment</button>
|
<button type="button" onClick={() => setValue(previous => previous + 1)}>increment</button>
|
||||||
</>
|
</>
|
||||||
)
|
)
|
||||||
}).pipe(
|
}).pipe(
|
||||||
@@ -102,7 +108,7 @@ describe("Lens", () => {
|
|||||||
lens = reactLens
|
lens = reactLens
|
||||||
}))
|
}))
|
||||||
|
|
||||||
return <button onClick={() => setValue(previous => `${previous}!`)}>{value}</button>
|
return <button type="button" onClick={() => setValue(previous => `${previous}!`)}>{value}</button>
|
||||||
}).pipe(
|
}).pipe(
|
||||||
Component.withRuntime(runtime.context)
|
Component.withRuntime(runtime.context)
|
||||||
)
|
)
|
||||||
@@ -118,7 +124,7 @@ describe("Lens", () => {
|
|||||||
|
|
||||||
fireEvent.click(screen.getByRole("button", { name: "hello" }))
|
fireEvent.click(screen.getByRole("button", { name: "hello" }))
|
||||||
await screen.findByText("hello!")
|
await screen.findByText("hello!")
|
||||||
await waitFor(async () => expect(await Effect.runPromise(Lens.get(lens!))).toBe("hello!"))
|
await waitFor(async () => expect(await Effect.runPromise(Lens.get(expectDefined(lens)))).toBe("hello!"))
|
||||||
|
|
||||||
view.unmount()
|
view.unmount()
|
||||||
await dispose()
|
await dispose()
|
||||||
@@ -152,11 +158,11 @@ describe("Lens", () => {
|
|||||||
await screen.findByText("first")
|
await screen.findByText("first")
|
||||||
await waitFor(() => expect(lens).toBeDefined())
|
await waitFor(() => expect(lens).toBeDefined())
|
||||||
|
|
||||||
await Effect.runPromise(Lens.set(lens!, { id: 1, label: "ignored" }))
|
await Effect.runPromise(Lens.set(expectDefined(lens), { id: 1, label: "ignored" }))
|
||||||
await waitFor(() => expect(screen.getByText("first")).toBeTruthy())
|
await waitFor(() => expect(screen.getByText("first")).toBeTruthy())
|
||||||
expect(screen.queryByText("ignored")).toBeNull()
|
expect(screen.queryByText("ignored")).toBeNull()
|
||||||
|
|
||||||
await Effect.runPromise(Lens.set(lens!, { id: 2, label: "updated" }))
|
await Effect.runPromise(Lens.set(expectDefined(lens), { id: 2, label: "updated" }))
|
||||||
await screen.findByText("updated")
|
await screen.findByText("updated")
|
||||||
|
|
||||||
view.unmount()
|
view.unmount()
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
import { Effect, Option, type Scope, Stream } from "effect"
|
import { Effect, Option, type Scope, Stream } from "effect"
|
||||||
import { describe, expect, it } from "vitest"
|
import { describe, expect, it } from "vitest"
|
||||||
import * as Query from "../src/Query.js"
|
import * as Query from "./Query.js"
|
||||||
import * as QueryClient from "../src/QueryClient.js"
|
import * as QueryClient from "./QueryClient.js"
|
||||||
import * as Result from "../src/Result.js"
|
import * as Result from "./Result.js"
|
||||||
|
|
||||||
|
|
||||||
const runQueryTest = <A, E>(effect: Effect.Effect<A, E, QueryClient.QueryClient | Scope.Scope>) =>
|
const runQueryTest = <A, E>(effect: Effect.Effect<A, E, QueryClient.QueryClient | Scope.Scope>) =>
|
||||||
+3
-3
@@ -2,9 +2,9 @@ import { render, screen, waitFor } from "@testing-library/react"
|
|||||||
import { Effect, Fiber, Layer, Stream, SubscriptionRef } from "effect"
|
import { Effect, Fiber, Layer, Stream, SubscriptionRef } from "effect"
|
||||||
import { Lens } from "effect-lens"
|
import { Lens } from "effect-lens"
|
||||||
import { describe, expect, it } from "vitest"
|
import { describe, expect, it } from "vitest"
|
||||||
import * as Component from "../src/Component.js"
|
import * as Component from "./Component.js"
|
||||||
import * as ReactRuntime from "../src/ReactRuntime.js"
|
import * as ReactRuntime from "./ReactRuntime.js"
|
||||||
import * as Subscribable from "../src/Subscribable.js"
|
import * as Subscribable from "./Subscribable.js"
|
||||||
|
|
||||||
|
|
||||||
const makeRuntime = async () => {
|
const makeRuntime = async () => {
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"extends": "./tsconfig.json",
|
||||||
|
"exclude": ["**/setup-tests.ts", "**/*.test.ts", "**/*.test.tsx", "**/*.spec.ts", "**/*.spec.tsx"]
|
||||||
|
}
|
||||||
@@ -36,5 +36,4 @@
|
|||||||
},
|
},
|
||||||
|
|
||||||
"include": ["./src"],
|
"include": ["./src"],
|
||||||
"exclude": ["**/*.test.ts", "**/*.spec.ts"]
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,6 +4,6 @@ import { defineConfig } from "vitest/config"
|
|||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
test: {
|
test: {
|
||||||
environment: "jsdom",
|
environment: "jsdom",
|
||||||
include: ["test/**/*.test.ts?(x)"],
|
include: ["./src/**/*.test.ts?(x)"],
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://thila.dev/effect-view">
|
<a href="https://thila.dev/effect-view">
|
||||||
<img src="../docs/static/img/logo.svg" width="104" height="104" alt="Effect View logo" />
|
<img src="https://github.com/Thiladev/effect-view/raw/master/packages/docs/static/img/logo.svg" width="104" height="104" alt="Effect View logo" />
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@@ -136,9 +136,6 @@ Effect View is renderer-independent and does not require `react-dom`.
|
|||||||
|
|
||||||
Effect View is currently beta software. The main APIs are available, but
|
Effect View is currently beta software. The main APIs are available, but
|
||||||
breaking changes and rough edges are still possible before a stable release.
|
breaking changes and rough edges are still possible before a stable release.
|
||||||
React Fast Refresh does not yet recognize Effect View component definitions, so
|
|
||||||
changes to them currently require a page reload; ordinary React components are
|
|
||||||
unaffected (currently being worked on).
|
|
||||||
|
|
||||||
Issues, ideas, and contributions are welcome on
|
Issues, ideas, and contributions are welcome on
|
||||||
[GitHub](https://github.com/Thiladev/effect-view).
|
[GitHub](https://github.com/Thiladev/effect-view).
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
{
|
||||||
|
"name": "effect-view",
|
||||||
|
"description": "Write React function components with Effect",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"type": "module",
|
||||||
|
"files": [
|
||||||
|
"./README.md",
|
||||||
|
"./dist"
|
||||||
|
],
|
||||||
|
"license": "MIT",
|
||||||
|
"repository": {
|
||||||
|
"url": "git+https://github.com/Thiladev/effect-view.git"
|
||||||
|
},
|
||||||
|
"types": "./dist/index.d.ts",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/index.d.ts",
|
||||||
|
"default": "./dist/index.js"
|
||||||
|
},
|
||||||
|
"./Async": {
|
||||||
|
"types": "./dist/Async.d.ts",
|
||||||
|
"default": "./dist/Async.js"
|
||||||
|
},
|
||||||
|
"./Component": {
|
||||||
|
"types": "./dist/Component.d.ts",
|
||||||
|
"default": "./dist/Component.js"
|
||||||
|
},
|
||||||
|
"./Form": {
|
||||||
|
"types": "./dist/Form.d.ts",
|
||||||
|
"default": "./dist/Form.js"
|
||||||
|
},
|
||||||
|
"./Lens": {
|
||||||
|
"types": "./dist/Lens.d.ts",
|
||||||
|
"default": "./dist/Lens.js"
|
||||||
|
},
|
||||||
|
"./LensForm": {
|
||||||
|
"types": "./dist/LensForm.d.ts",
|
||||||
|
"default": "./dist/LensForm.js"
|
||||||
|
},
|
||||||
|
"./Memoized": {
|
||||||
|
"types": "./dist/Memoized.d.ts",
|
||||||
|
"default": "./dist/Memoized.js"
|
||||||
|
},
|
||||||
|
"./Mutation": {
|
||||||
|
"types": "./dist/Mutation.d.ts",
|
||||||
|
"default": "./dist/Mutation.js"
|
||||||
|
},
|
||||||
|
"./MutationForm": {
|
||||||
|
"types": "./dist/MutationForm.d.ts",
|
||||||
|
"default": "./dist/MutationForm.js"
|
||||||
|
},
|
||||||
|
"./PubSub": {
|
||||||
|
"types": "./dist/PubSub.d.ts",
|
||||||
|
"default": "./dist/PubSub.js"
|
||||||
|
},
|
||||||
|
"./Query": {
|
||||||
|
"types": "./dist/Query.d.ts",
|
||||||
|
"default": "./dist/Query.js"
|
||||||
|
},
|
||||||
|
"./QueryClient": {
|
||||||
|
"types": "./dist/QueryClient.d.ts",
|
||||||
|
"default": "./dist/QueryClient.js"
|
||||||
|
},
|
||||||
|
"./ReactRuntime": {
|
||||||
|
"types": "./dist/ReactRuntime.d.ts",
|
||||||
|
"default": "./dist/ReactRuntime.js"
|
||||||
|
},
|
||||||
|
"./Refreshable": {
|
||||||
|
"types": "./dist/Refreshable.d.ts",
|
||||||
|
"default": "./dist/Refreshable.js"
|
||||||
|
},
|
||||||
|
"./ScopeRegistry": {
|
||||||
|
"types": "./dist/ScopeRegistry.d.ts",
|
||||||
|
"default": "./dist/ScopeRegistry.js"
|
||||||
|
},
|
||||||
|
"./SetStateAction": {
|
||||||
|
"types": "./dist/SetStateAction.d.ts",
|
||||||
|
"default": "./dist/SetStateAction.js"
|
||||||
|
},
|
||||||
|
"./Stream": {
|
||||||
|
"types": "./dist/Stream.d.ts",
|
||||||
|
"default": "./dist/Stream.js"
|
||||||
|
},
|
||||||
|
"./View": {
|
||||||
|
"types": "./dist/View.d.ts",
|
||||||
|
"default": "./dist/View.js"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"lint:tsc": "tsc -b --noEmit",
|
||||||
|
"lint:biome": "biome lint",
|
||||||
|
"test": "vitest run",
|
||||||
|
"build": "tsc -b tsconfig.build.json",
|
||||||
|
"pack": "npm pack",
|
||||||
|
"clean:cache": "rm -rf .turbo *.tsbuildinfo",
|
||||||
|
"clean:dist": "rm -rf dist",
|
||||||
|
"clean:modules": "rm -rf node_modules"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@effect/platform-browser": "4.0.0-beta.101",
|
||||||
|
"@testing-library/react": "^16.3.0",
|
||||||
|
"effect": "4.0.0-beta.101",
|
||||||
|
"jsdom": "^26.1.0",
|
||||||
|
"vitest": "^3.2.4"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"@types/react": "^19.2.0",
|
||||||
|
"effect": "4.0.0-beta.101",
|
||||||
|
"react": "^19.2.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@standard-schema/spec": "^1.1.0",
|
||||||
|
"effect-lens": "^2.0.1-beta.101"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
import { act, fireEvent, render, screen } from "@testing-library/react"
|
||||||
|
import { Effect, Layer } from "effect"
|
||||||
|
import * as React from "react"
|
||||||
|
import { describe, expect, it, vi } from "vitest"
|
||||||
|
import * as Async from "./Async.js"
|
||||||
|
import * as Component from "./Component.js"
|
||||||
|
import * as Memoized from "./Memoized.js"
|
||||||
|
import * as ReactRuntime from "./ReactRuntime.js"
|
||||||
|
|
||||||
|
describe("Async", () => {
|
||||||
|
it("does not rerun for an unrelated parent state update", async () => {
|
||||||
|
const load = vi.fn((_id: number) => Effect.never)
|
||||||
|
const renderPost = vi.fn()
|
||||||
|
const runtime = ReactRuntime.make(Layer.empty)
|
||||||
|
const context = await runtime.runtime.context()
|
||||||
|
|
||||||
|
const Post = Component.make("Post")(function*(props: { readonly id: number }) {
|
||||||
|
renderPost()
|
||||||
|
const value = yield* Component.useOnChange(() => load(props.id), [props.id])
|
||||||
|
return <div>{value}</div>
|
||||||
|
}).pipe(
|
||||||
|
Async.async,
|
||||||
|
Memoized.memoized,
|
||||||
|
)
|
||||||
|
|
||||||
|
const Parent = Component.make("Parent")(function*() {
|
||||||
|
const [text, setText] = React.useState("")
|
||||||
|
const AsyncPost = yield* Post.use
|
||||||
|
|
||||||
|
return <>
|
||||||
|
<input
|
||||||
|
aria-label="text"
|
||||||
|
value={text}
|
||||||
|
onChange={event => setText(event.currentTarget.value)}
|
||||||
|
/>
|
||||||
|
<AsyncPost id={1} fallback={<div>loading</div>} />
|
||||||
|
</>
|
||||||
|
}).pipe(Component.withContext(runtime.context))
|
||||||
|
|
||||||
|
let view!: ReturnType<typeof render>
|
||||||
|
await act(async () => {
|
||||||
|
view = render(
|
||||||
|
<runtime.context.Provider value={context}>
|
||||||
|
<Parent />
|
||||||
|
</runtime.context.Provider>,
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(screen.getByText("loading")).toBeTruthy()
|
||||||
|
expect(load).toHaveBeenCalledTimes(2)
|
||||||
|
const callsAfterLoad = load.mock.calls.length
|
||||||
|
const rendersAfterLoad = renderPost.mock.calls.length
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
fireEvent.change(screen.getByLabelText("text"), { target: { value: "a" } })
|
||||||
|
})
|
||||||
|
expect(load).toHaveBeenCalledTimes(callsAfterLoad)
|
||||||
|
expect(renderPost).toHaveBeenCalledTimes(rendersAfterLoad)
|
||||||
|
|
||||||
|
view.unmount()
|
||||||
|
await runtime.runtime.dispose()
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -4,7 +4,7 @@ import * as React from "react"
|
|||||||
import * as Component from "./Component.js"
|
import * as Component from "./Component.js"
|
||||||
|
|
||||||
|
|
||||||
export const AsyncTypeId: unique symbol = Symbol.for("@effect-fc/Async/Async")
|
export const AsyncTypeId: unique symbol = Symbol.for("@effect-view/Async/Async")
|
||||||
export type AsyncTypeId = typeof AsyncTypeId
|
export type AsyncTypeId = typeof AsyncTypeId
|
||||||
|
|
||||||
|
|
||||||
@@ -37,7 +37,7 @@ export type AsyncProps = Omit<React.SuspenseProps, "children">
|
|||||||
export const AsyncPrototype: AsyncPrototype = Object.freeze({
|
export const AsyncPrototype: AsyncPrototype = Object.freeze({
|
||||||
[AsyncTypeId]: AsyncTypeId,
|
[AsyncTypeId]: AsyncTypeId,
|
||||||
|
|
||||||
asFunctionComponent<P extends {}, A extends React.ReactNode, E, R, F extends Component.Component.Signature>(
|
makeFunctionComponent<P extends {}, A extends React.ReactNode, E, R, F extends Component.Component.Signature>(
|
||||||
this: Component.Component<P, A, E, R, F> & Async,
|
this: Component.Component<P, A, E, R, F> & Async,
|
||||||
contextRef: React.RefObject<Context.Context<Exclude<R, Scope.Scope>>>,
|
contextRef: React.RefObject<Context.Context<Exclude<R, Scope.Scope>>>,
|
||||||
) {
|
) {
|
||||||
+137
-14
@@ -1,9 +1,11 @@
|
|||||||
import { act, fireEvent, render, screen, waitFor } from "@testing-library/react"
|
import { act, fireEvent, render, screen, waitFor } from "@testing-library/react"
|
||||||
import { Context, Effect, HashMap, Layer, Ref } from "effect"
|
import { Context, Effect, HashMap, Layer, SubscriptionRef } from "effect"
|
||||||
import * as React from "react"
|
import * as React from "react"
|
||||||
import { afterEach, describe, expect, it, vi } from "vitest"
|
import { afterEach, describe, expect, it, vi } from "vitest"
|
||||||
import * as Component from "../src/Component.js"
|
import * as Component from "./Component.js"
|
||||||
import * as ReactRuntime from "../src/ReactRuntime.js"
|
import * as ReactRuntime from "./ReactRuntime.js"
|
||||||
|
import * as Refreshable from "./Refreshable.js"
|
||||||
|
import * as ScopeRegistry from "./ScopeRegistry.js"
|
||||||
|
|
||||||
|
|
||||||
class ValueService extends Context.Service<ValueService, { readonly value: string }>()("ValueService") {}
|
class ValueService extends Context.Service<ValueService, { readonly value: string }>()("ValueService") {}
|
||||||
@@ -275,6 +277,7 @@ describe("Component", () => {
|
|||||||
)
|
)
|
||||||
|
|
||||||
await screen.findByText("first")
|
await screen.findByText("first")
|
||||||
|
vi.useFakeTimers()
|
||||||
|
|
||||||
view.rerender(
|
view.rerender(
|
||||||
<runtime.context.Provider value={effectRuntime}>
|
<runtime.context.Provider value={effectRuntime}>
|
||||||
@@ -282,16 +285,19 @@ describe("Component", () => {
|
|||||||
</runtime.context.Provider>
|
</runtime.context.Provider>
|
||||||
)
|
)
|
||||||
|
|
||||||
await screen.findByText("second")
|
expect(screen.getByText("second")).toBeTruthy()
|
||||||
expect(cleanup).not.toHaveBeenCalled()
|
expect(cleanup).not.toHaveBeenCalled()
|
||||||
|
|
||||||
await new Promise(resolve => setTimeout(resolve, 5))
|
await vi.advanceTimersByTimeAsync(19)
|
||||||
expect(cleanup).not.toHaveBeenCalled()
|
expect(cleanup).not.toHaveBeenCalled()
|
||||||
|
|
||||||
await waitFor(() => expect(cleanup).toHaveBeenCalledWith("first"), { timeout: 100 })
|
await vi.advanceTimersByTimeAsync(1)
|
||||||
|
expect(cleanup).toHaveBeenCalledWith("first")
|
||||||
|
|
||||||
view.unmount()
|
view.unmount()
|
||||||
await waitFor(() => expect(cleanup).toHaveBeenCalledWith("second"), { timeout: 100 })
|
await vi.advanceTimersByTimeAsync(20)
|
||||||
|
expect(cleanup).toHaveBeenCalledWith("second")
|
||||||
|
vi.useRealTimers()
|
||||||
await runtime.runtime.dispose()
|
await runtime.runtime.dispose()
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -310,7 +316,7 @@ describe("Component", () => {
|
|||||||
yield* Effect.addFinalizer(() => Effect.sync(() => unmounts()))
|
yield* Effect.addFinalizer(() => Effect.sync(() => unmounts()))
|
||||||
}))
|
}))
|
||||||
|
|
||||||
return <button onClick={() => setCount(value => value + 1)}>{`${service.value}:${count}`}</button>
|
return <button type="button" onClick={() => setCount(value => value + 1)}>{`${service.value}:${count}`}</button>
|
||||||
}).pipe(
|
}).pipe(
|
||||||
Component.withOptions({
|
Component.withOptions({
|
||||||
nonReactiveTags: [...Component.defaultOptions.nonReactiveTags, ValueService],
|
nonReactiveTags: [...Component.defaultOptions.nonReactiveTags, ValueService],
|
||||||
@@ -361,11 +367,11 @@ describe("Component", () => {
|
|||||||
await runtime.runtime.dispose()
|
await runtime.runtime.dispose()
|
||||||
})
|
})
|
||||||
|
|
||||||
it.fails("does not commit effects or retain registered scopes for a discarded Suspense render", async () => {
|
it("does not commit effects or retain registered scopes for a discarded Suspense render", async () => {
|
||||||
const setup = vi.fn()
|
const setup = vi.fn()
|
||||||
const runtime = ReactRuntime.make(Layer.empty)
|
const runtime = ReactRuntime.make(Layer.empty)
|
||||||
const effectRuntime = await runtime.runtime.context()
|
const effectRuntime = await runtime.runtime.context()
|
||||||
const scopeMap = Context.get(effectRuntime, Component.ScopeMap)
|
const scopeRegistry = Context.get(effectRuntime, ScopeRegistry.ScopeRegistry)
|
||||||
const pending = new Promise<void>(() => {})
|
const pending = new Promise<void>(() => {})
|
||||||
|
|
||||||
const Probe = Component.makeUntraced("DiscardedSuspenseProbe")(function*() {
|
const Probe = Component.makeUntraced("DiscardedSuspenseProbe")(function*() {
|
||||||
@@ -373,6 +379,7 @@ describe("Component", () => {
|
|||||||
React.use(pending)
|
React.use(pending)
|
||||||
return <div>committed</div>
|
return <div>committed</div>
|
||||||
}).pipe(
|
}).pipe(
|
||||||
|
Component.withOptions({ scopeCommitTimeout: "10 millis" }),
|
||||||
Component.withContext(runtime.context)
|
Component.withContext(runtime.context)
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -390,7 +397,7 @@ describe("Component", () => {
|
|||||||
try {
|
try {
|
||||||
await screen.findByText("fallback")
|
await screen.findByText("fallback")
|
||||||
expect(setup).not.toHaveBeenCalled()
|
expect(setup).not.toHaveBeenCalled()
|
||||||
expect(HashMap.size(Effect.runSync(Ref.get(scopeMap.ref)))).toBe(0)
|
await waitFor(() => expect(HashMap.size(Effect.runSync(SubscriptionRef.get(scopeRegistry.ref)))).toBe(0))
|
||||||
}
|
}
|
||||||
finally {
|
finally {
|
||||||
view.unmount()
|
view.unmount()
|
||||||
@@ -398,11 +405,88 @@ describe("Component", () => {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
it.fails("clears ScopeMap after a suspended render retries, commits, and unmounts", async () => {
|
it("keeps committed scopes alive without heartbeats", async () => {
|
||||||
|
const acquisitions = vi.fn()
|
||||||
|
const releases = vi.fn()
|
||||||
|
const runtime = ReactRuntime.make(Layer.empty)
|
||||||
|
const effectRuntime = await runtime.runtime.context()
|
||||||
|
const scopeRegistry = Context.get(effectRuntime, ScopeRegistry.ScopeRegistry)
|
||||||
|
|
||||||
|
const Probe = Component.makeUntraced("CommittedScopeProbe")(function*() {
|
||||||
|
yield* Component.useOnMount(() => Effect.gen(function*() {
|
||||||
|
yield* Effect.sync(acquisitions)
|
||||||
|
yield* Effect.addFinalizer(() => Effect.sync(releases))
|
||||||
|
}))
|
||||||
|
|
||||||
|
return <div>committed</div>
|
||||||
|
}).pipe(
|
||||||
|
Component.withOptions({
|
||||||
|
finalizerExecutionDebounce: "10 millis",
|
||||||
|
scopeCommitTimeout: "10 millis",
|
||||||
|
}),
|
||||||
|
Component.withContext(runtime.context),
|
||||||
|
)
|
||||||
|
|
||||||
|
const view = render(
|
||||||
|
<runtime.context.Provider value={effectRuntime}>
|
||||||
|
<Probe />
|
||||||
|
</runtime.context.Provider>
|
||||||
|
)
|
||||||
|
|
||||||
|
await screen.findByText("committed")
|
||||||
|
await waitFor(() => expect(releases).toHaveBeenCalledTimes(acquisitions.mock.calls.length - 1))
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 30))
|
||||||
|
|
||||||
|
expect(HashMap.size(Effect.runSync(SubscriptionRef.get(scopeRegistry.ref)))).toBe(1)
|
||||||
|
expect(releases).toHaveBeenCalledTimes(acquisitions.mock.calls.length - 1)
|
||||||
|
|
||||||
|
view.unmount()
|
||||||
|
await waitFor(() => expect(releases).toHaveBeenCalledTimes(acquisitions.mock.calls.length))
|
||||||
|
await waitFor(() => expect(HashMap.size(Effect.runSync(SubscriptionRef.get(scopeRegistry.ref)))).toBe(0))
|
||||||
|
await runtime.runtime.dispose()
|
||||||
|
})
|
||||||
|
|
||||||
|
it("does not expire a scope while a descendant is suspended past the finalizer debounce", async () => {
|
||||||
|
const runtime = ReactRuntime.make(Layer.empty)
|
||||||
|
let resolve!: () => void
|
||||||
|
const pending = new Promise<void>(complete => {
|
||||||
|
resolve = complete
|
||||||
|
})
|
||||||
|
|
||||||
|
const Suspended = () => {
|
||||||
|
React.use(pending)
|
||||||
|
return <div>committed</div>
|
||||||
|
}
|
||||||
|
|
||||||
|
let view!: ReturnType<typeof render>
|
||||||
|
await act(async () => {
|
||||||
|
view = render(
|
||||||
|
<ReactRuntime.Provider runtime={runtime} fallback={<div>fallback</div>}>
|
||||||
|
<Suspended />
|
||||||
|
</ReactRuntime.Provider>
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
try {
|
||||||
|
await screen.findByText("fallback")
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 150))
|
||||||
|
await act(async () => {
|
||||||
|
resolve()
|
||||||
|
await pending
|
||||||
|
})
|
||||||
|
await screen.findByText("committed")
|
||||||
|
}
|
||||||
|
finally {
|
||||||
|
view.unmount()
|
||||||
|
await runtime.runtime.dispose()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it("clears ScopeRegistry after a suspended render retries, commits, and unmounts", async () => {
|
||||||
const lifecycle = vi.fn<(message: string) => void>()
|
const lifecycle = vi.fn<(message: string) => void>()
|
||||||
const runtime = ReactRuntime.make(Layer.empty)
|
const runtime = ReactRuntime.make(Layer.empty)
|
||||||
const effectRuntime = await runtime.runtime.context()
|
const effectRuntime = await runtime.runtime.context()
|
||||||
const scopeMap = Context.get(effectRuntime, Component.ScopeMap)
|
const scopeRegistry = Context.get(effectRuntime, ScopeRegistry.ScopeRegistry)
|
||||||
let resolve!: () => void
|
let resolve!: () => void
|
||||||
const pending = new Promise<void>(complete => {
|
const pending = new Promise<void>(complete => {
|
||||||
resolve = complete
|
resolve = complete
|
||||||
@@ -416,6 +500,7 @@ describe("Component", () => {
|
|||||||
}), [])
|
}), [])
|
||||||
return <div>committed</div>
|
return <div>committed</div>
|
||||||
}).pipe(
|
}).pipe(
|
||||||
|
Component.withOptions({ scopeCommitTimeout: "10 millis" }),
|
||||||
Component.withContext(runtime.context)
|
Component.withContext(runtime.context)
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -440,7 +525,7 @@ describe("Component", () => {
|
|||||||
await waitFor(() => expect(lifecycle).toHaveBeenCalledWith("mount"))
|
await waitFor(() => expect(lifecycle).toHaveBeenCalledWith("mount"))
|
||||||
|
|
||||||
view.unmount()
|
view.unmount()
|
||||||
await waitFor(() => expect(HashMap.size(Effect.runSync(Ref.get(scopeMap.ref)))).toBe(0))
|
await waitFor(() => expect(HashMap.size(Effect.runSync(SubscriptionRef.get(scopeRegistry.ref)))).toBe(0))
|
||||||
expect(lifecycle.mock.calls.filter(([message]) => message === "mount")).toHaveLength(2)
|
expect(lifecycle.mock.calls.filter(([message]) => message === "mount")).toHaveLength(2)
|
||||||
expect(lifecycle.mock.calls.filter(([message]) => message === "cleanup")).toHaveLength(2)
|
expect(lifecycle.mock.calls.filter(([message]) => message === "cleanup")).toHaveLength(2)
|
||||||
}
|
}
|
||||||
@@ -449,4 +534,42 @@ describe("Component", () => {
|
|||||||
await runtime.runtime.dispose()
|
await runtime.runtime.dispose()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it("refreshes a registered body while preserving or resetting local state", async () => {
|
||||||
|
const runtime = ReactRuntime.make(Layer.empty)
|
||||||
|
const effectRuntime = await runtime.runtime.context()
|
||||||
|
|
||||||
|
const makeProbe = (label: string) => Component.makeUntraced("RefreshProbe")(function*() {
|
||||||
|
const [count, setCount] = React.useState(0)
|
||||||
|
return <button type="button" onClick={() => setCount(value => value + 1)}>{label}:{count}</button>
|
||||||
|
})
|
||||||
|
const original = makeProbe("old")
|
||||||
|
const cell = Refreshable.makeCell(original, "hooks", false)
|
||||||
|
Refreshable.attach(original, cell)
|
||||||
|
|
||||||
|
const Probe = Component.withContext(original, runtime.context)
|
||||||
|
const view = render(
|
||||||
|
<runtime.context.Provider value={effectRuntime}>
|
||||||
|
<Probe />
|
||||||
|
</runtime.context.Provider>
|
||||||
|
)
|
||||||
|
|
||||||
|
fireEvent.click(await screen.findByRole("button"))
|
||||||
|
expect(screen.getByRole("button").textContent).toBe("old:1")
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
cell.update(makeProbe("compatible"), "hooks", false)
|
||||||
|
await Promise.resolve()
|
||||||
|
})
|
||||||
|
expect(screen.getByRole("button").textContent).toBe("compatible:1")
|
||||||
|
|
||||||
|
await act(async () => {
|
||||||
|
cell.update(makeProbe("reset"), "changed-hooks", false)
|
||||||
|
await Promise.resolve()
|
||||||
|
})
|
||||||
|
expect(screen.getByRole("button").textContent).toBe("reset:0")
|
||||||
|
|
||||||
|
view.unmount()
|
||||||
|
await runtime.runtime.dispose()
|
||||||
|
})
|
||||||
})
|
})
|
||||||
@@ -1,10 +1,11 @@
|
|||||||
/** biome-ignore-all lint/complexity/noBannedTypes: {} is the default type for React props */
|
/** biome-ignore-all lint/complexity/noBannedTypes: {} is the default type for React props */
|
||||||
/** biome-ignore-all lint/complexity/useArrowFunction: necessary for class prototypes */
|
/** biome-ignore-all lint/complexity/useArrowFunction: necessary for class prototypes */
|
||||||
import { Cause, Context, type Duration, Effect, Equal, Equivalence, Exit, Fiber, Function, HashMap, identity, Layer, Option, Pipeable, Predicate, Ref, Scheduler, Scope, Tracer } from "effect"
|
import { Context, type Duration, Effect, Equivalence, Exit, Function, identity, Layer, Pipeable, Predicate, References, Scheduler, Scope, Tracer } from "effect"
|
||||||
import * as React from "react"
|
import * as React from "react"
|
||||||
|
import * as ScopeRegistry from "./ScopeRegistry.js"
|
||||||
|
|
||||||
|
|
||||||
export const ComponentTypeId: unique symbol = Symbol.for("@effect-fc/Component/Component")
|
export const ComponentTypeId: unique symbol = Symbol.for("@effect-view/Component/Component")
|
||||||
export type ComponentTypeId = typeof ComponentTypeId
|
export type ComponentTypeId = typeof ComponentTypeId
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -43,10 +44,15 @@ export declare namespace Component {
|
|||||||
export interface ComponentImpl<P extends {}, A extends React.ReactNode, E, R, F extends Component.Signature>
|
export interface ComponentImpl<P extends {}, A extends React.ReactNode, E, R, F extends Component.Signature>
|
||||||
extends Component<P, A, E, R, F>, ComponentImplPrototype<R, F> {}
|
extends Component<P, A, E, R, F>, ComponentImplPrototype<R, F> {}
|
||||||
|
|
||||||
|
export declare namespace ComponentImpl {
|
||||||
|
export type Any = ComponentImpl<any, any, any, any, any>
|
||||||
|
}
|
||||||
|
|
||||||
export interface ComponentImplPrototype<R, F extends Component.Signature> {
|
export interface ComponentImplPrototype<R, F extends Component.Signature> {
|
||||||
readonly use: Effect.Effect<F, never, Exclude<R, Scope.Scope>>
|
readonly use: Effect.Effect<F, never, Exclude<R, Scope.Scope>>
|
||||||
|
|
||||||
asFunctionComponent(contextRef: React.Ref<Context.Context<Exclude<R, Scope.Scope>>>): F
|
asFunctionComponent(contextRef: React.Ref<Context.Context<Exclude<R, Scope.Scope>>>): F
|
||||||
|
makeFunctionComponent(contextRef: React.Ref<Context.Context<Exclude<R, Scope.Scope>>>): F
|
||||||
setFunctionComponentName(f: F): void
|
setFunctionComponentName(f: F): void
|
||||||
transformFunctionComponent(f: F): F
|
transformFunctionComponent(f: F): F
|
||||||
}
|
}
|
||||||
@@ -54,7 +60,7 @@ export interface ComponentImplPrototype<R, F extends Component.Signature> {
|
|||||||
export const ComponentImplPrototype: ComponentImplPrototype<any, any> = Object.freeze({
|
export const ComponentImplPrototype: ComponentImplPrototype<any, any> = Object.freeze({
|
||||||
get use() { return use(this) },
|
get use() { return use(this) },
|
||||||
|
|
||||||
asFunctionComponent<P extends {}, A extends React.ReactNode, E, R, F extends Component.Signature>(
|
makeFunctionComponent<P extends {}, A extends React.ReactNode, E, R, F extends Component.Signature>(
|
||||||
this: ComponentImpl<P, A, E, R, F>,
|
this: ComponentImpl<P, A, E, R, F>,
|
||||||
contextRef: React.RefObject<Context.Context<Exclude<R, Scope.Scope>>>,
|
contextRef: React.RefObject<Context.Context<Exclude<R, Scope.Scope>>>,
|
||||||
) {
|
) {
|
||||||
@@ -66,6 +72,13 @@ export const ComponentImplPrototype: ComponentImplPrototype<any, any> = Object.f
|
|||||||
)
|
)
|
||||||
},
|
},
|
||||||
|
|
||||||
|
asFunctionComponent<P extends {}, A extends React.ReactNode, E, R, F extends Component.Signature>(
|
||||||
|
this: ComponentImpl<P, A, E, R, F>,
|
||||||
|
contextRef: React.RefObject<Context.Context<Exclude<R, Scope.Scope>>>,
|
||||||
|
) {
|
||||||
|
return this.makeFunctionComponent(contextRef)
|
||||||
|
},
|
||||||
|
|
||||||
setFunctionComponentName<P extends {}, A extends React.ReactNode, E, R, F extends Component.Signature>(
|
setFunctionComponentName<P extends {}, A extends React.ReactNode, E, R, F extends Component.Signature>(
|
||||||
this: ComponentImpl<P, A, E, R, F>,
|
this: ComponentImpl<P, A, E, R, F>,
|
||||||
f: React.FC<P>,
|
f: React.FC<P>,
|
||||||
@@ -132,7 +145,7 @@ export interface ComponentOptions {
|
|||||||
/**
|
/**
|
||||||
* Context tags that should not trigger component remount when their values change.
|
* Context tags that should not trigger component remount when their values change.
|
||||||
*
|
*
|
||||||
* @default [Tracer.ParentSpan]
|
* @default [Tracer.ParentSpan, References.CurrentStackFrame, Scheduler.Scheduler, Layer.CurrentMemoMap, Scope.Scope]
|
||||||
*/
|
*/
|
||||||
readonly nonReactiveTags: readonly Context.Key<any, any>[]
|
readonly nonReactiveTags: readonly Context.Key<any, any>[]
|
||||||
|
|
||||||
@@ -152,12 +165,26 @@ export interface ComponentOptions {
|
|||||||
* @default "100 millis"
|
* @default "100 millis"
|
||||||
*/
|
*/
|
||||||
readonly finalizerExecutionDebounce: Duration.Input
|
readonly finalizerExecutionDebounce: Duration.Input
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Maximum duration an uncommitted scope may remain registered before it is considered abandoned.
|
||||||
|
*
|
||||||
|
* @default "30 seconds"
|
||||||
|
*/
|
||||||
|
readonly scopeCommitTimeout: Duration.Input
|
||||||
}
|
}
|
||||||
|
|
||||||
export const defaultOptions: ComponentOptions = {
|
export const defaultOptions: ComponentOptions = {
|
||||||
nonReactiveTags: [Tracer.ParentSpan, Scheduler.Scheduler, Layer.CurrentMemoMap],
|
nonReactiveTags: [
|
||||||
|
Tracer.ParentSpan,
|
||||||
|
References.CurrentStackFrame,
|
||||||
|
Scheduler.Scheduler,
|
||||||
|
Layer.CurrentMemoMap,
|
||||||
|
Scope.Scope,
|
||||||
|
],
|
||||||
finalizerExecutionStrategy: "sequential",
|
finalizerExecutionStrategy: "sequential",
|
||||||
finalizerExecutionDebounce: "100 millis",
|
finalizerExecutionDebounce: "100 millis",
|
||||||
|
scopeCommitTimeout: "1 minute",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -389,9 +416,9 @@ export declare namespace make {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an Effect-FC Component using the same overloads and pipeline composition style as `Effect.fn`.
|
* Creates an Effect View Component using the same overloads and pipeline composition style as `Effect.fn`.
|
||||||
*
|
*
|
||||||
* This is the **recommended** approach for defining Effect-FC components. It provides comprehensive
|
* This is the **recommended** approach for defining Effect View components. It provides comprehensive
|
||||||
* support for multiple component definition patterns:
|
* support for multiple component definition patterns:
|
||||||
*
|
*
|
||||||
* - **Generator syntax** (yield* style): Most ergonomic and readable approach for sequential operations
|
* - **Generator syntax** (yield* style): Most ergonomic and readable approach for sequential operations
|
||||||
@@ -464,7 +491,7 @@ export const make: (
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an Effect-FC Component without automatic distributed tracing.
|
* Creates an Effect View Component without automatic distributed tracing.
|
||||||
*
|
*
|
||||||
* This function provides the same API surface as `make`, but does not create automatic tracing spans.
|
* This function provides the same API surface as `make`, but does not create automatic tracing spans.
|
||||||
* It follows the exact same overload structure as `Effect.fnUntraced`.
|
* It follows the exact same overload structure as `Effect.fnUntraced`.
|
||||||
@@ -581,19 +608,19 @@ export const withOptions: {
|
|||||||
))
|
))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Wraps an Effect-FC Component and converts it into a standard React function component,
|
* Wraps an Effect View Component and converts it into a standard React function component,
|
||||||
* serving as an **entrypoint** into an Effect-FC component hierarchy.
|
* serving as an **entrypoint** into an Effect View component hierarchy.
|
||||||
*
|
*
|
||||||
* This is how Effect-FC components are integrated with the broader React ecosystem,
|
* This is how Effect View components are integrated with the broader React ecosystem,
|
||||||
* particularly when:
|
* particularly when:
|
||||||
* - Using client-side routers (TanStack Router, React Router, etc.)
|
* - Using client-side routers (TanStack Router, React Router, etc.)
|
||||||
* - Implementing lazy-loaded or code-split routes
|
* - Implementing lazy-loaded or code-split routes
|
||||||
* - Connecting to third-party libraries expecting standard React components
|
* - Connecting to third-party libraries expecting standard React components
|
||||||
* - Creating component boundaries between Effect-FC and non-Effect-FC code
|
* - Creating component boundaries between Effect View and non-Effect View code
|
||||||
*
|
*
|
||||||
* The Effect runtime is obtained from the provided React Context.
|
* The Effect runtime is obtained from the provided React Context.
|
||||||
*
|
*
|
||||||
* @param self - The Effect-FC Component to be rendered as a standard React component
|
* @param self - The Effect View Component to be rendered as a standard React component
|
||||||
* @param context - React Context providing the Effect Runtime for this component tree.
|
* @param context - React Context providing the Effect Runtime for this component tree.
|
||||||
* Create this using the `ReactRuntime` module.
|
* Create this using the `ReactRuntime` module.
|
||||||
*
|
*
|
||||||
@@ -636,35 +663,11 @@ export const withContext: {
|
|||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Internal Effect service that maintains a registry of scopes associated with React component instances.
|
|
||||||
*
|
|
||||||
* This service is used internally by the `useScope` hook to manage the lifecycle of component scopes,
|
|
||||||
* including tracking active scopes and coordinating their cleanup when components unmount or dependencies change.
|
|
||||||
*/
|
|
||||||
export class ScopeMap extends Context.Service<ScopeMap, {
|
|
||||||
readonly ref: Ref.Ref<HashMap.HashMap<object, ScopeMap.Entry>>
|
|
||||||
}>()(
|
|
||||||
"@effect-fc/Component/ScopeMap"
|
|
||||||
) {
|
|
||||||
static readonly layer = Layer.effect(ScopeMap, Effect.map(
|
|
||||||
Ref.make(HashMap.empty<object, ScopeMap.Entry>()),
|
|
||||||
ref => ({ ref }),
|
|
||||||
))
|
|
||||||
}
|
|
||||||
|
|
||||||
export declare namespace ScopeMap {
|
|
||||||
export interface Entry {
|
|
||||||
readonly scope: Scope.Closeable
|
|
||||||
readonly closeFiber: Option.Option<Fiber.Fiber<void>>
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
export declare namespace useScope {
|
export declare namespace useScope {
|
||||||
export interface Options {
|
export interface Options {
|
||||||
readonly finalizerExecutionStrategy?: "sequential" | "parallel"
|
readonly finalizerExecutionStrategy?: "sequential" | "parallel"
|
||||||
readonly finalizerExecutionDebounce?: Duration.Input
|
readonly finalizerExecutionDebounce?: Duration.Input
|
||||||
|
readonly scopeCommitTimeout?: Duration.Input
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -692,54 +695,27 @@ export const useScope = Effect.fnUntraced(function*(
|
|||||||
// biome-ignore lint/style/noNonNullAssertion: context initialization
|
// biome-ignore lint/style/noNonNullAssertion: context initialization
|
||||||
const contextRef = React.useRef<Context.Context<never>>(null!)
|
const contextRef = React.useRef<Context.Context<never>>(null!)
|
||||||
contextRef.current = yield* Effect.context()
|
contextRef.current = yield* Effect.context()
|
||||||
|
const registry = yield* ScopeRegistry.ScopeRegistry as unknown as Effect.Effect<ScopeRegistry.ScopeRegistryService>
|
||||||
|
|
||||||
const { key, scope } = React.useMemo(() => Effect.runSyncWith(contextRef.current)(Effect.Do.pipe(
|
const [key, scope] = React.useMemo(() => Effect.runSyncWith(contextRef.current)(Effect.gen(function*() {
|
||||||
Effect.bind("scopeMapRef", () => Effect.map(
|
const key = ScopeRegistry.makeKey()
|
||||||
ScopeMap as unknown as Effect.Effect<ScopeMap["Service"]>,
|
const entry = yield* registry.register(key, {
|
||||||
scopeMap => scopeMap.ref,
|
finalizerExecutionStrategy: options?.finalizerExecutionStrategy ?? defaultOptions.finalizerExecutionStrategy,
|
||||||
)),
|
finalizerExecutionDebounce: options?.finalizerExecutionDebounce ?? defaultOptions.finalizerExecutionDebounce,
|
||||||
Effect.let("key", () => Equal.byReference({})),
|
scopeCommitTimeout: options?.scopeCommitTimeout ?? defaultOptions.scopeCommitTimeout,
|
||||||
Effect.bind("scope", () => Scope.make(options?.finalizerExecutionStrategy ?? defaultOptions.finalizerExecutionStrategy)),
|
})
|
||||||
Effect.tap(({ scopeMapRef, key, scope }) =>
|
|
||||||
Ref.update(scopeMapRef, HashMap.set(key, Equal.byReference({
|
return [key, entry.scope]
|
||||||
scope,
|
|
||||||
closeFiber: Option.none(),
|
|
||||||
})))
|
|
||||||
),
|
|
||||||
// biome-ignore lint/correctness/useExhaustiveDependencies: use of React.DependencyList
|
// biome-ignore lint/correctness/useExhaustiveDependencies: use of React.DependencyList
|
||||||
)), deps)
|
})), deps)
|
||||||
|
|
||||||
// biome-ignore lint/correctness/useExhaustiveDependencies: only reactive on "key"
|
// biome-ignore lint/correctness/useExhaustiveDependencies: only reactive on "key"
|
||||||
React.useEffect(() => Effect.runSyncWith(contextRef.current)(
|
React.useEffect(() => {
|
||||||
(ScopeMap as unknown as Effect.Effect<ScopeMap["Service"]>).pipe(
|
Effect.runSyncWith(contextRef.current)(registry.commit(key))
|
||||||
Effect.map(scopeMap => scopeMap.ref),
|
return () => {
|
||||||
Effect.tap(ref => Ref.get(ref).pipe(
|
Effect.runSyncWith(contextRef.current)(registry.release(key))
|
||||||
Effect.flatMap(map => Effect.fromOption(HashMap.get(map, key))),
|
}
|
||||||
Effect.flatMap(entry => Option.match(entry.closeFiber, {
|
}, [key])
|
||||||
onSome: fiber => Effect.forkDetach(Fiber.interrupt(fiber)),
|
|
||||||
onNone: () => Effect.void,
|
|
||||||
})),
|
|
||||||
)),
|
|
||||||
Effect.map(ref =>
|
|
||||||
() => Effect.runSyncWith(contextRef.current)(Effect.flatMap(
|
|
||||||
Effect.sleep(options?.finalizerExecutionDebounce ?? defaultOptions.finalizerExecutionDebounce).pipe(
|
|
||||||
Effect.andThen(Scope.close(scope, Exit.void)),
|
|
||||||
Effect.onExit(exit => Exit.match(exit, {
|
|
||||||
onSuccess: () => Ref.update(ref, HashMap.remove(key)),
|
|
||||||
onFailure: cause => Cause.hasInterruptsOnly(cause)
|
|
||||||
? Effect.void
|
|
||||||
: Ref.update(ref, HashMap.remove(key)),
|
|
||||||
})),
|
|
||||||
Effect.forkDetach,
|
|
||||||
),
|
|
||||||
fiber => Ref.update(ref, HashMap.set(key, Equal.byReference({
|
|
||||||
scope,
|
|
||||||
closeFiber: Option.some(fiber),
|
|
||||||
}))),
|
|
||||||
))
|
|
||||||
),
|
|
||||||
)
|
|
||||||
), [key])
|
|
||||||
|
|
||||||
return scope
|
return scope
|
||||||
})
|
})
|
||||||
@@ -6,7 +6,7 @@ import * as Lens from "./Lens.js"
|
|||||||
import * as View from "./View.js"
|
import * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
export const FormTypeId: unique symbol = Symbol.for("@effect-fc/Form/Form")
|
export const FormTypeId: unique symbol = Symbol.for("@effect-view/Form/Form")
|
||||||
export type FormTypeId = typeof FormTypeId
|
export type FormTypeId = typeof FormTypeId
|
||||||
|
|
||||||
export interface Form<out P extends readonly PropertyKey[], out A, in out I = A, out ER = never, out EW = never>
|
export interface Form<out P extends readonly PropertyKey[], out A, in out I = A, out ER = never, out EW = never>
|
||||||
+14
-8
@@ -2,9 +2,9 @@ import { fireEvent, render, screen, waitFor } from "@testing-library/react"
|
|||||||
import { Effect, Layer, SubscriptionRef } from "effect"
|
import { Effect, Layer, SubscriptionRef } from "effect"
|
||||||
import * as React from "react"
|
import * as React from "react"
|
||||||
import { describe, expect, it } from "vitest"
|
import { describe, expect, it } from "vitest"
|
||||||
import * as Component from "../src/Component.js"
|
import * as Component from "./Component.js"
|
||||||
import * as Lens from "../src/Lens.js"
|
import * as Lens from "./Lens.js"
|
||||||
import * as ReactRuntime from "../src/ReactRuntime.js"
|
import * as ReactRuntime from "./ReactRuntime.js"
|
||||||
|
|
||||||
|
|
||||||
const makeRuntime = async () => {
|
const makeRuntime = async () => {
|
||||||
@@ -18,6 +18,12 @@ const makeRuntime = async () => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const expectDefined = <A,>(value: A | undefined): A => {
|
||||||
|
if (value === undefined)
|
||||||
|
throw new Error("Expected value to be defined")
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
describe("Lens", () => {
|
describe("Lens", () => {
|
||||||
it("useState stays in sync with lens updates in both directions", async () => {
|
it("useState stays in sync with lens updates in both directions", async () => {
|
||||||
const { runtime, effectRuntime, dispose } = await makeRuntime()
|
const { runtime, effectRuntime, dispose } = await makeRuntime()
|
||||||
@@ -30,7 +36,7 @@ describe("Lens", () => {
|
|||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<div>{value}</div>
|
<div>{value}</div>
|
||||||
<button onClick={() => setValue(previous => previous + 1)}>increment</button>
|
<button type="button" onClick={() => setValue(previous => previous + 1)}>increment</button>
|
||||||
</>
|
</>
|
||||||
)
|
)
|
||||||
}).pipe(
|
}).pipe(
|
||||||
@@ -102,7 +108,7 @@ describe("Lens", () => {
|
|||||||
lens = reactLens
|
lens = reactLens
|
||||||
}))
|
}))
|
||||||
|
|
||||||
return <button onClick={() => setValue(previous => `${previous}!`)}>{value}</button>
|
return <button type="button" onClick={() => setValue(previous => `${previous}!`)}>{value}</button>
|
||||||
}).pipe(
|
}).pipe(
|
||||||
Component.withContext(runtime.context)
|
Component.withContext(runtime.context)
|
||||||
)
|
)
|
||||||
@@ -118,7 +124,7 @@ describe("Lens", () => {
|
|||||||
|
|
||||||
fireEvent.click(screen.getByRole("button", { name: "hello" }))
|
fireEvent.click(screen.getByRole("button", { name: "hello" }))
|
||||||
await screen.findByText("hello!")
|
await screen.findByText("hello!")
|
||||||
await waitFor(async () => expect(await Effect.runPromise(Lens.get(lens!))).toBe("hello!"))
|
await waitFor(async () => expect(await Effect.runPromise(Lens.get(expectDefined(lens)))).toBe("hello!"))
|
||||||
|
|
||||||
view.unmount()
|
view.unmount()
|
||||||
await dispose()
|
await dispose()
|
||||||
@@ -152,11 +158,11 @@ describe("Lens", () => {
|
|||||||
await screen.findByText("first")
|
await screen.findByText("first")
|
||||||
await waitFor(() => expect(lens).toBeDefined())
|
await waitFor(() => expect(lens).toBeDefined())
|
||||||
|
|
||||||
await Effect.runPromise(Lens.set(lens!, { id: 1, label: "ignored" }))
|
await Effect.runPromise(Lens.set(expectDefined(lens), { id: 1, label: "ignored" }))
|
||||||
await waitFor(() => expect(screen.getByText("first")).toBeTruthy())
|
await waitFor(() => expect(screen.getByText("first")).toBeTruthy())
|
||||||
expect(screen.queryByText("ignored")).toBeNull()
|
expect(screen.queryByText("ignored")).toBeNull()
|
||||||
|
|
||||||
await Effect.runPromise(Lens.set(lens!, { id: 2, label: "updated" }))
|
await Effect.runPromise(Lens.set(expectDefined(lens), { id: 2, label: "updated" }))
|
||||||
await screen.findByText("updated")
|
await screen.findByText("updated")
|
||||||
|
|
||||||
view.unmount()
|
view.unmount()
|
||||||
@@ -5,7 +5,7 @@ import * as Lens from "./Lens.js"
|
|||||||
import * as View from "./View.js"
|
import * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
export const LensFormTypeId: unique symbol = Symbol.for("@effect-fc/Form/LensForm")
|
export const LensFormTypeId: unique symbol = Symbol.for("@effect-view/Form/LensForm")
|
||||||
export type LensFormTypeId = typeof LensFormTypeId
|
export type LensFormTypeId = typeof LensFormTypeId
|
||||||
|
|
||||||
export interface LensForm<in out A, in out I = A, in out RD = never, in out RE = never, out TER = never, out TEW = never, in out TRR = never, in out TRW = never>
|
export interface LensForm<in out A, in out I = A, in out RD = never, in out RE = never, out TER = never, out TEW = never, in out TRR = never, in out TRW = never>
|
||||||
@@ -4,7 +4,7 @@ import * as React from "react"
|
|||||||
import type * as Component from "./Component.js"
|
import type * as Component from "./Component.js"
|
||||||
|
|
||||||
|
|
||||||
export const MemoizedTypeId: unique symbol = Symbol.for("@effect-fc/Memoized/Memoized")
|
export const MemoizedTypeId: unique symbol = Symbol.for("@effect-view/Memoized/Memoized")
|
||||||
export type MemoizedTypeId = typeof MemoizedTypeId
|
export type MemoizedTypeId = typeof MemoizedTypeId
|
||||||
|
|
||||||
|
|
||||||
@@ -4,7 +4,7 @@ import * as Lens from "./Lens.js"
|
|||||||
import * as View from "./View.js"
|
import * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
export const MutationTypeId: unique symbol = Symbol.for("@effect-fc/Mutation/Mutation")
|
export const MutationTypeId: unique symbol = Symbol.for("@effect-view/Mutation/Mutation")
|
||||||
export type MutationTypeId = typeof MutationTypeId
|
export type MutationTypeId = typeof MutationTypeId
|
||||||
|
|
||||||
export interface Mutation<in out K, out A, out E = never, in out R = never>
|
export interface Mutation<in out K, out A, out E = never, in out R = never>
|
||||||
+1
-1
@@ -7,7 +7,7 @@ import * as Mutation from "./Mutation.js"
|
|||||||
import * as View from "./View.js"
|
import * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
export const MutationFormTypeId: unique symbol = Symbol.for("@effect-fc/Form/MutationForm")
|
export const MutationFormTypeId: unique symbol = Symbol.for("@effect-view/Form/MutationForm")
|
||||||
export type MutationFormTypeId = typeof MutationFormTypeId
|
export type MutationFormTypeId = typeof MutationFormTypeId
|
||||||
|
|
||||||
export interface MutationForm<in out A, in out I = A, in out RD = never, in out RE = never, out MA = void, out ME = never, in out MR = never>
|
export interface MutationForm<in out A, in out I = A, in out RD = never, in out RE = never, out MA = void, out ME = never, in out MR = never>
|
||||||
@@ -1,9 +1,9 @@
|
|||||||
import { Effect, type Scope, Stream } from "effect"
|
import { Effect, type Scope, Stream } from "effect"
|
||||||
import { AsyncResult } from "effect/unstable/reactivity"
|
import { AsyncResult } from "effect/unstable/reactivity"
|
||||||
import { describe, expect, it } from "vitest"
|
import { describe, expect, it } from "vitest"
|
||||||
import * as Query from "../src/Query.js"
|
import * as Query from "./Query.js"
|
||||||
import * as QueryClient from "../src/QueryClient.js"
|
import * as QueryClient from "./QueryClient.js"
|
||||||
import * as View from "../src/View.js"
|
import * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
const runQueryTest = <A, E>(effect: Effect.Effect<A, E, QueryClient.QueryClient | Scope.Scope>) =>
|
const runQueryTest = <A, E>(effect: Effect.Effect<A, E, QueryClient.QueryClient | Scope.Scope>) =>
|
||||||
@@ -5,7 +5,7 @@ import * as QueryClient from "./QueryClient.js"
|
|||||||
import * as View from "./View.js"
|
import * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
export const QueryTypeId: unique symbol = Symbol.for("@effect-fc/Query/Query")
|
export const QueryTypeId: unique symbol = Symbol.for("@effect-view/Query/Query")
|
||||||
export type QueryTypeId = typeof QueryTypeId
|
export type QueryTypeId = typeof QueryTypeId
|
||||||
|
|
||||||
export interface Query<in out K, out A, out E = never, in out R = never>
|
export interface Query<in out K, out A, out E = never, in out R = never>
|
||||||
+4
-4
@@ -4,7 +4,7 @@ import * as Lens from "./Lens.js"
|
|||||||
import type * as View from "./View.js"
|
import type * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
export const QueryClientServiceTypeId: unique symbol = Symbol.for("@effect-fc/QueryClient/QueryClientService")
|
export const QueryClientServiceTypeId: unique symbol = Symbol.for("@effect-view/QueryClient/QueryClientService")
|
||||||
export type QueryClientServiceTypeId = typeof QueryClientServiceTypeId
|
export type QueryClientServiceTypeId = typeof QueryClientServiceTypeId
|
||||||
|
|
||||||
export interface QueryClientService extends Pipeable.Pipeable {
|
export interface QueryClientService extends Pipeable.Pipeable {
|
||||||
@@ -27,7 +27,7 @@ export interface QueryClientService extends Pipeable.Pipeable {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export class QueryClient extends Context.Service<QueryClient, QueryClientService>()(
|
export class QueryClient extends Context.Service<QueryClient, QueryClientService>()(
|
||||||
"@effect-fc/QueryClient/QueryClient"
|
"@effect-view/QueryClient/QueryClient"
|
||||||
) {}
|
) {}
|
||||||
|
|
||||||
export class QueryClientServiceImpl
|
export class QueryClientServiceImpl
|
||||||
@@ -129,7 +129,7 @@ export const service = (
|
|||||||
export const layer = (options?: service.Options) => Layer.effect(QueryClient, service(options))
|
export const layer = (options?: service.Options) => Layer.effect(QueryClient, service(options))
|
||||||
|
|
||||||
|
|
||||||
export const QueryClientCacheKeyTypeId: unique symbol = Symbol.for("@effect-fc/QueryClient/QueryClientCacheKey")
|
export const QueryClientCacheKeyTypeId: unique symbol = Symbol.for("@effect-view/QueryClient/QueryClientCacheKey")
|
||||||
export type QueryClientCacheKeyTypeId = typeof QueryClientCacheKeyTypeId
|
export type QueryClientCacheKeyTypeId = typeof QueryClientCacheKeyTypeId
|
||||||
|
|
||||||
export class QueryClientCacheKey
|
export class QueryClientCacheKey
|
||||||
@@ -155,7 +155,7 @@ implements Pipeable.Pipeable, Equal.Equal {
|
|||||||
export const isQueryClientCacheKey = (u: unknown): u is QueryClientCacheKey => Predicate.hasProperty(u, QueryClientCacheKeyTypeId)
|
export const isQueryClientCacheKey = (u: unknown): u is QueryClientCacheKey => Predicate.hasProperty(u, QueryClientCacheKeyTypeId)
|
||||||
|
|
||||||
|
|
||||||
export const QueryClientCacheEntryTypeId: unique symbol = Symbol.for("@effect-fc/QueryClient/QueryClientCacheEntry")
|
export const QueryClientCacheEntryTypeId: unique symbol = Symbol.for("@effect-view/QueryClient/QueryClientCacheEntry")
|
||||||
export type QueryClientCacheEntryTypeId = typeof QueryClientCacheEntryTypeId
|
export type QueryClientCacheEntryTypeId = typeof QueryClientCacheEntryTypeId
|
||||||
|
|
||||||
export class QueryClientCacheEntry
|
export class QueryClientCacheEntry
|
||||||
+3
-2
@@ -2,9 +2,10 @@
|
|||||||
import { type Context, Effect, Layer, ManagedRuntime, Predicate } from "effect"
|
import { type Context, Effect, Layer, ManagedRuntime, Predicate } from "effect"
|
||||||
import * as React from "react"
|
import * as React from "react"
|
||||||
import * as Component from "./Component.js"
|
import * as Component from "./Component.js"
|
||||||
|
import * as ScopeRegistry from "./ScopeRegistry.js"
|
||||||
|
|
||||||
|
|
||||||
export const ReactRuntimeTypeId: unique symbol = Symbol.for("@effect-fc/ReactRuntime/ReactRuntime")
|
export const ReactRuntimeTypeId: unique symbol = Symbol.for("@effect-view/ReactRuntime/ReactRuntime")
|
||||||
export type ReactRuntimeTypeId = typeof ReactRuntimeTypeId
|
export type ReactRuntimeTypeId = typeof ReactRuntimeTypeId
|
||||||
|
|
||||||
export interface ReactRuntime<R, ER> {
|
export interface ReactRuntime<R, ER> {
|
||||||
@@ -16,7 +17,7 @@ export interface ReactRuntime<R, ER> {
|
|||||||
|
|
||||||
const ReactRuntimePrototype = Object.freeze({ [ReactRuntimeTypeId]: ReactRuntimeTypeId } as const)
|
const ReactRuntimePrototype = Object.freeze({ [ReactRuntimeTypeId]: ReactRuntimeTypeId } as const)
|
||||||
|
|
||||||
export const preludeLayer: Layer.Layer<Component.ScopeMap> = Component.ScopeMap.layer
|
export const preludeLayer: Layer.Layer<ScopeRegistry.ScopeRegistry> = ScopeRegistry.layer
|
||||||
|
|
||||||
export const isReactRuntime = (u: unknown): u is ReactRuntime<unknown, unknown> => Predicate.hasProperty(u, ReactRuntimeTypeId)
|
export const isReactRuntime = (u: unknown): u is ReactRuntime<unknown, unknown> => Predicate.hasProperty(u, ReactRuntimeTypeId)
|
||||||
|
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest"
|
||||||
|
import type * as Component from "./Component.js"
|
||||||
|
import * as Refreshable from "./Refreshable.js"
|
||||||
|
|
||||||
|
|
||||||
|
describe("Refreshable", () => {
|
||||||
|
it("attaches a cell and notifies subscribers after a compatible update", async () => {
|
||||||
|
const first = {} as Component.Component.Any
|
||||||
|
const cell = Refreshable.makeCell(first, "hooks", false)
|
||||||
|
const listener = vi.fn()
|
||||||
|
|
||||||
|
expect(Refreshable.isRefreshable(first)).toBe(false)
|
||||||
|
const attached = Refreshable.attach(first, cell)
|
||||||
|
expect(attached).toBe(first)
|
||||||
|
expect(Refreshable.isRefreshable(first)).toBe(true)
|
||||||
|
expect(attached[Refreshable.RefreshableTypeId]).toBe(cell)
|
||||||
|
expect(Object.getPrototypeOf(attached).asFunctionComponent)
|
||||||
|
.toBe(Refreshable.RefreshablePrototype.asFunctionComponent)
|
||||||
|
|
||||||
|
cell.subscribe(listener)
|
||||||
|
const second = {} as Component.Component.Any
|
||||||
|
cell.update(second, "hooks", false)
|
||||||
|
|
||||||
|
expect(cell.current).toBe(second)
|
||||||
|
expect(cell.snapshot).toEqual({
|
||||||
|
revision: 1,
|
||||||
|
resetRevision: 0,
|
||||||
|
})
|
||||||
|
|
||||||
|
await Promise.resolve()
|
||||||
|
expect(listener).toHaveBeenCalledTimes(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("requests a remount when a signature changes or reset is forced", () => {
|
||||||
|
const component = {} as Component.Component.Any
|
||||||
|
const cell = Refreshable.makeCell(component, "one", false)
|
||||||
|
|
||||||
|
cell.update({} as Component.Component.Any, "two", false)
|
||||||
|
expect(cell.snapshot.resetRevision).toBe(1)
|
||||||
|
|
||||||
|
cell.update({} as Component.Component.Any, "two", true)
|
||||||
|
expect(cell.snapshot.resetRevision).toBe(2)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("builds the refresh shell from the current descriptor implementation", () => {
|
||||||
|
const implementation = () => null
|
||||||
|
const makeFunctionComponent = vi.fn(() => implementation)
|
||||||
|
const component = {
|
||||||
|
makeFunctionComponent,
|
||||||
|
} as unknown as Component.ComponentImpl.Any
|
||||||
|
const contextRef = {
|
||||||
|
current: {},
|
||||||
|
} as never
|
||||||
|
const cell = Refreshable.makeCell(component, "hooks", false)
|
||||||
|
const attached = Refreshable.attach(component, cell)
|
||||||
|
|
||||||
|
expect(attached.asFunctionComponent(contextRef)).not.toBe(implementation)
|
||||||
|
expect(makeFunctionComponent).toHaveBeenCalledWith(contextRef)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,181 @@
|
|||||||
|
import type { Context, Scope } from "effect"
|
||||||
|
import * as React from "react"
|
||||||
|
import type * as Component from "./Component.js"
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A stable identifier used to associate an Effect View descriptor with its
|
||||||
|
* development refresh cell.
|
||||||
|
*
|
||||||
|
* This low-level API is intended for development-server integrations such as
|
||||||
|
* `@effect-view/vite-plugin`.
|
||||||
|
*/
|
||||||
|
export const RefreshableTypeId: unique symbol = Symbol.for("@effect-view/Refreshable/Refreshable")
|
||||||
|
export type RefreshableTypeId = typeof RefreshableTypeId
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The version observed by a mounted Effect View refresh shell.
|
||||||
|
*
|
||||||
|
* `revision` changes for every update. `resetRevision` changes only when the
|
||||||
|
* adapter determines that preserving React state is unsafe.
|
||||||
|
*/
|
||||||
|
export interface Snapshot {
|
||||||
|
readonly revision: number
|
||||||
|
readonly resetRevision: number
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A mutable development cell holding the latest version of an Effect View
|
||||||
|
* descriptor.
|
||||||
|
*
|
||||||
|
* This low-level API is intended for development-server integrations.
|
||||||
|
*/
|
||||||
|
export interface Cell {
|
||||||
|
current: Component.ComponentImpl.Any
|
||||||
|
signature: string
|
||||||
|
forceReset: boolean
|
||||||
|
snapshot: Snapshot
|
||||||
|
readonly subscribe: (listener: () => void) => () => void
|
||||||
|
readonly getSnapshot: () => Snapshot
|
||||||
|
readonly update: (
|
||||||
|
component: Component.Component.Any,
|
||||||
|
signature: string,
|
||||||
|
forceReset: boolean,
|
||||||
|
) => void
|
||||||
|
}
|
||||||
|
|
||||||
|
export const RefreshablePrototype = Object.freeze({
|
||||||
|
asFunctionComponent<P extends {}, A extends React.ReactNode, E, R, F extends Component.Component.Signature>(
|
||||||
|
this: Component.ComponentImpl<P, A, E, R, F> & Refreshable,
|
||||||
|
contextRef: React.RefObject<Context.Context<Exclude<R, Scope.Scope>>>,
|
||||||
|
) {
|
||||||
|
const cell = this[RefreshableTypeId]
|
||||||
|
let current = cell.current
|
||||||
|
let functionComponent = current.makeFunctionComponent(contextRef)
|
||||||
|
|
||||||
|
// Calling the current renderer inside this stable component deliberately
|
||||||
|
// keeps its hooks on the same fiber until resetRevision changes.
|
||||||
|
const Implementation = (props: P) => {
|
||||||
|
if (current !== cell.current) {
|
||||||
|
current = cell.current
|
||||||
|
functionComponent = current.makeFunctionComponent(contextRef)
|
||||||
|
}
|
||||||
|
return functionComponent(props)
|
||||||
|
}
|
||||||
|
|
||||||
|
const RefreshableComponent = (props: P) => {
|
||||||
|
const snapshot = React.useSyncExternalStore(
|
||||||
|
cell.subscribe,
|
||||||
|
cell.getSnapshot,
|
||||||
|
cell.getSnapshot,
|
||||||
|
)
|
||||||
|
return React.createElement(Implementation, {
|
||||||
|
...props,
|
||||||
|
key: snapshot.resetRevision,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return RefreshableComponent as F
|
||||||
|
},
|
||||||
|
} as const)
|
||||||
|
|
||||||
|
export type RefreshablePrototype = typeof RefreshablePrototype
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A descriptor that can be connected to a development refresh cell.
|
||||||
|
*/
|
||||||
|
export interface Refreshable extends RefreshablePrototype {
|
||||||
|
readonly [RefreshableTypeId]: Cell
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether a descriptor has been connected to a development refresh
|
||||||
|
* cell.
|
||||||
|
*/
|
||||||
|
export const isRefreshable = <A extends object>(
|
||||||
|
value: A,
|
||||||
|
): value is A & Refreshable => Object.hasOwn(value, RefreshableTypeId)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a refresh cell for an Effect View descriptor.
|
||||||
|
*
|
||||||
|
* This low-level API is intended for development-server integrations.
|
||||||
|
*/
|
||||||
|
export const makeCell = (
|
||||||
|
component: Component.Component.Any,
|
||||||
|
signature: string,
|
||||||
|
forceReset: boolean,
|
||||||
|
): Cell => {
|
||||||
|
const listeners = new Set<() => void>()
|
||||||
|
let notificationPending = false
|
||||||
|
|
||||||
|
const cell: Cell = {
|
||||||
|
current: component as Component.ComponentImpl.Any,
|
||||||
|
signature,
|
||||||
|
forceReset,
|
||||||
|
snapshot: {
|
||||||
|
revision: 0,
|
||||||
|
resetRevision: 0,
|
||||||
|
},
|
||||||
|
subscribe(listener) {
|
||||||
|
listeners.add(listener)
|
||||||
|
return () => {
|
||||||
|
listeners.delete(listener)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
getSnapshot() {
|
||||||
|
return cell.snapshot
|
||||||
|
},
|
||||||
|
update(nextComponent, nextSignature, nextForceReset) {
|
||||||
|
const shouldReset = cell.forceReset
|
||||||
|
|| nextForceReset
|
||||||
|
|| cell.signature !== nextSignature
|
||||||
|
|
||||||
|
cell.current = nextComponent as Component.ComponentImpl.Any
|
||||||
|
cell.signature = nextSignature
|
||||||
|
cell.forceReset = nextForceReset
|
||||||
|
cell.snapshot = {
|
||||||
|
revision: cell.snapshot.revision + 1,
|
||||||
|
resetRevision: cell.snapshot.resetRevision + (shouldReset ? 1 : 0),
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!notificationPending) {
|
||||||
|
notificationPending = true
|
||||||
|
queueMicrotask(() => {
|
||||||
|
notificationPending = false
|
||||||
|
for (const listener of listeners)
|
||||||
|
listener()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
return cell
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Associates a descriptor with a refresh cell and returns the descriptor.
|
||||||
|
*
|
||||||
|
* This low-level API is intended for development-server integrations.
|
||||||
|
*/
|
||||||
|
export const attach = <A extends Component.Component.Any>(
|
||||||
|
component: A,
|
||||||
|
cell: Cell,
|
||||||
|
): A & Refreshable => {
|
||||||
|
if (!isRefreshable(component)) {
|
||||||
|
Object.setPrototypeOf(
|
||||||
|
component,
|
||||||
|
Object.freeze(Object.setPrototypeOf(
|
||||||
|
Object.assign({}, RefreshablePrototype),
|
||||||
|
Object.getPrototypeOf(component),
|
||||||
|
)),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
Object.defineProperty(component, RefreshableTypeId, {
|
||||||
|
configurable: true,
|
||||||
|
enumerable: true,
|
||||||
|
value: cell,
|
||||||
|
})
|
||||||
|
return component as A & Refreshable
|
||||||
|
}
|
||||||
@@ -0,0 +1,186 @@
|
|||||||
|
import { type Cause, Chunk, Context, DateTime, type Duration, Effect, Equal, Exit, HashMap, Layer, Option, Order, Predicate, Scope, Semaphore, Stream, SubscriptionRef } from "effect"
|
||||||
|
|
||||||
|
|
||||||
|
export const ScopeRegistryServiceTypeId: unique symbol = Symbol.for("@effect-view/ScopeRegistryService/ScopeRegistryService")
|
||||||
|
export type ScopeRegistryServiceTypeId = typeof ScopeRegistryServiceTypeId
|
||||||
|
|
||||||
|
export interface ScopeRegistryService {
|
||||||
|
readonly [ScopeRegistryServiceTypeId]: ScopeRegistryServiceTypeId
|
||||||
|
readonly ref: SubscriptionRef.SubscriptionRef<HashMap.HashMap<ScopeRegistryService.Key, ScopeRegistryService.Entry>>
|
||||||
|
|
||||||
|
register(
|
||||||
|
key: ScopeRegistryService.Key,
|
||||||
|
options: ScopeRegistryService.RegisterOptions,
|
||||||
|
): Effect.Effect<ScopeRegistryService.Entry>
|
||||||
|
commit(key: ScopeRegistryService.Key): Effect.Effect<ScopeRegistryService.Entry, Cause.NoSuchElementError>
|
||||||
|
release(key: ScopeRegistryService.Key): Effect.Effect<ScopeRegistryService.Entry, Cause.NoSuchElementError>
|
||||||
|
|
||||||
|
readonly run: Effect.Effect<void, never, Scope.Scope>
|
||||||
|
}
|
||||||
|
|
||||||
|
export declare namespace ScopeRegistryService {
|
||||||
|
export type Key = object
|
||||||
|
|
||||||
|
export interface RegisterOptions {
|
||||||
|
readonly finalizerExecutionStrategy: "sequential" | "parallel"
|
||||||
|
readonly finalizerExecutionDebounce: Duration.Input
|
||||||
|
readonly scopeCommitTimeout: Duration.Input
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Entry {
|
||||||
|
readonly scope: Scope.Closeable
|
||||||
|
readonly expiresAt: Option.Option<DateTime.Utc>
|
||||||
|
readonly finalizerExecutionDebounce: Duration.Input
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const isScopeRegistryService = (u: unknown): u is ScopeRegistryService => Predicate.hasProperty(u, ScopeRegistryServiceTypeId)
|
||||||
|
export const makeKey = (): ScopeRegistryService.Key => Equal.byReference({})
|
||||||
|
|
||||||
|
|
||||||
|
export class ScopeRegistryServiceImpl implements ScopeRegistryService {
|
||||||
|
readonly [ScopeRegistryServiceTypeId]: ScopeRegistryServiceTypeId = ScopeRegistryServiceTypeId
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
readonly ref: SubscriptionRef.SubscriptionRef<HashMap.HashMap<ScopeRegistryService.Key, ScopeRegistryService.Entry>>,
|
||||||
|
readonly runSemaphore: Semaphore.Semaphore,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
register(
|
||||||
|
key: ScopeRegistryService.Key,
|
||||||
|
options: ScopeRegistryService.RegisterOptions,
|
||||||
|
): Effect.Effect<ScopeRegistryService.Entry> {
|
||||||
|
return Effect.gen({ self: this }, function*() {
|
||||||
|
const entry = Equal.byReference({
|
||||||
|
scope: yield* Scope.make(options.finalizerExecutionStrategy),
|
||||||
|
expiresAt: Option.some(DateTime.addDuration(yield* DateTime.now, options.scopeCommitTimeout)),
|
||||||
|
finalizerExecutionDebounce: options.finalizerExecutionDebounce,
|
||||||
|
})
|
||||||
|
|
||||||
|
yield* SubscriptionRef.update(this.ref, HashMap.set(key, entry))
|
||||||
|
return entry
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
commit(key: ScopeRegistryService.Key): Effect.Effect<ScopeRegistryService.Entry, Cause.NoSuchElementError> {
|
||||||
|
return SubscriptionRef.get(this.ref).pipe(
|
||||||
|
Effect.map(HashMap.get(key)),
|
||||||
|
Effect.flatMap(Effect.fromOption),
|
||||||
|
Effect.map(entry => Equal.byReference<ScopeRegistryService.Entry>({
|
||||||
|
...entry,
|
||||||
|
expiresAt: Option.none(),
|
||||||
|
})),
|
||||||
|
Effect.tap(entry => SubscriptionRef.update(this.ref, HashMap.set(key, entry))),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
release(key: ScopeRegistryService.Key): Effect.Effect<ScopeRegistryService.Entry, Cause.NoSuchElementError> {
|
||||||
|
return SubscriptionRef.get(this.ref).pipe(
|
||||||
|
Effect.map(HashMap.get(key)),
|
||||||
|
Effect.flatMap(option => Effect.all([
|
||||||
|
DateTime.now,
|
||||||
|
Effect.fromOption(option),
|
||||||
|
])),
|
||||||
|
Effect.map(([now, entry]) => Equal.byReference<ScopeRegistryService.Entry>({
|
||||||
|
...entry,
|
||||||
|
expiresAt: Option.some(DateTime.addDuration(now, entry.finalizerExecutionDebounce)),
|
||||||
|
})),
|
||||||
|
Effect.tap(entry => SubscriptionRef.update(this.ref, HashMap.set(key, entry))),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
get run(): Effect.Effect<void, never, Scope.Scope> {
|
||||||
|
return Effect.addFinalizer(() => this.dispose).pipe(
|
||||||
|
Effect.andThen(SubscriptionRef.changes(this.ref).pipe(
|
||||||
|
Stream.switchMap(entries => Option.match(this.getNextExpiration(entries), {
|
||||||
|
onNone: () => Stream.never,
|
||||||
|
onSome: expiresAt => Stream.fromEffect(DateTime.now.pipe(
|
||||||
|
Effect.flatMap(now => DateTime.isLessThan(now, expiresAt)
|
||||||
|
? Effect.sleep(DateTime.distance(now, expiresAt))
|
||||||
|
: Effect.void),
|
||||||
|
Effect.andThen(Effect.uninterruptible(this.closeExpired)),
|
||||||
|
)),
|
||||||
|
})),
|
||||||
|
Stream.runDrain,
|
||||||
|
)),
|
||||||
|
this.runSemaphore.withPermit,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
get dispose(): Effect.Effect<void> {
|
||||||
|
return SubscriptionRef.getAndSet(
|
||||||
|
this.ref,
|
||||||
|
HashMap.empty<ScopeRegistryService.Key, ScopeRegistryService.Entry>(),
|
||||||
|
).pipe(
|
||||||
|
Effect.flatMap(entries => Effect.forEach(
|
||||||
|
HashMap.values(entries),
|
||||||
|
entry => Scope.close(entry.scope, Exit.void),
|
||||||
|
)),
|
||||||
|
Effect.asVoid,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
get closeExpired(): Effect.Effect<void> {
|
||||||
|
return Effect.flatMap(DateTime.now, now => SubscriptionRef.modify(
|
||||||
|
this.ref,
|
||||||
|
HashMap.reduce(
|
||||||
|
[
|
||||||
|
Chunk.empty<ScopeRegistryService.Entry>(),
|
||||||
|
HashMap.empty<ScopeRegistryService.Key, ScopeRegistryService.Entry>(),
|
||||||
|
] as const,
|
||||||
|
|
||||||
|
([expired, remaining], entry, key) => Option.exists(
|
||||||
|
entry.expiresAt,
|
||||||
|
expiresAt => DateTime.isLessThanOrEqualTo(expiresAt, now),
|
||||||
|
)
|
||||||
|
? [Chunk.append(expired, entry), remaining] as const
|
||||||
|
: [expired, HashMap.set(remaining, key, entry)] as const,
|
||||||
|
),
|
||||||
|
)).pipe(
|
||||||
|
Effect.flatMap(entries => Effect.forEach(
|
||||||
|
entries,
|
||||||
|
entry => Scope.close(entry.scope, Exit.void),
|
||||||
|
)),
|
||||||
|
Effect.asVoid,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
getNextExpiration(
|
||||||
|
entries: HashMap.HashMap<ScopeRegistryService.Key, ScopeRegistryService.Entry>,
|
||||||
|
): Option.Option<DateTime.Utc> {
|
||||||
|
return HashMap.reduce(
|
||||||
|
entries,
|
||||||
|
Option.none<DateTime.Utc>(),
|
||||||
|
(earliest, entry) => Option.match(entry.expiresAt, {
|
||||||
|
onNone: () => earliest,
|
||||||
|
onSome: expiresAt => Option.some(Option.match(earliest, {
|
||||||
|
onNone: () => expiresAt,
|
||||||
|
onSome: Order.min<DateTime.Utc>(DateTime.Order)(expiresAt),
|
||||||
|
})),
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const make: Effect.Effect<ScopeRegistryService> = Effect.gen(function*() {
|
||||||
|
return new ScopeRegistryServiceImpl(
|
||||||
|
yield* SubscriptionRef.make(HashMap.empty<ScopeRegistryService.Key, ScopeRegistryService.Entry>()),
|
||||||
|
yield* Semaphore.make(1),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Internal Effect service that maintains a registry of scopes associated with React component instances.
|
||||||
|
*
|
||||||
|
* This service is used internally by the `Component.useScope` hook to manage the lifecycle of component scopes,
|
||||||
|
* including tracking active scopes and coordinating their cleanup when components unmount or dependencies change.
|
||||||
|
*/
|
||||||
|
export class ScopeRegistry extends Context.Service<ScopeRegistry, ScopeRegistryService>()(
|
||||||
|
"@effect-view/ScopeRegistry/ScopeRegistry"
|
||||||
|
) {}
|
||||||
|
|
||||||
|
export const layer = Layer.effect(ScopeRegistry, Effect.tap(
|
||||||
|
make,
|
||||||
|
registry => Effect.forkScoped(registry.run),
|
||||||
|
))
|
||||||
@@ -2,9 +2,9 @@ import { render, screen, waitFor } from "@testing-library/react"
|
|||||||
import { Effect, Layer, SubscriptionRef } from "effect"
|
import { Effect, Layer, SubscriptionRef } from "effect"
|
||||||
import { Lens } from "effect-lens"
|
import { Lens } from "effect-lens"
|
||||||
import { describe, expect, it } from "vitest"
|
import { describe, expect, it } from "vitest"
|
||||||
import * as Component from "../src/Component.js"
|
import * as Component from "./Component.js"
|
||||||
import * as ReactRuntime from "../src/ReactRuntime.js"
|
import * as ReactRuntime from "./ReactRuntime.js"
|
||||||
import * as View from "../src/View.js"
|
import * as View from "./View.js"
|
||||||
|
|
||||||
|
|
||||||
const makeRuntime = async () => {
|
const makeRuntime = async () => {
|
||||||
@@ -28,8 +28,10 @@ export const useAll = Effect.fnUntraced(function* <const T extends readonly View
|
|||||||
yield* Component.useOnMount(() => Effect.all(elements.map(View.get)))
|
yield* Component.useOnMount(() => Effect.all(elements.map(View.get)))
|
||||||
)
|
)
|
||||||
|
|
||||||
yield* Component.useReactEffect(() => View.changes(View.zipLatestAll(...elements)).pipe(
|
yield* Component.useReactEffect(() => Stream.make(reactStateValue).pipe(
|
||||||
|
Stream.concat(View.changes(View.zipLatestAll(...elements))),
|
||||||
Stream.changesWith((options?.equivalence as Equivalence.Equivalence<any[]> | undefined) ?? Equivalence.Array(Equivalence.strictEqual())),
|
Stream.changesWith((options?.equivalence as Equivalence.Equivalence<any[]> | undefined) ?? Equivalence.Array(Equivalence.strictEqual())),
|
||||||
|
Stream.drop(1),
|
||||||
Stream.runForEach(v =>
|
Stream.runForEach(v =>
|
||||||
Effect.sync(() => setReactStateValue(v))
|
Effect.sync(() => setReactStateValue(v))
|
||||||
),
|
),
|
||||||
@@ -1,6 +1,5 @@
|
|||||||
export * as Async from "./Async.js"
|
export * as Async from "./Async.js"
|
||||||
export * as Component from "./Component.js"
|
export * as Component from "./Component.js"
|
||||||
export * as ErrorObserver from "./ErrorObserver.js"
|
|
||||||
export * as Form from "./Form.js"
|
export * as Form from "./Form.js"
|
||||||
export * as Lens from "./Lens.js"
|
export * as Lens from "./Lens.js"
|
||||||
export * as LensForm from "./LensForm.js"
|
export * as LensForm from "./LensForm.js"
|
||||||
@@ -11,6 +10,8 @@ export * as PubSub from "./PubSub.js"
|
|||||||
export * as Query from "./Query.js"
|
export * as Query from "./Query.js"
|
||||||
export * as QueryClient from "./QueryClient.js"
|
export * as QueryClient from "./QueryClient.js"
|
||||||
export * as ReactRuntime from "./ReactRuntime.js"
|
export * as ReactRuntime from "./ReactRuntime.js"
|
||||||
|
export * as Refreshable from "./Refreshable.js"
|
||||||
|
export * as ScopeRegistry from "./ScopeRegistry.js"
|
||||||
export * as SetStateAction from "./SetStateAction.js"
|
export * as SetStateAction from "./SetStateAction.js"
|
||||||
export * as Stream from "./Stream.js"
|
export * as Stream from "./Stream.js"
|
||||||
export * as View from "./View.js"
|
export * as View from "./View.js"
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user