@meith/drivers 0.16.0

package/LICENSE.md

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@meith/drivers",
+  "version": "0.16.0",
+  "license": "LGPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meith-dev/meith.git",
+    "directory": "packages/drivers"
+  },
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./highlighting": "./src/highlighting/index.ts",
+    "./images": "./src/images/index.ts",
+    "./files/s3-file-store": "./src/files/s3-file-store.ts"
+  },
+  "files": [
+    "src",
+    "!src/**/*.test.*",
+    "!src/**/*.type-test.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "3.1111.0",
+    "@aws-sdk/s3-request-presigner": "3.1111.0",
+    "@jsquash/jpeg": "^1.6.0",
+    "@jsquash/png": "^3.1.1",
+    "@jsquash/resize": "^2.1.1",
+    "@types/nodemailer": "^8.0.1",
+    "drizzle-orm": "^0.45.2",
+    "nodemailer": "^9.0.5",
+    "redis": "^6.2.1",
+    "shiki": "^4.4.3",
+    "@meith/attachments": "0.16.0",
+    "@meith/i18n": "0.16.0",
+    "@meith/db": "0.16.0",
+    "@meith/core": "0.16.0",
+    "@meith/settings": "0.16.0"
+  },
+  "peerDependencies": {
+    "next": "16.3.1"
+  }
+}

package/src/cache/memory-cache.ts

@@ -0,0 +1,61 @@
+import type { CacheDriver, CacheSetOptions } from '@meith/core'
+
+interface Entry {
+  value: unknown
+  expiresAt?: number
+  tags: readonly string[]
+}
+
+export class MemoryCache implements CacheDriver {
+  private readonly entries = new Map<string, Entry>()
+
+  constructor(private readonly maxEntries = 5000) {}
+
+  get<T>(key: string): Promise<T | undefined> {
+    const entry = this.entries.get(key)
+    if (!entry) return Promise.resolve(undefined)
+
+    if (entry.expiresAt !== undefined && entry.expiresAt <= Date.now()) {
+      this.entries.delete(key)
+      return Promise.resolve(undefined)
+    }
+    return Promise.resolve(entry.value as T)
+  }
+
+  set<T>(key: string, value: T, options: CacheSetOptions = {}): Promise<void> {
+    if (this.entries.size >= this.maxEntries && !this.entries.has(key)) {
+      const oldest = this.entries.keys().next()
+      if (!oldest.done) this.entries.delete(oldest.value)
+    }
+
+    const entry: Entry = { value, tags: options.tags ?? [] }
+    if (options.ttlSeconds !== undefined) {
+      entry.expiresAt = Date.now() + options.ttlSeconds * 1000
+    }
+    this.entries.set(key, entry)
+    return Promise.resolve()
+  }
+
+  delete(key: string): Promise<void> {
+    this.entries.delete(key)
+    return Promise.resolve()
+  }
+
+  invalidateTags(tags: readonly string[]): Promise<void> {
+    if (tags.length === 0) return Promise.resolve()
+    const wanted = new Set(tags)
+
+    for (const [key, entry] of this.entries) {
+      if (entry.tags.some((t) => wanted.has(t))) this.entries.delete(key)
+    }
+    return Promise.resolve()
+  }
+
+  size(): number {
+    return this.entries.size
+  }
+
+  reset(): void {
+    this.entries.clear()
+  }
+}

package/src/cache/next-cache.ts

@@ -0,0 +1,29 @@
+import { revalidateTag } from 'next/cache'
+
+import type { CacheDriver, CacheSetOptions } from '@meith/core'
+
+import { MemoryCache } from './memory-cache'
+
+export class NextCacheDriver implements CacheDriver {
+  private readonly local = new MemoryCache()
+
+  get<T>(key: string): Promise<T | undefined> {
+    return this.local.get<T>(key)
+  }
+
+  set<T>(key: string, value: T, options?: CacheSetOptions): Promise<void> {
+    return this.local.set(key, value, options)
+  }
+
+  delete(key: string): Promise<void> {
+    return this.local.delete(key)
+  }
+
+  async invalidateTags(tags: readonly string[]): Promise<void> {
+    await this.local.invalidateTags(tags)
+
+    for (const tag of tags) {
+      revalidateTag(tag, 'max')
+    }
+  }
+}

package/src/cache/redis-cache.ts

@@ -0,0 +1,128 @@
+import { createClient } from 'redis'
+
+import { type CacheDriver, type CacheSetOptions, logger } from '@meith/core'
+
+const DATE_MARK = '\u001fmeith:date'
+
+function encode(value: unknown): string | undefined {
+  return JSON.stringify(value, function (this: Record<string, unknown>, key, raw) {
+    const original = this[key]
+    return original instanceof Date ? { [DATE_MARK]: original.toISOString() } : raw
+  })
+}
+
+function decode<T>(text: string): T {
+  return JSON.parse(text, (_key, raw) => {
+    if (
+      raw !== null &&
+      typeof raw === 'object' &&
+      !Array.isArray(raw) &&
+      typeof (raw as Record<string, unknown>)[DATE_MARK] === 'string' &&
+      Object.keys(raw as object).length === 1
+    ) {
+      return new Date((raw as Record<string, string>)[DATE_MARK] as string)
+    }
+    return raw
+  }) as T
+}
+
+const INVALIDATE_TAG = `
+local keys = redis.call('SMEMBERS', KEYS[1])
+for i = 1, #keys, 1000 do
+  redis.call('DEL', unpack(keys, i, math.min(i + 999, #keys)))
+end
+redis.call('DEL', KEYS[1])
+return #keys
+`
+
+export interface RedisCacheOptions {
+  readonly url?: string
+  readonly socketPath?: string
+  readonly keyPrefix?: string
+}
+
+type Client = ReturnType<typeof createClient>
+
+export class RedisCacheDriver implements CacheDriver {
+  private readonly client: Client
+  private readonly prefix: string
+  private ready: Promise<unknown> | undefined
+
+  constructor(options: RedisCacheOptions = {}) {
+    const log = logger({ driver: 'redis-cache' })
+    this.client = createClient(
+      options.socketPath !== undefined
+        ? { socket: { path: options.socketPath, tls: false } }
+        : options.url !== undefined
+          ? { url: options.url }
+          : {},
+    )
+    this.client.on('error', (error: unknown) => {
+      log.error({ err: error }, 'redis cache connection error')
+    })
+    this.prefix = options.keyPrefix ?? 'meith:'
+  }
+
+  private valueKey(key: string): string {
+    return `${this.prefix}v:${key}`
+  }
+
+  private tagKey(tag: string): string {
+    return `${this.prefix}t:${tag}`
+  }
+
+  private async connection(): Promise<Client> {
+    this.ready ??= this.client.connect().catch((error: unknown) => {
+      this.ready = undefined
+      throw error
+    })
+    await this.ready
+    return this.client
+  }
+
+  async get<T>(key: string): Promise<T | undefined> {
+    const client = await this.connection()
+    const stored = await client.get(this.valueKey(key))
+    return stored === null ? undefined : decode<T>(stored)
+  }
+
+  async set<T>(key: string, value: T, options: CacheSetOptions = {}): Promise<void> {
+    const text = encode(value)
+    if (text === undefined || (options.ttlSeconds !== undefined && options.ttlSeconds <= 0)) {
+      await this.delete(key)
+      return
+    }
+
+    const client = await this.connection()
+    const valueKey = this.valueKey(key)
+    const multi = client.multi()
+    multi.set(
+      valueKey,
+      text,
+      options.ttlSeconds === undefined
+        ? {}
+        : { expiration: { type: 'EX', value: Math.ceil(options.ttlSeconds) } },
+    )
+    for (const tag of options.tags ?? []) {
+      multi.sAdd(this.tagKey(tag), valueKey)
+    }
+    await multi.exec()
+  }
+
+  async delete(key: string): Promise<void> {
+    const client = await this.connection()
+    await client.del(this.valueKey(key))
+  }
+
+  async invalidateTags(tags: readonly string[]): Promise<void> {
+    if (tags.length === 0) return
+    const client = await this.connection()
+    await Promise.all(tags.map((tag) => client.eval(INVALIDATE_TAG, { keys: [this.tagKey(tag)] })))
+  }
+
+  async close(): Promise<void> {
+    if (this.ready === undefined) return
+    await this.ready.catch(() => undefined)
+    if (this.client.isOpen) await this.client.close()
+  }
+}

package/src/files/local-file-store.ts

@@ -0,0 +1,59 @@
+import { createHash } from 'node:crypto'
+import { mkdir, readFile, rm, writeFile } from 'node:fs/promises'
+import { dirname, join, normalize, resolve, sep } from 'node:path'
+
+import { type FileStore, type PutFileOptions, type StoredFile, ValidationError } from '@meith/core'
+import { msg } from '@meith/i18n'
+
+export class LocalFileStore implements FileStore {
+  constructor(
+    private readonly root: string,
+    private readonly publicPrefix = '/uploads',
+  ) {}
+
+  private pathFor(key: string): string {
+    if (key.includes('\0')) throw new ValidationError(msg('error.drivers.invalid-file-key'))
+
+    const base = resolve(this.root)
+    const target = resolve(base, normalize(key))
+
+    if (target !== base && !target.startsWith(base + sep)) {
+      throw new ValidationError(msg('error.drivers.invalid-file-key'))
+    }
+    return target
+  }
+
+  async put(key: string, body: Uint8Array, options: PutFileOptions): Promise<StoredFile> {
+    const path = this.pathFor(key)
+    await mkdir(dirname(path), { recursive: true })
+    await writeFile(path, body)
+
+    return { key, size: body.byteLength, contentType: options.contentType }
+  }
+
+  async get(key: string): Promise<Uint8Array | undefined> {
+    try {
+      return await readFile(this.pathFor(key))
+    } catch (error) {
+      if ((error as NodeJS.ErrnoException).code === 'ENOENT') return undefined
+      throw error
+    }
+  }
+
+  async delete(key: string): Promise<void> {
+    await rm(this.pathFor(key), { force: true })
+  }
+
+  signedUrl(): Promise<string | undefined> {
+    return Promise.resolve(undefined)
+  }
+
+  url(key: string): string {
+    return `${this.publicPrefix}/${key}`
+  }
+
+  static keyFor(prefix: string, body: Uint8Array, extension: string): string {
+    const digest = createHash('sha256').update(body).digest('hex')
+    return join(prefix, digest.slice(0, 2), `${digest}${extension}`)
+  }
+}

package/src/files/s3-file-store.ts

@@ -0,0 +1,190 @@
+import {
+  DeleteObjectCommand,
+  GetObjectCommand,
+  ListObjectsV2Command,
+  PutObjectCommand,
+  S3Client,
+} from '@aws-sdk/client-s3'
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
+
+import {
+  ConfigurationError,
+  type FileStore,
+  type PutFileOptions,
+  type StoredFile,
+} from '@meith/core'
+
+export interface S3FileStoreConfig {
+  readonly bucket: string
+  readonly region: string
+  readonly accessKeyId: string
+  readonly secretAccessKey: string
+  readonly endpoint?: string | undefined
+  readonly publicBaseUrl?: string | undefined
+}
+
+export interface S3Like {
+  send(command: unknown): Promise<unknown>
+}
+
+function assertUsableKey(key: string): void {
+  if (key === '' || key.trim() !== key) {
+    throw new ConfigurationError(`Invalid object key: ${JSON.stringify(key)}`)
+  }
+  if (key.startsWith('/') || key.includes('//')) {
+    throw new ConfigurationError(`Object key must not contain empty segments: ${key}`)
+  }
+  if (key.split('/').some((segment) => segment === '..' || segment === '.')) {
+    throw new ConfigurationError(`Object key must not contain relative segments: ${key}`)
+  }
+  // biome-ignore lint/suspicious/noControlCharactersInRegex: rejecting control characters is the point
+  if (/[\u0000-\u001f\u007f]/.test(key)) {
+    throw new ConfigurationError('Object key must not contain control characters.')
+  }
+}
+
+function isNotFound(error: unknown): boolean {
+  const name = (error as { name?: string } | null)?.name
+  const status = (error as { $metadata?: { httpStatusCode?: number } } | null)?.$metadata
+    ?.httpStatusCode
+
+  return name === 'NoSuchKey' || name === 'NotFound' || status === 404
+}
+
+export class S3FileStore implements FileStore {
+  private readonly sender: S3Like
+
+  private readonly signingClient: S3Client
+
+  constructor(
+    private readonly config: S3FileStoreConfig,
+    sender?: S3Like,
+  ) {
+    this.signingClient = new S3Client({
+      region: config.region,
+      credentials: {
+        accessKeyId: config.accessKeyId,
+        secretAccessKey: config.secretAccessKey,
+      },
+      ...(config.endpoint === undefined ? {} : { endpoint: config.endpoint, forcePathStyle: true }),
+    })
+
+    this.sender = sender ?? this.signingClient
+  }
+
+  static fromEnv(env: {
+    S3_BUCKET?: string | undefined
+    S3_REGION?: string | undefined
+    S3_ACCESS_KEY_ID?: string | undefined
+    S3_SECRET_ACCESS_KEY?: string | undefined
+    S3_ENDPOINT?: string | undefined
+  }): S3FileStore {
+    const missing = (
+      ['S3_BUCKET', 'S3_REGION', 'S3_ACCESS_KEY_ID', 'S3_SECRET_ACCESS_KEY'] as const
+    ).filter((key) => !env[key])
+
+    if (missing.length > 0) {
+      throw new ConfigurationError(
+        `FILESTORE_DRIVER=s3 requires ${missing.join(', ')}. See .env.example.`,
+      )
+    }
+
+    return new S3FileStore({
+      bucket: env.S3_BUCKET as string,
+      region: env.S3_REGION as string,
+      accessKeyId: env.S3_ACCESS_KEY_ID as string,
+      secretAccessKey: env.S3_SECRET_ACCESS_KEY as string,
+      endpoint: env.S3_ENDPOINT,
+    })
+  }
+
+  async put(key: string, body: Uint8Array, options: PutFileOptions): Promise<StoredFile> {
+    assertUsableKey(key)
+
+    await this.sender.send(
+      new PutObjectCommand({
+        Bucket: this.config.bucket,
+        Key: key,
+        Body: body,
+        ContentType: options.contentType,
+      }),
+    )
+
+    return { key, size: body.byteLength, contentType: options.contentType }
+  }
+
+  async get(key: string): Promise<Uint8Array | undefined> {
+    assertUsableKey(key)
+
+    try {
+      const response = (await this.sender.send(
+        new GetObjectCommand({ Bucket: this.config.bucket, Key: key }),
+      )) as { Body?: { transformToByteArray(): Promise<Uint8Array> } }
+
+      if (!response.Body) return undefined
+      return await response.Body.transformToByteArray()
+    } catch (error) {
+      if (isNotFound(error)) return undefined
+      throw error
+    }
+  }
+
+  async *listKeys(): AsyncGenerator<string> {
+    let continuationToken: string | undefined
+
+    do {
+      const response = (await this.sender.send(
+        new ListObjectsV2Command({
+          Bucket: this.config.bucket,
+          ...(continuationToken === undefined ? {} : { ContinuationToken: continuationToken }),
+        }),
+      )) as {
+        Contents?: readonly { Key?: string }[]
+        IsTruncated?: boolean
+        NextContinuationToken?: string
+      }
+
+      for (const object of response.Contents ?? []) {
+        if (object.Key !== undefined) yield object.Key
+      }
+
+      continuationToken = response.IsTruncated ? response.NextContinuationToken : undefined
+    } while (continuationToken !== undefined)
+  }
+
+  async delete(key: string): Promise<void> {
+    assertUsableKey(key)
+
+    try {
+      await this.sender.send(new DeleteObjectCommand({ Bucket: this.config.bucket, Key: key }))
+    } catch (error) {
+      if (isNotFound(error)) return
+      throw error
+    }
+  }
+
+  async signedUrl(key: string, expiresInSeconds: number): Promise<string | undefined> {
+    assertUsableKey(key)
+
+    if (expiresInSeconds <= 0) {
+      throw new ConfigurationError('signedUrl requires a positive expiry.')
+    }
+
+    return getSignedUrl(
+      this.signingClient,
+      new GetObjectCommand({ Bucket: this.config.bucket, Key: key }),
+      { expiresIn: expiresInSeconds },
+    )
+  }
+
+  url(key: string): string {
+    assertUsableKey(key)
+
+    const base =
+      this.config.publicBaseUrl ??
+      this.config.endpoint ??
+      `https://${this.config.bucket}.s3.${this.config.region}.amazonaws.com`
+
+    return `${base.replace(/\/+$/, '')}/${key}`
+  }
+}

package/src/highlighting/index.ts

@@ -0,0 +1 @@
+export { type CodeHighlighter, codeHighlighter } from './shiki-highlighter'