Generated typescript file is not usable anymore

[sherlock1982]

protobuf.js version: 6.8.0

Here's a part of my proto file:

message RequestUpdateDocument
{
        required ActionType Action = 1;
        optional WebMeetingDocument Document = 2;
        optional string Content = 3;
        optional int32 MeetingId = 4; 
}

Here's a part of generated typescript file using pbts:

        /** Properties of a RequestUpdateDocument. */
        interface IRequestUpdateDocument {

            /** RequestUpdateDocument Action */
            Action: MyPhone.Notifications.ActionType;

            /** RequestUpdateDocument Document */
            Document?: MyPhone.Notifications.IWebMeetingDocument;

            /** RequestUpdateDocument Content */
            Content?: string;

            /** RequestUpdateDocument MeetingId */
            MeetingId?: number;
        }

        /** Represents a RequestUpdateDocument. */
        class RequestUpdateDocument {

            /**
             * Constructs a new RequestUpdateDocument.
             * @param [properties] Properties to set
             */
            constructor(properties?: MyPhone.Notifications.IRequestUpdateDocument);

            /** RequestUpdateDocument Action. */
            public Action: MyPhone.Notifications.ActionType;

            /** RequestUpdateDocument Document. */
            public Document?: (MyPhone.Notifications.IWebMeetingDocument|null);

            /** RequestUpdateDocument Content. */
            public Content: string;

            /** RequestUpdateDocument MeetingId. */
            public MeetingId: number;
        }

You see that optional fields Document, Content, MeetingId have different types which makes this classes incompatible and this unusable. Class doesn't implement interface.

Expected behavior:

Interface and class should have same propeties. Probably it even makes sense to make class implement interface.

Also I don't understand why this:

properties?: MyPhone.Notifications.IRequestUpdateDocument

If we can make

properties?: Partial<MyPhone.Notifications.RequestUpdateDocument>

[wb14123]

Hi, I'm facing this problem, too. Have you found any workaround for this?

[wb14123]

@dcodeIO I think this is very important because currently there is no easy way to get the interface from the class.

[dcodeIO]

Does this issue still exist in master? There have been a couple merges that might, or might not, prevent this. Otherwise, do you have an updated example causing the issue?

[sherlock1982]

6.8.3 still reproducable.
For example:

    interface IWebRTCCall {
        /** WebRTCCall otherPartyDisplayname */
        otherPartyDisplayname?: (string|null);
    }

    class WebRTCCall implements IWebRTCCall {

        /** WebRTCCall otherPartyDisplayname. */
        public otherPartyDisplayname: string;
    }

Actually I don't understand why these interfaces were added. They add additional noise and doesn't bring anything new to the app.

[dcodeIO]

What about 6.8.4 (the version on npm)?

Btw. the interfaces are there because messages can be plain objects as well, without any methods but just data.

[mhoeger]

@dcodeIO - are interfaces for data that's to be sent and classes for data that is being received? Is that an ok rule of thumb?

[ikokostya]

I have the same issue with [email protected] from npm.