@xwiki/cristal-uiextension-api 0.20.0 → 0.21.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 +12 -0
- package/dist/index.d.ts +21 -1
- package/dist/index.d.ts.map +1 -0
- package/package.json +9 -19
- package/src/index.ts +1 -1
- package/tsconfig.json +4 -1
- package/dist/index.d.cts +0 -47
- package/dist/index.es.js +0 -2
- package/dist/index.es.js.map +0 -1
- package/dist/index.umd.js +0 -2
- package/dist/index.umd.js.map +0 -1
- package/vite.config.ts +0 -23
- package/vitest.config.ts +0 -25
package/CHANGELOG.md
CHANGED
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,23 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* See the LICENSE file distributed with this work for additional
|
|
3
|
+
* information regarding copyright ownership.
|
|
4
|
+
*
|
|
5
|
+
* This is free software; you can redistribute it and/or modify it
|
|
6
|
+
* under the terms of the GNU Lesser General Public License as
|
|
7
|
+
* published by the Free Software Foundation; either version 2.1 of
|
|
8
|
+
* the License, or (at your option) any later version.
|
|
9
|
+
*
|
|
10
|
+
* This software is distributed in the hope that it will be useful,
|
|
11
|
+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
12
|
+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
13
|
+
* Lesser General Public License for more details.
|
|
14
|
+
*
|
|
15
|
+
* You should have received a copy of the GNU Lesser General Public
|
|
16
|
+
* License along with this software; if not, write to the Free
|
|
17
|
+
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
|
|
18
|
+
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
|
|
19
|
+
*/
|
|
20
|
+
import { Component } from "vue";
|
|
2
21
|
/**
|
|
3
22
|
* Define the information held by a UI Extension (UIX).
|
|
4
23
|
*
|
|
@@ -45,3 +64,4 @@ interface UIExtensionsManager {
|
|
|
45
64
|
list(name: string): Promise<UIExtension[]>;
|
|
46
65
|
}
|
|
47
66
|
export type { UIExtension, UIExtensionsManager };
|
|
67
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xwiki/cristal-uiextension-api",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.21.1",
|
|
4
4
|
"license": "LGPL 2.1",
|
|
5
5
|
"author": "XWiki Org Community <contact@xwiki.org>",
|
|
6
6
|
"homepage": "https://cristal.xwiki.org/",
|
|
@@ -15,32 +15,22 @@
|
|
|
15
15
|
"type": "module",
|
|
16
16
|
"exports": {
|
|
17
17
|
".": {
|
|
18
|
-
"
|
|
19
|
-
"types": "./dist/index.d.ts",
|
|
20
|
-
"default": "./dist/index.es.js"
|
|
21
|
-
},
|
|
22
|
-
"require": {
|
|
23
|
-
"types": "./dist/index.d.cts",
|
|
24
|
-
"default": "./dist/index.umd.js"
|
|
25
|
-
}
|
|
18
|
+
"types": "./dist/index.d.ts"
|
|
26
19
|
}
|
|
27
20
|
},
|
|
28
|
-
"
|
|
21
|
+
"types": "./src/index.ts",
|
|
29
22
|
"peerDependencies": {
|
|
30
23
|
"reflect-metadata": "0.x",
|
|
31
24
|
"vue": "3.x"
|
|
32
25
|
},
|
|
33
26
|
"devDependencies": {
|
|
34
|
-
"typescript": "5.
|
|
35
|
-
"
|
|
36
|
-
"
|
|
37
|
-
"@xwiki/cristal-dev-config": "0.20.0"
|
|
27
|
+
"typescript": "5.9.2",
|
|
28
|
+
"vue": "3.5.18",
|
|
29
|
+
"@xwiki/cristal-dev-config": "0.21.1"
|
|
38
30
|
},
|
|
39
31
|
"scripts": {
|
|
40
|
-
"build": "tsc --project tsconfig.json
|
|
32
|
+
"build": "rimraf dist && tsc --project tsconfig.json",
|
|
41
33
|
"clean": "rimraf dist",
|
|
42
|
-
"lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
|
|
43
|
-
|
|
44
|
-
},
|
|
45
|
-
"types": "./dist/index.d.ts"
|
|
34
|
+
"lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
|
|
35
|
+
}
|
|
46
36
|
}
|
package/src/index.ts
CHANGED
package/tsconfig.json
CHANGED
package/dist/index.d.cts
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import { Component } from 'vue';
|
|
2
|
-
/**
|
|
3
|
-
* Define the information held by a UI Extension (UIX).
|
|
4
|
-
*
|
|
5
|
-
* @since 0.11
|
|
6
|
-
*/
|
|
7
|
-
interface UIExtension {
|
|
8
|
-
/**
|
|
9
|
-
* The unique id of an UI Extension
|
|
10
|
-
*/
|
|
11
|
-
id: string;
|
|
12
|
-
/**
|
|
13
|
-
* The id of the extension point where this UIX should be injected.
|
|
14
|
-
*/
|
|
15
|
-
uixpName: string;
|
|
16
|
-
/**
|
|
17
|
-
* The order of the UIX. The lowest values are expected to be presented
|
|
18
|
-
* first.
|
|
19
|
-
*/
|
|
20
|
-
order: number;
|
|
21
|
-
/**
|
|
22
|
-
* A free set of parameters.
|
|
23
|
-
*/
|
|
24
|
-
parameters: {
|
|
25
|
-
[key: string]: unknown;
|
|
26
|
-
};
|
|
27
|
-
/**
|
|
28
|
-
* Compute if the UIX should be displayed.
|
|
29
|
-
*/
|
|
30
|
-
enabled(): Promise<boolean>;
|
|
31
|
-
/**
|
|
32
|
-
* The UI component of the UIX.
|
|
33
|
-
*/
|
|
34
|
-
component(): Promise<Component>;
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* @since 0.11
|
|
38
|
-
*/
|
|
39
|
-
interface UIExtensionsManager {
|
|
40
|
-
/**
|
|
41
|
-
*
|
|
42
|
-
* @param name - the name of the UIXP
|
|
43
|
-
* @returns a list of UIExtension components, sorted by ascending order. disabled UIExtensions are excluded
|
|
44
|
-
*/
|
|
45
|
-
list(name: string): Promise<UIExtension[]>;
|
|
46
|
-
}
|
|
47
|
-
export type { UIExtension, UIExtensionsManager };
|
package/dist/index.es.js
DELETED
package/dist/index.es.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.es.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}
|
package/dist/index.umd.js
DELETED
package/dist/index.umd.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}
|
package/vite.config.ts
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* See the LICENSE file distributed with this work for additional
|
|
3
|
-
* information regarding copyright ownership.
|
|
4
|
-
*
|
|
5
|
-
* This is free software; you can redistribute it and/or modify it
|
|
6
|
-
* under the terms of the GNU Lesser General Public License as
|
|
7
|
-
* published by the Free Software Foundation; either version 2.1 of
|
|
8
|
-
* the License, or (at your option) any later version.
|
|
9
|
-
*
|
|
10
|
-
* This software is distributed in the hope that it will be useful,
|
|
11
|
-
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
12
|
-
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
13
|
-
* Lesser General Public License for more details.
|
|
14
|
-
*
|
|
15
|
-
* You should have received a copy of the GNU Lesser General Public
|
|
16
|
-
* License along with this software; if not, write to the Free
|
|
17
|
-
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
|
|
18
|
-
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
|
|
19
|
-
*/
|
|
20
|
-
|
|
21
|
-
import { generateConfig } from "../../../vite.config";
|
|
22
|
-
|
|
23
|
-
export default generateConfig(import.meta.url);
|
package/vitest.config.ts
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* See the LICENSE file distributed with this work for additional
|
|
3
|
-
* information regarding copyright ownership.
|
|
4
|
-
*
|
|
5
|
-
* This is free software; you can redistribute it and/or modify it
|
|
6
|
-
* under the terms of the GNU Lesser General Public License as
|
|
7
|
-
* published by the Free Software Foundation; either version 2.1 of
|
|
8
|
-
* the License, or (at your option) any later version.
|
|
9
|
-
*
|
|
10
|
-
* This software is distributed in the hope that it will be useful,
|
|
11
|
-
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
12
|
-
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
13
|
-
* Lesser General Public License for more details.
|
|
14
|
-
*
|
|
15
|
-
* You should have received a copy of the GNU Lesser General Public
|
|
16
|
-
* License along with this software; if not, write to the Free
|
|
17
|
-
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
|
|
18
|
-
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
|
|
19
|
-
*/
|
|
20
|
-
|
|
21
|
-
import localConfig from "./vite.config";
|
|
22
|
-
import { mergeConfig } from "vitest/config";
|
|
23
|
-
import defaultConfig from "@xwiki/cristal-dev-config/vitest-vue.config";
|
|
24
|
-
|
|
25
|
-
export default mergeConfig(defaultConfig, localConfig);
|