@gscdump/contracts 1.4.2 → 1.4.4

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.
@@ -1,15 +1,15 @@
1
1
  import { z } from "zod";
2
2
  declare const GSCDUMP_REALTIME_PROTOCOL_VERSION: 1;
3
- declare const GSCDUMP_REALTIME_SUBPROTOCOL: 'gscdump.v1';
4
- declare const GSCDUMP_REALTIME_TICKET_PREFIX: 'gscdump.ticket.v1';
5
- declare const GSCDUMP_REALTIME_TICKET_ISSUER: 'https://gscdump.com';
6
- declare const GSCDUMP_REALTIME_TICKET_AUDIENCE: 'https://gscdump.com/ws/v1';
7
- declare const GSCDUMP_REALTIME_PING: 'ping';
8
- declare const GSCDUMP_REALTIME_PONG: 'pong';
3
+ declare const GSCDUMP_REALTIME_SUBPROTOCOL: "gscdump.v1";
4
+ declare const GSCDUMP_REALTIME_TICKET_PREFIX: "gscdump.ticket.v1";
5
+ declare const GSCDUMP_REALTIME_TICKET_ISSUER: "https://gscdump.com";
6
+ declare const GSCDUMP_REALTIME_TICKET_AUDIENCE: "https://gscdump.com/ws/v1";
7
+ declare const GSCDUMP_REALTIME_PING: "ping";
8
+ declare const GSCDUMP_REALTIME_PONG: "pong";
9
9
  declare const GSCDUMP_REALTIME_TICKET_TTL_SECONDS: 60;
10
10
  declare const GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS: 900;
11
11
  declare const GSCDUMP_REALTIME_TICKET_POLICY: {
12
- readonly algorithm: 'HMAC-SHA-256';
12
+ readonly algorithm: "HMAC-SHA-256";
13
13
  readonly minimumSigningKeyBytes: 32;
14
14
  readonly jtiRandomBits: 128;
15
15
  readonly maxVerificationKeys: 2;
@@ -27,7 +27,7 @@ declare const GSCDUMP_REALTIME_CONNECTION_POLICY: {
27
27
  readonly staleAfterMs: 75000;
28
28
  readonly reconnectBaseDelayMs: 1000;
29
29
  readonly reconnectMaxDelayMs: 30000;
30
- readonly reconnectJitter: 'equal';
30
+ readonly reconnectJitter: "equal";
31
31
  };
32
32
  declare const GSCDUMP_REALTIME_REPLAY_POLICY: {
33
33
  readonly maxAgeMs: 86400000;
@@ -59,43 +59,43 @@ declare const GSCDUMP_REALTIME_CLOSE_CODES: {
59
59
  readonly overloadedOrAckLag: 1013;
60
60
  readonly maximumLifetime: 4001;
61
61
  };
62
- declare const REALTIME_V1_RESOURCE_TYPES: readonly ['partner.user', 'partner.team', 'user.sites', 'site.registration', 'site.lifecycle', 'site.analytics', 'site.sitemaps', 'site.indexing', 'site.auth'];
63
- declare const REALTIME_V1_EVENT_NAMES: readonly ['user.lifecycle.changed', 'site.lifecycle.changed', 'site.lifecycle.progress', 'site.analytics.ready', 'site.sitemaps.ready', 'site.indexing.ready', 'site.auth.failed', 'site.lifecycle.failed', 'site.registration.changed'];
62
+ declare const REALTIME_V1_RESOURCE_TYPES: readonly ["partner.user", "partner.team", "user.sites", "site.registration", "site.lifecycle", "site.analytics", "site.sitemaps", "site.indexing", "site.auth"];
63
+ declare const REALTIME_V1_EVENT_NAMES: readonly ["user.lifecycle.changed", "site.lifecycle.changed", "site.lifecycle.progress", "site.analytics.ready", "site.sitemaps.ready", "site.indexing.ready", "site.auth.failed", "site.lifecycle.failed", "site.registration.changed"];
64
64
  declare const REALTIME_V1_EVENT_SEMANTICS: {
65
65
  readonly 'user.lifecycle.changed': {
66
- readonly delivery: 'durable';
66
+ readonly delivery: "durable";
67
67
  readonly baseChanges: readonly ["partner.user", "user.sites"];
68
68
  };
69
69
  readonly 'site.lifecycle.changed': {
70
- readonly delivery: 'durable';
70
+ readonly delivery: "durable";
71
71
  readonly baseChanges: readonly ["site.lifecycle"];
72
72
  };
73
73
  readonly 'site.lifecycle.progress': {
74
- readonly delivery: 'ephemeral';
74
+ readonly delivery: "ephemeral";
75
75
  readonly baseChanges: readonly [];
76
76
  };
77
77
  readonly 'site.analytics.ready': {
78
- readonly delivery: 'durable';
78
+ readonly delivery: "durable";
79
79
  readonly baseChanges: readonly ["site.analytics", "site.lifecycle"];
80
80
  };
81
81
  readonly 'site.sitemaps.ready': {
82
- readonly delivery: 'durable';
82
+ readonly delivery: "durable";
83
83
  readonly baseChanges: readonly ["site.sitemaps", "site.lifecycle"];
84
84
  };
85
85
  readonly 'site.indexing.ready': {
86
- readonly delivery: 'durable';
86
+ readonly delivery: "durable";
87
87
  readonly baseChanges: readonly ["site.indexing", "site.lifecycle"];
88
88
  };
89
89
  readonly 'site.auth.failed': {
90
- readonly delivery: 'durable';
90
+ readonly delivery: "durable";
91
91
  readonly baseChanges: readonly ["site.auth", "site.lifecycle"];
92
92
  };
93
93
  readonly 'site.lifecycle.failed': {
94
- readonly delivery: 'durable';
94
+ readonly delivery: "durable";
95
95
  readonly baseChanges: readonly ["site.lifecycle"];
96
96
  };
97
97
  readonly 'site.registration.changed': {
98
- readonly delivery: 'durable';
98
+ readonly delivery: "durable";
99
99
  readonly baseChanges: readonly ["site.registration", "user.sites"];
100
100
  };
101
101
  };
@@ -153,31 +153,31 @@ declare function createRealtimeV1Schemas(): {
153
153
  exp: z.ZodNumber;
154
154
  connectionExpiresAt: z.ZodNumber;
155
155
  principalClass: z.ZodEnum<{
156
- partner_key: "partner_key";
157
156
  user_key: "user_key";
157
+ partner_key: "partner_key";
158
158
  }>;
159
159
  principalPublicId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
160
160
  streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
161
161
  origin: z.ZodNullable<z.ZodURL>;
162
162
  }, z.core.$strict>;
163
163
  knownResourceType: z.ZodEnum<{
164
- "partner.team": "partner.team";
165
164
  "partner.user": "partner.user";
166
- "site.analytics": "site.analytics";
167
- "site.auth": "site.auth";
168
- "site.indexing": "site.indexing";
169
- "site.lifecycle": "site.lifecycle";
165
+ "partner.team": "partner.team";
166
+ "user.sites": "user.sites";
170
167
  "site.registration": "site.registration";
168
+ "site.lifecycle": "site.lifecycle";
169
+ "site.analytics": "site.analytics";
171
170
  "site.sitemaps": "site.sitemaps";
172
- "user.sites": "user.sites";
171
+ "site.indexing": "site.indexing";
172
+ "site.auth": "site.auth";
173
173
  }>;
174
174
  resourceChange: z.ZodObject<{
175
175
  type: z.ZodString;
176
176
  id: z.ZodString;
177
177
  kind: z.ZodEnum<{
178
178
  created: "created";
179
- deleted: "deleted";
180
179
  updated: "updated";
180
+ deleted: "deleted";
181
181
  }>;
182
182
  }, z.core.$strict>;
183
183
  subject: z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -194,27 +194,6 @@ declare function createRealtimeV1Schemas(): {
194
194
  id: z.ZodString;
195
195
  }, z.core.$strict>], "type">;
196
196
  durableEvent: z.ZodObject<{
197
- type: z.ZodLiteral<"event">;
198
- protocolVersion: z.ZodLiteral<1>;
199
- eventVersion: z.ZodNumber;
200
- id: z.ZodString;
201
- name: z.ZodString;
202
- subject: z.ZodDiscriminatedUnion<[z.ZodObject<{
203
- type: z.ZodLiteral<"partner">;
204
- id: z.ZodString;
205
- }, z.core.$strict>, z.ZodObject<{
206
- type: z.ZodLiteral<"team">;
207
- id: z.ZodString;
208
- }, z.core.$strict>, z.ZodObject<{
209
- type: z.ZodLiteral<"user">;
210
- id: z.ZodString;
211
- }, z.core.$strict>, z.ZodObject<{
212
- type: z.ZodLiteral<"site">;
213
- id: z.ZodString;
214
- }, z.core.$strict>], "type">;
215
- occurredAt: z.ZodISODateTime;
216
- correlationId: z.ZodNullable<z.ZodString>;
217
- data: z.ZodJSONSchema;
218
197
  cursor: z.ZodObject<{
219
198
  streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
220
199
  sequence: z.ZodString;
@@ -224,13 +203,11 @@ declare function createRealtimeV1Schemas(): {
224
203
  id: z.ZodString;
225
204
  kind: z.ZodEnum<{
226
205
  created: "created";
227
- deleted: "deleted";
228
206
  updated: "updated";
207
+ deleted: "deleted";
229
208
  }>;
230
209
  }, z.core.$strict>>;
231
210
  delivery: z.ZodLiteral<"durable">;
232
- }, z.core.$strict>;
233
- ephemeralEvent: z.ZodObject<{
234
211
  type: z.ZodLiteral<"event">;
235
212
  protocolVersion: z.ZodLiteral<1>;
236
213
  eventVersion: z.ZodNumber;
@@ -252,19 +229,19 @@ declare function createRealtimeV1Schemas(): {
252
229
  occurredAt: z.ZodISODateTime;
253
230
  correlationId: z.ZodNullable<z.ZodString>;
254
231
  data: z.ZodJSONSchema;
232
+ }, z.core.$strict>;
233
+ ephemeralEvent: z.ZodObject<{
255
234
  cursor: z.ZodNull;
256
235
  changes: z.ZodArray<z.ZodObject<{
257
236
  type: z.ZodString;
258
237
  id: z.ZodString;
259
238
  kind: z.ZodEnum<{
260
239
  created: "created";
261
- deleted: "deleted";
262
240
  updated: "updated";
241
+ deleted: "deleted";
263
242
  }>;
264
243
  }, z.core.$strict>>;
265
244
  delivery: z.ZodLiteral<"ephemeral">;
266
- }, z.core.$strict>;
267
- event: z.ZodUnion<readonly [z.ZodObject<{
268
245
  type: z.ZodLiteral<"event">;
269
246
  protocolVersion: z.ZodLiteral<1>;
270
247
  eventVersion: z.ZodNumber;
@@ -286,6 +263,8 @@ declare function createRealtimeV1Schemas(): {
286
263
  occurredAt: z.ZodISODateTime;
287
264
  correlationId: z.ZodNullable<z.ZodString>;
288
265
  data: z.ZodJSONSchema;
266
+ }, z.core.$strict>;
267
+ event: z.ZodUnion<readonly [z.ZodObject<{
289
268
  cursor: z.ZodObject<{
290
269
  streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
291
270
  sequence: z.ZodString;
@@ -295,12 +274,11 @@ declare function createRealtimeV1Schemas(): {
295
274
  id: z.ZodString;
296
275
  kind: z.ZodEnum<{
297
276
  created: "created";
298
- deleted: "deleted";
299
277
  updated: "updated";
278
+ deleted: "deleted";
300
279
  }>;
301
280
  }, z.core.$strict>>;
302
281
  delivery: z.ZodLiteral<"durable">;
303
- }, z.core.$strict>, z.ZodObject<{
304
282
  type: z.ZodLiteral<"event">;
305
283
  protocolVersion: z.ZodLiteral<1>;
306
284
  eventVersion: z.ZodNumber;
@@ -322,17 +300,39 @@ declare function createRealtimeV1Schemas(): {
322
300
  occurredAt: z.ZodISODateTime;
323
301
  correlationId: z.ZodNullable<z.ZodString>;
324
302
  data: z.ZodJSONSchema;
303
+ }, z.core.$strict>, z.ZodObject<{
325
304
  cursor: z.ZodNull;
326
305
  changes: z.ZodArray<z.ZodObject<{
327
306
  type: z.ZodString;
328
307
  id: z.ZodString;
329
308
  kind: z.ZodEnum<{
330
309
  created: "created";
331
- deleted: "deleted";
332
310
  updated: "updated";
311
+ deleted: "deleted";
333
312
  }>;
334
313
  }, z.core.$strict>>;
335
314
  delivery: z.ZodLiteral<"ephemeral">;
315
+ type: z.ZodLiteral<"event">;
316
+ protocolVersion: z.ZodLiteral<1>;
317
+ eventVersion: z.ZodNumber;
318
+ id: z.ZodString;
319
+ name: z.ZodString;
320
+ subject: z.ZodDiscriminatedUnion<[z.ZodObject<{
321
+ type: z.ZodLiteral<"partner">;
322
+ id: z.ZodString;
323
+ }, z.core.$strict>, z.ZodObject<{
324
+ type: z.ZodLiteral<"team">;
325
+ id: z.ZodString;
326
+ }, z.core.$strict>, z.ZodObject<{
327
+ type: z.ZodLiteral<"user">;
328
+ id: z.ZodString;
329
+ }, z.core.$strict>, z.ZodObject<{
330
+ type: z.ZodLiteral<"site">;
331
+ id: z.ZodString;
332
+ }, z.core.$strict>], "type">;
333
+ occurredAt: z.ZodISODateTime;
334
+ correlationId: z.ZodNullable<z.ZodString>;
335
+ data: z.ZodJSONSchema;
336
336
  }, z.core.$strict>]>;
337
337
  helloFrame: z.ZodObject<{
338
338
  type: z.ZodLiteral<"hello">;
@@ -394,6 +394,20 @@ declare function createRealtimeV1Schemas(): {
394
394
  batchFrame: z.ZodObject<{
395
395
  type: z.ZodLiteral<"batch">;
396
396
  events: z.ZodArray<z.ZodObject<{
397
+ cursor: z.ZodObject<{
398
+ streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
399
+ sequence: z.ZodString;
400
+ }, z.core.$strict>;
401
+ changes: z.ZodArray<z.ZodObject<{
402
+ type: z.ZodString;
403
+ id: z.ZodString;
404
+ kind: z.ZodEnum<{
405
+ created: "created";
406
+ updated: "updated";
407
+ deleted: "deleted";
408
+ }>;
409
+ }, z.core.$strict>>;
410
+ delivery: z.ZodLiteral<"durable">;
397
411
  type: z.ZodLiteral<"event">;
398
412
  protocolVersion: z.ZodLiteral<1>;
399
413
  eventVersion: z.ZodNumber;
@@ -415,20 +429,6 @@ declare function createRealtimeV1Schemas(): {
415
429
  occurredAt: z.ZodISODateTime;
416
430
  correlationId: z.ZodNullable<z.ZodString>;
417
431
  data: z.ZodJSONSchema;
418
- cursor: z.ZodObject<{
419
- streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
420
- sequence: z.ZodString;
421
- }, z.core.$strict>;
422
- changes: z.ZodArray<z.ZodObject<{
423
- type: z.ZodString;
424
- id: z.ZodString;
425
- kind: z.ZodEnum<{
426
- created: "created";
427
- deleted: "deleted";
428
- updated: "updated";
429
- }>;
430
- }, z.core.$strict>>;
431
- delivery: z.ZodLiteral<"durable">;
432
432
  }, z.core.$strict>>;
433
433
  }, z.core.$strict>;
434
434
  resyncRequiredFrame: z.ZodObject<{
@@ -452,11 +452,11 @@ declare function createRealtimeV1Schemas(): {
452
452
  type: z.ZodLiteral<"error">;
453
453
  error: z.ZodObject<{
454
454
  code: z.ZodEnum<{
455
- internal_error: "internal_error";
456
455
  invalid_frame: "invalid_frame";
457
- overloaded: "overloaded";
458
- policy_violation: "policy_violation";
459
456
  protocol_mismatch: "protocol_mismatch";
457
+ policy_violation: "policy_violation";
458
+ overloaded: "overloaded";
459
+ internal_error: "internal_error";
460
460
  }>;
461
461
  message: z.ZodString;
462
462
  retryable: z.ZodBoolean;
@@ -517,6 +517,20 @@ declare function createRealtimeV1Schemas(): {
517
517
  sequence: z.ZodString;
518
518
  }, z.core.$strict>;
519
519
  }, z.core.$strict>, z.ZodUnion<readonly [z.ZodObject<{
520
+ cursor: z.ZodObject<{
521
+ streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
522
+ sequence: z.ZodString;
523
+ }, z.core.$strict>;
524
+ changes: z.ZodArray<z.ZodObject<{
525
+ type: z.ZodString;
526
+ id: z.ZodString;
527
+ kind: z.ZodEnum<{
528
+ created: "created";
529
+ updated: "updated";
530
+ deleted: "deleted";
531
+ }>;
532
+ }, z.core.$strict>>;
533
+ delivery: z.ZodLiteral<"durable">;
520
534
  type: z.ZodLiteral<"event">;
521
535
  protocolVersion: z.ZodLiteral<1>;
522
536
  eventVersion: z.ZodNumber;
@@ -538,21 +552,18 @@ declare function createRealtimeV1Schemas(): {
538
552
  occurredAt: z.ZodISODateTime;
539
553
  correlationId: z.ZodNullable<z.ZodString>;
540
554
  data: z.ZodJSONSchema;
541
- cursor: z.ZodObject<{
542
- streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
543
- sequence: z.ZodString;
544
- }, z.core.$strict>;
555
+ }, z.core.$strict>, z.ZodObject<{
556
+ cursor: z.ZodNull;
545
557
  changes: z.ZodArray<z.ZodObject<{
546
558
  type: z.ZodString;
547
559
  id: z.ZodString;
548
560
  kind: z.ZodEnum<{
549
561
  created: "created";
550
- deleted: "deleted";
551
562
  updated: "updated";
563
+ deleted: "deleted";
552
564
  }>;
553
565
  }, z.core.$strict>>;
554
- delivery: z.ZodLiteral<"durable">;
555
- }, z.core.$strict>, z.ZodObject<{
566
+ delivery: z.ZodLiteral<"ephemeral">;
556
567
  type: z.ZodLiteral<"event">;
557
568
  protocolVersion: z.ZodLiteral<1>;
558
569
  eventVersion: z.ZodNumber;
@@ -574,20 +585,23 @@ declare function createRealtimeV1Schemas(): {
574
585
  occurredAt: z.ZodISODateTime;
575
586
  correlationId: z.ZodNullable<z.ZodString>;
576
587
  data: z.ZodJSONSchema;
577
- cursor: z.ZodNull;
578
- changes: z.ZodArray<z.ZodObject<{
579
- type: z.ZodString;
580
- id: z.ZodString;
581
- kind: z.ZodEnum<{
582
- created: "created";
583
- deleted: "deleted";
584
- updated: "updated";
585
- }>;
586
- }, z.core.$strict>>;
587
- delivery: z.ZodLiteral<"ephemeral">;
588
588
  }, z.core.$strict>]>, z.ZodObject<{
589
589
  type: z.ZodLiteral<"batch">;
590
590
  events: z.ZodArray<z.ZodObject<{
591
+ cursor: z.ZodObject<{
592
+ streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
593
+ sequence: z.ZodString;
594
+ }, z.core.$strict>;
595
+ changes: z.ZodArray<z.ZodObject<{
596
+ type: z.ZodString;
597
+ id: z.ZodString;
598
+ kind: z.ZodEnum<{
599
+ created: "created";
600
+ updated: "updated";
601
+ deleted: "deleted";
602
+ }>;
603
+ }, z.core.$strict>>;
604
+ delivery: z.ZodLiteral<"durable">;
591
605
  type: z.ZodLiteral<"event">;
592
606
  protocolVersion: z.ZodLiteral<1>;
593
607
  eventVersion: z.ZodNumber;
@@ -609,20 +623,6 @@ declare function createRealtimeV1Schemas(): {
609
623
  occurredAt: z.ZodISODateTime;
610
624
  correlationId: z.ZodNullable<z.ZodString>;
611
625
  data: z.ZodJSONSchema;
612
- cursor: z.ZodObject<{
613
- streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
614
- sequence: z.ZodString;
615
- }, z.core.$strict>;
616
- changes: z.ZodArray<z.ZodObject<{
617
- type: z.ZodString;
618
- id: z.ZodString;
619
- kind: z.ZodEnum<{
620
- created: "created";
621
- deleted: "deleted";
622
- updated: "updated";
623
- }>;
624
- }, z.core.$strict>>;
625
- delivery: z.ZodLiteral<"durable">;
626
626
  }, z.core.$strict>>;
627
627
  }, z.core.$strict>, z.ZodObject<{
628
628
  type: z.ZodLiteral<"resync.required">;
@@ -644,11 +644,11 @@ declare function createRealtimeV1Schemas(): {
644
644
  type: z.ZodLiteral<"error">;
645
645
  error: z.ZodObject<{
646
646
  code: z.ZodEnum<{
647
- internal_error: "internal_error";
648
647
  invalid_frame: "invalid_frame";
649
- overloaded: "overloaded";
650
- policy_violation: "policy_violation";
651
648
  protocol_mismatch: "protocol_mismatch";
649
+ policy_violation: "policy_violation";
650
+ overloaded: "overloaded";
651
+ internal_error: "internal_error";
652
652
  }>;
653
653
  message: z.ZodString;
654
654
  retryable: z.ZodBoolean;
@@ -1,2 +1,2 @@
1
- declare const GSCDUMP_HTTP_V1_VERSION: '1.0';
1
+ declare const GSCDUMP_HTTP_V1_VERSION: "1.0";
2
2
  export { GSCDUMP_HTTP_V1_VERSION };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gscdump/contracts",
3
3
  "type": "module",
4
- "version": "1.4.2",
4
+ "version": "1.4.4",
5
5
  "description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
6
6
  "author": {
7
7
  "name": "Harlan Wilton",