@roastbook/open-coffee-schema 0.0.0-stage → 0.4.0

package/index.d.ts

@@ -0,0 +1,1114 @@
+// Generated by scripts/build-package.ts from the Open Coffee JSON Schemas. Do not edit.
+export type CoffeePlaceMeta = DatasetMeta & {
+  country_code: CountryCode;
+  /**
+   * City slug, matching the file name.
+   */
+  city: string;
+  /**
+   * City name in the local language.
+   */
+  city_name?: string;
+};
+/**
+ * ISO 3166-1 alpha-2 code in upper case.
+ */
+export type CountryCode = string;
+/**
+ * One place that serves coffee. In JSON-LD it is a schema.org CafeOrCoffeeShop whose IRI is https://data.roastbook.coffee/places/<id>.
+ */
+export type CoffeePlace = {
+  id: OpenCoffeeId;
+  /**
+   * Kind of place, as a schema.org type. Every place is a CafeOrCoffeeShop for now; JSON-LD processors read it as the record's @type.
+   */
+  type: "CafeOrCoffeeShop";
+  /**
+   * The name the place uses on its sign or website.
+   */
+  name: string;
+  /**
+   * open; temporarily_closed (renovation, holiday longer than a month); closed (permanently); unverified (found but not yet confirmed to exist).
+   */
+  status: "open" | "temporarily_closed" | "closed" | "unverified";
+  merged_into?: OpenCoffeeId;
+  opened_on?: IsoDate;
+  closed_on?: IsoDate;
+  last_verified_at?: IsoDateTime;
+  checked_at: IsoDateTime;
+  address: Address;
+  location: Location;
+  /**
+   * Opening hours in OpenStreetMap opening_hours syntax (used as a format only; no OSM data), for example "Mo-Fr 08:00-18:00; Sa,Su 09:00-17:00".
+   */
+  opening_hours?: string;
+  /**
+   * Short English description written only from the facts stored in this record. Never copied from the place's own texts.
+   */
+  description?: string;
+  specialty_tier: SpecialtyTier;
+  /**
+   * Whether the place roasts coffee itself. true: roasts its own beans; false: confirmed not roasting; absent: unknown.
+   */
+  roasts_own_beans?: boolean;
+  roasters_served?: CoffeePlaceRoasterRef[];
+  serving?: CoffeePlaceServing;
+  amenities?: CoffeePlaceAmenities;
+  food?: CoffeePlaceFood;
+  /**
+   * Whether whole beans or ground coffee are sold to take home. true: sold; false: confirmed not sold; absent: unknown.
+   */
+  sells_beans?: boolean;
+  /**
+   * Whether brewing equipment such as grinders, drippers or kettles is sold. true: sold; false: confirmed not sold; absent: unknown.
+   */
+  sells_equipment?: boolean;
+  /**
+   * Barista courses, brewing classes or public cuppings.
+   */
+  offers_courses?: boolean;
+  /**
+   * Deposit or reusable cup schemes accepted, for example recup, vytal, own_cup.
+   */
+  reusable_cup_systems?: string[];
+  good_for?: CoffeePlaceGoodFor[];
+  awards?: CoffeePlaceAward[];
+  /**
+   * Prices we observed, each with the date and page where we saw it. Currently only the cappuccino price, as a comparable reference.
+   */
+  prices?: {
+    cappuccino?: CoffeePlacePrice;
+  };
+  operator?: CoffeePlaceOperator;
+  links?: CoffeePlaceLinks;
+  image?: Image;
+  xref?: CoffeePlaceXref;
+  /**
+   * References to rating pages elsewhere. Rating values are never stored.
+   */
+  external_ratings?: ExternalRef[];
+};
+/**
+ * Permanent, opaque identifier. Never reused, never derived from a name, never deleted. Lowercase letters, digits, dots, dashes and underscores; starts and ends with a letter or digit.
+ */
+export type OpenCoffeeId = string;
+/**
+ * Calendar date, YYYY-MM-DD.
+ */
+export type IsoDate = string;
+/**
+ * RFC 3339 timestamp with time zone, for example 2026-11-05T14:00:00Z.
+ */
+export type IsoDateTime = string;
+/**
+ * A: coffee is the core product; the place roasts its own beans or serves named specialty roasters and usually offers filter coffee. B: food or something else leads, but the place serves a specialty roaster. none: not a specialty place (kept in the dataset). unknown: not yet assessed.
+ */
+export type SpecialtyTier = "A" | "B" | "none" | "unknown";
+/**
+ * Absolute http or https address. Letters outside ASCII, such as umlauts in the host or path, may be written as they are (an IRI, for example https://kaffee-münchen.de/über-uns). The scheme is not case-sensitive.
+ */
+export type HttpUrl = string;
+/**
+ * Coffee preparation offered. true: offered; false: confirmed not offered; absent: unknown.
+ */
+export type CoffeePlaceServing = {
+  /**
+   * Espresso and espresso-based drinks.
+   */
+  espresso?: boolean;
+  /**
+   * Any filter coffee.
+   */
+  filter?: boolean;
+  /**
+   * Hand-brewed filter (V60, Kalita, Chemex and similar).
+   */
+  pour_over?: boolean;
+  /**
+   * Filter coffee from a batch brewer.
+   */
+  batch_brew?: boolean;
+  /**
+   * Coffee brewed with cold water over many hours. true: offered; false: confirmed not offered; absent: unknown.
+   */
+  cold_brew?: boolean;
+  /**
+   * Decaffeinated coffee. true: offered; false: confirmed not offered; absent: unknown.
+   */
+  decaf?: boolean;
+  /**
+   * At least one plant-based milk.
+   */
+  plant_milk?: boolean;
+};
+/**
+ * true: available; false: confirmed not available; absent: unknown.
+ */
+export type CoffeePlaceAmenities = {
+  /**
+   * Wi-Fi for guests. true: available; false: confirmed not available; absent: unknown.
+   */
+  wifi?: boolean;
+  /**
+   * Laptops are welcome (no laptop ban, seats with sockets or tables).
+   */
+  laptop_friendly?: boolean;
+  /**
+   * Suitable for children, for example with high chairs, space for prams or a kids' menu. true: yes; false: confirmed not suitable; absent: unknown.
+   */
+  kids_friendly?: boolean;
+  /**
+   * Vegan food beyond plant milk.
+   */
+  vegan_options?: boolean;
+  /**
+   * Dogs may come inside. true: allowed; false: confirmed not allowed; absent: unknown.
+   */
+  dogs_allowed?: boolean;
+  /**
+   * Seats outside, such as a terrace or tables on the pavement. true: available; false: confirmed none; absent: unknown.
+   */
+  outdoor_seating?: boolean;
+  /**
+   * Payment by debit or credit card. true: accepted; false: confirmed not accepted; absent: unknown.
+   */
+  card_payment?: boolean;
+  /**
+   * Only cash is accepted. true: cash only; false: other payment methods are accepted; absent: unknown.
+   */
+  cash_only?: boolean;
+  /**
+   * Step-free entrance.
+   */
+  wheelchair_accessible?: boolean;
+};
+export type CoffeePlaceGoodFor =
+  | "working"
+  | "meetings"
+  | "quick_espresso"
+  | "takeaway"
+  | "brunch"
+  | "groups"
+  | "reading"
+  | "date"
+  | "coffee_nerds"
+  | "families";
+/**
+ * ISO 4217 currency code.
+ */
+export type Currency = string;
+/**
+ * espresso_machine_with_grinder is an espresso machine with a built-in grinder; filter covers paper and metal filters; accessory covers everything without a dedicated type (puck screens, distribution tools, thermometers, dosing cups).
+ */
+export type EquipmentType =
+  | "espresso_machine"
+  | "espresso_machine_with_grinder"
+  | "grinder"
+  | "brewer"
+  | "kettle"
+  | "scale"
+  | "tamper"
+  | "wdt"
+  | "basket"
+  | "filter"
+  | "roaster"
+  | "milk_frother"
+  | "accessory";
+/**
+ * Descriptive grind size; extra_fine is Turkish, fine espresso, medium filter, coarse French press and cold brew.
+ */
+export type GrindSize = "extra_fine" | "fine" | "medium_fine" | "medium" | "medium_coarse" | "coarse" | "extra_coarse";
+/**
+ * Where paper filter discs sit in an espresso basket. none: no paper filter; top: on top of the coffee, under the shower screen; bottom: under the coffee, at the basket floor; both: one disc on top and one at the bottom.
+ */
+export type PaperFilterPosition = "none" | "top" | "bottom" | "both";
+/**
+ * How ground coffee is spread evenly in the basket before tamping. wdt: stirring with fine needles (Weiss Distribution Technique); blind_shaker: grinding into a closed cup, shaking it and tipping the coffee into the basket; distribution_tool: a spinning leveller set on the basket; stockfleth_move: sweeping the coffee level with a finger while turning the portafilter.
+ */
+export type DistributionMethod = "wdt" | "blind_shaker" | "distribution_tool" | "stockfleth_move";
+/**
+ * Parameter keys shared with coffee journals such as Roastbook. brew_ratio is grams of brew water per gram of coffee (16 means 1:16); yield_ratio is grams of drink in the cup per gram of coffee (2 means a 1:2 espresso). brew_temperature_celsius is the temperature of the brew water. uses_puck_screen records whether a puck screen sat on top of the espresso puck (true or false). paper_filter_position takes a paper_filter_position value and distribution_method a distribution_method value.
+ */
+export type BrewParameter =
+  | "dose_g"
+  | "brew_water_g"
+  | "yield_g"
+  | "brew_ratio"
+  | "yield_ratio"
+  | "grind_setting"
+  | "brew_time_seconds"
+  | "target_time_seconds"
+  | "brew_temperature_celsius"
+  | "bloom_time_seconds"
+  | "bloom_water_g"
+  | "preinfusion_time_seconds"
+  | "preinfusion_pressure_bar"
+  | "brew_pressure_bar"
+  | "flow_rate_ml_per_second"
+  | "tamp_force_kg"
+  | "uses_puck_screen"
+  | "paper_filter_position"
+  | "distribution_method"
+  | "pour_count"
+  | "steep_time_seconds";
+
+/**
+ * One file per city listing cafés, coffee bars and other places that serve coffee. Part of Roastbook Open Coffee.
+ */
+export interface CoffeePlacesDataset {
+  /**
+   * Canonical URL of the schema version this file follows.
+   */
+  $schema: string;
+  meta: CoffeePlaceMeta;
+  places: CoffeePlace[];
+}
+/**
+ * File-level facts that are not records. The schema version is the $schema URL; the data version is the release tag.
+ */
+export interface DatasetMeta {
+  /**
+   * Licence of the file as an SPDX licence expression, for example MIT, CC0-1.0, CC-BY-4.0, ODbL-1.0 or "MIT OR Apache-2.0". Use identifiers from the SPDX licence list (https://spdx.org/licenses/) or LicenseRef-<name> for others.
+   */
+  licence: string;
+}
+export interface Address {
+  /**
+   * Street and house number.
+   */
+  street_address?: string;
+  /**
+   * Postal code as used locally, for example 80331.
+   */
+  postal_code?: string;
+  /**
+   * City or town.
+   */
+  locality?: string;
+  /**
+   * State or region.
+   */
+  region?: string;
+  country_code: CountryCode;
+}
+/**
+ * WGS 84 coordinates of the entrance or building.
+ */
+export interface Location {
+  /**
+   * Latitude in decimal degrees (WGS 84); positive is north of the equator, for example 48.1371.
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees (WGS 84); positive is east of Greenwich, for example 11.5754.
+   */
+  lon: number;
+}
+export interface CoffeePlaceRoasterRef {
+  /**
+   * Name of the roastery whose coffee is served.
+   */
+  name: string;
+  roaster_id?: OpenCoffeeId;
+  url?: HttpUrl;
+  /**
+   * The place roasts this coffee itself.
+   */
+  own?: boolean;
+}
+export interface CoffeePlaceFood {
+  /**
+   * coffee_led: coffee is the main product; food_led: food or a restaurant concept leads; balanced: both matter equally.
+   */
+  focus?: "coffee_led" | "food_led" | "balanced";
+  /**
+   * Breakfast is served. true: served; false: confirmed not served; absent: unknown.
+   */
+  breakfast?: boolean;
+  /**
+   * Lunch dishes are served. true: served; false: confirmed not served; absent: unknown.
+   */
+  lunch?: boolean;
+  /**
+   * Cakes or pastries are baked by the place itself. true: baked in house; false: confirmed bought in; absent: unknown.
+   */
+  cakes_baked_in_house?: boolean;
+}
+export interface CoffeePlaceAward {
+  /**
+   * Name of the award or ranking, for example a national barista championship or a city guide's list.
+   */
+  name: string;
+  /**
+   * Year the award was given, for example 2025.
+   */
+  year?: number;
+  url?: HttpUrl;
+}
+export interface CoffeePlacePrice {
+  /**
+   * Price paid for one standard drink, in the currency given by currency, for example 3.9.
+   */
+  amount: number;
+  currency: Currency;
+  observed_on: IsoDate;
+  source_url?: HttpUrl;
+}
+/**
+ * The legal entity running the place, taken from its Impressum or legal notice. Only companies and other legal entities; never the name of a natural person (sole traders are omitted).
+ */
+export interface CoffeePlaceOperator {
+  /**
+   * Registered name of the company that runs the place, as written in its legal notice.
+   */
+  name: string;
+  /**
+   * For example GmbH, UG (haftungsbeschränkt), KG, e.K.
+   */
+  legal_form?: string;
+  /**
+   * Commercial register number, for example HRB 123456 (Amtsgericht München).
+   */
+  register_id?: string;
+}
+export interface CoffeePlaceLinks {
+  website?: HttpUrl;
+  /**
+   * Address of the place's own Instagram profile. Write it as https://www.instagram.com/<handle>/ with the handle in lower case and no query string, for example https://www.instagram.com/example.coffee/. Posts, reels, stories and other non-profile pages are rejected.
+   */
+  instagram?: string;
+  /**
+   * Address of the place's own Facebook page.
+   */
+  facebook?: string;
+}
+/**
+ * An openly licensed image. Each image carries its own licence, author and source.
+ */
+export interface Image {
+  url: HttpUrl;
+  /**
+   * SPDX identifier, for example CC-BY-4.0, CC-BY-SA-4.0 or CC0-1.0.
+   */
+  licence: string;
+  /**
+   * Name of the photographer or creator, as the licence requires it to be credited.
+   */
+  author: string;
+  source_url: HttpUrl;
+  /**
+   * Short caption describing what the image shows.
+   */
+  title?: string;
+  /**
+   * Width of the image file in pixels.
+   */
+  width?: number;
+  /**
+   * Height of the image file in pixels.
+   */
+  height?: number;
+}
+/**
+ * Crosswalk to other datasets. google_place_id is the only Google data we may store.
+ */
+export interface CoffeePlaceXref {
+  /**
+   * Overture Maps place GERS id.
+   */
+  overture?: string;
+  /**
+   * Foursquare Open Source Places fsq_place_id.
+   */
+  foursquare?: string;
+  /**
+   * Wikidata item id of the place, for example Q42.
+   */
+  wikidata?: string;
+  /**
+   * Google Maps place id, stored only so a known place can be matched. No other Google data is stored.
+   */
+  google_place_id?: string;
+}
+/**
+ * A pointer to a record in another service. Never stores the other service's values.
+ */
+export interface ExternalRef {
+  /**
+   * Short name of the other service, for example tripadvisor or untappd. Lowercase letters, digits, dots, dashes and underscores.
+   */
+  source: string;
+  /**
+   * The record's identifier in the other service.
+   */
+  id: string;
+  url?: HttpUrl;
+}
+/**
+ * Ways of brewing coffee (espresso, pour-over, V60, AeroPress, cold brew…), their typical parameters and what a coffee journal should record for each. Methods form a tree: a device-specific method such as v60 has the general method pour-over as parent. Part of Roastbook Open Coffee.
+ */
+export interface BrewMethodsDataset {
+  /**
+   * Canonical URL of the schema version this file follows.
+   */
+  $schema: string;
+  meta: DatasetMeta1;
+  brew_methods: BrewMethod[];
+}
+/**
+ * File-level facts that are not records. The schema version is the $schema URL; the data version is the release tag.
+ */
+export interface DatasetMeta1 {
+  /**
+   * Licence of the file as an SPDX licence expression, for example MIT, CC0-1.0, CC-BY-4.0, ODbL-1.0 or "MIT OR Apache-2.0". Use identifiers from the SPDX licence list (https://spdx.org/licenses/) or LicenseRef-<name> for others.
+   */
+  licence: string;
+}
+export interface BrewMethod {
+  id: OpenCoffeeId;
+  /**
+   * Common English name of the method, for example Pour-over or French press.
+   */
+  name: string;
+  /**
+   * Other names in any language, e.g. Filterkaffee, drip.
+   */
+  aliases?: string[];
+  parent?: OpenCoffeeId;
+  /**
+   * Family used for grouping: espresso (9-bar style pressure), filter (percolation through a filter), immersion (steep, then separate), pressure (non-espresso pressure such as AeroPress or moka pot), vacuum (siphon), boiling (cezve/ibrik), cold (cold water over hours).
+   */
+  category: "espresso" | "filter" | "immersion" | "pressure" | "vacuum" | "boiling" | "cold";
+  /**
+   * Physical principle; matches equipment brewer.mechanism.
+   */
+  extraction: "percolation" | "immersion" | "hybrid";
+  /**
+   * Short neutral explanation in our own words.
+   */
+  description: string;
+  /**
+   * Year the method or device was invented or first sold.
+   */
+  introduced_year?: number;
+  origin_country_code?: CountryCode;
+  /**
+   * Equipment types needed, from the equipment schema's type list.
+   */
+  equipment_types?: EquipmentType[];
+  typical_parameters?: BrewMethodTypicalParameters;
+  /**
+   * Parameters a coffee journal should offer when logging a brew with this method.
+   */
+  recorded_parameters?: BrewParameter[];
+  /**
+   * Drinks usually made with this method, in plain lowercase English, for example espresso, cappuccino or flat white.
+   */
+  typical_drinks?: string[];
+  /**
+   * Identifiers of the method in other datasets and apps.
+   */
+  xref?: {
+    /**
+     * Wikidata item id of the method, for example Q180289 for espresso.
+     */
+    wikidata?: string;
+    /**
+     * Beanconqueror PREPARATION_TYPES key, for app imports.
+     */
+    beanconqueror?: string;
+  };
+  image?: Image;
+  checked_at: IsoDateTime;
+  /**
+   * Filters the method can use. paper: paper filters; metal: metal mesh or perforated metal; cloth: cloth filters; none: no filter (for example cezve or cold brew in a jar).
+   */
+  filter_types?: ("paper" | "metal" | "cloth" | "none")[];
+}
+/**
+ * Common starting ranges, not rules.
+ */
+export interface BrewMethodTypicalParameters {
+  dose_g?: BrewMethodRange;
+  brew_ratio?: BrewMethodRange;
+  yield_ratio?: BrewMethodRange;
+  brew_temperature_celsius?: BrewMethodRange;
+  brew_time_seconds?: BrewMethodRange;
+  brew_pressure_bar?: BrewMethodRange;
+  /**
+   * @minItems 1
+   */
+  grind_size?: GrindSize[];
+  grind_d50_microns?: BrewMethodRange;
+  /**
+   * Paper filter positions commonly used with this method.
+   *
+   * @minItems 1
+   */
+  paper_filter_position?: PaperFilterPosition[];
+  /**
+   * Distribution methods commonly used with this method.
+   *
+   * @minItems 1
+   */
+  distribution_method?: DistributionMethod[];
+}
+/**
+ * A starting range. When several values are given they must be ordered: min ≤ typical ≤ max. JSON Schema cannot compare two values, so this repository checks it in its examples and data repositories check it in their data.
+ */
+export interface BrewMethodRange {
+  /**
+   * Lowest common value, in the unit named by the parameter (for example grams for dose_g, degrees Celsius for brew_temperature_celsius).
+   */
+  min?: number;
+  /**
+   * Highest common value, in the unit named by the parameter.
+   */
+  max?: number;
+  /**
+   * A good starting value, in the unit named by the parameter.
+   */
+  typical?: number;
+}
+/**
+ * Coffee equipment models (machines, grinders, brewers, kettles, scales and accessories) as sold, not individual owned items. Measurements put the unit in the property name. Part of Roastbook Open Coffee; derived from the Roastbook journal gear model.
+ */
+export interface EquipmentCatalog {
+  /**
+   * Canonical URL of the schema version this file follows.
+   */
+  $schema: string;
+  meta: DatasetMeta2;
+  equipment: EquipmentItem[];
+}
+/**
+ * File-level facts that are not records. The schema version is the $schema URL; the data version is the release tag.
+ */
+export interface DatasetMeta2 {
+  /**
+   * Licence of the file as an SPDX licence expression, for example MIT, CC0-1.0, CC-BY-4.0, ODbL-1.0 or "MIT OR Apache-2.0". Use identifiers from the SPDX licence list (https://spdx.org/licenses/) or LicenseRef-<name> for others.
+   */
+  licence: string;
+}
+/**
+ * Each details object (espresso_machine, grinder, brewer, …) is only allowed for the types it describes.
+ */
+export interface EquipmentItem {
+  id: OpenCoffeeId;
+  /**
+   * Full display name, e.g. Hario V60 02.
+   */
+  name: string;
+  manufacturer: EquipmentManufacturer;
+  /**
+   * Model name without the brand, for example V60.
+   */
+  model?: string;
+  /**
+   * Sizes or materials sold under the same model, e.g. 01 and 02, ceramic and plastic.
+   */
+  variants?: string[];
+  type: EquipmentType;
+  /**
+   * Brew method ids from the Open Coffee brew methods dataset this equipment is made for.
+   */
+  brew_methods?: OpenCoffeeId[];
+  /**
+   * Year the model first went on sale.
+   */
+  released_year?: number;
+  /**
+   * Whether the maker has stopped selling the model. true: discontinued; false: still sold; absent: unknown.
+   */
+  discontinued?: boolean;
+  links?: EquipmentLinks;
+  image?: Image;
+  xref?: EquipmentIdentifiersElsewhere;
+  espresso_machine?: EquipmentEspressoMachine;
+  grinder?: EquipmentGrinder;
+  brewer?: EquipmentBrewer;
+  kettle?: EquipmentKettle;
+  scale?: EquipmentScale;
+  tamper?: EquipmentTamper;
+  wdt?: EquipmentWdt;
+  basket?: EquipmentBasket;
+  checked_at: IsoDateTime;
+  /**
+   * Manufacturer part number.
+   */
+  mpn?: string;
+  /**
+   * Weight of the product without packaging, in grams.
+   */
+  weight_g?: number;
+  /**
+   * Outside size of the product in millimetres.
+   */
+  dimensions_mm?: {
+    /**
+     * Width in millimetres, seen from the front.
+     */
+    width?: number;
+    /**
+     * Depth in millimetres, from front to back.
+     */
+    depth?: number;
+    /**
+     * Height in millimetres.
+     */
+    height?: number;
+  };
+}
+export interface EquipmentManufacturer {
+  /**
+   * Brand or company name as printed on the product, for example Hario.
+   */
+  name: string;
+  manufacturer_id?: OpenCoffeeId;
+  country_code?: CountryCode;
+  website?: HttpUrl;
+}
+export interface EquipmentLinks {
+  product?: HttpUrl;
+  manual?: HttpUrl;
+}
+export interface EquipmentIdentifiersElsewhere {
+  /**
+   * Wikidata item id of the model or product line, for example Q1234567.
+   */
+  wikidata?: string;
+  /**
+   * Barcode numbers (GTIN, EAN or UPC; 8 to 14 digits) printed on the packaging, one per variant.
+   */
+  gtin?: string[];
+  /**
+   * Google Product Taxonomy id (Wikidata P11302).
+   */
+  google_product_category?: number;
+  /**
+   * GS1 Global Product Classification brick code (Wikidata P8957).
+   */
+  gs1_gpc_brick?: string;
+}
+export interface EquipmentEspressoMachine {
+  /**
+   * How the machine heats water. single_boiler: one boiler for brewing and steam, used in turn; heat_exchanger: one steam boiler that heats brew water passing through a pipe inside it; dual_boiler: separate brew and steam boilers; multi_boiler: more than two boilers, for example one per group; single_thermoblock and dual_thermoblock: water heated on the fly in one or two thermoblocks; hybrid: a boiler combined with a thermoblock; manual: no heater, you pour in hot water.
+   */
+  heating_architecture?:
+    | "single_boiler"
+    | "heat_exchanger"
+    | "dual_boiler"
+    | "multi_boiler"
+    | "single_thermoblock"
+    | "dual_thermoblock"
+    | "hybrid"
+    | "manual"
+    | "other";
+  /**
+   * How brew temperature is set. none: no control; fixed: set at the factory; adjustable: the user can change it (for example with a PID); programmable: can change during the shot or follow profiles.
+   */
+  temperature_control?: "none" | "fixed" | "adjustable" | "programmable";
+  /**
+   * How brew pressure is set. fixed: set by the factory; adjustable_opv: the over-pressure valve can be adjusted; manual: controlled by hand, for example with a lever; programmable: follows set pressure profiles.
+   */
+  pressure_control?: "fixed" | "adjustable_opv" | "manual" | "programmable";
+  /**
+   * Whether water flow during the shot can be controlled. none: no control; manual: by hand, for example a needle valve paddle; programmable: follows set profiles.
+   */
+  flow_control?: "none" | "manual" | "programmable";
+  /**
+   * Wetting the coffee at low pressure before full pressure. none: no preinfusion; supported: possible by hand or by technique; fixed: built in with a fixed duration; adjustable: duration or pressure can be set; programmable: part of a programmable profile.
+   */
+  preinfusion_control?: "none" | "supported" | "fixed" | "adjustable" | "programmable";
+  /**
+   * How milk steam is produced. none: no steam wand; shared_heater: the same heater as for brewing, so the machine switches between modes; dedicated_heater: a separate boiler or thermoblock for steam.
+   */
+  steam_system?: "none" | "shared_heater" | "dedicated_heater";
+  /**
+   * Whether you can pull a shot and steam milk at the same time. true: possible; false: confirmed not possible; absent: unknown.
+   */
+  simultaneous_brew_and_steam?: boolean;
+  /**
+   * How pressure is made. vibration: small vibratory pump; rotary: quieter rotary vane pump; gear: gear pump, often used for flow profiling; peristaltic: squeezed-tube pump; manual: lever or hand pump, no motor.
+   */
+  pump_type?: "vibration" | "rotary" | "gear" | "peristaltic" | "manual" | "other";
+  /**
+   * Where water comes from. reservoir: a tank you fill; plumbed: connected to the mains water supply.
+   *
+   * @minItems 1
+   */
+  water_source_modes?: ("reservoir" | "plumbed")[];
+  /**
+   * How a shot can be stopped. manual: by the user; weight: automatically at a target weight with a scale; time: after a set time; volume: after a set volume (volumetric dosing).
+   */
+  shot_stop_modes?: ("manual" | "weight" | "time" | "volume")[];
+  /**
+   * Number of brew groups (where portafilters lock in), for example 1 for most home machines.
+   */
+  group_count?: number;
+  /**
+   * Inner diameter of the portafilter basket in millimetres, for example 58.
+   */
+  portafilter_diameter_mm?: number;
+  /**
+   * Lowest brew pressure the machine can deliver, in bar.
+   */
+  brew_pressure_min_bar?: number;
+  /**
+   * Highest brew pressure the machine can deliver, in bar.
+   */
+  brew_pressure_max_bar?: number;
+  /**
+   * Lowest brew water temperature that can be set, in degrees Celsius.
+   */
+  brew_temperature_min_celsius?: number;
+  /**
+   * Highest brew water temperature that can be set, in degrees Celsius.
+   */
+  brew_temperature_max_celsius?: number;
+  /**
+   * Size of the water tank in millilitres.
+   */
+  reservoir_capacity_ml?: number;
+  /**
+   * Rated electrical power in watts.
+   */
+  power_w?: number;
+  /**
+   * Type of brew group. e61: the classic heated E61 group; saturated: group filled with boiler water and kept at its temperature; semi_saturated: group attached to the boiler but not fully filled; lever: piston group driven by a lever; integrated: group built into a thermoblock or the machine body; other: anything else.
+   */
+  group_type?: "e61" | "saturated" | "semi_saturated" | "lever" | "integrated" | "other";
+  /**
+   * Number of boilers, 0 for thermoblock or manual machines.
+   */
+  boiler_count?: number;
+  /**
+   * Wireless or wired connections for apps or updates: bluetooth, wifi or usb.
+   */
+  connectivity?: ("bluetooth" | "wifi" | "usb")[];
+}
+export interface EquipmentGrinder {
+  /**
+   * Type of cutting parts. conical: cone-shaped burrs; flat: two flat discs; ghost: flat burrs in a design without a burr carrier contact, sold as "ghost burrs"; roller: industrial-style roller mill; blade: spinning blade that chops rather than grinds; other: anything else.
+   */
+  burr_mechanism?: "conical" | "flat" | "ghost" | "roller" | "blade" | "other";
+  /**
+   * Diameter of the burrs in millimetres, for example 64 for many flat-burr grinders.
+   */
+  burr_diameter_mm?: number;
+  /**
+   * What the burrs are made of. steel: hardened steel; ceramic: ceramic burrs; titanium_coated: steel with a titanium or similar hard coating; other: anything else.
+   */
+  burr_material?: "steel" | "ceramic" | "titanium_coated" | "other";
+  /**
+   * How grind size is changed. fixed: cannot be changed; stepped: clicks between set positions; stepless: any position in between.
+   */
+  adjustment_type?: "fixed" | "stepped" | "stepless";
+  /**
+   * How the dial reads, so journals can store settings.
+   */
+  grind_setting_format?: "whole_number" | "decimal" | "string";
+  /**
+   * Lowest number on the grind dial, as printed by the maker.
+   */
+  grind_setting_min?: number;
+  /**
+   * Highest number on the grind dial, as printed by the maker.
+   */
+  grind_setting_max?: number;
+  /**
+   * Brew styles the grinder can grind for, as stated by the maker: espresso, filter or turkish (extra fine).
+   *
+   * @minItems 1
+   */
+  brew_range?: ("espresso" | "filter" | "turkish")[];
+  /**
+   * How beans go in. single_dose: weighed dose for each brew; hopper: a container holding beans for many brews; both: works either way.
+   */
+  bean_feed?: "single_dose" | "hopper" | "both";
+  /**
+   * How the amount of ground coffee is controlled. manual: the user stops grinding; time: grinds for a set time; weight: stops at a target weight with a built-in scale.
+   */
+  dose_control_modes?: ("manual" | "time" | "weight")[];
+  /**
+   * manual: turned by hand; electric: driven by a motor.
+   */
+  drive?: "manual" | "electric";
+  /**
+   * Rated motor power in watts.
+   */
+  motor_power_w?: number;
+  /**
+   * Smallest step between settings on a stepped dial.
+   */
+  grind_setting_step?: number;
+  /**
+   * Burr gap change per setting step, as stated by the maker or measured.
+   */
+  microns_per_step?: number;
+  /**
+   * Ground coffee left inside the grinder after grinding, in grams, as measured or stated by the maker.
+   */
+  retention_g?: number;
+  /**
+   * Lowest motor speed in revolutions per minute.
+   */
+  rpm_min?: number;
+  /**
+   * Highest motor speed in revolutions per minute. Equal to rpm_min for fixed-speed grinders.
+   */
+  rpm_max?: number;
+}
+export interface EquipmentBrewer {
+  /**
+   * How water and coffee meet; matches brew method categories.
+   */
+  mechanism?: "percolation" | "immersion" | "hybrid" | "press" | "vacuum" | "boiling" | "other";
+  /**
+   * Largest amount of brewed coffee it holds or makes at once, in millilitres.
+   */
+  capacity_ml?: number;
+  /**
+   * Nominal number of cups the maker states.
+   */
+  cup_capacity?: number;
+  /**
+   * What the brewer is made of; list every material sold under this model, such as ceramic and plastic.
+   */
+  material?: (
+    | "ceramic"
+    | "glass"
+    | "plastic"
+    | "stainless_steel"
+    | "copper"
+    | "aluminium"
+    | "porcelain"
+    | "wood"
+    | "silicone"
+    | "other"
+  )[];
+  /**
+   * Filter shape or size, e.g. cone_02, flat_185, chemex_6cup, aeropress_round, metal_mesh.
+   */
+  filter_format?: string;
+  /**
+   * Shape of the filter it uses. cone: pointed cone; flat_bottom: flat base, for example wave filters; basket: basket-shaped paper filter used in drip machines; disc: round disc, as in AeroPress; none: no separate filter.
+   */
+  filter_shape?: "cone" | "flat_bottom" | "basket" | "disc" | "none";
+  /**
+   * How fast water drains. fixed: set by the design; manual_valve: a valve or switch you open and close; programmable: controlled by the machine.
+   */
+  flow_control?: "fixed" | "manual_valve" | "programmable";
+  /**
+   * manual: you pour or press by hand; electric: a machine heats and pours the water; stovetop: heated on a hob, such as a moka pot.
+   */
+  drive?: "manual" | "electric" | "stovetop";
+}
+export interface EquipmentKettle {
+  /**
+   * Largest amount of water it holds, in millilitres.
+   */
+  capacity_ml?: number;
+  /**
+   * gooseneck: thin curved spout for a slow, precise pour; standard: ordinary spout; other: anything else.
+   */
+  spout_type?: "gooseneck" | "standard" | "other";
+  /**
+   * none: just boils; fixed: a few preset temperatures; adjustable: any temperature in a range can be set.
+   */
+  temperature_control?: "none" | "fixed" | "adjustable";
+  /**
+   * Lowest temperature that can be set, in degrees Celsius.
+   */
+  temperature_min_celsius?: number;
+  /**
+   * Highest temperature that can be set, in degrees Celsius.
+   */
+  temperature_max_celsius?: number;
+  /**
+   * Whether the kettle can keep water at the set temperature. true: can hold; false: confirmed cannot hold; absent: unknown.
+   */
+  supports_temperature_hold?: boolean;
+  /**
+   * electric: has its own heating base; stovetop: heated on a hob; induction_compatible: stovetop kettle that also works on induction hobs; other: anything else.
+   */
+  heat_source?: "electric" | "stovetop" | "induction_compatible" | "other";
+}
+export interface EquipmentScale {
+  /**
+   * Smallest weight step the display shows, in grams, for example 0.1.
+   */
+  resolution_g?: number;
+  /**
+   * Largest weight the scale can measure, in grams.
+   */
+  capacity_g?: number;
+  /**
+   * Built-in timer. true: has one; false: confirmed none; absent: unknown.
+   */
+  has_timer?: boolean;
+  /**
+   * Sets itself to zero when a cup or brewer is put on. true: supported; false: confirmed not supported; absent: unknown.
+   */
+  supports_auto_tare?: boolean;
+  /**
+   * Starts the timer by itself when liquid starts to flow or water is poured. true: supported; false: confirmed not supported; absent: unknown.
+   */
+  supports_auto_timer?: boolean;
+  /**
+   * Shows how fast weight changes, in grams per second. true: shown; false: confirmed not shown; absent: unknown.
+   */
+  has_flow_rate_display?: boolean;
+  /**
+   * Wireless or wired connections to apps or machines: bluetooth, wifi or usb.
+   */
+  connectivity?: ("bluetooth" | "wifi" | "usb")[];
+}
+export interface EquipmentTamper {
+  /**
+   * Diameter of the tamper base in millimetres, for example 58.
+   */
+  diameter_mm?: number;
+  /**
+   * none: the user decides how hard to press; fixed: a spring gives a set force; adjustable: the spring force can be set.
+   */
+  force_control?: "none" | "fixed" | "adjustable";
+  /**
+   * Shape of the pressing surface. flat; convex: slightly curved outward; rippled: grooved surface; other: anything else.
+   */
+  base_shape?: "flat" | "convex" | "rippled" | "other";
+  /**
+   * Whether the tamper sits on the basket rim so it always presses level. true: self-levelling; false: confirmed not self-levelling; absent: unknown.
+   */
+  self_leveling?: boolean;
+}
+export interface EquipmentWdt {
+  /**
+   * Thickness of each needle in millimetres, for example 0.3.
+   */
+  needle_diameter_mm?: number;
+  /**
+   * Number of needles.
+   */
+  needle_count?: number;
+  /**
+   * Whether you can limit how deep the needles reach. none: no limit; fixed: set depth; adjustable: depth can be set.
+   */
+  depth_control?: "none" | "fixed" | "adjustable";
+}
+export interface EquipmentBasket {
+  /**
+   * single, double or triple: the shot size the basket is made for; other: anything else.
+   */
+  kind?: "single" | "double" | "triple" | "other";
+  /**
+   * Diameter of the basket in millimetres, for example 58.
+   */
+  diameter_mm?: number;
+  /**
+   * Dose of ground coffee the basket is designed for, in grams.
+   */
+  nominal_dose_g?: number;
+  /**
+   * Smallest recommended dose in grams.
+   */
+  dose_min_g?: number;
+  /**
+   * Largest recommended dose in grams.
+   */
+  dose_max_g?: number;
+  /**
+   * A pressurised basket has a single small exit hole that builds pressure even with a coarse grind. true: pressurised; false: standard unpressurised basket; absent: unknown.
+   */
+  pressurized?: boolean;
+  /**
+   * A precision basket has tightly controlled hole sizes, sold for consistent extraction. true: precision basket; false: ordinary basket; absent: unknown.
+   */
+  precision?: boolean;
+}
+
+export declare const SCHEMA_IDS: {
+  "coffee-places": {
+    "latest": "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.4.0.json",
+    "versions": {
+      "0.1.0": "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.1.0.json",
+      "0.2.0": "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.2.0.json",
+      "0.3.0": "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.3.0.json",
+      "0.4.0": "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.4.0.json"
+    }
+  },
+  "brew-methods": {
+    "latest": "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.4.0.json",
+    "versions": {
+      "0.1.0": "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.1.0.json",
+      "0.2.0": "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.2.0.json",
+      "0.3.0": "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.3.0.json",
+      "0.4.0": "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.4.0.json"
+    }
+  },
+  "equipment": {
+    "latest": "https://schema.roastbook.coffee/equipment/equipment.schema.v0.4.0.json",
+    "versions": {
+      "0.1.0": "https://schema.roastbook.coffee/equipment/equipment.schema.v0.1.0.json",
+      "0.2.0": "https://schema.roastbook.coffee/equipment/equipment.schema.v0.2.0.json",
+      "0.3.0": "https://schema.roastbook.coffee/equipment/equipment.schema.v0.3.0.json",
+      "0.4.0": "https://schema.roastbook.coffee/equipment/equipment.schema.v0.4.0.json"
+    }
+  },
+  "common": {
+    "latest": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json",
+    "versions": {
+      "0.1.0": "https://schema.roastbook.coffee/common/common.schema.v0.1.0.json",
+      "0.2.0": "https://schema.roastbook.coffee/common/common.schema.v0.2.0.json",
+      "0.3.0": "https://schema.roastbook.coffee/common/common.schema.v0.3.0.json",
+      "0.4.0": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json"
+    }
+  }
+};
+export declare const BREW_METHOD_CATEGORY_VALUES: readonly ["espresso", "filter", "immersion", "pressure", "vacuum", "boiling", "cold"];
+export declare const BREW_METHOD_EXTRACTION_VALUES: readonly ["percolation", "immersion", "hybrid"];
+export declare const BREW_METHOD_FILTER_TYPES_VALUES: readonly ["paper", "metal", "cloth", "none"];
+export declare const BREW_PARAMETER_VALUES: readonly ["dose_g", "brew_water_g", "yield_g", "brew_ratio", "yield_ratio", "grind_setting", "brew_time_seconds", "target_time_seconds", "brew_temperature_celsius", "bloom_time_seconds", "bloom_water_g", "preinfusion_time_seconds", "preinfusion_pressure_bar", "brew_pressure_bar", "flow_rate_ml_per_second", "tamp_force_kg", "uses_puck_screen", "paper_filter_position", "distribution_method", "pour_count", "steep_time_seconds"];
+export declare const COFFEE_PLACE_FOOD_FOCUS_VALUES: readonly ["coffee_led", "food_led", "balanced"];
+export declare const COFFEE_PLACE_GOOD_FOR_VALUES: readonly ["working", "meetings", "quick_espresso", "takeaway", "brunch", "groups", "reading", "date", "coffee_nerds", "families"];
+export declare const COFFEE_PLACE_STATUS_VALUES: readonly ["open", "temporarily_closed", "closed", "unverified"];
+export declare const COFFEE_PLACE_TYPE_VALUES: readonly ["CafeOrCoffeeShop"];
+export declare const DISTRIBUTION_METHOD_VALUES: readonly ["wdt", "blind_shaker", "distribution_tool", "stockfleth_move"];
+export declare const EQUIPMENT_BASKET_KIND_VALUES: readonly ["single", "double", "triple", "other"];
+export declare const EQUIPMENT_BREWER_DRIVE_VALUES: readonly ["manual", "electric", "stovetop"];
+export declare const EQUIPMENT_BREWER_FILTER_SHAPE_VALUES: readonly ["cone", "flat_bottom", "basket", "disc", "none"];
+export declare const EQUIPMENT_BREWER_FLOW_CONTROL_VALUES: readonly ["fixed", "manual_valve", "programmable"];
+export declare const EQUIPMENT_BREWER_MATERIAL_VALUES: readonly ["ceramic", "glass", "plastic", "stainless_steel", "copper", "aluminium", "porcelain", "wood", "silicone", "other"];
+export declare const EQUIPMENT_BREWER_MECHANISM_VALUES: readonly ["percolation", "immersion", "hybrid", "press", "vacuum", "boiling", "other"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_CONNECTIVITY_VALUES: readonly ["bluetooth", "wifi", "usb"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_FLOW_CONTROL_VALUES: readonly ["none", "manual", "programmable"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_GROUP_TYPE_VALUES: readonly ["e61", "saturated", "semi_saturated", "lever", "integrated", "other"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_HEATING_ARCHITECTURE_VALUES: readonly ["single_boiler", "heat_exchanger", "dual_boiler", "multi_boiler", "single_thermoblock", "dual_thermoblock", "hybrid", "manual", "other"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_PREINFUSION_CONTROL_VALUES: readonly ["none", "supported", "fixed", "adjustable", "programmable"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_PRESSURE_CONTROL_VALUES: readonly ["fixed", "adjustable_opv", "manual", "programmable"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_PUMP_TYPE_VALUES: readonly ["vibration", "rotary", "gear", "peristaltic", "manual", "other"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_SHOT_STOP_MODES_VALUES: readonly ["manual", "weight", "time", "volume"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_STEAM_SYSTEM_VALUES: readonly ["none", "shared_heater", "dedicated_heater"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_TEMPERATURE_CONTROL_VALUES: readonly ["none", "fixed", "adjustable", "programmable"];
+export declare const EQUIPMENT_ESPRESSO_MACHINE_WATER_SOURCE_MODES_VALUES: readonly ["reservoir", "plumbed"];
+export declare const EQUIPMENT_GRINDER_ADJUSTMENT_TYPE_VALUES: readonly ["fixed", "stepped", "stepless"];
+export declare const EQUIPMENT_GRINDER_BEAN_FEED_VALUES: readonly ["single_dose", "hopper", "both"];
+export declare const EQUIPMENT_GRINDER_BREW_RANGE_VALUES: readonly ["espresso", "filter", "turkish"];
+export declare const EQUIPMENT_GRINDER_BURR_MATERIAL_VALUES: readonly ["steel", "ceramic", "titanium_coated", "other"];
+export declare const EQUIPMENT_GRINDER_BURR_MECHANISM_VALUES: readonly ["conical", "flat", "ghost", "roller", "blade", "other"];
+export declare const EQUIPMENT_GRINDER_DOSE_CONTROL_MODES_VALUES: readonly ["manual", "time", "weight"];
+export declare const EQUIPMENT_GRINDER_DRIVE_VALUES: readonly ["manual", "electric"];
+export declare const EQUIPMENT_GRINDER_GRIND_SETTING_FORMAT_VALUES: readonly ["whole_number", "decimal", "string"];
+export declare const EQUIPMENT_KETTLE_HEAT_SOURCE_VALUES: readonly ["electric", "stovetop", "induction_compatible", "other"];
+export declare const EQUIPMENT_KETTLE_SPOUT_TYPE_VALUES: readonly ["gooseneck", "standard", "other"];
+export declare const EQUIPMENT_KETTLE_TEMPERATURE_CONTROL_VALUES: readonly ["none", "fixed", "adjustable"];
+export declare const EQUIPMENT_SCALE_CONNECTIVITY_VALUES: readonly ["bluetooth", "wifi", "usb"];
+export declare const EQUIPMENT_TAMPER_BASE_SHAPE_VALUES: readonly ["flat", "convex", "rippled", "other"];
+export declare const EQUIPMENT_TAMPER_FORCE_CONTROL_VALUES: readonly ["none", "fixed", "adjustable"];
+export declare const EQUIPMENT_TYPE_VALUES: readonly ["espresso_machine", "espresso_machine_with_grinder", "grinder", "brewer", "kettle", "scale", "tamper", "wdt", "basket", "filter", "roaster", "milk_frother", "accessory"];
+export declare const EQUIPMENT_WDT_DEPTH_CONTROL_VALUES: readonly ["none", "fixed", "adjustable"];
+export declare const GRIND_SIZE_VALUES: readonly ["extra_fine", "fine", "medium_fine", "medium", "medium_coarse", "coarse", "extra_coarse"];
+export declare const PAPER_FILTER_POSITION_VALUES: readonly ["none", "top", "bottom", "both"];
+export declare const SPECIALTY_TIER_VALUES: readonly ["A", "B", "none", "unknown"];
+/** Validator for the "iri" format used by URL fields, which ajv-formats lacks: ajv.addFormat("iri", isIri). */
+export declare function isIri(value: unknown): boolean;