ziex 0.1.0-dev.1466 → 0.1.0-dev.1568

package/README.md

@@ -6,10 +6,11 @@ A full-stack web framework for Zig. Declarative UI components using familiar pat
 
 Ziex combines the power and performance of Zig with the expressiveness and simplicity of declarative UI, enabling you to build fast, type-safe web applications.
 
-**[Documentation →](https://ziex.dev/learn)**
 
 > **Note:** Most of the API and syntax are finalized and stable, and server-side rendering (SSR) features are production-ready, Ziex continues to evolve with ongoing improvements to client-side rendering and state management, see the [roadmap](#roadmap). You can start using the documented features today, as they are stable and unlikely to change. Areas still under development are not yet documented and will be added as they mature. See [versions](#versions) for Zig and Ziex versions compatibility.
 
+**[Documentation →](https://ziex.dev/learn)**
+
 ## Getting Started
 
 ### 1. Installing CLI (optional)
@@ -181,13 +182,6 @@ The [`0.1.0`](https://github.com/ziex-dev/ziex/milestone/2) release will indicat
 
 The [`1.0.0`](https://github.com/ziex-dev/ziex/milestone/6) release will signify long-term support for that major version, receiving bug fixes and minor updates.
 
-## Editor Support
-
-- [VSCode](https://marketplace.visualstudio.com/items?itemName=ziex.ziex)/[VSCode Forks](https://open-vsx.org/extension/ziex/ziex)
-- [Neovim](/ide/neovim/)
-- [Helix](/ide/helix/)
-- [Zed](/ide/zed/)
-
 ## Community
 
 - [Discord](https://ziex.dev/r/discord)
@@ -198,4 +192,4 @@ The [`1.0.0`](https://github.com/ziex-dev/ziex/milestone/6) release will signify
 
 ## Contributing
 
-Contributions are welcome! Currently trying out Ziex and reporting issues for edge cases and providing feedback are greatly appreciated.
+Contributions are welcome! Trying out Ziex, reporting issues (especially edge cases), and providing feedback are greatly appreciated. You can also look through the [open issues](https://github.com/ziex-dev/ziex/issues) to find something to work on.

package/app.d.ts

@@ -1,4 +1,3 @@
-import type { DurableObjectNamespace } from "./runtime";
 import type { KVNamespace } from "./runtime/kv";
 import type { Database } from "./runtime/db";
 import type { WASI } from "./runtime/wasi";
@@ -16,18 +15,27 @@ export type WasmInput = WebAssembly.Module | ArrayBuffer | ArrayBufferView | Res
  * The result is NOT cached here - cache it at the call site if needed.
  */
 export declare function resolveModule(input: WasmInput): Promise<WebAssembly.Module>;
-/** Keys of `Env` whose value extends {@link KVNamespace}. */
+/** Keys of `Env` with a KV-like binding (host KV types rarely `extends` our interface). */
 type KVKey<Env> = {
-    [K in keyof Env]: Env[K] extends KVNamespace ? K : never;
+    [K in keyof Env]-?: Env[K] extends {
+        get(...args: any[]): any;
+        put(...args: any[]): any;
+    } ? K : never;
 }[keyof Env];
-/** Keys of `Env` whose value extends {@link DurableObjectNamespace}. */
-type DOKey<Env> = {
-    [K in keyof Env]: Env[K] extends DurableObjectNamespace ? K : never;
+/** Keys of `Env` whose value is a sticky long-lived fetch namespace. */
+export type StickyKey<Env> = {
+    [K in keyof Env]-?: Env[K] extends {
+        idFromName(name: string): any;
+        get(id: any, ...args: any[]): any;
+    } ? K : never;
 }[keyof Env];
+/** Keys of `Env` with a SQL prepare() binding (e.g. D1). */
 type DBKey<Env> = {
-    [K in keyof Env]: Env[K] extends Database ? K : never;
+    [K in keyof Env]-?: Env[K] extends {
+        prepare(query: string): any;
+    } ? K : never;
 }[keyof Env];
-type ZiexOptions<Env> = {
+export type ZiexOptions<Env = Record<string, unknown>> = {
     /** WASM module - accepts any {@link WasmInput}. Resolved and cached on first request. */
     module: WasmInput;
     /** Optional pre-configured WASI instance. */
@@ -58,15 +66,10 @@ type ZiexOptions<Env> = {
      */
     db?: DBKey<Env> | Record<string, DBKey<Env>>;
     /**
-     * Env key whose value is a `DurableObjectNamespace` for WebSocket pub/sub.
-     * Requires `createWebSocketDO` export on the worker.
-     *
-     * @example
-     * ```ts
-     * websocket: "ChatRoom"
-     * ```
+     * Env binding for sticky long-lived fetch (WebSocket upgrades, etc.).
+     * Prefer platform helpers (e.g. `stateful(app, binding)` on Cloudflare) over setting this directly.
      */
-    websocket?: DOKey<Env>;
+    sticky?: StickyKey<Env>;
 };
 /**
  * Main Ziex application class. Mirrors the Hono API style - construct once,
@@ -77,12 +80,11 @@ type ZiexOptions<Env> = {
  * @example Cloudflare Workers / wrangler
  * ```ts
  * import { Ziex } from "ziex";
+ * import { stateful } from "ziex/cloudflare";
  * import module from "./app.wasm";
  *
- * const app = new Ziex<Env>({
- *   module,
- *   kv: (env) => ({ default: env.KV }),
- * });
+ * const app = new Ziex<Env>({ module, kv: "KV", db: "DB" });
+ * export const ChatRoom = stateful(app, { binding: "CHAT_ROOM" });
  * export default app;
  * ```
  *
@@ -105,10 +107,23 @@ type ZiexOptions<Env> = {
  * ```
  */
 export declare class Ziex<Env = Record<string, unknown>> {
-    private readonly options;
+    /** @internal Platform adapters read shared config from here. */
+    protected readonly options: ZiexOptions<Env>;
     private resolved;
     constructor(options: ZiexOptions<Env>);
-    private getModule;
+    protected getModule(): Promise<WebAssembly.Module>;
+    /**
+     * Enable sticky upgrade forwarding and return host config for platform adapters
+     * (e.g. Cloudflare {@linkcode stateful}).
+     *
+     * Requires `options.module` to already be a compiled `WebAssembly.Module`.
+     */
+    stickyHost(binding: StickyKey<Env>): {
+        module: WebAssembly.Module;
+        imports: ((mem: () => WebAssembly.Memory) => WebAssembly.Imports) | undefined;
+        kv: (env: Env) => Record<string, KVNamespace> | undefined;
+        db: (env: Env) => Record<string, Database> | undefined;
+    };
     private resolveKV;
     private resolveDB;
     /**

package/build.zig.zon

@@ -2,6 +2,6 @@
     .name = .ziex_js,
     .fingerprint = 3758452767932569023,
     .version = "0.1.0-dev",
-    .minimum_zig_version = "0.17.0-dev.1465+8b2d0ce21",
+    .minimum_zig_version = "0.17.0",
     .paths = .{""},
 }

package/index.d.ts

@@ -1,2 +1,2 @@
 export { Ziex } from "./app";
-export type { WasmInput } from "./app";
+export type { WasmInput, ZiexOptions, StickyKey } from "./app";