Attempt to break up a couple more import cycles

turt2live · turt2live · commit e838e188a303 · 2022-06-27T13:21:29.000-06:00
diff --git a/src/CallHandler.tsx b/src/CallHandler.tsx
@@ -53,7 +53,8 @@ import VoipUserMapper from './VoipUserMapper';
 import { addManagedHybridWidget, isManagedHybridWidgetEnabled } from './widgets/ManagedHybrid';
 import SdkConfig from './SdkConfig';
 import { ensureDMExists } from './createRoom';
-import { Container, WidgetLayoutStore } from './stores/widgets/WidgetLayoutStore';
+import { WidgetLayoutStore } from './stores/widgets/WidgetLayoutStore';
+import { Container } from "./stores/widgets/types";
 import IncomingCallToast, { getIncomingCallToastKey } from './toasts/IncomingCallToast';
 import ToastStore from './stores/ToastStore';
 import Resend from './Resend';
diff --git a/src/RoomInvite.tsx b/src/RoomInvite.tsx
@@ -16,10 +16,8 @@ limitations under the License.
 
 import React from "react";
 import { Room } from "matrix-js-sdk/src/models/room";
-import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { User } from "matrix-js-sdk/src/models/user";
 import { logger } from "matrix-js-sdk/src/logger";
-import { EventType } from "matrix-js-sdk/src/@types/event";
 
 import { MatrixClientPeg } from './MatrixClientPeg';
 import MultiInviter, { CompletionStates } from './utils/MultiInviter';
@@ -79,24 +77,6 @@ export function showRoomInviteDialog(roomId: string, initialText = ""): void {
     );
 }
 
-/**
- * Checks if the given MatrixEvent is a valid 3rd party user invite.
- * @param {MatrixEvent} event The event to check
- * @returns {boolean} True if valid, false otherwise
- */
-export function isValid3pidInvite(event: MatrixEvent): boolean {
-    if (!event || event.getType() !== EventType.RoomThirdPartyInvite) return false;
-
-    // any events without these keys are not valid 3pid invites, so we ignore them
-    const requiredKeys = ['key_validity_url', 'public_key', 'display_name'];
-    if (requiredKeys.some(key => !event.getContent()[key])) {
-        return false;
-    }
-
-    // Valid enough by our standards
-    return true;
-}
-
 export function inviteUsersToRoom(
     roomId: string,
     userIds: string[],
diff --git a/src/TextForEvent.tsx b/src/TextForEvent.tsx
@@ -32,10 +32,10 @@ import {
 
 import { _t } from './languageHandler';
 import * as Roles from './Roles';
-import { isValid3pidInvite } from "./RoomInvite";
+import { isValid3pidInvite } from "./utils/invites";
 import SettingsStore from "./settings/SettingsStore";
 import { ALL_RULE_TYPES, ROOM_RULE_TYPES, SERVER_RULE_TYPES, USER_RULE_TYPES } from "./mjolnir/BanList";
-import { WIDGET_LAYOUT_EVENT_TYPE } from "./stores/widgets/WidgetLayoutStore";
+import { WIDGET_LAYOUT_EVENT_TYPE } from "./stores/widgets/types";
 import { RightPanelPhases } from './stores/right-panel/RightPanelStorePhases';
 import { Action } from './dispatcher/actions';
 import defaultDispatcher from './dispatcher/dispatcher';
diff --git a/src/components/structures/RoomView.tsx b/src/components/structures/RoomView.tsx
@@ -83,7 +83,8 @@ import { UPDATE_EVENT } from "../../stores/AsyncStore";
 import Notifier from "../../Notifier";
 import { showToast as showNotificationsToast } from "../../toasts/DesktopNotificationsToast";
 import { RoomNotificationStateStore } from "../../stores/notifications/RoomNotificationStateStore";
-import { Container, WidgetLayoutStore } from "../../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../stores/widgets/WidgetLayoutStore";
+import { Container } from "../../stores/widgets/types";
 import { getKeyBindingsManager } from '../../KeyBindingsManager';
 import { objectHasDiff } from "../../utils/objects";
 import SpaceRoomView from "./SpaceRoomView";
diff --git a/src/components/views/context_menus/WidgetContextMenu.tsx b/src/components/views/context_menus/WidgetContextMenu.tsx
@@ -32,7 +32,8 @@ import QuestionDialog from "../dialogs/QuestionDialog";
 import ErrorDialog from "../dialogs/ErrorDialog";
 import { WidgetType } from "../../../widgets/WidgetType";
 import MatrixClientContext from "../../../contexts/MatrixClientContext";
-import { Container, WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { Container } from "../../../stores/widgets/types";
 import { getConfigLivestreamUrl, startJitsiAudioLivestream } from "../../../Livestream";
 
 interface IProps extends React.ComponentProps<typeof IconizedContextMenu> {
diff --git a/src/components/views/elements/AppTile.tsx b/src/components/views/elements/AppTile.tsx
@@ -41,7 +41,8 @@ import WidgetContextMenu from "../context_menus/WidgetContextMenu";
 import WidgetAvatar from "../avatars/WidgetAvatar";
 import CallHandler from '../../../CallHandler';
 import { IApp } from "../../../stores/WidgetStore";
-import { Container, WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { Container } from "../../../stores/widgets/types";
 import { OwnProfileStore } from '../../../stores/OwnProfileStore';
 import { UPDATE_EVENT } from '../../../stores/AsyncStore';
 import { RoomViewStore } from '../../../stores/RoomViewStore';
diff --git a/src/components/views/elements/EventListSummary.tsx b/src/components/views/elements/EventListSummary.tsx
@@ -23,7 +23,7 @@ import { EventType } from 'matrix-js-sdk/src/@types/event';
 
 import { _t } from '../../../languageHandler';
 import { formatCommaSeparatedList } from '../../../utils/FormattingUtils';
-import { isValid3pidInvite } from "../../../RoomInvite";
+import { isValid3pidInvite } from "../../../utils/invites";
 import GenericEventListSummary from "./GenericEventListSummary";
 import { RightPanelPhases } from '../../../stores/right-panel/RightPanelStorePhases';
 import { jsxJoin } from '../../../utils/ReactUtils';
diff --git a/src/components/views/messages/MJitsiWidgetEvent.tsx b/src/components/views/messages/MJitsiWidgetEvent.tsx
@@ -21,7 +21,8 @@ import { _t } from "../../../languageHandler";
 import WidgetStore from "../../../stores/WidgetStore";
 import EventTileBubble from "./EventTileBubble";
 import { MatrixClientPeg } from "../../../MatrixClientPeg";
-import { Container, WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { Container } from "../../../stores/widgets/types";
 
 interface IProps {
     mxEvent: MatrixEvent;
diff --git a/src/components/views/right_panel/RoomSummaryCard.tsx b/src/components/views/right_panel/RoomSummaryCard.tsx
@@ -44,7 +44,8 @@ import WidgetContextMenu from "../context_menus/WidgetContextMenu";
 import { useRoomMemberCount } from "../../../hooks/useRoomMembers";
 import { useFeatureEnabled } from "../../../hooks/useSettings";
 import { usePinnedEvents } from "./PinnedMessagesCard";
-import { Container, MAX_PINNED, WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { Container, MAX_PINNED } from "../../../stores/widgets/types";
 import RoomName from "../elements/RoomName";
 import UIStore from "../../../stores/UIStore";
 import ExportDialog from "../dialogs/ExportDialog";
diff --git a/src/components/views/right_panel/WidgetCard.tsx b/src/components/views/right_panel/WidgetCard.tsx
@@ -25,7 +25,8 @@ import { _t } from "../../../languageHandler";
 import { useWidgets } from "./RoomSummaryCard";
 import { ChevronFace, ContextMenuButton, useContextMenu } from "../../structures/ContextMenu";
 import WidgetContextMenu from "../context_menus/WidgetContextMenu";
-import { Container, WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { Container } from "../../../stores/widgets/types";
 import UIStore from "../../../stores/UIStore";
 import RightPanelStore from "../../../stores/right-panel/RightPanelStore";
 import Heading from '../typography/Heading';
diff --git a/src/components/views/rooms/AppsDrawer.tsx b/src/components/views/rooms/AppsDrawer.tsx
@@ -29,7 +29,8 @@ import ResizeNotifier from "../../../utils/ResizeNotifier";
 import ResizeHandle from "../elements/ResizeHandle";
 import Resizer from "../../../resizer/resizer";
 import PercentageDistributor from "../../../resizer/distributors/percentage";
-import { Container, WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../../stores/widgets/WidgetLayoutStore";
+import { Container } from "../../../stores/widgets/types";
 import { clamp, percentageOf, percentageWithin } from "../../../utils/numbers";
 import { useStateCallback } from "../../../hooks/useStateCallback";
 import UIStore from "../../../stores/UIStore";
diff --git a/src/components/views/rooms/MemberList.tsx b/src/components/views/rooms/MemberList.tsx
@@ -31,7 +31,7 @@ import { EventType } from "matrix-js-sdk/src/@types/event";
 import { _t } from '../../../languageHandler';
 import SdkConfig from '../../../SdkConfig';
 import dis from '../../../dispatcher/dispatcher';
-import { isValid3pidInvite } from "../../../RoomInvite";
+import { isValid3pidInvite } from "../../../utils/invites";
 import { MatrixClientPeg } from "../../../MatrixClientPeg";
 import BaseCard from "../right_panel/BaseCard";
 import RoomAvatar from "../avatars/RoomAvatar";
diff --git a/src/components/views/rooms/ThirdPartyMemberInfo.tsx b/src/components/views/rooms/ThirdPartyMemberInfo.tsx
@@ -25,7 +25,7 @@ import { MatrixClientPeg } from "../../../MatrixClientPeg";
 import { _t } from "../../../languageHandler";
 import dis from "../../../dispatcher/dispatcher";
 import Modal from "../../../Modal";
-import { isValid3pidInvite } from "../../../RoomInvite";
+import { isValid3pidInvite } from "../../../utils/invites";
 import RoomAvatar from "../avatars/RoomAvatar";
 import RoomName from "../elements/RoomName";
 import ErrorDialog from '../dialogs/ErrorDialog';
diff --git a/src/components/views/voip/PipView.tsx b/src/components/views/voip/PipView.tsx
@@ -30,7 +30,8 @@ import { MatrixClientPeg } from '../../../MatrixClientPeg';
 import PictureInPictureDragger from './PictureInPictureDragger';
 import dis from '../../../dispatcher/dispatcher';
 import { Action } from "../../../dispatcher/actions";
-import { Container, WidgetLayoutStore } from '../../../stores/widgets/WidgetLayoutStore';
+import { WidgetLayoutStore } from '../../../stores/widgets/WidgetLayoutStore';
+import { Container } from "../../../stores/widgets/types";
 import CallViewHeader from './CallView/CallViewHeader';
 import ActiveWidgetStore, { ActiveWidgetStoreEvent } from '../../../stores/ActiveWidgetStore';
 import WidgetStore, { IApp } from "../../../stores/WidgetStore";
diff --git a/src/events/EventTileFactory.tsx b/src/events/EventTileFactory.tsx
@@ -32,7 +32,7 @@ import TextualEvent from "../components/views/messages/TextualEvent";
 import EncryptionEvent from "../components/views/messages/EncryptionEvent";
 import RoomCreate from "../components/views/messages/RoomCreate";
 import RoomAvatarEvent from "../components/views/messages/RoomAvatarEvent";
-import { WIDGET_LAYOUT_EVENT_TYPE } from "../stores/widgets/WidgetLayoutStore";
+import { WIDGET_LAYOUT_EVENT_TYPE } from "../stores/widgets/types";
 import { ALL_RULE_TYPES } from "../mjolnir/BanList";
 import { MatrixClientPeg } from "../MatrixClientPeg";
 import MKeyVerificationRequest from "../components/views/messages/MKeyVerificationRequest";
diff --git a/src/stores/widgets/WidgetLayoutStore.ts b/src/stores/widgets/WidgetLayoutStore.ts
@@ -29,44 +29,7 @@ import { SettingLevel } from "../../settings/SettingLevel";
 import { arrayFastClone } from "../../utils/arrays";
 import { UPDATE_EVENT } from "../AsyncStore";
 import { compare } from "../../utils/strings";
-
-export const WIDGET_LAYOUT_EVENT_TYPE = "io.element.widgets.layout";
-
-export enum Container {
-    // "Top" is the app drawer, and currently the only sensible value.
-    Top = "top",
-
-    // "Right" is the right panel, and the default for widgets. Setting
-    // this as a container on a widget is essentially like saying "no
-    // changes needed", though this may change in the future.
-    Right = "right",
-
-    Center = "center"
-}
-
-export interface IStoredLayout {
-    // Where to store the widget. Required.
-    container: Container;
-
-    // The index (order) to position the widgets in. Only applies for
-    // ordered containers (like the top container). Smaller numbers first,
-    // and conflicts resolved by comparing widget IDs.
-    index?: number;
-
-    // Percentage (integer) for relative width of the container to consume.
-    // Clamped to 0-100 and may have minimums imposed upon it. Only applies
-    // to containers which support inner resizing (currently only the top
-    // container).
-    width?: number;
-
-    // Percentage (integer) for relative height of the container. Note that
-    // this only applies to the top container currently, and that container
-    // will take the highest value among widgets in the container. Clamped
-    // to 0-100 and may have minimums imposed on it.
-    height?: number;
-
-    // TODO: [Deferred] Maximizing (fullscreen) widgets by default.
-}
+import { Container, IStoredLayout, MAX_PINNED, WIDGET_LAYOUT_EVENT_TYPE } from "./types";
 
 interface IWidgetLayouts {
     [widgetId: string]: IStoredLayout;
@@ -83,9 +46,6 @@ interface ILayoutSettings extends ILayoutStateEvent {
     overrides?: string; // event ID for layout state event, if present
 }
 
-// Dev note: "Pinned" widgets are ones in the top container.
-export const MAX_PINNED = 3;
-
 // These two are whole percentages and don't really mean anything. Later values will decide
 // minimum, but these help determine proportions during our calculations here. In fact, these
 // values should be *smaller* than the actual minimums imposed by later components.
diff --git a/src/stores/widgets/types.ts b/src/stores/widgets/types.ts
@@ -0,0 +1,56 @@
+/*
+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 const WIDGET_LAYOUT_EVENT_TYPE = "io.element.widgets.layout";
+
+export enum Container {
+    // "Top" is the app drawer, and currently the only sensible value.
+    Top = "top",
+
+    // "Right" is the right panel, and the default for widgets. Setting
+    // this as a container on a widget is essentially like saying "no
+    // changes needed", though this may change in the future.
+    Right = "right",
+
+    Center = "center"
+}
+
+export interface IStoredLayout {
+    // Where to store the widget. Required.
+    container: Container;
+
+    // The index (order) to position the widgets in. Only applies for
+    // ordered containers (like the top container). Smaller numbers first,
+    // and conflicts resolved by comparing widget IDs.
+    index?: number;
+
+    // Percentage (integer) for relative width of the container to consume.
+    // Clamped to 0-100 and may have minimums imposed upon it. Only applies
+    // to containers which support inner resizing (currently only the top
+    // container).
+    width?: number;
+
+    // Percentage (integer) for relative height of the container. Note that
+    // this only applies to the top container currently, and that container
+    // will take the highest value among widgets in the container. Clamped
+    // to 0-100 and may have minimums imposed on it.
+    height?: number;
+
+    // TODO: [Deferred] Maximizing (fullscreen) widgets by default.
+}
+
+// Dev note: "Pinned" widgets are ones in the top container.
+export const MAX_PINNED = 3;
diff --git a/src/utils/invites.ts b/src/utils/invites.ts
@@ -0,0 +1,36 @@
+/*
+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 { MatrixEvent } from "matrix-js-sdk/src/models/event";
+import { EventType } from "matrix-js-sdk/src/@types/event";
+
+/**
+ * Checks if the given MatrixEvent is a valid 3rd party user invite.
+ * @param {MatrixEvent} event The event to check
+ * @returns {boolean} True if valid, false otherwise
+ */
+export function isValid3pidInvite(event: MatrixEvent): boolean {
+    if (!event || event.getType() !== EventType.RoomThirdPartyInvite) return false;
+
+    // any events without these keys are not valid 3pid invites, so we ignore them
+    const requiredKeys = ['key_validity_url', 'public_key', 'display_name'];
+    if (requiredKeys.some(key => !event.getContent()[key])) {
+        return false;
+    }
+
+    // Valid enough by our standards
+    return true;
+}
diff --git a/src/widgets/ManagedHybrid.ts b/src/widgets/ManagedHybrid.ts
@@ -20,7 +20,8 @@ import { logger } from "matrix-js-sdk/src/logger";
 import { MatrixClientPeg } from "../MatrixClientPeg";
 import { getCallBehaviourWellKnown } from "../utils/WellKnownUtils";
 import WidgetUtils from "../utils/WidgetUtils";
-import { IStoredLayout, WidgetLayoutStore } from "../stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../stores/widgets/WidgetLayoutStore";
+import { IStoredLayout } from "../stores/widgets/types";
 import WidgetEchoStore from "../stores/WidgetEchoStore";
 import WidgetStore from "../stores/WidgetStore";
 import SdkConfig from "../SdkConfig";
diff --git a/test/components/views/elements/AppTile-test.tsx b/test/components/views/elements/AppTile-test.tsx
@@ -37,7 +37,8 @@ import { UPDATE_EVENT } from "../../../../src/stores/AsyncStore";
 import WidgetStore, { IApp } from "../../../../src/stores/WidgetStore";
 import ActiveWidgetStore from "../../../../src/stores/ActiveWidgetStore";
 import AppTile from "../../../../src/components/views/elements/AppTile";
-import { Container, WidgetLayoutStore } from "../../../../src/stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../../../src/stores/widgets/WidgetLayoutStore";
+import { Container } from "../../../../src/stores/widgets/types";
 import AppsDrawer from "../../../../src/components/views/rooms/AppsDrawer";
 import { ElementWidgetCapabilities } from "../../../../src/stores/widgets/ElementWidgetCapabilities";
 import { ElementWidget } from "../../../../src/stores/widgets/StopGapWidget";
diff --git a/test/stores/WidgetLayoutStore-test.ts b/test/stores/WidgetLayoutStore-test.ts
@@ -17,7 +17,8 @@ limitations under the License.
 import { Room } from "matrix-js-sdk/src/matrix";
 
 import WidgetStore, { IApp } from "../../src/stores/WidgetStore";
-import { Container, WidgetLayoutStore } from "../../src/stores/widgets/WidgetLayoutStore";
+import { WidgetLayoutStore } from "../../src/stores/widgets/WidgetLayoutStore";
+import { Container } from "../../src/stores/widgets/types";
 import { stubClient } from "../test-utils";
 
 // setup test env values
