sendscript 2.4.0 → 2.4.2

package/CHANGELOG.md

@@ -4,8 +4,24 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v2.4.2](https://github.com/bas080/sendscript/compare/v2.4.1...v2.4.2)
+
+- Update tap and typedoc [`46421de`](https://github.com/bas080/sendscript/commit/46421de16533066ee13c91ea75505b1ecdd548f0)
+- Remove the unused curry helper [`9dcbb48`](https://github.com/bas080/sendscript/commit/9dcbb485b455937070c65359ecde8236c128bee8)
+- Remove duplicate Promises section with outdated async/await information [`5f43ddb`](https://github.com/bas080/sendscript/commit/5f43ddb91ddb2d77227ddd6a570807f874230ea1)
+
+#### [v2.4.1](https://github.com/bas080/sendscript/compare/v2.4.0...v2.4.1)
+
+> 29 June 2026
+
+- Update tap and typedoc version [`3f10410`](https://github.com/bas080/sendscript/commit/3f1041020e00331ff30ffb5f972738dbaf7a50f3)
+- Update tap to 21.7.1 [`d1b5bbd`](https://github.com/bas080/sendscript/commit/d1b5bbd4cb7012e6606973d3d23d08df56cadca2)
+- Document limitations of sendscript [`f577499`](https://github.com/bas080/sendscript/commit/f577499279b85e04ea589a3bcb1866d145216f00)
+
 #### [v2.4.0](https://github.com/bas080/sendscript/compare/v2.3.9...v2.4.0)
 
+> 16 April 2026
+
 - Update tap to 4.5.4 [`5249a85`](https://github.com/bas080/sendscript/commit/5249a85a08b10485f0d64058fd2c8bcaae84edda)
 - Add fn and args support [`6110654`](https://github.com/bas080/sendscript/commit/6110654fa039d17cd9ba0e15f749756b615b5d09)
 - Move transport agnostic section to socket example [`3a92257`](https://github.com/bas080/sendscript/commit/3a9225787df16a0fd83293bfa14d91b74a46d070)

package/CONTRIBUTING.md

@@ -1,5 +1,17 @@
 # Contributing
 
+The pre-push git hook.
+
+```bash cat - > .git/hooks/pre-push
+#!/usr/bin/env bash
+
+set -xeuo pipefail
+
+npm t
+npx standard
+npx prettier -c --parser markdown *.mz
+```
+
 For the README.mz examples to work we need sendscript to be linked.
 
 ```bash bash > /dev/null
@@ -40,8 +52,6 @@ Generate the README from the mz file.
 ```bash bash
 markatzea ./README.mz | tee ./README.md
 
-npx documentation readme schema.mjs references.mjs stringify.mjs parse.mjs -s Reference --github --a public --markdown-toc false
-
 npx markdown-toc --maxdepth 3 -i README.md
 
 git add *.md ./example

package/README.md

@@ -1,31 +1,37 @@
 # SendScript
 
-Write JS code that you can run on servers, browsers or other clients.
+Serialize and execute composable JavaScript function calls with JSON.
 
-[![NPM](https://img.shields.io/npm/v/sendscript?color=blue\&style=flat-square)](https://www.npmjs.com/package/sendscript)
+[![NPM](https://img.shields.io/npm/v/sendscript?color=blue&style=flat-square)](https://www.npmjs.com/package/sendscript)
 [![100% Code Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?style=flat-square)](#tests)
 [![Standard Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com)
-[![License](https://img.shields.io/npm/l/sendscript?color=brightgreen\&style=flat-square)](./LICENSE.txt)
+[![License](https://img.shields.io/npm/l/sendscript?color=brightgreen&style=flat-square)](./LICENSE.txt)
+
+## Features
+
+- **Composable function calls** - Combine multiple functions into a single
+  request
+- **Write ordinary JavaScript** - Programs serialize to JSON and execute as
+  written
+- **Type-safe** - Works great with TypeScript for client-side type checking
+- **Zero dependencies** - Lightweight core library
+- **Async/await support** - Seamless async operations within a single payload
+- **Custom serializers** - Support for Date, Map, Set, BigInt, and more
+- **Transport agnostic** - Use HTTP, WebSockets, or any other communication
+  method
 
 <!-- toc -->
 
+- [Installation](#installation)
+- [Quick Start](#quick-start)
 - [Introduction](#introduction)
-- [Reference](#reference)
-  * [defaultLeafParse](#defaultleafparse)
-  * [Parse](#parse)
-  * [parse](#parse)
-  * [References](#references)
-  * [SchemaNode](#schemanode)
-  * [Schema](#schema)
-  * [defaultLeafStringify](#defaultleafstringify)
-  * [Stringify](#stringify)
-  * [stringify](#stringify)
+- [Why SendScript?](#why-sendscript)
+- [How It Works](#how-it-works)
 - [Socket example](#socket-example)
   * [Module](#module)
   * [Server](#server)
   * [Client](#client)
 - [Repl](#repl)
-- [Functions](#functions)
 - [Promises](#promises)
   * [.then / .catch](#then--catch)
   * [await](#await)
@@ -36,23 +42,75 @@ Write JS code that you can run on servers, browsers or other clients.
   * [Validating structured input](#validating-structured-input)
 - [Leaf Serializer](#leaf-serializer)
   * [Example with superjson](#example-with-superjson)
+- [Limitations](#limitations)
+  * [Chaining APIs](#chaining-apis)
+  * [Callbacks](#callbacks)
+  * [Error handling](#error-handling)
+- [Tests](#tests)
+- [Formatting](#formatting)
 - [Changelog](#changelog)
 - [License](#license)
 - [Issues](#issues)
 
 <!-- tocstop -->
 
+## Installation
+
+Install SendScript from npm:
+
+```bash
+npm install sendscript
+```
+
+## Quick Start
+
+Here's the simplest example to get started with SendScript:
+
+```js
+import Stringify from 'sendscript/stringify.mjs'
+import Parse from 'sendscript/parse.mjs'
+import references from 'sendscript/references.mjs'
+
+// Define your functions
+const functions = {
+  greet: (name) => `Hello, ${name}!`,
+}
+
+// Create client-side stubs
+const { greet } = references(['greet'])
+
+// Serialize a program on the client
+const stringify = Stringify()
+const program = stringify(greet('World'))
+
+// Parse and execute on the server
+const parse = Parse(['greet'], functions)
+const result = parse(program) // "Hello, World!"
+```
+
+This demonstrates the core concept: write a program on the client, serialize it
+to JSON, send it to the server, and execute it exactly as written.
+
 ## Introduction
 
 There has been interest in improving APIs by allowing aggregations in a single
 request. Examples include
 
-*   [JSON-RPC](https://json-rpc.dev/) which allows you to do multiple requests but
-    it does not allow you to compose the return value of one endpoint to be the
-    input/arguments of another.
+- [JSON-RPC](https://json-rpc.dev/) which allows you to do multiple requests but
+  it does not allow you to compose the return value of one endpoint to be the
+  input/arguments of another.
+
+- [GraphQL](https://graphql.org/) is very cool but also introduces a new
+  language and the tooling that is required to wield it.
+
+## Why SendScript?
+
+Unlike JSON-RPC (which doesn't support function composition) or GraphQL (which
+requires learning a new language), SendScript lets you write ordinary
+JavaScript/TypeScript that gets serialized and executed on the server exactly as
+written.
 
-*   [GraphQL](https://graphql.org/) is very cool but also introduces a new
-    languages and the tooling that is required to wield it.
+## How It Works
 
 What SendScript attempts is to allow for very expressive queries and mutations
 to be performed that read and write like ordinary JS. That means that the
@@ -73,7 +131,6 @@ const stringify = Stringify()
 
 console.log(stringify(add(1,2)))
 ```
-
 ```json
 ["call",["ref","add"],[["leaf","1"],["leaf","2"]]]
 ```
@@ -95,7 +152,6 @@ const program = '["call",["ref","add"],[1,2]]'
 
 console.log(parse(program))
 ```
-
 ```json
 3
 ```
@@ -105,131 +161,18 @@ composition and even await.
 
 This package is nothing more than the absolute core of sendscript. It includes:
 
-*   The `references` function to create stubs to write the programs.
-*   `stringify` which takes the program and returns a JSON string.
-*   `parse` which takes the `stringify` JSON string and a real module and returns
-    the result.
-
-The naming could use more love and there are many things to solve either in the
-core or around it. Things like supporting more complex (de)serializers, errors
-and maybe mixing client functions with sendscript programs. Contact me if I have
-piqued your interest.
-
-## Reference
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### defaultLeafParse
-
-[parse.mjs:49-49](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/parse.mjs#L49-L49 "Source code on GitHub")
-
-Default deserializer for leaf nodes.
-
-#### Parameters
-
-*   `text` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-
-Returns **any**&#x20;
-
-### Parse
-
-[parse.mjs:68-215](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/parse.mjs#L68-L215 "Source code on GitHub")
-
-#### Parameters
-
-*   `schema` **[Schema](#schema)**&#x20;
-*   `env` **Env** runtime environment for refs
-*   `leafParse`   (optional, default `defaultLeafParse`)
-
-Returns **[parse](#parse)**&#x20;
-
-### parse
-
-[parse.mjs:78-214](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/parse.mjs#L78-L214 "Source code on GitHub")
-
-Parses and executes a serialized program.
-
-#### Parameters
-
-*   `program` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** JSON encoded program
-
-Returns **(any | [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>)**&#x20;
-
-### References
-
-[references.mjs:109-127](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/references.mjs#L109-L127 "Source code on GitHub")
-
-Builds a nested API structure from a schema definition.
-
-#### Parameters
-
-*   `schema` **[Schema](#schema)**&#x20;
-*   `parentPath`   (optional, default `[]`)
-
-<!---->
-
-*   Throws **[Error](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** If schema format is invalid
-
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Nested instrumented API object
-
-### SchemaNode
-
-[schema.mjs:1-19](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/schema.mjs#L1-L6 "Source code on GitHub")
-
-A single schema node.
-
-Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | \[[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Schema](#schema)])
-
-### Schema
-
-[schema.mjs:1-19](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/schema.mjs#L8-L18 "Source code on GitHub")
-
-A schema defines the structure of the runtime API tree.
-
-*   string → leaf node
-*   \[name, children] → namespace node
-
-Schema is recursive: nodes can contain nested schemas.
-
-Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[SchemaNode](#schemanode)>
-
-### defaultLeafStringify
+- The `references` function to create stubs to write the programs.
+- `stringify` which takes the program and returns a JSON string.
+- `parse` which takes the `stringify` JSON string and a real module and returns
+  the result.
 
-[stringify.mjs:37-47](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/stringify.mjs#L37-L47 "Source code on GitHub")
+> **Note:** SendScript works in Node.js and browsers. The core library is
+> framework-agnostic and transport-agnostic — use HTTP, WebSockets, or any other
+> communication method that suits your needs.
 
-Default strict serializer for leaf values.
-
-Rejects non-JSON-safe values.
-
-#### Parameters
-
-*   `x` **any**&#x20;
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-
-### Stringify
-
-[stringify.mjs:56-157](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/stringify.mjs#L56-L157 "Source code on GitHub")
-
-Creates a stringify function for SendScript AST structures.
-
-#### Parameters
-
-*   `leafStringify`   (optional, default `defaultLeafStringify`)
-
-Returns **[stringify](#stringify)**&#x20;
-
-### stringify
-
-[stringify.mjs:64-156](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/stringify.mjs#L64-L156 "Source code on GitHub")
-
-Serializes a program into a JSON string representation.
-
-#### Parameters
-
-*   `program` **any**&#x20;
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+Future enhancements may include support for more complex (de)serializers,
+improved error handling, and deeper integration of client functions with
+SendScript programs. Contributions and feedback are welcome.
 
 ## Socket example
 
@@ -251,7 +194,7 @@ export const square = (a) => a * a
 
 ### Server
 
-Here a socket.io server that runs SendScript programs.
+Here's a socket.io server that runs SendScript programs.
 
 ```js
 // ./example/server.socket.io.mjs
@@ -331,40 +274,23 @@ node ./example/client.socket.io.mjs
 
 pkill sendscript
 ```
-
-    Result:  100
+```
+Result:  100
+```
 
 ## Repl
 
-Sendscript ships with a barebones (no-dependencies) node-repl script. One can
+Sendscript ships with a bare-bones (no-dependencies) node-repl script. One can
 run it by simply typing `sendscript` in their console.
 
-> Use the `DEBUG='*'` to enable all logs or `DEBUG='sendscript:*'` for
-> printingonly sendscript logs.
-
-## Functions
-
-SendScript as of `v2.4` supports functions to do basic templating. It does not
-support async functions and will throw an error when you define one.
-
-Under the hood the function is called when it is being parsed. Make sure you
-understand what you are doing when mixing client and server functions.
-
-```js
-map((a) => add(a, 1))([1, 2, 3]))
-```
-
-It also supports nested functions.
-
-```js
-map(call)(map((a) => () => add(a, 1))([1, 2, 3]))
-```
+> Use the `DEBUG='*'` to enable all logs or `DEBUG='sendscript:*'` for printing
+> only sendscript logs.
 
 ## Promises
 
 ### .then / .catch
 
-Supported since vs `v2.3`.
+Supported since `v2.3`.
 
 ```js
 const getOrCreatePost = send(createPost(title).catch(createPost(title)))
@@ -402,19 +328,18 @@ defined properties and returned values.
 
 There is a good use-case to write a module in TypeScript.
 
-1.  Obviously the module would have the benefits that TypeScript offers when
-    coding.
-2.  You can use tools like [typedoc][typedoc] to generate docs from your types to
-    share with consumers of your API.
-3.  You can use the types of the module to coerce your client to adopt the
-    module's type.
+1. Obviously the module would have the benefits that TypeScript offers when
+   coding.
+2. You can use tools like [typedoc][typedoc] to generate docs from your types to
+   share with consumers of your API.
+3. You can use the types of the module to coerce your client to adopt the
+   module's type.
 
 Let's say we have this module which we use on the server.
 
 ```bash
 cat ./example/typescript/math.ts
 ```
-
 ```ts
 export const add = (a: number, b: number) => a + b
 export const square = (a: number) => a * a
@@ -425,7 +350,6 @@ We can then coerce the types of the instrumented stubs.
 ```bash
 cat ./example/typescript/client.ts
 ```
-
 ```ts
 import math  from './math.client.ts'
 import Stringify from 'sendscript/stringify.mjs'
@@ -451,7 +375,7 @@ npx typedoc --plugin typedoc-plugin-markdown --out ./example/typescript/docs ./e
 
 You can see the docs [here](./example/typescript/docs/globals.md)
 
-> \[!NOTE] Although type coercion on the client side can improve the development
+> [!NOTE] Although type coercion on the client side can improve the development
 > experience, it does not represent the actual type. Values are subject to
 > serialization and deserialization.
 
@@ -518,9 +442,9 @@ export function createUser(user) {
 
 **Benefits**:
 
-*   Ensures arguments match expected types and shapes.
-*   Throws structured errors that can be propagated to clients.
-*   Works with TypeScript for automatic type inference.
+- Ensures arguments match expected types and shapes.
+- Throws structured errors that can be propagated to clients.
+- Works with TypeScript for automatic type inference.
 
 ## Leaf Serializer
 
@@ -584,7 +508,7 @@ const env = {
 }
 
 // Parse with custom leaf deserializer
-const parse = Parse(schema, env, leadDeserializer)
+const parse = Parse(schema, env, leafDeserializer)
 
 const result = parse(json)
 ```
@@ -592,6 +516,84 @@ const result = parse(json)
 The leaf wrapper format is `['leaf', serializedPayload]`, making it unambiguous
 and safe from colliding with SendScript operators.
 
+## Limitations
+
+The stubs the `references` function returns are limited in the way they can be
+used. This has to do with the fact that they are to be serialized.
+
+### Chaining APIs
+
+Currently you cannot do chaining APIs. `lib().doThis().doThat()`. It likely is
+possible to implement but will require more extensive schemas and obviously more
+code to create the AST.
+
+### Callbacks
+
+Although it is possible to mix client and server functions, it works very
+different to ordinary functions. Client functions can be used but should be seen
+as a templating tool to make sendscript programs; just like one would use
+JavaScript with react templates. `items.map(deleteItem)` would return an array
+of sendscript function calls which can be given to sendscript's parse.
+
+Client functions cannot be called by sendscript functions (as of yet) since we
+cannot serialize client functions. No work has been done to have the server send
+back intermediate values to perform client function calls or by performing
+smaller sendscript program payloads that are passed to the client. Very
+interesting stuff to look into. You can achieve this now but it looks less clean
+because you have to do `send` calls which is a bit manual.
+
+```js
+await send(updateUser(id, merge(await send(getUser(id)), { ...newValues })))
+```
+
+It might be interesting to allow configuration to create references that will
+trigger a send whenever await is called. That would remove the ability to create
+a single payload whenever using await. You can then write the above in the
+following manner.
+
+```js
+await updateUser(id, merge(await getUser(id), { ...newValues }))
+```
+
+Possible footgun is that updateUser is only performed when awaited (.then is
+called). This lazy behavior can trip users. This footgun could be resolved by
+checking if any outstanding work exists at the end of a step or the beginning of
+a new step.
+
+### Error handling
+
+Sendscript does not have builtin tools to handle errors. You can write your own
+utilities for that or use things like [Ramda's tryCatch][tryCatch]. This will
+likely never be supported as JS try catch does not have a return value. It might
+make sense to wrap everything that can throw in promises which is easy to do
+with async functions.
+
+## Tests
+
+Tests with 100% code coverage.
+
+```bash
+npm t -- -R silent
+npm t -- report text-summary
+```
+```
+
+=============================== Coverage summary ===============================
+Statements   : 100% ( 512/512 )
+Branches     : 100% ( 147/147 )
+Functions    : 100% ( 23/23 )
+Lines        : 100% ( 512/512 )
+================================================================================
+```
+
+## Formatting
+
+Standard because no config.
+
+```bash
+npx standard
+```
+
 ## Changelog
 
 The [changelog][changelog] is generated using the useful
@@ -610,13 +612,8 @@ See the [LICENSE.txt][license] file for details.
 See [issues][issues] for roadmap and known bugs.
 
 [license]: ./LICENSE.txt
-
 [socket.io]: https://socket.io/
-
 [changelog]: ./CHANGELOG.md
-
 [auto-changelog]: https://www.npmjs.com/package/auto-changelog
-
 [typedoc]: https://github.com/TypeStrong/typedoc
-
 [issues]: https://github.com/bas080/sendscript/issues

package/README.mz

@@ -1,14 +1,64 @@
 # SendScript
 
-Write JS code that you can run on servers, browsers or other clients.
+Serialize and execute composable JavaScript function calls with JSON.
 
 [![NPM](https://img.shields.io/npm/v/sendscript?color=blue&style=flat-square)](https://www.npmjs.com/package/sendscript)
 [![100% Code Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?style=flat-square)](#tests)
 [![Standard Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com)
 [![License](https://img.shields.io/npm/l/sendscript?color=brightgreen&style=flat-square)](./LICENSE.txt)
 
+## Features
+
+- **Composable function calls** - Combine multiple functions into a single
+  request
+- **Write ordinary JavaScript** - Programs serialize to JSON and execute as
+  written
+- **Type-safe** - Works great with TypeScript for client-side type checking
+- **Zero dependencies** - Lightweight core library
+- **Async/await support** - Seamless async operations within a single payload
+- **Custom serializers** - Support for Date, Map, Set, BigInt, and more
+- **Transport agnostic** - Use HTTP, WebSockets, or any other communication
+  method
+
 <!-- toc -->
 
+## Installation
+
+Install SendScript from npm:
+
+```bash
+npm install sendscript
+```
+
+## Quick Start
+
+Here's the simplest example to get started with SendScript:
+
+```js
+import Stringify from 'sendscript/stringify.mjs'
+import Parse from 'sendscript/parse.mjs'
+import references from 'sendscript/references.mjs'
+
+// Define your functions
+const functions = {
+  greet: (name) => `Hello, ${name}!`,
+}
+
+// Create client-side stubs
+const { greet } = references(['greet'])
+
+// Serialize a program on the client
+const stringify = Stringify()
+const program = stringify(greet('World'))
+
+// Parse and execute on the server
+const parse = Parse(['greet'], functions)
+const result = parse(program) // "Hello, World!"
+```
+
+This demonstrates the core concept: write a program on the client, serialize it
+to JSON, send it to the server, and execute it exactly as written.
+
 ## Introduction
 
 There has been interest in improving APIs by allowing aggregations in a single
@@ -19,7 +69,16 @@ request. Examples include
   input/arguments of another.
 
 - [GraphQL](https://graphql.org/) is very cool but also introduces a new
-  languages and the tooling that is required to wield it.
+  language and the tooling that is required to wield it.
+
+## Why SendScript?
+
+Unlike JSON-RPC (which doesn't support function composition) or GraphQL (which
+requires learning a new language), SendScript lets you write ordinary
+JavaScript/TypeScript that gets serialized and executed on the server exactly as
+written.
+
+## How It Works
 
 What SendScript attempts is to allow for very expressive queries and mutations
 to be performed that read and write like ordinary JS. That means that the
@@ -69,14 +128,13 @@ This package is nothing more than the absolute core of sendscript. It includes:
 - `parse` which takes the `stringify` JSON string and a real module and returns
   the result.
 
-The naming could use more love and there are many things to solve either in the
-core or around it. Things like supporting more complex (de)serializers, errors
-and maybe mixing client functions with sendscript programs. Contact me if I have
-piqued your interest.
+> **Note:** SendScript works in Node.js and browsers. The core library is
+> framework-agnostic and transport-agnostic — use HTTP, WebSockets, or any other
+> communication method that suits your needs.
 
-## Reference
-
-<!-- Reference -->
+Future enhancements may include support for more complex (de)serializers,
+improved error handling, and deeper integration of client functions with
+SendScript programs. Contributions and feedback are welcome.
 
 ## Socket example
 
@@ -98,7 +156,7 @@ export const square = (a) => a * a
 
 ### Server
 
-Here a socket.io server that runs SendScript programs.
+Here's a socket.io server that runs SendScript programs.
 
 ```js cat - > ./example/server.socket.io.mjs
 // ./example/server.socket.io.mjs
@@ -181,35 +239,17 @@ pkill sendscript
 
 ## Repl
 
-Sendscript ships with a barebones (no-dependencies) node-repl script. One can
+Sendscript ships with a bare-bones (no-dependencies) node-repl script. One can
 run it by simply typing `sendscript` in their console.
 
-> Use the `DEBUG='*'` to enable all logs or `DEBUG='sendscript:*'` for
-> printingonly sendscript logs.
-
-## Functions
-
-SendScript as of `v2.4` supports functions to do basic templating. It does not
-support async functions and will throw an error when you define one.
-
-Under the hood the function is called when it is being parsed. Make sure you
-understand what you are doing when mixing client and server functions.
-
-```js
-map((a) => add(a, 1))([1, 2, 3]))
-```
-
-It also supports nested functions.
-
-```js
-map(call)(map((a) => () => add(a, 1))([1, 2, 3]))
-```
+> Use the `DEBUG='*'` to enable all logs or `DEBUG='sendscript:*'` for printing
+> only sendscript logs.
 
 ## Promises
 
 ### .then / .catch
 
-Supported since vs `v2.3`.
+Supported since `v2.3`.
 
 ```js
 const getOrCreatePost = send(createPost(title).catch(createPost(title)))
@@ -407,7 +447,7 @@ const env = {
 }
 
 // Parse with custom leaf deserializer
-const parse = Parse(schema, env, leadDeserializer)
+const parse = Parse(schema, env, leafDeserializer)
 
 const result = parse(json)
 ```
@@ -415,6 +455,75 @@ const result = parse(json)
 The leaf wrapper format is `['leaf', serializedPayload]`, making it unambiguous
 and safe from colliding with SendScript operators.
 
+## Limitations
+
+The stubs the `references` function returns are limited in the way they can be
+used. This has to do with the fact that they are to be serialized.
+
+### Chaining APIs
+
+Currently you cannot do chaining APIs. `lib().doThis().doThat()`. It likely is
+possible to implement but will require more extensive schemas and obviously more
+code to create the AST.
+
+### Callbacks
+
+Although it is possible to mix client and server functions, it works very
+different to ordinary functions. Client functions can be used but should be seen
+as a templating tool to make sendscript programs; just like one would use
+JavaScript with react templates. `items.map(deleteItem)` would return an array
+of sendscript function calls which can be given to sendscript's parse.
+
+Client functions cannot be called by sendscript functions (as of yet) since we
+cannot serialize client functions. No work has been done to have the server send
+back intermediate values to perform client function calls or by performing
+smaller sendscript program payloads that are passed to the client. Very
+interesting stuff to look into. You can achieve this now but it looks less clean
+because you have to do `send` calls which is a bit manual.
+
+```js
+await send(updateUser(id, merge(await send(getUser(id)), { ...newValues })))
+```
+
+It might be interesting to allow configuration to create references that will
+trigger a send whenever await is called. That would remove the ability to create
+a single payload whenever using await. You can then write the above in the
+following manner.
+
+```js
+await updateUser(id, merge(await getUser(id), { ...newValues }))
+```
+
+Possible footgun is that updateUser is only performed when awaited (.then is
+called). This lazy behavior can trip users. This footgun could be resolved by
+checking if any outstanding work exists at the end of a step or the beginning of
+a new step.
+
+### Error handling
+
+Sendscript does not have builtin tools to handle errors. You can write your own
+utilities for that or use things like [Ramda's tryCatch][tryCatch]. This will
+likely never be supported as JS try catch does not have a return value. It might
+make sense to wrap everything that can throw in promises which is easy to do
+with async functions.
+
+## Tests
+
+Tests with 100% code coverage.
+
+```bash bash
+npm t -- -R silent
+npm t -- report text-summary
+```
+
+## Formatting
+
+Standard because no config.
+
+```bash bash
+npx standard
+```
+
 ## Changelog
 
 The [changelog][changelog] is generated using the useful

package/example/typescript/docs/functions/add.md

@@ -8,7 +8,7 @@
 
 > **add**(`a`, `b`): `number`
 
-Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/example/typescript/math.ts#L1)
+Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/46421de16533066ee13c91ea75505b1ecdd548f0/example/typescript/math.ts#L1)
 
 ## Parameters
 

package/example/typescript/docs/functions/square.md

@@ -8,7 +8,7 @@
 
 > **square**(`a`): `number`
 
-Defined in: [math.ts:2](https://github.com/bas080/sendscript/blob/5249a85a08b10485f0d64058fd2c8bcaae84edda/example/typescript/math.ts#L2)
+Defined in: [math.ts:2](https://github.com/bas080/sendscript/blob/46421de16533066ee13c91ea75505b1ecdd548f0/example/typescript/math.ts#L2)
 
 ## Parameters
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sendscript",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "description": "Blur the line between server and client code.",
   "module": true,
   "main": "index.mjs",
@@ -25,7 +25,7 @@
   "license": "MIT",
   "devDependencies": {
     "superjson": "^2.2.6",
-    "tap": "^21.6.3",
+    "tap": "^21.7.1",
     "tape-check": "^1.0.0-rc.0",
     "typedoc": "^0.28.18",
     "typedoc-plugin-markdown": "^4.11.0"

package/curry.mjs

@@ -1,11 +0,0 @@
-export default function curry (func) {
-  return function curried (...args) {
-    if (args.length >= func.length) {
-      return func.apply(this, args)
-    } else {
-      return function (...args2) {
-        return curried.apply(this, args.concat(args2))
-      }
-    }
-  }
-}

package/curry.test.mjs

@@ -1,35 +0,0 @@
-import { test } from 'tap'
-import curry from './curry.mjs'
-
-test('curry function', (t) => {
-  t.test('curry function returns a function', (assert) => {
-    const curried = curry((a, b, c) => a + b + c)
-    assert.type(curried, 'function', 'returns a function')
-    assert.end()
-  })
-
-  t.test('curried function returns correct result', (assert) => {
-    const curried = curry((a, b, c) => a + b + c)
-    const result = curried(1)(2)(3)
-    assert.equal(result, 6, 'returns correct result')
-    assert.end()
-  })
-
-  t.test('curried function handles partial application', (assert) => {
-    const curried = curry((a, b, c) => a + b + c)
-    const partial = curried(1, 2)
-    const result = partial(3)
-    assert.equal(result, 6, 'handles partial application')
-    assert.end()
-  })
-
-  t.test('curried function handles multiple arguments', (assert) => {
-    const curried = curry((a, b, c, d) => a + b + c + d)
-    const partial = curried(1)
-    const result = partial(2)(3, 4)
-    assert.equal(result, 10, 'handles multiple arguments')
-    assert.end()
-  })
-
-  t.end()
-})