Merge pull request #145 from cupcakearmy/better-programmatic-access

better programmatic access

.gitignore

@@ -8,3 +8,4 @@ target
 
 # Testing
 test-results
+tmp

.nvmrc

@@ -1 +1 @@
-v20.11.1
+v22.7.0

Dockerfile

@@ -1,5 +1,5 @@
 # FRONTEND
-FROM node:20-alpine as client 
+FROM node:22-alpine as client 
 ENV PNPM_HOME="/pnpm"
 ENV PATH="$PNPM_HOME:$PATH"
 RUN corepack enable
@@ -11,17 +11,17 @@ RUN pnpm run build
 
 
 # BACKEND
-FROM rust:1.76-alpine as backend
+FROM rust:1.80-alpine as backend
 WORKDIR /tmp
 RUN apk add --no-cache libc-dev openssl-dev alpine-sdk
 COPY ./packages/backend ./
-RUN cargo build --release
+RUN RUSTFLAGS="-Ctarget-feature=-crt-static" cargo build --release
 
 
 # RUNNER
 FROM alpine:3.19
 WORKDIR /app
-RUN apk add --no-cache curl 
+RUN apk add --no-cache curl libgcc
 COPY --from=backend /tmp/target/release/cryptgeon .
 COPY --from=client /tmp/packages/frontend/build ./frontend
 ENV FRONTEND_PATH="./frontend"

README.md

@@ -141,12 +141,16 @@ There is a [guide](https://mariushosting.com/how-to-install-cryptgeon-on-your-sy
 - English by [DB Tech](https://www.youtube.com/watch?v=S0jx7wpOfNM) [Previous Video](https://www.youtube.com/watch?v=JhpIatD06vE)
 - German by [ApfelCast](https://www.youtube.com/watch?v=84ZMbE9AkHg)
 
+### Written Guides
+
+- French by [zarevskaya](https://belginux.com/installer-cryptgeon-avec-docker/)
+
 ## Development
 
 **Requirements**
 
-- `pnpm`: `>=6`
+- `pnpm`: `>=9`
-- `node`: `>=18`
+- `node`: `>=22`
 - `rust`: edition `2021`
 
 **Install**

docker-compose.dev.yaml

@@ -1,8 +1,6 @@
 # DEV Compose file.
 # For a production file see: README.md
 
-version: '3.8'
-
 services:
   redis:
     image: redis:7-alpine

docker-compose.yaml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 services:
   redis:
     image: redis:7-alpine

package.json

@@ -1,6 +1,6 @@
 {
   "scripts": {
-    "dev:docker": "docker-compose -f docker-compose.dev.yaml up redis",
+    "dev:docker": "docker compose -f docker-compose.dev.yaml up redis",
     "dev:packages": "pnpm --parallel run dev",
     "dev": "run-p dev:*",
     "docker:up": "docker compose -f docker-compose.dev.yaml up",
@@ -12,10 +12,10 @@
     "build": "pnpm run --recursive --filter=!@cryptgeon/backend build"
   },
   "devDependencies": {
-    "@playwright/test": "^1.42.1",
+    "@playwright/test": "^1.46.1",
-    "@types/node": "^20.11.28",
+    "@types/node": "^22.5.0",
     "npm-run-all": "^4.1.5",
     "shelljs": "^0.8.5"
   },
-  "packageManager": "pnpm@8.15.4"
+  "packageManager": "pnpm@9.8.0"
 }

packages/backend/Cargo.toml

@@ -1,9 +1,9 @@
 [package]
 name = "cryptgeon"
-version = "2.6.0"
+version = "2.7.0"
 authors = ["cupcakearmy <hi@nicco.io>"]
 edition = "2021"
-rust-version = "1.76"
+rust-version = "1.80"
 
 [[bin]]
 name = "cryptgeon"
@@ -22,4 +22,4 @@ dotenv = "0.15"
 mime = "0.3"
 env_logger = "0.9"
 log = "0.4"
-redis = "0.23"
+redis = { version = "0.25.2", features = ["tls-native-tls"] }

packages/backend/src/store.rs

@@ -36,7 +36,7 @@ pub fn set(id: &String, note: &Note) -> Result<(), &'static str> {
     match note.expiration {
         Some(e) => {
             let seconds = e - now();
-            conn.expire(id, seconds as usize)
+            conn.expire(id, seconds as i64)
                 .map_err(|_| "Unable to set expiration on notion")?
         }
         None => {}

packages/cli/build.js

@@ -0,0 +1,14 @@
+import pkg from './package.json' with { type: 'json' }
+import { build } from 'tsup'
+
+const watch = process.argv.slice(2)[0] === '--watch'
+
+await build({
+  entry: ['src/index.ts', 'src/cli.ts'],
+  dts: true,
+  minify: true,
+  format: ['esm', 'cjs'],
+  clean: true,
+  define: { VERSION: `"${pkg.version}"` },
+  watch,
+})

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cryptgeon",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "homepage": "https://github.com/cupcakearmy/cryptgeon",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "type": "module",
   "exports": {
-    ".": "./dist/index.mjs"
+    ".": "./dist/index.js"
   },
   "types": "./dist/index.d.ts",
   "bin": {
@@ -20,8 +20,8 @@
   ],
   "scripts": {
     "bin": "run-s build package",
-    "build": "rm -rf dist && tsc && ./scripts/build.js",
+    "build": "tsc && node build.js",
-    "dev": "./scripts/build.js --watch",
+    "dev": "node build.js --watch",
     "prepublishOnly": "run-s build"
   },
   "devDependencies": {
@@ -31,11 +31,11 @@
     "@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",
     "pretty-bytes": "^6.1.1",
+    "tsup": "^8.2.4",
     "typescript": "^5.3.3"
   },
   "engines": {

packages/cli/scripts/build.js

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

packages/cli/src/cli.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { Argument, Option, program } from '@commander-js/extra-typings'
-import { setBase, status } from '@cryptgeon/shared'
+import { setOptions, status } from '@cryptgeon/shared'
 import prettyBytes from 'pretty-bytes'
 
 import { download } from './download.js'
@@ -33,7 +33,7 @@ program
   .description('show information about the server')
   .addOption(server)
   .action(async (options) => {
-    setBase(options.server)
+    setOptions({ server: options.server })
     const response = await status()
     const formatted = {
       ...response,
@@ -54,7 +54,7 @@ send
   .addOption(minutes)
   .addOption(password)
   .action(async (files, options) => {
-    setBase(options.server!)
+    setOptions({ server: options.server })
     await checkConstrains(options)
     options.password ||= await getStdin()
     try {
@@ -72,7 +72,7 @@ send
   .addOption(minutes)
   .addOption(password)
   .action(async (text, options) => {
-    setBase(options.server!)
+    setOptions({ server: options.server })
     await checkConstrains(options)
     options.password ||= await getStdin()
     try {

packages/cli/src/download.ts

@@ -1,4 +1,4 @@
-import { Adapters, get, info, setBase } from '@cryptgeon/shared'
+import { Adapters, get, info, setOptions } from '@cryptgeon/shared'
 import inquirer from 'inquirer'
 import { access, constants, writeFile } from 'node:fs/promises'
 import { basename, resolve } from 'node:path'
@@ -6,7 +6,7 @@ import { AES, Hex } from 'occulto'
 import pretty from 'pretty-bytes'
 
 export async function download(url: URL, all: boolean, suggestedPassword?: string) {
-  setBase(url.origin)
+  setOptions({ server: url.origin })
   const id = url.pathname.split('/')[2]
   const preview = await info(id).catch(() => {
     throw new Error('Note does not exist or is expired')

packages/cli/src/upload.ts

@@ -1,7 +1,7 @@
 import { readFile, stat } from 'node:fs/promises'
 import { basename } from 'node:path'
 
-import { Adapters, BASE, create, FileDTO, Note, NoteMeta } from '@cryptgeon/shared'
+import { Adapters, create, getOptions, FileDTO, Note, NoteMeta } from '@cryptgeon/shared'
 import mime from 'mime'
 import { AES, Hex } from 'occulto'
 
@@ -39,7 +39,7 @@ export async function upload(input: string | string[], options: UploadOptions):
   // 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}`
+  let url = `${getOptions().server}/note/${result.id}`
   if (!derived) url += `#${Hex.encode(key)}`
   return url
 }

packages/frontend/locales/fr.json

@@ -23,7 +23,7 @@
 		"intro": "Envoyez facilement des notes ou des fichiers <i>entièrement chiffrés</i> et sécurisés en un seul clic. Il suffit de créer une note et de partager le lien.",
 		"explanation": "la note expirera et sera détruite après {type}.",
 		"new_note": "nouvelle note",
-		"new_note_notice": "<b>disponibilité :</b><br />la note n'est pas garantie d'être stockée car tout est conservé dans la mémoire vive; si elle se remplit, les notes les plus anciennes seront supprimées.<br />(tout ira probablement bien, soyez juste averti.)",
+		"new_note_notice": "<b>disponibilité :</b><br />il n'est pas garanti que la note reste stockée car tout est conservé dans la mémoire vive; si elle se remplit, les notes les plus anciennes seront supprimées.<br />(tout ira probablement bien, soyez juste averti.)",
 		"errors": {
 			"note_to_big": "Impossible de créer une note. La note est trop grande.",
 			"note_error": "n'a pas pu créer de note. Veuillez réessayer.",
@@ -45,9 +45,9 @@
 			"unsupported_type": "type de note non supporté."
 		},
 		"explanation": "Cliquez ci-dessous pour afficher et supprimer la note si le compteur a atteint sa limite.",
-		"show_note": "note de présentation",
+		"show_note": "afficher la note",
 		"warning_will_not_see_again": "vous <b>n'aurez pas</b> la chance de revoir la note.",
-		"download_all": "télécharger tout",
+		"download_all": "tout télécharger",
 		"links_found": "liens trouvés à l’intérieur de la note :"
 	},
 	"file_upload": {

packages/frontend/locales/pl.json

@@ -0,0 +1,58 @@
+{
+	"common": {
+		"note": "notatka",
+		"file": "plik",
+		"advanced": "zaawansowane",
+		"create": "utwórz",
+		"loading": "ładowanie",
+		"mode": "tryb",
+		"views": "{n, plural, =0 {wyświetleń} =1 {1 wyświetlenie} other {# wyświetleń}}",
+		"minutes": "{n, plural, =0 {minut} =1 {1 minuta} other {# minuty}}",
+		"max": "maks.",
+		"share_link": "link udostępniania",
+		"copy_clipboard": "kopiuj do schowka",
+		"copied_to_clipboard": "skopiowano do schowka",
+		"encrypting": "szyfrowanie",
+		"decrypting": "odszyfrowywanie",
+		"uploading": "wysyłanie",
+		"downloading": "pobieranie",
+		"qr_code": "kod QR",
+		"password": "hasło"
+	},
+	"home": {
+		"intro": "Łatwo wysyłaj <i>w pełni zaszyfrowane</i>, bezpieczne notatki lub pliki jednym kliknięciem. Po prostu utwórz notatkę i udostępnij link.",
+		"explanation": "notatka wygaśnie i zostanie zniszczona po {type}.",
+		"new_note": "nowa notatka",
+		"new_note_notice": "<b>dostępność:</b><br />nie ma gwarancji, że notatka będzie przechowywana, ponieważ wszystko jest przechowywane w pamięci RAM, jeśli się zapełni, najstarsze notatki zostaną usunięte.<br />(prawdopodobnie nic się nie stanie, ale warto ostrzec.)",
+		"errors": {
+			"note_to_big": "nie można utworzyć notatki. notatka jest za duża",
+			"note_error": "nie można utworzyć notatki. spróbuj ponownie.",
+			"max": "maks .: {n}",
+			"empty_content": "notatka jest pusta."
+		},
+		"messages": {
+			"note_created": "notatka utworzona."
+		},
+		"advanced": {
+			"explanation": "Domyślnie dla każdej notatki używane jest bezpiecznie wygenerowane hasło. Możesz jednak wybrać własne hasło, które nie jest uwzględnione w linku.",
+			"custom_password": "własne hasło"
+		}
+	},
+	"show": {
+		"errors": {
+			"not_found": "notatka nie została znaleziona lub została już usunięta.",
+			"decryption_failed": "błędne hasło. nie można odszyfrować. prawdopodobnie uszkodzony link. notatka została zniszczona.",
+			"unsupported_type": "nieobsługiwany typ notatki."
+		},
+		"explanation": "kliknij poniżej, aby wyświetlić i usunąć notatkę, jeśli licznik osiągnie swój limit",
+		"show_note": "pokaż notatkę",
+		"warning_will_not_see_again": "<b>nie będziesz mieć</b> możliwości ponownego zobaczenia notatki.",
+		"download_all": "pobierz wszystko",
+		"links_found": "linki znalezione w notatce:"
+	},
+	"file_upload": {
+		"selected_files": "Wybrane pliki",
+		"no_files_selected": "Nie wybrano plików",
+		"clear": "Wyczyść"
+	}
+}

packages/frontend/locales/ru.json

@@ -23,7 +23,7 @@
     "intro": "Легко отправляйте <i>полностью зашифрованные</i> защищенные заметки или файлы одним щелчком мыши. Просто создайте заметку и поделитесь ссылкой.",
     "explanation": "заметка истечет и будет уничтожена после {type}.",
     "new_note": "новая заметка",
-		"new_note_notice": "<b>availability:</b><br />the note is not guaranteed to be stored as everything is kept in ram, if it fills up the oldest notes will be removed.<br />(you probably will be fine, just be warned.)",
+    "new_note_notice": "<b>доступность:</b><br />сохранение заметки не гарантируется, поскольку все хранится в оперативной памяти; если она заполнится, самые старые заметки будут удалены.<br />( вероятно, все будет в порядке, просто будьте осторожны.)",
     "errors": {
       "note_to_big": "нельзя создать новую заметку. заметка слишком большая",
       "note_error": "нельзя создать новую заметку. пожалйста попробуйте позднее.",

packages/frontend/package.json

@@ -26,7 +26,7 @@
 		"svelte-intl-precompile": "^0.12.3",
 		"tslib": "^2.6.2",
 		"typescript": "^5.3.3",
-		"vite": "^5.1.4"
+		"vite": "^5.1.7"
 	},
 	"dependencies": {
 		"@cryptgeon/shared": "workspace:*",

packages/frontend/src/lib/ui/NoteResult.svelte

@@ -37,7 +37,7 @@
 
 {#if $status?.theme_new_note_notice}
 	<p>
-		{@html $t('home.theme_new_note_notice')}
+		{@html $t('home.new_note_notice')}
 	</p>
 {/if}
 <br />

packages/shared/src/api.ts

@@ -23,6 +23,10 @@ export type EncryptedFileDTO = Omit<FileDTO, 'contents'> & {
   contents: string
 }
 
+type ClientOptions = {
+  server: string
+}
+
 type CallOptions = {
   url: string
   method: string
@@ -31,14 +35,21 @@ type CallOptions = {
 
 export class PayloadToLargeError extends Error {}
 
-export let BASE = ''
+export let client: ClientOptions = {
+  server: '',
+}
 
-export function setBase(url: string) {
+export function setOptions(options: Partial<ClientOptions>) {
-  BASE = url
+  client = { ...client, ...options }
+}
+
+export function getOptions(): ClientOptions {
+  return client
 }
 
 export async function call(options: CallOptions) {
-  const response = await fetch(BASE + '/api/' + options.url, {
+  const url = client.server + '/api/' + options.url
+  const response = await fetch(url, {
     method: options.method,
     body: options.body === undefined ? undefined : JSON.stringify(options.body),
     mode: 'cors',

playwright.config.ts

@@ -4,12 +4,13 @@ const config: PlaywrightTestConfig = {
   use: {
     video: 'retain-on-failure',
     baseURL: 'http://localhost:1234',
-    actionTimeout: 60_000,
+    actionTimeout: 10_000,
   },
 
   outputDir: './test-results',
   testDir: './test',
-  timeout: 60_000,
+  timeout: 10_000,
+  fullyParallel: true,
 
   webServer: {
     command: 'docker compose -f docker-compose.dev.yaml up',