@c15t/backend 2.0.0-rc.0 → 2.0.0-rc.10

package/src/cache/index.ts

@@ -1,34 +0,0 @@
-/**
- * Cache Module
- *
- * Multi-layer caching system with pluggable adapters for GVL and other data.
- *
- * @packageDocumentation
- */
-
-// Adapters
-export {
-	clearMemoryCache,
-	// Cloudflare KV
-	createCloudflareKVAdapter,
-	// Memory
-	createMemoryCacheAdapter,
-	// Upstash Redis
-	createUpstashRedisAdapter,
-	createUpstashRedisAdapterFromClient,
-	getMemoryCacheSize,
-	type KVNamespace,
-	type UpstashRedisAdapterOptions,
-} from './adapters';
-// GVL Resolver
-export {
-	createGVLResolver,
-	type GVLResolver,
-	type GVLResolverOptions,
-} from './gvl-resolver';
-
-// Cache Key Utilities
-export { createCacheKey, createGVLCacheKey } from './keys';
-// Types
-export type { CacheAdapter } from './types';
-export { GVL_TTL_MS, MEMORY_TTL_MS } from './types';

package/src/cache/keys.ts

@@ -1,68 +0,0 @@
-/**
- * Cache Key Utilities
- *
- * Functions for generating consistent cache keys with app name prefixing.
- *
- * @packageDocumentation
- */
-
-/**
- * Create a GVL cache key.
- *
- * Format: `{appName}:gvl:{language}:{sortedVendorIds}`
- *
- * @param appName - The application name for key prefixing
- * @param language - The language code (e.g., "en", "de")
- * @param vendorIds - Optional array of vendor IDs to include in the key
- * @returns A unique cache key for the GVL configuration
- *
- * @example
- * ```typescript
- * // All vendors
- * createGVLCacheKey('my-app', 'en');
- * // => 'my-app:gvl:en:all'
- *
- * // Specific vendors
- * createGVLCacheKey('my-app', 'de', [1, 10, 2]);
- * // => 'my-app:gvl:de:1,2,10'
- * ```
- *
- * @public
- */
-export function createGVLCacheKey(
-	appName: string,
-	language: string,
-	vendorIds?: number[]
-): string {
-	const sortedIds = vendorIds
-		? [...vendorIds].sort((a, b) => a - b).join(',')
-		: 'all';
-	return `${appName}:gvl:${language}:${sortedIds}`;
-}
-
-/**
- * Create a generic cache key with namespace and parts.
- *
- * Format: `{appName}:{namespace}:{part1}:{part2}:...`
- *
- * @param appName - The application name for key prefixing
- * @param namespace - The cache namespace (e.g., "gvl", "translations")
- * @param parts - Additional key parts
- * @returns A namespaced cache key
- *
- * @example
- * ```typescript
- * createCacheKey('my-app', 'translations', 'en', 'banner');
- * // => 'my-app:translations:en:banner'
- * ```
- *
- * @public
- */
-export function createCacheKey(
-	appName: string,
-	namespace: string,
-	...parts: (string | number)[]
-): string {
-	const allParts = [appName, namespace, ...parts];
-	return allParts.join(':');
-}

package/src/cache/types.ts

@@ -1,66 +0,0 @@
-/**
- * Cache Adapter Types
- *
- * Generic cache adapter interface for pluggable caching implementations.
- * Supports in-memory, Redis, Cloudflare KV, and custom adapters.
- *
- * @packageDocumentation
- */
-
-/**
- * Generic cache adapter interface.
- *
- * Implementations should handle serialization/deserialization internally.
- * All methods are async to support both sync (memory) and async (Redis/KV) backends.
- *
- * @public
- */
-export interface CacheAdapter {
-	/**
-	 * Get a value from the cache.
-	 *
-	 * @param key - Cache key
-	 * @returns The cached value, or null if not found or expired
-	 */
-	get<T>(key: string): Promise<T | null>;
-
-	/**
-	 * Set a value in the cache.
-	 *
-	 * @param key - Cache key
-	 * @param value - Value to cache
-	 * @param ttlMs - Time to live in milliseconds (optional)
-	 */
-	set<T>(key: string, value: T, ttlMs?: number): Promise<void>;
-
-	/**
-	 * Delete a value from the cache.
-	 *
-	 * @param key - Cache key
-	 */
-	delete(key: string): Promise<void>;
-
-	/**
-	 * Check if a key exists in the cache.
-	 *
-	 * @param key - Cache key
-	 * @returns True if the key exists and is not expired
-	 */
-	has(key: string): Promise<boolean>;
-}
-
-/**
- * Default TTL for GVL cache entries (3 days).
- * Matches the typical GVL update frequency.
- *
- * @public
- */
-export const GVL_TTL_MS = 3 * 24 * 60 * 60 * 1000; // 3 days
-
-/**
- * Default TTL for in-memory cache entries (5 minutes).
- * Shorter TTL to handle worker restarts and keep memory usage low.
- *
- * @public
- */
-export const MEMORY_TTL_MS = 5 * 60 * 1000; // 5 minutes

package/src/core.ts

@@ -1,368 +0,0 @@
-import { createLogger } from '@c15t/logger';
-import { SpanStatusCode } from '@opentelemetry/api';
-import { apiReference } from '@scalar/hono-api-reference';
-import { Hono } from 'hono';
-import { cors } from 'hono/cors';
-import { HTTPException } from 'hono/http-exception';
-import { openAPIRouteHandler } from 'hono-openapi';
-import { validateRequestAuth } from '~/middleware/auth';
-import { createCORSOptions } from '~/middleware/cors';
-import { createOpenAPIConfig } from '~/middleware/openapi';
-import { getIpAddress } from '~/middleware/process-ip';
-import type { C15TContext, C15TOptions } from '~/types';
-import { init } from './init';
-import { createConsentRoutes } from './routes/consent';
-// Import route handlers
-import { createInitRoute } from './routes/init';
-import { createStatusRoute } from './routes/status';
-import { createSubjectRoutes } from './routes/subject';
-import {
-	createRequestSpan,
-	handleSpanError,
-	withSpanContext,
-} from './utils/create-telemetry-options';
-import { extractErrorMessage } from './utils/extract-error-message';
-import { getMetrics } from './utils/metrics';
-import { version } from './version';
-
-/**
- * Type representing an API route
- */
-export type Route = {
-	path: string;
-	method: string;
-	description?: string;
-};
-
-/**
- * Hono app type with c15t context
- */
-export type C15TApp = Hono<{ Variables: { c15tContext: C15TContext } }>;
-
-/**
- * Interface representing a configured c15t consent management instance.
- *
- * @remarks
- * The C15TInstance provides the main interface for interacting with the consent
- * management system. It includes methods for handling requests, accessing API
- * endpoints, and managing the system's configuration.
- */
-export interface C15TInstance {
-	/**
-	 * Processes incoming HTTP requests and routes them to appropriate handlers.
-	 *
-	 * @param request - The incoming web request
-	 * @returns A Promise containing the HTTP response
-	 *
-	 * @example
-	 * ```typescript
-	 * try {
-	 *   const response = await instance.handler(request);
-	 *   sendResponse(response);
-	 * } catch (error) {
-	 *   handleError(error);
-	 * }
-	 * ```
-	 */
-	handler: (request: Request) => Promise<Response>;
-
-	/**
-	 * The configuration options used for this instance.
-	 */
-	options: C15TOptions;
-
-	/**
-	 * Access to the underlying context.
-	 */
-	$context: C15TContext;
-
-	/**
-	 * Access to the Hono app for direct usage.
-	 */
-	app: C15TApp;
-
-	/**
-	 * Generates and returns the OpenAPI specification as a JSON object.
-	 *
-	 * @returns A Promise containing the OpenAPI specification
-	 */
-	getOpenAPISpec: () => Promise<Record<string, unknown>>;
-
-	/**
-	 * Returns an HTML document with the API documentation UI.
-	 *
-	 * @returns An HTML string with the API reference UI
-	 */
-	getDocsUI: () => string;
-}
-
-/**
- * Creates a new c15t consent management instance.
- *
- * This version uses Hono as the HTTP framework with OpenAPI support.
- */
-export const c15tInstance = (options: C15TOptions): C15TInstance => {
-	const context = init(options);
-	const logger = createLogger(options.logger);
-
-	// Create the Hono app
-	const app = new Hono<{ Variables: { c15tContext: C15TContext } }>();
-
-	// Set up OpenAPI configuration
-	const openApiConfig = createOpenAPIConfig(options);
-	const basePath = options.basePath || '/';
-
-	// CORS middleware
-	const corsOptions = createCORSOptions(options.trustedOrigins);
-	app.use('*', cors(corsOptions));
-
-	// Note: Compression disabled - causes issues with response passthrough in wrapper scenarios
-	// app.use('*', compress());
-
-	// Get metrics instance (null if telemetry is disabled)
-	const metrics = getMetrics(options);
-
-	// Context middleware - enriches each request with c15t context
-	app.use('*', async (c, next) => {
-		const request = c.req.raw;
-		const startTime = Date.now();
-
-		// Check API key authentication
-		const apiKeyAuthenticated = validateRequestAuth(
-			request.headers,
-			options.advanced?.apiKeys
-		);
-
-		const enrichedContext: C15TContext = {
-			...context,
-			ipAddress: getIpAddress(request, options),
-			userAgent: request.headers.get('user-agent') || undefined,
-			apiKeyAuthenticated,
-			path: c.req.path,
-			method: c.req.method,
-			headers: request.headers,
-		};
-
-		c.set('c15tContext', enrichedContext);
-
-		// Create a telemetry span for the request (if enabled)
-		const span = createRequestSpan(c.req.method, c.req.path, options);
-
-		const runNext = async () => {
-			await next();
-		};
-
-		try {
-			if (span) {
-				await withSpanContext(span, runNext);
-				// After routing, update span name with matched route pattern
-				const matchedRoutes = c.req.matchedRoutes;
-				const routePattern =
-					matchedRoutes
-						.map((r) => r.path)
-						.filter((p) => p !== '/*')
-						.pop() ?? c.req.path;
-				span.updateName(`${c.req.method} ${routePattern}`);
-				span.setAttribute('http.route', routePattern);
-				span.setStatus({ code: SpanStatusCode.OK });
-			} else {
-				await runNext();
-			}
-		} catch (error) {
-			if (span) {
-				handleSpanError(span, error);
-			}
-			throw error;
-		} finally {
-			span?.end();
-		}
-
-		// Record HTTP metrics after request completes
-		if (metrics) {
-			const durationMs = Date.now() - startTime;
-			// Use route pattern instead of raw path to avoid high cardinality
-			const matchedRoutes = c.req.matchedRoutes;
-			const routePattern =
-				matchedRoutes
-					.map((r) => r.path)
-					.filter((p) => p !== '/*')
-					.pop() ?? c.req.path;
-			metrics.recordHttpRequest(
-				{
-					method: c.req.method,
-					route: routePattern,
-					status: c.res.status,
-				},
-				durationMs
-			);
-		}
-	});
-
-	// OpenAPI spec endpoint
-	if (openApiConfig.enabled) {
-		app.get(
-			openApiConfig.specPath,
-			openAPIRouteHandler(app, {
-				documentation: {
-					openapi: '3.1.0',
-					info: {
-						title: options.appName || 'c15t API',
-						version,
-						description: 'API for consent management',
-					},
-					servers: [{ url: basePath }],
-					components: {
-						securitySchemes: {
-							bearerAuth: {
-								type: 'http',
-								scheme: 'bearer',
-							},
-						},
-					},
-				},
-			})
-		);
-
-		// Docs UI endpoint
-		// The spec URL needs to include the basePath since it's used by the browser
-		const publicSpecUrl = `${basePath}${openApiConfig.specPath}`.replace(
-			/\/+/g,
-			'/'
-		);
-		app.get(
-			openApiConfig.docsPath,
-			apiReference({
-				spec: {
-					url: publicSpecUrl,
-				},
-				pageTitle: `${options.appName || 'c15t API'} Documentation`,
-			})
-		);
-	}
-
-	// Mount routes - using plural nouns for REST conventions
-	app.route('/init', createInitRoute(options));
-	app.route('/subjects', createSubjectRoutes());
-	app.route('/consents', createConsentRoutes());
-	app.route('/status', createStatusRoute());
-
-	// Global error handler
-	app.onError((err, c) => {
-		const ctx = c.get('c15tContext');
-		const log = ctx?.logger || logger;
-
-		log.error('Request handling error:', extractErrorMessage(err));
-
-		if (err instanceof HTTPException) {
-			const cause = err.cause as
-				| { code?: string; message?: string; [key: string]: unknown }
-				| undefined;
-			return c.json(
-				{
-					code: cause?.code || 'HTTP_ERROR',
-					message: err.message,
-					status: err.status,
-					defined: true,
-					data: {},
-				},
-				err.status
-			);
-		}
-
-		return c.json(
-			{
-				code: 'INTERNAL_SERVER_ERROR',
-				message: 'Internal server error',
-				status: 500,
-				defined: true,
-				data: {},
-			},
-			500
-		);
-	});
-
-	// 404 handler
-	app.notFound((c) => {
-		return c.json(
-			{
-				code: 'NOT_FOUND',
-				message: 'Not Found',
-				status: 404,
-				defined: true,
-				data: {},
-			},
-			404
-		);
-	});
-
-	// Create the handler function
-	const handler = async (request: Request): Promise<Response> => {
-		logger?.debug?.('Incoming request', {
-			method: request.method,
-			url: request.url,
-		});
-
-		// Strip the basePath from the URL if present
-		// This allows Hono routes to be defined without the basePath prefix
-		let modifiedRequest = request;
-		if (basePath && basePath !== '/') {
-			const url = new URL(request.url);
-			const normalizedBasePath = basePath.replace(/\/$/, ''); // Remove trailing slash
-			if (url.pathname.startsWith(normalizedBasePath)) {
-				const newPath = url.pathname.slice(normalizedBasePath.length) || '/';
-				url.pathname = newPath;
-				modifiedRequest = new Request(url.toString(), {
-					method: request.method,
-					headers: request.headers,
-					body: request.body,
-					duplex: 'half',
-				} as RequestInit);
-			}
-		}
-
-		return app.fetch(modifiedRequest);
-	};
-
-	// Create docs UI helper
-	const getDocsUI = () => {
-		const specUrl = `${basePath}${openApiConfig.specPath}`.replace(/\/+/g, '/');
-		return `
-<!doctype html> 
-<html>
-  <head>
-    <title>${options.appName || 'c15t API'} Documentation</title>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <link rel="icon" type="image/svg+xml" href="https://c15t.com/icon.svg" />
-  </head>
-  <body>
-    <script
-      id="api-reference"
-      data-url="${encodeURI(specUrl)}">
-    </script>
-    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
-  </body>
-</html>
-`;
-	};
-
-	// Return the instance
-	return {
-		options,
-		$context: context,
-		app,
-		handler,
-		getOpenAPISpec: async () => {
-			// Generate OpenAPI spec by fetching from our own endpoint
-			const specResponse = await app.fetch(
-				new Request(`http://localhost${openApiConfig.specPath}`)
-			);
-			return specResponse.json() as Promise<Record<string, unknown>>;
-		},
-		getDocsUI,
-	};
-};
-
-export { defineConfig } from './define-config';
-export type { C15TContext, C15TOptions } from './types';
-export { version } from './version';

package/src/db/migrator/index.ts

@@ -1,80 +0,0 @@
-import type { InferFumaDB } from 'fumadb';
-import type { DB } from '~/db/schema';
-
-type DatabaseInstance = InferFumaDB<typeof DB>;
-type MigratorInstance = ReturnType<DatabaseInstance['createMigrator']>;
-type VersionTag = ReturnType<(typeof DB)['version']>;
-
-type MigrateToLatestResult = Awaited<
-	ReturnType<MigratorInstance['migrateToLatest']>
->;
-type MigrateToResult = Awaited<ReturnType<MigratorInstance['migrateTo']>>;
-type DownResult = Awaited<ReturnType<MigratorInstance['down']>>;
-
-export type MigrationResult =
-	| MigrateToLatestResult
-	| MigrateToResult
-	| DownResult;
-
-export type ORMResult = {
-	code: string;
-	path: string;
-};
-
-interface BaseOptions {
-	db: DatabaseInstance;
-	schema: VersionTag | 'latest';
-}
-
-/**
- * Executes database migrations for supported adapters, or generates ORM schema
- * code for ORM-based adapters.
- *
- * - For 'kysely' and 'mongo', this function runs migrations using the
- *   underlying migrator returned by `db.createMigrator()`.
- * - For 'drizzle', 'prisma', and 'typeorm', this function generates schema
- *   code via `db.generateSchema()`.
- */
-export async function migrator(
-	options: BaseOptions
-): Promise<MigrationResult | ORMResult> {
-	const { db } = options;
-
-	let version: VersionTag | 'legacy';
-	try {
-		version = await db.version();
-	} catch {
-		// If FumaDB isn't initalized yet, we're in legacy mode
-		version = 'legacy';
-	}
-
-	const migratorInstance = db.adapter?.createMigrationEngine
-		? db.createMigrator()
-		: undefined;
-
-	const schema = db.adapter?.generateSchema
-		? db.generateSchema(options.schema)
-		: undefined;
-
-	if (migratorInstance) {
-		switch (options.schema) {
-			case 'latest':
-				return await migratorInstance.migrateToLatest({
-					mode: version === 'legacy' ? 'from-database' : 'from-schema',
-				});
-			default:
-				return await migratorInstance.migrateTo(options.schema, {
-					mode: version === 'legacy' ? 'from-database' : 'from-schema',
-				});
-		}
-	}
-
-	if (schema) {
-		return {
-			code: schema.code,
-			path: schema.path,
-		};
-	}
-
-	throw new Error('Adapter does not support migrations or schema generation');
-}