Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit a75901d

Browse files
charlynguyendhenneke
charlynguyen
and
dhenneke
authored
Introduce openDesk module (#34)
* Introduce openDesk module Signed-off-by: Charly Nguyen <[email protected]> * Add a workaround where the module broke the navigation features in Element Signed-off-by: Dominik Henneke <[email protected]> --------- Signed-off-by: Charly Nguyen <[email protected]> Signed-off-by: Dominik Henneke <[email protected]> Co-authored-by: Dominik Henneke <[email protected]>
1 parent 5c5669d commit a75901d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2510
-283
lines changed

‎.changeset/stupid-vans-itch.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@nordeck/element-web-opendesk-module': patch
3+
---
4+
5+
Add initial version.

‎e2e/src/deploy/elementWeb/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM node:20-bullseye as builder
22

3-
ARG ELEMENT_VERSION="v1.11.40"
3+
ARG ELEMENT_VERSION="v1.11.46"
44

55
WORKDIR /src
66

‎e2e/src/deploy/elementWeb/build_config.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Register the module that was created by `yarn build`
22
modules:
33
- 'file:nordeck-element-web-guest-module.tgz'
4+
- 'file:nordeck-element-web-opendesk-module.tgz'
45
- 'file:nordeck-element-web-widget-lifecycle-module.tgz'

‎e2e/src/deploy/elementWeb/config.json

+8
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,14 @@
4949
"skip_single_sign_on": true
5050
}
5151
},
52+
"net.nordeck.element_web.module.opendesk": {
53+
"config": {
54+
"ics_navigation_json_url": "https://example.com/navigation.json",
55+
"ics_silent_url": "https://example.com/silent",
56+
"portal_logo_svg_url": "https://example.com/logo.svg",
57+
"portal_url": "https://example.com"
58+
}
59+
},
5260
"net.nordeck.element_web.module.widget_lifecycle": {
5361
"widget_permissions": {
5462
"{{WIDGET_SERVER_URL}}/widget.html": {

‎e2e/src/deploy/elementWeb/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ let container: StartedTestContainer | undefined;
2222
export async function startElementWeb({
2323
homeserverUrl,
2424
widgetServerUrl,
25-
version = 'v1.11.40',
25+
version = 'v1.11.46',
2626
}: {
2727
homeserverUrl: string;
2828
widgetServerUrl: string;

‎e2e/src/navbar.spec.ts

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Copyright 2023 Nordeck IT + Consulting GmbH
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import { expect } from '@playwright/test';
18+
import { test } from './fixtures';
19+
import { getElementWebUrl } from './util';
20+
21+
test.describe('Navbar Module', () => {
22+
test('renders the link to the portal', async ({ page }) => {
23+
await page.goto(getElementWebUrl());
24+
const navigation = page.getByRole('navigation');
25+
const link = navigation.getByRole('link', { name: 'Show portal' });
26+
await expect(link).toHaveAttribute('href', 'https://example.com');
27+
});
28+
});

‎packages/element-web-opendesk-module/LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎packages/element-web-opendesk-module/README.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Element Web openDesk Module
2+
3+
A module for Element to provide openDesk specific functionality.
4+
5+
It uses the [Module API](https://www.npmjs.com/package/@matrix-org/react-sdk-module-api) to add the openDesk navbar.
6+
7+
<img src="./docs/navbar.png" alt="openDesk navbar" />
8+
9+
## Requirements
10+
11+
The minimal Element version to use this module is `1.11.41`.
12+
13+
## Install the Element Module
14+
15+
Checkout Element and setup the development environment according to [their documentation](https://github.com/vector-im/element-web/#building-from-source).
16+
Go into the `element-web` folder and create a `build_config.yaml` file with the following content:
17+
18+
```yaml
19+
modules:
20+
- '@nordeck/element-web-widget-opendesk-module@^0.0.1'
21+
```
22+
23+
Build Element and deploy your custom version as described by the original documentation.
24+
In case you want to create a docker-based build process, you might find inspiration in the setup [we use for our e2e tests](../../e2e/src/deploy/elementWeb/Dockerfile).
25+
26+
## Configure the Element Module
27+
28+
The module provides required configuration options:
29+
30+
- `ics_navigation_json_url` - The URL of the `navigation.json` file that contains the navigation structure for the user.
31+
- `ics_silent_url` - The URL of the silent endpoint that is used via inline frame to log in the user.
32+
- `portal_logo_svg_url` - The URL of the portal `logo.svg` file.
33+
- `portal_url` - The URL of the portal.
34+
35+
Example configuration:
36+
37+
```json
38+
{
39+
"net.nordeck.element_web.module.opendesk": {
40+
"config": {
41+
"ics_navigation_json_url": "https://example.com/navigation.json",
42+
"ics_silent_url": "https://example.com/silent",
43+
"portal_logo_svg_url": "https://example.com/logo.svg",
44+
"portal_url": "https://example.com"
45+
}
46+
}
47+
}
48+
```
49+
50+
## Running the Element Module Locally
51+
52+
1. Run `yarn build` in this repository.
53+
54+
2. Checkout Element and setup the development environment according to [their documentation](https://github.com/vector-im/element-web/#building-from-source).
55+
56+
3. (In the `element-web` folder) Create a `build_config.yaml` with the following content:
57+
58+
```yaml
59+
# Directory structure:
60+
# <your projects folder>/
61+
# ├─ element-web/
62+
# │ ├─ ...
63+
# │ ├─ build_config.yaml
64+
# │ ├─ package.json
65+
# ├─ matrix-react-sdk/
66+
# │ ├─ ...
67+
# ├─ matrix-js-sdk/
68+
# │ ├─ ...
69+
# ├─ element-web-modules/
70+
# │ ├─ packages
71+
# │ │ ├─ element-web-opendesk-module
72+
# │ │ │ ├─ build/
73+
# │ │ │ │ ├─ ...
74+
# │ │ │ ├─ package.json
75+
# │ │ │ ├─ ...
76+
# │ ├─ package.json
77+
78+
modules:
79+
- 'file:../element-web-modules/packages/element-web-opendesk-module'
80+
```
81+
82+
4. (In the `element-web` folder) Run `yarn start` and access it at `http://localhost:8080`
83+
84+
> **Important**: You must run `yarn build` in this repo and restart Element after each change in the module.

‎packages/element-web-opendesk-module/api-extractor.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
4+
"extends": "../../api-extractor.json"
5+
}

0 commit comments

Comments
 (0)