@plyaz/types 1.2.0 → 1.3.0

package/dist/features/feature-flag/types.d.ts

@@ -2,7 +2,6 @@
  * Feature Flags Domain Types
  *
  * Core type definitions for the feature flags domain.
- * These types will be moved to @plyaz/types when the package structure is finalized.
  *
  * @fileoverview Feature flags domain type definitions
  * @version 1.0.0
@@ -17,7 +16,7 @@ export type FeatureFlagValue = boolean | string | number | Record<string, unknow
  * Core feature flag definition interface.
  * Represents a complete feature flag with all its metadata and configuration.
  */
-export interface FeatureFlag<FeatureFlagKey> {
+export interface FeatureFlag<FeatureFlagKey extends string> {
     /** The unique identifier for this flag */
     key: FeatureFlagKey;
     /** Human-readable name for the flag */
@@ -46,7 +45,7 @@ export interface FeatureFlag<FeatureFlagKey> {
 /**
  * Feature flag rule for advanced targeting and conditional logic.
  */
-export interface FeatureFlagRule<FeatureFlagKey> {
+export interface FeatureFlagRule<FeatureFlagKey extends string> {
     /** Unique identifier for this rule */
     id: string;
     /** The feature flag this rule applies to */
@@ -99,7 +98,7 @@ export interface FeatureFlagContext {
 /**
  * Result of a feature flag evaluation.
  */
-export interface FeatureFlagEvaluation<FeatureFlagKey> {
+export interface FeatureFlagEvaluation<FeatureFlagKey extends string> {
     /** The feature flag key that was evaluated */
     flagKey: FeatureFlagKey;
     /** The resolved value for this flag */
@@ -118,7 +117,7 @@ export interface FeatureFlagEvaluation<FeatureFlagKey> {
 /**
  * Configuration options for the feature flag system.
  */
-export interface FeatureFlagConfig<FeatureFlagKey> {
+export interface FeatureFlagConfig<FeatureFlagKey extends string> {
     /** The storage provider to use for flag data */
     provider: 'database' | 'redis' | 'memory' | 'api' | 'file';
     /** Whether to enable caching of flag evaluations */
@@ -170,7 +169,7 @@ export interface UseFeatureFlagOptions {
 /**
  * Internal state for feature flag evaluation in React hooks.
  */
-export interface FeatureFlagState<FeatureFlagKey, T extends FeatureFlagValue = FeatureFlagValue> {
+export interface FeatureFlagState<FeatureFlagKey extends string, T extends FeatureFlagValue = FeatureFlagValue> {
     value: T;
     isLoading: boolean;
     error: Error | null;
@@ -179,7 +178,7 @@ export interface FeatureFlagState<FeatureFlagKey, T extends FeatureFlagValue = F
 /**
  * Context value interface for React feature flag provider.
  */
-export interface FeatureFlagContextValue<FeatureFlagKey> {
+export interface FeatureFlagContextValue<FeatureFlagKey extends string> {
     /** The feature flag provider instance */
     provider: FeatureFlagProvider<FeatureFlagKey>;
     /** Whether the provider is initialized */
@@ -196,13 +195,15 @@ export interface FeatureFlagContextValue<FeatureFlagKey> {
 /**
  * Props for the React FeatureFlagProvider component.
  */
-export interface FeatureFlagProviderProps<FeatureFlagKey> {
+export interface FeatureFlagProviderProps<FeatureFlagKey extends string, FeatureFlags extends Record<FeatureFlagKey, FeatureFlagValue>> {
     /** Provider configuration */
     config: FeatureFlagConfig<FeatureFlagKey>;
     /** Default context for flag evaluation */
     defaultContext?: FeatureFlagContext;
     /** Children components */
     children: React.ReactNode;
+    /** Predefined feature flags and their values */
+    features: FeatureFlags;
     /** Callback when provider is ready */
     onReady?: (provider: FeatureFlagProvider<FeatureFlagKey>) => void;
     /** Callback when an error occurs */
@@ -220,7 +221,7 @@ export interface FeatureFlagProviderProps<FeatureFlagKey> {
 /**
  * Backend Request DTO for flag creation.
  */
-export interface CreateFlagRequest<FeatureFlagKey> {
+export interface CreateFlagRequest<FeatureFlagKey extends string> {
     key: FeatureFlagKey;
     name: string;
     description?: string;
@@ -240,7 +241,7 @@ export interface ProviderHealthStatus {
 /**
  * Main interface for feature flag providers.
  */
-export interface FeatureFlagProvider<FeatureFlagKey> {
+export interface FeatureFlagProvider<FeatureFlagKey extends string> {
     /** Initializes the provider by loading initial data */
     initialize(): Promise<void>;
     /** Evaluates a feature flag and returns full evaluation details */
@@ -296,7 +297,7 @@ export interface FeatureFlagHelpers<FeatureFlagKey extends string = string> {
     isAllEnabled: (keys: FeatureFlagKey[], context?: FeatureFlagContext) => Promise<boolean>;
     whenEnabled: <T>(key: FeatureFlagKey, callback: () => T | Promise<T>, fallback?: () => T | Promise<T>, context?: FeatureFlagContext) => Promise<T | undefined>;
 }
-export interface FetchFeatureFlagDataResponse<FeatureFlagKey> {
+export interface FetchFeatureFlagDataResponse<FeatureFlagKey extends string> {
     flags: FeatureFlag<FeatureFlagKey>[];
     rules: FeatureFlagRule<FeatureFlagKey>[];
 }
@@ -314,7 +315,7 @@ export interface ErrorHandlingTestInput {
 /**
  * Input for flag evaluation test cases
  */
-export interface FlagEvaluationTestInput<FeatureFlagKey> {
+export interface FlagEvaluationTestInput<FeatureFlagKey extends string> {
     /** The flag key to evaluate */
     flagKey: FeatureFlagKey;
     /** Optional evaluation context */
@@ -327,7 +328,7 @@ export interface FlagEvaluationTestInput<FeatureFlagKey> {
 /**
  * Input for flag creation test cases
  */
-export interface FlagCreationTestInput<FeatureFlagKey> {
+export interface FlagCreationTestInput<FeatureFlagKey extends string> {
     /** Unique key for the flag */
     key: FeatureFlagKey;
     /** Human-readable name */
@@ -346,7 +347,7 @@ export interface FlagCreationTestInput<FeatureFlagKey> {
 /**
  * Input for flag update test cases
  */
-export interface FlagUpdateTestInput<FeatureFlagKey> {
+export interface FlagUpdateTestInput<FeatureFlagKey extends string> {
     /** Key of the flag to update */
     flagKey: FeatureFlagKey;
     /** Update data object */
@@ -355,7 +356,7 @@ export interface FlagUpdateTestInput<FeatureFlagKey> {
 /**
  * Input for override test cases
  */
-export interface OverrideTestInput<FeatureFlagKey> {
+export interface OverrideTestInput<FeatureFlagKey extends string> {
     /** Flag key to override */
     flagKey: FeatureFlagKey;
     /** Override value */
@@ -386,7 +387,7 @@ export interface ServiceInitializationTestInput {
 /**
  * Input for flag operation error test cases
  */
-export interface FlagOperationErrorTestInput<FeatureFlagKey> {
+export interface FlagOperationErrorTestInput<FeatureFlagKey extends string> {
     /** Flag key involved in the operation */
     flagKey: FeatureFlagKey;
     /** Error that occurred */
@@ -428,7 +429,7 @@ export interface ModuleConfigurationTestInput {
 export interface ProviderTypeTestInput {
     provider: string;
 }
-export interface FlagOperationTestInput<FeatureFlagKey> {
+export interface FlagOperationTestInput<FeatureFlagKey extends string> {
     operation: 'create' | 'update' | 'delete' | 'evaluate';
     flagKey: FeatureFlagKey;
     data?: unknown;
@@ -441,12 +442,12 @@ export interface PermissionTestInput {
     resource: string;
     expected: boolean;
 }
-export interface CacheOperationTestInput<FeatureFlagKey> {
+export interface CacheOperationTestInput<FeatureFlagKey extends string> {
     operation: 'set' | 'get' | 'refresh' | 'clear';
     flagKey?: FeatureFlagKey;
     expectedBehavior: string;
 }
-export interface RuleEvaluationTestInput<FeatureFlagKey> {
+export interface RuleEvaluationTestInput<FeatureFlagKey extends string> {
     flagKey: FeatureFlagKey;
     rules: Array<{
         conditions: Record<string, unknown>;
@@ -455,7 +456,7 @@ export interface RuleEvaluationTestInput<FeatureFlagKey> {
     context: FeatureFlagContext;
     expectedValue: FeatureFlagValue;
 }
-export interface BatchOperationTestInput<FeatureFlagKey> {
+export interface BatchOperationTestInput<FeatureFlagKey extends string> {
     operations: Array<{
         type: 'create' | 'update' | 'delete';
         flagKey: FeatureFlagKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",
@@ -43,6 +43,8 @@
     "@types/react-dom": "^19.1.6",
     "@typescript-eslint/eslint-plugin": "^8.15.0",
     "@typescript-eslint/parser": "^8.15.0",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
     "@vitest/coverage-v8": "^3.1.3",
     "eslint": "^9.29.0",
     "eslint-config-next": "^15.3.3",