lowlander 0.2.1 → 0.2.3

package/README.md

@@ -20,16 +20,261 @@ This library is built on top of a number of libraries by the same author:
 
 Lowlander glues these together and adds real-time partial data synchronization and type-safe RPCs to provide a framework for rapidly building performant full-stack (database included!) web applications.
 
-## Logging
+## Tutorial
 
-You can enable debug logging to stdout by setting the `LOWLANDER_LOG_LEVEL` environment variable to a number from 0 to 3. Higher numbers produce more verbose logs, including model-level operations, updates, and reads.
+### Project Setup
+
+```bash
+bun init
+bun add lowlander aberdeen edinburgh
+```
+
+(npm should also work for all of this.)
+
+Create the project structure:
+
+```
+server/
+  main.ts     # starts the server
+  api.ts      # exported functions = RPC endpoints
+client/
+  app.ts      # UI using Aberdeen + Connection
+```
+
+If you use Claude Code, GitHub Copilot or another AI agent that supports Skills, Lowlander and its dependencies include `skill/` directories that provide specialized knowledge to the AI.
+
+Symlink them into your project's `.claude/skills` directory:
+
+```bash
+mkdir -p .claude/skills
+ln -s ../../node_modules/lowlander/skill .claude/skills/lowlander
+ln -s ../../node_modules/aberdeen/skill .claude/skills/aberdeen
+ln -s ../../node_modules/edinburgh/skill .claude/skills/edinburgh
+```
+
+### Server Entry Point
+
+The entry point starts the WarpSocket server and points it at the API file:
+
+```ts
+// server/main.ts
+import { start } from 'lowlander/server';
+import { fileURLToPath } from 'url';
+import { resolve, dirname } from 'path';
+
+const API_FILE = resolve(dirname(fileURLToPath(import.meta.url)), 'api.js');
+start(API_FILE, { bind: '0.0.0.0:8080' });
+```
+
+Options: `bind` (address:port), `threads` (worker count).
+
+### Defining RPC Endpoints
+
+Every exported function in the API file is callable from the client. No decorators or registration needed:
+
+```ts
+// server/api.ts
+export function add(a: number, b: number): number {
+    return a + b;
+}
+```
+
+Functions can be `async`. Thrown errors are sent to the client as error responses.
+
+### Edinburgh Models
+
+Define persistent data models using Edinburgh. See [Edinburgh docs](https://github.com/vanviegen/edinburgh) for full details.
+
+```ts
+import * as E from 'edinburgh';
+
+@E.registerModel
+class Person extends E.Model<Person> {
+    static byName = E.primary(Person, 'name');
+    name = E.field(E.string);
+    age = E.field(E.number);
+    friends = E.field(E.array(E.link(Person)));
+    password = E.field(E.string);
+}
+```
+
+Models are ACID, and RPC calls automatically run in transactions. When creating a `new Instance()` or updating props on an existing instance, changes are persisted to disk automatically. `E.link` objects are lazy-loaded.
+
+### Model Streaming with `createStreamType`
+
+Stream a subset of model fields to clients with real-time updates. Changes are pushed automatically. First you need to create a stream type, by doing this once:
+
+```ts
+import { createStreamType } from 'lowlander/server';
+
+// Exclude password; include friends' names and ages
+const PersonStream = createStreamType(Person, {
+    name: true,
+    age: true,
+    friends: {        // nested linked model: specify sub-selection
+        name: true,
+        age: true,
+    }
+});
+```
+
+Use `true` for plain fields. For linked model fields, provide a nested selection object. To return a stream instance from an API function:
+
+```ts
+export function streamPerson(name: string) {
+    const person = Person.byName.get(name)!;
+    return new PersonStream(person);
+}
+```
+
+On the client, this returns a reactive Aberdeen proxy that updates live when server data changes.
+
+### ServerProxy for Stateful APIs
+
+Wrap a class instance to expose per-connection stateful methods:
+
+```ts
+import { ServerProxy } from 'lowlander/server';
+
+class UserAPI {
+    constructor(public userName: string) {}
+    
+    get user(): Person {
+        return Person.byName.get(this.userName)!;
+    }
+
+    getBio() {
+        return `${this.user.name} is ${this.user.age} years old`;
+    }
+}
+
+export async function authenticate(token: string) {
+    const user = Person.byName.get(token);
+    if (!user) throw new Error('User not found');
+    return new ServerProxy(new UserAPI(token), 'secret-value');
+}
+```
+
+The client receives `'secret-value'` as `.value` and can call `UserAPI` methods via `.serverProxy`.
+
+### Socket Callbacks
+
+Use `Socket<T>` parameters for server-push streaming. On the client, these become callback functions:
+
+```ts
+import { Socket } from 'lowlander/server';
+
+export function streamNumbers(socket: Socket<number>) {
+    const interval = setInterval(() => {
+        if (!socket.send(Math.random())) clearInterval(interval);
+    }, 1000);
+}
+```
+
+`socket.send()` returns falsy when the client disconnects.
+
+### Client Connection
+
+Connect to the server with full type safety:
+
+```ts
+import { Connection } from 'lowlander/client';
+import type * as API from './server/api.js';
+
+const conn = new Connection<typeof API>('ws://localhost:8080/');
+const api = conn.api;
+```
+
+All server exports are available on `conn.api` with matching types, except `Socket<T>` params become callbacks.
+
+#### Simple RPC
+
+```ts
+const sum = api.add(1, 2);
+// sum is a PromiseProxy:
+// - sum.value starts out as undefined, and reactively updates to the result when available
+// - sum.error is an Error object if the call threw, or undefined otherwise
+// - sum.promise can be awaited: `const val = await sum.promise;` - this throws on error
+```
+
+#### Using ServerProxy
+
+```ts
+const auth = api.authenticate('Frank');
+// auth.value → 'secret-value' (after resolution)
+// auth.serverProxy → typed proxy to UserAPI methods
+
+const bio = auth.serverProxy.getBio();
+// bio.value → "Frank is 45 years old"
+```
+
+The server proxy is usable immediately—calls queue until authentication completes. If auth fails, queued calls fail too.
+
+#### Model Streaming
+
+```ts
+const person = api.streamPerson('Alice');
+// person.value is a reactive proxy that auto-updates
+```
+
+#### Socket Callbacks
+
+```ts
+api.streamNumbers(num => console.log(num));
+```
+
+On the server-side we should have a `export function streamNumbers(socket: Socket<number>)`.
+
+#### Reactive Integration with Aberdeen
+
+`PromiseProxy` results are reactive in Aberdeen scopes:
+
+```ts
+import A from 'aberdeen';
+
+const sum = api.add(1, 2);
+A(() => {
+    if (sum.busy) A('span#Loading...');
+    else if (sum.error) A('span#Error: ' + sum.error.message);
+    else A('span#Result: ' + sum.value);
+});
+```
+
+Model streams are also reactive—nested data updates trigger fine-grained UI updates:
+
+```ts
+const model = api.streamModel();
+A(() => {
+    if (!model.value) return;
+    A('h2#' + model.value.name);
+    A('p#Owner: ' + model.value.owner.name);
+});
+```
+
+#### Connection Status
+
+```ts
+A(() => {
+    A('span#' + (conn.isOnline() ? 'Connected' : 'Offline'));
+});
+```
+
+Reconnection is automatic with exponential backoff.
+
+#### Cleanup
+
+Aberdeen's `clean()` handles RPC lifecycle. When a reactive scope is destroyed, active requests and subscriptions are cancelled automatically.
+
+### Logging
+
+Set the `LOWLANDER_LOG_LEVEL` environment variable to a number from 0 to 3:
 
 - 0: no logging (default)
 - 1: connections & lifecycle
 - 2: RPC calls & responses
 - 3: model streaming & internals
 
-You can set a similar `EDINBURGH_LOG_LEVEL` variable to enable logging from the underlying Edinburgh library, which Lowlander uses for data management and synchronization.
+Set `EDINBURGH_LOG_LEVEL` similarly for Edinburgh internals.
 
 ## Server API Reference
 
@@ -59,6 +304,26 @@ Supports nested linked models and type-safe field selection.
 **Examples:**
 
 ```ts
+⁣@E.registerModel
+class Person extends Model {
+  name = field(string);
+  age = field(number);
+  password = field(string);
+  friends = field(array(link(Person)));
+}
+
+// Exclude password, include friends' names
+const PersonStream = createStreamType(Person, {
+  name: true,
+  age: true,
+  friends: { name: true }
+});
+
+export function streamPerson() {
+  const person = Person.byName.get('Alice')!;
+  return new PersonStream(person);
+}
+```
 
 ### sendModel · [function](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L262)
 
@@ -90,7 +355,7 @@ Subscribes `target` to this model, and sends initial data.
 - `SubStreamType: typeof StreamTypeBase<any>`
 - `delta: number`
 
-### start · [function](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L427)
+### start · [function](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L428)
 
 Starts the Lowlander WebSocket server.
 
@@ -140,9 +405,6 @@ start(API_FILE, { bind: '0.0.0.0:8080' });
 
 **Signature:** `() => string`
 
-**Parameters:**
-
-
 ### ServerProxy · [class](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L349)
 
 Wraps a server-side API object to create a stateful, type-safe proxy accessible from clients.
@@ -178,9 +440,6 @@ export async function authenticate(token: string) {
 
 **Signature:** `() => string`
 
-**Parameters:**
-
-
 ### Socket · [class](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L379)
 
 Server-side socket for pushing data to a client. Server functions with `Socket<T>` parameters
@@ -229,27 +488,25 @@ Sends data to the client.
 
 **Signature:** `() => string`
 
-**Parameters:**
-
-
 #### socket.[Symbol.for('nodejs.util.inspect.custom')] · [method](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L405)
 
 **Signature:** `() => string`
 
-**Parameters:**
-
-
 ## Client API Reference
 
 The following is auto-generated from `client/client.ts`:
 
-### logLevel · [variable](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L8)
+### setLogLevel · [function](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L10)
 
-Set to 1-3 for increasing verbosity.
+Set to 0-3 for increasing verbosity.
 
-**Value:** `number`
+**Signature:** `(level: number) => void`
+
+**Parameters:**
+
+- `level: number`
 
-### ClientProxyObject · [type](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L157)
+### ClientProxyObject · [type](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L161)
 
 Transforms server-side API objects to client-side proxy objects with type-safe RPC methods.
 
@@ -257,7 +514,7 @@ Transforms server-side API objects to client-side proxy objects with type-safe R
     [K in keyof T]: ClientProxyFunction<T[K]>
 }`
 
-### Connection · [class](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L190)
+### Connection · [class](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L194)
 
 WebSocket connection to a Lowlander server with type-safe RPC, automatic reconnection,
 and reactive updates.
@@ -293,27 +550,27 @@ $(() => {
 
 - `url`: - WebSocket URL (e.g., 'ws://localhost:8080/'), or a fake WebSocket object for testing
 
-#### connection.ws · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L192)
+#### connection.ws · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L196)
 
 **Type:** `WebSocket`
 
-#### connection.activeRequests · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L193)
+#### connection.activeRequests · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L197)
 
 **Type:** `Map<number, ActiveRequest>`
 
-#### connection.requestCounter · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L194)
+#### connection.requestCounter · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L198)
 
 **Type:** `number`
 
-#### connection.reconnectAttempts · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L195)
+#### connection.reconnectAttempts · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L199)
 
 **Type:** `number`
 
-#### connection.onlineProxy · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L198)
+#### connection.onlineProxy · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L202)
 
 **Type:** `ValueRef<boolean>`
 
-#### connection.api · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L205)
+#### connection.api · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L209)
 
 Type-safe proxy to the server-side API. Methods return `PromiseProxy` objects
 that work reactively in Aberdeen scopes. `ServerProxy` returns include a
@@ -321,30 +578,21 @@ that work reactively in Aberdeen scopes. `ServerProxy` returns include a
 
 **Type:** `ClientProxyObject<T>`
 
-#### connection.isOnline · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L218)
+#### connection.isOnline · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L222)
 
 Returns the current connection status. Reactive in Aberdeen scopes.
 
 **Signature:** `() => boolean`
 
-**Parameters:**
-
-
-#### connection.connect · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L220)
+#### connection.connect · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L224)
 
 **Signature:** `() => void`
 
-**Parameters:**
-
-
-#### connection.reconnect · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L374)
+#### connection.reconnect · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L378)
 
 **Signature:** `() => void`
 
-**Parameters:**
-
-
-#### connection.pruneCommitIds · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L388)
+#### connection.pruneCommitIds · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L392)
 
 **Signature:** `(request: ActiveRequest, maxCommitId: number) => void`
 

package/build/client/client.d.ts

@@ -0,0 +1,153 @@
+import type { Socket, ServerProxy, StreamTypeBase } from '../server/server.js';
+import type { PromiseProxy } from 'aberdeen';
+/** Set to 0-3 for increasing verbosity. */
+export declare function setLogLevel(level: number): void;
+/**
+ * Transforms server-side `Socket<T>` arguments to client-side callback functions `(data: T) => void`.
+ *
+ * @typeParam A - The server-side argument type
+ */
+type ClientProxyArg<A> = A extends Socket<infer U> ? (data: U) => void : A;
+/**
+ * Recursively transforms all server-side function arguments for client-side use.
+ *
+ * @typeParam Args - Tuple of server-side argument types
+ */
+type ClientProxyArgs<Args extends any[]> = Args extends [infer A, ...infer Rest] ? [ClientProxyArg<A>, ...ClientProxyArgs<Rest>] : [];
+/**
+ * Transforms server-side return types for client-side use.
+ *
+ * - Strips `Promise` wrappers
+ * - `ServerProxy<API, RETURN>` → `PromiseProxy<RETURN> & {serverProxy: ClientProxyObject<API>}`
+ * - Other types → `PromiseProxy<R>`
+ *
+ * @typeParam R - The server-side return type
+ */
+type ClientProxyReturn<R> = R extends Promise<infer U> ? ClientProxyReturn<U> : R extends ServerProxy<infer API, infer RETURN> ? PromiseProxy<RETURN> & {
+    promise: Promise<RETURN>;
+    serverProxy: ClientProxyObject<API>;
+} : R extends StreamTypeBase<infer T> ? PromiseProxy<T> & {
+    promise: Promise<T>;
+} : PromiseProxy<R> & {
+    promise: Promise<R>;
+};
+/**
+ * Transforms server-side function signatures for client-side proxy use.
+ * This type correctly handles function overloads by explicitly matching
+ * up to 8 signatures and creating an intersection of the transformed types.
+ *
+ * @typeParam T - The server-side function type, which may be overloaded.
+ */
+type ClientProxyFunction<T> = T extends {
+    (...args: infer A1): infer R1;
+    (...args: infer A2): infer R2;
+    (...args: infer A3): infer R3;
+    (...args: infer A4): infer R4;
+    (...args: infer A5): infer R5;
+    (...args: infer A6): infer R6;
+    (...args: infer A7): infer R7;
+    (...args: infer A8): infer R8;
+} ? ((...args: ClientProxyArgs<A1>) => ClientProxyReturn<R1>) & ((...args: ClientProxyArgs<A2>) => ClientProxyReturn<R2>) & ((...args: ClientProxyArgs<A3>) => ClientProxyReturn<R3>) & ((...args: ClientProxyArgs<A4>) => ClientProxyReturn<R4>) & ((...args: ClientProxyArgs<A5>) => ClientProxyReturn<R5>) & ((...args: ClientProxyArgs<A6>) => ClientProxyReturn<R6>) & ((...args: ClientProxyArgs<A7>) => ClientProxyReturn<R7>) & ((...args: ClientProxyArgs<A8>) => ClientProxyReturn<R8>) : T extends {
+    (...args: infer A1): infer R1;
+    (...args: infer A2): infer R2;
+    (...args: infer A3): infer R3;
+    (...args: infer A4): infer R4;
+    (...args: infer A5): infer R5;
+    (...args: infer A6): infer R6;
+    (...args: infer A7): infer R7;
+} ? ((...args: ClientProxyArgs<A1>) => ClientProxyReturn<R1>) & ((...args: ClientProxyArgs<A2>) => ClientProxyReturn<R2>) & ((...args: ClientProxyArgs<A3>) => ClientProxyReturn<R3>) & ((...args: ClientProxyArgs<A4>) => ClientProxyReturn<R4>) & ((...args: ClientProxyArgs<A5>) => ClientProxyReturn<R5>) & ((...args: ClientProxyArgs<A6>) => ClientProxyReturn<R6>) & ((...args: ClientProxyArgs<A7>) => ClientProxyReturn<R7>) : T extends {
+    (...args: infer A1): infer R1;
+    (...args: infer A2): infer R2;
+    (...args: infer A3): infer R3;
+    (...args: infer A4): infer R4;
+    (...args: infer A5): infer R5;
+    (...args: infer A6): infer R6;
+} ? ((...args: ClientProxyArgs<A1>) => ClientProxyReturn<R1>) & ((...args: ClientProxyArgs<A2>) => ClientProxyReturn<R2>) & ((...args: ClientProxyArgs<A3>) => ClientProxyReturn<R3>) & ((...args: ClientProxyArgs<A4>) => ClientProxyReturn<R4>) & ((...args: ClientProxyArgs<A5>) => ClientProxyReturn<R5>) & ((...args: ClientProxyArgs<A6>) => ClientProxyReturn<R6>) : T extends {
+    (...args: infer A1): infer R1;
+    (...args: infer A2): infer R2;
+    (...args: infer A3): infer R3;
+    (...args: infer A4): infer R4;
+    (...args: infer A5): infer R5;
+} ? ((...args: ClientProxyArgs<A1>) => ClientProxyReturn<R1>) & ((...args: ClientProxyArgs<A2>) => ClientProxyReturn<R2>) & ((...args: ClientProxyArgs<A3>) => ClientProxyReturn<R3>) & ((...args: ClientProxyArgs<A4>) => ClientProxyReturn<R4>) & ((...args: ClientProxyArgs<A5>) => ClientProxyReturn<R5>) : T extends {
+    (...args: infer A1): infer R1;
+    (...args: infer A2): infer R2;
+    (...args: infer A3): infer R3;
+    (...args: infer A4): infer R4;
+} ? ((...args: ClientProxyArgs<A1>) => ClientProxyReturn<R1>) & ((...args: ClientProxyArgs<A2>) => ClientProxyReturn<R2>) & ((...args: ClientProxyArgs<A3>) => ClientProxyReturn<R3>) & ((...args: ClientProxyArgs<A4>) => ClientProxyReturn<R4>) : T extends {
+    (...args: infer A1): infer R1;
+    (...args: infer A2): infer R2;
+    (...args: infer A3): infer R3;
+} ? ((...args: ClientProxyArgs<A1>) => ClientProxyReturn<R1>) & ((...args: ClientProxyArgs<A2>) => ClientProxyReturn<R2>) & ((...args: ClientProxyArgs<A3>) => ClientProxyReturn<R3>) : T extends {
+    (...args: infer A1): infer R1;
+    (...args: infer A2): infer R2;
+} ? ((...args: ClientProxyArgs<A1>) => ClientProxyReturn<R1>) & ((...args: ClientProxyArgs<A2>) => ClientProxyReturn<R2>) : T extends (...args: infer A) => infer R ? (...args: ClientProxyArgs<A>) => ClientProxyReturn<R> : never;
+/**
+ * Transforms server-side API objects to client-side proxy objects with type-safe RPC methods.
+ *
+ * @typeParam T - The server-side API object type
+ */
+export type ClientProxyObject<T> = {
+    [K in keyof T]: ClientProxyFunction<T[K]>;
+};
+/**
+ * WebSocket connection to a Lowlander server with type-safe RPC, automatic reconnection,
+ * and reactive updates.
+ *
+ * @typeParam T - The server-side API type (import from your server API file)
+ *
+ * @example
+ * ```ts
+ * import type * as API from './server/api.js';
+ * const conn = new Connection<typeof API>('ws://localhost:8080/');
+ *
+ * // Simple RPC - returns PromiseProxy
+ * const sum = conn.api.add(1, 2);
+ *
+ * // Server proxy for stateful APIs
+ * const auth = conn.api.authenticate('token');
+ * const secret = auth.serverProxy.getSecret();
+ *
+ * // Streaming with callbacks
+ * conn.api.streamData(data => console.log(data));
+ *
+ * // Use within Aberdeen reactive scopes
+ * $(() => {
+ *   dump(conn.isOnline());
+ *   dump(sum);
+ * });
+ * ```
+ */
+export declare class Connection<T> {
+    url: string | (() => WebSocket);
+    private ws?;
+    private activeRequests;
+    private requestCounter;
+    private reconnectAttempts;
+    /** @internal */
+    _proxyCounter: number;
+    private onlineProxy;
+    /**
+     * Type-safe proxy to the server-side API. Methods return `PromiseProxy` objects
+     * that work reactively in Aberdeen scopes. `ServerProxy` returns include a
+     * `.serverProxy` property for accessing stateful server APIs.
+     */
+    api: ClientProxyObject<T>;
+    /**
+     * @param url - WebSocket URL (e.g., 'ws://localhost:8080/'), or a fake WebSocket object for testing
+     */
+    constructor(url: string | (() => WebSocket));
+    /**
+     * Returns the current connection status. Reactive in Aberdeen scopes.
+     */
+    isOnline(): boolean;
+    private connect;
+    private reconnect;
+    private pruneCommitIds;
+    /** @internal */
+    _createMethodStub(methodName: string, proxyId?: number): (...params: any[]) => PromiseProxy<any> & {
+        promise: Promise<any>;
+    } & {
+        serverProxy: any;
+    };
+}
+export {};