svelte-effect-runtime 3.4.11 → 4.0.1

package/.dist/server/types.d.ts

@@ -1,7 +1,8 @@
-import type { create_form_error, RemoteFailure } from "../remote/shared.js";
 import type { RemoteFormInput, RemoteQuery, RemoteQueryOverride } from "@sveltejs/kit";
-import type { EffectRemoteForm as ClientEffectRemoteForm } from "../remote/client.js";
+import type { EffectRemoteCommandCall as ClientEffectRemoteCommandCall, EffectRemoteForm as ClientEffectRemoteForm, EffectRemoteQueryUpdateBrand as ClientEffectRemoteQueryUpdateBrand } from "../remote/client.js";
 import type { Effect, Layer, ManagedRuntime, Schema, Stream } from "effect";
+import type { create_form_error, RemoteFailure } from "../remote/shared.js";
+import type { RemoteLiveStream } from "../live.js";
 /**
  * Effect-like values accepted by remote helper wrappers.
  *
@@ -13,6 +14,25 @@ import type { Effect, Layer, ManagedRuntime, Schema, Stream } from "effect";
  * @since 2.0.0
  */
 export type EffectLike<A = unknown, E = unknown, R = unknown> = Effect.Effect<A, E, R> | Effect.gen.Return<A, E, R>;
+/**
+ * Effect-producing callback adapted by {@link Handler} to a native SvelteKit
+ * server handler. The callback must resolve every typed failure before the
+ * server boundary, while its service requirements are supplied by
+ * {@link ServerRuntime}.
+ *
+ * @example
+ * ```ts
+ * import type { RequestHandler } from "./$types";
+ *
+ * const get_post: EffectHandler<RequestHandler> = ({ params }) =>
+ *   Posts.get(params.slug).pipe(
+ *     Effect.map((post) => Response.json(post)),
+ *   );
+ * ```
+ *
+ * @since 4.0.0
+ */
+export type EffectHandler<NativeHandler extends (...arguments_: never[]) => unknown, R = unknown> = (...arguments_: Parameters<NativeHandler>) => EffectLike<Awaited<ReturnType<NativeHandler>>, never, R>;
 /**
  * Handler shape accepted by query, command, and prerender helpers.
  *
@@ -26,17 +46,28 @@ export type EffectLike<A = unknown, E = unknown, R = unknown> = Effect.Effect<A,
  */
 export type RemoteHandler<Input = unknown, A = unknown, E = unknown, R = unknown> = (input: Input) => EffectLike<A, E, R>;
 /**
- * Handler or source shape accepted by live query helpers.
+ * Source shape accepted by no-argument live query helpers.
  *
  * @example
  * ```ts
- * const handler: RemoteLiveHandler<void, number> = () =>
- *   Stream.make(1, 2, 3);
+ * const source: RemoteLiveSource<number> = Stream.make(1, 2, 3);
+ * ```
+ *
+ * @since 3.4.8
+ */
+export type RemoteLiveSource<A = unknown, E = unknown, R = unknown> = Stream.Stream<A, E, R>;
+/**
+ * Handler shape accepted by input-bearing live query helpers.
+ *
+ * @example
+ * ```ts
+ * const handler: RemoteLiveHandler<string, number> = (id) =>
+ *   Stream.make(id.length);
  * ```
  *
  * @since 2.0.0
  */
-export type RemoteLiveHandler<Input = unknown, A = unknown, E = unknown, R = unknown> = EffectLike<EffectRemoteLiveSource<A>, E, R> | EffectRemoteLiveSource<A> | ((input: Input) => EffectLike<EffectRemoteLiveSource<A>, E, R> | EffectRemoteLiveSource<A>);
+export type RemoteLiveHandler<Input = unknown, A = unknown, E = unknown, R = unknown> = (input: Input) => Stream.Stream<A, E, R>;
 /**
  * Handler shape accepted by batch query helpers. The handler receives the
  * validated inputs collected by SvelteKit and returns an Effect-producing
@@ -104,18 +135,25 @@ type IsUnknown<Value> = unknown extends Value ? ([Value] extends [unknown] ? tru
  *
  * @example
  * ```ts
- * const options: PrerenderOptions = {
- *   inputs: () => ["first-post", "second-post"],
+ * const options: PrerenderOptions<string> = {
+ *   inputs: () => Effect.succeed(["first-post", "second-post"]),
  *   dynamic: true,
  * };
  * ```
  *
  * @since 2.0.0
  */
-export type PrerenderOptions = {
-    readonly inputs?: unknown;
+export type PrerenderOptions<Input = unknown, E = unknown, R = unknown> = {
+    readonly inputs?: PrerenderInputs<Input, E, R>;
     readonly dynamic?: boolean;
 };
+/**
+ * Effect-producing input generator for a prerendered remote function.
+ *
+ * @since 4.0.0
+ * @returns The caller inputs SvelteKit should prerender.
+ */
+export type PrerenderInputs<Input = unknown, E = unknown, R = unknown> = () => EffectLike<readonly Input[], E, R>;
 /**
  * Minimal Standard Schema shape accepted by SvelteKit remote helpers.
  *
@@ -262,7 +300,7 @@ export interface QueryBatchFactory {
  * @since 2.0.0
  */
 export interface QueryLiveFactory {
-    <A, E = never, R = never>(validate_or_handler: RemoteLiveHandler<void, A, E, R>): EffectRemoteLiveQueryFunction<void, A, E>;
+    <A, E = never, R = never>(validate_or_handler: RemoteLiveSource<A, E, R> | RemoteLiveHandler<void, A, E, R>): EffectRemoteLiveQueryFunction<void, A, E>;
     <Input, A, E = never, R = never>(validate_or_handler: "unchecked", maybe_handler: RemoteLiveHandler<Input, A, E, R>): EffectRemoteLiveQueryFunction<Input, A, E>;
     <S extends Schema.Schema<unknown>, A, E = never, R = never>(validate_or_handler: S, maybe_handler: RemoteLiveHandler<SchemaInput<S>, A, E, R>): EffectRemoteLiveQueryFunction<SchemaEncodedInput<S>, A, E>;
     <S extends StandardSchema, A, E = never, R = never>(validate_or_handler: S, maybe_handler: RemoteLiveHandler<StandardSchemaOutput<S>, A, E, R>): EffectRemoteLiveQueryFunction<StandardSchemaInput<S>, A, E>;
@@ -316,36 +354,41 @@ export interface FormFactory {
  * @since 2.0.0
  */
 export interface PrerenderFactory {
-    <A, E = never, R = never>(validate_or_handler: EffectLike<A, E, R> | RemoteHandler<void, A, E, R>, maybe_options?: PrerenderOptions): EffectRemoteFunction<void, A, E>;
-    <Input, A, E = never, R = never>(validate_or_handler: "unchecked", maybe_handler: RemoteHandler<Input, A, E, R>, maybe_options?: PrerenderOptions): EffectRemoteFunction<Input, A, E>;
-    <S extends Schema.Schema<unknown>, A, E = never, R = never>(validate_or_handler: S, maybe_handler: RemoteHandler<SchemaInput<S>, A, E, R>, maybe_options?: PrerenderOptions): EffectRemoteFunction<SchemaEncodedInput<S>, A, E>;
-    <S extends StandardSchema, A, E = never, R = never>(validate_or_handler: S, maybe_handler: RemoteHandler<StandardSchemaOutput<S>, A, E, R>, maybe_options?: PrerenderOptions): EffectRemoteFunction<StandardSchemaInput<S>, A, E>;
+    <A, E = never, R = never>(validate_or_handler: EffectLike<A, E, R> | RemoteHandler<void, A, E, R>, maybe_options?: PrerenderOptions<void>): EffectRemotePrerenderFunction<void, A, E>;
+    <Input, A, E = never, R = never>(validate_or_handler: "unchecked", maybe_handler: RemoteHandler<Input, A, E, R>, maybe_options?: PrerenderOptions<Input>): EffectRemotePrerenderFunction<Input, A, E>;
+    <S extends Schema.Schema<unknown>, A, E = never, R = never>(validate_or_handler: S, maybe_handler: RemoteHandler<SchemaInput<S>, A, E, R>, maybe_options?: PrerenderOptions<SchemaEncodedInput<S>>): EffectRemotePrerenderFunction<SchemaEncodedInput<S>, A, E>;
+    <S extends StandardSchema, A, E = never, R = never>(validate_or_handler: S, maybe_handler: RemoteHandler<StandardSchemaOutput<S>, A, E, R>, maybe_options?: PrerenderOptions<StandardSchemaInput<S>>): EffectRemotePrerenderFunction<StandardSchemaInput<S>, A, E>;
 }
 /**
- * Source values accepted by live query helpers.
+ * Base Effect-returning function type used by remote commands.
  *
  * @example
  * ```ts
- * const source: EffectRemoteLiveSource<number> = Stream.make(1, 2, 3);
+ * const SavePost: EffectRemoteFunction<string, { saved: true }> = (id) =>
+ *   Effect.succeed({ saved: true });
  * ```
  *
  * @since 2.0.0
  */
-export type EffectRemoteLiveSource<A> = Stream.Stream<A, unknown, unknown> | AsyncIterable<A> | AsyncIterator<A> | Iterable<A> | Iterator<A>;
+export type EffectRemoteFunction<Input, A, E = never> = [Input] extends [void] ? () => Effect.Effect<A, RemoteFailure<E>, never> : undefined extends Input ? (input?: Input) => Effect.Effect<A, RemoteFailure<E>, never> : (input: Input) => Effect.Effect<A, RemoteFailure<E>, never>;
 /**
- * Effect-returning remote function type exposed by query and prerender.
+ * Effect-returning prerender resource with SvelteKit's read-only state
+ * preserved.
  *
- * @example
- * ```ts
- * type Post = { id: string };
- * const posts: Post[] = [];
- * const getPosts: EffectRemoteFunction<void, Post[]> = () =>
- *   Effect.succeed(posts);
- * ```
+ * @since 4.0.0
+ */
+export type EffectRemotePrerender<A, E = never> = Effect.Effect<A, RemoteFailure<E>, never> & {
+    readonly current: A | undefined;
+    readonly error: unknown;
+    readonly loading: boolean;
+    readonly ready: boolean;
+};
+/**
+ * Effect-returning prerender function whose resource state remains readable.
  *
- * @since 2.0.0
+ * @since 4.0.0
  */
-export type EffectRemoteFunction<Input, A, E = never> = [Input] extends [void] ? () => Effect.Effect<A, RemoteFailure<E>, never> : undefined extends Input ? (input?: Input) => Effect.Effect<A, RemoteFailure<E>, never> : (input: Input) => Effect.Effect<A, RemoteFailure<E>, never>;
+export type EffectRemotePrerenderFunction<Input, A, E = never> = [Input] extends [void] ? () => EffectRemotePrerender<A, E> : undefined extends Input ? (input?: Input) => EffectRemotePrerender<A, E> : (input: Input) => EffectRemotePrerender<A, E>;
 /**
  * Effect-returning query resource with SvelteKit cache update methods
  * preserved.
@@ -358,7 +401,7 @@ export type EffectRemoteFunction<Input, A, E = never> = [Input] extends [void] ?
  *
  * @since 2.0.0
  */
-export type EffectRemoteQuery<A, E = never> = Effect.Effect<A, RemoteFailure<E>, never> & Pick<RemoteQuery<A>, "set"> & {
+export type EffectRemoteQuery<A, E = never> = ClientEffectRemoteQueryUpdateBrand & Effect.Effect<A, RemoteFailure<E>, never> & Pick<RemoteQuery<A>, "set"> & {
     readonly current: A | undefined;
     readonly error: unknown;
     readonly loading: boolean;
@@ -381,68 +424,42 @@ export type EffectRemoteQuery<A, E = never> = Effect.Effect<A, RemoteFailure<E>,
  */
 export type EffectRemoteQueryFunction<Input, A, E = never> = [Input] extends [void] ? () => EffectRemoteQuery<A, E> : undefined extends Input ? (input?: Input) => EffectRemoteQuery<A, E> : (input: Input) => EffectRemoteQuery<A, E>;
 /**
- * Live query resource with SvelteKit live stream state and reconnect controls
- * preserved.
+ * Remote live query stream.
  *
  * @example
  * ```ts
- * const clock = yield* getClock();
- * yield* clock.reconnect();
- *
- * for await (const value of clock) {
- *   console.log(value);
- * }
+ * const clock = getClock();
+ * const first = yield* Stream.runHead(clock);
  * ```
  *
- * @since 2.0.0
+ * @since 3.4.8
  */
-export type EffectRemoteLiveQueryResource<A> = {
-    readonly connected: boolean;
-    readonly current: A | undefined;
-    readonly done: boolean;
-    readonly error: unknown;
-    readonly loading: boolean;
-    readonly ready: boolean;
-    readonly reconnect: () => Effect.Effect<void, unknown, never>;
-} & AsyncIterable<A>;
+export type EffectRemoteLiveQuery<A, E = never> = RemoteLiveStream<A, E>;
 /**
- * Effect-returning live query whose yielded value is the live resource.
+ * Remote live query function returning an Effect Stream.
  *
  * @example
  * ```ts
- * const clock = yield* getClock();
- * const current = clock.current;
+ * const clock = getClock();
  * ```
  *
- * @since 2.2.0
+ * @since 3.4.8
  */
-export type EffectRemoteLiveQuery<A, E = never> = Effect.Effect<EffectRemoteLiveQueryResource<A>, RemoteFailure<E>, never>;
+export type EffectRemoteLiveQueryFunction<Input, A, E = never> = [Input] extends [void] ? () => EffectRemoteLiveQuery<A, E> : undefined extends Input ? (input?: Input) => EffectRemoteLiveQuery<A, E> : (input: Input) => EffectRemoteLiveQuery<A, E>;
 /**
- * Effect-returning remote live query function with SvelteKit live stream
- * properties preserved on the returned Effect.
- *
- * @example
- * ```ts
- * const clock = yield* getClock();
- * ```
+ * Effect returned by a command invocation, including SvelteKit's per-call
+ * query update selection.
  *
- * @since 2.2.0
+ * @since 4.0.0
  */
-export type EffectRemoteLiveQueryFunction<Input, A, E = never> = [Input] extends [void] ? () => EffectRemoteLiveQuery<A, E> : undefined extends Input ? (input?: Input) => EffectRemoteLiveQuery<A, E> : (input: Input) => EffectRemoteLiveQuery<A, E>;
+export type EffectRemoteCommandCall<A, E = never> = ClientEffectRemoteCommandCall<A, E>;
 /**
- * Effect-returning command type with SvelteKit's pending counter preserved.
- *
- * @example
- * ```ts
- * const upvote: EffectRemoteCommand<string, number> = Object.assign(
- *   (id: string) => Effect.succeed(id.length),
- *   { pending: 0 },
- * );
- * ```
+ * Effect-returning command type with SvelteKit's pending counter and per-call
+ * updates preserved.
  *
  * @since 2.0.0
  */
-export type EffectRemoteCommand<Input, A, E = never> = EffectRemoteFunction<Input, A, E> & {
+export type EffectRemoteCommand<Input, A, E = never> = ([Input] extends [void] ? () => EffectRemoteCommandCall<A, E> : undefined extends Input ? (input?: Input) => EffectRemoteCommandCall<A, E> : (input: Input) => EffectRemoteCommandCall<A, E>) & {
     readonly pending: number;
 };
 /**

package/.dist/server/wrappers.d.ts

@@ -1,43 +1,6 @@
-import type { EffectLike, RemoteFormHandler, RemoteHandler, RemoteLiveHandler } from "./types.js";
-/**
- * Reports whether SER is currently executing user remote handler code.
- *
- * @example
- * ```ts
- * if (is_running_remote_effect_handler()) {
- *   return query();
- * }
- * ```
- *
- * @since 2.0.0
- * @returns Whether a remote handler wrapper is currently active.
- * @internal
- */
-export declare function is_running_remote_effect_handler(): boolean;
-/**
- * Builds the wrapper passed to native query, command, and prerender helpers.
- *
- * @since 2.0.0
- * @param handler - Effect handler or already-built Effect-like value.
- * @param helper_name - Remote helper name for error normalization.
- * @returns Native SvelteKit handler wrapper.
- */
+import type { EffectLike, PrerenderInputs, RemoteFormHandler, RemoteHandler, RemoteLiveHandler, RemoteLiveSource } from "./types.js";
+export { is_running_remote_effect_handler } from "./remote-handler-context.js";
+export declare function make_prerender_inputs_wrapper<Input>(generate_inputs: PrerenderInputs<Input>): () => Promise<Input[]>;
 export declare function make_remote_wrapper(handler: RemoteHandler<unknown, unknown, unknown, unknown> | EffectLike, helper_name: string): (input: unknown) => Promise<unknown>;
-/**
- * Builds the wrapper passed to native live query helpers.
- *
- * @since 2.0.0
- * @param handler - Effect-aware live source handler.
- * @param helper_name - Remote helper name for error normalization.
- * @returns Native SvelteKit live query wrapper.
- */
-export declare function make_remote_live_wrapper<Input, A>(handler: RemoteLiveHandler<Input, A, unknown, unknown>, helper_name: string): (input: unknown) => Promise<unknown>;
-/**
- * Builds the wrapper passed to native form helpers.
- *
- * @since 2.0.0
- * @param handler - Effect-aware form handler.
- * @param helper_name - Remote helper name for error normalization.
- * @returns Native SvelteKit form handler wrapper.
- */
+export declare function make_remote_live_wrapper<Input, A>(handler: RemoteLiveSource<A, unknown, unknown> | RemoteLiveHandler<Input, A, unknown, unknown>, helper_name: string): (input: unknown) => Promise<unknown>;
 export declare function make_remote_form_wrapper<Input, A>(handler: RemoteFormHandler<Input, A, unknown, unknown>, helper_name: string): (data: unknown, issue: unknown) => Promise<unknown>;

package/.dist/server.d.ts

@@ -1,2 +1,2 @@
-export { Command, Error, Form, get_server_runtime_or_throw, Prerender, Query, Redirect, RequestEvent, ServerRuntime, } from "./server/index.js";
-export type { CommandFactory, EffectLike, EffectRemoteBatchHandler, EffectRemoteCommand, EffectRemoteForm, EffectRemoteFunction, EffectRemoteLiveQuery, EffectRemoteLiveQueryFunction, EffectRemoteLiveQueryResource, EffectRemoteLiveSource, EffectRemoteQuery, EffectRemoteQueryFunction, ErrorBody, ErrorEffectFactory, ErrorProperties, ErrorStatus, ErrorStatusName, FormFactory, FormInvalid, PrerenderFactory, PrerenderOptions, QueryBatchFactory, QueryFactory, QueryLiveFactory, RedirectEffectFactory, RedirectOptions, RedirectStatus, RedirectStatusName, RemoteFormHandler, RemoteHandler, RemoteLiveHandler, SchemaEncodedInput, SchemaInput, ServerRuntimeFactory, StandardSchema, StandardSchemaInput, StandardSchemaOutput, } from "./server/index.js";
+export { Command, Error, Form, get_server_runtime_or_throw, Handler, Live, Prerender, Query, Redirect, RequestEvent, ServerRuntime, } from "./server/index.js";
+export type { CommandFactory, EffectHandler, EffectLike, EffectRemoteBatchHandler, EffectRemoteCommand, EffectRemoteCommandCall, EffectRemoteForm, EffectRemoteFunction, EffectRemoteLiveQuery, EffectRemoteLiveQueryFunction, EffectRemotePrerender, EffectRemotePrerenderFunction, EffectRemoteQuery, EffectRemoteQueryFunction, ErrorBody, ErrorEffectFactory, ErrorProperties, ErrorStatus, ErrorStatusName, FormFactory, FormInvalid, LiveFactory, LiveStatus, PrerenderFactory, PrerenderInputs, PrerenderOptions, QueryBatchFactory, QueryFactory, QueryLiveFactory, RedirectEffectFactory, RedirectOptions, RedirectStatus, RedirectStatusName, RemoteFormHandler, RemoteHandler, RemoteLiveStream, RemoteLiveHandler, RemoteLiveSource, SchemaEncodedInput, SchemaInput, ServerRuntimeFactory, StandardSchema, StandardSchemaInput, StandardSchemaOutput, } from "./server/index.js";