Merge pull request #117 from cupcakearmy/also-expose-api-methods-for-programmatic-usage

Also expose api methods for programmatic usage

.github/workflows/test.yaml

@@ -10,18 +10,18 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # Node
-      - uses: pnpm/action-setup@v2
-      - uses: actions/setup-node@v3
+      - uses: pnpm/action-setup@v3
+      - uses: actions/setup-node@v4
         with:
           cache: 'pnpm'
           node-version-file: '.nvmrc'
 
       # Docker
-      - uses: docker/setup-qemu-action@v2
-      - uses: docker/setup-buildx-action@v2
+      - uses: docker/setup-qemu-action@v3
+      - uses: docker/setup-buildx-action@v3
         with:
           install: true
 

.nvmrc

@@ -1 +1 @@
-v20.9.0
+v18.19.1

Dockerfile

@@ -1,14 +1,17 @@
 # FRONTEND
 FROM node:18-alpine as client 
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+
 WORKDIR /tmp
-RUN npm install -g pnpm@8
 COPY . .
 RUN pnpm install --frozen-lockfile
 RUN pnpm run build
 
 
 # BACKEND
-FROM rust:1.73-alpine as backend
+FROM rust:1.76-alpine as backend
 WORKDIR /tmp
 RUN apk add libc-dev openssl-dev alpine-sdk
 COPY ./packages/backend ./

docker-compose.dev.yaml

@@ -14,11 +14,12 @@ services:
     env_file: .dev.env
     depends_on:
       - redis
+    restart: unless-stopped
     ports:
       - 1234:8000
 
     healthcheck:
-      test: ["CMD", "curl", "--fail", "http://127.0.0.1:8000/api/live/"]
+      test: ['CMD', 'curl', '--fail', 'http://127.0.0.1:8000/api/live/']
       interval: 1m
       timeout: 3s
       retries: 2

package.json

@@ -1,5 +1,4 @@
 {
-  "packageManager": "pnpm@8.10.1",
   "scripts": {
     "dev:docker": "docker-compose -f docker-compose.dev.yaml up redis",
     "dev:packages": "pnpm --parallel run dev",
@@ -13,9 +12,10 @@
     "build": "pnpm run --recursive --filter=!@cryptgeon/backend build"
   },
   "devDependencies": {
-    "@playwright/test": "^1.39.0",
-    "@types/node": "^20.8.10",
+    "@playwright/test": "^1.42.1",
+    "@types/node": "^20.11.24",
     "npm-run-all": "^4.1.5",
     "shelljs": "^0.8.5"
-  }
+  },
+  "packageManager": "pnpm@8.15.4"
 }

packages/backend/Cargo.toml

@@ -3,7 +3,7 @@ name = "cryptgeon"
 version = "2.4.0"
 authors = ["cupcakearmy <hi@nicco.io>"]
 edition = "2021"
-rust-version = "1.73"
+rust-version = "1.76"
 
 [[bin]]
 name = "cryptgeon"

packages/cli/package.json

@@ -1,43 +1,49 @@
 {
-  "version": "2.4.0",
   "name": "cryptgeon",
+  "version": "2.4.0",
+  "homepage": "https://github.com/cupcakearmy/cryptgeon",
   "repository": {
     "type": "git",
     "url": "https://github.com/cupcakearmy/cryptgeon.git",
     "directory": "packages/cli"
   },
-  "homepage": "https://github.com/cupcakearmy/cryptgeon",
   "type": "module",
-  "engines": {
-    "node": ">=18"
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
   },
-  "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",
+  "types": "./dist/index.d.ts",
   "bin": {
-    "cryptgeon": "./dist/index.cjs"
+    "cryptgeon": "./dist/cli.cjs"
   },
   "files": [
     "dist"
   ],
+  "scripts": {
+    "bin": "run-s build package",
+    "build": "tsc && ./scripts/build.js",
+    "dev": "./scripts/build.js --watch",
+    "package": "./scripts/package.js",
+    "prepublishOnly": "run-s build"
+  },
   "devDependencies": {
-    "@commander-js/extra-typings": "^11.1.0",
+    "@commander-js/extra-typings": "^12.0.1",
     "@cryptgeon/shared": "workspace:*",
-    "@types/inquirer": "^9.0.6",
-    "@types/mime": "^3.0.3",
-    "@types/node": "^20.8.10",
-    "commander": "^11.1.0",
-    "esbuild": "^0.19.5",
-    "inquirer": "^9.2.11",
-    "mime": "^3.0.0",
-    "occulto": "^2.0.1",
+    "@types/inquirer": "^9.0.7",
+    "@types/mime": "^3.0.4",
+    "@types/node": "^20.11.24",
+    "commander": "^12.0.0",
+    "esbuild": "^0.20.1",
+    "inquirer": "^9.2.15",
+    "mime": "^4.0.1",
+    "occulto": "^2.0.3",
     "pkg": "^5.8.1",
     "pretty-bytes": "^6.1.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=18"
   }
 }

packages/cli/scripts/build.js

@@ -4,14 +4,28 @@ import { build, context } from 'esbuild'
 import pkg from '../package.json' assert { type: 'json' }
 
 const options = {
-  entryPoints: ['./src/index.ts'],
+  entryPoints: ['./src/cli.ts'],
   bundle: true,
   minify: true,
   platform: 'node',
-  outfile: './dist/index.cjs',
+  outfile: './dist/cli.cjs',
   define: { VERSION: `"${pkg.version}"` },
 }
 
 const watch = process.argv.slice(2)[0] === '--watch'
-if (watch) (await context(options)).watch()
-else await build(options)
+if (watch) {
+  ;(await context(options)).watch()
+} else {
+  await build(options)
+
+  // Also build internals to expose
+  await build({
+    entryPoints: ['./src/index.ts'],
+    bundle: true,
+    minify: true,
+    platform: 'node',
+    format: 'esm',
+    outfile: './dist/index.js',
+    define: { VERSION: `"${pkg.version}"` },
+  })
+}

packages/cli/scripts/package.js

@@ -13,5 +13,5 @@ const targets = [
 
 for (const target of targets) {
   console.log(`🚀 Building ${target}`)
-  await exec(['./dist/index.cjs', '--target', target, '--output', `./bin/${target.replace('node18', 'cryptgeon')}`])
+  await exec(['./dist/cli.cjs', '--target', target, '--output', `./bin/${target.replace('node18', 'cryptgeon')}`])
 }

packages/cli/src/cli.ts

@@ -0,0 +1,106 @@
+#!/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 { getStdin } from './stdin.js'
+import { upload } from './upload.js'
+import { checkConstrains, 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 all = new Option('-a --all', 'Save all files without prompt').default(false)
+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
+
+program.name('cryptgeon').version(version).configureHelp({ showGlobalOptions: true })
+
+program
+  .command('info')
+  .description('show information about the server')
+  .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').description('send a note')
+send
+  .command('file')
+  .addArgument(files)
+  .addOption(server)
+  .addOption(views)
+  .addOption(minutes)
+  .addOption(password)
+  .action(async (files, options) => {
+    setBase(options.server!)
+    await checkConstrains(options)
+    options.password ||= await getStdin()
+    try {
+      const url = await upload(files, { views: options.views, expiration: options.minutes, password: options.password })
+      console.log(`Note created:\n\n${url}`)
+    } catch {
+      exit('Could not create note')
+    }
+  })
+send
+  .command('text')
+  .addArgument(text)
+  .addOption(server)
+  .addOption(views)
+  .addOption(minutes)
+  .addOption(password)
+  .action(async (text, options) => {
+    setBase(options.server!)
+    await checkConstrains(options)
+    options.password ||= await getStdin()
+    try {
+      const url = await upload(text, { views: options.views, expiration: options.minutes, password: options.password })
+      console.log(`Note created:\n\n${url}`)
+    } catch {
+      exit('Could not create note')
+    }
+  })
+
+program
+  .command('open')
+  .description('open a link with text or files inside')
+  .addArgument(url)
+  .addOption(password)
+  .addOption(all)
+  .action(async (note, options) => {
+    try {
+      const url = new URL(note)
+      options.password ||= await getStdin()
+      try {
+        await download(url, options.all, options.password)
+      } catch (e) {
+        exit(e instanceof Error ? e.message : 'Unknown error occurred')
+      }
+    } catch {
+      exit('Invalid URL')
+    }
+  })
+
+program.parse()

packages/cli/src/download.ts

@@ -5,12 +5,12 @@ import { basename, resolve } from 'node:path'
 import { AES, Hex } from 'occulto'
 import pretty from 'pretty-bytes'
 
-import { exit } from './utils'
-
 export async function download(url: URL, all: boolean, suggestedPassword?: string) {
   setBase(url.origin)
   const id = url.pathname.split('/')[2]
-  const preview = await info(id).catch(() => exit('Note does not exist or is expired'))
+  const preview = await info(id).catch(() => {
+    throw new Error('Note does not exist or is expired')
+  })
 
   // Password
   let password: string
@@ -35,13 +35,14 @@ export async function download(url: URL, all: boolean, suggestedPassword?: strin
   const key = derivation ? (await AES.derive(password, derivation))[0] : Hex.decode(password)
   const note = await get(id)
 
-  const couldNotDecrypt = () => exit('Could not decrypt note. Probably an invalid password')
+  const couldNotDecrypt = new Error('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)
+      const files = await Adapters.Files.decrypt(note.contents, key).catch(() => {
+        throw couldNotDecrypt
+      })
       if (!files) {
-        exit('No files found in note')
-        return
+        throw new Error('No files found in note')
       }
 
       let selected: typeof files
@@ -63,7 +64,7 @@ export async function download(url: URL, all: boolean, suggestedPassword?: strin
         selected = files.filter((file) => names.includes(file.name))
       }
 
-      if (!selected.length) exit('No files selected')
+      if (!selected.length) throw new Error('No files selected')
       await Promise.all(
         selected.map(async (file) => {
           let filename = resolve(file.name)
@@ -79,7 +80,9 @@ export async function download(url: URL, all: boolean, suggestedPassword?: strin
 
       break
     case 'text':
-      const plaintext = await Adapters.Text.decrypt(note.contents, key).catch(couldNotDecrypt)
+      const plaintext = await Adapters.Text.decrypt(note.contents, key).catch(() => {
+        throw couldNotDecrypt
+      })
       console.log(plaintext)
       break
   }

packages/cli/src/index.ts

@@ -1,104 +1,4 @@
-#!/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 { getStdin } from './stdin.js'
-import { upload } 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 all = new Option('-a --all', 'Save all files without prompt').default(false)
-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')
-  .description('show information about the server')
-  .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').description('send a note')
-send
-  .command('file')
-  .addArgument(files)
-  .addOption(server)
-  .addOption(views)
-  .addOption(minutes)
-  .addOption(password)
-  .action(async (files, options) => {
-    setBase(options.server!)
-    await checkConstrains(options)
-    options.password ||= await getStdin()
-    await upload(files, { views: options.views, expiration: options.minutes, password: options.password })
-  })
-send
-  .command('text')
-  .addArgument(text)
-  .addOption(server)
-  .addOption(views)
-  .addOption(minutes)
-  .addOption(password)
-  .action(async (text, options) => {
-    setBase(options.server!)
-    await checkConstrains(options)
-    options.password ||= await getStdin()
-    await upload(text, { views: options.views, expiration: options.minutes, password: options.password })
-  })
-
-program
-  .command('open')
-  .description('open a link with text or files inside')
-  .addArgument(url)
-  .addOption(password)
-  .addOption(all)
-  .action(async (note, options) => {
-    try {
-      const url = new URL(note)
-      options.password ||= await getStdin()
-      await download(url, options.all, options.password)
-    } catch {
-      exit('Invalid URL')
-    }
-  })
-
-program.parse()
+export * from '@cryptgeon/shared'
+export * from './download.js'
+export * from './upload.js'
+export * from './utils.js'

packages/cli/src/upload.ts

@@ -3,49 +3,43 @@ import { basename } from 'node:path'
 
 import { Adapters, BASE, create, FileDTO, Note, NoteMeta } from '@cryptgeon/shared'
 import mime from 'mime'
-import { AES, Hex, TypedArray } from 'occulto'
+import { AES, Hex } from 'occulto'
 
-import { exit } from './utils.js'
+export type UploadOptions = Pick<Note, 'views' | 'expiration'> & { password?: string }
 
-type UploadOptions = Pick<Note, 'views' | 'expiration'> & { password?: string }
+export async function upload(input: string | string[], options: UploadOptions): Promise<string> {
+  const { password, ...noteOptions } = options
+  const derived = options.password ? await AES.derive(options.password) : undefined
+  const key = derived ? derived[0] : await AES.generateKey()
 
-export async function upload(input: string | string[], options: UploadOptions) {
-  try {
-    const { password, ...noteOptions } = options
-    const derived = options.password ? await AES.derive(options.password) : undefined
-    const key = derived ? derived[0] : await AES.generateKey()
-
-    let contents: string
-    let type: NoteMeta['type']
-    if (typeof input === 'string') {
-      contents = await Adapters.Text.encrypt(input, key)
-      type = 'text'
-    } else {
-      const files: FileDTO[] = await Promise.all(
-        input.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
-        })
-      )
-      contents = await Adapters.Files.encrypt(files, key)
-      type = 'file'
-    }
-
-    // Create the actual note and upload it.
-    const note: Note = { ...noteOptions, contents, meta: { type, derivation: derived?.[1] } }
-    const result = await create(note)
-    let url = `${BASE}/note/${result.id}`
-    if (!derived) url += `#${Hex.encode(key)}`
-    console.log(`Note created:\n\n${url}`)
-  } catch {
-    exit('Could not create note')
+  let contents: string
+  let type: NoteMeta['type']
+  if (typeof input === 'string') {
+    contents = await Adapters.Text.encrypt(input, key)
+    type = 'text'
+  } else {
+    const files: FileDTO[] = await Promise.all(
+      input.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
+      })
+    )
+    contents = await Adapters.Files.encrypt(files, key)
+    type = 'file'
   }
+
+  // Create the actual note and upload it.
+  const note: Note = { ...noteOptions, contents, meta: { type, derivation: derived?.[1] } }
+  const result = await create(note)
+  let url = `${BASE}/note/${result.id}`
+  if (!derived) url += `#${Hex.encode(key)}`
+  return url
 }

packages/cli/src/utils.ts

@@ -1,6 +1,19 @@
+import { status } from '@cryptgeon/shared'
 import { exit as exitNode } from 'node:process'
 
 export function exit(message: string) {
   console.error(message)
   exitNode(1)
 }
+
+export 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.`)
+}

packages/cli/tsconfig.json

@@ -3,8 +3,11 @@
     "target": "es2022",
     "module": "es2022",
     "moduleResolution": "node",
-    "noEmit": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
     "strict": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
     "allowSyntheticDefaultImports": true
   }
 }

packages/frontend/package.json

@@ -13,26 +13,27 @@
 	},
 	"type": "module",
 	"devDependencies": {
-		"@lokalise/node-api": "^12.0.0",
-		"@sveltejs/adapter-static": "^2.0.3",
-		"@sveltejs/kit": "^1.27.2",
-		"@types/file-saver": "^2.0.6",
+		"@lokalise/node-api": "^12.1.0",
+		"@sveltejs/adapter-static": "^3.0.1",
+		"@sveltejs/kit": "^2.5.2",
+		"@sveltejs/vite-plugin-svelte": "^3.0.2",
+		"@types/file-saver": "^2.0.7",
 		"@zerodevx/svelte-toast": "^0.9.5",
 		"adm-zip": "^0.5.10",
-		"dotenv": "^16.3.1",
-		"svelte": "^4.2.2",
-		"svelte-check": "^3.5.2",
+		"dotenv": "^16.4.5",
+		"svelte": "^4.2.12",
+		"svelte-check": "^3.6.6",
 		"svelte-intl-precompile": "^0.12.3",
 		"tslib": "^2.6.2",
-		"typescript": "^5.2.2",
-		"vite": "^4.5.0"
+		"typescript": "^5.3.3",
+		"vite": "^5.1.4"
 	},
 	"dependencies": {
 		"@cryptgeon/shared": "workspace:*",
 		"@fontsource/fira-mono": "^5.0.8",
 		"copy-to-clipboard": "^3.3.3",
 		"file-saver": "^2.0.5",
-		"occulto": "^2.0.1",
+		"occulto": "^2.0.3",
 		"pretty-bytes": "^6.1.1",
 		"qrious": "^4.0.2"
 	}

packages/frontend/svelte.config.js

@@ -1,6 +1,6 @@
 import adapter from '@sveltejs/adapter-static'
 import precompileIntl from 'svelte-intl-precompile/sveltekit-plugin'
-import { vitePreprocess } from '@sveltejs/kit/vite'
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'
 
 export default {
 	preprocess: vitePreprocess([precompileIntl('locales')]),

packages/shared/package.json

@@ -14,9 +14,9 @@
     "build": "tsc"
   },
   "devDependencies": {
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "occulto": "^2.0.1"
+    "occulto": "^2.0.3"
   }
 }

test/utils.ts

@@ -88,7 +88,7 @@ export async function checkLinkDoesNotExist(page: Page, link: string) {
 }
 
 export async function CLI(...args: string[]) {
-  return await exec('./packages/cli/dist/index.cjs', args, {
+  return await exec('./packages/cli/dist/cli.cjs', args, {
     env: {
       ...process.env,
       CRYPTGEON_SERVER: 'http://localhost:1234',