svelte-effect-runtime 1.3.2 → 1.4.0

package/dist/internal/remote-shared.d.ts

@@ -1,53 +1,186 @@
+/**
+ * Marker property name placed on serialized `RemoteFailure` envelopes so the
+ * client adapters can recognise server-produced failure payloads.
+ *
+ * @internal Internal - do not use.
+ */
 export declare const EFFECT_REMOTE_ERROR_MARKER = "__svelte_effect_remote__";
+/**
+ * Well-known symbol used to attach a payload decoder to a remote function,
+ * enabling the client to reconstruct typed domain errors from wire data.
+ *
+ * @internal Internal - do not use.
+ */
 export declare const REMOTE_ERROR_DECODER: unique symbol;
+/**
+ * A single validation problem surfaced by a remote form or schema check.
+ * Mirrors SvelteKit's `invalid()` issue shape.
+ */
 export interface FormIssue {
+    /** Human-readable description of the failure at {@link FormIssue.path}. */
     readonly message: string;
+    /** Field path (dot or array-index segments) the issue applies to. */
     readonly path: ReadonlyArray<string | number>;
 }
+/**
+ * Typed error produced by `invalid.form(...)` / `invalid.<field>(...)` helpers
+ * inside a `Form` handler. Carries the collected `FormIssue`s to surface to
+ * the browser.
+ */
 export interface FormError<SchemaType = unknown> {
+    /** Discriminator identifying this as a form error. */
     readonly _tag: "FormError";
+    /** Issues produced by the handler, one per failed field. */
     readonly issues: ReadonlyArray<FormIssue>;
+    /**
+     * Phantom reference to the originating schema. Used purely for type
+     * inference of field helpers.
+     */
     readonly _schema?: SchemaType | undefined;
 }
+/**
+ * Legacy wrapper around a typed server-side domain error value.
+ *
+ * @deprecated Tagged remote domain errors are no longer wrapped in
+ * `RemoteDomainError`. The user's own tagged error is now placed directly on
+ * the Effect error channel so `Effect.catchTag("YourTag", ...)` works without
+ * unwrapping. This interface is kept only for backwards compatibility with
+ * code that pattern-matched on `_tag === "RemoteDomainError"`.
+ */
 export interface RemoteDomainError<ErrorType = unknown> {
+    /** Discriminator identifying this variant of `RemoteFailure`. */
     readonly _tag: "RemoteDomainError";
+    /** The original typed error value produced on the server. */
     readonly cause: ErrorType;
+    /** HTTP status code associated with the failure. */
     readonly status: number;
 }
+/**
+ * Remote failure emitted when request validation (schema or form) rejects the
+ * payload. Defaults to HTTP `400`, but callers may override the status code
+ * when constructing the value.
+ */
 export interface RemoteValidationError {
+    /** Discriminator identifying this variant of `RemoteFailure`. */
     readonly _tag: "RemoteValidationError";
+    /** Raw response body returned alongside the failure, when available. */
     readonly body?: unknown;
+    /** Validation issues, keyed by field path. */
     readonly issues: ReadonlyArray<FormIssue>;
+    /** HTTP status code for the validation failure, defaulting to `400`. */
     readonly status: number;
 }
+/**
+ * Remote failure for HTTP-level errors returned by the server that do not map
+ * onto a typed domain error or validation failure.
+ */
 export interface RemoteHttpError {
+    /** Discriminator identifying this variant of `RemoteFailure`. */
     readonly _tag: "RemoteHttpError";
+    /** Parsed response body, if any. */
     readonly body?: unknown;
+    /** Original thrown value captured while handling the response. */
     readonly cause: unknown;
+    /** HTTP status code reported by the response. */
     readonly status: number;
 }
+/**
+ * Remote failure for transport-level breakages (network errors, decoding
+ * failures). Does not carry an HTTP status.
+ */
 export interface RemoteTransportError {
+    /** Discriminator identifying this variant of `RemoteFailure`. */
     readonly _tag: "RemoteTransportError";
+    /** Raw body captured when the transport failure was detected, if any. */
     readonly body?: unknown;
+    /** Underlying error value - usually a `TypeError` or `DOMException`. */
     readonly cause: unknown;
 }
-export type RemoteFailure<ErrorType = unknown> = RemoteDomainError<ErrorType> | RemoteValidationError | RemoteHttpError | RemoteTransportError;
+/**
+ * Error channel produced by every remote Effect wrapper. A server-side
+ * `Effect.fail(MyTaggedError)` surfaces on the client as the raw `ErrorType`,
+ * so `Effect.catchTag("MyTag", ...)` narrows directly to your error. The
+ * framework-level failure variants (`RemoteValidationError`,
+ * `RemoteHttpError`, `RemoteTransportError`) are still included for transport
+ * and HTTP failures that the caller didn't model explicitly.
+ */
+export type RemoteFailure<ErrorType = unknown> = ErrorType | RemoteValidationError | RemoteHttpError | RemoteTransportError;
+/**
+ * Wire shape of a serialised remote failure envelope that the server embeds
+ * in its response body.
+ *
+ * @internal Internal - do not use.
+ */
 export interface SerializedRemoteFailureEnvelope {
+    /** Marker flag; always `true`. */
     readonly [EFFECT_REMOTE_ERROR_MARKER]: true;
+    /** `devalue.stringify`-encoded payload for the failure value. */
     readonly encoded: string;
 }
+/**
+ * Construct a {@link FormError} from one or more {@link FormIssue}s.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function create_form_error<SchemaType = unknown>(...issues: Array<FormIssue>): FormError<SchemaType>;
+/**
+ * Build a {@link RemoteDomainError} around a typed server-side error value.
+ *
+ * @deprecated Remote tagged failures are no longer wrapped - the user's
+ * tagged error is forwarded directly on the Effect error channel. This helper
+ * is retained for backwards compatibility with downstream code that still
+ * constructs `RemoteDomainError` values explicitly.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function create_remote_domain_error<ErrorType = unknown>(cause: ErrorType, status: number): RemoteDomainError<ErrorType>;
+/**
+ * Build a {@link RemoteValidationError} from a list of issues.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function create_remote_validation_error(issues: ReadonlyArray<FormIssue>, options?: {
     body?: unknown;
     status?: number;
 }): RemoteValidationError;
+/**
+ * Build a {@link RemoteHttpError} from an arbitrary thrown value.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function create_remote_http_error(cause: unknown, options?: {
     body?: unknown;
     status?: number;
 }): RemoteHttpError;
+/**
+ * Build a {@link RemoteTransportError} from an arbitrary thrown value.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function create_remote_transport_error(cause: unknown, body?: unknown): RemoteTransportError;
+/**
+ * Wrap a pre-encoded failure payload in the marker envelope the client
+ * adapters look for when decoding responses.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function create_serialized_remote_failure_envelope(encoded: string): SerializedRemoteFailureEnvelope;
+/**
+ * Type guard for {@link FormError} values.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function is_form_error(value: unknown): value is FormError;
+/**
+ * Type guard recognising the marker envelope wrapping an encoded remote
+ * failure payload.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function is_serialized_remote_failure_envelope(value: unknown): value is SerializedRemoteFailureEnvelope;
+/**
+ * Type guard for individual {@link FormIssue} values.
+ *
+ * @internal Internal - do not use.
+ */
 export declare function is_remote_validation_issue(value: unknown): value is FormIssue;

package/dist/internal/remote-shared.js

@@ -1,12 +1,39 @@
 //#region internal/remote-shared.ts
+/**
+* Marker property name placed on serialized `RemoteFailure` envelopes so the
+* client adapters can recognise server-produced failure payloads.
+*
+* @internal Internal - do not use.
+*/
 const EFFECT_REMOTE_ERROR_MARKER = "__svelte_effect_remote__";
+/**
+* Well-known symbol used to attach a payload decoder to a remote function,
+* enabling the client to reconstruct typed domain errors from wire data.
+*
+* @internal Internal - do not use.
+*/
 const REMOTE_ERROR_DECODER = Symbol.for("svelte-effect-runtime/remote-error-decoder");
+/**
+* Construct a {@link FormError} from one or more {@link FormIssue}s.
+*
+* @internal Internal - do not use.
+*/
 function create_form_error(...issues) {
 	return {
 		_tag: "FormError",
 		issues
 	};
 }
+/**
+* Build a {@link RemoteDomainError} around a typed server-side error value.
+*
+* @deprecated Remote tagged failures are no longer wrapped - the user's
+* tagged error is forwarded directly on the Effect error channel. This helper
+* is retained for backwards compatibility with downstream code that still
+* constructs `RemoteDomainError` values explicitly.
+*
+* @internal Internal - do not use.
+*/
 function create_remote_domain_error(cause, status) {
 	return {
 		_tag: "RemoteDomainError",
@@ -14,6 +41,11 @@ function create_remote_domain_error(cause, status) {
 		status
 	};
 }
+/**
+* Build a {@link RemoteValidationError} from a list of issues.
+*
+* @internal Internal - do not use.
+*/
 function create_remote_validation_error(issues, options = {}) {
 	return {
 		_tag: "RemoteValidationError",
@@ -22,6 +54,11 @@ function create_remote_validation_error(issues, options = {}) {
 		status: options.status ?? 400
 	};
 }
+/**
+* Build a {@link RemoteHttpError} from an arbitrary thrown value.
+*
+* @internal Internal - do not use.
+*/
 function create_remote_http_error(cause, options = {}) {
 	return {
 		_tag: "RemoteHttpError",
@@ -30,6 +67,11 @@ function create_remote_http_error(cause, options = {}) {
 		status: options.status ?? 500
 	};
 }
+/**
+* Build a {@link RemoteTransportError} from an arbitrary thrown value.
+*
+* @internal Internal - do not use.
+*/
 function create_remote_transport_error(cause, body) {
 	return {
 		_tag: "RemoteTransportError",
@@ -37,18 +79,40 @@ function create_remote_transport_error(cause, body) {
 		cause
 	};
 }
+/**
+* Wrap a pre-encoded failure payload in the marker envelope the client
+* adapters look for when decoding responses.
+*
+* @internal Internal - do not use.
+*/
 function create_serialized_remote_failure_envelope(encoded) {
 	return {
 		[EFFECT_REMOTE_ERROR_MARKER]: true,
 		encoded
 	};
 }
+/**
+* Type guard for {@link FormError} values.
+*
+* @internal Internal - do not use.
+*/
 function is_form_error(value) {
 	return Boolean(value && typeof value === "object" && value._tag === "FormError" && Array.isArray(value.issues));
 }
+/**
+* Type guard recognising the marker envelope wrapping an encoded remote
+* failure payload.
+*
+* @internal Internal - do not use.
+*/
 function is_serialized_remote_failure_envelope(value) {
 	return Boolean(value && typeof value === "object" && "__svelte_effect_remote__" in value && value["__svelte_effect_remote__"] === true && typeof value.encoded === "string");
 }
+/**
+* Type guard for individual {@link FormIssue} values.
+*
+* @internal Internal - do not use.
+*/
 function is_remote_validation_issue(value) {
 	return Boolean(value && typeof value === "object" && typeof value.message === "string" && Array.isArray(value.path));
 }

package/dist/internal/remote-shared.js.map

@@ -1 +1 @@
-{"version":3,"file":"remote-shared.js","names":[],"sources":["../../../modules/svelte-effect-runtime/internal/remote-shared.ts"],"sourcesContent":["export const EFFECT_REMOTE_ERROR_MARKER = \"__svelte_effect_remote__\";\nexport const REMOTE_ERROR_DECODER = Symbol.for(\n  \"svelte-effect-runtime/remote-error-decoder\",\n);\n\nexport interface FormIssue {\n  readonly message: string;\n  readonly path: ReadonlyArray<string | number>;\n}\n\nexport interface FormError<SchemaType = unknown> {\n  readonly _tag: \"FormError\";\n  readonly issues: ReadonlyArray<FormIssue>;\n  readonly _schema?: SchemaType | undefined;\n}\n\nexport interface RemoteDomainError<ErrorType = unknown> {\n  readonly _tag: \"RemoteDomainError\";\n  readonly cause: ErrorType;\n  readonly status: number;\n}\n\nexport interface RemoteValidationError {\n  readonly _tag: \"RemoteValidationError\";\n  readonly body?: unknown;\n  readonly issues: ReadonlyArray<FormIssue>;\n  readonly status: number;\n}\n\nexport interface RemoteHttpError {\n  readonly _tag: \"RemoteHttpError\";\n  readonly body?: unknown;\n  readonly cause: unknown;\n  readonly status: number;\n}\n\nexport interface RemoteTransportError {\n  readonly _tag: \"RemoteTransportError\";\n  readonly body?: unknown;\n  readonly cause: unknown;\n}\n\nexport type RemoteFailure<ErrorType = unknown> =\n  | RemoteDomainError<ErrorType>\n  | RemoteValidationError\n  | RemoteHttpError\n  | RemoteTransportError;\n\nexport interface SerializedRemoteFailureEnvelope {\n  readonly [EFFECT_REMOTE_ERROR_MARKER]: true;\n  readonly encoded: string;\n}\n\nexport function create_form_error<SchemaType = unknown>(\n  ...issues: Array<FormIssue>\n): FormError<SchemaType> {\n  return {\n    _tag: \"FormError\",\n    issues,\n  };\n}\n\nexport function create_remote_domain_error<ErrorType = unknown>(\n  cause: ErrorType,\n  status: number,\n): RemoteDomainError<ErrorType> {\n  return {\n    _tag: \"RemoteDomainError\",\n    cause,\n    status,\n  };\n}\n\nexport function create_remote_validation_error(\n  issues: ReadonlyArray<FormIssue>,\n  options: {\n    body?: unknown;\n    status?: number;\n  } = {},\n): RemoteValidationError {\n  return {\n    _tag: \"RemoteValidationError\",\n    body: options.body,\n    issues,\n    status: options.status ?? 400,\n  };\n}\n\nexport function create_remote_http_error(\n  cause: unknown,\n  options: {\n    body?: unknown;\n    status?: number;\n  } = {},\n): RemoteHttpError {\n  return {\n    _tag: \"RemoteHttpError\",\n    body: options.body,\n    cause,\n    status: options.status ?? 500,\n  };\n}\n\nexport function create_remote_transport_error(\n  cause: unknown,\n  body?: unknown,\n): RemoteTransportError {\n  return {\n    _tag: \"RemoteTransportError\",\n    body,\n    cause,\n  };\n}\n\nexport function create_serialized_remote_failure_envelope(\n  encoded: string,\n): SerializedRemoteFailureEnvelope {\n  return {\n    [EFFECT_REMOTE_ERROR_MARKER]: true,\n    encoded,\n  };\n}\n\nexport function is_form_error(value: unknown): value is FormError {\n  return Boolean(\n    value &&\n      typeof value === \"object\" &&\n      (value as { _tag?: unknown })._tag === \"FormError\" &&\n      Array.isArray((value as { issues?: unknown }).issues),\n  );\n}\n\nexport function is_serialized_remote_failure_envelope(\n  value: unknown,\n): value is SerializedRemoteFailureEnvelope {\n  return Boolean(\n    value &&\n      typeof value === \"object\" &&\n      EFFECT_REMOTE_ERROR_MARKER in value &&\n      (value as Record<string, unknown>)[EFFECT_REMOTE_ERROR_MARKER] === true &&\n      typeof (value as { encoded?: unknown }).encoded === \"string\",\n  );\n}\n\nexport function is_remote_validation_issue(\n  value: unknown,\n): value is FormIssue {\n  return Boolean(\n    value &&\n      typeof value === \"object\" &&\n      typeof (value as { message?: unknown }).message === \"string\" &&\n      Array.isArray((value as { path?: unknown }).path),\n  );\n}\n"],"mappings":";AAAA,MAAa,6BAA6B;AAC1C,MAAa,uBAAuB,OAAO,IACzC,6CACD;AAkDD,SAAgB,kBACd,GAAG,QACoB;AACvB,QAAO;EACL,MAAM;EACN;EACD;;AAGH,SAAgB,2BACd,OACA,QAC8B;AAC9B,QAAO;EACL,MAAM;EACN;EACA;EACD;;AAGH,SAAgB,+BACd,QACA,UAGI,EAAE,EACiB;AACvB,QAAO;EACL,MAAM;EACN,MAAM,QAAQ;EACd;EACA,QAAQ,QAAQ,UAAU;EAC3B;;AAGH,SAAgB,yBACd,OACA,UAGI,EAAE,EACW;AACjB,QAAO;EACL,MAAM;EACN,MAAM,QAAQ;EACd;EACA,QAAQ,QAAQ,UAAU;EAC3B;;AAGH,SAAgB,8BACd,OACA,MACsB;AACtB,QAAO;EACL,MAAM;EACN;EACA;EACD;;AAGH,SAAgB,0CACd,SACiC;AACjC,QAAO;GACJ,6BAA6B;EAC9B;EACD;;AAGH,SAAgB,cAAc,OAAoC;AAChE,QAAO,QACL,SACE,OAAO,UAAU,YAChB,MAA6B,SAAS,eACvC,MAAM,QAAS,MAA+B,OAAO,CACxD;;AAGH,SAAgB,sCACd,OAC0C;AAC1C,QAAO,QACL,SACE,OAAO,UAAU,YAAA,8BACa,SAC7B,MAAA,gCAAkE,QACnE,OAAQ,MAAgC,YAAY,SACvD;;AAGH,SAAgB,2BACd,OACoB;AACpB,QAAO,QACL,SACE,OAAO,UAAU,YACjB,OAAQ,MAAgC,YAAY,YACpD,MAAM,QAAS,MAA6B,KAAK,CACpD"}
+{"version":3,"file":"remote-shared.js","names":[],"sources":["../../../modules/svelte-effect-runtime/internal/remote-shared.ts"],"sourcesContent":["/**\n * Marker property name placed on serialized `RemoteFailure` envelopes so the\n * client adapters can recognise server-produced failure payloads.\n *\n * @internal Internal - do not use.\n */\nexport const EFFECT_REMOTE_ERROR_MARKER = \"__svelte_effect_remote__\";\n/**\n * Well-known symbol used to attach a payload decoder to a remote function,\n * enabling the client to reconstruct typed domain errors from wire data.\n *\n * @internal Internal - do not use.\n */\nexport const REMOTE_ERROR_DECODER = Symbol.for(\n  \"svelte-effect-runtime/remote-error-decoder\",\n);\n\n/**\n * A single validation problem surfaced by a remote form or schema check.\n * Mirrors SvelteKit's `invalid()` issue shape.\n */\nexport interface FormIssue {\n  /** Human-readable description of the failure at {@link FormIssue.path}. */\n  readonly message: string;\n  /** Field path (dot or array-index segments) the issue applies to. */\n  readonly path: ReadonlyArray<string | number>;\n}\n\n/**\n * Typed error produced by `invalid.form(...)` / `invalid.<field>(...)` helpers\n * inside a `Form` handler. Carries the collected `FormIssue`s to surface to\n * the browser.\n */\nexport interface FormError<SchemaType = unknown> {\n  /** Discriminator identifying this as a form error. */\n  readonly _tag: \"FormError\";\n  /** Issues produced by the handler, one per failed field. */\n  readonly issues: ReadonlyArray<FormIssue>;\n  /**\n   * Phantom reference to the originating schema. Used purely for type\n   * inference of field helpers.\n   */\n  readonly _schema?: SchemaType | undefined;\n}\n\n/**\n * Legacy wrapper around a typed server-side domain error value.\n *\n * @deprecated Tagged remote domain errors are no longer wrapped in\n * `RemoteDomainError`. The user's own tagged error is now placed directly on\n * the Effect error channel so `Effect.catchTag(\"YourTag\", ...)` works without\n * unwrapping. This interface is kept only for backwards compatibility with\n * code that pattern-matched on `_tag === \"RemoteDomainError\"`.\n */\nexport interface RemoteDomainError<ErrorType = unknown> {\n  /** Discriminator identifying this variant of `RemoteFailure`. */\n  readonly _tag: \"RemoteDomainError\";\n  /** The original typed error value produced on the server. */\n  readonly cause: ErrorType;\n  /** HTTP status code associated with the failure. */\n  readonly status: number;\n}\n\n/**\n * Remote failure emitted when request validation (schema or form) rejects the\n * payload. Defaults to HTTP `400`, but callers may override the status code\n * when constructing the value.\n */\nexport interface RemoteValidationError {\n  /** Discriminator identifying this variant of `RemoteFailure`. */\n  readonly _tag: \"RemoteValidationError\";\n  /** Raw response body returned alongside the failure, when available. */\n  readonly body?: unknown;\n  /** Validation issues, keyed by field path. */\n  readonly issues: ReadonlyArray<FormIssue>;\n  /** HTTP status code for the validation failure, defaulting to `400`. */\n  readonly status: number;\n}\n\n/**\n * Remote failure for HTTP-level errors returned by the server that do not map\n * onto a typed domain error or validation failure.\n */\nexport interface RemoteHttpError {\n  /** Discriminator identifying this variant of `RemoteFailure`. */\n  readonly _tag: \"RemoteHttpError\";\n  /** Parsed response body, if any. */\n  readonly body?: unknown;\n  /** Original thrown value captured while handling the response. */\n  readonly cause: unknown;\n  /** HTTP status code reported by the response. */\n  readonly status: number;\n}\n\n/**\n * Remote failure for transport-level breakages (network errors, decoding\n * failures). Does not carry an HTTP status.\n */\nexport interface RemoteTransportError {\n  /** Discriminator identifying this variant of `RemoteFailure`. */\n  readonly _tag: \"RemoteTransportError\";\n  /** Raw body captured when the transport failure was detected, if any. */\n  readonly body?: unknown;\n  /** Underlying error value - usually a `TypeError` or `DOMException`. */\n  readonly cause: unknown;\n}\n\n/**\n * Error channel produced by every remote Effect wrapper. A server-side\n * `Effect.fail(MyTaggedError)` surfaces on the client as the raw `ErrorType`,\n * so `Effect.catchTag(\"MyTag\", ...)` narrows directly to your error. The\n * framework-level failure variants (`RemoteValidationError`,\n * `RemoteHttpError`, `RemoteTransportError`) are still included for transport\n * and HTTP failures that the caller didn't model explicitly.\n */\nexport type RemoteFailure<ErrorType = unknown> =\n  | ErrorType\n  | RemoteValidationError\n  | RemoteHttpError\n  | RemoteTransportError;\n\n/**\n * Wire shape of a serialised remote failure envelope that the server embeds\n * in its response body.\n *\n * @internal Internal - do not use.\n */\nexport interface SerializedRemoteFailureEnvelope {\n  /** Marker flag; always `true`. */\n  readonly [EFFECT_REMOTE_ERROR_MARKER]: true;\n  /** `devalue.stringify`-encoded payload for the failure value. */\n  readonly encoded: string;\n}\n\n/**\n * Construct a {@link FormError} from one or more {@link FormIssue}s.\n *\n * @internal Internal - do not use.\n */\nexport function create_form_error<SchemaType = unknown>(\n  ...issues: Array<FormIssue>\n): FormError<SchemaType> {\n  return {\n    _tag: \"FormError\",\n    issues,\n  };\n}\n\n/**\n * Build a {@link RemoteDomainError} around a typed server-side error value.\n *\n * @deprecated Remote tagged failures are no longer wrapped - the user's\n * tagged error is forwarded directly on the Effect error channel. This helper\n * is retained for backwards compatibility with downstream code that still\n * constructs `RemoteDomainError` values explicitly.\n *\n * @internal Internal - do not use.\n */\nexport function create_remote_domain_error<ErrorType = unknown>(\n  cause: ErrorType,\n  status: number,\n): RemoteDomainError<ErrorType> {\n  return {\n    _tag: \"RemoteDomainError\",\n    cause,\n    status,\n  };\n}\n\n/**\n * Build a {@link RemoteValidationError} from a list of issues.\n *\n * @internal Internal - do not use.\n */\nexport function create_remote_validation_error(\n  issues: ReadonlyArray<FormIssue>,\n  options: {\n    body?: unknown;\n    status?: number;\n  } = {},\n): RemoteValidationError {\n  return {\n    _tag: \"RemoteValidationError\",\n    body: options.body,\n    issues,\n    status: options.status ?? 400,\n  };\n}\n\n/**\n * Build a {@link RemoteHttpError} from an arbitrary thrown value.\n *\n * @internal Internal - do not use.\n */\nexport function create_remote_http_error(\n  cause: unknown,\n  options: {\n    body?: unknown;\n    status?: number;\n  } = {},\n): RemoteHttpError {\n  return {\n    _tag: \"RemoteHttpError\",\n    body: options.body,\n    cause,\n    status: options.status ?? 500,\n  };\n}\n\n/**\n * Build a {@link RemoteTransportError} from an arbitrary thrown value.\n *\n * @internal Internal - do not use.\n */\nexport function create_remote_transport_error(\n  cause: unknown,\n  body?: unknown,\n): RemoteTransportError {\n  return {\n    _tag: \"RemoteTransportError\",\n    body,\n    cause,\n  };\n}\n\n/**\n * Wrap a pre-encoded failure payload in the marker envelope the client\n * adapters look for when decoding responses.\n *\n * @internal Internal - do not use.\n */\nexport function create_serialized_remote_failure_envelope(\n  encoded: string,\n): SerializedRemoteFailureEnvelope {\n  return {\n    [EFFECT_REMOTE_ERROR_MARKER]: true,\n    encoded,\n  };\n}\n\n/**\n * Type guard for {@link FormError} values.\n *\n * @internal Internal - do not use.\n */\nexport function is_form_error(value: unknown): value is FormError {\n  return Boolean(\n    value &&\n      typeof value === \"object\" &&\n      (value as { _tag?: unknown })._tag === \"FormError\" &&\n      Array.isArray((value as { issues?: unknown }).issues),\n  );\n}\n\n/**\n * Type guard recognising the marker envelope wrapping an encoded remote\n * failure payload.\n *\n * @internal Internal - do not use.\n */\nexport function is_serialized_remote_failure_envelope(\n  value: unknown,\n): value is SerializedRemoteFailureEnvelope {\n  return Boolean(\n    value &&\n      typeof value === \"object\" &&\n      EFFECT_REMOTE_ERROR_MARKER in value &&\n      (value as Record<string, unknown>)[EFFECT_REMOTE_ERROR_MARKER] === true &&\n      typeof (value as { encoded?: unknown }).encoded === \"string\",\n  );\n}\n\n/**\n * Type guard for individual {@link FormIssue} values.\n *\n * @internal Internal - do not use.\n */\nexport function is_remote_validation_issue(\n  value: unknown,\n): value is FormIssue {\n  return Boolean(\n    value &&\n      typeof value === \"object\" &&\n      typeof (value as { message?: unknown }).message === \"string\" &&\n      Array.isArray((value as { path?: unknown }).path),\n  );\n}\n"],"mappings":";;;;;;;AAMA,MAAa,6BAA6B;;;;;;;AAO1C,MAAa,uBAAuB,OAAO,IACzC,6CACD;;;;;;AA4HD,SAAgB,kBACd,GAAG,QACoB;AACvB,QAAO;EACL,MAAM;EACN;EACD;;;;;;;;;;;;AAaH,SAAgB,2BACd,OACA,QAC8B;AAC9B,QAAO;EACL,MAAM;EACN;EACA;EACD;;;;;;;AAQH,SAAgB,+BACd,QACA,UAGI,EAAE,EACiB;AACvB,QAAO;EACL,MAAM;EACN,MAAM,QAAQ;EACd;EACA,QAAQ,QAAQ,UAAU;EAC3B;;;;;;;AAQH,SAAgB,yBACd,OACA,UAGI,EAAE,EACW;AACjB,QAAO;EACL,MAAM;EACN,MAAM,QAAQ;EACd;EACA,QAAQ,QAAQ,UAAU;EAC3B;;;;;;;AAQH,SAAgB,8BACd,OACA,MACsB;AACtB,QAAO;EACL,MAAM;EACN;EACA;EACD;;;;;;;;AASH,SAAgB,0CACd,SACiC;AACjC,QAAO;GACJ,6BAA6B;EAC9B;EACD;;;;;;;AAQH,SAAgB,cAAc,OAAoC;AAChE,QAAO,QACL,SACE,OAAO,UAAU,YAChB,MAA6B,SAAS,eACvC,MAAM,QAAS,MAA+B,OAAO,CACxD;;;;;;;;AASH,SAAgB,sCACd,OAC0C;AAC1C,QAAO,QACL,SACE,OAAO,UAAU,YAAA,8BACa,SAC7B,MAAA,gCAAkE,QACnE,OAAQ,MAAgC,YAAY,SACvD;;;;;;;AAQH,SAAgB,2BACd,OACoB;AACpB,QAAO,QACL,SACE,OAAO,UAAU,YACjB,OAAQ,MAAgC,YAAY,YACpD,MAAM,QAAS,MAA6B,KAAK,CACpD"}

package/dist/internal/transform.d.ts

@@ -6,6 +6,13 @@ interface TransformEffectScriptOptions extends EffectPreprocessOptions {
 interface TransformEffectScriptResult {
     code: string;
     map: SourceMap;
+    relocations: Array<TransformRelocation>;
+}
+interface TransformRelocation {
+    originalStart: number;
+    originalEnd: number;
+    generatedStart: number;
+    generatedEnd: number;
 }
 export declare function transformEffectScript(content: string, options: TransformEffectScriptOptions): TransformEffectScriptResult;
 export {};

package/dist/internal/transform.js

@@ -35,6 +35,7 @@ function transformEffectScript(content, options) {
 	const sourceFile = ts.createSourceFile(options.filename, content, ts.ScriptTarget.Latest, true, ts.ScriptKind.TS);
 	const effectStatements = [];
 	const runtimeStatements = [];
+	const pendingRelocations = [];
 	const magicString = new MagicString(content);
 	const effectBoundBindings = /* @__PURE__ */ new Set();
 	for (const statement of sourceFile.statements) {
@@ -44,6 +45,7 @@ function transformEffectScript(content, options) {
 			if (transformed.hoistedText.length === 0) magicString.remove(statement.getFullStart(), statement.end);
 			else magicString.overwrite(statement.getStart(sourceFile), statement.end, transformed.hoistedText);
 			runtimeStatements.push(...transformed.effectTexts);
+			pendingRelocations.push(...transformed.pendingRelocations);
 			for (const bindingName of transformed.loweredBindings) effectBoundBindings.add(bindingName);
 			continue;
 		}
@@ -54,6 +56,13 @@ function transformEffectScript(content, options) {
 			node: statement,
 			text: normalizeStatementText(sliceNode(content, statement))
 		});
+		pendingRelocations.push({
+			originalStart: statement.getStart(sourceFile),
+			originalEnd: statement.end,
+			generatedSnippet: normalizeStatementText(sliceNode(content, statement)),
+			generatedInnerStart: 0,
+			generatedInnerEnd: normalizeStatementText(sliceNode(content, statement)).length
+		});
 	}
 	for (const statement of [...effectStatements].reverse()) magicString.remove(statement.node.getFullStart(), statement.node.end);
 	const allRuntimeStatements = [...runtimeStatements, ...effectStatements.map((statement) => statement.text)];
@@ -61,13 +70,15 @@ function transformEffectScript(content, options) {
 		magicString.prepend(makeInjectedImports(options));
 		magicString.append(makeRuntimeBlock(allRuntimeStatements));
 	}
+	const code = magicString.toString();
 	return {
-		code: magicString.toString(),
+		code,
 		map: magicString.generateMap({
 			hires: true,
 			includeContent: true,
 			source: options.filename
-		})
+		}),
+		relocations: resolvePendingRelocations(pendingRelocations, code)
 	};
 }
 function isHoistedStatement(statement) {
@@ -91,34 +102,60 @@ function transformVariableStatement(statement, content, filename, effectBoundBin
 		return {
 			effectTexts: [],
 			hoistedText: normalizeStatementText(sliceNode(content, statement)),
-			loweredBindings: []
+			loweredBindings: [],
+			pendingRelocations: [],
+			usesPendingYieldHelper: false
 		};
 	}
 	const effectTexts = [];
 	const hoistedDeclarations = [];
 	const loweredBindings = [];
+	const pendingRelocations = [];
 	for (const declaration of statement.declarationList.declarations) {
 		if (declaration.initializer && containsTopLevelAwait(declaration.initializer)) {
 			const statementText = normalizeStatementText(sliceNode(content, statement));
 			throw new Error(`${filename}: declarations in <script effect> cannot depend on await.\nUse yield* Effect.promise(...) or yield* Effect.tryPromise(...) instead.\n\nProblematic statement:\n${statementText}`);
 		}
 		if (declaration.initializer && isRuneInitializer(declaration.initializer)) {
-			hoistedDeclarations.push(`${getDeclarationKind(statement.declarationList.flags)} ${normalizeStatementText(sliceNode(content, declaration))};`);
+			const renderedDeclaration = `${getDeclarationKind(statement.declarationList.flags)} ${normalizeStatementText(sliceNode(content, declaration))};`;
+			hoistedDeclarations.push(renderedDeclaration);
+			pendingRelocations.push(...make_declaration_relocations(declaration, renderedDeclaration, content));
 			continue;
 		}
 		if (shouldHoistDeclaration(statement.declarationList.flags, declaration, effectBoundBindings)) {
-			hoistedDeclarations.push(`${getDeclarationKind(statement.declarationList.flags)} ${normalizeStatementText(sliceNode(content, declaration))};`);
+			const renderedDeclaration = `${getDeclarationKind(statement.declarationList.flags)} ${normalizeStatementText(sliceNode(content, declaration))};`;
+			hoistedDeclarations.push(renderedDeclaration);
+			pendingRelocations.push(...make_declaration_relocations(declaration, renderedDeclaration, content));
 			continue;
 		}
 		const bindingNames = extractBindingNames(declaration.name);
-		for (const bindingName of bindingNames) hoistedDeclarations.push(makeStateDeclaration(bindingName, declaration, content));
+		const helper = create_lowered_declaration_helper(declaration, content);
+		if (helper) {
+			hoistedDeclarations.push(helper.declarationText);
+			pendingRelocations.push(helper.expressionRelocation);
+		}
+		if (helper?.tempName) hoistedDeclarations.push(makeTypedStateBinding(helper.tempName, helper.stateTypeText));
+		for (const bindingName of bindingNames) {
+			const stateDeclaration = makeStateDeclaration(bindingName, declaration, content, helper?.tempName ? null : helper?.stateTypeText);
+			hoistedDeclarations.push(stateDeclaration.code);
+			pendingRelocations.push(...stateDeclaration.pendingRelocations);
+		}
 		loweredBindings.push(...bindingNames);
-		if (declaration.initializer) effectTexts.push(makeEffectAssignment(declaration.name, declaration.initializer, content));
+		if (declaration.initializer) if (helper?.tempName) {
+			effectTexts.push(`${helper.tempName} = ${helper.assignmentExpression};`);
+			effectTexts.push(makeEffectAssignment(declaration.name, helper.tempName, content));
+		} else {
+			const effectAssignment = helper ? `${bindingNames[0]} = ${helper.assignmentExpression};` : makeEffectAssignment(declaration.name, declaration.initializer, content);
+			effectTexts.push(effectAssignment);
+			if (!helper) pendingRelocations.push(makeEffectAssignmentRelocation(declaration.initializer, effectAssignment, content));
+		}
 	}
 	return {
 		effectTexts,
 		hoistedText: hoistedDeclarations.join("\n"),
-		loweredBindings
+		loweredBindings,
+		pendingRelocations,
+		usesPendingYieldHelper: false
 	};
 }
 function shouldHoistDeclaration(flags, declaration, effectBoundBindings) {
@@ -178,16 +215,45 @@ function getDeclarationKind(flags) {
 	if ((flags & ts.NodeFlags.Let) !== 0) return "let";
 	return "var";
 }
-function makeStateDeclaration(name, declaration, content) {
-	if (ts.isIdentifier(declaration.name) && declaration.type) return `let ${name} = $state<${normalizeStatementText(sliceNode(content, declaration.type))} | undefined>(undefined);`;
-	return `let ${name} = $state<any>(undefined);`;
+function makeStateDeclaration(name, declaration, content, inferredTypeText) {
+	let stateTypeText = null;
+	if (ts.isIdentifier(declaration.name) && declaration.type) stateTypeText = normalizeStatementText(sliceNode(content, declaration.type));
+	else if (inferredTypeText) stateTypeText = inferredTypeText;
+	const code = stateTypeText ? makeTypedStateBinding(name, stateTypeText) : `let ${name} = $state<any>(undefined);`;
+	const nameStart = code.indexOf(name);
+	const pendingRelocations = [{
+		originalStart: find_binding_name_start(declaration.name, name),
+		originalEnd: find_binding_name_end(declaration.name, name),
+		generatedSnippet: "",
+		generatedInnerStart: nameStart,
+		generatedInnerEnd: nameStart + name.length
+	}];
+	pendingRelocations[0] = {
+		...pendingRelocations[0],
+		generatedSnippet: code
+	};
+	return {
+		code,
+		pendingRelocations
+	};
 }
 function makeEffectAssignment(name, initializer, content) {
 	const target = normalizeStatementText(sliceNode(content, name));
-	const expression = normalizeStatementText(sliceNode(content, initializer));
+	const expression = typeof initializer === "string" ? initializer : normalizeStatementText(sliceNode(content, initializer));
 	if (ts.isIdentifier(name)) return `${target} = ${expression};`;
 	return `(${target} = ${expression});`;
 }
+function makeEffectAssignmentRelocation(initializer, effectAssignment, content) {
+	const expression = normalizeStatementText(sliceNode(content, initializer));
+	const generatedInnerStart = effectAssignment.lastIndexOf(expression);
+	return {
+		originalStart: initializer.getStart(),
+		originalEnd: initializer.end,
+		generatedSnippet: effectAssignment,
+		generatedInnerStart,
+		generatedInnerEnd: generatedInnerStart + expression.length
+	};
+}
 function extractBindingNames(name) {
 	if (ts.isIdentifier(name)) return [name.text];
 	const names = [];
@@ -210,6 +276,10 @@ function containsYieldStar(node) {
 	if (ts.isBinaryExpression(node) && node.operatorToken.kind === ts.SyntaxKind.AsteriskToken && ts.isIdentifier(node.left) && node.left.text === "yield") return true;
 	return node.getChildren().some((child) => isFunctionBoundary(child) ? false : containsYieldStar(child));
 }
+function getYieldOperand(node) {
+	if (node && ts.isBinaryExpression(node) && node.operatorToken.kind === ts.SyntaxKind.AsteriskToken && ts.isIdentifier(node.left) && node.left.text === "yield") return node.right;
+	return null;
+}
 function containsTopLevelAwait(node) {
 	if (ts.isAwaitExpression(node)) return true;
 	return node.getChildren().some((child) => isFunctionBoundary(child) ? false : containsTopLevelAwait(child));
@@ -229,12 +299,83 @@ function indentBlock(text, indent) {
 function makeInjectedImports(options) {
 	const runtimeModuleId = options.runtimeModuleId ?? DEFAULT_RUNTIME_MODULE_ID;
 	const effectModuleId = options.effectModuleId ?? DEFAULT_EFFECT_MODULE_ID;
-	return [
+	const lines = [
 		`import { onMount as __svelteEffectRuntimeOnMount } from "${options.svelteModuleId ?? DEFAULT_SVELTE_MODULE_ID}";`,
 		`import { Effect as __svelteEffectRuntimeEffect } from "${effectModuleId}";`,
 		`import { get_effect_runtime_or_throw as __svelteEffectRuntimeGetRuntime, run_component_effect as __svelteEffectRuntimeRunComponentEffect } from "${runtimeModuleId}";`,
-		""
-	].join("\n");
+		`type __svelteEffectRuntimeYielded<T> = T extends __svelteEffectRuntimeEffect.Effect<infer A, any, any> ? A : T;`
+	];
+	lines.push("");
+	return lines.join("\n");
+}
+function makeTypedStateBinding(name, stateTypeText) {
+	return `let ${name}: ${stateTypeText} | undefined = $state(undefined as ${stateTypeText} | undefined);`;
+}
+function create_lowered_declaration_helper(declaration, content) {
+	if (declaration.type || !declaration.initializer) return null;
+	const bindingNames = extractBindingNames(declaration.name);
+	const suffix = declaration.getStart();
+	const helperName = `__svelteEffectRuntime_${bindingNames[0] ?? "binding"}_${suffix}`;
+	const expressionNode = getYieldOperand(declaration.initializer) ?? declaration.initializer;
+	const expressionText = normalizeStatementText(sliceNode(content, expressionNode));
+	const declarationText = `const ${helperName} = () => ${expressionText};`;
+	const yieldedExpression = getYieldOperand(declaration.initializer);
+	return {
+		declarationText,
+		stateTypeText: yieldedExpression ? `__svelteEffectRuntimeYielded<ReturnType<typeof ${helperName}>>` : `ReturnType<typeof ${helperName}>`,
+		assignmentExpression: yieldedExpression ? `yield* ${helperName}()` : `${helperName}()`,
+		tempName: ts.isIdentifier(declaration.name) ? void 0 : `__svelteEffectRuntimeTemp_${suffix}`,
+		expressionRelocation: {
+			originalStart: expressionNode.getStart(),
+			originalEnd: expressionNode.end,
+			generatedSnippet: declarationText,
+			generatedInnerStart: declarationText.lastIndexOf(expressionText),
+			generatedInnerEnd: declarationText.lastIndexOf(expressionText) + expressionText.length
+		}
+	};
+}
+function make_declaration_relocations(declaration, renderedDeclaration, content) {
+	const relocations = [];
+	if (ts.isIdentifier(declaration.name)) {
+		const nameStart = renderedDeclaration.indexOf(declaration.name.text);
+		relocations.push({
+			originalStart: declaration.name.getStart(),
+			originalEnd: declaration.name.end,
+			generatedSnippet: renderedDeclaration,
+			generatedInnerStart: nameStart,
+			generatedInnerEnd: nameStart + declaration.name.text.length
+		});
+	}
+	if (declaration.initializer) {
+		const initializerText = normalizeStatementText(sliceNode(content, declaration.initializer));
+		const initializerStart = renderedDeclaration.lastIndexOf(initializerText);
+		if (initializerStart >= 0) relocations.push({
+			originalStart: declaration.initializer.getStart(),
+			originalEnd: declaration.initializer.end,
+			generatedSnippet: renderedDeclaration,
+			generatedInnerStart: initializerStart,
+			generatedInnerEnd: initializerStart + initializerText.length
+		});
+	}
+	return relocations;
+}
+function find_binding_name_start(name, bindingName) {
+	if (ts.isIdentifier(name)) return name.text === bindingName ? name.getStart() : -1;
+	for (const element of name.elements) {
+		if (ts.isOmittedExpression(element)) continue;
+		const start = find_binding_name_start(element.name, bindingName);
+		if (start !== -1) return start;
+	}
+	return -1;
+}
+function find_binding_name_end(name, bindingName) {
+	if (ts.isIdentifier(name)) return name.text === bindingName ? name.end : -1;
+	for (const element of name.elements) {
+		if (ts.isOmittedExpression(element)) continue;
+		const end = find_binding_name_end(element.name, bindingName);
+		if (end !== -1) return end;
+	}
+	return -1;
 }
 function makeRuntimeBlock(statements) {
 	return [
@@ -255,6 +396,22 @@ function makeRuntimeBlock(statements) {
 		""
 	].join("\n");
 }
+function resolvePendingRelocations(pendingRelocations, code) {
+	const relocations = [];
+	let searchStart = 0;
+	for (const relocation of pendingRelocations) {
+		const generatedStart = code.indexOf(relocation.generatedSnippet, searchStart);
+		if (generatedStart === -1) continue;
+		searchStart = generatedStart + relocation.generatedSnippet.length;
+		relocations.push({
+			originalStart: relocation.originalStart,
+			originalEnd: relocation.originalEnd,
+			generatedStart: generatedStart + relocation.generatedInnerStart,
+			generatedEnd: generatedStart + relocation.generatedInnerEnd
+		});
+	}
+	return relocations;
+}
 //#endregion
 export { transformEffectScript };