@xwiki/cristal-uiextension-api 0.21.1 → 0.22.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 (7) hide show
  1. package/CHANGELOG.md +3 -3
  2. package/api-extractor.json +4 -0
  3. package/dist/index.d.ts +3 -1
  4. package/dist/index.d.ts.map +1 -1
  5. package/etc/cristal-uiextension-api.api.md +29 -0
  6. package/package.json +6 -5
  7. package/src/index.ts +3 -1
package/CHANGELOG.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # @xwiki/cristal-uiextension-api
2
2
 
3
- ## 0.21.1
3
+ ## 0.22.0
4
4
 
5
- ### Patch Changes
5
+ ### Minor Changes
6
6
 
7
- - Cristal 0.21.1 Release
7
+ - Cristal 0.22 Release
8
8
 
9
9
  ## 0.21.0
10
10
 
package/api-extractor.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
+ "extends": "../../../api-extractor.json"
4
+ }
package/dist/index.d.ts CHANGED
@@ -17,11 +17,12 @@
17
17
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18
18
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19
19
  */
20
- import { Component } from "vue";
20
+ import type { Component } from "vue";
21
21
  /**
22
22
  * Define the information held by a UI Extension (UIX).
23
23
  *
24
24
  * @since 0.11
25
+ * @beta
25
26
  */
26
27
  interface UIExtension {
27
28
  /**
@@ -54,6 +55,7 @@ interface UIExtension {
54
55
  }
55
56
  /**
56
57
  * @since 0.11
58
+ * @beta
57
59
  */
58
60
  interface UIExtensionsManager {
59
61
  /**
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAEhC;;;;GAIG;AACH,UAAU,WAAW;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,UAAU,mBAAmB;IAC3B;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC5C;AAED,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAErC;;;;;GAKG;AACH,UAAU,WAAW;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;CACjC;AAED;;;GAGG;AACH,UAAU,mBAAmB;IAC3B;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC5C;AAED,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC"}
package/etc/cristal-uiextension-api.api.md ADDED
@@ -0,0 +1,29 @@
1
+ ## API Report File for "@xwiki/cristal-uiextension-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 { Component } from 'vue';
8
+
9
+ // @beta
10
+ export interface UIExtension {
11
+ component(): Promise<Component>;
12
+ enabled(): Promise<boolean>;
13
+ id: string;
14
+ order: number;
15
+ parameters: {
16
+ [key: string]: unknown;
17
+ };
18
+ uixpName: string;
19
+ }
20
+
21
+ // @beta (undocumented)
22
+ export interface UIExtensionsManager {
23
+ // (undocumented)
24
+ list(name: string): Promise<UIExtension[]>;
25
+ }
26
+
27
+ // (No @packageDocumentation comment for this package)
28
+
29
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xwiki/cristal-uiextension-api",
3
- "version": "0.21.1",
3
+ "version": "0.22.0",
4
4
  "license": "LGPL 2.1",
5
5
  "author": "XWiki Org Community <contact@xwiki.org>",
6
6
  "homepage": "https://cristal.xwiki.org/",
@@ -18,18 +18,19 @@
18
18
  "types": "./dist/index.d.ts"
19
19
  }
20
20
  },
21
- "types": "./src/index.ts",
21
+ "types": "./dist/index.d.ts",
22
22
  "peerDependencies": {
23
23
  "reflect-metadata": "0.x",
24
24
  "vue": "3.x"
25
25
  },
26
26
  "devDependencies": {
27
27
  "typescript": "5.9.2",
28
- "vue": "3.5.18",
29
- "@xwiki/cristal-dev-config": "0.21.1"
28
+ "vue": "3.5.20",
29
+ "@xwiki/cristal-dev-config": "0.22.0"
30
30
  },
31
31
  "scripts": {
32
- "build": "rimraf dist && tsc --project tsconfig.json",
32
+ "api-extractor:local": "api-extractor run --local",
33
+ "build": "rimraf dist && tsc",
33
34
  "clean": "rimraf dist",
34
35
  "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
35
36
  }
package/src/index.ts CHANGED
@@ -18,12 +18,13 @@
18
18
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19
19
  */
20
20
 
21
- import { Component } from "vue";
21
+ import type { Component } from "vue";
22
22
 
23
23
  /**
24
24
  * Define the information held by a UI Extension (UIX).
25
25
  *
26
26
  * @since 0.11
27
+ * @beta
27
28
  */
28
29
  interface UIExtension {
29
30
  /**
@@ -60,6 +61,7 @@ interface UIExtension {
60
61
 
61
62
  /**
62
63
  * @since 0.11
64
+ * @beta
63
65
  */
64
66
  interface UIExtensionsManager {
65
67
  /**