functionalscript 0.0.264 → 0.0.265

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,62 @@
+const package_ = require('../package')
+const module_ = require('../module')
+const function_ = require('../module/function')
+const { todo } = require('../../dev')
+
+/**
+ * @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 {(packageGet: package_.Get) =>
+ *  <M>(moduleMapInterface: module_.MapInterface<M>) =>
+ *  (compile: function_.Compile) =>
+ *  (moduleId: module_.Id) =>
+ *  (moduleMap: M) =>
+ *  Result<M>
+ * } 
+ */
+const getOrBuild = packageGet => moduleMapInterface => compile => moduleId => moduleMap => {
+    const moduleIdStr = module_.idToString(moduleId)
+
+    /** @type {() => Result<typeof moduleMap>} */
+    const notFound = () => [['error', ['file not found']], moduleMap]
+    
+    /** @type {(e: module_.Error) => Result<typeof moduleMap>} */
+    const error = e => {
+        /** @type {module_.State} */
+        const state = ['error', e]
+        moduleMapInterface.insert(moduleIdStr)(state)
+        return [state, moduleMap]
+    }
+
+    const m = moduleMapInterface.at(moduleIdStr)(moduleMap)
+    if (m !== undefined) { return [m, moduleMap] }
+    
+    const p = packageGet(moduleId.packageId)
+    if (p === undefined) { return notFound() }
+    
+    const source = p.file(moduleId.path.join('/'))
+    if (source === undefined) { return notFound() }
+    
+    const compileResult = compile(source)
+    if (compileResult[0] === 'error') { return error(['compilation error', compileResult[1]]) }
+    
+    return todo()
+}
+
+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['error', Error] | 
  *  readonly['building']
- * } ModuleState 
+ * } State 
  */
 
 /**
@@ -25,11 +25,24 @@ const object = require('../../types/object')
 
 /** 
  * @typedef {|
- *  'file not found' | 
- *  'compile error' | 
- *  'runtime error' | 
- *  'circular reference'
- * } ModuleError
+ *  ['file not found'] | 
+ *  ['compilation error', unknown] | 
+ *  ['runtime error'] | 
+ *  ['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/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} */
+/** @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.265",
   "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/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 = {}