diff --git a/.ts-eslintrc.js b/.ts-eslintrc.js
index 1974e07b..cf1fc3bf 100644
--- a/.ts-eslintrc.js
+++ b/.ts-eslintrc.js
@@ -19,6 +19,7 @@ module.exports = {
],
rules: {
"@typescript-eslint/no-floating-promises": 2,
- "@typescript-eslint/no-misused-promises": 2
+ "@typescript-eslint/no-misused-promises": 2,
+ "semi": ["error", "always"]
}
};
diff --git a/Dockerfile b/Dockerfile
index 5bdc6269..d4faba7e 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -11,8 +11,8 @@ COPY . .
RUN yarn build
# Remove the default config, replace it with a symlink to somewhere that will be updated at runtime
-RUN rm -f target/assets/config.json \
- && ln -sf /tmp/config.json target/assets/config.json
+RUN rm -f target/config.json \
+ && ln -sf /tmp/config.json target/config.json
FROM --platform=${TARGETPLATFORM} docker.io/nginxinc/nginx-unprivileged:1.21-alpine
diff --git a/doc/IMPORT-ISSUES.md b/doc/IMPORT-ISSUES.md
new file mode 100644
index 00000000..d4bb62fe
--- /dev/null
+++ b/doc/IMPORT-ISSUES.md
@@ -0,0 +1,11 @@
+## How to import common-js dependency using ES6 syntax
+---
+Until [#6632](https://github.com/vitejs/vite/issues/6632) is fixed, such imports should be done as follows:
+
+```ts
+import * as pkg from "off-color";
+// @ts-ignore
+const offColor = pkg.offColor ?? pkg.default.offColor;
+```
+
+This way build, dev server and unit tests should all work.
diff --git a/doc/THEMING.md b/doc/THEMING.md
index b6af27cf..599434bd 100644
--- a/doc/THEMING.md
+++ b/doc/THEMING.md
@@ -167,3 +167,38 @@ To find the theme-id of some theme, you can look at the built-asset section of t
This default theme will render as "Default" option in the theme-chooser dropdown. If the device preference is for dark theme, the dark default is selected and vice versa.
**You'll need to reload twice so that Hydrogen picks up the config changes!**
+
+# Derived Theme(Collection)
+This allows users to theme Hydrogen without the need for rebuilding. Derived theme collections can be thought of as extensions (derivations) of some existing build time theme.
+
+## Creating a derived theme:
+Here's how you create a new derived theme:
+1. You create a new theme manifest file (eg: theme-awesome.json) and mention which build time theme you're basing your new theme on using the `extends` field. The base css file of the mentioned theme is used for your new theme.
+2. You configure the theme manifest as usual by populating the `variants` field with your desired colors.
+3. You add your new theme manifest to the list of themes in `config.json`.
+
+Refresh Hydrogen twice (once to refresh cache, and once to load) and the new theme should show up in the theme chooser.
+
+## How does it work?
+
+For every theme collection in hydrogen, the build process emits a runtime css file which like the built theme css file contains variables in the css code. But unlike the theme css file, the runtime css file lacks the definition for these variables:
+
+CSS for the built theme:
+```css
+:root {
+ --background-color-primary: #f2f20f;
+}
+
+body {
+ background-color: var(--background-color-primary);
+}
+```
+and the corresponding runtime theme:
+```css
+/* Notice the lack of definiton for --background-color-primary here! */
+body {
+ background-color: var(--background-color-primary);
+}
+```
+
+When hydrogen loads a derived theme, it takes the runtime css file of the extended theme and dynamically adds the variable definition based on the values specified in the manifest. Icons are also colored dynamically and injected as variables using Data URIs.
diff --git a/doc/UI/ui.md b/doc/UI/ui.md
new file mode 100644
index 00000000..d3aa3893
--- /dev/null
+++ b/doc/UI/ui.md
@@ -0,0 +1,206 @@
+## IView components
+
+The [interface](https://github.com/vector-im/hydrogen-web/blob/master/src/platform/web/ui/general/types.ts) adopted by view components is agnostic of how they are rendered to the DOM. This has several benefits:
+ - it allows Hydrogen to not ship a [heavy view framework](https://bundlephobia.com/package/react-dom@18.2.0) that may or may not be used by its SDK users, and also keep bundle size of the app down.
+ - Given the interface is quite simple, is should be easy to integrate this interface into the render lifecycle of other frameworks.
+ - The main implementations used in Hydrogen are [`ListView`](https://github.com/vector-im/hydrogen-web/blob/master/src/platform/web/ui/general/ListView.ts) (rendering [`ObservableList`](https://github.com/vector-im/hydrogen-web/blob/master/src/observable/list/BaseObservableList.ts)s) and [`TemplateView`](https://github.com/vector-im/hydrogen-web/blob/master/src/platform/web/ui/general/TemplateView.ts) (templating and one-way databinding), each only a few 100 lines of code and tailored towards their specific use-case. They work straight with the DOM API and have no other dependencies.
+ - a common inteface allows us to mix and match between these different implementations (and gradually shift if need be in the future) with the code.
+
+## Templates
+
+### Template language
+
+Templates use a mini-DSL language in pure javascript to express declarative templates. This is basically a very thin wrapper around `document.createElement`, `document.createTextNode`, `node.setAttribute` and `node.appendChild` to quickly create DOM trees. The general syntax is as follows:
+```js
+t.tag_name({attribute1: value, attribute2: value, ...}, [child_elements]);
+t.tag_name(child_element);
+t.tag_name([child_elements]);
+```
+**tag_name** can be [most HTML or SVG tags](https://github.com/vector-im/hydrogen-web/blob/master/src/platform/web/ui/general/html.ts#L102-L110).
+
+eg:
+Here is an example HTML segment followed with the code to create it in Hydrogen.
+```html
+
+```
+```js
+t.section({className: "main-section"},[
+ t.h1("Demo"),
+ t.button({className:"btn_cool"}, "Click me")
+]);
+```
+
+All these functions return DOM element nodes, e.g. the result of `document.createElement`.
+
+### TemplateView
+
+`TemplateView` builds on top of templating by adopting the IView component model and adding event handling attributes, sub views and one-way databinding.
+In views based on `TemplateView`, you will see a render method with a `t` argument.
+`t` is `TemplateBuilder` object passed to the render function in `TemplateView`. It also takes a data object to render and bind to, often called `vm`, short for view model from the MVVM pattern Hydrogen uses.
+
+You either subclass `TemplateView` and override the `render` method:
+```js
+class MyView extends TemplateView {
+ render(t, vm) {
+ return t.div(...);
+ }
+}
+```
+
+Or you pass a render function to `InlineTemplateView`:
+```js
+new InlineTemplateView(vm, (t, vm) => {
+ return t.div(...);
+});
+```
+
+**Note:** the render function is only called once to build the initial DOM tree and setup bindings, etc ... Any subsequent updates to the DOM of a component happens through bindings.
+
+#### Event handlers
+
+Any attribute starting with `on` and having a function as a value will be attached as an event listener on the given node. The event handler will be removed during unmounting.
+
+```js
+t.button({onClick: evt => {
+ vm.doSomething(evt.target.value);
+}}, "Click me");
+```
+
+#### Subviews
+
+`t.view(instance)` will mount the sub view (can be any IView) and return its root node so it can be attached in the DOM tree.
+All subviews will be unmounted when the parent view gets unmounted.
+
+```js
+t.div({className: "Container"}, t.view(new ChildView(vm.childViewModel)));
+```
+
+#### One-way data-binding
+
+A binding couples a part of the DOM to a value on the view model. The view model emits an update when any of its properties change, to which the view can subscribe. When an update is received by the view, it will reevaluate all the bindings, and update the DOM accordingly.
+
+A binding can appear in many places where a static value can usually be used in the template tree.
+To create a binding, you pass a function that maps the view value to a static value.
+
+##### Text binding
+
+```js
+t.p(["I've got ", vm => vm.counter, " beans"])
+```
+
+##### Attribute binding
+
+```js
+t.button({disabled: vm => vm.isBusy}, "Submit");
+```
+
+##### Class-name binding
+```js
+t.div({className: {
+ button: true,
+ active: vm => vm.isActive
+}})
+```
+##### Subview binding
+
+So far, all the bindings can only change node values within our tree, but don't change the structure of the DOM. A sub view binding allows you to conditionally add a subview based on the result of a binding function.
+
+All sub view bindings return a DOM (element or comment) node and can be directly added to the DOM tree by including them in your template.
+
+###### map
+
+`t.mapView` allows you to choose a view based on the result of the binding function:
+
+```js
+t.mapView(vm => vm.count, count => {
+ return count > 5 ? new LargeView(count) : new SmallView(count);
+});
+```
+
+Every time the first or binding function returns a different value, the second function is run to create a new view to replace the previous view.
+
+You can also return `null` or `undefined` from the second function to indicate a view should not be rendered. In this case a comment node will be used as a placeholder.
+
+There is also a `t.map` which will create a new template view (with the same value) and you directly provide a render function for it:
+
+```js
+t.map(vm => vm.shape, (shape, t, vm) => {
+ switch (shape) {
+ case "rect": return t.rect();
+ case "circle": return t.circle();
+ }
+})
+```
+
+###### if
+
+`t.ifView` will render the subview if the binding returns a truthy value:
+
+```js
+t.ifView(vm => vm.isActive, vm => new View(vm.someValue));
+```
+
+You equally have `t.if`, which creates a `TemplateView` and passes you the `TemplateBuilder`:
+
+```js
+t.if(vm => vm.isActive, (t, vm) => t.div("active!"));
+```
+
+##### Side-effects
+
+Sometimes you want to imperatively modify your DOM tree based on the value of a binding.
+`mapSideEffect` makes this easy to do:
+
+```js
+let node = t.div();
+t.mapSideEffect(vm => vm.color, (color, oldColor) => node.style.background = color);
+return node;
+```
+
+**Note:** you shouldn't add any bindings, subviews or event handlers from the side-effect callback,
+the safest is to not use the `t` argument at all.
+If you do, they will be added every time the callback is run and only cleaned up when the view is unmounted.
+
+#### `tag` vs `t`
+
+If you don't need a view component with data-binding, sub views and event handler attributes, the template language also is available in `ui/general/html.js` without any of these bells and whistles, exported as `tag`. As opposed to static templates with `tag`, you always use
+`TemplateView` as an instance of a class, as there is some extra state to keep track (bindings, event handlers and subviews).
+
+Although syntactically similar, `TemplateBuilder` and `tag` are not functionally equivalent.
+Primarily `t` **supports** bindings and event handlers while `tag` **does not**. This is because to remove event listeners, we need to keep track of them, and thus we need to keep this state somewhere which
+we can't do with a simple function call but we can insite the TemplateView class.
+
+```js
+ // The onClick here wont work!!
+ tag.button({className:"awesome-btn", onClick: () => this.foo()});
+
+class MyView extends TemplateView {
+ render(t, vm){
+ // The onClick works here.
+ t.button({className:"awesome-btn", onClick: () => this.foo()});
+ }
+}
+```
+
+## ListView
+
+A view component that renders and updates a list of sub views for every item in a `ObservableList`.
+
+```js
+const list = new ListView({
+ list: someObservableList
+}, listValue => return new ChildView(listValue))
+```
+
+As items are added, removed, moved (change position) and updated, the DOM will be kept in sync.
+
+There is also a `LazyListView` that only renders items in and around the current viewport, with the restriction that all items in the list must be rendered with the same height.
+
+### Sub view updates
+
+Unless the `parentProvidesUpdates` option in the constructor is set to `false`, the ListView will call the `update` method on the child `IView` component when it receives an update event for one of the items in the `ObservableList`.
+
+This way, not every sub view has to have an individual listener on it's view model (a value from the observable list), and all updates go from the observable list to the list view, who then notifies the correct sub view.
diff --git a/docker/config.json.tmpl b/docker/config.json.tmpl
index 94295c43..48ecef01 100644
--- a/docker/config.json.tmpl
+++ b/docker/config.json.tmpl
@@ -4,5 +4,13 @@
"gatewayUrl": "$PUSH_GATEWAY_URL",
"applicationServerKey": "$PUSH_APPLICATION_SERVER_KEY"
},
- "defaultHomeServer": "$DEFAULT_HOMESERVER"
+ "defaultHomeServer": "$DEFAULT_HOMESERVER",
+ "bugReportEndpointUrl": "https://element.io/bugreports/submit",
+ "themeManifests": [
+ "assets/theme-element.json"
+ ],
+ "defaultTheme": {
+ "light": "element-light",
+ "dark": "element-dark"
+ }
}
diff --git a/package.json b/package.json
index 82588f10..1823ef45 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "hydrogen-web",
- "version": "0.2.33",
+ "version": "0.3.0",
"description": "A javascript matrix client prototype, trying to minize RAM usage by offloading as much as possible to IndexedDB",
"directories": {
"doc": "doc"
@@ -50,8 +50,9 @@
"postcss-flexbugs-fixes": "^5.0.2",
"postcss-value-parser": "^4.2.0",
"regenerator-runtime": "^0.13.7",
+ "svgo": "^2.8.0",
"text-encoding": "^0.7.0",
- "typescript": "^4.3.5",
+ "typescript": "^4.7.0",
"vite": "^2.9.8",
"xxhashjs": "^0.2.2"
},
diff --git a/scripts/build-plugins/rollup-plugin-build-themes.js b/scripts/build-plugins/rollup-plugin-build-themes.js
index 43a21623..c8c73220 100644
--- a/scripts/build-plugins/rollup-plugin-build-themes.js
+++ b/scripts/build-plugins/rollup-plugin-build-themes.js
@@ -14,10 +14,10 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
const path = require('path').posix;
+const {optimize} = require('svgo');
async function readCSSSource(location) {
const fs = require("fs").promises;
- const path = require("path");
const resolvedLocation = path.resolve(__dirname, "../../", `${location}/theme.css`);
const data = await fs.readFile(resolvedLocation);
return data;
@@ -43,29 +43,54 @@ function addThemesToConfig(bundle, manifestLocations, defaultThemes) {
}
}
-function parseBundle(bundle) {
+/**
+ * Returns an object where keys are the svg file names and the values
+ * are the svg code (optimized)
+ * @param {*} icons Object where keys are css variable names and values are locations of the svg
+ * @param {*} manifestLocation Location of manifest used for resolving path
+ */
+async function generateIconSourceMap(icons, manifestLocation) {
+ const sources = {};
+ const fileNames = [];
+ const promises = [];
+ const fs = require("fs").promises;
+ for (const icon of Object.values(icons)) {
+ const [location] = icon.split("?");
+ // resolve location against manifestLocation
+ const resolvedLocation = path.resolve(manifestLocation, location);
+ const iconData = fs.readFile(resolvedLocation);
+ promises.push(iconData);
+ const fileName = path.basename(resolvedLocation);
+ fileNames.push(fileName);
+ }
+ const results = await Promise.all(promises);
+ for (let i = 0; i < results.length; ++i) {
+ const svgString = results[i].toString();
+ const result = optimize(svgString, {
+ plugins: [
+ {
+ name: "preset-default",
+ params: {
+ overrides: { convertColors: false, },
+ },
+ },
+ ],
+ });
+ const optimizedSvgString = result.data;
+ sources[fileNames[i]] = optimizedSvgString;
+ }
+ return sources;
+}
+
+/**
+ * Returns a mapping from location (of manifest file) to an array containing all the chunks (of css files) generated from that location.
+ * To understand what chunk means in this context, see https://rollupjs.org/guide/en/#generatebundle.
+ * @param {*} bundle Mapping from fileName to AssetInfo | ChunkInfo
+ */
+function getMappingFromLocationToChunkArray(bundle) {
const chunkMap = new Map();
- const assetMap = new Map();
- let runtimeThemeChunk;
for (const [fileName, info] of Object.entries(bundle)) {
- if (!fileName.endsWith(".css")) {
- continue;
- }
- if (info.type === "asset") {
- /**
- * So this is the css assetInfo that contains the asset hashed file name.
- * We'll store it in a separate map indexed via fileName (unhashed) to avoid
- * searching through the bundle array later.
- */
- assetMap.set(info.name, info);
- continue;
- }
- if (info.facadeModuleId?.includes("type=runtime")) {
- /**
- * We have a separate field in manifest.source just for the runtime theme,
- * so store this separately.
- */
- runtimeThemeChunk = info;
+ if (!fileName.endsWith(".css") || info.type === "asset" || info.facadeModuleId?.includes("type=runtime")) {
continue;
}
const location = info.facadeModuleId?.match(/(.+)\/.+\.css/)?.[1];
@@ -80,7 +105,56 @@ function parseBundle(bundle) {
array.push(info);
}
}
- return { chunkMap, assetMap, runtimeThemeChunk };
+ return chunkMap;
+}
+
+/**
+ * Returns a mapping from unhashed file name (of css files) to AssetInfo.
+ * To understand what AssetInfo means in this context, see https://rollupjs.org/guide/en/#generatebundle.
+ * @param {*} bundle Mapping from fileName to AssetInfo | ChunkInfo
+ */
+function getMappingFromFileNameToAssetInfo(bundle) {
+ const assetMap = new Map();
+ for (const [fileName, info] of Object.entries(bundle)) {
+ if (!fileName.endsWith(".css")) {
+ continue;
+ }
+ if (info.type === "asset") {
+ /**
+ * So this is the css assetInfo that contains the asset hashed file name.
+ * We'll store it in a separate map indexed via fileName (unhashed) to avoid
+ * searching through the bundle array later.
+ */
+ assetMap.set(info.name, info);
+ }
+ }
+ return assetMap;
+}
+
+/**
+ * Returns a mapping from location (of manifest file) to ChunkInfo of the runtime css asset
+ * To understand what ChunkInfo means in this context, see https://rollupjs.org/guide/en/#generatebundle.
+ * @param {*} bundle Mapping from fileName to AssetInfo | ChunkInfo
+ */
+function getMappingFromLocationToRuntimeChunk(bundle) {
+ let runtimeThemeChunkMap = new Map();
+ for (const [fileName, info] of Object.entries(bundle)) {
+ if (!fileName.endsWith(".css") || info.type === "asset") {
+ continue;
+ }
+ const location = info.facadeModuleId?.match(/(.+)\/.+\.css/)?.[1];
+ if (!location) {
+ throw new Error("Cannot find location of css chunk!");
+ }
+ if (info.facadeModuleId?.includes("type=runtime")) {
+ /**
+ * We have a separate field in manifest.source just for the runtime theme,
+ * so store this separately.
+ */
+ runtimeThemeChunkMap.set(location, info);
+ }
+ }
+ return runtimeThemeChunkMap;
}
module.exports = function buildThemes(options) {
@@ -88,6 +162,7 @@ module.exports = function buildThemes(options) {
let isDevelopment = false;
const virtualModuleId = '@theme/'
const resolvedVirtualModuleId = '\0' + virtualModuleId;
+ const themeToManifestLocation = new Map();
return {
name: "build-themes",
@@ -100,37 +175,34 @@ module.exports = function buildThemes(options) {
},
async buildStart() {
- if (isDevelopment) { return; }
const { themeConfig } = options;
- for (const [name, location] of Object.entries(themeConfig.themes)) {
+ for (const location of themeConfig.themes) {
manifest = require(`${location}/manifest.json`);
+ const themeCollectionId = manifest.id;
+ themeToManifestLocation.set(themeCollectionId, location);
variants = manifest.values.variants;
for (const [variant, details] of Object.entries(variants)) {
- const fileName = `theme-${name}-${variant}.css`;
- if (name === themeConfig.default && details.default) {
+ const fileName = `theme-${themeCollectionId}-${variant}.css`;
+ if (themeCollectionId === themeConfig.default && details.default) {
// This is the default theme, stash the file name for later
if (details.dark) {
defaultDark = fileName;
- defaultThemes["dark"] = `${name}-${variant}`;
+ defaultThemes["dark"] = `${themeCollectionId}-${variant}`;
}
else {
defaultLight = fileName;
- defaultThemes["light"] = `${name}-${variant}`;
+ defaultThemes["light"] = `${themeCollectionId}-${variant}`;
}
}
// emit the css as built theme bundle
- this.emitFile({
- type: "chunk",
- id: `${location}/theme.css?variant=${variant}${details.dark? "&dark=true": ""}`,
- fileName,
- });
+ if (!isDevelopment) {
+ this.emitFile({ type: "chunk", id: `${location}/theme.css?variant=${variant}${details.dark ? "&dark=true" : ""}`, fileName, });
+ }
}
// emit the css as runtime theme bundle
- this.emitFile({
- type: "chunk",
- id: `${location}/theme.css?type=runtime`,
- fileName: `theme-${name}-runtime.css`,
- });
+ if (!isDevelopment) {
+ this.emitFile({ type: "chunk", id: `${location}/theme.css?type=runtime`, fileName: `theme-${themeCollectionId}-runtime.css`, });
+ }
}
},
@@ -152,7 +224,7 @@ module.exports = function buildThemes(options) {
if (theme === "default") {
theme = options.themeConfig.default;
}
- const location = options.themeConfig.themes[theme];
+ const location = themeToManifestLocation.get(theme);
const manifest = require(`${location}/manifest.json`);
const variants = manifest.values.variants;
if (!variant || variant === "default") {
@@ -245,30 +317,53 @@ module.exports = function buildThemes(options) {
];
},
- generateBundle(_, bundle) {
- // assetMap: Mapping from asset-name (eg: element-dark.css) to AssetInfo
- // chunkMap: Mapping from theme-location (eg: hydrogen-web/src/.../css/themes/element) to a list of ChunkInfo
- // types of AssetInfo and ChunkInfo can be found at https://rollupjs.org/guide/en/#generatebundle
- const { assetMap, chunkMap, runtimeThemeChunk } = parseBundle(bundle);
+ async generateBundle(_, bundle) {
+ const assetMap = getMappingFromFileNameToAssetInfo(bundle);
+ const chunkMap = getMappingFromLocationToChunkArray(bundle);
+ const runtimeThemeChunkMap = getMappingFromLocationToRuntimeChunk(bundle);
const manifestLocations = [];
+ // Location of the directory containing manifest relative to the root of the build output
+ const manifestLocation = "assets";
for (const [location, chunkArray] of chunkMap) {
const manifest = require(`${location}/manifest.json`);
const compiledVariables = options.compiledVariables.get(location);
const derivedVariables = compiledVariables["derived-variables"];
const icon = compiledVariables["icon"];
const builtAssets = {};
+ let themeKey;
for (const chunk of chunkArray) {
const [, name, variant] = chunk.fileName.match(/theme-(.+)-(.+)\.css/);
- builtAssets[`${name}-${variant}`] = assetMap.get(chunk.fileName).fileName;
+ themeKey = name;
+ const locationRelativeToBuildRoot = assetMap.get(chunk.fileName).fileName;
+ const locationRelativeToManifest = path.relative(manifestLocation, locationRelativeToBuildRoot);
+ builtAssets[`${name}-${variant}`] = locationRelativeToManifest;
}
+ // Emit the base svg icons as asset
+ const nameToAssetHashedLocation = [];
+ const nameToSource = await generateIconSourceMap(icon, location);
+ for (const [name, source] of Object.entries(nameToSource)) {
+ const ref = this.emitFile({ type: "asset", name, source });
+ const assetHashedName = this.getFileName(ref);
+ nameToAssetHashedLocation[name] = assetHashedName;
+ }
+ // Update icon section in output manifest with paths to the icon in build output
+ for (const [variable, location] of Object.entries(icon)) {
+ const [locationWithoutQueryParameters, queryParameters] = location.split("?");
+ const name = path.basename(locationWithoutQueryParameters);
+ const locationRelativeToBuildRoot = nameToAssetHashedLocation[name];
+ const locationRelativeToManifest = path.relative(manifestLocation, locationRelativeToBuildRoot);
+ icon[variable] = `${locationRelativeToManifest}?${queryParameters}`;
+ }
+ const runtimeThemeChunk = runtimeThemeChunkMap.get(location);
+ const runtimeAssetLocation = path.relative(manifestLocation, assetMap.get(runtimeThemeChunk.fileName).fileName);
manifest.source = {
"built-assets": builtAssets,
- "runtime-asset": assetMap.get(runtimeThemeChunk.fileName).fileName,
+ "runtime-asset": runtimeAssetLocation,
"derived-variables": derivedVariables,
- "icon": icon
+ "icon": icon,
};
- const name = `theme-${manifest.name}.json`;
- manifestLocations.push(`assets/${name}`);
+ const name = `theme-${themeKey}.json`;
+ manifestLocations.push(`${manifestLocation}/${name}`);
this.emitFile({
type: "asset",
name,
diff --git a/scripts/postcss/css-compile-variables.js b/scripts/postcss/css-compile-variables.js
index 63aef97f..80aedf60 100644
--- a/scripts/postcss/css-compile-variables.js
+++ b/scripts/postcss/css-compile-variables.js
@@ -112,7 +112,14 @@ function populateMapWithDerivedVariables(map, cssFileLocation, {resolvedMap, ali
...([...resolvedMap.keys()].filter(v => !aliasMap.has(v))),
...([...aliasMap.entries()].map(([alias, variable]) => `${alias}=${variable}`))
];
- map.set(location, { "derived-variables": derivedVariables });
+ const sharedObject = map.get(location);
+ const output = { "derived-variables": derivedVariables };
+ if (sharedObject) {
+ Object.assign(sharedObject, output);
+ }
+ else {
+ map.set(location, output);
+ }
}
/**
diff --git a/scripts/postcss/css-url-to-variables.js b/scripts/postcss/css-url-to-variables.js
index 82ddae82..9988a10e 100644
--- a/scripts/postcss/css-url-to-variables.js
+++ b/scripts/postcss/css-url-to-variables.js
@@ -55,7 +55,13 @@ function addResolvedVariablesToRootSelector(root, { Rule, Declaration }, urlVari
function populateMapWithIcons(map, cssFileLocation, urlVariables) {
const location = cssFileLocation.match(/(.+)\/.+\.css/)?.[1];
const sharedObject = map.get(location);
- sharedObject["icon"] = Object.fromEntries(urlVariables);
+ const output = {"icon": Object.fromEntries(urlVariables)};
+ if (sharedObject) {
+ Object.assign(sharedObject, output);
+ }
+ else {
+ map.set(location, output);
+ }
}
function *createCounter() {
@@ -75,7 +81,8 @@ module.exports = (opts = {}) => {
const urlVariables = new Map();
const counter = createCounter();
root.walkDecls(decl => findAndReplaceUrl(decl, urlVariables, counter));
- if (urlVariables.size) {
+ const cssFileLocation = root.source.input.from;
+ if (urlVariables.size && !cssFileLocation.includes("type=runtime")) {
addResolvedVariablesToRootSelector(root, { Rule, Declaration }, urlVariables);
}
if (opts.compiledVariables){
diff --git a/scripts/postcss/svg-colorizer.js b/scripts/postcss/svg-builder.mjs
similarity index 61%
rename from scripts/postcss/svg-colorizer.js
rename to scripts/postcss/svg-builder.mjs
index 06b7b14b..cbfd3637 100644
--- a/scripts/postcss/svg-colorizer.js
+++ b/scripts/postcss/svg-builder.mjs
@@ -14,12 +14,13 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-const fs = require("fs");
-const path = require("path");
-const xxhash = require('xxhashjs');
+import {readFileSync, mkdirSync, writeFileSync} from "fs";
+import {resolve} from "path";
+import {h32} from "xxhashjs";
+import {getColoredSvgString} from "../../src/platform/web/theming/shared/svg-colorizer.mjs";
function createHash(content) {
- const hasher = new xxhash.h32(0);
+ const hasher = new h32(0);
hasher.update(content);
return hasher.digest();
}
@@ -30,18 +31,14 @@ function createHash(content) {
* @param {string} primaryColor Primary color for the new svg
* @param {string} secondaryColor Secondary color for the new svg
*/
-module.exports.buildColorizedSVG = function (svgLocation, primaryColor, secondaryColor) {
- const svgCode = fs.readFileSync(svgLocation, { encoding: "utf8"});
- let coloredSVGCode = svgCode.replaceAll("#ff00ff", primaryColor);
- coloredSVGCode = coloredSVGCode.replaceAll("#00ffff", secondaryColor);
- if (svgCode === coloredSVGCode) {
- throw new Error("svg-colorizer made no color replacements! The input svg should only contain colors #ff00ff (primary, case-sensitive) and #00ffff (secondary, case-sensitive).");
- }
+export function buildColorizedSVG(svgLocation, primaryColor, secondaryColor) {
+ const svgCode = readFileSync(svgLocation, { encoding: "utf8"});
+ const coloredSVGCode = getColoredSvgString(svgCode, primaryColor, secondaryColor);
const fileName = svgLocation.match(/.+[/\\](.+\.svg)/)[1];
const outputName = `${fileName.substring(0, fileName.length - 4)}-${createHash(coloredSVGCode)}.svg`;
- const outputPath = path.resolve(__dirname, "../../.tmp");
+ const outputPath = resolve(__dirname, "./.tmp");
try {
- fs.mkdirSync(outputPath);
+ mkdirSync(outputPath);
}
catch (e) {
if (e.code !== "EEXIST") {
@@ -49,6 +46,6 @@ module.exports.buildColorizedSVG = function (svgLocation, primaryColor, secondar
}
}
const outputFile = `${outputPath}/${outputName}`;
- fs.writeFileSync(outputFile, coloredSVGCode);
+ writeFileSync(outputFile, coloredSVGCode);
return outputFile;
}
diff --git a/scripts/sdk/base-manifest.json b/scripts/sdk/base-manifest.json
index a62888a7..b00b0b62 100644
--- a/scripts/sdk/base-manifest.json
+++ b/scripts/sdk/base-manifest.json
@@ -1,7 +1,7 @@
{
"name": "hydrogen-view-sdk",
"description": "Embeddable matrix client library, including view components",
- "version": "0.0.13",
+ "version": "0.1.0",
"main": "./lib-build/hydrogen.cjs.js",
"exports": {
".": {
diff --git a/scripts/test-derived-theme/test-theme.sh b/scripts/test-derived-theme/test-theme.sh
new file mode 100755
index 00000000..6ac9b128
--- /dev/null
+++ b/scripts/test-derived-theme/test-theme.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+cp scripts/test-derived-theme/theme.json target/assets/theme-customer.json
+cat target/config.json | jq '.themeManifests += ["assets/theme-customer.json"]' | cat > target/config.temp.json
+rm target/config.json
+mv target/config.temp.json target/config.json
diff --git a/scripts/test-derived-theme/theme.json b/scripts/test-derived-theme/theme.json
new file mode 100644
index 00000000..ea7492d4
--- /dev/null
+++ b/scripts/test-derived-theme/theme.json
@@ -0,0 +1,51 @@
+{
+ "name": "Customer",
+ "extends": "element",
+ "id": "customer",
+ "values": {
+ "variants": {
+ "dark": {
+ "dark": true,
+ "default": true,
+ "name": "Dark",
+ "variables": {
+ "background-color-primary": "#21262b",
+ "background-color-secondary": "#2D3239",
+ "text-color": "#fff",
+ "accent-color": "#F03F5B",
+ "error-color": "#FF4B55",
+ "fixed-white": "#fff",
+ "room-badge": "#61708b",
+ "link-color": "#238cf5"
+ }
+ },
+ "light": {
+ "default": true,
+ "name": "Dark",
+ "variables": {
+ "background-color-primary": "#21262b",
+ "background-color-secondary": "#2D3239",
+ "text-color": "#fff",
+ "accent-color": "#F03F5B",
+ "error-color": "#FF4B55",
+ "fixed-white": "#fff",
+ "room-badge": "#61708b",
+ "link-color": "#238cf5"
+ }
+ },
+ "red": {
+ "name": "Gruvbox",
+ "variables": {
+ "background-color-primary": "#282828",
+ "background-color-secondary": "#3c3836",
+ "text-color": "#fbf1c7",
+ "accent-color": "#8ec07c",
+ "error-color": "#fb4934",
+ "fixed-white": "#fff",
+ "room-badge": "#cc241d",
+ "link-color": "#fe8019"
+ }
+ }
+ }
+ }
+}
diff --git a/src/domain/LogoutViewModel.ts b/src/domain/LogoutViewModel.ts
index 3edfcad5..b7aecc2c 100644
--- a/src/domain/LogoutViewModel.ts
+++ b/src/domain/LogoutViewModel.ts
@@ -14,18 +14,19 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import {Options, ViewModel} from "./ViewModel";
+import {Options as BaseOptions, ViewModel} from "./ViewModel";
import {Client} from "../matrix/Client.js";
+import {SegmentType} from "./navigation/index";
-type LogoutOptions = { sessionId: string; } & Options;
+type Options = { sessionId: string; } & BaseOptions;
-export class LogoutViewModel extends ViewModel {
+export class LogoutViewModel extends ViewModel {
private _sessionId: string;
private _busy: boolean;
private _showConfirm: boolean;
private _error?: Error;
- constructor(options: LogoutOptions) {
+ constructor(options: Options) {
super(options);
this._sessionId = options.sessionId;
this._busy = false;
@@ -41,7 +42,7 @@ export class LogoutViewModel extends ViewModel {
return this._busy;
}
- get cancelUrl(): string {
+ get cancelUrl(): string | undefined {
return this.urlCreator.urlForSegment("session", true);
}
diff --git a/src/domain/RootViewModel.js b/src/domain/RootViewModel.js
index 91f144c7..38ea845f 100644
--- a/src/domain/RootViewModel.js
+++ b/src/domain/RootViewModel.js
@@ -17,7 +17,7 @@ limitations under the License.
import {Client} from "../matrix/Client.js";
import {SessionViewModel} from "./session/SessionViewModel.js";
import {SessionLoadViewModel} from "./SessionLoadViewModel.js";
-import {LoginViewModel} from "./login/LoginViewModel.js";
+import {LoginViewModel} from "./login/LoginViewModel";
import {LogoutViewModel} from "./LogoutViewModel";
import {SessionPickerViewModel} from "./SessionPickerViewModel.js";
import {ViewModel} from "./ViewModel";
@@ -131,7 +131,7 @@ export class RootViewModel extends ViewModel {
// but we also want the change of screen to go through the navigation
// so we store the session container in a temporary variable that will be
// consumed by _applyNavigation, triggered by the navigation change
- //
+ //
// Also, we should not call _setSection before the navigation is in the correct state,
// as url creation (e.g. in RoomTileViewModel)
// won't be using the correct navigation base path.
diff --git a/src/domain/ViewModel.ts b/src/domain/ViewModel.ts
index 0bc52f6e..62da159f 100644
--- a/src/domain/ViewModel.ts
+++ b/src/domain/ViewModel.ts
@@ -27,17 +27,19 @@ import type {Platform} from "../platform/web/Platform";
import type {Clock} from "../platform/web/dom/Clock";
import type {ILogger} from "../logging/types";
import type {Navigation} from "./navigation/Navigation";
-import type {URLRouter} from "./navigation/URLRouter";
+import type {SegmentType} from "./navigation/index";
+import type {IURLRouter} from "./navigation/URLRouter";
-export type Options = {
- platform: Platform
- logger: ILogger
- urlCreator: URLRouter
- navigation: Navigation
- emitChange?: (params: any) => void
+export type Options = {
+ platform: Platform;
+ logger: ILogger;
+ urlCreator: IURLRouter;
+ navigation: Navigation;
+ emitChange?: (params: any) => void;
}
-export class ViewModel extends EventEmitter<{change: never}> {
+
+export class ViewModel = Options> extends EventEmitter<{change: never}> {
private disposables?: Disposables;
private _isDisposed = false;
private _options: Readonly;
@@ -47,7 +49,7 @@ export class ViewModel extends EventEmitter<{change
this._options = options;
}
- childOptions(explicitOptions: T): T & Options {
+ childOptions(explicitOptions: T): T & Options {
return Object.assign({}, this._options, explicitOptions);
}
@@ -58,11 +60,11 @@ export class ViewModel extends EventEmitter<{change
return this._options[name];
}
- observeNavigation(type: string, onChange: (value: string | true | undefined, type: string) => void) {
+ observeNavigation(type: T, onChange: (value: N[T], type: T) => void): void {
const segmentObservable = this.navigation.observe(type);
- const unsubscribe = segmentObservable.subscribe((value: string | true | undefined) => {
+ const unsubscribe = segmentObservable.subscribe((value: N[T]) => {
onChange(value, type);
- })
+ });
this.track(unsubscribe);
}
@@ -100,10 +102,10 @@ export class ViewModel extends EventEmitter<{change
// TODO: this will need to support binding
// if any of the expr is a function, assume the function is a binding, and return a binding function ourselves
- //
+ //
// translated string should probably always be bindings, unless we're fine with a refresh when changing the language?
// we probably are, if we're using routing with a url, we could just refresh.
- i18n(parts: TemplateStringsArray, ...expr: any[]) {
+ i18n(parts: TemplateStringsArray, ...expr: any[]): string {
// just concat for now
let result = "";
for (let i = 0; i < parts.length; ++i) {
@@ -135,11 +137,12 @@ export class ViewModel extends EventEmitter<{change
return this.platform.logger;
}
- get urlCreator(): URLRouter {
+ get urlCreator(): IURLRouter {
return this._options.urlCreator;
}
- get navigation(): Navigation {
- return this._options.navigation;
+ get navigation(): Navigation {
+ // typescript needs a little help here
+ return this._options.navigation as unknown as Navigation;
}
}
diff --git a/src/domain/login/LoginViewModel.js b/src/domain/login/LoginViewModel.ts
similarity index 65%
rename from src/domain/login/LoginViewModel.js
rename to src/domain/login/LoginViewModel.ts
index 63a98e76..2b57389a 100644
--- a/src/domain/login/LoginViewModel.js
+++ b/src/domain/login/LoginViewModel.ts
@@ -15,7 +15,8 @@ limitations under the License.
*/
import {Client} from "../../matrix/Client.js";
-import {ViewModel} from "../ViewModel";
+import {OidcApi} from "../../matrix/net/OidcApi.js";
+import {Options as BaseOptions, ViewModel} from "../ViewModel";
import {PasswordLoginViewModel} from "./PasswordLoginViewModel.js";
import {StartSSOLoginViewModel} from "./StartSSOLoginViewModel.js";
import {CompleteSSOLoginViewModel} from "./CompleteSSOLoginViewModel.js";
@@ -23,58 +24,112 @@ import {StartOIDCLoginViewModel} from "./StartOIDCLoginViewModel.js";
import {CompleteOIDCLoginViewModel} from "./CompleteOIDCLoginViewModel.js";
import {LoadStatus} from "../../matrix/Client.js";
import {SessionLoadViewModel} from "../SessionLoadViewModel.js";
+import {SegmentType} from "../navigation/index";
-export class LoginViewModel extends ViewModel {
- constructor(options) {
+import type {PasswordLoginMethod, SSOLoginHelper, TokenLoginMethod, ILoginMethod} from "../../matrix/login";
+import { OIDCLoginMethod } from "../../matrix/login/OIDCLoginMethod.js";
+
+type Options = {
+ defaultHomeserver: string;
+ ready: ReadyFn;
+ oidc?: { state: string, code: string };
+ loginToken?: string;
+} & BaseOptions;
+
+export class LoginViewModel extends ViewModel {
+ private _ready: ReadyFn;
+ private _loginToken?: string;
+ private _client: Client;
+ private _oidc?: { state: string, code: string };
+ private _loginOptions?: LoginOptions;
+ private _passwordLoginViewModel?: PasswordLoginViewModel;
+ private _startSSOLoginViewModel?: StartSSOLoginViewModel;
+ private _completeSSOLoginViewModel?: CompleteSSOLoginViewModel;
+ private _startOIDCLoginViewModel?: StartOIDCLoginViewModel;
+ private _completeOIDCLoginViewModel?: CompleteOIDCLoginViewModel;
+ private _loadViewModel?: SessionLoadViewModel;
+ private _loadViewModelSubscription?: () => void;
+ private _homeserver: string;
+ private _queriedHomeserver?: string;
+ private _abortHomeserverQueryTimeout?: () => void;
+ private _abortQueryOperation?: () => void;
+
+ private _hideHomeserver: boolean = false;
+ private _isBusy: boolean = false;
+ private _errorMessage: string = "";
+
+ constructor(options: Readonly) {
super(options);
const {ready, defaultHomeserver, loginToken, oidc} = options;
this._ready = ready;
this._loginToken = loginToken;
this._oidc = oidc;
this._client = new Client(this.platform);
- this._loginOptions = null;
- this._passwordLoginViewModel = null;
- this._startSSOLoginViewModel = null;
- this._completeSSOLoginViewModel = null;
- this._startOIDCLoginViewModel = null;
- this._completeOIDCLoginViewModel = null;
- this._loadViewModel = null;
- this._loadViewModelSubscription = null;
this._homeserver = defaultHomeserver;
- this._queriedHomeserver = null;
- this._errorMessage = "";
- this._hideHomeserver = false;
- this._isBusy = false;
- this._abortHomeserverQueryTimeout = null;
- this._abortQueryOperation = null;
this._initViewModels();
}
- get passwordLoginViewModel() { return this._passwordLoginViewModel; }
- get startSSOLoginViewModel() { return this._startSSOLoginViewModel; }
- get completeSSOLoginViewModel() { return this._completeSSOLoginViewModel; }
- get startOIDCLoginViewModel() { return this._startOIDCLoginViewModel; }
- get completeOIDCLoginViewModel() { return this._completeOIDCLoginViewModel; }
- get homeserver() { return this._homeserver; }
- get resolvedHomeserver() { return this._loginOptions?.homeserver; }
- get errorMessage() { return this._errorMessage; }
- get showHomeserver() { return !this._hideHomeserver; }
- get loadViewModel() { return this._loadViewModel; }
- get isBusy() { return this._isBusy; }
- get isFetchingLoginOptions() { return !!this._abortQueryOperation; }
+ get passwordLoginViewModel(): PasswordLoginViewModel {
+ return this._passwordLoginViewModel;
+ }
- goBack() {
+ get startSSOLoginViewModel(): StartSSOLoginViewModel {
+ return this._startSSOLoginViewModel;
+ }
+
+ get completeSSOLoginViewModel(): CompleteSSOLoginViewModel {
+ return this._completeSSOLoginViewModel;
+ }
+
+ get startOIDCLoginViewModel(): StartOIDCLoginViewModel {
+ return this._startOIDCLoginViewModel;
+ }
+
+ get completeOIDCLoginViewModel(): CompleteOIDCLoginViewModel {
+ return this._completeOIDCLoginViewModel;
+ }
+
+
+ get homeserver(): string {
+ return this._homeserver;
+ }
+
+ get resolvedHomeserver(): string | undefined {
+ return this._loginOptions?.homeserver;
+ }
+
+ get errorMessage(): string {
+ return this._errorMessage;
+ }
+
+ get showHomeserver(): boolean {
+ return !this._hideHomeserver;
+ }
+
+ get loadViewModel(): SessionLoadViewModel {
+ return this._loadViewModel;
+ }
+
+ get isBusy(): boolean {
+ return this._isBusy;
+ }
+
+ get isFetchingLoginOptions(): boolean {
+ return !!this._abortQueryOperation;
+ }
+
+ goBack(): void {
this.navigation.push("session");
}
- async _initViewModels() {
+ private _initViewModels(): void {
if (this._loginToken) {
this._hideHomeserver = true;
this._completeSSOLoginViewModel = this.track(new CompleteSSOLoginViewModel(
this.childOptions(
{
client: this._client,
- attemptLogin: loginMethod => this.attemptLogin(loginMethod),
+ attemptLogin: (loginMethod: TokenLoginMethod) => this.attemptLogin(loginMethod),
loginToken: this._loginToken
})));
this.emitChange("completeSSOLoginViewModel");
@@ -84,35 +139,35 @@ export class LoginViewModel extends ViewModel {
this._completeOIDCLoginViewModel = this.track(new CompleteOIDCLoginViewModel(
this.childOptions(
{
- sessionContainer: this._sessionContainer,
- attemptLogin: loginMethod => this.attemptLogin(loginMethod),
+ client: this._client,
+ attemptLogin: (loginMethod: OIDCLoginMethod) => this.attemptLogin(loginMethod),
state: this._oidc.state,
code: this._oidc.code,
})));
this.emitChange("completeOIDCLoginViewModel");
}
else {
- await this.queryHomeserver();
+ void this.queryHomeserver();
}
}
- _showPasswordLogin() {
+ private _showPasswordLogin(): void {
this._passwordLoginViewModel = this.track(new PasswordLoginViewModel(
this.childOptions({
loginOptions: this._loginOptions,
- attemptLogin: loginMethod => this.attemptLogin(loginMethod)
+ attemptLogin: (loginMethod: PasswordLoginMethod) => this.attemptLogin(loginMethod)
})));
this.emitChange("passwordLoginViewModel");
}
- _showSSOLogin() {
+ private _showSSOLogin(): void {
this._startSSOLoginViewModel = this.track(
new StartSSOLoginViewModel(this.childOptions({loginOptions: this._loginOptions}))
);
this.emitChange("startSSOLoginViewModel");
}
- async _showOIDCLogin() {
+ private async _showOIDCLogin(): Promise {
this._startOIDCLoginViewModel = this.track(
new StartOIDCLoginViewModel(this.childOptions({loginOptions: this._loginOptions}))
);
@@ -125,12 +180,12 @@ export class LoginViewModel extends ViewModel {
}
}
- _showError(message) {
+ private _showError(message: string): void {
this._errorMessage = message;
this.emitChange("errorMessage");
}
- _setBusy(status) {
+ private _setBusy(status: boolean): void {
this._isBusy = status;
this._passwordLoginViewModel?.setBusy(status);
this._startSSOLoginViewModel?.setBusy(status);
@@ -138,11 +193,11 @@ export class LoginViewModel extends ViewModel {
this.emitChange("isBusy");
}
- async attemptLogin(loginMethod) {
+ async attemptLogin(loginMethod: ILoginMethod): Promise {
this._setBusy(true);
- this._client.startWithLogin(loginMethod, {inspectAccountSetup: true});
+ void this._client.startWithLogin(loginMethod, {inspectAccountSetup: true});
const loadStatus = this._client.loadStatus;
- const handle = loadStatus.waitFor(status => status !== LoadStatus.Login);
+ const handle = loadStatus.waitFor((status: LoadStatus) => status !== LoadStatus.Login);
await handle.promise;
this._setBusy(false);
const status = loadStatus.get();
@@ -152,11 +207,11 @@ export class LoginViewModel extends ViewModel {
this._hideHomeserver = true;
this.emitChange("hideHomeserver");
this._disposeViewModels();
- this._createLoadViewModel();
+ void this._createLoadViewModel();
return null;
}
- _createLoadViewModel() {
+ private _createLoadViewModel(): void {
this._loadViewModelSubscription = this.disposeTracked(this._loadViewModelSubscription);
this._loadViewModel = this.disposeTracked(this._loadViewModel);
this._loadViewModel = this.track(
@@ -172,7 +227,7 @@ export class LoginViewModel extends ViewModel {
})
)
);
- this._loadViewModel.start();
+ void this._loadViewModel.start();
this.emitChange("loadViewModel");
this._loadViewModelSubscription = this.track(
this._loadViewModel.disposableOn("change", () => {
@@ -184,23 +239,23 @@ export class LoginViewModel extends ViewModel {
);
}
- _disposeViewModels() {
- this._startSSOLoginViewModel = this.disposeTracked(this._ssoLoginViewModel);
+ private _disposeViewModels(): void {
+ this._startSSOLoginViewModel = this.disposeTracked(this._startSSOLoginViewModel);
this._passwordLoginViewModel = this.disposeTracked(this._passwordLoginViewModel);
this._completeSSOLoginViewModel = this.disposeTracked(this._completeSSOLoginViewModel);
this._startOIDCLoginViewModel = this.disposeTracked(this._startOIDCLoginViewModel);
this.emitChange("disposeViewModels");
}
- async setHomeserver(newHomeserver) {
+ async setHomeserver(newHomeserver: string): Promise {
this._homeserver = newHomeserver;
// clear everything set by queryHomeserver
- this._loginOptions = null;
- this._queriedHomeserver = null;
+ this._loginOptions = undefined;
+ this._queriedHomeserver = undefined;
this._showError("");
this._disposeViewModels();
this._abortQueryOperation = this.disposeTracked(this._abortQueryOperation);
- this.emitChange(); // multiple fields changing
+ this.emitChange("loginViewModels"); // multiple fields changing
// also clear the timeout if it is still running
this.disposeTracked(this._abortHomeserverQueryTimeout);
const timeout = this.clock.createTimeout(1000);
@@ -215,10 +270,10 @@ export class LoginViewModel extends ViewModel {
}
}
this._abortHomeserverQueryTimeout = this.disposeTracked(this._abortHomeserverQueryTimeout);
- this.queryHomeserver();
+ void this.queryHomeserver();
}
-
- async queryHomeserver() {
+
+ async queryHomeserver(): Promise {
// don't repeat a query we've just done
if (this._homeserver === this._queriedHomeserver || this._homeserver === "") {
return;
@@ -244,7 +299,7 @@ export class LoginViewModel extends ViewModel {
if (e.name === "AbortError") {
return; //aborted, bail out
} else {
- this._loginOptions = null;
+ this._loginOptions = undefined;
}
} finally {
this._abortQueryOperation = this.disposeTracked(this._abortQueryOperation);
@@ -263,12 +318,23 @@ export class LoginViewModel extends ViewModel {
}
}
- dispose() {
+ dispose(): void {
super.dispose();
if (this._client) {
// if we move away before we're done with initial sync
// delete the session
- this._client.deleteSession();
+ void this._client.deleteSession();
}
}
}
+
+type ReadyFn = (client: Client) => void;
+
+// TODO: move to Client.js when its converted to typescript.
+type LoginOptions = {
+ homeserver: string;
+ password?: (username: string, password: string) => PasswordLoginMethod;
+ sso?: SSOLoginHelper;
+ oidc?: { issuer: string };
+ token?: (loginToken: string) => TokenLoginMethod;
+};
diff --git a/src/domain/navigation/Navigation.js b/src/domain/navigation/Navigation.ts
similarity index 65%
rename from src/domain/navigation/Navigation.js
rename to src/domain/navigation/Navigation.ts
index 340ae0d5..f5039732 100644
--- a/src/domain/navigation/Navigation.js
+++ b/src/domain/navigation/Navigation.ts
@@ -16,27 +16,49 @@ limitations under the License.
import {BaseObservableValue, ObservableValue} from "../../observable/ObservableValue";
-export class Navigation {
- constructor(allowsChild) {
+
+type AllowsChild = (parent: Segment | undefined, child: Segment) => boolean;
+
+/**
+ * OptionalValue is basically stating that if SegmentType[type] = true:
+ * - Allow this type to be optional
+ * - Give it a default value of undefined
+ * - Also allow it to be true
+ * This lets us do:
+ * const s: Segment = new Segment("create-room");
+ * instead of
+ * const s: Segment = new Segment("create-room", undefined);
+ */
+export type OptionalValue = T extends true? [(undefined | true)?]: [T];
+
+export class Navigation {
+ private readonly _allowsChild: AllowsChild;
+ private _path: Path;
+ private readonly _observables: Map> = new Map();
+ private readonly _pathObservable: ObservableValue>;
+
+ constructor(allowsChild: AllowsChild) {
this._allowsChild = allowsChild;
this._path = new Path([], allowsChild);
- this._observables = new Map();
this._pathObservable = new ObservableValue(this._path);
}
- get pathObservable() {
+ get pathObservable(): ObservableValue> {
return this._pathObservable;
}
- get path() {
+ get path(): Path {
return this._path;
}
- push(type, value = undefined) {
- return this.applyPath(this.path.with(new Segment(type, value)));
+ push(type: K, ...value: OptionalValue): void {
+ const newPath = this.path.with(new Segment(type, ...value));
+ if (newPath) {
+ this.applyPath(newPath);
+ }
}
- applyPath(path) {
+ applyPath(path: Path): void {
// Path is not exported, so you can only create a Path through Navigation,
// so we assume it respects the allowsChild rules
const oldPath = this._path;
@@ -60,7 +82,7 @@ export class Navigation {
this._pathObservable.set(this._path);
}
- observe(type) {
+ observe(type: keyof T): SegmentObservable {
let observable = this._observables.get(type);
if (!observable) {
observable = new SegmentObservable(this, type);
@@ -69,9 +91,9 @@ export class Navigation {
return observable;
}
- pathFrom(segments) {
- let parent;
- let i;
+ pathFrom(segments: Segment[]): Path {
+ let parent: Segment | undefined;
+ let i: number;
for (i = 0; i < segments.length; i += 1) {
if (!this._allowsChild(parent, segments[i])) {
return new Path(segments.slice(0, i), this._allowsChild);
@@ -81,12 +103,12 @@ export class Navigation {
return new Path(segments, this._allowsChild);
}
- segment(type, value) {
- return new Segment(type, value);
+ segment(type: K, ...value: OptionalValue): Segment {
+ return new Segment(type, ...value);
}
}
-function segmentValueEqual(a, b) {
+function segmentValueEqual(a?: T[keyof T], b?: T[keyof T]): boolean {
if (a === b) {
return true;
}
@@ -103,24 +125,29 @@ function segmentValueEqual(a, b) {
return false;
}
-export class Segment {
- constructor(type, value) {
- this.type = type;
- this.value = value === undefined ? true : value;
+
+export class Segment {
+ public value: T[K];
+
+ constructor(public type: K, ...value: OptionalValue) {
+ this.value = (value[0] === undefined ? true : value[0]) as unknown as T[K];
}
}
-class Path {
- constructor(segments = [], allowsChild) {
+class Path {
+ private readonly _segments: Segment[];
+ private readonly _allowsChild: AllowsChild;
+
+ constructor(segments: Segment[] = [], allowsChild: AllowsChild) {
this._segments = segments;
this._allowsChild = allowsChild;
}
- clone() {
+ clone(): Path {
return new Path(this._segments.slice(), this._allowsChild);
}
- with(segment) {
+ with(segment: Segment): Path | undefined {
let index = this._segments.length - 1;
do {
if (this._allowsChild(this._segments[index], segment)) {
@@ -132,10 +159,10 @@ class Path {
index -= 1;
} while(index >= -1);
// allow -1 as well so we check if the segment is allowed as root
- return null;
+ return undefined;
}
- until(type) {
+ until(type: keyof T): Path {
const index = this._segments.findIndex(s => s.type === type);
if (index !== -1) {
return new Path(this._segments.slice(0, index + 1), this._allowsChild)
@@ -143,11 +170,11 @@ class Path {
return new Path([], this._allowsChild);
}
- get(type) {
+ get(type: keyof T): Segment | undefined {
return this._segments.find(s => s.type === type);
}
- replace(segment) {
+ replace(segment: Segment): Path | undefined {
const index = this._segments.findIndex(s => s.type === segment.type);
if (index !== -1) {
const parent = this._segments[index - 1];
@@ -160,10 +187,10 @@ class Path {
}
}
}
- return null;
+ return undefined;
}
- get segments() {
+ get segments(): Segment[] {
return this._segments;
}
}
@@ -172,43 +199,49 @@ class Path {
* custom observable so it always returns what is in navigation.path, even if we haven't emitted the change yet.
* This ensures that observers of a segment can also read the most recent value of other segments.
*/
-class SegmentObservable extends BaseObservableValue {
- constructor(navigation, type) {
+class SegmentObservable extends BaseObservableValue {
+ private readonly _navigation: Navigation;
+ private _type: keyof T;
+ private _lastSetValue?: T[keyof T];
+
+ constructor(navigation: Navigation, type: keyof T) {
super();
this._navigation = navigation;
this._type = type;
this._lastSetValue = navigation.path.get(type)?.value;
}
- get() {
+ get(): T[keyof T] | undefined {
const path = this._navigation.path;
const segment = path.get(this._type);
const value = segment?.value;
return value;
}
- emitIfChanged() {
+ emitIfChanged(): void {
const newValue = this.get();
- if (!segmentValueEqual(newValue, this._lastSetValue)) {
+ if (!segmentValueEqual(newValue, this._lastSetValue)) {
this._lastSetValue = newValue;
this.emit(newValue);
}
}
}
+export type {Path};
+
export function tests() {
function createMockNavigation() {
return new Navigation((parent, {type}) => {
switch (parent?.type) {
case undefined:
- return type === "1" || "2";
+ return type === "1" || type === "2";
case "1":
return type === "1.1";
case "1.1":
return type === "1.1.1";
case "2":
- return type === "2.1" || "2.2";
+ return type === "2.1" || type === "2.2";
default:
return false;
}
@@ -216,7 +249,7 @@ export function tests() {
}
function observeTypes(nav, types) {
- const changes = [];
+ const changes: {type:string, value:any}[] = [];
for (const type of types) {
nav.observe(type).subscribe(value => {
changes.push({type, value});
@@ -225,6 +258,12 @@ export function tests() {
return changes;
}
+ type SegmentType = {
+ "foo": number;
+ "bar": number;
+ "baz": number;
+ }
+
return {
"applying a path emits an event on the observable": assert => {
const nav = createMockNavigation();
@@ -242,18 +281,18 @@ export function tests() {
assert.equal(changes[1].value, 8);
},
"path.get": assert => {
- const path = new Path([new Segment("foo", 5), new Segment("bar", 6)], () => true);
- assert.equal(path.get("foo").value, 5);
- assert.equal(path.get("bar").value, 6);
+ const path = new Path([new Segment("foo", 5), new Segment("bar", 6)], () => true);
+ assert.equal(path.get("foo")!.value, 5);
+ assert.equal(path.get("bar")!.value, 6);
},
"path.replace success": assert => {
- const path = new Path([new Segment("foo", 5), new Segment("bar", 6)], () => true);
+ const path = new Path([new Segment("foo", 5), new Segment("bar", 6)], () => true);
const newPath = path.replace(new Segment("foo", 1));
- assert.equal(newPath.get("foo").value, 1);
- assert.equal(newPath.get("bar").value, 6);
+ assert.equal(newPath!.get("foo")!.value, 1);
+ assert.equal(newPath!.get("bar")!.value, 6);
},
"path.replace not found": assert => {
- const path = new Path([new Segment("foo", 5), new Segment("bar", 6)], () => true);
+ const path = new Path([new Segment("foo", 5), new Segment("bar", 6)], () => true);
const newPath = path.replace(new Segment("baz", 1));
assert.equal(newPath, null);
}
diff --git a/src/domain/navigation/URLRouter.js b/src/domain/navigation/URLRouter.ts
similarity index 57%
rename from src/domain/navigation/URLRouter.js
rename to src/domain/navigation/URLRouter.ts
index 6620e8c9..a52f71a0 100644
--- a/src/domain/navigation/URLRouter.js
+++ b/src/domain/navigation/URLRouter.ts
@@ -14,28 +14,58 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-export class URLRouter {
- constructor({history, navigation, parseUrlPath, stringifyPath}) {
+import type {History} from "../../platform/web/dom/History.js";
+import type {Navigation, Segment, Path, OptionalValue} from "./Navigation";
+import type {SubscriptionHandle} from "../../observable/BaseObservable";
+
+type ParseURLPath = (urlPath: string, currentNavPath: Path, defaultSessionId?: string) => Segment[];
+type StringifyPath = (path: Path) => string;
+
+export interface IURLRouter {
+ attach(): void;
+ dispose(): void;
+ pushUrl(url: string): void;
+ tryRestoreLastUrl(): boolean;
+ urlForSegments(segments: Segment[]): string | undefined;
+ urlForSegment(type: K, ...value: OptionalValue): string | undefined;
+ urlUntilSegment(type: keyof T): string;
+ urlForPath(path: Path): string;
+ openRoomActionUrl(roomId: string): string;
+ createSSOCallbackURL(): string;
+ createOIDCRedirectURL(): string;
+ absoluteAppUrl(): string;
+ absoluteUrlForAsset(asset: string): string;
+ normalizeUrl(): void;
+}
+
+export class URLRouter implements IURLRouter {
+ private readonly _history: History;
+ private readonly _navigation: Navigation;
+ private readonly _parseUrlPath: ParseURLPath;
+ private readonly _stringifyPath: StringifyPath;
+ private _subscription?: SubscriptionHandle;
+ private _pathSubscription?: SubscriptionHandle;
+ private _isApplyingUrl: boolean = false;
+ private _defaultSessionId?: string;
+
+ constructor(history: History, navigation: Navigation, parseUrlPath: ParseURLPath, stringifyPath: StringifyPath) {
this._history = history;
this._navigation = navigation;
this._parseUrlPath = parseUrlPath;
this._stringifyPath = stringifyPath;
- this._subscription = null;
- this._pathSubscription = null;
- this._isApplyingUrl = false;
this._defaultSessionId = this._getLastSessionId();
}
- _getLastSessionId() {
- const navPath = this._urlAsNavPath(this._history.getLastUrl() || "");
+ private _getLastSessionId(): string | undefined {
+ const navPath = this._urlAsNavPath(this._history.getLastSessionUrl() || "");
const sessionId = navPath.get("session")?.value;
if (typeof sessionId === "string") {
return sessionId;
}
- return null;
+ return undefined;
}
- attach() {
+ attach(): void {
this._subscription = this._history.subscribe(url => this._applyUrl(url));
// subscribe to path before applying initial url
// so redirects in _applyNavPathToHistory are reflected in url bar
@@ -43,12 +73,12 @@ export class URLRouter {
this._applyUrl(this._history.get());
}
- dispose() {
- this._subscription = this._subscription();
- this._pathSubscription = this._pathSubscription();
+ dispose(): void {
+ if (this._subscription) { this._subscription = this._subscription(); }
+ if (this._pathSubscription) { this._pathSubscription = this._pathSubscription(); }
}
- _applyNavPathToHistory(path) {
+ private _applyNavPathToHistory(path: Path): void {
const url = this.urlForPath(path);
if (url !== this._history.get()) {
if (this._isApplyingUrl) {
@@ -60,7 +90,7 @@ export class URLRouter {
}
}
- _applyNavPathToNavigation(navPath) {
+ private _applyNavPathToNavigation(navPath: Path): void {
// this will cause _applyNavPathToHistory to be called,
// so set a flag whether this request came from ourselves
// (in which case it is a redirect if the url does not match the current one)
@@ -69,22 +99,22 @@ export class URLRouter {
this._isApplyingUrl = false;
}
- _urlAsNavPath(url) {
+ private _urlAsNavPath(url: string): Path {
const urlPath = this._history.urlAsPath(url);
return this._navigation.pathFrom(this._parseUrlPath(urlPath, this._navigation.path, this._defaultSessionId));
}
- _applyUrl(url) {
+ private _applyUrl(url: string): void {
const navPath = this._urlAsNavPath(url);
this._applyNavPathToNavigation(navPath);
}
- pushUrl(url) {
+ pushUrl(url: string): void {
this._history.pushUrl(url);
}
- tryRestoreLastUrl() {
- const lastNavPath = this._urlAsNavPath(this._history.getLastUrl() || "");
+ tryRestoreLastUrl(): boolean {
+ const lastNavPath = this._urlAsNavPath(this._history.getLastSessionUrl() || "");
if (lastNavPath.segments.length !== 0) {
this._applyNavPathToNavigation(lastNavPath);
return true;
@@ -92,8 +122,8 @@ export class URLRouter {
return false;
}
- urlForSegments(segments) {
- let path = this._navigation.path;
+ urlForSegments(segments: Segment[]): string | undefined {
+ let path: Path | undefined = this._navigation.path;
for (const segment of segments) {
path = path.with(segment);
if (!path) {
@@ -103,41 +133,41 @@ export class URLRouter {
return this.urlForPath(path);
}
- urlForSegment(type, value) {
- return this.urlForSegments([this._navigation.segment(type, value)]);
+ urlForSegment(type: K, ...value: OptionalValue): string | undefined {
+ return this.urlForSegments([this._navigation.segment(type, ...value)]);
}
- urlUntilSegment(type) {
+ urlUntilSegment(type: keyof T): string {
return this.urlForPath(this._navigation.path.until(type));
}
- urlForPath(path) {
+ urlForPath(path: Path): string {
return this._history.pathAsUrl(this._stringifyPath(path));
}
- openRoomActionUrl(roomId) {
+ openRoomActionUrl(roomId: string): string {
// not a segment to navigation knowns about, so append it manually
const urlPath = `${this._stringifyPath(this._navigation.path.until("session"))}/open-room/${roomId}`;
return this._history.pathAsUrl(urlPath);
}
- createSSOCallbackURL() {
+ createSSOCallbackURL(): string {
return window.location.origin;
}
- createOIDCRedirectURL() {
+ createOIDCRedirectURL(): string {
return window.location.origin;
}
- absoluteAppUrl() {
+ absoluteAppUrl(): string {
return window.location.origin;
}
- absoluteUrlForAsset(asset) {
+ absoluteUrlForAsset(asset: string): string {
return (new URL('/assets/' + asset, window.location.origin)).toString();
}
- normalizeUrl() {
+ normalizeUrl(): void {
// Remove any queryParameters from the URL
// Gets rid of the loginToken after SSO
this._history.replaceUrlSilently(`${window.location.origin}/${window.location.hash}`);
diff --git a/src/domain/navigation/index.js b/src/domain/navigation/index.ts
similarity index 73%
rename from src/domain/navigation/index.js
rename to src/domain/navigation/index.ts
index bd4dd0db..8ff0aa0b 100644
--- a/src/domain/navigation/index.js
+++ b/src/domain/navigation/index.ts
@@ -14,18 +14,46 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import {Navigation, Segment} from "./Navigation.js";
-import {URLRouter} from "./URLRouter.js";
+import {Navigation, Segment} from "./Navigation";
+import {URLRouter} from "./URLRouter";
+import type {Path, OptionalValue} from "./Navigation";
-export function createNavigation() {
+export type SegmentType = {
+ "login": true;
+ "session": string | boolean;
+ "sso": string;
+ "logout": true;
+ "room": string;
+ "rooms": string[];
+ "settings": true;
+ "create-room": true;
+ "empty-grid-tile": number;
+ "lightbox": string;
+ "right-panel": true;
+ "details": true;
+ "members": true;
+ "member": string;
+ "oidc": {
+ state: string,
+ } &
+ ({
+ code: string,
+ } | {
+ error: string,
+ errorDescription: string | null,
+ errorUri: string | null ,
+ });
+};
+
+export function createNavigation(): Navigation {
return new Navigation(allowsChild);
}
-export function createRouter({history, navigation}) {
- return new URLRouter({history, navigation, stringifyPath, parseUrlPath});
+export function createRouter({history, navigation}: {history: History, navigation: Navigation}): URLRouter {
+ return new URLRouter(history, navigation, parseUrlPath, stringifyPath);
}
-function allowsChild(parent, child) {
+function allowsChild(parent: Segment | undefined, child: Segment): boolean {
const {type} = child;
switch (parent?.type) {
case undefined:
@@ -45,8 +73,9 @@ function allowsChild(parent, child) {
}
}
-export function removeRoomFromPath(path, roomId) {
- const rooms = path.get("rooms");
+export function removeRoomFromPath(path: Path, roomId: string): Path | undefined {
+ let newPath: Path | undefined = path;
+ const rooms = newPath.get("rooms");
let roomIdGridIndex = -1;
// first delete from rooms segment
if (rooms) {
@@ -54,22 +83,22 @@ export function removeRoomFromPath(path, roomId) {
if (roomIdGridIndex !== -1) {
const idsWithoutRoom = rooms.value.slice();
idsWithoutRoom[roomIdGridIndex] = "";
- path = path.replace(new Segment("rooms", idsWithoutRoom));
+ newPath = newPath.replace(new Segment("rooms", idsWithoutRoom));
}
}
- const room = path.get("room");
+ const room = newPath!.get("room");
// then from room (which occurs with or without rooms)
if (room && room.value === roomId) {
if (roomIdGridIndex !== -1) {
- path = path.with(new Segment("empty-grid-tile", roomIdGridIndex));
+ newPath = newPath!.with(new Segment("empty-grid-tile", roomIdGridIndex));
} else {
- path = path.until("session");
+ newPath = newPath!.until("session");
}
}
- return path;
+ return newPath;
}
-function roomsSegmentWithRoom(rooms, roomId, path) {
+function roomsSegmentWithRoom(rooms: Segment, roomId: string, path: Path): Segment {
if(!rooms.value.includes(roomId)) {
const emptyGridTile = path.get("empty-grid-tile");
const oldRoom = path.get("room");
@@ -87,41 +116,44 @@ function roomsSegmentWithRoom(rooms, roomId, path) {
}
}
-function pushRightPanelSegment(array, segment, value = true) {
+function pushRightPanelSegment(array: Segment[], segment: T, ...value: OptionalValue): void {
array.push(new Segment("right-panel"));
- array.push(new Segment(segment, value));
+ array.push(new Segment(segment, ...value));
}
-export function addPanelIfNeeded(navigation, path) {
+export function addPanelIfNeeded(navigation: Navigation, path: Path): Path {
const segments = navigation.path.segments;
const i = segments.findIndex(segment => segment.type === "right-panel");
let _path = path;
if (i !== -1) {
_path = path.until("room");
- _path = _path.with(segments[i]);
- _path = _path.with(segments[i + 1]);
+ _path = _path.with(segments[i])!;
+ _path = _path.with(segments[i + 1])!;
}
return _path;
}
-export function parseUrlPath(urlPath, currentNavPath, defaultSessionId) {
- const segments = [];
+export function parseUrlPath(urlPath: string, currentNavPath: Path, defaultSessionId?: string): Segment[] {
+ const segments: Segment[] = [];
// Special case for OIDC callback
if (urlPath.includes("state")) {
const params = new URLSearchParams(urlPath);
- if (params.has("state")) {
+ const state = params.get("state");
+ const code = params.get("code");
+ const error = params.get("error");
+ if (state) {
// This is a proper OIDC callback
- if (params.has("code")) {
+ if (code) {
segments.push(new Segment("oidc", {
- state: params.get("state"),
- code: params.get("code"),
+ state,
+ code,
}));
return segments;
- } else if (params.has("error")) {
+ } else if (error) {
segments.push(new Segment("oidc", {
- state: params.get("state"),
- error: params.get("error"),
+ state,
+ error,
errorDescription: params.get("error_description"),
errorUri: params.get("error_uri"),
}));
@@ -130,10 +162,10 @@ export function parseUrlPath(urlPath, currentNavPath, defaultSessionId) {
}
}
- // substr(1) to take of initial /
- const parts = urlPath.substr(1).split("/");
+ // substring(1) to take of initial /
+ const parts = urlPath.substring(1).split("/");
const iterator = parts[Symbol.iterator]();
- let next;
+ let next;
while (!(next = iterator.next()).done) {
const type = next.value;
if (type === "rooms") {
@@ -194,9 +226,9 @@ export function parseUrlPath(urlPath, currentNavPath, defaultSessionId) {
return segments;
}
-export function stringifyPath(path) {
+export function stringifyPath(path: Path): string {
let urlPath = "";
- let prevSegment;
+ let prevSegment: Segment | undefined;
for (const segment of path.segments) {
switch (segment.type) {
case "rooms":
@@ -231,9 +263,15 @@ export function stringifyPath(path) {
}
export function tests() {
+ function createEmptyPath() {
+ const nav: Navigation = new Navigation(allowsChild);
+ const path = nav.pathFrom([]);
+ return path;
+ }
+
return {
"stringify grid url with focused empty tile": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -243,7 +281,7 @@ export function tests() {
assert.equal(urlPath, "/session/1/rooms/a,b,c/3");
},
"stringify grid url with focused room": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -253,7 +291,7 @@ export function tests() {
assert.equal(urlPath, "/session/1/rooms/a,b,c/1");
},
"stringify url with right-panel and details segment": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -265,13 +303,15 @@ export function tests() {
assert.equal(urlPath, "/session/1/rooms/a,b,c/1/details");
},
"Parse loginToken query parameter into SSO segment": assert => {
- const segments = parseUrlPath("?loginToken=a1232aSD123");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("?loginToken=a1232aSD123", path);
assert.equal(segments.length, 1);
assert.equal(segments[0].type, "sso");
assert.equal(segments[0].value, "a1232aSD123");
},
"parse grid url path with focused empty tile": assert => {
- const segments = parseUrlPath("/session/1/rooms/a,b,c/3");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("/session/1/rooms/a,b,c/3", path);
assert.equal(segments.length, 3);
assert.equal(segments[0].type, "session");
assert.equal(segments[0].value, "1");
@@ -281,7 +321,8 @@ export function tests() {
assert.equal(segments[2].value, 3);
},
"parse grid url path with focused room": assert => {
- const segments = parseUrlPath("/session/1/rooms/a,b,c/1");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("/session/1/rooms/a,b,c/1", path);
assert.equal(segments.length, 3);
assert.equal(segments[0].type, "session");
assert.equal(segments[0].value, "1");
@@ -291,7 +332,8 @@ export function tests() {
assert.equal(segments[2].value, "b");
},
"parse empty grid url": assert => {
- const segments = parseUrlPath("/session/1/rooms/");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("/session/1/rooms/", path);
assert.equal(segments.length, 3);
assert.equal(segments[0].type, "session");
assert.equal(segments[0].value, "1");
@@ -301,7 +343,8 @@ export function tests() {
assert.equal(segments[2].value, 0);
},
"parse empty grid url with focus": assert => {
- const segments = parseUrlPath("/session/1/rooms//1");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("/session/1/rooms//1", path);
assert.equal(segments.length, 3);
assert.equal(segments[0].type, "session");
assert.equal(segments[0].value, "1");
@@ -311,7 +354,7 @@ export function tests() {
assert.equal(segments[2].value, 1);
},
"parse open-room action replacing the current focused room": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -327,7 +370,7 @@ export function tests() {
assert.equal(segments[2].value, "d");
},
"parse open-room action changing focus to an existing room": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -343,7 +386,7 @@ export function tests() {
assert.equal(segments[2].value, "a");
},
"parse open-room action changing focus to an existing room with details open": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -365,7 +408,7 @@ export function tests() {
assert.equal(segments[4].value, true);
},
"open-room action should only copy over previous segments if there are no parts after open-room": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -387,7 +430,7 @@ export function tests() {
assert.equal(segments[4].value, "foo");
},
"parse open-room action setting a room in an empty tile": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
@@ -403,97 +446,101 @@ export function tests() {
assert.equal(segments[2].value, "d");
},
"parse session url path without id": assert => {
- const segments = parseUrlPath("/session");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("/session", path);
assert.equal(segments.length, 1);
assert.equal(segments[0].type, "session");
assert.strictEqual(segments[0].value, true);
},
"remove active room from grid path turns it into empty tile": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
new Segment("room", "b")
]);
const newPath = removeRoomFromPath(path, "b");
- assert.equal(newPath.segments.length, 3);
- assert.equal(newPath.segments[0].type, "session");
- assert.equal(newPath.segments[0].value, 1);
- assert.equal(newPath.segments[1].type, "rooms");
- assert.deepEqual(newPath.segments[1].value, ["a", "", "c"]);
- assert.equal(newPath.segments[2].type, "empty-grid-tile");
- assert.equal(newPath.segments[2].value, 1);
+ assert.equal(newPath?.segments.length, 3);
+ assert.equal(newPath?.segments[0].type, "session");
+ assert.equal(newPath?.segments[0].value, 1);
+ assert.equal(newPath?.segments[1].type, "rooms");
+ assert.deepEqual(newPath?.segments[1].value, ["a", "", "c"]);
+ assert.equal(newPath?.segments[2].type, "empty-grid-tile");
+ assert.equal(newPath?.segments[2].value, 1);
},
"remove inactive room from grid path": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", "c"]),
new Segment("room", "b")
]);
const newPath = removeRoomFromPath(path, "a");
- assert.equal(newPath.segments.length, 3);
- assert.equal(newPath.segments[0].type, "session");
- assert.equal(newPath.segments[0].value, 1);
- assert.equal(newPath.segments[1].type, "rooms");
- assert.deepEqual(newPath.segments[1].value, ["", "b", "c"]);
- assert.equal(newPath.segments[2].type, "room");
- assert.equal(newPath.segments[2].value, "b");
+ assert.equal(newPath?.segments.length, 3);
+ assert.equal(newPath?.segments[0].type, "session");
+ assert.equal(newPath?.segments[0].value, 1);
+ assert.equal(newPath?.segments[1].type, "rooms");
+ assert.deepEqual(newPath?.segments[1].value, ["", "b", "c"]);
+ assert.equal(newPath?.segments[2].type, "room");
+ assert.equal(newPath?.segments[2].value, "b");
},
"remove inactive room from grid path with empty tile": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("rooms", ["a", "b", ""]),
new Segment("empty-grid-tile", 3)
]);
const newPath = removeRoomFromPath(path, "b");
- assert.equal(newPath.segments.length, 3);
- assert.equal(newPath.segments[0].type, "session");
- assert.equal(newPath.segments[0].value, 1);
- assert.equal(newPath.segments[1].type, "rooms");
- assert.deepEqual(newPath.segments[1].value, ["a", "", ""]);
- assert.equal(newPath.segments[2].type, "empty-grid-tile");
- assert.equal(newPath.segments[2].value, 3);
+ assert.equal(newPath?.segments.length, 3);
+ assert.equal(newPath?.segments[0].type, "session");
+ assert.equal(newPath?.segments[0].value, 1);
+ assert.equal(newPath?.segments[1].type, "rooms");
+ assert.deepEqual(newPath?.segments[1].value, ["a", "", ""]);
+ assert.equal(newPath?.segments[2].type, "empty-grid-tile");
+ assert.equal(newPath?.segments[2].value, 3);
},
"remove active room": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("room", "b")
]);
const newPath = removeRoomFromPath(path, "b");
- assert.equal(newPath.segments.length, 1);
- assert.equal(newPath.segments[0].type, "session");
- assert.equal(newPath.segments[0].value, 1);
+ assert.equal(newPath?.segments.length, 1);
+ assert.equal(newPath?.segments[0].type, "session");
+ assert.equal(newPath?.segments[0].value, 1);
},
"remove inactive room doesn't do anything": assert => {
- const nav = new Navigation(allowsChild);
+ const nav: Navigation = new Navigation(allowsChild);
const path = nav.pathFrom([
new Segment("session", 1),
new Segment("room", "b")
]);
const newPath = removeRoomFromPath(path, "a");
- assert.equal(newPath.segments.length, 2);
- assert.equal(newPath.segments[0].type, "session");
- assert.equal(newPath.segments[0].value, 1);
- assert.equal(newPath.segments[1].type, "room");
- assert.equal(newPath.segments[1].value, "b");
+ assert.equal(newPath?.segments.length, 2);
+ assert.equal(newPath?.segments[0].type, "session");
+ assert.equal(newPath?.segments[0].value, 1);
+ assert.equal(newPath?.segments[1].type, "room");
+ assert.equal(newPath?.segments[1].value, "b");
},
"Parse OIDC callback": assert => {
- const segments = parseUrlPath("state=tc9CnLU7&code=cnmUnwIYtY7V8RrWUyhJa4yvX72jJ5Yx");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("state=tc9CnLU7&code=cnmUnwIYtY7V8RrWUyhJa4yvX72jJ5Yx", path);
assert.equal(segments.length, 1);
assert.equal(segments[0].type, "oidc");
assert.deepEqual(segments[0].value, {state: "tc9CnLU7", code: "cnmUnwIYtY7V8RrWUyhJa4yvX72jJ5Yx"});
},
"Parse OIDC error": assert => {
- const segments = parseUrlPath("state=tc9CnLU7&error=invalid_request");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("state=tc9CnLU7&error=invalid_request", path);
assert.equal(segments.length, 1);
assert.equal(segments[0].type, "oidc");
assert.deepEqual(segments[0].value, {state: "tc9CnLU7", error: "invalid_request", errorUri: null, errorDescription: null});
},
"Parse OIDC error with description": assert => {
- const segments = parseUrlPath("state=tc9CnLU7&error=invalid_request&error_description=Unsupported%20response_type%20value");
+ const path = createEmptyPath();
+ const segments = parseUrlPath("state=tc9CnLU7&error=invalid_request&error_description=Unsupported%20response_type%20value", path);
assert.equal(segments.length, 1);
assert.equal(segments[0].type, "oidc");
assert.deepEqual(segments[0].value, {state: "tc9CnLU7", error: "invalid_request", errorDescription: "Unsupported response_type value", errorUri: null});
diff --git a/src/domain/session/RoomGridViewModel.js b/src/domain/session/RoomGridViewModel.js
index a7d19054..8e443e2d 100644
--- a/src/domain/session/RoomGridViewModel.js
+++ b/src/domain/session/RoomGridViewModel.js
@@ -15,7 +15,7 @@ limitations under the License.
*/
import {ViewModel} from "../ViewModel";
-import {addPanelIfNeeded} from "../navigation/index.js";
+import {addPanelIfNeeded} from "../navigation/index";
function dedupeSparse(roomIds) {
return roomIds.map((id, idx) => {
@@ -185,7 +185,7 @@ export class RoomGridViewModel extends ViewModel {
}
}
-import {createNavigation} from "../navigation/index.js";
+import {createNavigation} from "../navigation/index";
import {ObservableValue} from "../../observable/ObservableValue";
export function tests() {
diff --git a/src/domain/session/leftpanel/LeftPanelViewModel.js b/src/domain/session/leftpanel/LeftPanelViewModel.js
index 2fd3ca7e..8c8d71a2 100644
--- a/src/domain/session/leftpanel/LeftPanelViewModel.js
+++ b/src/domain/session/leftpanel/LeftPanelViewModel.js
@@ -21,7 +21,7 @@ import {InviteTileViewModel} from "./InviteTileViewModel.js";
import {RoomBeingCreatedTileViewModel} from "./RoomBeingCreatedTileViewModel.js";
import {RoomFilter} from "./RoomFilter.js";
import {ApplyMap} from "../../../observable/map/ApplyMap.js";
-import {addPanelIfNeeded} from "../../navigation/index.js";
+import {addPanelIfNeeded} from "../../navigation/index";
export class LeftPanelViewModel extends ViewModel {
constructor(options) {
diff --git a/src/domain/session/room/RoomViewModel.js b/src/domain/session/room/RoomViewModel.js
index 66042ae5..75f90730 100644
--- a/src/domain/session/room/RoomViewModel.js
+++ b/src/domain/session/room/RoomViewModel.js
@@ -23,6 +23,7 @@ import {imageToInfo} from "../common.js";
// TODO: remove fallback so default isn't included in bundle for SDK users that have their custom tileClassForEntry
// this is a breaking SDK change though to make this option mandatory
import {tileClassForEntry as defaultTileClassForEntry} from "./timeline/tiles/index";
+import {RoomStatus} from "../../../matrix/room/common";
export class RoomViewModel extends ViewModel {
constructor(options) {
@@ -37,9 +38,9 @@ export class RoomViewModel extends ViewModel {
this._sendError = null;
this._composerVM = null;
if (room.isArchived) {
- this._composerVM = new ArchivedViewModel(this.childOptions({archivedRoom: room}));
+ this._composerVM = this.track(new ArchivedViewModel(this.childOptions({archivedRoom: room})));
} else {
- this._composerVM = new ComposerViewModel(this);
+ this._recreateComposerOnPowerLevelChange();
}
this._clearUnreadTimout = null;
this._closeUrl = this.urlCreator.urlUntilSegment("session");
@@ -67,6 +68,30 @@ export class RoomViewModel extends ViewModel {
this._clearUnreadAfterDelay();
}
+ async _recreateComposerOnPowerLevelChange() {
+ const powerLevelObservable = await this._room.observePowerLevels();
+ const canSendMessage = () => powerLevelObservable.get().canSendType("m.room.message");
+ let oldCanSendMessage = canSendMessage();
+ const recreateComposer = newCanSendMessage => {
+ this._composerVM = this.disposeTracked(this._composerVM);
+ if (newCanSendMessage) {
+ this._composerVM = this.track(new ComposerViewModel(this));
+ }
+ else {
+ this._composerVM = this.track(new LowerPowerLevelViewModel(this.childOptions()));
+ }
+ this.emitChange("powerLevelObservable")
+ };
+ this.track(powerLevelObservable.subscribe(() => {
+ const newCanSendMessage = canSendMessage();
+ if (oldCanSendMessage !== newCanSendMessage) {
+ recreateComposer(newCanSendMessage);
+ oldCanSendMessage = newCanSendMessage;
+ }
+ }));
+ recreateComposer(oldCanSendMessage);
+ }
+
async _clearUnreadAfterDelay() {
if (this._room.isArchived || this._clearUnreadTimout) {
return;
@@ -173,18 +198,89 @@ export class RoomViewModel extends ViewModel {
}
}
+ async _processCommandJoin(roomName) {
+ try {
+ const roomId = await this._options.client.session.joinRoom(roomName);
+ const roomStatusObserver = await this._options.client.session.observeRoomStatus(roomId);
+ await roomStatusObserver.waitFor(status => status === RoomStatus.Joined);
+ this.navigation.push("room", roomId);
+ } catch (err) {
+ let exc;
+ if ((err.statusCode ?? err.status) === 400) {
+ exc = new Error(`/join : '${roomName}' was not legal room ID or room alias`);
+ } else if ((err.statusCode ?? err.status) === 404 || (err.statusCode ?? err.status) === 502 || err.message == "Internal Server Error") {
+ exc = new Error(`/join : room '${roomName}' not found`);
+ } else if ((err.statusCode ?? err.status) === 403) {
+ exc = new Error(`/join : you're not invited to join '${roomName}'`);
+ } else {
+ exc = err;
+ }
+ this._sendError = exc;
+ this._timelineError = null;
+ this.emitChange("error");
+ }
+ }
+
+ async _processCommand (message) {
+ let msgtype;
+ const [commandName, ...args] = message.substring(1).split(" ");
+ switch (commandName) {
+ case "me":
+ message = args.join(" ");
+ msgtype = "m.emote";
+ break;
+ case "join":
+ if (args.length === 1) {
+ const roomName = args[0];
+ await this._processCommandJoin(roomName);
+ } else {
+ this._sendError = new Error("join syntax: /join ");
+ this._timelineError = null;
+ this.emitChange("error");
+ }
+ break;
+ case "shrug":
+ message = "¯\\_(ツ)_/¯ " + args.join(" ");
+ msgtype = "m.text";
+ break;
+ case "tableflip":
+ message = "(╯°□°）╯︵ ┻━┻ " + args.join(" ");
+ msgtype = "m.text";
+ break;
+ case "unflip":
+ message = "┬──┬ ノ( ゜-゜ノ) " + args.join(" ");
+ msgtype = "m.text";
+ break;
+ case "lenny":
+ message = "( ͡° ͜ʖ ͡°) " + args.join(" ");
+ msgtype = "m.text";
+ break;
+ default:
+ this._sendError = new Error(`no command name "${commandName}". To send the message instead of executing, please type "/${message}"`);
+ this._timelineError = null;
+ this.emitChange("error");
+ message = undefined;
+ }
+ return {type: msgtype, message: message};
+ }
+
async _sendMessage(message, replyingTo) {
if (!this._room.isArchived && message) {
+ let messinfo = {type : "m.text", message : message};
+ if (message.startsWith("//")) {
+ messinfo.message = message.substring(1).trim();
+ } else if (message.startsWith("/")) {
+ messinfo = await this._processCommand(message);
+ }
try {
- let msgtype = "m.text";
- if (message.startsWith("/me ")) {
- message = message.substr(4).trim();
- msgtype = "m.emote";
- }
- if (replyingTo) {
- await replyingTo.reply(msgtype, message);
- } else {
- await this._room.sendEvent("m.room.message", {msgtype, body: message});
+ const msgtype = messinfo.type;
+ const message = messinfo.message;
+ if (msgtype && message) {
+ if (replyingTo) {
+ await replyingTo.reply(msgtype, message);
+ } else {
+ await this._room.sendEvent("m.room.message", {msgtype, body: message});
+ }
}
} catch (err) {
console.error(`room.sendMessage(): ${err.message}:\n${err.stack}`);
@@ -329,6 +425,11 @@ export class RoomViewModel extends ViewModel {
this._composerVM.setReplyingTo(entry);
}
}
+
+ dismissError() {
+ this._sendError = null;
+ this.emitChange("error");
+ }
}
function videoToInfo(video) {
@@ -362,6 +463,16 @@ class ArchivedViewModel extends ViewModel {
}
get kind() {
- return "archived";
+ return "disabled";
+ }
+}
+
+class LowerPowerLevelViewModel extends ViewModel {
+ get description() {
+ return this.i18n`You do not have the powerlevel necessary to send messages`;
+ }
+
+ get kind() {
+ return "disabled";
}
}
diff --git a/src/lib.ts b/src/lib.ts
index 90bf597c..4d1f906f 100644
--- a/src/lib.ts
+++ b/src/lib.ts
@@ -18,7 +18,7 @@ export {Platform} from "./platform/web/Platform.js";
export {Client, LoadStatus} from "./matrix/Client.js";
export {RoomStatus} from "./matrix/room/common";
// export main view & view models
-export {createNavigation, createRouter} from "./domain/navigation/index.js";
+export {createNavigation, createRouter} from "./domain/navigation/index";
export {RootViewModel} from "./domain/RootViewModel.js";
export {RootView} from "./platform/web/ui/RootView.js";
export {SessionViewModel} from "./domain/session/SessionViewModel.js";
diff --git a/src/matrix/Client.js b/src/matrix/Client.js
index 4597b511..0cf4f5aa 100644
--- a/src/matrix/Client.js
+++ b/src/matrix/Client.js
@@ -102,6 +102,8 @@ export class Client {
});
}
+ // TODO: When converted to typescript this should return the same type
+ // as this._loginOptions is in LoginViewModel.ts (LoginOptions).
_parseLoginOptions(options, homeserver) {
/*
Take server response and return new object which has two props password and sso which
@@ -156,7 +158,7 @@ export class Client {
const request = this._platform.request;
const hsApi = new HomeServerApi({homeserver, request});
const registration = new Registration(hsApi, {
- username,
+ username,
password,
initialDeviceDisplayName,
},
@@ -333,7 +335,7 @@ export class Client {
this._status.set(LoadStatus.SessionSetup);
await log.wrap("createIdentity", log => this._session.createIdentity(log));
}
-
+
this._sync = new Sync({hsApi: this._requestScheduler.hsApi, storage: this._storage, session: this._session, logger: this._platform.logger});
// notify sync and session when back online
this._reconnectSubscription = this._reconnector.connectionStatus.subscribe(state => {
@@ -378,7 +380,7 @@ export class Client {
this._waitForFirstSyncHandle = this._sync.status.waitFor(s => {
if (s === SyncStatus.Stopped) {
// keep waiting if there is a ConnectionError
- // as the reconnector above will call
+ // as the reconnector above will call
// sync.start again to retry in this case
return this._sync.error?.name !== "ConnectionError";
}
diff --git a/src/matrix/e2ee/DeviceTracker.js b/src/matrix/e2ee/DeviceTracker.js
index f8c3bca8..484a6d0b 100644
--- a/src/matrix/e2ee/DeviceTracker.js
+++ b/src/matrix/e2ee/DeviceTracker.js
@@ -15,11 +15,13 @@ limitations under the License.
*/
import {verifyEd25519Signature, SIGNATURE_ALGORITHM} from "./common.js";
+import {HistoryVisibility, shouldShareKey} from "./common.js";
+import {RoomMember} from "../room/members/RoomMember.js";
const TRACKING_STATUS_OUTDATED = 0;
const TRACKING_STATUS_UPTODATE = 1;
-export function addRoomToIdentity(identity, userId, roomId) {
+function addRoomToIdentity(identity, userId, roomId) {
if (!identity) {
identity = {
userId: userId,
@@ -79,28 +81,57 @@ export class DeviceTracker {
}));
}
- writeMemberChanges(room, memberChanges, txn) {
- return Promise.all(Array.from(memberChanges.values()).map(async memberChange => {
- return this._applyMemberChange(memberChange, txn);
+ /** @return Promise<{added: string[], removed: string[]}> the user ids for who the room was added or removed to the userIdentity,
+ * and with who a key should be now be shared
+ **/
+ async writeMemberChanges(room, memberChanges, historyVisibility, txn) {
+ const added = [];
+ const removed = [];
+ await Promise.all(Array.from(memberChanges.values()).map(async memberChange => {
+ // keys should now be shared with this member?
+ // add the room to the userIdentity if so
+ if (shouldShareKey(memberChange.membership, historyVisibility)) {
+ if (await this._addRoomToUserIdentity(memberChange.roomId, memberChange.userId, txn)) {
+ added.push(memberChange.userId);
+ }
+ } else if (shouldShareKey(memberChange.previousMembership, historyVisibility)) {
+ // try to remove room we were previously sharing the key with the member but not anymore
+ const {roomId} = memberChange;
+ // if we left the room, remove room from all user identities in the room
+ if (memberChange.userId === this._ownUserId) {
+ const userIds = await txn.roomMembers.getAllUserIds(roomId);
+ await Promise.all(userIds.map(userId => {
+ return this._removeRoomFromUserIdentity(roomId, userId, txn);
+ }));
+ } else {
+ await this._removeRoomFromUserIdentity(roomId, memberChange.userId, txn);
+ }
+ removed.push(memberChange.userId);
+ }
}));
+ return {added, removed};
}
- async trackRoom(room, log) {
+ async trackRoom(room, historyVisibility, log) {
if (room.isTrackingMembers || !room.isEncrypted) {
return;
}
- const memberList = await room.loadMemberList(log);
+ const memberList = await room.loadMemberList(undefined, log);
+ const txn = await this._storage.readWriteTxn([
+ this._storage.storeNames.roomSummary,
+ this._storage.storeNames.userIdentities,
+ ]);
try {
- const txn = await this._storage.readWriteTxn([
- this._storage.storeNames.roomSummary,
- this._storage.storeNames.userIdentities,
- ]);
let isTrackingChanges;
try {
isTrackingChanges = room.writeIsTrackingMembers(true, txn);
const members = Array.from(memberList.members.values());
log.set("members", members.length);
- await this._writeJoinedMembers(members, txn);
+ await Promise.all(members.map(async member => {
+ if (shouldShareKey(member.membership, historyVisibility)) {
+ await this._addRoomToUserIdentity(member.roomId, member.userId, txn);
+ }
+ }));
} catch (err) {
txn.abort();
throw err;
@@ -112,21 +143,43 @@ export class DeviceTracker {
}
}
- async _writeJoinedMembers(members, txn) {
- await Promise.all(members.map(async member => {
- if (member.membership === "join") {
- await this._writeMember(member, txn);
- }
- }));
+ async writeHistoryVisibility(room, historyVisibility, syncTxn, log) {
+ const added = [];
+ const removed = [];
+ if (room.isTrackingMembers && room.isEncrypted) {
+ await log.wrap("rewriting userIdentities", async log => {
+ const memberList = await room.loadMemberList(syncTxn, log);
+ try {
+ const members = Array.from(memberList.members.values());
+ log.set("members", members.length);
+ await Promise.all(members.map(async member => {
+ if (shouldShareKey(member.membership, historyVisibility)) {
+ if (await this._addRoomToUserIdentity(member.roomId, member.userId, syncTxn)) {
+ added.push(member.userId);
+ }
+ } else {
+ if (await this._removeRoomFromUserIdentity(member.roomId, member.userId, syncTxn)) {
+ removed.push(member.userId);
+ }
+ }
+ }));
+ } finally {
+ memberList.release();
+ }
+ });
+ }
+ return {added, removed};
}
- async _writeMember(member, txn) {
+ async _addRoomToUserIdentity(roomId, userId, txn) {
const {userIdentities} = txn;
- const identity = await userIdentities.get(member.userId);
- const updatedIdentity = addRoomToIdentity(identity, member.userId, member.roomId);
+ const identity = await userIdentities.get(userId);
+ const updatedIdentity = addRoomToIdentity(identity, userId, roomId);
if (updatedIdentity) {
userIdentities.set(updatedIdentity);
+ return true;
}
+ return false;
}
async _removeRoomFromUserIdentity(roomId, userId, txn) {
@@ -141,28 +194,9 @@ export class DeviceTracker {
} else {
userIdentities.set(identity);
}
+ return true;
}
- }
-
- async _applyMemberChange(memberChange, txn) {
- // TODO: depends whether we encrypt for invited users??
- // add room
- if (memberChange.hasJoined) {
- await this._writeMember(memberChange.member, txn);
- }
- // remove room
- else if (memberChange.hasLeft) {
- const {roomId} = memberChange;
- // if we left the room, remove room from all user identities in the room
- if (memberChange.userId === this._ownUserId) {
- const userIds = await txn.roomMembers.getAllUserIds(roomId);
- await Promise.all(userIds.map(userId => {
- return this._removeRoomFromUserIdentity(roomId, userId, txn);
- }));
- } else {
- await this._removeRoomFromUserIdentity(roomId, memberChange.userId, txn);
- }
- }
+ return false;
}
async _queryKeys(userIds, hsApi, log) {
@@ -367,16 +401,18 @@ export class DeviceTracker {
import {createMockStorage} from "../../mocks/Storage";
import {Instance as NullLoggerInstance} from "../../logging/NullLogger";
+import {MemberChange} from "../room/members/RoomMember";
export function tests() {
function createUntrackedRoomMock(roomId, joinedUserIds, invitedUserIds = []) {
return {
+ id: roomId,
isTrackingMembers: false,
isEncrypted: true,
loadMemberList: () => {
- const joinedMembers = joinedUserIds.map(userId => {return {membership: "join", roomId, userId};});
- const invitedMembers = invitedUserIds.map(userId => {return {membership: "invite", roomId, userId};});
+ const joinedMembers = joinedUserIds.map(userId => {return RoomMember.fromUserId(roomId, userId, "join");});
+ const invitedMembers = invitedUserIds.map(userId => {return RoomMember.fromUserId(roomId, userId, "invite");});
const members = joinedMembers.concat(invitedMembers);
const memberMap = members.reduce((map, member) => {
map.set(member.userId, member);
@@ -440,10 +476,29 @@ export function tests() {
}
};
}
+
+ async function writeMemberListToStorage(room, storage) {
+ const txn = await storage.readWriteTxn([
+ storage.storeNames.roomMembers,
+ ]);
+ const memberList = await room.loadMemberList(txn);
+ try {
+ for (const member of memberList.members.values()) {
+ txn.roomMembers.set(member.serialize());
+ }
+ } catch (err) {
+ txn.abort();
+ throw err;
+ } finally {
+ memberList.release();
+ }
+ await txn.complete();
+ }
+
const roomId = "!abc:hs.tld";
return {
- "trackRoom only writes joined members": async assert => {
+ "trackRoom only writes joined members with history visibility of joined": async assert => {
const storage = await createMockStorage();
const tracker = new DeviceTracker({
storage,
@@ -453,7 +508,7 @@ export function tests() {
ownDeviceId: "ABCD",
});
const room = createUntrackedRoomMock(roomId, ["@alice:hs.tld", "@bob:hs.tld"], ["@charly:hs.tld"]);
- await tracker.trackRoom(room, NullLoggerInstance.item);
+ await tracker.trackRoom(room, HistoryVisibility.Joined, NullLoggerInstance.item);
const txn = await storage.readTxn([storage.storeNames.userIdentities]);
assert.deepEqual(await txn.userIdentities.get("@alice:hs.tld"), {
userId: "@alice:hs.tld",
@@ -477,7 +532,7 @@ export function tests() {
ownDeviceId: "ABCD",
});
const room = createUntrackedRoomMock(roomId, ["@alice:hs.tld", "@bob:hs.tld"]);
- await tracker.trackRoom(room, NullLoggerInstance.item);
+ await tracker.trackRoom(room, HistoryVisibility.Joined, NullLoggerInstance.item);
const hsApi = createQueryKeysHSApiMock();
const devices = await tracker.devicesForRoomMembers(roomId, ["@alice:hs.tld", "@bob:hs.tld"], hsApi, NullLoggerInstance.item);
assert.equal(devices.length, 2);
@@ -494,7 +549,7 @@ export function tests() {
ownDeviceId: "ABCD",
});
const room = createUntrackedRoomMock(roomId, ["@alice:hs.tld", "@bob:hs.tld"]);
- await tracker.trackRoom(room, NullLoggerInstance.item);
+ await tracker.trackRoom(room, HistoryVisibility.Joined, NullLoggerInstance.item);
const hsApi = createQueryKeysHSApiMock();
// query devices first time
await tracker.devicesForRoomMembers(roomId, ["@alice:hs.tld", "@bob:hs.tld"], hsApi, NullLoggerInstance.item);
@@ -512,6 +567,169 @@ export function tests() {
const txn2 = await storage.readTxn([storage.storeNames.deviceIdentities]);
// also check the modified key was not stored
assert.equal((await txn2.deviceIdentities.get("@alice:hs.tld", "device1")).ed25519Key, "ed25519:@alice:hs.tld:device1:key");
- }
+ },
+ "change history visibility from joined to invited adds invitees": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ // alice is joined, bob is invited
+ const room = await createUntrackedRoomMock(roomId,
+ ["@alice:hs.tld"], ["@bob:hs.tld"]);
+ await tracker.trackRoom(room, HistoryVisibility.Joined, NullLoggerInstance.item);
+ const txn = await storage.readWriteTxn([storage.storeNames.userIdentities, storage.storeNames.deviceIdentities]);
+ assert.equal(await txn.userIdentities.get("@bob:hs.tld"), undefined);
+ const {added, removed} = await tracker.writeHistoryVisibility(room, HistoryVisibility.Invited, txn, NullLoggerInstance.item);
+ assert.equal((await txn.userIdentities.get("@bob:hs.tld")).userId, "@bob:hs.tld");
+ assert.deepEqual(added, ["@bob:hs.tld"]);
+ assert.deepEqual(removed, []);
+ },
+ "change history visibility from invited to joined removes invitees": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ // alice is joined, bob is invited
+ const room = await createUntrackedRoomMock(roomId,
+ ["@alice:hs.tld"], ["@bob:hs.tld"]);
+ await tracker.trackRoom(room, HistoryVisibility.Invited, NullLoggerInstance.item);
+ const txn = await storage.readWriteTxn([storage.storeNames.userIdentities, storage.storeNames.deviceIdentities]);
+ assert.equal((await txn.userIdentities.get("@bob:hs.tld")).userId, "@bob:hs.tld");
+ const {added, removed} = await tracker.writeHistoryVisibility(room, HistoryVisibility.Joined, txn, NullLoggerInstance.item);
+ assert.equal(await txn.userIdentities.get("@bob:hs.tld"), undefined);
+ assert.deepEqual(added, []);
+ assert.deepEqual(removed, ["@bob:hs.tld"]);
+ },
+ "adding invitee with history visibility of invited adds room to userIdentities": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ const room = await createUntrackedRoomMock(roomId, ["@alice:hs.tld"]);
+ await tracker.trackRoom(room, HistoryVisibility.Invited, NullLoggerInstance.item);
+ const txn = await storage.readWriteTxn([storage.storeNames.userIdentities, storage.storeNames.deviceIdentities]);
+ // inviting a new member
+ const inviteChange = new MemberChange(RoomMember.fromUserId(roomId, "@bob:hs.tld", "invite"));
+ const {added, removed} = await tracker.writeMemberChanges(room, [inviteChange], HistoryVisibility.Invited, txn);
+ assert.deepEqual(added, ["@bob:hs.tld"]);
+ assert.deepEqual(removed, []);
+ assert.equal((await txn.userIdentities.get("@bob:hs.tld")).userId, "@bob:hs.tld");
+ },
+ "adding invitee with history visibility of joined doesn't add room": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ const room = await createUntrackedRoomMock(roomId, ["@alice:hs.tld"]);
+ await tracker.trackRoom(room, HistoryVisibility.Joined, NullLoggerInstance.item);
+ const txn = await storage.readWriteTxn([storage.storeNames.userIdentities, storage.storeNames.deviceIdentities]);
+ // inviting a new member
+ const inviteChange = new MemberChange(RoomMember.fromUserId(roomId, "@bob:hs.tld", "invite"));
+ const memberChanges = new Map([[inviteChange.userId, inviteChange]]);
+ const {added, removed} = await tracker.writeMemberChanges(room, memberChanges, HistoryVisibility.Joined, txn);
+ assert.deepEqual(added, []);
+ assert.deepEqual(removed, []);
+ assert.equal(await txn.userIdentities.get("@bob:hs.tld"), undefined);
+ },
+ "getting all devices after changing history visibility now includes invitees": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ const room = createUntrackedRoomMock(roomId, ["@alice:hs.tld"], ["@bob:hs.tld"]);
+ await tracker.trackRoom(room, HistoryVisibility.Invited, NullLoggerInstance.item);
+ const hsApi = createQueryKeysHSApiMock();
+ // write memberlist from room mock to mock storage,
+ // as devicesForTrackedRoom reads directly from roomMembers store.
+ await writeMemberListToStorage(room, storage);
+ const devices = await tracker.devicesForTrackedRoom(roomId, hsApi, NullLoggerInstance.item);
+ assert.equal(devices.length, 2);
+ assert.equal(devices.find(d => d.userId === "@alice:hs.tld").ed25519Key, "ed25519:@alice:hs.tld:device1:key");
+ assert.equal(devices.find(d => d.userId === "@bob:hs.tld").ed25519Key, "ed25519:@bob:hs.tld:device1:key");
+ },
+ "rejecting invite with history visibility of invited removes room from user identity": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ // alice is joined, bob is invited
+ const room = await createUntrackedRoomMock(roomId, ["@alice:hs.tld"], ["@bob:hs.tld"]);
+ await tracker.trackRoom(room, HistoryVisibility.Invited, NullLoggerInstance.item);
+ const txn = await storage.readWriteTxn([storage.storeNames.userIdentities, storage.storeNames.deviceIdentities]);
+ // reject invite
+ const inviteChange = new MemberChange(RoomMember.fromUserId(roomId, "@bob:hs.tld", "leave"), "invite");
+ const memberChanges = new Map([[inviteChange.userId, inviteChange]]);
+ const {added, removed} = await tracker.writeMemberChanges(room, memberChanges, HistoryVisibility.Invited, txn);
+ assert.deepEqual(added, []);
+ assert.deepEqual(removed, ["@bob:hs.tld"]);
+ assert.equal(await txn.userIdentities.get("@bob:hs.tld"), undefined);
+ },
+ "remove room from user identity sharing multiple rooms with us preserves other room": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ // alice is joined, bob is invited
+ const room1 = await createUntrackedRoomMock("!abc:hs.tld", ["@alice:hs.tld", "@bob:hs.tld"]);
+ const room2 = await createUntrackedRoomMock("!def:hs.tld", ["@alice:hs.tld", "@bob:hs.tld"]);
+ await tracker.trackRoom(room1, HistoryVisibility.Joined, NullLoggerInstance.item);
+ await tracker.trackRoom(room2, HistoryVisibility.Joined, NullLoggerInstance.item);
+ const txn1 = await storage.readTxn([storage.storeNames.userIdentities]);
+ assert.deepEqual((await txn1.userIdentities.get("@bob:hs.tld")).roomIds, ["!abc:hs.tld", "!def:hs.tld"]);
+ const leaveChange = new MemberChange(RoomMember.fromUserId(room2.id, "@bob:hs.tld", "leave"), "join");
+ const memberChanges = new Map([[leaveChange.userId, leaveChange]]);
+ const txn2 = await storage.readWriteTxn([storage.storeNames.userIdentities, storage.storeNames.deviceIdentities]);
+ await tracker.writeMemberChanges(room2, memberChanges, HistoryVisibility.Joined, txn2);
+ await txn2.complete();
+ const txn3 = await storage.readTxn([storage.storeNames.userIdentities]);
+ assert.deepEqual((await txn3.userIdentities.get("@bob:hs.tld")).roomIds, ["!abc:hs.tld"]);
+ },
+ "add room to user identity sharing multiple rooms with us preserves other room": async assert => {
+ const storage = await createMockStorage();
+ const tracker = new DeviceTracker({
+ storage,
+ getSyncToken: () => "token",
+ olmUtil: {ed25519_verify: () => {}}, // valid if it does not throw
+ ownUserId: "@alice:hs.tld",
+ ownDeviceId: "ABCD",
+ });
+ // alice is joined, bob is invited
+ const room1 = await createUntrackedRoomMock("!abc:hs.tld", ["@alice:hs.tld", "@bob:hs.tld"]);
+ const room2 = await createUntrackedRoomMock("!def:hs.tld", ["@alice:hs.tld", "@bob:hs.tld"]);
+ await tracker.trackRoom(room1, HistoryVisibility.Joined, NullLoggerInstance.item);
+ const txn1 = await storage.readTxn([storage.storeNames.userIdentities]);
+ assert.deepEqual((await txn1.userIdentities.get("@bob:hs.tld")).roomIds, ["!abc:hs.tld"]);
+ await tracker.trackRoom(room2, HistoryVisibility.Joined, NullLoggerInstance.item);
+ const txn2 = await storage.readTxn([storage.storeNames.userIdentities]);
+ assert.deepEqual((await txn2.userIdentities.get("@bob:hs.tld")).roomIds, ["!abc:hs.tld", "!def:hs.tld"]);
+ },
}
}
diff --git a/src/matrix/e2ee/RoomEncryption.js b/src/matrix/e2ee/RoomEncryption.js
index 80f57507..36424b02 100644
--- a/src/matrix/e2ee/RoomEncryption.js
+++ b/src/matrix/e2ee/RoomEncryption.js
@@ -19,8 +19,10 @@ import {groupEventsBySession} from "./megolm/decryption/utils";
import {mergeMap} from "../../utils/mergeMap";
import {groupBy} from "../../utils/groupBy";
import {makeTxnId} from "../common.js";
+import {iterateResponseStateEvents} from "../room/common";
const ENCRYPTED_TYPE = "m.room.encrypted";
+const ROOM_HISTORY_VISIBILITY_TYPE = "m.room.history_visibility";
// how often ensureMessageKeyIsShared can check if it needs to
// create a new outbound session
// note that encrypt could still create a new session
@@ -45,6 +47,7 @@ export class RoomEncryption {
this._isFlushingRoomKeyShares = false;
this._lastKeyPreShareTime = null;
this._keySharePromise = null;
+ this._historyVisibility = undefined;
this._disposed = false;
}
@@ -77,22 +80,68 @@ export class RoomEncryption {
this._senderDeviceCache = new Map(); // purge the sender device cache
}
- async writeMemberChanges(memberChanges, txn, log) {
- let shouldFlush = false;
- const memberChangesArray = Array.from(memberChanges.values());
- // this also clears our session if we leave the room ourselves
- if (memberChangesArray.some(m => m.hasLeft)) {
+ async writeSync(roomResponse, memberChanges, txn, log) {
+ let historyVisibility = await this._loadHistoryVisibilityIfNeeded(this._historyVisibility, txn);
+ const addedMembers = [];
+ const removedMembers = [];
+ // update the historyVisibility if needed
+ await iterateResponseStateEvents(roomResponse, event => {
+ // TODO: can the same state event appear twice? Hence we would be rewriting the useridentities twice...
+ // we'll see in the logs
+ if(event.state_key === "" && event.type === ROOM_HISTORY_VISIBILITY_TYPE) {
+ const newHistoryVisibility = event?.content?.history_visibility;
+ if (newHistoryVisibility !== historyVisibility) {
+ return log.wrap({
+ l: "history_visibility changed",
+ from: historyVisibility,
+ to: newHistoryVisibility
+ }, async log => {
+ historyVisibility = newHistoryVisibility;
+ const result = await this._deviceTracker.writeHistoryVisibility(this._room, historyVisibility, txn, log);
+ addedMembers.push(...result.added);
+ removedMembers.push(...result.removed);
+ });
+ }
+ }
+ });
+ // process member changes
+ if (memberChanges.size) {
+ const result = await this._deviceTracker.writeMemberChanges(
+ this._room, memberChanges, historyVisibility, txn);
+ addedMembers.push(...result.added);
+ removedMembers.push(...result.removed);
+ }
+ // discard key if somebody (including ourselves) left
+ if (removedMembers.length) {
log.log({
l: "discardOutboundSession",
- leftUsers: memberChangesArray.filter(m => m.hasLeft).map(m => m.userId),
+ leftUsers: removedMembers,
});
this._megolmEncryption.discardOutboundSession(this._room.id, txn);
}
- if (memberChangesArray.some(m => m.hasJoined)) {
- shouldFlush = await this._addShareRoomKeyOperationForNewMembers(memberChangesArray, txn, log);
+ let shouldFlush = false;
+ // add room to userIdentities if needed, and share the current key with them
+ if (addedMembers.length) {
+ shouldFlush = await this._addShareRoomKeyOperationForMembers(addedMembers, txn, log);
}
- await this._deviceTracker.writeMemberChanges(this._room, memberChanges, txn);
- return shouldFlush;
+ return {shouldFlush, historyVisibility};
+ }
+
+ afterSync({historyVisibility}) {
+ this._historyVisibility = historyVisibility;
+ }
+
+ async _loadHistoryVisibilityIfNeeded(historyVisibility, txn = undefined) {
+ if (!historyVisibility) {
+ if (!txn) {
+ txn = await this._storage.readTxn([this._storage.storeNames.roomState]);
+ }
+ const visibilityEntry = await txn.roomState.get(this._room.id, ROOM_HISTORY_VISIBILITY_TYPE, "");
+ if (visibilityEntry) {
+ return visibilityEntry.event?.content?.history_visibility;
+ }
+ }
+ return historyVisibility;
}
async prepareDecryptAll(events, newKeys, source, txn) {
@@ -274,10 +323,15 @@ export class RoomEncryption {
}
async _shareNewRoomKey(roomKeyMessage, hsApi, log) {
+ this._historyVisibility = await this._loadHistoryVisibilityIfNeeded(this._historyVisibility);
+ await this._deviceTracker.trackRoom(this._room, this._historyVisibility, log);
+ const devices = await this._deviceTracker.devicesForTrackedRoom(this._room.id, hsApi, log);
+ const userIds = Array.from(devices.reduce((set, device) => set.add(device.userId), new Set()));
+
let writeOpTxn = await this._storage.readWriteTxn([this._storage.storeNames.operations]);
let operation;
try {
- operation = this._writeRoomKeyShareOperation(roomKeyMessage, null, writeOpTxn);
+ operation = this._writeRoomKeyShareOperation(roomKeyMessage, userIds, writeOpTxn);
} catch (err) {
writeOpTxn.abort();
throw err;
@@ -288,8 +342,7 @@ export class RoomEncryption {
await this._processShareRoomKeyOperation(operation, hsApi, log);
}
- async _addShareRoomKeyOperationForNewMembers(memberChangesArray, txn, log) {
- const userIds = memberChangesArray.filter(m => m.hasJoined).map(m => m.userId);
+ async _addShareRoomKeyOperationForMembers(userIds, txn, log) {
const roomKeyMessage = await this._megolmEncryption.createRoomKeyMessage(
this._room.id, txn);
if (roomKeyMessage) {
@@ -342,18 +395,9 @@ export class RoomEncryption {
async _processShareRoomKeyOperation(operation, hsApi, log) {
log.set("id", operation.id);
-
- await this._deviceTracker.trackRoom(this._room, log);
- let devices;
- if (operation.userIds === null) {
- devices = await this._deviceTracker.devicesForTrackedRoom(this._room.id, hsApi, log);
- const userIds = Array.from(devices.reduce((set, device) => set.add(device.userId), new Set()));
- operation.userIds = userIds;
- await this._updateOperationsStore(operations => operations.update(operation));
- } else {
- devices = await this._deviceTracker.devicesForRoomMembers(this._room.id, operation.userIds, hsApi, log);
- }
-
+ this._historyVisibility = await this._loadHistoryVisibilityIfNeeded(this._historyVisibility);
+ await this._deviceTracker.trackRoom(this._room, this._historyVisibility, log);
+ const devices = await this._deviceTracker.devicesForRoomMembers(this._room.id, operation.userIds, hsApi, log);
const messages = await log.wrap("olm encrypt", log => this._olmEncryption.encrypt(
"m.room_key", operation.roomKeyMessage, devices, hsApi, log));
const missingDevices = devices.filter(d => !messages.some(m => m.device === d));
@@ -507,3 +551,143 @@ class BatchDecryptionResult {
}));
}
}
+
+import {createMockStorage} from "../../mocks/Storage";
+import {Clock as MockClock} from "../../mocks/Clock";
+import {poll} from "../../mocks/poll";
+import {Instance as NullLoggerInstance} from "../../logging/NullLogger";
+import {ConsoleLogger} from "../../logging/ConsoleLogger";
+import {HomeServer as MockHomeServer} from "../../mocks/HomeServer.js";
+
+export function tests() {
+ const roomId = "!abc:hs.tld";
+ return {
+ "ensureMessageKeyIsShared tracks room and passes correct history visibility to deviceTracker": async assert => {
+ const storage = await createMockStorage();
+ const megolmMock = {
+ async ensureOutboundSession() { return { }; }
+ };
+ const olmMock = {
+ async encrypt() { return []; }
+ }
+ let isRoomTracked = false;
+ let isDevicesRequested = false;
+ const deviceTracker = {
+ async trackRoom(room, historyVisibility) {
+ // only assert on first call
+ if (isRoomTracked) { return; }
+ assert(!isDevicesRequested);
+ assert.equal(room.id, roomId);
+ assert.equal(historyVisibility, "invited");
+ isRoomTracked = true;
+ },
+ async devicesForTrackedRoom() {
+ assert(isRoomTracked);
+ isDevicesRequested = true;
+ return [];
+ },
+ async devicesForRoomMembers() {
+ return [];
+ }
+ }
+ const writeTxn = await storage.readWriteTxn([storage.storeNames.roomState]);
+ writeTxn.roomState.set(roomId, {state_key: "", type: ROOM_HISTORY_VISIBILITY_TYPE, content: {
+ history_visibility: "invited"
+ }});
+ await writeTxn.complete();
+ const roomEncryption = new RoomEncryption({
+ room: {id: roomId},
+ megolmEncryption: megolmMock,
+ olmEncryption: olmMock,
+ storage,
+ deviceTracker,
+ clock: new MockClock()
+ });
+ const homeServer = new MockHomeServer();
+ const promise = roomEncryption.ensureMessageKeyIsShared(homeServer.api, NullLoggerInstance.item);
+ // need to poll because sendToDevice isn't first async step
+ const request = await poll(() => homeServer.requests.sendToDevice?.[0]);
+ request.respond({});
+ await promise;
+ assert(isRoomTracked);
+ assert(isDevicesRequested);
+ },
+ "encrypt tracks room and passes correct history visibility to deviceTracker": async assert => {
+ const storage = await createMockStorage();
+ const megolmMock = {
+ async encrypt() { return { roomKeyMessage: {} }; }
+ };
+ const olmMock = {
+ async encrypt() { return []; }
+ }
+ let isRoomTracked = false;
+ let isDevicesRequested = false;
+ const deviceTracker = {
+ async trackRoom(room, historyVisibility) {
+ // only assert on first call
+ if (isRoomTracked) { return; }
+ assert(!isDevicesRequested);
+ assert.equal(room.id, roomId);
+ assert.equal(historyVisibility, "invited");
+ isRoomTracked = true;
+ },
+ async devicesForTrackedRoom() {
+ assert(isRoomTracked);
+ isDevicesRequested = true;
+ return [];
+ },
+ async devicesForRoomMembers() {
+ return [];
+ }
+ }
+ const writeTxn = await storage.readWriteTxn([storage.storeNames.roomState]);
+ writeTxn.roomState.set(roomId, {state_key: "", type: ROOM_HISTORY_VISIBILITY_TYPE, content: {
+ history_visibility: "invited"
+ }});
+ await writeTxn.complete();
+ const roomEncryption = new RoomEncryption({
+ room: {id: roomId},
+ megolmEncryption: megolmMock,
+ olmEncryption: olmMock,
+ storage,
+ deviceTracker
+ });
+ const homeServer = new MockHomeServer();
+ const promise = roomEncryption.encrypt("m.room.message", {body: "hello"}, homeServer.api, NullLoggerInstance.item);
+ // need to poll because sendToDevice isn't first async step
+ const request = await poll(() => homeServer.requests.sendToDevice?.[0]);
+ request.respond({});
+ await promise;
+ assert(isRoomTracked);
+ assert(isDevicesRequested);
+ },
+ "writeSync passes correct history visibility to deviceTracker": async assert => {
+ const storage = await createMockStorage();
+ let isMemberChangesCalled = false;
+ const deviceTracker = {
+ async writeMemberChanges(room, memberChanges, historyVisibility, txn) {
+ assert.equal(historyVisibility, "invited");
+ isMemberChangesCalled = true;
+ return {removed: [], added: []};
+ },
+ async devicesForRoomMembers() {
+ return [];
+ }
+ }
+ const writeTxn = await storage.readWriteTxn([storage.storeNames.roomState]);
+ writeTxn.roomState.set(roomId, {state_key: "", type: ROOM_HISTORY_VISIBILITY_TYPE, content: {
+ history_visibility: "invited"
+ }});
+ const memberChanges = new Map([["@alice:hs.tld", {}]]);
+ const roomEncryption = new RoomEncryption({
+ room: {id: roomId},
+ storage,
+ deviceTracker
+ });
+ const roomResponse = {};
+ const txn = await storage.readWriteTxn([storage.storeNames.roomState]);
+ await roomEncryption.writeSync(roomResponse, memberChanges, txn, NullLoggerInstance.item);
+ assert(isMemberChangesCalled);
+ },
+ }
+}
diff --git a/src/matrix/e2ee/common.js b/src/matrix/e2ee/common.js
index 2b9d46b9..cc3bfff5 100644
--- a/src/matrix/e2ee/common.js
+++ b/src/matrix/e2ee/common.js
@@ -69,3 +69,28 @@ export function createRoomEncryptionEvent() {
}
}
}
+
+
+// Use enum when converting to TS
+export const HistoryVisibility = Object.freeze({
+ Joined: "joined",
+ Invited: "invited",
+ WorldReadable: "world_readable",
+ Shared: "shared",
+});
+
+export function shouldShareKey(membership, historyVisibility) {
+ switch (historyVisibility) {
+ case HistoryVisibility.WorldReadable:
+ return true;
+ case HistoryVisibility.Shared:
+ // was part of room at some time
+ return membership !== undefined;
+ case HistoryVisibility.Joined:
+ return membership === "join";
+ case HistoryVisibility.Invited:
+ return membership === "invite" || membership === "join";
+ default:
+ return false;
+ }
+}
diff --git a/src/matrix/login/index.ts b/src/matrix/login/index.ts
new file mode 100644
index 00000000..ba133a26
--- /dev/null
+++ b/src/matrix/login/index.ts
@@ -0,0 +1,7 @@
+import {ILoginMethod} from "./LoginMethod";
+import {PasswordLoginMethod} from "./PasswordLoginMethod";
+import {SSOLoginHelper} from "./SSOLoginHelper";
+import {TokenLoginMethod} from "./TokenLoginMethod";
+
+
+export {PasswordLoginMethod, SSOLoginHelper, TokenLoginMethod, ILoginMethod};
\ No newline at end of file
diff --git a/src/matrix/net/OidcApi.ts b/src/matrix/net/OidcApi.ts
index cb57c4ab..ca2e2739 100644
--- a/src/matrix/net/OidcApi.ts
+++ b/src/matrix/net/OidcApi.ts
@@ -15,7 +15,8 @@ limitations under the License.
*/
import type {RequestFunction} from "../../platform/types/types";
-import type {URLRouter} from "../../domain/navigation/URLRouter.js";
+import type {IURLRouter} from "../../domain/navigation/URLRouter.js";
+import type {SegmentType} from "../../domain/navigation";
const WELL_KNOWN = ".well-known/openid-configuration";
@@ -69,12 +70,12 @@ const clientIds: Record = {
},
};
-export class OidcApi {
+export class OidcApi {
_issuer: string;
_requestFn: RequestFunction;
_encoding: any;
_crypto: any;
- _urlCreator: URLRouter;
+ _urlCreator: IURLRouter;
_metadataPromise: Promise;
_registrationPromise: Promise;
diff --git a/src/matrix/room/BaseRoom.js b/src/matrix/room/BaseRoom.js
index dda3e2e5..57d2a7b2 100644
--- a/src/matrix/room/BaseRoom.js
+++ b/src/matrix/room/BaseRoom.js
@@ -243,7 +243,7 @@ export class BaseRoom extends EventEmitter {
/** @public */
- async loadMemberList(log = null) {
+ async loadMemberList(txn = undefined, log = null) {
if (this._memberList) {
// TODO: also await fetchOrLoadMembers promise here
this._memberList.retain();
@@ -254,6 +254,9 @@ export class BaseRoom extends EventEmitter {
roomId: this._roomId,
hsApi: this._hsApi,
storage: this._storage,
+ // pass in a transaction if we know we won't need to fetch (which would abort the transaction)
+ // and we want to make this operation part of the larger transaction
+ txn,
syncToken: this._getSyncToken(),
// to handle race between /members and /sync
setChangedMembersMap: map => this._changedMembersDuringSync = map,
diff --git a/src/matrix/room/Room.js b/src/matrix/room/Room.js
index 12c17580..8cc87845 100644
--- a/src/matrix/room/Room.js
+++ b/src/matrix/room/Room.js
@@ -139,11 +139,11 @@ export class Room extends BaseRoom {
}
log.set("newEntries", newEntries.length);
log.set("updatedEntries", updatedEntries.length);
- let shouldFlushKeyShares = false;
+ let encryptionChanges;
// pass member changes to device tracker
- if (roomEncryption && this.isTrackingMembers && memberChanges?.size) {
- shouldFlushKeyShares = await roomEncryption.writeMemberChanges(memberChanges, txn, log);
- log.set("shouldFlushKeyShares", shouldFlushKeyShares);
+ if (roomEncryption) {
+ encryptionChanges = await roomEncryption.writeSync(roomResponse, memberChanges, txn, log);
+ log.set("shouldFlushKeyShares", encryptionChanges.shouldFlush);
}
const allEntries = newEntries.concat(updatedEntries);
// also apply (decrypted) timeline entries to the summary changes
@@ -188,7 +188,7 @@ export class Room extends BaseRoom {
memberChanges,
heroChanges,
powerLevelsEvent,
- shouldFlushKeyShares,
+ encryptionChanges,
};
}
@@ -201,11 +201,14 @@ export class Room extends BaseRoom {
const {
summaryChanges, newEntries, updatedEntries, newLiveKey,
removedPendingEvents, memberChanges, powerLevelsEvent,
- heroChanges, roomEncryption
+ heroChanges, roomEncryption, encryptionChanges
} = changes;
log.set("id", this.id);
this._syncWriter.afterSync(newLiveKey);
this._setEncryption(roomEncryption);
+ if (this._roomEncryption) {
+ this._roomEncryption.afterSync(encryptionChanges);
+ }
if (memberChanges.size) {
if (this._changedMembersDuringSync) {
for (const [userId, memberChange] of memberChanges.entries()) {
@@ -288,8 +291,8 @@ export class Room extends BaseRoom {
}
}
- needsAfterSyncCompleted({shouldFlushKeyShares}) {
- return shouldFlushKeyShares;
+ needsAfterSyncCompleted({encryptionChanges}) {
+ return encryptionChanges?.shouldFlush;
}
/**
diff --git a/src/matrix/room/RoomBeingCreated.ts b/src/matrix/room/RoomBeingCreated.ts
index 78202203..b2c9dafb 100644
--- a/src/matrix/room/RoomBeingCreated.ts
+++ b/src/matrix/room/RoomBeingCreated.ts
@@ -37,7 +37,8 @@ type CreateRoomPayload = {
invite?: string[];
room_alias_name?: string;
creation_content?: {"m.federate": boolean};
- initial_state: {type: string; state_key: string; content: Record}[]
+ initial_state: { type: string; state_key: string; content: Record }[];
+ power_level_content_override?: Record;
}
type ImageInfo = {
@@ -62,6 +63,7 @@ type Options = {
invites?: string[];
avatar?: Avatar;
alias?: string;
+ powerLevelContentOverride?: Record;
}
function defaultE2EEStatusForType(type: RoomType): boolean {
@@ -151,6 +153,9 @@ export class RoomBeingCreated extends EventEmitter<{change: never}> {
"m.federate": false
};
}
+ if (this.options.powerLevelContentOverride) {
+ createOptions.power_level_content_override = this.options.powerLevelContentOverride;
+ }
if (this.isEncrypted) {
createOptions.initial_state.push(createRoomEncryptionEvent());
}
diff --git a/src/matrix/room/common.ts b/src/matrix/room/common.ts
index 57ab7023..4556302f 100644
--- a/src/matrix/room/common.ts
+++ b/src/matrix/room/common.ts
@@ -14,6 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
+import type {StateEvent} from "../storage/types";
+
export function getPrevContentFromStateEvent(event) {
// where to look for prev_content is a bit of a mess,
// see https://matrix.to/#/!NasysSDfxKxZBzJJoE:matrix.org/$DvrAbZJiILkOmOIuRsNoHmh2v7UO5CWp_rYhlGk34fQ?via=matrix.org&via=pixie.town&via=amorgan.xyz
@@ -40,3 +42,83 @@ export enum RoomType {
Private,
Public
}
+
+type RoomResponse = {
+ state?: {
+ events?: Array
+ },
+ timeline?: {
+ events?: Array
+ }
+}
+
+/** iterates over any state events in a sync room response, in the order that they should be applied (from older to younger events) */
+export function iterateResponseStateEvents(roomResponse: RoomResponse, callback: (StateEvent) => Promise | void): Promise | void {
+ let promises: Promise[] | undefined = undefined;
+ const callCallback = stateEvent => {
+ const result = callback(stateEvent);
+ if (result instanceof Promise) {
+ promises = promises ?? [];
+ promises.push(result);
+ }
+ };
+ // first iterate over state events, they precede the timeline
+ const stateEvents = roomResponse.state?.events;
+ if (stateEvents) {
+ for (let i = 0; i < stateEvents.length; i++) {
+ callCallback(stateEvents[i]);
+ }
+ }
+ // now see if there are any state events within the timeline
+ let timelineEvents = roomResponse.timeline?.events;
+ if (timelineEvents) {
+ for (let i = 0; i < timelineEvents.length; i++) {
+ const event = timelineEvents[i];
+ if (typeof event.state_key === "string") {
+ callCallback(event);
+ }
+ }
+ }
+ if (promises) {
+ return Promise.all(promises).then(() => undefined);
+ }
+}
+
+export function tests() {
+ return {
+ "test iterateResponseStateEvents with both state and timeline sections": assert => {
+ const roomResponse = {
+ state: {
+ events: [
+ {type: "m.room.member", state_key: "1"},
+ {type: "m.room.member", state_key: "2", content: {a: 1}},
+ ]
+ },
+ timeline: {
+ events: [
+ {type: "m.room.message"},
+ {type: "m.room.member", state_key: "3"},
+ {type: "m.room.message"},
+ {type: "m.room.member", state_key: "2", content: {a: 2}},
+ ]
+ }
+ } as unknown as RoomResponse;
+ const expectedStateKeys = ["1", "2", "3", "2"];
+ const expectedAForMember2 = [1, 2];
+ iterateResponseStateEvents(roomResponse, event => {
+ assert.strictEqual(event.type, "m.room.member");
+ assert.strictEqual(expectedStateKeys.shift(), event.state_key);
+ if (event.state_key === "2") {
+ assert.strictEqual(expectedAForMember2.shift(), event.content.a);
+ }
+ });
+ assert.strictEqual(expectedStateKeys.length, 0);
+ assert.strictEqual(expectedAForMember2.length, 0);
+ },
+ "test iterateResponseStateEvents with empty response": assert => {
+ iterateResponseStateEvents({}, () => {
+ assert.fail("no events expected");
+ });
+ }
+ }
+}
diff --git a/src/matrix/room/members/RoomMember.js b/src/matrix/room/members/RoomMember.js
index dabff972..8e00f5de 100644
--- a/src/matrix/room/members/RoomMember.js
+++ b/src/matrix/room/members/RoomMember.js
@@ -137,6 +137,10 @@ export class MemberChange {
return this.member.membership;
}
+ get wasInvited() {
+ return this.previousMembership === "invite" && this.membership !== "invite";
+ }
+
get hasLeft() {
return this.previousMembership === "join" && this.membership !== "join";
}
diff --git a/src/matrix/room/members/load.js b/src/matrix/room/members/load.js
index 5077d793..3d0556fc 100644
--- a/src/matrix/room/members/load.js
+++ b/src/matrix/room/members/load.js
@@ -17,10 +17,12 @@ limitations under the License.
import {RoomMember} from "./RoomMember.js";
-async function loadMembers({roomId, storage}) {
- const txn = await storage.readTxn([
- storage.storeNames.roomMembers,
- ]);
+async function loadMembers({roomId, storage, txn}) {
+ if (!txn) {
+ txn = await storage.readTxn([
+ storage.storeNames.roomMembers,
+ ]);
+ }
const memberDatas = await txn.roomMembers.getAll(roomId);
return memberDatas.map(d => new RoomMember(d));
}
diff --git a/src/matrix/storage/idb/StorageFactory.ts b/src/matrix/storage/idb/StorageFactory.ts
index 5cb1b6e5..1f64baf3 100644
--- a/src/matrix/storage/idb/StorageFactory.ts
+++ b/src/matrix/storage/idb/StorageFactory.ts
@@ -42,6 +42,7 @@ async function requestPersistedStorage(): Promise {
await glob.document.requestStorageAccess();
return true;
} catch (err) {
+ console.warn("requestStorageAccess threw an error:", err);
return false;
}
} else {
diff --git a/src/matrix/storage/idb/schema.ts b/src/matrix/storage/idb/schema.ts
index 7819130e..9b875f9c 100644
--- a/src/matrix/storage/idb/schema.ts
+++ b/src/matrix/storage/idb/schema.ts
@@ -2,7 +2,6 @@ import {IDOMStorage} from "./types";
import {ITransaction} from "./QueryTarget";
import {iterateCursor, NOT_DONE, reqAsPromise} from "./utils";
import {RoomMember, EVENT_TYPE as MEMBER_EVENT_TYPE} from "../../room/members/RoomMember.js";
-import {addRoomToIdentity} from "../../e2ee/DeviceTracker.js";
import {SESSION_E2EE_KEY_PREFIX} from "../../e2ee/common.js";
import {SummaryData} from "../../room/RoomSummary";
import {RoomMemberStore, MemberData} from "./stores/RoomMemberStore";
@@ -183,51 +182,12 @@ function createTimelineRelationsStore(db: IDBDatabase) : void {
db.createObjectStore("timelineRelations", {keyPath: "key"});
}
-//v11 doesn't change the schema, but ensures all userIdentities have all the roomIds they should (see #470)
-async function fixMissingRoomsInUserIdentities(db: IDBDatabase, txn: IDBTransaction, localStorage: IDOMStorage, log: ILogItem) {
- const roomSummaryStore = txn.objectStore("roomSummary");
- const trackedRoomIds: string[] = [];
- await iterateCursor(roomSummaryStore.openCursor(), roomSummary => {
- if (roomSummary.isTrackingMembers) {
- trackedRoomIds.push(roomSummary.roomId);
- }
- return NOT_DONE;
- });
- const outboundGroupSessionsStore = txn.objectStore("outboundGroupSessions");
- const userIdentitiesStore: IDBObjectStore = txn.objectStore("userIdentities");
- const roomMemberStore = txn.objectStore("roomMembers");
- for (const roomId of trackedRoomIds) {
- let foundMissing = false;
- const joinedUserIds: string[] = [];
- const memberRange = IDBKeyRange.bound(roomId, `${roomId}|${MAX_UNICODE}`, true, true);
- await log.wrap({l: "room", id: roomId}, async log => {
- await iterateCursor(roomMemberStore.openCursor(memberRange), member => {
- if (member.membership === "join") {
- joinedUserIds.push(member.userId);
- }
- return NOT_DONE;
- });
- log.set("joinedUserIds", joinedUserIds.length);
- for (const userId of joinedUserIds) {
- const identity = await reqAsPromise(userIdentitiesStore.get(userId));
- const originalRoomCount = identity?.roomIds?.length;
- const updatedIdentity = addRoomToIdentity(identity, userId, roomId);
- if (updatedIdentity) {
- log.log({l: `fixing up`, id: userId,
- roomsBefore: originalRoomCount, roomsAfter: updatedIdentity.roomIds.length});
- userIdentitiesStore.put(updatedIdentity);
- foundMissing = true;
- }
- }
- log.set("foundMissing", foundMissing);
- if (foundMissing) {
- // clear outbound megolm session,
- // so we'll create a new one on the next message that will be properly shared
- outboundGroupSessionsStore.delete(roomId);
- }
- });
- }
-}
+//v11 doesn't change the schema,
+// but ensured all userIdentities have all the roomIds they should (see #470)
+
+// 2022-07-20: The fix dated from August 2021, and have removed it now because of a
+// refactoring needed in the device tracker, which made it inconvenient to expose addRoomToIdentity
+function fixMissingRoomsInUserIdentities() {}
// v12 move ssssKey to e2ee:ssssKey so it will get backed up in the next step
async function changeSSSSKeyPrefix(db: IDBDatabase, txn: IDBTransaction) {
diff --git a/src/platform/types/config.ts b/src/platform/types/config.ts
new file mode 100644
index 00000000..8a5eabf2
--- /dev/null
+++ b/src/platform/types/config.ts
@@ -0,0 +1,64 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+export type Config = {
+ /**
+ * The default homeserver used by Hydrogen; auto filled in the login UI.
+ * eg: https://matrix.org
+ * REQUIRED
+ */
+ defaultHomeServer: string;
+ /**
+ * The submit endpoint for your preferred rageshake server.
+ * eg: https://element.io/bugreports/submit
+ * Read more about rageshake at https://github.com/matrix-org/rageshake
+ * OPTIONAL
+ */
+ bugReportEndpointUrl?: string;
+ /**
+ * Paths to theme-manifests
+ * eg: ["assets/theme-element.json", "assets/theme-awesome.json"]
+ * REQUIRED
+ */
+ themeManifests: string[];
+ /**
+ * This configures the default theme(s) used by Hydrogen.
+ * These themes appear as "Default" option in the theme chooser UI and are also
+ * used as a fallback when other themes fail to load.
+ * Whether the dark or light variant is used depends on the system preference.
+ * OPTIONAL
+ */
+ defaultTheme?: {
+ // id of light theme
+ light: string;
+ // id of dark theme
+ dark: string;
+ };
+ /**
+ * Configuration for push notifications.
+ * See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3pushersset
+ * and https://github.com/matrix-org/sygnal/blob/main/docs/applications.md#webpush
+ * OPTIONAL
+ */
+ push?: {
+ // See app_id in the request body in above link
+ appId: string;
+ // The host used for pushing notification
+ gatewayUrl: string;
+ // See pushkey in above link
+ applicationServerKey: string;
+ };
+};
diff --git a/src/platform/types/theme.ts b/src/platform/types/theme.ts
index 9a984277..9dd969de 100644
--- a/src/platform/types/theme.ts
+++ b/src/platform/types/theme.ts
@@ -22,6 +22,13 @@ export type ThemeManifest = Partial<{
version: number;
// A user-facing string that is the name for this theme-collection.
name: string;
+ // An identifier for this theme
+ id: string;
+ /**
+ * Id of the theme that this theme derives from.
+ * Only present for derived/runtime themes.
+ */
+ extends: string;
/**
* This is added to the manifest during the build process and includes data
* that is needed to load themes at runtime.
@@ -42,6 +49,12 @@ export type ThemeManifest = Partial<{
"runtime-asset": string;
// Array of derived-variables
"derived-variables": Array;
+ /**
+ * Mapping from icon variable to location of icon in build output with query parameters
+ * indicating how it should be colored for this particular theme.
+ * eg: "icon-url-1": "element-logo.86bc8565.svg?primary=accent-color"
+ */
+ icon: Record;
};
values: {
/**
@@ -60,6 +73,8 @@ type Variant = Partial<{
default: boolean;
// A user-facing string that is the name for this variant.
name: string;
+ // A boolean indicating whether this is a dark theme or not
+ dark: boolean;
/**
* Mapping from css variable to its value.
* eg: {"background-color-primary": "#21262b", ...}
diff --git a/src/platform/web/Platform.js b/src/platform/web/Platform.js
index e2ca2028..15923a86 100644
--- a/src/platform/web/Platform.js
+++ b/src/platform/web/Platform.js
@@ -38,7 +38,7 @@ import {downloadInIframe} from "./dom/download.js";
import {Disposables} from "../../utils/Disposables";
import {parseHTML} from "./parsehtml.js";
import {handleAvatarError} from "./ui/avatar";
-import {ThemeLoader} from "./ThemeLoader";
+import {ThemeLoader} from "./theming/ThemeLoader";
function addScript(src) {
return new Promise(function (resolve, reject) {
@@ -338,7 +338,7 @@ export class Platform {
document.querySelectorAll(".theme").forEach(e => e.remove());
// add new theme
const styleTag = document.createElement("link");
- styleTag.href = `./${newPath}`;
+ styleTag.href = newPath;
styleTag.rel = "stylesheet";
styleTag.type = "text/css";
styleTag.className = "theme";
diff --git a/src/platform/web/ThemeLoader.ts b/src/platform/web/ThemeLoader.ts
deleted file mode 100644
index 8c9364bc..00000000
--- a/src/platform/web/ThemeLoader.ts
+++ /dev/null
@@ -1,207 +0,0 @@
-/*
-Copyright 2020 The Matrix.org Foundation C.I.C.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-import type {ILogItem} from "../../logging/types.js";
-import type {Platform} from "./Platform.js";
-
-type NormalVariant = {
- id: string;
- cssLocation: string;
-};
-
-type DefaultVariant = {
- dark: {
- id: string;
- cssLocation: string;
- variantName: string;
- };
- light: {
- id: string;
- cssLocation: string;
- variantName: string;
- };
- default: {
- id: string;
- cssLocation: string;
- variantName: string;
- };
-}
-
-type ThemeInformation = NormalVariant | DefaultVariant;
-
-export enum ColorSchemePreference {
- Dark,
- Light
-};
-
-export class ThemeLoader {
- private _platform: Platform;
- private _themeMapping: Record;
-
- constructor(platform: Platform) {
- this._platform = platform;
- }
-
- async init(manifestLocations: string[], log?: ILogItem): Promise {
- await this._platform.logger.wrapOrRun(log, "ThemeLoader.init", async (log) => {
- this._themeMapping = {};
- const results = await Promise.all(
- manifestLocations.map( location => this._platform.request(location, { method: "GET", format: "json", cache: true, }).response())
- );
- results.forEach(({ body }) => this._populateThemeMap(body, log));
- });
- }
-
- private _populateThemeMap(manifest, log: ILogItem) {
- log.wrap("populateThemeMap", (l) => {
- /*
- After build has finished, the source section of each theme manifest
- contains `built-assets` which is a mapping from the theme-id to
- cssLocation of theme
- */
- const builtAssets: Record = manifest.source?.["built-assets"];
- const themeName = manifest.name;
- let defaultDarkVariant: any = {}, defaultLightVariant: any = {};
- for (const [themeId, cssLocation] of Object.entries(builtAssets)) {
- const variant = themeId.match(/.+-(.+)/)?.[1];
- const { name: variantName, default: isDefault, dark } = manifest.values.variants[variant!];
- const themeDisplayName = `${themeName} ${variantName}`;
- if (isDefault) {
- /**
- * This is a default variant!
- * We'll add these to the themeMapping (separately) keyed with just the
- * theme-name (i.e "Element" instead of "Element Dark").
- * We need to be able to distinguish them from other variants!
- *
- * This allows us to render radio-buttons with "dark" and
- * "light" options.
- */
- const defaultVariant = dark ? defaultDarkVariant : defaultLightVariant;
- defaultVariant.variantName = variantName;
- defaultVariant.id = themeId
- defaultVariant.cssLocation = cssLocation;
- continue;
- }
- // Non-default variants are keyed in themeMapping with "theme_name variant_name"
- // eg: "Element Dark"
- this._themeMapping[themeDisplayName] = {
- cssLocation,
- id: themeId
- };
- }
- if (defaultDarkVariant.id && defaultLightVariant.id) {
- /**
- * As mentioned above, if there's both a default dark and a default light variant,
- * add them to themeMapping separately.
- */
- const defaultVariant = this.preferredColorScheme === ColorSchemePreference.Dark ? defaultDarkVariant : defaultLightVariant;
- this._themeMapping[themeName] = { dark: defaultDarkVariant, light: defaultLightVariant, default: defaultVariant };
- }
- else {
- /**
- * If only one default variant is found (i.e only dark default or light default but not both),
- * treat it like any other variant.
- */
- const variant = defaultDarkVariant.id ? defaultDarkVariant : defaultLightVariant;
- this._themeMapping[`${themeName} ${variant.variantName}`] = { id: variant.id, cssLocation: variant.cssLocation };
- }
- //Add the default-theme as an additional option to the mapping
- const defaultThemeId = this.getDefaultTheme();
- if (defaultThemeId) {
- const themeDetails = this._findThemeDetailsFromId(defaultThemeId);
- if (themeDetails) {
- this._themeMapping["Default"] = { id: "default", cssLocation: themeDetails.cssLocation };
- }
- }
- l.log({ l: "Default Theme", theme: defaultThemeId});
- l.log({ l: "Preferred colorscheme", scheme: this.preferredColorScheme === ColorSchemePreference.Dark ? "dark" : "light" });
- l.log({ l: "Result", themeMapping: this._themeMapping });
- });
- }
-
- setTheme(themeName: string, themeVariant?: "light" | "dark" | "default", log?: ILogItem) {
- this._platform.logger.wrapOrRun(log, { l: "change theme", name: themeName, variant: themeVariant }, () => {
- let cssLocation: string;
- let themeDetails = this._themeMapping[themeName];
- if ("id" in themeDetails) {
- cssLocation = themeDetails.cssLocation;
- }
- else {
- if (!themeVariant) {
- throw new Error("themeVariant is undefined!");
- }
- cssLocation = themeDetails[themeVariant].cssLocation;
- }
- this._platform.replaceStylesheet(cssLocation);
- this._platform.settingsStorage.setString("theme-name", themeName);
- if (themeVariant) {
- this._platform.settingsStorage.setString("theme-variant", themeVariant);
- }
- else {
- this._platform.settingsStorage.remove("theme-variant");
- }
- });
- }
-
- /** Maps theme display name to theme information */
- get themeMapping(): Record {
- return this._themeMapping;
- }
-
- async getActiveTheme(): Promise<{themeName: string, themeVariant?: string}> {
- let themeName = await this._platform.settingsStorage.getString("theme-name");
- let themeVariant = await this._platform.settingsStorage.getString("theme-variant");
- if (!themeName || !this._themeMapping[themeName]) {
- themeName = "Default" in this._themeMapping ? "Default" : Object.keys(this._themeMapping)[0];
- if (!this._themeMapping[themeName][themeVariant]) {
- themeVariant = "default" in this._themeMapping[themeName] ? "default" : undefined;
- }
- }
- return { themeName, themeVariant };
- }
-
- getDefaultTheme(): string | undefined {
- switch (this.preferredColorScheme) {
- case ColorSchemePreference.Dark:
- return this._platform.config["defaultTheme"]?.dark;
- case ColorSchemePreference.Light:
- return this._platform.config["defaultTheme"]?.light;
- }
- }
-
- private _findThemeDetailsFromId(themeId: string): {themeName: string, cssLocation: string, variant?: string} | undefined {
- for (const [themeName, themeData] of Object.entries(this._themeMapping)) {
- if ("id" in themeData && themeData.id === themeId) {
- return { themeName, cssLocation: themeData.cssLocation };
- }
- else if ("light" in themeData && themeData.light?.id === themeId) {
- return { themeName, cssLocation: themeData.light.cssLocation, variant: "light" };
- }
- else if ("dark" in themeData && themeData.dark?.id === themeId) {
- return { themeName, cssLocation: themeData.dark.cssLocation, variant: "dark" };
- }
- }
- }
-
- get preferredColorScheme(): ColorSchemePreference | undefined {
- if (window.matchMedia("(prefers-color-scheme: dark)").matches) {
- return ColorSchemePreference.Dark;
- }
- else if (window.matchMedia("(prefers-color-scheme: light)").matches) {
- return ColorSchemePreference.Light;
- }
- }
-}
diff --git a/src/platform/web/dom/History.js b/src/platform/web/dom/History.js
index d51974bb..d40f501b 100644
--- a/src/platform/web/dom/History.js
+++ b/src/platform/web/dom/History.js
@@ -17,6 +17,12 @@ limitations under the License.
import {BaseObservableValue} from "../../../observable/ObservableValue";
export class History extends BaseObservableValue {
+
+ constructor() {
+ super();
+ this._lastSessionHash = undefined;
+ }
+
handleEvent(event) {
if (event.type === "hashchange") {
this.emit(this.get());
@@ -65,6 +71,7 @@ export class History extends BaseObservableValue {
}
onSubscribeFirst() {
+ this._lastSessionHash = window.localStorage?.getItem("hydrogen_last_url_hash");
window.addEventListener('hashchange', this);
}
@@ -76,7 +83,7 @@ export class History extends BaseObservableValue {
window.localStorage?.setItem("hydrogen_last_url_hash", hash);
}
- getLastUrl() {
- return window.localStorage?.getItem("hydrogen_last_url_hash");
+ getLastSessionUrl() {
+ return this._lastSessionHash;
}
}
diff --git a/src/platform/web/dom/request/common.js b/src/platform/web/dom/request/common.js
index c073cf6b..d6ed5074 100644
--- a/src/platform/web/dom/request/common.js
+++ b/src/platform/web/dom/request/common.js
@@ -30,7 +30,6 @@ export function addCacheBuster(urlStr, random = Math.random) {
export function mapAsFormData(map) {
const formData = new FormData();
for (const [name, value] of map) {
- let filename;
// Special case {name: string, blob: BlobHandle} to set a filename.
// This is the format returned by platform.openFile
if (value.blob?.nativeBlob && value.name) {
diff --git a/src/platform/web/dom/request/fetch.js b/src/platform/web/dom/request/fetch.js
index 497ad553..eb4caab6 100644
--- a/src/platform/web/dom/request/fetch.js
+++ b/src/platform/web/dom/request/fetch.js
@@ -115,6 +115,9 @@ export function createFetchRequest(createTimeout, serviceWorkerHandler) {
} else if (format === "buffer") {
body = await response.arrayBuffer();
}
+ else if (format === "text") {
+ body = await response.text();
+ }
} catch (err) {
// some error pages return html instead of json, ignore error
if (!(err.name === "SyntaxError" && status >= 400)) {
diff --git a/src/platform/web/main.js b/src/platform/web/main.js
index edc2cf14..83644456 100644
--- a/src/platform/web/main.js
+++ b/src/platform/web/main.js
@@ -17,7 +17,7 @@ limitations under the License.
// import {RecordRequester, ReplayRequester} from "./matrix/net/request/replay";
import {RootViewModel} from "../../domain/RootViewModel.js";
-import {createNavigation, createRouter} from "../../domain/navigation/index.js";
+import {createNavigation, createRouter} from "../../domain/navigation/index";
// Don't use a default export here, as we use multiple entries during legacy build,
// which does not support default exports,
// see https://github.com/rollup/plugins/tree/master/packages/multi-entry
diff --git a/src/platform/web/theming/DerivedVariables.ts b/src/platform/web/theming/DerivedVariables.ts
new file mode 100644
index 00000000..ca46a8fd
--- /dev/null
+++ b/src/platform/web/theming/DerivedVariables.ts
@@ -0,0 +1,131 @@
+/*
+Copyright 2020 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import {derive} from "./shared/color.mjs";
+
+export class DerivedVariables {
+ private _baseVariables: Record;
+ private _variablesToDerive: string[]
+ private _isDark: boolean
+ private _aliases: Record = {};
+ private _derivedAliases: string[] = [];
+
+ constructor(baseVariables: Record, variablesToDerive: string[], isDark: boolean) {
+ this._baseVariables = baseVariables;
+ this._variablesToDerive = variablesToDerive;
+ this._isDark = isDark;
+ }
+
+ toVariables(): Record {
+ const resolvedVariables: any = {};
+ this._detectAliases();
+ for (const variable of this._variablesToDerive) {
+ const resolvedValue = this._derive(variable);
+ if (resolvedValue) {
+ resolvedVariables[variable] = resolvedValue;
+ }
+ }
+ for (const [alias, variable] of Object.entries(this._aliases) as any) {
+ resolvedVariables[alias] = this._baseVariables[variable] ?? resolvedVariables[variable];
+ }
+ for (const variable of this._derivedAliases) {
+ const resolvedValue = this._deriveAlias(variable, resolvedVariables);
+ if (resolvedValue) {
+ resolvedVariables[variable] = resolvedValue;
+ }
+ }
+ return resolvedVariables;
+ }
+
+ private _detectAliases(): void {
+ const newVariablesToDerive: string[] = [];
+ for (const variable of this._variablesToDerive) {
+ const [alias, value] = variable.split("=");
+ if (value) {
+ this._aliases[alias] = value;
+ }
+ else {
+ newVariablesToDerive.push(variable);
+ }
+ }
+ this._variablesToDerive = newVariablesToDerive;
+ }
+
+ private _derive(variable: string): string | undefined {
+ const RE_VARIABLE_VALUE = /(.+)--(.+)-(.+)/;
+ const matches = variable.match(RE_VARIABLE_VALUE);
+ if (matches) {
+ const [, baseVariable, operation, argument] = matches;
+ const value = this._baseVariables[baseVariable];
+ if (!value ) {
+ if (this._aliases[baseVariable]) {
+ this._derivedAliases.push(variable);
+ return;
+ }
+ else {
+ throw new Error(`Cannot find value for base variable "${baseVariable}"!`);
+ }
+ }
+ const resolvedValue = derive(value, operation, argument, this._isDark);
+ return resolvedValue;
+ }
+ }
+
+ private _deriveAlias(variable: string, resolvedVariables: Record): string | undefined {
+ const RE_VARIABLE_VALUE = /(.+)--(.+)-(.+)/;
+ const matches = variable.match(RE_VARIABLE_VALUE);
+ if (matches) {
+ const [, baseVariable, operation, argument] = matches;
+ const value = resolvedVariables[baseVariable];
+ if (!value ) {
+ throw new Error(`Cannot find value for alias "${baseVariable}" when trying to derive ${variable}!`);
+ }
+ const resolvedValue = derive(value, operation, argument, this._isDark);
+ return resolvedValue;
+ }
+ }
+}
+
+import * as pkg from "off-color";
+// @ts-ignore
+const offColor = pkg.offColor ?? pkg.default.offColor;
+
+export function tests() {
+ return {
+ "Simple variable derivation": assert => {
+ const deriver = new DerivedVariables({ "background-color": "#ff00ff" }, ["background-color--darker-5"], false);
+ const result = deriver.toVariables();
+ const resultColor = offColor("#ff00ff").darken(5/100).hex();
+ assert.deepEqual(result, {"background-color--darker-5": resultColor});
+ },
+
+ "For dark themes, lighten and darken are inverted": assert => {
+ const deriver = new DerivedVariables({ "background-color": "#ff00ff" }, ["background-color--darker-5"], true);
+ const result = deriver.toVariables();
+ const resultColor = offColor("#ff00ff").lighten(5/100).hex();
+ assert.deepEqual(result, {"background-color--darker-5": resultColor});
+ },
+
+ "Aliases can be derived": assert => {
+ const deriver = new DerivedVariables({ "background-color": "#ff00ff" }, ["my-awesome-alias=background-color","my-awesome-alias--darker-5"], false);
+ const result = deriver.toVariables();
+ const resultColor = offColor("#ff00ff").darken(5/100).hex();
+ assert.deepEqual(result, {
+ "my-awesome-alias": "#ff00ff",
+ "my-awesome-alias--darker-5": resultColor,
+ });
+ },
+ }
+}
diff --git a/src/platform/web/theming/IconColorizer.ts b/src/platform/web/theming/IconColorizer.ts
new file mode 100644
index 00000000..e02c0971
--- /dev/null
+++ b/src/platform/web/theming/IconColorizer.ts
@@ -0,0 +1,79 @@
+/*
+Copyright 2020 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import type {Platform} from "../Platform.js";
+import {getColoredSvgString} from "./shared/svg-colorizer.mjs";
+
+type ParsedStructure = {
+ [variableName: string]: {
+ svg: Promise<{ status: number; body: string }>;
+ primary: string | null;
+ secondary: string | null;
+ };
+};
+
+export class IconColorizer {
+ private _iconVariables: Record;
+ private _resolvedVariables: Record;
+ private _manifestLocation: string;
+ private _platform: Platform;
+
+ constructor(platform: Platform, iconVariables: Record, resolvedVariables: Record, manifestLocation: string) {
+ this._platform = platform;
+ this._iconVariables = iconVariables;
+ this._resolvedVariables = resolvedVariables;
+ this._manifestLocation = manifestLocation;
+ }
+
+ async toVariables(): Promise> {
+ const { parsedStructure, promises } = await this._fetchAndParseIcons();
+ await Promise.all(promises);
+ return this._produceColoredIconVariables(parsedStructure);
+ }
+
+ private async _fetchAndParseIcons(): Promise<{ parsedStructure: ParsedStructure, promises: any[] }> {
+ const promises: any[] = [];
+ const parsedStructure: ParsedStructure = {};
+ for (const [variable, url] of Object.entries(this._iconVariables)) {
+ const urlObject = new URL(`https://${url}`);
+ const pathWithoutQueryParams = urlObject.hostname;
+ const relativePath = new URL(pathWithoutQueryParams, new URL(this._manifestLocation, window.location.origin));
+ const responsePromise = this._platform.request(relativePath, { method: "GET", format: "text", cache: true, }).response()
+ promises.push(responsePromise);
+ const searchParams = urlObject.searchParams;
+ parsedStructure[variable] = {
+ svg: responsePromise,
+ primary: searchParams.get("primary"),
+ secondary: searchParams.get("secondary")
+ };
+ }
+ return { parsedStructure, promises };
+ }
+
+ private async _produceColoredIconVariables(parsedStructure: ParsedStructure): Promise> {
+ let coloredVariables: Record = {};
+ for (const [variable, { svg, primary, secondary }] of Object.entries(parsedStructure)) {
+ const { body: svgCode } = await svg;
+ if (!primary) {
+ throw new Error(`Primary color variable ${primary} not in list of variables!`);
+ }
+ const primaryColor = this._resolvedVariables[primary], secondaryColor = this._resolvedVariables[secondary!];
+ const coloredSvgCode = getColoredSvgString(svgCode, primaryColor, secondaryColor);
+ const dataURI = `url('data:image/svg+xml;utf8,${encodeURIComponent(coloredSvgCode)}')`;
+ coloredVariables[variable] = dataURI;
+ }
+ return coloredVariables;
+ }
+}
diff --git a/src/platform/web/theming/ThemeLoader.ts b/src/platform/web/theming/ThemeLoader.ts
new file mode 100644
index 00000000..be1bafc0
--- /dev/null
+++ b/src/platform/web/theming/ThemeLoader.ts
@@ -0,0 +1,188 @@
+/*
+Copyright 2020 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import type {ILogItem} from "../../../logging/types";
+import type {Platform} from "../Platform.js";
+import {RuntimeThemeParser} from "./parsers/RuntimeThemeParser";
+import type {Variant, ThemeInformation} from "./parsers/types";
+import {ColorSchemePreference} from "./parsers/types";
+import {BuiltThemeParser} from "./parsers/BuiltThemeParser";
+
+export class ThemeLoader {
+ private _platform: Platform;
+ private _themeMapping: Record;
+ private _injectedVariables?: Record;
+
+ constructor(platform: Platform) {
+ this._platform = platform;
+ }
+
+ async init(manifestLocations: string[], log?: ILogItem): Promise {
+ await this._platform.logger.wrapOrRun(log, "ThemeLoader.init", async (log) => {
+ const results = await Promise.all(
+ manifestLocations.map(location => this._platform.request(location, { method: "GET", format: "json", cache: true, }).response())
+ );
+ const runtimeThemeParser = new RuntimeThemeParser(this._platform, this.preferredColorScheme);
+ const builtThemeParser = new BuiltThemeParser(this.preferredColorScheme);
+ const runtimeThemePromises: Promise[] = [];
+ for (let i = 0; i < results.length; ++i) {
+ const { body } = results[i];
+ try {
+ if (body.extends) {
+ const indexOfBaseManifest = results.findIndex(manifest => manifest.body.id === body.extends);
+ if (indexOfBaseManifest === -1) {
+ throw new Error(`Base manifest for derived theme at ${manifestLocations[i]} not found!`);
+ }
+ const {body: baseManifest} = results[indexOfBaseManifest];
+ const baseManifestLocation = manifestLocations[indexOfBaseManifest];
+ const promise = runtimeThemeParser.parse(body, baseManifest, baseManifestLocation, log);
+ runtimeThemePromises.push(promise);
+ }
+ else {
+ builtThemeParser.parse(body, manifestLocations[i], log);
+ }
+ }
+ catch(e) {
+ console.error(e);
+ }
+ }
+ await Promise.all(runtimeThemePromises);
+ this._themeMapping = { ...builtThemeParser.themeMapping, ...runtimeThemeParser.themeMapping };
+ Object.assign(this._themeMapping, builtThemeParser.themeMapping, runtimeThemeParser.themeMapping);
+ this._addDefaultThemeToMapping(log);
+ log.log({ l: "Preferred colorscheme", scheme: this.preferredColorScheme === ColorSchemePreference.Dark ? "dark" : "light" });
+ log.log({ l: "Result", themeMapping: this._themeMapping });
+ });
+ }
+
+ setTheme(themeName: string, themeVariant?: "light" | "dark" | "default", log?: ILogItem) {
+ this._platform.logger.wrapOrRun(log, { l: "change theme", name: themeName, variant: themeVariant }, () => {
+ let cssLocation: string, variables: Record;
+ let themeDetails = this._themeMapping[themeName];
+ if ("id" in themeDetails) {
+ cssLocation = themeDetails.cssLocation;
+ variables = themeDetails.variables;
+ }
+ else {
+ if (!themeVariant) {
+ throw new Error("themeVariant is undefined!");
+ }
+ cssLocation = themeDetails[themeVariant].cssLocation;
+ variables = themeDetails[themeVariant].variables;
+ }
+ this._platform.replaceStylesheet(cssLocation);
+ if (variables) {
+ log?.log({l: "Derived Theme", variables});
+ this._injectCSSVariables(variables);
+ }
+ else {
+ this._removePreviousCSSVariables();
+ }
+ this._platform.settingsStorage.setString("theme-name", themeName);
+ if (themeVariant) {
+ this._platform.settingsStorage.setString("theme-variant", themeVariant);
+ }
+ else {
+ this._platform.settingsStorage.remove("theme-variant");
+ }
+ });
+ }
+
+ private _injectCSSVariables(variables: Record): void {
+ const root = document.documentElement;
+ for (const [variable, value] of Object.entries(variables)) {
+ root.style.setProperty(`--${variable}`, value);
+ }
+ this._injectedVariables = variables;
+ }
+
+ private _removePreviousCSSVariables(): void {
+ if (!this._injectedVariables) {
+ return;
+ }
+ const root = document.documentElement;
+ for (const variable of Object.keys(this._injectedVariables)) {
+ root.style.removeProperty(`--${variable}`);
+ }
+ this._injectedVariables = undefined;
+ }
+
+ /** Maps theme display name to theme information */
+ get themeMapping(): Record {
+ return this._themeMapping;
+ }
+
+ async getActiveTheme(): Promise<{themeName: string, themeVariant?: string}> {
+ let themeName = await this._platform.settingsStorage.getString("theme-name");
+ let themeVariant = await this._platform.settingsStorage.getString("theme-variant");
+ if (!themeName || !this._themeMapping[themeName]) {
+ themeName = "Default" in this._themeMapping ? "Default" : Object.keys(this._themeMapping)[0];
+ if (!this._themeMapping[themeName][themeVariant]) {
+ themeVariant = "default" in this._themeMapping[themeName] ? "default" : undefined;
+ }
+ }
+ return { themeName, themeVariant };
+ }
+
+ getDefaultTheme(): string | undefined {
+ switch (this.preferredColorScheme) {
+ case ColorSchemePreference.Dark:
+ return this._platform.config["defaultTheme"]?.dark;
+ case ColorSchemePreference.Light:
+ return this._platform.config["defaultTheme"]?.light;
+ }
+ }
+
+ private _findThemeDetailsFromId(themeId: string): {themeName: string, themeData: Partial} | undefined {
+ for (const [themeName, themeData] of Object.entries(this._themeMapping)) {
+ if ("id" in themeData && themeData.id === themeId) {
+ return { themeName, themeData };
+ }
+ else if ("light" in themeData && themeData.light?.id === themeId) {
+ return { themeName, themeData: themeData.light };
+ }
+ else if ("dark" in themeData && themeData.dark?.id === themeId) {
+ return { themeName, themeData: themeData.dark };
+ }
+ }
+ }
+
+ private _addDefaultThemeToMapping(log: ILogItem) {
+ log.wrap("addDefaultThemeToMapping", l => {
+ const defaultThemeId = this.getDefaultTheme();
+ if (defaultThemeId) {
+ const themeDetails = this._findThemeDetailsFromId(defaultThemeId);
+ if (themeDetails) {
+ this._themeMapping["Default"] = { id: "default", cssLocation: themeDetails.themeData.cssLocation! };
+ const variables = themeDetails.themeData.variables;
+ if (variables) {
+ this._themeMapping["Default"].variables = variables;
+ }
+ }
+ }
+ l.log({ l: "Default Theme", theme: defaultThemeId});
+ });
+ }
+
+ get preferredColorScheme(): ColorSchemePreference | undefined {
+ if (window.matchMedia("(prefers-color-scheme: dark)").matches) {
+ return ColorSchemePreference.Dark;
+ }
+ else if (window.matchMedia("(prefers-color-scheme: light)").matches) {
+ return ColorSchemePreference.Light;
+ }
+ }
+}
diff --git a/src/platform/web/theming/parsers/BuiltThemeParser.ts b/src/platform/web/theming/parsers/BuiltThemeParser.ts
new file mode 100644
index 00000000..fbafadb8
--- /dev/null
+++ b/src/platform/web/theming/parsers/BuiltThemeParser.ts
@@ -0,0 +1,106 @@
+/*
+Copyright 2020 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import type {ThemeInformation} from "./types";
+import type {ThemeManifest} from "../../../types/theme";
+import type {ILogItem} from "../../../../logging/types";
+import {ColorSchemePreference} from "./types";
+
+export class BuiltThemeParser {
+ private _themeMapping: Record = {};
+ private _preferredColorScheme?: ColorSchemePreference;
+
+ constructor(preferredColorScheme?: ColorSchemePreference) {
+ this._preferredColorScheme = preferredColorScheme;
+ }
+
+ parse(manifest: ThemeManifest, manifestLocation: string, log: ILogItem) {
+ log.wrap("BuiltThemeParser.parse", () => {
+ /*
+ After build has finished, the source section of each theme manifest
+ contains `built-assets` which is a mapping from the theme-id to
+ cssLocation of theme
+ */
+ const builtAssets: Record = manifest.source?.["built-assets"];
+ const themeName = manifest.name;
+ if (!themeName) {
+ throw new Error(`Theme name not found in manifest at ${manifestLocation}`);
+ }
+ let defaultDarkVariant: any = {}, defaultLightVariant: any = {};
+ for (let [themeId, cssLocation] of Object.entries(builtAssets)) {
+ try {
+ /**
+ * This cssLocation is relative to the location of the manifest file.
+ * So we first need to resolve it relative to the root of this hydrogen instance.
+ */
+ cssLocation = new URL(cssLocation, new URL(manifestLocation, window.location.origin)).href;
+ }
+ catch {
+ continue;
+ }
+ const variant = themeId.match(/.+-(.+)/)?.[1];
+ const variantDetails = manifest.values?.variants[variant!];
+ if (!variantDetails) {
+ throw new Error(`Variant ${variant} is missing in manifest at ${manifestLocation}`);
+ }
+ const { name: variantName, default: isDefault, dark } = variantDetails;
+ const themeDisplayName = `${themeName} ${variantName}`;
+ if (isDefault) {
+ /**
+ * This is a default variant!
+ * We'll add these to the themeMapping (separately) keyed with just the
+ * theme-name (i.e "Element" instead of "Element Dark").
+ * We need to be able to distinguish them from other variants!
+ *
+ * This allows us to render radio-buttons with "dark" and
+ * "light" options.
+ */
+ const defaultVariant = dark ? defaultDarkVariant : defaultLightVariant;
+ defaultVariant.variantName = variantName;
+ defaultVariant.id = themeId
+ defaultVariant.cssLocation = cssLocation;
+ continue;
+ }
+ // Non-default variants are keyed in themeMapping with "theme_name variant_name"
+ // eg: "Element Dark"
+ this._themeMapping[themeDisplayName] = {
+ cssLocation,
+ id: themeId
+ };
+ }
+ if (defaultDarkVariant.id && defaultLightVariant.id) {
+ /**
+ * As mentioned above, if there's both a default dark and a default light variant,
+ * add them to themeMapping separately.
+ */
+ const defaultVariant = this._preferredColorScheme === ColorSchemePreference.Dark ? defaultDarkVariant : defaultLightVariant;
+ this._themeMapping[themeName] = { dark: defaultDarkVariant, light: defaultLightVariant, default: defaultVariant };
+ }
+ else {
+ /**
+ * If only one default variant is found (i.e only dark default or light default but not both),
+ * treat it like any other variant.
+ */
+ const variant = defaultDarkVariant.id ? defaultDarkVariant : defaultLightVariant;
+ this._themeMapping[`${themeName} ${variant.variantName}`] = { id: variant.id, cssLocation: variant.cssLocation };
+ }
+ });
+ }
+
+ get themeMapping(): Record {
+ return this._themeMapping;
+ }
+}
diff --git a/src/platform/web/theming/parsers/RuntimeThemeParser.ts b/src/platform/web/theming/parsers/RuntimeThemeParser.ts
new file mode 100644
index 00000000..9471740a
--- /dev/null
+++ b/src/platform/web/theming/parsers/RuntimeThemeParser.ts
@@ -0,0 +1,98 @@
+/*
+Copyright 2020 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import type {ThemeInformation} from "./types";
+import type {Platform} from "../../Platform.js";
+import type {ThemeManifest} from "../../../types/theme";
+import {ColorSchemePreference} from "./types";
+import {IconColorizer} from "../IconColorizer";
+import {DerivedVariables} from "../DerivedVariables";
+import {ILogItem} from "../../../../logging/types";
+
+export class RuntimeThemeParser {
+ private _themeMapping: Record = {};
+ private _preferredColorScheme?: ColorSchemePreference;
+ private _platform: Platform;
+
+ constructor(platform: Platform, preferredColorScheme?: ColorSchemePreference) {
+ this._preferredColorScheme = preferredColorScheme;
+ this._platform = platform;
+ }
+
+ async parse(manifest: ThemeManifest, baseManifest: ThemeManifest, baseManifestLocation: string, log: ILogItem): Promise {
+ await log.wrap("RuntimeThemeParser.parse", async () => {
+ const {cssLocation, derivedVariables, icons} = this._getSourceData(baseManifest, baseManifestLocation, log);
+ const themeName = manifest.name;
+ if (!themeName) {
+ throw new Error(`Theme name not found in manifest!`);
+ }
+ let defaultDarkVariant: any = {}, defaultLightVariant: any = {};
+ for (const [variant, variantDetails] of Object.entries(manifest.values?.variants!) as [string, any][]) {
+ try {
+ const themeId = `${manifest.id}-${variant}`;
+ const { name: variantName, default: isDefault, dark, variables } = variantDetails;
+ const resolvedVariables = new DerivedVariables(variables, derivedVariables, dark).toVariables();
+ Object.assign(variables, resolvedVariables);
+ const iconVariables = await new IconColorizer(this._platform, icons, variables, baseManifestLocation).toVariables();
+ Object.assign(variables, resolvedVariables, iconVariables);
+ const themeDisplayName = `${themeName} ${variantName}`;
+ if (isDefault) {
+ const defaultVariant = dark ? defaultDarkVariant : defaultLightVariant;
+ Object.assign(defaultVariant, { variantName, id: themeId, cssLocation, variables });
+ continue;
+ }
+ this._themeMapping[themeDisplayName] = { cssLocation, id: themeId, variables: variables, };
+ }
+ catch (e) {
+ console.error(e);
+ continue;
+ }
+ }
+ if (defaultDarkVariant.id && defaultLightVariant.id) {
+ const defaultVariant = this._preferredColorScheme === ColorSchemePreference.Dark ? defaultDarkVariant : defaultLightVariant;
+ this._themeMapping[themeName] = { dark: defaultDarkVariant, light: defaultLightVariant, default: defaultVariant };
+ }
+ else {
+ const variant = defaultDarkVariant.id ? defaultDarkVariant : defaultLightVariant;
+ this._themeMapping[`${themeName} ${variant.variantName}`] = { id: variant.id, cssLocation: variant.cssLocation };
+ }
+ });
+ }
+
+ private _getSourceData(manifest: ThemeManifest, location: string, log: ILogItem)
+ : { cssLocation: string, derivedVariables: string[], icons: Record} {
+ return log.wrap("getSourceData", () => {
+ const runtimeCSSLocation = manifest.source?.["runtime-asset"];
+ if (!runtimeCSSLocation) {
+ throw new Error(`Run-time asset not found in source section for theme at ${location}`);
+ }
+ const cssLocation = new URL(runtimeCSSLocation, new URL(location, window.location.origin)).href;
+ const derivedVariables = manifest.source?.["derived-variables"];
+ if (!derivedVariables) {
+ throw new Error(`Derived variables not found in source section for theme at ${location}`);
+ }
+ const icons = manifest.source?.["icon"];
+ if (!icons) {
+ throw new Error(`Icon mapping not found in source section for theme at ${location}`);
+ }
+ return { cssLocation, derivedVariables, icons };
+ });
+ }
+
+ get themeMapping(): Record {
+ return this._themeMapping;
+ }
+
+}
diff --git a/src/platform/web/theming/parsers/types.ts b/src/platform/web/theming/parsers/types.ts
new file mode 100644
index 00000000..b357cf2c
--- /dev/null
+++ b/src/platform/web/theming/parsers/types.ts
@@ -0,0 +1,38 @@
+/*
+Copyright 2020 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+export type NormalVariant = {
+ id: string;
+ cssLocation: string;
+ variables?: any;
+};
+
+export type Variant = NormalVariant & {
+ variantName: string;
+};
+
+export type DefaultVariant = {
+ dark: Variant;
+ light: Variant;
+ default: Variant;
+}
+
+export type ThemeInformation = NormalVariant | DefaultVariant;
+
+export enum ColorSchemePreference {
+ Dark,
+ Light
+};
diff --git a/scripts/postcss/color.js b/src/platform/web/theming/shared/color.mjs
similarity index 89%
rename from scripts/postcss/color.js
rename to src/platform/web/theming/shared/color.mjs
index b1ef7073..8af76b6b 100644
--- a/scripts/postcss/color.js
+++ b/src/platform/web/theming/shared/color.mjs
@@ -13,10 +13,10 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
+import * as pkg from 'off-color';
+const offColor = pkg.offColor ?? pkg.default.offColor;
-const offColor = require("off-color").offColor;
-
-module.exports.derive = function (value, operation, argument, isDark) {
+export function derive(value, operation, argument, isDark) {
const argumentAsNumber = parseInt(argument);
if (isDark) {
// For dark themes, invert the operation
diff --git a/src/platform/web/theming/shared/svg-colorizer.mjs b/src/platform/web/theming/shared/svg-colorizer.mjs
new file mode 100644
index 00000000..cb291726
--- /dev/null
+++ b/src/platform/web/theming/shared/svg-colorizer.mjs
@@ -0,0 +1,24 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+export function getColoredSvgString(svgString, primaryColor, secondaryColor) {
+ let coloredSVGCode = svgString.replaceAll("#ff00ff", primaryColor);
+ coloredSVGCode = coloredSVGCode.replaceAll("#00ffff", secondaryColor);
+ if (svgString === coloredSVGCode) {
+ throw new Error("svg-colorizer made no color replacements! The input svg should only contain colors #ff00ff (primary, case-sensitive) and #00ffff (secondary, case-sensitive).");
+ }
+ return coloredSVGCode;
+}
diff --git a/src/platform/web/ui/avatar.js b/src/platform/web/ui/avatar.js
index 5bc019cb..547d4b51 100644
--- a/src/platform/web/ui/avatar.js
+++ b/src/platform/web/ui/avatar.js
@@ -31,7 +31,7 @@ export function renderStaticAvatar(vm, size, extraClasses = undefined) {
avatarClasses += ` ${extraClasses}`;
}
const avatarContent = hasAvatar ? renderImg(vm, size) : text(vm.avatarLetter);
- const avatar = tag.div({className: avatarClasses}, [avatarContent]);
+ const avatar = tag.div({className: avatarClasses, "data-testid": "avatar"}, [avatarContent]);
if (hasAvatar) {
setAttribute(avatar, "data-avatar-letter", vm.avatarLetter);
setAttribute(avatar, "data-avatar-color", vm.avatarColorNumber);
diff --git a/src/platform/web/ui/css/themes/element/manifest.json b/src/platform/web/ui/css/themes/element/manifest.json
index e183317c..cb21eaad 100644
--- a/src/platform/web/ui/css/themes/element/manifest.json
+++ b/src/platform/web/ui/css/themes/element/manifest.json
@@ -1,6 +1,7 @@
{
"version": 1,
"name": "Element",
+ "id": "element",
"values": {
"variants": {
"light": {
diff --git a/src/platform/web/ui/css/themes/element/theme.css b/src/platform/web/ui/css/themes/element/theme.css
index 113ea254..05681cbb 100644
--- a/src/platform/web/ui/css/themes/element/theme.css
+++ b/src/platform/web/ui/css/themes/element/theme.css
@@ -521,6 +521,62 @@ a {
.RoomView_error {
color: var(--error-color);
+ background : #efefef;
+ height : 0px;
+ font-weight : bold;
+ transition : 0.25s all ease-out;
+ padding-right : 20px;
+ padding-left : 20px;
+}
+
+.RoomView_error div{
+ overflow : hidden;
+ height: 100%;
+ width: 100%;
+ position : relative;
+ display : flex;
+ align-items : center;
+}
+
+.RoomView_error:not(:empty) {
+ height : auto;
+ padding-top : 20px;
+ padding-bottom : 20px;
+}
+
+.RoomView_error p {
+ position : relative;
+ display : block;
+ width : 100%;
+ height : auto;
+ margin : 0;
+}
+
+.RoomView_error button {
+ width : 40px;
+ padding-top : 20px;
+ padding-bottom : 20px;
+ background : none;
+ border : none;
+ position : relative;
+ border-radius : 5px;
+ transition: 0.1s all ease-out;
+ cursor: pointer;
+}
+
+.RoomView_error button:hover {
+ background : #cfcfcf;
+}
+
+.RoomView_error button:before {
+ content:"\274c";
+ position : absolute;
+ top : 15px;
+ left: 9px;
+ width : 20px;
+ height : 10px;
+ font-size : 10px;
+ align-self : middle;
}
.MessageComposer_replyPreview .Timeline_message {
@@ -894,12 +950,12 @@ button.link {
width: 100%;
}
-.RoomArchivedView {
+.DisabledComposerView {
padding: 12px;
background-color: var(--background-color-secondary);
}
-.RoomArchivedView h3 {
+.DisabledComposerView h3 {
margin: 0;
}
diff --git a/src/platform/web/ui/session/room/RoomArchivedView.js b/src/platform/web/ui/session/room/DisabledComposerView.js
similarity index 82%
rename from src/platform/web/ui/session/room/RoomArchivedView.js
rename to src/platform/web/ui/session/room/DisabledComposerView.js
index 1db1c2d2..caa8eeb9 100644
--- a/src/platform/web/ui/session/room/RoomArchivedView.js
+++ b/src/platform/web/ui/session/room/DisabledComposerView.js
@@ -16,8 +16,8 @@ limitations under the License.
import {TemplateView} from "../../general/TemplateView";
-export class RoomArchivedView extends TemplateView {
+export class DisabledComposerView extends TemplateView {
render(t) {
- return t.div({className: "RoomArchivedView"}, t.h3(vm => vm.description));
+ return t.div({className: "DisabledComposerView"}, t.h3(vm => vm.description));
}
}
diff --git a/src/platform/web/ui/session/room/RoomView.js b/src/platform/web/ui/session/room/RoomView.js
index 76e26eab..e3eb0587 100644
--- a/src/platform/web/ui/session/room/RoomView.js
+++ b/src/platform/web/ui/session/room/RoomView.js
@@ -21,7 +21,7 @@ import {Menu} from "../../general/Menu.js";
import {TimelineView} from "./TimelineView";
import {TimelineLoadingView} from "./TimelineLoadingView.js";
import {MessageComposer} from "./MessageComposer.js";
-import {RoomArchivedView} from "./RoomArchivedView.js";
+import {DisabledComposerView} from "./DisabledComposerView.js";
import {AvatarView} from "../../AvatarView.js";
export class RoomView extends TemplateView {
@@ -32,12 +32,6 @@ export class RoomView extends TemplateView {
}
render(t, vm) {
- let bottomView;
- if (vm.composerViewModel.kind === "composer") {
- bottomView = new MessageComposer(vm.composerViewModel, this._viewClassForTile);
- } else if (vm.composerViewModel.kind === "archived") {
- bottomView = new RoomArchivedView(vm.composerViewModel);
- }
return t.main({className: "RoomView middle"}, [
t.div({className: "RoomHeader middle-header"}, [
t.a({className: "button-utility close-middle", href: vm.closeUrl, title: vm.i18n`Close room`}),
@@ -52,17 +46,31 @@ export class RoomView extends TemplateView {
})
]),
t.div({className: "RoomView_body"}, [
- t.div({className: "RoomView_error"}, vm => vm.error),
+ t.div({className: "RoomView_error"}, [
+ t.if(vm => vm.error, t => t.div(
+ [
+ t.p({}, vm => vm.error),
+ t.button({ className: "RoomView_error_closerButton", onClick: evt => vm.dismissError(evt) })
+ ])
+ )]),
t.mapView(vm => vm.timelineViewModel, timelineViewModel => {
return timelineViewModel ?
new TimelineView(timelineViewModel, this._viewClassForTile) :
new TimelineLoadingView(vm); // vm is just needed for i18n
}),
- t.view(bottomView),
+ t.mapView(vm => vm.composerViewModel,
+ composerViewModel => {
+ switch (composerViewModel?.kind) {
+ case "composer":
+ return new MessageComposer(vm.composerViewModel, this._viewClassForTile);
+ case "disabled":
+ return new DisabledComposerView(vm.composerViewModel);
+ }
+ }),
])
]);
}
-
+
_toggleOptionsMenu(evt) {
if (this._optionsPopup && this._optionsPopup.isOpen) {
this._optionsPopup.close();
diff --git a/src/platform/web/ui/session/room/timeline/BaseMediaView.js b/src/platform/web/ui/session/room/timeline/BaseMediaView.js
index 16b5de14..9d534fd1 100644
--- a/src/platform/web/ui/session/room/timeline/BaseMediaView.js
+++ b/src/platform/web/ui/session/room/timeline/BaseMediaView.js
@@ -53,7 +53,7 @@ export class BaseMediaView extends BaseMessageView {
children.push(progress);
}
return t.div({className: "Timeline_messageBody"}, [
- t.div({className: "media", style: `max-width: ${vm.width}px`}, children),
+ t.div({className: "media", style: `max-width: ${vm.width}px`, "data-testid": "media"}, children),
t.if(vm => vm.error, t => t.p({className: "error"}, vm.error))
]);
}
diff --git a/src/platform/web/ui/session/room/timeline/ImageView.js b/src/platform/web/ui/session/room/timeline/ImageView.js
index 1668b09c..19591606 100644
--- a/src/platform/web/ui/session/room/timeline/ImageView.js
+++ b/src/platform/web/ui/session/room/timeline/ImageView.js
@@ -24,6 +24,6 @@ export class ImageView extends BaseMediaView {
title: vm => vm.label,
style: `max-width: ${vm.width}px; max-height: ${vm.height}px;`
});
- return vm.isPending ? img : t.a({href: vm.lightboxUrl}, img);
+ return vm.isPending || !vm.lightboxUrl ? img : t.a({href: vm.lightboxUrl}, img);
}
}
diff --git a/vite.common-config.js b/vite.common-config.js
index 5d65f8e2..2fa09d46 100644
--- a/vite.common-config.js
+++ b/vite.common-config.js
@@ -8,8 +8,8 @@ const path = require("path");
const manifest = require("./package.json");
const version = manifest.version;
const compiledVariables = new Map();
-const derive = require("./scripts/postcss/color").derive;
-const replacer = require("./scripts/postcss/svg-colorizer").buildColorizedSVG;
+import {buildColorizedSVG as replacer} from "./scripts/postcss/svg-builder.mjs";
+import {derive} from "./src/platform/web/theming/shared/color.mjs";
const commonOptions = {
logLevel: "warn",
diff --git a/vite.config.js b/vite.config.js
index 72be0184..10348218 100644
--- a/vite.config.js
+++ b/vite.config.js
@@ -33,9 +33,7 @@ export default defineConfig(({mode}) => {
plugins: [
themeBuilder({
themeConfig: {
- themes: {
- element: "./src/platform/web/ui/css/themes/element",
- },
+ themes: ["./src/platform/web/ui/css/themes/element"],
default: "element",
},
compiledVariables,
diff --git a/vite.sdk-assets-config.js b/vite.sdk-assets-config.js
index d7d4d064..5c1f3196 100644
--- a/vite.sdk-assets-config.js
+++ b/vite.sdk-assets-config.js
@@ -36,7 +36,7 @@ export default mergeOptions(commonOptions, {
plugins: [
themeBuilder({
themeConfig: {
- themes: { element: "./src/platform/web/ui/css/themes/element" },
+ themes: ["./src/platform/web/ui/css/themes/element"],
default: "element",
},
compiledVariables,
diff --git a/yarn.lock b/yarn.lock
index 28efc3bc..c48d2719 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -77,6 +77,11 @@
"@nodelib/fs.scandir" "2.1.5"
fastq "^1.6.0"
+"@trysound/sax@0.2.0":
+ version "0.2.0"
+ resolved "https://registry.yarnpkg.com/@trysound/sax/-/sax-0.2.0.tgz#cccaab758af56761eb7bf37af6f03f326dd798ad"
+ integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA==
+
"@types/json-schema@^7.0.7":
version "7.0.9"
resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.9.tgz#97edc9037ea0c38585320b28964dde3b39e4660d"
@@ -347,6 +352,11 @@ commander@^6.1.0:
resolved "https://registry.yarnpkg.com/commander/-/commander-6.2.1.tgz#0792eb682dfbc325999bb2b84fddddba110ac73c"
integrity sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==
+commander@^7.2.0:
+ version "7.2.0"
+ resolved "https://registry.yarnpkg.com/commander/-/commander-7.2.0.tgz#a36cb57d0b501ce108e4d20559a150a391d97ab7"
+ integrity sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==
+
concat-map@0.0.1:
version "0.0.1"
resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
@@ -382,11 +392,26 @@ css-select@^4.1.3:
domutils "^2.6.0"
nth-check "^2.0.0"
+css-tree@^1.1.2, css-tree@^1.1.3:
+ version "1.1.3"
+ resolved "https://registry.yarnpkg.com/css-tree/-/css-tree-1.1.3.tgz#eb4870fb6fd7707327ec95c2ff2ab09b5e8db91d"
+ integrity sha512-tRpdppF7TRazZrjJ6v3stzv93qxRcSsFmW6cX0Zm2NVKpxE1WV1HblnghVv9TreireHkqI/VDEsfolRF1p6y7Q==
+ dependencies:
+ mdn-data "2.0.14"
+ source-map "^0.6.1"
+
css-what@^5.0.0:
version "5.0.1"
resolved "https://registry.yarnpkg.com/css-what/-/css-what-5.0.1.tgz#3efa820131f4669a8ac2408f9c32e7c7de9f4cad"
integrity sha512-FYDTSHb/7KXsWICVsxdmiExPjCfRC4qRFBdVwv7Ax9hMnvMmEjP9RfxTEZ3qPZGmADDn2vAKSo9UcN1jKVYscg==
+csso@^4.2.0:
+ version "4.2.0"
+ resolved "https://registry.yarnpkg.com/csso/-/csso-4.2.0.tgz#ea3a561346e8dc9f546d6febedd50187cf389529"
+ integrity sha512-wvlcdIbf6pwKEk7vHj8/Bkc0B4ylXZruLvOgs9doS5eOsOpuodOV2zJChSpkp+pRpYQLQMeF04nr3Z68Sta9jA==
+ dependencies:
+ css-tree "^1.1.2"
+
cuint@^0.2.2:
version "0.2.2"
resolved "https://registry.yarnpkg.com/cuint/-/cuint-0.2.2.tgz#408086d409550c2631155619e9fa7bcadc3b991b"
@@ -1197,6 +1222,11 @@ lru-cache@^6.0.0:
dependencies:
yallist "^4.0.0"
+mdn-data@2.0.14:
+ version "2.0.14"
+ resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.0.14.tgz#7113fc4281917d63ce29b43446f701e68c25ba50"
+ integrity sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow==
+
mdn-polyfills@^5.20.0:
version "5.20.0"
resolved "https://registry.yarnpkg.com/mdn-polyfills/-/mdn-polyfills-5.20.0.tgz#ca8247edf20a4f60dec6804372229812b348260b"
@@ -1500,7 +1530,7 @@ source-map-js@^1.0.2:
resolved "https://registry.yarnpkg.com/source-map-js/-/source-map-js-1.0.2.tgz#adbc361d9c62df380125e7f161f71c826f1e490c"
integrity sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==
-source-map@~0.6.1:
+source-map@^0.6.1, source-map@~0.6.1:
version "0.6.1"
resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==
@@ -1510,6 +1540,11 @@ sprintf-js@~1.0.2:
resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c"
integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=
+stable@^0.1.8:
+ version "0.1.8"
+ resolved "https://registry.yarnpkg.com/stable/-/stable-0.1.8.tgz#836eb3c8382fe2936feaf544631017ce7d47a3cf"
+ integrity sha512-ji9qxRnOVfcuLDySj9qzhGSEFVobyt1kIOSkj1qZzYLzq7Tos/oUUWvotUPQLlrsidqsK6tBH89Bc9kL5zHA6w==
+
string-width@^4.2.0:
version "4.2.2"
resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.2.tgz#dafd4f9559a7585cfba529c6a0a4f73488ebd4c5"
@@ -1550,6 +1585,19 @@ supports-preserve-symlinks-flag@^1.0.0:
resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09"
integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==
+svgo@^2.8.0:
+ version "2.8.0"
+ resolved "https://registry.yarnpkg.com/svgo/-/svgo-2.8.0.tgz#4ff80cce6710dc2795f0c7c74101e6764cfccd24"
+ integrity sha512-+N/Q9kV1+F+UeWYoSiULYo4xYSDQlTgb+ayMobAXPwMnLvop7oxKMo9OzIrX5x3eS4L4f2UHhc9axXwY8DpChg==
+ dependencies:
+ "@trysound/sax" "0.2.0"
+ commander "^7.2.0"
+ css-select "^4.1.3"
+ css-tree "^1.1.3"
+ csso "^4.2.0"
+ picocolors "^1.0.0"
+ stable "^0.1.8"
+
table@^6.0.9:
version "6.7.1"
resolved "https://registry.yarnpkg.com/table/-/table-6.7.1.tgz#ee05592b7143831a8c94f3cee6aae4c1ccef33e2"
@@ -1617,10 +1665,10 @@ type-fest@^0.20.2:
resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4"
integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==
-typescript@^4.3.5:
- version "4.3.5"
- resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.3.5.tgz#4d1c37cc16e893973c45a06886b7113234f119f4"
- integrity sha512-DqQgihaQ9cUrskJo9kIyW/+g0Vxsk8cDtZ52a3NGh0YNTfpUSArXSohyUGnvbPazEPLu398C0UxmKSOrPumUzA==
+typescript@^4.7.0:
+ version "4.7.4"
+ resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.7.4.tgz#1a88596d1cf47d59507a1bcdfb5b9dfe4d488235"
+ integrity sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==
typeson-registry@^1.0.0-alpha.20:
version "1.0.0-alpha.39"