effect-atom-svelte 0.0.0-stage → 0.1.0

package/dist/SvelteKit.js

@@ -0,0 +1,90 @@
+/**
+ * SvelteKit `handleError` hooks that keep an Effect error's `_tag`, so a `<svelte:boundary>`
+ * `failed` snippet can tell typed errors apart. Import them from `effect-atom-svelte/sveltekit`.
+ *
+ * The module does not import SvelteKit: the hooks take the fields of SvelteKit's input they read
+ * and return the fields they set, so they type-check against `HandleClientError` and
+ * `HandleServerError` once `App.Error` declares `tag?: string`.
+ *
+ * @since 0.1.0
+ */
+const tagOf = (error) => typeof error === "object" &&
+    error !== null &&
+    "_tag" in error &&
+    typeof error._tag === "string"
+    ? error._tag
+    : undefined;
+const messageOf = (error) => {
+    if (error instanceof Error) {
+        return error.message;
+    }
+    return typeof error === "string" ? error : undefined;
+};
+// SvelteKit 2 expects a message from the hook, and passes the one it would show. SvelteKit 3 fills
+// in its own, and warns in development when the hook reads `message`, so it is read only without a
+// `kind`.
+const fallbackMessage = (input) => input.kind === undefined ? input.message : undefined;
+// Leaves out empty fields, so SvelteKit's defaults apply, and returns nothing when both are empty.
+const body = (message, tag) => {
+    if (!(message || tag)) {
+        return undefined;
+    }
+    return { ...(message ? { message } : {}), ...(tag ? { tag } : {}) };
+};
+/**
+ * A client `handleError` hook (`src/hooks.client.ts`) that keeps the message and `_tag` of errors
+ * thrown by your code, so a boundary's `failed` snippet shows them instead of
+ * `{ status: 500, message: "Internal Error" }`. It logs those errors like SvelteKit's default
+ * hook, and leaves `error(...)` and SvelteKit's own errors as they are. Made for SvelteKit 3:
+ * SvelteKit 2 doesn't say which errors are its own, so there every error is kept and logged.
+ *
+ * **Example** (Using it as the client hook)
+ *
+ * ```ts
+ * // src/hooks.client.ts
+ * export { handleClientError as handleError } from "effect-atom-svelte/sveltekit";
+ * ```
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category hooks
+ */
+export const handleClientError = (input) => {
+    // Destructured here, not in the parameter list, so the API reference shows a named parameter.
+    const { error, kind = "unknown" } = input;
+    if (kind !== "unknown") {
+        return undefined;
+    }
+    console.error(error);
+    return body(messageOf(error) ?? fallbackMessage(input), tagOf(error));
+};
+/**
+ * A server `handleError` hook (`src/hooks.server.ts`) that keeps the `_tag` of errors thrown by
+ * your code but not their message, which could expose details of the server to users: the
+ * message stays SvelteKit's `"Internal Error"`. It logs errors with `console.error`.
+ * Server errors reach a boundary's `failed` snippet when it renders on the server. Made for
+ * SvelteKit 3: SvelteKit 2 doesn't say which errors are its own, so there every error is logged.
+ *
+ * **Example** (Using it as the server hook)
+ *
+ * ```ts
+ * // src/hooks.server.ts
+ * export { handleServerError as handleError } from "effect-atom-svelte/sveltekit";
+ * ```
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category hooks
+ */
+export const handleServerError = (input) => {
+    const { error, issues, kind = "unknown" } = input;
+    if (kind === "validation") {
+        console.error("Remote function schema validation failed:", issues);
+        return undefined;
+    }
+    if (kind !== "unknown") {
+        return undefined;
+    }
+    console.error(error);
+    return body(fallbackMessage(input), tagOf(error));
+};

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Svelte 5 bindings for Effect Atom: the hooks, components and registry an app uses, scoped atoms,
+ * and Effect Atom's own modules.
+ *
+ * @since 0.1.0
+ */
+/**
+ * The hooks that read, write and await atoms from components.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category hooks
+ */
+export * from "./Hooks.svelte.ts";
+/**
+ * The registry that hooks read from, and `provideRegistry` to give a component tree its own.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category registry
+ */
+export * from "./RegistryContext.ts";
+/**
+ * @stability unstable
+ * @since 0.1.0
+ * @category components
+ */
+export { default as HydrationBoundary } from "./HydrationBoundary.svelte";
+/**
+ * @stability unstable
+ * @since 0.1.0
+ * @category components
+ */
+export { default as RegistryProvider } from "./RegistryProvider.svelte";
+/**
+ * Atoms created once per component subtree and read from context below it.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category scoped atoms
+ */
+export * as ScopedAtom from "./ScopedAtom.ts";
+/**
+ * Effect Atom's modules, so an app can import everything from one place.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category re-exports
+ */
+export { AsyncResult, Atom, AtomHttpApi, AtomRef, AtomRegistry, AtomRpc, Hydration, } from "effect/reactivity";

package/dist/index.js

@@ -0,0 +1,50 @@
+/**
+ * Svelte 5 bindings for Effect Atom: the hooks, components and registry an app uses, scoped atoms,
+ * and Effect Atom's own modules.
+ *
+ * @since 0.1.0
+ */
+/**
+ * The hooks that read, write and await atoms from components.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category hooks
+ */
+export * from "./Hooks.svelte.js";
+/**
+ * The registry that hooks read from, and `provideRegistry` to give a component tree its own.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category registry
+ */
+export * from "./RegistryContext.js";
+/**
+ * @stability unstable
+ * @since 0.1.0
+ * @category components
+ */
+export { default as HydrationBoundary } from "./HydrationBoundary.svelte";
+/**
+ * @stability unstable
+ * @since 0.1.0
+ * @category components
+ */
+export { default as RegistryProvider } from "./RegistryProvider.svelte";
+/**
+ * Atoms created once per component subtree and read from context below it.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category scoped atoms
+ */
+export * as ScopedAtom from "./ScopedAtom.js";
+/**
+ * Effect Atom's modules, so an app can import everything from one place.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ * @category re-exports
+ */
+export { AsyncResult, Atom, AtomHttpApi, AtomRef, AtomRegistry, AtomRpc, Hydration, } from "effect/reactivity";

package/dist/internal/hydration.d.ts

@@ -0,0 +1,26 @@
+import { AsyncResult } from "effect/reactivity";
+/** Sets the default for this component's children. Call during component init. */
+export declare const setRevalidateOnHydrate: (value: boolean) => void;
+/**
+ * Whether a hook runs its atom again once the page has hydrated: its own option, else the nearest
+ * provider's, else no (JND-19). Call during component init.
+ */
+export declare const revalidatesOnHydrate: (option: boolean | undefined) => boolean;
+/**
+ * Encodes the server's result for the page, or returns the no-seed marker for a result that must
+ * not or cannot travel:
+ *
+ * - A failure with a defect or an interruption. `Schema.Defect` keeps a defect's name, message and
+ *   cause, which can hold details of the server (a connection string, say) that `handleServerError`
+ *   keeps from the visitor. Typed errors are part of the atom's schema, so they are sent.
+ * - A result the schema can't encode, as Effect's `Hydration.dehydrate` skips it, rather than
+ *   failing the whole render. Development builds warn.
+ */
+export declare const encodeSeed: (key: string, encode: (value: AsyncResult.AsyncResult<unknown, unknown>) => unknown, result: AsyncResult.AsyncResult<unknown, unknown>) => unknown;
+/** The server's result, decoded, or undefined when the server sent none. */
+export declare const decodeSeed: (value: unknown, decode: (value: unknown) => unknown) => unknown;
+/**
+ * Whether a seed is still waiting, as a stream's result is between its values. The browser runs
+ * the atom again from it, as the server's run ended with the render.
+ */
+export declare const isWaiting: (value: unknown) => boolean;

package/dist/internal/hydration.js

@@ -0,0 +1,57 @@
+// Hydration helpers shared by the hooks: the registry provider's default for revalidateOnHydrate,
+// and how a seed is encoded on the server and read in the browser. Internal: not exported from the
+// package.
+import { Cause, Schema } from "effect";
+import { AsyncResult } from "effect/reactivity";
+import { DEV } from "esm-env";
+import { createContext } from "svelte";
+const [getDefault, setDefault, hasDefault] = createContext();
+/** Sets the default for this component's children. Call during component init. */
+export const setRevalidateOnHydrate = (value) => {
+    setDefault(value);
+};
+/**
+ * Whether a hook runs its atom again once the page has hydrated: its own option, else the nearest
+ * provider's, else no (JND-19). Call during component init.
+ */
+export const revalidatesOnHydrate = (option) => option ?? (hasDefault() ? getDefault() : false);
+/**
+ * What the server sends for a result it doesn't pass on, so the browser computes the atom itself.
+ * An encoded `AsyncResult` is an object, never `null`.
+ */
+const noSeed = null;
+/**
+ * Encodes the server's result for the page, or returns the no-seed marker for a result that must
+ * not or cannot travel:
+ *
+ * - A failure with a defect or an interruption. `Schema.Defect` keeps a defect's name, message and
+ *   cause, which can hold details of the server (a connection string, say) that `handleServerError`
+ *   keeps from the visitor. Typed errors are part of the atom's schema, so they are sent.
+ * - A result the schema can't encode, as Effect's `Hydration.dehydrate` skips it, rather than
+ *   failing the whole render. Development builds warn.
+ */
+export const encodeSeed = (key, encode, result) => {
+    if (AsyncResult.isFailure(result) &&
+        (Cause.hasDies(result.cause) || Cause.hasInterrupts(result.cause))) {
+        return noSeed;
+    }
+    try {
+        return encode(result);
+    }
+    catch (error) {
+        if (!Schema.isSchemaError(error)) {
+            throw error;
+        }
+        if (DEV) {
+            console.warn(`effect-atom-svelte: the result of the serializable atom "${key}" doesn't encode with its schema, so it isn't sent to the browser, which computes the atom again.`, error);
+        }
+        return noSeed;
+    }
+};
+/** The server's result, decoded, or undefined when the server sent none. */
+export const decodeSeed = (value, decode) => (value === noSeed ? undefined : decode(value));
+/**
+ * Whether a seed is still waiting, as a stream's result is between its values. The browser runs
+ * the atom again from it, as the server's run ended with the render.
+ */
+export const isWaiting = (value) => AsyncResult.isAsyncResult(value) && value.waiting;

package/package.json

@@ -1,6 +1,74 @@
 {
   "name": "effect-atom-svelte",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Community-built Svelte 5 bindings for Effect Atom (not affiliated with the Effect team)",
+  "keywords": [
+    "effect",
+    "effect-atom",
+    "reactivity",
+    "state",
+    "svelte",
+    "sveltekit"
+  ],
+  "homepage": "https://atom.jarrednorris.dev",
+  "bugs": "https://github.com/jarrednorrisdev/effect-atom-svelte/issues",
+  "license": "MIT",
+  "author": "Jarred Norris",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jarrednorrisdev/effect-atom-svelte.git",
+    "directory": "packages/effect-atom-svelte"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
+  "svelte": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./sveltekit": {
+      "types": "./dist/SvelteKit.d.ts",
+      "default": "./dist/SvelteKit.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "svelte-package -i src -o dist",
+    "check": "svelte-check --tsconfig ./tsconfig.json && bun scripts/check-docs.ts",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "esm-env": "^1.2.2"
+  },
+  "devDependencies": {
+    "@demo/domain": "workspace:*",
+    "@sveltejs/package": "^3.0.0",
+    "@sveltejs/vite-plugin-svelte": "^7.2.0",
+    "@vitest/browser": "^5.0.3",
+    "@vitest/browser-playwright": "^5.0.3",
+    "effect": "4.0.0",
+    "playwright": "^1.57.0",
+    "svelte": "^5.57.1",
+    "svelte-check": "^4.6.0",
+    "vite": "^8.3.0",
+    "vitest": "^5.0.3",
+    "vitest-browser-svelte": "^3.1.0"
+  },
+  "peerDependencies": {
+    "@sveltejs/kit": "^2.0.0 || ^3.0.0",
+    "effect": "~4.0.0",
+    "svelte": "^5.57.0"
+  },
+  "peerDependenciesMeta": {
+    "@sveltejs/kit": {
+      "optional": true
+    }
+  }
+}