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

package/index.js

@@ -0,0 +1,94 @@
+// Generated by scripts/build-package.ts. Do not edit.
+export 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 const BREW_METHOD_CATEGORY_VALUES = ["espresso","filter","immersion","pressure","vacuum","boiling","cold"];
+export const BREW_METHOD_EXTRACTION_VALUES = ["percolation","immersion","hybrid"];
+export const BREW_METHOD_FILTER_TYPES_VALUES = ["paper","metal","cloth","none"];
+export const BREW_PARAMETER_VALUES = ["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 const COFFEE_PLACE_FOOD_FOCUS_VALUES = ["coffee_led","food_led","balanced"];
+export const COFFEE_PLACE_GOOD_FOR_VALUES = ["working","meetings","quick_espresso","takeaway","brunch","groups","reading","date","coffee_nerds","families"];
+export const COFFEE_PLACE_STATUS_VALUES = ["open","temporarily_closed","closed","unverified"];
+export const COFFEE_PLACE_TYPE_VALUES = ["CafeOrCoffeeShop"];
+export const DISTRIBUTION_METHOD_VALUES = ["wdt","blind_shaker","distribution_tool","stockfleth_move"];
+export const EQUIPMENT_BASKET_KIND_VALUES = ["single","double","triple","other"];
+export const EQUIPMENT_BREWER_DRIVE_VALUES = ["manual","electric","stovetop"];
+export const EQUIPMENT_BREWER_FILTER_SHAPE_VALUES = ["cone","flat_bottom","basket","disc","none"];
+export const EQUIPMENT_BREWER_FLOW_CONTROL_VALUES = ["fixed","manual_valve","programmable"];
+export const EQUIPMENT_BREWER_MATERIAL_VALUES = ["ceramic","glass","plastic","stainless_steel","copper","aluminium","porcelain","wood","silicone","other"];
+export const EQUIPMENT_BREWER_MECHANISM_VALUES = ["percolation","immersion","hybrid","press","vacuum","boiling","other"];
+export const EQUIPMENT_ESPRESSO_MACHINE_CONNECTIVITY_VALUES = ["bluetooth","wifi","usb"];
+export const EQUIPMENT_ESPRESSO_MACHINE_FLOW_CONTROL_VALUES = ["none","manual","programmable"];
+export const EQUIPMENT_ESPRESSO_MACHINE_GROUP_TYPE_VALUES = ["e61","saturated","semi_saturated","lever","integrated","other"];
+export const EQUIPMENT_ESPRESSO_MACHINE_HEATING_ARCHITECTURE_VALUES = ["single_boiler","heat_exchanger","dual_boiler","multi_boiler","single_thermoblock","dual_thermoblock","hybrid","manual","other"];
+export const EQUIPMENT_ESPRESSO_MACHINE_PREINFUSION_CONTROL_VALUES = ["none","supported","fixed","adjustable","programmable"];
+export const EQUIPMENT_ESPRESSO_MACHINE_PRESSURE_CONTROL_VALUES = ["fixed","adjustable_opv","manual","programmable"];
+export const EQUIPMENT_ESPRESSO_MACHINE_PUMP_TYPE_VALUES = ["vibration","rotary","gear","peristaltic","manual","other"];
+export const EQUIPMENT_ESPRESSO_MACHINE_SHOT_STOP_MODES_VALUES = ["manual","weight","time","volume"];
+export const EQUIPMENT_ESPRESSO_MACHINE_STEAM_SYSTEM_VALUES = ["none","shared_heater","dedicated_heater"];
+export const EQUIPMENT_ESPRESSO_MACHINE_TEMPERATURE_CONTROL_VALUES = ["none","fixed","adjustable","programmable"];
+export const EQUIPMENT_ESPRESSO_MACHINE_WATER_SOURCE_MODES_VALUES = ["reservoir","plumbed"];
+export const EQUIPMENT_GRINDER_ADJUSTMENT_TYPE_VALUES = ["fixed","stepped","stepless"];
+export const EQUIPMENT_GRINDER_BEAN_FEED_VALUES = ["single_dose","hopper","both"];
+export const EQUIPMENT_GRINDER_BREW_RANGE_VALUES = ["espresso","filter","turkish"];
+export const EQUIPMENT_GRINDER_BURR_MATERIAL_VALUES = ["steel","ceramic","titanium_coated","other"];
+export const EQUIPMENT_GRINDER_BURR_MECHANISM_VALUES = ["conical","flat","ghost","roller","blade","other"];
+export const EQUIPMENT_GRINDER_DOSE_CONTROL_MODES_VALUES = ["manual","time","weight"];
+export const EQUIPMENT_GRINDER_DRIVE_VALUES = ["manual","electric"];
+export const EQUIPMENT_GRINDER_GRIND_SETTING_FORMAT_VALUES = ["whole_number","decimal","string"];
+export const EQUIPMENT_KETTLE_HEAT_SOURCE_VALUES = ["electric","stovetop","induction_compatible","other"];
+export const EQUIPMENT_KETTLE_SPOUT_TYPE_VALUES = ["gooseneck","standard","other"];
+export const EQUIPMENT_KETTLE_TEMPERATURE_CONTROL_VALUES = ["none","fixed","adjustable"];
+export const EQUIPMENT_SCALE_CONNECTIVITY_VALUES = ["bluetooth","wifi","usb"];
+export const EQUIPMENT_TAMPER_BASE_SHAPE_VALUES = ["flat","convex","rippled","other"];
+export const EQUIPMENT_TAMPER_FORCE_CONTROL_VALUES = ["none","fixed","adjustable"];
+export const EQUIPMENT_TYPE_VALUES = ["espresso_machine","espresso_machine_with_grinder","grinder","brewer","kettle","scale","tamper","wdt","basket","filter","roaster","milk_frother","accessory"];
+export const EQUIPMENT_WDT_DEPTH_CONTROL_VALUES = ["none","fixed","adjustable"];
+export const GRIND_SIZE_VALUES = ["extra_fine","fine","medium_fine","medium","medium_coarse","coarse","extra_coarse"];
+export const PAPER_FILTER_POSITION_VALUES = ["none","top","bottom","both"];
+export const SPECIALTY_TIER_VALUES = ["A","B","none","unknown"];
+/** Validator for the "iri" format, which ajv-formats lacks: ajv.addFormat("iri", isIri). */
+export function isIri(value) {
+  if (typeof value !== "string" || !/^[A-Za-z][A-Za-z0-9+.-]*:[^\s<>"{}|\\^`\u0000-\u001f\u007f]+$/.test(value))
+    return !1;
+  try {
+    return Boolean(new URL(value));
+  } catch {
+    return !1;
+  }
+}

package/package.json

@@ -1,6 +1,69 @@
 {
   "name": "@roastbook/open-coffee-schema",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.4.0",
+  "description": "TypeScript types, JSON Schemas, JSON-LD context and allowed values of the Open Coffee standard (coffee places, equipment, brew methods). By Roastbook.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Roastbook/open-coffee-schema",
+    "directory": "packages/schema"
+  },
+  "homepage": "https://schema.roastbook.coffee/",
+  "bugs": "https://github.com/Roastbook/open-coffee-schema/issues",
+  "keywords": [
+    "open-coffee",
+    "roastbook",
+    "json-schema",
+    "json-ld",
+    "schema-org",
+    "coffee",
+    "specialty-coffee",
+    "cafes",
+    "open-data",
+    "typescript"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public",
+    "provenance": true
+  },
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./schemas": {
+      "types": "./schemas.d.ts",
+      "default": "./schemas.js"
+    },
+    "./package.json": "./package.json",
+    "./coffee-places/v0.1.0.json": "./coffee-places/v0.1.0.json",
+    "./coffee-places/v0.2.0.json": "./coffee-places/v0.2.0.json",
+    "./coffee-places/v0.3.0.json": "./coffee-places/v0.3.0.json",
+    "./coffee-places/v0.4.0.json": "./coffee-places/v0.4.0.json",
+    "./coffee-places/latest.json": "./coffee-places/latest.json",
+    "./brew-methods/v0.1.0.json": "./brew-methods/v0.1.0.json",
+    "./brew-methods/v0.2.0.json": "./brew-methods/v0.2.0.json",
+    "./brew-methods/v0.3.0.json": "./brew-methods/v0.3.0.json",
+    "./brew-methods/v0.4.0.json": "./brew-methods/v0.4.0.json",
+    "./brew-methods/latest.json": "./brew-methods/latest.json",
+    "./equipment/v0.1.0.json": "./equipment/v0.1.0.json",
+    "./equipment/v0.2.0.json": "./equipment/v0.2.0.json",
+    "./equipment/v0.3.0.json": "./equipment/v0.3.0.json",
+    "./equipment/v0.4.0.json": "./equipment/v0.4.0.json",
+    "./equipment/latest.json": "./equipment/latest.json",
+    "./common/v0.1.0.json": "./common/v0.1.0.json",
+    "./common/v0.2.0.json": "./common/v0.2.0.json",
+    "./common/v0.3.0.json": "./common/v0.3.0.json",
+    "./common/v0.4.0.json": "./common/v0.4.0.json",
+    "./common/latest.json": "./common/latest.json",
+    "./coffee-places/context.v0.1.0.json": "./coffee-places/context.v0.1.0.json",
+    "./coffee-places/context.v0.3.0.json": "./coffee-places/context.v0.3.0.json",
+    "./coffee-places/context.v0.4.0.json": "./coffee-places/context.v0.4.0.json",
+    "./coffee-places/context.latest.json": "./coffee-places/context.latest.json"
+  },
+  "main": "./index.js",
+  "types": "./index.d.ts"
+}

package/schemas.d.ts

@@ -0,0 +1,5 @@
+// Generated by scripts/build-package.ts. Do not edit.
+export type SchemaId = "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.1.0.json" | "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.2.0.json" | "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.3.0.json" | "https://schema.roastbook.coffee/brew-methods/brew-methods.schema.v0.4.0.json" | "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.1.0.json" | "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.2.0.json" | "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.3.0.json" | "https://schema.roastbook.coffee/coffee-places/coffee-places.schema.v0.4.0.json" | "https://schema.roastbook.coffee/common/common.schema.v0.1.0.json" | "https://schema.roastbook.coffee/common/common.schema.v0.2.0.json" | "https://schema.roastbook.coffee/common/common.schema.v0.3.0.json" | "https://schema.roastbook.coffee/common/common.schema.v0.4.0.json" | "https://schema.roastbook.coffee/equipment/equipment.schema.v0.1.0.json" | "https://schema.roastbook.coffee/equipment/equipment.schema.v0.2.0.json" | "https://schema.roastbook.coffee/equipment/equipment.schema.v0.3.0.json" | "https://schema.roastbook.coffee/equipment/equipment.schema.v0.4.0.json";
+/** Every schema version, keyed by $id. Add them all to Ajv, then validate against an $id. */
+export declare const schemas: Record<SchemaId, Record<string, unknown>>;
+export default schemas;