@dani-builder/strapi-client 0.2.0 → 0.4.0

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 (101) hide show
  1. package/AGENTS.md +9 -5
  2. package/LICENSE +21 -0
  3. package/README.md +50 -0
  4. package/dist/api/articles.d.ts +3 -0
  5. package/dist/api/articles.d.ts.map +1 -1
  6. package/dist/api/articles.js +8 -5
  7. package/dist/api/articles.js.map +1 -1
  8. package/dist/api/authors.d.ts +2 -0
  9. package/dist/api/authors.d.ts.map +1 -1
  10. package/dist/api/authors.js +5 -2
  11. package/dist/api/authors.js.map +1 -1
  12. package/dist/api/categories.d.ts +2 -0
  13. package/dist/api/categories.d.ts.map +1 -1
  14. package/dist/api/categories.js +4 -1
  15. package/dist/api/categories.js.map +1 -1
  16. package/dist/api/faqs.d.ts +2 -0
  17. package/dist/api/faqs.d.ts.map +1 -1
  18. package/dist/api/faqs.js +4 -1
  19. package/dist/api/faqs.js.map +1 -1
  20. package/dist/api/global.js +1 -1
  21. package/dist/api/global.js.map +1 -1
  22. package/dist/api/inquiry.js +1 -1
  23. package/dist/api/inquiry.js.map +1 -1
  24. package/dist/api/navigation.js +1 -1
  25. package/dist/api/navigation.js.map +1 -1
  26. package/dist/api/pages.d.ts +9 -1
  27. package/dist/api/pages.d.ts.map +1 -1
  28. package/dist/api/pages.js +26 -9
  29. package/dist/api/pages.js.map +1 -1
  30. package/dist/api/series.d.ts +2 -0
  31. package/dist/api/series.d.ts.map +1 -1
  32. package/dist/api/series.js +5 -2
  33. package/dist/api/series.js.map +1 -1
  34. package/dist/api/site-settings.js +1 -1
  35. package/dist/api/site-settings.js.map +1 -1
  36. package/dist/api/tags.d.ts +2 -0
  37. package/dist/api/tags.d.ts.map +1 -1
  38. package/dist/api/tags.js +4 -1
  39. package/dist/api/tags.js.map +1 -1
  40. package/dist/client/create-client.d.ts +7 -3
  41. package/dist/client/create-client.d.ts.map +1 -1
  42. package/dist/client/create-client.js +13 -5
  43. package/dist/client/create-client.js.map +1 -1
  44. package/dist/client/index.d.ts +2 -2
  45. package/dist/client/index.d.ts.map +1 -1
  46. package/dist/client/index.js +1 -1
  47. package/dist/client/index.js.map +1 -1
  48. package/dist/index.d.ts +7 -7
  49. package/dist/index.d.ts.map +1 -1
  50. package/dist/index.js +4 -4
  51. package/dist/index.js.map +1 -1
  52. package/dist/populate/builders.d.ts +12 -0
  53. package/dist/populate/builders.d.ts.map +1 -1
  54. package/dist/populate/builders.js +10 -0
  55. package/dist/populate/builders.js.map +1 -1
  56. package/dist/populate/core-blocks.d.ts.map +1 -1
  57. package/dist/populate/core-blocks.js +15 -9
  58. package/dist/populate/core-blocks.js.map +1 -1
  59. package/dist/types/components/blocks.d.ts +12 -11
  60. package/dist/types/components/blocks.d.ts.map +1 -1
  61. package/dist/types/components/index.d.ts +1 -1
  62. package/dist/types/components/index.d.ts.map +1 -1
  63. package/dist/types/components/shared.d.ts +14 -3
  64. package/dist/types/components/shared.d.ts.map +1 -1
  65. package/dist/types/components/shared.js +1 -1
  66. package/dist/types/content-types/article.d.ts +3 -1
  67. package/dist/types/content-types/article.d.ts.map +1 -1
  68. package/dist/types/content-types/article.js +1 -1
  69. package/dist/types/content-types/article.js.map +1 -1
  70. package/dist/types/content-types/author.js +1 -1
  71. package/dist/types/content-types/author.js.map +1 -1
  72. package/dist/types/content-types/category.js +1 -1
  73. package/dist/types/content-types/category.js.map +1 -1
  74. package/dist/types/content-types/faq.js +1 -1
  75. package/dist/types/content-types/faq.js.map +1 -1
  76. package/dist/types/content-types/global.js +1 -1
  77. package/dist/types/content-types/global.js.map +1 -1
  78. package/dist/types/content-types/inquiry.js +1 -1
  79. package/dist/types/content-types/inquiry.js.map +1 -1
  80. package/dist/types/content-types/navigation.js +1 -1
  81. package/dist/types/content-types/navigation.js.map +1 -1
  82. package/dist/types/content-types/page.d.ts +12 -3
  83. package/dist/types/content-types/page.d.ts.map +1 -1
  84. package/dist/types/content-types/page.js +1 -1
  85. package/dist/types/content-types/page.js.map +1 -1
  86. package/dist/types/content-types/series.js +1 -1
  87. package/dist/types/content-types/series.js.map +1 -1
  88. package/dist/types/content-types/site-settings.js +1 -1
  89. package/dist/types/content-types/site-settings.js.map +1 -1
  90. package/dist/types/content-types/tag.js +1 -1
  91. package/dist/types/content-types/tag.js.map +1 -1
  92. package/dist/types/index.d.ts +2 -2
  93. package/dist/types/index.d.ts.map +1 -1
  94. package/dist/types/strapi.d.ts +10 -0
  95. package/dist/types/strapi.d.ts.map +1 -1
  96. package/docs/api-guide.md +22 -22
  97. package/docs/block-reference.md +147 -554
  98. package/docs/components.md +234 -0
  99. package/docs/content-types.md +173 -382
  100. package/docs/elements.md +50 -0
  101. package/package.json +25 -8
@@ -0,0 +1,234 @@
1
+ ---
2
+ type: reference
3
+ status: current
4
+ generated: true
5
+ generator: .claude/skills/docs-steward/scripts/gen-reference.mjs
6
+ sources:
7
+ - packages/strapi-plugin-builder/server/src/components/shared/*.json
8
+ ---
9
+
10
+ <!-- DO NOT EDIT. Run `pnpm docs:gen` after changing the schemas. -->
11
+
12
+ # Shared Components
13
+
14
+ Reusable sub-components referenced by blocks and content types.
15
+
16
+ ## Quick reference
17
+
18
+ | Component | `__component` | Variants |
19
+ |---|---|---|
20
+ | Analytics Setting | `shared.analytics-setting` | — |
21
+ | Bento Item | `shared.bento-item` | — |
22
+ | Brand Colors | `shared.brand-colors` | — |
23
+ | Chatbot Setting | `shared.chatbot-setting` | — |
24
+ | Feature Item | `shared.feature-item` | — |
25
+ | Highlight Item | `shared.highlight-item` | — |
26
+ | Image | `shared.image` | — |
27
+ | Link | `shared.link` | — |
28
+ | Logo Item | `shared.logo-item` | — |
29
+ | Navigation Group | `shared.navigation-group` | — |
30
+ | Pricing Tier | `shared.pricing-tier` | — |
31
+ | SEO | `shared.seo` | — |
32
+ | Site Verification | `shared.site-verification` | — |
33
+ | Slider Item | `shared.slider-item` | — |
34
+ | Stat Item | `shared.stat-item` | — |
35
+ | Team Member | `shared.team-member` | — |
36
+ | Testimonial Item | `shared.testimonial-item` | — |
37
+
38
+ ## Analytics Setting
39
+
40
+ `shared.analytics-setting` — Web analytics tool configuration
41
+
42
+ | Attribute | Type | Required | Default | Notes |
43
+ |---|---|---|---|---|
44
+ | `provider` | enumeration | yes | — | `google-tag-manager`, `google-analytics`, `matomo` |
45
+ | `trackingId` | string | yes | — | — |
46
+ | `customDomain` | string | — | — | — |
47
+ | `enabled` | boolean | — | `true` | — |
48
+
49
+ ## Bento Item
50
+
51
+ `shared.bento-item` — Bento grid item with span control and optional link
52
+
53
+ | Attribute | Type | Required | Default | Notes |
54
+ |---|---|---|---|---|
55
+ | `title` | string | — | — | — |
56
+ | `description` | text | — | — | — |
57
+ | `image` | component `shared.image` | — | — | — |
58
+ | `icon` | customField | — | — | custom field `plugin::icon-picker.icon` |
59
+ | `colSpan` | integer | — | `1` | — |
60
+ | `rowSpan` | integer | — | `1` | — |
61
+ | `link` | component `shared.link` | — | — | — |
62
+
63
+ ## Brand Colors
64
+
65
+ `shared.brand-colors` — Brand color overrides for the site theme
66
+
67
+ | Attribute | Type | Required | Default | Notes |
68
+ |---|---|---|---|---|
69
+ | `primary` | string | — | — | custom field `plugin::color-picker.color` |
70
+ | `primaryLight` | string | — | — | custom field `plugin::color-picker.color` |
71
+ | `cta` | string | — | — | custom field `plugin::color-picker.color` |
72
+ | `ctaHover` | string | — | — | custom field `plugin::color-picker.color` |
73
+ | `background` | string | — | — | custom field `plugin::color-picker.color` |
74
+ | `text` | string | — | — | custom field `plugin::color-picker.color` |
75
+ | `textMuted` | string | — | — | custom field `plugin::color-picker.color` |
76
+
77
+ ## Chatbot Setting
78
+
79
+ `shared.chatbot-setting` — Chatbot integration configuration
80
+
81
+ | Attribute | Type | Required | Default | Notes |
82
+ |---|---|---|---|---|
83
+ | `provider` | enumeration | yes | — | `channel-talk`, `zendesk`, `intercom` |
84
+ | `appId` | string | yes | — | — |
85
+ | `key` | string | — | — | — |
86
+ | `secret` | string | — | — | — |
87
+
88
+ ## Feature Item
89
+
90
+ `shared.feature-item` — Feature item with icon, label, description, and link
91
+
92
+ | Attribute | Type | Required | Default | Notes |
93
+ |---|---|---|---|---|
94
+ | `label` | string | — | — | — |
95
+ | `description` | richtext | — | — | — |
96
+ | `icon` | customField | — | — | custom field `plugin::icon-picker.icon` |
97
+ | `infoText` | string | — | — | — |
98
+ | `link` | component `shared.link` | — | — | — |
99
+
100
+ ## Highlight Item
101
+
102
+ `shared.highlight-item` — Highlight item with required media, label, description, and link
103
+
104
+ | Attribute | Type | Required | Default | Notes |
105
+ |---|---|---|---|---|
106
+ | `label` | string | — | — | — |
107
+ | `description` | richtext | — | — | — |
108
+ | `image` | component `shared.image` | yes | — | — |
109
+ | `link` | component `shared.link` | — | — | — |
110
+
111
+ ## Image
112
+
113
+ `shared.image` — Informational image with per-usage fit control and localized alt override
114
+
115
+ | Attribute | Type | Required | Default | Notes |
116
+ |---|---|---|---|---|
117
+ | `media` | media (single) | yes | — | allowed: images, videos |
118
+ | `alt` | string | — | — | — |
119
+ | `fit` | enumeration | — | `auto` | `auto`, `cover`, `contain` |
120
+
121
+ ## Link
122
+
123
+ `shared.link` — Link with label, URL, icon, and new window option
124
+
125
+ | Attribute | Type | Required | Default | Notes |
126
+ |---|---|---|---|---|
127
+ | `label` | string | yes | — | maxLength 80 |
128
+ | `href` | string | yes | — | — |
129
+ | `newWindow` | boolean | — | `false` | — |
130
+ | `icon` | customField | — | — | custom field `plugin::icon-picker.icon` |
131
+
132
+ ## Logo Item
133
+
134
+ `shared.logo-item` — Company/partner logo with optional link
135
+
136
+ | Attribute | Type | Required | Default | Notes |
137
+ |---|---|---|---|---|
138
+ | `logo` | media (single) | yes | — | allowed: images |
139
+ | `companyName` | string | — | — | — |
140
+ | `link` | component `shared.link` | — | — | — |
141
+
142
+ ## Navigation Group
143
+
144
+ `shared.navigation-group` — Navigation group with label and child links
145
+
146
+ | Attribute | Type | Required | Default | Notes |
147
+ |---|---|---|---|---|
148
+ | `label` | string | — | — | — |
149
+ | `href` | string | — | — | — |
150
+ | `links` | component `shared.link` (repeatable) | — | — | — |
151
+
152
+ ## Pricing Tier
153
+
154
+ `shared.pricing-tier` — Pricing plan with name, price, features, and CTA
155
+
156
+ | Attribute | Type | Required | Default | Notes |
157
+ |---|---|---|---|---|
158
+ | `planName` | string | yes | — | — |
159
+ | `price` | string | yes | — | — |
160
+ | `billingPeriod` | string | — | — | — |
161
+ | `description` | text | — | — | — |
162
+ | `featureList` | richtext | — | — | — |
163
+ | `ctaLink` | component `shared.link` | — | — | — |
164
+ | `highlighted` | boolean | — | `false` | — |
165
+
166
+ ## SEO
167
+
168
+ `shared.seo` — SEO meta tags and structured data
169
+
170
+ | Attribute | Type | Required | Default | Notes |
171
+ |---|---|---|---|---|
172
+ | `metaTitle` | string | — | — | maxLength 120 |
173
+ | `metaDescription` | text | — | — | — |
174
+ | `ogImage` | media (single) | — | — | allowed: images |
175
+ | `canonicalURL` | string | — | — | — |
176
+ | `noindex` | boolean | — | `false` | — |
177
+ | `nofollow` | boolean | — | `false` | — |
178
+ | `structuredData` | json | — | — | — |
179
+
180
+ ## Site Verification
181
+
182
+ `shared.site-verification` — Search engine site verification
183
+
184
+ | Attribute | Type | Required | Default | Notes |
185
+ |---|---|---|---|---|
186
+ | `service` | enumeration | yes | — | `google`, `bing`, `naver`, `custom` |
187
+ | `name` | string | — | — | — |
188
+ | `content` | string | yes | — | — |
189
+
190
+ ## Slider Item
191
+
192
+ `shared.slider-item` — Slider carousel item with required media, label, and link
193
+
194
+ | Attribute | Type | Required | Default | Notes |
195
+ |---|---|---|---|---|
196
+ | `label` | string | — | — | — |
197
+ | `description` | text | — | — | — |
198
+ | `link` | component `shared.link` | — | — | — |
199
+ | `image` | component `shared.image` | yes | — | — |
200
+
201
+ ## Stat Item
202
+
203
+ `shared.stat-item` — Metric item with value, label, and description
204
+
205
+ | Attribute | Type | Required | Default | Notes |
206
+ |---|---|---|---|---|
207
+ | `value` | string | yes | — | — |
208
+ | `label` | string | — | — | — |
209
+ | `description` | text | — | — | — |
210
+
211
+ ## Team Member
212
+
213
+ `shared.team-member` — Team member with name, role, bio, photo, and social links
214
+
215
+ | Attribute | Type | Required | Default | Notes |
216
+ |---|---|---|---|---|
217
+ | `memberName` | string | yes | — | — |
218
+ | `role` | string | — | — | — |
219
+ | `bio` | text | — | — | — |
220
+ | `photo` | media (single) | — | — | allowed: images |
221
+ | `socialLinks` | component `shared.link` (repeatable) | — | — | — |
222
+
223
+ ## Testimonial Item
224
+
225
+ `shared.testimonial-item` — Testimonial with quote, author info, and optional rating
226
+
227
+ | Attribute | Type | Required | Default | Notes |
228
+ |---|---|---|---|---|
229
+ | `quote` | text | yes | — | — |
230
+ | `authorName` | string | — | — | — |
231
+ | `authorRole` | string | — | — | — |
232
+ | `avatar` | media (single) | — | — | allowed: images |
233
+ | `logo` | media (single) | — | — | allowed: images |
234
+ | `rating` | integer | — | — | — |