Convert js/modules/types/contact.js to TypeScript

This commit is contained in:
Fedor Indutny 2021-09-23 07:26:25 -07:00 committed by GitHub
parent e6d952d105
commit dbd427396c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 641 additions and 564 deletions

View file

@ -1,154 +0,0 @@
// Copyright 2018-2020 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
const { omit, compact, map } = require('lodash');
const { toLogFormat } = require('../../../ts/types/errors');
const { SignalService } = require('../../../ts/protobuf');
const { parse: parsePhoneNumber } = require('../../../ts/types/PhoneNumber');
const DEFAULT_PHONE_TYPE = SignalService.DataMessage.Contact.Phone.Type.HOME;
const DEFAULT_EMAIL_TYPE = SignalService.DataMessage.Contact.Email.Type.HOME;
const DEFAULT_ADDRESS_TYPE =
SignalService.DataMessage.Contact.PostalAddress.Type.HOME;
exports.parseAndWriteAvatar = upgradeAttachment => async (
contact,
context = {}
) => {
const { message, regionCode, logger } = context;
const { avatar } = contact;
// This is to ensure that an omit() call doesn't pull in prototype props/methods
const contactShallowCopy = { ...contact };
const contactWithUpdatedAvatar =
avatar && avatar.avatar
? {
...contactShallowCopy,
avatar: {
...avatar,
avatar: await upgradeAttachment(avatar.avatar, context),
},
}
: omit(contactShallowCopy, ['avatar']);
// eliminates empty numbers, emails, and addresses; adds type if not provided
const parsedContact = parseContact(contactWithUpdatedAvatar, { regionCode });
const error = exports._validate(parsedContact, {
messageId: idForLogging(message),
});
if (error) {
logger.error(
'Contact.parseAndWriteAvatar: contact was malformed.',
toLogFormat(error)
);
}
return parsedContact;
};
function parseContact(contact, options = {}) {
const { regionCode } = options;
const boundParsePhone = phoneNumber =>
parsePhoneItem(phoneNumber, { regionCode });
return {
...omit(contact, ['avatar', 'number', 'email', 'address']),
...parseAvatar(contact.avatar),
...createArrayKey('number', compact(map(contact.number, boundParsePhone))),
...createArrayKey('email', compact(map(contact.email, parseEmailItem))),
...createArrayKey('address', compact(map(contact.address, parseAddress))),
};
}
function idForLogging(message) {
return `${message.source}.${message.sourceDevice} ${message.sent_at}`;
}
exports._validate = (contact, options = {}) => {
const { messageId } = options;
const { name, number, email, address, organization } = contact;
if ((!name || !name.displayName) && !organization) {
return new Error(
`Message ${messageId}: Contact had neither 'displayName' nor 'organization'`
);
}
if (
(!number || !number.length) &&
(!email || !email.length) &&
(!address || !address.length)
) {
return new Error(
`Message ${messageId}: Contact had no included numbers, email or addresses`
);
}
return null;
};
function parsePhoneItem(item, options = {}) {
const { regionCode } = options;
if (!item.value) {
return null;
}
return {
...item,
type: item.type || DEFAULT_PHONE_TYPE,
value: parsePhoneNumber(item.value, { regionCode }),
};
}
function parseEmailItem(item) {
if (!item.value) {
return null;
}
return { ...item, type: item.type || DEFAULT_EMAIL_TYPE };
}
function parseAddress(address) {
if (!address) {
return null;
}
if (
!address.street &&
!address.pobox &&
!address.neighborhood &&
!address.city &&
!address.region &&
!address.postcode &&
!address.country
) {
return null;
}
return { ...address, type: address.type || DEFAULT_ADDRESS_TYPE };
}
function parseAvatar(avatar) {
if (!avatar) {
return null;
}
return {
avatar: { ...avatar, isProfile: avatar.isProfile || false },
};
}
function createArrayKey(key, array) {
if (!array || !array.length) {
return null;
}
return {
[key]: array,
};
}

View file

@ -3,7 +3,7 @@
const { isFunction, isObject, isString, omit } = require('lodash');
const Contact = require('./contact');
const Contact = require('../../../ts/types/EmbeddedContact');
const Attachment = require('../../../ts/types/Attachment');
const Errors = require('../../../ts/types/errors');
const SchemaVersion = require('./schema_version');