@adobe/helix-config-storage 2.2.0 → 2.2.1
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.
- package/CHANGELOG.md +7 -0
- package/package.json +2 -2
- package/src/schemas/sidekick.schema.json +154 -56
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## [2.2.1](https://github.com/adobe/helix-config-storage/compare/v2.2.0...v2.2.1) (2025-04-29)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* **deps:** update dependency @adobe/helix-shared-config to v11.1.4 ([#118](https://github.com/adobe/helix-config-storage/issues/118)) ([1c5893b](https://github.com/adobe/helix-config-storage/commit/1c5893b2dac59c9bc091d5ae278d54619e609a54))
|
|
7
|
+
|
|
1
8
|
# [2.2.0](https://github.com/adobe/helix-config-storage/compare/v2.1.7...v2.2.0) (2025-04-22)
|
|
2
9
|
|
|
3
10
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adobe/helix-config-storage",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.1",
|
|
4
4
|
"description": "Helix Config Storage",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"types": "src/index.d.ts",
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
},
|
|
61
61
|
"dependencies": {
|
|
62
62
|
"@adobe/fetch": "4.2.0",
|
|
63
|
-
"@adobe/helix-shared-config": "11.1.
|
|
63
|
+
"@adobe/helix-shared-config": "11.1.4",
|
|
64
64
|
"@adobe/helix-shared-git": "3.0.18",
|
|
65
65
|
"@adobe/helix-shared-storage": "1.3.0",
|
|
66
66
|
"@adobe/helix-shared-string": "2.1.0",
|
|
@@ -6,17 +6,25 @@
|
|
|
6
6
|
"sidekickPlugin": {
|
|
7
7
|
"type": "object",
|
|
8
8
|
"properties": {
|
|
9
|
-
"
|
|
10
|
-
"type": "string",
|
|
11
|
-
"description": "The unique plugin ID"
|
|
12
|
-
},
|
|
13
|
-
"title": {
|
|
14
|
-
"type": "string",
|
|
15
|
-
"description": "The button text"
|
|
16
|
-
},
|
|
17
|
-
"url": {
|
|
9
|
+
"badgeVariant": {
|
|
18
10
|
"type": "string",
|
|
19
|
-
"description": "The
|
|
11
|
+
"description": "The variant of the badge following the Adobe Spectrum badge variants",
|
|
12
|
+
"enum": [
|
|
13
|
+
"gray",
|
|
14
|
+
"red",
|
|
15
|
+
"orange",
|
|
16
|
+
"yellow",
|
|
17
|
+
"chartreuse",
|
|
18
|
+
"celery",
|
|
19
|
+
"green",
|
|
20
|
+
"seafoam",
|
|
21
|
+
"cyan",
|
|
22
|
+
"blue",
|
|
23
|
+
"indigo",
|
|
24
|
+
"purple",
|
|
25
|
+
"fuchsia",
|
|
26
|
+
"magenta"
|
|
27
|
+
]
|
|
20
28
|
},
|
|
21
29
|
"containerId": {
|
|
22
30
|
"type": "string",
|
|
@@ -26,7 +34,16 @@
|
|
|
26
34
|
"type": "array",
|
|
27
35
|
"items": {
|
|
28
36
|
"type": "string",
|
|
29
|
-
"enum": [
|
|
37
|
+
"enum": [
|
|
38
|
+
"any",
|
|
39
|
+
"dev",
|
|
40
|
+
"admin",
|
|
41
|
+
"edit",
|
|
42
|
+
"preview",
|
|
43
|
+
"review",
|
|
44
|
+
"live",
|
|
45
|
+
"prod"
|
|
46
|
+
]
|
|
30
47
|
},
|
|
31
48
|
"description": "The environments to display this plugin in",
|
|
32
49
|
"default": "any"
|
|
@@ -40,43 +57,73 @@
|
|
|
40
57
|
"items": {
|
|
41
58
|
"type": "string"
|
|
42
59
|
},
|
|
43
|
-
"description": "
|
|
60
|
+
"description": "Excludes the plugin from these paths",
|
|
44
61
|
"examples": [
|
|
45
62
|
"/foo/**",
|
|
46
63
|
"**/:x:**"
|
|
47
64
|
]
|
|
48
65
|
},
|
|
66
|
+
"id": {
|
|
67
|
+
"type": "string",
|
|
68
|
+
"description": "The unique plugin ID"
|
|
69
|
+
},
|
|
49
70
|
"includePaths": {
|
|
50
71
|
"type": "array",
|
|
51
72
|
"items": {
|
|
52
73
|
"type": "string"
|
|
53
74
|
},
|
|
54
|
-
"description": "
|
|
75
|
+
"description": "Includes the plugin on these paths (overrides excludePaths)",
|
|
55
76
|
"examples": [
|
|
56
77
|
"/foo/bar/**",
|
|
57
78
|
"**.docx**"
|
|
58
79
|
]
|
|
59
80
|
},
|
|
81
|
+
"isBadge": {
|
|
82
|
+
"type": "boolean",
|
|
83
|
+
"description": "Renders the plugin as a badge"
|
|
84
|
+
},
|
|
60
85
|
"isContainer": {
|
|
61
86
|
"type": "boolean",
|
|
62
|
-
"description": "
|
|
87
|
+
"description": "Renders the plugin as a container for other plugins"
|
|
63
88
|
},
|
|
64
89
|
"isPalette": {
|
|
65
90
|
"type": "boolean",
|
|
66
91
|
"description": "Opens the URL in a palette instead of a new tab"
|
|
67
92
|
},
|
|
93
|
+
"isPopover": {
|
|
94
|
+
"type": "boolean",
|
|
95
|
+
"description": "Opens the URL in a popover instead of a new tab"
|
|
96
|
+
},
|
|
68
97
|
"paletteRect": {
|
|
69
98
|
"type": "string",
|
|
70
|
-
"description": "
|
|
99
|
+
"description": "The dimensions and position of the palette (top, left, bottom, right, width, height)",
|
|
100
|
+
"examples": [
|
|
101
|
+
"top: 100px; right: 20px; width: 200px; height: 50vh"
|
|
102
|
+
]
|
|
71
103
|
},
|
|
72
|
-
"
|
|
104
|
+
"passConfig": {
|
|
73
105
|
"type": "boolean",
|
|
74
|
-
"description": "
|
|
106
|
+
"description": "Append ref, repo, owner, host, and project as query params to the URL"
|
|
107
|
+
},
|
|
108
|
+
"passReferrer": {
|
|
109
|
+
"type": "boolean",
|
|
110
|
+
"description": "Append the referrer URL as a query param to the URL"
|
|
111
|
+
},
|
|
112
|
+
"pinned": {
|
|
113
|
+
"type": "boolean",
|
|
114
|
+
"description": "Renders the plugin in the bar (true, default) or the menu (false)"
|
|
75
115
|
},
|
|
76
116
|
"popoverRect": {
|
|
77
117
|
"type": "string",
|
|
78
|
-
"description": "The dimensions of
|
|
79
|
-
|
|
118
|
+
"description": "The dimensions of the popover (width, height)",
|
|
119
|
+
"examples": [
|
|
120
|
+
"width: 400px; height: 300px"
|
|
121
|
+
]
|
|
122
|
+
},
|
|
123
|
+
"title": {
|
|
124
|
+
"type": "string",
|
|
125
|
+
"description": "The button text"
|
|
126
|
+
},
|
|
80
127
|
"titleI18n": {
|
|
81
128
|
"type": "object",
|
|
82
129
|
"description": "The button text in other supported languages",
|
|
@@ -89,59 +136,110 @@
|
|
|
89
136
|
"minProperties": 1,
|
|
90
137
|
"additionalProperties": false
|
|
91
138
|
},
|
|
92
|
-
"
|
|
93
|
-
"type": "
|
|
94
|
-
"description": "
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
139
|
+
"url": {
|
|
140
|
+
"type": "string",
|
|
141
|
+
"description": "The URL to open when the button is clicked"
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
"required": [
|
|
145
|
+
"id"
|
|
146
|
+
],
|
|
147
|
+
"dependentRequired": {
|
|
148
|
+
"isPalette": [
|
|
149
|
+
"url"
|
|
150
|
+
],
|
|
151
|
+
"paletteRect": [
|
|
152
|
+
"isPalette"
|
|
153
|
+
],
|
|
154
|
+
"isPopover": [
|
|
155
|
+
"url"
|
|
156
|
+
],
|
|
157
|
+
"popoverRect": [
|
|
158
|
+
"isPopover"
|
|
159
|
+
],
|
|
160
|
+
"badgeVariant": [
|
|
161
|
+
"isBadge"
|
|
162
|
+
]
|
|
163
|
+
},
|
|
164
|
+
"additionalProperties": false
|
|
165
|
+
},
|
|
166
|
+
"sidekickSpecialView": {
|
|
167
|
+
"type": "object",
|
|
168
|
+
"properties": {
|
|
169
|
+
"id": {
|
|
170
|
+
"type": "string",
|
|
171
|
+
"description": "The unique view ID"
|
|
99
172
|
},
|
|
100
|
-
"
|
|
101
|
-
"type": "
|
|
102
|
-
"description": "
|
|
173
|
+
"path": {
|
|
174
|
+
"type": "string",
|
|
175
|
+
"description": "Open the special view on this path",
|
|
176
|
+
"examples": [
|
|
177
|
+
"/foo/**.json"
|
|
178
|
+
]
|
|
103
179
|
},
|
|
104
|
-
"
|
|
180
|
+
"viewer": {
|
|
105
181
|
"type": "string",
|
|
106
|
-
"description": "The
|
|
107
|
-
"
|
|
108
|
-
"
|
|
109
|
-
"red",
|
|
110
|
-
"orange",
|
|
111
|
-
"yellow",
|
|
112
|
-
"chartreuse",
|
|
113
|
-
"celery",
|
|
114
|
-
"green",
|
|
115
|
-
"seafoam",
|
|
116
|
-
"cyan",
|
|
117
|
-
"blue",
|
|
118
|
-
"indigo",
|
|
119
|
-
"purple",
|
|
120
|
-
"fuchsia",
|
|
121
|
-
"magenta"
|
|
182
|
+
"description": "The URL of the special view. The resource path will be passed to it via 'path' parameter",
|
|
183
|
+
"examples": [
|
|
184
|
+
"/tools/sidekick/foo/index.html"
|
|
122
185
|
]
|
|
123
186
|
}
|
|
124
187
|
},
|
|
125
188
|
"required": [
|
|
126
|
-
"id"
|
|
189
|
+
"id",
|
|
190
|
+
"path",
|
|
191
|
+
"viewer"
|
|
127
192
|
],
|
|
128
|
-
"
|
|
129
|
-
"isPalette": ["url"],
|
|
130
|
-
"paletteRect": ["isPalette"],
|
|
131
|
-
"isPopover": ["url"],
|
|
132
|
-
"popoverRect": ["isPopover"],
|
|
133
|
-
"badgeVariant": ["isBadge"]
|
|
134
|
-
}
|
|
193
|
+
"additionalProperties": false
|
|
135
194
|
}
|
|
136
195
|
},
|
|
137
196
|
"title": "Sidekick Config",
|
|
138
197
|
"type": "object",
|
|
139
198
|
"properties": {
|
|
199
|
+
"editUrlLabel": {
|
|
200
|
+
"type": "string",
|
|
201
|
+
"description": "The label of the custom editing environment."
|
|
202
|
+
},
|
|
203
|
+
"editUrlPattern": {
|
|
204
|
+
"type": "string",
|
|
205
|
+
"description": "The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}."
|
|
206
|
+
},
|
|
207
|
+
"host": {
|
|
208
|
+
"type": "string",
|
|
209
|
+
"format": "hostname",
|
|
210
|
+
"description": "The host name of the production website (overrides cdn.prod.host)"
|
|
211
|
+
},
|
|
212
|
+
"liveHost": {
|
|
213
|
+
"type": "string",
|
|
214
|
+
"format": "hostname",
|
|
215
|
+
"description": "The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)"
|
|
216
|
+
},
|
|
140
217
|
"plugins": {
|
|
141
218
|
"type": "array",
|
|
142
219
|
"items": {
|
|
143
220
|
"$ref": "#/definitions/sidekickPlugin"
|
|
144
221
|
}
|
|
222
|
+
},
|
|
223
|
+
"previewHost": {
|
|
224
|
+
"type": "string",
|
|
225
|
+
"format": "hostname",
|
|
226
|
+
"description": "The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)"
|
|
227
|
+
},
|
|
228
|
+
"project": {
|
|
229
|
+
"type": "string",
|
|
230
|
+
"description": "The name of the project to display in the sidekick"
|
|
231
|
+
},
|
|
232
|
+
"reviewHost": {
|
|
233
|
+
"type": "string",
|
|
234
|
+
"format": "hostname",
|
|
235
|
+
"description": "The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)"
|
|
236
|
+
},
|
|
237
|
+
"specialViews": {
|
|
238
|
+
"type": "array",
|
|
239
|
+
"items": {
|
|
240
|
+
"$ref": "#/definitions/sidekickSpecialView"
|
|
241
|
+
}
|
|
145
242
|
}
|
|
146
|
-
}
|
|
147
|
-
|
|
243
|
+
},
|
|
244
|
+
"additionalProperties": false
|
|
245
|
+
}
|