@prismicio/vue 5.3.0-canary.4c3e4ab → 5.3.0-canary.553482e

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 (111) hide show
  1. package/dist/PrismicImage.vue.d.cts +10 -23
  2. package/dist/PrismicImage.vue.d.cts.map +1 -1
  3. package/dist/PrismicLink.vue.d.cts +11 -26
  4. package/dist/PrismicLink.vue.d.cts.map +1 -1
  5. package/dist/PrismicRichText/PrismicRichText.vue.d.cts +6 -10
  6. package/dist/PrismicRichText/PrismicRichText.vue.d.cts.map +1 -1
  7. package/dist/PrismicRichText/types.d.cts +25 -26
  8. package/dist/PrismicRichText/types.d.cts.map +1 -1
  9. package/dist/PrismicTable/PrismicTable.vue.d.cts +2 -6
  10. package/dist/PrismicTable/PrismicTable.vue.d.cts.map +1 -1
  11. package/dist/PrismicTable/types.d.cts +7 -8
  12. package/dist/PrismicTable/types.d.cts.map +1 -1
  13. package/dist/PrismicText.vue.d.cts +4 -8
  14. package/dist/PrismicText.vue.d.cts.map +1 -1
  15. package/dist/SliceZone/SliceZone.vue.d.cts +5 -11
  16. package/dist/SliceZone/SliceZone.vue.d.cts.map +1 -1
  17. package/dist/SliceZone/types.d.cts +3 -9
  18. package/dist/SliceZone/types.d.cts.map +1 -1
  19. package/dist/package.cjs +1 -1
  20. package/dist/package.cjs.map +1 -1
  21. package/dist/package.js +1 -1
  22. package/dist/package.js.map +1 -1
  23. package/dist/src/PrismicImage.cjs.map +1 -1
  24. package/dist/src/PrismicImage.js.map +1 -1
  25. package/dist/src/PrismicImage.vue.d.ts +10 -23
  26. package/dist/src/PrismicImage.vue.d.ts.map +1 -1
  27. package/dist/src/PrismicImage.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  28. package/dist/src/PrismicImage.vue_vue_type_script_setup_true_lang.js.map +1 -1
  29. package/dist/src/PrismicLink.cjs.map +1 -1
  30. package/dist/src/PrismicLink.js.map +1 -1
  31. package/dist/src/PrismicLink.vue.d.ts +11 -26
  32. package/dist/src/PrismicLink.vue.d.ts.map +1 -1
  33. package/dist/src/PrismicLink.vue_vue_type_script_setup_true_lang.cjs +3 -9
  34. package/dist/src/PrismicLink.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  35. package/dist/src/PrismicLink.vue_vue_type_script_setup_true_lang.js +3 -9
  36. package/dist/src/PrismicLink.vue_vue_type_script_setup_true_lang.js.map +1 -1
  37. package/dist/src/PrismicRichText/PrismicRichText.cjs.map +1 -1
  38. package/dist/src/PrismicRichText/PrismicRichText.js.map +1 -1
  39. package/dist/src/PrismicRichText/PrismicRichText.vue.d.ts +2 -6
  40. package/dist/src/PrismicRichText/PrismicRichText.vue.d.ts.map +1 -1
  41. package/dist/src/PrismicRichText/PrismicRichText.vue_vue_type_script_setup_true_lang.cjs +2 -4
  42. package/dist/src/PrismicRichText/PrismicRichText.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  43. package/dist/src/PrismicRichText/PrismicRichText.vue_vue_type_script_setup_true_lang.js +2 -4
  44. package/dist/src/PrismicRichText/PrismicRichText.vue_vue_type_script_setup_true_lang.js.map +1 -1
  45. package/dist/src/PrismicRichText/PrismicRichTextDefaultComponent.cjs.map +1 -1
  46. package/dist/src/PrismicRichText/PrismicRichTextDefaultComponent.js.map +1 -1
  47. package/dist/src/PrismicRichText/PrismicRichTextDefaultComponent.vue_vue_type_script_setup_true_lang.cjs +2 -2
  48. package/dist/src/PrismicRichText/PrismicRichTextDefaultComponent.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  49. package/dist/src/PrismicRichText/PrismicRichTextDefaultComponent.vue_vue_type_script_setup_true_lang.js +2 -2
  50. package/dist/src/PrismicRichText/PrismicRichTextDefaultComponent.vue_vue_type_script_setup_true_lang.js.map +1 -1
  51. package/dist/src/PrismicRichText/PrismicRichTextSerialize.cjs.map +1 -1
  52. package/dist/src/PrismicRichText/PrismicRichTextSerialize.js.map +1 -1
  53. package/dist/src/PrismicRichText/PrismicRichTextSerialize.vue_vue_type_script_setup_true_lang.cjs +10 -4
  54. package/dist/src/PrismicRichText/PrismicRichTextSerialize.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  55. package/dist/src/PrismicRichText/PrismicRichTextSerialize.vue_vue_type_script_setup_true_lang.js +11 -5
  56. package/dist/src/PrismicRichText/PrismicRichTextSerialize.vue_vue_type_script_setup_true_lang.js.map +1 -1
  57. package/dist/src/PrismicRichText/types.d.ts +25 -26
  58. package/dist/src/PrismicRichText/types.d.ts.map +1 -1
  59. package/dist/src/PrismicTable/PrismicTable.cjs.map +1 -1
  60. package/dist/src/PrismicTable/PrismicTable.js.map +1 -1
  61. package/dist/src/PrismicTable/PrismicTable.vue.d.ts +4 -8
  62. package/dist/src/PrismicTable/PrismicTable.vue.d.ts.map +1 -1
  63. package/dist/src/PrismicTable/PrismicTable.vue_vue_type_script_setup_true_lang.cjs +8 -8
  64. package/dist/src/PrismicTable/PrismicTable.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  65. package/dist/src/PrismicTable/PrismicTable.vue_vue_type_script_setup_true_lang.js +8 -8
  66. package/dist/src/PrismicTable/PrismicTable.vue_vue_type_script_setup_true_lang.js.map +1 -1
  67. package/dist/src/PrismicTable/PrismicTableDefaultComponents.cjs +12 -30
  68. package/dist/src/PrismicTable/PrismicTableDefaultComponents.cjs.map +1 -1
  69. package/dist/src/PrismicTable/PrismicTableDefaultComponents.js +12 -30
  70. package/dist/src/PrismicTable/PrismicTableDefaultComponents.js.map +1 -1
  71. package/dist/src/PrismicTable/types.d.ts +7 -8
  72. package/dist/src/PrismicTable/types.d.ts.map +1 -1
  73. package/dist/src/PrismicText.cjs.map +1 -1
  74. package/dist/src/PrismicText.js.map +1 -1
  75. package/dist/src/PrismicText.vue.d.ts +4 -8
  76. package/dist/src/PrismicText.vue.d.ts.map +1 -1
  77. package/dist/src/PrismicText.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  78. package/dist/src/PrismicText.vue_vue_type_script_setup_true_lang.js.map +1 -1
  79. package/dist/src/SliceZone/SliceZone.cjs.map +1 -1
  80. package/dist/src/SliceZone/SliceZone.js.map +1 -1
  81. package/dist/src/SliceZone/SliceZone.vue.d.ts +5 -11
  82. package/dist/src/SliceZone/SliceZone.vue.d.ts.map +1 -1
  83. package/dist/src/SliceZone/SliceZone.vue_vue_type_script_setup_true_lang.cjs.map +1 -1
  84. package/dist/src/SliceZone/SliceZone.vue_vue_type_script_setup_true_lang.js.map +1 -1
  85. package/dist/src/SliceZone/types.d.ts +3 -9
  86. package/dist/src/SliceZone/types.d.ts.map +1 -1
  87. package/dist/src/lib/isInternalURL.cjs +2 -6
  88. package/dist/src/lib/isInternalURL.cjs.map +1 -1
  89. package/dist/src/lib/isInternalURL.js +2 -6
  90. package/dist/src/lib/isInternalURL.js.map +1 -1
  91. package/dist/src/types.cjs.map +1 -1
  92. package/dist/src/types.d.ts +11 -1
  93. package/dist/src/types.d.ts.map +1 -1
  94. package/dist/src/types.js.map +1 -1
  95. package/dist/types.d.cts +11 -1
  96. package/dist/types.d.cts.map +1 -1
  97. package/package.json +1 -3
  98. package/src/PrismicImage.vue +2 -6
  99. package/src/PrismicLink.vue +6 -18
  100. package/src/PrismicRichText/PrismicRichText.vue +13 -15
  101. package/src/PrismicRichText/PrismicRichTextDefaultComponent.vue +8 -4
  102. package/src/PrismicRichText/PrismicRichTextSerialize.vue +4 -3
  103. package/src/PrismicRichText/types.ts +57 -29
  104. package/src/PrismicTable/PrismicTable.vue +14 -18
  105. package/src/PrismicTable/PrismicTableDefaultComponents.ts +14 -39
  106. package/src/PrismicTable/types.ts +41 -23
  107. package/src/PrismicText.vue +2 -6
  108. package/src/SliceZone/SliceZone.vue +3 -9
  109. package/src/SliceZone/types.ts +3 -9
  110. package/src/lib/isInternalURL.ts +2 -6
  111. package/src/types.ts +13 -1
@@ -16,14 +16,10 @@ import { TODOSliceComponent } from "./TODOSliceComponent"
16
16
  * @typeParam TContext - Arbitrary data made available to all Slice components
17
17
  */
18
18
  export type SliceZoneProps<TContext = unknown> = {
19
- /**
20
- * List of slice data from the slice zone.
21
- */
19
+ /** List of slice data from the slice zone. */
22
20
  slices: SliceZoneLike<SliceLike | (SliceLike & Record<string, unknown>)>
23
21
 
24
- /**
25
- * A record mapping slice types to React components.
26
- */
22
+ /** A record mapping slice types to React components. */
27
23
  components?: SliceZoneComponents
28
24
 
29
25
  /**
@@ -33,9 +29,7 @@ export type SliceZoneProps<TContext = unknown> = {
33
29
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
34
30
  defaultComponent?: SliceComponentType<any, TContext>
35
31
 
36
- /**
37
- * Arbitrary data made available to all slice components.
38
- */
32
+ /** Arbitrary data made available to all slice components. */
39
33
  context?: TContext
40
34
  }
41
35
 
@@ -83,19 +83,13 @@ export type SliceComponentProps<
83
83
  TSlice extends SliceLike = SliceLike,
84
84
  TContext = unknown,
85
85
  > = {
86
- /**
87
- * Slice data for this component.
88
- */
86
+ /** Slice data for this component. */
89
87
  slice: TSlice
90
88
 
91
- /**
92
- * The index of the Slice in the Slice Zone.
93
- */
89
+ /** The index of the Slice in the Slice Zone. */
94
90
  index: number
95
91
 
96
- /**
97
- * All Slices from the Slice Zone to which the Slice belongs.
98
- */
92
+ /** All Slices from the Slice Zone to which the Slice belongs. */
99
93
  // TODO: We have to keep this list of Slices general due to circular
100
94
  // reference limtiations. If we had another generic to determine the full
101
95
  // union of Slice types, it would include TSlice. This causes TypeScript to
@@ -7,13 +7,9 @@
7
7
  */
8
8
  // TODO: This does not detect all relative URLs as internal, such as `about` or `./about`. This function assumes relative URLs start with a "/"`.
9
9
  export const isInternalURL = (url: string): boolean => {
10
- /**
11
- * @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1}
12
- */
10
+ /** @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1} */
13
11
  const isInternal = /^\/(?!\/)/.test(url)
14
- /**
15
- * @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1}
16
- */
12
+ /** @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1} */
17
13
  const isSpecialLink = !isInternal && !/^https?:\/\//i.test(url)
18
14
 
19
15
  return isInternal && !isSpecialLink
package/src/types.ts CHANGED
@@ -20,8 +20,20 @@ export type VueComponent<TProps> =
20
20
  | DefineComponent<TProps>
21
21
  | FunctionalComponent<TProps>
22
22
 
23
+ /**
24
+ * A shorthand definition for `<PrismicRichText />` and `<PrismicTable />`
25
+ * component types.
26
+ */
27
+ export type VueComponentShorthand = {
28
+ /** The HTML element type rendered for this node type. */
29
+ as?: string
30
+
31
+ /** Other attributes to apply to the element type. */
32
+ [Attribute: string]: string | boolean | null | undefined
33
+ }
34
+
23
35
  export const isVueComponent = <T>(
24
- component: VueComponent<T> | unknown,
36
+ component: VueComponent<T> | VueComponentShorthand | undefined,
25
37
  ): component is VueComponent<T> => {
26
38
  return (
27
39
  !!component &&