Merge pull request #4 from verji/taj/1976-user-search-extension

Taj/1976 user search extension

Author: thoraj

.github/workflows/main.yml

@@ -1,7 +1,7 @@
 name: Main
 on:
     push:
-        branches: [main]
+        branches: [main, verji-main]
     pull_request:
         branches: [main, verji-main]
 jobs:

.github/workflows/verji-release.yaml

@@ -104,13 +104,14 @@ From the `RuntimeModule` instance, modules can listen for `WrapperLifecycle.Wrap
 It would wrap the `MatrixChat` component and let any consumer add a header, a footer.
 
 ### Custom components
+
 From the `RuntimeModule` instance, modules can listen for different `CustomComponentLifecycle` events and swap the component
-with a custom written component. In principle it works the same way as the `WrapperLifecycle`, but the usecase is different. 
+with a custom written component. In principle it works the same way as the `WrapperLifecycle`, but the usecase is different.
 Instead of wrapping the element, you can intercept it, consume the state of the component including its children, and return
-your own customly written component. 
+your own customly written component.
 
 It is possible to add `matrix-react-sdk`, `matrix-js-sdk` as a dependency into your custom module implementation to gain complete
-functionality within your custom components, aswell as the ability to reuse sub-components and styles.  
+functionality within your custom components, aswell as the ability to reuse sub-components and styles.
 
 ## Contributing / developing
 

README.md

@@ -1,6 +1,6 @@
 {
     "name": "@matrix-org/react-sdk-module-api",
-    "version": "2.4.0",
+    "version": "2.4.0-vrj1",
     "description": "Module API surface for matrix-react-sdk",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -67,7 +67,8 @@
         "typescript": "^4.6.3"
     },
     "dependencies": {
-        "@babel/runtime": "^7.17.9"
+        "@babel/runtime": "^7.17.9",
+        "matrix-events-sdk": "^2.0.0"
     },
     "peerDependencies": {
         "react": "^17.0.2"

package.json

@@ -0,0 +1,108 @@
+import { DefaultCryptoSetupExtensions, ProvideCryptoSetupExtensions } from "./CryptoSetupExtensions";
+import { DefaultExperimentalExtensions, ProvideExperimentalExtensions } from "./ExperimentalExtensions";
+import { DefaultUserSearchExtensions, ProvideUserSearchExtensions } from "./UserSearchExtensions";
+import { RuntimeModule } from "../RuntimeModule";
+
+/**
+ * Handles and manages extensions provided by modules.
+ */
+export class ExtensionsManager {
+    // Private backing fields for extensions
+    private cryptoSetupExtension: ProvideCryptoSetupExtensions;
+    private experimentalExtension: ProvideExperimentalExtensions;
+    private userSearchExtension: ProvideUserSearchExtensions;
+
+    /** `true` if `cryptoSetupExtension` is the default implementation; `false` if it is implemented by a module. */
+    private hasDefaultCryptoSetupExtension = true;
+
+    /** `true` if `userSearchExtension` is the default implementation; `false` if it is implemented by a module. */
+    private hasDefaultUserSearchExtension = true;
+
+    /** `true` if `experimentalExtension` is the default implementation; `false` if it is implemented by a module. */
+    private hasDefaultExperimentalExtension = true;
+
+    /**
+     * Create a new instance.
+     */
+    public constructor() {
+        // Set up defaults
+        this.cryptoSetupExtension = new DefaultCryptoSetupExtensions();
+        this.experimentalExtension = new DefaultExperimentalExtensions();
+        this.userSearchExtension = new DefaultUserSearchExtensions();
+    }
+
+    /**
+     * Provides a crypto setup extension.
+     *
+     * @returns The registered extension. If no module provides this extension, a default implementation is returned.
+     */
+    public get cryptoSetup(): ProvideCryptoSetupExtensions {
+        return this.cryptoSetupExtension;
+    }
+
+    /**
+     * Provides a user search extension.
+     *
+     * @returns The registered extension. If no module provides this extension, a default implementation is returned.
+     */
+    public get userSearch(): ProvideUserSearchExtensions {
+        return this.userSearchExtension;
+    }
+
+    /**
+     * Provides an experimental extension.
+     *
+     * @remarks
+     * This method extension is provided to simplify experimentation and development, and is not intended for production code.
+     *
+     * @returns The registered extension. If no module provides this extension, a default implementation is returned.
+     */
+    public get experimental(): ProvideExperimentalExtensions {
+        return this.experimentalExtension;
+    }
+
+    /**
+     * Add any extensions provided by the module.
+     *
+     * @param module - The appModule to check for extensions.
+     *
+     * @throws if an extension is provided by more than one module.
+     */
+    public addExtensions(module: RuntimeModule): void {
+        /* Add the cryptoSetup extension if any */
+        if (module.extensions?.cryptoSetup) {
+            if (this.hasDefaultCryptoSetupExtension) {
+                this.cryptoSetupExtension = module.extensions?.cryptoSetup;
+                this.hasDefaultCryptoSetupExtension = false;
+            } else {
+                throw new Error(
+                    `adding cryptoSetup extension implementation from module ${module.moduleName} but an implementation was already provided.`,
+                );
+            }
+        }
+
+        /* Add the userSearch extension if any */
+        if (module.extensions?.userSearch) {
+            if (this.hasDefaultUserSearchExtension) {
+                this.userSearchExtension = module.extensions?.userSearch;
+                this.hasDefaultUserSearchExtension = false;
+            } else {
+                throw new Error(
+                    `adding userSearch extension implementation from module ${module.moduleName} but an implementation was already provided.`,
+                );
+            }
+        }
+
+        /* Add the experimental extension if any */
+        if (module.extensions?.experimental) {
+            if (this.hasDefaultExperimentalExtension) {
+                this.experimentalExtension = module.extensions?.experimental;
+                this.hasDefaultExperimentalExtension = false;
+            } else {
+                throw new Error(
+                    `adding experimental extension implementation from module ${module.moduleName} but an implementation was already provided.`,
+                );
+            }
+        }
+    }
+}

src/lifecycles/CryptoSetupExtensions.ts renamed to src/extensions/CryptoSetupExtensions.ts

@@ -0,0 +1,123 @@
+/*
+Copyright 2023 Verji Tech AS
+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 { Optional } from "matrix-events-sdk";
+
+export interface RoomViewStoreProjection {
+    // The room ID of the room currently being viewed
+    getRoomId(): Optional<string>;
+}
+
+export interface RoomProjection {
+    // The room ID of the room currently being viewed
+    roomId: string;
+}
+
+export interface SpaceStoreClassProjection {
+    get activeSpaceRoom(): RoomProjection | null;
+}
+
+interface RequestInit {
+    /**
+     * Specifies the priority of the fetch request relative to other requests of the same type.
+     * Must be one of the following strings:
+     *   high: A high priority fetch request relative to other requests of the same type.
+     *   low: A low priority fetch request relative to other requests of the same type.
+     *   auto: Automatically determine the priority of the fetch request relative to other requests of the same type (default).
+     *
+     * @see https://html.spec.whatwg.org/multipage/urls-and-fetching.html#fetch-priority-attribute
+     * @see https://github.com/microsoft/TypeScript/issues/54472
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API#browser_compatibility
+     * Not yet supported in Safari or Firefox
+     */
+    priority?: "high" | "low" | "auto";
+}
+
+interface RequestOptsProjection extends Pick<RequestInit, "priority"> {
+    /**
+     * The alternative base url to use.
+     * If not specified, uses this.opts.baseUrl
+     */
+    baseUrl?: string;
+    /**
+     * The full prefix to use e.g.
+     * "/_matrix/client/v2_alpha". If not specified, uses this.opts.prefix.
+     */
+    prefix?: string;
+    /**
+     * map of additional request headers
+     */
+    headers?: Record<string, string>;
+    abortSignal?: AbortSignal;
+    /**
+     * The maximum amount of time to wait before
+     * timing out the request. If not specified, there is no timeout.
+     */
+    localTimeoutMs?: number;
+    keepAlive?: boolean; // defaults to false
+    json?: boolean; // defaults to true
+
+    // Set to true to prevent the request function from emitting a Session.logged_out event.
+    // This is intended for use on endpoints where M_UNKNOWN_TOKEN is a valid/notable error response,
+    // such as with token refreshes.
+    inhibitLogoutEmit?: boolean;
+}
+
+/*
+ * A interface providing a slice/projection of the SdkContextClass in matrix-react-sdk
+ */
+export interface SdkContextClassProjection {
+    get roomViewStore(): RoomViewStoreProjection;
+    get spaceStore(): SpaceStoreClassProjection;
+}
+
+/**
+ * Public api surface used to consume the extension in client code
+ */
+export interface ProvideUserSearchExtensions {
+    getSearchContext(client: any, sdkContext: SdkContextClassProjection): Promise<SearchContext>;
+}
+
+/**
+ * Abstract base class which concrete extension implementations will extend/derive from
+ */
+export abstract class UserSearchExtensionsBase implements ProvideUserSearchExtensions {
+    public abstract getSearchContext(client: any, sdkContextClass: SdkContextClassProjection): Promise<SearchContext>;
+}
+
+/**
+ * Search context used to augment call to /user-directory/search
+ *
+ */
+export interface SearchContext {
+    extraBodyArgs: { [key: string]: string } | null;
+    extraRequestOptions: RequestOptsProjection;
+}
+
+/**
+ *
+ * The default/empty usersearch-extension
+ * Can (and will) be used if none of the modules has an implementaion of ProvideUserSearchExtensions
+ *
+ * */
+export class DefaultUserSearchExtensions extends UserSearchExtensionsBase {
+    public async getSearchContext(client: any, sdkContext: SdkContextClassProjection): Promise<SearchContext> {
+        console.log("Default resolveSearchContext()");
+        return {
+            extraBodyArgs: {},
+            extraRequestOptions: {},
+        };
+    }
+}

src/lifecycles/ExperimentalExtensions.ts renamed to src/extensions/ExperimentalExtensions.ts

@@ -1,22 +1,22 @@
-/*
-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 { RoomViewLifecycle } from "./RoomViewLifecycle";
-import { WidgetLifecycle } from "./WidgetLifecycle";
-import { WrapperLifecycle } from "./WrapperLifecycle";
-import { CustomComponentLifecycle } from "./CustomComponentLifecycle";
-
-export type AnyLifecycle = RoomViewLifecycle | WidgetLifecycle | WrapperLifecycle | CustomComponentLifecycle;
+/*
+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 { RoomViewLifecycle } from "./RoomViewLifecycle";
+import { WidgetLifecycle } from "./WidgetLifecycle";
+import { WrapperLifecycle } from "./WrapperLifecycle";
+import { CustomComponentLifecycle } from "./CustomComponentLifecycle";
+
+export type AnyLifecycle = RoomViewLifecycle | WidgetLifecycle | WrapperLifecycle | CustomComponentLifecycle;

src/extensions/ExtensionsManager.ts

@@ -13,10 +13,12 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { ProvideCryptoSetupExtensions } from "../lifecycles/CryptoSetupExtensions";
-import { ProvideExperimentalExtensions } from "../lifecycles/ExperimentalExtensions";
+import { ProvideCryptoSetupExtensions } from "../extensions/CryptoSetupExtensions";
+import { ProvideExperimentalExtensions } from "../extensions/ExperimentalExtensions";
+import { ProvideUserSearchExtensions } from "../extensions/UserSearchExtensions";
 
 export type AllExtensions = {
     cryptoSetup?: ProvideCryptoSetupExtensions;
     experimental?: ProvideExperimentalExtensions;
+    userSearch?: ProvideUserSearchExtensions;
 };