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

package/brew-methods/v0.4.0.json

@@ -0,0 +1,312 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.4.0.json",
+  "title": "Open Coffee brew methods",
+  "description": "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.",
+  "type": "object",
+  "required": [
+    "$schema",
+    "meta",
+    "brew_methods"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "pattern": "^https://schema\\.roastbook\\.coffee/brew-methods/brew-methods\\.schema\\.v[0-9]+\\.[0-9]+\\.[0-9]+\\.json$",
+      "description": "Canonical URL of the schema version this file follows."
+    },
+    "meta": {
+      "type": "object",
+      "$ref": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json#/$defs/dataset_meta",
+      "unevaluatedProperties": false
+    },
+    "brew_methods": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/brew_method"
+      }
+    }
+  },
+  "$defs": {
+    "range": {
+      "title": "Range",
+      "type": "object",
+      "additionalProperties": false,
+      "minProperties": 1,
+      "properties": {
+        "min": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Lowest common value, in the unit named by the parameter (for example grams for dose_g, degrees Celsius for brew_temperature_celsius)."
+        },
+        "max": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Highest common value, in the unit named by the parameter."
+        },
+        "typical": {
+          "type": "number",
+          "minimum": 0,
+          "description": "A good starting value, in the unit named by the parameter."
+        }
+      },
+      "description": "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."
+    },
+    "parameter": {
+      "title": "Brew parameter",
+      "enum": [
+        "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"
+      ],
+      "description": "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."
+    },
+    "grind_size": {
+      "title": "Grind size",
+      "enum": [
+        "extra_fine",
+        "fine",
+        "medium_fine",
+        "medium",
+        "medium_coarse",
+        "coarse",
+        "extra_coarse"
+      ],
+      "description": "Descriptive grind size; extra_fine is Turkish, fine espresso, medium filter, coarse French press and cold brew."
+    },
+    "paper_filter_position": {
+      "title": "Paper filter position",
+      "enum": [
+        "none",
+        "top",
+        "bottom",
+        "both"
+      ],
+      "description": "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."
+    },
+    "distribution_method": {
+      "title": "Distribution method",
+      "enum": [
+        "wdt",
+        "blind_shaker",
+        "distribution_tool",
+        "stockfleth_move"
+      ],
+      "description": "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."
+    },
+    "brew_method": {
+      "title": "Brew method",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "category",
+        "extraction",
+        "description",
+        "checked_at"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json#/$defs/id",
+          "description": "Stable readable slug, e.g. v60, french-press. Never reused.",
+          "examples": [
+            "v60"
+          ]
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Common English name of the method, for example Pour-over or French press."
+        },
+        "aliases": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Other names in any language, e.g. Filterkaffee, drip."
+        },
+        "parent": {
+          "$ref": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json#/$defs/id",
+          "description": "The more general method, e.g. pour-over for v60."
+        },
+        "category": {
+          "enum": [
+            "espresso",
+            "filter",
+            "immersion",
+            "pressure",
+            "vacuum",
+            "boiling",
+            "cold"
+          ],
+          "description": "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)."
+        },
+        "extraction": {
+          "enum": [
+            "percolation",
+            "immersion",
+            "hybrid"
+          ],
+          "description": "Physical principle; matches equipment brewer.mechanism."
+        },
+        "description": {
+          "type": "string",
+          "minLength": 20,
+          "maxLength": 600,
+          "description": "Short neutral explanation in our own words."
+        },
+        "introduced_year": {
+          "type": "integer",
+          "minimum": 1000,
+          "maximum": 2100,
+          "description": "Year the method or device was invented or first sold."
+        },
+        "origin_country_code": {
+          "$ref": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json#/$defs/country_code"
+        },
+        "equipment_types": {
+          "type": "array",
+          "uniqueItems": true,
+          "description": "Equipment types needed, from the equipment schema's type list.",
+          "items": {
+            "$ref": "https://schema.roastbook.coffee/equipment/equipment.schema.v0.4.0.json#/$defs/type"
+          }
+        },
+        "typical_parameters": {
+          "title": "Typical parameters",
+          "type": "object",
+          "additionalProperties": false,
+          "description": "Common starting ranges, not rules.",
+          "properties": {
+            "dose_g": {
+              "$ref": "#/$defs/range"
+            },
+            "brew_ratio": {
+              "$ref": "#/$defs/range",
+              "description": "Grams of brew water per gram of coffee, for example 16 for 1:16. Used for filter, immersion and cold brew. A journal that keeps one ratio and a basis puts the ratio here when the basis is brew water (Roastbook: ratioBasis brew_water)."
+            },
+            "yield_ratio": {
+              "$ref": "#/$defs/range",
+              "description": "Grams of drink in the cup per gram of coffee, for example 2 for a 1:2 espresso. Used where the drink is weighed, mainly espresso. A journal that keeps one ratio and a basis puts the ratio here when the basis is the yield (Roastbook: ratioBasis target_yield)."
+            },
+            "brew_temperature_celsius": {
+              "$ref": "#/$defs/range",
+              "description": "Temperature of the brew water, in degrees Celsius."
+            },
+            "brew_time_seconds": {
+              "$ref": "#/$defs/range"
+            },
+            "brew_pressure_bar": {
+              "$ref": "#/$defs/range"
+            },
+            "grind_size": {
+              "type": "array",
+              "uniqueItems": true,
+              "minItems": 1,
+              "items": {
+                "$ref": "#/$defs/grind_size"
+              }
+            },
+            "grind_d50_microns": {
+              "$ref": "#/$defs/range",
+              "description": "Median particle size in micrometres, comparable across grinders."
+            },
+            "paper_filter_position": {
+              "type": "array",
+              "uniqueItems": true,
+              "minItems": 1,
+              "items": {
+                "$ref": "#/$defs/paper_filter_position"
+              },
+              "description": "Paper filter positions commonly used with this method."
+            },
+            "distribution_method": {
+              "type": "array",
+              "uniqueItems": true,
+              "minItems": 1,
+              "items": {
+                "$ref": "#/$defs/distribution_method"
+              },
+              "description": "Distribution methods commonly used with this method."
+            }
+          }
+        },
+        "recorded_parameters": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/$defs/parameter"
+          },
+          "description": "Parameters a coffee journal should offer when logging a brew with this method."
+        },
+        "typical_drinks": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Drinks usually made with this method, in plain lowercase English, for example espresso, cappuccino or flat white."
+        },
+        "xref": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "wikidata": {
+              "type": "string",
+              "pattern": "^Q[1-9][0-9]*$",
+              "description": "Wikidata item id of the method, for example Q180289 for espresso."
+            },
+            "beanconqueror": {
+              "type": "string",
+              "pattern": "^[A-Z0-9_]+$",
+              "description": "Beanconqueror PREPARATION_TYPES key, for app imports."
+            }
+          },
+          "description": "Identifiers of the method in other datasets and apps."
+        },
+        "image": {
+          "$ref": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json#/$defs/image"
+        },
+        "checked_at": {
+          "$ref": "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json#/$defs/datetime"
+        },
+        "filter_types": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "enum": [
+              "paper",
+              "metal",
+              "cloth",
+              "none"
+            ]
+          },
+          "description": "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)."
+        }
+      }
+    }
+  }
+}

package/coffee-places/context.latest.json

@@ -0,0 +1,246 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "@base": "https://data.roastbook.coffee/places/",
+    "schema": "https://schema.org/",
+    "oc": "https://schema.roastbook.coffee/vocab#",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "dcterms": "http://purl.org/dc/terms/",
+    "CafeOrCoffeeShop": "schema:CafeOrCoffeeShop",
+    "$schema": {
+      "@id": "dcterms:conformsTo",
+      "@type": "@id"
+    },
+    "meta": {
+      "@id": "oc:meta",
+      "@context": {
+        "licence": "schema:license",
+        "country_code": "schema:addressCountry",
+        "city": "oc:city",
+        "city_name": "oc:cityName"
+      }
+    },
+    "places": {
+      "@id": "schema:hasPart",
+      "@container": "@set"
+    },
+    "id": "@id",
+    "type": "@type",
+    "name": "schema:name",
+    "status": "oc:status",
+    "merged_into": {
+      "@id": "oc:mergedInto",
+      "@type": "@id"
+    },
+    "opened_on": {
+      "@id": "schema:foundingDate",
+      "@type": "xsd:date"
+    },
+    "closed_on": {
+      "@id": "schema:dissolutionDate",
+      "@type": "xsd:date"
+    },
+    "last_verified_at": {
+      "@id": "oc:lastVerifiedAt",
+      "@type": "xsd:dateTime"
+    },
+    "checked_at": {
+      "@id": "oc:checkedAt",
+      "@type": "xsd:dateTime"
+    },
+    "address": {
+      "@id": "schema:address",
+      "@context": {
+        "street_address": "schema:streetAddress",
+        "postal_code": "schema:postalCode",
+        "locality": "schema:addressLocality",
+        "region": "schema:addressRegion",
+        "country_code": "schema:addressCountry"
+      }
+    },
+    "location": {
+      "@id": "schema:geo",
+      "@context": {
+        "lat": {
+          "@id": "schema:latitude",
+          "@type": "xsd:double"
+        },
+        "lon": {
+          "@id": "schema:longitude",
+          "@type": "xsd:double"
+        }
+      }
+    },
+    "opening_hours": "schema:openingHours",
+    "description": "schema:description",
+    "specialty_tier": "oc:specialtyTier",
+    "roasts_own_beans": "oc:roastsOwnBeans",
+    "roasters_served": {
+      "@id": "oc:roastersServed",
+      "@container": "@set",
+      "@context": {
+        "roaster_id": "schema:identifier",
+        "url": {
+          "@id": "schema:url",
+          "@type": "@id"
+        },
+        "own": "oc:ownRoast"
+      }
+    },
+    "serving": {
+      "@id": "oc:serving",
+      "@context": {
+        "espresso": "oc:espresso",
+        "filter": "oc:filter",
+        "pour_over": "oc:pourOver",
+        "batch_brew": "oc:batchBrew",
+        "cold_brew": "oc:coldBrew",
+        "decaf": "oc:decaf",
+        "plant_milk": "oc:plantMilk"
+      }
+    },
+    "amenities": {
+      "@id": "oc:amenities",
+      "@context": {
+        "wifi": "oc:wifi",
+        "laptop_friendly": "oc:laptopFriendly",
+        "kids_friendly": "oc:kidsFriendly",
+        "vegan_options": "oc:veganOptions",
+        "dogs_allowed": "oc:dogsAllowed",
+        "outdoor_seating": "oc:outdoorSeating",
+        "card_payment": "oc:cardPayment",
+        "cash_only": "oc:cashOnly",
+        "wheelchair_accessible": "oc:wheelchairAccessible"
+      }
+    },
+    "food": {
+      "@id": "oc:food",
+      "@context": {
+        "focus": "oc:focus",
+        "breakfast": "oc:breakfast",
+        "lunch": "oc:lunch",
+        "cakes_baked_in_house": "oc:cakesBakedInHouse"
+      }
+    },
+    "sells_beans": "oc:sellsBeans",
+    "sells_equipment": "oc:sellsEquipment",
+    "offers_courses": "oc:offersCourses",
+    "reusable_cup_systems": {
+      "@id": "oc:reusableCupSystems",
+      "@container": "@set"
+    },
+    "good_for": {
+      "@id": "oc:goodFor",
+      "@container": "@set"
+    },
+    "awards": {
+      "@id": "oc:awards",
+      "@container": "@set",
+      "@context": {
+        "year": {
+          "@id": "oc:year",
+          "@type": "xsd:gYear"
+        },
+        "url": {
+          "@id": "schema:url",
+          "@type": "@id"
+        }
+      }
+    },
+    "prices": {
+      "@id": "oc:prices",
+      "@context": {
+        "cappuccino": {
+          "@id": "oc:cappuccinoPrice",
+          "@context": {
+            "amount": "schema:price",
+            "currency": "schema:priceCurrency",
+            "observed_on": {
+              "@id": "oc:observedOn",
+              "@type": "xsd:date"
+            },
+            "source_url": {
+              "@id": "schema:url",
+              "@type": "@id"
+            }
+          }
+        }
+      }
+    },
+    "operator": {
+      "@id": "oc:operator",
+      "@context": {
+        "name": "schema:legalName",
+        "legal_form": "oc:legalForm",
+        "register_id": "oc:registerId"
+      }
+    },
+    "links": "@nest",
+    "website": {
+      "@id": "schema:url",
+      "@type": "@id",
+      "@nest": "links"
+    },
+    "instagram": {
+      "@id": "schema:sameAs",
+      "@type": "@id",
+      "@nest": "links"
+    },
+    "facebook": {
+      "@id": "schema:sameAs",
+      "@type": "@id",
+      "@nest": "links"
+    },
+    "image": {
+      "@id": "schema:image",
+      "@context": {
+        "url": {
+          "@id": "schema:contentUrl",
+          "@type": "@id"
+        },
+        "licence": "schema:license",
+        "author": "schema:creditText",
+        "source_url": {
+          "@id": "schema:url",
+          "@type": "@id"
+        },
+        "title": "schema:name",
+        "width": "schema:width",
+        "height": "schema:height"
+      }
+    },
+    "xref": "@nest",
+    "overture": {
+      "@id": "oc:overtureId",
+      "@nest": "xref"
+    },
+    "foursquare": {
+      "@id": "oc:foursquareId",
+      "@nest": "xref"
+    },
+    "wikidata": {
+      "@id": "schema:sameAs",
+      "@type": "@vocab",
+      "@nest": "xref",
+      "@context": {
+        "@vocab": "http://www.wikidata.org/entity/"
+      }
+    },
+    "google_place_id": {
+      "@id": "oc:googlePlaceId",
+      "@nest": "xref"
+    },
+    "external_ratings": {
+      "@id": "oc:externalRatings",
+      "@container": "@set",
+      "@context": {
+        "source": "oc:source",
+        "id": "schema:identifier",
+        "url": {
+          "@id": "schema:url",
+          "@type": "@id"
+        }
+      }
+    }
+  }
+}