Ref: plural props

README.md

@@ -178,7 +178,7 @@ The endpoint responds with "Hello, World" or "Hello, {name}" if the name is supp
 import { z } from "zod";
 
 const helloWorldEndpoint = defaultEndpointsFactory.build({
-  method: "get", // or methods: ["get", "post", ...]
+  methods: "get", // or array: ["get", "post", ...]
   input: z.object({
     // for empty input use z.object({})
     name: z.string().optional(),
@@ -380,7 +380,7 @@ arrays of numbers.
 import { z } from "zod";
 
 const getUserEndpoint = endpointsFactory.build({
-  method: "get",
+  methods: "get",
   input: z.object({
     id: z.string().transform((id) => parseInt(id, 10)),
     ids: z
@@ -429,7 +429,7 @@ import { z } from "zod";
 import { ez, defaultEndpointsFactory } from "express-zod-api";
 
 const updateUserEndpoint = defaultEndpointsFactory.build({
-  method: "post",
+  methods: "post",
   input: z.object({
     userId: z.string(),
     birthday: ez.dateIn(), // string -> Date
@@ -614,7 +614,7 @@ You then need to specify these parameters in the endpoint input schema in the us
 
 ```typescript
 const getUserEndpoint = endpointsFactory.build({
-  method: "get",
+  methods: "get",
   input: z.object({
     // id is the route path param, always string
     id: z.string().transform((value) => parseInt(value, 10)),
@@ -689,7 +689,7 @@ import {
 export const yourResultHandler = createResultHandler({
   getPositiveResponse: (output: IOSchema) => ({
     schema: z.object({ data: output }),
-    mimeType: "application/json", // optinal, or mimeTypes for array
+    mimeTypes: "application/json", // optinal, or array
   }),
   getNegativeResponse: () => z.object({ error: z.string() }),
   handler: ({ error, input, output, request, response, logger }) => {
@@ -734,9 +734,12 @@ const fileStreamingEndpointsFactory = new EndpointsFactory(
   createResultHandler({
     getPositiveResponse: () => ({
       schema: ez.file("buffer"),
-      mimeType: "image/*",
+      mimeTypes: "image/*",
+    }),
+    getNegativeResponse: () => ({
+      schema: z.string(),
+      mimeTypes: "text/plain",
     }),
-    getNegativeResponse: () => ({ schema: z.string(), mimeType: "text/plain" }),
     handler: ({ response, error, output }) => {
       if (error) {
         response.status(400).send(error.message);
@@ -779,7 +782,7 @@ import { z } from "zod";
 import { ez, defaultEndpointsFactory } from "express-zod-api";
 
 const fileUploadEndpoint = defaultEndpointsFactory.build({
-  method: "post",
+  methods: "post",
   input: z.object({
     avatar: ez.upload(), // <--
   }),
@@ -860,7 +863,7 @@ createResultHandler({
   }),
   getNegativeResponse: () => [
     {
-      statusCode: 409, // conflict: entity already exists
+      statusCodes: 409, // conflict: entity already exists
       schema: z.object({ status: z.literal("exists"), id: z.number().int() }),
     },
     {
@@ -903,7 +906,7 @@ createConfig({
 });
 
 defaultEndpointsFactory.build({
-  method: "get",
+  methods: "get",
   input: z.object({
     "x-request-id": z.string(), // this one is from request.headers
     id: z.string(), // this one is from request.query
@@ -930,7 +933,7 @@ const config = createConfig({
 });
 
 const rawAcceptingEndpoint = defaultEndpointsFactory.build({
-  method: "post",
+  methods: "post",
   input: ez
     .raw() // accepts the featured { raw: Buffer }
     .extend({}), // for additional inputs, like route params, if needed
@@ -1060,7 +1063,7 @@ const taggedEndpointsFactory = new EndpointsFactory({
 
 const exampleEndpoint = taggedEndpointsFactory.build({
   // ...
-  tag: "users", // or tags: ["users", "files"]
+  tags: "users", // or array: ["users", "files"]
 });
 ```
 

example/endpoints/accept-raw.ts

@@ -3,8 +3,8 @@ import { ez } from "../../src";
 import { taggedEndpointsFactory } from "../factories";
 
 export const rawAcceptingEndpoint = taggedEndpointsFactory.build({
-  method: "post",
-  tag: "files",
+  methods: "post",
+  tags: "files",
   input: ez
     .raw() // requires to enable rawParser option in server config
     .extend({}), // additional inputs, route params for example, if needed

example/endpoints/create-user.ts

@@ -5,8 +5,8 @@ import { statusDependingFactory } from "../factories";
 
 /** @desc depending on the thrown error, the custom result handler of the factory responds slightly differently */
 export const createUserEndpoint = statusDependingFactory.build({
-  method: "post",
-  tag: "users",
+  methods: "post",
+  tags: "users",
   input: z.object({
     name: z.string().min(1),
   }),

example/endpoints/list-users.ts

@@ -7,8 +7,8 @@ import { arrayRespondingFactory } from "../factories";
  * Avoid doing this in new projects. This feature is only for easier migration of legacy APIs.
  * */
 export const listUsersEndpoint = arrayRespondingFactory.build({
-  method: "get",
-  tag: "users",
+  methods: "get",
+  tags: "users",
   input: z.object({}),
   output: withMeta(
     z.object({

example/endpoints/retrieve-user.ts

@@ -18,8 +18,8 @@ const feature: z.ZodType<Feature> = baseFeature.extend({
 export const retrieveUserEndpoint = taggedEndpointsFactory
   .addMiddleware(methodProviderMiddleware)
   .build({
-    method: "get",
-    tag: "users",
+    methods: "get",
+    tags: "users",
     shortDescription: "Retrieves the user.",
     description: "Example user retrieval endpoint.",
     input: z.object({

example/endpoints/send-avatar.ts

@@ -3,7 +3,7 @@ import { fileSendingEndpointsFactory } from "../factories";
 import { readFile } from "node:fs/promises";
 
 export const sendAvatarEndpoint = fileSendingEndpointsFactory.build({
-  method: "get",
+  methods: "get",
   shortDescription: "Sends a file content.",
   tags: ["files", "users"],
   input: z.object({

example/endpoints/stream-avatar.ts

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { fileStreamingEndpointsFactory } from "../factories";
 
 export const streamAvatarEndpoint = fileStreamingEndpointsFactory.build({
-  method: "get",
+  methods: "get",
   shortDescription: "Streams a file content.",
   tags: ["users", "files"],
   input: z.object({

example/endpoints/update-user.ts

@@ -6,8 +6,8 @@ import { keyAndTokenAuthenticatedEndpointsFactory } from "../factories";
 
 export const updateUserEndpoint =
   keyAndTokenAuthenticatedEndpointsFactory.build({
-    method: "patch",
-    tag: "users",
+    methods: "patch",
+    tags: "users",
     description: "Changes the user record. Example user update endpoint.",
     input: withMeta(
       z.object({

example/endpoints/upload-avatar.ts

@@ -4,8 +4,8 @@ import { createHash } from "node:crypto";
 import { taggedEndpointsFactory } from "../factories";
 
 export const uploadAvatarEndpoint = taggedEndpointsFactory.build({
-  method: "post",
-  tag: "files",
+  methods: "post",
+  tags: "files",
   description: "Handles a file upload.",
   input: z
     .object({

example/factories.ts

@@ -27,11 +27,11 @@ export const fileSendingEndpointsFactory = new EndpointsFactory({
   resultHandler: createResultHandler({
     getPositiveResponse: () => ({
       schema: z.string(),
-      mimeType: "image/svg+xml",
+      mimeTypes: "image/svg+xml",
     }),
     getNegativeResponse: () => ({
       schema: z.string(),
-      mimeType: "text/plain",
+      mimeTypes: "text/plain",
     }),
     handler: ({ response, error, output }) => {
       if (error) {
@@ -53,11 +53,11 @@ export const fileStreamingEndpointsFactory = new EndpointsFactory({
   resultHandler: createResultHandler({
     getPositiveResponse: () => ({
       schema: ez.file("buffer"),
-      mimeType: "image/*",
+      mimeTypes: "image/*",
     }),
     getNegativeResponse: () => ({
       schema: z.string(),
-      mimeType: "text/plain",
+      mimeTypes: "text/plain",
     }),
     handler: ({ response, error, output }) => {
       if (error) {
@@ -97,7 +97,7 @@ export const statusDependingFactory = new EndpointsFactory({
     }),
     getNegativeResponse: () => [
       {
-        statusCode: 409,
+        statusCodes: 409,
         schema: z.object({ status: z.literal("exists"), id: z.number().int() }),
       },
       {

src/api-response.ts

@@ -8,28 +8,23 @@ export const defaultStatusCodes = {
 export interface ApiResponse<S extends z.ZodTypeAny> {
   schema: S;
   /**
-   * @default 200 for a positive response
-   * @default 400 for a negative response
-   * @override statusCodes
+   * @default 200 for positive response
+   * @default 400 for negative response
    * */
-  statusCode?: number;
-  /**
-   * @default [200] for positive response
-   * @default [400] for negative response
-   * */
-  statusCodes?: [number, ...number[]];
-  /**
-   * @default "application/json"
-   * @override mimeTypes
-   * */
-  mimeType?: string;
-  /** @default [ "application/json" ] */
-  mimeTypes?: [string, ...string[]];
+  statusCodes?: number | [number, ...number[]];
+  /** @default "application/json" */
+  mimeTypes?: string | [string, ...string[]];
+  /** @deprecated use statusCodes instead */
+  statusCode?: never;
+  /** @deprecated use mimeTypes instead */
+  mimeType?: never;
 }
 
-export type NormalizedResponse = Required<
-  Pick<ApiResponse<z.ZodTypeAny>, "schema" | "statusCodes" | "mimeTypes">
->;
+export interface NormalizedResponse {
+  schema: z.ZodTypeAny;
+  statusCodes: [number, ...number[]];
+  mimeTypes: [string, ...string[]];
+}
 
 export type AnyResponseDefinition =
   | z.ZodTypeAny // plain schema, default status codes applied
@@ -44,12 +39,16 @@ export const normalizeApiResponse = (
     return [{ ...fallback, schema: subject }];
   }
   return (Array.isArray(subject) ? subject : [subject]).map(
-    ({ schema, statusCodes, statusCode, mimeTypes, mimeType }) => ({
+    ({ schema, statusCodes, mimeTypes }) => ({
       schema,
-      statusCodes: statusCode
-        ? [statusCode]
-        : statusCodes || fallback.statusCodes,
-      mimeTypes: mimeType ? [mimeType] : mimeTypes || fallback.mimeTypes,
+      statusCodes:
+        typeof statusCodes === "number"
+          ? [statusCodes]
+          : statusCodes || fallback.statusCodes,
+      mimeTypes:
+        typeof mimeTypes === "string"
+          ? [mimeTypes]
+          : mimeTypes || fallback.mimeTypes,
     }),
   );
 };

src/endpoints-factory.ts

@@ -36,9 +36,10 @@ type BuildProps<
   description?: string;
   shortDescription?: string;
   operationId?: string | ((method: Method) => string);
-} & ({ method: Method } | { methods: Method[] }) &
-  ({ scopes?: SCO[] } | { scope?: SCO }) &
-  ({ tags?: TAG[] } | { tag?: TAG });
+  methods: Method | Method[];
+  scopes?: SCO | SCO[];
+  tags?: TAG | TAG[];
+};
 
 export class EndpointsFactory<
   IN extends IOSchema<"strip"> | null = null,
@@ -145,7 +146,9 @@ export class EndpointsFactory<
     description,
     shortDescription,
     operationId,
-    ...rest
+    methods,
+    scopes,
+    tags,
   }: BuildProps<BIN, BOUT, IN, OUT, SCO, TAG>): Endpoint<
     ProbableIntersection<IN, BIN>,
     BOUT,
@@ -154,25 +157,16 @@ export class EndpointsFactory<
     TAG
   > {
     const { middlewares, resultHandler } = this;
-    const methods = "methods" in rest ? rest.methods : [rest.method];
     const getOperationId =
       typeof operationId === "function" ? operationId : () => operationId;
-    const scopes =
-      "scopes" in rest
-        ? rest.scopes
-        : "scope" in rest && rest.scope
-          ? [rest.scope]
-          : [];
-    const tags =
-      "tags" in rest ? rest.tags : "tag" in rest && rest.tag ? [rest.tag] : [];
     return new Endpoint({
       handler,
       middlewares,
       outputSchema,
       resultHandler,
-      scopes,
-      tags,
-      methods,
+      scopes: typeof scopes === "string" ? [scopes] : scopes || [],
+      tags: typeof tags === "string" ? [tags] : tags || [],
+      methods: typeof methods === "string" ? [methods] : methods,
       getOperationId,
       description,
       shortDescription,

tests/system/system.spec.ts

@@ -28,7 +28,7 @@ describe("App", async () => {
           },
         )
         .build({
-          method: "get",
+          methods: "get",
           input: z.object({}),
           output: z.object({ corsDone: z.boolean() }),
           handler: async ({ options }) => ({
@@ -59,7 +59,7 @@ describe("App", async () => {
           }),
         )
         .build({
-          method: "get",
+          methods: "get",
           input: z.object({
             epError: z
               .any()

tests/unit/depends-on-method.spec.ts

@@ -16,7 +16,7 @@ describe("DependsOnMethod", () => {
   test("should accept an endpoint with a corresponding method", () => {
     const instance = new DependsOnMethod({
       post: new EndpointsFactory(defaultResultHandler).build({
-        method: "post",
+        methods: "post",
         input: z.object({}),
         output: z.object({}),
         handler: async () => ({}),