@happyvertical/smrt-planner 0.0.2 → 0.1.0

package/dist/library/pending.json

@@ -0,0 +1,5 @@
+{
+  "note": "Cookbooks whose recipes are not in the catalog yet. Nothing loads this file: when the smrt release that declares the awaited recipes is installed and `pnpm catalog:generate` has run, move each entry into library.json (tests/library-cookbooks.test.ts says when).",
+  "awaiting": {},
+  "cookbooks": []
+}

package/dist/library/types.d.ts

@@ -20,6 +20,10 @@ export interface CookbookSettings {
     paymentTerms?: string;
     /** Default line-item tax rate as a fraction (0.0825 is 8.25%). */
     taxRate?: number;
+    /** New documents' prices include tax (Invoice / Contract `lineAmountType`). */
+    pricesIncludeTax?: boolean;
+    /** Tax rounds per line or once per document (`taxRoundingScope`). */
+    taxRounding?: 'line' | 'document';
 }
 /** A curated, ready-made cookbook with the words that introduce it. */
 export interface LibraryCookbook {

package/dist/motion/tokens.d.ts

@@ -0,0 +1,6 @@
+export type MotionDurationToken = 'instant' | 'short1' | 'short2' | 'short3' | 'short4' | 'medium1' | 'medium2' | 'medium3' | 'medium4' | 'long1' | 'long2' | 'long3' | 'long4';
+/**
+ * `--smrt-duration-<token>` in milliseconds, else `fallback` where the theme
+ * CSS is not loaded (tests, SSR) or the token is missing from this release.
+ */
+export declare function motionDuration(token: MotionDurationToken, fallback: number): number;

package/dist/motion/tokens.js

@@ -0,0 +1,32 @@
+/**
+ * smrt-ui's motion tokens, read for the Svelte transitions and animations
+ * (`animate:flip`) that take a number of milliseconds rather than CSS.
+ *
+ * CSS-side usages should write the token directly with a fallback, e.g.
+ * `var(--smrt-duration-short3, 150ms)`; this is only for the JS side. Reduced
+ * motion collapses every duration to 0 so the animation is skipped outright.
+ */
+import { prefersReducedMotion } from "./view-transition.js";
+const cache = new Map();
+/**
+ * `--smrt-duration-<token>` in milliseconds, else `fallback` where the theme
+ * CSS is not loaded (tests, SSR) or the token is missing from this release.
+ */
+export function motionDuration(token, fallback) {
+    if (prefersReducedMotion())
+        return 0;
+    if (typeof document === 'undefined')
+        return fallback;
+    const cached = cache.get(token);
+    if (cached !== undefined)
+        return cached;
+    const raw = getComputedStyle(document.documentElement)
+        .getPropertyValue(`--smrt-duration-${token}`)
+        .trim();
+    const match = /^([\d.]+)(ms|s)$/.exec(raw);
+    const value = match
+        ? Number(match[1]) * (match[2] === 's' ? 1000 : 1)
+        : fallback;
+    cache.set(token, value);
+    return value;
+}

package/dist/motion/view-transition.d.ts

@@ -0,0 +1,13 @@
+/**
+ * View transitions: the shell's helpers (`@happyvertical/smrt-svelte/app`,
+ * smrt#3858), re-exported so every planner-side caller keeps one import.
+ * `runViewTransition` skips the transition under reduced motion and where the
+ * browser has none; the hash router in `Planner.svelte` and the static app's
+ * `onNavigate` (`createOnNavigateViewTransition`) both go through it.
+ */
+export { createOnNavigateViewTransition, type RunViewTransitionOptions as ViewTransitionOptions, runViewTransition, } from '@happyvertical/smrt-svelte/app';
+/**
+ * True when the visitor's OS or browser asks for reduced motion. The shell
+ * keeps its own check private, so the motion tokens read this one.
+ */
+export declare function prefersReducedMotion(): boolean;

package/dist/motion/view-transition.js

@@ -0,0 +1,17 @@
+/**
+ * View transitions: the shell's helpers (`@happyvertical/smrt-svelte/app`,
+ * smrt#3858), re-exported so every planner-side caller keeps one import.
+ * `runViewTransition` skips the transition under reduced motion and where the
+ * browser has none; the hash router in `Planner.svelte` and the static app's
+ * `onNavigate` (`createOnNavigateViewTransition`) both go through it.
+ */
+export { createOnNavigateViewTransition, runViewTransition, } from '@happyvertical/smrt-svelte/app';
+/**
+ * True when the visitor's OS or browser asks for reduced motion. The shell
+ * keeps its own check private, so the motion tokens read this one.
+ */
+export function prefersReducedMotion() {
+    return (typeof window !== 'undefined' &&
+        typeof window.matchMedia === 'function' &&
+        window.matchMedia('(prefers-reduced-motion: reduce)').matches);
+}

package/dist/overviews/definitions.d.ts

@@ -10,15 +10,54 @@
  */
 import { type OverviewDefinition } from '@happyvertical/smrt-svelte/overview';
 import type { ShellLayout } from '@happyvertical/smrt-svelte/workspace/layout';
+import type { CatalogModel } from '../catalog/types.ts';
 /**
  * The overview a section page renders; one frozen definition per id.
  * `undefined` for an id no overview can have (a hand-edited layout's custom
  * section id outside the overview id pattern): the page then shows its menu.
  */
 export declare function sectionOverview(sectionId: string): OverviewDefinition | undefined;
+/**
+ * A record view's overview id (smrt#3718): `detail:<pkg>.<Model>`, the
+ * catalog package id and class name, one per model kind. Spelled by the
+ * planner, not `recordOverviewId` (which folds the qualified name), so the
+ * key reads like the page's path.
+ */
+export declare function detailOverviewId(packageId: string, modelName: string): string;
+/**
+ * The catalog model a record overview id names, if any: the planner's
+ * `detail:<pkg>.<Model>`, or the framework's `recordOverviewId` form.
+ */
+export declare function detailOverviewModel(id: string): {
+    packageId: string;
+    model: CatalogModel;
+} | undefined;
+/**
+ * The overview a record's view page renders (smrt#3718): the framework's
+ * `recordOverview` over the model's definition and its relations: a summary
+ * strip of `metric` tiles (a count and a money sum per related model), the
+ * `line-items` table and totals when the model has line items, then one
+ * tabbed `related` widget. Widget ids come from the relation, so they are the
+ * same in the narrowed page. Static per model kind over the whole catalog
+ * (every relation's tiles, not only the first four), so a stored override
+ * always resolves against the same widget ids whichever recipes are on;
+ * {@link detailOverviewFor} is the same definition narrowed to the models in
+ * the visitor's app.
+ */
+export declare function detailOverview(id: string): OverviewDefinition | undefined;
+/**
+ * {@link detailOverview} with only the default widgets the app can fill
+ * (`inApp`): tiles over its models (the first four), the line items when
+ * the app has them, the related tabs when any related model is in it. The
+ * ids and the allowed set stay those of the static one.
+ */
+export declare function detailOverviewFor(id: string, inApp: ReadonlySet<string>): OverviewDefinition | undefined;
+/** The definition behind any overview id: a section's or a record view's. */
+export declare function overviewDefinition(id: string): OverviewDefinition | undefined;
 /**
  * Whether `id` names an overview in a cookbook with this layout: a section a
- * recipe suggests, More, or one of the layout's custom sections. Anything else
- * (a typo, a section from another app) is unknown and its override is dropped.
+ * recipe suggests, More, one of the layout's custom sections, or a record
+ * view of a catalog model (`detail:<pkg>.<Model>`). Anything else (a typo, a
+ * section from another app) is unknown and its override is dropped.
  */
 export declare function isOverviewId(id: string, layout?: ShellLayout): boolean;

package/dist/overviews/definitions.js

@@ -8,11 +8,13 @@
  * on), so a saved override always resolves against the same defaults: the
  * cookbook loader, the import and the page agree on what is canonical.
  */
-import { defineOverview, OVERVIEW_PAGE_ID_PATTERN, } from '@happyvertical/smrt-svelte/overview';
-import { catalog } from "../catalog/index.js";
+import { defineOverview, OVERVIEW_DEFAULT_MAX_WIDGETS, OVERVIEW_PAGE_ID_PATTERN, RECORD_OVERVIEW_MAX_METRICS, recordOverview, recordOverviewId, } from '@happyvertical/smrt-svelte/overview';
+import { catalog, getModel } from "../catalog/index.js";
 import { humanize, pluralize } from "../data/format.js";
 import { FEATURE_SECTION } from "../recipes/features.js";
 import { buildNavSections, recipeNav, recipes } from "../recipes/index.js";
+import { screenDefinition } from "../screens/definition.js";
+import { screenRelations } from "../screens/relations.js";
 import { CORE_WIDGET_TYPES, RECIPE_WIDGET_TYPES } from "./registry.js";
 const NAV_SECTIONS = new Map(buildNavSections(recipes).map((section) => [
     `section:${section.id}`,
@@ -82,15 +84,120 @@ export function sectionOverview(sectionId) {
     }
     return definition;
 }
+/**
+ * A record view's overview id (smrt#3718): `detail:<pkg>.<Model>`, the
+ * catalog package id and class name, one per model kind. Spelled by the
+ * planner, not `recordOverviewId` (which folds the qualified name), so the
+ * key reads like the page's path.
+ */
+export function detailOverviewId(packageId, modelName) {
+    return `detail:${packageId}.${modelName}`;
+}
+/**
+ * Exposed models by the framework's own record overview id
+ * (`recordOverviewId(objectRef)`: `detail:happyvertical.smrt-commerce.Customer`),
+ * so an override keyed the way a generated app keys it is a known page here too.
+ */
+const BY_FRAMEWORK_ID = new Map(catalog.packages.flatMap((pkg) => pkg.models
+    .filter((model) => model.exposed)
+    .map((model) => [
+    recordOverviewId(model.id),
+    { packageId: pkg.id, model },
+])));
+/**
+ * The catalog model a record overview id names, if any: the planner's
+ * `detail:<pkg>.<Model>`, or the framework's `recordOverviewId` form.
+ */
+export function detailOverviewModel(id) {
+    const match = /^detail:([A-Za-z0-9_-]+)\.([A-Za-z0-9_]+)$/.exec(id);
+    const [, packageId, modelName] = match ?? [];
+    const model = packageId && modelName ? getModel(packageId, modelName) : undefined;
+    if (packageId && model?.exposed)
+        return { packageId, model };
+    return BY_FRAMEWORK_ID.get(id);
+}
+/** Every exposed model: the relations a detail overview's defaults cover. */
+const EXPOSED = new Set(catalog.packages.flatMap((pkg) => pkg.models.filter((model) => model.exposed).map((model) => model.id)));
+const detailCache = new Map();
+/**
+ * The overview a record's view page renders (smrt#3718): the framework's
+ * `recordOverview` over the model's definition and its relations: a summary
+ * strip of `metric` tiles (a count and a money sum per related model), the
+ * `line-items` table and totals when the model has line items, then one
+ * tabbed `related` widget. Widget ids come from the relation, so they are the
+ * same in the narrowed page. Static per model kind over the whole catalog
+ * (every relation's tiles, not only the first four), so a stored override
+ * always resolves against the same widget ids whichever recipes are on;
+ * {@link detailOverviewFor} is the same definition narrowed to the models in
+ * the visitor's app.
+ */
+export function detailOverview(id) {
+    let definition = detailCache.get(id);
+    if (definition)
+        return definition;
+    const found = detailOverviewModel(id);
+    if (!found)
+        return undefined;
+    const relations = screenRelations(catalog, found.model.id, EXPOSED);
+    const base = recordOverview(screenDefinition(found.model), relations, {
+        id,
+        // Every relation's tiles: the narrowed page keeps the first four in the app.
+        maxMetrics: 2 * relations.length,
+    });
+    // The whole catalog relates more models to a customer than one app ever
+    // shows; the defaults must fit, and the visitor still gets room to add.
+    definition = defineOverview({
+        ...base,
+        maxWidgets: Math.max(base.maxWidgets ?? OVERVIEW_DEFAULT_MAX_WIDGETS, base.defaults.length + OVERVIEW_DEFAULT_MAX_WIDGETS),
+    });
+    detailCache.set(id, definition);
+    return definition;
+}
+/**
+ * {@link detailOverview} with only the default widgets the app can fill
+ * (`inApp`): tiles over its models (the first four), the line items when
+ * the app has them, the related tabs when any related model is in it. The
+ * ids and the allowed set stay those of the static one.
+ */
+export function detailOverviewFor(id, inApp) {
+    const full = detailOverview(id);
+    const found = detailOverviewModel(id);
+    if (!full || !found)
+        return undefined;
+    const relations = screenRelations(catalog, found.model.id, inApp);
+    let tiles = 0;
+    const defaults = full.defaults.filter((widget) => {
+        if (widget.type === 'line-items') {
+            return relations.some((r) => r.kind === 'items');
+        }
+        if (widget.type === 'related') {
+            return relations.some((r) => r.kind === 'children');
+        }
+        if (!inApp.has(String(widget.options.model)))
+            return false;
+        if (widget.type !== 'metric')
+            return true;
+        tiles += 1;
+        return tiles <= RECORD_OVERVIEW_MAX_METRICS;
+    });
+    return defineOverview({ ...full, defaults });
+}
+/** The definition behind any overview id: a section's or a record view's. */
+export function overviewDefinition(id) {
+    return id.startsWith('detail:') ? detailOverview(id) : sectionOverview(id);
+}
 /**
  * Whether `id` names an overview in a cookbook with this layout: a section a
- * recipe suggests, More, or one of the layout's custom sections. Anything else
- * (a typo, a section from another app) is unknown and its override is dropped.
+ * recipe suggests, More, one of the layout's custom sections, or a record
+ * view of a catalog model (`detail:<pkg>.<Model>`). Anything else (a typo, a
+ * section from another app) is unknown and its override is dropped.
  */
 export function isOverviewId(id, layout) {
     if (NAV_SECTIONS.has(id) || id === `section:${FEATURE_SECTION.id}`) {
         return true;
     }
+    if (id.startsWith('detail:'))
+        return detailOverviewModel(id) !== undefined;
     return (id.startsWith('custom:') &&
         OVERVIEW_PAGE_ID_PATTERN.test(id) &&
         (layout?.customSections ?? []).some((section) => section.id === id));

package/dist/overviews/models.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The models a section overview's option editor offers: the app's, i.e. the
+ * added recipes' models and the features' entries, each once, labelled as the
+ * menu would. The standalone section page and the mounted `Planner`'s section
+ * view compute the same list from the same inputs.
+ */
+import type { OverviewModelChoice } from '@happyvertical/smrt-svelte/overview';
+import type { Recipe } from '../recipes/types.ts';
+import type { SectionEntry } from '../sections/entries.ts';
+export declare function overviewModelChoices(added: readonly Recipe[], index: ReadonlyMap<string, SectionEntry>): OverviewModelChoice[];

package/dist/overviews/models.js

@@ -0,0 +1,19 @@
+import { humanize, pluralize } from "../data/format.js";
+import { recipeModels } from "../recipes/index.js";
+export function overviewModelChoices(added, index) {
+    const ids = new Set();
+    const choices = [];
+    const offer = (id, name) => {
+        if (ids.has(id))
+            return;
+        ids.add(id);
+        choices.push({ value: id, label: pluralize(humanize(name)) });
+    };
+    for (const recipe of added) {
+        for (const { model } of recipeModels(recipe))
+            offer(model.id, model.name);
+    }
+    for (const entry of index.values())
+        offer(entry.model.id, entry.model.name);
+    return choices;
+}

package/dist/overviews/registry.d.ts

@@ -10,8 +10,10 @@
  * never from option values: an option names a model or field, the loader looks
  * it up in the catalog and asks the `DataSource` for it.
  */
-import { type RecipeExportResolver, type RecipeWidgetSource, type ShortcutNavSection } from '@happyvertical/smrt-svelte/overview';
-import type { DataSource } from '../data/source.ts';
+import { type CookbookShortcutsLoader } from '@happyvertical/smrt-svelte/cookbook';
+import { type ChartWidgetData, type MetricWidgetData, type RecipeExportResolver, type RecipeWidgetSource, type RecordListColumn, type RecordListWidgetData, type ShortcutNavSection, type WidgetLoadContext } from '@happyvertical/smrt-svelte/overview';
+import { type ScreenRelation } from '@happyvertical/smrt-svelte/screens';
+import type { DataSource, ModelRecord } from '../data/source.ts';
 import type { SectionEntry } from '../sections/entries.ts';
 /** The capabilities a section page hands its widgets' loaders. */
 export interface PlannerWidgetContext {
@@ -19,15 +21,99 @@ export interface PlannerWidgetContext {
     source: DataSource;
     /** The shell's resolved sections (renames and hides applied). */
     sections: readonly ShortcutNavSection[];
-    /** Layout item id -> the model and scope it lists, for record counts. */
-    entries: ReadonlyMap<string, SectionEntry>;
+    /**
+     * Layout item id -> the model and scope it lists, for the shortcuts' record
+     * counts. Its own key: under `CookbookApp` the shell sets `entries` to its
+     * own entry map, which knows no scopes.
+     */
+    entryIndex: ReadonlyMap<string, SectionEntry>;
     /** An in-app path with the app query (`appHref`). */
     href: (path: string) => string;
+    /**
+     * The record a detail overview is rendered on (smrt#3718 record view): what
+     * a widget's `filter: 'parent'` confines its rows to. Absent on a section
+     * page.
+     */
+    record?: {
+        model: string;
+        id: string;
+    };
+    /**
+     * A record page's relations in the visitor's app (`screenRelations`): the
+     * tabs of its `related` widget and the lines of its `line-items` widget.
+     */
+    relations?: readonly ScreenRelation[];
+    /** A related tab's "View all" link. */
+    viewAllHref?: (relation: ScreenRelation) => string | undefined;
 }
 /** The registry every planner overview uses. */
 export declare const overviewRegistry: import("@happyvertical/smrt-svelte/overview").WidgetRegistry;
+/**
+ * `metric`: a count, or the sum / average / min / max of one numeric field,
+ * over the model's sample rows. Money fields stay integer minor units.
+ */
+declare function loadMetric(options: Record<string, unknown>, ctx: WidgetLoadContext): Promise<MetricWidgetData>;
+/**
+ * Footer sums over EVERY matching row, not only the page shown: the money
+ * (integer minor units) and quantity columns, never one marked
+ * `summarize: false` (a unit price).
+ */
+export declare function recordSummaries(columns: readonly RecordListColumn[], rows: readonly ModelRecord[]): Record<string, number>;
+/**
+ * `records`: the first `limit` sample rows, optionally sorted by a field;
+ * each row links to its record page and carries `cells` for the table's
+ * columns (raw: money in integer minor units, dates as ISO strings, a
+ * reference as its record's label). `summaries` sum the money and quantity
+ * columns over every matching row and `total` counts them, so a footer
+ * under a page of five orders still totals all of them. A sort by a
+ * framework timestamp the samples do not carry (`createdAt`, the record
+ * view's default) falls back to the model's lead date, so "newest" still
+ * means newest.
+ */
+declare function loadRecords(options: Record<string, unknown>, ctx: WidgetLoadContext): Promise<RecordListWidgetData>;
+/**
+ * `chart`: one measure of the model's sample rows grouped by a field. This is
+ * the IN-BROWSER STAND-IN for a runtime report: a generated app's chart
+ * loader hands these same options to the runtime report compiler and renders
+ * what it returns; the planner groups the seeded rows itself so the widget
+ * can be tried before a server exists.
+ *
+ * `groupBy` names a field: a date field is bucketed (days for `7d`/`30d`,
+ * weeks for `90d`, months for `12m`/`all`) with empty buckets kept so a line
+ * stays continuous; any other field groups by value, largest first. Absent,
+ * the model's lead date field is used. `period` is a window back from the
+ * sample clock (`EPOCH`, the fixed "now" of the seeded data) over the
+ * grouped date field, else the lead date field; a model with no date field
+ * ignores it. `measure` is `count`, or `sum` / `avg` of a numeric `field`;
+ * money stays integer minor units. The widget's `style` (bar, line, table,
+ * pie or stat) is rendered by the widget itself from these points: `stat`
+ * headlines the last point against the one before, which on a date axis is
+ * the latest bucket.
+ */
+declare function loadChart(options: Record<string, unknown>, ctx: WidgetLoadContext): Promise<ChartWidgetData>;
+/**
+ * The shortcuts' record counts: a `CookbookShortcutsLoader` that gives each of
+ * the shell's default entries (the section's menu as resolved: renames, hides,
+ * moves) its count of sample rows, in the entry's own scope. The framework
+ * composes it with its entries (`composeShortcutsLoader`): under the mounted
+ * `Planner`'s `CookbookApp` as `loaders.shortcuts`, on the static app's
+ * section pages through {@link overviewRegistry}. An entry the index does not
+ * know (no model) keeps no count.
+ */
+export declare const loadShortcutCounts: CookbookShortcutsLoader;
+/**
+ * The data loaders over the sample source and the shortcuts' counts, for the
+ * mounted `Planner`'s `CookbookApp`, whose registry composes `shortcuts` with
+ * the shell's entries.
+ */
+export declare const plannerLoaders: {
+    metric: typeof loadMetric;
+    records: typeof loadRecords;
+    chart: typeof loadChart;
+    shortcuts: CookbookShortcutsLoader;
+};
 /** The core widget types a section overview offers. */
-export declare const CORE_WIDGET_TYPES: readonly ["shortcuts", "metric", "records", "note"];
+export declare const CORE_WIDGET_TYPES: readonly ["shortcuts", "metric", "records", "chart", "note"];
 export declare const resolveRecipeExport: RecipeExportResolver;
 /** Recipes that declare at least one `widget` surface. */
 export declare const widgetRecipes: readonly RecipeWidgetSource[];
@@ -42,3 +128,4 @@ export declare const RECIPE_WIDGET_TYPES: readonly string[];
  * validation at load sees them; the promise reports what was skipped.
  */
 export declare const recipeWidgets: Promise<import("@happyvertical/smrt-svelte/overview").RecipeWidgetRegistration>;
+export {};