@plyaz/types 1.5.5 → 1.7.0

package/dist/api/types.d.ts

@@ -1,3 +1,5 @@
+import type { Simplify } from 'type-fest';
+import type { WithTimestamp, WithCorrelationId, Pageable, Versioned, NavigablePaginationMetadata, WithRequestId, WithItems } from '../common/types';
 /**
  * Standard structure for API responses.
  * @template Data - The main payload/data returned by the API.
@@ -17,66 +19,31 @@ export interface ApiResponse<Data, Meta = Record<string, string>> {
  * Metadata included in API responses.
  * @description Provides useful context such as timestamps, request tracking, and API versioning.
  */
-export interface ApiResponseMeta {
-    /**
-     * ISO timestamp indicating when the response was generated.
-     */
-    readonly timestamp: string;
-    /**
-     * Semantic version or release version of the API.
-     */
-    readonly version: string;
-    /**
-     * Unique identifier for tracing the API request.
-     */
-    readonly requestId: string;
-}
+export type ApiResponseMeta = WithTimestamp & Versioned & WithCorrelationId & WithRequestId;
 /**
  * Generic structure for paginated API responses.
  * @template Item - The type of items in the paginated result.
  */
-export interface PaginatedResponse<Item> {
-    /**
-     * The current page's list of items.
-     */
-    readonly items: readonly Item[];
-    /**
-     * Total number of items across all pages.
-     */
-    readonly totalCount: number;
-    /**
-     * Number of items per page.
-     */
-    readonly pageSize: number;
-    /**
-     * Current page number (starting from 1).
-     */
-    readonly currentPage: number;
-    /**
-     * Total number of available pages.
-     */
-    readonly totalPages: number;
-    /**
-     * Indicates whether there is a next page.
-     */
-    readonly hasNextPage: boolean;
-    /**
-     * Indicates whether there is a previous page.
-     */
-    readonly hasPreviousPage: boolean;
-}
+/**
+ * Common pagination information shared by paginated API results.
+ * Type alias for NavigablePaginationMetadata to maintain consistency.
+ */
+export type PaginationInfo = NavigablePaginationMetadata;
+/**
+ * Items wrapper used in paginated results.
+ * Extends WithItems with readonly array for API immutability.
+ */
+export type Paginated<Item> = WithItems<Item>;
+/**
+ * Generic structure for paginated API responses.
+ * Combines items with pagination metadata.
+ * @template Item - The type of items in the paginated result.
+ */
+export type PaginatedResponse<Item> = Simplify<Paginated<Item> & PaginationInfo>;
 /**
  * Parameters used to control pagination in API requests.
  */
-export interface PaginationParameters {
-    /**
-     * Page number to retrieve (starting from 1).
-     */
-    readonly page?: number;
-    /**
-     * Maximum number of items per page.
-     */
-    readonly limit?: number;
+export interface PaginationParameters extends Partial<Pageable> {
     /**
      * Optional cursor string for cursor-based pagination.
      */

package/dist/auth/types.d.ts

@@ -1,32 +1,15 @@
+import type { WithUuid, WithExpiration, WithAuthTokens } from '../common/types';
 /**
  * Represents a simplified user model.
  * @description Typically used for identification purposes within auth or session logic.
  */
-export interface User {
-    /**
-     * Universally unique identifier (UUID) for the user.
-     * @example "f47ac10b-58cc-4372-a567-0e02b2c3d479"
-     */
-    readonly uuid: string;
+export interface User extends WithUuid {
 }
 /**
  * AuthToken Interface.
  * @description Represents an authentication token set returned after a successful login or refresh.
  */
-export interface AuthToken {
-    /**
-     * JWT or opaque access token used for authenticating API requests.
-     */
-    readonly accessToken: string;
-    /**
-     * Token used to obtain a new access token when the current one expires.
-     */
-    readonly refreshToken: string;
-    /**
-     * ISO timestamp indicating when the access token will expire.
-     * @example "2025-06-15T12:00:00Z"
-     */
-    readonly expiresAt: string;
+export interface AuthToken extends WithExpiration, WithAuthTokens {
     /**
      * Token type, typically "Bearer" for OAuth2-style tokens.
      */