functionalscript 0.0.343 → 0.0.350

package/.github/workflows/node.js.yml

@@ -25,3 +25,5 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm install
     - run: npm test
+    - run: npm run version
+    - run: npm pack

package/.github/workflows/npm-publish.yml

@@ -30,7 +30,7 @@ jobs:
           node-version: 14
           registry-url: https://registry.npmjs.org/
       - run: npm ci
-      - run: node ./io/nodejs/version
+      - run: npm run version
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/LANGUAGE.md

@@ -206,3 +206,43 @@ const f = () => x // < invalid
 ### 9.7. Block
 
 [Block](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/block)
+
+## 10. Generators
+
+For compatibility reason, FunctionalScript allows to create generators as implementation of `[Symbol.iterator]` function. However, it doesn't allow to read the `[Symbol.iterator]` property. For example
+
+This code is allowed
+
+```js
+/** @type {<T>(list: List<T>) => Iterable<T>} */
+const iterable = list => ({
+    *[Symbol.iterator]() {
+        let i = list
+        while (true) {
+            const r = next(i)
+            if (r === undefined) { return }
+            yield r.first
+            i = r.tail
+        }
+    }
+})
+```
+
+The following code is not allowed, because `iterator` is a mutated object by design in JavaScript.
+
+```js
+const it = [0, 1, 2][Symbol.iterator] //< compilation error.
+```
+
+Use `Iterable` instead of `Iterator`.
+
+```js
+const x = () => {
+    const a = [0, 1, 2] // iterable
+    let sum = 0;
+    for (let i in a) {
+        sum = sum + i
+    }
+    return sum;
+}
+```

package/commonjs/README.md

@@ -1,8 +1,10 @@
 # Common.js
 
-```ts
-// package/index.js
+## Package
+
+[package/index.js](package/index.js)
 
+```ts
 // A dictionary of packages.
 //
 // A package contains a dictionary of dependencies and a dictionary of files.
@@ -25,9 +27,13 @@ type Package = {
     // returns source of the file.
     readonly file: (localFileId: string) => string | undefined
 }
+```
 
-// module/index.js
+## Module
 
+[module/index.js](module/index.js)
+
+```ts
 // A module map is a dictionary of modules.
 //
 // A module is a compiled and initialized source file.
@@ -62,9 +68,13 @@ type ModuleId = {
 }
 
 const moduleIdToString: (moduleId: ModuleId) => string;
+```
 
-// build/index.js
+## Build
 
+[build/index.js](build/index.js)
+
+```ts
 type BuildConfig<M> = {
     readonly packageGet: PackageGet
     readonly moduleMapInterface: ModuleMapInterface<M>
@@ -81,8 +91,4 @@ type BuildState<M> = {
 }
 
 const getOrBuild: <M>(buildConfig: BuildConfig<M>) => readonly[ModuleState, M];
-
-//
-
-
 ```

package/commonjs/build/{index.js → main.f.js}

@@ -1,10 +1,10 @@
-const package_ = require('../package/index.js')
-const module_ = require('../module/index.js')
-const function_ = require('../module/function/index.js')
-const map = require('../../types/map/index.js')
-const object = require('../../types/object/index.js')
-const path = require('../path/index.js')
-const stringSet = require('../../types/stringSet/index.js')
+const package_ = require('../package/main.f.js')
+const module_ = require('../module/main.f.js')
+const function_ = require('../module/function/main.f.js')
+const map = require('../../types/map/main.f.js')
+const object = require('../../types/object/main.f.js')
+const path = require('../path/main.f.js')
+const stringSet = require('../../types/stringset/main.f.js')
 
 /**
  * @template M
@@ -36,7 +36,13 @@ const notFound = moduleMap => [['error', ['file not found']], moduleMap]
 const getOrBuild = compile => packageGet => moduleMapInterface =>  {
     /** @typedef {typeof moduleMapInterface extends module_.MapInterface<infer M> ? M : never} M */
 
-    /** @type {(buildSet: stringSet.StringSet) => (moduleId: module_.Id) => (source: string) => (moduleMap: M) => Result<M>} */
+    /**
+     * @type {(buildSet: stringSet.StringSet) =>
+     *  (moduleId: module_.Id) =>
+     *  (source: string) =>
+     *  (moduleMap: M) =>
+     *  Result<M>}
+     */
     const build = buildSet => moduleId => {
         const moduleIdStr = module_.idToString(moduleId)
         const buildSet1 = stringSet.set(moduleIdStr)(buildSet)

package/commonjs/build/{test.js → test.f.js}

@@ -1,9 +1,9 @@
-const _ = require('./index.js')
-const map = require('../../types/map/index.js')
-const module_ = require('../module/index.js')
-const function_ = require('../module/function/index.js')
-const result = require('../../types/result/index.js')
-const package_ = require('../package/index.js')
+const _ = require('./main.f.js')
+const map = require('../../types/map/main.f.js')
+const module_ = require('../module/main.f.js')
+const function_ = require('../module/function/main.f.js')
+const result = require('../../types/result/main.f.js')
+const package_ = require('../package/main.f.js')
 
 /** @type {{ readonly [k in string]?: result.Result<function_.Function_, unknown> }} */
 const compileMap = {

package/commonjs/main.f.js

@@ -0,0 +1,20 @@
+/** @typedef {(packageName: string) => PackageMap|Package|undefined} PackageMap */
+
+/** 
+ * @typedef {readonly[
+ *  string, 
+ *  PackageMap, 
+ *  (fileName: string) => string|undefined
+ * ]} Package 
+ */
+
+module.exports = {
+    /** @readonly */
+    build: require('./build/main.f.js'),
+    /** @readonly */
+    module: require('./module/main.f.js'),
+    /** @readonly */
+    package: require('./package/main.f.js'),
+    /** @readonly */
+    path: require('./path/main.f.js'),
+}

package/commonjs/module/function/{index.js → main.f.js}

@@ -2,7 +2,7 @@
  * An IO interface for creating and running module functions.
  */
 
-const result = require('../../../types/result/index.js')
+const result = require('../../../types/result/main.f.js')
 
 /** @typedef {<M>(require: Require<M>) => (prior: M) => Result<M>} Function_ */
 

package/commonjs/module/{index.js → main.f.js}

@@ -1,4 +1,4 @@
-const object = require('../../types/object/index.js')
+const object = require('../../types/object/main.f.js')
 
 /**
  * @template M
@@ -52,6 +52,8 @@ const dir = id => {
 const idToString = id => `${id.package}/${id.path.join('/')}`
 
 module.exports = {
+    /** @readonly */
+    function: require('./function/main.f.js'),
     /** @readonly */
     dir,
     /** @readonly */

package/commonjs/package/dependencies/{index.js → main.f.js}

@@ -1,5 +1,5 @@
-const json = require('../../../json/index.js')
-const seq = require('../../../types/list/index.js')
+const json = require('../../../json/main.f.js')
+const list = require('../../../types/list/main.f.js')
 
 /** @typedef {readonly[string, string]} DependencyJson */
 
@@ -14,7 +14,7 @@ const isDependencyJson = ([, v]) => typeof v === 'string'
 const isDependenciesJson = j => {
     if (j === undefined) { return true }
     if (!json.isObject(j)) { return false }
-    return seq.every(seq.map(isDependencyJson)(Object.entries(j)))
+    return list.every(list.map(isDependencyJson)(Object.entries(j)))
 }
 
 module.exports = {

package/commonjs/package/dependencies/{test.js → test.f.js}

@@ -1,4 +1,4 @@
-const _ = require('./index.js')
+const _ = require('./main.f.js')
 
 {
     if (!_.isDependenciesJson(undefined)) { throw 'error' }

package/commonjs/package/{index.js → main.f.js}

@@ -1,5 +1,5 @@
-const json = require('../../json/index.js')
-const dependencies = require('./dependencies/index.js')
+const json = require('../../json/main.f.js')
+const dependencies = require('./dependencies/main.f.js')
 
 /**
  * @typedef {{
@@ -25,9 +25,14 @@ const isPackageJson = j => {
  * }} Package
  */
 
-/** @typedef {(packageId: string) => Package | undefined} Get */
+/**
+ * @note Current package has an empty string '' as a packageId.
+ * @typedef {(packageId: string) => Package | undefined} Get
+ */
 
 module.exports = {
+    /** @readonly */
+    dependencies,
     /** @readonly */
     isPackageJson,
 }

package/commonjs/package/{test.js → test.f.js}

@@ -1,6 +1,6 @@
-const _ = require('./index.js')
+const _ = require('./main.f.js')
 
-require('./dependencies/test.js')
+require('./dependencies/test.f.js')
 
 {
     if (_.isPackageJson(null)) { throw 'error' }

package/commonjs/path/{index.js → main.f.js}

@@ -1,6 +1,6 @@
-const list = require("../../types/list/index.js")
-const package_ = require("../package/index.js")
-const module_ = require("../module/index.js")
+const list = require("../../types/list/main.f.js")
+const package_ = require("../package/main.f.js")
+const module_ = require("../module/main.f.js")
 
 /** @typedef {readonly string[]} Items */
 

package/commonjs/path/{test.js → test.f.js}

@@ -1,10 +1,10 @@
-const _ = require('./index.js')
-const { todo } = require('../../dev/index.js')
-const json = require('../../json/index.js')
-const { identity } = require('../../types/function/index.js')
-const object = require('../../types/object/index.js')
-const { at } = require('../../types/object/index.js')
-const package_ = require('../package/index.js')
+const _ = require('./main.f.js')
+const { todo } = require('../../dev/main.f.js')
+const json = require('../../json/main.f.js')
+const { identity } = require('../../types/function/main.f.js')
+const object = require('../../types/object/main.f.js')
+const { at } = require('../../types/object/main.f.js')
+const package_ = require('../package/main.f.js')
 
 /** @type {(g: json.Unknown|undefined) => string} */
 const stringify = g => {

package/html/{index.js → main.f.js}

@@ -1,7 +1,6 @@
-const list = require('../types/list/index.js')
-const object = require('../types/object/index.js')
-const operator = require('../types/function/operator/index.js')
-const { compose } = require('../types/function/index.js')
+const list = require('../types/list/main.f.js')
+const object = require('../types/object/main.f.js')
+const { operator, compose } = require('../types/function/main.f.js')
 
 /**
  * @typedef {|

package/html/{test.js → test.f.js}

@@ -1,4 +1,4 @@
-const _ = require('./index.js')
+const _ = require('./main.f.js')
 
 {
     const r = _.htmlToString(['html', []])

package/io/commonjs/{index.js → main.js}

@@ -1,6 +1,6 @@
-const { tryCatch } = require('../result/index.js')
-const { unwrap } = require('../../types/result/index.js')
-const moduleFunction = require('../../commonjs/module/function/index.js')
+const { tryCatch } = require('../result/main.js')
+const { unwrap } = require('../../types/result/main.f.js')
+const moduleFunction = require('../../commonjs/module/function/main.f.js')
 
 /** @type {(f: Function) => moduleFunction.Function_} */
 const build = f => immutableRequire => mutableData => {

package/io/commonjs/test.js

@@ -1,5 +1,5 @@
-const _ = require('./index.js')
-const run = require('../../commonjs/module/function/index.js')
+const _ = require('./main.js')
+const run = require('../../commonjs/module/function/main.f.js')
 
 // ok:
 {

package/io/result/{index.js → main.js}

@@ -1,4 +1,4 @@
-const result = require('../../types/result/index.js')
+const result = require('../../types/result/main.f.js')
 
 /** @type {<T>(f: () => T) => result.Result<T, unknown>} */
 const tryCatch = f => {

package/json/{index.js → main.f.js}

@@ -1,7 +1,7 @@
-const seq = require('../types/list/index.js')
-const object = require('../types/object/index.js')
-const op = require('../types/function/operator/index.js')
-const { compose } = require('../types/function/index.js')
+const list = require('../types/list/main.f.js')
+const object = require('../types/object/main.f.js')
+const operator = require('../types/function/operator/main.f.js')
+const { compose } = require('../types/function/main.f.js')
 
 /**
  * @typedef {{
@@ -13,11 +13,11 @@ const { compose } = require('../types/function/index.js')
 
 /** @typedef {Object|boolean|string|number|null|Array} Unknown */
 
-/** @type {(value: Unknown) => (path: seq.List<string>) => (src: Unknown|undefined) => Unknown} */
+/** @type {(value: Unknown) => (path: list.List<string>) => (src: Unknown|undefined) => Unknown} */
 const setProperty = value => {
-    /** @type {(path: seq.List<string>) => (src: Unknown|undefined) => Unknown} */
+    /** @type {(path: list.List<string>) => (src: Unknown|undefined) => Unknown} */
     const f = path => src => {
-        const result = seq.next(path)
+        const result = list.next(path)
         if (result === undefined) { return value }
         const srcObject = (src === undefined || src === null || typeof src !== 'object' || src instanceof Array) ? {} : src
         const { first, tail } = result
@@ -26,10 +26,10 @@ const setProperty = value => {
     return f
 }
 
-/** @type {(_: string) => seq.List<string>} */
+/** @type {(_: string) => list.List<string>} */
 const stringSerialize = input => [JSON.stringify(input)]
 
-/** @type {(_: number) => seq.List<string>} */
+/** @type {(_: number) => list.List<string>} */
 const numberSerialize = input => [JSON.stringify(input)]
 
 const nullSerialize = ['null']
@@ -38,46 +38,46 @@ const trueSerialize = ['true']
 
 const falseSerialize = ['false']
 
-/** @type {(_: boolean) => seq.List<string>} */
+/** @type {(_: boolean) => list.List<string>} */
 const boolSerialize = value => value ? trueSerialize : falseSerialize
 
 const colon = [':']
 const comma = [',']
 
-/** @type {op.Fold<seq.List<string>>} */
-const joinOp = b => prior => seq.flat([prior, comma, b])
+/** @type {operator.Fold<list.List<string>>} */
+const joinOp = b => prior => list.flat([prior, comma, b])
 
-/** @type {(input: seq.List<seq.List<string>>) => seq.List<string>} */
-const join = seq.fold(joinOp)([])
+/** @type {(input: list.List<list.List<string>>) => list.List<string>} */
+const join = list.fold(joinOp)([])
 
-/** @type {(open: string) => (close: string) => (input: seq.List<seq.List<string>>) => seq.List<string>} */
-const list = open => close => {
+/** @type {(open: string) => (close: string) => (input: list.List<list.List<string>>) => list.List<string>} */
+const wrap = open => close => {
     const seqOpen = [open]
     const seqClose = [close]
-    return input => seq.flat([seqOpen, join(input), seqClose])
+    return input => list.flat([seqOpen, join(input), seqClose])
 }
 
-const objectList = list('{')('}')
+const objectWrap = wrap('{')('}')
 
-const arrayList = list('[')(']')
+const arrayWrap = wrap('[')(']')
 
 /** @typedef {object.Entry<Unknown>} Entry*/
 
-/** @typedef {(seq.List<Entry>)} Entries */
+/** @typedef {(list.List<Entry>)} Entries */
 
 /** @typedef {(entries: Entries) => Entries} MapEntries */
 
-/** @type {(mapEntries: MapEntries) => (value: Unknown) => seq.List<string>} */
+/** @type {(mapEntries: MapEntries) => (value: Unknown) => list.List<string>} */
 const serialize = sort => {
-    /** @type {(kv: readonly[string, Unknown]) => seq.List<string>} */
-    const propertySerialize = ([k, v]) => seq.flat([
+    /** @type {(kv: readonly[string, Unknown]) => list.List<string>} */
+    const propertySerialize = ([k, v]) => list.flat([
         stringSerialize(k),
         colon,
         f(v)
     ])
-    /** @type {(object: Object) => seq.List<string>} */
-    const objectSerialize = input => objectList(seq.map(propertySerialize)(sort(Object.entries(input))))
-    /** @type {(value: Unknown) => seq.List<string>} */
+    /** @type {(object: Object) => list.List<string>} */
+    const objectSerialize = input => objectWrap(list.map(propertySerialize)(sort(Object.entries(input))))
+    /** @type {(value: Unknown) => list.List<string>} */
     const f = value => {
         switch (typeof value) {
             case 'boolean': { return boolSerialize(value) }
@@ -90,8 +90,8 @@ const serialize = sort => {
             }
         }
     }
-    /** @type {(input: Array) => seq.List<string>} */
-    const arraySerialize = compose(seq.map(f))(arrayList)
+    /** @type {(input: Array) => list.List<string>} */
+    const arraySerialize = compose(list.map(f))(arrayWrap)
     return f
 }
 
@@ -101,7 +101,7 @@ const serialize = sort => {
  *
  * @type {(mapEntries: MapEntries) => (value: Unknown) => string}
  */
-const stringify = sort => compose(serialize(sort))(seq.join(''))
+const stringify = sort => compose(serialize(sort))(list.join(''))
 
 /** @type {(value: string) => Unknown} */
 const parse = JSON.parse
@@ -110,6 +110,8 @@ const parse = JSON.parse
 const isObject = value => typeof value === 'object' && value !== null && !(value instanceof Array)
 
 module.exports = {
+    /** @readonly */
+    tokenizer: require('./tokenizer/main.f.js'),
     /** @readonly */
     setProperty,
     /** @readonly */

package/json/{test.js → test.f.js}

@@ -1,6 +1,6 @@
-const json = require('./index.js')
-const { sort } = require('../types/object/index.js')
-const { identity } = require('../types/function/index.js')
+const json = require('./main.f.js')
+const { sort } = require('../types/object/main.f.js')
+const { identity } = require('../types/function/main.f.js')
 
 if (json.setProperty("Hello")([])({}) !== "Hello") { throw 'error' }
 

package/json/tokenizer/{index.js → main.f.js}

@@ -1,6 +1,6 @@
-const operator = require('../../types/function/operator/index.js')
-const list = require('../../types/list/index.js')
-const range = require('../../types/range/index.js')
+const operator = require('../../types/function/operator/main.f.js')
+const list = require('../../types/list/main.f.js')
+const range = require('../../types/range/main.f.js')
 
 /**
  * @typedef {{

package/json/tokenizer/{test.js → test.f.js}

@@ -1,7 +1,7 @@
-const tokenizer = require('./index.js')
-const list = require('../../types/list/index.js')
-const json = require('../index.js')
-const { sort } = require('../../types/object/index.js')
+const tokenizer = require('./main.f.js')
+const list = require('../../types/list/main.f.js')
+const json = require('../main.f.js')
+const { sort } = require('../../types/object/main.f.js')
 
 /** @type {(s: string) => readonly tokenizer.JsonToken[]} */
 const tokenizeString = s => list.toArray(tokenizer.tokenize(list.toCharCodes(s)))

package/main.f.js

@@ -0,0 +1,14 @@
+module.exports = {
+    /** @readonly */
+    commonjs: require('./commonjs/main.f.js'),
+    /** @readonly */
+    dev: require('./dev/main.f.js'),
+    /** @readonly */
+    html: require('./html/main.f.js'),
+    /** @readonly */
+    json: require('./json/main.f.js'),
+    /** @readonly */
+    sha2: require('./sha2/main.f.js'),
+    /** @readonly */
+    types: require('./types/main.f.js'),
+}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "functionalscript",
-  "version": "0.0.343",
+  "version": "0.0.350",
   "description": "FunctionalScript is a functional subset of JavaScript",
-  "main": "index.js",
+  "main": "main.f.js",
   "scripts": {
     "tsc": "tsc",
     "test": "tsc && npm run test-only",
-    "test-only": "node --trace-uncaught ./test"
+    "version": "node ./io/nodejs/version/main.js",
+    "test-only": "node --trace-uncaught ./test.f.js"
   },
   "repository": {
     "type": "git",
@@ -28,7 +29,7 @@
   },
   "homepage": "https://github.com/functionalscript/functionalscript#readme",
   "devDependencies": {
-    "@types/node": "^17.0.35",
-    "typescript": "^4.7.2"
+    "@types/node": "^18.0.0",
+    "typescript": "^4.7.4"
   }
 }

package/sha2/{index.js → main.f.js}

@@ -1,4 +1,4 @@
-const array = require('../types/array/index.js')
+const array = require('../types/array/main.f.js')
 
 /**
  * @typedef {{

package/sha2/{test.js → test.f.js}

@@ -1,7 +1,7 @@
-const _ = require('./index.js')
-const json = require('../json/index.js')
-const { sort } = require('../types/object/index.js')
-const list = require('../types/list/index.js')
+const _ = require('./main.f.js')
+const json = require('../json/main.f.js')
+const { sort } = require('../types/object/main.f.js')
+const list = require('../types/list/main.f.js')
 
 /** @type {(a: number) => number} */
 const toU32 = x => (x + 0x1_0000_0000) % 0x1_0000_0000