@atlassian/clientside-extensions-docs 5.0.0 → 5.1.0-9864e593-me132vr9
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/content/server/framework/clientside-extensions/guides/how-to/setup-webpack-plugin.md +8 -8
- package/content/server/framework/clientside-extensions/reference/webpack-plugin/annotations.md +4 -4
- package/content/server/framework/clientside-extensions/reference/webpack-plugin/webpack-plugin.md +3 -3
- package/package.json +4 -4
package/content/server/framework/clientside-extensions/guides/how-to/setup-webpack-plugin.md
CHANGED
|
@@ -4,7 +4,7 @@ platform: server
|
|
|
4
4
|
product: clientside-extensions
|
|
5
5
|
category: devguide
|
|
6
6
|
subcategory: how-to
|
|
7
|
-
date: '
|
|
7
|
+
date: '2025-06-08'
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# Setting up the CSE webpack plugin
|
|
@@ -23,10 +23,10 @@ Add `@atlassian/clientside-extension-webpack-plugin` as a dependency of your pro
|
|
|
23
23
|
npm install --save-dev @atlassian/clientside-extensions-webpack-plugin
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
And make sure to also install its peer dependency:
|
|
26
|
+
And make sure to also install its peer dependency: `@atlassian/webresource-webpack-plugin`
|
|
27
27
|
|
|
28
28
|
```
|
|
29
|
-
npm install --save-dev atlassian
|
|
29
|
+
npm install --save-dev @atlassian/webresource-webpack-plugin
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
## 2. Configuring CSE
|
|
@@ -64,15 +64,15 @@ module.exports = {
|
|
|
64
64
|
|
|
65
65
|
## 3. Configuring WRM webpack plugin
|
|
66
66
|
|
|
67
|
-
CSE webpack plugin makes use of [WRM webpack plugin](https://www.npmjs.com/package/
|
|
67
|
+
CSE webpack plugin makes use of [WRM webpack plugin](https://www.npmjs.com/package/@atlassian/webresource-webpack-plugin) to generate the
|
|
68
68
|
resource definitions for your extensions, so you also need to configure it.
|
|
69
69
|
|
|
70
|
-
In your webpack configuration, import
|
|
70
|
+
In your webpack configuration, import `@atlassian/webresource-webpack-plugin` and use as follows:
|
|
71
71
|
|
|
72
72
|
```js
|
|
73
73
|
// #webpack.config.js
|
|
74
74
|
const path = require('path');
|
|
75
|
-
const WrmPlugin = require('atlassian
|
|
75
|
+
const WrmPlugin = require('@atlassian/webresource-webpack-plugin');
|
|
76
76
|
const CSEPlugin = require('@atlassian/clientside-extensions-webpack-plugin');
|
|
77
77
|
|
|
78
78
|
const csePlugin = new CSEPlugin({...});
|
|
@@ -96,7 +96,7 @@ const providedDependencies = {
|
|
|
96
96
|
* Configure WRM webpack plugin
|
|
97
97
|
*
|
|
98
98
|
* More info about WRM Webpack Plugin:
|
|
99
|
-
* https://bitbucket.org/atlassianlabs/
|
|
99
|
+
* https://bitbucket.org/atlassianlabs/fe-server/src/master/packages/webresource-webpack-plugin
|
|
100
100
|
*/
|
|
101
101
|
const wrmPlugin = new WrmPlugin({
|
|
102
102
|
// Your Atlassian Plugin key
|
|
@@ -132,7 +132,7 @@ At the end, your webpack configuration should look very similar to the following
|
|
|
132
132
|
// #webpack.config.js
|
|
133
133
|
const path = require('path');
|
|
134
134
|
const CSEPlugin = require('@atlassian/clientside-extensions-webpack-plugin');
|
|
135
|
-
const WrmPlugin = require('atlassian
|
|
135
|
+
const WrmPlugin = require('@atlassian/webresource-webpack-plugin');
|
|
136
136
|
|
|
137
137
|
const targetDirectory = path.join(__dirname, 'target');
|
|
138
138
|
|
package/content/server/framework/clientside-extensions/reference/webpack-plugin/annotations.md
CHANGED
|
@@ -4,7 +4,7 @@ platform: server
|
|
|
4
4
|
product: clientside-extensions
|
|
5
5
|
category: reference
|
|
6
6
|
subcategory: webpack
|
|
7
|
-
date: '
|
|
7
|
+
date: '2025-06-08'
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# Annotations
|
|
@@ -265,7 +265,7 @@ export default PageExtension.factory((container) => {
|
|
|
265
265
|
The `@condition` annotation allows you to define one or multiple conditions that must be satisfied for the extension to be displayed.
|
|
266
266
|
These conditions are evaluated on the server and are implemented in Java. They are used for determining if the extension should be downloaded and rendered by the client. For compatibility reasons, the condition class needs to implement both `com.atlassian.plugin.web.Condition` and `com.atlassian.webresource.spi.condition.UrlReadingCondition` interfaces, and both implementations should yield the same result.
|
|
267
267
|
|
|
268
|
-
For more information about the condition's usage please refer to the [examples of Web items documentation](https://developer.atlassian.com/server/framework/atlassian-sdk/web-section-plugin-module/#condition-and-conditions-elements) and check the [documentation of `conditionMap` option from
|
|
268
|
+
For more information about the condition's usage please refer to the [examples of Web items documentation](https://developer.atlassian.com/server/framework/atlassian-sdk/web-section-plugin-module/#condition-and-conditions-elements) and check the [documentation of `conditionMap` option from `@atlassian/webresource-webpack-plugin`](https://www.npmjs.com/package/@atlassian/webresource-webpack-plugin#conditionmap-optional).
|
|
269
269
|
|
|
270
270
|
```ts
|
|
271
271
|
import { LinkExtension } from '@atlassian/clientside-extensions';
|
|
@@ -327,7 +327,7 @@ import { LinkExtension } from '@atlassian/clientside-extensions';
|
|
|
327
327
|
export default LinkExtension.factory(/*...*/);
|
|
328
328
|
```
|
|
329
329
|
|
|
330
|
-
These `@condition` annotations will result in creating a condition map object that is matching the [shape of `conditionMap` option from
|
|
330
|
+
These `@condition` annotations will result in creating a condition map object that is matching the [shape of `conditionMap` option from `@atlassian/webresource-webpack-plugin`](https://www.npmjs.com/package/@atlassian/webresource-webpack-plugin#conditionmap-optional):
|
|
331
331
|
|
|
332
332
|
```json
|
|
333
333
|
{
|
|
@@ -376,7 +376,7 @@ import { LinkExtension } from '@atlassian/clientside-extensions';
|
|
|
376
376
|
export default LinkExtension.factory(/*...*/);
|
|
377
377
|
```
|
|
378
378
|
|
|
379
|
-
These `@condition` annotations will result in creating a condition map object that is matching the [shape of `conditionMap` option from
|
|
379
|
+
These `@condition` annotations will result in creating a condition map object that is matching the [shape of `conditionMap` option from `@atlassian/webresource-webpack-plugin`](https://www.npmjs.com/package/@atlassian/webresource-webpack-plugin#conditionmap-optional):
|
|
380
380
|
|
|
381
381
|
```json
|
|
382
382
|
{
|
package/content/server/framework/clientside-extensions/reference/webpack-plugin/webpack-plugin.md
CHANGED
|
@@ -4,12 +4,12 @@ platform: server
|
|
|
4
4
|
product: clientside-extensions
|
|
5
5
|
category: reference
|
|
6
6
|
subcategory: webpack
|
|
7
|
-
date: '
|
|
7
|
+
date: '2025-06-08'
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# Webpack plugin
|
|
11
11
|
|
|
12
|
-
Client-side Extensions webpack plugin depends on [WRM webpack plugin](https://www.npmjs.com/package/
|
|
12
|
+
Client-side Extensions webpack plugin depends on [WRM webpack plugin](https://www.npmjs.com/package/@atlassian/webresource-webpack-plugin).
|
|
13
13
|
|
|
14
14
|
Refer to the [setup guide](/server/framework/clientside-extensions/guides/how-to/setup-webpack-plugin/) to check how to install and configure the webpack plugin.
|
|
15
15
|
|
|
@@ -53,7 +53,7 @@ Generates all the entry-point definitions for the webpack `entry` configuration.
|
|
|
53
53
|
```js
|
|
54
54
|
const path = require('path');
|
|
55
55
|
const ClientsideExtensionsWebpackPlugin = require('@atlassian/clientside-extensions-webpack-plugin');
|
|
56
|
-
const WrmPlugin = require('atlassian
|
|
56
|
+
const WrmPlugin = require('@atlassian/webresource-webpack-plugin');
|
|
57
57
|
|
|
58
58
|
const wrmPlugin = new WrmPlugin(/*...*/);
|
|
59
59
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlassian/clientside-extensions-docs",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.1.0-9864e593-me132vr9",
|
|
4
4
|
"description": "Holds the official documentation for Altassian Server client-side extensions API.",
|
|
5
5
|
"license": "BSD-3-Clause",
|
|
6
6
|
"homepage": "https://bitbucket.org/atlassian/atlassian-clientside-extensions#readme",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
],
|
|
49
49
|
"publishConfig": {
|
|
50
50
|
"access": "public",
|
|
51
|
-
"@atlassian:registry": "https://
|
|
51
|
+
"@atlassian:registry": "https://packages.atlassian.com/api/npm/npm-public/"
|
|
52
52
|
},
|
|
53
53
|
"docs": [
|
|
54
54
|
{
|
|
@@ -77,8 +77,8 @@
|
|
|
77
77
|
"//comment": "We use the proxy command to 'doc-scripts' so we don't need to pass the enviroment flag all over the places",
|
|
78
78
|
"doc-scripts": "env SKIP_VERSION_CHECK=true doc-scripts"
|
|
79
79
|
},
|
|
80
|
-
"
|
|
80
|
+
"devDependencies": {
|
|
81
81
|
"@atlassian/doc-scripts": "^11.1.0"
|
|
82
82
|
},
|
|
83
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "9864e5937d68e51d7a26eece1238be16589135b5"
|
|
84
84
|
}
|