@plyaz/types 1.6.0 → 1.7.1

package/dist/errors/types.d.ts

@@ -1,32 +1,13 @@
+import type { WithStatusCode, WithErrorCode, WithMessage, WithCorrelationId, WithTimestamp, WithValidationError } from '../common/types';
 /**
  * Represents the structure of an error response returned by the application.
  * @template ErrorDetails - The type of the `errors` array, defaults to `ErrorDetailsList`.
  */
-export interface ErrorResponse<ErrorDetails = ErrorDetailsList> {
-    /**
-     * HTTP status code (e.g., 400, 404, 500).
-     */
-    readonly statusCode: number;
-    /**
-     * Application-specific error code used for programmatic handling.
-     */
-    readonly errorCode: string;
-    /**
-     * Human-readable message describing the error.
-     */
-    readonly message: string;
+export interface ErrorResponse<ErrorDetails = ErrorDetailsList> extends WithStatusCode, WithErrorCode, WithMessage, Partial<WithCorrelationId>, WithTimestamp {
     /**
      * Array of detailed errors, typically used for validation failures.
      */
     readonly errors: ErrorDetails;
-    /**
-     * Optional unique identifier for tracing the request across systems.
-     */
-    readonly correlationId?: string;
-    /**
-     * ISO 8601 timestamp indicating when the error occurred.
-     */
-    readonly timestamp: string;
 }
 /**
  * Additional context information about a validation error.
@@ -50,28 +31,12 @@ export interface ErrorDetailContext<ValueGiven, AllowedValues, Constraints> {
 }
 /**
  * Represents a specific validation or business logic error related to a particular field.
+ * Uses WithValidationError for consistent validation error structure.
  * @template ValueGiven - Type of the value that caused the error.
  * @template AllowedValues - Type of acceptable values for the field.
  * @template Constraints - Type of any validation constraints.
  */
-export interface ErrorDetail<ValueGiven, AllowedValues, Constraints> {
-    /**
-     * The name of the field that caused the error (optional).
-     */
-    readonly field?: string;
-    /**
-     * Human-readable error message for this specific field or rule.
-     */
-    readonly message: string;
-    /**
-     * Specific application-defined error code for this error.
-     */
-    readonly errorCode: string;
-    /**
-     * Additional context information about the error.
-     */
-    readonly context?: ErrorDetailContext<ValueGiven, AllowedValues, Constraints>;
-}
+export type ErrorDetail<ValueGiven, AllowedValues, Constraints> = WithValidationError<ErrorDetailContext<ValueGiven, AllowedValues, Constraints>>;
 /**
  * Error Details Array.
  * @description A flexible list of error details that can contain string, number, or boolean values along with structured allowed values and constraints.

package/dist/events/payload.d.ts

@@ -1,6 +1,7 @@
 /**
  * User Payloads.
  */
+import type { WithUuid } from '../common/types';
 /**
  * Payload for user update events.
  * Contains the unique identifier of the user that was updated.
@@ -12,7 +13,5 @@
  * };
  * ```
  */
-export interface UserUpdatePayload {
-    /** The unique identifier of the updated user */
-    readonly uuid: string;
+export interface UserUpdatePayload extends WithUuid {
 }

package/dist/events/types.d.ts

@@ -1,14 +1,12 @@
+import type { Promisable, SetOptional } from 'type-fest';
 import type { EVENT_PRIORITY, EVENT_STATUS, EVENT_TYPE } from './enums';
+import type { Identifiable, WithUserId, WithSessionId, WithUserAgent, WithRetryTracking, WithTimestamp, WithCorrelationId, Versioned, WithSource, WithStatus, WithPriority, WithMetadata, WithIpAddress, WithPayload, SubscriptionWithHandler } from '../common/types';
 /**
  * Event Details.
  * @description Represents a typed event published and consumed via the event bus.
  * @template T - The payload type carried by the event.
  */
-export interface Event<T> {
-    /**
-     * Unique identifier for the event instance.
-     */
-    readonly id: string;
+export interface Event<T> extends Identifiable, WithTimestamp, Partial<WithCorrelationId>, Versioned, WithSource, WithStatus<typeof EVENT_STATUS>, WithPriority<typeof EVENT_PRIORITY>, Partial<WithMetadata<EventMetadata>>, WithPayload<T> {
     /**
      * Type of the event, used to categorize behavior.
      */
@@ -17,103 +15,42 @@ export interface Event<T> {
      * Topic used for event routing and subscription.
      */
     readonly topic: string;
-    /**
-     * ISO timestamp of when the event was created.
-     */
-    readonly timestamp: string;
-    /**
-     * Payload data associated with the event.
-     */
-    readonly payload: T;
-    /**
-     * Origin or service that published the event.
-     */
-    readonly source: string;
-    /**
-     * Optional correlation ID used for tracing distributed flows.
-     */
-    readonly correlationId?: string;
-    /**
-     * Version number of the event structure or schema.
-     */
-    readonly version: number;
-    /**
-     * Priority level of the event.
-     */
-    readonly priority: typeof EVENT_PRIORITY;
-    /**
-     * Current processing status of the event.
-     */
-    readonly status: typeof EVENT_STATUS;
-    /**
-     * Optional metadata providing contextual details about the event.
-     */
-    readonly metadata?: EventMetadata;
 }
 /**
  * Additional contextual data for an event.
  * @description This is often populated with session/user data and retry tracking.
  */
-export interface EventMetadata {
-    /**
-     * Optional user identifier associated with the event.
-     */
-    readonly userId?: string;
-    /**
-     * Optional session identifier, typically from a browser or mobile session.
-     */
-    readonly sessionId?: string;
-    /**
-     * User-agent string from the origin of the event.
-     */
-    readonly userAgent?: string;
-    /**
-     * IP address of the origin that triggered the event.
-     */
-    readonly ipAddress?: string;
-    /**
-     * Current retry attempt count for the event.
-     */
-    readonly retryCount?: number;
-    /**
-     * Maximum allowed retries for this event.
-     */
-    readonly maxRetries?: number;
+export type EventMetadata = SetOptional<WithUserId & WithSessionId & WithUserAgent & WithRetryTracking & WithIpAddress, 'userId' | 'sessionId' | 'userAgent' | 'retryCount' | 'maxRetries' | 'ip'> & {
     /**
      * Additional metadata as key-value pairs.
      */
     readonly [key: string]: unknown;
-}
+};
 /**
  * Event Handler.
  * @description A handler function that processes an event of type `T`.
  * @template T - The event payload type.
  */
-export type EventHandler<T = unknown> = (event: Event<T>) => void | Promise<void>;
+export type EventHandler<T = unknown> = (event: Event<T>) => Promisable<void>;
 /**
  * Represents a subscription to a specific topic on the event bus.
+ * Uses the common SubscriptionWithHandler pattern with EventHandler type.
  */
-export interface Subscription {
-    /**
-     * Unique ID for the subscription.
-     */
-    readonly id: string;
-    /**
-     * Topic the handler is subscribed to.
-     */
-    readonly topic: string;
+export type Subscription = SubscriptionWithHandler<Event<unknown>> & {
     /**
      * Handler function to invoke when an event is published on the topic.
      */
     readonly handler: EventHandler;
-    /**
-     * Function to cancel the subscription.
-     */
-    readonly unsubscribe: () => void;
-}
+};
 /**
  * Interface for a publish-subscribe event bus system.
  * @description Allows services to publish events and listen to specific topics.
+ *
+ * While this doesn't directly extend WithTopicSubscribe due to different signatures
+ * (EventBus uses EventHandler instead of a generic callback), it follows the same
+ * conceptual pattern of topic-based pub/sub.
+ *
+ * For simpler pub/sub patterns, see WithTopicPubSub or WithSubscribable in common/types.
  */
 export interface EventBus {
     /**
@@ -123,6 +60,7 @@ export interface EventBus {
     readonly publish: <T>(event: Event<T>) => Promise<void>;
     /**
      * Subscribes a handler function to a specific topic.
+     * Similar to WithTopicSubscribe but uses EventHandler for type safety.
      * @param topic - The topic to subscribe to.
      * @param handler - The function to call when events are published to the topic.
      * @returns A `Subscription` object for managing the listener.
@@ -130,6 +68,7 @@ export interface EventBus {
     readonly subscribe: <T>(topic: string, handler: EventHandler<T>) => Subscription;
     /**
      * Unsubscribes a handler by its subscription ID.
+     * Matches the pattern in WithTopicSubscribe.
      * @param subscriptionId - The unique ID of the subscription to remove.
      */
     readonly unsubscribe: (subscriptionId: string) => void;

package/dist/features/cache/types.d.ts

@@ -10,15 +10,11 @@
 /**
  * Cache entry structure that wraps cached data with metadata.
  */
-export interface CacheEntry<T = unknown> {
+import type { UnknownRecord } from 'type-fest';
+import type { Configurable, WithExpiration, WithMetadata, Enabled, WithUrl, Timestamped } from '../../common/types';
+export interface CacheEntry<T = unknown> extends Partial<WithMetadata<UnknownRecord>>, WithExpiration<number>, Pick<Timestamped<number, number>, 'createdAt'> {
     /** The cached data */
     data: T;
-    /** When the entry expires (timestamp in milliseconds) */
-    expiresAt: number;
-    /** When the entry was created (timestamp in milliseconds) */
-    createdAt: number;
-    /** Optional metadata for the cache entry */
-    meta?: Record<string, unknown>;
 }
 /**
  * Cache statistics for monitoring and debugging.
@@ -40,9 +36,7 @@ export interface CacheStats {
 /**
  * Configuration for cache strategies.
  */
-export interface CacheConfig {
-    /** Whether caching is enabled */
-    isEnabled: boolean;
+export interface CacheConfig extends Configurable, Enabled {
     /** Default TTL in seconds */
     ttl: number;
     /** Cache strategy to use */
@@ -50,14 +44,7 @@ export interface CacheConfig {
     /** Redis-specific configuration */
     redisConfig?: RedisCacheConfig;
     /** Memory cache specific configuration */
-    memoryConfig?: {
-        /** Maximum number of entries to store */
-        maxSize?: number;
-        /** Maximum number of entries to store (alias for maxSize) */
-        maxEntries?: number;
-        /** Check for expired entries every N milliseconds */
-        cleanupInterval?: number;
-    };
+    memoryConfig?: MemoryCacheConfig;
 }
 /**
  * Configuration for memory cache strategy.
@@ -75,9 +62,7 @@ export interface MemoryCacheConfig {
 /**
  * Configuration for Redis cache strategy.
  */
-export interface RedisCacheConfig {
-    /** Redis connection URL */
-    url: string;
+export interface RedisCacheConfig extends WithUrl {
     /** Redis password for authentication */
     password?: string;
     /** Redis database number */
@@ -92,8 +77,7 @@ export interface RedisCacheConfig {
 /**
  * Cache manager statistics interface.
  */
-export interface CacheManagerStats extends CacheStats {
-}
+export type CacheManagerStats = CacheStats;
 /**
  * Interface that all cache strategies must implement.
  */

package/dist/features/community/blog/providers/wordpress/types.d.ts

@@ -6,10 +6,9 @@
  * @fileoverview WordPress provider type definitions
  * @version 1.0.0
  */
-export interface WPPostRaw {
-    id: number;
+import type { Named, Sluggable } from '../../../../../common';
+export interface WPPostRaw extends Sluggable, Named {
     date: string;
-    slug: string;
     title: {
         rendered: string;
     };

package/dist/features/community/blog/types.d.ts

@@ -6,23 +6,21 @@
  * @fileoverview Blog domain type definitions
  * @version 1.0.0
  */
+import type { Identifiable, Named, Sluggable, WithCategories } from '../../../common/types';
+export interface Author extends Named {
+    avatar?: string;
+}
 /**
  * Blog post interface
  * @description This interface defines the properties of a blog post.
  */
-export interface BlogPost {
-    id: number;
+export interface BlogPost extends Identifiable<number>, Sluggable, WithCategories {
     title: string;
     excerpt: string;
     content: string;
     date: string;
-    slug: string;
     featuredImage?: string;
-    author: {
-        name: string;
-        avatar?: string;
-    };
-    categories: string[];
+    author: Author;
     readingTime: number;
 }
 /**