@plyaz/types 1.7.18 → 1.7.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/dist/api/client/enum.d.ts +12 -0
  2. package/dist/api/client/index.d.ts +1 -0
  3. package/dist/api/client/types.d.ts +114 -0
  4. package/dist/api/config/types.d.ts +56 -9
  5. package/dist/api/debugger/enums.d.ts +153 -0
  6. package/dist/api/debugger/factories/index.d.ts +1 -0
  7. package/dist/api/debugger/factories/types.d.ts +191 -0
  8. package/dist/api/debugger/index.d.ts +2 -0
  9. package/dist/api/debugger/types.d.ts +628 -0
  10. package/dist/api/endpoints/campaigns/index.d.ts +1 -0
  11. package/dist/api/endpoints/campaigns/types.d.ts +68 -0
  12. package/dist/api/endpoints/health/index.d.ts +1 -0
  13. package/dist/api/endpoints/health/types.d.ts +127 -0
  14. package/dist/api/endpoints/index.d.ts +3 -0
  15. package/dist/api/endpoints/types.d.ts +5 -0
  16. package/dist/api/errors/enum.d.ts +182 -0
  17. package/dist/api/errors/index.d.ts +1 -0
  18. package/dist/api/errors/types.d.ts +126 -27
  19. package/dist/api/events/enum.d.ts +262 -0
  20. package/dist/api/events/factories/cache/index.d.ts +1 -0
  21. package/dist/api/events/factories/cache/types.d.ts +60 -0
  22. package/dist/api/events/factories/client/index.d.ts +1 -0
  23. package/dist/api/events/factories/client/types.d.ts +120 -0
  24. package/dist/api/events/factories/config/index.d.ts +1 -0
  25. package/dist/api/events/factories/config/types.d.ts +77 -0
  26. package/dist/api/events/factories/debug/index.d.ts +1 -0
  27. package/dist/api/events/factories/debug/types.d.ts +131 -0
  28. package/dist/api/events/factories/errors/index.d.ts +1 -0
  29. package/dist/api/events/factories/errors/types.d.ts +293 -0
  30. package/dist/api/events/factories/headers/index.d.ts +1 -0
  31. package/dist/api/events/factories/headers/types.d.ts +256 -0
  32. package/dist/api/events/factories/index.d.ts +9 -0
  33. package/dist/api/events/factories/network/index.d.ts +1 -0
  34. package/dist/api/events/factories/network/types.d.ts +196 -0
  35. package/dist/api/events/factories/performance/index.d.ts +1 -0
  36. package/dist/api/events/factories/performance/types.d.ts +150 -0
  37. package/dist/api/events/factories/types.d.ts +84 -0
  38. package/dist/api/events/index.d.ts +2 -0
  39. package/dist/api/events/types.d.ts +1 -730
  40. package/dist/api/headers/enum.d.ts +34 -0
  41. package/dist/api/headers/index.d.ts +1 -0
  42. package/dist/api/headers/types.d.ts +456 -0
  43. package/dist/api/hooks/index.d.ts +1 -0
  44. package/dist/api/hooks/types.d.ts +131 -0
  45. package/dist/api/index.d.ts +7 -1
  46. package/dist/api/network/enums.d.ts +75 -5
  47. package/dist/api/network/frameworks/index.d.ts +2 -0
  48. package/dist/api/network/frameworks/nestjs/index.d.ts +1 -0
  49. package/dist/api/network/frameworks/nestjs/types.d.ts +47 -0
  50. package/dist/api/network/frameworks/types.d.ts +76 -0
  51. package/dist/api/network/index.d.ts +1 -0
  52. package/dist/api/network/types.d.ts +346 -39
  53. package/dist/api/performance/types.d.ts +17 -10
  54. package/dist/api/polling/types.d.ts +6 -4
  55. package/dist/api/pubsub/enum.d.ts +12 -0
  56. package/dist/api/pubsub/index.d.ts +2 -0
  57. package/dist/api/pubsub/types.d.ts +61 -0
  58. package/dist/api/queue/types.d.ts +69 -0
  59. package/dist/api/regional/enum.d.ts +75 -0
  60. package/dist/api/regional/index.d.ts +1 -0
  61. package/dist/api/regional/types.d.ts +2 -1
  62. package/dist/api/request/index.d.ts +1 -0
  63. package/dist/api/request/types.d.ts +44 -0
  64. package/dist/api/retry/types.d.ts +31 -0
  65. package/dist/api/strategies/types.d.ts +12 -8
  66. package/dist/errors/index.cjs +69 -0
  67. package/dist/errors/index.cjs.map +1 -1
  68. package/dist/errors/index.d.ts +1 -1
  69. package/dist/errors/index.js +66 -0
  70. package/dist/errors/index.js.map +1 -1
  71. package/dist/features/cache/types.d.ts +5 -0
  72. package/dist/testing/features/api/types.d.ts +355 -4
  73. package/package.json +5 -3
@@ -0,0 +1,293 @@
1
+ /**
2
+ * Error Event Factory
3
+ * Creates and emits error-related events with type safety
4
+ */
5
+ import { type BaseEvent, type EventOptions } from '..';
6
+ import type { ApiPackageErrorLike } from '../../../errors';
7
+ import type { ERROR_CATEGORY } from '../../../../errors';
8
+ import type { ERROR_EVENTS } from '../..';
9
+ /**
10
+ * Base structure for error events
11
+ */
12
+ export interface ErrorEvent extends BaseEvent {
13
+ type: string;
14
+ data: unknown;
15
+ }
16
+ /**
17
+ * Generic error event
18
+ */
19
+ export interface GenericErrorEvent extends BaseEvent {
20
+ type: typeof ERROR_EVENTS.GENERIC_ERROR;
21
+ data: {
22
+ error: ApiPackageErrorLike;
23
+ category: typeof ERROR_CATEGORY | string;
24
+ code: string;
25
+ message: string;
26
+ context?: Record<string, unknown>;
27
+ };
28
+ }
29
+ /**
30
+ * Network error event
31
+ */
32
+ export interface NetworkErrorEvent extends BaseEvent {
33
+ type: typeof ERROR_EVENTS.NETWORK_ERROR;
34
+ data: {
35
+ error: ApiPackageErrorLike;
36
+ code: string;
37
+ message: string;
38
+ url?: string;
39
+ method?: string;
40
+ status?: number;
41
+ retryable?: boolean;
42
+ };
43
+ }
44
+ /**
45
+ * Validation error event
46
+ */
47
+ export interface ValidationErrorEvent extends BaseEvent {
48
+ type: typeof ERROR_EVENTS.VALIDATION_ERROR;
49
+ data: {
50
+ error: ApiPackageErrorLike;
51
+ code: string;
52
+ message: string;
53
+ field?: string;
54
+ value?: unknown;
55
+ constraints?: Record<string, string>;
56
+ };
57
+ }
58
+ /**
59
+ * Authentication error event
60
+ */
61
+ export interface AuthenticationErrorEvent extends BaseEvent {
62
+ type: typeof ERROR_EVENTS.AUTHENTICATION_ERROR;
63
+ data: {
64
+ error: ApiPackageErrorLike;
65
+ code: string;
66
+ message: string;
67
+ realm?: string;
68
+ scheme?: string;
69
+ };
70
+ }
71
+ /**
72
+ * Rate limit error event
73
+ */
74
+ export interface RateLimitErrorEvent extends BaseEvent {
75
+ type: typeof ERROR_EVENTS.RATE_LIMIT_ERROR;
76
+ data: {
77
+ error: ApiPackageErrorLike;
78
+ code: string;
79
+ message: string;
80
+ limit?: number;
81
+ remaining?: number;
82
+ resetAt?: string;
83
+ retryAfter?: number;
84
+ };
85
+ }
86
+ /**
87
+ * Server error event
88
+ */
89
+ export interface ServerErrorEvent extends BaseEvent {
90
+ type: typeof ERROR_EVENTS.SERVER_ERROR;
91
+ data: {
92
+ error: ApiPackageErrorLike;
93
+ code: string;
94
+ message: string;
95
+ status: number;
96
+ serverMessage?: string;
97
+ traceId?: string;
98
+ };
99
+ }
100
+ /**
101
+ * Timeout error event
102
+ */
103
+ export interface TimeoutErrorEvent extends BaseEvent {
104
+ type: typeof ERROR_EVENTS.TIMEOUT_ERROR;
105
+ data: {
106
+ error: ApiPackageErrorLike;
107
+ code: string;
108
+ message: string;
109
+ timeoutMs: number;
110
+ operation?: string;
111
+ url?: string;
112
+ };
113
+ }
114
+ /**
115
+ * Authorization error event
116
+ */
117
+ export interface AuthorizationErrorEvent extends BaseEvent {
118
+ type: typeof ERROR_EVENTS.AUTHORIZATION_ERROR;
119
+ data: {
120
+ error: ApiPackageErrorLike;
121
+ code: string;
122
+ message: string;
123
+ url?: string;
124
+ method?: string;
125
+ resource?: string;
126
+ permission?: string;
127
+ };
128
+ }
129
+ /**
130
+ * Not found error event
131
+ */
132
+ export interface NotFoundErrorEvent extends BaseEvent {
133
+ type: typeof ERROR_EVENTS.NOT_FOUND_ERROR;
134
+ data: {
135
+ error: ApiPackageErrorLike;
136
+ code: string;
137
+ message: string;
138
+ url?: string;
139
+ resource?: string;
140
+ };
141
+ }
142
+ /**
143
+ * Conflict error event
144
+ */
145
+ export interface ConflictErrorEvent extends BaseEvent {
146
+ type: typeof ERROR_EVENTS.CONFLICT_ERROR;
147
+ data: {
148
+ error: ApiPackageErrorLike;
149
+ code: string;
150
+ message: string;
151
+ conflictingResource?: string;
152
+ currentValue?: unknown;
153
+ attemptedValue?: unknown;
154
+ };
155
+ }
156
+ /**
157
+ * Client error event
158
+ */
159
+ export interface ClientErrorEvent extends BaseEvent {
160
+ type: typeof ERROR_EVENTS.CLIENT_ERROR;
161
+ data: {
162
+ error: ApiPackageErrorLike;
163
+ code: string;
164
+ message: string;
165
+ status: number;
166
+ url?: string;
167
+ method?: string;
168
+ };
169
+ }
170
+ /**
171
+ * External service error event
172
+ */
173
+ export interface ExternalServiceErrorEvent extends BaseEvent {
174
+ type: typeof ERROR_EVENTS.EXTERNAL_SERVICE_ERROR;
175
+ data: {
176
+ error: ApiPackageErrorLike;
177
+ code: string;
178
+ message: string;
179
+ service?: string;
180
+ endpoint?: string;
181
+ timeout?: number;
182
+ };
183
+ }
184
+ /**
185
+ * Cache error event
186
+ */
187
+ export interface CacheErrorEvent extends BaseEvent {
188
+ type: typeof ERROR_EVENTS.CACHE_ERROR;
189
+ data: {
190
+ error: ApiPackageErrorLike;
191
+ code: string;
192
+ message: string;
193
+ operation?: string;
194
+ key?: string;
195
+ };
196
+ }
197
+ /**
198
+ * Headers error event
199
+ */
200
+ export interface HeadersErrorEvent extends BaseEvent {
201
+ type: typeof ERROR_EVENTS.HEADERS_ERROR;
202
+ data: {
203
+ error: ApiPackageErrorLike;
204
+ code: string;
205
+ message: string;
206
+ header?: string;
207
+ operation?: string;
208
+ };
209
+ }
210
+ /**
211
+ * Retry error event
212
+ */
213
+ export interface RetryErrorEvent extends BaseEvent {
214
+ type: typeof ERROR_EVENTS.RETRY_ERROR;
215
+ data: {
216
+ error: ApiPackageErrorLike;
217
+ code: string;
218
+ message: string;
219
+ attempts?: number;
220
+ maxAttempts?: number;
221
+ lastError?: unknown;
222
+ };
223
+ }
224
+ /**
225
+ * Options for emit methods
226
+ */
227
+ export interface EmitNetworkErrorOptions extends EventOptions {
228
+ error: ApiPackageErrorLike;
229
+ url?: string;
230
+ method?: string;
231
+ status?: number;
232
+ retryable?: boolean;
233
+ }
234
+ export interface EmitValidationErrorOptions extends EventOptions {
235
+ error: ApiPackageErrorLike;
236
+ field?: string;
237
+ value?: unknown;
238
+ constraints?: Record<string, string>;
239
+ }
240
+ export interface EmitRateLimitErrorOptions extends EventOptions {
241
+ error: ApiPackageErrorLike;
242
+ limit?: number;
243
+ remaining?: number;
244
+ resetAt?: string;
245
+ retryAfter?: number;
246
+ }
247
+ export interface EmitServerErrorOptions extends EventOptions {
248
+ error: ApiPackageErrorLike;
249
+ statusCode: number;
250
+ serverMessage?: string;
251
+ traceId?: string;
252
+ }
253
+ export interface EmitTimeoutErrorOptions extends EventOptions {
254
+ error: ApiPackageErrorLike;
255
+ timeout: number;
256
+ operation?: string;
257
+ url?: string;
258
+ }
259
+ export interface EmitAuthorizationErrorOptions extends EventOptions {
260
+ error: ApiPackageErrorLike;
261
+ url?: string;
262
+ method?: string;
263
+ resource?: string;
264
+ permission?: string;
265
+ }
266
+ export interface EmitConflictErrorOptions extends EventOptions {
267
+ error: ApiPackageErrorLike;
268
+ conflictingResource?: string;
269
+ currentValue?: unknown;
270
+ attemptedValue?: unknown;
271
+ }
272
+ export interface EmitClientErrorOptions extends EventOptions {
273
+ error: ApiPackageErrorLike;
274
+ status: number;
275
+ url?: string;
276
+ method?: string;
277
+ }
278
+ export interface EmitExternalServiceErrorOptions extends EventOptions {
279
+ error: ApiPackageErrorLike;
280
+ service?: string;
281
+ endpoint?: string;
282
+ timeout?: number;
283
+ }
284
+ export interface EmitRetryErrorOptions extends EventOptions {
285
+ error: ApiPackageErrorLike;
286
+ attempts?: number;
287
+ maxAttempts?: number;
288
+ lastError?: unknown;
289
+ }
290
+ /**
291
+ * Union type for all error event types
292
+ */
293
+ export type ErrorEventData = GenericErrorEvent | NetworkErrorEvent | ValidationErrorEvent | AuthenticationErrorEvent | RateLimitErrorEvent | ServerErrorEvent | TimeoutErrorEvent;
@@ -0,0 +1 @@
1
+ export type * from './types';
@@ -0,0 +1,256 @@
1
+ /**
2
+ * Header Event Factory
3
+ * Creates and emits header-related events with type safety
4
+ */
5
+ import { type BaseEvent, type EventOptions } from '..';
6
+ import type { ApiHeaders } from '../../../headers';
7
+ import type { DebuggerConfigSource, HEADER_EVENTS } from '../../..';
8
+ /**
9
+ * Base structure for header events
10
+ */
11
+ export interface HeaderEvent extends BaseEvent {
12
+ type: string;
13
+ data: Record<string, unknown>;
14
+ }
15
+ /**
16
+ * Headers changed event
17
+ */
18
+ export interface HeadersChangedEvent extends HeaderEvent {
19
+ type: typeof HEADER_EVENTS.CHANGED;
20
+ data: {
21
+ previous: ApiHeaders;
22
+ current: ApiHeaders;
23
+ changes: {
24
+ added: ApiHeaders;
25
+ modified: ApiHeaders;
26
+ removed: string[];
27
+ };
28
+ source: DebuggerConfigSource;
29
+ reason?: string;
30
+ };
31
+ }
32
+ /**
33
+ * Headers enriched event
34
+ */
35
+ export interface HeadersEnrichedEvent extends HeaderEvent {
36
+ type: typeof HEADER_EVENTS.ENRICHED;
37
+ data: {
38
+ original: ApiHeaders;
39
+ enriched: ApiHeaders;
40
+ addedHeaders: string[];
41
+ source: 'client-hints' | 'device-detection' | 'user-agent' | 'custom';
42
+ metadata?: {
43
+ deviceType?: string;
44
+ browserName?: string;
45
+ osName?: string;
46
+ [key: string]: unknown;
47
+ };
48
+ };
49
+ }
50
+ /**
51
+ * Headers conflict event
52
+ */
53
+ export interface HeadersConflictEvent extends HeaderEvent {
54
+ type: typeof HEADER_EVENTS.CONFLICT;
55
+ data: {
56
+ header: string;
57
+ conflicts: Array<{
58
+ source: DebuggerConfigSource;
59
+ value: string;
60
+ priority: number;
61
+ }>;
62
+ resolution: {
63
+ source: DebuggerConfigSource;
64
+ value: string;
65
+ reason: string;
66
+ };
67
+ strategy: 'override' | 'merge' | 'preserve';
68
+ };
69
+ }
70
+ /**
71
+ * Headers override event
72
+ */
73
+ export interface HeadersOverrideEvent extends HeaderEvent {
74
+ type: typeof HEADER_EVENTS.OVERRIDE;
75
+ data: {
76
+ header: string;
77
+ previousValue: string | undefined;
78
+ newValue: string;
79
+ source: DebuggerConfigSource;
80
+ reason: string;
81
+ temporary?: boolean;
82
+ };
83
+ }
84
+ /**
85
+ * Headers merged event
86
+ */
87
+ export interface HeadersMergedEvent extends HeaderEvent {
88
+ type: typeof HEADER_EVENTS.MERGED;
89
+ data: {
90
+ sources: ApiHeaders[];
91
+ result: ApiHeaders;
92
+ strategy: 'shallow' | 'deep' | 'concat';
93
+ conflictsResolved: number;
94
+ };
95
+ }
96
+ /**
97
+ * Headers filtered event
98
+ */
99
+ export interface HeadersFilteredEvent extends HeaderEvent {
100
+ type: typeof HEADER_EVENTS.FILTERED;
101
+ data: {
102
+ original: ApiHeaders;
103
+ filtered: ApiHeaders;
104
+ removedHeaders: string[];
105
+ reason: string;
106
+ source?: DebuggerConfigSource;
107
+ };
108
+ }
109
+ /**
110
+ * Headers validated event
111
+ */
112
+ export interface HeadersValidatedEvent extends HeaderEvent {
113
+ type: typeof HEADER_EVENTS.VALIDATED;
114
+ data: {
115
+ headers: ApiHeaders;
116
+ valid: boolean;
117
+ errors?: Array<{
118
+ header: string;
119
+ reason: string;
120
+ }>;
121
+ warnings?: Array<{
122
+ header: string;
123
+ message: string;
124
+ }>;
125
+ };
126
+ }
127
+ /**
128
+ * Headers cached event
129
+ */
130
+ export interface HeadersCachedEvent extends HeaderEvent {
131
+ type: typeof HEADER_EVENTS.CACHED;
132
+ data: {
133
+ key: string;
134
+ headers: ApiHeaders;
135
+ ttl?: number;
136
+ strategy?: 'memory' | 'session' | 'persistent';
137
+ };
138
+ }
139
+ /**
140
+ * Headers cache hit event
141
+ */
142
+ export interface HeadersCacheHitEvent extends HeaderEvent {
143
+ type: typeof HEADER_EVENTS.CACHE_HIT;
144
+ data: {
145
+ key: string;
146
+ headers: ApiHeaders;
147
+ ttl?: number;
148
+ strategy?: 'memory' | 'session' | 'persistent';
149
+ };
150
+ }
151
+ /**
152
+ * Headers cache miss event
153
+ */
154
+ export interface HeadersCacheMissEvent extends HeaderEvent {
155
+ type: typeof HEADER_EVENTS.CACHE_MISS;
156
+ data: {
157
+ key: string;
158
+ headers?: ApiHeaders;
159
+ ttl?: number;
160
+ strategy?: 'memory' | 'session' | 'persistent';
161
+ };
162
+ }
163
+ /**
164
+ * Options for emitChanged method
165
+ */
166
+ export interface EmitChangedOptions extends EventOptions {
167
+ previous: ApiHeaders;
168
+ current: ApiHeaders;
169
+ source: DebuggerConfigSource;
170
+ reason?: string;
171
+ }
172
+ /**
173
+ * Options for emitEnriched method
174
+ */
175
+ export interface EmitEnrichedOptions extends EventOptions {
176
+ original: ApiHeaders;
177
+ enriched: ApiHeaders;
178
+ source: 'client-hints' | 'device-detection' | 'user-agent' | 'custom';
179
+ metadata?: Record<string, unknown>;
180
+ }
181
+ /**
182
+ * Options for emitConflict method
183
+ */
184
+ export interface EmitConflictOptions extends EventOptions {
185
+ header: string;
186
+ conflicts: Array<{
187
+ source: DebuggerConfigSource;
188
+ value: string;
189
+ priority: number;
190
+ }>;
191
+ resolution: {
192
+ source: DebuggerConfigSource;
193
+ value: string;
194
+ reason: string;
195
+ };
196
+ strategy?: 'override' | 'merge' | 'preserve';
197
+ }
198
+ /**
199
+ * Options for emitOverride method
200
+ */
201
+ export interface EmitOverrideOptions extends EventOptions {
202
+ header: string;
203
+ previousValue: string | undefined;
204
+ newValue: string;
205
+ source: DebuggerConfigSource;
206
+ reason: string;
207
+ temporary?: boolean;
208
+ }
209
+ /**
210
+ * Options for emitMerged method
211
+ */
212
+ export interface EmitMergedOptions extends EventOptions {
213
+ sources: ApiHeaders[];
214
+ result: ApiHeaders;
215
+ strategy?: 'shallow' | 'deep' | 'concat';
216
+ conflictsResolved?: number;
217
+ }
218
+ /**
219
+ * Options for emitFiltered method
220
+ */
221
+ export interface EmitFilteredOptions extends EventOptions {
222
+ original: ApiHeaders;
223
+ filtered: ApiHeaders;
224
+ reason: string;
225
+ source?: DebuggerConfigSource;
226
+ }
227
+ /**
228
+ * Options for emitCached method
229
+ */
230
+ export interface EmitCachedOptions extends EventOptions {
231
+ key: string;
232
+ headers: ApiHeaders;
233
+ ttl?: number;
234
+ strategy?: 'memory' | 'session' | 'persistent';
235
+ }
236
+ /**
237
+ * Union type for all header event types
238
+ */
239
+ export type HeaderEventType = HeadersChangedEvent | HeadersEnrichedEvent | HeadersConflictEvent | HeadersOverrideEvent | HeadersMergedEvent | HeadersFilteredEvent | HeadersValidatedEvent | HeadersCachedEvent | HeadersCacheHitEvent | HeadersCacheMissEvent;
240
+ /**
241
+ * Header event handlers interface
242
+ */
243
+ export interface HeaderEventHandlers {
244
+ onHeadersChanged?: (event: HeadersChangedEvent) => void;
245
+ onHeadersEnriched?: (event: HeadersEnrichedEvent) => void;
246
+ onHeadersConflict?: (event: HeadersConflictEvent) => void;
247
+ onHeadersOverride?: (event: HeadersOverrideEvent) => void;
248
+ onHeadersMerged?: (event: HeadersMergedEvent) => void;
249
+ onHeadersFiltered?: (event: HeadersFilteredEvent) => void;
250
+ onHeadersValidated?: (event: HeadersValidatedEvent) => void;
251
+ onHeadersCached?: (event: HeadersCachedEvent) => void;
252
+ onHeadersCacheHit?: (event: HeadersCacheHitEvent) => void;
253
+ onHeadersCacheMiss?: (event: HeadersCacheMissEvent) => void;
254
+ onAnyHeaderEvent?: (event: HeaderEventType) => void;
255
+ }
256
+ export type HeaderEventData = HeadersChangedEvent | HeadersEnrichedEvent | HeadersConflictEvent | HeadersOverrideEvent | HeadersMergedEvent | HeadersValidatedEvent | HeadersCachedEvent;
@@ -0,0 +1,9 @@
1
+ export type * from './cache';
2
+ export type * from './client';
3
+ export type * from './debug';
4
+ export type * from './config';
5
+ export type * from './errors';
6
+ export type * from './headers';
7
+ export type * from './network';
8
+ export type * from './performance';
9
+ export type * from './types';
@@ -0,0 +1 @@
1
+ export type * from './types';