atom.io 0.34.1 → 0.35.0

package/src/main/selector.ts

@@ -6,11 +6,15 @@ import {
 import type { Canonical } from "atom.io/json"
 
 import type {
+	ReadonlyHeldSelectorFamilyToken,
 	ReadonlyHeldSelectorToken,
+	ReadonlyPureSelectorFamilyToken,
 	ReadonlyPureSelectorToken,
+	WritableHeldSelectorFamilyToken,
 	WritableHeldSelectorToken,
+	WritablePureSelectorFamilyToken,
 	WritablePureSelectorToken,
-} from "."
+} from "./tokens"
 import type { Read, Write } from "./transaction"
 
 export type WritablePureSelectorOptions<T> = {
@@ -47,7 +51,6 @@ export type WritableHeldSelectorOptions<T extends object> = {
 }
 
 /**
- * @public
  * Declare a selector. The value of a selector should depend
  * on the value of atoms or other selectors in the store, and
  * should be recycled when a root atom of the selector is set.
@@ -68,7 +71,6 @@ export function selector<T extends object>(
 	options: WritableHeldSelectorOptions<T>,
 ): WritableHeldSelectorToken<T>
 /**
- * @public
  * Declare a selector. The value of a selector should depend
  * on the value of atoms or other selectors in the store,
  * and should be recycled when a root atom of the selector is set.
@@ -87,7 +89,6 @@ export function selector<T extends object>(
 	options: ReadonlyHeldSelectorOptions<T>,
 ): ReadonlyHeldSelectorToken<T>
 /**
- * @public
  * Declare a selector. The value of a selector should depend
  * on the value of atoms or other selectors in the store.
  *
@@ -107,7 +108,6 @@ export function selector<T>(
 	options: WritablePureSelectorOptions<T>,
 ): WritablePureSelectorToken<T>
 /**
- * @public
  * Declare a selector. The value of a selector should depend
  * on the value of atoms or other selectors in the store.
  *
@@ -138,7 +138,6 @@ export function selector(
 	return createStandaloneSelector(IMPLICIT.STORE, options)
 }
 
-/** @public */
 export type WritablePureSelectorFamilyOptions<T, K extends Canonical> = {
 	/** The unique identifier of the family */
 	key: string
@@ -147,14 +146,12 @@ export type WritablePureSelectorFamilyOptions<T, K extends Canonical> = {
 	/** For each instantiated family member, a function that sets its value */
 	set: (key: K) => Write<(newValue: T) => void>
 }
-/** @public */
 export type ReadonlyPureSelectorFamilyOptions<T, K extends Canonical> = {
 	/** The unique identifier of the family */
 	key: string
 	/** For each instantiated family member, a function that computes its value */
 	get: (key: K) => Read<() => T>
 }
-/** @public */
 export type WritableHeldSelectorFamilyOptions<
 	T extends object,
 	K extends Canonical,
@@ -168,7 +165,6 @@ export type WritableHeldSelectorFamilyOptions<
 	/** For each instantiated family member, a function that sets its value */
 	set: (key: K) => Write<(newValue: T) => void>
 }
-/** @public */
 export type ReadonlyHeldSelectorFamilyOptions<
 	T extends object,
 	K extends Canonical,
@@ -181,67 +177,7 @@ export type ReadonlyHeldSelectorFamilyOptions<
 	get: (key: K) => Read<(permanent: T) => void>
 }
 
-export type WritablePureSelectorFamilyToken<T, K extends Canonical> = {
-	/** The unique identifier of the family */
-	key: string
-	/** Discriminator */
-	type: `writable_pure_selector_family`
-	/** Never present. This is a marker that preserves the type of the value of each family member */
-	__T?: T
-	/** Never present. This is a marker that preserves the type of keys used for each family member */
-	__K?: K
-}
-export type ReadonlyPureSelectorFamilyToken<T, K extends Canonical> = {
-	/** The unique identifier of the family */
-	key: string
-	/** Discriminator */
-	type: `readonly_pure_selector_family`
-	/** Never present. This is a marker that preserves the type of the value of each family member */
-	__T?: T
-	/** Never present. This is a marker that preserves the type of keys used for each family member */
-	__K?: K
-}
-export type WritableHeldSelectorFamilyToken<T, K extends Canonical> = {
-	/** The unique identifier of the family */
-	key: string
-	/** Discriminator */
-	type: `writable_held_selector_family`
-	/** Never present. This is a marker that preserves the type of the value of each family member */
-	__T?: T
-	/** Never present. This is a marker that preserves the type of keys used for each family member */
-	__K?: K
-}
-export type ReadonlyHeldSelectorFamilyToken<T, K extends Canonical> = {
-	/** The unique identifier of the family */
-	key: string
-	/** Discriminator */
-	type: `readonly_held_selector_family`
-	/** Never present. This is a marker that preserves the type of the value of each family member */
-	__T?: T
-	/** Never present. This is a marker that preserves the type of keys used for each family member */
-	__K?: K
-}
-
-export type PureSelectorFamilyToken<T, K extends Canonical> =
-	| ReadonlyPureSelectorFamilyToken<T, K>
-	| WritablePureSelectorFamilyToken<T, K>
-export type HeldSelectorFamilyToken<T, K extends Canonical> =
-	| ReadonlyHeldSelectorFamilyToken<T, K>
-	| WritableHeldSelectorFamilyToken<T, K>
-export type ReadonlySelectorFamilyToken<T, K extends Canonical> =
-	| ReadonlyHeldSelectorFamilyToken<T, K>
-	| ReadonlyPureSelectorFamilyToken<T, K>
-
-export type WritableSelectorFamilyToken<T, K extends Canonical> =
-	| WritableHeldSelectorFamilyToken<T, K>
-	| WritablePureSelectorFamilyToken<T, K>
-
-export type SelectorFamilyToken<T, K extends Canonical> =
-	| HeldSelectorFamilyToken<T, K>
-	| PureSelectorFamilyToken<T, K>
-
 /**
- * @public
  * Create a family of selectors, allowing for the dynamic creation and disposal of selectors.
  *
  * The value of a held selector should depend on the value of atoms or other selectors in the store,
@@ -263,7 +199,6 @@ export function selectorFamily<T extends object, K extends Canonical>(
 	options: WritableHeldSelectorFamilyOptions<T, K>,
 ): WritableHeldSelectorFamilyToken<T, K>
 /**
- * @public
  * Create a family of selectors, allowing for the dynamic creation and disposal of selectors.
  *
  * The value of a held selector should depend on the value of atoms or other selectors in the store,
@@ -283,7 +218,6 @@ export function selectorFamily<T extends object, K extends Canonical>(
 	options: ReadonlyHeldSelectorFamilyOptions<T, K>,
 ): ReadonlyHeldSelectorFamilyToken<T, K>
 /**
- * @public
  * Create a family of selectors, allowing for the dynamic creation and disposal of selectors.
  *
  * The value of a selector should depend on the value of atoms or other selectors in the store.
@@ -304,7 +238,6 @@ export function selectorFamily<T, K extends Canonical>(
 	options: WritablePureSelectorFamilyOptions<T, K>,
 ): WritablePureSelectorFamilyToken<T, K>
 /**
- * @public
  * Create a family of selectors, allowing for the dynamic creation and disposal of selectors.
  *
  * The value of a selector should depend on the value of atoms or other selectors in the store.

package/src/main/set-state.ts

@@ -1,10 +1,9 @@
 import * as Internal from "atom.io/internal"
 import type { Canonical } from "atom.io/json"
 
-import type { WritableFamilyToken, WritableToken } from "."
+import type { WritableFamilyToken, WritableToken } from "./tokens"
 
 /**
- * @public
  * A function that sets the value of a state.
  * @param oldValue - The current value of the state.
  * @returns
@@ -13,7 +12,6 @@ import type { WritableFamilyToken, WritableToken } from "."
 export type Setter<T, New extends T> = (oldValue: T) => New
 
 /**
- * @public
  * Set the value of a state into the implicit store.
  * @param token - An atom or writable selector token.
  * @param value - The new value of the state.
@@ -26,7 +24,6 @@ export function setState<T, New extends T>(
 ): void
 
 /**
- * @public
  * Set the value of a state into the implicit store.
  * @param token - An atom family or writable selector family token.
  * @param key - The unique key of the state to set.

package/src/main/silo.ts

@@ -2,9 +2,11 @@ import type { findState } from "atom.io"
 import {
 	actUponStore,
 	arbitrary,
-	createAtomFamily,
+	createMutableAtom,
+	createMutableAtomFamily,
+	createRegularAtom,
+	createRegularAtomFamily,
 	createSelectorFamily,
-	createStandaloneAtom,
 	createStandaloneSelector,
 	createTimeline,
 	createTransaction,
@@ -30,7 +32,7 @@ import type {
 	timeline,
 	undo,
 } from "."
-import type { atom, atomFamily } from "./atom"
+import type { atom, atomFamily, mutableAtom, mutableAtomFamily } from "./atom"
 import type { resetState } from "./reset-state"
 import type { selector, selectorFamily } from "./selector"
 import type { runTransaction, transaction } from "./transaction"
@@ -38,7 +40,9 @@ import type { runTransaction, transaction } from "./transaction"
 export class Silo {
 	public store: Store
 	public atom: typeof atom
+	public mutableAtom: typeof mutableAtom
 	public atomFamily: typeof atomFamily
+	public mutableAtomFamily: typeof mutableAtomFamily
 	public selector: typeof selector
 	public selectorFamily: typeof selectorFamily
 	public transaction: typeof transaction
@@ -57,9 +61,14 @@ export class Silo {
 	public constructor(config: Store[`config`], fromStore: Store | null = null) {
 		const s = (this.store = new Store(config, fromStore))
 		this.atom = ((options: Parameters<typeof atom>[0]) =>
-			createStandaloneAtom(s, options)) as typeof atom
+			createRegularAtom(s, options, undefined)) as typeof atom
+		this.mutableAtom = ((options: Parameters<typeof mutableAtom>[0]) =>
+			createMutableAtom(s, options, undefined)) as typeof mutableAtom
 		this.atomFamily = ((options: Parameters<typeof atomFamily>[0]) =>
-			createAtomFamily(s, options)) as typeof atomFamily
+			createRegularAtomFamily(s, options)) as typeof atomFamily
+		this.mutableAtomFamily = ((
+			options: Parameters<typeof mutableAtomFamily>[0],
+		) => createMutableAtomFamily(s, options)) as typeof mutableAtomFamily
 		this.selector = ((options: Parameters<typeof selector>[0]) =>
 			createStandaloneSelector(s, options)) as typeof selector
 		this.selectorFamily = ((options: Parameters<typeof selectorFamily>[0]) =>

package/src/main/subscribe.ts

@@ -11,9 +11,7 @@ import type {
 	TransactionUpdate,
 } from "."
 
-/** @public */
 export type StateUpdate<T> = { newValue: T; oldValue: T }
-/** @public */
 export type KeyedStateUpdate<T> = Flat<
 	StateUpdate<T> & {
 		key: string
@@ -21,15 +19,12 @@ export type KeyedStateUpdate<T> = Flat<
 		family?: FamilyMetadata
 	}
 >
-/** @public */
 export type UpdateHandler<T> = (update: StateUpdate<T>) => void
-/** @public */
 export type TransactionUpdateHandler<F extends Func> = (
 	data: TransactionUpdate<F>,
 ) => void
 
 /**
- * @public
  * Subscribe to a state in the implicit store
  * @param token - The token of the state to subscribe to
  * @param handleUpdate - A function that will be called when the state is updated
@@ -43,7 +38,6 @@ export function subscribe<T>(
 	key?: string,
 ): () => void
 /**
- * @public
  * Subscribe to a transaction in the implicit store
  * @param token - The token of the transaction to subscribe to
  * @param handleUpdate - A function that will be called when the transaction succeeds
@@ -57,7 +51,6 @@ export function subscribe<F extends Func>(
 	key?: string,
 ): () => void
 /**
- * @public
  * Subscribe to a timeline in the implicit store
  * @param token - The token of the timeline to subscribe to
  * @param handleUpdate - A function that will be called when a new update is available

package/src/main/timeline.ts

@@ -10,11 +10,9 @@ import type {
 } from "atom.io/internal"
 import { createTimeline, IMPLICIT, timeTravel } from "atom.io/internal"
 
-import type { AtomFamilyToken, AtomToken } from "."
+import type { AtomFamilyToken, AtomToken, TimelineToken } from "."
 
-/** @public */
 export type TimelineManageable = AtomFamilyToken<any, any> | AtomToken<any>
-/** @public */
 export type AtomOnly<M extends TimelineManageable> = M extends AtomFamilyToken<
 	any,
 	any
@@ -24,17 +22,30 @@ export type AtomOnly<M extends TimelineManageable> = M extends AtomFamilyToken<
 		? M
 		: never
 
-/** @public */
-export type TimelineToken<M> = {
-	/** The unique identifier of the timeline */
-	key: string
-	/** Discriminator */
-	type: `timeline`
-	/** Never present. This is a marker that preserves the type of the managed atoms */
-	__M?: M
+/**
+ * If there is an update ahead of the cursor (in the future of this {@link timeline}), apply it and move the cursor to the next update
+ * @param timeline - A {@link TimelineToken}
+ */
+export const redo = (timeline: TimelineToken<any>): void => {
+	timeTravel(IMPLICIT.STORE, `redo`, timeline)
+}
+/**
+ * Reverse the last update on the {@link timeline} and move the cursor to the previous update
+ * @param timeline - A {@link TimelineToken}
+ */
+export const undo = (timeline: TimelineToken<any>): void => {
+	timeTravel(IMPLICIT.STORE, `undo`, timeline)
 }
 
-/** @public */
+export type TimelineUpdate<ManagedAtom extends TimelineManageable> =
+	| TimelineAtomUpdate<ManagedAtom>
+	| TimelineMoleculeCreation
+	| TimelineMoleculeDisposal
+	| TimelineSelectorUpdate<ManagedAtom>
+	| TimelineStateCreation<AtomOnly<ManagedAtom>>
+	| TimelineStateDisposal<AtomOnly<ManagedAtom>>
+	| TimelineTransactionUpdate
+
 export type TimelineOptions<ManagedAtom extends TimelineManageable> = {
 	/** The unique identifier of the timeline */
 	key: string
@@ -47,19 +58,8 @@ export type TimelineOptions<ManagedAtom extends TimelineManageable> = {
 	) => boolean
 }
 
-/** @public */
-export type TimelineUpdate<ManagedAtom extends TimelineManageable> =
-	| TimelineAtomUpdate<ManagedAtom>
-	| TimelineMoleculeCreation
-	| TimelineMoleculeDisposal
-	| TimelineSelectorUpdate<ManagedAtom>
-	| TimelineStateCreation<AtomOnly<ManagedAtom>>
-	| TimelineStateDisposal<AtomOnly<ManagedAtom>>
-	| TimelineTransactionUpdate
-
 /**
- * @public
- * Create a timeline, a mechanism for recording, undoing, and replaying changes to groups of atoms.
+ * Create a timeline, a mechanism for recording, undoing, and replaying changes to groups of atoms
  * @param options - {@link TimelineOptions}
  * @returns A reference to the timeline created: a {@link TimelineToken}
  */
@@ -68,11 +68,3 @@ export const timeline = <ManagedAtom extends TimelineManageable>(
 ): TimelineToken<ManagedAtom> => {
 	return createTimeline(IMPLICIT.STORE, options)
 }
-
-export const redo = (tl: TimelineToken<any>): void => {
-	timeTravel(IMPLICIT.STORE, `redo`, tl)
-}
-
-export const undo = (tl: TimelineToken<any>): void => {
-	timeTravel(IMPLICIT.STORE, `undo`, tl)
-}

package/src/main/tokens.ts

@@ -0,0 +1,247 @@
+import type { Func, Transceiver } from "atom.io/internal"
+import type { Canonical, Json, stringified } from "atom.io/json"
+
+/**
+ * A token is an object that uniquely identifies a particular state, family, timeline, or transaction.
+ *
+ * While they represent one of these resources, they are not the resource itself. Think of them like paper currency representing money in the bank.
+ *
+ * Tokens are returned from resource creation functions, such as {@link atom} and {@link transaction}.
+ *
+ * Tokens can be used as parameters to functions that take a token, such as {@link getState}, {@link setState}, or {@link runTransaction}.
+ *
+ * Tokens are fully serializable, so they can be passed between processes.
+ */
+export type AtomIOToken =
+	| ReadableFamilyToken<any, any>
+	| ReadableToken<any>
+	| TimelineToken<any>
+	| TransactionToken<any>
+
+/**
+ * These states cannot be set.
+ */
+export type ReadableToken<T, K extends Canonical = any> =
+	| AtomToken<T, K>
+	| SelectorToken<T, K>
+/**
+ * These states can be set.
+ */
+export type WritableToken<T, K extends Canonical = any> =
+	| AtomToken<T, K>
+	| WritableSelectorToken<T, K>
+
+/**
+ * States belonging to this family can be gotten from the store.
+ */
+export type ReadableFamilyToken<T, K extends Canonical> =
+	| AtomFamilyToken<T, K>
+	| SelectorFamilyToken<T, K>
+/**
+ * States belonging to this family can be set.
+ */
+export type WritableFamilyToken<T, K extends Canonical> =
+	| AtomFamilyToken<T, K>
+	| WritableSelectorFamilyToken<T, K>
+
+export type TimelineToken<M> = {
+	/** The unique identifier of the timeline */
+	key: string
+	/** Discriminator */
+	type: `timeline`
+	/** Never present. This is a marker that preserves the type of the managed atoms */
+	__M?: M
+}
+
+export type TransactionToken<F extends Func> = {
+	/** The unique identifier of the transaction */
+	key: string
+	/** Discriminator */
+	type: `transaction`
+	/** Never present. This is a marker that preserves the type of the transaction function */
+	__F?: F
+}
+
+export type AtomToken<T, K extends Canonical = any> =
+	| MutableAtomToken<T extends Transceiver<any> ? T : never, any, K>
+	| RegularAtomToken<T, K>
+export type RegularAtomToken<T, K extends Canonical = any> = {
+	/** The unique identifier of the atom. */
+	key: string
+	/** Discriminator. */
+	type: `atom`
+	/** Present if the atom belongs to a family. */
+	family?: FamilyMetadata<K>
+	/** Never present. This is a marker that preserves the type of the atom's value. */
+	__T?: T
+}
+export type MutableAtomToken<
+	T extends Transceiver<any>,
+	J extends Json.Serializable,
+	K extends Canonical = any,
+> = {
+	/** The unique identifier of the atom. */
+	key: string
+	/** Discriminator. */
+	type: `mutable_atom`
+	/** Present if the atom belongs to a family. */
+	family?: FamilyMetadata<K>
+	/** Never present. This is a marker that preserves the JSON form of the atom's transceiver value. */
+	__J?: J
+	/** Never present. This is a marker that preserves the type of the atom's transceiver value. */
+	__U?: T extends Transceiver<infer Update> ? Update : never
+}
+
+export type SelectorToken<T, K extends Canonical = any> =
+	| ReadonlySelectorToken<T, K>
+	| WritableSelectorToken<T, K>
+export type ReadonlySelectorToken<T, K extends Canonical = any> =
+	| ReadonlyHeldSelectorToken<T, K>
+	| ReadonlyPureSelectorToken<T, K>
+export type WritableSelectorToken<T, K extends Canonical = any> =
+	| WritableHeldSelectorToken<T, K>
+	| WritablePureSelectorToken<T, K>
+export type PureSelectorToken<T, K extends Canonical = any> =
+	| ReadonlyPureSelectorToken<T, K>
+	| WritablePureSelectorToken<T, K>
+export type HeldSelectorToken<T, K extends Canonical = any> =
+	| ReadonlyHeldSelectorToken<T, K>
+	| WritableHeldSelectorToken<T, K>
+
+export type WritablePureSelectorToken<T, K extends Canonical = any> = {
+	/** The unique identifier of the selector. */
+	key: string
+	/** Discriminator. */
+	type: `writable_pure_selector`
+	/** Present if the selector belongs to a family. */
+	family?: FamilyMetadata<K>
+	/** Never present. This is a marker that preserves the type of the selector's value. */
+	__T?: T
+}
+export type WritableHeldSelectorToken<T, K extends Canonical = any> = {
+	/** The unique identifier of the selector. */
+	key: string
+	/** Discriminator. */
+	type: `writable_held_selector`
+	/** Present if the selector belongs to a family. */
+	family?: FamilyMetadata<K>
+	/** Never present. This is a marker that preserves the type of the selector's value. */
+	__T?: T
+}
+export type ReadonlyPureSelectorToken<T, K extends Canonical = any> = {
+	/** The unique identifier of the selector. */
+	key: string
+	/** Discriminator. */
+	type: `readonly_pure_selector`
+	/** Present if the selector belongs to a family. */
+	family?: FamilyMetadata<K>
+	/** Never present. This is a marker that preserves the type of the selector's value. */
+	__T?: T
+}
+export type ReadonlyHeldSelectorToken<T, K extends Canonical = any> = {
+	/** The unique identifier of the selector. */
+	key: string
+	/** Discriminator. */
+	type: `readonly_held_selector`
+	/** Present if the selector belongs to a family. */
+	family?: FamilyMetadata<K>
+	/** Never present. This is a marker that preserves the type of the selector's value. */
+	__T?: T
+}
+
+/**
+ * Identifies a state's connection to its family.
+ */
+export type FamilyMetadata<K extends Canonical = any> = {
+	/** The family's unique key. */
+	key: string
+	/** The family member's unique identifier, in the form of a string. */
+	subKey: stringified<K>
+}
+
+export type AtomFamilyToken<T, K extends Canonical = Canonical> =
+	| MutableAtomFamilyToken<T extends Transceiver<any> ? T : never, any, K>
+	| RegularAtomFamilyToken<T, K>
+export type RegularAtomFamilyToken<T, K extends Canonical> = {
+	/** The unique identifier of the atom family */
+	key: string
+	/** Discriminator */
+	type: `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 keys used for atoms in this family */
+	__K?: K
+}
+export type MutableAtomFamilyToken<
+	T extends Transceiver<any>,
+	J extends Json.Serializable,
+	K extends Canonical,
+> = {
+	/** The unique identifier of the atom family */
+	key: string
+	/** Discriminator */
+	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?: J
+	/** Never present. This is a marker that preserves the type of keys used for atoms in this family */
+	__K?: K
+}
+
+export type SelectorFamilyToken<T, K extends Canonical> =
+	| ReadonlySelectorFamilyToken<T, K>
+	| WritableSelectorFamilyToken<T, K>
+export type ReadonlySelectorFamilyToken<T, K extends Canonical> =
+	| ReadonlyHeldSelectorFamilyToken<T, K>
+	| ReadonlyPureSelectorFamilyToken<T, K>
+export type WritableSelectorFamilyToken<T, K extends Canonical> =
+	| WritableHeldSelectorFamilyToken<T, K>
+	| WritablePureSelectorFamilyToken<T, K>
+export type PureSelectorFamilyToken<T, K extends Canonical> =
+	| ReadonlyPureSelectorFamilyToken<T, K>
+	| WritablePureSelectorFamilyToken<T, K>
+export type HeldSelectorFamilyToken<T, K extends Canonical> =
+	| ReadonlyHeldSelectorFamilyToken<T, K>
+	| WritableHeldSelectorFamilyToken<T, K>
+
+export type WritablePureSelectorFamilyToken<T, K extends Canonical> = {
+	/** The unique identifier of the family */
+	key: string
+	/** Discriminator */
+	type: `writable_pure_selector_family`
+	/** Never present. This is a marker that preserves the type of the value of each family member */
+	__T?: T
+	/** Never present. This is a marker that preserves the type of keys used for each family member */
+	__K?: K
+}
+export type ReadonlyPureSelectorFamilyToken<T, K extends Canonical> = {
+	/** The unique identifier of the family */
+	key: string
+	/** Discriminator */
+	type: `readonly_pure_selector_family`
+	/** Never present. This is a marker that preserves the type of the value of each family member */
+	__T?: T
+	/** Never present. This is a marker that preserves the type of keys used for each family member */
+	__K?: K
+}
+export type WritableHeldSelectorFamilyToken<T, K extends Canonical> = {
+	/** The unique identifier of the family */
+	key: string
+	/** Discriminator */
+	type: `writable_held_selector_family`
+	/** Never present. This is a marker that preserves the type of the value of each family member */
+	__T?: T
+	/** Never present. This is a marker that preserves the type of keys used for each family member */
+	__K?: K
+}
+export type ReadonlyHeldSelectorFamilyToken<T, K extends Canonical> = {
+	/** The unique identifier of the family */
+	key: string
+	/** Discriminator */
+	type: `readonly_held_selector_family`
+	/** Never present. This is a marker that preserves the type of the value of each family member */
+	__T?: T
+	/** Never present. This is a marker that preserves the type of keys used for each family member */
+	__K?: K
+}