improve Serializable compatibility

Author: tim-smart

.changeset/thick-apes-make.md

@@ -0,0 +1,6 @@
+---
+"@effect-atom/atom-react": patch
+"@effect-atom/atom": patch
+---
+
+improve Serializable compatibility

docs/atom/Atom.ts.md

@@ -323,11 +323,11 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export interface Serializable {
+export interface Serializable<S extends Schema.Schema.Any> {
   readonly [SerializableTypeId]: {
     readonly key: string
-    readonly encode: (value: unknown) => unknown
-    readonly decode: (value: unknown) => unknown
+    readonly encode: (value: S["Type"]) => S["Encoded"]
+    readonly decode: (value: S["Encoded"]) => S["Type"]
   }
 }
 ```
@@ -359,7 +359,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const isSerializable: (self: Atom<any>) => self is Atom<any> & Serializable
+export declare const isSerializable: (self: Atom<any>) => self is Atom<any> & Serializable<any>
 ```
 
 Added in v1.0.0
@@ -548,14 +548,14 @@ Added in v1.0.0
 
 ```ts
 export declare const serializable: {
-  <R extends Atom<any>, I>(options: {
+  <R extends Atom<any>, S extends Schema.Schema<Type<R>, any>>(options: {
     readonly key: string
-    readonly schema: Schema.Schema<Type<R>, I>
-  }): (self: R) => R & Serializable
-  <R extends Atom<any>, I>(
+    readonly schema: S
+  }): (self: R) => R & Serializable<S>
+  <R extends Atom<any>, S extends Schema.Schema<Type<R>, any>>(
     self: R,
-    options: { readonly key: string; readonly schema: Schema.Schema<Type<R>, I> }
-  ): R & Serializable
+    options: { readonly key: string; readonly schema: S }
+  ): R & Serializable<S>
 }
 ```
 

docs/atom/Hydration.ts.md

@@ -14,10 +14,12 @@ Added in v1.0.0
 
 - [dehydration](#dehydration)
   - [dehydrate](#dehydrate)
+  - [toValues](#tovalues)
 - [hydration](#hydration)
   - [hydrate](#hydrate)
 - [models](#models)
   - [DehydratedAtom (interface)](#dehydratedatom-interface)
+  - [DehydratedAtomValue (interface)](#dehydratedatomvalue-interface)
 
 ---
 
@@ -36,6 +38,16 @@ export declare const dehydrate: (
 
 Added in v1.0.0
 
+## toValues
+
+**Signature**
+
+```ts
+export declare const toValues: (state: ReadonlyArray<DehydratedAtom>) => Array<DehydratedAtomValue>
+```
+
+Added in v1.0.0
+
 # hydration
 
 ## hydrate
@@ -56,6 +68,18 @@ Added in v1.0.0
 
 ```ts
 export interface DehydratedAtom {
+  readonly "~@effect-atom/atom/DehydratedAtom": true
+}
+```
+
+Added in v1.0.0
+
+## DehydratedAtomValue (interface)
+
+**Signature**
+
+```ts
+export interface DehydratedAtomValue extends DehydratedAtom {
   readonly key: string
   readonly value: unknown
   readonly dehydratedAt: number

packages/atom-react/src/ReactHydration.ts

@@ -40,13 +40,13 @@ export const HydrationBoundary: React.FC<HydrationBoundaryProps> = ({
   // If the transition is aborted, we will have hydrated any _new_ Atom values, but
   // we throw away the fresh data for any existing ones to avoid unexpectedly
   // updating the UI.
-  const hydrationQueue: Array<Hydration.DehydratedAtom> | undefined = React.useMemo(() => {
+  const hydrationQueue: Array<Hydration.DehydratedAtomValue> | undefined = React.useMemo(() => {
     if (state) {
-      const dehydratedAtoms = Array.from(state)
+      const dehydratedAtoms = Array.from(state) as Array<Hydration.DehydratedAtomValue>
       const nodes = registry.getNodes()
 
-      const newDehydratedAtoms: Array<Hydration.DehydratedAtom> = []
-      const existingDehydratedAtoms: Array<Hydration.DehydratedAtom> = []
+      const newDehydratedAtoms: Array<Hydration.DehydratedAtomValue> = []
+      const existingDehydratedAtoms: Array<Hydration.DehydratedAtomValue> = []
 
       for (const dehydratedAtom of dehydratedAtoms) {
         const existingNode = nodes.get(dehydratedAtom.key)

packages/atom/src/Atom.ts

@@ -2023,37 +2023,37 @@ export type SerializableTypeId = "~effect-atom/atom/Atom/Serializable"
  * @since 1.0.0
  * @category Serializable
  */
-export interface Serializable {
+export interface Serializable<S extends Schema.Schema.Any> {
   readonly [SerializableTypeId]: {
     readonly key: string
-    readonly encode: (value: unknown) => unknown
-    readonly decode: (value: unknown) => unknown
+    readonly encode: (value: S["Type"]) => S["Encoded"]
+    readonly decode: (value: S["Encoded"]) => S["Type"]
   }
 }
 
 /**
  * @since 1.0.0
  * @category Serializable
  */
-export const isSerializable = (self: Atom<any>): self is Atom<any> & Serializable => SerializableTypeId in self
+export const isSerializable = (self: Atom<any>): self is Atom<any> & Serializable<any> => SerializableTypeId in self
 
 /**
  * @since 1.0.0
  * @category combinators
  */
 export const serializable: {
-  <R extends Atom<any>, I>(options: {
+  <R extends Atom<any>, S extends Schema.Schema<Type<R>, any>>(options: {
     readonly key: string
-    readonly schema: Schema.Schema<Type<R>, I>
-  }): (self: R) => R & Serializable
-  <R extends Atom<any>, I>(self: R, options: {
+    readonly schema: S
+  }): (self: R) => R & Serializable<S>
+  <R extends Atom<any>, S extends Schema.Schema<Type<R>, any>>(self: R, options: {
     readonly key: string
-    readonly schema: Schema.Schema<Type<R>, I>
-  }): R & Serializable
+    readonly schema: S
+  }): R & Serializable<S>
 } = dual(2, <R extends Atom<any>, A, I>(self: R, options: {
   readonly key: string
   readonly schema: Schema.Schema<A, I>
-}): R & Serializable =>
+}): R & Serializable<any> =>
   Object.assign(Object.create(Object.getPrototypeOf(self)), {
     ...self,
     label: self.label ?? [options.key, new Error().stack?.split("\n")[5] ?? ""],

packages/atom/src/Hydration.ts

@@ -11,6 +11,14 @@ import * as Result from "./Result.js"
  * @category models
  */
 export interface DehydratedAtom {
+  readonly "~@effect-atom/atom/DehydratedAtom": true
+}
+
+/**
+ * @since 1.0.0
+ * @category models
+ */
+export interface DehydratedAtomValue extends DehydratedAtom {
   readonly key: string
   readonly value: unknown
   readonly dehydratedAt: number
@@ -31,7 +39,7 @@ export const dehydrate = (
   }
 ): Array<DehydratedAtom> => {
   const encodeInitialResultMode = options?.encodeInitialAs ?? "ignore"
-  const arr = Arr.empty<DehydratedAtom>()
+  const arr = Arr.empty<DehydratedAtomValue>()
   const now = Date.now()
   registry.getNodes().forEach((node, key) => {
     if (!Atom.isSerializable(node.atom)) return
@@ -55,15 +63,22 @@ export const dehydrate = (
     }
 
     arr.push({
+      "~@effect-atom/atom/DehydratedAtom": true,
       key: key as string,
       value: encodedValue,
       dehydratedAt: now,
       resultPromise
     })
   })
-  return arr
+  return arr as any
 }
 
+/**
+ * @since 1.0.0
+ * @category dehydration
+ */
+export const toValues = (state: ReadonlyArray<DehydratedAtom>): Array<DehydratedAtomValue> => state as any
+
 /**
  * @since 1.0.0
  * @category hydration
@@ -72,7 +87,7 @@ export const hydrate = (
   registry: Registry.Registry,
   dehydratedState: Iterable<DehydratedAtom>
 ): void => {
-  for (const datom of dehydratedState) {
+  for (const datom of (dehydratedState as Iterable<DehydratedAtomValue>)) {
     registry.setSerializable(datom.key, datom.value)
 
     // If there's a resultPromise, it means this was in Initial state when dehydrated

packages/atom/test/Atom.test.ts

@@ -1135,14 +1135,15 @@ describe("Atom", () => {
     }))
     r.mount(pending)
 
-    const state = Hydration.dehydrate(r, {
+    const state = Hydration.toValues(Hydration.dehydrate(r, {
       encodeInitialAs: "promise"
-    })
+    }))
     expect(state.map((r) => Struct.omit(r, "dehydratedAt", "resultPromise"))).toMatchInlineSnapshot(`
       [
         {
           "key": "basicSerializable",
           "value": 0,
+          "~@effect-atom/atom/DehydratedAtom": true,
         },
         {
           "key": "errored",
@@ -1157,6 +1158,7 @@ describe("Atom", () => {
             },
             "waiting": false,
           },
+          "~@effect-atom/atom/DehydratedAtom": true,
         },
         {
           "key": "success",
@@ -1166,13 +1168,15 @@ describe("Atom", () => {
             "value": 123,
             "waiting": false,
           },
+          "~@effect-atom/atom/DehydratedAtom": true,
         },
         {
           "key": "pending",
           "value": {
             "_tag": "Initial",
             "waiting": true,
           },
+          "~@effect-atom/atom/DehydratedAtom": true,
         },
       ]
     `)