shutro-erp 0.3.4 → 0.3.6

package/dist/views/types.d.ts

@@ -15,6 +15,11 @@ export interface FieldNode {
     readonly widget?: string;
     readonly readonlyWhen?: Condition;
     readonly visibleWhen?: Condition;
+    /**
+     * Required on the form when this holds (RFC 0022 step 3): the mark, the checklist and the hint; the server's own
+     * constraints stay the authority.
+     */
+    readonly requiredWhen?: Condition;
     /** List columns: show the total. */
     readonly sum?: boolean;
     /** Placeholder / help text. */
@@ -25,6 +30,8 @@ export interface GroupNode {
     readonly kind: 'group';
     readonly id: string;
     readonly label?: string;
+    /** A sentence under the title saying what the section is for (RFC 0022 §3.4). */
+    readonly description?: string;
     readonly columns?: 1 | 2 | 3;
     readonly children: readonly FormNode[];
     readonly visibleWhen?: Condition;
@@ -33,6 +40,7 @@ export interface PageNode {
     readonly kind: 'page';
     readonly id: string;
     readonly label: string;
+    readonly description?: string;
     readonly children: readonly FormNode[];
     readonly visibleWhen?: Condition;
 }
@@ -57,7 +65,36 @@ export interface ComponentNode {
     readonly props?: Readonly<Record<string, unknown>>;
     readonly visibleWhen?: Condition;
 }
-export type FormNode = FieldNode | GroupNode | NotebookNode | LinesNode | ComponentNode;
+/**
+ * A tile of related records (RFC 0022 §3.1): how many — or how much — of another model relate to this record, with
+ * a jump to that list. `where` takes `$record` placeholders (`{ partner: { $record: 'id' } }`); the value is computed
+ * by the server with the user's rights.
+ */
+export interface StatNode {
+    readonly kind: 'stat';
+    readonly id: string;
+    readonly label: string;
+    readonly model: string;
+    readonly where: Condition;
+    /** Default: the count. */
+    readonly measure?: {
+        readonly sum: string;
+    } | {
+        readonly avg: string;
+    };
+    /** The window action that opens the records, filtered the same way. */
+    readonly action?: string;
+    readonly tone?: 'neutral' | 'info' | 'success' | 'warning' | 'danger';
+    readonly visibleWhen?: Condition;
+}
+/** A row of stat tiles; other modules append theirs (`{ append: 'related', nodes: [stat(...)] }`). */
+export interface StatsNode {
+    readonly kind: 'stats';
+    readonly id: string;
+    readonly children: readonly StatNode[];
+    readonly visibleWhen?: Condition;
+}
+export type FormNode = FieldNode | GroupNode | NotebookNode | LinesNode | ComponentNode | StatsNode;
 /** A header button running a state transition. */
 export interface ButtonNode {
     readonly kind: 'button';
@@ -84,6 +121,8 @@ export interface ListView extends ViewBase {
     /** Columns editable in the list. */
     readonly inlineEdit?: readonly string[];
     readonly pageSize?: number;
+    /** RFC 0022 §3.3: rows in a tone when a condition holds on them (overdue in danger, done muted). */
+    readonly decorations?: Readonly<Partial<Record<Tone, Condition>>>;
 }
 export interface FormView extends ViewBase {
     readonly type: 'form';
@@ -104,11 +143,19 @@ export interface FormView extends ViewBase {
     /** The fields of the right rail's Summary (RFC 0018 §4.2). Default: the group named `totals`. */
     readonly summary?: readonly string[];
 }
+/** A semantic tone (RFC 0018 §4.5): meaning only, never decoration. */
+export type Tone = 'info' | 'success' | 'warning' | 'danger' | 'neutral';
 export interface KanbanCard {
     readonly title: string;
     readonly subtitle?: string;
     readonly footer?: readonly FieldNode[];
     readonly badges?: readonly FieldNode[];
+    /** RFC 0022 §3.3: a cover image (an `image` field), a person (a many2one with a photo), a progress (0–100). */
+    readonly image?: string;
+    readonly avatar?: string;
+    readonly progress?: string;
+    /** A selection or char field whose value tints the card's edge. */
+    readonly color?: string;
 }
 export interface KanbanView extends ViewBase {
     readonly type: 'kanban';
@@ -266,16 +313,16 @@ export interface SearchSpec {
 /** An operation of a view extension, on the node with id `anchor`. */
 export type ViewOperation = {
     readonly insertAfter: string;
-    readonly nodes: readonly (FormNode | ButtonNode)[];
+    readonly nodes: readonly (FormNode | ButtonNode | StatNode)[];
 } | {
     readonly insertBefore: string;
-    readonly nodes: readonly (FormNode | ButtonNode)[];
+    readonly nodes: readonly (FormNode | ButtonNode | StatNode)[];
 } | {
     readonly append: string;
-    readonly nodes: readonly (FormNode | ButtonNode)[];
+    readonly nodes: readonly (FormNode | ButtonNode | StatNode)[];
 } | {
     readonly replace: string;
-    readonly nodes: readonly (FormNode | ButtonNode)[];
+    readonly nodes: readonly (FormNode | ButtonNode | StatNode)[];
 } | {
     readonly remove: string;
 } | {

package/dist/views/validate.js

@@ -55,6 +55,22 @@ export function validateView(view, models) {
                 for (const column of node.columns)
                     checkField(column, field.target);
         }
+        if (node.kind === 'stat') {
+            const related = models(node.model);
+            if (related === undefined)
+                problems.push(`stat '${node.id}': the model '${node.model}' is not installed`);
+            else {
+                const measure = node.measure === undefined ? null : Object.values(node.measure)[0];
+                if (typeof measure === 'string' && !related.fields.has(measure))
+                    problems.push(`stat '${node.id}': no field '${measure}' on ${node.model}`);
+                for (const key of Object.keys(node.where))
+                    if (!['and', 'or', 'not'].includes(key) && !key.includes('.') && !related.fields.has(key))
+                        problems.push(`stat '${node.id}': no field '${key}' on ${node.model}`);
+                for (const key of recordKeys(node.where))
+                    if (!info.fields.has(key))
+                        problems.push(`stat '${node.id}': '$record' names no field '${key}' of ${view.model}`);
+            }
+        }
         if (node.kind === 'button' && !info.transitions.includes(node.transition))
             problems.push(`unknown transition '${node.transition}' (has ${info.transitions.join(', ') || 'none'})`);
     }
@@ -71,10 +87,22 @@ export function validateView(view, models) {
         const group = info.fields.get(view.groupBy);
         if (group === undefined || !GROUPABLE.has(group.kind) || !group.stored)
             problems.push(`kanban groupBy '${view.groupBy}' is not a stored selection, state, many2one or char field`);
-        for (const key of [view.card.title, view.card.subtitle].filter((k) => k !== undefined))
+        for (const key of [
+            view.card.title,
+            view.card.subtitle,
+            view.card.image,
+            view.card.avatar,
+            view.card.progress,
+            view.card.color,
+        ].filter((k) => k !== undefined))
             if (pathProblem(models, view.model, key) !== null)
                 problems.push(`unknown card field '${key}'`);
     }
+    if (view.type === 'list')
+        for (const [tone, condition] of Object.entries(view.decorations ?? {}))
+            for (const key of Object.keys(condition ?? {}))
+                if (!['and', 'or', 'not'].includes(key) && !key.includes('.') && !info.fields.has(key))
+                    problems.push(`decoration '${tone}': no field '${key}' on ${view.model}`);
     problems.push(...reportProblems(view, info, models));
     if (view.type === 'list')
         for (const term of view.defaultOrder ?? []) {
@@ -84,6 +112,16 @@ export function validateView(view, models) {
         }
     return problems;
 }
+/** The record fields a condition's `$record` placeholders name. */
+function recordKeys(value) {
+    if (Array.isArray(value))
+        return value.flatMap(recordKeys);
+    if (typeof value !== 'object' || value === null)
+        return [];
+    if ('$record' in value)
+        return [String(value.$record)];
+    return Object.values(value).flatMap(recordKeys);
+}
 function isLineColumn(view, node) {
     return nodesOf(view).some((n) => n.kind === 'lines' && n.columns.includes(node));
 }

package/dist/website/.kosh/bindings.d.ts

@@ -0,0 +1,22 @@
+export { defineModel, defineModule, extendModel, f, replace } from '../../server/orm.js';
+import { type DefinitionHelpers } from '../../server/orm.js';
+import type { DefaultLoaded, Env as CoreEnv, RecordSet as CoreRecordSet, Shutro as CoreShutro } from '../../server/orm.js';
+import type { SchemaView } from './schema.js';
+export type { SchemaView };
+/** Every model visible in this view. */
+export type ModelName = keyof SchemaView & string;
+/** `Env` typed to this view. */
+export type Env = CoreEnv<SchemaView>;
+/** `Shutro` typed to this view. */
+export type Shutro = CoreShutro<SchemaView>;
+/** A recordset of `M`, with the default loaded shape unless `L` is given. */
+export type Records<M extends ModelName, L = DefaultLoaded<SchemaView, M>> = CoreRecordSet<SchemaView, M, L>;
+export declare const compute: DefinitionHelpers<SchemaView>['compute'];
+export declare const check: DefinitionHelpers<SchemaView>['check'];
+export declare const onchange: DefinitionHelpers<SchemaView>['onchange'];
+export declare const records: DefinitionHelpers<SchemaView>['records'];
+export declare const method: DefinitionHelpers<SchemaView>['method'];
+/** Module data (RFC 0017): records, overrides of dependencies' records, and references, typed like creates. */
+export declare const record: DefinitionHelpers<SchemaView>['record'];
+export declare const override: DefinitionHelpers<SchemaView>['override'];
+export declare const ref: DefinitionHelpers<SchemaView>['ref'];

package/dist/website/.kosh/bindings.js

@@ -0,0 +1,15 @@
+// GENERATED by `pnpm generate:models` (Shutro’s generator). Do not edit. definitions-hash: 91d347eb721a67c2
+// Bindings of module `website`: import the definition API from here to get types scoped to what it can see.
+export { defineModel, defineModule, extendModel, f, replace } from '../../server/orm.js';
+import { definitions } from '../../server/orm.js';
+/** Definition callbacks typed against this module's view: no casts in computes, checks, onchange, methods. */
+const helpers = definitions();
+export const compute = helpers.compute;
+export const check = helpers.check;
+export const onchange = helpers.onchange;
+export const records = helpers.records;
+export const method = helpers.method;
+/** Module data (RFC 0017): records, overrides of dependencies' records, and references, typed like creates. */
+export const record = helpers.record;
+export const override = helpers.override;
+export const ref = helpers.ref;