Wrong type for M2M relations?

[linaGirl]

Thanks for the great extension!

Looks like there is a problem with M2M relations when creating types for TypeScript:

Database

CREATE TABLE "scene" (
    `id` integer PRIMARY KEY AUTOINCREMENT NOT NULL
  , `name` varchar(255) NOT NULL
)

CREATE TABLE "audioScene" (
    `id` integer PRIMARY KEY AUTOINCREMENT NOT NULL
  , `name` varchar(255) NOT NULL 
)

CREATE TABLE "scene_audioScene" (
    `id` integer PRIMARY KEY AUTOINCREMENT NOT NULL, 
   ,`scene` integer NOT NULL
   ,`audioScene` integer NOT NULL
   ,CONSTRAINT `scene_audioscene_scene_foreign` FOREIGN KEY (`scene`) REFERENCES `scene` (`id`) 
   ,CONSTRAINT `scene_audioscene_audioscene_foreign` FOREIGN KEY (`audioScene`) REFERENCES `audioScene` (`id`)
)

Generated Types

export type AudioScene = {
  id: number;
  name: string;
  scene: string & SceneAudioScene[];
};

export type Scene = {
  audioScene: string & SceneAudioScene[];
  id: number;
  name: string;
};

export type SceneAudioScene = {
  audioScene: number & AudioScene;
  id: number;
  scene: number & Scene;
};

Why does the scene M2M reference scene on the Type AudioScene have the type string & SceneAudioScene[]; Seems to be that it never will be a string. Same for the reference audioScene on the type Scene.

[maltejur]

Oh you are right. The type returned by the directus API doesn't seem to match the type used by the SDK in this case. Since we still have to cover the case that the Directus SDK just returns the item IDs instead of the actual relational items, would any[] be a good alternative? So for example:

export type Scene = {
  audioScene: any[] & SceneAudioScene[];

[maltejur]

On a second look the Directus API doesn't even return something wrong, I just use "string" as the default type if no other one is given.

[linaGirl]

Since the SDK returns an empty array if there are no relations or nothing if the relation is not requested audioScene?: SceneAudioScene[]; could be fine?

[maltejur]

The problem is that sometimes the list just contains the foreign ids of the relational fields, and those are pretty complicated to find out. This is why I would suggest using any[] as the type there. See this example:

[linaGirl]

Ok, i see. Your suggestion seems to be the correct one!

audioScene?: any[] & SceneAudioScene[];

[maltejur]

Fixed in eb83e90