sendscript 1.0.3 → 1.0.5

package/.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
+      - run: npm publish

package/CHANGELOG.md

@@ -4,8 +4,22 @@ 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).
 
+#### [v1.0.5](https://github.com/bas080/sendscript/compare/v1.0.4...v1.0.5)
+
+- Add publish to npm workflow [`aaaa97d`](https://github.com/bas080/sendscript/commit/aaaa97d1024d6b5ed574a2cd103035949ec8280d)
+
+#### [v1.0.4](https://github.com/bas080/sendscript/compare/v1.0.3...v1.0.4)
+
+> 5 April 2026
+
+- Update tap and debug deps [`bd28139`](https://github.com/bas080/sendscript/commit/bd28139b633a04ac1b705b71c6bd24e98655d3b4)
+- Give example its own package.json [`4307988`](https://github.com/bas080/sendscript/commit/4307988467d866f461f27c42a92a304bfe7617d6)
+- Add cli with repl command [`d811fcb`](https://github.com/bas080/sendscript/commit/d811fcbf2d95fe8729c3782aceec6aea3bff1367)
+
 #### [v1.0.3](https://github.com/bas080/sendscript/compare/v1.0.2...v1.0.3)
 
+> 4 May 2025
+
 - Make examples import module not relative file [`0a5e1c8`](https://github.com/bas080/sendscript/commit/0a5e1c8ec2527d63d1e248f63568668058de388c)
 - Fix repository url in package.json [`d4f1e79`](https://github.com/bas080/sendscript/commit/d4f1e79a75daea28905c9b680b31e517526588d3)
 

package/README.md

@@ -13,6 +13,7 @@ Write JS code that you can run on servers, browsers or other clients.
   * [Module](#module)
   * [Server](#server)
   * [Client](#client)
+- [Repl](#repl)
 - [Async/Await](#asyncawait)
 - [TypeScript](#typescript)
 - [Tests](#tests)
@@ -33,11 +34,12 @@ needs.
 For this example we'll use [socket.io][socket.io].
 
 ```bash
-npm link &&
-  npm install --no-save \
-    socket.io \
-    socket.io-client \
-    sendscript
+set -e
+
+npm link
+cd ./example
+npm ci
+npm link sendscript
 ```
 
 > We use the `--no-save` option because it's only for demonstration purposes.
@@ -140,6 +142,12 @@ pkill sendscript
 Result:  100
 ```
 
+## Repl
+
+Sendscript ships with a barebones (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.
+
 ## Async/Await
 
 SendScript supports async/await seamlessly within a single request. This avoids the performance pitfalls of waterfall-style messaging, which can be especially slow on high-latency networks.
@@ -246,11 +254,11 @@ npm t -- report text-summary
 ```
 ```
 
-> sendscript@1.0.3 test
+> sendscript@1.0.5 test
 > tap -R silent
 
 
-> sendscript@1.0.3 test
+> sendscript@1.0.5 test
 > tap report text-summary
 
 

package/README.mz

@@ -18,11 +18,12 @@ needs.
 For this example we'll use [socket.io][socket.io].
 
 ```bash bash > /dev/null
-npm link &&
-  npm install --no-save \
-    socket.io \
-    socket.io-client \
-    sendscript
+set -e
+
+npm link
+cd ./example
+npm ci
+npm link sendscript
 ```
 
 > We use the `--no-save` option because it's only for demonstration purposes.
@@ -122,6 +123,12 @@ node ./example/client.socket.io.mjs
 pkill sendscript
 ```
 
+## Repl
+
+Sendscript ships with a barebones (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.
+
 ## Async/Await
 
 SendScript supports async/await seamlessly within a single request. This avoids the performance pitfalls of waterfall-style messaging, which can be especially slow on high-latency networks.

package/cli.mjs

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+
+import path from 'path'
+import { pathToFileURL } from 'url'
+import stringify from './stringify.mjs'
+import repl from './repl.mjs'
+import Parse from './parse.mjs'
+
+const modulePath = pathToFileURL(path.resolve(process.cwd(), process.argv[2])).href
+const mod = await import(modulePath)
+const parse = Parse(mod)
+
+const send = program => parse(stringify(program))
+
+repl(send, mod)

package/example/README.md

@@ -0,0 +1,3 @@
+# Sendscript Example
+
+Showcases the use of sendscript in combination with TypeScript.

package/example/package-lock.json

@@ -0,0 +1,242 @@
+{
+  "name": "sendscript-example",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "sendscript-example",
+      "dependencies": {
+        "socket.io": "^4.8.1",
+        "socket.io-client": "^4.8.1"
+      }
+    },
+    "node_modules/@socket.io/component-emitter": {
+      "version": "3.1.2",
+      "license": "MIT"
+    },
+    "node_modules/@types/cors": {
+      "version": "2.8.18",
+      "license": "MIT",
+      "dependencies": {
+        "@types/node": "*"
+      }
+    },
+    "node_modules/@types/node": {
+      "version": "22.15.17",
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~6.21.0"
+      }
+    },
+    "node_modules/accepts": {
+      "version": "1.3.8",
+      "license": "MIT",
+      "dependencies": {
+        "mime-types": "~2.1.34",
+        "negotiator": "0.6.3"
+      },
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/base64id": {
+      "version": "2.0.0",
+      "license": "MIT",
+      "engines": {
+        "node": "^4.5.0 || >= 5.9"
+      }
+    },
+    "node_modules/cookie": {
+      "version": "0.7.2",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/cors": {
+      "version": "2.8.5",
+      "license": "MIT",
+      "dependencies": {
+        "object-assign": "^4",
+        "vary": "^1"
+      },
+      "engines": {
+        "node": ">= 0.10"
+      }
+    },
+    "node_modules/debug": {
+      "version": "4.3.7",
+      "license": "MIT",
+      "dependencies": {
+        "ms": "^2.1.3"
+      },
+      "engines": {
+        "node": ">=6.0"
+      },
+      "peerDependenciesMeta": {
+        "supports-color": {
+          "optional": true
+        }
+      }
+    },
+    "node_modules/engine.io": {
+      "version": "6.6.4",
+      "license": "MIT",
+      "dependencies": {
+        "@types/cors": "^2.8.12",
+        "@types/node": ">=10.0.0",
+        "accepts": "~1.3.4",
+        "base64id": "2.0.0",
+        "cookie": "~0.7.2",
+        "cors": "~2.8.5",
+        "debug": "~4.3.1",
+        "engine.io-parser": "~5.2.1",
+        "ws": "~8.17.1"
+      },
+      "engines": {
+        "node": ">=10.2.0"
+      }
+    },
+    "node_modules/engine.io-client": {
+      "version": "6.6.3",
+      "license": "MIT",
+      "dependencies": {
+        "@socket.io/component-emitter": "~3.1.0",
+        "debug": "~4.3.1",
+        "engine.io-parser": "~5.2.1",
+        "ws": "~8.17.1",
+        "xmlhttprequest-ssl": "~2.1.1"
+      }
+    },
+    "node_modules/engine.io-parser": {
+      "version": "5.2.3",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10.0.0"
+      }
+    },
+    "node_modules/mime-db": {
+      "version": "1.52.0",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/mime-types": {
+      "version": "2.1.35",
+      "license": "MIT",
+      "dependencies": {
+        "mime-db": "1.52.0"
+      },
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/ms": {
+      "version": "2.1.3",
+      "license": "MIT"
+    },
+    "node_modules/negotiator": {
+      "version": "0.6.3",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/object-assign": {
+      "version": "4.1.1",
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/socket.io": {
+      "version": "4.8.1",
+      "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-4.8.1.tgz",
+      "integrity": "sha512-oZ7iUCxph8WYRHHcjBEc9unw3adt5CmSNlppj/5Q4k2RIrhl8Z5yY2Xr4j9zj0+wzVZ0bxmYoGSzKJnRl6A4yg==",
+      "license": "MIT",
+      "dependencies": {
+        "accepts": "~1.3.4",
+        "base64id": "~2.0.0",
+        "cors": "~2.8.5",
+        "debug": "~4.3.2",
+        "engine.io": "~6.6.0",
+        "socket.io-adapter": "~2.5.2",
+        "socket.io-parser": "~4.2.4"
+      },
+      "engines": {
+        "node": ">=10.2.0"
+      }
+    },
+    "node_modules/socket.io-adapter": {
+      "version": "2.5.5",
+      "license": "MIT",
+      "dependencies": {
+        "debug": "~4.3.4",
+        "ws": "~8.17.1"
+      }
+    },
+    "node_modules/socket.io-client": {
+      "version": "4.8.1",
+      "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.8.1.tgz",
+      "integrity": "sha512-hJVXfu3E28NmzGk8o1sHhN3om52tRvwYeidbj7xKy2eIIse5IoKX3USlS6Tqt3BHAtflLIkCQBkzVrEEfWUyYQ==",
+      "license": "MIT",
+      "dependencies": {
+        "@socket.io/component-emitter": "~3.1.0",
+        "debug": "~4.3.2",
+        "engine.io-client": "~6.6.1",
+        "socket.io-parser": "~4.2.4"
+      },
+      "engines": {
+        "node": ">=10.0.0"
+      }
+    },
+    "node_modules/socket.io-parser": {
+      "version": "4.2.4",
+      "license": "MIT",
+      "dependencies": {
+        "@socket.io/component-emitter": "~3.1.0",
+        "debug": "~4.3.1"
+      },
+      "engines": {
+        "node": ">=10.0.0"
+      }
+    },
+    "node_modules/undici-types": {
+      "version": "6.21.0",
+      "license": "MIT"
+    },
+    "node_modules/vary": {
+      "version": "1.1.2",
+      "license": "MIT",
+      "engines": {
+        "node": ">= 0.8"
+      }
+    },
+    "node_modules/ws": {
+      "version": "8.17.1",
+      "license": "MIT",
+      "engines": {
+        "node": ">=10.0.0"
+      },
+      "peerDependencies": {
+        "bufferutil": "^4.0.1",
+        "utf-8-validate": ">=5.0.2"
+      },
+      "peerDependenciesMeta": {
+        "bufferutil": {
+          "optional": true
+        },
+        "utf-8-validate": {
+          "optional": true
+        }
+      }
+    },
+    "node_modules/xmlhttprequest-ssl": {
+      "version": "2.1.2",
+      "engines": {
+        "node": ">=0.4.0"
+      }
+    }
+  }
+}

package/example/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "sendscript-example",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "socket.io": "^4.8.1",
+    "socket.io-client": "^4.8.1"
+  }
+}

package/example/typescript/docs/README.md

@@ -1,211 +1,7 @@
-**sendscript**
+**sendscript-example**
 
 ***
 
-# SendScript
+# Sendscript Example
 
-Write JS code that you can run on servers, browsers or other clients.
-
-[![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)
-
-<!-- toc -->
-
-SendScript leaves it up to you to choose HTTP, web-sockets or any other
-method of communication between servers and clients that best fits your
-needs.
-
-## Socket example
-
-For this example we'll use [socket.io][socket.io].
-
-```bash
-npm link &&
-  npm install --no-save \
-    socket.io \
-    socket.io-client \
-    sendscript
-```
-
-> We use the `--no-save` option because it's only for demonstration purposes.
-
-### Module
-
-We write a simple module.
-
-```js
-// ./example/math.mjs
-
-export const add = (a, b) => a + b
-export const square = a => a * a
-```
-
-### Server
-
-Here a socket.io server that runs SendScript programs.
-
-```js
-// ./example/server.socket.io.mjs
-
-import { Server } from 'socket.io'
-import Parse from 'sendscript/parse.mjs'
-import * as math from './math.mjs'
-
-const parse = Parse(math)
-const server = new Server()
-const port = process.env.PORT || 3000
-
-server.on('connection', (socket) => {
-  socket.on('message', async (program, callback) => {
-    try {
-      const result = parse(program)
-      callback(null, result) // Pass null as the first argument to indicate success
-    } catch (error) {
-      callback(error) // Pass the error to the callback
-    }
-  })
-})
-
-server.listen(port)
-process.title = 'sendscript'
-```
-
-### Client
-
-Now for a client that sends a program to the server.
-
-```js
-// ./example/client.socket.io.mjs
-
-import socketClient from 'socket.io-client'
-import stringify from 'sendscript/stringify.mjs'
-import module from 'sendscript/module.mjs'
-import * as math from './math.mjs'
-import assert from 'node:assert'
-
-const port = process.env.PORT || 3000
-const client = socketClient(`http://localhost:${port}`)
-
-const send = program => {
-  return new Promise((resolve, reject) => {
-    client.emit('message', stringify(program), (error, result) => {
-      error
-        ? reject(error)
-        : resolve(result)
-    })
-  })
-}
-
-const { add, square } = module(math)
-
-// The program to be sent over the wire
-const program = square(add(1, add(add(2, 3), 4)))
-
-const result = await send(program)
-
-console.log('Result: ', result)
-
-assert.equal(result, 100)
-
-process.exit(0)
-```
-
-Now we run this server and a client script.
-
-```bash
-set -e
-
-# Run the server
-node ./example/server.socket.io.mjs&
-
-# Run the client example
-node ./example/client.socket.io.mjs
-
-pkill sendscript
-```
-```
-Result:  100
-```
-
-## Async/Await
-
-SendScript supports async/await seamlessly within a single request. This avoids the performance pitfalls of waterfall-style messaging, which can be especially slow on high-latency networks.
-
-While it's possible to chain promises manually or use utility functions, native async/await support makes your code more readable, modern, and easier to reason about — aligning SendScript with today’s JavaScript best practices.
-
-```js
-const userId = 'user-123'
-const program = {
-  unread: await fetchUnreadMessages(userId),
-  emptyTrash: await emptyTrash(userId),
-  archived: await archiveMessages(selectMessages({ old: true }))
-}
-
-const result = await send(program)
-```
-
-This operation is done in a single round-trip. The result is an object with the defined properties and returned values.
-
-## TypeScript
-
-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.
-
-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
-```
-
-We want to use this module on the client. We create a client version of that module and coerce the types to match those of the server.
-
-```bash
-cat ./example/typescript/math.client.ts
-```
-```ts
-import module from 'sendscript/module.mjs'
-import type * as mathTypes from './math.ts'
-
-const math = module([
-  'add',
-  'square'
-]) as typeof mathTypes
-
-export default math
-```
-
-We now use the client version of this module.
-
-```bash
-cat ./example/typescript/client.ts
-```
-```ts
-import stringify from 'sendscript/stringify.mjs'
-
-async function send<T>(program: T): Promise<T>{
-  return (await fetch('/api', {
-    method: 'POST',
-    body: stringify(program)
-  })).json()
-}
-
-import math from './math.client.ts'
-
-const { add, square } = math
-
-send(square(add(1, 2)))
-```
-
-We'll also generate the docs for this module.
+Showcases the use of sendscript in combination with TypeScript.

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

@@ -1,14 +1,14 @@
-[**sendscript**](../README.md)
+[**sendscript-example**](../README.md)
 
 ***
 
-[sendscript](../globals.md) / add
+[sendscript-example](../globals.md) / add
 
 # Function: add()
 
 > **add**(`a`, `b`): `number`
 
-Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/0a5e1c8ec2527d63d1e248f63568668058de388c/example/typescript/math.ts#L1)
+Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/aaaa97d1024d6b5ed574a2cd103035949ec8280d/example/typescript/math.ts#L1)
 
 ## Parameters
 

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

@@ -1,14 +1,14 @@
-[**sendscript**](../README.md)
+[**sendscript-example**](../README.md)
 
 ***
 
-[sendscript](../globals.md) / square
+[sendscript-example](../globals.md) / square
 
 # Function: square()
 
 > **square**(`a`): `number`
 
-Defined in: [math.ts:2](https://github.com/bas080/sendscript/blob/0a5e1c8ec2527d63d1e248f63568668058de388c/example/typescript/math.ts#L2)
+Defined in: [math.ts:2](https://github.com/bas080/sendscript/blob/aaaa97d1024d6b5ed574a2cd103035949ec8280d/example/typescript/math.ts#L2)
 
 ## Parameters
 

package/example/typescript/docs/globals.md

@@ -1,8 +1,8 @@
-[**sendscript**](README.md)
+[**sendscript-example**](README.md)
 
 ***
 
-# sendscript
+# sendscript-example
 
 ## Functions
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sendscript",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Blur the line between server and client code.",
   "module": true,
   "main": "index.mjs",
@@ -23,9 +23,9 @@
   "author": "Bas Huis",
   "license": "MIT",
   "devDependencies": {
-    "tap": "^21.0.1"
+    "tap": "^21.6.2"
   },
   "dependencies": {
-    "debug": "^4.3.7"
+    "debug": "^4.4.3"
   }
 }

package/repl.mjs

@@ -0,0 +1,15 @@
+import instrument from './module.mjs'
+import repl from 'node:repl'
+
+export default async function sendscriptRepl (send, module) {
+  Object.assign(global, instrument(module))
+
+  async function cb (cmd, context, filename, callback) {
+    callback(null, await send(eval(cmd))) // eslint-disable-line no-eval
+  }
+
+  return repl.start({
+    prompt: '> ',
+    eval: cb
+  })
+}

package/schema.json

@@ -1,53 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "JSON S-expression Language Schema",
-  "description": "Schema for a custom JSON S-expression language.",
-  "definitions": {
-    "ref": {
-      "title": "Reference Operator",
-      "description": "A reference to a function or identifier.",
-      "type": "array",
-      "minItems": 2,
-      "maxItems": 2,
-      "items": [
-        { "enum": ["ref"], "title": "Operator", "description": "The operator type, representing a reference to a function or identifier." },
-        { "type": "string", "title": "Identifier", "description": "The identifier or function name." }
-      ]
-    },
-    "call": {
-      "title": "Call Operator",
-      "description": "A function call.",
-      "type": "array",
-      "minItems": 2,
-      "maxItems": 3,
-      "items": [
-        { "const": "call", "title": "Operator", "description": "The operator type, representing a function call." },
-        { "$ref": "#/definitions/ref", "title": "Reference", "description": "The reference to a function or identifier." },
-        {
-          "type": "array",
-          "items": {
-            "$ref": "#"
-          },
-          "title": "Arguments",
-          "description": "The arguments passed to the function."
-        }
-      ]
-    }
-  },
-  "oneOf": [
-    { "$ref": "#/definitions/ref" },
-    { "$ref": "#/definitions/call" },
-    { "type": "number", "title": "Number", "description": "A JSON number." },
-    { "type": "string", "title": "String", "description": "A JSON string." },
-    { "type": "boolean", "title": "Boolean", "description": "A JSON boolean." },
-    { "type": "null", "title": "Null", "description": "A JSON null value." },
-    {
-      "title": "Object",
-      "description": "A generic JSON object with additional properties.",
-      "type": "object",
-      "additionalProperties": {
-        "$ref": "#"
-      }
-    }
-  ]
-}