Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

widgetize: Convert module to typescript.

This commit is contained in:
Joydeep Bhattacharjee 2024-02-26 19:21:39 +00:00 committed by Tim Abbott
parent 94cd67b90f
commit d99238526d
2 changed files with 38 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
web/src/poll_widget.ts
View File

@ -16,7 +16,7 @@ import * as keydown_util from "./keydown_util";
import type {Message} from "./message_store"; import type {Message} from "./message_store";
import * as people from "./people"; import * as people from "./people";
type Event = {sender_id: number; data: InboundData}; export type Event = {sender_id: number; data: InboundData};
export type ExtraData = { export type ExtraData = {
question?: string; question?: string;

47
web/src/widgetize.js → web/src/widgetize.ts
View File

@ -2,15 +2,42 @@ import $ from "jquery";
import * as blueslip from "./blueslip"; import * as blueslip from "./blueslip";
import * as message_lists from "./message_lists"; import * as message_lists from "./message_lists";
import type {Message} from "./message_store";
import type {Event, ExtraData as PollWidgetExtraData} from "./poll_widget";
export const widgets = new Map(); // TODO: This ZFormExtraData type should be moved to web/src/zform.js when it will be migrated
export const widget_contents = new Map(); type ZFormExtraData = {
type: string;
heading: string;
choices: {type: string; reply: string; long_name: string; short_name: string}[];
};
export function clear_for_testing() { type WidgetOptions = {
widget_type: string;
extra_data: PollWidgetExtraData | ZFormExtraData | null;
events: Event[];
$row: JQuery;
message: Message;
post_to_server: (data: {msg_type: string; data: string}) => void;
};
type WidgetValue = Record<string, unknown> & {
activate: (data: {
$elem: JQuery;
callback: (data: string) => void;
message: Message;
extra_data: WidgetOptions["extra_data"];
}) => void;
};
export const widgets = new Map<string, WidgetValue>();
export const widget_contents = new Map<number, JQuery>();
export function clear_for_testing(): void {
widget_contents.clear(); widget_contents.clear();
} }
function set_widget_in_message($row, $widget_elem) { function set_widget_in_message($row: JQuery, $widget_elem: JQuery): void {
const $content_holder = $row.find(".message_content"); const $content_holder = $row.find(".message_content");
// Avoid adding the $widget_elem if it already exists. // Avoid adding the $widget_elem if it already exists.
@ -23,7 +50,7 @@ function set_widget_in_message($row, $widget_elem) {
} }
} }
export function activate(in_opts) { export function activate(in_opts: WidgetOptions): void {
const widget_type = in_opts.widget_type; const widget_type = in_opts.widget_type;
const extra_data = in_opts.extra_data; const extra_data = in_opts.extra_data;
const events = in_opts.events; const events = in_opts.events;
@ -41,14 +68,14 @@ export function activate(in_opts) {
return; return;
} }
const callback = function (data) { const callback = function (data: string): void {
post_to_server({ post_to_server({
msg_type: "widget", msg_type: "widget",
data, data,
}); });
}; };
if (!$row.attr("id").startsWith(`message-row-${message_lists.current?.id}-`)) { if (!$row.attr("id")!.startsWith(`message-row-${message_lists.current?.id}-`)) {
// Don't activate widgets for messages that are not in the current view. // Don't activate widgets for messages that are not in the current view.
return; return;
} }
@ -63,7 +90,7 @@ export function activate(in_opts) {
// the HTML that will eventually go in this div. // the HTML that will eventually go in this div.
$widget_elem = $("<div>").addClass("widget-content"); $widget_elem = $("<div>").addClass("widget-content");
widgets.get(widget_type).activate({ widgets.get(widget_type)!.activate({
$elem: $widget_elem, $elem: $widget_elem,
callback, callback,
message, message,
@ -81,7 +108,7 @@ export function activate(in_opts) {
} }
} }
export function set_widgets_for_list() { export function set_widgets_for_list(): void {
for (const [idx, $widget_elem] of widget_contents) { for (const [idx, $widget_elem] of widget_contents) {
if (message_lists.current?.get(idx) !== undefined) { if (message_lists.current?.get(idx) !== undefined) {
const $row = message_lists.current.get_row(idx); const $row = message_lists.current.get_row(idx);
@ -90,7 +117,7 @@ export function set_widgets_for_list() {
} }
} }
export function handle_event(widget_event) { export function handle_event(widget_event: Event & {message_id: number}): void {
const $widget_elem = widget_contents.get(widget_event.message_id); const $widget_elem = widget_contents.get(widget_event.message_id);
if (!$widget_elem) { if (!$widget_elem) {