pockethost 1.6.0 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # pockethost
 
+## 1.7.0
+
+### Minor Changes
+
+- 3c7e9bf: Added plugin template command and updated docs
+
+## 1.6.1
+
+### Patch Changes
+
+- dc8f70b: Updated docs
+
 ## 1.6.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pockethost",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "author": {
     "name": "Ben Allfree",
     "url": "https://github.com/benallfree"
@@ -27,11 +27,13 @@
     "get-port": "^6.1.2",
     "http-proxy": "^1.18.1",
     "immer": "^10.1.1",
+    "inflection": "^3.0.0",
     "json-stringify-safe": "^5.0.1",
     "listr2": "^8.2.3",
     "minimist": "^1.2.8",
     "nanoid": "^5.0.2",
     "node-fetch": "^3.3.2",
+    "node-plop": "^0.32.0",
     "pocketbase": "^0.21.3",
     "rimraf": "^5.0.5",
     "semver": "^7.6.2",
@@ -41,9 +43,9 @@
     "typescript": "^5.4.5",
     "update-notifier": "^7.0.0",
     "url-pattern": "^1.0.3",
-    "@pockethost/plugin-launcher-spawn": "^0.4.0",
+    "@pockethost/plugin-auto-admin": "^0.2.0",
     "@pockethost/plugin-console-logger": "^0.3.0",
-    "@pockethost/plugin-auto-admin": "^0.2.0"
+    "@pockethost/plugin-launcher-spawn": "^0.4.0"
   },
   "devDependencies": {
     "@types/conventional-commits-parser": "^5.0.0",

package/readme.md

@@ -111,6 +111,7 @@ These plugins are maintained by the PocketHost project.
 | `@pockethost/plugin-launcher-spawn`            | Launches PocketBase instances via `spawn()` on the local machine. PocketHost uses this by default                       |
 | `@pockethost/plugin-cloudflare-request-logger` | Log additional data when running behind Cloudflare                                                                      |
 | `@pockethost/plugin-ftp-server`                | Used to provide secure FTPS access to PocketBase instance data. This FTP server can run along-side a PocketHost server. |
+| `@pockethost/plugin-local-auth`                | A light-weight username/password auth provider for associating instances with users.                                    |
 
 Coming soon:
 | name | description |

package/src/cli/commands/PluginCommand/index.ts

@@ -1,10 +1,19 @@
 import { Command } from 'commander'
 import { readFileSync } from 'fs'
+import { dasherize, underscore } from 'inflection'
+import nodePlop from 'node-plop'
+import { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { join } from 'path'
+import { cwd } from 'process'
 import { error, info } from '../..'
+import { version } from '../../../../package.json'
 import { PH_PLUGINS, PH_PROJECT_DIR } from '../../../constants'
 import { appendConfig, filterConfig } from '../../../core'
 import { getCompatibleVersions, getPackageJson, removePackage } from './util'
 
+const __dirname = dirname(fileURLToPath(import.meta.url))
+
 export const PluginCommand = () => {
   const cmd = new Command(`plugin`)
     .description(`Manage PocketHost plugins`)
@@ -77,5 +86,28 @@ export const PluginCommand = () => {
           }
         }),
     )
+
+    .addCommand(
+      new Command(`create`)
+        .description(`Create a new plugin`)
+        .alias(`new`)
+        .alias(`n`)
+        .alias(`make`)
+        .alias(`generate`)
+        .argument(`<name>`, `Plugin name (dash case)`)
+        .action(async (name) => {
+          const dashCase = dasherize(underscore(name))
+          const plopfilePath = join(__dirname, 'plopfile.mjs')
+          const plopInstance = await nodePlop(plopfilePath, {
+            destBasePath: cwd(),
+            force: false,
+          })
+          const generator = plopInstance.getGenerator('plugin')
+          const results = await generator.runActions({
+            name: dashCase,
+            version,
+          })
+        }),
+    )
   return cmd
 }

package/src/cli/commands/PluginCommand/plugin-template/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@pockethost/plugin-{{dashCase name}}",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/pockethost/pockethost/packages/plugin-{{dashCase name}}"
+  },
+  "description": "A pockethost plugin.",
+  "main": "src/index.ts",
+  "module": "src/index.ts",
+  "types": "src/index.ts",
+  "type": "module",
+  "scripts": {
+    "check-types": "tsc --noEmit "
+  },
+  "keywords": [
+    "pockethost"
+  ],
+  "author": {
+    "name": "Ben Allfree",
+    "url": "https://github.com/benallfree"
+  },
+  "license": "MIT",
+  "peerDependencies": {
+    "pockethost": "workspace:^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.8.10",
+    "typescript": "^5.4.5",
+    "@types/lowdb": "^1.0.15"
+  },
+  "dependencies": {
+    "commander": "^11.1.0",
+    "immer": "^10.1.1",
+    "inflection": "^3.0.0",
+    "lowdb": "^7.0.1"
+  }
+}

package/src/cli/commands/PluginCommand/plugin-template/readme.md

@@ -0,0 +1,33 @@
+# plugin-{{dashCase name}}
+
+A plugin for [pockethost](https://www.npmjs.com/package/pockethost).
+
+## Quickstart
+
+```bash
+npx pockethost plugin install @pockethost/plugin-{{dashCase name}}
+
+npx pockethost {{dashCase name}} --help
+```
+
+## Variables
+
+The following variables will be used if they are found in the shell environment. PocketHost will also load them from an `.env` file if found at load time.
+
+| Name                            | Default                                | Discussion                                                    |
+| ------------------------------- | -------------------------------------- | ------------------------------------------------------------- |
+| PH\_{{constantCase name}}\_HOME | `.pockethost/plugin-{{dashCase name}}` | The home directory for any data storage needs of this plugin. |
+
+## Actions
+
+## Filters
+
+## Support
+
+PocketHost has a thriving [Discord community](https://discord.gg/nVTxCMEcGT).
+
+---
+
+### Sponsored by https://pockethost.io. Instantly host your PocketBase projects.
+
+---

package/src/cli/commands/PluginCommand/plugin-template/src/constants.ts

@@ -0,0 +1,22 @@
+import { underscore } from 'inflection'
+import { dirname, join } from 'path'
+import { PH_HOME, Settings, mkPath } from 'pockethost/core'
+import { fileURLToPath } from 'url'
+
+export const PLUGIN_NAME = `plugin-{{dashCase name}}`
+
+export const HOME_DIR =
+  process.env.PH_{{constantCase name}}_HOME || join(PH_HOME(),PLUGIN_NAME)
+
+export const PLUGIN_NAME_CONSTANT_CASE = underscore(PLUGIN_NAME, true)
+
+export const PLUGIN_DATA = (...paths: string[]) => join(HOME_DIR, ...paths)
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+export const PROJECT_DIR = (...paths: string[]) =>
+  join(__dirname, '..', ...paths)
+
+export const settings = Settings({
+  PH_{{constantCase name}}_HOME: mkPath(HOME_DIR, { create: true }),
+})
+

package/src/cli/commands/PluginCommand/plugin-template/src/db.ts

@@ -0,0 +1,30 @@
+import { JSONFileSyncPreset } from 'lowdb/node'
+import { InstanceFields, InstanceId, mkSingleton } from 'pockethost'
+import { PLUGIN_DATA } from './constants'
+import { info } from './log'
+
+export const DbService = mkSingleton(async () => {
+  const db = await JSONFileSyncPreset<{
+    instances: { [key: InstanceId]: InstanceFields }
+  }>(PLUGIN_DATA('db.json'), { instances: {} })
+
+  const deleteInstance = (id: InstanceId) => {
+    db.update((data) => {
+      delete data.instances[id]
+    })
+    info(`Deleted instance ${id}`)
+  }
+
+  const addInstance = (instance: InstanceFields) => {
+    db.update((data) => (data.instances[instance.id] = instance))
+    info(`Added instance ${instance.id}`)
+  }
+
+  const getInstanceById = (id: InstanceId) => db.data.instances[id]
+
+  return {
+    addInstance,
+    deleteInstance,
+    getInstanceById,
+  }
+})

package/src/cli/commands/PluginCommand/plugin-template/src/index.ts

@@ -0,0 +1,3 @@
+import { plugin } from './plugin'
+
+export default plugin

package/src/cli/commands/PluginCommand/plugin-template/src/log.ts

@@ -0,0 +1,5 @@
+import { LoggerService } from 'pockethost'
+import { PLUGIN_NAME } from './constants'
+
+const logger = LoggerService().create(PLUGIN_NAME)
+export const { dbg, info, error } = logger

package/src/cli/commands/PluginCommand/plugin-template/src/plugin.ts

@@ -0,0 +1,58 @@
+import { Command } from 'commander'
+import { produce } from 'immer'
+import {
+  PocketHostPlugin,
+  onCliCommandsFilter,
+  onInstanceConfigFilter,
+  onServeAction,
+  onServeSlugsFilter,
+  onSettingsFilter,
+} from 'pockethost'
+import {
+  PLUGIN_NAME,
+  PLUGIN_NAME_CONSTANT_CASE,
+  PROJECT_DIR,
+  settings,
+} from './constants'
+import { DbService } from './db'
+import { dbg } from './log'
+
+export const plugin: PocketHostPlugin = async ({}) => {
+  dbg(`initializing ${PLUGIN_NAME}`)
+
+  await DbService({})
+
+  onInstanceConfigFilter(async (config) => {
+    return produce(config, (draft) => {
+      draft.env[`PH_${PLUGIN_NAME_CONSTANT_CASE}_ENABLED`] = true.toString()
+      draft.binds.hooks.push({
+        src: PROJECT_DIR(`src/instance-app/hooks/**/*`),
+        base: PROJECT_DIR(`src/instance-app/hooks`),
+      })
+    })
+  })
+
+  onCliCommandsFilter(async (commands) => {
+    return [
+      ...commands,
+      new Command(PLUGIN_NAME).description(`Command root`).addCommand(
+        new Command(`serve`)
+          .description(`Run a task`)
+          .action(async (options) => {
+            // do something
+          }),
+      ),
+    ]
+  })
+
+  onServeSlugsFilter(async (slugs) => {
+    return [...slugs, PLUGIN_NAME]
+  })
+
+  onServeAction(async ({ only }) => {
+    if (!only.includes(PLUGIN_NAME)) return
+    // Do something
+  })
+
+  onSettingsFilter(async (allSettings) => ({ ...allSettings, ...settings }))
+}

package/src/instance-app/types/all.d.ts

@@ -1,3 +0,0 @@
-/// <reference path="./lib.d.ts" />
-/// <reference path="./goja.d.ts" />
-/// <reference path="./types.d.ts" />

package/src/instance-app/types/goja.d.ts

@@ -1,58 +0,0 @@
-interface Require {
-  (id: string): any
-}
-declare var require: Require
-
-/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console) */
-interface Console {
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/assert) */
-  assert(condition?: boolean, ...data: any[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear) */
-  clear(): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count) */
-  count(label?: string): void
-  /**
-   * [MDN
-   * Reference](https://developer.mozilla.org/docs/Web/API/console/countReset)
-   */
-  countReset(label?: string): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug) */
-  debug(...data: any[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir) */
-  dir(item?: any, options?: any): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml) */
-  dirxml(...data: any[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error) */
-  error(...data: any[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group) */
-  group(...data: any[]): void
-  /**
-   * [MDN
-   * Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed)
-   */
-  groupCollapsed(...data: any[]): void
-  /**
-   * [MDN
-   * Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd)
-   */
-  groupEnd(): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info) */
-  info(...data: any[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log) */
-  log(...data: any[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table) */
-  table(tabularData?: any, properties?: string[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time) */
-  time(label?: string): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd) */
-  timeEnd(label?: string): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog) */
-  timeLog(label?: string, ...data: any[]): void
-  timeStamp(label?: string): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace) */
-  trace(...data: any[]): void
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn) */
-  warn(...data: any[]): void
-}
-
-declare var console: Console

package/src/instance-app/types/lib.d.ts

@@ -1,5 +0,0 @@
-type Logger = (...args: any[]) => void
-
-interface Lib {
-  mkLog: (namespace: string) => Logger
-}