sendscript 2.3.3 → 2.3.4

package/CHANGELOG.md

@@ -4,8 +4,14 @@ 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.3.4](https://github.com/bas080/sendscript/compare/v2.3.3...v2.3.4)
+
+- Improve naming in JSDocs [`669a40e`](https://github.com/bas080/sendscript/commit/669a40e28a5c77963d855dd4e2122d0ba2c074cd)
+
 #### [v2.3.3](https://github.com/bas080/sendscript/compare/v2.3.2...v2.3.3)
 
+> 14 April 2026
+
 - Add JSDoc to relevant function for docs [`d1d3709`](https://github.com/bas080/sendscript/commit/d1d3709088a51b71651170ef642b013eedc9ca3a)
 - Remove tests section from README [`5da7bb3`](https://github.com/bas080/sendscript/commit/5da7bb3f3b1dc8078683e076fe2b520bc6d28896)
 - Add generated from JSDoc reference section [`08eb266`](https://github.com/bas080/sendscript/commit/08eb266b06d8998e6849dbc5c9738fbe782ada18)

package/CONTRIBUTING.md

@@ -40,7 +40,7 @@ Generate the README from the mz file.
 ```bash bash
 markatzea ./README.mz | tee ./README.md
 
-npx documentation readme references.mjs parse.mjs stringify.mjs -s Reference --github --a public --markdown-toc false
+npx documentation readme references.mjs stringify.mjs parse.mjs -s Reference --github --a public --markdown-toc false
 
 npx markdown-toc --maxdepth 3 -i README.md
 

package/README.md

@@ -11,11 +11,11 @@ Write JS code that you can run on servers, browsers or other clients.
 
 - [Introduction](#introduction)
 - [Reference](#reference)
-  * [defaultLeafDeserializer](#defaultleafdeserializer)
+  * [defaultLeafParse](#defaultleafparse)
   * [Parse](#parse)
   * [parse](#parse)
   * [References](#references)
-  * [strictStringify](#strictstringify)
+  * [defaultLeafStringify](#defaultleafstringify)
   * [Stringify](#stringify)
   * [stringify](#stringify)
 - [Socket example](#socket-example)
@@ -121,7 +121,7 @@ of communication between servers and clients that best fits your needs.
 
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
-### defaultLeafDeserializer
+### defaultLeafParse
 
 Default deserializer for leaf nodes.
 
@@ -133,20 +133,13 @@ Returns **any**&#x20;
 
 ### Parse
 
-Creates a program parser for a given schema and environment.
-
-The parser:
-
-*   resolves references into runtime functions
-*   deserializes leaf nodes
-*   collects and executes async awaits
-*   evaluates AST-like JSON programs
-
 #### Parameters
 
 *   `schemaArg` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | \[[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)])>**&#x20;
-*   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** runtime environment for refs
-*   `deserialize`   (optional, default `defaultLeafDeserializer`)
+*   `env` **Env** runtime environment for refs
+*   `leafParse`   (optional, default `defaultLeafParse`)
+
+Returns **[parse](#parse)**&#x20;
 
 ### parse
 
@@ -178,7 +171,7 @@ Schema supports:
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Nested instrumented API object
 
-### strictStringify
+### defaultLeafStringify
 
 Default strict serializer for leaf values.
 
@@ -196,7 +189,7 @@ Creates a stringify function for SendScript AST structures.
 
 #### Parameters
 
-*   `leafSerializer`   (optional, default `strictStringify`)
+*   `leafStringify`   (optional, default `defaultLeafStringify`)
 
 ### stringify
 

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/08eb266b06d8998e6849dbc5c9738fbe782ada18/example/typescript/math.ts#L1)
+Defined in: [math.ts:1](https://github.com/bas080/sendscript/blob/669a40e28a5c77963d855dd4e2122d0ba2c074cd/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/08eb266b06d8998e6849dbc5c9738fbe782ada18/example/typescript/math.ts#L2)
+Defined in: [math.ts:2](https://github.com/bas080/sendscript/blob/669a40e28a5c77963d855dd4e2122d0ba2c074cd/example/typescript/math.ts#L2)
 
 ## Parameters
 

package/package.json

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

package/parse.mjs

@@ -98,9 +98,12 @@ const evaluate = spy('eval', (value, awaits = []) => {
  * @returns {any}
  * @public
  */
-const defaultLeafDeserializer = (text) => JSON.parse(text)
+const defaultLeafParse = (text) => JSON.parse(text)
 
 /**
+ * @template Env
+ * @typedef {(program: string) => any | Promise<any>} parse
+ *
  * Creates a program parser for a given schema and environment.
  *
  * The parser:
@@ -110,12 +113,12 @@ const defaultLeafDeserializer = (text) => JSON.parse(text)
  * - evaluates AST-like JSON programs
  *
  * @param {Array<string | [string, Array]>} schemaArg
- * @param {Object} env - runtime environment for refs
- * @param {(text: string) => any} [deserialize=defaultLeafDeserializer]
- * @returns {(program: string) => any|Promise<any>}
+ * @param {Env} env - runtime environment for refs
+ * @param {(text: string) => any} [leafParse=defaultLeafParse]
+ * @returns {parse}
  * @public
  */
-export default function Parse (schemaArg, env, deserialize = defaultLeafDeserializer) {
+export default function Parse (schemaArg, env, leafParse = defaultLeafParse) {
   const schema = flattenSchema(schemaArg)
 
   /**
@@ -145,7 +148,7 @@ export default function Parse (schemaArg, env, deserialize = defaultLeafDeserial
       const [operator, ...rest] = value
 
       if (operator === 'leaf') {
-        const leafValue = deserialize(rest[0])
+        const leafValue = leafParse(rest[0])
         return leafValue === undefined ? undefinedSentinel : leafValue
       }
 

package/stringify.mjs

@@ -89,7 +89,7 @@ function transformValue (value, leafSerializer) {
  * @returns {string}
  * @public
  */
-function strictStringify (x) {
+function defaultLeafStringify (x) {
   const typeOf = typeof x
 
   if (typeOf === 'object' || typeOf === 'function' || x === undefined) {
@@ -108,7 +108,7 @@ function strictStringify (x) {
  * @returns {(program: any) => string}
  * @public
  */
-export default function Stringify (leafSerializer = strictStringify) {
+export default function Stringify (leafStringify = defaultLeafStringify) {
   /**
    * Serializes a program into a JSON string representation.
    *
@@ -116,9 +116,7 @@ export default function Stringify (leafSerializer = strictStringify) {
    * @returns {string}
    * @public
    */
-  function stringify (program) {
-    return JSON.stringify(transformValue(program, leafSerializer))
+  return function stringify (program) {
+    return JSON.stringify(transformValue(program, leafStringify))
   }
-
-  return stringify
 }