2.0.0

Author: bas080

CHANGELOG.md

@@ -4,8 +4,16 @@ 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.0.0](https://github.com/bas080/sendscript/compare/v1.1.0...v2.0.0)
+
+- Rewrite to have parse take schema to prevent accessing refs [`df16f85`](https://github.com/bas080/sendscript/commit/df16f85c79299aa8bcd3e44b6cc127bd7198eace)
+- Run tests before release and publish on release [`10442d6`](https://github.com/bas080/sendscript/commit/10442d6766a098926ee98daee08dba23eea0fb14)
+- Create release on tag with github workflows [`4ec222b`](https://github.com/bas080/sendscript/commit/4ec222bf51fc1d3cce9fc54fdd1e9639b5d259cd)
+
 #### [v1.1.0](https://github.com/bas080/sendscript/compare/v1.0.6...v1.1.0)
 
+> 7 April 2026
+
 - Support custom serialization of leaf nodes [`d56f1b7`](https://github.com/bas080/sendscript/commit/d56f1b750e2d7faf72d69f9ba8e9bb62ef5ebce7)
 - Support nested modules [`88e69e5`](https://github.com/bas080/sendscript/commit/88e69e5c05ddb85aac1797a020e92519c986e89f)
 - Document new nesting and leaf serialization feature [`b3ee9f6`](https://github.com/bas080/sendscript/commit/b3ee9f693dc6137b01c9f0072aa2dd1e940f07c9)

README.md

@@ -53,10 +53,11 @@ using more advanced (de)serialization libraries.
 SendScript produces an intermediate JSON representation of the program. Let's see what that looks like.
 
 ```js
-import stringify from 'sendscript/stringify.mjs'
-import module from 'sendscript/module.mjs'
+import Stringify from 'sendscript/stringify.mjs'
+import references from 'sendscript/references.mjs'
 
-const { add } = module(['add'])
+const { add } = references(['add'])
+const stringify = Stringify()
 
 console.log(stringify(add(1,2)))
 ```
@@ -75,7 +76,7 @@ const module = {
   }
 }
 
-const parse = Parse(module)
+const parse = Parse(['add'], module)
 
 const program = '["call",["ref","add"],[1,2]]'
 
@@ -131,7 +132,8 @@ import { Server } from 'socket.io'
 import Parse from 'sendscript/parse.mjs'
 import * as math from './math.mjs'
 
-const parse = Parse(math)
+const schema = Object.keys(math)
+const parse = Parse(schema, math)
 const server = new Server()
 const port = process.env.PORT || 3000
 
@@ -158,11 +160,13 @@ Now for a client that sends a program to the server.
 // ./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 Stringify from 'sendscript/stringify.mjs'
+import references from 'sendscript/references.mjs'
 import assert from 'node:assert'
 
+const { add, square } = references(['add', 'square'])
+const stringify = Stringify()
+
 const port = process.env.PORT || 3000
 const client = socketClient(`http://localhost:${port}`)
 
@@ -176,8 +180,6 @@ const send = program => {
   })
 }
 
-const { add, square } = module(math)
-
 // The program to be sent over the wire
 const program = square(add(1, add(add(2, 3), 4)))
 
@@ -253,52 +255,31 @@ 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.
+We can then coerce the types of the instrumented stubs.
 
 ```bash
 cat ./example/typescript/client.ts
 ```
 ```ts
-import stringify from 'sendscript/stringify.mjs'
+import math  from './math.client.ts'
+import Stringify from 'sendscript/stringify.mjs'
+
+const stringify = Stringify()
 
-async function send<T>(program: T): Promise<T>{
+// The return type of this function matches the type passed as the return of the program.
+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.
 
 ```bash
-npm install --no-save \
-  typedoc \
-  typedoc-plugin-markdown
-
 npx typedoc --plugin typedoc-plugin-markdown --out ./example/typescript/docs ./example/typescript/math.ts
 ```
 
@@ -316,32 +297,33 @@ Sendscript allows you to define your API as a **nested object of functions**, ma
 
 ### Defining a Nested Module
 
-You can define a schema as either:
-
-1. **An object with nested objects** – submodules.
-2. **An array of function names** – automatically instrumented.
+You can define a schema as **an array of function names**
 
 ```js
-import module from 'sendscript/module.mjs'
-
-const myModule = module({
-  math: ['add', 'sub'],
-
-  // Use an object with keys and true value
-  vector: {
-    add: true,
-    multiply: true
-  },
 
-  // or use an array.
-  utils: ['identity', 'always'],
+const schema = [
+  'help',
+  'version',
+
+  ['math', [
+    'add',
+    'sub'
+  ]],
+  ['vector', [
+    'add',
+    'multiply'
+  ]],
+  ['utils', [
+    'identity',
+    'always'
+  ]],
 })
 ```
 
 Functions are referenced via their **path in the module tree**:
 
 ```js
-const { math, vector } = myModule
+const { math, vector } = references(schema)
 
 math.add(
   1,
@@ -389,9 +371,9 @@ Here's how to use [superjson](https://github.com/blitz-js/superjson) to support
 
 ```js
 import SuperJSON from 'superjson'
-import stringify from 'sendscript/stringify.mjs'
+import Stringify from 'sendscript/stringify.mjs'
+import references from 'sendscript/references.mjs'
 import Parse from 'sendscript/parse.mjs'
-import module from 'sendscript/module.mjs'
 
 const leafSerializer = (value) => {
   if (value === undefined) return JSON.stringify({ __undefined__: true })
@@ -404,7 +386,10 @@ const leafDeserializer = (text) => {
   return SuperJSON.deserialize(parsed)
 }
 
-const { processData } = module(['processData'])
+const schema = ['processData']
+
+const { processData } = references(schema)
+const stringify = Stringify(leafSerializer)
 
 // Program with Date, RegExp, and other types
 const program = {
@@ -416,17 +401,20 @@ const program = {
 }
 
 // Serialize with custom leaf serializer
-const json = stringify(processData(program), leafSerializer)
+const json = stringify(processData(program))
 
-// Parse with custom leaf deserializer
-const parse = Parse({
+// The environment
+const env = {
   processData: (data) => ({
     success: true,
     received: data
   })
-})
+}
+
+// Parse with custom leaf deserializer
+const parse = Parse(schema, env, leadDeserializer)
 
-const result = parse(json, leafDeserializer)
+const result = parse(json)
 ```
 
 The leaf wrapper format is `['leaf', serializedPayload]`, making it unambiguous and safe from colliding with SendScript operators.
@@ -441,19 +429,19 @@ npm t -- report text-summary
 ```
 ```
 
-> sendscript@1.1.0 test
+> sendscript@2.0.0 test
 > tap -R silent
 
 
-> sendscript@1.1.0 test
+> sendscript@2.0.0 test
 > tap report text-summary
 
 
 =============================== Coverage summary ===============================
-Statements   : 100% ( 328/328 )
-Branches     : 100% ( 138/138 )
-Functions    : 100% ( 23/23 )
-Lines        : 100% ( 328/328 )
+Statements   : 100% ( 348/348 )
+Branches     : 100% ( 145/145 )
+Functions    : 100% ( 24/24 )
+Lines        : 100% ( 348/348 )
 ================================================================================
 ```
 

example/client.socket.io.mjs

@@ -1,11 +1,13 @@
 // ./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 Stringify from 'sendscript/stringify.mjs'
+import references from 'sendscript/references.mjs'
 import assert from 'node:assert'
 
+const { add, square } = references(['add', 'square'])
+const stringify = Stringify()
+
 const port = process.env.PORT || 3000
 const client = socketClient(`http://localhost:${port}`)
 
@@ -19,8 +21,6 @@ const send = program => {
   })
 }
 
-const { add, square } = module(math)
-
 // The program to be sent over the wire
 const program = square(add(1, add(add(2, 3), 4)))
 

example/server.socket.io.mjs

@@ -4,7 +4,8 @@ import { Server } from 'socket.io'
 import Parse from 'sendscript/parse.mjs'
 import * as math from './math.mjs'
 
-const parse = Parse(math)
+const schema = Object.keys(math)
+const parse = Parse(schema, math)
 const server = new Server()
 const port = process.env.PORT || 3000
 

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/68bfab27a561a994381cdcf5a7cf367e29a2d07d/example/typescript/math.ts#L1)
+Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/ffa4feaeee11b6652b89c5412b2af937139edac5/example/typescript/math.ts#L1)
 
 ## Parameters
 

example/typescript/docs/functions/square.md

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

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "sendscript",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Blur the line between server and client code.",
   "module": true,
   "main": "index.mjs",