atom.io 0.36.0 → 0.36.1

package/src/main/find-state.ts

@@ -30,7 +30,7 @@ import type { MutableAtomFamilyToken, RegularAtomFamilyToken } from "./tokens"
  * @overload Mutable Atom
  */
 export function findState<
-	T extends Transceiver<any, any>,
+	T extends Transceiver<any, any, any>,
 	K extends Canonical,
 	Key extends K,
 >(token: MutableAtomFamilyToken<T, K>, key: Key): MutableAtomToken<T, K>

package/src/main/get-state.ts

@@ -1,4 +1,5 @@
-import * as Internal from "atom.io/internal"
+import type { ViewOf } from "atom.io/internal"
+import { getFromStore, IMPLICIT } from "atom.io/internal"
 import type { Canonical } from "atom.io/json"
 
 import type { ReadableFamilyToken, ReadableToken } from "."
@@ -10,7 +11,7 @@ import type { ReadableFamilyToken, ReadableToken } from "."
  * @overload Default
  * @default
  */
-export function getState<T>(token: ReadableToken<T>): T
+export function getState<T>(token: ReadableToken<T>): ViewOf<T>
 
 /**
  * Read or compute the current value of a state
@@ -22,7 +23,7 @@ export function getState<T>(token: ReadableToken<T>): T
 export function getState<T, K extends Canonical, Key extends K>(
 	token: ReadableFamilyToken<T, K>,
 	key: Key,
-): T
+): ViewOf<T>
 
 export function getState(
 	...params:
@@ -30,7 +31,7 @@ export function getState(
 		| [token: ReadableToken<any>]
 ): any {
 	if (params.length === 2) {
-		return Internal.getFromStore(Internal.IMPLICIT.STORE, ...params)
+		return getFromStore(IMPLICIT.STORE, ...params)
 	}
-	return Internal.getFromStore(Internal.IMPLICIT.STORE, ...params)
+	return getFromStore(IMPLICIT.STORE, ...params)
 }

package/src/main/reset-state.ts

@@ -1,4 +1,4 @@
-import * as Internal from "atom.io/internal"
+import { IMPLICIT, resetInStore } from "atom.io/internal"
 import type { Canonical } from "atom.io/json"
 
 import type { WritableFamilyToken, WritableToken } from "."
@@ -26,8 +26,8 @@ export function resetState(
 		| [token: WritableToken<any>]
 ): void {
 	if (params.length === 2) {
-		Internal.resetInStore(Internal.IMPLICIT.STORE, ...params)
+		resetInStore(IMPLICIT.STORE, ...params)
 	} else {
-		Internal.resetInStore(Internal.IMPLICIT.STORE, ...params)
+		resetInStore(IMPLICIT.STORE, ...params)
 	}
 }

package/src/main/set-state.ts

@@ -1,4 +1,4 @@
-import * as Internal from "atom.io/internal"
+import { IMPLICIT, setIntoStore } from "atom.io/internal"
 import type { Canonical } from "atom.io/json"
 
 import type { WritableFamilyToken, WritableToken } from "./tokens"
@@ -45,8 +45,8 @@ export function setState<T, New extends T>(
 		| [token: WritableToken<T>, value: New | Setter<T, New>]
 ): void {
 	if (params.length === 2) {
-		Internal.setIntoStore(Internal.IMPLICIT.STORE, ...params)
+		setIntoStore(IMPLICIT.STORE, ...params)
 	} else {
-		Internal.setIntoStore(Internal.IMPLICIT.STORE, ...params)
+		setIntoStore(IMPLICIT.STORE, ...params)
 	}
 }

package/src/main/subscribe.ts

@@ -1,4 +1,4 @@
-import type { Flat, Func } from "atom.io/internal"
+import type { Flat, Fn } from "atom.io/internal"
 import { arbitrary, IMPLICIT, subscribeInStore } from "atom.io/internal"
 
 import type {
@@ -20,7 +20,7 @@ export type KeyedStateUpdate<T> = Flat<
 	}
 >
 export type UpdateHandler<T> = (update: StateUpdate<T>) => void
-export type TransactionUpdateHandler<F extends Func> = (
+export type TransactionUpdateHandler<F extends Fn> = (
 	data: TransactionUpdate<F>,
 ) => void
 
@@ -45,7 +45,7 @@ export function subscribe<T>(
  * @returns A function that can be called to unsubscribe from the transaction
  * @overload Transaction
  */
-export function subscribe<F extends Func>(
+export function subscribe<F extends Fn>(
 	token: TransactionToken<F>,
 	handleUpdate: TransactionUpdateHandler<F>,
 	key?: string,

package/src/main/tokens.ts

@@ -1,4 +1,4 @@
-import type { AsJSON, Func, Transceiver } from "atom.io/internal"
+import type { AsJSON, Fn, Transceiver } from "atom.io/internal"
 import type { Canonical, stringified } from "atom.io/json"
 
 /**
@@ -53,7 +53,7 @@ export type TimelineToken<M> = {
 	__M?: M
 }
 
-export type TransactionToken<F extends Func> = {
+export type TransactionToken<F extends Fn> = {
 	/** The unique identifier of the transaction */
 	key: string
 	/** Discriminator */
@@ -63,7 +63,7 @@ export type TransactionToken<F extends Func> = {
 }
 
 export type AtomToken<T, K extends Canonical = any> =
-	| MutableAtomToken<T extends Transceiver<any, any> ? T : never, K>
+	| MutableAtomToken<T extends Transceiver<any, any, any> ? T : never, K>
 	| RegularAtomToken<T, K>
 export type RegularAtomToken<T, K extends Canonical = any> = {
 	/** The unique identifier of the atom. */
@@ -76,7 +76,7 @@ export type RegularAtomToken<T, K extends Canonical = any> = {
 	__T?: T
 }
 export type MutableAtomToken<
-	T extends Transceiver<any, any>,
+	T extends Transceiver<any, any, any>,
 	K extends Canonical = any,
 > = {
 	/** The unique identifier of the atom. */
@@ -87,8 +87,6 @@ export type MutableAtomToken<
 	family?: FamilyMetadata<K>
 	/** Never present. This is a marker that preserves the JSON form of the atom's transceiver value. */
 	__J?: AsJSON<T>
-	/** Never present. This is a marker that preserves the type of the atom's transceiver value. */
-	__U?: T extends Transceiver<infer Update, any> ? Update : never
 }
 
 export type SelectorToken<T, K extends Canonical = any> =
@@ -159,7 +157,7 @@ export type FamilyMetadata<K extends Canonical = any> = {
 }
 
 export type AtomFamilyToken<T, K extends Canonical = Canonical> =
-	| MutableAtomFamilyToken<T extends Transceiver<any, any> ? T : never, K>
+	| MutableAtomFamilyToken<T extends Transceiver<any, any, any> ? T : never, K>
 	| RegularAtomFamilyToken<T, K>
 export type RegularAtomFamilyToken<T, K extends Canonical> = {
 	/** The unique identifier of the atom family */
@@ -172,7 +170,7 @@ export type RegularAtomFamilyToken<T, K extends Canonical> = {
 	__K?: K
 }
 export type MutableAtomFamilyToken<
-	T extends Transceiver<any, any>,
+	T extends Transceiver<any, any, any>,
 	K extends Canonical,
 > = {
 	/** The unique identifier of the atom family */
@@ -181,8 +179,6 @@ export type MutableAtomFamilyToken<
 	type: `mutable_atom_family`
 	/** Never present. This is a marker that preserves the type of atoms in this family */
 	__T?: T
-	/** Never present. This is a marker that preserves the type of the JSON form of atoms in this family */
-	__J?: AsJSON<T>
 	/** Never present. This is a marker that preserves the type of keys used for atoms in this family */
 	__K?: K
 }

package/src/main/transaction.ts

@@ -1,9 +1,4 @@
-import type {
-	AsJSON,
-	EnvironmentData,
-	Func,
-	Transceiver,
-} from "atom.io/internal"
+import type { AsJSON, EnvironmentData, Fn, Transceiver } from "atom.io/internal"
 import {
 	actUponStore,
 	arbitrary,
@@ -33,6 +28,9 @@ export type StateCreation<Token extends ReadableToken<any>> = {
 export type StateDisposal<Token extends ReadableToken<any>> =
 	| AtomDisposal<Token>
 	| SelectorDisposal<Token>
+export type StateLifecycleEvent<Token extends ReadableToken<any>> =
+	| StateCreation<Token>
+	| StateDisposal<Token>
 
 export type AtomDisposal<Token extends ReadableToken<any>> = {
 	type: `state_disposal`
@@ -72,9 +70,9 @@ export type TransactionUpdateContent =
 	| MoleculeTransfer
 	| StateCreation<ReadableToken<unknown>>
 	| StateDisposal<ReadableToken<unknown>>
-	| TransactionUpdate<Func>
+	| TransactionUpdate<Fn>
 
-export type TransactionUpdate<F extends Func> = {
+export type TransactionUpdate<F extends Fn> = {
 	type: `transaction_update`
 	key: string
 	id: string
@@ -91,7 +89,7 @@ export type ActorToolkit = Readonly<{
 	set: typeof setState
 	reset: typeof resetState
 	find: typeof findState
-	json: <T extends Transceiver<any, any>>(
+	json: <T extends Transceiver<any, any, any>>(
 		state: MutableAtomToken<T>,
 	) => WritablePureSelectorToken<AsJSON<T>>
 	dispose: typeof disposeState
@@ -99,21 +97,21 @@ export type ActorToolkit = Readonly<{
 	env: () => EnvironmentData
 }>
 
-export type Read<F extends Func> = (
+export type Read<F extends Fn> = (
 	toolkit: ReaderToolkit,
 	...parameters: Parameters<F>
 ) => ReturnType<F>
-export type Write<F extends Func> = (
+export type Write<F extends Fn> = (
 	toolkit: WriterToolkit,
 	...parameters: Parameters<F>
 ) => ReturnType<F>
-export type Transact<F extends Func> = (
+export type Transact<F extends Fn> = (
 	toolkit: ActorToolkit,
 	...parameters: Parameters<F>
 ) => ReturnType<F>
 export type TransactionIO<Token extends TransactionToken<any>> =
 	Token extends TransactionToken<infer F> ? F : never
-export type TransactionOptions<F extends Func> = {
+export type TransactionOptions<F extends Fn> = {
 	/** The unique identifier of the transaction */
 	key: string
 	/** The operation to perform */
@@ -125,7 +123,7 @@ export type TransactionOptions<F extends Func> = {
  * @param options - {@link TransactionOptions}
  * @returns A reference to the transaction created: a {@link TransactionToken}
  */
-export function transaction<F extends Func>(
+export function transaction<F extends Fn>(
 	options: TransactionOptions<F>,
 ): TransactionToken<F> {
 	return createTransaction(IMPLICIT.STORE, options)
@@ -137,7 +135,7 @@ export function transaction<F extends Func>(
  * @param id - A unique identifier for the transaction. If not provided, a random identifier will be generated
  * @returns A function that can be called to run the transaction with its {@link TransactionIO} parameters
  */
-export function runTransaction<F extends Func>(
+export function runTransaction<F extends Fn>(
 	token: TransactionToken<F>,
 	id: string = arbitrary(),
 ): (...parameters: Parameters<F>) => ReturnType<F> {

package/src/react/use-json.ts

@@ -7,14 +7,14 @@ import * as React from "react"
 import { StoreContext } from "./store-context"
 import { useO } from "./use-o"
 
-export function useJSON<T extends Transceiver<any, any>>(
+export function useJSON<T extends Transceiver<any, any, any>>(
 	token: MutableAtomToken<T>,
 ): AsJSON<T>
 
-export function useJSON<T extends Transceiver<any, any>, K extends Canonical>(
-	token: MutableAtomFamilyToken<T, K>,
-	key: K,
-): AsJSON<T>
+export function useJSON<
+	T extends Transceiver<any, any, any>,
+	K extends Canonical,
+>(token: MutableAtomFamilyToken<T, K>, key: K): AsJSON<T>
 
 export function useJSON(
 	token: MutableAtomFamilyToken<any, any> | MutableAtomToken<any>,

package/src/react-devtools/TransactionIndex.tsx

@@ -4,7 +4,7 @@ import type {
 	TransactionToken,
 	TransactionUpdate,
 } from "atom.io"
-import { findInStore, type Func } from "atom.io/internal"
+import { findInStore, type Fn } from "atom.io/internal"
 import { useI, useO } from "atom.io/react"
 import { type FC, useContext } from "react"
 
@@ -13,9 +13,9 @@ import { DevtoolsContext } from "./store"
 import { article } from "./Updates"
 
 export const TransactionLog: FC<{
-	token: TransactionToken<Func>
+	token: TransactionToken<Fn>
 	isOpenState: RegularAtomToken<boolean>
-	logState: ReadonlyPureSelectorToken<TransactionUpdate<Func>[]>
+	logState: ReadonlyPureSelectorToken<TransactionUpdate<Fn>[]>
 }> = ({ token, isOpenState, logState }) => {
 	const log = useO(logState)
 	const isOpen = useO(isOpenState)

package/src/react-devtools/Updates.tsx

@@ -3,7 +3,7 @@ import type {
 	TimelineUpdate,
 	TransactionUpdate,
 } from "atom.io"
-import type { Func } from "atom.io/internal"
+import type { Fn } from "atom.io/internal"
 import { discoverType, prettyJson } from "atom.io/introspection"
 import { stringifyJson } from "atom.io/json"
 import * as React from "react"
@@ -37,7 +37,7 @@ const AtomUpdateFC: React.FC<{
 
 const TransactionUpdateFC: React.FC<{
 	serialNumber: number
-	transactionUpdate: TransactionUpdate<Func>
+	transactionUpdate: TransactionUpdate<Fn>
 }> = ({ serialNumber, transactionUpdate }) => {
 	return (
 		<article

package/src/realtime-client/continuity/register-and-attempt-confirmed-update.ts

@@ -1,5 +1,5 @@
 import type * as AtomIO from "atom.io"
-import type { Func, Store } from "atom.io/internal"
+import type { Fn, Store } from "atom.io/internal"
 import {
 	actUponStore,
 	getEpochNumberOfContinuity,
@@ -22,7 +22,7 @@ export const useRegisterAndAttemptConfirmedUpdate =
 		optimisticUpdates: AtomIO.TransactionUpdate<any>[],
 		confirmedUpdates: AtomIO.TransactionUpdate<any>[],
 	) =>
-	(confirmed: AtomIO.TransactionUpdate<Func>): void => {
+	(confirmed: AtomIO.TransactionUpdate<Fn>): void => {
 		function reconcileEpoch(
 			optimisticUpdate: AtomIO.TransactionUpdate<any>,
 			confirmedUpdate: AtomIO.TransactionUpdate<any>,

package/src/realtime-client/pull-mutable-atom-family-member.ts

@@ -1,16 +1,14 @@
 import type * as AtomIO from "atom.io"
-import type { AsJSON, Store, Transceiver } from "atom.io/internal"
+import type { AsJSON, SignalFrom, Store, Transceiver } from "atom.io/internal"
 import { getJsonToken, getUpdateToken, setIntoStore } from "atom.io/internal"
 import { parseJson } from "atom.io/json"
 import type { Socket } from "socket.io-client"
 
 /* eslint-disable no-console */
 
-export function pullMutableAtomFamilyMember<T extends Transceiver<any, any>>(
-	store: Store,
-	socket: Socket,
-	token: AtomIO.MutableAtomToken<T>,
-): () => void {
+export function pullMutableAtomFamilyMember<
+	T extends Transceiver<any, any, any>,
+>(store: Store, socket: Socket, token: AtomIO.MutableAtomToken<T>): () => void {
 	if (!(`family` in token)) {
 		console.error(`Token is not a family member:`, token)
 		return () => {}
@@ -21,13 +19,10 @@ export function pullMutableAtomFamilyMember<T extends Transceiver<any, any>>(
 		const jsonToken = getJsonToken(store, token)
 		setIntoStore(store, jsonToken, data)
 	})
-	socket.on(
-		`next:${token.key}`,
-		(data: T extends Transceiver<infer Signal, any> ? Signal : never) => {
-			const trackerToken = getUpdateToken(token)
-			setIntoStore(store, trackerToken, data)
-		},
-	)
+	socket.on(`next:${token.key}`, (data: SignalFrom<T>) => {
+		const trackerToken = getUpdateToken(token)
+		setIntoStore(store, trackerToken, data)
+	})
 	socket.emit(`sub:${familyKey}`, subKey)
 	return () => {
 		socket.off(`serve:${token.key}`)

package/src/realtime-client/pull-mutable-atom.ts

@@ -1,9 +1,9 @@
 import type * as AtomIO from "atom.io"
-import type { AsJSON, Store, Transceiver } from "atom.io/internal"
+import type { AsJSON, SignalFrom, Store, Transceiver } from "atom.io/internal"
 import { getJsonToken, getUpdateToken, setIntoStore } from "atom.io/internal"
 import type { Socket } from "socket.io-client"
 
-export function pullMutableAtom<T extends Transceiver<any, any>>(
+export function pullMutableAtom<T extends Transceiver<any, any, any>>(
 	store: Store,
 	socket: Socket,
 	token: AtomIO.MutableAtomToken<T>,
@@ -13,12 +13,9 @@ export function pullMutableAtom<T extends Transceiver<any, any>>(
 	socket.on(`init:${token.key}`, (data: AsJSON<T>) => {
 		setIntoStore(store, jsonToken, data)
 	})
-	socket.on(
-		`next:${token.key}`,
-		(data: T extends Transceiver<infer Update, any> ? Update : never) => {
-			setIntoStore(store, updateToken, data)
-		},
-	)
+	socket.on(`next:${token.key}`, (data: SignalFrom<T>) => {
+		setIntoStore(store, updateToken, data)
+	})
 	socket.emit(`sub:${token.key}`)
 	return () => {
 		socket.off(`init:${token.key}`)

package/src/realtime-client/push-state.ts

@@ -1,15 +1,16 @@
-import type * as AtomIO from "atom.io"
-import * as Internal from "atom.io/internal"
+import type { WritableToken } from "atom.io"
+import type { Store } from "atom.io/internal"
+import { subscribeToState } from "atom.io/internal"
 import type { Json } from "atom.io/json"
 import type { Socket } from "socket.io-client"
 
 export function pushState<J extends Json.Serializable>(
-	store: Internal.Store,
+	store: Store,
 	socket: Socket,
-	token: AtomIO.WritableToken<J>,
+	token: WritableToken<J>,
 ): () => void {
 	socket.emit(`claim:${token.key}`)
-	Internal.subscribeToState(store, token, `push`, ({ newValue }) => {
+	subscribeToState(store, token, `push`, ({ newValue }) => {
 		socket.emit(`pub:${token.key}`, newValue)
 	})
 	return () => {

package/src/realtime-client/server-action.ts

@@ -1,13 +1,14 @@
 import type * as AtomIO from "atom.io"
-import * as Internal from "atom.io/internal"
+import type { Fn, Store } from "atom.io/internal"
+import { subscribeToTransaction } from "atom.io/internal"
 import type { Socket } from "socket.io-client"
 
-export function serverAction<F extends Internal.Func>(
-	store: Internal.Store,
+export function serverAction<F extends Fn>(
+	store: Store,
 	socket: Socket,
 	token: AtomIO.TransactionToken<F>,
 ): () => void {
-	const unsubscribeFromLocalUpdates = Internal.subscribeToTransaction(
+	const unsubscribeFromLocalUpdates = subscribeToTransaction(
 		store,
 		token,
 		`tx-run:${token.key}:${socket.id}`,

package/src/realtime-react/use-pull-mutable-atom.ts

@@ -6,7 +6,7 @@ import * as React from "react"
 
 import { useRealtimeService } from "./use-realtime-service"
 
-export function usePullMutable<T extends Transceiver<any, any>>(
+export function usePullMutable<T extends Transceiver<any, any, any>>(
 	token: AtomIO.MutableAtomToken<T>,
 ): T {
 	const store = React.useContext(StoreContext)

package/src/realtime-react/use-pull-mutable-family-member.ts

@@ -9,7 +9,7 @@ import * as React from "react"
 import { useRealtimeService } from "./use-realtime-service"
 
 export function usePullMutableAtomFamilyMember<
-	T extends Transceiver<any, any>,
+	T extends Transceiver<any, any, any>,
 	K extends Canonical,
 	Key extends K,
 >(familyToken: AtomIO.MutableAtomFamilyToken<T, K>, key: Key): T {

package/src/realtime-react/use-server-action.ts

@@ -1,5 +1,5 @@
 import type * as AtomIO from "atom.io"
-import type { Func } from "atom.io/internal"
+import type { Fn } from "atom.io/internal"
 import { actUponStore, arbitrary } from "atom.io/internal"
 import { StoreContext } from "atom.io/react"
 import * as RTC from "atom.io/realtime-client"
@@ -7,7 +7,7 @@ import * as React from "react"
 
 import { useRealtimeService } from "./use-realtime-service"
 
-export function useServerAction<F extends Func>(
+export function useServerAction<F extends Fn>(
 	token: AtomIO.TransactionToken<F>,
 ): (...parameters: Parameters<F>) => ReturnType<F> {
 	const store = React.useContext(StoreContext)

package/src/realtime-server/realtime-mutable-family-provider.ts

@@ -21,7 +21,7 @@ export function realtimeMutableFamilyProvider({
 	store = IMPLICIT.STORE,
 }: ServerConfig) {
 	return function mutableFamilyProvider<
-		T extends Transceiver<any, any>,
+		T extends Transceiver<any, any, any>,
 		K extends Canonical,
 	>(
 		family: AtomIO.MutableAtomFamilyToken<T, K>,

package/src/realtime-server/realtime-mutable-provider.ts

@@ -17,7 +17,7 @@ export function realtimeMutableProvider({
 	store = IMPLICIT.STORE,
 }: ServerConfig) {
 	return function mutableProvider<
-		Core extends Transceiver<Json.Serializable, Json.Serializable>,
+		Core extends Transceiver<any, Json.Serializable, Json.Serializable>,
 	>(token: AtomIO.MutableAtomToken<Core>): () => void {
 		let unsubscribeFromStateUpdates: (() => void) | null = null
 

package/src/transceivers/set-rtx/set-rtx.ts

@@ -7,6 +7,13 @@ export type SetUpdateType = `add` | `clear` | `del` | `tx`
 export type SetUpdate = `${SetUpdateType}:${string}`
 export type NumberedSetUpdate = `${number}=${SetUpdate}`
 
+export interface SetRTXView<P extends primitive> extends ReadonlySet<P> {
+	readonly cache: ReadonlyArray<NumberedSetUpdate | null>
+	readonly cacheLimit: number
+	readonly cacheIdx: number
+	readonly cacheUpdateNumber: number
+}
+
 export interface SetRTXJson<P extends primitive> extends Json.Object {
 	members: P[]
 	cache: (NumberedSetUpdate | null)[]
@@ -16,7 +23,9 @@ export interface SetRTXJson<P extends primitive> extends Json.Object {
 }
 export class SetRTX<P extends primitive>
 	extends Set<P>
-	implements Transceiver<NumberedSetUpdate, SetRTXJson<P>>, Lineage
+	implements
+		Transceiver<SetRTXView<P>, NumberedSetUpdate, SetRTXJson<P>>,
+		Lineage
 {
 	public mode: TransceiverMode = `record`
 	public readonly subject: Subject<SetUpdate> = new Subject<SetUpdate>()
@@ -42,6 +51,10 @@ export class SetRTX<P extends primitive>
 		}
 	}
 
+	public view(): SetRTXView<P> {
+		return this
+	}
+
 	public toJSON(): SetRTXJson<P> {
 		return {
 			members: [...this],

package/src/internal/set-state/copy-mutable-if-needed.ts

@@ -1,29 +0,0 @@
-import type { MutableAtom, Transceiver } from ".."
-import { Tracker } from "../mutable"
-import type { Store } from "../store"
-
-export function copyMutableIfNeeded<T extends Transceiver<any, any>>(
-	target: Store,
-	atom: MutableAtom<T>,
-	origin: Store,
-): T {
-	const originValue = origin.valueMap.get(atom.key) as
-		| Transceiver<any, any>
-		| undefined
-	const targetValue = target.valueMap.get(atom.key)
-
-	if (originValue !== targetValue) {
-		return targetValue
-	}
-
-	if (originValue === undefined) {
-		return new atom.class()
-	}
-
-	origin.logger.info(`📃`, `atom`, atom.key, `copying`)
-	const jsonValue = originValue.toJSON()
-	const copiedValue = atom.class.fromJSON(jsonValue)
-	target.valueMap.set(atom.key, copiedValue)
-	new Tracker(atom, origin)
-	return copiedValue
-}