feat: customize link preview image width

This commit is contained in:
Adhiraj Singh
2022-04-19 19:12:24 +05:30
parent ab65a4dad9
commit f421f5d387
4 changed files with 19 additions and 7 deletions

View File

@@ -37,6 +37,7 @@ const BASE_CONNECTION_CONFIG: CommonSocketConfig<any> = {
export const DEFAULT_CONNECTION_CONFIG: SocketConfig = { export const DEFAULT_CONNECTION_CONFIG: SocketConfig = {
...BASE_CONNECTION_CONFIG, ...BASE_CONNECTION_CONFIG,
waWebSocketUrl: 'wss://web.whatsapp.com/ws/chat', waWebSocketUrl: 'wss://web.whatsapp.com/ws/chat',
linkPreviewImageThumbnailWidth: 192,
getMessage: async() => undefined getMessage: async() => undefined
} }

View File

@@ -9,7 +9,7 @@ import { BinaryNode, BinaryNodeAttributes, getBinaryNodeChild, getBinaryNodeChil
import { makeGroupsSocket } from './groups' import { makeGroupsSocket } from './groups'
export const makeMessagesSocket = (config: SocketConfig) => { export const makeMessagesSocket = (config: SocketConfig) => {
const { logger } = config const { logger, linkPreviewImageThumbnailWidth } = config
const sock = makeGroupsSocket(config) const sock = makeGroupsSocket(config)
const { const {
ev, ev,
@@ -485,7 +485,7 @@ export const makeMessagesSocket = (config: SocketConfig) => {
logger, logger,
userJid, userJid,
// multi-device does not have this yet // multi-device does not have this yet
getUrlInfo: getUrlInfo, getUrlInfo: text => getUrlInfo(text, { thumbnailWidth: linkPreviewImageThumbnailWidth }),
upload: waUploadToServer, upload: waUploadToServer,
mediaCache: config.mediaCache, mediaCache: config.mediaCache,
...options, ...options,

View File

@@ -19,6 +19,8 @@ export type SocketConfig = CommonSocketConfig<AuthenticationState> & {
userDevicesCache?: NodeCache userDevicesCache?: NodeCache
/** map to store the retry counts for failed messages */ /** map to store the retry counts for failed messages */
msgRetryCounterMap?: { [msgId: string]: number } msgRetryCounterMap?: { [msgId: string]: number }
/** width for link preview images */
linkPreviewImageThumbnailWidth: number
/** /**
* fetch a message from your store * fetch a message from your store
* implement this so that messages failed to send (solves the "this message can take a while" issue) can be retried * implement this so that messages failed to send (solves the "this message can take a while" issue) can be retried

View File

@@ -1,22 +1,29 @@
import { WAUrlInfo } from '../Types' import { WAUrlInfo } from '../Types'
import { extractImageThumb, getHttpStream } from './messages-media' import { extractImageThumb, getHttpStream } from './messages-media'
const THUMBNAIL_WIDTH_PX = 128 const THUMBNAIL_WIDTH_PX = 192
/** Fetches an image and generates a thumbnail for it */ /** Fetches an image and generates a thumbnail for it */
const getCompressedJpegThumbnail = async(url: string) => { const getCompressedJpegThumbnail = async(url: string, thumbnailWidth: number) => {
const stream = await getHttpStream(url) const stream = await getHttpStream(url)
const result = await extractImageThumb(stream, THUMBNAIL_WIDTH_PX) const result = await extractImageThumb(stream, thumbnailWidth)
return result return result
} }
export type URLGenerationOptions = {
thumbnailWidth: number
}
/** /**
* Given a piece of text, checks for any URL present, generates link preview for the same and returns it * Given a piece of text, checks for any URL present, generates link preview for the same and returns it
* Return undefined if the fetch failed or no URL was found * Return undefined if the fetch failed or no URL was found
* @param text the text containing URL * @param text the text containing URL
* @returns the URL info required to generate link preview * @returns the URL info required to generate link preview
*/ */
export const getUrlInfo = async(text: string): Promise<WAUrlInfo | undefined> => { export const getUrlInfo = async(
text: string,
opts: URLGenerationOptions = { thumbnailWidth: THUMBNAIL_WIDTH_PX }
): Promise<WAUrlInfo | undefined> => {
try { try {
const { getLinkPreview } = await import('link-preview-js') const { getLinkPreview } = await import('link-preview-js')
@@ -24,7 +31,9 @@ export const getUrlInfo = async(text: string): Promise<WAUrlInfo | undefined> =>
if(info && 'title' in info) { if(info && 'title' in info) {
const [image] = info.images const [image] = info.images
const jpegThumbnail = image ? await getCompressedJpegThumbnail(image) : undefined const jpegThumbnail = image
? await getCompressedJpegThumbnail(image, opts.thumbnailWidth)
: undefined
return { return {
'canonical-url': info.url, 'canonical-url': info.url,