Support a module API surface for custom functionality (#8246)
* Early implementation of module API surface + functions for ILAG module * Wire up dialog functions and ILAG-needed surface * Ensure component renders for modules get overridden * Respond to changes from module API interface * Use a real module-api dependency * Update for new Dialogs interface * Add support for getConfigValue from module API * Update the remainder of the module API interface * Docs & cleanup * Add some unit tests around module stuff Needs end-to-end tests still. * Appease early linters * Break import cycles by not directly depending on Lifecycle * Appease the linter * Fix bad merge
This commit is contained in:
parent
2dd683a42f
commit
7f5bb61a79
22 changed files with 906 additions and 34 deletions
45
src/modules/AppModule.ts
Normal file
45
src/modules/AppModule.ts
Normal file
|
@ -0,0 +1,45 @@
|
|||
/*
|
||||
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.
|
||||
*/
|
||||
|
||||
import { RuntimeModule } from "@matrix-org/react-sdk-module-api/lib/RuntimeModule";
|
||||
|
||||
import { ModuleFactory } from "./ModuleFactory";
|
||||
import { ProxiedModuleApi } from "./ProxiedModuleApi";
|
||||
|
||||
/**
|
||||
* Wraps a module factory into a usable module. Acts as a simple container
|
||||
* for the constructs needed to operate a module.
|
||||
*/
|
||||
export class AppModule {
|
||||
/**
|
||||
* The module instance.
|
||||
*/
|
||||
public readonly module: RuntimeModule;
|
||||
|
||||
/**
|
||||
* The API instance used by the module.
|
||||
*/
|
||||
public readonly api = new ProxiedModuleApi();
|
||||
|
||||
/**
|
||||
* Converts a factory into an AppModule. The factory will be called
|
||||
* immediately.
|
||||
* @param factory The module factory.
|
||||
*/
|
||||
public constructor(factory: ModuleFactory) {
|
||||
this.module = factory(this.api);
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue