lowlander 0.2.0 → 0.2.1

package/README.md

@@ -6,8 +6,8 @@ This project is still under heavy development. **DO NOT USE** for anything serio
 
 To get an impression of what use of this framework currently looks like, check out the example project's...
 
- - [server-side API](examples/helloworld/server/api.ts) and
- - [client-side UI](examples/helloworld/client/js/base.ts) code.
+ - [server-side API](https://github.com/vanviegen/lowlander/blob/main/examples/helloworld/server/api.ts) and
+ - [client-side UI](https://github.com/vanviegen/lowlander/blob/main/examples/helloworld/client/js/base.ts) code.
 
 ## Tech
 
@@ -35,7 +35,7 @@ You can set a similar `EDINBURGH_LOG_LEVEL` variable to enable logging from the
 
 The following is auto-generated from `server/server.ts`:
 
-### createStreamType · [function](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L162)
+### createStreamType · [function](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L162)
 
 Creates a stream type for reactive model streaming to clients with automatic updates.
 
@@ -60,7 +60,7 @@ Supports nested linked models and type-safe field selection.
 
 ```ts
 
-### sendModel · [function](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L262)
+### sendModel · [function](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L262)
 
 Sends (updated) data for `model` to `target`.
 `target` is a virtual socket with a requestId+'d' user prefix, or a channel that subscribes such virtual sockets.
@@ -75,7 +75,7 @@ Sends (updated) data for `model` to `target`.
 - `StreamType: typeof StreamTypeBase<any>`
 - `changed?: E.Change`
 
-### pushModel · [function](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L318)
+### pushModel · [function](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L318)
 
 Subscribes `target` to this model, and sends initial data.
 `target` is a virtual socket with a requestId+'d' user prefix, or a channel that subscribes such virtual sockets.
@@ -90,7 +90,7 @@ Subscribes `target` to this model, and sends initial data.
 - `SubStreamType: typeof StreamTypeBase<any>`
 - `delta: number`
 
-### start · [function](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L427)
+### start · [function](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L427)
 
 Starts the Lowlander WebSocket server.
 
@@ -112,15 +112,15 @@ const API_FILE = resolve(dirname(fileURLToPath(import.meta.url)), 'api.js');
 start(API_FILE, { bind: '0.0.0.0:8080' });
 ```
 
-### logLevel · [constant](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L10)
+### logLevel · [constant](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L10)
 
 **Value:** `number`
 
-### warpsocket · [class](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L13)
+### warpsocket · [class](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L13)
 
 **Type:** `typeof import("/var/home/frank/projects/warpsocket/dist/src/index", { with: { "resolution-mode": "import" } })`
 
-### StreamTypeBase · [abstract class](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L34)
+### StreamTypeBase · [abstract class](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L34)
 
 [object Object],[object Object],[object Object]
 
@@ -128,22 +128,22 @@ start(API_FILE, { bind: '0.0.0.0:8080' });
 
 - `T`
 
-#### StreamTypeBase.fields · [static property](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L36)
+#### StreamTypeBase.fields · [static property](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L36)
 
 **Type:** `{ [key: string]: number | true; }`
 
-#### StreamTypeBase.id · [static property](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L38)
+#### StreamTypeBase.id · [static property](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L38)
 
 **Type:** `number`
 
-#### streamTypeBase.toString · [method](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L42)
+#### streamTypeBase.toString · [method](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L42)
 
 **Signature:** `() => string`
 
 **Parameters:**
 
 
-### ServerProxy · [class](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L349)
+### 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.
 Use for authentication, sessions, or any stateful context that persists across RPC calls.
@@ -174,14 +174,14 @@ export async function authenticate(token: string) {
 - `api`: - Server-side API object exposed to the client
 - `value`: - Value returned immediately to the client
 
-#### serverProxy.toString · [method](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L355)
+#### serverProxy.toString · [method](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L355)
 
 **Signature:** `() => string`
 
 **Parameters:**
 
 
-### Socket · [class](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L379)
+### 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
 receive client callbacks on the client side.
@@ -204,7 +204,7 @@ export function streamNumbers(socket: Socket<number>) {
 api.streamNumbers(num => console.log(num));
 ```
 
-#### socket.send · [method](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L388)
+#### socket.send · [method](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L388)
 
 Sends data to the client.
 
@@ -216,7 +216,7 @@ Sends data to the client.
 
 **Returns:** `true` if sent, `false` if socket is closed
 
-#### socket.subscribe · [method](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L394)
+#### socket.subscribe · [method](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L394)
 
 **Signature:** `(channel: Uint8Array<ArrayBufferLike>, delta?: number) => void`
 
@@ -225,14 +225,14 @@ Sends data to the client.
 - `channel: Uint8Array`
 - `delta: any` (optional)
 
-#### socket.toString · [method](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L401)
+#### socket.toString · [method](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L401)
 
 **Signature:** `() => string`
 
 **Parameters:**
 
 
-#### socket.[Symbol.for('nodejs.util.inspect.custom')] · [method](https://github.com/vanviegen/edinburgh/blob/main/server/server.ts#L405)
+#### socket.[Symbol.for('nodejs.util.inspect.custom')] · [method](https://github.com/vanviegen/lowlander/blob/main/server/server.ts#L405)
 
 **Signature:** `() => string`
 
@@ -243,13 +243,13 @@ Sends data to the client.
 
 The following is auto-generated from `client/client.ts`:
 
-### logLevel · [variable](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L8)
+### logLevel · [variable](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L8)
 
 Set to 1-3 for increasing verbosity.
 
 **Value:** `number`
 
-### ClientProxyObject · [type](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L157)
+### ClientProxyObject · [type](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L157)
 
 Transforms server-side API objects to client-side proxy objects with type-safe RPC methods.
 
@@ -257,7 +257,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/edinburgh/blob/main/client/client.ts#L190)
+### Connection · [class](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L190)
 
 WebSocket connection to a Lowlander server with type-safe RPC, automatic reconnection,
 and reactive updates.
@@ -293,27 +293,27 @@ $(() => {
 
 - `url`: - WebSocket URL (e.g., 'ws://localhost:8080/'), or a fake WebSocket object for testing
 
-#### connection.ws · [property](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L192)
+#### connection.ws · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L192)
 
 **Type:** `WebSocket`
 
-#### connection.activeRequests · [property](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L193)
+#### connection.activeRequests · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L193)
 
 **Type:** `Map<number, ActiveRequest>`
 
-#### connection.requestCounter · [property](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L194)
+#### connection.requestCounter · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L194)
 
 **Type:** `number`
 
-#### connection.reconnectAttempts · [property](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L195)
+#### connection.reconnectAttempts · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L195)
 
 **Type:** `number`
 
-#### connection.onlineProxy · [property](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L198)
+#### connection.onlineProxy · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L198)
 
 **Type:** `ValueRef<boolean>`
 
-#### connection.api · [property](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L205)
+#### connection.api · [property](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L205)
 
 Type-safe proxy to the server-side API. Methods return `PromiseProxy` objects
 that work reactively in Aberdeen scopes. `ServerProxy` returns include a
@@ -321,7 +321,7 @@ that work reactively in Aberdeen scopes. `ServerProxy` returns include a
 
 **Type:** `ClientProxyObject<T>`
 
-#### connection.isOnline · [method](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L218)
+#### connection.isOnline · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L218)
 
 Returns the current connection status. Reactive in Aberdeen scopes.
 
@@ -330,21 +330,21 @@ Returns the current connection status. Reactive in Aberdeen scopes.
 **Parameters:**
 
 
-#### connection.connect · [method](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L220)
+#### connection.connect · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L220)
 
 **Signature:** `() => void`
 
 **Parameters:**
 
 
-#### connection.reconnect · [method](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L374)
+#### connection.reconnect · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L374)
 
 **Signature:** `() => void`
 
 **Parameters:**
 
 
-#### connection.pruneCommitIds · [method](https://github.com/vanviegen/edinburgh/blob/main/client/client.ts#L388)
+#### connection.pruneCommitIds · [method](https://github.com/vanviegen/lowlander/blob/main/client/client.ts#L388)
 
 **Signature:** `(request: ActiveRequest, maxCommitId: number) => void`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lowlander",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript framework for data persistence, type-safe RPCs and real-time (partial) client synchronization.",
   "type": "module",
   "main": "./build/server/server.js",
@@ -27,7 +27,8 @@
     "build": "tsc -b && cp -rf examples/helloworld/client/assets examples/helloworld/client/index.html build/examples/helloworld/client/ && npm run build:readme",
     "typecheck": "bun x tsc -b",
     "clean": "rm -rf build dist",
-    "build:readme": "readme-tsdoc --repo-url https://github.com/vanviegen/edinburgh",
+    "prepack": "bun install && bun run build",
+    "build:readme": "readme-tsdoc --repo-url https://github.com/vanviegen/lowlander",
     "test": "bun test"
   },
   "dependencies": {