CLI (#84)

* move to packages

* update deps

* update deps

* actions maintenance

* don't use blob

* cli

* fix default import

* use synthetic default imports

* remove comment

* cli packaging

* node 18 guard

* packages

* build system

* testing

* test pipeline

* pipelines

* changelog

* version bump

* update locales

* update deps

* update deps

* update dependecies

packages/cli/package.json

@@ -0,0 +1,37 @@
+{
+  "version": "2.3.0-beta.4",
+  "name": "cryptgeon",
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "dev": "./scripts/build.js --watch",
+    "build": "./scripts/build.js",
+    "package": "./scripts/package.js",
+    "bin": "run-s build package",
+    "prepublishOnly": "run-s build"
+  },
+  "main": "./dist/index.cjs",
+  "bin": {
+    "cryptgeon": "./dist/index.cjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@commander-js/extra-typings": "^10.0.3",
+    "@cryptgeon/shared": "workspace:*",
+    "@types/inquirer": "^9.0.3",
+    "@types/mime": "^3.0.1",
+    "@types/node": "^20.1.3",
+    "commander": "^10.0.1",
+    "esbuild": "^0.17.19",
+    "inquirer": "^9.2.2",
+    "mime": "^3.0.0",
+    "occulto": "^2.0.1",
+    "pkg": "^5.8.1",
+    "pretty-bytes": "^6.1.0",
+    "typescript": "^5.0.4"
+  }
+}

packages/cli/scripts/build.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+import { build, context } from 'esbuild'
+import pkg from '../package.json' assert { type: 'json' }
+
+const options = {
+  entryPoints: ['./src/index.ts'],
+  bundle: true,
+  minify: true,
+  platform: 'node',
+  outfile: './dist/index.cjs',
+  define: { VERSION: `"${pkg.version}"` },
+}
+
+const watch = process.argv.slice(2)[0] === '--watch'
+if (watch) (await context(options)).watch()
+else await build(options)

packages/cli/scripts/package.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+import { exec } from 'pkg'
+
+const targets = [
+  'node18-macos-arm64',
+  'node18-macos-x64',
+  'node18-linux-arm64',
+  'node18-linux-x64',
+  'node18-win-arm64',
+  'node18-win-x64',
+]
+
+for (const target of targets) {
+  console.log(`🚀 Building ${target}`)
+  await exec(['./dist/index.cjs', '--target', target, '--output', `./bin/${target.replace('node18', 'cryptgeon')}`])
+}

packages/cli/src/download.ts

@@ -0,0 +1,62 @@
+import { Adapters, get, info, setBase } from '@cryptgeon/shared'
+import inquirer from 'inquirer'
+import { access, constants, writeFile } from 'node:fs/promises'
+import { basename, resolve } from 'node:path'
+import { Hex } from 'occulto'
+import pretty from 'pretty-bytes'
+
+import { exit } from './utils'
+
+export async function download(url: URL) {
+  setBase(url.origin)
+  const id = url.pathname.split('/')[2]
+  await info(id).catch(() => exit('Note does not exist or is expired'))
+  const note = await get(id)
+
+  const password = url.hash.slice(1)
+  const key = Hex.decode(password)
+
+  const couldNotDecrypt = () => exit('Could not decrypt note. Probably an invalid password')
+  switch (note.meta.type) {
+    case 'file':
+      const files = await Adapters.Files.decrypt(note.contents, key).catch(couldNotDecrypt)
+      if (!files) {
+        exit('No files found in note')
+        return
+      }
+      const { names } = await inquirer.prompt([
+        {
+          type: 'checkbox',
+          message: 'What files should be saved?',
+          name: 'names',
+          choices: files.map((file) => ({
+            value: file.name,
+            name: `${file.name} - ${file.type} - ${pretty(file.size, { binary: true })}`,
+            checked: true,
+          })),
+        },
+      ])
+
+      const selected = files.filter((file) => names.includes(file.name))
+
+      if (!selected.length) exit('No files selected')
+
+      await Promise.all(
+        files.map(async (file) => {
+          let filename = resolve(file.name)
+          try {
+            // If exists -> prepend timestamp to not overwrite the current file
+            await access(filename, constants.R_OK)
+            filename = resolve(`${Date.now()}-${file.name}`)
+          } catch {}
+          await writeFile(filename, file.contents)
+          console.log(`Saved: ${basename(filename)}`)
+        })
+      )
+      break
+    case 'text':
+      const plaintext = await Adapters.Text.decrypt(note.contents, key).catch(couldNotDecrypt)
+      console.log(plaintext)
+      break
+  }
+}

packages/cli/src/index.ts

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+
+import { Argument, Option, program } from '@commander-js/extra-typings'
+import { setBase, status } from '@cryptgeon/shared'
+import prettyBytes from 'pretty-bytes'
+
+import { download } from './download.js'
+import { parseFile, parseNumber } from './parsers.js'
+import { uploadFiles, uploadText } from './upload.js'
+import { exit } from './utils.js'
+
+const defaultServer = process.env['CRYPTGEON_SERVER'] || 'https://cryptgeon.org'
+const server = new Option('-s --server <url>', 'the cryptgeon server to use').default(defaultServer)
+const files = new Argument('<file...>', 'Files to be sent').argParser(parseFile)
+const text = new Argument('<text>', 'Text content of the note')
+const password = new Option('-p --password <string>', 'manually set a password')
+const url = new Argument('<url>', 'The url to open')
+const views = new Option('-v --views <number>', 'Amount of views before getting destroyed').argParser(parseNumber)
+const minutes = new Option('-m --minutes <number>', 'Minutes before the note expires').argParser(parseNumber)
+
+// Node 18 guard
+parseInt(process.version.slice(1).split(',')[0]) < 18 && exit('Node 18 or higher is required')
+
+// @ts-ignore
+const version: string = VERSION
+
+async function checkConstrains(constrains: { views?: number; minutes?: number }) {
+  const { views, minutes } = constrains
+  if (views && minutes) exit('cannot set view and minutes constrains simultaneously')
+  if (!views && !minutes) constrains.views = 1
+
+  const response = await status()
+  if (views && views > response.max_views)
+    exit(`Only a maximum of ${response.max_views} views allowed. ${views} given.`)
+  if (minutes && minutes > response.max_expiration)
+    exit(`Only a maximum of ${response.max_expiration} minutes allowed. ${minutes} given.`)
+}
+
+program.name('cryptgeon').version(version).configureHelp({ showGlobalOptions: true })
+
+program
+  .command('info')
+  .addOption(server)
+  .action(async (options) => {
+    setBase(options.server)
+    const response = await status()
+    const formatted = {
+      ...response,
+      max_size: prettyBytes(response.max_size),
+    }
+    for (const key of Object.keys(formatted)) {
+      if (key.startsWith('theme_')) delete formatted[key as keyof typeof formatted]
+    }
+    console.table(formatted)
+  })
+
+const send = program.command('send')
+send
+  .command('file')
+  .addArgument(files)
+  .addOption(server)
+  .addOption(views)
+  .addOption(minutes)
+  .action(async (files, options) => {
+    setBase(options.server!)
+    await checkConstrains(options)
+    await uploadFiles(files, { views: options.views, expiration: options.minutes })
+  })
+send
+  .command('text')
+  .addArgument(text)
+  .addOption(server)
+  .addOption(views)
+  .addOption(minutes)
+  .action(async (text, options) => {
+    setBase(options.server!)
+    await checkConstrains(options)
+    await uploadText(text, { views: options.views, expiration: options.minutes })
+  })
+
+program
+  .command('open')
+  .addArgument(url)
+  .action(async (note, options) => {
+    try {
+      const url = new URL(note)
+      await download(url)
+    } catch {
+      exit('Invalid URL')
+    }
+  })
+
+program.parse()

packages/cli/src/parsers.ts

@@ -0,0 +1,27 @@
+import { InvalidArgumentError, InvalidOptionArgumentError } from '@commander-js/extra-typings'
+import { accessSync, constants } from 'node:fs'
+import { resolve } from 'node:path'
+
+export function parseFile(value: string, before: string[] = []) {
+  try {
+    const file = resolve(value)
+    accessSync(file, constants.R_OK)
+    return [...before, file]
+  } catch {
+    throw new InvalidArgumentError('cannot access file')
+  }
+}
+
+export function parseURL(value: string, _: URL): URL {
+  try {
+    return new URL(value)
+  } catch {
+    throw new InvalidArgumentError('is not a valid url')
+  }
+}
+
+export function parseNumber(value: string, _: number): number {
+  const n = parseInt(value, 10)
+  if (isNaN(n)) throw new InvalidOptionArgumentError('invalid number')
+  return n
+}

packages/cli/src/upload.ts

@@ -0,0 +1,48 @@
+import { readFile, stat } from 'node:fs/promises'
+import { basename } from 'node:path'
+
+import { Adapters, BASE, create, FileDTO, Note } from '@cryptgeon/shared'
+import mime from 'mime'
+import { AES, Hex, TypedArray } from 'occulto'
+
+import { exit } from './utils.js'
+
+type UploadOptions = Pick<Note, 'views' | 'expiration'>
+
+export async function upload(key: TypedArray, note: Note) {
+  try {
+    const result = await create(note)
+    const password = Hex.encode(key)
+    const url = `${BASE}/note/${result.id}#${password}`
+    console.log(`Note created under:\n\n${url}`)
+  } catch {
+    exit('Could not create note')
+  }
+}
+
+export async function uploadFiles(paths: string[], options: UploadOptions) {
+  const key = await AES.generateKey()
+  const files: FileDTO[] = await Promise.all(
+    paths.map(async (path) => {
+      const data = new Uint8Array(await readFile(path))
+      const stats = await stat(path)
+      const extension = path.substring(path.indexOf('.') + 1)
+      const type = mime.getType(extension) ?? 'application/octet-stream'
+      return {
+        name: basename(path),
+        size: stats.size,
+        contents: data,
+        type,
+      } satisfies FileDTO
+    })
+  )
+
+  const contents = await Adapters.Files.encrypt(files, key)
+  await upload(key, { ...options, contents, meta: { type: 'file' } })
+}
+
+export async function uploadText(text: string, options: UploadOptions) {
+  const key = await AES.generateKey()
+  const contents = await Adapters.Text.encrypt(text, key)
+  await upload(key, { ...options, contents, meta: { type: 'text' } })
+}

packages/cli/src/utils.ts

@@ -0,0 +1,6 @@
+import { exit as exitNode } from 'node:process'
+
+export function exit(message: string) {
+  console.error(message)
+  exitNode(1)
+}

packages/cli/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "es2022",
+    "moduleResolution": "node",
+    "noEmit": true,
+    "strict": true,
+    "allowSyntheticDefaultImports": true
+  }
+}