Use js-sdk imports for poll event types instead of events-sdk (#9904)

* Use js-sdk imports for poll event types instead of events-sdk

* Attempt to appease some tsc --strict errors

* Manually create poll response in cypress test

cypress/e2e/polls/polls.spec.ts

@@ -16,8 +16,6 @@ limitations under the License.
 
 /// <reference types="cypress" />
 
-import { PollResponseEvent } from "matrix-events-sdk";
-
 import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import { MatrixClient } from "../../global";
 import Chainable = Cypress.Chainable;
@@ -70,8 +68,16 @@ describe("Polls", () => {
             cy.get('input[type="radio"]')
                 .invoke("attr", "value")
                 .then((optionId) => {
-                    const pollVote = PollResponseEvent.from([optionId], pollId).serialize();
+                    // We can't use the js-sdk types for this stuff directly, so manually construct the event.
-                    bot.sendEvent(roomId, pollVote.type, pollVote.content);
+                    bot.sendEvent(roomId, "org.matrix.msc3381.poll.response", {
+                        "m.relates_to": {
+                            rel_type: "m.reference",
+                            event_id: pollId,
+                        },
+                        "org.matrix.msc3381.poll.response": {
+                            answers: [optionId],
+                        },
+                    });
                 });
         });
     };

src/TextForEvent.tsx

@@ -20,7 +20,8 @@ import { logger } from "matrix-js-sdk/src/logger";
 import { removeDirectionOverrideChars } from "matrix-js-sdk/src/utils";
 import { GuestAccess, HistoryVisibility, JoinRule } from "matrix-js-sdk/src/@types/partials";
 import { EventType, MsgType } from "matrix-js-sdk/src/@types/event";
-import { M_POLL_START, M_POLL_END, PollStartEvent } from "matrix-events-sdk";
+import { M_POLL_START, M_POLL_END } from "matrix-js-sdk/src/@types/polls";
+import { PollStartEvent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
 
 import { _t } from "./languageHandler";
 import * as Roles from "./Roles";

src/components/views/context_menus/MessageContextMenu.tsx

@@ -21,7 +21,7 @@ import { EventStatus, MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType, RelationType } from "matrix-js-sdk/src/@types/event";
 import { Relations } from "matrix-js-sdk/src/models/relations";
 import { RoomMemberEvent } from "matrix-js-sdk/src/models/room-member";
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 import { Thread } from "matrix-js-sdk/src/models/thread";
 
 import { MatrixClientPeg } from "../../../MatrixClientPeg";

src/components/views/dialogs/EndPollDialog.tsx

@@ -17,7 +17,7 @@ limitations under the License.
 import React from "react";
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { MatrixClient } from "matrix-js-sdk/src/client";
-import { PollEndEvent } from "matrix-events-sdk";
+import { PollEndEvent } from "matrix-js-sdk/src/extensible_events_v1/PollEndEvent";
 
 import { _t } from "../../../languageHandler";
 import { IDialogProps } from "./IDialogProps";

src/components/views/elements/PollCreateDialog.tsx

@@ -17,14 +17,14 @@ limitations under the License.
 import React, { ChangeEvent, createRef } from "react";
 import { Room } from "matrix-js-sdk/src/models/room";
 import {
-    IPartialEvent,
+    KnownPollKind,
-    KNOWN_POLL_KIND,
     M_POLL_KIND_DISCLOSED,
     M_POLL_KIND_UNDISCLOSED,
     M_POLL_START,
-    PollStartEvent,
+} from "matrix-js-sdk/src/@types/polls";
-} from "matrix-events-sdk";
+import { PollStartEvent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
+import { IPartialEvent } from "matrix-js-sdk/src/@types/extensible_events";
 
 import ScrollableBaseModal, { IScrollableBaseState } from "../dialogs/ScrollableBaseModal";
 import { IDialogProps } from "../dialogs/IDialogProps";
@@ -51,7 +51,7 @@ interface IState extends IScrollableBaseState {
     question: string;
     options: string[];
     busy: boolean;
-    kind: KNOWN_POLL_KIND;
+    kind: KnownPollKind;
     autoFocusTarget: FocusTarget;
 }
 
@@ -263,7 +263,7 @@ export default class PollCreateDialog extends ScrollableBaseModal<IProps, IState
     };
 }
 
-function pollTypeNotes(kind: KNOWN_POLL_KIND): string {
+function pollTypeNotes(kind: KnownPollKind): string {
     if (M_POLL_KIND_DISCLOSED.matches(kind.name)) {
         return _t("Voters see results as soon as they have voted");
     } else {

src/components/views/messages/MPollBody.tsx

@@ -20,17 +20,11 @@ import { logger } from "matrix-js-sdk/src/logger";
 import { MatrixEvent, MatrixEventEvent } from "matrix-js-sdk/src/models/event";
 import { Relations, RelationsEvent } from "matrix-js-sdk/src/models/relations";
 import { MatrixClient } from "matrix-js-sdk/src/matrix";
-import {
+import { M_POLL_END, M_POLL_KIND_DISCLOSED, M_POLL_RESPONSE, M_POLL_START } from "matrix-js-sdk/src/@types/polls";
-    M_POLL_END,
-    M_POLL_KIND_DISCLOSED,
-    M_POLL_RESPONSE,
-    M_POLL_START,
-    NamespacedValue,
-    PollAnswerSubevent,
-    PollResponseEvent,
-    PollStartEvent,
-} from "matrix-events-sdk";
 import { RelatedRelations } from "matrix-js-sdk/src/models/related-relations";
+import { NamespacedValue } from "matrix-events-sdk";
+import { PollStartEvent, PollAnswerSubevent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
+import { PollResponseEvent } from "matrix-js-sdk/src/extensible_events_v1/PollResponseEvent";
 
 import { _t } from "../../../languageHandler";
 import Modal from "../../../Modal";

src/components/views/messages/MessageEvent.tsx

@@ -18,7 +18,7 @@ import React, { createRef } from "react";
 import { EventType, MsgType } from "matrix-js-sdk/src/@types/event";
 import { M_BEACON_INFO } from "matrix-js-sdk/src/@types/beacon";
 import { M_LOCATION } from "matrix-js-sdk/src/@types/location";
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 import { MatrixEventEvent } from "matrix-js-sdk/src/models/event";
 
 import SettingsStore from "../../../settings/SettingsStore";

src/components/views/rooms/MessageComposerButtons.tsx

@@ -16,7 +16,7 @@ limitations under the License.
 
 import classNames from "classnames";
 import { IEventRelation } from "matrix-js-sdk/src/models/event";
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 import React, { createContext, MouseEventHandler, ReactElement, useContext, useRef } from "react";
 import { Room } from "matrix-js-sdk/src/models/room";
 import { MatrixClient } from "matrix-js-sdk/src/client";

src/components/views/rooms/PinnedEventTile.tsx

@@ -20,7 +20,7 @@ import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { Relations } from "matrix-js-sdk/src/models/relations";
 import { EventType, RelationType } from "matrix-js-sdk/src/@types/event";
 import { logger } from "matrix-js-sdk/src/logger";
-import { M_POLL_START, M_POLL_RESPONSE, M_POLL_END } from "matrix-events-sdk";
+import { M_POLL_START, M_POLL_RESPONSE, M_POLL_END } from "matrix-js-sdk/src/@types/polls";
 
 import dis from "../../../dispatcher/dispatcher";
 import { Action } from "../../../dispatcher/actions";

src/events/EventTileFactory.tsx

@@ -17,7 +17,8 @@ limitations under the License.
 import React from "react";
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType, MsgType, RelationType } from "matrix-js-sdk/src/@types/event";
-import { M_POLL_START, Optional } from "matrix-events-sdk";
+import { Optional } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 import { MatrixClient } from "matrix-js-sdk/src/client";
 import { GroupCallIntent } from "matrix-js-sdk/src/webrtc/groupCall";
 

src/events/forward/getForwardableEvent.ts

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 import { M_BEACON_INFO } from "matrix-js-sdk/src/@types/beacon";
 import { MatrixEvent, MatrixClient } from "matrix-js-sdk/src/matrix";
 

src/stores/room-list/MessagePreviewStore.ts

@@ -17,7 +17,7 @@ limitations under the License.
 import { Room } from "matrix-js-sdk/src/models/room";
 import { isNullOrUndefined } from "matrix-js-sdk/src/utils";
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 
 import { ActionPayload } from "../../dispatcher/payloads";
 import { AsyncStoreWithClient } from "../AsyncStoreWithClient";

src/stores/room-list/previews/PollStartEventPreview.ts

@@ -15,7 +15,9 @@ limitations under the License.
 */
 
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
-import { InvalidEventError, M_POLL_START_EVENT_CONTENT, PollStartEvent } from "matrix-events-sdk";
+import { PollStartEventContent } from "matrix-js-sdk/src/@types/polls";
+import { InvalidEventError } from "matrix-js-sdk/src/extensible_events_v1/InvalidEventError";
+import { PollStartEvent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
 
 import { IPreview } from "./IPreview";
 import { TagID } from "../models";
@@ -43,7 +45,7 @@ export class PollStartEventPreview implements IPreview {
         try {
             const poll = new PollStartEvent({
                 type: event.getType(),
-                content: eventContent as M_POLL_START_EVENT_CONTENT,
+                content: eventContent as PollStartEventContent,
             });
 
             let question = poll.question.text.trim();

src/utils/EventRenderingUtils.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType, MsgType } from "matrix-js-sdk/src/@types/event";
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 import { M_BEACON_INFO } from "matrix-js-sdk/src/@types/beacon";
 import { IContent } from "matrix-js-sdk/src/matrix";
 

src/utils/EventUtils.ts

@@ -18,7 +18,7 @@ import { EventStatus, MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType, EVENT_VISIBILITY_CHANGE_TYPE, MsgType, RelationType } from "matrix-js-sdk/src/@types/event";
 import { MatrixClient } from "matrix-js-sdk/src/client";
 import { logger } from "matrix-js-sdk/src/logger";
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 import { M_LOCATION } from "matrix-js-sdk/src/@types/location";
 import { M_BEACON_INFO } from "matrix-js-sdk/src/@types/beacon";
 import { THREAD_RELATION_TYPE } from "matrix-js-sdk/src/models/thread";

src/utils/PinningUtils.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType } from "matrix-js-sdk/src/@types/event";
-import { M_POLL_START } from "matrix-events-sdk";
+import { M_POLL_START } from "matrix-js-sdk/src/@types/polls";
 
 export default class PinningUtils {
     /**

test/components/views/context_menus/MessageContextMenu-test.tsx

@@ -26,7 +26,8 @@ import {
     getBeaconInfoIdentifier,
     EventType,
 } from "matrix-js-sdk/src/matrix";
-import { M_POLL_KIND_DISCLOSED, PollStartEvent } from "matrix-events-sdk";
+import { M_POLL_KIND_DISCLOSED } from "matrix-js-sdk/src/@types/polls";
+import { PollStartEvent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
 import { FeatureSupport, Thread } from "matrix-js-sdk/src/models/thread";
 import { mocked } from "jest-mock";
 import { act } from "@testing-library/react";

test/components/views/dialogs/ForwardDialog-test.tsx

@@ -18,7 +18,7 @@ import React from "react";
 import { act } from "react-dom/test-utils";
 import { MatrixEvent, EventType } from "matrix-js-sdk/src/matrix";
 import { LocationAssetType, M_ASSET, M_LOCATION, M_TIMESTAMP } from "matrix-js-sdk/src/@types/location";
-import { TEXT_NODE_TYPE } from "matrix-js-sdk/src/@types/extensible_events";
+import { M_TEXT } from "matrix-js-sdk/src/@types/extensible_events";
 import { fireEvent, getByTestId, render, RenderResult, screen } from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
 
@@ -248,7 +248,7 @@ describe("ForwardDialog", () => {
             const expectedStrippedContent = {
                 ...modernLocationEvent.getContent(),
                 body: text,
-                [TEXT_NODE_TYPE.name]: text,
+                [M_TEXT.name]: text,
                 [M_TIMESTAMP.name]: now,
                 [M_ASSET.name]: { type: LocationAssetType.Pin },
                 [M_LOCATION.name]: {
@@ -276,7 +276,7 @@ describe("ForwardDialog", () => {
             const expectedStrippedContent = {
                 ...modernLocationEvent.getContent(),
                 body: text,
-                [TEXT_NODE_TYPE.name]: text,
+                [M_TEXT.name]: text,
                 [M_ASSET.name]: { type: LocationAssetType.Pin },
                 [M_LOCATION.name]: {
                     uri: geoUri,
@@ -297,7 +297,7 @@ describe("ForwardDialog", () => {
             const expectedContent = {
                 msgtype: "m.location",
                 body: text,
-                [TEXT_NODE_TYPE.name]: text,
+                [M_TEXT.name]: text,
                 [M_ASSET.name]: { type: LocationAssetType.Pin },
                 [M_LOCATION.name]: {
                     uri: geoUri,

test/components/views/elements/PollCreateDialog-test.tsx

@@ -18,14 +18,10 @@ import React from "react";
 // eslint-disable-next-line deprecate/import
 import { mount, ReactWrapper } from "enzyme";
 import { Room } from "matrix-js-sdk/src/models/room";
-import {
+import { M_POLL_KIND_DISCLOSED, M_POLL_KIND_UNDISCLOSED, M_POLL_START } from "matrix-js-sdk/src/@types/polls";
-    M_POLL_KIND_DISCLOSED,
+import { PollStartEvent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
-    M_POLL_KIND_UNDISCLOSED,
-    M_POLL_START,
-    M_TEXT,
-    PollStartEvent,
-} from "matrix-events-sdk";
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
+import { M_TEXT } from "matrix-js-sdk/src/@types/extensible_events";
 
 import { findById, getMockClientWithEventEmitter } from "../../../test-utils";
 import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";

test/components/views/messages/MPollBody-test.tsx

@@ -26,10 +26,10 @@ import {
     M_POLL_KIND_UNDISCLOSED,
     M_POLL_RESPONSE,
     M_POLL_START,
-    M_POLL_START_EVENT_CONTENT,
+    PollStartEventContent,
-    M_TEXT,
+    PollAnswer,
-    POLL_ANSWER,
+} from "matrix-js-sdk/src/@types/polls";
-} from "matrix-events-sdk";
+import { M_TEXT } from "matrix-js-sdk/src/@types/extensible_events";
 import { MockedObject } from "jest-mock";
 
 import {
@@ -440,7 +440,7 @@ describe("MPollBody", () => {
             responseEvent("@catrd:example.com", "poutine"),
             responseEvent("@dune2:example.com", "wings"),
         ];
-        const body = newMPollBody(votes, [], null, false);
+        const body = newMPollBody(votes, [], undefined, false);
         expect(votesCount(body, "pizza")).toBe("");
         expect(votesCount(body, "poutine")).toBe("");
         expect(votesCount(body, "italian")).toBe("");
@@ -456,7 +456,7 @@ describe("MPollBody", () => {
             responseEvent("@catrd:example.com", "poutine"),
             responseEvent("@dune2:example.com", "wings"),
         ];
-        const body = newMPollBody(votes, [], null, false);
+        const body = newMPollBody(votes, [], undefined, false);
 
         // My vote is marked
         expect(body.find('input[value="pizza"]').prop("checked")).toBeTruthy();
@@ -474,7 +474,7 @@ describe("MPollBody", () => {
             responseEvent("@dune2:example.com", "wings"),
         ];
         const ends = [endEvent("@me:example.com", 12)];
-        const body = newMPollBody(votes, ends, null, false);
+        const body = newMPollBody(votes, ends, undefined, false);
         expect(endedVotesCount(body, "pizza")).toBe("3 votes");
         expect(endedVotesCount(body, "poutine")).toBe("1 vote");
         expect(endedVotesCount(body, "italian")).toBe("0 votes");
@@ -913,7 +913,7 @@ describe("MPollBody", () => {
             responseEvent("@yh:example.com", "poutine", 14),
         ];
         const ends = [];
-        const body = newMPollBody(votes, ends, null, false);
+        const body = newMPollBody(votes, ends, undefined, false);
         expect(body.html()).toMatchSnapshot();
     });
 
@@ -927,7 +927,7 @@ describe("MPollBody", () => {
             responseEvent("@yh:example.com", "poutine", 14),
         ];
         const ends = [endEvent("@me:example.com", 25)];
-        const body = newMPollBody(votes, ends, null, false);
+        const body = newMPollBody(votes, ends, undefined, false);
         expect(body.html()).toMatchSnapshot();
     });
 });
@@ -951,7 +951,7 @@ function newRelations(relationEvents: Array<MatrixEvent>, eventType: string): Re
 function newMPollBody(
     relationEvents: Array<MatrixEvent>,
     endEvents: Array<MatrixEvent> = [],
-    answers?: POLL_ANSWER[],
+    answers?: PollAnswer[],
     disclosed = true,
 ): ReactWrapper {
     const mxEvent = new MatrixEvent({
@@ -1033,7 +1033,7 @@ function endedVotesCount(wrapper: ReactWrapper, value: string): string {
     return wrapper.find(`div[data-value="${value}"] .mx_MPollBody_optionVoteCount`).text();
 }
 
-function newPollStart(answers?: POLL_ANSWER[], question?: string, disclosed = true): M_POLL_START_EVENT_CONTENT {
+function newPollStart(answers?: PollAnswer[], question?: string, disclosed = true): PollStartEventContent {
     if (!answers) {
         answers = [
             { id: "pizza", [M_TEXT.name]: "Pizza" },
@@ -1047,7 +1047,7 @@ function newPollStart(answers?: POLL_ANSWER[], question?: string, disclosed = tr
         question = "What should we order for the party?";
     }
 
-    const answersFallback = answers.map((a, i) => `${i + 1}. ${a[M_TEXT.name]}`).join("\n");
+    const answersFallback = answers.map((a, i) => `${i + 1}. ${M_TEXT.findIn<string>(a)}`).join("\n");
 
     const fallback = `${question}\n${answersFallback}`;
 

test/components/views/right_panel/PinnedMessagesCard-test.tsx

@@ -23,14 +23,10 @@ import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType, RelationType, MsgType } from "matrix-js-sdk/src/@types/event";
 import { RoomStateEvent } from "matrix-js-sdk/src/models/room-state";
 import { IEvent, Room, EventTimelineSet, IMinimalEvent } from "matrix-js-sdk/src/matrix";
-import {
+import { M_POLL_RESPONSE, M_POLL_END, M_POLL_KIND_DISCLOSED } from "matrix-js-sdk/src/@types/polls";
-    M_POLL_RESPONSE,
+import { PollStartEvent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
-    M_POLL_END,
+import { PollResponseEvent } from "matrix-js-sdk/src/extensible_events_v1/PollResponseEvent";
-    M_POLL_KIND_DISCLOSED,
+import { PollEndEvent } from "matrix-js-sdk/src/extensible_events_v1/PollEndEvent";
-    PollStartEvent,
-    PollResponseEvent,
-    PollEndEvent,
-} from "matrix-events-sdk";
 
 import { stubClient, mkStubRoom, mkEvent, mkMessage } from "../../../test-utils";
 import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";

test/test-utils/poll.ts

@@ -15,9 +15,10 @@ limitations under the License.
 */
 
 import { MatrixEvent } from "matrix-js-sdk/src/matrix";
-import { M_TEXT, M_POLL_START, POLL_ANSWER, M_POLL_KIND_DISCLOSED } from "matrix-events-sdk";
+import { M_POLL_START, PollAnswer, M_POLL_KIND_DISCLOSED } from "matrix-js-sdk/src/@types/polls";
+import { M_TEXT } from "matrix-js-sdk/src/@types/extensible_events";
 
-export const makePollStartEvent = (question: string, sender: string, answers?: POLL_ANSWER[]): MatrixEvent => {
+export const makePollStartEvent = (question: string, sender: string, answers?: PollAnswer[]): MatrixEvent => {
     if (!answers) {
         answers = [
             { id: "socks", [M_TEXT.name]: "Socks" },

test/utils/location/isSelfLocation-test.ts

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { TEXT_NODE_TYPE } from "matrix-js-sdk/src/@types/extensible_events";
+import { M_TEXT } from "matrix-js-sdk/src/@types/extensible_events";
 import {
     ILocationContent,
     LocationAssetType,
@@ -38,7 +38,7 @@ describe("isSelfLocation", () => {
             msgtype: "m.location",
             geo_uri: "",
             [M_LOCATION.name]: { uri: "" },
-            [TEXT_NODE_TYPE.name]: "",
+            [M_TEXT.name]: "",
             [M_TIMESTAMP.name]: 0,
             // Note: no m.asset!
         };
@@ -51,7 +51,7 @@ describe("isSelfLocation", () => {
             msgtype: "m.location",
             geo_uri: "",
             [M_LOCATION.name]: { uri: "" },
-            [TEXT_NODE_TYPE.name]: "",
+            [M_TEXT.name]: "",
             [M_TIMESTAMP.name]: 0,
             [M_ASSET.name]: {
                 // Note: no type!