@recipe-book/react 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,81 @@
 # @recipe-book/react
 
+## 0.1.2
+
+### Patch Changes
+
+- `docsUrl`, and the link at the end of every error message, now end with a slash, such as `https://recipe-book.siraj.page/errors/unknown_unit/`, so they open the page without a redirect. ([#1377](https://github.com/SirajChokshi/recipe-book/pull/1377) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+- `RecipeBookError` now sets `cause` from its options in browsers whose built-in `Error` ignores them. ([#1217](https://github.com/SirajChokshi/recipe-book/pull/1217) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - In Chrome and Edge before 93, Firefox before 91, and Safari before 15, `error.cause` was `undefined`.
+
+- The TSDoc for core's conversion, format, and resolve functions now says which inputs pass through an error thrown by a getter or proxy. ([#1368](https://github.com/SirajChokshi/recipe-book/pull/1368) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - The input and options: `resolveIngredient`, `formatQuantity`, `formatQuantityToParts`, `formatIngredient`, `formatServings`, `formatYield`, and `formatTemperature`.
+  - The input: `scaleQuantity`, `convert`, `toSystem`, and `convertTemperature`.
+  - The options: `segmentStepText`, `formatDuration`, and `toJsonLd`.
+
+- Add `isRecipeValidationError`, which checks whether a caught value is a `RecipeValidationError` and narrows its type, so `issues` needs no cast. ([#1266](https://github.com/SirajChokshi/recipe-book/pull/1266) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - It checks the error's `name`, `code`, and `issues` rather than using `instanceof`, so it also recognizes errors from another installed copy of `@recipe-book/core`, as `isRecipeBookError` does.
+
+- Add `ParsedRecipe`, the same type as `Recipe` under another name. ([#924](https://github.com/SirajChokshi/recipe-book/pull/924) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - A file that imports `@recipe-book/react` as `Recipe` can import `ParsedRecipe` from `@recipe-book/react/core` instead of renaming the type with `import type { Recipe as ParsedRecipe }`.
+
+- Development warnings and React DevTools name each part as you write it, such as `Recipe.Step`, instead of the name the published build gave it, such as `ForwardRef(Step2)`. ([#1092](https://github.com/SirajChokshi/recipe-book/pull/1092) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - Component stacks in React 18 and 19 use the same names, such as `at Recipe.Step` instead of `at Step2`. The provider is `Recipe.RecipeBookProvider`.
+  - Warnings about an `asChild` child, such as one that can't take a ref or children without keys, name `Slot` instead of `ForwardRef(Slot2)`.
+  - Production builds leave the names out.
+
+- `parseRecipe` and `recipeSchema` now list `duplicate_id` warnings in input order when a repeated section id follows repeated item ids in earlier sections. ([#1221](https://github.com/SirajChokshi/recipe-book/pull/1221) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - Before, when no other issue came between them, the section's warning came before the items' warnings.
+
+- The TSDoc for `ResolvedRecipe.servings` and `yield` now says that at a scale within 1e-9 of 1, including one the `servings` option sets, they're the authored servings and yield. ([#1368](https://github.com/SirajChokshi/recipe-book/pull/1368) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+- In development, the summary `<Recipe.Root>` logs before its `parse` warnings now links the Issue codes table, which gives the fix for each warning's code. ([#954](https://github.com/SirajChokshi/recipe-book/pull/954) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - The summary now reads: `Recipe Book: "Buttermilk pancakes" has 1 warning. It still renders. https://recipe-book.siraj.page/errors/#issue-codes gives the fix for each warning's code.`
+  - Only the text changes, and only in development. If a test matches the old summary, update it.
+
+- On React 18, a part with `asChild` no longer makes React warn that function components cannot be given refs when its child is a function component and you pass the part no `ref`. ([#1329](https://github.com/SirajChokshi/recipe-book/pull/1329) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+- The arrow keys in `<Recipe.SystemToggle>` now follow the toggle's computed CSS `direction` instead of the nearest `dir` attribute, so Left Arrow and Right Arrow also swap under CSS `direction: rtl` and under `dir="auto"` on right-to-left text, no longer swap under CSS `direction: ltr` inside `dir="rtl"`, and no longer depend on the focused option's own `dir`. ([#1339](https://github.com/SirajChokshi/recipe-book/pull/1339) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+- `segmentStepText` no longer reads a "-" right after a number with no unit of its own, or with only a degree sign, as a minus sign. ([#919](https://github.com/SirajChokshi/recipe-book/pull/919) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - In `Bake at 350 -375°F.` and `Bake at 350° -375°F.`, it read the second end as a negative temperature, −375 °F. Such a range now stays text, as `350–375°F` does.
+  - After a unit, as in `350°F -375°F`, the "-" is still a minus sign.
+
+## 0.1.1
+
+### Patch Changes
+
+- `<Recipe.Ingredient>` and the function `useFormatIngredient()` returns now throw a `RecipeBookError` with code `invalid_argument` for an item that isn't `{ ingredient, quantity? }`, such as `{}`, `null`, or an authored ingredient, instead of a bare `TypeError`. ([#925](https://github.com/SirajChokshi/recipe-book/pull/925) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - The error is the one `formatIngredient` from `@recipe-book/react/core` throws: its message says what it expects and what it received, and links to the error's page.
+
+- Passing `dangerouslySetInnerHTML` to a part that always renders content now fails typecheck instead of throwing when React renders it. ([#906](https://github.com/SirajChokshi/recipe-book/pull/906) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - That's every part except four. `<Recipe.Root>` and `<Recipe.JsonLd>` already failed typecheck with it. `<Recipe.Image>` and `<Recipe.ServingsInput>` still typecheck with it, as a plain `<img>` or `<input>` does, and React still throws when it renders them.
+  - A wrapper that spreads its element's props into a part typechecks as before.
+
+- Add `@recipe-book/react/core` and `@recipe-book/react/core/schema-org`, which re-export `@recipe-book/core` and `@recipe-book/core/schema-org`, so a React app installs one package. ([#888](https://github.com/SirajChokshi/recipe-book/pull/888) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - The re-exports are core's own values, not copies. While an app's `@recipe-book/core` is on the same version as `@recipe-book/react`, the two packages share one copy of core, so code can mix imports from both. With different versions, the app gets a second copy of core.
+  - Neither is a `'use client'` module, so in a Server Component `parseRecipe`, `toJsonLd`, and core's other functions run on the server, as they do from core.
+  - `@recipe-book/react` still re-exports nothing from core, and its parts and hooks stay client references.
+  - Errors that said to call `parseRecipe()` or `formatIngredient()` from `@recipe-book/core` now name `@recipe-book/react/core`.
+
+- `setServings`, `servings`, and `defaultServings` accept a number at either end of the servings window, such as 700000 for a recipe with 0.7 servings, as `resolveRecipe` now does. ([#911](https://github.com/SirajChokshi/recipe-book/pull/911) by [@SirajChokshi](https://github.com/SirajChokshi))
+
+  - The development warning for a number outside the window rounds the bounds it names to six digits inside the window, so it never names a number that's rejected: for a recipe with ⅔ servings, it names 666666 rather than 666667.
+
+- `SystemOption` now sets `autoComplete="off"`, so when going back reloads the page, Firefox no longer re-enables an option that the server rendered disabled and the page enabled later, and its new `autoComplete` prop lets you pass your own value. ([#905](https://github.com/SirajChokshi/recipe-book/pull/905) by [@SirajChokshi](https://github.com/SirajChokshi))
+
 ## 0.1.0
 
 - `<Recipe.Root>` holds a parsed recipe's servings and measurement system, controlled or not, and `useRecipe()` reads them. `useRecipeState()` does the same without a Root. With `parse={parseRecipe}`, a Root parses recipe input in the browser.

package/README.md

@@ -5,15 +5,17 @@ Unstyled React components for recipes. Scale servings, switch between metric and
 ## Install
 
 ```sh
-npm i @recipe-book/react @recipe-book/core
+npm i @recipe-book/react
 ```
 
+Core's functions and types, such as `parseRecipe`, come from `@recipe-book/react/core`, so you don't install `@recipe-book/core` yourself. If your app also installs `@recipe-book/core`, keep it on the same version as `@recipe-book/react`, or the app gets a second copy of core.
+
 ## Usage
 
-Parse recipe input with `parseRecipe` from `@recipe-book/core` and pass the parsed recipe to `<Recipe.Root>`. The parts inside it render the recipe at the chosen servings and measurement system.
+Parse recipe input with `parseRecipe` and pass the parsed recipe to `<Recipe.Root>`. The parts inside it render the recipe at the chosen servings and measurement system.
 
 ```tsx
-import { parseRecipe } from '@recipe-book/core'
+import { parseRecipe } from '@recipe-book/react/core'
 import * as Recipe from '@recipe-book/react'
 
 const result = parseRecipe({
@@ -47,7 +49,7 @@ export function Pancakes() {
 }
 ```
 
-Parse where you load the recipe, such as in a Server Component or at build time, so the parser stays out of the browser bundle. With Next.js, and with Vite when each page loads as its own chunk, such as a lazy route, a page that parses in the browser with `import { parseRecipe } from '@recipe-book/core'` doesn't put the parser on other pages. Otherwise, such as with esbuild's code splitting or with Vite without lazy routes, parse on the server on every page: one page that parses in the browser can put the parser on other pages. Calling `import('@recipe-book/core')` can also download it, as [Why parse on the server](https://recipe-book.siraj.page/guides/render-a-recipe-in-react/#why-parse-on-the-server) describes.
+Parse where you load the recipe, such as in a Server Component or at build time, so the parser stays out of the browser bundle. [Render a recipe on the server](https://recipe-book.siraj.page/guides/render-a-recipe-on-the-server/) shows how with the Next.js App Router and Pages Router, React Router, Astro, and your own server. With Next.js, and with Vite when each page loads as its own chunk, such as a lazy route, a page that parses in the browser with `import { parseRecipe } from '@recipe-book/react/core'` doesn't put the parser on other pages. Otherwise, such as with esbuild's code splitting or with Vite without lazy routes, parse on the server on every page: one page that parses in the browser can put the parser on other pages. Calling `import('@recipe-book/react/core')` can also download it, as [Why parse on the server](https://recipe-book.siraj.page/guides/render-a-recipe-in-react/#why-parse-on-the-server) describes.
 
 ## Documentation
 

package/core/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../dist/core.cjs",
+  "module": "../dist/core.js",
+  "types": "../dist/core.d.cts"
+}

package/core/schema-org/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../../dist/core/schema-org.cjs",
+  "module": "../../dist/core/schema-org.js",
+  "types": "../../dist/core/schema-org.d.cts"
+}

package/dist/core/schema-org.cjs

@@ -0,0 +1,25 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/core/schema-org.ts
+var schema_org_exports = {};
+module.exports = __toCommonJS(schema_org_exports);
+__reExport(schema_org_exports, require("@recipe-book/core/schema-org"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("@recipe-book/core/schema-org")
+});
+//# sourceMappingURL=schema-org.cjs.map

package/dist/core/schema-org.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/core/schema-org.ts"],"sourcesContent":["export * from '@recipe-book/core/schema-org'\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,+BAAc,yCAAd;","names":[]}

package/dist/core/schema-org.d.cts

@@ -0,0 +1 @@
+export * from '@recipe-book/core/schema-org';

package/dist/core/schema-org.d.ts

@@ -0,0 +1 @@
+export * from '@recipe-book/core/schema-org';

package/dist/core/schema-org.js

@@ -0,0 +1,3 @@
+// src/core/schema-org.ts
+export * from "@recipe-book/core/schema-org";
+//# sourceMappingURL=schema-org.js.map

package/dist/core/schema-org.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/core/schema-org.ts"],"sourcesContent":["export * from '@recipe-book/core/schema-org'\n"],"mappings":";AAAA,cAAc;","names":[]}

package/dist/core.cjs

@@ -0,0 +1,25 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/core.ts
+var core_exports = {};
+module.exports = __toCommonJS(core_exports);
+__reExport(core_exports, require("@recipe-book/core"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("@recipe-book/core")
+});
+//# sourceMappingURL=core.cjs.map

package/dist/core.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/core.ts"],"sourcesContent":["export * from '@recipe-book/core'\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,yBAAc,8BAAd;","names":[]}

package/dist/core.d.cts

@@ -0,0 +1 @@
+export * from '@recipe-book/core';

package/dist/core.d.ts

@@ -0,0 +1 @@
+export * from '@recipe-book/core';

package/dist/core.js

@@ -0,0 +1,3 @@
+// src/core.ts
+export * from "@recipe-book/core";
+//# sourceMappingURL=core.js.map

package/dist/core.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/core.ts"],"sourcesContent":["export * from '@recipe-book/core'\n"],"mappings":";AAAA,cAAc;","names":[]}