hyperweb-io/ts-codegen

[Question] adding undefined for message types

Opened this issue · 1 comments

I have an enum:

pub enum MintStatus {
    Pending{},
    Success{token_id: String},
    Error{message: String},
}

This enum is a response to a query in my contract, when I use ts-codegen, it parses it to this:

export type MintStatus = {
  pending: {};
} | {
  success: {
    token_id: string;
  };
} | {
  error: {
    message: string;
  };
};

To me it feels wrong, because this forces me to cast my MintStatus type into any, in order to do something like this:

let mintStatus = query() as any;
if(mintStatus.success) {
  let tokenId = mintStatus.success.token_id;
}

I would suggest to change the parsing into something like this:

export type MintStatus = {
 pending: {} | undefined;
 success: {
   token_id: string;
 } | undefined;
 error: {
   message: string;
 } | undefined;
};

This change will allow me to avoid the any cast, and allow me to get TS work correctly for this type.
Right now it doesn't give me any auto completion and complains when I do not cast to any.

I understand why you'd want to make undefined allowed, but then in this case, the MintStatus could be constructed as not proper. I think doing any to construct dynamically is probably the best in terms of data integrity in this case.

Curious about other thoughts and opinions, but I think allowing undefined is probably also not an ideal solution.