pockethost 1.3.0 → 1.3.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # pockethost
 
+## 1.3.2
+
+### Patch Changes
+
+- b0a78d8: Updated plugin authoring guide
+- ac63ea7: Updated plugin documentation
+- Updated dependencies [eb0d011]
+- Updated dependencies [38d2c93]
+  - @pockethost/plugin-launcher-spawn@0.2.0
+  - @pockethost/plugin-console-logger@0.2.0
+  - @pockethost/plugin-auto-admin@0.1.0
+
+## 1.3.1
+
+### Patch Changes
+
+- 8288197: Added plugin authoring guide
+
 ## 1.3.0
 
 ### Minor Changes

package/core.ts

@@ -1,2 +1 @@
-export * from './src/common'
 export * from './src/core'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pockethost",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "author": {
     "name": "Ben Allfree",
     "url": "https://github.com/benallfree"
@@ -39,9 +39,9 @@
     "typescript": "^5.4.5",
     "update-notifier": "^7.0.0",
     "url-pattern": "^1.0.3",
-    "@pockethost/plugin-console-logger": "^0.1.0",
-    "@pockethost/plugin-launcher-spawn": "^0.1.0",
-    "@pockethost/plugin-auto-admin": "^0.0.1"
+    "@pockethost/plugin-launcher-spawn": "^0.2.0",
+    "@pockethost/plugin-auto-admin": "^0.1.0",
+    "@pockethost/plugin-console-logger": "^0.2.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",

package/readme.md

@@ -40,18 +40,30 @@ Use `pockethost config` to set global defaults stored in `<PH_HOME>/.env`.
 
 - `@pockethost/plugin-console-logger`
 - `@pockethost/plugin-launcher-spawn`
+- `@pockethost/plugin-auto-admin`
 
 ## Plugins
 
-PocketHost uses a hook architecture and features many plugins. Some plugins have a CLI component, whereas others add purely programmatic support to alter how PocketHost works:
+PocketHost uses a hook architecture and features a growing list plugins. Some plugins have a CLI component, whereas others add purely programmatic support to alter how PocketHost works:
 
-| name                   | description                                                                                                                            |
+Current plugins:
+
+| name                  | description                                                                                       |
+| --------------------- | ------------------------------------------------------------------------------------------------- |
+| plugin-console-logger | Routes log messages to the console                                                                |
+| plugin-auto-admin     | Auto-creates a default admin account on instance launch                                           |
+| plugin-launcher-spawn | Launches PocketBase instances via `spawn()` on the local machine. PocketHost uses this by default |
+
+Coming soon:
+| name | description |
 | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| plugin-ftp-server      | Used to provide secure FTPS access to PocketBase instance data. This FTP server can run along-side a PocketHost server.                |
+| plugin-ftp-server | Used to provide secure FTPS access to PocketBase instance data. This FTP server can run along-side a PocketHost server. |
 | plugin-launcher-docker | Launches PocketBase instances via Docker. This is useful for running untrusted PocketBase code and instances. pockethost.io uses this. |
-| plugin-launcher-spawn  | Launches PocketBase instances via `spawn()` on the local machine. PocketHost uses this by default.                                     |
-| plugin-waf             | A Web Application Firewall                                                                                                             |
-| plugin-waf-enforce-ssl | Enforce SSL at the WAF                                                                                                                 |
+| plugin-waf | A Web Application Firewall |
+| plugin-waf-enforce-ssl | Enforce SSL at the
+WAF
+
+See the [./plugin-guide.md](Plugin Authoring Guide) for details about what hooks and filters are available.
 
 ## Support
 

package/src/cli/index.ts

@@ -4,15 +4,14 @@ import { uniq } from '@s-libs/micro-dash'
 import { program } from 'commander'
 import { readFileSync } from 'fs'
 import updateNotifier from 'update-notifier'
+import { PH_PLUGINS, PH_PROJECT_DIR } from '../../core'
 import {
   DEBUG,
   LogLevelName,
   LoggerService,
-  PH_PLUGINS,
-  PH_PROJECT_DIR,
   doCliCommandsFilter,
   loadPlugins,
-} from '../../core'
+} from '../common'
 import { ConfigCommand } from './commands/ConfigCommand'
 import { PluginCommand } from './commands/PluginCommand'
 import { ServeCommand } from './commands/ServeCommand'

package/src/constants.ts

@@ -4,14 +4,8 @@ import envPaths from 'env-paths'
 import { dirname, join } from 'path'
 import { cwd } from 'process'
 import { fileURLToPath } from 'url'
-import {
-  InstanceId,
-  mkBoolean,
-  mkCsvString,
-  mkNumber,
-  mkPath,
-  mkString,
-} from '../core'
+import { mkBoolean, mkCsvString, mkNumber, mkPath, mkString } from '../core'
+import { InstanceId } from './common'
 import { DEBUG, IS_DEV } from './common/debug'
 import { Settings } from './core/Settings'
 

package/src/server.ts

@@ -2,10 +2,7 @@ import express, { ErrorRequestHandler } from 'express'
 import 'express-async-errors'
 import { default as httpProxy } from 'http-proxy'
 import {
-  APEX_DOMAIN,
   LoggerService,
-  PORT,
-  asyncExitHook,
   doAfterInstanceFoundAction,
   doAfterServerStartAction,
   doAppMountedAction,
@@ -15,7 +12,8 @@ import {
   doRequestErrorAction,
   doRequestErrorMessageFilter,
   onInstanceLogAction,
-} from '../core'
+} from '../common'
+import { APEX_DOMAIN, PORT, asyncExitHook } from '../core'
 
 export const serve = async () => {
   const _proxyLogger = LoggerService().create('ProxyService')