cooking-temperature 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Luc Atangana
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,103 @@
+# cooking-temperature
+
+A comprehensive library for safe cooking temperatures, doneness levels, and cooking instructions for various ingredients.
+
+## Installation
+
+```bash
+npm install cooking-temperature
+```
+
+## Usage
+
+```typescript
+import {
+  findByName,
+  getQuickReference,
+  getSafeMinimumTemp,
+  getDonenessTemp,
+  getCookingInstruction,
+  convertTemperature,
+} from "cooking-temperature"
+
+// Quick reference lookup
+const chicken = getQuickReference("chicken breast", "oven_bake")
+// Returns: { name, safeMinimumTemp, tempUnit, restMinutes, suggestedMethod, visualIndicators }
+
+// Find an ingredient by name or alias
+const beef = findByName("ribeye")
+
+// Get safe minimum temperature
+const safeTemp = getSafeMinimumTemp("chicken-breast", "F")
+// Returns: { temp: 165, restMinutes: 0 }
+
+// Get doneness temperature for proteins
+const mediumRare = getDonenessTemp("beef-ribeye", "medium_rare", "F")
+// Returns: 135
+
+// Get cooking instructions
+const instructions = getCookingInstruction("salmon-fillet", "oven_bake")
+// Returns: { applianceTemp, applianceTempUnit, timeMinutes, notes, portionDescription }
+
+// Convert between Fahrenheit and Celsius
+const celsius = convertTemperature(165, "F", "C")
+// Returns: 74
+```
+
+## API
+
+### Lookup Functions
+
+- `findByName(query)` - Find an ingredient by name or alias
+- `findById(id)` - Find an ingredient by its unique ID
+- `findByCategory(category)` - Get all ingredients in a category
+- `getAllEntries()` - Get all cooking temperature entries
+- `getAllCategories()` - Get all available categories
+
+### Temperature Functions
+
+- `convertTemperature(temp, from, to)` - Convert between Fahrenheit and Celsius
+- `getSafeMinimumTemp(ingredientId, unit?)` - Get USDA safe minimum temperature
+- `getDonenessTemp(ingredientId, doneness, unit?)` - Get temperature for a specific doneness level
+
+### Cooking Instructions
+
+- `getCookingMethods(ingredientId)` - Get available cooking methods for an ingredient
+- `getCookingInstruction(ingredientId, method, portionHint?)` - Get detailed cooking instructions
+- `getQuickReference(query, method?, unit?)` - Get a quick reference with all relevant info
+
+## Categories
+
+- `poultry` - Chicken, turkey, duck
+- `beef` - Steaks, roasts, ground beef
+- `pork` - Chops, tenderloin, ribs
+- `seafood_fish` - Salmon, tuna, cod
+- `seafood_shellfish` - Shrimp, lobster, scallops
+- `egg` - Various egg preparations
+- `vegetable` - Common vegetables
+- `grain` - Rice, pasta, quinoa
+
+## Doneness Levels
+
+For proteins that support doneness preferences:
+
+- `rare`
+- `medium_rare`
+- `medium`
+- `medium_well`
+- `well_done`
+- `safe_minimum` (USDA baseline)
+
+## Cooking Methods
+
+- `oven_roast`, `oven_bake`
+- `pan_sear`, `pan_fry`
+- `grill`, `broil`
+- `poach`, `simmer`, `boil`, `steam`
+- `sous_vide`
+- `air_fry`, `deep_fry`
+- `slow_cook`
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,77 @@
+type TemperatureUnit = "F" | "C";
+type CookingMethod = "oven_roast" | "oven_bake" | "pan_sear" | "pan_fry" | "grill" | "broil" | "poach" | "simmer" | "boil" | "steam" | "sous_vide" | "air_fry" | "deep_fry" | "slow_cook";
+type DonenessLevel = "rare" | "medium_rare" | "medium" | "medium_well" | "well_done" | "safe_minimum";
+type IngredientCategory = "poultry" | "beef" | "pork" | "lamb" | "seafood_fish" | "seafood_shellfish" | "egg" | "vegetable" | "grain" | "legume";
+interface CookingInstruction {
+    method: CookingMethod;
+    applianceTemp: number;
+    applianceTempUnit: TemperatureUnit;
+    timeMinutes: {
+        min: number;
+        max: number;
+    };
+    notes?: string;
+}
+interface DonenessSpec {
+    level: DonenessLevel;
+    internalTemp: number;
+    internalTempUnit: TemperatureUnit;
+    description: string;
+}
+interface CookingTemperatureEntry {
+    id: string;
+    name: string;
+    category: IngredientCategory;
+    aliases: string[];
+    safeMinimumTemp: number;
+    safeMinimumTempUnit: TemperatureUnit;
+    restTimeMinutes?: number;
+    donenessLevels?: DonenessSpec[];
+    cookingInstructions: {
+        portionDescription: string;
+        methods: CookingInstruction[];
+    }[];
+    visualIndicators?: string[];
+    sources: string[];
+}
+
+declare const findByName: (query: string) => CookingTemperatureEntry | undefined;
+declare const findById: (id: string) => CookingTemperatureEntry | undefined;
+declare const findByCategory: (category: IngredientCategory) => CookingTemperatureEntry[];
+declare const getAllEntries: () => CookingTemperatureEntry[];
+declare const getAllCategories: () => IngredientCategory[];
+declare const convertTemperature: (temp: number, from: TemperatureUnit, to: TemperatureUnit) => number;
+declare const getSafeMinimumTemp: (ingredientId: string, unit?: TemperatureUnit) => {
+    temp: number;
+    restMinutes: number;
+} | undefined;
+declare const getDonenessTemp: (ingredientId: string, doneness: DonenessLevel, unit?: TemperatureUnit) => number | undefined;
+declare const getCookingMethods: (ingredientId: string) => CookingMethod[];
+declare const getCookingInstruction: (ingredientId: string, method: CookingMethod, portionHint?: string) => {
+    applianceTemp: number;
+    applianceTempUnit: TemperatureUnit;
+    timeMinutes: {
+        min: number;
+        max: number;
+    };
+    notes?: string;
+    portionDescription: string;
+} | undefined;
+declare const getQuickReference: (query: string, method?: CookingMethod, unit?: TemperatureUnit) => {
+    name: string;
+    safeMinimumTemp: number;
+    tempUnit: TemperatureUnit;
+    restMinutes: number;
+    suggestedMethod?: {
+        method: CookingMethod;
+        applianceTemp: number;
+        timeMinutes: {
+            min: number;
+            max: number;
+        };
+        notes?: string;
+    };
+    visualIndicators: string[];
+} | undefined;
+
+export { type CookingInstruction, type CookingMethod, type CookingTemperatureEntry, type DonenessLevel, type DonenessSpec, type IngredientCategory, type TemperatureUnit, convertTemperature, findByCategory, findById, findByName, getAllCategories, getAllEntries, getCookingInstruction, getCookingMethods, getDonenessTemp, getQuickReference, getSafeMinimumTemp };

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+type TemperatureUnit = "F" | "C";
+type CookingMethod = "oven_roast" | "oven_bake" | "pan_sear" | "pan_fry" | "grill" | "broil" | "poach" | "simmer" | "boil" | "steam" | "sous_vide" | "air_fry" | "deep_fry" | "slow_cook";
+type DonenessLevel = "rare" | "medium_rare" | "medium" | "medium_well" | "well_done" | "safe_minimum";
+type IngredientCategory = "poultry" | "beef" | "pork" | "lamb" | "seafood_fish" | "seafood_shellfish" | "egg" | "vegetable" | "grain" | "legume";
+interface CookingInstruction {
+    method: CookingMethod;
+    applianceTemp: number;
+    applianceTempUnit: TemperatureUnit;
+    timeMinutes: {
+        min: number;
+        max: number;
+    };
+    notes?: string;
+}
+interface DonenessSpec {
+    level: DonenessLevel;
+    internalTemp: number;
+    internalTempUnit: TemperatureUnit;
+    description: string;
+}
+interface CookingTemperatureEntry {
+    id: string;
+    name: string;
+    category: IngredientCategory;
+    aliases: string[];
+    safeMinimumTemp: number;
+    safeMinimumTempUnit: TemperatureUnit;
+    restTimeMinutes?: number;
+    donenessLevels?: DonenessSpec[];
+    cookingInstructions: {
+        portionDescription: string;
+        methods: CookingInstruction[];
+    }[];
+    visualIndicators?: string[];
+    sources: string[];
+}
+
+declare const findByName: (query: string) => CookingTemperatureEntry | undefined;
+declare const findById: (id: string) => CookingTemperatureEntry | undefined;
+declare const findByCategory: (category: IngredientCategory) => CookingTemperatureEntry[];
+declare const getAllEntries: () => CookingTemperatureEntry[];
+declare const getAllCategories: () => IngredientCategory[];
+declare const convertTemperature: (temp: number, from: TemperatureUnit, to: TemperatureUnit) => number;
+declare const getSafeMinimumTemp: (ingredientId: string, unit?: TemperatureUnit) => {
+    temp: number;
+    restMinutes: number;
+} | undefined;
+declare const getDonenessTemp: (ingredientId: string, doneness: DonenessLevel, unit?: TemperatureUnit) => number | undefined;
+declare const getCookingMethods: (ingredientId: string) => CookingMethod[];
+declare const getCookingInstruction: (ingredientId: string, method: CookingMethod, portionHint?: string) => {
+    applianceTemp: number;
+    applianceTempUnit: TemperatureUnit;
+    timeMinutes: {
+        min: number;
+        max: number;
+    };
+    notes?: string;
+    portionDescription: string;
+} | undefined;
+declare const getQuickReference: (query: string, method?: CookingMethod, unit?: TemperatureUnit) => {
+    name: string;
+    safeMinimumTemp: number;
+    tempUnit: TemperatureUnit;
+    restMinutes: number;
+    suggestedMethod?: {
+        method: CookingMethod;
+        applianceTemp: number;
+        timeMinutes: {
+            min: number;
+            max: number;
+        };
+        notes?: string;
+    };
+    visualIndicators: string[];
+} | undefined;
+
+export { type CookingInstruction, type CookingMethod, type CookingTemperatureEntry, type DonenessLevel, type DonenessSpec, type IngredientCategory, type TemperatureUnit, convertTemperature, findByCategory, findById, findByName, getAllCategories, getAllEntries, getCookingInstruction, getCookingMethods, getDonenessTemp, getQuickReference, getSafeMinimumTemp };