@plyaz/types 1.5.0 → 1.5.2

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

@@ -732,3 +732,58 @@ export interface RepositoryOperationTestInput {
     /** Whether operation should throw an error */
     shouldThrow?: boolean;
 }
+/**
+ * Default configuration for feature flags.
+ * Provides template values for newly created flags.
+ *
+ * @example
+ * ```typescript
+ * const defaults: FlagDefaults = {
+ *   name: 'New Feature',
+ *   description: 'Enables the new experimental feature',
+ *   isEnabled: false,
+ *   value: false,
+ *   type: 'boolean',
+ *   environment: 'development',
+ *   createdAt: new Date(),
+ *   updatedAt: new Date(),
+ *   createdBy: 'system',
+ *   updatedBy: 'system'
+ * };
+ * ```
+ */
+export interface FlagDefaults {
+    /** Flag name */
+    name: string;
+    /** Flag description */
+    description: string;
+    /** Whether flag is enabled */
+    isEnabled: boolean;
+    /** Default value */
+    value: FeatureFlagValue;
+    /** Flag type */
+    type: FlagType;
+    /** Environment */
+    environment: 'development' | 'staging' | 'production' | 'all';
+    /** Created date */
+    createdAt: Date;
+    /** Updated date */
+    updatedAt: Date;
+    /** Created by */
+    createdBy: string;
+    /** Updated by */
+    updatedBy: string;
+}
+/**
+ * Supported types for feature flag values.
+ * Determines how flag values are stored and evaluated.
+ *
+ * @example
+ * ```typescript
+ * const booleanFlag: FlagType = 'boolean'; // true/false flags
+ * const stringFlag: FlagType = 'string';   // Text values like themes
+ * const numberFlag: FlagType = 'number';   // Numeric values like limits
+ * const jsonFlag: FlagType = 'json';       // Complex configurations
+ * ```
+ */
+export type FlagType = 'boolean' | 'string' | 'number' | 'json';

package/dist/testing/common/factories/types.d.ts

@@ -344,49 +344,49 @@ export interface ScenarioTestSuite<TContext, TInput, TExpected> {
  */
 export interface AutoMockedRepository {
     /** Find entities matching criteria */
-    find: Vitest.MockInstance;
+    find: Vitest.Mock;
     /** Find single entity */
-    findOne: Vitest.MockInstance;
+    findOne: Vitest.Mock;
     /** Find single entity by criteria */
-    findOneBy: Vitest.MockInstance;
+    findOneBy: Vitest.Mock;
     /** Find single entity or throw */
-    findOneOrFail: Vitest.MockInstance;
+    findOneOrFail: Vitest.Mock;
     /** Find entities by criteria */
-    findBy: Vitest.MockInstance;
+    findBy: Vitest.Mock;
     /** Find entities and get count */
-    findAndCount: Vitest.MockInstance;
+    findAndCount: Vitest.Mock;
     /** Save entity */
-    save: Vitest.MockInstance;
+    save: Vitest.Mock;
     /** Create entity instance */
-    create: Vitest.MockInstance;
+    create: Vitest.Mock;
     /** Update entity */
-    update: Vitest.MockInstance;
+    update: Vitest.Mock;
     /** Delete entity */
-    delete: Vitest.MockInstance;
+    delete: Vitest.Mock;
     /** Remove entity */
-    remove: Vitest.MockInstance;
+    remove: Vitest.Mock;
     /** Count entities */
-    count: Vitest.MockInstance;
+    count: Vitest.Mock;
     /** Execute raw query */
-    query: Vitest.MockInstance;
+    query: Vitest.Mock;
     /** Create query builder */
-    createQueryBuilder: Vitest.MockInstance;
+    createQueryBuilder: Vitest.Mock;
     /** Preload entity with relations */
-    preload: Vitest.MockInstance;
+    preload: Vitest.Mock;
     /** Merge entity changes */
-    merge: Vitest.MockInstance;
+    merge: Vitest.Mock;
     /** Soft delete entity */
-    softDelete: Vitest.MockInstance;
+    softDelete: Vitest.Mock;
     /** Restore soft deleted entity */
-    restore: Vitest.MockInstance;
+    restore: Vitest.Mock;
     /** Check if entity exists */
-    exist: Vitest.MockInstance;
+    exist: Vitest.Mock;
     /** Clear all entities */
-    clear: Vitest.MockInstance;
+    clear: Vitest.Mock;
     /** Increment field value */
-    increment: Vitest.MockInstance;
+    increment: Vitest.Mock;
     /** Decrement field value */
-    decrement: Vitest.MockInstance;
+    decrement: Vitest.Mock;
 }
 /**
  * Auto-mocked HTTP service interface for HTTP client testing
@@ -407,21 +407,21 @@ export interface AutoMockedRepository {
  */
 export interface AutoMockedHttpService {
     /** HTTP GET request */
-    get: Vitest.MockInstance;
+    get: Vitest.Mock;
     /** HTTP POST request */
-    post: Vitest.MockInstance;
+    post: Vitest.Mock;
     /** HTTP PUT request */
-    put: Vitest.MockInstance;
+    put: Vitest.Mock;
     /** HTTP PATCH request */
-    patch: Vitest.MockInstance;
+    patch: Vitest.Mock;
     /** HTTP DELETE request */
-    delete: Vitest.MockInstance;
+    delete: Vitest.Mock;
     /** HTTP HEAD request */
-    head: Vitest.MockInstance;
+    head: Vitest.Mock;
     /** HTTP OPTIONS request */
-    options: Vitest.MockInstance;
+    options: Vitest.Mock;
     /** Generic HTTP request */
-    request: Vitest.MockInstance;
+    request: Vitest.Mock;
 }
 /**
  * Auto-mocked configuration service interface for config testing
@@ -442,13 +442,13 @@ export interface AutoMockedHttpService {
  */
 export interface AutoMockedConfigService {
     /** Get configuration value */
-    get: Vitest.MockInstance;
+    get: Vitest.Mock;
     /** Get configuration value or throw */
-    getOrThrow: Vitest.MockInstance;
+    getOrThrow: Vitest.Mock;
     /** Check if configuration key exists */
-    has: Vitest.MockInstance;
+    has: Vitest.Mock;
     /** Set configuration value */
-    set: Vitest.MockInstance;
+    set: Vitest.Mock;
 }
 /**
  * Database update operation result
@@ -700,10 +700,29 @@ export interface ScenarioResult<T> {
     duration: number;
 }
 /**
- * Tracked call record for mock functions
- * @interface TrackedCallRecord
- * @typeParam TArgs - Function argument types
- * @typeParam TReturn - Function return type
+ * Record of a single function call with metadata.
+ * Captures comprehensive information about each mock function invocation.
+ *
+ * @template TArgs - Function argument types
+ * @template TReturn - Function return type
+ *
+ * @example
+ * ```typescript
+ * const record: TrackedCallRecord<[string, number], string> = {
+ *   args: ['hello', 42],
+ *   timestamp: new Date('2024-01-01T10:00:00Z'),
+ *   result: 'success',
+ *   duration: 125
+ * };
+ *
+ * // Error case
+ * const errorRecord: TrackedCallRecord<[string], void> = {
+ *   args: ['invalid'],
+ *   timestamp: new Date(),
+ *   error: new Error('Validation failed'),
+ *   duration: 50
+ * };
+ * ```
  */
 export interface TrackedCallRecord<TArgs extends unknown[], TReturn> {
     /** Function arguments */
@@ -714,32 +733,49 @@ export interface TrackedCallRecord<TArgs extends unknown[], TReturn> {
     result?: TReturn;
     /** Error if thrown */
     error?: Error;
-    /** Call duration */
+    /** Call duration in milliseconds */
     duration?: number;
 }
 /**
- * Tracked mock function with enhanced capabilities
- * @interface TrackedMockFunction
- * @typeParam TArgs - Function argument types
- * @typeParam TReturn - Function return type
- * @extends Vitest.MockInstance from vitest
+ * Enhanced mock function with call tracking and filtering capabilities.
+ * Extends Vitest's Mock to provide detailed call history and search functionality.
+ *
+ * @template TArgs - Function argument types
+ * @template TReturn - Function return type
+ *
+ * @extends {Vitest.Mock<(...args: TArgs) => TReturn>}
+ *
+ * @example
+ * ```typescript
+ * const trackedFn: TrackedMockFunction<[string, number], boolean> = createTrackedMock();
+ *
+ * // Use the mock
+ * trackedFn('test', 42);
+ * trackedFn('example', 100);
+ *
+ * // Access call records
+ * const firstCall = trackedFn.getCall(0);
+ * console.log(firstCall?.args); // ['test', 42]
+ *
+ * // Find specific calls
+ * const testCalls = trackedFn.findCalls(
+ *   call => call.args[0] === 'test'
+ * );
+ *
+ * // Reset call history
+ * trackedFn.resetCalls();
+ * ```
  */
-export interface TrackedMockFunction<TArgs extends unknown[], TReturn> extends Vitest.MockInstance<(...args: TArgs) => TReturn> {
-    /** All call records */
+export interface TrackedMockFunction<TArgs extends unknown[], TReturn> extends Vitest.Mock<(...args: TArgs) => TReturn> {
+    /** Array of all call records with metadata */
     calls: Array<TrackedCallRecord<TArgs, TReturn>>;
-    /** Get specific call */
+    /** Get a specific call by index */
     getCall: (index: number) => TrackedCallRecord<TArgs, TReturn> | undefined;
-    /** Find calls matching predicate */
+    /** Find calls matching a predicate */
     findCalls: (predicate: (call: {
         args: TArgs;
         timestamp: Date;
     }) => boolean) => Array<TrackedCallRecord<TArgs, TReturn>>;
-    /** Get call count */
-    getCallCount: () => number;
-    /** Get total execution time */
-    getTotalExecutionTime: () => number;
-    /** Get average execution time */
-    getAverageExecutionTime: () => number;
-    /** Clear tracking history */
-    clearTracking: () => void;
+    /** Reset all tracked calls */
+    resetCalls: () => void;
 }