imdone-core 1.54.8 → 1.54.9

package/README.md

@@ -199,8 +199,9 @@ License
 
 <!-- # #NOTE Notes
 
-**Development Package Version {{version}}**
-**Published Version**
+{{branch}} :deciduous_tree: :hammer_and_wrench: Current Branch
+{{version}} :package: :hammer_and_wrench: Code Version
+{{publishedVersion}} :package: :passenger_ship: Published Version
 
 [Focus]({{getFilterURL('list = DOING or tags = focus')}})
 [Plan]({{getFilterURL(' ')}})

package/lib/adapters/file-gateway.js

@@ -3,6 +3,14 @@ const _path = require('path')
 let fs = require('fs')
 const sanitize = require('sanitize-filename')
 
+async function exists(path) {
+  try {
+    await fs.promises.access(path)
+    return path
+  } catch {
+    return false
+  }
+}
 
 function mkdirpSync(path) {
   console.warn('sync call')
@@ -29,14 +37,7 @@ const gateway = {
     return fs.existsSync.apply({}, args)
   },
 
-  async exists(path) {
-    try {
-      await fs.promises.access(path)
-      return path
-    } catch {
-      return false
-    }
-  },
+  exists,
 
   async stat(path, opts) {
     try {

package/lib/context/ApplicationContext.js

@@ -14,6 +14,7 @@ class ApplicationContext {
     this.projectReader = projectReader;
     this.projectPresenter = projectPresenter;
     this.innerConfig = Config.newDefaultConfig()
+    this.pluginRegistry = require('../plugins/plugin-registry')
   }
 
   set config(config) {

package/lib/plugins/plugin-manager.js

@@ -1,11 +1,12 @@
 const Emitter = require('events')
 const Plugin = require('imdone-api')
-const fs = require('fs')
 const _path = require('path')
 const downloadRepo = require('../adapters/git-download')
 const rimraf = require('rimraf')
 const sane = require('sane')
 const debounce = require('lodash.debounce')
+const { exists, mkdir, readdir } = require('../adapters/file-gateway')
+const appContext = require('../context/ApplicationContext')
 
 module.exports = class PluginManager extends Emitter {
   constructor(project) {
@@ -26,8 +27,8 @@ module.exports = class PluginManager extends Emitter {
 
   async startDevMode() {
     if (this.project && this.project.config.devMode && !this.watcher) {
-      if (!(await this.exists(this.pluginPath)))
-        await fs.promises.mkdir(this.pluginPath)
+      if (!(await exists(this.pluginPath)))
+        await mkdir(this.pluginPath)
       this.watcher = sane(this.pluginPath, {
         ignored(path) {
           return /node_modules/.test(path)
@@ -92,8 +93,8 @@ module.exports = class PluginManager extends Emitter {
   }
 
   async installPlugin({ name, version }) {
-    if (!(await this.exists(this.pluginPath)))
-      await fs.promises.mkdir(this.pluginPath)
+    if (!(await exists(this.pluginPath)))
+      await mkdir(this.pluginPath)
     const installPath = _path.join(this.pluginPath, name)
     await downloadRepo(version, installPath)
     console.log(`Done installing ${name}`)
@@ -106,9 +107,16 @@ module.exports = class PluginManager extends Emitter {
       await this.loadPlugin(pluginPath)
     }
 
-    const path = await this.exists(this.pluginPath)
-    if (!path) return
-    const paths = await fs.promises.readdir(this.pluginPath, { withFileTypes: true })
+    await this.loadInstalledPlugins()
+    await this.loadPluginsNotInstalled()
+  }
+
+  async loadInstalledPlugins() {
+    const path = await exists(this.pluginPath)
+    if (!path) {
+      await mkdir(this.pluginPath)
+    }
+    const paths = await readdir(this.pluginPath, { withFileTypes: true })
     const pluginPaths = paths
     .filter(
       (entry) =>
@@ -120,9 +128,20 @@ module.exports = class PluginManager extends Emitter {
     for (const path of pluginPaths) {
       await this.loadPlugin(path)
     }
-      
   }
   
+  async loadPluginsNotInstalled() {
+    const availablePlugins = await appContext().pluginRegistry.getAvailablePlugins()
+    const configPluginNames = Object.keys(this.project.config.plugins)
+    if (!configPluginNames) return
+    const installedPluginNames = Object.keys(this.pluginsMap)
+    const pluginsNotInstalled = configPluginNames.filter(name => !installedPluginNames.includes(name))
+    for (const pluginName of pluginsNotInstalled) {
+      const plugin = availablePlugins.find(p => p.name === pluginName)
+      await this.installPlugin(plugin)
+    }
+  }
+
   async loadPlugin(path) {
     console.log('Loading plugin: ', path)
     try {
@@ -380,15 +399,6 @@ module.exports = class PluginManager extends Emitter {
     return actions
   }
 
-  async exists(path) {
-    try {
-      await fs.promises.access(path)
-      return path
-    } catch {
-      return false
-    }
-  }
-
   performCardAction(action, task) {
     const plugin = this.getPluginInstance(action.plugin)
     try {

package/lib/plugins/plugin-registry.js

@@ -0,0 +1,61 @@
+const {
+	renderMarkdown,
+} = require('../adapters/markdown')
+
+module.exports = {
+  
+  getAvailablePlugins: async function () {
+    const response = await fetch('https://raw.githubusercontent.com/imdone/imdone-plugins/main/index.json')
+    const plugins = response.body
+    for (const plugin of plugins) {
+      plugin.content = renderMarkdown(await getReadmeContent(plugin))
+    }
+    return plugins
+  },
+
+}
+
+async function getReadmeContent({version}) {
+  const response = await fetch(`https://api.github.com/repos/${version}/readme`)
+  const { content } = response.body
+  const buffer = Buffer.from(content, 'base64');
+  return buffer.toString('utf-8');
+}
+
+const https = require('https')
+
+async function fetch(url, opts = { method: 'GET', headers: {} }) {
+  const { method, headers, body, debug = () => { } } = opts
+  if (body) headers['Content-Length'] = body.length
+  headers['Cache-Control'] = 'no-cache'; // Add Cache-Control header
+  url = new URL(url)
+  const port = url.protocol === 'https:' ? 443 : 80
+  const options = {
+      hostname: url.hostname,
+      port: port,
+      path: url.pathname,
+      method,
+      headers: {
+          'User-Agent': 'imdone',
+          ...headers,
+      },
+  }
+
+  debug("Fetch request:", JSON.stringify({ method, url, body }))
+  
+  return new Promise((resolve, reject) => {
+      let result = []
+
+      const req = https.request(options, (res) => {
+          res.on('data', (chunk) => result.push(chunk))
+          res.on('end', () => {
+              const data = Buffer.concat(result).toString()
+              debug("Fetch response:", JSON.stringify({ data, status: res.statusCode }))
+              resolve({ body: data && JSON.parse(data), status: res.statusCode })
+          })
+      })
+      req.on('error', reject)
+      if (body) req.write(body)
+      req.end()
+  })
+}

package/lib/project-factory.js

@@ -5,16 +5,40 @@ const ProjectContext = require('./ProjectContext')
 const Project = require('./project')
 const context = require('./context/ApplicationContext')
 
-function createFileSystemProject({path, config, repo = fsStore(new Repository(path, config))}) {
+function createFileSystemProject({
+    path,
+    config,
+    repo = fsStore(new Repository(path, config)),
+    loadInstalledPlugins,
+    loadPluginsNotInstalled
+}) {
     context().repo = repo
     context().projectContext = new ProjectContext(repo)
     context().project = new Project(repo)
+    if (loadInstalledPlugins) {
+        context().project.pluginManager.loadInstalledPlugins = loadInstalledPlugins
+    }
+    if (loadPluginsNotInstalled) {
+        context().project.pluginManager.loadPluginsNotInstalled = loadPluginsNotInstalled
+    }
     return context().project
 }
 
 module.exports = {
-    createWatchedFileSystemProject: function({path, config, repo = watchedFsStore(new Repository(path, config))}) {
-        return createFileSystemProject({path, config, repo})
+    createWatchedFileSystemProject: function({
+        path,
+        config,
+        repo = watchedFsStore(new Repository(path, config)),
+        loadInstalledPlugins,
+        loadPluginsNotInstalled    
+    }) {
+        return createFileSystemProject({
+            path,
+            config,
+            repo,
+            loadInstalledPlugins,
+            loadPluginsNotInstalled        
+        })
     },
 
     createFileSystemProject

package/lib/project.js

@@ -54,13 +54,100 @@ module.exports = class WorkerProject extends Project {
     this._updatedAt = undefined
     this.data = {}
     this.dataKeys = []
+    this.repo.project = this
+    this.pluginManager = new PluginManager(this)
+  }
+
+  get configDir() {
+    return _path.join(this.path, CONFIG_DIR)
+  }
+
+  get allTopics() {
+    return [...this.repo.allTopics]
+  }
+
+  get allTags() {
+    return [...this.repo.allTags]
+  }
+
+  get allContexts() {
+    return [...this.repo.allContexts]
+  }
+
+  get allMeta() {
+    return this.repo.allMeta
+  }
+
+  get lists() {
+    return this.getLists({
+      tasks: this.filteredCards,
+    })
+  }
+
+  get allLists() {
+    return this.getLists()
+  }
+
+  get filteredCards() {
+    return this.getCards(this.filter)
+  }
+
+  get isoDateWithOffset() {
+    return getIsoDateWithOffset()
+  }
+
+  get updatedAt() {
+    return this._updatedAt
+  }
+
+  get files() {
+    return this.repo.getFilePaths()
+  }
+
+  get config() {
+    return this.repo.config
+  }
+
+  get defaultFilter() {
+    return this.config && this.config.defaultFilter
+  }
+
+  set defaultFilter(filter) {
+    this.config.defaultFilter = filter
+  }
+
+  get totals() {
+    return calculateTotals(this.lists)
+  }
+
+  get path() {
+    return this.repo.path
+  }
+
+  get name() {
+    return this.repo.getDisplayName()
+  }
+
+  get doneList() {
+    return this.config.getDoneList()
+  }
+
+  get boardActions() {
+    return [
+      ...this.pluginManager.getBoardActions(),
+    ]
+  }
+
+  get filter() {
+    return this.innerFilter
+  }
+
+  set filter(filter) {
+    this.innerFilter = filter
   }
 
   async init(cb) {
     const promise = new Promise(async (resolve, reject) => {
-      this.repo.project = this
-
-      this.pluginManager = new PluginManager(this)
       this.pluginManager.on('plugin-installed', () => this.emitUpdate())
       this.pluginManager.on('plugin-uninstalled', () => this.emitUpdate())
       this.pluginManager.on('plugins-reloaded', () => this.emitUpdate())
@@ -226,48 +313,6 @@ module.exports = class WorkerProject extends Project {
     if (this.pluginManager) this.pluginManager.destroyPlugins()
   }
 
-  get configDir() {
-    return _path.join(this.path, CONFIG_DIR)
-  }
-
-  get allTopics() {
-    return [...this.repo.allTopics]
-  }
-
-  get allTags() {
-    return [...this.repo.allTags]
-  }
-
-  get allContexts() {
-    return [...this.repo.allContexts]
-  }
-
-  get allMeta() {
-    return this.repo.allMeta
-  }
-
-  get lists() {
-    return this.getLists({
-      tasks: this.filteredCards,
-    })
-  }
-
-  get allLists() {
-    return this.getLists()
-  }
-
-  get filteredCards() {
-    return this.getCards(this.filter)
-  }
-
-  get isoDateWithOffset() {
-    return getIsoDateWithOffset()
-  }
-
-  get updatedAt() {
-    return this._updatedAt
-  }
-
   getDataKeys(data) {
     const keys = Object.keys(data).map((key) => {
       const value = data[key]
@@ -372,52 +417,6 @@ module.exports = class WorkerProject extends Project {
     return result
   }
 
-  get files() {
-    return this.repo.getFilePaths()
-  }
-
-  get config() {
-    return this.repo.config
-  }
-
-  get defaultFilter() {
-    return this.config && this.config.defaultFilter
-  }
-
-  set defaultFilter(filter) {
-    this.config.defaultFilter = filter
-  }
-
-  get totals() {
-    return calculateTotals(this.lists)
-  }
-
-  get path() {
-    return this.repo.path
-  }
-
-  get name() {
-    return this.repo.getDisplayName()
-  }
-
-  get doneList() {
-    return this.config.getDoneList()
-  }
-
-  get filter() {
-    return this.innerFilter
-  }
-
-  get boardActions() {
-    return [
-      ...this.pluginManager.getBoardActions(),
-    ]
-  }
-
-  set filter(filter) {
-    this.innerFilter = filter
-  }
-
   async addMetadata(task, key, value) {
     if (task.hasMetaData(key, value)) return
     if (!task.allMeta[key]) task.allMeta[key] = []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "imdone-core",
-  "version": "1.54.8",
+  "version": "1.54.9",
   "description": "imdone-core",
   "main": "index.js",
   "bin": {
@@ -118,7 +118,7 @@
     "fs-extra": "^11.1.0",
     "jshint": "^2.9.4",
     "json-stringify-safe": "~5.0.0",
-    "mocha": "^9.2.2",
+    "mocha": "^11.1.0",
     "mocha-each": "^2.0.1",
     "nyc": "^15.1.0",
     "prettier": "^2.5.1",