@simonarcher/fika-types 1.5.1 → 2.0.0-rc.1

package/dist/bean-scans.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Bag-scan event design surface (FIK-124 P1).
+ *
+ * NOTE: the `bean_scans` table is **not yet migrated**. This file is the
+ * type contract for the future bag-scan project — see
+ * `plans/bean-schema-redesign.md` (P1 — Bag-scan ready surface) for the SQL
+ * DDL and rationale.
+ *
+ * New types in this package use ISO string timestamps (Supabase / Postgres
+ * convention). Firebase-era types like `CoffeeBean` retain `Timestamp` for
+ * back-compat during the Firestore→Supabase migration window.
+ */
+/**
+ * What the user did with the scan after seeing the candidates.
+ *
+ * - `pending` — scan ingested, no user action yet
+ * - `saved` — user kept the matched bean (e.g. added to a list)
+ * - `tried` — user marked having drunk this bean
+ * - `rejected` — user said the match was wrong
+ * - `created_new` — user created a new bean record from this scan
+ */
+export type BeanScanAction = "pending" | "saved" | "tried" | "rejected" | "created_new";
+/**
+ * One row per user scan event. Powers the bag-scan loop: photograph →
+ * OCR + photo similarity → top-N candidate beans → user picks (or rejects).
+ */
+export interface BeanScan {
+    id: string;
+    userId?: string;
+    photoUrl: string;
+    ocrText?: string;
+    /**
+     * Top-N matcher candidates as inline jsonb. Promoted to a dedicated
+     * `bean_scan_candidates` table only when cross-scan analytics warrant it.
+     */
+    candidates?: Array<{
+        beanId: string;
+        score: number;
+        source: "ocr" | "vector" | "hybrid";
+    }>;
+    matchedBeanId?: string;
+    action: BeanScanAction;
+    deviceMeta?: Record<string, unknown>;
+    createdAt: string;
+    resolvedAt?: string;
+}

package/dist/bean-scans.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * Bag-scan event design surface (FIK-124 P1).
+ *
+ * NOTE: the `bean_scans` table is **not yet migrated**. This file is the
+ * type contract for the future bag-scan project — see
+ * `plans/bean-schema-redesign.md` (P1 — Bag-scan ready surface) for the SQL
+ * DDL and rationale.
+ *
+ * New types in this package use ISO string timestamps (Supabase / Postgres
+ * convention). Firebase-era types like `CoffeeBean` retain `Timestamp` for
+ * back-compat during the Firestore→Supabase migration window.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/coffee.d.ts

@@ -126,16 +126,31 @@ export type DecafMethod = "Swiss Water" | "Sugarcane / Ethyl Acetate" | "Carbon
 export declare const DECAF_METHODS: readonly ["Swiss Water", "Sugarcane / Ethyl Acetate", "Carbon Dioxide (CO₂)", "Methylene Chloride", "Mountain Water", "Unknown"];
 export type CoffeeProcessingMethod = "Washed (Wet)" | "Natural (Dry)" | "Honey" | "Anaerobic Fermentation" | "Carbonic Maceration" | "Wet-Hulled" | "Semi-Washed" | "Experimental / Other" | "Unknown";
 export type RoastLevel = "Light" | "Medium" | "Dark" | "Medium-Dark" | "Medium-Light" | "Espresso";
+/**
+ * Per-origin row on a bean. Mirrors `coffee_bean_origins`.
+ * Multiple origins = blend (use `blendPercentage` when documented).
+ */
 export interface Origin {
     countryCode: string;
     countryName?: string;
     region?: string;
     subregion?: string;
-    elevationMinMeters?: number;
-    elevationMaxMeters?: number;
+    altitudeMinM?: number;
+    altitudeMaxM?: number;
+    farmId?: string;
+    farmNameUnverified?: string;
+    producerName?: string;
+    tradeProgram?: string;
+    blendPercentage?: number;
 }
+/**
+ * Recipe-level bean record. Flat fields mirror `coffee_beans`; per-origin detail
+ * lives in `origins[]` (joined from `coffee_bean_origins`).
+ *
+ * Note: `varieties` here is recipe-level (what the roaster shipped). Farm-level
+ * varieties (what the farm grows) live on `Farm.varieties`.
+ */
 export interface CoffeeBean {
-    active: boolean;
     id: string;
     name: string;
     description?: string;
@@ -146,9 +161,10 @@ export interface CoffeeBean {
     origins?: Origin[];
     varieties?: string[];
     harvestYear?: number;
+    harvestPeriod?: string;
     lotName?: string;
     scaScore?: number;
-    roastLevel?: "Light" | "Medium-Light" | "Medium" | "Medium-Dark" | "Dark";
+    roastLevel?: RoastLevel;
     processing?: CoffeeProcessingMethod;
     processingDetails?: string;
     tastingNotes?: string[];
@@ -160,10 +176,16 @@ export interface CoffeeBean {
     farmerStory?: string;
     impactNotes?: string;
     awards?: string[];
+    certifications?: string[];
     limitedEdition?: boolean;
+    active: boolean;
     createdAt?: Timestamp;
     updatedAt?: Timestamp;
 }
+/**
+ * Submission payload for a proposed bean. Origins ride along via `submission_origins`
+ * once accepted; the server promotes them to `coffee_bean_origins` on approval.
+ */
 export interface SubmissionCoffeeBeanData {
     name: string;
     description?: string;

package/dist/coffeeEvents.d.ts

@@ -23,7 +23,6 @@ export interface CoffeeShopEvent extends NewCoffeeShopEvent {
     createdAt: Date;
     updatedAt: Date;
     eventType: CoffeeShopEventType;
-    rewardStickerId?: string | null;
 }
 export interface EventAttendee {
     userId: string;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './shop';
 export * from './coffee';
+export * from './bean-scans';
 export * from './farm';
 export * from './user';
 export * from './userList';

package/dist/index.js

@@ -16,8 +16,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // Export all shop-related types
 __exportStar(require("./shop"), exports);
-// Export all coffee-related types  
+// Export all coffee-related types
 __exportStar(require("./coffee"), exports);
+// Export bag-scan types (design surface; bean_scans table not yet migrated)
+__exportStar(require("./bean-scans"), exports);
 // Export all farm-related types
 __exportStar(require("./farm"), exports);
 // Export all user-related types

package/dist/shop.d.ts

@@ -256,21 +256,7 @@ export type ShopData = {
         completedAt?: AdminTimestamp;
         lastUpdated?: AdminTimestamp;
     };
-    ownerSectionVerifications?: OwnerSectionVerifications;
 };
-/** Stable section keys exposed in the owner portal and surfaced as "verified
- *  by owner" badges on user-facing apps. */
-export type OwnerSectionKey = 'hours' | 'about' | 'photos' | 'contact' | 'socials' | 'brew_methods' | 'roasters' | 'amenities' | 'specialties' | 'specialty_flags';
-export interface OwnerSectionVerification {
-    /** ISO-8601 timestamp of when the owner last attested this section. */
-    verifiedAt: string;
-    /** staff_invites.id of the token used (null if attributed to the
-     *  signed-in accepted_by user, post-claim). */
-    tokenId: string | null;
-    /** Email captured from the invite at attestation time. */
-    actorEmail: string | null;
-}
-export type OwnerSectionVerifications = Partial<Record<OwnerSectionKey, OwnerSectionVerification>>;
 export interface ShopCommunityStats {
     totalCheckIns: number;
     uniqueVisitors: number;
@@ -298,10 +284,6 @@ export interface DailyVisitorStats {
     updatedAt: AdminTimestamp;
 }
 export interface ShopInfo {
-    /** FIKA-curated public description. Mirrored to top-level `shop.about`. */
-    description?: string | null;
-    /** Owner-authored public note, edited through the owner portal. */
-    ownerDescription?: string | null;
     features: Partial<Record<ShopFeatureKey, boolean | null>> & Record<string, boolean | null>;
     wifiDetails?: {
         name?: string;
@@ -319,17 +301,6 @@ export interface ShopContactDetails {
     contactNumber: string;
     email: string;
     website: string;
-    /**
-     * Social media handles. Stored alongside other contact data so a shop has a
-     * single source of truth for "how to reach this place". Bare handles only —
-     * no `@` prefix, no URL — clients construct platform URLs at render time.
-     * Optional/nullable to keep records sparse for shops that don't publish a
-     * given platform.
-     */
-    instagram?: string | null;
-    facebook?: string | null;
-    tiktok?: string | null;
-    twitter?: string | null;
     address: {
         formattedAddress: string;
         shortFormattedAddress: string;
@@ -342,18 +313,9 @@ export interface ShopContactDetails {
     };
     updatedAt?: Date;
 }
-export type ShopFeatureKey = 'powerOutlets' | 'laptopFriendly' | 'outdoorSeating' | 'indoorSeating' | 'accessibility' | 'alcohol' | 'breakfast' | 'lunch' | 'vegetarian' | 'petFriendly' | 'kidFriendly' | 'restrooms' | 'parking' | 'wifi' | 'acceptsCash' | 'acceptsCreditCards' | 'acceptsNfc' | 'discountOnReusableCup' | 'glutenFree' | 'loyaltyCard' | 'takeaway' | 'delivery' | 'walkInOnly';
-export type FeatureGroupKey = 'Space & Seating' | 'Work & Facilities' | 'Food & Drink' | 'Service' | 'Payment';
-/** Maps each feature key to its display group. Single source of truth for admin and mobile. */
-export declare const featureGroupMap: Record<ShopFeatureKey, FeatureGroupKey>;
-/** Display labels for each feature key. Single source of truth for admin and mobile. */
-export declare const featureLabelMap: Record<ShopFeatureKey, string>;
-export type ShopSpecialtyKey = 'inHouseRoastery' | 'pourOverSpecialty' | 'espressoExpert' | 'singleOriginFocus' | 'rotatingRoasters' | 'tastingNotesOnMenu' | 'naturalFermentedFocus' | 'cuppingAndEducation' | 'cozyAmbiance' | 'bustlingEnergy' | 'espressoBarStanding' | 'vinylRecords' | 'uniqueExperience' | 'inHouseBakery' | 'freshPastries' | 'localBakeryPartner' | 'dessertDestination' | 'lgbtqFriendly' | 'womenOwned' | 'zeroWasteFocus' | 'communityHub' | 'laptopWelcome' | 'fastWifi' | 'longStayOk';
-export type SpecialtyCategoryKey = 'Coffee' | 'Atmosphere' | 'Food & Treats' | 'Identity & Values' | 'Workspace';
-/** Maps each specialty key to its category. Single source of truth for admin and mobile. */
-export declare const specialtyCategoryMap: Record<ShopSpecialtyKey, SpecialtyCategoryKey>;
-/** Display labels for each specialty key. Single source of truth for admin and mobile. */
-export declare const specialtyLabelMap: Record<ShopSpecialtyKey, string>;
+export type ShopFeatureKey = 'powerOutlets' | 'laptopFriendly' | 'outdoorSeating' | 'indoorSeating' | 'accessibility' | 'alcohol' | 'breakfast' | 'lunch' | 'vegetarian' | 'petFriendly' | 'restrooms' | 'parking' | 'wifi' | 'acceptsCash' | 'acceptsCreditCards' | 'acceptsNfc' | 'discountOnReusableCup' | 'glutenFree' | 'loyaltyCard' | 'takeaway' | 'delivery';
+export type ShopSpecialtyKey = 'pourOverSpecialty' | 'espressoExpert' | 'singleOriginFocus' | 'localRoaster' | 'brewingEducation' | 'cuppingEvents' | 'matchaSpecialty' | 'decafSpecialty' | 'inHouseRoastery' | 'relaxingVibes' | 'bustlingEnergy' | 'quietStudySpace' | 'uniqueExperience' | 'instagramWorthy' | 'cozyAmbiance' | 'freshPastries' | 'homemadeTreats' | 'artisanBread' | 'localBakery' | 'healthyOptions' | 'dessertDestination' | 'inHouseBakery' | 'signatureBakedGoods' | 'lgbtqFriendly' | 'womenOwned' | 'familyOwned' | 'communityHub' | 'sociallyConscious' | 'localArtSupport' | 'liveMusic' | 'localArt' | 'bookExchange' | 'boardGames' | 'culturalEvents' | 'workshopSpace' | 'laptopFriendlyPro' | 'meetingSpaceAvailable' | 'quietZones' | 'fastWifi' | 'longStayWelcome' | 'coworkingVibes';
+export type SpecialtyCategoryKey = 'Coffee Excellence' | 'Atmosphere' | 'Food & Treats' | 'Community & Values' | 'Entertainment' | 'Work & Study';
 export interface ShopSpecialties {
     highlighted: ShopSpecialtyKey[];
     additional: ShopSpecialtyKey[];

package/dist/shop.js

@@ -1,129 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.specialtyLabelMap = exports.specialtyCategoryMap = exports.featureLabelMap = exports.featureGroupMap = void 0;
-/** Maps each feature key to its display group. Single source of truth for admin and mobile. */
-exports.featureGroupMap = {
-    // Space & Seating
-    indoorSeating: 'Space & Seating',
-    outdoorSeating: 'Space & Seating',
-    petFriendly: 'Space & Seating',
-    kidFriendly: 'Space & Seating',
-    // Work & Facilities
-    wifi: 'Work & Facilities',
-    powerOutlets: 'Work & Facilities',
-    laptopFriendly: 'Work & Facilities',
-    restrooms: 'Work & Facilities',
-    parking: 'Work & Facilities',
-    accessibility: 'Work & Facilities',
-    // Food & Drink
-    breakfast: 'Food & Drink',
-    lunch: 'Food & Drink',
-    vegetarian: 'Food & Drink',
-    glutenFree: 'Food & Drink',
-    alcohol: 'Food & Drink',
-    // Service
-    takeaway: 'Service',
-    delivery: 'Service',
-    loyaltyCard: 'Service',
-    discountOnReusableCup: 'Service',
-    walkInOnly: 'Service',
-    // Payment
-    acceptsCash: 'Payment',
-    acceptsCreditCards: 'Payment',
-    acceptsNfc: 'Payment',
-};
-/** Display labels for each feature key. Single source of truth for admin and mobile. */
-exports.featureLabelMap = {
-    // Space & Seating
-    indoorSeating: 'Indoor Seating',
-    outdoorSeating: 'Outdoor Seating',
-    petFriendly: 'Pet Friendly',
-    kidFriendly: 'Kid Friendly',
-    // Work & Facilities
-    wifi: 'Free WiFi',
-    powerOutlets: 'Power Outlets',
-    laptopFriendly: 'Laptop Friendly',
-    restrooms: 'Restrooms',
-    parking: 'Parking',
-    accessibility: 'Wheelchair Accessible',
-    // Food & Drink
-    breakfast: 'Serves Breakfast',
-    lunch: 'Serves Lunch',
-    vegetarian: 'Vegetarian Options',
-    glutenFree: 'Gluten-Free Options',
-    alcohol: 'Serves Alcohol',
-    // Service
-    takeaway: 'Takeaway',
-    delivery: 'Delivery',
-    loyaltyCard: 'Loyalty Card',
-    discountOnReusableCup: 'Discount for Reusable Cup',
-    walkInOnly: 'Walk-In Only',
-    // Payment
-    acceptsCash: 'Cash Payments',
-    acceptsCreditCards: 'Card Payments',
-    acceptsNfc: 'Contactless / NFC',
-};
-/** Maps each specialty key to its category. Single source of truth for admin and mobile. */
-exports.specialtyCategoryMap = {
-    // Coffee
-    inHouseRoastery: 'Coffee',
-    pourOverSpecialty: 'Coffee',
-    espressoExpert: 'Coffee',
-    singleOriginFocus: 'Coffee',
-    rotatingRoasters: 'Coffee',
-    tastingNotesOnMenu: 'Coffee',
-    naturalFermentedFocus: 'Coffee',
-    cuppingAndEducation: 'Coffee',
-    // Atmosphere
-    cozyAmbiance: 'Atmosphere',
-    bustlingEnergy: 'Atmosphere',
-    espressoBarStanding: 'Atmosphere',
-    vinylRecords: 'Atmosphere',
-    uniqueExperience: 'Atmosphere',
-    // Food & Treats
-    inHouseBakery: 'Food & Treats',
-    freshPastries: 'Food & Treats',
-    localBakeryPartner: 'Food & Treats',
-    dessertDestination: 'Food & Treats',
-    // Identity & Values
-    lgbtqFriendly: 'Identity & Values',
-    womenOwned: 'Identity & Values',
-    zeroWasteFocus: 'Identity & Values',
-    communityHub: 'Identity & Values',
-    // Workspace
-    laptopWelcome: 'Workspace',
-    fastWifi: 'Workspace',
-    longStayOk: 'Workspace',
-};
-/** Display labels for each specialty key. Single source of truth for admin and mobile. */
-exports.specialtyLabelMap = {
-    // Coffee
-    inHouseRoastery: 'In-House Roastery',
-    pourOverSpecialty: 'Pour-Over / Filter Focus',
-    espressoExpert: 'Espresso Specialists',
-    singleOriginFocus: 'Single Origin Focus',
-    rotatingRoasters: 'Rotating / Guest Roasters',
-    tastingNotesOnMenu: 'Tasting Notes on Menu',
-    naturalFermentedFocus: 'Natural & Fermented Coffees',
-    cuppingAndEducation: 'Cuppings & Education',
-    // Atmosphere
-    cozyAmbiance: 'Cosy & Welcoming',
-    bustlingEnergy: 'Lively Atmosphere',
-    espressoBarStanding: 'Espresso Bar / Standing Only',
-    vinylRecords: 'Vinyl Records',
-    uniqueExperience: 'Unique Concept',
-    // Food & Treats
-    inHouseBakery: 'In-House Bakery',
-    freshPastries: 'Fresh Pastries',
-    localBakeryPartner: 'Local Bakery Partner',
-    dessertDestination: 'Dessert Destination',
-    // Identity & Values
-    lgbtqFriendly: 'LGBTQ+ Friendly',
-    womenOwned: 'Women Owned & Led',
-    zeroWasteFocus: 'Zero Waste Focused',
-    communityHub: 'Community Hub',
-    // Workspace
-    laptopWelcome: 'Laptop Welcome',
-    fastWifi: 'Fast WiFi',
-    longStayOk: 'Long Stay OK',
-};

package/dist/supabase-helpers.d.ts

@@ -20,17 +20,15 @@ export type DbFarm = Tables<"farms">;
 export type DbFranchise = Tables<"franchises">;
 export type DbCoffeeBean = Tables<"coffee_beans">;
 export type DbShopRoaster = Tables<"shop_roasters">;
-export type DbRoasterFarm = Tables<"roaster_farms">;
 export type DbFranchiseRoaster = Tables<"franchise_roasters">;
 export type DbShopBean = Tables<"shop_beans">;
 export type DbUserFollower = Tables<"user_followers">;
-export type DbShopFollower = Tables<"shop_followers">;
 export type DbShopFavourite = Tables<"shop_favourites">;
+export type DbCoffeeBeanOrigin = Tables<"coffee_bean_origins">;
+export type DbSubmissionOrigin = Tables<"submission_origins">;
 export type DbAction = Tables<"actions">;
 export type DbPoints = Tables<"points">;
 export type DbReward = Tables<"rewards">;
-export type DbShot = Tables<"shots">;
-export type DbShotLike = Tables<"shot_likes">;
 export type DbReview = Tables<"reviews">;
 export type DbVote = Tables<"votes">;
 export type DbAssertion = Tables<"assertions">;
@@ -80,17 +78,15 @@ export type NewFarm = TablesInsert<"farms">;
 export type NewFranchise = TablesInsert<"franchises">;
 export type NewCoffeeBean = TablesInsert<"coffee_beans">;
 export type NewShopRoaster = TablesInsert<"shop_roasters">;
-export type NewRoasterFarm = TablesInsert<"roaster_farms">;
 export type NewFranchiseRoaster = TablesInsert<"franchise_roasters">;
 export type NewShopBean = TablesInsert<"shop_beans">;
 export type NewUserFollower = TablesInsert<"user_followers">;
-export type NewShopFollower = TablesInsert<"shop_followers">;
 export type NewShopFavourite = TablesInsert<"shop_favourites">;
+export type NewCoffeeBeanOrigin = TablesInsert<"coffee_bean_origins">;
+export type NewSubmissionOrigin = TablesInsert<"submission_origins">;
 export type NewAction = TablesInsert<"actions">;
 export type NewPoints = TablesInsert<"points">;
 export type NewReward = TablesInsert<"rewards">;
-export type NewShot = TablesInsert<"shots">;
-export type NewShotLike = TablesInsert<"shot_likes">;
 export type NewReview = TablesInsert<"reviews">;
 export type NewVote = TablesInsert<"votes">;
 export type NewAssertion = TablesInsert<"assertions">;
@@ -139,7 +135,8 @@ export type CoffeeBeanUpdate = TablesUpdate<"coffee_beans">;
 export type ActionUpdate = TablesUpdate<"actions">;
 export type PointsUpdate = TablesUpdate<"points">;
 export type RewardUpdate = TablesUpdate<"rewards">;
-export type ShotUpdate = TablesUpdate<"shots">;
+export type CoffeeBeanOriginUpdate = TablesUpdate<"coffee_bean_origins">;
+export type SubmissionOriginUpdate = TablesUpdate<"submission_origins">;
 export type ReviewUpdate = TablesUpdate<"reviews">;
 export type VoteUpdate = TablesUpdate<"votes">;
 export type AssertionUpdate = TablesUpdate<"assertions">;