@xwiki/cristal-wiki-config-api 1.1.0-rc-1 → 1.1.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 (3) hide show
  1. package/package.json +4 -4
  2. package/temp/cristal-wiki-config-api.api.json +0 -329
  3. package/temp/cristal-wiki-config-api.api.md +0 -20
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xwiki/cristal-wiki-config-api",
3
- "version": "1.1.0-rc-1",
3
+ "version": "1.1.0",
4
4
  "license": "LGPL 2.1",
5
5
  "author": "XWiki Org Community <contact@xwiki.org>",
6
6
  "homepage": "https://cristal.xwiki.org/",
@@ -20,8 +20,8 @@
20
20
  },
21
21
  "types": "./dist/index.d.ts",
22
22
  "dependencies": {
23
- "@xwiki/platform-api": "18.1.0-rc-1",
24
- "@xwiki/platform-configuration-api": "18.1.0-rc-1"
23
+ "@xwiki/platform-api": "18.1.0",
24
+ "@xwiki/platform-configuration-api": "18.1.0"
25
25
  },
26
26
  "peerDependencies": {
27
27
  "reflect-metadata": "0.x",
@@ -30,7 +30,7 @@
30
30
  "devDependencies": {
31
31
  "typescript": "5.9.3",
32
32
  "vue": "3.5.28",
33
- "@xwiki/cristal-dev-config": "1.1.0-rc-1"
33
+ "@xwiki/cristal-dev-config": "1.1.0"
34
34
  },
35
35
  "scripts": {
36
36
  "api-extractor:local": "api-extractor run --local",
package/temp/cristal-wiki-config-api.api.json DELETED
@@ -1,329 +0,0 @@
1
- {
2
- "metadata": {
3
- "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.56.3",
5
- "schemaVersion": 1011,
6
- "oldestForwardsCompatibleVersion": 1001,
7
- "tsdocConfig": {
8
- "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9
- "noStandardTags": true,
10
- "tagDefinitions": [
11
- {
12
- "tagName": "@alpha",
13
- "syntaxKind": "modifier"
14
- },
15
- {
16
- "tagName": "@beta",
17
- "syntaxKind": "modifier"
18
- },
19
- {
20
- "tagName": "@defaultValue",
21
- "syntaxKind": "block"
22
- },
23
- {
24
- "tagName": "@decorator",
25
- "syntaxKind": "block",
26
- "allowMultiple": true
27
- },
28
- {
29
- "tagName": "@deprecated",
30
- "syntaxKind": "block"
31
- },
32
- {
33
- "tagName": "@eventProperty",
34
- "syntaxKind": "modifier"
35
- },
36
- {
37
- "tagName": "@example",
38
- "syntaxKind": "block",
39
- "allowMultiple": true
40
- },
41
- {
42
- "tagName": "@experimental",
43
- "syntaxKind": "modifier"
44
- },
45
- {
46
- "tagName": "@inheritDoc",
47
- "syntaxKind": "inline"
48
- },
49
- {
50
- "tagName": "@internal",
51
- "syntaxKind": "modifier"
52
- },
53
- {
54
- "tagName": "@label",
55
- "syntaxKind": "inline"
56
- },
57
- {
58
- "tagName": "@link",
59
- "syntaxKind": "inline",
60
- "allowMultiple": true
61
- },
62
- {
63
- "tagName": "@override",
64
- "syntaxKind": "modifier"
65
- },
66
- {
67
- "tagName": "@packageDocumentation",
68
- "syntaxKind": "modifier"
69
- },
70
- {
71
- "tagName": "@param",
72
- "syntaxKind": "block",
73
- "allowMultiple": true
74
- },
75
- {
76
- "tagName": "@privateRemarks",
77
- "syntaxKind": "block"
78
- },
79
- {
80
- "tagName": "@public",
81
- "syntaxKind": "modifier"
82
- },
83
- {
84
- "tagName": "@readonly",
85
- "syntaxKind": "modifier"
86
- },
87
- {
88
- "tagName": "@remarks",
89
- "syntaxKind": "block"
90
- },
91
- {
92
- "tagName": "@returns",
93
- "syntaxKind": "block"
94
- },
95
- {
96
- "tagName": "@sealed",
97
- "syntaxKind": "modifier"
98
- },
99
- {
100
- "tagName": "@see",
101
- "syntaxKind": "block"
102
- },
103
- {
104
- "tagName": "@throws",
105
- "syntaxKind": "block",
106
- "allowMultiple": true
107
- },
108
- {
109
- "tagName": "@typeParam",
110
- "syntaxKind": "block",
111
- "allowMultiple": true
112
- },
113
- {
114
- "tagName": "@virtual",
115
- "syntaxKind": "modifier"
116
- },
117
- {
118
- "tagName": "@jsx",
119
- "syntaxKind": "block"
120
- },
121
- {
122
- "tagName": "@jsxRuntime",
123
- "syntaxKind": "block"
124
- },
125
- {
126
- "tagName": "@jsxFrag",
127
- "syntaxKind": "block"
128
- },
129
- {
130
- "tagName": "@jsxImportSource",
131
- "syntaxKind": "block"
132
- },
133
- {
134
- "tagName": "@since",
135
- "syntaxKind": "block"
136
- }
137
- ],
138
- "supportForTags": {
139
- "@beta": true,
140
- "@deprecated": true,
141
- "@example": true,
142
- "@internal": true,
143
- "@link": true,
144
- "@param": true,
145
- "@public": true,
146
- "@returns": true,
147
- "@see": true,
148
- "@throws": true,
149
- "@since": true
150
- },
151
- "reportUnsupportedHtmlElements": false
152
- }
153
- },
154
- "kind": "Package",
155
- "canonicalReference": "@xwiki/cristal-wiki-config-api!",
156
- "docComment": "",
157
- "name": "@xwiki/cristal-wiki-config-api",
158
- "preserveMemberOrder": false,
159
- "members": [
160
- {
161
- "kind": "EntryPoint",
162
- "canonicalReference": "@xwiki/cristal-wiki-config-api!",
163
- "name": "",
164
- "preserveMemberOrder": false,
165
- "members": [
166
- {
167
- "kind": "Interface",
168
- "canonicalReference": "@xwiki/cristal-wiki-config-api!WikiConfigProxy:interface",
169
- "docComment": "/**\n * Service that provides a reactive proxy to handle changes in available WikiConfigs.\n *\n * @since\n *\n * 0.18\n *\n * @beta\n */\n",
170
- "excerptTokens": [
171
- {
172
- "kind": "Content",
173
- "text": "interface WikiConfigProxy "
174
- }
175
- ],
176
- "fileUrlPath": "src/index.ts",
177
- "releaseTag": "Beta",
178
- "name": "WikiConfigProxy",
179
- "preserveMemberOrder": false,
180
- "members": [
181
- {
182
- "kind": "MethodSignature",
183
- "canonicalReference": "@xwiki/cristal-wiki-config-api!WikiConfigProxy#deleteAvailableConfiguration:member(1)",
184
- "docComment": "/**\n * Delete a configuration from the set of available configurations and trigger a change in the internal Map.\n *\n * @param configName - the name of the configuration to delete\n */\n",
185
- "excerptTokens": [
186
- {
187
- "kind": "Content",
188
- "text": "deleteAvailableConfiguration(configName: "
189
- },
190
- {
191
- "kind": "Content",
192
- "text": "string"
193
- },
194
- {
195
- "kind": "Content",
196
- "text": "): "
197
- },
198
- {
199
- "kind": "Content",
200
- "text": "void"
201
- },
202
- {
203
- "kind": "Content",
204
- "text": ";"
205
- }
206
- ],
207
- "isOptional": false,
208
- "returnTypeTokenRange": {
209
- "startIndex": 3,
210
- "endIndex": 4
211
- },
212
- "releaseTag": "Beta",
213
- "overloadIndex": 1,
214
- "parameters": [
215
- {
216
- "parameterName": "configName",
217
- "parameterTypeTokenRange": {
218
- "startIndex": 1,
219
- "endIndex": 2
220
- },
221
- "isOptional": false
222
- }
223
- ],
224
- "name": "deleteAvailableConfiguration"
225
- },
226
- {
227
- "kind": "MethodSignature",
228
- "canonicalReference": "@xwiki/cristal-wiki-config-api!WikiConfigProxy#getAvailableConfigurations:member(1)",
229
- "docComment": "/**\n * Provide a reactive Map containing the currently available configurations.\n *\n * @returns the reactive Map\n */\n",
230
- "excerptTokens": [
231
- {
232
- "kind": "Content",
233
- "text": "getAvailableConfigurations(): "
234
- },
235
- {
236
- "kind": "Reference",
237
- "text": "Ref",
238
- "canonicalReference": "@vue/reactivity!Ref:interface"
239
- },
240
- {
241
- "kind": "Content",
242
- "text": "<"
243
- },
244
- {
245
- "kind": "Reference",
246
- "text": "Map",
247
- "canonicalReference": "!Map:interface"
248
- },
249
- {
250
- "kind": "Content",
251
- "text": "<string, "
252
- },
253
- {
254
- "kind": "Reference",
255
- "text": "WikiConfig",
256
- "canonicalReference": "@xwiki/platform-api!WikiConfig:interface"
257
- },
258
- {
259
- "kind": "Content",
260
- "text": ">>"
261
- },
262
- {
263
- "kind": "Content",
264
- "text": ";"
265
- }
266
- ],
267
- "isOptional": false,
268
- "returnTypeTokenRange": {
269
- "startIndex": 1,
270
- "endIndex": 7
271
- },
272
- "releaseTag": "Beta",
273
- "overloadIndex": 1,
274
- "parameters": [],
275
- "name": "getAvailableConfigurations"
276
- },
277
- {
278
- "kind": "MethodSignature",
279
- "canonicalReference": "@xwiki/cristal-wiki-config-api!WikiConfigProxy#setAvailableConfigurations:member(1)",
280
- "docComment": "/**\n * Add or replace configurations from the set of available configurations and trigger a change in the internal Map.\n *\n * @param config - the configurations to add or replace\n */\n",
281
- "excerptTokens": [
282
- {
283
- "kind": "Content",
284
- "text": "setAvailableConfigurations(config: "
285
- },
286
- {
287
- "kind": "Reference",
288
- "text": "Configurations",
289
- "canonicalReference": "@xwiki/platform-configuration-api!Configurations:type"
290
- },
291
- {
292
- "kind": "Content",
293
- "text": "): "
294
- },
295
- {
296
- "kind": "Content",
297
- "text": "void"
298
- },
299
- {
300
- "kind": "Content",
301
- "text": ";"
302
- }
303
- ],
304
- "isOptional": false,
305
- "returnTypeTokenRange": {
306
- "startIndex": 3,
307
- "endIndex": 4
308
- },
309
- "releaseTag": "Beta",
310
- "overloadIndex": 1,
311
- "parameters": [
312
- {
313
- "parameterName": "config",
314
- "parameterTypeTokenRange": {
315
- "startIndex": 1,
316
- "endIndex": 2
317
- },
318
- "isOptional": false
319
- }
320
- ],
321
- "name": "setAvailableConfigurations"
322
- }
323
- ],
324
- "extendsTokenRanges": []
325
- }
326
- ]
327
- }
328
- ]
329
- }
package/temp/cristal-wiki-config-api.api.md DELETED
@@ -1,20 +0,0 @@
1
- ## API Report File for "@xwiki/cristal-wiki-config-api"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import type { Configurations } from '@xwiki/platform-configuration-api';
8
- import type { Ref } from 'vue';
9
- import type { WikiConfig } from '@xwiki/platform-api';
10
-
11
- // @beta
12
- export interface WikiConfigProxy {
13
- deleteAvailableConfiguration(configName: string): void;
14
- getAvailableConfigurations(): Ref<Map<string, WikiConfig>>;
15
- setAvailableConfigurations(config: Configurations): void;
16
- }
17
-
18
- // (No @packageDocumentation comment for this package)
19
-
20
- ```