@xwiki/cristal-page-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 +2 -2
  2. package/temp/cristal-page-api.api.json +0 -295
  3. package/temp/cristal-page-api.api.md +0 -24
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xwiki/cristal-page-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/",
@@ -27,7 +27,7 @@
27
27
  "inversify": "7.11.0",
28
28
  "reflect-metadata": "0.2.2",
29
29
  "typescript": "5.9.3",
30
- "@xwiki/cristal-dev-config": "1.1.0-rc-1"
30
+ "@xwiki/cristal-dev-config": "1.1.0"
31
31
  },
32
32
  "scripts": {
33
33
  "api-extractor:local": "api-extractor run --local",
package/temp/cristal-page-api.api.json DELETED
@@ -1,295 +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-page-api!",
156
- "docComment": "",
157
- "name": "@xwiki/cristal-page-api",
158
- "preserveMemberOrder": false,
159
- "members": [
160
- {
161
- "kind": "EntryPoint",
162
- "canonicalReference": "@xwiki/cristal-page-api!",
163
- "name": "",
164
- "preserveMemberOrder": false,
165
- "members": [
166
- {
167
- "kind": "Interface",
168
- "canonicalReference": "@xwiki/cristal-page-api!PageReader:interface",
169
- "docComment": "/**\n * Provide the operations to read a page content\n *\n * @since\n *\n * 0.20\n *\n * @beta\n */\n",
170
- "excerptTokens": [
171
- {
172
- "kind": "Content",
173
- "text": "interface PageReader "
174
- }
175
- ],
176
- "fileUrlPath": "src/index.ts",
177
- "releaseTag": "Beta",
178
- "name": "PageReader",
179
- "preserveMemberOrder": false,
180
- "members": [
181
- {
182
- "kind": "MethodSignature",
183
- "canonicalReference": "@xwiki/cristal-page-api!PageReader#readPage:member(1)",
184
- "docComment": "/**\n * Parse the provided page content, and returns a json object containing the actual page content plus the available metadata. The metadata are expected to be provided as a yaml object wrapped between two lines containing exactly '---'\n *\n * @param pageContent - the provided page content\n */\n",
185
- "excerptTokens": [
186
- {
187
- "kind": "Content",
188
- "text": "readPage(pageContent: "
189
- },
190
- {
191
- "kind": "Content",
192
- "text": "string"
193
- },
194
- {
195
- "kind": "Content",
196
- "text": "): "
197
- },
198
- {
199
- "kind": "Content",
200
- "text": "{\n [key: string]: unknown;\n }"
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": "pageContent",
217
- "parameterTypeTokenRange": {
218
- "startIndex": 1,
219
- "endIndex": 2
220
- },
221
- "isOptional": false
222
- }
223
- ],
224
- "name": "readPage"
225
- }
226
- ],
227
- "extendsTokenRanges": []
228
- },
229
- {
230
- "kind": "Interface",
231
- "canonicalReference": "@xwiki/cristal-page-api!PageWriter:interface",
232
- "docComment": "/**\n * @since\n *\n * 0.20\n *\n * @beta\n */\n",
233
- "excerptTokens": [
234
- {
235
- "kind": "Content",
236
- "text": "interface PageWriter "
237
- }
238
- ],
239
- "fileUrlPath": "src/index.ts",
240
- "releaseTag": "Beta",
241
- "name": "PageWriter",
242
- "preserveMemberOrder": false,
243
- "members": [
244
- {
245
- "kind": "MethodSignature",
246
- "canonicalReference": "@xwiki/cristal-page-api!PageWriter#writePage:member(1)",
247
- "docComment": "",
248
- "excerptTokens": [
249
- {
250
- "kind": "Content",
251
- "text": "writePage(pageContent: "
252
- },
253
- {
254
- "kind": "Content",
255
- "text": "{\n [key: string]: unknown;\n }"
256
- },
257
- {
258
- "kind": "Content",
259
- "text": "): "
260
- },
261
- {
262
- "kind": "Content",
263
- "text": "string"
264
- },
265
- {
266
- "kind": "Content",
267
- "text": ";"
268
- }
269
- ],
270
- "isOptional": false,
271
- "returnTypeTokenRange": {
272
- "startIndex": 3,
273
- "endIndex": 4
274
- },
275
- "releaseTag": "Beta",
276
- "overloadIndex": 1,
277
- "parameters": [
278
- {
279
- "parameterName": "pageContent",
280
- "parameterTypeTokenRange": {
281
- "startIndex": 1,
282
- "endIndex": 2
283
- },
284
- "isOptional": false
285
- }
286
- ],
287
- "name": "writePage"
288
- }
289
- ],
290
- "extendsTokenRanges": []
291
- }
292
- ]
293
- }
294
- ]
295
- }
package/temp/cristal-page-api.api.md DELETED
@@ -1,24 +0,0 @@
1
- ## API Report File for "@xwiki/cristal-page-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
- // @beta
8
- export interface PageReader {
9
- readPage(pageContent: string): {
10
- [key: string]: unknown;
11
- };
12
- }
13
-
14
- // @beta (undocumented)
15
- export interface PageWriter {
16
- // (undocumented)
17
- writePage(pageContent: {
18
- [key: string]: unknown;
19
- }): string;
20
- }
21
-
22
- // (No @packageDocumentation comment for this package)
23
-
24
- ```