@elaraai/e3-ui-components 1.0.83 → 1.0.85

package/dist/query/model/cards.d.ts

@@ -0,0 +1,179 @@
+import { EastType } from '@elaraai/east';
+import { CheckedSteps, StepFix } from '../steps/check.js';
+import { Step, StepQuery } from '../steps/values.js';
+import { ActionRef, InputRef, RemoveRef, SlotRef } from './refs.js';
+import { QueryWords } from './words.js';
+/** One part of a card's row. */
+export type CardPart = 
+/** Words; a joiner (`and`, `or`) sits in the joiner column. */
+{
+    readonly t: "word";
+    readonly text: string;
+    readonly joiner?: boolean;
+}
+/** A slot: what it shows, its placeholder while empty, and whether it reads as data or has a problem. */
+ | {
+    readonly t: "slot";
+    readonly slot: SlotRef;
+    readonly text: string;
+    readonly empty: boolean;
+    readonly placeholder: string;
+    readonly mono: boolean;
+    readonly error: boolean;
+}
+/** An input: a count, a name, a value or a bound. */
+ | {
+    readonly t: "input";
+    readonly input: InputRef;
+    readonly value: string;
+    readonly width: "count" | "name" | "value" | "range";
+    readonly mono: boolean;
+    readonly error: boolean;
+}
+/** A chip with its ×: a field a Look up brings in. */
+ | {
+    readonly t: "chip";
+    readonly text: string;
+    readonly remove: RemoveRef;
+}
+/** An add: a foot's, or Look up's Add field. */
+ | {
+    readonly t: "add";
+    readonly text: string;
+    readonly action: ActionRef;
+    readonly ghost: boolean;
+}
+/** A row's ×. */
+ | {
+    readonly t: "remove";
+    readonly label: string;
+    readonly target: RemoveRef;
+}
+/** A jq step's code. */
+ | {
+    readonly t: "code";
+    readonly text: string;
+};
+/** A problem under a row: its plain words, the checker's, and its fixes. */
+export interface ProblemLine {
+    /** An error, a warning, or a jq step's note. */
+    readonly severity: "error" | "warning" | "note";
+    /** Its code. */
+    readonly code: string;
+    /** The plain sentence. */
+    readonly text: string;
+    /** The checker's own sentence, one step away (on hover). */
+    readonly message: string;
+    /** Its fixes, best first. */
+    readonly fixes: readonly {
+        readonly label: string;
+        readonly fix: StepFix;
+    }[];
+}
+/** One line of a card. */
+export interface CardLine {
+    /** A row of parts; a group, with its own head and lines; a foot of adds; a note; a jq step's code. */
+    readonly kind: "row" | "group" | "foot" | "note" | "code";
+    /** Its parts. */
+    readonly parts: readonly CardPart[];
+    /** A group's head: its match and its words. */
+    readonly head?: readonly CardPart[];
+    /** A group's lines. */
+    readonly lines?: readonly CardLine[];
+    /** The problems under it. */
+    readonly problems: readonly ProblemLine[];
+}
+/** The line between two steps: the shape in words. */
+export interface ShapeLine {
+    /** The shape, or the count after a fresh run — `16 shipped orders`. */
+    readonly text: string;
+    /** What changed: `+ name, region` after a Look up or a date part, or the fields after a reshaping step. */
+    readonly extra: string;
+    /** The East type, for hover. */
+    readonly type: string;
+    /** Whether the text is a count. */
+    readonly counted: boolean;
+}
+/** A step's card. */
+export interface Card {
+    /** The step's id. */
+    readonly stepId: string;
+    /** Its place, from 0. */
+    readonly index: number;
+    /** Its kind. */
+    readonly kind: Step["type"];
+    /** Its title. */
+    readonly title: string;
+    /** Its icon. */
+    readonly icon: string;
+    /** Its head: a filter's match, when it has two conditions or more. */
+    readonly head: readonly CardPart[];
+    /** Its lines. */
+    readonly lines: readonly CardLine[];
+    /** Whether it is finished, and so in the program. */
+    readonly complete: boolean;
+    /** Its problems that stop the query running. */
+    readonly errors: number;
+    /** Its warnings, unfinished slots aside. */
+    readonly warnings: number;
+    /** The shape after it. */
+    readonly shape: ShapeLine;
+}
+/** The source's card: what the query starts with. */
+export interface SourceCard {
+    /** `Start with orders`. */
+    readonly title: string;
+    /** The source's plain kind — `list of orders`. */
+    readonly kind: string;
+    /** The shape it gives. */
+    readonly shape: ShapeLine;
+}
+/**
+ * A query's step cards (`Query Editor Spec.md` §4.3, §4.4).
+ *
+ * @param query - the query
+ * @param root - the root's type: a struct of the data sources
+ * @param checked - its check (`checkSteps`)
+ * @param words - the words
+ * @param counts - the rows a fresh run counted, by step id (`readCounts`), so the shape lines count
+ * @returns one card per step, in order
+ */
+export declare function cardsFor(query: StepQuery, root: EastType, checked: CheckedSteps, words: QueryWords, counts?: ReadonlyMap<string, number>): Card[];
+/**
+ * The source's card: `Start with orders`, its plain kind and its shape.
+ *
+ * @param query - the query
+ * @param root - the root's type
+ * @param checked - its check
+ * @param words - the words
+ * @param counts - the rows a fresh run counted (`SOURCE_COUNT` for the source's)
+ * @returns the card
+ */
+export declare function sourceCard(query: StepQuery, root: EastType, checked: CheckedSteps, words: QueryWords, counts?: ReadonlyMap<string, number>): SourceCard;
+/** One line of an outline: a finished step's icon, title and words. */
+export interface OutlineLine {
+    /** The step's icon. */
+    readonly icon: string;
+    /** Its title. */
+    readonly title: string;
+    /** What it does, in words — `status is shipped and total is at least 100`. */
+    readonly words: string;
+}
+/**
+ * A query's outline: one line per finished step, which a library card's
+ * wireframe draws (`Query Editor Spec.md` §5).
+ *
+ * @param query - the query
+ * @param checked - its check, for the rows each step takes
+ * @param words - the words
+ * @returns the lines, in order: each step's icon, title and {@link stepWords}
+ */
+export declare function outlineOf(query: StepQuery, checked: CheckedSteps, words: QueryWords): OutlineLine[];
+/**
+ * The first empty slot of a card: where an added step opens.
+ *
+ * @param card - the card
+ * @returns the slot, or `undefined` when every slot is filled
+ */
+export declare function firstEmptySlot(card: Card): SlotRef | undefined;
+//# sourceMappingURL=cards.d.ts.map

package/dist/query/model/cards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../../../src/query/model/cards.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;GASG;AAEH,OAAO,EAA+B,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAkC,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAK/F,OAAO,EAA0C,KAAK,IAAI,EAAE,KAAK,SAAS,EAAsB,MAAM,oBAAoB,CAAC;AAC3H,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,EAEH,KAAK,UAAU,EAClB,MAAM,YAAY,CAAC;AAEpB,gCAAgC;AAChC,MAAM,MAAM,QAAQ;AAChB,+DAA+D;AAC7D;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE;AAC1E,yGAAyG;GACvG;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE;AAC/K,qDAAqD;GACnD;IAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE;AAClL,sDAAsD;GACpD;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;CAAE;AAC3E,gDAAgD;GAC9C;IAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE;AACnG,iBAAiB;GACf;IAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;CAAE;AAC9E,wBAAwB;GACtB;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD,4EAA4E;AAC5E,MAAM,WAAW,WAAW;IACxB,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IAChD,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,6BAA6B;IAC7B,QAAQ,CAAC,KAAK,EAAE,SAAS;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CAChF;AAED,0BAA0B;AAC1B,MAAM,WAAW,QAAQ;IACrB,sGAAsG;IACtG,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC1D,iBAAiB;IACjB,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC,+CAA+C;IAC/C,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC,uBAAuB;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;IACrC,6BAA6B;IAC7B,QAAQ,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;CAC7C;AAED,sDAAsD;AACtD,MAAM,WAAW,SAAS;IACtB,uEAAuE;IACvE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,2GAA2G;IAC3G,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,gCAAgC;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC7B;AAED,qBAAqB;AACrB,MAAM,WAAW,IAAI;IACjB,qBAAqB;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,yBAAyB;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,iBAAiB;IACjB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sEAAsE;IACtE,QAAQ,CAAC,IAAI,EAAE,SAAS,QAAQ,EAAE,CAAC;IACnC,iBAAiB;IACjB,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC,qDAAqD;IACrD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,0BAA0B;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC7B;AAED,qDAAqD;AACrD,MAAM,WAAW,UAAU;IACvB,2BAA2B;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,kDAAkD;IAClD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC7B;AAoUD;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,EAAE,CAoBjJ;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,UAAU,CAQvJ;AAED,uEAAuE;AACvE,MAAM,WAAW,WAAW;IACxB,uBAAuB;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,iBAAiB;IACjB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,8EAA8E;IAC9E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,GAAG,WAAW,EAAE,CAMnG;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,GAAG,SAAS,CAI9D"}

package/dist/query/model/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+/**
+ * The query builder's model (#934), on top of the canonical steps (#933):
+ * plain words, step cards, slots and autocomplete, summaries and the
+ * generated description — plain TypeScript over East values, with no React,
+ * so the renderers (#935–#939, #1063) stay thin.
+ *
+ * @packageDocumentation
+ */
+export { queryMessages, type KindName, type OneKind, type QueryMessages, type SlotKind, type TotalName, } from './messages.js';
+export { DESCRIPTION_MAX, STEP_ICON, adjectiveOf, conditionWords, countWords, dataNumber, describeQuery, fieldKind, fieldLabel, fieldLabels, fieldSummaryWords, human, isIdName, leafPath, orderKind, parseErrorWords, plainKind, plural, problemWords, queryWords, refLabel, rowsWords, shapeWords, stepWords, valueWords, type ProblemWords, type QueryWords, type SummaryLeaf, } from './words.js';
+export { sameSlot, type ActionRef, type InputKind, type InputRef, type RemoveRef, type SlotRef, type SlotValue } from './refs.js';
+export { cardsFor, firstEmptySlot, outlineOf, sourceCard, type Card, type CardLine, type CardPart, type OutlineLine, type ProblemLine, type ShapeLine, type SourceCard, } from './cards.js';
+export { activeItem, applyAction, applyInput, applyRemove, applySlot, quickAddOptions, slotEmpty, slotHint, slotItems, slotLabel, slotPlaceholder, stepOptions, type SavedOffer, type SlotContext, type SlotItem, type SlotResult, type StepOption, } from './slots.js';
+export { SUMMARY_LIMITS, SummaryCache, leafOf, summaryAt, summaryNeeded, type Summary, type SummaryRequest, type SummaryResult, type SummaryRun, } from './summaries.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/query/model/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/query/model/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AAEH,OAAO,EACH,aAAa,EACb,KAAK,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,QAAQ,EAAE,KAAK,SAAS,GACjF,MAAM,eAAe,CAAC;AACvB,OAAO,EACH,eAAe,EAAE,SAAS,EAC1B,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EACpJ,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAC/H,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,GACvD,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAClI,OAAO,EACH,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,UAAU,EAC/C,KAAK,IAAI,EAAE,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,GAC/G,MAAM,YAAY,CAAC;AACpB,OAAO,EACH,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,WAAW,EACrJ,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,QAAQ,EAAE,KAAK,UAAU,EAAE,KAAK,UAAU,GACrF,MAAM,YAAY,CAAC;AACpB,OAAO,EACH,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAC9D,KAAK,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,UAAU,GACzE,MAAM,gBAAgB,CAAC"}