@voxgig/model 4.0.0 → 5.0.0

package/lib/builder/local.ts

@@ -1,130 +0,0 @@
-
-import Path from 'path'
-
-import type { Build, Builder, BuildContext } from '../types'
-
-
-// Runs any builders local to the repo.
-const local_builder: Builder = async (build: Build, ctx: BuildContext) => {
-  ctx.state.local = (ctx.state.local || {})
-  let actionDefs = ctx.state.local.actionDefs
-
-  if (null == actionDefs) {
-    try {
-      actionDefs = ctx.state.local.actionDefs = []
-
-      // TODO: need to provide project root via build
-      let root = Path.resolve(build.path, '..', '..')
-
-
-      // TODO: build should do this
-      let configbuild = build.use.config
-
-      let config = configbuild.watch.last.build.model
-
-      let builders = config.sys.model.builders
-
-      // TODO: order by comma sep string
-      // Load builders
-      for (let name in builders) {
-        let builder = builders[name]
-        let action_path = Path.join(root, builder.load)
-
-
-        // clear(action_path)
-
-
-        let action = require(action_path)
-
-        if (action instanceof Promise) {
-          action = await action
-        }
-
-        const step = action.step || 'post'
-
-        actionDefs.push({ name, builder, action, step })
-      }
-    }
-    catch (e: any) {
-      throw e
-    }
-  }
-
-
-  if ('pre' === ctx.step) {
-    try {
-      let ok = true
-      let brlog = []
-
-      for (let actionDef of actionDefs) {
-        if ('pre' === actionDef.step || 'all' === actionDef.step) {
-          let br = await actionDef.action(build.model, build)
-          ok = ok && null != br && br.ok
-          brlog.push(br)
-        }
-      }
-
-      return { ok: true, step: ctx.step, active: true }
-    }
-    catch (e: any) {
-      throw e
-    }
-  }
-
-  else if ('post' === ctx.step) {
-    try {
-      let ok = true
-      let brlog = []
-
-      for (let actionDef of actionDefs) {
-        if ('post' === actionDef.step || 'all' === actionDef.step) {
-          let br = await actionDef.action(build.model, build)
-          ok = ok && null != br && br.ok
-          brlog.push(br)
-        }
-      }
-
-      return { ok: true, step: ctx.step, active: true }
-    }
-    catch (e: any) {
-      throw e
-    }
-  }
-
-  return { ok: false, why: 'bad-step', step: ctx.step, active: false }
-}
-
-/*
-// Adapted from https://github.com/sindresorhus/import-fresh - Thanks!
-function clear(path: string) {
-  let filePath = require.resolve(path)
-
-  if (require.cache[filePath]) {
-    const children = require.cache[filePath].children.map(child => child.id)
-
-    // Delete module from cache
-    delete require.cache[filePath]
-
-    for (const id of children) {
-      clear(id)
-    }
-  }
-
-
-  if (require.cache[filePath] && require.cache[filePath].parent) {
-    let i = require.cache[filePath].parent.children.length
-
-    while (i--) {
-      if (require.cache[filePath].parent.children[i].id === filePath) {
-        require.cache[filePath].parent.children.splice(i, 1)
-      }
-    }
-  }
-
-}
-*/
-
-
-export {
-  local_builder
-}

package/lib/builder/model.ts

@@ -1,37 +0,0 @@
-
-import Path from 'path'
-
-import { writeFile } from 'fs/promises'
-
-import type { Build, Builder, BuildContext } from '../types'
-
-
-// Builds the main model file, after unification.
-const model_builder: Builder = async (build: Build, ctx: BuildContext) => {
-  if ('post' !== ctx.step) {
-    return { ok: true, step: ctx.step, active: false }
-  }
-
-  try {
-    let json = JSON.stringify(build.root.gen(), null, 2)
-
-    let filename = Path.basename(build.path)
-    let filenameparts = filename.match(/^(.*)\.[^.]+$/)
-    if (filenameparts) {
-      filename = filenameparts[1]
-    }
-
-    let file = build.opts.base + '/' + filename + '.json'
-
-    await writeFile(file, json)
-
-    return { ok: true, step: ctx.step, active: true }
-  }
-  catch (e: any) {
-    throw e
-  }
-}
-
-export {
-  model_builder
-}

package/lib/config.ts

@@ -1,50 +0,0 @@
-/* Copyright © 2021-2024 Voxgig Ltd, MIT License. */
-
-
-import type { BuildResult, Spec } from './types'
-
-import { Watch } from './watch'
-
-import { model_builder } from './builder/model'
-
-
-
-
-
-
-class Config {
-  build: any
-  watch: Watch
-
-  constructor(spec: Spec) {
-    this.build = {
-      src: spec.src,
-      path: spec.path,
-      base: spec.base,
-      res: [
-        ...(spec.res || [])
-      ],
-      require: spec.require
-    }
-
-    this.watch = new Watch(this.build)
-  }
-
-  async run(): Promise<BuildResult> {
-    return this.watch.run(true, '<config>')
-  }
-
-  async start() {
-    return this.watch.start()
-  }
-
-  async stop() {
-    return this.watch.stop()
-  }
-}
-
-
-export { Config, Spec }
-
-
-

package/lib/types.ts

@@ -1,67 +0,0 @@
-
-
-
-interface Build {
-  id: string
-  src: string
-  base: string
-  path: string
-  root: any
-  opts: { [key: string]: any }
-  res: BuildAction[]
-  spec: Spec
-  model: any
-  use: { [name: string]: any }
-  err: any[]
-  ctx: BuildContext
-
-  run: () => Promise<BuildResult>
-}
-
-
-interface BuildResult {
-  ok: boolean
-  builder?: string
-  path?: string
-  build?: Build
-  builders?: BuildResult[]
-  step?: string
-  err?: any[]
-}
-
-interface BuildAction {
-  path: string
-  build: Builder
-}
-
-
-interface BuildContext {
-  step: 'pre' | 'post'
-  state: Record<string, any>
-}
-
-type Builder = (
-  build: Build,
-  ctx: BuildContext,
-) => Promise<BuildResult>
-
-
-interface Spec {
-  src: string
-  path?: string
-  base?: string
-  res?: BuildAction[]
-  require?: any
-  use?: { [name: string]: any }
-}
-
-
-
-export type {
-  Build,
-  BuildResult,
-  BuildAction,
-  Builder,
-  BuildContext,
-  Spec,
-}

package/lib/watch.ts

@@ -1,301 +0,0 @@
-/* Copyright © 2021-2024 Voxgig Ltd, MIT License. */
-
-import Path from 'node:path'
-
-
-import type { Build, BuildResult } from './types'
-
-import { makeBuild } from './build'
-import { FSWatcher } from 'chokidar'
-
-import { readFile, stat } from 'fs/promises'
-
-
-const print = console.log
-const warn = console.warn
-
-
-type Run = {
-  canon: string
-  path: string
-  start: number
-  end: number
-}
-
-type Canon = {
-  path: string
-  isFolder: boolean
-  when: number
-}
-
-
-type ChangeItem = {
-  path: string
-  when: number
-}
-
-class Watch {
-  fsw: FSWatcher
-  spec: any
-  last?: BuildResult
-  lastChangeTime: number
-  build: Build | undefined
-  runq: Run[]
-  doneq: Run[]
-  canons: Canon[]
-  lastrun: Run | undefined
-  idle: number
-  startTime: number
-  running: boolean
-  lastChange: ChangeItem
-  lastTrigger: ChangeItem
-
-  constructor(spec: any) {
-    this.spec = spec
-    this.fsw = new FSWatcher()
-    this.lastChangeTime = 0
-    this.runq = []
-    this.doneq = []
-    this.canons = []
-    this.startTime = 0
-    this.lastChange = { path: '', when: 0 }
-    this.lastTrigger = { path: '', when: 0 }
-    this.running = false
-    this.lastrun = undefined
-
-    this.idle = spec.idle || 111
-
-    this.fsw.on('change', async (path: string) => {
-      // console.log('CHANGE', Date.now() - this.startTime, path)
-      this.handleChange(path)
-    })
-  }
-
-
-  // Returns first BuildResult
-  start() {
-    this.startTime = Date.now()
-    this.handleChange('<start>')
-
-    // Check if there have been no recent changes, if so, run build.
-    setInterval(() => {
-      const start = this.startTime
-      const now = Date.now()
-      const idleDuration = now - this.lastChange.when
-
-      // Only trigger a build if there was a actual change
-      const trigger = this.lastChange.when !== this.lastTrigger.when &&
-        this.lastChange.path !== this.lastTrigger.path
-
-      // console.log('CHECK-A', {
-      //   tick: (now - start),
-      //   idleDuration,
-      //   trigger,
-      //   running: this.running,
-      //   path: this.lastChange.path
-      // })
-
-      if (trigger) {
-
-        // Only add to build queue if we've been idle.
-        // This allows external compilation outputting multiple files to complete fully.
-        // IMPORTANT: always trigger a new build if there were changes *inside* a build period
-        if (this.idle < idleDuration) {
-          this.lastTrigger.path = this.lastChange.path
-          this.lastTrigger.when = this.lastChange.when
-
-          const path = this.lastChange.path
-          const canon = this.canon(path)
-
-          this.runq.push({
-            canon,
-            path,
-            start: now,
-            end: -1,
-          })
-
-          // Defer builds to the event loop to keep idle checking separate.
-          setImmediate(this.drain.bind(this))
-        }
-      }
-
-    }, (this.idle * 1.1 / 2) | 0)
-  }
-
-
-  // If path is inside a watched folder, return folder as canonical reference.
-  canon(path: string) {
-    for (const canon of this.canons) {
-      if (canon.isFolder && path.startsWith(canon.path)) {
-        return canon.path
-      }
-    }
-    return path
-  }
-
-
-  handleChange(path: string) {
-    // Record most recent (last) changed path and time
-    this.lastChange.path = path
-    this.lastChange.when = Date.now()
-  }
-
-
-  async drain() {
-    // If already running, all items in queue will be drained from this.runq in the while loop
-    if (this.running) {
-      return
-    }
-
-    this.running = true
-    let r: Run | undefined
-
-    // While there are queued runs, run them sequentially
-    while (r = this.runq.shift()) {
-      // console.log('===DRAIN-RUN', this.runq.length, new Date(), r.start, r.canon)
-
-      // TODO: collect results and errors!!!
-      let br = await this.run(false, r.canon)
-      // console.log('BR', br)
-
-      r.end = Date.now()
-      this.doneq.push(r)
-      this.lastrun = r
-
-      // console.log('===DRAIN-DONE', this.runq.length, new Date(), r.start, r.canon)
-    }
-    this.running = false
-  }
-
-
-  async add(path: string) {
-    if (!Path.isAbsolute(path)) {
-      path = Path.join(this.spec.require, path)
-    }
-
-    // Ignore if aleady added
-    if (this.canons.find((c: Canon) => c.path === path)) {
-      return
-    }
-
-    const fileStat = await stat(path)
-    const canon: Canon = {
-      path: path,
-      isFolder: fileStat.isDirectory(),
-      when: Date.now()
-    }
-
-    this.canons.push(canon)
-
-    this.fsw.add(path)
-
-    // console.log('ADD', canon)
-  }
-
-
-  async update(br: BuildResult) {
-    let build = (br.build as Build)
-
-    let files: string[] =
-      Object.keys(build.root.deps).reduce((files: string[], target: any) => {
-        files = files.concat(Object.keys(build.root.deps[target]))
-        return files
-      }, [build.path])
-
-
-    // TODO: remove deleted files
-    files.forEach(async (file: string) => {
-      if ('string' === typeof (file) &&
-        '' !== file &&
-        build.opts.base !== file
-      ) {
-        await this.add(file)
-      }
-    })
-
-  }
-
-
-
-  async run(once?: boolean, trigger?: string): Promise<BuildResult> {
-    // console.trace()
-
-    this.lastChangeTime = Date.now()
-    print('\n@voxgig/model =================', this.lastChangeTime, new Date(this.lastChangeTime))
-    print('TRIGGER:', trigger, '\n')
-
-    // TODO: build spec should not have src!
-    let src = (await readFile(this.spec.path)).toString()
-    this.spec.src = src
-
-    this.build = this.build || makeBuild(this.spec)
-
-    // TODO: better way to do this?
-    this.build.src = src
-
-    let br: BuildResult = await this.build.run()
-
-    print('\nFILES:\n' + this.descDeps((br as any).build.root.deps) + '\n')
-
-    if (br.ok) {
-      print('TOP:', Object.keys(br?.build?.model).join(', '), '\n')
-
-      if (!once) {
-        // There may be new files.
-        await this.update(br)
-      }
-    }
-    else {
-      warn('MODEL ERRORS: ' + br.err?.length)
-      this.handleErrors(br)
-    }
-
-    this.last = br
-
-    return br
-  }
-
-
-  async stop() {
-    await this.fsw.close()
-  }
-
-
-  handleErrors(br: BuildResult) {
-    if (br.err) {
-      for (let be of br.err) {
-        // TODO: print stack if not a model error
-
-        if (be.isVal && be.msg) {
-          warn(be.msg)
-        }
-        // else if (be.message) {
-        //   warn(be.message)
-        // }
-        else {
-          warn(be)
-        }
-      }
-    }
-  }
-
-  descDeps(deps: Record<string, Record<string, { tar: string }>>) {
-    if (null == deps) {
-      return ''
-    }
-
-    let desc = []
-    for (let entryPath of Object.keys(deps)) {
-      desc.push('  ' + entryPath)
-      for (let depPath of Object.keys(deps[entryPath])) {
-        desc.push('    ' + depPath)
-      }
-    }
-    return desc.join('\n')
-  }
-}
-
-
-export {
-  Watch
-}