better-auth-feature-flags/src/index.ts

Ship features safely with feature flags, A/B testing, and progressive rollouts - Better Auth plugin for modern release management

// SPDX-FileCopyrightText: 2025-present Kriasoft
// SPDX-License-Identifier: MIT

// Type augmentations only - no runtime imports to preserve tree-shaking
import type {} from "./augmentation";

import { createFeatureFlagsPlugin } from "./plugin";
import type { BetterAuthPlugin } from "better-auth";
import type { FeatureFlagsOptions } from "./types";
import type { FlagEndpoints } from "./endpoints";
import { definePlugin } from "./internal/define-plugin";

/**
 * Better Auth Feature Flags Plugin
 *
 * Provides comprehensive feature flag management with:
 * - Multiple storage backends (memory, database, redis)
 * - Advanced targeting and segmentation
 * - Percentage-based rollouts
 * - A/B testing with variants
 * - Real-time evaluation and caching
 * - Audit logging and analytics
 * - Multi-tenancy support
 *
 * @example
 * ```typescript
 * import { betterAuth } from "better-auth";
 * import { featureFlags } from "better-auth-feature-flags";
 *
 * export const auth = betterAuth({
 *   plugins: [
 *     featureFlags({
 *       storage: "database",
 *       caching: { enabled: true, ttl: 60 },
 *       analytics: { trackUsage: true },
 *     })
 *   ]
 * });
 * ```
 */
export function featureFlags(
  options: FeatureFlagsOptions = {},
): BetterAuthPlugin & { endpoints: FlagEndpoints } {
  // Hide complex internal types while preserving endpoint keys for API typing
  return definePlugin<FlagEndpoints>(createFeatureFlagsPlugin(options));
}

export default featureFlags;

// Core schema types for external consumers
export type {
  AuditAction,
  ConditionOperator,
  EvaluationContext,
  EvaluationReason,
  FeatureFlag,
  FlagAudit,
  FlagEvaluation,
  FlagOverride,
  FlagRule,
  FlagType,
  RuleConditions,
} from "./schema";

// Middleware configuration types
export type { ContextCollectionOptions } from "./middleware/context";

// Validation utilities and configuration
export { DEFAULT_HEADER_CONFIG } from "./middleware/validation";
export type { HeaderConfig, ValidationConfig } from "./middleware/validation";
// Main plugin configuration interface
export type { FeatureFlagsOptions } from "./types";