@cravery/types 0.0.1

package/src/common/cuisine.ts

@@ -0,0 +1,77 @@
+export const CUISINE_VALUES = [
+  // East Asia
+  "chinese",
+  "japanese",
+  "korean",
+  // Southeast Asia
+  "filipino",
+  "indonesian",
+  "malaysian",
+  "singaporean",
+  "thai",
+  "vietnamese",
+  // South Asia
+  "bangladeshi",
+  "indian",
+  "pakistani",
+  "sri_lankan",
+  // Middle East
+  "emirati",
+  "iraqi",
+  "jordanian",
+  "lebanese",
+  "palestinian",
+  "saudi",
+  "syrian",
+  "yemeni",
+  // Central Asia & Caucasus
+  "persian",
+  "turkish",
+  // North Africa
+  "algerian",
+  "egyptian",
+  "moroccan",
+  "sudanese",
+  "tunisian",
+  // Sub-Saharan Africa
+  "ethiopian",
+  "ghanaian",
+  "kenyan",
+  "nigerian",
+  "south_african",
+  // Western Europe
+  "british",
+  "french",
+  "german",
+  "irish",
+  "italian",
+  "portuguese",
+  "spanish",
+  // Northern Europe
+  "danish",
+  "swedish",
+  // Eastern Europe
+  "greek",
+  "hungarian",
+  "polish",
+  "russian",
+  "ukrainian",
+  // North America
+  "american",
+  "cajun",
+  "mexican",
+  // Caribbean
+  "cuban",
+  "jamaican",
+  "puerto_rican",
+  // South America
+  "argentinian",
+  "brazilian",
+  "colombian",
+  "peruvian",
+  "venezuelan",
+  // Oceania
+  "australian",
+] as const;
+
+export type Cuisine = (typeof CUISINE_VALUES)[number];

package/src/common/currency.ts

@@ -0,0 +1,6 @@
+import { CurrencyCode } from "./currency_code";
+
+export interface Currency {
+  amount: number;
+  currency: CurrencyCode;
+}

package/src/common/currency_code.ts

@@ -0,0 +1,10 @@
+export const CURRENCY_CODE_VALUES = [
+  "USD",
+  "CAD",
+  "GBP",
+  "EUR",
+  "EGP",
+  "AED",
+  "SAR",
+] as const;
+export type CurrencyCode = (typeof CURRENCY_CODE_VALUES)[number];

package/src/common/dietary_tag.ts

@@ -0,0 +1,18 @@
+export const DIETARY_TAG_VALUES = [
+  "dairy_free",
+  "egg_free",
+  "gluten_free",
+  "halal",
+  "high_protein",
+  "keto",
+  "low_carb",
+  "low_fat",
+  "low_sodium",
+  "low_sugar",
+  "nut_free",
+  "pescatarian",
+  "soy_free",
+  "vegan",
+  "vegetarian",
+] as const;
+export type DietaryTag = (typeof DIETARY_TAG_VALUES)[number];

package/src/common/difficulty.ts

@@ -0,0 +1,2 @@
+export const DIFFICULTY_VALUES = ["easy", "medium", "hard", "expert"] as const;
+export type Difficulty = (typeof DIFFICULTY_VALUES)[number];

package/src/common/index.ts

@@ -0,0 +1,13 @@
+export * from "./allergen";
+export * from "./cuisine";
+export * from "./currency";
+export * from "./currency_code";
+export * from "./dietary_tag";
+export * from "./difficulty";
+export * from "./meal_type";
+export * from "./measurement_system";
+export * from "./nutrition";
+export * from "./spiciness";
+export * from "./temperature_unit";
+export * from "./temperature";
+export * from "./unit";

package/src/common/meal_type.ts

@@ -0,0 +1,13 @@
+export const MEAL_TYPE_VALUES = [
+  "appetizer",
+  "breakfast",
+  "brunch",
+  "dessert",
+  "dinner",
+  "drink",
+  "lunch",
+  "sauce",
+  "side",
+  "snack",
+] as const;
+export type MealType = (typeof MEAL_TYPE_VALUES)[number];

package/src/common/measurement_system.ts

@@ -0,0 +1,2 @@
+export const MEASUREMENT_SYSTEM_VALUES = ["imperial", "metric"] as const;
+export type MeasurementSystem = (typeof MEASUREMENT_SYSTEM_VALUES)[number];

package/src/common/nutrition.ts

@@ -0,0 +1,11 @@
+export interface Nutrition {
+  calories: number;
+  carbs?: number;
+  cholesterol?: number;
+  fat?: number;
+  fiber?: number;
+  protein?: number;
+  saturatedFat?: number;
+  sodium?: number;
+  sugar?: number;
+}

package/src/common/spiciness.ts

@@ -0,0 +1,8 @@
+export const SPICINESS_VALUES = [
+  "none",
+  "mild",
+  "medium",
+  "hot",
+  "extreme",
+] as const;
+export type Spiciness = (typeof SPICINESS_VALUES)[number];

package/src/common/temperature.ts

@@ -0,0 +1,6 @@
+import { TemperatureUnit } from "./temperature_unit";
+
+export interface Temperature {
+  unit: TemperatureUnit;
+  value: number;
+}

package/src/common/temperature_unit.ts

@@ -0,0 +1,2 @@
+export const TEMPERATURE_UNIT_VALUES = ["celsius", "fahrenheit"] as const;
+export type TemperatureUnit = (typeof TEMPERATURE_UNIT_VALUES)[number];

package/src/common/unit.ts

@@ -0,0 +1,48 @@
+export const UNIT_VALUES = [
+  // Volume (metric)
+  "ml",
+  "l",
+  // Volume (imperial)
+  "tsp",
+  "tbsp",
+  "fl_oz",
+  "cup",
+  "pint",
+  "quart",
+  "gallon",
+  // Weight (metric)
+  "mg",
+  "g",
+  "kg",
+  // Weight (imperial)
+  "oz",
+  "lb",
+  // Count/portion
+  "piece",
+  "whole",
+  "half",
+  "quarter",
+  "slice",
+  "serving",
+  // Produce-specific
+  "clove",
+  "stalk",
+  "sprig",
+  "leaf",
+  "bunch",
+  "head",
+  "fillet",
+  "stick",
+  "sheet",
+  // Container
+  "can",
+  "package",
+  "bottle",
+  "jar",
+  // Imprecise
+  "handful",
+  "pinch",
+  "dash",
+  "drop",
+] as const;
+export type Unit = (typeof UNIT_VALUES)[number];

package/src/core/api.ts

@@ -0,0 +1,30 @@
+import { AppErrorCode } from "./errors";
+
+export interface ApiSuccessResponse<T> {
+  success: true;
+  data: T;
+}
+
+export interface ApiErrorResponse {
+  success: false;
+  error: {
+    code: AppErrorCode;
+    message: string;
+  };
+}
+
+export type ApiResponse<T> = ApiSuccessResponse<T> | ApiErrorResponse;
+
+export function success<T>(data: T): ApiSuccessResponse<T> {
+  return { success: true, data };
+}
+
+export function failure(
+  code: AppErrorCode,
+  message: string,
+): ApiErrorResponse {
+  return {
+    success: false,
+    error: { code, message },
+  };
+}

package/src/core/entity.ts

@@ -0,0 +1,8 @@
+import { Timestamp } from "./timestamp";
+
+export interface Entity {
+  id: string;
+  createdAt: Timestamp;
+  updatedAt: Timestamp;
+  deletedAt: Timestamp | null;
+}

package/src/core/errors.ts

@@ -0,0 +1,118 @@
+export const APP_ERROR_CODE_VALUES = [
+  "bad-request",
+  "conflict",
+  "daily-limit-reached",
+  "forbidden",
+  "internal-error",
+  "low-confidence",
+  "monthly-limit-reached",
+  "not-found",
+  "no-recipe-found",
+  "unauthorized",
+  "unsafe-content",
+  "validation-error",
+] as const;
+export type AppErrorCode = (typeof APP_ERROR_CODE_VALUES)[number];
+
+export class AppError extends Error {
+  public readonly code: AppErrorCode;
+  public readonly context?: Record<string, unknown>;
+
+  constructor(
+    code: AppErrorCode,
+    message: string,
+    context?: Record<string, unknown>,
+  ) {
+    super(message);
+    this.name = "AppError";
+    this.code = code;
+    this.context = context;
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, AppError);
+    }
+  }
+
+  toJSON() {
+    return {
+      name: this.name,
+      code: this.code,
+      message: this.message,
+      context: this.context,
+    };
+  }
+}
+
+export class ValidationError extends AppError {
+  constructor(message: string, context?: Record<string, unknown>) {
+    super("validation-error", message, context);
+    this.name = "ValidationError";
+  }
+}
+
+export class NotFoundError extends AppError {
+  constructor(message: string, context?: Record<string, unknown>) {
+    super("not-found", message, context);
+    this.name = "NotFoundError";
+  }
+}
+
+export class UnauthorizedError extends AppError {
+  constructor(message: string, context?: Record<string, unknown>) {
+    super("unauthorized", message, context);
+    this.name = "UnauthorizedError";
+  }
+}
+
+export class ForbiddenError extends AppError {
+  constructor(message: string, context?: Record<string, unknown>) {
+    super("forbidden", message, context);
+    this.name = "ForbiddenError";
+  }
+}
+
+export class ConflictError extends AppError {
+  constructor(message: string, context?: Record<string, unknown>) {
+    super("conflict", message, context);
+    this.name = "ConflictError";
+  }
+}
+
+export class DailyLimitError extends AppError {
+  constructor(message: string, context?: Record<string, unknown>) {
+    super("daily-limit-reached", message, context);
+    this.name = "DailyLimitError";
+  }
+}
+
+export class MonthlyLimitError extends AppError {
+  constructor(message: string, context?: Record<string, unknown>) {
+    super("monthly-limit-reached", message, context);
+    this.name = "MonthlyLimitError";
+  }
+}
+
+export class NoRecipeFoundError extends AppError {
+  constructor(reason: string, context?: Record<string, unknown>) {
+    super("no-recipe-found", reason, context);
+    this.name = "NoRecipeFoundError";
+  }
+}
+
+export class LowConfidenceError extends AppError {
+  constructor(confidence: number, context?: Record<string, unknown>) {
+    super(
+      "low-confidence",
+      "We couldn't extract a complete recipe. Try a clearer image or more detailed text.",
+      { ...context, confidence },
+    );
+    this.name = "LowConfidenceError";
+  }
+}
+
+export class UnsafeContentError extends AppError {
+  constructor(context?: Record<string, unknown>) {
+    super("unsafe-content", "This content cannot be processed.", context);
+    this.name = "UnsafeContentError";
+  }
+}

package/src/core/index.ts

@@ -0,0 +1,7 @@
+export * from "./api";
+export * from "./entity";
+export * from "./errors";
+export * from "./locale";
+export * from "./pagination";
+export * from "./theme";
+export * from "./timestamp";

package/src/core/locale.ts

@@ -0,0 +1,2 @@
+export const LOCALE_VALUES = ["en", "ar", "es"] as const;
+export type Locale = (typeof LOCALE_VALUES)[number];

package/src/core/pagination.ts

@@ -0,0 +1,15 @@
+export type PaginationDirection = "forward" | "backward";
+
+export interface PaginationParams {
+  limit?: number;
+  cursor?: string;
+  direction?: PaginationDirection;
+}
+
+export interface PaginatedResult<T> {
+  data: T[];
+  startCursor: string | null;
+  endCursor: string | null;
+  hasNextPage: boolean;
+  hasPreviousPage: boolean;
+}

package/src/core/theme.ts

@@ -0,0 +1,2 @@
+export const THEME_VALUES = ["dark", "light", "system"] as const;
+export type Theme = (typeof THEME_VALUES)[number];

package/src/core/timestamp.ts

@@ -0,0 +1,4 @@
+export interface Timestamp {
+  seconds: number;
+  nanoseconds: number;
+}

package/src/equipment/category.ts

@@ -0,0 +1,15 @@
+export const EQUIPMENT_CATEGORY_VALUES = [
+  "cookware",
+  "bakeware",
+  "cutlery",
+  "utensils",
+  "appliances",
+  "mixing",
+  "measuring",
+  "prep",
+  "baking_tools",
+  "storage",
+  "serving",
+  "specialty",
+] as const;
+export type EquipmentCategory = (typeof EQUIPMENT_CATEGORY_VALUES)[number];

package/src/equipment/entity.ts

@@ -0,0 +1,18 @@
+import { Currency } from "../common";
+import { Entity } from "../core";
+import { EquipmentCategory } from "./category";
+
+export interface EquipmentEntityMeta extends Entity {
+  category: EquipmentCategory;
+  cost: Currency;
+  slug: string;
+  imageUrl: string | null;
+}
+
+export interface EquipmentEntityContent {
+  name: string;
+  slug: string;
+}
+
+export interface EquipmentEntity
+  extends EquipmentEntityMeta, EquipmentEntityContent {}

package/src/equipment/index.ts

@@ -0,0 +1,4 @@
+export * from "./category";
+export * from "./entity";
+export * from "./recipe";
+export * from "./user";

package/src/equipment/recipe.ts

@@ -0,0 +1,14 @@
+export interface RecipeEquipmentMeta {
+  slug: string;
+  optional?: boolean;
+  quantity?: number;
+}
+
+export interface RecipeEquipmentContent {
+  name: string;
+  slug: string;
+  notes?: string;
+}
+
+export interface RecipeEquipment
+  extends RecipeEquipmentMeta, RecipeEquipmentContent {}

package/src/equipment/user.ts

@@ -0,0 +1,10 @@
+import { Currency } from "../common";
+import { Entity } from "../core";
+import { EquipmentCategory } from "./category";
+
+export interface UserEquipment extends Entity {
+  category: EquipmentCategory;
+  cost: Currency;
+  slug: string;
+  quantity?: number;
+}

package/src/feed/index.ts

@@ -0,0 +1 @@
+export * from "./recipe";

package/src/feed/recipe.ts

@@ -0,0 +1,61 @@
+import { Allergen, Cuisine, Currency, DietaryTag, Difficulty, MealType, Spiciness } from "../common";
+import { Entity, Locale } from "../core";
+import { RecipeStats } from "../recipes";
+
+export interface RecipeFeedItem extends Entity {
+  allergens: Allergen[];
+  cost: Currency;
+  cuisines: Cuisine[];
+  dietaryTags: DietaryTag[];
+  difficulty: Difficulty;
+  duration: number;
+  images: string[];
+  mealTypes: MealType[];
+  spiciness: Spiciness;
+  titles: Partial<Record<Locale, string>>;
+}
+
+export interface FeedRecipe extends RecipeFeedItem {
+  stats: RecipeStats;
+}
+
+/*
+import { Cuisine } from "../recipes/cuisine";
+import { DietaryTag } from "../recipes/dietary_tag";
+import { Difficulty } from "../recipes/difficulty";
+import { RecipeStats } from "../recipes/recipe_stats";
+import { FeedReason } from "./feed_reason";
+import { Region } from "./region";
+
+export interface FeedItemBase {
+  recipeId: string;
+  rank: number;
+  score: number;
+  titles: Partial<Record<Locale, string>>;
+  imageUrl?: string;
+  difficulty: Difficulty;
+  time: number;
+  cuisines: Cuisine[];
+  dietaryTags: DietaryTag[];
+  stats: RecipeStats;
+  computedAt: Timestamp;
+}
+
+export interface GlobalFeedItem extends FeedItemBase {
+  type: "global";
+}
+
+export interface RegionalFeedItem extends FeedItemBase {
+  type: "regional";
+  region: Region;
+  regionScore: number;
+}
+
+export interface PersonalFeedItem extends FeedItemBase {
+  type: "personal";
+  reason: FeedReason;
+  similarityScore?: number;
+}
+
+export type FeedItem = GlobalFeedItem | RegionalFeedItem | PersonalFeedItem;
+*/

package/src/iam/index.ts

@@ -0,0 +1,2 @@
+export * from "./role";
+export * from "./user";

package/src/iam/role.ts

@@ -0,0 +1,8 @@
+export const USER_ROLE_VALUES = [
+  "admin",
+  "developer",
+  "moderator",
+  "translator",
+  "user",
+] as const;
+export type UserRole = (typeof USER_ROLE_VALUES)[number];

package/src/iam/user.ts

@@ -0,0 +1,12 @@
+import { Entity } from "../core";
+import { UserRole } from "./role";
+
+export interface User extends Entity {
+  email: string;
+  imageUrl: string | null;
+  name: string;
+  role: UserRole;
+  score: number;
+  subscriptionId: string | null;
+  verified: boolean;
+}

package/src/index.ts

@@ -0,0 +1,13 @@
+export * from "./common";
+export * from "./core";
+export * from "./equipment";
+export * from "./feed";
+export * from "./iam";
+export * from "./ingredients";
+export * from "./limits";
+export * from "./mealplan";
+export * from "./recipes";
+export * from "./reports";
+export * from "./settings";
+export * from "./shopping";
+export * from "./subscriptions";

package/src/ingredients/category.ts

@@ -0,0 +1,28 @@
+export const INGREDIENT_CATEGORY_VALUES = [
+  "fruits",
+  "vegetables",
+  "meat",
+  "poultry",
+  "seafood",
+  "dairy",
+  "grains",
+  "legumes",
+  "spices",
+  "nuts_seeds",
+  "oils_fats",
+  "sauces",
+  "condiments",
+  "sweeteners",
+  "baking",
+  "pantry",
+  "canned",
+  "frozen",
+  "bakery",
+  "prepared",
+  "beverages",
+  "snacks",
+  "international",
+  "specialty",
+  "baby",
+] as const;
+export type IngredientCategory = (typeof INGREDIENT_CATEGORY_VALUES)[number];

package/src/ingredients/entity.ts

@@ -0,0 +1,21 @@
+import { Currency, Unit } from "../common";
+import { Entity } from "../core";
+import { IngredientCategory } from "./category";
+import { IngredientGroup } from "./group";
+
+export interface IngredientEntityMeta extends Entity {
+  category: IngredientCategory;
+  cost: Currency;
+  group: IngredientGroup;
+  slug: string;
+  imageUrl: string | null;
+  standardUnit?: Unit;
+}
+
+export interface IngredientEntityContent {
+  name: string;
+  slug: string;
+}
+
+export interface IngredientEntity
+  extends IngredientEntityMeta, IngredientEntityContent {}

package/src/ingredients/group.ts

@@ -0,0 +1,8 @@
+export const INGREDIENT_GROUP_VALUES = [
+  "counter",
+  "freezer",
+  "fridge",
+  "pantry",
+  "spice",
+] as const;
+export type IngredientGroup = (typeof INGREDIENT_GROUP_VALUES)[number];

package/src/ingredients/index.ts

@@ -0,0 +1,6 @@
+export * from "./category";
+export * from "./entity";
+export * from "./group";
+export * from "./recipe";
+export * from "./section";
+export * from "./user";