@uniformdev/next-app-router 20.7.1-alpha.118

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.
@@ -0,0 +1,779 @@
1
+ import { RouteGetParameters, RouteGetResponseEdgehancedComposition, RouteClient, RouteGetResponse } from '@uniformdev/canvas';
2
+ import { ManifestV2 } from '@uniformdev/context';
3
+ import { PageState } from '@uniformdev/next-app-router-shared';
4
+
5
+ type GetRouteFromMiddlewareOptions = {
6
+ source: 'middleware';
7
+ route: Omit<RouteGetParameters, 'projectId'>;
8
+ searchParams: URLSearchParams;
9
+ draftModeEnabled: boolean;
10
+ };
11
+ type GetRouteFromPageStateOptions = {
12
+ source: 'pageState';
13
+ pageState: PageState;
14
+ };
15
+ type GetRouteOptions = GetRouteFromMiddlewareOptions | GetRouteFromPageStateOptions;
16
+ type GetRouteFromApiOptions = {
17
+ source: GetRouteOptions['source'];
18
+ route: Omit<RouteGetParameters, 'projectId'>;
19
+ routeClient: RouteClient;
20
+ enableRuntimeCache: boolean;
21
+ disableSwrCache: boolean;
22
+ };
23
+ type GetRouteResult = {
24
+ route: RouteGetResponse | null;
25
+ };
26
+ interface DataClient {
27
+ getManifest: (options: GetManifestOptions) => Promise<ManifestV2 | null>;
28
+ getRoute(options: GetRouteOptions): Promise<GetRouteResult>;
29
+ }
30
+ type RewriteRouteMiddlewareOptions = {
31
+ source: 'middleware';
32
+ routeClient: RouteClient;
33
+ route: Omit<RouteGetParameters, 'projectId'>;
34
+ searchParams: URLSearchParams;
35
+ draftModeEnabled: boolean;
36
+ };
37
+ type RewriteRoutePageStateOptions = {
38
+ source: 'pageState';
39
+ routeClient: RouteClient;
40
+ route: Omit<RouteGetParameters, 'projectId'>;
41
+ };
42
+ type RewriteRouteOptions = RewriteRouteMiddlewareOptions | RewriteRoutePageStateOptions;
43
+ type RewriteRouteResult = {
44
+ route: RewriteRouteOptions['route'] | null;
45
+ };
46
+ type EnhanceRouteOptions = {
47
+ source: GetRouteOptions['source'];
48
+ parameters: Omit<RouteGetParameters, 'projectId'>;
49
+ route: RouteGetResponseEdgehancedComposition;
50
+ routeClient: RouteClient;
51
+ keys: Record<string, string> | undefined;
52
+ };
53
+ type GetManifestOptions = {
54
+ source: GetRouteOptions['source'];
55
+ };
56
+ declare class DefaultDataClient implements DataClient {
57
+ getManifest(options: GetManifestOptions): Promise<ManifestV2 | null>;
58
+ protected getRouteFromApi({ route, routeClient, enableRuntimeCache, disableSwrCache, }: GetRouteFromApiOptions): Promise<{
59
+ matchedRoute: string;
60
+ dynamicInputs?: {
61
+ [key: string]: string;
62
+ };
63
+ dataResourcesVariant?: "unpublished";
64
+ type: "composition";
65
+ compositionApiResponse: {
66
+ state: number;
67
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown";
68
+ projectId: string;
69
+ created: string;
70
+ modified: string;
71
+ creator?: string;
72
+ author?: string;
73
+ categoryId?: string;
74
+ description?: string;
75
+ previewImageUrl?: string;
76
+ pattern: boolean;
77
+ patternType?: "component" | "composition";
78
+ releaseId?: string;
79
+ composition: {
80
+ type: string;
81
+ parameters?: {
82
+ [key: string]: {
83
+ value?: unknown;
84
+ type: string;
85
+ connectedData?: {
86
+ pointer: string;
87
+ syntax: "jptr";
88
+ failureAction?: "t" | "p" | "c" | "a";
89
+ failureLogLevel?: "e" | "w" | "i";
90
+ failureDefault?: string;
91
+ };
92
+ locales?: {
93
+ [key: string]: unknown;
94
+ };
95
+ conditions?: {
96
+ when: {
97
+ op?: "&" | "|";
98
+ clauses: ({
99
+ rule: string;
100
+ source?: string;
101
+ op: string;
102
+ value: string | string[];
103
+ } | /*elided*/ any)[];
104
+ };
105
+ value: unknown;
106
+ id: number;
107
+ }[];
108
+ localesConditions?: {
109
+ [key: string]: {
110
+ when: {
111
+ op?: "&" | "|";
112
+ clauses: ({
113
+ rule: string;
114
+ source?: string;
115
+ op: string;
116
+ value: string | string[];
117
+ } | /*elided*/ any)[];
118
+ };
119
+ value: unknown;
120
+ id: number;
121
+ }[];
122
+ };
123
+ };
124
+ };
125
+ variant?: string;
126
+ projectMapNodes?: {
127
+ id: string;
128
+ path: string;
129
+ projectMapId: string;
130
+ data?: {
131
+ isSearchHit?: boolean;
132
+ queryStrings?: {
133
+ name: string;
134
+ value?: string;
135
+ helpText?: string;
136
+ optionsSource?: {
137
+ source: "static";
138
+ options: {
139
+ name: string;
140
+ value: string;
141
+ }[];
142
+ };
143
+ }[];
144
+ previewValue?: string;
145
+ };
146
+ locales?: {
147
+ [key: string]: {
148
+ path: string;
149
+ inherited: boolean;
150
+ };
151
+ };
152
+ }[];
153
+ slots?: {
154
+ [key: string]: {
155
+ type: string;
156
+ parameters?: {
157
+ [key: string]: {
158
+ value?: unknown;
159
+ type: string;
160
+ connectedData?: {
161
+ pointer: string;
162
+ syntax: "jptr";
163
+ failureAction?: "t" | "p" | "c" | "a";
164
+ failureLogLevel?: "e" | "w" | "i";
165
+ failureDefault?: string;
166
+ };
167
+ locales?: {
168
+ [key: string]: unknown;
169
+ };
170
+ conditions?: {
171
+ when: {
172
+ op?: "&" | "|";
173
+ clauses: ({
174
+ rule: string;
175
+ source?: string;
176
+ op: string;
177
+ value: string | string[];
178
+ } | /*elided*/ any)[];
179
+ };
180
+ value: unknown;
181
+ id: number;
182
+ }[];
183
+ localesConditions?: {
184
+ [key: string]: {
185
+ when: {
186
+ op?: "&" | "|";
187
+ clauses: ({
188
+ rule: string;
189
+ source?: string;
190
+ op: string;
191
+ value: string | string[];
192
+ } | /*elided*/ any)[];
193
+ };
194
+ value: unknown;
195
+ id: number;
196
+ }[];
197
+ };
198
+ };
199
+ };
200
+ variant?: string;
201
+ slots?: {
202
+ [key: string]: /*elided*/ any[];
203
+ };
204
+ _id?: string;
205
+ _pattern?: string;
206
+ _dataResources?: {
207
+ [key: string]: {
208
+ type: string;
209
+ isPatternParameter?: boolean;
210
+ ignorePatternParameterDefault?: boolean;
211
+ optionalPatternParameter?: boolean;
212
+ variables?: {
213
+ [key: string]: string;
214
+ };
215
+ };
216
+ };
217
+ _patternDataResources?: {
218
+ [key: string]: {
219
+ type: string;
220
+ isPatternParameter?: boolean;
221
+ ignorePatternParameterDefault?: boolean;
222
+ optionalPatternParameter?: boolean;
223
+ variables?: {
224
+ [key: string]: string;
225
+ };
226
+ };
227
+ };
228
+ _patternError?: "NOTFOUND" | "CYCLIC";
229
+ _overrides?: {
230
+ [key: string]: {
231
+ parameters?: {
232
+ [key: string]: {
233
+ value?: unknown;
234
+ type: string;
235
+ connectedData?: {
236
+ pointer: string;
237
+ syntax: "jptr";
238
+ failureAction?: "t" | "p" | "c" | "a";
239
+ failureLogLevel?: "e" | "w" | "i";
240
+ failureDefault?: string;
241
+ };
242
+ locales?: {
243
+ [key: string]: unknown;
244
+ };
245
+ conditions?: {
246
+ when: {
247
+ op?: "&" | "|";
248
+ clauses: ({
249
+ rule: string;
250
+ source?: string;
251
+ op: string;
252
+ value: string | string[];
253
+ } | /*elided*/ any)[];
254
+ };
255
+ value: unknown;
256
+ id: number;
257
+ }[];
258
+ localesConditions?: {
259
+ [key: string]: {
260
+ when: {
261
+ op?: "&" | "|";
262
+ clauses: ({
263
+ rule: string;
264
+ source?: string;
265
+ op: string;
266
+ value: string | string[];
267
+ } | /*elided*/ any)[];
268
+ };
269
+ value: unknown;
270
+ id: number;
271
+ }[];
272
+ };
273
+ };
274
+ };
275
+ slots?: {
276
+ [key: string]: /*elided*/ any[];
277
+ };
278
+ variant?: string;
279
+ dataResources?: {
280
+ [key: string]: {
281
+ type: string;
282
+ isPatternParameter?: boolean;
283
+ ignorePatternParameterDefault?: boolean;
284
+ optionalPatternParameter?: boolean;
285
+ variables?: {
286
+ [key: string]: string;
287
+ };
288
+ };
289
+ };
290
+ };
291
+ };
292
+ _patternOverrides?: {
293
+ [key: string]: {
294
+ parameters?: {
295
+ [key: string]: {
296
+ value?: unknown;
297
+ type: string;
298
+ connectedData?: {
299
+ pointer: string;
300
+ syntax: "jptr";
301
+ failureAction?: "t" | "p" | "c" | "a";
302
+ failureLogLevel?: "e" | "w" | "i";
303
+ failureDefault?: string;
304
+ };
305
+ locales?: {
306
+ [key: string]: unknown;
307
+ };
308
+ conditions?: {
309
+ when: {
310
+ op?: "&" | "|";
311
+ clauses: ({
312
+ rule: string;
313
+ source?: string;
314
+ op: string;
315
+ value: string | string[];
316
+ } | /*elided*/ any)[];
317
+ };
318
+ value: unknown;
319
+ id: number;
320
+ }[];
321
+ localesConditions?: {
322
+ [key: string]: {
323
+ when: {
324
+ op?: "&" | "|";
325
+ clauses: ({
326
+ rule: string;
327
+ source?: string;
328
+ op: string;
329
+ value: string | string[];
330
+ } | /*elided*/ any)[];
331
+ };
332
+ value: unknown;
333
+ id: number;
334
+ }[];
335
+ };
336
+ };
337
+ };
338
+ slots?: {
339
+ [key: string]: /*elided*/ any[];
340
+ };
341
+ variant?: string;
342
+ dataResources?: {
343
+ [key: string]: {
344
+ type: string;
345
+ isPatternParameter?: boolean;
346
+ ignorePatternParameterDefault?: boolean;
347
+ optionalPatternParameter?: boolean;
348
+ variables?: {
349
+ [key: string]: string;
350
+ };
351
+ };
352
+ };
353
+ };
354
+ };
355
+ _overridability?: {
356
+ parameters?: {
357
+ [key: string]: "yes" | "no";
358
+ };
359
+ variants?: boolean;
360
+ hideLockedParameters?: boolean;
361
+ };
362
+ _locales?: string[];
363
+ }[];
364
+ };
365
+ _id: string;
366
+ _slug?: string | null;
367
+ _name: string;
368
+ _author?: string;
369
+ _authorSubject?: string;
370
+ _creator?: string;
371
+ _creatorSubject?: string;
372
+ _pattern?: string;
373
+ _patternDataResources?: {
374
+ [key: string]: {
375
+ type: string;
376
+ isPatternParameter?: boolean;
377
+ ignorePatternParameterDefault?: boolean;
378
+ optionalPatternParameter?: boolean;
379
+ variables?: {
380
+ [key: string]: string;
381
+ };
382
+ };
383
+ };
384
+ _dataResources?: {
385
+ [key: string]: {
386
+ type: string;
387
+ isPatternParameter?: boolean;
388
+ ignorePatternParameterDefault?: boolean;
389
+ optionalPatternParameter?: boolean;
390
+ variables?: {
391
+ [key: string]: string;
392
+ };
393
+ };
394
+ };
395
+ _patternError?: "NOTFOUND" | "CYCLIC";
396
+ _overrides?: {
397
+ [key: string]: {
398
+ parameters?: {
399
+ [key: string]: {
400
+ value?: unknown;
401
+ type: string;
402
+ connectedData?: {
403
+ pointer: string;
404
+ syntax: "jptr";
405
+ failureAction?: "t" | "p" | "c" | "a";
406
+ failureLogLevel?: "e" | "w" | "i";
407
+ failureDefault?: string;
408
+ };
409
+ locales?: {
410
+ [key: string]: unknown;
411
+ };
412
+ conditions?: {
413
+ when: {
414
+ op?: "&" | "|";
415
+ clauses: ({
416
+ rule: string;
417
+ source?: string;
418
+ op: string;
419
+ value: string | string[];
420
+ } | /*elided*/ any)[];
421
+ };
422
+ value: unknown;
423
+ id: number;
424
+ }[];
425
+ localesConditions?: {
426
+ [key: string]: {
427
+ when: {
428
+ op?: "&" | "|";
429
+ clauses: ({
430
+ rule: string;
431
+ source?: string;
432
+ op: string;
433
+ value: string | string[];
434
+ } | /*elided*/ any)[];
435
+ };
436
+ value: unknown;
437
+ id: number;
438
+ }[];
439
+ };
440
+ };
441
+ };
442
+ slots?: {
443
+ [key: string]: {
444
+ type: string;
445
+ parameters?: {
446
+ [key: string]: {
447
+ value?: unknown;
448
+ type: string;
449
+ connectedData?: {
450
+ pointer: string;
451
+ syntax: "jptr";
452
+ failureAction?: "t" | "p" | "c" | "a";
453
+ failureLogLevel?: "e" | "w" | "i";
454
+ failureDefault?: string;
455
+ };
456
+ locales?: {
457
+ [key: string]: unknown;
458
+ };
459
+ conditions?: {
460
+ when: {
461
+ op?: "&" | "|";
462
+ clauses: ({
463
+ rule: string;
464
+ source?: string;
465
+ op: string;
466
+ value: string | string[];
467
+ } | /*elided*/ any)[];
468
+ };
469
+ value: unknown;
470
+ id: number;
471
+ }[];
472
+ localesConditions?: {
473
+ [key: string]: {
474
+ when: {
475
+ op?: "&" | "|";
476
+ clauses: ({
477
+ rule: string;
478
+ source?: string;
479
+ op: string;
480
+ value: string | string[];
481
+ } | /*elided*/ any)[];
482
+ };
483
+ value: unknown;
484
+ id: number;
485
+ }[];
486
+ };
487
+ };
488
+ };
489
+ variant?: string;
490
+ slots?: {
491
+ [key: string]: /*elided*/ any[];
492
+ };
493
+ _id?: string;
494
+ _pattern?: string;
495
+ _dataResources?: {
496
+ [key: string]: {
497
+ type: string;
498
+ isPatternParameter?: boolean;
499
+ ignorePatternParameterDefault?: boolean;
500
+ optionalPatternParameter?: boolean;
501
+ variables?: {
502
+ [key: string]: string;
503
+ };
504
+ };
505
+ };
506
+ _patternDataResources?: {
507
+ [key: string]: {
508
+ type: string;
509
+ isPatternParameter?: boolean;
510
+ ignorePatternParameterDefault?: boolean;
511
+ optionalPatternParameter?: boolean;
512
+ variables?: {
513
+ [key: string]: string;
514
+ };
515
+ };
516
+ };
517
+ _patternError?: "NOTFOUND" | "CYCLIC";
518
+ _overrides?: {
519
+ [key: string]: /*elided*/ any;
520
+ };
521
+ _patternOverrides?: {
522
+ [key: string]: /*elided*/ any;
523
+ };
524
+ _overridability?: {
525
+ parameters?: {
526
+ [key: string]: "yes" | "no";
527
+ };
528
+ variants?: boolean;
529
+ hideLockedParameters?: boolean;
530
+ };
531
+ _locales?: string[];
532
+ }[];
533
+ };
534
+ variant?: string;
535
+ dataResources?: {
536
+ [key: string]: {
537
+ type: string;
538
+ isPatternParameter?: boolean;
539
+ ignorePatternParameterDefault?: boolean;
540
+ optionalPatternParameter?: boolean;
541
+ variables?: {
542
+ [key: string]: string;
543
+ };
544
+ };
545
+ };
546
+ };
547
+ };
548
+ _patternOverrides?: {
549
+ [key: string]: {
550
+ parameters?: {
551
+ [key: string]: {
552
+ value?: unknown;
553
+ type: string;
554
+ connectedData?: {
555
+ pointer: string;
556
+ syntax: "jptr";
557
+ failureAction?: "t" | "p" | "c" | "a";
558
+ failureLogLevel?: "e" | "w" | "i";
559
+ failureDefault?: string;
560
+ };
561
+ locales?: {
562
+ [key: string]: unknown;
563
+ };
564
+ conditions?: {
565
+ when: {
566
+ op?: "&" | "|";
567
+ clauses: ({
568
+ rule: string;
569
+ source?: string;
570
+ op: string;
571
+ value: string | string[];
572
+ } | /*elided*/ any)[];
573
+ };
574
+ value: unknown;
575
+ id: number;
576
+ }[];
577
+ localesConditions?: {
578
+ [key: string]: {
579
+ when: {
580
+ op?: "&" | "|";
581
+ clauses: ({
582
+ rule: string;
583
+ source?: string;
584
+ op: string;
585
+ value: string | string[];
586
+ } | /*elided*/ any)[];
587
+ };
588
+ value: unknown;
589
+ id: number;
590
+ }[];
591
+ };
592
+ };
593
+ };
594
+ slots?: {
595
+ [key: string]: {
596
+ type: string;
597
+ parameters?: {
598
+ [key: string]: {
599
+ value?: unknown;
600
+ type: string;
601
+ connectedData?: {
602
+ pointer: string;
603
+ syntax: "jptr";
604
+ failureAction?: "t" | "p" | "c" | "a";
605
+ failureLogLevel?: "e" | "w" | "i";
606
+ failureDefault?: string;
607
+ };
608
+ locales?: {
609
+ [key: string]: unknown;
610
+ };
611
+ conditions?: {
612
+ when: {
613
+ op?: "&" | "|";
614
+ clauses: ({
615
+ rule: string;
616
+ source?: string;
617
+ op: string;
618
+ value: string | string[];
619
+ } | /*elided*/ any)[];
620
+ };
621
+ value: unknown;
622
+ id: number;
623
+ }[];
624
+ localesConditions?: {
625
+ [key: string]: {
626
+ when: {
627
+ op?: "&" | "|";
628
+ clauses: ({
629
+ rule: string;
630
+ source?: string;
631
+ op: string;
632
+ value: string | string[];
633
+ } | /*elided*/ any)[];
634
+ };
635
+ value: unknown;
636
+ id: number;
637
+ }[];
638
+ };
639
+ };
640
+ };
641
+ variant?: string;
642
+ slots?: {
643
+ [key: string]: /*elided*/ any[];
644
+ };
645
+ _id?: string;
646
+ _pattern?: string;
647
+ _dataResources?: {
648
+ [key: string]: {
649
+ type: string;
650
+ isPatternParameter?: boolean;
651
+ ignorePatternParameterDefault?: boolean;
652
+ optionalPatternParameter?: boolean;
653
+ variables?: {
654
+ [key: string]: string;
655
+ };
656
+ };
657
+ };
658
+ _patternDataResources?: {
659
+ [key: string]: {
660
+ type: string;
661
+ isPatternParameter?: boolean;
662
+ ignorePatternParameterDefault?: boolean;
663
+ optionalPatternParameter?: boolean;
664
+ variables?: {
665
+ [key: string]: string;
666
+ };
667
+ };
668
+ };
669
+ _patternError?: "NOTFOUND" | "CYCLIC";
670
+ _overrides?: {
671
+ [key: string]: /*elided*/ any;
672
+ };
673
+ _patternOverrides?: {
674
+ [key: string]: /*elided*/ any;
675
+ };
676
+ _overridability?: {
677
+ parameters?: {
678
+ [key: string]: "yes" | "no";
679
+ };
680
+ variants?: boolean;
681
+ hideLockedParameters?: boolean;
682
+ };
683
+ _locales?: string[];
684
+ }[];
685
+ };
686
+ variant?: string;
687
+ dataResources?: {
688
+ [key: string]: {
689
+ type: string;
690
+ isPatternParameter?: boolean;
691
+ ignorePatternParameterDefault?: boolean;
692
+ optionalPatternParameter?: boolean;
693
+ variables?: {
694
+ [key: string]: string;
695
+ };
696
+ };
697
+ };
698
+ };
699
+ };
700
+ _overridability?: {
701
+ parameters?: {
702
+ [key: string]: "yes" | "no";
703
+ };
704
+ variants?: boolean;
705
+ hideLockedParameters?: boolean;
706
+ };
707
+ _locales?: string[];
708
+ };
709
+ workflowId?: string;
710
+ workflowStageId?: string;
711
+ workflowDefinition?: {
712
+ id: string;
713
+ name: string;
714
+ initialStage: string;
715
+ stages: {
716
+ [key: string]: {
717
+ name: string;
718
+ permissions: {
719
+ [key: string]: {
720
+ write?: boolean;
721
+ publish?: boolean;
722
+ };
723
+ };
724
+ autoPublish?: boolean;
725
+ requireValidity?: boolean;
726
+ transitions: {
727
+ to: string;
728
+ name: string;
729
+ permissions: {
730
+ [key: string]: {
731
+ execute?: boolean;
732
+ };
733
+ };
734
+ }[];
735
+ icon?: string;
736
+ order?: number;
737
+ };
738
+ };
739
+ modified?: string;
740
+ created?: string;
741
+ createdBy?: string;
742
+ modifiedBy?: string;
743
+ };
744
+ editionId?: string;
745
+ editionName?: string;
746
+ editionPriority?: number;
747
+ };
748
+ } | {
749
+ matchedRoute: string;
750
+ dynamicInputs?: {
751
+ [key: string]: string;
752
+ };
753
+ type: "redirect";
754
+ redirect: {
755
+ id?: string;
756
+ sourceUrl: string;
757
+ targetUrl: string;
758
+ targetStatusCode: number;
759
+ sourceProjectMapNodeId?: string;
760
+ targetProjectMapNodeId?: string;
761
+ projectMapId?: string;
762
+ sourceRetainQuerystring?: boolean;
763
+ sourceMustMatchDomain?: boolean;
764
+ targetPreserveIncomingProtocol?: boolean;
765
+ targetPreserveIncomingDomain?: boolean;
766
+ targetMergeQuerystring?: boolean;
767
+ labelAsSystem?: boolean;
768
+ };
769
+ } | {
770
+ type: "notFound";
771
+ }>;
772
+ getRoute(options: GetRouteOptions): Promise<GetRouteResult>;
773
+ protected enhanceRoute(_options: EnhanceRouteOptions): Promise<void>;
774
+ protected getRouteMiddleware(options: GetRouteFromMiddlewareOptions): Promise<GetRouteResult>;
775
+ protected getRoutePageState(options: GetRouteFromPageStateOptions): Promise<GetRouteResult>;
776
+ }
777
+ declare const expireMiddlewareCacheTag: (tag: string | string[]) => Promise<void>;
778
+
779
+ export { type DataClient as D, type EnhanceRouteOptions as E, type GetRouteFromMiddlewareOptions as G, type RewriteRouteOptions as R, DefaultDataClient as a, type GetRouteFromPageStateOptions as b, type GetRouteOptions as c, type RewriteRouteResult as d, expireMiddlewareCacheTag as e };