@vectoriox/iox-builder 2.3.3 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vectoriox/iox-builder",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "peerDependencies": {
     "@angular/common": ">=20.0.0",
     "@angular/core": ">=20.0.0",

package/types/vectoriox-iox-builder.d.ts

@@ -1,14 +1,14 @@
 import * as i0 from '@angular/core';
 import { ComponentRef, Type, ChangeDetectorRef, OnInit, AfterViewInit, OnChanges, OnDestroy, EventEmitter, ElementRef, ApplicationRef, SimpleChanges, ViewContainerRef, Injector, EnvironmentInjector, InjectionToken, TemplateRef, AfterContentInit, QueryList } from '@angular/core';
+import * as i28 from '@vectoriox/iox-ui';
+import { RelativeSourceSpec, DataSourceEndpoints } from '@vectoriox/iox-ui';
+export { ComponentInstanceRegistryService, VIRTUAL_TRAIT_KEYS, composeVirtualTraits } from '@vectoriox/iox-ui';
 import * as rxjs from 'rxjs';
 import { Subject, Subscription, BehaviorSubject, Observable } from 'rxjs';
 import * as _vectoriox_iox_builder from '@vectoriox/iox-builder';
 import * as i23 from 'primeng/popover';
 import { Popover } from 'primeng/popover';
 import { HttpClient } from '@angular/common/http';
-import * as i28 from '@vectoriox/iox-ui';
-import { DataSourceEndpoints } from '@vectoriox/iox-ui';
-export { ComponentInstanceRegistryService, VIRTUAL_TRAIT_KEYS, composeVirtualTraits } from '@vectoriox/iox-ui';
 import * as i20 from '@angular/cdk/drag-drop';
 import { CdkDragDrop } from '@angular/cdk/drag-drop';
 import * as i18 from '@angular/common';
@@ -69,11 +69,15 @@ declare enum DataSourceType {
     Static = "static",
     /** A VIEW into another variable: `{ from: <alias>, path }` (e.g. galleryImages = product.gallery).
      *  Resolves to the value one (or more) level(s) into a parent variable — page-scoped. */
-    Derived = "derived"
+    Derived = "derived",
+    /** A ROUTE-CONTEXT value derived from the current route item — `$route`/`$current`/`$siblings`/
+     *  `$related`. Not fetched: computed by the shared `computeRelative` from other resolved sources.
+     *  See relative-data-sources-plan.md. */
+    Relative = "relative"
 }
 interface IoxDataSource {
     id: string;
-    type: 'cms' | 'shop' | 'internal-api' | 'external-api' | 'static' | 'derived';
+    type: 'cms' | 'shop' | 'internal-api' | 'external-api' | 'static' | 'derived' | 'relative';
     mode: 'single' | 'query';
     alias: string;
     request: {
@@ -84,6 +88,9 @@ interface IoxDataSource {
             from: string;
             path: string;
         };
+        /** `relative` alias: a route-context computation (kind + from/subjectFrom/sortBy/matchFields…),
+         *  resolved by the shared `computeRelative`. */
+        relative?: RelativeSourceSpec;
         cms?: {
             contentType: string;
             filter?: any;
@@ -414,6 +421,23 @@ declare function arraySchemaFields(properties: Record<string, any>): {
     label: string;
     value: string;
 }[];
+/**
+ * Describe the ITEM shape of an array PROPERTY, straight from the schema — the authoritative source
+ * (a resolved sample may be missing, or ambiguous). Given a resource's schema `properties` and the
+ * dot-path to an array field (e.g. `gallery` or `info.items`):
+ *   - **object item** → its primitive leaf fields (flattened): `[{label:'url',value:'url'}, …]`.
+ *   - **primitive item** (`string[]`/`number[]`) → `isPrimitive:true` (caller offers "(the item value)").
+ *   - **can't tell** (many-relation whose items are related docs, or path not found) → both empty, so
+ *     the caller falls back to a resolved sample.
+ * JSON-schema arrays store the item schema under `.items`; embedded objects under `.properties`.
+ */
+declare function arrayItemSchemaFields(properties: Record<string, any>, arrayPath: string): {
+    fields: {
+        label: string;
+        value: string;
+    }[];
+    isPrimitive: boolean;
+};
 
 declare enum PanelTypes {
     BINDINGS = "Bindings",
@@ -1783,8 +1807,14 @@ declare class BuilderDataSourceService {
     fetchRepeaterItems(ds: IoxDataSource | undefined, sourcePath?: string): Observable<any[]>;
     /**
      * Resolve a data source BY ALIAS, following `derived` aliases (a VIEW into another variable:
-     * resolve the parent, then getByPath). `findByAlias` is injected so this module stays registry-free
-     * (the caller passes its own page-scoped registry). Recurses for chained derived aliases.
+     * resolve the parent, then getByPath) and `relative` aliases (route-context — `$current`/
+     * `$siblings`/`$related`). `findByAlias` is injected so this module stays registry-free (the caller
+     * passes its own page-scoped registry). Recurses for chained aliases.
+     *
+     * The builder is design time: `relative` sources resolve their dependency aliases (subject +
+     * collection) — a single source falls back to its `defaultId`, a list to the whole collection —
+     * then run the SHARED `computeRelative`, so the canvas shows the SAME neighbours the SSR engine
+     * bakes into the live page. `$route` has no live params at design time → `{}`.
      */
     fetchByAlias(alias: string, findByAlias: (a: string) => IoxDataSource | undefined): Observable<any>;
     /** Repeater items for an alias (follows derived aliases + applies an optional sourcePath). */
@@ -2273,5 +2303,5 @@ declare class TextBlockComponentConfig extends ComponentConfig {
     constructor();
 }
 
-export { ACTION_TYPE_OPTIONS, BackgroundGroupStyleConfig, BorderGroupStyleConfig, BuilderButtonBlockComponent, BuilderButtonComponentConfig, BuilderClipboardService, BuilderComponent, BuilderContainerComponent, BuilderContainerComponentConfig, BuilderDataSourceService, BuilderDividerComponentConfig, BuilderHeadingComponentConfig, BuilderHistoryService, BuilderIconComponentConfig, BuilderImageComponentConfig, BuilderLinkComponentConfig, BuilderLinkedContainerComponent, BuilderLinkedContainerConfig, BuilderListComponentConfig, BuilderListItemComponentConfig, BuilderMode, BuilderRepeaterComponent, BuilderSpacerComponentConfig, ButtonBlockComponentConfig, CardComponentConfig, ComponentConfig, ComponentRegistryService, DEVICE_OPTIONS, DataSourceRegistryService, DataSourceType, DeviceMode, DimensionsGroupStyleConfig, DragEngineService, EASING_OPTIONS, EffectsGroupStyleConfig, GroupStyleConfig, INTERACTION_STATES, INVERSE_ACTION, IOX_DATA_SOURCE_ENDPOINTS, IOX_FONT_MANAGER, InteractionEngineService, InteractionPresetRegistryService, InteractionsPanelComponent, IoxBuilderModule, IoxDraggableDirective, IoxDropzoneDirective, LayerTreeComponent, LayoutGroupStyleConfig, ListGroupStyleConfig, NodeAction, OverlayComponent, OverlayService, PanelChildComponent, PanelComponent, PanelEventService, PanelEventTypes, PanelTypes, PositionGroupStyleConfig, PresetRegistryService, RELATIONAL_STATES, RELATIONAL_STATE_BASE, ROUTE_ANIMATION_OPTIONS, RenderDirective, RepeaterComponentConfig, SCREEN_WIDTH_OPTIONS, STRUCTURAL_STATES, SUPPORTED_STATES, SectionComponent, SectionComponentConfig, SizeGroupStyleConfig, SliderContainerComponent, SliderContainerConfig, SliderSlideComponent, SliderSlideConfig, SpacingGroupStyleConfig, StyleCategory, StyleRegistryService, TraitConfig as StyleTraitConfig, SymbolRegistryService, TRIGGER_OPTIONS, TextBlockComponentConfig, ToolbarAction, ToolbarComponent, TraitConfig, TraitInputType, TypographyGroupStyleConfig, UNITS_ALL, UNITS_DEG, UNITS_FIXED, UNITS_NO_VW, ViewportService, ZOOM_OPTIONS, arraySchemaFields, buildFullStyleTraits, buildPresetStyleTraits, defaultPageSettings, flattenSchemaFields, generateNodeId, resolveTraitControllerType, resolveTraitOptions };
+export { ACTION_TYPE_OPTIONS, BackgroundGroupStyleConfig, BorderGroupStyleConfig, BuilderButtonBlockComponent, BuilderButtonComponentConfig, BuilderClipboardService, BuilderComponent, BuilderContainerComponent, BuilderContainerComponentConfig, BuilderDataSourceService, BuilderDividerComponentConfig, BuilderHeadingComponentConfig, BuilderHistoryService, BuilderIconComponentConfig, BuilderImageComponentConfig, BuilderLinkComponentConfig, BuilderLinkedContainerComponent, BuilderLinkedContainerConfig, BuilderListComponentConfig, BuilderListItemComponentConfig, BuilderMode, BuilderRepeaterComponent, BuilderSpacerComponentConfig, ButtonBlockComponentConfig, CardComponentConfig, ComponentConfig, ComponentRegistryService, DEVICE_OPTIONS, DataSourceRegistryService, DataSourceType, DeviceMode, DimensionsGroupStyleConfig, DragEngineService, EASING_OPTIONS, EffectsGroupStyleConfig, GroupStyleConfig, INTERACTION_STATES, INVERSE_ACTION, IOX_DATA_SOURCE_ENDPOINTS, IOX_FONT_MANAGER, InteractionEngineService, InteractionPresetRegistryService, InteractionsPanelComponent, IoxBuilderModule, IoxDraggableDirective, IoxDropzoneDirective, LayerTreeComponent, LayoutGroupStyleConfig, ListGroupStyleConfig, NodeAction, OverlayComponent, OverlayService, PanelChildComponent, PanelComponent, PanelEventService, PanelEventTypes, PanelTypes, PositionGroupStyleConfig, PresetRegistryService, RELATIONAL_STATES, RELATIONAL_STATE_BASE, ROUTE_ANIMATION_OPTIONS, RenderDirective, RepeaterComponentConfig, SCREEN_WIDTH_OPTIONS, STRUCTURAL_STATES, SUPPORTED_STATES, SectionComponent, SectionComponentConfig, SizeGroupStyleConfig, SliderContainerComponent, SliderContainerConfig, SliderSlideComponent, SliderSlideConfig, SpacingGroupStyleConfig, StyleCategory, StyleRegistryService, TraitConfig as StyleTraitConfig, SymbolRegistryService, TRIGGER_OPTIONS, TextBlockComponentConfig, ToolbarAction, ToolbarComponent, TraitConfig, TraitInputType, TypographyGroupStyleConfig, UNITS_ALL, UNITS_DEG, UNITS_FIXED, UNITS_NO_VW, ViewportService, ZOOM_OPTIONS, arrayItemSchemaFields, arraySchemaFields, buildFullStyleTraits, buildPresetStyleTraits, defaultPageSettings, flattenSchemaFields, generateNodeId, resolveTraitControllerType, resolveTraitOptions };
 export type { BuilderClipboard, ComponentEventDef, ComponentMethodDef, ComponentNode, ComponentTrait, DeviceOption, DragPayload, DsFilterByQueryParam, DsFilterByRouteParam, ElementState, HistoryEntry, InteractionAction, InteractionActionType, InteractionPreset, InteractionTrigger, IoxBinding, IoxDataSource, IoxDropEvent, IoxFontManager, IoxInteraction, IoxSymbol, NodeRef, OverlayBoxModel, OverlayBoxSpacing, OverlayEntry, PageRouteAnimationSettings, PageScrollSettings, PageSettings, PageStyleSettings, PanelEvent, QuadSizeSegment, RouteAnimationPreset, ScreenWidthOption, StylePreset, StyleTrait, StyleTraitGroup, TraitOptionMap, TraitSelectOption, TraitShowCondition, ViewportState, ZoomOption };