signal-desktop/ts/state/ducks/linkPreviews.ts

135 lines
3.2 KiB
TypeScript

// Copyright 2021 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
import type { ThunkAction } from 'redux-thunk';
import type { BoundActionCreatorsMapObject } from '../../hooks/useBoundActions';
import type { LinkPreviewType } from '../../types/message/LinkPreviews';
import type { MaybeGrabLinkPreviewOptionsType } from '../../types/LinkPreview';
import type { NoopActionType } from './noop';
import type { StateType as RootStateType } from '../reducer';
import { LinkPreviewSourceType } from '../../types/LinkPreview';
import { assignWithNoUnnecessaryAllocation } from '../../util/assignWithNoUnnecessaryAllocation';
import { maybeGrabLinkPreview } from '../../services/LinkPreview';
import { strictAssert } from '../../util/assert';
import { useBoundActions } from '../../hooks/useBoundActions';
// State
export type LinkPreviewsStateType = {
readonly linkPreview?: LinkPreviewType;
readonly source?: LinkPreviewSourceType;
};
// Actions
export const ADD_PREVIEW = 'linkPreviews/ADD_PREVIEW';
export const REMOVE_PREVIEW = 'linkPreviews/REMOVE_PREVIEW';
export type AddLinkPreviewActionType = {
type: 'linkPreviews/ADD_PREVIEW';
payload: {
conversationId?: string;
linkPreview: LinkPreviewType;
source: LinkPreviewSourceType;
};
};
export type RemoveLinkPreviewActionType = {
type: 'linkPreviews/REMOVE_PREVIEW';
payload: {
conversationId?: string;
};
};
type LinkPreviewsActionType =
| AddLinkPreviewActionType
| RemoveLinkPreviewActionType;
// Action Creators
function debouncedMaybeGrabLinkPreview(
message: string,
source: LinkPreviewSourceType,
options?: MaybeGrabLinkPreviewOptionsType
): ThunkAction<void, RootStateType, unknown, NoopActionType> {
return dispatch => {
maybeGrabLinkPreview(message, source, options);
dispatch({
type: 'NOOP',
payload: null,
});
};
}
function addLinkPreview(
linkPreview: LinkPreviewType,
source: LinkPreviewSourceType,
conversationId?: string
): AddLinkPreviewActionType {
if (source === LinkPreviewSourceType.Composer) {
strictAssert(conversationId, 'no conversationId provided');
}
return {
type: ADD_PREVIEW,
payload: {
conversationId,
linkPreview,
source,
},
};
}
function removeLinkPreview(
conversationId?: string
): RemoveLinkPreviewActionType {
return {
type: REMOVE_PREVIEW,
payload: {
conversationId,
},
};
}
export const actions = {
addLinkPreview,
debouncedMaybeGrabLinkPreview,
removeLinkPreview,
};
export const useLinkPreviewActions = (): BoundActionCreatorsMapObject<
typeof actions
> => useBoundActions(actions);
// Reducer
export function getEmptyState(): LinkPreviewsStateType {
return {
linkPreview: undefined,
};
}
export function reducer(
state: Readonly<LinkPreviewsStateType> = getEmptyState(),
action: Readonly<LinkPreviewsActionType>
): LinkPreviewsStateType {
if (action.type === ADD_PREVIEW) {
const { payload } = action;
return {
linkPreview: payload.linkPreview,
source: payload.source,
};
}
if (action.type === REMOVE_PREVIEW) {
return assignWithNoUnnecessaryAllocation(state, {
linkPreview: undefined,
source: undefined,
});
}
return state;
}