@typed/fx 2.0.0-beta.5 → 2.0.0-beta.7

package/dist/Push/Push.js

@@ -49,7 +49,7 @@ import * as Sink from "../Sink.js";
  * ```
  *
  * @since 1.0.0
- * @category constructors
+ * @category Push construction
  */
 export const make = dual(2, (sink, fx) => new PushImpl(sink, fx));
 const VARIANCE = {
@@ -124,7 +124,7 @@ class PushImpl {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Transforming inputs
  */
 export const mapInput = dual(2, function mapInput(push, f) {
     return make(Sink.map(push, f), push);
@@ -171,7 +171,7 @@ export const mapInput = dual(2, function mapInput(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Transforming inputs
  */
 export const mapInputEffect = dual(2, function mapInputEffect(push, f) {
     return make(Sink.mapEffect(push, f), push);
@@ -213,7 +213,7 @@ export const mapInputEffect = dual(2, function mapInputEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting inputs
  */
 export const filterInput = dual(2, function filterInput(push, f) {
     return make(Sink.filter(push, f), push);
@@ -255,7 +255,7 @@ export const filterInput = dual(2, function filterInput(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting inputs
  */
 export const filterInputEffect = dual(2, function filterInputEffect(push, f) {
     return make(Sink.filterEffect(push, f), push);
@@ -300,7 +300,7 @@ export const filterInputEffect = dual(2, function filterInputEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting inputs
  */
 export const filterMapInput = dual(2, function filterMapInput(push, f) {
     return make(Sink.filterMap(push, f), push);
@@ -342,7 +342,7 @@ export const filterMapInput = dual(2, function filterMapInput(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting inputs
  */
 export const filterMapInputEffect = dual(2, function filterMapInputEffect(push, f) {
     return make(Sink.filterMapEffect(push, f), push);
@@ -393,7 +393,7 @@ export const filterMapInputEffect = dual(2, function filterMapInputEffect(push,
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Transforming outputs
  */
 export const map = dual(2, function map(push, f) {
     return make(push, Fx.map(push, f));
@@ -429,7 +429,7 @@ export const map = dual(2, function map(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Transforming outputs
  */
 export const mapEffect = dual(2, function mapEffect(push, f) {
     return make(push, Fx.mapEffect(push, f));
@@ -467,7 +467,7 @@ export const mapEffect = dual(2, function mapEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Output failures
  */
 export const mapError = dual(2, function mapError(push, f) {
     return make(push, Fx.mapError(push, f));
@@ -505,7 +505,7 @@ export const mapError = dual(2, function mapError(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Transforming outputs
  */
 export const mapBoth = dual(2, function mapBoth(push, options) {
     return make(push, Fx.mapBoth(push, options));
@@ -542,7 +542,7 @@ export const mapBoth = dual(2, function mapBoth(push, options) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting outputs
  */
 export const filter = dual(2, function filter(push, f) {
     return make(push, Fx.filter(push, f));
@@ -579,7 +579,7 @@ export const filter = dual(2, function filter(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting outputs
  */
 export const filterEffect = dual(2, function filterEffect(push, f) {
     return make(push, Fx.filterEffect(push, f));
@@ -615,7 +615,7 @@ export const filterEffect = dual(2, function filterEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting outputs
  */
 export const filterMap = dual(2, function filterMap(push, f) {
     return make(push, Fx.filterMap(push, f));
@@ -651,7 +651,7 @@ export const filterMap = dual(2, function filterMap(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Selecting outputs
  */
 export const filterMapEffect = dual(2, function filterMapEffect(push, f) {
     return make(push, Fx.filterMapEffect(push, f));
@@ -709,7 +709,7 @@ export const filterMapEffect = dual(2, function filterMapEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const switchMap = dual(2, function switchMap(push, f) {
     return make(push, Fx.switchMap(push, f));
@@ -762,7 +762,7 @@ export const switchMap = dual(2, function switchMap(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const switchMapEffect = dual(2, function switchMapEffect(push, f) {
     return make(push, Fx.switchMapEffect(push, f));
@@ -817,7 +817,7 @@ export const switchMapEffect = dual(2, function switchMapEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const flatMap = dual(2, function flatMap(push, f) {
     return make(push, Fx.flatMap(push, f));
@@ -867,7 +867,7 @@ export const flatMap = dual(2, function flatMap(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const flatMapEffect = dual(2, function flatMapEffect(push, f) {
     return make(push, Fx.flatMapEffect(push, f));
@@ -926,7 +926,7 @@ export const flatMapEffect = dual(2, function flatMapEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const exhaustMap = dual(2, function exhaustMap(push, f) {
     return make(push, Fx.exhaustMap(push, f));
@@ -978,7 +978,7 @@ export const exhaustMap = dual(2, function exhaustMap(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const exhaustMapEffect = dual(2, function exhaustMapEffect(push, f) {
     return make(push, Fx.exhaustMapEffect(push, f));
@@ -1038,7 +1038,7 @@ export const exhaustMapEffect = dual(2, function exhaustMapEffect(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const exhaustLatestMap = dual(2, function exhaustLatestMap(push, f) {
     return make(push, Fx.exhaustLatestMap(push, f));
@@ -1091,7 +1091,7 @@ export const exhaustLatestMap = dual(2, function exhaustLatestMap(push, f) {
  * ```
  *
  * @since 1.0.0
- * @category combinators
+ * @category Concurrent output work
  */
 export const exhaustLatestMapEffect = dual(2, function exhaustLatestMapEffect(push, f) {
     return make(push, Fx.exhaustLatestMapEffect(push, f));
@@ -1129,7 +1129,7 @@ export const exhaustLatestMapEffect = dual(2, function exhaustLatestMapEffect(pu
  * @param f - Reducer `(state, value) => [nextState, emitted]`.
  * @returns A `Push` whose Fx side emits the accumulated/mapped values.
  * @since 1.0.0
- * @category combinators
+ * @category Stateful outputs
  */
 export const mapAccum = dual(3, function mapAccum(push, initial, f) {
     return make(push, Fx.make((sink) => push.run(Sink.loop(sink, initial, (s, b) => {
@@ -1206,7 +1206,7 @@ export const mapAccum = dual(3, function mapAccum(push, initial, f) {
  * @param f - Effectful reducer `(state, value) => Effect<[nextState, emitted]>`.
  * @returns A `Push` whose Fx side emits the accumulated/mapped values.
  * @since 1.0.0
- * @category combinators
+ * @category Stateful outputs
  */
 export const mapAccumEffect = dual(3, function mapAccumEffect(push, initial, f) {
     return make(push, Fx.make((sink) => push.run(Sink.filterMapLoopEffect(sink, initial, (s, b) => f(s, b).pipe(Effect.map(([sNext, c]) => [Option.some(c), sNext]), Effect.catchCause((cause) => sink.onFailure(cause).pipe(Effect.as([Option.none(), s]))))))));
@@ -1248,7 +1248,7 @@ export const mapAccumEffect = dual(3, function mapAccumEffect(push, initial, f)
  * ```
  *
  * @since 1.0.0
- * @category services
+ * @category Push services
  */
 export function Service() {
     return (id) => {

package/dist/RefSubject/Hydration.d.ts

@@ -19,7 +19,7 @@ import { type RefSubject, type RefSubjectOptions } from "./RefSubject.js";
  * services and Scope requirements.
  *
  * @since 2.0.0
- * @category combinators
+ * @category Hydration protocol
  */
 export declare const HydrationRefTypeId: unique symbol;
 /**
@@ -37,7 +37,7 @@ export declare const HydrationRefTypeId: unique symbol;
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 2.0.0
- * @category type-level
+ * @category Hydration types
  */
 export type HydrationRefTypeId = typeof HydrationRefTypeId;
 /**
@@ -55,7 +55,7 @@ export type HydrationRefTypeId = typeof HydrationRefTypeId;
  * services and Scope requirements.
  *
  * @since 2.0.0
- * @category combinators
+ * @category Hydration protocol
  */
 export declare const HYDRATION_ATTRIBUTE = "data-typed-refsubject";
 /**
@@ -73,7 +73,7 @@ export declare const HYDRATION_ATTRIBUTE = "data-typed-refsubject";
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 2.0.0
- * @category models
+ * @category Hydration protocol
  */
 export interface HydrationAttribute {
     /**
@@ -90,7 +90,7 @@ export interface HydrationAttribute {
      * services and Scope requirements.
      *
      * @since 2.0.0
-     * @category combinators
+     * @category Hydration protocol
      */
     readonly name: string;
     /**
@@ -108,7 +108,7 @@ export interface HydrationAttribute {
      * services and Scope requirements.
      *
      * @since 2.0.0
-     * @category combinators
+     * @category Hydration protocol
      */
     readonly value: string;
 }
@@ -127,7 +127,7 @@ export interface HydrationAttribute {
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 2.0.0
- * @category models
+ * @category Hydration protocol
  */
 export interface HydrationElement {
     /**
@@ -144,7 +144,7 @@ export interface HydrationElement {
      * services and Scope requirements.
      *
      * @since 2.0.0
-     * @category combinators
+     * @category DOM attribute protocol
      */
     getAttribute(name: string): string | null;
     /**
@@ -161,7 +161,7 @@ export interface HydrationElement {
      * services and Scope requirements.
      *
      * @since 2.0.0
-     * @category combinators
+     * @category DOM attribute protocol
      */
     setAttribute(name: string, value: string): void;
     /**
@@ -178,7 +178,7 @@ export interface HydrationElement {
      * services and Scope requirements.
      *
      * @since 2.0.0
-     * @category combinators
+     * @category DOM attribute protocol
      */
     removeAttribute(name: string): void;
 }
@@ -204,7 +204,7 @@ interface HydrationMember {
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 2.0.0
- * @category models
+ * @category Hydration protocol
  */
 export interface HydrationRef<E = never, R = never> {
     /**
@@ -223,7 +223,7 @@ export interface HydrationRef<E = never, R = never> {
      * member metadata rather than becoming DOM exceptions.
      *
      * @since 2.0.0
-     * @category type-level
+     * @category Hydration types
      */
     (element: HydrationElement): Effect.Effect<void, never, R | Scope.Scope>;
     /**
@@ -241,7 +241,7 @@ export interface HydrationRef<E = never, R = never> {
      * finalized by the required Scope.
      *
      * @since 2.0.0
-     * @category combinators
+     * @category Hydration protocol
      */
     readonly [HydrationRefTypeId]: {
         readonly members: ReadonlyArray<HydrationMember>;
@@ -264,7 +264,7 @@ export interface HydrationRef<E = never, R = never> {
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 2.0.0
- * @category models
+ * @category Hydration protocol
  */
 export interface HydratedRefSubject<A, E = never, R = never, RH = R> extends RefSubject<A, E, R>, HydrationRef<E, RH> {
 }
@@ -283,7 +283,7 @@ export interface HydratedRefSubject<A, E = never, R = never, RH = R> extends Ref
  * finalized by the required Scope.
  *
  * @since 2.0.0
- * @category combinators
+ * @category Hydration protocol
  */
 export declare namespace HydratedRefSubject {
     /**
@@ -300,7 +300,7 @@ export declare namespace HydratedRefSubject {
      * interruption, and Scope requirements expressed by its members.
      *
      * @since 2.0.0
-     * @category type-level
+     * @category Hydration types
      */
     type Any = HydratedRefSubject<any, any, any, any>;
     /**
@@ -317,7 +317,7 @@ export declare namespace HydratedRefSubject {
      * services, interruption, and Scope requirements expressed by its members.
      *
      * @since 2.0.0
-     * @category type-level
+     * @category Hydration types
      */
     type HydrationError<T> = T extends HydrationRef<infer E, any> ? E : never;
     /**
@@ -334,7 +334,7 @@ export declare namespace HydratedRefSubject {
      * errors, services, interruption, and Scope requirements expressed by its members.
      *
      * @since 2.0.0
-     * @category type-level
+     * @category Hydration types
      */
     type HydrationServices<T> = T extends HydrationRef<any, infer R> ? R : never;
 }
@@ -353,7 +353,7 @@ export declare namespace HydratedRefSubject {
  * services and Scope requirements.
  *
  * @since 2.0.0
- * @category guards
+ * @category Type guards
  */
 export declare function isHydrationRef(value: unknown): value is HydrationRef<any, any>;
 /**
@@ -371,7 +371,7 @@ export declare function isHydrationRef(value: unknown): value is HydrationRef<an
  * services, interruption, and Scope requirements expressed by its members.
  *
  * @since 2.0.0
- * @category models
+ * @category Hydration protocol
  */
 export interface HydrateOptions<A> extends RefSubjectOptions<A> {
     /**
@@ -388,7 +388,7 @@ export interface HydrateOptions<A> extends RefSubjectOptions<A> {
      * services and Scope requirements.
      *
      * @since 2.0.0
-     * @category combinators
+     * @category Hydration protocol
      */
     readonly name?: string;
 }
@@ -434,7 +434,7 @@ type HydrateEffect<S extends Schema.Top, E, R> = Effect.Effect<HydratedRefSubjec
  * ```
  *
  * @since 2.0.0
- * @category constructors
+ * @category Hydration construction
  */
 export declare function hydrate<S extends Schema.Codec<any, string, any, any>, E = never, R = never>(schema: S, effect: HydrationInput<NoInfer<Schema.Schema.Type<S>>, E, R>, options: HydrateOptions<Schema.Schema.Type<S>> & {
     readonly name: string;
@@ -454,7 +454,7 @@ export declare function hydrate<S extends Schema.Codec<any, string, any, any>, E
  * server/client coordination. Schema errors and codec services remain typed.
  *
  * @since 2.0.0
- * @category constructors
+ * @category Hydration construction
  */
 export declare function hydrate<S extends Schema.Top, E = never, R = never>(schema: S, effect: HydrationInput<NoInfer<Schema.Schema.Type<S>>, E, R>, options?: HydrateOptions<Schema.Schema.Type<S>> & {
     readonly name?: undefined;
@@ -497,7 +497,7 @@ export declare function hydrate<S extends Schema.Top, E = never, R = never>(sche
  * ```
  *
  * @since 2.0.0
- * @category combinators
+ * @category Hydration construction
  */
 export declare function hydrateAll<const Refs extends readonly [HydratedRefSubject.Any, ...HydratedRefSubject.Any[]]>(...refs: Refs): HydrationRef<HydratedRefSubject.HydrationError<Refs[number]>, HydratedRefSubject.HydrationServices<Refs[number]>>;
 export {};

package/dist/RefSubject/Hydration.js

@@ -25,7 +25,7 @@ import { CurrentComputedBehavior, make, } from "./RefSubject.js";
  * services and Scope requirements.
  *
  * @since 2.0.0
- * @category combinators
+ * @category Hydration protocol
  */
 export const HydrationRefTypeId = Symbol.for("@typed/fx/RefSubjectRef");
 /**
@@ -43,7 +43,7 @@ export const HydrationRefTypeId = Symbol.for("@typed/fx/RefSubjectRef");
  * services and Scope requirements.
  *
  * @since 2.0.0
- * @category combinators
+ * @category Hydration protocol
  */
 export const HYDRATION_ATTRIBUTE = "data-typed-refsubject";
 const allUnbounded = (effects) => Effect.all(effects, { concurrency: "unbounded" });
@@ -62,7 +62,7 @@ const allUnbounded = (effects) => Effect.all(effects, { concurrency: "unbounded"
  * services and Scope requirements.
  *
  * @since 2.0.0
- * @category guards
+ * @category Type guards
  */
 export function isHydrationRef(value) {
     return (typeof value === "function" &&
@@ -85,7 +85,7 @@ export function isHydrationRef(value) {
  * server/client coordination. Schema errors and codec services remain typed.
  *
  * @since 2.0.0
- * @category constructors
+ * @category Hydration construction
  */
 export function hydrate(schema, effect, options) {
     const attributeName = options?.name === undefined ? undefined : toHydrationAttributeName(options.name);
@@ -205,7 +205,7 @@ function normalizeHydrationInitializer(value) {
  * ```
  *
  * @since 2.0.0
- * @category combinators
+ * @category Hydration construction
  */
 export function hydrateAll(...refs) {
     return makeHydrationRef(refs.flatMap((ref) => ref[HydrationRefTypeId].members));