Project Structure

{
  "properties": [
    {
      "name": "id",
      "type": "int",
      "isPrimary": true
    },
    {
      "name": "email",
      "type": "varchar"
    },
    {
      "name": "name",
      "type": "varchar"
    }
  ]
}

// File you write directly
import { api, BaseModelClass } from "sonamu";

class UserModelClass extends BaseModelClass {
  @api({ httpMethod: "GET", clients: ["axios", "tanstack-query"] })
  async findById(id: number): Promise<UserSubsetA | null> {
    // Business logic
  }
}

export const UserModel = new UserModelClass();

// Auto-generated + extensible
import { z } from "zod";
import { UserBaseSchema } from "../sonamu.generated";

// Base type (auto-generated)
export type User = z.infer<typeof UserBaseSchema>;

// Extensible custom types
export const UserSaveParams = UserBaseSchema.partial({
  id: true,
  created_at: true,
});
export type UserSaveParams = z.infer<typeof UserSaveParams>;

// Auto-generated - do not modify directly
export const UserBaseSchema = z.object({
  id: z.number(),
  email: z.string(),
  name: z.string(),
  created_at: z.date(),
});

export const UserOrderBy = z.enum(["id-desc", "name-asc"]);
export type UserOrderBy = z.infer<typeof UserOrderBy>;

// Auto-generated
import { useQuery } from "@tanstack/react-query";

export class UserService {
  static async findById(id: number): Promise<UserSubsetA | null> {
    const res = await axios.get(`/api/user/findById`, { params: { id } });
    return res.data;
  }

  // TanStack Query hooks are also auto-generated
  static useFindById(id: number) {
    return useQuery({
      queryKey: ["User", "findById", id],
      queryFn: () => UserService.findById(id),
    });
  }
}