@c15t/backend 1.8.0 → 2.0.0-rc.1

package/src/pkgs/types/context.ts

@@ -1,178 +0,0 @@
-import type { createLogger } from '@c15t/logger';
-import type { DatabaseHook, EntityName } from '~/pkgs/data-model';
-import type { Adapter } from '~/pkgs/db-adapters/types';
-import type { createRegistry } from '~/schema/create-registry';
-import type { getConsentTables } from '~/schema/definition';
-import type { DoubleTieOptions } from './options';
-
-/**
- * Extended endpoint context for hooks
- *
- * This type extends the standard endpoint context with additional properties
- * specific to DoubleTie hooks, allowing hooks to access the complete DoubleTie context.
- */
-export type HookEndpointContext = {
-	/**
-	 * The request object
-	 */
-	request: Request;
-
-	/**
-	 * The DoubleTie context with possible hook-specific extensions
-	 */
-	context: DoubleTieContext & {
-		/**
-		 * Value returned by the endpoint handler, available in 'after' hooks
-		 */
-		returned?: unknown;
-
-		/**
-		 * Response headers, available in 'after' hooks
-		 */
-		responseHeaders?: Headers;
-	};
-};
-
-/**
- * Generic endpoint context type
- *
- * A simplified context type for endpoint handlers that don't need
- * access to input-specific context properties.
- */
-export type GenericEndpointContext = {
-	/**
-	 * The request object
-	 */
-	request: Request;
-
-	/**
-	 * The DoubleTie application context
-	 */
-	context: DoubleTieContext;
-};
-
-/**
- * Base context interface
- *
- * Defines the minimal required properties for a DoubleTie context.
- */
-export interface BaseContext {
-	/**
-	 * Configuration options for the DoubleTie system
-	 */
-	options: DoubleTieOptions;
-
-	/**
-	 * Logger instance for recording events and errors
-	 */
-	logger: ReturnType<typeof createLogger>;
-}
-
-/**
- * Registry context interface
- *
- * Extends the base context with registry-specific properties
- * for database access and entity management.
- */
-export interface RegistryContext extends BaseContext {
-	/**
-	 * Database adapter instance
-	 */
-	adapter: Adapter;
-
-	/**
-	 * Database lifecycle hooks
-	 */
-	hooks: DatabaseHook[];
-
-	/**
-	 * Function to generate unique IDs for entities
-	 *
-	 * @param options - Options for ID generation including entity type and length
-	 * @returns A unique ID string
-	 */
-	generateId: (options: { model: EntityName; size?: number }) => string;
-}
-
-/**
- * Base DoubleTie context interface
- *
- * Defines the core properties available in all DoubleTie application contexts.
- * This forms the foundation for the complete context used throughout the system.
- */
-export interface BaseDoubleTieContext {
-	/**
-	 * Application name displayed in application dialogs
-	 */
-	appName: string;
-
-	/**
-	 * Configuration options for the DoubleTie system
-	 */
-	options: DoubleTieOptions;
-
-	/**
-	 * List of origins that are trusted for CORS and CSRF protection
-	 */
-	trustedOrigins: string[];
-
-	/**
-	 * Base URL for API requests
-	 */
-	baseURL: string;
-
-	/**
-	 * Logger instance for recording events and errors
-	 */
-	logger: ReturnType<typeof createLogger>;
-
-	/**
-	 * Function to generate unique IDs for entities
-	 *
-	 * @param options - Options for ID generation including entity type and length
-	 * @returns A unique ID string
-	 */
-	generateId: (options: { model: EntityName; size?: number }) => string;
-
-	/**
-	 * Database adapter instance
-	 */
-	adapter: Adapter;
-
-	/**
-	 * Entity registry for database operations
-	 */
-	registry: ReturnType<typeof createRegistry>;
-
-	/**
-	 * Database tables for the system
-	 */
-	tables: ReturnType<typeof getConsentTables>;
-
-	/**
-	 * IP address of the client
-	 */
-	ipAddress?: string | null;
-
-	/**
-	 * User agent of the client
-	 */
-	userAgent?: string | null;
-
-	/**
-	 * Headers of the request
-	 */
-	headers?: Headers;
-}
-
-/**
- * Complete DoubleTie context type
- *
- * This type combines the base context with plugin-specific context extensions.
- * It's the primary context type used throughout the system.
- *
- * @typeParam TPluginContext - Record of plugin-specific context properties
- */
-export type DoubleTieContext<
-	TPluginContext extends Record<string, unknown> = Record<string, unknown>,
-> = BaseDoubleTieContext & TPluginContext;

package/src/pkgs/types/endpoints.ts

@@ -1,35 +0,0 @@
-export interface EndpointOptions {
-	/**
-	 * Whether authentication is required for this endpoint
-	 */
-	auth?: boolean;
-
-	/**
-	 * Custom middleware to run before the endpoint
-	 */
-	middleware?: EndpointMiddleware[];
-}
-
-export type EndpointMiddleware = (request: Request) => Promise<void>;
-
-export type EndpointHandler = (request: Request) => Promise<unknown>;
-
-/**
- * Native endpoint interface
- */
-export interface Endpoint {
-	/**
-	 * The endpoint handler function
-	 */
-	handler: EndpointHandler;
-
-	/**
-	 * Configuration options for the endpoint
-	 */
-	options?: EndpointOptions;
-
-	/**
-	 * The path for this endpoint
-	 */
-	path: string;
-}

package/src/pkgs/types/helper.ts

@@ -1,57 +0,0 @@
-/**
- * Represents a string literal type
- *
- * This type ensures that only string literals are accepted, not general string types.
- * It's useful for ensuring type safety with specific string values.
- *
- * @example
- * ```ts
- * // Function that only accepts literal strings, not string variables
- * function doSomething(value: LiteralString) {
- *   // Implementation
- * }
- *
- * // Valid usage:
- * doSomething('specific-value');
- *
- * // Invalid usage:
- * const dynamicString = getStringFromSomewhere();
- * doSomething(dynamicString); // Type error
- * ```
- */
-export type LiteralString = '' | (string & Record<never, never>);
-
-/**
- * Makes all properties in an object optional recursively
- *
- * This is like TypeScript's built-in Partial<T>, but it goes deeper into
- * nested objects to make their properties optional too.
- *
- * @typeParam T - The type to make deeply partial
- *
- * @example
- * ```ts
- * interface User {
- *   id: string;
- *   name: string;
- *   settings: {
- *     theme: string;
- *     notifications: boolean;
- *   }
- * }
- *
- * // All properties are optional, including nested ones
- * const partialUser: DeepPartial<User> = {
- *   name: 'Alice',
- *   settings: {
- *     theme: 'dark'
- *     // notifications is optional
- *   }
- * };
- * ```
- */
-export type DeepPartial<T> = T extends (...args: unknown[]) => unknown
-	? T
-	: T extends object
-		? { [K in keyof T]?: DeepPartial<T[K]> }
-		: T;

package/src/pkgs/types/index.ts

@@ -1,18 +0,0 @@
-/**
- * DoubleTie Framework Types Package
- *
- * This package provides base type definitions for the DoubleTie SDK framework.
- * It includes generic API types, context types, option types, plugin types,
- * and helper types that can be extended by specific implementations like c15t.
- */
-
-export type {
-	BaseContext,
-	BaseDoubleTieContext,
-	DoubleTieContext,
-	GenericEndpointContext,
-	HookEndpointContext,
-	RegistryContext,
-} from './context';
-export type { DoubleTieOptions } from './options';
-export type { PluginHookContext } from './plugins';

package/src/pkgs/types/options.ts

@@ -1,252 +0,0 @@
-import type { LoggerOptions } from '@c15t/logger';
-import type { Translations } from '@c15t/translations';
-import type { Tracer } from '@opentelemetry/api';
-import type { DatabaseHook } from '~/pkgs/data-model';
-import type { DatabaseConfiguration } from '~/pkgs/db-adapters/adapters/kysely-adapter/types';
-
-// Import table configuration types from the schema module
-import type { TablesConfig } from '~/schema/types';
-import type { Branding } from '~/types';
-import type { DoubleTiePlugin } from './plugins';
-
-/**
- * Main configuration options for the DoubleTie SDK framework
- *
- * This interface provides a comprehensive set of options for configuring
- * all aspects of the framework, including core functionality,
- * database settings, UI components, and plugin extensions.
- *
- * @typeParam P - Array of plugin types to be used with this configuration
- *
- * @example
- * ```ts
- * // Basic configuration
- * const options: DoubleTieOptions = {
- *   appName: "My App",
- *   baseURL: "https://example.com",
- *   trustedOrigins: ["https://example.com"]
- * };
- * ```
- */
-export interface DoubleTieOptions {
-	/**
-	 * The base URL for the API (optional if running in a browser)
-	 * @example "https://example.com"
-	 */
-	baseURL?: string;
-
-	/**
-	 * The base path for API endpoints
-	 * @default "/api/c15t"
-	 * @example "/api/c15t"
-	 */
-	basePath?: string;
-
-	/**
-	 * Application name shown in application dialogs
-	 * @example "My App"
-	 */
-	appName?: string;
-
-	/**
-	 * Secret used for signing cookies and tokens
-	 * Should be a strong, unique string in production environments
-	 */
-	secret?: string;
-
-	/**
-	 * Database configuration
-	 */
-	database?: DatabaseConfiguration;
-
-	/**
-	 * Enable CORS support
-	 * @default true
-	 */
-	cors?: boolean;
-
-	/**
-	 * Trusted origins for CORS
-	 * Can be an array of origin strings or a function that returns origins based on the request
-	 * @example ["https://example.com", "https://www.example.com"]
-	 */
-	trustedOrigins?: string[];
-
-	/**
-	 * Plugins to extend functionality
-	 * Array of plugin objects that add features to the system
-	 */
-	plugins?: DoubleTiePlugin[];
-
-	/**
-	 * Logger configuration
-	 * Controls how events are logged
-	 */
-	logger?: LoggerOptions;
-
-	/**
-	 * allows you to define custom hooks that can be
-	 * executed during lifecycle of core database
-	 * operations.
-	 */
-	databaseHooks?: DatabaseHook[];
-
-	/**
-	 * Advanced configuration options
-	 * Settings for specialized use cases
-	 */
-	advanced?: {
-		/**
-		 * Disable Geo-Location detection
-		 */
-		disableGeoLocation?: boolean;
-
-		/**
-		 * Custom Translation Strings
-		 * Override the default translations with your own
-		 */
-		customTranslations?: Record<string, Partial<Translations>>;
-
-		/**
-		 * Select which branding to show in the consent banner.
-		 * Use "none" to hide branding.
-		 * @default "c15t"
-		 */
-		branding?: Branding;
-
-		/**
-		 * Ip address configuration
-		 */
-		ipAddress?: {
-			/**
-			 * List of headers to use for ip address
-			 *
-			 * Ip address is used for rate limiting and session tracking
-			 *
-			 * @example ["x-client-ip", "x-forwarded-for"]
-			 *
-			 * @default
-			 * @link https://github.com/c15t/c15t/blob/main/packages/c15t/src/utils/get-request-ip.ts#L8
-			 */
-			ipAddressHeaders?: string[];
-			/**
-			 * Disable ip tracking
-			 *
-			 * ⚠︎ This is a security risk and it may expose your application to abuse
-			 */
-			disableIpTracking?: boolean;
-		};
-
-		/**
-		 * Function to generate IDs
-		 * Custom ID generation for records and other entities
-		 */
-		generateId?: (options: { model: string; size?: number }) => string;
-
-		/**
-		 * Disable database transactions
-		 *
-		 * When true, operations will execute directly without transaction support.
-		 * Useful for databases that don't support transactions or when you want to bypass transaction overhead.
-		 *
-		 * @default false
-		 */
-		disableTransactions?: boolean;
-	};
-
-	/**
-	 * Hooks
-	 */
-	hooks?: {
-		/**
-		 * Before a request is processed
-		 */
-		before?: DoubleTieMiddleware;
-		/**
-		 * After a request is processed
-		 */
-		after?: DoubleTieMiddleware;
-	};
-
-	/**
-	 * OpenTelemetry configuration for observability
-	 *
-	 * Controls how telemetry data is collected and exported, allowing
-	 * users to integrate with their own observability stack.
-	 *
-	 * @example
-	 * ```typescript
-	 * // Basic configuration
-	 * telemetry: {
-	 *   disabled: false,
-	 *   defaultAttributes: {
-	 *     'deployment.environment': 'production'
-	 *   }
-	 * }
-	 * ```
-	 *
-	 * @example
-	 * ```typescript
-	 * // Using a custom tracer
-	 * import { trace } from '@opentelemetry/api';
-	 *
-	 * const tracer = trace.getTracer('my-custom-tracer');
-	 *
-	 * telemetry: {
-	 *   tracer,
-	 *   defaultAttributes: {
-	 *     'service.instance.id': instanceId
-	 *   }
-	 * }
-	 * ```
-	 */
-	telemetry?: {
-		/**
-		 * Custom OpenTelemetry tracer to use
-		 *
-		 * If provided, this tracer will be used instead of creating a new one.
-		 * This allows for integration with existing OpenTelemetry setups.
-		 */
-		tracer?: Tracer;
-
-		/**
-		 * Whether to disable telemetry collection
-		 *
-		 * When set to true, no telemetry data will be collected or exported.
-		 * Useful for development environments or when running tests.
-		 *
-		 * @default false
-		 */
-		disabled?: boolean;
-
-		/**
-		 * Default attributes to add to all telemetry spans
-		 *
-		 * These attributes will be added to every span created by the system,
-		 * useful for adding environment, deployment, or instance information.
-		 *
-		 * Required attributes like 'service.name' and 'service.version' will be
-		 * automatically added based on application configuration.
-		 */
-		defaultAttributes?: Record<string, string | number | boolean>;
-	};
-
-	/**
-	 * Database tables configuration
-	 * Contains all entity table configurations
-	 */
-	tables?: TablesConfig;
-
-	/**
-	 * Any additional options
-	 */
-	[key: string]: unknown;
-}
-
-/**
- * Middleware function for processing API requests
- */
-export type DoubleTieMiddleware = (
-	request: Request,
-	next: () => Promise<unknown>
-) => Promise<unknown>;