Messaging interface BaseMessage is no longer exported

[rubenvereecken]

I just upgraded to 7.5.0coming from 7.2.1. I just noticed I could no longer import the BaseMessage interface, which I use because I've got some functionality that is independent of the exact type of Message. It looks like the interface is no longer exported. Is this on purpose? I had a look at where this was taken out but I struggled navigating the git blame on Github.

firebase-admin-node/src/messaging/index.ts

Line 52 in 01d8177

interface BaseMessage {

[google-oss-bot]

I found a few problems with this issue:

• I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
• This issue does not seem to follow the issue template. Make sure you provide all the required information.

[lahirumaramba]

Hi @rubenvereecken! Thank you for reporting this issue.

@hiranya911 should we export BaseMessage along with the rest we did in #1147 ?

[hiranya911]

BaseMessage was never intended to be part of our public API surface. In the old releases it was declared outside of the admin.messaging namespace to keep it separate from the public API:

firebase-admin-node/src/index.d.ts

Lines 392 to 398 in d0ccf8f

	type BaseMessage = {
	data?: {[key: string]: string};
	notification?: admin.messaging.Notification;
	android?: admin.messaging.AndroidConfig;
	webpush?: admin.messaging.WebpushConfig;
	apns?: admin.messaging.ApnsConfig;
	};

In more recent versions it is in the namespace, but is not exported:

firebase-admin-node/src/messaging/index.ts

Lines 52 to 59 in 6bcffa2

	interface BaseMessage {
	data?: { [key: string]: string };
	notification?: Notification;
	android?: AndroidConfig;
	webpush?: WebpushConfig;
	apns?: ApnsConfig;
	fcmOptions?: FcmOptions;
	}

@rubenvereecken can you use the Message type for your use case? Most things that that can be assigned to BaseMessage can be assigned to Message.

Also, can you please verify your SDK versions? We have never released a 7.2.1 or a 7.5.0.

[rubenvereecken]

... I think I meant 9.2.1 and 9.5.0 as I seem to have 9.5.0 installed currently.

My current solution to get this working consists of using TokenMessage | MulticastMessage, pretty close to using Message which I noticed is a union type. The problem is that TokenMessage for example requires the token field, which I currently simply set to null until it gets populated later, if indeed it does. I used to use BaseMessage because I've got some generic functionality that fills in a bunch of basic fields. Only afterwards does the object become a TokenMessage or MulticastMessage, depending on what I need. Maybe this is unorthodox use of typing because I "upgrade" an object from one type to another.

[hiranya911]

You can probably do something like this:

type MyBaseMessage = Partial<TokenMessage | MulticastMessage>

function addCommonFields(m: MyBaseMessage) {
  
}

const m = { };
addCommonFields(m);

const tm: TokenMessage = {...m, token: 'token'};
const mm: MulticastMessage = {...m, tokens: ['token']};

[rubenvereecken]

Actually, that's right, I'm very happy with that solution. Thanks @hiranya911!

Happy to close it here.

[hiranya911]

Glad to hear that @rubenvereecken. We can also revisit the issue of exposing BaseMessage once our new modular API surface (on going effort), is a bit more fleshed out.