input to separate components

[pepegc]

I find myself in need of distinguishing input in my handlers. Right now everything gets flattened there.

Ideally input would have a query with the query params, params with the url params, headers, etc...

export const myResolver = defaultEndpointsFactory.addMiddleware(myMiddleware).build({
  method: 'get',
  input: z.object({
    query: z.object({
      foo: z.string().optional(),
      bar: z.string().optional(),
    }),
    params: z.object({
      id: z.string()
    })
  }),
  output: z.object(...),
  handler: async ({ input }) => {
    const { query, params, headers, body } = input; // IDEAL !
    const { id } = params; // IDEAL!
    const { foo, bar } = query; // IDEAL!

    // ...
});

Alternatively, drop the input altogether and put these new things on the top level:

export const myResolver = defaultEndpointsFactory.addMiddleware(myMiddleware).build({
  method: 'get',
  query: z.object({
    foo: z.string().optional(),
    bar: z.string().optional(),
  }),
  params: z.object({
    id: z.string()
  }),
  output: z.object(...),
  handler: async ({ params, query }) => {
    const { id } = params; // IDEAL!
    const { foo, bar } = query; // IDEAL!

    // ...
});

My current workaround:

const zParams = z.object({
  id: z.string(),
})

const zQuery = z.object({
  foo: z.string().optional(),
  bar: z.string().optional(),
})

export const myResolver = defaultEndpointsFactory.addMiddleware(myMiddleware).build({
  method: 'get',
  input: zQuery.merge(zParams), // add more as needed, order matters
  output: z.object(...),
  handler: async ({ input }) => {
    const { id } = zParams.strip().parse(input);
    const { foo, bar } = zQuery.strip().parse(input);

    // ...
});

[RobinTail]

I find myself in need of distinguishing input in my handlers.

Please explain why, @pepegc

[ruankotovich]

How do you manage to pick two attributes with same name in input @pepegc ?

for instance:

[POST] localhost:8080/?brand=test
BODY:

{
    "brand": "test2"
}

[RobinTail]

1. If you're doing POST you have the whole body to place everything, no need for query params
2. equally named inputs would be overwritten in order of the priority configured by inputSources

[ruankotovich]

Got it! Makes a lot of sense, I am starting now using this framework and I am in love 😆

Thank you @RobinTail!

[ruankotovich]

Is there a way to change the priority of inputs from a specific routing?

[RobinTail]

No, @ruankotovich ,inputSources is the configuration option on the server level.

[RobinTail]

@pepegc

Pass down input as elements of a where clause in Prisma (Postgres ORM). Prisma dies if it receives unexpected fields. In this case I'd want to just pass down all the query args.

const { foo, bar, ...whatPrismaDoesNotExpect } = input;

A pagination utility function that takes in the existing query args and builds a "next page url" and "previous page url" with the same query args. Currently I cannot just pass input there because a bunch of extra things get put as query args in these urls.

const makePagination = ({page, total, ...rest}: {
  page: number;
  total: number;
  [X: string]: unknown;
}) => ({
  nextPageUrl: new URLSearchParams({ page: Math.min(page + 1, total), ...rest }).toString(),
  prevPageUrl: new URLSearchParams({ page: Math.max(page - 1, 1), ...rest }).toString(),
});