fix: add missing properties to ExportChannelStatusResponse

[rchl]

CLA

• I have signed the Stream CLA (required).
• Code changes are tested

Description of the changes, What, Why and How?

Those properties were missing in the type returned from getExportChannelStatus API.

Some references:

• Node.js API - https://getstream.io/chat/docs/node/exporting_channels/?language=javascript#requesting-a-channel-export
• REST API - https://getstream.io/chat/docs/rest/#channels-getexportchannelsstatus

Unfortunately there is no documentation as to what exact values the status can have so it's just typed as string.

The error and result objects could also have better types but apart from REST documentation having some info on those, it's not 100% clear on which properties are optional.

EDIT: Added types for result also, making best effort with available information.

Changelog

• fix: add missing properties to ExportChannelStatusResponse

[rchl]

Also created ExportChannelsResult type to improve slightly more.

[santhoshvai]

result should use ExportChannelsResult

and error should use ErrorResult

where ErrorResult is

type?: string;
description?: string;
stacktrace?: string;
version?: string;

[rchl]

Thanks. That was embarrassing :)

Applied your suggestion with the difference that I've called the error type ExportChannelError since I thought ErrorResult would be too generic. Can change if you actually want it to be that generic.

[santhoshvai]

Thanks, also I think null is unnecessary here . ExportChannelError sounds good to me 👍

[santhoshvai]

and we would need to make it

 status?: string;
 task_id?: string;

[rchl]

and we would need to make it

 status?: string;
 task_id?: string;

Don't fully understand. Add those to the ExportChannelError or change required to optional in ExportChannelStatusResponse?

[rchl]

I could see the null value when testing exporting locally.

[rchl]

Status {
  task_id: 'c1e57bb1-04f1-4284-af61-455c3990b631',
  status: 'waiting',
  created_at: '2023-11-30T12:42:46.266232Z',
  updated_at: '2023-11-30T12:42:46.266232Z',
  duration: '16.19ms',
  result: null
}
Status {
  task_id: 'c1e57bb1-04f1-4284-af61-455c3990b631',
  status: 'pending',
  created_at: '2023-11-30T12:42:46.266232Z',
  updated_at: '2023-11-30T12:42:46.501436Z',
  duration: '3.45ms',
  result: null
}
Status {
  task_id: 'c1e57bb1-04f1-4284-af61-455c3990b631',
  status: 'completed',
  created_at: '2023-11-30T12:42:46.266232Z',
  updated_at: '2023-11-30T12:42:46.689775Z',
  duration: '2.00ms',
  result: {
    url: 'https://...'
  }
}

[rchl]

I've added duration though since it was missing.
I don't know how to get ExportChannelError but I've added there too as I'm assuming it would also be present.

[rchl]

BTW. I wonder what makes you think that task_id and status are optional. Did you verify internally that it can be the case that those are missing? I would think that the response would be pretty useless without those.

[rchl]

We're closing on a year here.
If you don't care then I can just close it.