Query ResultSet.asMappedResults() isn't useable

[bbahrman]

When running a query and getting ResultSet.asMappedResults(), a QueryResultMap is returned. While factually accurate, the QueryResultMap isn't useable since if you assign it to another type/interface there's no overlap.

For example, this
const folderLookup: { id: number }[] = query.runSuiteQL({ query:SELECT id from MediaItemFolder WHERE parent = 1522749 AND name = '${folderName}'}).asMappedResults();
Will throw an error:

TS2322: Type  QueryResultMap[]  is not assignable to type  { id: number; }[] Property  id  is missing in type  QueryResultMap  but required in type  { id: number; }

The solution that I've used for a while has been to convert to any and then to the type I want
const folderLookup: { id: number }[] = query.runSuiteQL({ query:SELECT id from MediaItemFolder WHERE parent = 1522749 AND name = '${folderName}'}).asMappedResults() as any;
But doing so means that you are now using any which fails standard linting and is an extra step to write every time which can lead to errors.

[bbahrman]

I've created #308 as a proposed fix

[lyatziv]

I've had some success defining a type and casting the type using as

type someCoolType = query.QueryResultMap & { ... }
// then
const queryResults.asMappedResults() as someCoolType[]; 

[darrenhillconsulting]

Really, what it should be is something like this ...

type LowercaseKeys<T> = {
    [K in keyof T as Lowercase<K & string>]: T[K];
};

asMappedResults<T extends LowercaseKeys<T>>(): LowercaseKeys<T>[];

This will save developers from wondering why all the camelcase properties they expect to be returned from SuiteQL are suddenly converted to lowercase

[lyatziv]

☝️ That's a good point. I would then point out the convention with SQL is it use snake_case for columns so that can be avoided.

[bbahrman]

Thanks @darrenhillconsulting for the idea and example. I added it in and have updated my pull request.

@lyatziv - agreed, I like the validation of the interface for things that will break and then assume most people are using snake_case as the solution to that.

[moosey-moose]

I usually make an interface representing the returned columns as to not attempt to access something that is not there, then types can be specified for each column. I agree with darren though, it would be more intuitive.