common-schema.ts

import { z } from "@hono/zod-openapi";

export const BaseResponseSchema = z.object({
  success: z.boolean(),
  code: z.number(),
  message: z.string(),
});

export const ErrorResponseSchema = BaseResponseSchema.extend({
  success: z.literal(false),
  data: z.null().optional().openapi({
    description: "No data for error responses",
  }),
}).openapi("ErrorResponse");

export const createSuccessResponseSchema = <T extends z.ZodTypeAny>(dataSchema: T) => {
  return BaseResponseSchema.extend({
    success: z.literal(true),
    data: dataSchema.optional(),
  });
};

export const PackageKeySchema = z.string();

export const CategoryConfigSchema = z
  .object({
    key: z.string(),
    name: z.string(),
    description: z.string().optional(),
  })
  .openapi("CategoryConfig");

export const HostingBlackListSchema = z.array(PackageKeySchema);

export const FeaturedListSchema = z.array(PackageKeySchema);

export const MCPServerPackageConfigSchema = z
  .object({
    type: z.literal("mcp-server"),

    runtime: z.enum(["node", "python", "java", "go", "docker"]),
    packageName: z.string().describe("Name of the node, python, java package or docker image"),
    packageVersion: z
      .string()
      .optional()
      .describe("Version of the package, if not provided then it will use latest version"),

    bin: z
      .string()
      .optional()
      .describe(
        "Binary Command to run the MCP server, if not provided then it will use the package name",
      ),
    binArgs: z
      .array(z.string())
      .optional()
      .describe(
        "Binary Arguments to pass to the command, if not provided then it will use an empty array",
      ),

    remotes: z
      .array(
        z.object({
          type: z.literal("streamable-http"),
          url: z.string().url(),
          auth: z
            .object({
              type: z.enum(["oauth2"]),
              scopes: z.array(z.string()).optional(),
            })
            .optional()
            .describe("OAuth 2.1 authentication configuration for MCP Server"),
        }),
      )
      .optional(),

    // if no custom key then would use name
    key: z.string().optional().describe("Unique key for url and slug"),
    name: z
      .string()
      .optional()
      .describe("Custom name for display, if empty then it will use the package name"),
    description: z.string().optional(),
    readme: z
      .string()
      .optional()
      .describe("URL to the README file, if not provided then it will use the package URL"),

    url: z.string().optional(),
    license: z.string().optional().describe("Open source license like MIT, AGPL, GPL, etc"),
    logo: z
      .string()
      .optional()
      .describe(
        "URL to custom logo image, if undefined and the URL is Github, then it will use the Github logo",
      ),
    author: z.string().optional().describe("Author name of the ToolSDK.ai's developer ID"),
    env: z
      .record(
        z.object({
          description: z.string(),
          required: z.boolean(),
        }),
      )
      .optional(),
  })
  .openapi("MCPServerPackageConfig");

export const PackageConfigSchema = z
  .discriminatedUnion("type", [
    MCPServerPackageConfigSchema,
    z.object({
      type: z.literal("toolapp"),
      packageName: z.string(),
      url: z.string().optional(),
    }),
  ])
  .openapi("PackageConfig");

export const PackagesListSchema = z
  .record(
    z.object({
      category: z.string().optional(),
      path: z.string(),
      validated: z.boolean().optional(),
      tools: z
        .record(
          z.object({
            name: z.string().optional(),
            description: z.string().optional(),
          }),
        )
        .optional(),
    }),
  )
  .openapi("PackagesList");