@matrix-widget-toolkit/mui 1.0.1

package/build/index.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @packageDocumentation This package provides a MUI theme that fits to
+ *                       the default Element theme.
+ */
+
+import { BackendModule } from 'i18next';
+import { Capability } from 'matrix-widget-api';
+import LanguageDetector from 'i18next-browser-languagedetector';
+import { PropsWithChildren } from 'react';
+import { ReactElement } from 'react';
+import { WidgetApi } from '@matrix-widget-toolkit/api';
+import { WidgetEventCapability } from 'matrix-widget-api';
+import { WidgetRegistration } from '@matrix-widget-toolkit/api';
+
+/**
+ * Reads environment variables starting with `REACT_APP_` from a global variable
+ * at runtime and falls back to `process.env` build time variables.
+ *
+ * @param name - The name of the environment variable, should start with
+ *               `REACT_APP_`.
+ */
+export declare function getEnvironment(name: string): string | undefined;
+
+/**
+ * Reads environment variables starting with `REACT_APP_` from a global variable
+ * at runtime and falls back to `process.env` build time variables.
+ *
+ * @param name - The name of the environment variable, should start with
+ *               `REACT_APP_`.
+ * @param defaultValue - The default value to return if the environment variable
+ *                       is not provided.
+ */
+export declare function getEnvironment(name: string, defaultValue: string): string;
+
+/**
+ * Retrieve the nonce passed by our Docker base image.
+ * @returns A nonce that can be used to perform operations that are disabled in
+ *          our CSP by default.
+ */
+export declare function getNonce(): string | undefined;
+
+/**
+ * A guard that ask the user for capabilities and only shows the `children`
+ * if all capabilities were accepted.
+ * If capabilities are denined, a message and a button to retry is displayed
+ * instead.
+ * @param param0 - {@link MuiCapabilitiesGuardProps}
+ */
+export declare function MuiCapabilitiesGuard({ capabilities, children, }: MuiCapabilitiesGuardProps): ReactElement;
+
+/**
+ * Props for the {@link MuiCapabilitiesGuard} component.
+ */
+export declare type MuiCapabilitiesGuardProps = PropsWithChildren<{
+    /**
+     * Required capabilities to display the `children`.
+     */
+    capabilities: Array<WidgetEventCapability | Capability>;
+}>;
+
+/**
+ * Provide a semantic UI based theme to the child components.
+ * @param param0 - {@link MuiThemeProviderProps}
+ */
+export declare function MuiThemeProvider({ children, }: MuiThemeProviderProps): ReactElement;
+
+/**
+ * Props for the {@link MuiThemeProvider} component.
+ */
+export declare type MuiThemeProviderProps = PropsWithChildren<{}>;
+
+/**
+ * Provides the `WidgetApi` in the React context once it's fully
+ * initialized without errors.
+ * Use `useWidgetApi` to access it.
+ * @param param0 - {@link MuiWidgetApiProviderProps}
+ */
+export declare function MuiWidgetApiProvider({ widgetRegistration, widgetApiPromise, children, }: MuiWidgetApiProviderProps): ReactElement;
+
+/**
+ * Props for the {@link (MuiWidgetApiProvider:function)} component.
+ */
+export declare type MuiWidgetApiProviderProps = PropsWithChildren<{
+    /**
+     * Configuration to set during Widget registration.
+     */
+    widgetRegistration?: WidgetRegistration;
+    /**
+     * Result from a call to `WidgetApiImpl.create`.
+     */
+    widgetApiPromise: Promise<WidgetApi>;
+}>;
+
+/**
+ * A language detector that reads the language from the widget url.
+ */
+export declare class WidgetApiLanguageDetector extends LanguageDetector {
+    constructor();
+}
+
+/**
+ * Backend for usage with `i18n-next` that provides translations for internal
+ * messages.
+ */
+export declare const WidgetToolkitI18nBackend: BackendModule<object>;
+
+export { }

package/build/locales/de/widget-toolkit.json

@@ -0,0 +1,40 @@
+{
+  "code": {
+    "copy-to-clipboard": "In die Zwischenablage kopieren"
+  },
+  "error": {
+    "instructions": "Im Widget ist ein Fehler aufgetreten. Der Fehler kann eventuell durch erneutes Öffnen des Widgets behoben werden.",
+    "title": "Ohh nein!"
+  },
+  "loading": {
+    "message": "Lädt…"
+  },
+  "missing-capabilities": {
+    "instructions": "Die minimal erforderlichen Rechte für dieses Widget fehlen. Es müssen alle angefragen Rechte erteilt werden.",
+    "request-capabilities": "Rechte erteilen",
+    "title": "Fehlende Rechte"
+  },
+  "missing-parameters": {
+    "completed": {
+      "instructions": "Widget Konfiguration abgeschlossen, das Widget muss erneut geöffnet werden.",
+      "title": "Widget Konfiguration abgeschlossen"
+    },
+    "instructions": "Das Widget ist nicht korrekt registriert. Es muss sichergestellt werden, das alle Parameter in der URL enthalten sind:",
+    "permissions-error": {
+      "close": "Schließen",
+      "instructions": "Fehlende Berechtigungen, das Widget konnte nicht konfiguriert werden. Die Korrektur muss durch einen Raum-Administrator durchgeführt werden.",
+      "title": "Fehler"
+    },
+    "repair": "Registrierung korrigieren",
+    "repair-instructions": "Die Widget Registrierung kann entweder manuell oder automatisch korrigiert werden:",
+    "title": "Fehlerhafte Widget Registrierung"
+  },
+  "mobile-client": {
+    "instructions": "Aufgrund von technischen Limitationen funktioniert das Widget nicht in den mobilen Apps. Das Widget muss in einer Desktop oder Web App geöffnet werden.",
+    "title": "Mobile Apps werden nicht unterstützt"
+  },
+  "outside-client": {
+    "instructions": "Diese URL muss als Widget registiert werden und kann nicht direkt aufgerufen werden. Mit dem folgenden Kommando kann das Widget in einem Raum eingerichtet werden:",
+    "title": "Nur als Widget ausführbar"
+  }
+}

package/build/locales/en/widget-toolkit.json

@@ -0,0 +1,40 @@
+{
+  "code": {
+    "copy-to-clipboard": "Copy to clipboard"
+  },
+  "error": {
+    "instructions": "An error occured inside the widget. You can try to reopen the widget.",
+    "title": "Ohh no!"
+  },
+  "loading": {
+    "message": "Loading…"
+  },
+  "missing-capabilities": {
+    "instructions": "The minimum capabilities required for this widget are missing. Make sure to grant all requested capabilities.",
+    "request-capabilities": "Request capabilities",
+    "title": "Missing capabilities"
+  },
+  "missing-parameters": {
+    "completed": {
+      "instructions": "Configuration completed, reopen the widget to start using it.",
+      "title": "Widget configuration complete"
+    },
+    "instructions": "The widget is not registered correctly. Make sure to include the correct parameters in the widget URL:",
+    "permissions-error": {
+      "close": "Close",
+      "instructions": "Insufficient permissions, could not configure widget. Only room admins can configure the widget.",
+      "title": "Error"
+    },
+    "repair": "Repair registration",
+    "repair-instructions": "You can either modify the widget registration manually or fix it automatically:",
+    "title": "Wrong widget registration"
+  },
+  "mobile-client": {
+    "instructions": "The widget doesn't work in mobile clients due to technical limitations. Open the widget on you Desktop or Web client.",
+    "title": "Mobile clients are not supported"
+  },
+  "outside-client": {
+    "instructions": "You need to register this URL as a widget, it's not possible to use it standalone. Run this command in the matrix room you want to register the widget in:",
+    "title": "Only runs as a widget"
+  }
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@matrix-widget-toolkit/mui",
+  "version": "1.0.1",
+  "description": "A customized material-ui theme that matches the style of the Element Matrix client",
+  "author": "Nordeck IT + Consulting GmbH",
+  "license": "Apache-2.0",
+  "source": "./src/index.ts",
+  "module": "./build/esm/index.js",
+  "types": "./build/index.d.ts",
+  "devDependencies": {
+    "@craco/craco": "^6.4.5",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^12.1.5",
+    "@testing-library/user-event": "^14.4.3",
+    "@types/jest": "^27.5.2",
+    "@types/jest-axe": "^3.5.5",
+    "@types/node": "^16.11.64",
+    "@types/react": "^17.0.45",
+    "copyfiles": "^2.4.1",
+    "i18next-parser": "^6.6.0",
+    "jest-axe": "^6.0.0",
+    "react": "^17.0.2",
+    "react-scripts": "5.0.1",
+    "typescript": "^4.8.4"
+  },
+  "scripts": {
+    "build": "tsc && rollup --config ../../rollup.config.mjs",
+    "postbuild": "copyfiles -E -u 1 src/locales/**/*.json build",
+    "tsc": "tsc",
+    "lint": "eslint .",
+    "test": "jest --watch",
+    "depcheck": "depcheck --ignores=@types/jest,@types/node,i18next-parser --ignore-dirs=lib,build",
+    "prepack": "node ../../scripts/prepack.js",
+    "postpack": "node ../../scripts/postpack.js",
+    "translate": "i18next src/**/*.{ts,tsx}",
+    "check-api-report": "api-extractor run --verbose",
+    "generate-api-report": "tsc && api-extractor run --verbose --local"
+  },
+  "dependencies": {
+    "@emotion/cache": "^11.10.3",
+    "@emotion/react": "^11.10.4",
+    "@emotion/styled": "^11.10.4",
+    "@fontsource/inter": "^4.5.12",
+    "@mui/icons-material": "^5.10.3",
+    "@mui/material": "^5.10.8",
+    "@mui/utils": "^5.10.6",
+    "@matrix-widget-toolkit/api": "^1.0.1",
+    "@matrix-widget-toolkit/react": "^1.0.1",
+    "i18next": "^21.10.0",
+    "i18next-browser-languagedetector": "^6.1.5",
+    "i18next-resources-to-backend": "^1.0.0",
+    "matrix-widget-api": "^1.1.1",
+    "react": "^17.0.2",
+    "react-i18next": "^11.18.6",
+    "react-use": "^17.3.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nordeck/matrix-widget-toolkit.git",
+    "directory": "packages/mui"
+  },
+  "files": [
+    "build"
+  ],
+  "keywords": [
+    "matrix",
+    "widget",
+    "matrix-widget-api"
+  ],
+  "main": "./build/cjs/index.js"
+}