optimistix (#257)

Author: tim-smart

.changeset/deep-sheep-sink.md

@@ -0,0 +1,5 @@
+---
+"@effect-rx/rx": minor
+---
+
+add timestamp to Result.Success

.changeset/happy-sites-feel.md

@@ -0,0 +1,5 @@
+---
+"@effect-rx/rx": patch
+---
+
+add Rx.withOptimisticSet

docs/rx-react/Hooks.ts.md

@@ -120,7 +120,7 @@ Added in v1.0.0
 ```ts
 export declare const useRxSetPromise: <E, A, W>(
   rx: Rx.Writable<Result.Result<A, E>, W>
-) => (_: W) => Promise<Exit.Exit<A, E>>
+) => (_: W, options?: { readonly signal?: AbortSignal | undefined } | undefined) => Promise<Exit.Exit<A, E>>
 ```
 
 Added in v1.0.0

docs/rx-react/index.md

@@ -2,5 +2,5 @@
 title: "@effect-rx/rx-react"
 has_children: true
 permalink: /docs/rx-react
-nav_order: 3
+nav_order: 4
 ---

docs/rx-vue/index.md

@@ -2,5 +2,5 @@
 title: "@effect-rx/rx-vue"
 has_children: true
 permalink: /docs/rx-vue
-nav_order: 4
+nav_order: 5
 ---

docs/rx/Hydration.ts.md

@@ -30,7 +30,7 @@ Added in v1.0.0
 ```ts
 export declare const dehydrate: (
   registry: Registry.Registry,
-  options?: { readonly encodeInitialAs?: "ignore" | "promise" | "value-only" }
+  options?: { readonly encodeInitialAs?: "ignore" | "promise" | "value-only" | undefined }
 ) => Array<DehydratedRx>
 ```
 

docs/rx/Result.ts.md

@@ -91,6 +91,7 @@ export type Encoded<A, E> =
   | {
       readonly _tag: "Success"
       readonly waiting: boolean
+      readonly timestamp: number
       readonly value: A
     }
   | {
@@ -116,6 +117,7 @@ export type PartialEncoded<A, E> =
   | {
       readonly _tag: "Success"
       readonly waiting: boolean
+      readonly timestamp: number
       readonly value: A
     }
   | {
@@ -314,7 +316,13 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const fail: <E, A = never>(error: E, previousData?: Option.Option<A>, waiting?: boolean) => Failure<A, E>
+export declare const fail: <E, A = never>(
+  error: E,
+  options?: {
+    readonly previousSuccess?: Option.Option<Success<A, E>> | undefined
+    readonly waiting?: boolean | undefined
+  }
+) => Failure<A, E>
 ```
 
 Added in v1.0.0
@@ -326,8 +334,7 @@ Added in v1.0.0
 ```ts
 export declare const failWithPrevious: <A, E>(
   error: E,
-  previous: Option.Option<Result<A, E>>,
-  waiting?: boolean
+  options: { readonly previous: Option.Option<Result<A, E>>; readonly waiting?: boolean | undefined }
 ) => Failure<A, E>
 ```
 
@@ -340,8 +347,10 @@ Added in v1.0.0
 ```ts
 export declare const failure: <E, A = never>(
   cause: Cause.Cause<E>,
-  previousValue?: Option.Option<A>,
-  waiting?: boolean
+  options?: {
+    readonly previousSuccess?: Option.Option<Success<A, E>> | undefined
+    readonly waiting?: boolean | undefined
+  }
 ) => Failure<A, E>
 ```
 
@@ -354,8 +363,7 @@ Added in v1.0.0
 ```ts
 export declare const failureWithPrevious: <A, E>(
   cause: Cause.Cause<E>,
-  previous: Option.Option<Result<A, E>>,
-  waiting?: boolean
+  options: { readonly previous: Option.Option<Result<A, E>>; readonly waiting?: boolean | undefined }
 ) => Failure<A, E>
 ```
 
@@ -412,7 +420,10 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const success: <A, E = never>(value: A, waiting?: boolean) => Success<A, E>
+export declare const success: <A, E = never>(
+  value: A,
+  options?: { readonly waiting?: boolean | undefined; readonly timestamp?: number | undefined }
+) => Success<A, E>
 ```
 
 Added in v1.0.0
@@ -447,7 +458,7 @@ Added in v1.0.0
 export interface Failure<A, E = never> extends Result.Proto<A, E> {
   readonly _tag: "Failure"
   readonly cause: Cause.Cause<E>
-  readonly previousValue: Option.Option<A>
+  readonly previousSuccess: Option.Option<Success<A, E>>
 }
 ```
 
@@ -540,6 +551,7 @@ Added in v1.0.0
 export interface Success<A, E = never> extends Result.Proto<A, E> {
   readonly _tag: "Success"
   readonly value: A
+  readonly timestamp: number
 }
 ```
 

docs/rx/Rx.ts.md

@@ -23,6 +23,7 @@ Added in v1.0.0
   - [update](#update)
 - [Focus](#focus)
   - [makeRefreshOnSignal](#makerefreshonsignal)
+  - [refreshOnWindowFocus](#refreshonwindowfocus)
   - [windowFocusSignal](#windowfocussignal)
 - [KeyValueStore](#keyvaluestore)
   - [kvs](#kvs)
@@ -41,13 +42,13 @@ Added in v1.0.0
   - [keepAlive](#keepalive)
   - [map](#map)
   - [mapResult](#mapresult)
-  - [refreshOnWindowFocus](#refreshonwindowfocus)
   - [serializable](#serializable-1)
   - [setIdleTTL](#setidlettl)
   - [setLazy](#setlazy)
   - [transform](#transform)
   - [withFallback](#withfallback)
   - [withLabel](#withlabel)
+  - [withOptimisticSet](#withoptimisticset)
 - [constructors](#constructors)
   - [context](#context)
   - [family](#family)
@@ -88,9 +89,6 @@ Added in v1.0.0
   - [TypeId (type alias)](#typeid-type-alias)
   - [WritableTypeId](#writabletypeid)
   - [WritableTypeId (type alias)](#writabletypeid-type-alias)
-- [utils](#utils)
-  - [RxResultFn (namespace)](#rxresultfn-namespace)
-    - [ArgToVoid (type alias)](#argtovoid-type-alias)
 
 ---
 
@@ -199,6 +197,16 @@ export declare const makeRefreshOnSignal: <_>(
 
 Added in v1.0.0
 
+## refreshOnWindowFocus
+
+**Signature**
+
+```ts
+export declare const refreshOnWindowFocus: <A extends Rx<any>>(self: A) => Rx.WithoutSerializable<A>
+```
+
+Added in v1.0.0
+
 ## windowFocusSignal
 
 **Signature**
@@ -385,16 +393,6 @@ export declare const mapResult: {
 
 Added in v1.0.0
 
-## refreshOnWindowFocus
-
-**Signature**
-
-```ts
-export declare const refreshOnWindowFocus: <A extends Rx<any>>(self: A) => Rx.WithoutSerializable<A>
-```
-
-Added in v1.0.0
-
 ## serializable
 
 **Signature**
@@ -495,6 +493,33 @@ export declare const withLabel: {
 
 Added in v1.0.0
 
+## withOptimisticSet
+
+**Signature**
+
+```ts
+export declare const withOptimisticSet: {
+  <A, XA, XE, W = A extends Result.Result<infer _A, infer _E> ? _A : A>(options: {
+    readonly updateToValue: (
+      value: W,
+      current: NoInfer<A>
+    ) => A extends Result.Result<infer _A, infer _E> ? _A : NoInfer<A>
+    readonly fn: RxResultFn<NoInfer<W>, XA, XE>
+    readonly disableRefresh?: boolean | undefined
+  }): (self: Rx<A>) => Writable<A, W>
+  <A, XA, XE, W = A extends Result.Result<infer _A, infer _E> ? _A : A>(
+    self: Rx<A>,
+    options: {
+      readonly updateToValue: (value: W, current: NoInfer<A>) => A extends Result.Result<infer _A, infer _E> ? _A : A
+      readonly fn: RxResultFn<NoInfer<W>, XA, XE>
+      readonly disableRefresh?: boolean | undefined
+    }
+  ): Writable<A, W>
+}
+```
+
+Added in v1.0.0
+
 # constructors
 
 ## context
@@ -526,19 +551,19 @@ export declare const fn: {
   <Arg>(): <E, A>(
     fn: (arg: Arg, get: FnContext) => Effect.Effect<A, E, Scope.Scope | RxRegistry>,
     options?: { readonly initialValue?: A }
-  ) => RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E>
-  <Arg, E, A>(
+  ) => RxResultFn<Arg, A, E>
+  <E, A, Arg = void>(
     fn: (arg: Arg, get: FnContext) => Effect.Effect<A, E, Scope.Scope | RxRegistry>,
     options?: { readonly initialValue?: A }
-  ): RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E>
+  ): RxResultFn<Arg, A, E>
   <Arg>(): <E, A>(
     fn: (arg: Arg, get: FnContext) => Stream.Stream<A, E, RxRegistry>,
     options?: { readonly initialValue?: A }
-  ) => RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E | NoSuchElementException>
-  <Arg, E, A>(
+  ) => RxResultFn<Arg, A, E | NoSuchElementException>
+  <E, A, Arg = void>(
     fn: (arg: Arg, get: FnContext) => Stream.Stream<A, E, RxRegistry>,
     options?: { readonly initialValue?: A }
-  ): RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E | NoSuchElementException>
+  ): RxResultFn<Arg, A, E | NoSuchElementException>
 }
 ```
 
@@ -551,17 +576,11 @@ Added in v1.0.0
 ```ts
 export declare const fnSync: {
   <Arg>(): {
-    <A>(f: (arg: Arg, get: FnContext) => A): Writable<Option.Option<A>, RxResultFn.ArgToVoid<Arg>>
-    <A>(
-      f: (arg: Arg, get: FnContext) => A,
-      options: { readonly initialValue: A }
-    ): Writable<A, RxResultFn.ArgToVoid<Arg>>
+    <A>(f: (arg: Arg, get: FnContext) => A): Writable<Option.Option<A>, Arg>
+    <A>(f: (arg: Arg, get: FnContext) => A, options: { readonly initialValue: A }): Writable<A, Arg>
   }
-  <Arg, A>(f: (arg: Arg, get: FnContext) => A): Writable<Option.Option<A>, RxResultFn.ArgToVoid<Arg>>
-  <Arg, A>(
-    f: (arg: Arg, get: FnContext) => A,
-    options: { readonly initialValue: A }
-  ): Writable<A, RxResultFn.ArgToVoid<Arg>>
+  <A, Arg = void>(f: (arg: Arg, get: FnContext) => A): Writable<Option.Option<A>, Arg>
+  <A, Arg = void>(f: (arg: Arg, get: FnContext) => A, options: { readonly initialValue: A }): Writable<A, Arg>
 }
 ```
 
@@ -927,26 +946,26 @@ export interface RxRuntime<R, ER> extends Rx<Result.Result<Runtime.Runtime<R>, E
         options?: {
           readonly initialValue?: A
         }
-      ): RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E | ER>
+      ): RxResultFn<Arg, A, E | ER>
       <E, A>(
         fn: (arg: Arg, get: FnContext) => Stream.Stream<A, E, RxRegistry | R>,
         options?: {
           readonly initialValue?: A
         }
-      ): RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E | ER | NoSuchElementException>
+      ): RxResultFn<Arg, A, E | ER | NoSuchElementException>
     }
-    <Arg, E, A>(
+    <E, A, Arg = void>(
       fn: (arg: Arg, get: FnContext) => Effect.Effect<A, E, Scope.Scope | RxRegistry | R>,
       options?: {
         readonly initialValue?: A
       }
-    ): RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E | ER>
-    <Arg, E, A>(
+    ): RxResultFn<Arg, A, E | ER>
+    <E, A, Arg = void>(
       fn: (arg: Arg, get: FnContext) => Stream.Stream<A, E, RxRegistry | R>,
       options?: {
         readonly initialValue?: A
       }
-    ): RxResultFn<RxResultFn.ArgToVoid<Arg>, A, E | ER | NoSuchElementException>
+    ): RxResultFn<Arg, A, E | ER | NoSuchElementException>
   }
 
   readonly pull: <A, E>(
@@ -1061,19 +1080,3 @@ export type WritableTypeId = typeof WritableTypeId
 ```
 
 Added in v1.0.0
-
-# utils
-
-## RxResultFn (namespace)
-
-Added in v1.0.0
-
-### ArgToVoid (type alias)
-
-**Signature**
-
-```ts
-export type ArgToVoid<Arg> = Arg extends infer A ? (unknown extends A ? void : A extends undefined ? void : A) : never
-```
-
-Added in v1.0.0

package.json

@@ -27,15 +27,16 @@
     "@effect/build-utils": "^0.8.9",
     "@effect/docgen": "^0.5.2",
     "@effect/eslint-plugin": "^0.3.2",
-    "@effect/language-service": "^0.28.2",
+    "@effect/language-service": "^0.31.2",
+    "@effect/vitest": "^0.25.0",
     "@eslint/compat": "^1.3.1",
     "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.31.0",
+    "@eslint/js": "^9.32.0",
     "@typescript-eslint/eslint-plugin": "^8.38.0",
     "@typescript-eslint/parser": "^8.38.0",
     "@vitest/coverage-v8": "^3.2.4",
     "babel-plugin-annotate-pure-calls": "^0.5.0",
-    "eslint": "^9.31.0",
+    "eslint": "^9.32.0",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-codegen": "^0.33.0",
     "eslint-plugin-deprecation": "^3.0.0",

packages/rx-livestore/package.json

@@ -25,7 +25,7 @@
   "sideEffects": [],
   "devDependencies": {
     "@livestore/livestore": "^0.3.1",
-    "effect": "^3.17.0"
+    "effect": "^3.17.2"
   },
   "peerDependencies": {
     "@livestore/livestore": "*",