@simonarcher/fika-types 1.0.0

package/dist/coffee.d.ts

@@ -0,0 +1,98 @@
+import type { GeoPoint, Timestamp } from "firebase-admin/firestore";
+export interface RoasterData {
+    id: string;
+    name: string;
+    logoImage?: string;
+    about?: string;
+    country: string;
+    countryCode: string;
+    city?: string;
+    contactDetails?: {
+        phone?: string;
+        instagram?: string;
+        website?: string;
+        email?: string;
+        address?: {
+            formattedAddress: string;
+            shortFormattedAddress?: string;
+            addressLine1?: string;
+            addressLine2?: string;
+            postalCode?: string;
+            province?: string;
+            country: string;
+            city: string;
+        };
+    };
+    addedByUser?: string;
+    active: boolean;
+    createdAt?: Timestamp;
+    updatedAt?: Timestamp;
+    status: "inReview" | "approved" | "rejected";
+    additionalInfo?: string;
+    suppliedShops?: string[];
+    geoPoint?: GeoPoint;
+}
+export interface SubmissionRoasterData {
+    name: string;
+    logoImage?: string;
+    about?: string;
+    country: string;
+    countryCode: string;
+    city?: string;
+    contactDetails?: {
+        phone?: string;
+        instagram?: string;
+        website?: string;
+        email?: string;
+        address?: {
+            formattedAddress: string;
+            country: string;
+            city: string;
+        };
+    };
+    userId: string;
+    status: "inReview" | "approved" | "rejected";
+    active: boolean;
+    additionalInfo?: string;
+    geoPoint?: GeoPoint;
+}
+export type DecafMethod = "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';
+export interface CoffeeBeanData {
+    id: string;
+    name: string;
+    description?: string;
+    image?: string;
+    roasterId: string;
+    country?: string;
+    region?: string;
+    origin?: string;
+    elevation?: number;
+    processing?: CoffeeProcessingMethod;
+    tastingNotes?: string[];
+    isDecaf: boolean;
+    decafMethod?: DecafMethod;
+    shops?: string[];
+    active: boolean;
+    createdAt?: Timestamp;
+    updatedAt?: Timestamp;
+}
+export interface SubmissionCoffeeBeanData {
+    name: string;
+    description?: string;
+    image?: string;
+    roasterId: string;
+    country?: string;
+    region?: string;
+    origin?: string;
+    elevation?: number;
+    processing?: CoffeeProcessingMethod;
+    tastingNotes?: string[];
+    isDecaf: boolean;
+    decafMethod?: DecafMethod;
+    userId: string;
+    status: "inReview" | "approved" | "rejected";
+    active: boolean;
+}
+export declare const COFFEE_PRODUCING_COUNTRIES: string[];

package/dist/coffee.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.COFFEE_PRODUCING_COUNTRIES = void 0;
+exports.COFFEE_PRODUCING_COUNTRIES = [
+    "Bolivia",
+    "Brazil",
+    "Burundi",
+    "Colombia",
+    "Costa Rica",
+    "Dominican Republic",
+    "Ecuador",
+    "El Salvador",
+    "Ethiopia",
+    "Guatemala",
+    "Haiti",
+    "Honduras",
+    "India",
+    "Indonesia",
+    "Jamaica",
+    "Kenya",
+    "Mexico",
+    "Nicaragua",
+    "Panama",
+    "Papua New Guinea",
+    "Peru",
+    "Rwanda",
+    "Tanzania",
+    "Uganda",
+    "Vietnam",
+    "Yemen",
+    "Other",
+];

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './shop';
+export * from './coffee';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Export all shop-related types
+__exportStar(require("./shop"), exports);
+// Export all coffee-related types  
+__exportStar(require("./coffee"), exports);

package/dist/shop.d.ts

@@ -0,0 +1,299 @@
+import type { Timestamp } from "firebase-admin/firestore";
+import type { GeoPoint, Timestamp as AdminTimestamp } from "firebase-admin/firestore";
+import type { CoffeeProcessingMethod, DecafMethod, RoastLevel } from "./coffee";
+export type MenuItemDrinkType = "Filter" | "ColdBrew" | "Specialty" | "Espresso" | "Milk" | "Tea" | "Other";
+export type MenuItemFoodType = "Breakfast" | "Lunch" | "Pastry" | "Snack" | "Sweets" | "Sandwiches" | "Other";
+export type MenuItemType = MenuItemDrinkType | MenuItemFoodType;
+export type MenuItemCategory = "drink" | "food";
+export interface MenuItem {
+    id: string;
+    name: string;
+    description?: string;
+    price: number;
+    type: MenuItemType;
+    category: MenuItemCategory;
+    available: boolean;
+    image?: string;
+    createdAt: number;
+    updatedAt: number;
+    currency: string;
+    coffeeBeanIds?: string[];
+}
+export interface NewMenuItem {
+    name: string;
+    description?: string;
+    price: number;
+    type: MenuItemType;
+    category: MenuItemCategory;
+    available: boolean;
+    image?: string;
+    currency: string;
+    coffeeBeanIds?: string[];
+}
+export interface StaffMember {
+    id: string;
+    userId: string;
+    profilePicture?: string;
+    membershipId: string;
+    role: string;
+    shopId: string;
+    name?: string;
+    bio?: string;
+    favouriteCoffeeDrink?: string;
+    email?: string;
+    isWorking: boolean;
+    shiftStart?: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface StaffMemberInvite {
+    id: string;
+    shopId: string;
+    invitedEmail: string;
+    token: string;
+    role: "owner" | "staff";
+    status: "pending" | "accepted" | "declined";
+    expiresAt: AdminTimestamp;
+    createdAt: AdminTimestamp;
+    updatedAt: AdminTimestamp;
+}
+export type ShopOpeningTimes = {
+    monday?: {
+        open: string;
+        close: string;
+    };
+    tuesday?: {
+        open: string;
+        close: string;
+    };
+    wednesday?: {
+        open: string;
+        close: string;
+    };
+    thursday?: {
+        open: string;
+        close: string;
+    };
+    friday?: {
+        open: string;
+        close: string;
+    };
+    saturday?: {
+        open: string;
+        close: string;
+    };
+    sunday?: {
+        open: string;
+        close: string;
+    };
+};
+export type ShopData = {
+    id: string;
+    name: string;
+    about?: string;
+    businessStatus?: string;
+    fikaRating?: number;
+    totalReviews?: number;
+    ratingDetails?: {
+        coffee: number;
+        service: number;
+        ambience: number;
+    };
+    googleRating?: number;
+    coverImage?: string;
+    logoImage?: string;
+    addedByUser?: string;
+    ownerId?: string;
+    platformLoyaltyRewards?: {
+        hasPlatformLoyaltyRewards?: boolean;
+        stampsRequired?: number;
+    };
+    info?: {
+        hasWifi: boolean;
+        wifiName: string;
+        wifiPassword: string;
+        laptopFriendly: boolean;
+        hasKitchen: boolean;
+        servesBreakfast: boolean;
+        servesLunch: boolean;
+        servesVegetarianFood: boolean;
+        discountOnReusableCup: boolean;
+        hasLoyaltyRewards: boolean;
+    };
+    socials?: {
+        instagram: string;
+        facebook: string;
+        tiktok: string;
+        twitter: string;
+    };
+    location?: {
+        latitude: number;
+        longitude: number;
+    };
+    geoPoint?: GeoPoint;
+    regularOpeningHours?: DayOpeningHours[];
+    contactDetails?: {
+        contactNumber: string;
+        website: string;
+        address: {
+            formattedAddress: string;
+            shortFormattedAddress: string;
+            addressLine1: string;
+            addressLine2: string;
+            postalCode: string;
+            province: string;
+            country: string;
+        };
+    };
+    addedAt?: AdminTimestamp;
+    images?: {
+        cover?: string;
+        general?: string[];
+        menu?: string[];
+    };
+};
+interface OpeningTime {
+    day: number;
+    hour: number | null;
+    minute: number | null;
+}
+export interface DayOpeningHours {
+    dayOfWeek: string;
+    open?: OpeningTime;
+    close?: OpeningTime;
+}
+export interface FullShopData extends ShopData {
+    staff: StaffMember[];
+    roastingAndBeansInfo?: RoastingAndBeansInfo;
+}
+export interface RoastingAndBeansInfo {
+    roasters?: string[];
+    hasDecaf?: boolean;
+    decafMethods?: DecafMethod[];
+    flavourNotes?: string[];
+    coffeeBeans?: string[];
+    coffeeOriginCountries?: string[];
+    processingMethods?: CoffeeProcessingMethod[];
+    roastLevels?: RoastLevel[];
+    singleOrigin?: boolean;
+    directTrade?: boolean;
+    seasonal?: boolean;
+}
+export interface ShopPaymentOptions {
+    acceptsCashOnly: boolean;
+    acceptsCreditCards: boolean;
+    acceptsDebitCards: boolean;
+    acceptsNfc: boolean;
+}
+export interface SubmissionShopData {
+    shopName: string;
+    lat?: number;
+    long?: number;
+    active: boolean;
+    userId: string;
+    status: string;
+    isOwner: boolean;
+    ownerEmail: string;
+    countryCode: string;
+    city: string;
+}
+export type SubmissionShopFormData = {
+    shopName: string;
+    lat?: number;
+    long?: number;
+    isOwner: boolean;
+    ownerEmail: string;
+    countryCode: string;
+    city: string;
+    placeId?: string;
+    address?: string;
+    info?: {
+        hasWifi: string;
+        laptopFriendly: string;
+        hasKitchen: string;
+        discountOnReusableCup: string;
+        hasLoyaltyRewards: string;
+    };
+    geoPoint?: {
+        latitude: number;
+        longitude: number;
+    };
+    review?: ShopReview;
+    images?: {
+        cover?: string;
+        general?: string[];
+        menu?: string[];
+    };
+    regularOpeningHours?: DayOpeningHours[];
+    contactDetails?: {
+        contactNumber?: string;
+        website?: string;
+        address?: {
+            formattedAddress?: string;
+            shortFormattedAddress?: string;
+            city?: string;
+            country?: string;
+        };
+    };
+};
+export interface ShopReview {
+    id: string;
+    userId: string;
+    shopId?: string;
+    reviewText?: string;
+    imageUrl?: string | undefined;
+    createdAt: Timestamp;
+    createdAtISO?: string;
+    ratings?: {
+        coffee?: number;
+        service?: number;
+        ambience?: number;
+    };
+}
+export interface PostShopReviewData {
+    userId: string | undefined;
+    shopId: string;
+    reviewText?: string;
+    imageUrl?: string | undefined;
+    ratings?: {
+        coffee?: number;
+        service?: number;
+        ambience?: number;
+    };
+    createdAt: AdminTimestamp;
+}
+export interface ShopReviewSubmission {
+    reviewText?: string;
+    imageUrl?: string | undefined;
+    userId: string;
+    shopId: string;
+    ratings?: {
+        coffee?: number;
+        service?: number;
+        ambience?: number;
+    };
+}
+export interface LoyaltyRewardPlatformShop {
+    id: string;
+    name: string;
+    hasPlatformLoyaltyRewards: boolean;
+    stampsRequired: number;
+    countryCode: string;
+    city: string;
+    shopId: string;
+    coverImage?: string;
+    logoImage?: string;
+}
+export interface LoyaltyStamp {
+    id: string;
+    userId: string;
+    shopId: string;
+    issueMethod: "app" | "nfc";
+    issuerId: string;
+    createdAt: AdminTimestamp;
+    updatedAt?: AdminTimestamp;
+    type: string;
+    valid: boolean;
+    voucherId?: string;
+}
+export {};

package/dist/shop.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "@simonarcher/fika-types",
+    "version": "1.0.0",
+    "description": "Shared TypeScript types for Fika projects",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+      "build": "tsc",
+      "dev": "tsc --watch",
+      "clean": "rm -rf dist",
+      "prepublishOnly": "npm run build"
+    },
+    "devDependencies": {
+      "typescript": "^5.0.0",
+      "firebase": "^10.8.1",
+      "firebase-admin": "^12.0.0"
+    },
+    "peerDependencies": {
+      "firebase": "^10.0.0",
+      "firebase-admin": "^12.0.0"
+    },
+    "files": [
+      "dist/**/*"
+    ],
+    "publishConfig": {
+      "access": "public"
+    },
+    "repository": {
+      "type": "git",
+      "url": "https://github.com/simonarcher/FIKA-schema.git"
+    },
+    "keywords": [
+      "typescript",
+      "types",
+      "fika",
+      "coffee",
+      "firebase"
+    ],
+    "author": "Simon Archer",
+    "license": "MIT",
+    "engines": {
+      "node": ">=16.0.0"
+    }
+  }