@webx-ui/module-recipes 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 webx-ui
+
+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,46 @@
+# @webx-ui/module-recipes
+
+The front end of the recipes section of the [WebX UI](https://github.com/webx-ui/webx-ui) admin
+panel: recipes — a gallery, ingredients, a method, nutrition, time and servings — the categories
+they are filed under, and what they are rich in.
+
+The other half is the Composer package `webx-ui/module-recipes`, which owns the recipes, their
+pages and addresses, the `Recipe` markup, the Recipes block, `recipes()` for templates and the
+API. A section appears in the panel when both halves are installed.
+
+## Install
+
+```bash
+npm install @webx-ui/module-recipes
+```
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { recipes } from '@webx-ui/module-recipes'
+import '@webx-ui/module-recipes/style.css'
+
+createAdmin({
+  basePath: '/cms',
+  modules: [...recipes()],
+}).mount()
+```
+
+`recipes()` answers with three sections — the recipes, their categories and "Rich in" — because
+the panel draws one entry per module. The server puts all three in the `recipes` group.
+`recipes({ path: '/cookbook' })` puts them somewhere else inside the panel.
+
+## What is here
+
+- **The list** — every recipe at once, in the one order the site shows them. Recipes have no order
+  inside a category or a service, so the list can be dragged only while nothing narrows it; with a
+  filter on, the line under it says why the grips are gone.
+- **The editor** — the described screen `recipes.form` with the tabs Recipe · Settings · SEO ·
+  History, autosaved into a draft and guarded by a revision. The categories, the nutrients, the
+  services and the similar recipes wait in the draft with the text and reach the site on
+  "Publish". A project adds its own fields with a patch into the `project-fields` card.
+- **Categories and "Rich in"** — the panel's shared category screens (`categoryRoutes`), with
+  `recipeCategoriesOptions()` and `recipeNutrientsOptions()` exported for a panel that mounts them
+  elsewhere.
+
+The words are English by default and come from the server in the panel's language
+(`webx-recipes::`).

package/dist/RecipeCreateDialog.d.ts

@@ -0,0 +1,4 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
+    field: HTMLDivElement;
+}, any>;
+export default _default;

package/dist/RecipeEditorPage.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The editor of one recipe: a head that stays put, the described screen under it, and the bar
+ * along the bottom where it is saved and published (§5.9).
+ *
+ * Everything between the head and the bar is `recipes.form` — the recipe, its settings, the SEO
+ * card `module-seo` patches on and the history — so a project adds its own field (an author's
+ * note) with a patch rather than a fork of this file. Saving is by autosave into the draft, and
+ * the draft carries the categories, the services and the similar recipes too: the site changes,
+ * all of it at once, only on "Publish". Edits are guarded by a revision: a save over somebody
+ * else's is refused with a 409 and the question of which version the site gets.
+ */
+type __VLS_Props = {
+    base?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/RecipeHistory.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+export default _default;

package/dist/RecipesPage.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Every recipe at once, in the order the site shows them (§5.9).
+ *
+ * No paginator: this list is where recipes are put in order, and a drag cannot cross a page
+ * boundary. Recipes have one order and only one (decision 4) — no order inside a category, none
+ * inside a service — so the grips are there only while the list is the whole of it. Any filter
+ * makes it a selection with invisible gaps in it, the grips go away and the line under the list
+ * says why: that is the difference from services, where a category has an order of its own.
+ *
+ * A row is a card rather than a line of cells, which is what makes the same list work on a
+ * phone: the picture, the name and the address on one side, the categories and the state beside
+ * them on a wide screen and under them on a narrow one.
+ */
+type __VLS_Props = {
+    base?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/api.d.ts

@@ -0,0 +1,35 @@
+import { AdminContext } from '@webx-ui/module-admin';
+import { RecipeDetail, RecipeInput, RecipeQuery, RecipeRow, RecipeSave, RecipesList, RecipeVersion } from './types';
+export interface RecipesApi {
+    /** Every recipe, with what the list can be narrowed by. */
+    list(query?: RecipeQuery): Promise<RecipesList>;
+    /** One recipe as its editor opens it: the record, the screen's values and the revision. */
+    get(id: number): Promise<RecipeDetail>;
+    /** A new recipe, made in one transaction: a refused address leaves no bare row behind. */
+    create(input: RecipeInput): Promise<Pick<RecipeDetail, 'recipe' | 'values'>>;
+    /**
+     * Save the draft. Refused with a 409 when the revision is stale — the body is a
+     * {@link RecipeConflict} with the recipe as it now is.
+     */
+    save(id: number, input: RecipeSave): Promise<RecipeDetail>;
+    /** Throw away what is waiting and keep what the site is showing. */
+    discard(id: number): Promise<RecipeDetail>;
+    publish(id: number): Promise<RecipeRow>;
+    unpublish(id: number): Promise<RecipeRow>;
+    remove(id: number): Promise<void>;
+    restore(id: number): Promise<RecipeRow>;
+    /** The publications, newest first. */
+    versions(id: number): Promise<RecipeVersion[]>;
+    /** An old publication becomes the draft; putting it on the site is a separate step. */
+    restoreVersion(id: number, number: number): Promise<RecipeDetail>;
+    /** The one order recipes have — never a category's (decision 4). */
+    reorder(ids: number[]): Promise<void>;
+}
+/** The path of the list under the panel's API. */
+export declare const RECIPES_API = "recipes";
+/**
+ * Everything under `/recipes`, below the panel's API path — except the categories and the
+ * nutrients, which are the panel's shared category API under `recipes/categories` and
+ * `recipes/nutrients`.
+ */
+export declare function createRecipesApi(admin: AdminContext): RecipesApi;

package/dist/editor.d.ts

@@ -0,0 +1,19 @@
+import { InjectionKey, Ref } from 'vue';
+import { RecipeRow } from './types';
+/**
+ * What the editor knows and the nodes of `recipes.form` do not: the recipe being edited, and a
+ * way to read it again. The history needs both — its list is keyed by the recipe, and a restored
+ * version has to reach the fields the form is bound to.
+ */
+export interface RecipeEditorContext {
+    /** The recipe as the server last answered it, or `null` while the first request is out. */
+    recipe: Ref<RecipeRow | null>;
+    /** Whether this administrator may write at all. */
+    canManage: boolean;
+    /** Ask the server for the recipe again — after a restore, a publication, a discard. */
+    reload(): Promise<void>;
+}
+export declare const recipeEditorKey: InjectionKey<RecipeEditorContext>;
+export declare function provideRecipeEditor(editor: RecipeEditorContext): void;
+/** The editor above this node, or `null` outside one — a demo or a test draws nothing. */
+export declare function useRecipeEditor(): RecipeEditorContext | null;

package/dist/i18n.d.ts

@@ -0,0 +1,2 @@
+/** Puts this package's English under the panel's dictionary, once per panel. */
+export declare function useRecipesMessages(): void;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { recipes, recipeCategoriesOptions, recipeNutrientsOptions, type RecipesOptions, } from './module';
+export { createRecipesApi, RECIPES_API, type RecipesApi } from './api';
+export { recipesMessages } from './messages';
+export { formatMinutes } from './minutes';
+export { provideRecipeEditor, recipeEditorKey, useRecipeEditor, type RecipeEditorContext, } from './editor';
+export { default as WxRecipesPage } from './RecipesPage';
+export { default as WxRecipeCreateDialog } from './RecipeCreateDialog';
+export { default as WxRecipeEditorPage } from './RecipeEditorPage';
+export { default as WxRecipeHistory } from './RecipeHistory';
+export type { RecipeConflict, RecipeDetail, RecipeInput, RecipeQuery, RecipeRow, RecipeSave, RecipesList, RecipeStatus, RecipeTermRef, RecipeVersion, } from './types';