EmilePerron
commented
1 year ago As it turns out this is not only related to errors, but successful responses as well.
Using a similar schema (posted below), the following code breaks with the same error as mentioned above:
const client = createClient<paths>({ baseUrl: apiBaseUrl, headers: { ...baseHeaders, Authorization: `Bearer ${jwt}` } });
const response = await client.get("/rtm/{userId}/notes", { params: { path: { userId: user.id } } });
if (!response.error) {
console.log(response.data["hydra:member"]);
}Relevant bit of the schema:
'/rtm/{userId}/notes':
get:
operationId: api_rtm_userIdnotes_get_collection
tags:
- RTM
responses:
200:
description: 'GetUserNotesWithNames collection'
content:
application/ld+json:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/GetUserNotesWithNames.jsonld' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: string, nullable: true }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GetUserNotesWithNames'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/GetUserNotesWithNames'
401:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
code: { readOnly: true, type: string, nullable: false }
message: { readOnly: true, type: string, nullable: false }
required:
- '@context'
- '@type'
- 'hydra:title'
- 'hydra:description'
application/ld+json:
schema:
type: object
properties:
'@context': { readOnly: true, type: string, nullable: false }
'@type': { readOnly: true, type: string, nullable: false }
'hydra:title': { readOnly: true, type: string, nullable: false }
'hydra:description': { readOnly: true, type: string, nullable: false }
required:
- '@context'
- '@type'
- 'hydra:title'
- 'hydra:description'
summary: 'Get all notes for a user.'
description: 'Get all notes for a user.'
parameters:
-
name: userId
in: path
description: 'User identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
deprecated: false
parameters: []Relevant types generated by the lib:
/**
* Get all notes for a user.
* @description Get all notes for a user.
*/
api_rtm_userIdnotes_get_collection: {
parameters: {
path: {
/** @description User identifier */
userId: string;
};
};
responses: {
/** @description GetUserNotesWithNames collection */
200: {
content: {
"application/ld+json": {
"hydra:member": (components["schemas"]["GetUserNotesWithNames.jsonld"])[];
"hydra:totalItems"?: number;
/**
* @example {
* "@id": "string",
* "type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:previous": "string",
* "hydra:next": "string"
* }
*/
"hydra:view"?: {
/** Format: iri-reference */
"@id"?: string;
"@type"?: string;
/** Format: iri-reference */
"hydra:first"?: string;
/** Format: iri-reference */
"hydra:last"?: string;
/** Format: iri-reference */
"hydra:previous"?: string;
/** Format: iri-reference */
"hydra:next"?: string;
};
"hydra:search"?: {
"@type"?: string;
"hydra:template"?: string;
"hydra:variableRepresentation"?: string;
"hydra:mapping"?: ({
"@type"?: string;
variable?: string;
property?: string | null;
required?: boolean;
})[];
};
};
"application/json": (components["schemas"]["GetUserNotesWithNames"])[];
"text/html": (components["schemas"]["GetUserNotesWithNames"])[];
};
};
/** @description Unauthorized */
401: {
content: {
"application/json": {
code?: string;
message?: string;
};
"application/ld+json": {
"@context": string;
"@type": string;
"hydra:title": string;
"hydra:description": string;
};
};
};
};
};The error message:
Element implicitly has an 'any' type because expression of type '"hydra:member"' can't be used to index type 'NonNullable<FilterKeys<{ "application/ld+json": { "hydra:member": { "@id"?: string | undefined; "@type"?: string | undefined; id?: string | undefined; note?: string | undefined; isCall?: boolean | undefined; timeSpent?: number | undefined; createdAt?: string | undefined; userFirstName?: string | undefined; userLastN...'.
Property 'hydra:member' does not exist on type 'NonNullable<FilterKeys<{ "application/ld+json": { "hydra:member": { "@id"?: string | undefined; "@type"?: string | undefined; id?: string | undefined; note?: string | undefined; isCall?: boolean | undefined; timeSpent?: number | undefined; createdAt?: string | undefined; userFirstName?: string | undefined; userLastN...'.ts(7053)At this point I'm just about convinced I'm either doing something wrong, or multiple Accept types simply aren't supported.
Any clues as to what is happening here? And what could be done to fix it (either in the lib or in my use of it)?
Thanks :)
drwpow
NikolaStojicic
simon511000
armandabric
Description
When making an API call using the library, using fairly simple code like below, the error object does not allow access to any of the keys that are supposed to be available.
Ex.:
Gives the following error when using
response.error["hydra:description"](or any other key/property on the error):Here is the Typescript error in VS Code:
My OpenAPI schema for the responses is the following:
Perhaps it's related to #1128, but my understanding of it is that it would default the
error's type to the400's format - not cause the error above. Do let me know if I'm wrong about this!Reproduction
This is a typescript error, and so I expect reproducing the code above using the provided API responses schema would trigger the same error.
Expected result
Until #1128 is resolved, my expected result would've been that
errorbe typed as the schema/type for400, and that its properties could be accessed without any errors.Checklist
(I don't expect that'll be necessary as I feel I might just be doing something wrong, but if it's something I can fix in a PR, I'd be happy to!)
Thanks in advance! :)