@plyaz/types 1.1.4 → 1.2.1

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

@@ -17,7 +17,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 +46,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 +99,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 +118,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 +170,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 +179,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,7 +196,7 @@ export interface FeatureFlagContextValue<FeatureFlagKey> {
 /**
  * Props for the React FeatureFlagProvider component.
  */
-export interface FeatureFlagProviderProps<FeatureFlagKey> {
+export interface FeatureFlagProviderProps<FeatureFlagKey extends string> {
     /** Provider configuration */
     config: FeatureFlagConfig<FeatureFlagKey>;
     /** Default context for flag evaluation */
@@ -220,7 +220,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 +240,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 +296,195 @@ 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>[];
 }
+/**
+ * Input for error handling test cases
+ */
+export interface ErrorHandlingTestInput {
+    /** The error to test */
+    error: unknown;
+    /** Expected error message */
+    expectedMessage: string;
+    /** Expected HTTP status code */
+    expectedStatus: number;
+}
+/**
+ * Input for flag evaluation test cases
+ */
+export interface FlagEvaluationTestInput<FeatureFlagKey extends string> {
+    /** The flag key to evaluate */
+    flagKey: FeatureFlagKey;
+    /** Optional evaluation context */
+    context?: FeatureFlagContext;
+    /** Mock value to return */
+    mockValue: boolean;
+    /** Whether the flag is enabled */
+    isEnabled: boolean;
+}
+/**
+ * Input for flag creation test cases
+ */
+export interface FlagCreationTestInput<FeatureFlagKey extends string> {
+    /** Unique key for the flag */
+    key: FeatureFlagKey;
+    /** Human-readable name */
+    name: string;
+    /** Optional description */
+    description?: string;
+    /** Flag value */
+    value: FeatureFlagValue;
+    /** Whether the flag is enabled */
+    isEnabled?: boolean;
+    /** Target environment */
+    environment?: 'all' | 'development' | 'production' | 'staging';
+    /** Rollout percentage (0-100) */
+    rolloutPercentage?: number;
+}
+/**
+ * Input for flag update test cases
+ */
+export interface FlagUpdateTestInput<FeatureFlagKey extends string> {
+    /** Key of the flag to update */
+    flagKey: FeatureFlagKey;
+    /** Update data object */
+    updateData: Record<string, unknown>;
+}
+/**
+ * Input for override test cases
+ */
+export interface OverrideTestInput<FeatureFlagKey extends string> {
+    /** Flag key to override */
+    flagKey: FeatureFlagKey;
+    /** Override value */
+    value: FeatureFlagValue;
+}
+/**
+ * Input for service initialization test cases
+ */
+export interface ServiceInitializationTestInput {
+    /** Environment variables to set */
+    envVars: Record<string, string>;
+    /** Expected configuration after initialization */
+    expectedConfig: {
+        /** Provider type */
+        provider: string;
+        /** Whether caching is enabled */
+        isCacheEnabled: boolean;
+        /** Cache TTL in seconds */
+        cacheTtl: number;
+        /** Refresh interval in seconds */
+        refreshInterval: number;
+        /** Whether to fallback to defaults on error */
+        shouldFallbackToDefaults: boolean;
+        /** Whether logging is enabled */
+        isLoggingEnabled: boolean;
+    };
+}
+/**
+ * Input for flag operation error test cases
+ */
+export interface FlagOperationErrorTestInput<FeatureFlagKey extends string> {
+    /** Flag key involved in the operation */
+    flagKey: FeatureFlagKey;
+    /** Error that occurred */
+    error: Error;
+    /** Expected log message */
+    expectedLogMessage: string;
+}
+/**
+ * Input for type inference test cases
+ */
+export interface TypeInferenceTestInput {
+    /** Value to infer type from */
+    value: unknown;
+    /** Expected type string */
+    expectedType: string;
+}
+/**
+ * Input for environment filter test cases
+ */
+export interface EnvironmentFilterTestInput {
+    /** Environment to filter by */
+    environment: string;
+    /** List of allowed environments */
+    allowedEnvironments: string[];
+}
+/**
+ * Input for timestamp behavior test cases
+ */
+export interface TimestampTestInput {
+    /** Operation type */
+    operation: 'create' | 'update';
+    /** Description of expected timestamp behavior */
+    expectedTimestampBehavior: string;
+}
+export interface ModuleConfigurationTestInput {
+    config: Record<string, unknown>;
+    expectedConfig: Record<string, unknown>;
+}
+export interface ProviderTypeTestInput {
+    provider: string;
+}
+export interface FlagOperationTestInput<FeatureFlagKey extends string> {
+    operation: 'create' | 'update' | 'delete' | 'evaluate';
+    flagKey: FeatureFlagKey;
+    data?: unknown;
+    context?: FeatureFlagContext;
+    expectedResult?: unknown;
+}
+export interface PermissionTestInput {
+    role: string;
+    operation: string;
+    resource: string;
+    expected: boolean;
+}
+export interface CacheOperationTestInput<FeatureFlagKey extends string> {
+    operation: 'set' | 'get' | 'refresh' | 'clear';
+    flagKey?: FeatureFlagKey;
+    expectedBehavior: string;
+}
+export interface RuleEvaluationTestInput<FeatureFlagKey extends string> {
+    flagKey: FeatureFlagKey;
+    rules: Array<{
+        conditions: Record<string, unknown>;
+        value: FeatureFlagValue;
+    }>;
+    context: FeatureFlagContext;
+    expectedValue: FeatureFlagValue;
+}
+export interface BatchOperationTestInput<FeatureFlagKey extends string> {
+    operations: Array<{
+        type: 'create' | 'update' | 'delete';
+        flagKey: FeatureFlagKey;
+        data?: unknown;
+    }>;
+    expectedResults: unknown[];
+}
+export interface ValidationTestInput {
+    input: unknown;
+    field: string;
+    expectedError?: string;
+    isValid: boolean;
+}
+export interface DynamicModuleTestInput {
+    config: Record<string, unknown>;
+    expectedProviders?: string[];
+    expectedImports?: string[];
+    expectedExports?: string[];
+}
+export interface AsyncModuleConfigTestInput {
+    imports?: string[];
+    inject?: string[];
+    useFactory?: (...args: unknown[]) => Record<string, unknown>;
+    expectedImports?: string[];
+    expectedProviders?: string[];
+}
+export interface RepositoryOperationTestInput {
+    operation: 'create' | 'update' | 'delete' | 'find';
+    data?: unknown;
+    expectedResult?: unknown;
+    shouldThrow?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.1.4",
+  "version": "1.2.1",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",
@@ -37,9 +37,10 @@
     "@eslint/markdown": "^6.5.0",
     "@nestjs/common": "^11.1.3",
     "@next/eslint-plugin-next": "^15.0.3",
-    "@plyaz/devtools": "^1.4.2",
-    "@types/node": "^20.0.0",
+    "@plyaz/devtools": "^1.6.11",
+    "@types/node": "^22.14.0",
     "@types/react": "^19.1.8",
+    "@types/react-dom": "^19.1.6",
     "@typescript-eslint/eslint-plugin": "^8.15.0",
     "@typescript-eslint/parser": "^8.15.0",
     "@vitest/coverage-v8": "^3.1.3",