@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.15 → 0.4.49-alpha.feat-onboarding-guide.16

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 (16) hide show
  1. package/dist/core/MediaLibrary/hooks/mediaLibraryData.d.ts +27 -27
  2. package/dist/core/MediaLibrary/hooks/useSelectedMedia.d.ts +3 -3
  3. package/dist/core/OnboardingGuide/OnboardingGuide.d.ts +2 -2
  4. package/dist/core/OnboardingGuide/components/OnboardingCard.d.ts +2 -2
  5. package/dist/core/OnboardingGuide/components/OnboardingProgressStepper.d.ts +2 -2
  6. package/dist/core/OnboardingGuide/content.d.ts +1 -1
  7. package/dist/core/service/customType.d.ts +3 -3
  8. package/dist/core/service/document.d.ts +25 -25
  9. package/dist/core/service/onboarding.d.ts +14 -19
  10. package/dist/core/service/repository.d.ts +12 -12
  11. package/dist/fields/LinkField/Documents/documentsData.d.ts +2 -2
  12. package/dist/fields/LinkField/LinkField.d.ts +1 -1
  13. package/dist/fields/RichTextField/coreExtensions/ListItem.d.ts +2 -2
  14. package/dist/index.cjs.js +23 -23
  15. package/dist/index.es.js +2491 -2502
  16. package/package.json +4 -4
package/dist/core/MediaLibrary/hooks/mediaLibraryData.d.ts CHANGED
@@ -54,6 +54,9 @@ export declare const mediaAssetType: z.ZodObject<{
54
54
  count?: number | undefined;
55
55
  }>, "many">;
56
56
  }, "strip", z.ZodTypeAny, {
57
+ id: string;
58
+ size: number;
59
+ url: string;
57
60
  tags: {
58
61
  id: string;
59
62
  name: string;
@@ -62,9 +65,6 @@ export declare const mediaAssetType: z.ZodObject<{
62
65
  count: number;
63
66
  uploader_id?: string | undefined;
64
67
  }[];
65
- id: string;
66
- url: string;
67
- size: number;
68
68
  last_modified: number;
69
69
  kind: string;
70
70
  filename: string;
@@ -82,6 +82,9 @@ export declare const mediaAssetType: z.ZodObject<{
82
82
  credits?: string | undefined;
83
83
  } | undefined;
84
84
  }, {
85
+ id: string;
86
+ size: number;
87
+ url: string;
85
88
  tags: {
86
89
  id: string;
87
90
  name: string;
@@ -90,9 +93,6 @@ export declare const mediaAssetType: z.ZodObject<{
90
93
  uploader_id?: string | undefined;
91
94
  count?: number | undefined;
92
95
  }[];
93
- id: string;
94
- url: string;
95
- size: number;
96
96
  last_modified: number;
97
97
  kind: string;
98
98
  filename: string;
@@ -169,6 +169,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
169
169
  count?: number | undefined;
170
170
  }>, "many">;
171
171
  }, "strip", z.ZodTypeAny, {
172
+ id: string;
173
+ size: number;
174
+ url: string;
172
175
  tags: {
173
176
  id: string;
174
177
  name: string;
@@ -177,9 +180,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
177
180
  count: number;
178
181
  uploader_id?: string | undefined;
179
182
  }[];
180
- id: string;
181
- url: string;
182
- size: number;
183
183
  last_modified: number;
184
184
  kind: string;
185
185
  filename: string;
@@ -197,6 +197,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
197
197
  credits?: string | undefined;
198
198
  } | undefined;
199
199
  }, {
200
+ id: string;
201
+ size: number;
202
+ url: string;
200
203
  tags: {
201
204
  id: string;
202
205
  name: string;
@@ -205,9 +208,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
205
208
  uploader_id?: string | undefined;
206
209
  count?: number | undefined;
207
210
  }[];
208
- id: string;
209
- url: string;
210
- size: number;
211
211
  last_modified: number;
212
212
  kind: string;
213
213
  filename: string;
@@ -228,6 +228,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
228
228
  }, "strip", z.ZodTypeAny, {
229
229
  total: number;
230
230
  items: {
231
+ id: string;
232
+ size: number;
233
+ url: string;
231
234
  tags: {
232
235
  id: string;
233
236
  name: string;
@@ -236,9 +239,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
236
239
  count: number;
237
240
  uploader_id?: string | undefined;
238
241
  }[];
239
- id: string;
240
- url: string;
241
- size: number;
242
242
  last_modified: number;
243
243
  kind: string;
244
244
  filename: string;
@@ -260,6 +260,9 @@ export declare const mediaSearchResponse: z.ZodObject<{
260
260
  }, {
261
261
  total: number;
262
262
  items: {
263
+ id: string;
264
+ size: number;
265
+ url: string;
263
266
  tags: {
264
267
  id: string;
265
268
  name: string;
@@ -268,9 +271,6 @@ export declare const mediaSearchResponse: z.ZodObject<{
268
271
  uploader_id?: string | undefined;
269
272
  count?: number | undefined;
270
273
  }[];
271
- id: string;
272
- url: string;
273
- size: number;
274
274
  last_modified: number;
275
275
  kind: string;
276
276
  filename: string;
@@ -308,6 +308,9 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
308
308
  page: number;
309
309
  total: number;
310
310
  items: {
311
+ id: string;
312
+ size: number;
313
+ url: string;
311
314
  tags: {
312
315
  id: string;
313
316
  name: string;
@@ -316,9 +319,6 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
316
319
  count: number;
317
320
  uploader_id?: string | undefined;
318
321
  }[];
319
- id: string;
320
- url: string;
321
- size: number;
322
322
  last_modified: number;
323
323
  kind: string;
324
324
  filename: string;
@@ -357,6 +357,9 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
357
357
  setFilters: (filters: Partial<MediaLibraryFilters>) => void;
358
358
  resetFilters: () => void;
359
359
  media: {
360
+ id: string;
361
+ size: number;
362
+ url: string;
360
363
  tags: {
361
364
  id: string;
362
365
  name: string;
@@ -365,9 +368,6 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
365
368
  count: number;
366
369
  uploader_id?: string | undefined;
367
370
  }[];
368
- id: string;
369
- url: string;
370
- size: number;
371
371
  last_modified: number;
372
372
  kind: string;
373
373
  filename: string;
@@ -407,6 +407,9 @@ declare function deleteMedia(mediaIds: string[]): void;
407
407
  declare function deleteSearchData(args: MediaLibraryFilters): void;
408
408
  type MediaPage = Awaited<ReturnType<typeof searchMedia>>;
409
409
  export declare function getMedia(allPages: MediaPage[], keyword: string, assetType: MediaAssetType, uploaderId: string | undefined, tags: string): {
410
+ id: string;
411
+ size: number;
412
+ url: string;
410
413
  tags: {
411
414
  id: string;
412
415
  name: string;
@@ -415,9 +418,6 @@ export declare function getMedia(allPages: MediaPage[], keyword: string, assetTy
415
418
  count: number;
416
419
  uploader_id?: string | undefined;
417
420
  }[];
418
- id: string;
419
- url: string;
420
- size: number;
421
421
  last_modified: number;
422
422
  kind: string;
423
423
  filename: string;
package/dist/core/MediaLibrary/hooks/useSelectedMedia.d.ts CHANGED
@@ -1,4 +1,7 @@
1
1
  export declare function useSelectedMedia(): {
2
+ id: string;
3
+ size: number;
4
+ url: string;
2
5
  tags: {
3
6
  id: string;
4
7
  name: string;
@@ -7,9 +10,6 @@ export declare function useSelectedMedia(): {
7
10
  count: number;
8
11
  uploader_id?: string | undefined;
9
12
  }[];
10
- id: string;
11
- url: string;
12
- size: number;
13
13
  last_modified: number;
14
14
  kind: string;
15
15
  filename: string;
package/dist/core/OnboardingGuide/OnboardingGuide.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  /// <reference types="react" />
2
- import type { OnboardingState, OnboardingStepId, OnboardingTracking } from "../service";
2
+ import type { OnboardingState, OnboardingTracking } from "../service";
3
3
  interface OnboardingGuideProps {
4
4
  onboardingState: OnboardingState;
5
5
  tracking: OnboardingTracking;
6
- onToggleStep: (stepId: OnboardingStepId) => Promise<OnboardingStepId[]>;
6
+ onToggleStep: (stepId: string) => Promise<string[]>;
7
7
  onToggleGuide: () => Promise<void>;
8
8
  }
9
9
  export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element | null;
package/dist/core/OnboardingGuide/components/OnboardingCard.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /// <reference types="react" />
2
- import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
2
+ import type { OnboardingStep, OnboardingTracking } from "../../service";
3
3
  interface OnboardingCardProps {
4
4
  steps: OnboardingStep[];
5
- completedSteps: OnboardingStepId[];
5
+ completedSteps: string[];
6
6
  tutorialLink?: string;
7
7
  tracking: OnboardingTracking;
8
8
  onToggleStep: (step: OnboardingStep) => Promise<void>;
package/dist/core/OnboardingGuide/components/OnboardingProgressStepper.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /// <reference types="react" />
2
- import type { OnboardingStep, OnboardingStepId, OnboardingTracking } from "../../service";
2
+ import type { OnboardingStep, OnboardingTracking } from "../../service";
3
3
  interface OnboardingProgressStepperProps {
4
4
  steps: OnboardingStep[];
5
- completedSteps: OnboardingStepId[];
5
+ completedSteps: string[];
6
6
  onToggleStep: (step: OnboardingStep) => Promise<void>;
7
7
  tracking: OnboardingTracking;
8
8
  }
package/dist/core/OnboardingGuide/content.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { OnboardingFramework, OnboardingStep } from "../service/onboarding";
2
2
  export declare function getOnboardingContent(framework?: OnboardingFramework, starter?: string | null): {
3
3
  steps: OnboardingStep[];
4
- defaultCompletedStepIds: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
4
+ defaultCompletedStepIds: string[];
5
5
  tutorialLink: string | undefined;
6
6
  };
package/dist/core/service/customType.d.ts CHANGED
@@ -6,21 +6,21 @@ declare const customTypeResponse: z.ZodObject<{
6
6
  repeatable: z.ZodBoolean;
7
7
  status: z.ZodBoolean;
8
8
  }, "strip", z.ZodTypeAny, {
9
- label: string;
10
9
  id: string;
11
10
  status: boolean;
11
+ label: string;
12
12
  repeatable: boolean;
13
13
  }, {
14
- label: string;
15
14
  id: string;
16
15
  status: boolean;
16
+ label: string;
17
17
  repeatable: boolean;
18
18
  }>;
19
19
  export type CustomTypeResponse = z.TypeOf<typeof customTypeResponse>;
20
20
  export declare function getRepositoryCustomTypes(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<{
21
- label: string;
22
21
  id: string;
23
22
  status: boolean;
23
+ label: string;
24
24
  repeatable: boolean;
25
25
  }[]>;
26
26
  export {};
package/dist/core/service/document.d.ts CHANGED
@@ -66,7 +66,6 @@ declare const documentVersionOkType: z.ZodIntersection<z.ZodDiscriminatedUnion<"
66
66
  }>;
67
67
  uid: z.ZodOptional<z.ZodString>;
68
68
  }, "strip", z.ZodTypeAny, {
69
- tags: string[];
70
69
  author: {
71
70
  first_name?: string | undefined;
72
71
  last_name?: string | undefined;
@@ -74,13 +73,13 @@ declare const documentVersionOkType: z.ZodIntersection<z.ZodDiscriminatedUnion<"
74
73
  uploadedAvatar?: string | undefined;
75
74
  };
76
75
  version_id: string;
76
+ tags: string[];
77
77
  custom_type_label: string;
78
78
  last_modified_date: Date;
79
79
  preview_summary?: string | undefined;
80
80
  preview_image?: string | undefined;
81
81
  uid?: string | undefined;
82
82
  }, {
83
- tags: string[];
84
83
  author: {
85
84
  first_name?: string | undefined;
86
85
  last_name?: string | undefined;
@@ -88,6 +87,7 @@ declare const documentVersionOkType: z.ZodIntersection<z.ZodDiscriminatedUnion<"
88
87
  uploadedAvatar?: string | undefined;
89
88
  };
90
89
  version_id: string;
90
+ tags: string[];
91
91
  custom_type_label: string;
92
92
  last_modified_date: Date;
93
93
  preview_summary?: string | undefined;
@@ -164,7 +164,6 @@ export declare const documentMetaOkType: z.ZodObject<{
164
164
  }>;
165
165
  uid: z.ZodOptional<z.ZodString>;
166
166
  }, "strip", z.ZodTypeAny, {
167
- tags: string[];
168
167
  author: {
169
168
  first_name?: string | undefined;
170
169
  last_name?: string | undefined;
@@ -172,13 +171,13 @@ export declare const documentMetaOkType: z.ZodObject<{
172
171
  uploadedAvatar?: string | undefined;
173
172
  };
174
173
  version_id: string;
174
+ tags: string[];
175
175
  custom_type_label: string;
176
176
  last_modified_date: Date;
177
177
  preview_summary?: string | undefined;
178
178
  preview_image?: string | undefined;
179
179
  uid?: string | undefined;
180
180
  }, {
181
- tags: string[];
182
181
  author: {
183
182
  first_name?: string | undefined;
184
183
  last_name?: string | undefined;
@@ -186,6 +185,7 @@ export declare const documentMetaOkType: z.ZodObject<{
186
185
  uploadedAvatar?: string | undefined;
187
186
  };
188
187
  version_id: string;
188
+ tags: string[];
189
189
  custom_type_label: string;
190
190
  last_modified_date: Date;
191
191
  preview_summary?: string | undefined;
@@ -212,7 +212,6 @@ export declare const documentMetaOkType: z.ZodObject<{
212
212
  } | {
213
213
  status: "archived";
214
214
  }) & {
215
- tags: string[];
216
215
  author: {
217
216
  first_name?: string | undefined;
218
217
  last_name?: string | undefined;
@@ -220,6 +219,7 @@ export declare const documentMetaOkType: z.ZodObject<{
220
219
  uploadedAvatar?: string | undefined;
221
220
  };
222
221
  version_id: string;
222
+ tags: string[];
223
223
  custom_type_label: string;
224
224
  last_modified_date: Date;
225
225
  preview_summary?: string | undefined;
@@ -245,7 +245,6 @@ export declare const documentMetaOkType: z.ZodObject<{
245
245
  } | {
246
246
  status: "archived";
247
247
  }) & {
248
- tags: string[];
249
248
  author: {
250
249
  first_name?: string | undefined;
251
250
  last_name?: string | undefined;
@@ -253,6 +252,7 @@ export declare const documentMetaOkType: z.ZodObject<{
253
252
  uploadedAvatar?: string | undefined;
254
253
  };
255
254
  version_id: string;
255
+ tags: string[];
256
256
  custom_type_label: string;
257
257
  last_modified_date: Date;
258
258
  preview_summary?: string | undefined;
@@ -334,7 +334,6 @@ declare const getDocumentListSchema: z.ZodObject<{
334
334
  }>;
335
335
  uid: z.ZodOptional<z.ZodString>;
336
336
  }, "strip", z.ZodTypeAny, {
337
- tags: string[];
338
337
  author: {
339
338
  first_name?: string | undefined;
340
339
  last_name?: string | undefined;
@@ -342,13 +341,13 @@ declare const getDocumentListSchema: z.ZodObject<{
342
341
  uploadedAvatar?: string | undefined;
343
342
  };
344
343
  version_id: string;
344
+ tags: string[];
345
345
  custom_type_label: string;
346
346
  last_modified_date: Date;
347
347
  preview_summary?: string | undefined;
348
348
  preview_image?: string | undefined;
349
349
  uid?: string | undefined;
350
350
  }, {
351
- tags: string[];
352
351
  author: {
353
352
  first_name?: string | undefined;
354
353
  last_name?: string | undefined;
@@ -356,6 +355,7 @@ declare const getDocumentListSchema: z.ZodObject<{
356
355
  uploadedAvatar?: string | undefined;
357
356
  };
358
357
  version_id: string;
358
+ tags: string[];
359
359
  custom_type_label: string;
360
360
  last_modified_date: Date;
361
361
  preview_summary?: string | undefined;
@@ -382,7 +382,6 @@ declare const getDocumentListSchema: z.ZodObject<{
382
382
  } | {
383
383
  status: "archived";
384
384
  }) & {
385
- tags: string[];
386
385
  author: {
387
386
  first_name?: string | undefined;
388
387
  last_name?: string | undefined;
@@ -390,6 +389,7 @@ declare const getDocumentListSchema: z.ZodObject<{
390
389
  uploadedAvatar?: string | undefined;
391
390
  };
392
391
  version_id: string;
392
+ tags: string[];
393
393
  custom_type_label: string;
394
394
  last_modified_date: Date;
395
395
  preview_summary?: string | undefined;
@@ -415,7 +415,6 @@ declare const getDocumentListSchema: z.ZodObject<{
415
415
  } | {
416
416
  status: "archived";
417
417
  }) & {
418
- tags: string[];
419
418
  author: {
420
419
  first_name?: string | undefined;
421
420
  last_name?: string | undefined;
@@ -423,6 +422,7 @@ declare const getDocumentListSchema: z.ZodObject<{
423
422
  uploadedAvatar?: string | undefined;
424
423
  };
425
424
  version_id: string;
425
+ tags: string[];
426
426
  custom_type_label: string;
427
427
  last_modified_date: Date;
428
428
  preview_summary?: string | undefined;
@@ -432,7 +432,6 @@ declare const getDocumentListSchema: z.ZodObject<{
432
432
  title?: string | null | undefined;
433
433
  }>, "many">;
434
434
  }, "strip", z.ZodTypeAny, {
435
- total: number;
436
435
  results: {
437
436
  id: string;
438
437
  title: string;
@@ -453,7 +452,6 @@ declare const getDocumentListSchema: z.ZodObject<{
453
452
  } | {
454
453
  status: "archived";
455
454
  }) & {
456
- tags: string[];
457
455
  author: {
458
456
  first_name?: string | undefined;
459
457
  last_name?: string | undefined;
@@ -461,6 +459,7 @@ declare const getDocumentListSchema: z.ZodObject<{
461
459
  uploadedAvatar?: string | undefined;
462
460
  };
463
461
  version_id: string;
462
+ tags: string[];
464
463
  custom_type_label: string;
465
464
  last_modified_date: Date;
466
465
  preview_summary?: string | undefined;
@@ -468,9 +467,9 @@ declare const getDocumentListSchema: z.ZodObject<{
468
467
  uid?: string | undefined;
469
468
  })[];
470
469
  }[];
470
+ total: number;
471
471
  cursor?: string | undefined;
472
472
  }, {
473
- total: number;
474
473
  results: {
475
474
  id: string;
476
475
  language: {
@@ -490,7 +489,6 @@ declare const getDocumentListSchema: z.ZodObject<{
490
489
  } | {
491
490
  status: "archived";
492
491
  }) & {
493
- tags: string[];
494
492
  author: {
495
493
  first_name?: string | undefined;
496
494
  last_name?: string | undefined;
@@ -498,6 +496,7 @@ declare const getDocumentListSchema: z.ZodObject<{
498
496
  uploadedAvatar?: string | undefined;
499
497
  };
500
498
  version_id: string;
499
+ tags: string[];
501
500
  custom_type_label: string;
502
501
  last_modified_date: Date;
503
502
  preview_summary?: string | undefined;
@@ -506,6 +505,7 @@ declare const getDocumentListSchema: z.ZodObject<{
506
505
  })[];
507
506
  title?: string | null | undefined;
508
507
  }[];
508
+ total: number;
509
509
  cursor?: string | undefined;
510
510
  }>;
511
511
  declare const documentsFullTextSearchAPISchemaOkType: z.ZodObject<{
@@ -854,7 +854,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
854
854
  label?: string | null | undefined;
855
855
  direction?: string | null | undefined;
856
856
  }) | ({
857
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
857
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
858
858
  content: {
859
859
  text: string;
860
860
  } & {
@@ -1201,7 +1201,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
1201
1201
  label?: string | null | undefined;
1202
1202
  direction?: string | null | undefined;
1203
1203
  }) | ({
1204
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
1204
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
1205
1205
  content: {
1206
1206
  text: string;
1207
1207
  } & {
@@ -1540,7 +1540,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
1540
1540
  label?: string | null | undefined;
1541
1541
  direction?: string | null | undefined;
1542
1542
  }) | ({
1543
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
1543
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
1544
1544
  content: {
1545
1545
  text: string;
1546
1546
  } & {
@@ -1881,7 +1881,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
1881
1881
  label?: string | null | undefined;
1882
1882
  direction?: string | null | undefined;
1883
1883
  }) | ({
1884
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
1884
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
1885
1885
  content: {
1886
1886
  text: string;
1887
1887
  } & {
@@ -2220,7 +2220,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
2220
2220
  label?: string | null | undefined;
2221
2221
  direction?: string | null | undefined;
2222
2222
  }) | ({
2223
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
2223
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
2224
2224
  content: {
2225
2225
  text: string;
2226
2226
  } & {
@@ -2557,7 +2557,7 @@ export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDe
2557
2557
  label?: string | null | undefined;
2558
2558
  direction?: string | null | undefined;
2559
2559
  }) | ({
2560
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
2560
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
2561
2561
  content: {
2562
2562
  text: string;
2563
2563
  } & {
@@ -2905,7 +2905,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
2905
2905
  label?: string | null | undefined;
2906
2906
  direction?: string | null | undefined;
2907
2907
  }) | ({
2908
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
2908
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
2909
2909
  content: {
2910
2910
  text: string;
2911
2911
  } & {
@@ -3244,7 +3244,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
3244
3244
  label?: string | null | undefined;
3245
3245
  direction?: string | null | undefined;
3246
3246
  }) | ({
3247
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
3247
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
3248
3248
  content: {
3249
3249
  text: string;
3250
3250
  } & {
@@ -3585,7 +3585,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
3585
3585
  label?: string | null | undefined;
3586
3586
  direction?: string | null | undefined;
3587
3587
  }) | ({
3588
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
3588
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
3589
3589
  content: {
3590
3590
  text: string;
3591
3591
  } & {
@@ -3924,7 +3924,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
3924
3924
  label?: string | null | undefined;
3925
3925
  direction?: string | null | undefined;
3926
3926
  }) | ({
3927
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
3927
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
3928
3928
  content: {
3929
3929
  text: string;
3930
3930
  } & {
@@ -4261,7 +4261,7 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
4261
4261
  label?: string | null | undefined;
4262
4262
  direction?: string | null | undefined;
4263
4263
  }) | ({
4264
- type: "image" | "em" | "embed" | "strong" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
4264
+ type: "em" | "embed" | "strong" | "image" | "list-item" | "paragraph" | "rtl" | "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "preformatted" | "hyperlink" | "o-list-item";
4265
4265
  content: {
4266
4266
  text: string;
4267
4267
  } & {
package/dist/core/service/onboarding.d.ts CHANGED
@@ -1,54 +1,50 @@
1
1
  /// <reference types="react" />
2
2
  import { z } from "zod";
3
3
  import { type AuthStrategy } from "../../EditorConfig";
4
- declare const onboardingStepIds: readonly ["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"];
5
- export declare const onboardingStepIdSchema: z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>;
6
- export type OnboardingStepId = typeof onboardingStepIds[number];
7
4
  export interface OnboardingStep {
8
- id: OnboardingStepId;
5
+ id: string;
9
6
  title: string;
10
7
  description: string;
11
8
  content?: JSX.Element;
12
9
  videoUrl?: string;
13
10
  defaultCompleted?: boolean;
14
11
  }
15
- declare const onboardingFrameworks: readonly ["next", "nuxt", "sveltekit", "other"];
16
- export type OnboardingFramework = typeof onboardingFrameworks[number];
17
12
  export declare const onboardingStateSchema: z.ZodObject<{
18
- completedSteps: z.ZodArray<z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
13
+ completedSteps: z.ZodArray<z.ZodString, "many">;
19
14
  isDismissed: z.ZodBoolean;
20
15
  context: z.ZodObject<{
21
- framework: z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>;
16
+ framework: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodEnum<["next", "nuxt", "sveltekit", "other"]>, "next" | "nuxt" | "sveltekit" | "other", unknown>>>;
22
17
  starterId: z.ZodNullable<z.ZodString>;
23
18
  }, "strip", z.ZodTypeAny, {
24
19
  framework: "next" | "nuxt" | "sveltekit" | "other";
25
20
  starterId: string | null;
26
21
  }, {
27
- framework: "next" | "nuxt" | "sveltekit" | "other";
28
22
  starterId: string | null;
23
+ framework?: unknown;
29
24
  }>;
30
25
  }, "strip", z.ZodTypeAny, {
31
- completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
26
+ completedSteps: string[];
32
27
  isDismissed: boolean;
33
28
  context: {
34
29
  framework: "next" | "nuxt" | "sveltekit" | "other";
35
30
  starterId: string | null;
36
31
  };
37
32
  }, {
38
- completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
33
+ completedSteps: string[];
39
34
  isDismissed: boolean;
40
35
  context: {
41
- framework: "next" | "nuxt" | "sveltekit" | "other";
42
36
  starterId: string | null;
37
+ framework?: unknown;
43
38
  };
44
39
  }>;
45
40
  export type OnboardingState = z.infer<typeof onboardingStateSchema>;
41
+ export type OnboardingFramework = OnboardingState["context"]["framework"];
46
42
  export declare const onboardingToggleStepResultSchema: z.ZodObject<{
47
- completedSteps: z.ZodArray<z.ZodEnum<["createPrismicProject", "chooseLocale", "createProject", "setupSliceMachine", "createPageType", "codePage", "createSlice", "reviewAndPush", "createContent", "renderPage"]>, "many">;
43
+ completedSteps: z.ZodArray<z.ZodString, "many">;
48
44
  }, "strip", z.ZodTypeAny, {
49
- completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
45
+ completedSteps: string[];
50
46
  }, {
51
- completedSteps: ("createPrismicProject" | "chooseLocale" | "createProject" | "setupSliceMachine" | "createPageType" | "codePage" | "createSlice" | "reviewAndPush" | "createContent" | "renderPage")[];
47
+ completedSteps: string[];
52
48
  }>;
53
49
  export type OnboardingToggleStepResult = z.infer<typeof onboardingToggleStepResultSchema>;
54
50
  export declare const onboardingToggleResultSchema: z.ZodObject<{
@@ -60,17 +56,17 @@ export declare const onboardingToggleResultSchema: z.ZodObject<{
60
56
  }>;
61
57
  export type OnboardingToggleResult = z.infer<typeof onboardingToggleResultSchema>;
62
58
  export declare function getOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingState>;
63
- export declare function toggleOnboardingStep(stepId: OnboardingStepId, baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleStepResult>;
59
+ export declare function toggleOnboardingStep(stepId: string, baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleStepResult>;
64
60
  export declare function toggleOnboarding(baseUrl: URL, repository: string, authStrategy: AuthStrategy): Promise<OnboardingToggleResult>;
65
61
  export type OnboardingTrackSource = "PageBuilder" | "SliceMachine";
66
62
  export type OnboardingTrackEvent = {
67
63
  event: "shared-onboarding:step-completed";
68
- stepId: OnboardingStepId;
64
+ stepId: string;
69
65
  stepTitle: string;
70
66
  source: OnboardingTrackSource;
71
67
  } | {
72
68
  event: "shared-onboarding:step-opened";
73
- stepId: OnboardingStepId;
69
+ stepId: string;
74
70
  stepTitle: string;
75
71
  source: OnboardingTrackSource;
76
72
  } | {
@@ -81,4 +77,3 @@ export interface OnboardingTracking {
81
77
  track: (args: OnboardingTrackEvent) => void | Promise<void>;
82
78
  source: OnboardingTrackSource;
83
79
  }
84
- export {};