Responding with a plain text and z.string() schema

[JoshElias]

Looks like the base type is IOSchema but is there any way to return a string?

Here's an example of me trying to handle /robots.txt with it:

const robotsResultHandler = new ResultHandler({
  positive: { statusCode: 200, mimeType: 'text/plain', schema: z.string() },
  negative: { statusCode: 404, mimeType: null, schema: z.never() },
  handler: ({ output, response }) => {
    response.set('Cache-Control', 'max-age=2592000');
    response.status(200);
    response.send(output);
  },
});

export const robotsHandler = new EndpointsFactory(robotsResultHandler)
.build({
  output: z.string(),
  handler: async () => 'User-agent: *\nDisallow: /\n\nUser-agent: Googlebot\nDisallow:\n'
});

[JoshElias]

If the answer is to use an object, should I expect the output object in the ResultHandler.handler to untyped? Right now I need to do this:

const robotsResultHandler = new ResultHandler({
  positive: (data) => ({
    schema: z.object({ data }),
    mimeType: 'text/plain',
  }),
  negative: { statusCode: 404, mimeType: null, schema: z.never() },
  handler: ({ output, response }) => {
    response.type('text/plain');
    response.set('Cache-Control', 'max-age=2592000'); // 1 month
    response.status(200);
    response.send((output as any).disallow);
  },
});

export const robotsHandler = new EndpointsFactory(robotsResultHandler).build({
  output: z.object({
    disallow: z.string(),
  }),
  handler: async () => ({
    disallow: 'User-agent: *\nDisallow: /\n\nUser-agent: Googlebot\nDisallow:\n'
  })
});

[RobinTail]

ResuiltHandler can respond anything, @JoshElias , including strings with a corresponding MIME type.

https://ez.robintail.cz/v24.7.1/non-json-response

Your implementation of ResultHandler is looking good, but it should make a string out of object-based output

const robotsResultHandler = new ResultHandler({
  positive: { statusCode: 200, mimeType: 'text/plain', schema: z.string() },
  negative: { statusCode: 404, mimeType: null, schema: z.never() },
  handler: ({ output, response }) => {
    response.set('Cache-Control', 'max-age=2592000');
    response.status(200);
    response.send(output.toString()); // somehow
  },
});

Looks like the base type is IOSchema

This type is for I/O: input and output schemas of Middlewares and Endpoints.
But response is not constrained by it.

Therefore, your Endpoint::output must be an object, but above mentioned ResultHandler can (and should in your case) make a string out of it.

✅	❌
output: z.object({ ... })	output: z.string()

response.send((output as any).disallow);

This is fine, but I suggest

if (output && "disallow" in output) response.send(output.disallow);
// else — handle it