@plyaz/types 1.12.4 → 1.13.1

package/dist/api/endpoints/infobip/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './types';
+export type * from './endpoints';

package/dist/api/endpoints/infobip/types.d.ts

@@ -0,0 +1,265 @@
+/**
+ * Infobip Email API Type Definitions
+ *
+ * Focused on essential email operations:
+ * - Send single email (with attachment support)
+ * - Email validation
+ * - Email bulk operations
+ *
+ * All types are generated from official Infobip OpenAPI specifications.
+ */
+import type { HTTP_STATUS } from '@plyaz/config';
+import type { operations as EmailOperations, components as EmailComponents } from './generated/email.generated';
+/**
+ * Standard Infobip API error response structure
+ */
+export type InfobipErrorResponse = EmailComponents['schemas']['ApiError'];
+/**
+ * Error resource reference in error response
+ */
+export type InfobipErrorResource = EmailComponents['schemas']['ApiErrorResource'];
+/**
+ * Validation violation details in error response
+ */
+export type InfobipViolation = EmailComponents['schemas']['ApiErrorViolation'];
+/**
+ * Send email request - supports both simple text and HTML emails with attachments
+ * POST /email/3/send
+ */
+export type InfobipSendEmailRequest = NonNullable<EmailOperations['send-fully-featured-email']['requestBody']>['content']['multipart/form-data'];
+/**
+ * Send email response with message IDs and status
+ */
+export type InfobipSendEmailResponse = EmailOperations['send-fully-featured-email']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Send email error responses
+ */
+export type InfobipSendEmailError400 = EmailOperations['send-fully-featured-email']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipSendEmailError401 = EmailOperations['send-fully-featured-email']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipSendEmailError403 = EmailOperations['send-fully-featured-email']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipSendEmailError500 = EmailOperations['send-fully-featured-email']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Send advanced email request - supports full email customization
+ * POST /email/4/send
+ */
+export type InfobipSendAdvancedEmailRequest = NonNullable<EmailOperations['send-email-messages-api']['requestBody']>['content']['application/json'];
+/**
+ * Send advanced email response
+ */
+export type InfobipSendAdvancedEmailResponse = EmailOperations['send-email-messages-api']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Send advanced email error responses
+ */
+export type InfobipSendAdvancedEmailError400 = EmailOperations['send-email-messages-api']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipSendAdvancedEmailError401 = EmailOperations['send-email-messages-api']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipSendAdvancedEmailError403 = EmailOperations['send-email-messages-api']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipSendAdvancedEmailError500 = EmailOperations['send-email-messages-api']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Send email via MIME format
+ * POST /email/3/mime
+ */
+export type InfobipSendEmailMimeRequest = EmailOperations['send-mime-email']['requestBody'];
+/**
+ * Send MIME email response
+ */
+export type InfobipSendEmailMimeResponse = EmailOperations['send-mime-email']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Send MIME email error responses
+ */
+export type InfobipSendEmailMimeError400 = EmailOperations['send-mime-email']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipSendEmailMimeError401 = EmailOperations['send-mime-email']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipSendEmailMimeError403 = EmailOperations['send-mime-email']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipSendEmailMimeError500 = EmailOperations['send-mime-email']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Validate single email address
+ * POST /email/2/validation
+ */
+export type InfobipValidateEmailRequest = NonNullable<EmailOperations['validate-email-addresses']['requestBody']>['content']['application/json'];
+/**
+ * Email validation response with validity status
+ */
+export type InfobipValidateEmailResponse = EmailOperations['validate-email-addresses']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Validate email error responses
+ */
+export type InfobipValidateEmailError400 = EmailOperations['validate-email-addresses']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipValidateEmailError401 = EmailOperations['validate-email-addresses']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipValidateEmailError403 = EmailOperations['validate-email-addresses']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipValidateEmailError500 = EmailOperations['validate-email-addresses']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Request bulk email validation
+ * POST /email/2/validations
+ *
+ * Submit multiple email addresses for validation
+ */
+export type InfobipBulkValidateEmailsRequest = NonNullable<EmailOperations['request-validations']['requestBody']>['content']['application/json'];
+/**
+ * Bulk validation request accepted response
+ * Returns 202 with validation request ID
+ */
+export type InfobipBulkValidateEmailsResponse = EmailOperations['request-validations']['responses'][typeof HTTP_STATUS.ACCEPTED]['content']['application/json'];
+/**
+ * Bulk validate emails error responses
+ */
+export type InfobipBulkValidateEmailsError400 = EmailOperations['request-validations']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipBulkValidateEmailsError401 = EmailOperations['request-validations']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipBulkValidateEmailsError403 = EmailOperations['request-validations']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipBulkValidateEmailsError429 = EmailOperations['request-validations']['responses'][typeof HTTP_STATUS.TOO_MANY_REQUESTS];
+export type InfobipBulkValidateEmailsError500 = EmailOperations['request-validations']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Query parameters for fetching validation results
+ */
+export type InfobipGetValidationsParams = EmailOperations['get-validations']['parameters']['query'];
+/**
+ * Get bulk validation results
+ * Retrieve results of bulk email validation requests
+ */
+export type InfobipGetValidationsResponse = EmailOperations['get-validations']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Get validations error responses
+ */
+export type InfobipGetValidationsError401 = EmailOperations['get-validations']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipGetValidationsError403 = EmailOperations['get-validations']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipGetValidationsError429 = EmailOperations['get-validations']['responses'][typeof HTTP_STATUS.TOO_MANY_REQUESTS];
+export type InfobipGetValidationsError500 = EmailOperations['get-validations']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Query parameters for fetching email delivery reports
+ */
+export type InfobipGetEmailReportsParams = EmailOperations['get-email-delivery-reports']['parameters']['query'];
+/**
+ * Email delivery reports response
+ */
+export type InfobipGetEmailReportsResponse = EmailOperations['get-email-delivery-reports']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Get email reports error responses
+ */
+export type InfobipGetEmailReportsError400 = EmailOperations['get-email-delivery-reports']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipGetEmailReportsError401 = EmailOperations['get-email-delivery-reports']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipGetEmailReportsError403 = EmailOperations['get-email-delivery-reports']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipGetEmailReportsError500 = EmailOperations['get-email-delivery-reports']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Query parameters for fetching email logs
+ */
+export type InfobipGetEmailLogsParams = EmailOperations['get-email-logs']['parameters']['query'];
+/**
+ * Email logs response
+ */
+export type InfobipGetEmailLogsResponse = EmailOperations['get-email-logs']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Get email logs error responses
+ */
+export type InfobipGetEmailLogsError401 = EmailOperations['get-email-logs']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipGetEmailLogsError403 = EmailOperations['get-email-logs']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipGetEmailLogsError429 = EmailOperations['get-email-logs']['responses'][typeof HTTP_STATUS.TOO_MANY_REQUESTS];
+export type InfobipGetEmailLogsError500 = EmailOperations['get-email-logs']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Query parameters for fetching scheduled email bulks
+ */
+export type InfobipGetScheduledEmailsParams = EmailOperations['get-scheduled-emails']['parameters']['query'];
+/**
+ * Scheduled emails response
+ */
+export type InfobipGetScheduledEmailsResponse = EmailOperations['get-scheduled-emails']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Get scheduled emails error responses
+ */
+export type InfobipGetScheduledEmailsError401 = EmailOperations['get-scheduled-emails']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipGetScheduledEmailsError403 = EmailOperations['get-scheduled-emails']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipGetScheduledEmailsError500 = EmailOperations['get-scheduled-emails']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Query parameters for fetching scheduled email status
+ */
+export type InfobipGetScheduledEmailStatusesParams = EmailOperations['get-scheduled-email-statuses']['parameters']['query'];
+/**
+ * Scheduled email status response
+ */
+export type InfobipGetScheduledEmailStatusesResponse = EmailOperations['get-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Get scheduled email status error responses
+ */
+export type InfobipGetScheduledEmailStatusesError401 = EmailOperations['get-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipGetScheduledEmailStatusesError403 = EmailOperations['get-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipGetScheduledEmailStatusesError500 = EmailOperations['get-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Path and query parameters for rescheduling emails
+ */
+export type InfobipRescheduleEmailsParams = EmailOperations['reschedule-emails']['parameters']['query'];
+/**
+ * Reschedule emails request body
+ */
+export type InfobipRescheduleEmailsRequest = NonNullable<EmailOperations['reschedule-emails']['requestBody']>['content']['application/json'];
+/**
+ * Reschedule emails response
+ */
+export type InfobipRescheduleEmailsResponse = EmailOperations['reschedule-emails']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Reschedule emails error responses
+ */
+export type InfobipRescheduleEmailsError400 = EmailOperations['reschedule-emails']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipRescheduleEmailsError401 = EmailOperations['reschedule-emails']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipRescheduleEmailsError403 = EmailOperations['reschedule-emails']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipRescheduleEmailsError500 = EmailOperations['reschedule-emails']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Query parameters for updating scheduled email status
+ */
+export type InfobipUpdateScheduledEmailStatusesParams = EmailOperations['update-scheduled-email-statuses']['parameters']['query'];
+/**
+ * Update scheduled email status request
+ */
+export type InfobipUpdateScheduledEmailStatusesRequest = NonNullable<EmailOperations['update-scheduled-email-statuses']['requestBody']>['content']['application/json'];
+/**
+ * Update scheduled email status response
+ */
+export type InfobipUpdateScheduledEmailStatusesResponse = EmailOperations['update-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.OK]['content']['application/json'];
+/**
+ * Update scheduled email status error responses
+ */
+export type InfobipUpdateScheduledEmailStatusesError400 = EmailOperations['update-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.BAD_REQUEST]['content']['application/json'];
+export type InfobipUpdateScheduledEmailStatusesError401 = EmailOperations['update-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.UNAUTHORIZED];
+export type InfobipUpdateScheduledEmailStatusesError403 = EmailOperations['update-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.FORBIDDEN];
+export type InfobipUpdateScheduledEmailStatusesError500 = EmailOperations['update-scheduled-email-statuses']['responses'][typeof HTTP_STATUS.INTERNAL_SERVER_ERROR];
+/**
+ * Email message status
+ */
+export type InfobipEmailStatus = EmailComponents['schemas']['34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageStatus'];
+/**
+ * Email attachment
+ */
+export type InfobipEmailAttachment = EmailComponents['schemas']['39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment'];
+/**
+ * Email delivery report
+ */
+export type InfobipEmailDeliveryReport = EmailComponents['schemas']['34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReport'];
+/**
+ * Email price information
+ */
+export type InfobipEmailPrice = EmailComponents['schemas']['34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessagePrice'];
+/**
+ * Bulk information for scheduled emails
+ */
+export type InfobipEmailBulkInfo = EmailComponents['schemas']['34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkInfo'];
+/**
+ * Bulk status for scheduled emails
+ */
+export type InfobipEmailBulkStatus = EmailComponents['schemas']['34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatus'];
+/**
+ * Email delivery report webhook payload
+ * Webhook: POST receive-email-delivery-reports
+ *
+ * Infobip sends this payload to your configured notifyUrl when an email delivery status changes.
+ */
+export type InfobipEmailDeliveryReportWebhook = NonNullable<EmailOperations['receive-email-delivery-reports']['requestBody']>['content']['application/json'];
+/**
+ * Email tracking events webhook payload
+ * Webhook: POST receive-email-tracking-reports
+ *
+ * Infobip sends tracking events (opened, clicked, complained, bounced, unsubscribed) to your configured endpoint.
+ */
+export type InfobipEmailTrackingReportWebhook = NonNullable<EmailOperations['receive-email-tracking-reports']['requestBody']>['content']['application/json'];
+/**
+ * Inbound email webhook payload
+ * Webhook: POST receive-inbound-email
+ *
+ * Infobip sends parsed inbound emails to your configured endpoint when emails are received on your domain.
+ */
+export type InfobipInboundEmailWebhook = NonNullable<EmailOperations['receive-inbound-email']['requestBody']>['content']['multipart/form-data'];

package/dist/api/endpoints/types.d.ts

@@ -1,5 +1,6 @@
 import type { CampaignEndpointTypes } from './campaigns';
 import type { PollingEndpointTypes } from './health';
+import type { InfobipEndpointTypes } from './infobip';
 /**
  * Query parameters type - matches fetchff's flexible param handling
  * Supports objects, URLSearchParams, and arrays of name-value pairs
@@ -8,5 +9,5 @@ export type QueryParams = Record<string, string | number | boolean | string[] |
 /**
  * All endpoint types combined
  */
-export interface EndpointTypes extends CampaignEndpointTypes, PollingEndpointTypes {
+export interface EndpointTypes extends CampaignEndpointTypes, PollingEndpointTypes, InfobipEndpointTypes {
 }

package/dist/api/errors/types.d.ts

@@ -3,7 +3,8 @@
  * Following the Confluence architecture specifications
  */
 /**
- * Import ResponseError and RequestConfig types from fetchff
+ * Import and re-export ResponseError and RequestConfig types from fetchff
+ * These are 3rd party types that @plyaz/api wraps
  */
 import type { ResponseError, RequestConfig } from 'fetchff';
 import type { ERROR_CATEGORY, ErrorDetail, ErrorResponse } from '../../errors';

package/dist/api/hooks/types.d.ts

@@ -1,5 +1,85 @@
-import type { NETWORK_QUALITY, NetworkInfo } from '..';
+/**
+ * Hook Types and Options
+ * TypeScript types for React Query hooks with API configuration support
+ */
+import type { UseQueryOptions, UseMutationOptions, QueryKey, UseQueryResult, UseMutationResult } from '@tanstack/react-query';
+import type { ApiConfig } from '../config';
+import type { ApiClientWithEvents } from '../client';
+import type { NETWORK_QUALITY, NetworkInfo } from '../network';
 import type { ConfigConflict, DebugInfo, MonitoringAlert } from '../debugger';
+/**
+ * Options for query hooks (GET requests)
+ * Extends React Query's UseQueryOptions with API-specific options
+ *
+ * @template TData - The type of data returned by the query
+ * @template TError - The type of error that can be thrown (defaults to Error)
+ *
+ * @example
+ * ```typescript
+ * const queryOptions: ApiQueryOptions<Campaign> = {
+ *   staleTime: 5 * 60 * 1000,
+ *   apiConfig: { timeout: 10000 },
+ *   enabled: !!campaignId,
+ * };
+ * ```
+ */
+export interface ApiQueryOptions<TData, TError = Error, ClientEventManager = unknown, OverrideEndpointsList = unknown> extends Omit<UseQueryOptions<TData, TError>, 'queryKey' | 'queryFn'> {
+    /**
+     * Optional API client instance to use for this query
+     * Overrides the default client instance
+     */
+    apiClient?: ApiClientWithEvents<ClientEventManager, OverrideEndpointsList>;
+    /**
+     * Optional API configuration for this specific query
+     * Applied temporarily using updateConfig({ strategy: 'temporary' })
+     */
+    apiConfig?: Partial<ApiConfig>;
+}
+/**
+ * Options for mutation hooks (POST, PUT, PATCH, DELETE)
+ * Extends React Query's UseMutationOptions with API-specific options
+ *
+ * @template TData - The type of data returned by the mutation
+ * @template TVariables - The type of variables passed to the mutation
+ * @template TError - The type of error that can be thrown (defaults to Error)
+ *
+ * @example
+ * ```typescript
+ * const mutationOptions: ApiMutationOptions<Campaign, CreateCampaignDto> = {
+ *   apiConfig: { timeout: 30000 },
+ *   onSuccess: (data) => {
+ *     console.log('Campaign created:', data.id);
+ *   },
+ * };
+ * ```
+ */
+export interface ApiMutationOptions<TData, TVariables, TError = Error, ClientEventManager = unknown, OverrideEndpointsList = unknown> extends Omit<UseMutationOptions<TData, TError, TVariables>, 'mutationFn'> {
+    /**
+     * Optional API client instance to use for this mutation
+     * Overrides the default client instance
+     */
+    apiClient?: ApiClientWithEvents<ClientEventManager, OverrideEndpointsList>;
+    /**
+     * Optional API configuration for this specific mutation
+     * Applied temporarily using updateConfig({ strategy: 'temporary' })
+     */
+    apiConfig?: Partial<ApiConfig>;
+}
+/**
+ * Return type for query hooks
+ * Re-export from React Query for convenience
+ */
+export type { UseQueryResult };
+/**
+ * Return type for mutation hooks
+ * Re-export from React Query for convenience
+ */
+export type { UseMutationResult };
+/**
+ * Query key type
+ * Re-export from React Query for convenience
+ */
+export type { QueryKey };
 /**
  * Hook options for conflict monitoring
  */
@@ -12,7 +92,7 @@ export interface UseApiConfigConflictsOptions {
     onConflict?: (conflict: ConfigConflict) => void;
 }
 /**
- * Hook return value
+ * Hook return value for conflict monitoring
  */
 export interface UseApiConfigConflictsReturn {
     /** Current conflicts */
@@ -42,7 +122,7 @@ export interface UseApiDebugInfoOptions {
     onUpdate?: (debugInfo: DebugInfo) => void;
 }
 /**
- * Hook return value
+ * Hook return value for debug info monitoring
  */
 export interface UseApiDebugInfoReturn {
     /** Current debug information */
@@ -76,7 +156,7 @@ export interface UseApiMonitorOptions {
     onAlert?: (alert: MonitoringAlert) => void;
 }
 /**
- * Hook return value
+ * Hook return value for complete monitoring
  */
 export interface UseApiMonitorReturn {
     /** Current conflicts */
@@ -109,7 +189,7 @@ export interface UseApiMonitorReturn {
     lastDebugUpdate: Date | null;
 }
 /**
- * Hook return value
+ * Hook return value for network quality monitoring
  */
 export interface UseApiNetworkQualityReturn {
     /** Current network quality */

package/dist/api/index.cjs

@@ -158,7 +158,7 @@ var ALL_EVENTS = {
   ...CACHE_EVENTS
 };
 
-// node_modules/.pnpm/@plyaz+config@1.6.5_@darraghor+eslint-plugin-nestjs-typed@6.9.3_@typescript-eslint+eslint-plu_glxbouqjdzbo5neiwqf2pt5xdy/node_modules/@plyaz/config/dist/index.mjs
+// node_modules/.pnpm/@plyaz+config@1.6.5_@darraghor+eslint-plugin-nestjs-typed@6.9.3_@types+react@19.2.2_@typescri_x2zut4rwivkuvldn552zktqyt4/node_modules/@plyaz/config/dist/index.mjs
 globalThis.process.env.NODE_ENV === "development";
 globalThis.process.env.NODE_ENV === "production";
 globalThis.process.env.NODE_ENV === "test";