@sme.up/ketchup2 2.5.0 → 2.6.0

package/dist/functional-components/shape/shape-resolver.d.ts

@@ -0,0 +1,61 @@
+import { DataCellShapes, DataObj } from '../../types/data-structures';
+export declare const getNodeShapeHint: (node: {
+    shape?: DataCellShapes | string;
+    name?: string;
+    obj?: DataObj;
+}) => DataCellShapes | string | undefined;
+/**
+ * Infer a shape token from a Smeup object type descriptor.
+ *
+ * When no explicit shape is set on a node and no preferred shape is supplied
+ * by the layout, the object's `t` / `p` fields determine a sensible default
+ * (e.g. `NR` → `INPUT_NUMBER`, `D8` → `DATE`).
+ *
+ * Used by {@link resolveShape} for general-purpose consumers and internally
+ * by `computeShape` (in `cell-utils.ts`) for Cell-specific resolution.
+ *
+ * @param obj - The object type descriptor (`{ t, p }`) from a DataCell / DataNode.
+ * @returns The inferred shape token, or `undefined` if no mapping exists.
+ *
+ * @see resolveShape — the full priority chain for non-Cell consumers.
+ * @see computeShape — the Cell-specific variant that adds shape overrides
+ *                      and parent-component fallbacks on top.
+ */
+export declare const inferShapeFromObj: (obj: DataObj | undefined) => DataCellShapes | string | undefined;
+/**
+ * Determine the concrete shape token for a data node or cell.
+ *
+ * Implements the standard priority chain used by layout-aware consumers:
+ *
+ *   1. **Explicit shape** — `node.shape`, set by the data source.
+ *   2. **Preferred shape** — supplied by the layout context or parent
+ *      component (e.g. via `SlotDescriptor.preferredShape` or a resolved
+ *      navigation mode).
+ *   3. **Object inference** — derived from `node.obj` via
+ *      {@link inferShapeFromObj} (e.g. `NR` → `INPUT_NUMBER`).
+ *   4. **`undefined`** — no shape could be determined; the downstream
+ *      renderer (typically the `<Shape>` router) applies its own
+ *      fallback (usually `LABEL`).
+ *
+ * This sits at **step 2** of the 3-step rendering pipeline:
+ *
+ * | Step | Utility            | Question answered              |
+ * |------|---------------------|-------------------------------|
+ * | 1    | `useSlotResolver`   | *Where* does this node render? |
+ * | 2    | **`resolveShape`**  | *What* shape should it use?    |
+ * | 3    | `<Shape>` router    | *How* to render that shape?    |
+ *
+ * **Not for Cell.** The `<Cell>` component uses `computeShape` instead,
+ * which adds Cell-specific overrides (LABEL → INPUT_NUMBER for NR obj,
+ * TIME → TIMEPICKER, MEMO + URL → LABEL) and parent-component fallbacks.
+ *
+ * @param node - Any object with optional `shape` and `obj` fields.
+ * @param preferredShape - Preferred shape from layout context. Applied when
+ *                         `node.shape` is absent.
+ * @returns The resolved shape token, or `undefined` if undetermined.
+ */
+export declare const resolveShape: (node: {
+    shape?: DataCellShapes | string;
+    obj?: DataObj;
+}, preferredShape?: DataCellShapes | string) => DataCellShapes | string | undefined;
+//# sourceMappingURL=shape-resolver.d.ts.map

package/dist/functional-components/shape/shape-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shape-resolver.d.ts","sourceRoot":"","sources":["../../../src/functional-components/shape/shape-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,OAAO,EAAE,MAAM,6BAA6B,CAAA;AAsC1E,eAAO,MAAM,gBAAgB,GAAI,MAAM;IACrC,KAAK,CAAC,EAAE,cAAc,GAAG,MAAM,CAAA;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,OAAO,CAAA;CACd,KAAG,cAAc,GAAG,MAAM,GAAG,SAO7B,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB,GAC5B,KAAK,OAAO,GAAG,SAAS,KACvB,cAAc,GAAG,MAAM,GAAG,SAa5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,YAAY,GACvB,MAAM;IAAE,KAAK,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,EACxD,iBAAiB,cAAc,GAAG,MAAM,KACvC,cAAc,GAAG,MAAM,GAAG,SAI5B,CAAA"}

package/dist/functional-components/shape/shape-types.d.ts

@@ -0,0 +1,55 @@
+import { ComponentsType, DataCellSetup, DataCellShapes, DataNode, DataTable, DataTree } from '../../types/data-structures';
+import { ObjectProtocolHandler, OptionsRequest, UploadRequest } from '../../types/generic';
+import { BooleanValue } from '../../types/legacy';
+import { ImageTextType } from '../../basic-components/image/image-types';
+export interface ShapeAdapterBridge {
+    structuredData?: DataTree | DataTable;
+    idx?: number;
+    selected?: boolean;
+    presentation?: boolean;
+    QuickActions?: BooleanValue;
+    MultiSelect?: BooleanValue;
+    ImageText?: ImageTextType;
+    onToolbarLoadInitialData?: () => Promise<DataTree>;
+    onToolbarLeafNodeClick?: (action: DataNode) => void;
+    onActionsRequest?: (node: DataNode) => Promise<DataTree>;
+    onActionClick?: (node: DataNode, action: DataNode) => void;
+}
+export interface ShapeAdapterData extends DataCellSetup {
+    data?: unknown;
+    shape?: DataCellShapes | string;
+    Shape?: DataCellShapes | string;
+    bridge?: ShapeAdapterBridge;
+}
+interface ShapePassthroughProps {
+    id?: string;
+    value?: string;
+    decode?: string;
+    icon?: string;
+    placeholderIcon?: string;
+    fun?: string;
+    Drag?: BooleanValue;
+    parentComponent?: ComponentsType;
+    isContentOnly?: boolean;
+    isCompact?: boolean;
+    tooltip?: boolean;
+    isEditable?: boolean;
+    data?: ShapeAdapterData;
+    onOptionsRequest?: OptionsRequest;
+    onUploadRequest?: UploadRequest;
+    onObjectProtocol?: ObjectProtocolHandler;
+    onClick?: (...args: any[]) => void;
+    onKeyDown?: (...args: any[]) => void;
+    onContextMenu?: (...args: any[]) => void;
+}
+export interface ShapeProps extends ShapePassthroughProps {
+    node: DataNode;
+    shape?: DataCellShapes | string;
+    preferredShape?: DataCellShapes | string;
+}
+export interface ShapeAdapterProps extends ShapePassthroughProps {
+    node: DataNode;
+    shape?: DataCellShapes | string;
+}
+export {};
+//# sourceMappingURL=shape-types.d.ts.map

package/dist/functional-components/shape/shape-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shape-types.d.ts","sourceRoot":"","sources":["../../../src/functional-components/shape/shape-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,cAAc,EACd,QAAQ,EACR,SAAS,EACT,QAAQ,EACT,MAAM,6BAA6B,CAAA;AACpC,OAAO,KAAK,EACV,qBAAqB,EACrB,cAAc,EACd,aAAa,EACd,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAA;AAE7E,MAAM,WAAW,kBAAkB;IACjC,cAAc,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IACrC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,wBAAwB,CAAC,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAA;IAClD,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAA;IACnD,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IACxD,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAA;CAC3D;AAED,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,cAAc,GAAG,MAAM,CAAA;IAC/B,KAAK,CAAC,EAAE,cAAc,GAAG,MAAM,CAAA;IAC/B,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B;AAED,UAAU,qBAAqB;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB,eAAe,CAAC,EAAE,cAAc,CAAA;IAChC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,gBAAgB,CAAC,EAAE,cAAc,CAAA;IACjC,eAAe,CAAC,EAAE,aAAa,CAAA;IAC/B,gBAAgB,CAAC,EAAE,qBAAqB,CAAA;IAExC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IAElC,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IAEpC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,UAAW,SAAQ,qBAAqB;IACvD,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,CAAC,EAAE,cAAc,GAAG,MAAM,CAAA;IAC/B,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAA;CACzC;AAED,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;IAC9D,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,CAAC,EAAE,cAAc,GAAG,MAAM,CAAA;CAChC"}

package/dist/functional-components/shape/shape.d.ts

@@ -0,0 +1,5 @@
+import { default as React } from 'react';
+import { ShapeProps } from './shape-types';
+export declare const Shape: React.FC<ShapeProps>;
+export default Shape;
+//# sourceMappingURL=shape.d.ts.map

package/dist/functional-components/shape/shape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shape.d.ts","sourceRoot":"","sources":["../../../src/functional-components/shape/shape.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAI/C,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,UAAU,CAUtC,CAAA;AAED,eAAe,KAAK,CAAA"}

package/dist/functional-components/shape/slot-resolver.d.ts

@@ -0,0 +1,24 @@
+import { LayoutSlotConfig } from './slot-types';
+/**
+ * Route items into named layout slots based on their shape token.
+ *
+ * This is **step 1** of the 3-step rendering pipeline:
+ *
+ * | Step | Utility            | Question answered              |
+ * |------|--------------------|--------------------------------|
+ * | 1    | **`resolveSlots`** | *Where* does this node render? |
+ * | 2    | `resolveShape`     | *What* shape should it use?    |
+ * | 3    | `<Shape>` router   | *How* to render that shape?    |
+ *
+ * Algorithm: builds a shape→slot index from the config's `accepts` sets,
+ * then assigns each item to the first matching slot (respecting `limit`).
+ * Items that don't match or exceed a slot's limit fall to `defaultSlot`.
+ *
+ * @param items - Flat list of items to partition.
+ * @param config - Slot definitions with `accepts` sets and optional `limit`.
+ * @param getShape - Extracts the shape token from an item.
+ * @param defaultSlot - Catch-all slot for unmatched / overflow items.
+ * @returns A record mapping each slot name to its assigned items.
+ */
+export declare function resolveSlots<SlotName extends string, T>(items: readonly T[], config: LayoutSlotConfig<SlotName>, getShape: (item: T) => string | undefined, defaultSlot: SlotName): Record<SlotName, T[]>;
+//# sourceMappingURL=slot-resolver.d.ts.map

package/dist/functional-components/shape/slot-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slot-resolver.d.ts","sourceRoot":"","sources":["../../../src/functional-components/shape/slot-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAEpD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,YAAY,CAAC,QAAQ,SAAS,MAAM,EAAE,CAAC,EACrD,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAClC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,GAAG,SAAS,EACzC,WAAW,EAAE,QAAQ,GACpB,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CA0CvB"}

package/dist/functional-components/shape/slot-types.d.ts

@@ -0,0 +1,27 @@
+import { DataCellShapes } from '../../types/data-structures';
+/**
+ * Describes how a single layout slot accepts and constrains items.
+ *
+ * Used by {@link resolveSlots} (step 1 of the rendering pipeline) to
+ * route data nodes into named layout areas based on their shape token.
+ *
+ * @see LayoutSlotConfig — the per-layout mapping of slot names to descriptors.
+ */
+export interface SlotDescriptor {
+    /** Shape tokens this slot will accept (e.g. `new Set(["IMG", "IMAGE"])`). */
+    readonly accepts?: ReadonlySet<string>;
+    /** Shape to apply when no explicit shape is set on the node. */
+    readonly preferredShape?: DataCellShapes | string;
+    /** Max items this slot will hold; overflow goes to the default slot. */
+    readonly limit?: number;
+}
+/**
+ * Maps each slot name in a layout to its {@link SlotDescriptor}.
+ *
+ * Consumed by {@link resolveSlots} and {@link useSlotResolver} to partition
+ * a flat list of items into named layout areas.
+ */
+export type LayoutSlotConfig<SlotName extends string = string> = {
+    readonly [K in SlotName]?: SlotDescriptor;
+};
+//# sourceMappingURL=slot-types.d.ts.map

package/dist/functional-components/shape/slot-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slot-types.d.ts","sourceRoot":"","sources":["../../../src/functional-components/shape/slot-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAEjE;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IACtC,gEAAgE;IAChE,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAA;IACjD,wEAAwE;IACxE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,IAAI;IAC/D,QAAQ,EAAE,CAAC,IAAI,QAAQ,CAAC,CAAC,EAAE,cAAc;CAC1C,CAAA"}

package/dist/functional-components/shape/useSlotResolver.d.ts

@@ -0,0 +1,13 @@
+import { LayoutSlotConfig } from './slot-types';
+/**
+ * React hook wrapping {@link resolveSlots} with memoisation.
+ *
+ * Partitions `items` into named layout slots on every render where the
+ * inputs change. Returns `undefined` when no config is provided (opt-out).
+ *
+ * Sits at **step 1** of the rendering pipeline — call this once per list,
+ * then use {@link resolveShape} per item (step 2) before passing to the
+ * `<Shape>` router (step 3).
+ */
+export declare function useSlotResolver<SlotName extends string, T>(items: readonly T[], config: LayoutSlotConfig<SlotName> | undefined, getShape: (item: T) => string | undefined, defaultSlot: SlotName): Record<SlotName, T[]> | undefined;
+//# sourceMappingURL=useSlotResolver.d.ts.map

package/dist/functional-components/shape/useSlotResolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSlotResolver.d.ts","sourceRoot":"","sources":["../../../src/functional-components/shape/useSlotResolver.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAGpD;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,QAAQ,SAAS,MAAM,EAAE,CAAC,EACxD,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,SAAS,EAC9C,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,GAAG,SAAS,EACzC,WAAW,EAAE,QAAQ,GACpB,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,GAAG,SAAS,CAKnC"}