pockethost 1.6.1 → 3.0.0

package/package.json

@@ -1,67 +1,69 @@
 {
   "name": "pockethost",
-  "version": "1.6.1",
-  "author": {
-    "name": "Ben Allfree",
-    "url": "https://github.com/benallfree"
+  "version": "3.0.0",
+  "description": "The PocketHost CLI: deploy, sync, and tail logs for your PocketHost instances",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pockethost/pockethost.git",
+    "directory": "packages/cli"
   },
+  "homepage": "https://pockethost.io",
+  "keywords": [
+    "cli",
+    "pocketbase",
+    "pockethost"
+  ],
+  "author": "Ben Allfree",
   "license": "MIT",
-  "main": "./common.ts",
-  "module": "./common.ts",
+  "bugs": {
+    "url": "https://github.com/pockethost/pockethost/issues"
+  },
   "type": "module",
   "bin": {
-    "pockethost": "src/cli/index.ts"
+    "pockethost": "dist/cli.js"
+  },
+  "engines": {
+    "node": ">=20"
   },
+  "files": [
+    "dist",
+    "CHANGELOG.md",
+    "README.md"
+  ],
   "dependencies": {
-    "@s-libs/micro-dash": "^16.1.0",
-    "ajv": "^8.12.0",
-    "boolean": "^3.2.0",
-    "bottleneck": "^2.19.5",
-    "chalk": "^5.3.0",
-    "commander": "^11.1.0",
-    "dotenv": "^16.3.1",
-    "env-paths": "^3.0.0",
-    "exit-hook": "^4.0.0",
-    "express": "^4.18.2",
-    "express-async-errors": "^3.1.1",
-    "get-port": "^6.1.2",
-    "http-proxy": "^1.18.1",
-    "immer": "^10.1.1",
-    "json-stringify-safe": "^5.0.1",
-    "listr2": "^8.2.3",
-    "minimist": "^1.2.8",
-    "nanoid": "^5.0.2",
-    "node-fetch": "^3.3.2",
-    "pocketbase": "^0.21.3",
-    "rimraf": "^5.0.5",
-    "semver": "^7.6.2",
-    "tmp": "^0.2.1",
-    "tsx": "^4.15.7",
-    "type-fest": "^4.6.0",
-    "typescript": "^5.4.5",
-    "update-notifier": "^7.0.0",
-    "url-pattern": "^1.0.3",
-    "@pockethost/plugin-auto-admin": "^0.2.0",
-    "@pockethost/plugin-console-logger": "^0.3.0",
-    "@pockethost/plugin-launcher-spawn": "^0.4.0"
+    "ssh2-sftp-client": "^12.1.1"
   },
   "devDependencies": {
-    "@types/conventional-commits-parser": "^5.0.0",
-    "@types/express": "^4.17.21",
-    "@types/http-proxy": "^1.17.13",
-    "@types/inquirer": "^9.0.7",
-    "@types/json-stringify-safe": "^5.0.2",
-    "@types/minimist": "^1.2.5",
-    "@types/node": "^20.8.10",
-    "@types/semver": "^7.5.4",
-    "@types/tmp": "^0.2.5",
-    "@types/update-notifier": "^6.0.8",
-    "conventional-commits-parser": "^5.0.0"
+    "@inquirer/prompts": "^8.5.2",
+    "@microsoft/fetch-event-source": "github:pockethost/fetch-event-source#ebe3b7122647b48b93fd11effbbfb915d98956b0",
+    "@types/node": "^20.0.0",
+    "@types/ssh2-sftp-client": "^9.0.6",
+    "bottleneck": "^2.19.5",
+    "chokidar": "^5.0.0",
+    "commander": "^15.0.0",
+    "env-paths": "^4.0.0",
+    "env-var": "^7.5.0",
+    "esbuild": "^0.28.1",
+    "glob": "^13.0.6",
+    "multimatch": "^8.0.0",
+    "ora": "^9.4.0",
+    "pocketbase": "^0.27.0",
+    "pretty-bytes": "^7.1.0",
+    "pretty-ms": "^9.3.0",
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.8"
+  },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "es5"
   },
   "scripts": {
-    "check-types": "tsc --noEmit ",
-    "lint": "prettier -c \"./**/*.{ts,js,cjs,svelte,json}\"",
-    "dev": "NODE_ENV=development tsx --watch ./src/cli/index.ts",
-    "start": "tsx ./src/cli/index.ts"
+    "build": "node scripts/build.mjs",
+    "check:types": "tsc --noEmit",
+    "dev": "node --import tsx ./src/cli.ts",
+    "start": "node --import tsx ./src/cli.ts",
+    "test": "vitest run"
   }
 }

package/changesetx.ts

@@ -1,110 +0,0 @@
-#!/usr/bin/env tsx
-import { execSync } from 'child_process'
-import { sync } from 'conventional-commits-parser'
-import fs, { readFileSync } from 'fs'
-import minimist from 'minimist'
-import { dirname, join } from 'path'
-import { fileURLToPath } from 'url'
-
-const __dirname = dirname(fileURLToPath(import.meta.url))
-const repoRootDir = join(__dirname, `../..`)
-
-const argv = minimist(process.argv.slice(2))
-const commitMessage = argv._[0]!
-const { type, subject } = sync(commitMessage)
-if (!type) {
-  console.log('Invalid commit message type')
-  process.exit(1)
-}
-
-function getStagedPackageNames(filePaths: string[]): string[] {
-  const packageNames = new Set<string>()
-
-  filePaths.forEach((filePath) => {
-    const packageName = getPackageName(filePath)
-    if (packageName) {
-      packageNames.add(packageName)
-    }
-  })
-
-  return Array.from(packageNames)
-}
-
-function getPackageName(filePath: string): string | null {
-  const packagePath = filePath.split('/').slice(0, 2).join('/')
-  const packageJsonPath = join(repoRootDir, `${packagePath}/package.json`)
-  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'))
-  try {
-    return packageJson.name
-  } catch (error) {
-    return null
-  }
-}
-
-function getStagedFileNames(): string[] {
-  const output = execSync('git diff --name-only --cached').toString()
-  const fileNames = output
-    .trim()
-    .split('\n')
-    .filter((fileName) => fileName.startsWith(`packages/`))
-  return fileNames
-}
-
-async function createChangesetFile() {
-  const fileNames = getStagedFileNames()
-  const packageNames = getStagedPackageNames(fileNames)
-
-  if (packageNames.length === 0) {
-    console.log('No packages staged for commit')
-    process.exit(0)
-  }
-  console.log('Staged packages:', packageNames)
-
-  const prefixMap = {
-    feat: 'minor',
-    enh: 'minor',
-    fix: 'patch',
-    docs: 'patch',
-    chore: 'patch',
-  } as const
-
-  if (!(type! in prefixMap)) {
-    console.log('Invalid prefix found in commit message')
-    process.exit(1)
-  }
-
-  const versionType = prefixMap[type as keyof typeof prefixMap]
-
-  const changesetFile = [
-    `---`,
-    ...packageNames.map((packageName) => `'${packageName}': ${versionType}`),
-    `---`,
-    ``,
-    subject,
-  ].join('\n')
-  return changesetFile
-}
-
-async function writeChangesetFile(changesetFile: string) {
-  const filePath = join(repoRootDir, `.changeset`, `${+new Date()}.md`)
-  try {
-    fs.writeFileSync(filePath, changesetFile)
-    console.log(`Changeset file written successfully at ${filePath}`)
-    execSync(`git add ${filePath}`)
-    console.log(`Changeset file added to git`)
-  } catch (error) {
-    console.error(`Error writing changeset file: ${error}`)
-  }
-}
-
-function commit() {
-  execSync(`git commit -m "${commitMessage}"`)
-}
-
-async function main() {
-  const changesetFile = await createChangesetFile()
-  await writeChangesetFile(changesetFile)
-  commit()
-}
-
-main()

package/common.ts

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

package/core.ts

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

package/readme.md

@@ -1,129 +0,0 @@
-# PocketHost
-
-PocketHost is the open source multi-tenant PocketBase server. PocketHost can run dozens, hundreds, even thousands of PocketBase instances on a single server or across a global cloud.
-
-Extend PocketHost with its Plugin ecosystem. Start with the bare-bones dev server and add plugins to grow your enterprise into a global cloud.
-
----
-
-### Sponsored by https://pockethost.io. Instantly host your PocketBase projects.
-
----
-
-<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=2 orderedList=false} -->
-
-<!-- code_chunk_output -->
-
-- [Quickstart](#quickstart)
-- [Introduction](#introduction)
-- [The magic `serve` command](#the-magic-serve-command)
-- [Configuration](#configuration)
-- [Plugins Directory](#plugins-directory)
-- [Writing Plugins](#writing-plugins)
-- [Support](#support)
-
-<!-- /code_chunk_output -->
-
----
-
-## Quickstart
-
-```
-npx pockethost serve
-```
-
-## Introduction
-
-PocketHost is a multitenant PocketBase hosting system. With it, you can run multiple instances of PocketBase on different subdomains, all on the same server.
-
-Use PocketHost for development or production purposes.
-
-PocketHost can be easily extended using its thoughtful plugin architecture. By choosing additional plugins, PocketHost's features can be extended according to your exact needs. You can even write your own plugins.
-
-## The magic `serve` command
-
-`pockethost serve` is a special command that can be decorated with plugins. Plugins can respond to the `serve` command by running their own services.
-
-By convention, plugins that have some kind of `serve` functionality such as running a server, will make it available in two ways.
-
-The first way runs ONLY the plugin's `serve` functionality:
-
-```bash
-pockethost <plugin-name> serve
-```
-
-The second way runs ALL `serve` functionality from ALL plugins:
-
-```bash
-pockethost serve
-```
-
-The exact plugins can also be narrowed:
-
-```bash
-pockethost serve --only=plugin1,plugin2,plugin3
-```
-
-See the plugin authoring guide for more information on how to make a plugin that responds to both methods.
-
-## Configuration
-
-PocketHost supports configuration by environment variable, `.env` file, and also built-in settings via `pockethost config`.
-
-All PocketHost variables begin with `PH_`.
-
-PocketHost will search the current directory for an `.env` when it loads. Anything in `.env` will be merged with and override any `<PH_HOME>/.env` that may exist.
-
-Use `pockethost config` to list and set global defaults.
-
-### Core Variables
-
-See `pockethost config ls` for a full list of variables. Plugin variables will also be listed for loaded plugins.
-
-| Name           | Default                    | Discussion                                                                    |
-| -------------- | -------------------------- | ----------------------------------------------------------------------------- |
-| PH_HOME        | `~/.pockethost`            | PocketHost's home directory where it holds all data.                          |
-| PH_APEX_DOMAIN | `pockethost.lvh.me`        | The apex domain used for routing and determining instance names.              |
-| PH_PORT        | `3000`                     | The port PocketHost listens on                                                |
-| PH_DEBUG       | `NODE_ENV==='development'` | Debug mode                                                                    |
-| PH_PLUGINS     | (see below)                | A comma-separated list of Plugins to load                                     |
-| PH_DATA_DIR    | `~/.pockethost/data`       | The root directory for storing PocketHost data, including instance databases. |
-| PH_DEV         | `NODE_ENV==='development'` | Whether PocketHost is running in development mode.                            |
-
-### Default Plugins
-
-- `@pockethost/plugin-console-logger`
-- `@pockethost/plugin-launcher-spawn`
-- `@pockethost/plugin-auto-admin`
-
-## Plugins Directory
-
-PocketHost uses an action/filter architecture to support a growing list plugins. Some plugins have a CLI component, whereas others add purely programmatic support to alter how PocketHost works.
-
-### Core plugins
-
-These plugins are maintained by the PocketHost project.
-
-| Name                                           | Description                                                                                                             |
-| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `@pockethost/plugin-console-logger`            | Routes log messages to the console                                                                                      |
-| `@pockethost/plugin-auto-admin`                | Auto-creates a default admin account on instance launch                                                                 |
-| `@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 |
-| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| plugin-launcher-docker | Launches PocketBase instances via Docker. This is useful for running untrusted PocketBase code and instances. pockethost.io uses this. |
-| plugin-waf | A Web Application Firewall |
-| plugin-waf-enforce-ssl | Enforce SSL at the WAF
-
-## Writing Plugins
-
-See the [Plugin Authoring Guide](https://github.com/pockethost/pockethost/blob/master/packages/pockethost/plugin-guide.md) for details about how to write your own plugins.
-
-## Support
-
-PocketHost has a thriving [Discord community](https://discord.gg/nVTxCMEcGT).

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

@@ -1,28 +0,0 @@
-import { Command } from 'commander'
-import { listConfig, setConfig, unsetConfig } from '../../../core'
-
-export const ConfigCommand = () => {
-  const cmd = new Command(`config`)
-    .description(`Set global config defaults`)
-    .addCommand(
-      new Command(`set`)
-        .argument(`<name>`, `Config name`)
-        .argument(`<value>`, `Config value`)
-        .description(`Set a config value`)
-        .action(setConfig),
-    )
-
-    .addCommand(
-      new Command(`unset`)
-        .argument(`<name>`, `Config name`)
-        .description(`Unset a config value`)
-        .action(unsetConfig),
-    )
-    .addCommand(
-      new Command(`list`)
-        .description(`List all config values`)
-        .alias(`ls`)
-        .action(listConfig),
-    )
-  return cmd
-}

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

@@ -1,81 +0,0 @@
-import { Command } from 'commander'
-import { readFileSync } from 'fs'
-import { error, info } from '../..'
-import { PH_PLUGINS, PH_PROJECT_DIR } from '../../../constants'
-import { appendConfig, filterConfig } from '../../../core'
-import { getCompatibleVersions, getPackageJson, removePackage } from './util'
-
-export const PluginCommand = () => {
-  const cmd = new Command(`plugin`)
-    .description(`Manage PocketHost plugins`)
-    .addCommand(
-      new Command(`install`)
-        .alias(`i`)
-        .argument(`<name>`, `NPM registry plugin name`)
-        .description(`Install a plugin`)
-        .action(async (name: string) => {
-          try {
-            const pkg = JSON.parse(
-              readFileSync(PH_PROJECT_DIR(`package.json`), 'utf8').toString(),
-            )
-            const { version } = pkg
-            await getCompatibleVersions(`pockethost`, version, [name])
-
-            appendConfig(`PH_PLUGINS`, name)
-          } catch (e) {
-            error(`${e}`)
-          }
-        }),
-    )
-
-    .addCommand(
-      new Command(`list`)
-        .alias(`ls`)
-        .description(`List plugins`)
-        .action(async (name: string) => {
-          try {
-            for (const plugin of PH_PLUGINS()) {
-              const pkg = await getPackageJson(plugin)
-              info(`${plugin}@${pkg.version} - ${pkg?.description}`)
-            }
-          } catch (e) {
-            error(`${e}`)
-          }
-        }),
-    )
-
-    .addCommand(
-      new Command(`remove`)
-        .alias(`rm`)
-        .alias(`uninstall`)
-        .alias(`delete`)
-        .argument(`<name>`, `Plugin name`)
-        .description(`Remove a plugin`)
-        .action(async (name) => {
-          try {
-            await removePackage(name)
-            filterConfig(`PH_PLUGINS`, name)
-          } catch (e) {
-            error(`${e}`)
-          }
-        }),
-    )
-
-    .addCommand(
-      new Command(`update`)
-        .alias(`up`)
-        .description(`Update all plugins`)
-        .action(async () => {
-          try {
-            const pkg = JSON.parse(
-              readFileSync(PH_PROJECT_DIR(`package.json`), 'utf8').toString(),
-            )
-            const { version } = pkg
-            await getCompatibleVersions(`pockethost`, version, PH_PLUGINS())
-          } catch (e) {
-            error(`${e}`)
-          }
-        }),
-    )
-  return cmd
-}

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

@@ -1,140 +0,0 @@
-import { exec } from 'child_process'
-import fs from 'fs/promises'
-import { Listr, ListrTask } from 'listr2'
-import { createRequire } from 'module'
-import fetch from 'node-fetch'
-import semver from 'semver'
-import util from 'util'
-
-const execPromise = util.promisify(exec)
-const require = createRequire(import.meta.url)
-
-export async function getPackageJson(packageName: string): Promise<any | null> {
-  try {
-    const packageJsonPath = require.resolve(`${packageName}/package.json`)
-    const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'))
-    return packageJson
-  } catch (error) {
-    return null
-  }
-}
-
-export async function fetchPackageData(
-  packageName: string,
-): Promise<any | null> {
-  const npmRegistryUrl = `https://registry.npmjs.org/${packageName}`
-  try {
-    const response = await fetch(npmRegistryUrl)
-    return await response.json()
-  } catch (error) {
-    return null
-  }
-}
-
-async function installPackage(
-  packageName: string,
-  version: string,
-): Promise<void> {
-  try {
-    await execPromise(`npm install -g ${packageName}@${version}`)
-  } catch (e) {
-    throw new Error(`Error installing ${packageName}@${version}: ${e}`)
-  }
-}
-
-export async function removePackage(packageName: string): Promise<void> {
-  try {
-    await execPromise(`npm remove -g ${packageName}`)
-  } catch (e) {
-    throw new Error(`Error removing ${packageName}: ${e}`)
-  }
-}
-
-async function checkPackageCompatibility(
-  packageA: string,
-  versionA: string,
-  packageB: string,
-): Promise<string> {
-  const localPackageJson = await getPackageJson(packageB)
-
-  if (localPackageJson) {
-    const { version: localPackageBVersion, dependencies } = localPackageJson
-
-    if (dependencies && semver.satisfies(versionA, dependencies[packageA])) {
-      return `Local ${packageB}@${localPackageBVersion} is already compatible with ${packageA}@${versionA}`
-    }
-  }
-
-  const packageBData = await fetchPackageData(packageB)
-  if (!packageBData) {
-    throw new Error(`Error fetching data for ${packageB}`)
-  }
-
-  const versions = packageBData.versions
-  let latestCompatibleVersion: string | null = null
-
-  for (const version in versions) {
-    const dependencies = versions[version].dependencies
-    if (
-      dependencies &&
-      packageA in dependencies &&
-      semver.satisfies(versionA, dependencies[packageA])
-    ) {
-      if (
-        !latestCompatibleVersion ||
-        semver.gt(version, latestCompatibleVersion)
-      ) {
-        latestCompatibleVersion = version
-      }
-    }
-  }
-
-  if (latestCompatibleVersion) {
-    await installPackage(packageB, latestCompatibleVersion)
-    return `${packageB}@${latestCompatibleVersion} installed successfully`
-  } else {
-    throw new Error(
-      `No compatible version of ${packageB} found for ${packageA}@${versionA}`,
-    )
-  }
-}
-
-export async function getCompatibleVersions(
-  packageA: string,
-  versionA: string,
-  packagesB: string[],
-): Promise<void> {
-  const tasks = packagesB.map(
-    (packageB) =>
-      ({
-        title: `Checking ${packageB}...`,
-        task: async (_, task) => {
-          try {
-            const result = await checkPackageCompatibility(
-              packageA,
-              versionA,
-              packageB,
-            )
-            task.output = result
-          } catch (error) {
-            task.output = `${error}`
-            throw error
-          }
-        },
-      }) as ListrTask,
-  )
-
-  const listr = new Listr(tasks, {
-    concurrent: true,
-    rendererOptions: { collapseSubtasks: false },
-  })
-
-  await listr.run()
-}
-
-// Example usage
-// const packageA = 'express'
-// const versionA = '4.17.1'
-// const packagesB = ['some-package', 'another-package', 'yet-another-package']
-
-// getCompatibleVersions(packageA, versionA, packagesB)

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

@@ -1,36 +0,0 @@
-import { Command } from 'commander'
-import {
-  LoggerService,
-  doServeAction,
-  doServeSlugsFilter,
-} from '../../../common'
-
-type Options = {
-  only: string[]
-}
-
-export const ServeCommand = async () => {
-  const serveSlugs = await doServeSlugsFilter([])
-
-  const cmd = new Command(`serve`)
-    .description(`Run PocketHost`)
-    .option(
-      `-o, --only <only>`,
-      `Only run the specified services`,
-      (s) =>
-        s
-          .split(/,/)
-          .map((s) => s.trim())
-          .filter((s) => serveSlugs.includes(s)),
-      serveSlugs,
-    )
-    .action(async (options: Options, cmd: Command) => {
-      const logger = LoggerService().create(`ServeCommand`)
-      const { dbg, error, info, warn } = logger
-      info(`Starting`)
-
-      const { only } = options
-      await doServeAction({ only })
-    })
-  return cmd
-}