functionalscript 0.0.264 → 0.0.268

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

@@ -5,7 +5,6 @@ name: Node.js CI
 
 on:
   push:
-  pull_request:
 
 jobs:
   build:

package/README.md

@@ -39,11 +39,11 @@ The prefered way to refence dependencies is to use a GitHub URL. These dependenc
 
 ```json
 {
-   ...
+   // ...
    "dependencies": {
       "third-party-package": "github:exampleorg/thirdpartypackage"
    }
-   ...
+   // ...
 }
 ```
 
@@ -82,7 +82,13 @@ module.exports = {
 // 1. references
 const first = require('./first.js')
 
+// 2. definitions
 const _42plus7 = first.add42(7)
+
+// 3. exports
+module.exports = {
+   _42plus7,
+}
 ```
 
 ### 2.4. References To Other Modules

package/commonjs/README.md

@@ -52,4 +52,8 @@ type BuildState<M> = {
 }
 
 const getOrBuild: <M>(buildConfig: BuildConfig<M>) => readonly[ModuleState, M];
+
+//
+
+
 ```

package/commonjs/build/index.js

@@ -0,0 +1,99 @@
+const package_ = require('../package')
+const module_ = require('../module')
+const function_ = require('../module/function')
+const { todo } = require('../../dev')
+const map = require('../../types/map')
+const object = require('../../types/object')
+const list = require('../../types/list')
+
+/**
+ * @template M
+ * @typedef {{
+ *  readonly pagkageGet: package_.Get
+ *  readonly moduleMapInterface: module_.MapInterface<M>
+ *  readonly moduleId: module_.Id
+ *  readonly moduleMap: M
+ * }} Config
+ */
+
+/**
+ * @template M
+ * @typedef {readonly[module_.State, M]} Result
+ */
+
+/** @type {<M>(moduleMap: M) => Result<M>} */
+const notFound = moduleMap => [['error', ['file not found']], moduleMap]
+
+/**
+ * @type {(packageGet: package_.Get) =>
+ *  <M>(moduleMapInterface: module_.MapInterface<M>) =>
+ *  (compile: function_.Compile) =>
+ *  (moduleId: module_.Id) =>
+ *  (moduleMapFirst: M) =>
+ *  Result<M>
+ * }
+ */
+const getOrBuild = packageGet => moduleMapInterface => compile => moduleId => {
+
+    /** @typedef {typeof moduleMapInterface extends module_.MapInterface<infer M> ? M : never} M */
+
+    const moduleIdStr = module_.idToString(moduleId)
+
+    /** @type {(e: module_.Error) => (moduleMap: M) => Result<M>} */
+    const error = e => moduleMap => {
+        /** @type {module_.State} */
+        const state = ['error', e]
+        return [state, moduleMapInterface.insert(moduleIdStr)(state)(moduleMap)]
+    }
+
+    /** @type {function_.Require<readonly[M, map.Map<string>]>} */
+    const require_ = path => ([moduleMap, requireMap]) => {
+        return todo()
+    }
+
+    return moduleMapFirst => {
+        let moduleMap = moduleMapFirst
+
+        {
+            const m = moduleMapInterface.at(moduleIdStr)(moduleMap)
+            if (m !== undefined) { return [m, moduleMap] }
+        }
+
+        const p = packageGet(moduleId.packageId)
+        if (p === undefined) { return notFound(moduleMap) }
+
+        const source = p.file(moduleId.path.join('/'))
+        if (source === undefined) { return notFound(moduleMap) }
+
+        const compileResult = compile(source)
+        if (compileResult[0] === 'error') { return error(['compilation error', compileResult[1]])(moduleMap) }
+
+        const moduleFunction = compileResult[1]
+
+        moduleMap = moduleMapInterface.insert(moduleIdStr)(['building'])(moduleMap)
+
+        const [[type, exportsOrError], [newModuleMap, requireMap]] = moduleFunction(require_)([moduleMap, map.empty])
+        moduleMap = newModuleMap
+
+        {
+            const m = moduleMapInterface.at(moduleIdStr)(moduleMap)
+            if (m === undefined ) { throw 'm === undefined' }
+            if (m[0] !== 'building') { return [m, moduleMap] }
+        }
+
+        /** @type {module_.State} */
+        const result = type === 'error' ?
+            ['error', ['runtime error', exportsOrError]] :
+            ['ok', {
+                exports: exportsOrError,
+                requireMap: object.fromMap(requireMap)
+            }]
+
+        return [result, moduleMapInterface.insert(moduleIdStr)(result)(moduleMap)]
+    }
+}
+
+module.exports = {
+    /** @readonly */
+    getOrBuild,
+}

package/commonjs/module/function/index.js

@@ -0,0 +1,21 @@
+/**
+ * An IO interface for creating and running module functions.
+ */
+
+const result = require('../../../types/result')
+
+/** @typedef {<M>(require: Require<M>) => (prior: M) => Result<M>} Function_ */
+
+/**
+ * @template M
+ * @typedef {readonly[result.Result<unknown, unknown>, M]} Result
+ */
+
+/**
+ * @template M
+ * @typedef {(path: string) => (prior: M) => Result<M>} Require
+ */
+
+/** @typedef {(source: string) => result.Result<Function_, unknown>} Compile */
+
+module.exports = {}

package/commonjs/module/index.js

@@ -3,17 +3,17 @@ const object = require('../../types/object')
 /**
  * @template M
  * @typedef {{
- *  readonly at: (moduleId: string) => (moduleMap: M) => ModuleState | undefined
- *  readonly insert: (moduleId: string) => (moduleState: ModuleState) => (moduleMap: M) => M
- * }} ModuleMapInterface
+ *  readonly at: (moduleId: string) => (moduleMap: M) => State | undefined
+ *  readonly insert: (moduleId: string) => (moduleState: State) => (moduleMap: M) => M
+ * }} MapInterface
  */
 
-/** 
+/**
  * @typedef {|
- *  readonly['ok', Module] | 
- *  readonly['error', ModuleError] | 
+ *  readonly['ok', Module] |
+ *  readonly['error', Error] |
  *  readonly['building']
- * } ModuleState 
+ * } State
  */
 
 /**
@@ -23,13 +23,26 @@ const object = require('../../types/object')
  * }} Module
  */
 
-/** 
+/**
  * @typedef {|
- *  'file not found' | 
- *  'compile error' | 
- *  'runtime error' | 
- *  'circular reference'
- * } ModuleError
+ *  ['file not found'] |
+ *  ['compilation error', unknown] |
+ *  ['runtime error', unknown] |
+ *  ['circular reference']
+ * } Error
  */
 
-module.exports = {}
+/**
+ * @typedef {{
+ *  readonly packageId: string
+ *  readonly path: readonly string[]
+ * }} Id
+ */
+
+/** @type {(id: Id) => string} */
+const idToString = ({ packageId, path }) => `${packageId}/${path.join('/')}`
+
+module.exports = {
+    /** @readonly */
+    idToString,
+}

package/commonjs/package/index.js

@@ -1,13 +1,11 @@
 const json = require('../../json')
-const dep = require('./dependencies')
-const object = require('../../types/object')
-const run = require('../run')
+const dependencies = require('./dependencies')
 
 /** 
  * @typedef {{
  *  readonly name: string
  *  readonly version: string
- *  readonly dependencies?: dep.DependenciesJson
+ *  readonly dependencies?: dependencies.DependenciesJson
  * }} PackageJson 
  */
 
@@ -16,7 +14,7 @@ const isPackageJson = j => {
     if (!json.isObject(j)) { return false }
     if (typeof j.name !== 'string') { return false }
     if (typeof j.version !== 'string') { return false }
-    if (!dep.isDependenciesJson(j.dependencies)) { return false }
+    if (!dependencies.isDependenciesJson(j.dependencies)) { return false }
     return true
 }
 
@@ -27,7 +25,7 @@ const isPackageJson = j => {
  * }} Package
  */
 
-/** @typedef {(packageId: string) => Package | undefined} PackageGet */
+/** @typedef {(packageId: string) => Package | undefined} Get */
 
 module.exports = {
     /** @readonly */

package/commonjs/path/index.js

@@ -7,12 +7,12 @@ const { at } = require("../../types/object")
 
 /** @typedef {readonly string[]} Items */
 
-/** 
+/**
  * @typedef {{
  *  readonly external: boolean
  *  readonly dir: boolean
  *  readonly items: Items
- * }} LocalPath 
+ * }} LocalPath
  */
 
 /** @type {(path: string) => readonly string[]} */
@@ -74,9 +74,9 @@ const variants = prior => () => {
     return { first: n, tail: variants(n) }
 }
 
-/** @type {(d: dep.DependencyMapJson) => (p: IdPath) => IdPath|undefined} */
+/** @type {(d: (local: string) => string|undefined) => (p: IdPath) => IdPath|undefined} */
 const mapDependency = d => ([external, internal]) => {
-    const id = at(external)(d)
+    const id = d(external)
     return id === undefined ? undefined : [id, internal]
 }
 
@@ -88,16 +88,21 @@ const mapDependency = d => ([external, internal]) => {
  * }} Path
  */
 
-/** @type {(d: dep.DependenciesJson) => (dir: boolean) => (items: seq.List<string>) => Path|undefined} */
+/** @type {(d: (local: string) => string|undefined) => (dir: boolean) => (items: seq.List<string>) => Path|undefined} */
 const parseGlobal = d => dir => items => {
-    if (d === undefined) { return undefined }
     const v = variants([undefined, items])
     const r = seq.first(undefined)(seq.filterMap(mapDependency(d))(v))
     if (r === undefined) { return undefined }
     return { name: r[0], items: seq.toArray(r[1]), dir }
 }
 
-/** @type {(name: string) => (dependencies: dep.DependenciesJson) => (local: string) => (path: string) => Path|undefined } */
+/**
+ * @type {(name: string) =>
+ *  (dependencies: (local: string) => string|undefined) =>
+ *  (local: string) =>
+ *  (path: string) =>
+ *  Path|undefined }
+ */
 const parse = name => dependencies => local => path => {
     const parsed = parseLocal(local)(path)
     if (parsed === undefined) { return undefined }

package/commonjs/path/test.js

@@ -1,6 +1,7 @@
 const _ = require('.')
 const json = require('../../json')
 const { identity } = require('../../types/function')
+const { at } = require('../../types/object')
 
 /** @type {(g: json.Unknown|undefined) => string} */
 const stringify = g => {
@@ -45,20 +46,20 @@ const stringify = g => {
 }
 
 {
-    if (_.parseGlobal(undefined)(false)(['a', 'b']) !== undefined) { throw 'error' }
-    if (_.parseGlobal({})(false)(['b']) !== undefined) { throw 'error' }
-    if (_.parseGlobal({ b: 'x' })(false)(['d']) !== undefined) { throw 'error' }
+    if (_.parseGlobal(() => undefined)(false)(['a', 'b']) !== undefined) { throw 'error' }
+    if (_.parseGlobal(() => undefined)(false)(['b']) !== undefined) { throw 'error' }
+    if (_.parseGlobal(d => at(d)({ b: 'x' }))(false)(['d']) !== undefined) { throw 'error' }
     {
-        const result = stringify(_.parseGlobal({ b: 'x' })(false)(['b']))
+        const result = stringify(_.parseGlobal(d => at(d)({ b: 'x' }))(false)(['b']))
         if (result !== '["x",""]') { throw result }
     }
-    if (_.parseGlobal({ 'b/r': 'x' })(false)(['b']) !== undefined) { throw 'error' }
+    if (_.parseGlobal(d => at(d)({ 'b/r': 'x' }))(false)(['b']) !== undefined) { throw 'error' }
     {
-        const result = stringify(_.parseGlobal({ 'b/r': 'x' })(false)(['b', 'r']))
+        const result = stringify(_.parseGlobal(d => at(d)({ 'b/r': 'x' }))(false)(['b', 'r']))
         if (result !== '["x",""]') { throw result }
     }
     {
-        const result = stringify(_.parseGlobal({ 'b/r': 'x' })(false)(['b', 'r', 'd', 't']))
+        const result = stringify(_.parseGlobal(d => at(d)({ 'b/r': 'x' }))(false)(['b', 'r', 'd', 't']))
         if (result !== '["x","d/t"]') { throw result }
     }
 }

package/io/commonjs/index.js

@@ -1,12 +1,14 @@
 const { tryCatch } = require('../result')
 const { unwrap } = require('../../types/result')
-const run = require('../../commonjs/run')
+const moduleFunction = require('../../commonjs/module/function')
 
-/** @type {(f: Function) => run.Module} */
+/** @type {(f: Function) => moduleFunction.Function_} */
 const build = f => immutableRequire => mutableData => {
     /** @type {(path: string) => unknown} */
     const mutableRequire = path => {
         const [result, data] = immutableRequire(path)(mutableData)
+        // Side effect: setting a variable from a nested function (closure)
+        // is not allowed in FunctionalScript.
         mutableData = data
         return unwrap(result)
     }
@@ -18,8 +20,9 @@ const build = f => immutableRequire => mutableData => {
     return [result, mutableData]
 }
 
-/** @type {run.Compile} */
-const compile = source => 
+/** @type {moduleFunction.Compile} */
+const compile = source =>
+    // Side effect: a `Function` constructor is not allowed in FunctionalScript.
     tryCatch(() => build(Function('module', 'require', `"use strict";${source}`)))
 
 module.exports = {

package/io/commonjs/test.js

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

package/io/result/index.js

@@ -2,6 +2,7 @@ const result = require('../../types/result')
 
 /** @type {<T>(f: () => T) => result.Result<T, unknown>} */
 const tryCatch = f => {
+    // Side effect: `try catch` is not allowed in FunctionalScript.
     try {
         return result.ok(f())
     } catch (e) {
@@ -12,4 +13,4 @@ const tryCatch = f => {
 module.exports = {
     /** @readonly */
     tryCatch,
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "functionalscript",
-  "version": "0.0.264",
+  "version": "0.0.268",
   "description": "FunctionalScript is a functional subset of JavaScript",
   "main": "index.js",
   "scripts": {
@@ -19,7 +19,9 @@
     "functional-programming",
     "closure",
     "pure-functional",
-    "typescript"
+    "typescript",
+    "programming-language",
+    "lazy-evaluation"
   ],
   "bugs": {
     "url": "https://github.com/functionalscript/functionalscript/issues"

package/types/btree/index.js

@@ -36,8 +36,8 @@ const seq = require('../list')
 //
 
 /**
- * @template T 
- * @typedef {Array1<T>} Leaf1 
+ * @template T
+ * @typedef {Array1<T>} Leaf1
  */
 
 /**
@@ -62,9 +62,9 @@ const seq = require('../list')
 
 /** @typedef {readonly['done']} NotFoundDone */
 
-/** 
+/**
  * @template T
- * @typedef {readonly['done', T]} FoundDone 
+ * @typedef {readonly['done', T]} FoundDone
  */
 
 /**
@@ -92,7 +92,7 @@ const seq = require('../list')
 /** @typedef {<T>(_: Lazy<T>) => (_: Branch3<T>) => Result<T>} InBranch3 */
 /** @typedef {<T>(_: Lazy<T>) => (_: Branch5<T>) => Result<T>} InBranch5 */
 
-/** 
+/**
  * @typedef {{
  *  readonly leaf1: InLeaf1
  *  readonly leaf2_left: InLeaf2
@@ -113,7 +113,7 @@ const seq = require('../list')
  * }} NotFound
  */
 
-/** 
+/**
  * @typedef {{
  *  readonly found: Found
  *  readonly notFound: NotFound
@@ -128,11 +128,11 @@ const seq = require('../list')
 /** @type {<T>(n: Branch7<T>) => Branch3<T>} */
 const split = ([n0, v1, n2, v3, n4, v5, n6]) => [[n0, v1, n2], v3, [n4, v5, n6]]
 
-/** 
- * @type {<T>(extend: (o: Branch3<T>) => Result<T>) => 
- *  (replace: (r: Node<T>) => Node<T>) => 
- *  (result: Result<T>) => 
- *  Result<T>} 
+/**
+ * @type {<T>(extend: (o: Branch3<T>) => Result<T>) =>
+ *  (replace: (r: Node<T>) => Node<T>) =>
+ *  (result: Result<T>) =>
+ *  Result<T>}
  */
 const merge = extend => replace => result => {
     switch (result[0]) {
@@ -147,17 +147,17 @@ const visit = ({ found, notFound }) => cmp => {
     const i3 = index3(cmp)
     const i5 = index5(cmp)
     /** @typedef {typeof cmp extends Cmp<infer T> ? T : never} T */
-    /** 
-     * @type {(extend: (o: Branch3<T>) => Branch5<T>) => 
-     *  (replace: (r: Node<T>) => Branch3<T>) => 
-     *  (result: Result<T>) => 
-     *  Result<T>} 
+    /**
+     * @type {(extend: (o: Branch3<T>) => Branch5<T>) =>
+     *  (replace: (r: Node<T>) => Branch3<T>) =>
+     *  (result: Result<T>) =>
+     *  Result<T>}
      */
     const merge2 = extend => merge(o => ['replace', extend(o)])
-    /** 
-     * @type {(extend: (o: Branch3<T>) => Branch7<T>) => 
-     *  (replace: (r: Node<T>) => Branch5<T>) => 
-     *  (result: Result<T>) => 
+    /**
+     * @type {(extend: (o: Branch3<T>) => Branch7<T>) =>
+     *  (replace: (r: Node<T>) => Branch5<T>) =>
+     *  (result: Result<T>) =>
      *  Result<T>}
      */
     const merge3 = extend => merge(o => ['overflow', split(extend(o))])
@@ -305,34 +305,31 @@ const replaceVisitor = {
 
 /** @type {<T>(node: Node<T>) => seq.List<T>} */
 const values = node => () => {
-    const f = () => {
-        switch (node.length) {
-            case 1: case 2: { return node }
-            case 3: { 
-                return seq.flat([
-                    values(node[0]), 
-                    [node[1]], 
-                    values(node[2])
-                ])
-            }
-            default: {
-                return seq.flat([
-                    values(node[0]),
-                    [node[1]],
-                    values(node[2]),
-                    [node[3]],
-                    values(node[4])
-                ])
-            }
+    switch (node.length) {
+        case 1: case 2: { return node }
+        case 3: {
+            return seq.flat([
+                values(node[0]),
+                [node[1]],
+                values(node[2])
+            ])
+        }
+        default: {
+            return seq.flat([
+                values(node[0]),
+                [node[1]],
+                values(node[2]),
+                [node[3]],
+                values(node[4])
+            ])
         }
     }
-    return seq.next(f())
 }
 
 module.exports = {
     /** @readonly */
     values,
-    /** 
+    /**
      * @readonly
      * @type { <T>(cmp: Cmp<T>) => (node: Node<T>) => T|undefined }
      */

package/types/map/index.js

@@ -3,13 +3,13 @@ const btree = require('../btree')
 const { getVisitor, setVisitor, values } = require("../btree")
 const compare = require("../function/compare")
 const { cmp } = require("../function/compare")
-const seq = require("../list")
+const list = require("../list")
 
 /** @typedef {compare.Sign} Sign */
 
 /**
- * @template T 
- * @typedef {btree.Leaf1<T>} Leaf1 
+ * @template T
+ * @typedef {btree.Leaf1<T>} Leaf1
  */
 
 /**
@@ -27,7 +27,7 @@ const seq = require("../list")
  * @typedef {readonly[string, T]} Entry
  */
 
-/** 
+/**
  * @template T
  * @typedef {undefined|TNode<Entry<T>>} Map
  */
@@ -54,16 +54,16 @@ const set = name => value => map =>  {
     }
 }
 
-/** @type {<T>(map: Map<T>) => seq.List<Entry<T>>} */
-const entries = map => map === undefined ? [] : values(map)
+/** @type {<T>(map: Map<T>) => list.List<Entry<T>>} */
+const entries = map => map === undefined ? undefined : values(map)
 
 /** @type {<T>(map: Map<T>) => (entry: Entry<T>) => Map<T>} */
 const setOp = map => ([name, value]) => set(name)(value)(map)
 
-/** @type {<T>(entries: seq.List<Entry<T>>) => Map<T>} */
+/** @type {<T>(entries: list.List<Entry<T>>) => Map<T>} */
 const fromEntries = entries => {
-    /** @typedef {typeof entries extends seq.List<Entry<infer T>> ? T : never} T */    
-    return seq.reduce(setOp)(/** @type {Map<T>} */(undefined))(entries)
+    /** @typedef {typeof entries extends list.List<Entry<infer T>> ? T : never} T */
+    return list.reduce(setOp)(/** @type {Map<T>} */(undefined))(entries)
 }
 
 module.exports = {

package/types/object/index.js

@@ -1,4 +1,4 @@
-const seq = require('../list')
+const list = require('../list')
 const map = require('../map')
 
 /**
@@ -16,12 +16,17 @@ const map = require('../map')
 /** @type {(name: string) => <T>(object: Map<T>) => T|undefined} */
 const at = name => object => Object.getOwnPropertyDescriptor(object, name)?.value
 
-/** @type {<T>(entries: seq.List<Entry<T>>) => seq.List<Entry<T>>} */
+/** @type {<T>(entries: list.List<Entry<T>>) => list.List<Entry<T>>} */
 const sort = entries => map.entries(map.fromEntries(entries))
 
+/** @type {<T>(m: map.Map<T>) => Map<T>} */
+const fromMap = m => Object.fromEntries(list.iterable(map.entries(m)))
+
 module.exports = {
     /** @readonly */
     at,
     /** @readonly */
     sort,
+    /** @readonly */
+    fromMap,
 }

package/commonjs/run/index.js

@@ -1,17 +0,0 @@
-const result = require('../../types/result')
-
-/** @typedef {<T>(req: Require<T>) => (prior: T) => ModuleResult<T>} Module*/
-
-/**
- * @template T 
- * @typedef {readonly[result.Result<unknown, unknown>, T]} ModuleResult 
- */
-
-/**
- * @template T 
- * @typedef {(path: string) => (prior: T) => ModuleResult<T>} Require
- */
-
-/** @typedef {(source: string) => result.Result<Module, unknown>} Compile */
-
-module.exports = {}