Use my model as an array in response

[erwanlpfr]

Hi there !

First, I would like to thank you for this work, the DX is super smooth and features are covering almost everything I need !
I was wondering one thing though:

I have a model for my user data :

import Elysia, { t } from "elysia";

export const adminUserModel = t.Object(
  {
    id: t.String(),
    email: t.String(),
    createdAt: t.Date(),
    updatedAt: t.Date(),
  },
);

export const adminUsersModel = t.Array(adminUserModel);

export const adminUsersModels = new Elysia().model({
  "admin-users.user": adminUserModel,
  "admin-users.users": adminUsersModel,
});

that is used as it :

export const readUsers = new Elysia({
  detail: {
    description: "Get users list with pagination",
  },
})
  .use(paginationModels)
  .use(adminUsersModels)
  .use(
    hasPermissions([
      {
        resource: Resource.ADMIN_USERS,
        rights: {
          read: true,
        },
      },
    ]),
  )
  .get(
    "/users",
    async ({ query }) => {
      const userRepository = AppDataSource.getRepository(User);
      const users = await userRepository.find({
        take: query.limit,
        skip: (query.page - 1) * query.limit,
      });

      return users.map((user) => ({
        id: user.id,
        name: user.name,
        email: user.email,
        updatedAt: user.updated_at,
        createdAt: user.created_at,
      }));
    },
    {
      query: "pagination.pagination-params",
      response: "admin-users.users",
    },
  );

I used the "users" in plural because I need a list here.
It means, logically, that the swagger documentation will generate two models.

I did not find a way, so far, to have only "user" that is a array only for this response; to allow in fine having only one model.
It would avoid confusing an openAPI generator to have duplicated models.
Same in the answer, it "does not" point to the model , isn't it ?

If you have any answers I take it,
Thank you !

[mtt-artis]

hi 👋

i think you want something like below

import { Elysia, t } from "elysia";
import swagger from "@elysiajs/swagger";

new Elysia()
  .use(swagger())
  .model({ a: t.String({ $id: "a" }) })
  .get("/a", () => "a", { type: "json", response: "a" })
  .get("/as", () => ["a", "a", "a"], { type: "json", response: t.Array(t.Ref("a")) })
  .listen(3000, ({ hostname, port }) => {
    console.log(`🦊 Elysia is running at ${hostname}:${port}`);
  });

setInterval(async () => {
  const l = await Promise.all([
    fetch("http://localhost:3000/a").then(r => r.text()),
    fetch("http://localhost:3000/as").then(r => r.text()),
    fetch("http://localhost:3000/swagger/json").then(r => r.text()),
  ]);

  console.log(l.join("\n"))
}, 3000)

[erwanlpfr]

Thank you for your answer,
but it does not look like to work

import Elysia, { t } from "elysia";

export const adminUserModel = t.Object(
  {
    id: t.String({
      format: "uuid",
    }),
    email: t.String(),
    createdAt: t.Date(),
    updatedAt: t.Date(),
  },
  {
    $id: "admin-users.user",
  },
);

export const adminUsersModels = new Elysia().model({
  "admin-users.user": adminUserModel,
});

export const readUsers = new Elysia({
  detail: {
    description: "Get users list with pagination",
  },
})
  .use(paginationModels)
  .use(adminUsersModels)
  .get(
    "/users",
    async ({ query }) => {
      const users = await userService.getUsers(query);

      return users.map((user) => ({
        id: user.id,
        name: user.name,
        email: user.email,
        updatedAt: user.updated_at,
        createdAt: user.created_at,
      }));
    },
    {
      query: "pagination.pagination-params",
      response: t.Array(t.Ref("admin-users.user")),
    },
  );

After that, the autocompletion does not work in the map and also, once in swagger :

That's true in this way, the duplicated models are not shown. But it lost the autocompletion and the swagger type.
Am I doing something wrong ?

Thank you for your help !

[mtt-artis]

you're right,

• you need to passe the type in the t.Ref<X>method
• for the swagger, i 'm not very happy with it but it seems to work
  i found this issue on github Unable to use local $ref components elysia-swagger#93

// filename adminUserModels.ts

import Elysia, { t } from "elysia";

const adminUserModel = t.Object(
    {
        id: t.String({
            format: "uuid",
        }),
        email: t.String(),
        createdAt: t.Date(),
        updatedAt: t.Date(),
    },
    {
        $id: "#/components/schemas/admin-users.user",
    },
);

export const adminUsersModels = new Elysia().model({
    "admin-users.user": adminUserModel,
    "admin-users.users": t.Array(
        t.Ref<typeof adminUserModel>("#/components/schemas/admin-users.user"),
    )   
});

import Elysia from "elysia";
import { adminUsersModels } from "./adminUserModels";
import swagger from "@elysiajs/swagger";

export const readUsers = new Elysia()
    .use(swagger())
    .use(adminUsersModels)
    .get("/user", () => ({
        id: "123e4567-e89b-12d3-a456-426614174000",
        email: "[email protected]",
        createdAt: new Date("2023-01-01T10:00:00Z"),
        updatedAt: new Date("2023-06-01T15:30:00Z"),
    }), {
        type: "json",
        response: "admin-users.user",
    })
    .get(
        "/users",
        () => [{
            id: "123e4567-e89b-12d3-a456-426614174000",
            email: "[email protected]",
            createdAt: new Date("2023-01-01T10:00:00Z"),
            updatedAt: new Date("2023-06-01T15:30:00Z"),
        }],
        {
            type: "json",
            response: "admin-users.users",
        },
    ).listen(3000, async ({ hostname, port }) => {
        console.log(`🦊 Elysia is running at ${hostname}:${port}`);

        const l = await Promise.all([
            fetch("http://localhost:3000/users").then(r => r.text()),
            fetch("http://localhost:3000/swagger/json").then(r => r.text()),
        ]);

        console.log(l.join("\n"))
    });

[erwanlpfr]

Thanks !

// filename adminUserModels.ts

import Elysia, { t } from "elysia";

export const adminUserModel = t.Object(
  {
    id: t.String({
      format: "uuid",
    }),
    email: t.String(),
    createdAt: t.Date(),
    updatedAt: t.Date(),
  },
  {
    $id: "#/components/schemas/admin-users.user",
  },
);

/**
 * Type as an array of admin-users.user
 * @see https://github.com/elysiajs/elysia/discussions/921
 */
export const adminUsersModel = t.Array(
  t.Ref<typeof adminUserModel>("#/components/schemas/admin-users.user"),
);

export const adminUsersModels = new Elysia().model({
  "admin-users.user": adminUserModel,
  "admin-users.users": adminUsersModel,
});

export const readUsers = new Elysia({
  detail: {
    description: "Get users list with pagination",
  },
})
  .use(paginationModels)
  .use(adminUsersModels)
  .get(
    "/users",
    async ({ query }) => {
      const users = await userService.getUsers(query);

      return users.map((user) => ({
        id: user.id,
        name: user.name,
        email: user.email,
        updatedAt: user.updated_at,
        createdAt: user.created_at,
      }));
    },
    {
      query: "pagination.pagination-params",
      response: "admin-users.users",
    },
  );

At this point, I get this in the scalar UI.

I don't know if it comes from ScalarUI, but It looks like it does not display the "reference".
But I tried with a simple TS fetch generator and it looks to work pretty well !

Thanks for your time, do you think a PR to improve the doc is welcomed ? I can try it out !

[mtt-artis]

do you think a PR to improve the doc is welcomed ?

I agree this needs to be documented. But I hope the core team finds a better DX/solution.

Your PR might start the reflection 😉