Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jacobsamo/buzztrip/llms.txt

Use this file to discover all available pages before exploring further.

Maps are the top-level containers in BuzzTrip. Every piece of content you add — markers, collections, paths, labels, and routes — lives inside a map. You can create as many maps as you need for different trips, projects, or purposes, each with its own collaborators, visibility settings, and map style.

Map Properties

When you create or edit a map, the following fields are available:
title
string
required
The display name of the map. The first letter is automatically uppercased when saved.
description
string
An optional longer description of the map’s purpose or contents.
image
string (URL)
An optional cover image URL displayed as a thumbnail for the map.
icon
icon
An optional icon used to visually identify the map in listings and sidebars.
color
string (hex)
An optional hex color used to accent the map in the UI.
visibility
string
required
Controls who can access the map. One of private, public, or unlisted. See Visibility Levels below.
mapTypeId
string
The base map style to use. One of hybrid, roadmap, satellite, or terrain. Defaults to hybrid if not specified.
location_name
string
An optional human-readable place name describing where the map is based — for example, Brisbane, Australia.
lat
number
Optional latitude for the map’s initial center position.
lng
number
Optional longitude for the map’s initial center position.
bounds
object
Optional geographic bounding box that defines the initial viewport of the map.

Visibility Levels

Private

Only the owner and explicitly invited collaborators can view or edit the map. It does not appear in search or public listings.

Public

Viewable by anyone, and indexable or searchable by other BuzzTrip users. Anyone can also duplicate a public map to their own account.

Unlisted

Accessible to anyone who has the direct link, but not discoverable through search or public listings.

Creating a Map

1

Open the Maps dashboard

Navigate to your BuzzTrip dashboard and click New Map.
2

Fill in map details

Enter a title and optionally add a description, cover image, icon, color, and starting location. Choose a visibility level and map style.
3

Save the map

Click Create. BuzzTrip calls the createMap Convex mutation, which automatically:
  • Inserts the new map record with the authenticated user as owner_id
  • Creates a Default Collection for the map via createCollectionFunction
  • Adds the creating user to the map’s map_users table with the owner permission role
Because BuzzTrip uses Convex as its real-time backend, all map changes — including creation — are pushed to every connected client instantly. Collaborators on the same map see updates without needing to refresh the page.

Duplicating a Map

The duplicateMap function creates a full copy of an existing map under your account. The new map is titled Copy of <original title> and is owned by you. The duplicate includes all of the following from the original map:
  • Markers
  • Collections
  • Collection links (marker ↔ collection assignments)
  • Paths
  • Labels
  • Routes
  • Route stops
Permission check: You can duplicate a map if any one of these conditions is true:
  1. You are the map’s owner
  2. You have an active map_users entry for the map (editor, viewer, or commenter)
  3. The map’s visibility is set to public
If none of those conditions are met, the duplication is rejected with a permission error. If an error occurs mid-duplication, the partially created map is automatically cleaned up to prevent orphaned records.

Map Views

BuzzTrip tracks map views for analytics via the trackMapView mutation. View history is queryable via getMapViews for maps you own, giving you insight into how often and from where your maps are being accessed. Each view record captures the following fields:
FieldDescription
userIdThe authenticated user who viewed the map (optional — unset for anonymous views)
ipIP address of the viewer
countryCountry derived from the IP
regionRegion or state derived from the IP
cityCity derived from the IP
userAgentRaw user-agent string from the request
browserParsed browser name
osParsed operating system
deviceParsed device type

Map Styles

Choose a base map style that best fits your content. The mapTypeId field accepts one of four values:
Combines satellite photography with road and label overlays. This is the default style when no mapTypeId is specified. Ideal when you need both geographic detail and navigational labels — useful for travel planning, location scouting, and event mapping.

Build docs developers (and LLMs) love