@mintplayer/ng-spark 0.0.1 → 0.0.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mintplayer/ng-spark",
   "private": false,
-  "version": "0.0.1",
+  "version": "0.0.5",
   "description": "Angular component library for MintPlayer.Spark CRUD applications",
   "repository": {
     "type": "git",

package/types/mintplayer-ng-spark.d.ts

@@ -1,5 +1,5 @@
 import * as _angular_core from '@angular/core';
-import { InjectionToken, TemplateRef, QueryList, PipeTransform, Provider } from '@angular/core';
+import { InjectionToken, Type, TemplateRef, PipeTransform, InputSignal, Provider } from '@angular/core';
 import { Color } from '@mintplayer/ng-bootstrap';
 import { DatatableSettings } from '@mintplayer/ng-bootstrap/datatable';
 import { PaginationResponse } from '@mintplayer/pagination';
@@ -53,6 +53,11 @@ interface PersistentObjectAttribute {
     showedOn?: ShowedOn | string;
     isValueChanged?: boolean;
     rules: ValidationRule[];
+    group?: string;
+    /** Renderer component name for custom display in detail/list views */
+    renderer?: string;
+    /** Options passed to the renderer component */
+    rendererOptions?: Record<string, any>;
 }
 
 interface PersistentObject {
@@ -90,6 +95,30 @@ interface EntityAttributeDefinition {
      */
     showedOn?: ShowedOn | string;
     rules: ValidationRule[];
+    /** References an AttributeGroup.id to assign this attribute to a group */
+    group?: string;
+    /** Number of grid columns this attribute spans within a tab's column layout */
+    columnSpan?: number;
+    /** Renderer component name for custom display in detail/list views */
+    renderer?: string;
+    /** Options passed to the renderer component */
+    rendererOptions?: Record<string, any>;
+}
+interface AttributeTab {
+    id: string;
+    name: string;
+    label?: TranslatedString;
+    order: number;
+    /** Number of columns for the grid layout within this tab */
+    columnCount?: number;
+}
+interface AttributeGroup {
+    id: string;
+    name: string;
+    label?: TranslatedString;
+    /** References an AttributeTab.id to assign this group to a tab */
+    tab?: string;
+    order: number;
 }
 interface EntityType {
     id: string;
@@ -106,6 +135,8 @@ interface EntityType {
      * (Fallback) Single attribute name to use as display value when displayFormat is not specified.
      */
     displayAttribute?: string;
+    tabs?: AttributeTab[];
+    groups?: AttributeGroup[];
     attributes: EntityAttributeDefinition[];
 }
 
@@ -274,31 +305,15 @@ declare class RetryActionService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<RetryActionService>;
 }
 
-interface SparkFieldTemplateContext {
-    $implicit: EntityAttributeDefinition;
-    formData: Record<string, any>;
-    value: any;
-    hasError: boolean;
-    errorMessage: TranslatedString | null;
-}
-declare class SparkFieldTemplateDirective {
-    template: TemplateRef<SparkFieldTemplateContext>;
-    name: _angular_core.InputSignal<string>;
-    constructor(template: TemplateRef<SparkFieldTemplateContext>);
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkFieldTemplateDirective, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<SparkFieldTemplateDirective, "[sparkFieldTemplate]", never, { "name": { "alias": "sparkFieldTemplate"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
 declare class SparkPoFormComponent {
     private readonly sparkService;
     private readonly translations;
-    fieldTemplates: QueryList<SparkFieldTemplateDirective>;
+    private readonly rendererRegistry;
     entityType: _angular_core.InputSignal<EntityType>;
     formData: _angular_core.ModelSignal<Record<string, any>>;
     validationErrors: _angular_core.InputSignal<ValidationError[]>;
     showButtons: _angular_core.InputSignal<boolean>;
     isSaving: _angular_core.InputSignal<boolean>;
-    externalFieldTemplates: _angular_core.InputSignal<SparkFieldTemplateDirective[]>;
     save: _angular_core.OutputEmitterRef<void>;
     cancel: _angular_core.OutputEmitterRef<void>;
     colors: typeof Color;
@@ -324,10 +339,13 @@ declare class SparkPoFormComponent {
     lookupSearchTerm: _angular_core.WritableSignal<string>;
     ELookupDisplayType: typeof ELookupDisplayType;
     editableAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
+    private static readonly DEFAULT_TAB;
+    ungroupedAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
+    resolvedTabs: _angular_core.Signal<AttributeTab[]>;
+    groupsForTab(tab: AttributeTab): AttributeGroup[];
+    attrsForGroup(group: AttributeGroup): EntityAttributeDefinition[];
     referenceVisibleAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
     filteredLookupItems: _angular_core.Signal<LookupReferenceValue[]>;
-    getFieldTemplate(attr: EntityAttributeDefinition): TemplateRef<SparkFieldTemplateContext> | null;
-    getFieldTemplateContext(attr: EntityAttributeDefinition): SparkFieldTemplateContext;
     constructor();
     private toRecord;
     loadReferenceOptions(): Promise<void>;
@@ -338,6 +356,8 @@ declare class SparkPoFormComponent {
     openLookupSelector(attr: EntityAttributeDefinition): void;
     selectLookupItem(item: LookupReferenceValue): void;
     closeLookupModal(): void;
+    getEditRendererComponent(attr: EntityAttributeDefinition): Type<any> | null;
+    getEditRendererInputs(attr: EntityAttributeDefinition): Record<string, any>;
     hasError(attrName: string): boolean;
     onFieldChange(): void;
     onSave(): void;
@@ -356,14 +376,13 @@ declare class SparkPoFormComponent {
     selectReferenceItem(item: PersistentObject): void;
     closeReferenceModal(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkPoFormComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoFormComponent, "spark-po-form", never, { "entityType": { "alias": "entityType"; "required": false; "isSignal": true; }; "formData": { "alias": "formData"; "required": false; "isSignal": true; }; "validationErrors": { "alias": "validationErrors"; "required": false; "isSignal": true; }; "showButtons": { "alias": "showButtons"; "required": false; "isSignal": true; }; "isSaving": { "alias": "isSaving"; "required": false; "isSignal": true; }; "externalFieldTemplates": { "alias": "externalFieldTemplates"; "required": false; "isSignal": true; }; }, { "formData": "formDataChange"; "save": "save"; "cancel": "cancel"; }, ["fieldTemplates"], never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoFormComponent, "spark-po-form", never, { "entityType": { "alias": "entityType"; "required": false; "isSignal": true; }; "formData": { "alias": "formData"; "required": false; "isSignal": true; }; "validationErrors": { "alias": "validationErrors"; "required": false; "isSignal": true; }; "showButtons": { "alias": "showButtons"; "required": false; "isSignal": true; }; "isSaving": { "alias": "isSaving"; "required": false; "isSignal": true; }; }, { "formData": "formDataChange"; "save": "save"; "cancel": "cancel"; }, never, never, true, never>;
 }
 
 declare class SparkPoCreateComponent {
     private readonly route;
     private readonly router;
     private readonly sparkService;
-    fieldTemplates: QueryList<SparkFieldTemplateDirective>;
     saved: _angular_core.OutputEmitterRef<PersistentObject>;
     cancelled: _angular_core.OutputEmitterRef<void>;
     colors: typeof Color;
@@ -380,14 +399,13 @@ declare class SparkPoCreateComponent {
     onSave(): Promise<void>;
     onCancel(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkPoCreateComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoCreateComponent, "spark-po-create", never, {}, { "saved": "saved"; "cancelled": "cancelled"; }, ["fieldTemplates"], never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoCreateComponent, "spark-po-create", never, {}, { "saved": "saved"; "cancelled": "cancelled"; }, never, never, true, never>;
 }
 
 declare class SparkPoEditComponent {
     private readonly route;
     private readonly router;
     private readonly sparkService;
-    fieldTemplates: QueryList<SparkFieldTemplateDirective>;
     saved: _angular_core.OutputEmitterRef<PersistentObject>;
     cancelled: _angular_core.OutputEmitterRef<void>;
     colors: typeof Color;
@@ -406,20 +424,7 @@ declare class SparkPoEditComponent {
     onSave(): Promise<void>;
     onCancel(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkPoEditComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoEditComponent, "spark-po-edit", never, {}, { "saved": "saved"; "cancelled": "cancelled"; }, ["fieldTemplates"], never, true, never>;
-}
-
-interface SparkDetailFieldTemplateContext {
-    $implicit: EntityAttributeDefinition;
-    item: PersistentObject;
-    value: any;
-}
-declare class SparkDetailFieldTemplateDirective {
-    template: TemplateRef<SparkDetailFieldTemplateContext>;
-    name: _angular_core.InputSignal<string>;
-    constructor(template: TemplateRef<SparkDetailFieldTemplateContext>);
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkDetailFieldTemplateDirective, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<SparkDetailFieldTemplateDirective, "[sparkDetailFieldTemplate]", never, { "name": { "alias": "sparkDetailFieldTemplate"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoEditComponent, "spark-po-edit", never, {}, { "saved": "saved"; "cancelled": "cancelled"; }, never, never, true, never>;
 }
 
 declare class SparkPoDetailComponent {
@@ -427,7 +432,7 @@ declare class SparkPoDetailComponent {
     private readonly router;
     private readonly sparkService;
     private readonly lang;
-    detailFieldTemplates: QueryList<SparkDetailFieldTemplateDirective>;
+    private readonly rendererRegistry;
     showCustomActions: _angular_core.InputSignal<boolean>;
     extraActionsTemplate: _angular_core.InputSignal<TemplateRef<void>>;
     extraContentTemplate: _angular_core.InputSignal<TemplateRef<{
@@ -456,8 +461,13 @@ declare class SparkPoDetailComponent {
     constructor();
     private onParamsChange;
     visibleAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
-    getDetailFieldTemplate(attr: EntityAttributeDefinition): TemplateRef<SparkDetailFieldTemplateContext> | null;
-    getDetailFieldContext(attr: EntityAttributeDefinition, item: PersistentObject): SparkDetailFieldTemplateContext;
+    private static readonly DEFAULT_TAB;
+    ungroupedAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
+    resolvedTabs: _angular_core.Signal<AttributeTab[]>;
+    groupsForTab(tab: AttributeTab): AttributeGroup[];
+    attrsForGroup(group: AttributeGroup): EntityAttributeDefinition[];
+    getDetailRendererComponent(attr: EntityAttributeDefinition): Type<any> | null;
+    getDetailRendererInputs(attr: EntityAttributeDefinition, item: PersistentObject): Record<string, any>;
     private loadLookupReferenceOptions;
     private loadAsDetailTypes;
     onCustomAction(action: CustomActionDefinition): Promise<void>;
@@ -465,27 +475,14 @@ declare class SparkPoDetailComponent {
     onDelete(): Promise<void>;
     onBack(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkPoDetailComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoDetailComponent, "spark-po-detail", never, { "showCustomActions": { "alias": "showCustomActions"; "required": false; "isSignal": true; }; "extraActionsTemplate": { "alias": "extraActionsTemplate"; "required": false; "isSignal": true; }; "extraContentTemplate": { "alias": "extraContentTemplate"; "required": false; "isSignal": true; }; }, { "edited": "edited"; "deleted": "deleted"; "customActionExecuted": "customActionExecuted"; }, ["detailFieldTemplates"], never, true, never>;
-}
-
-interface SparkColumnTemplateContext {
-    $implicit: PersistentObject;
-    attr: EntityAttributeDefinition;
-    value: any;
-}
-declare class SparkColumnTemplateDirective {
-    template: TemplateRef<SparkColumnTemplateContext>;
-    name: _angular_core.InputSignal<string>;
-    constructor(template: TemplateRef<SparkColumnTemplateContext>);
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkColumnTemplateDirective, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<SparkColumnTemplateDirective, "[sparkColumnTemplate]", never, { "name": { "alias": "sparkColumnTemplate"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkPoDetailComponent, "spark-po-detail", never, { "showCustomActions": { "alias": "showCustomActions"; "required": false; "isSignal": true; }; "extraActionsTemplate": { "alias": "extraActionsTemplate"; "required": false; "isSignal": true; }; "extraContentTemplate": { "alias": "extraContentTemplate"; "required": false; "isSignal": true; }; }, { "edited": "edited"; "deleted": "deleted"; "customActionExecuted": "customActionExecuted"; }, never, never, true, never>;
 }
 
 declare class SparkQueryListComponent {
     private readonly route;
     private readonly router;
     private readonly sparkService;
-    columnTemplates: QueryList<SparkColumnTemplateDirective>;
+    private readonly rendererRegistry;
     extraActionsTemplate: _angular_core.InputSignal<TemplateRef<void>>;
     rowClicked: _angular_core.OutputEmitterRef<PersistentObject>;
     createClicked: _angular_core.OutputEmitterRef<void>;
@@ -512,13 +509,13 @@ declare class SparkQueryListComponent {
     applyFilter(): void;
     clearSearch(): void;
     visibleAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
-    getColumnTemplate(attr: EntityAttributeDefinition): TemplateRef<SparkColumnTemplateContext> | null;
-    getColumnTemplateContext(item: PersistentObject, attr: EntityAttributeDefinition): SparkColumnTemplateContext;
+    getColumnRendererComponent(attr: EntityAttributeDefinition): Type<any> | null;
+    getColumnRendererInputs(item: PersistentObject, attr: EntityAttributeDefinition): Record<string, any>;
     private loadLookupReferenceOptions;
     onRowClick(item: PersistentObject): void;
     onCreate(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkQueryListComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkQueryListComponent, "spark-query-list", never, { "extraActionsTemplate": { "alias": "extraActionsTemplate"; "required": false; "isSignal": true; }; }, { "rowClicked": "rowClicked"; "createClicked": "createClicked"; }, ["columnTemplates"], never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkQueryListComponent, "spark-query-list", never, { "extraActionsTemplate": { "alias": "extraActionsTemplate"; "required": false; "isSignal": true; }; }, { "rowClicked": "rowClicked"; "createClicked": "createClicked"; }, never, never, true, never>;
 }
 
 declare class SparkRetryActionModalComponent {
@@ -688,6 +685,69 @@ declare class ArrayValuePipe implements PipeTransform {
     static ɵpipe: _angular_core.ɵɵPipeDeclaration<ArrayValuePipe, "arrayValue", true>;
 }
 
+/**
+ * Contract for detail-page renderers (spark-po-detail).
+ * Displays a single attribute value in the PO detail view.
+ */
+interface SparkAttributeDetailRenderer {
+    /** The current attribute value */
+    value: InputSignal<any>;
+    /** The attribute definition metadata */
+    attribute: InputSignal<EntityAttributeDefinition | undefined>;
+    /** Renderer-specific options from rendererOptions */
+    options: InputSignal<Record<string, any> | undefined>;
+    /** The full form data (for cross-field dependencies) */
+    formData: InputSignal<Record<string, any>>;
+}
+/**
+ * Contract for query-list column renderers (spark-query-list).
+ * Displays a compact cell value in the list/grid view.
+ */
+interface SparkAttributeColumnRenderer {
+    /** The current attribute value */
+    value: InputSignal<any>;
+    /** The attribute definition metadata */
+    attribute: InputSignal<EntityAttributeDefinition | undefined>;
+    /** Renderer-specific options from rendererOptions */
+    options: InputSignal<Record<string, any> | undefined>;
+}
+/**
+ * Contract for edit-form renderers (spark-po-form on create/edit pages).
+ * Replaces the default <input> for this attribute.
+ */
+interface SparkAttributeEditRenderer {
+    /** The current attribute value */
+    value: InputSignal<any>;
+    /** The attribute definition metadata */
+    attribute: InputSignal<EntityAttributeDefinition | undefined>;
+    /** Renderer-specific options from rendererOptions */
+    options: InputSignal<Record<string, any> | undefined>;
+    /** Callback to notify parent form of value changes (since NgComponentOutlet doesn't support outputs) */
+    valueChange: InputSignal<(value: any) => void>;
+}
+
+interface SparkAttributeRendererRegistration {
+    /** The renderer name (must match attr.renderer in model JSON) */
+    name: string;
+    /** Component for the PO detail page. Must implement SparkAttributeDetailRenderer. */
+    detailComponent: Type<any>;
+    /** Component for query-list column cells. Must implement SparkAttributeColumnRenderer. */
+    columnComponent: Type<any>;
+    /** Optional component for create/edit forms. Must implement SparkAttributeEditRenderer. When omitted, the default input is used. */
+    editComponent?: Type<any>;
+}
+declare const SPARK_ATTRIBUTE_RENDERERS: InjectionToken<SparkAttributeRendererRegistration[]>;
+/**
+ * Register custom attribute renderers globally.
+ *
+ * @example
+ * provideSparkAttributeRenderers([
+ *   { name: 'video-player', detailComponent: VideoDetailComponent, columnComponent: VideoColumnComponent },
+ *   { name: 'color-swatch', detailComponent: ColorDetailComponent, columnComponent: ColorColumnComponent },
+ * ])
+ */
+declare function provideSparkAttributeRenderers(renderers: SparkAttributeRendererRegistration[]): Provider;
+
 interface SparkRouteConfig {
     queryList?: Route['loadComponent'];
     poCreate?: Route['loadComponent'];
@@ -698,5 +758,5 @@ declare function sparkRoutes(config?: SparkRouteConfig): Routes;
 
 declare function provideSpark(config?: Partial<SparkConfig>): Provider[];
 
-export { ArrayValuePipe, AsDetailCellValuePipe, AsDetailColumnsPipe, AsDetailDisplayValuePipe, AsDetailTypePipe, AttributeValuePipe, CanCreateDetailRowPipe, CanDeleteDetailRowPipe, ELookupDisplayType, ErrorForAttributePipe, IconNamePipe, InlineRefOptionsPipe, InputTypePipe, LookupDisplayTypePipe, LookupDisplayValuePipe, LookupOptionsPipe, RawAttributeValuePipe, ReferenceAttrValuePipe, ReferenceDisplayValuePipe, ReferenceLinkRoutePipe, ResolveTranslationPipe, RetryActionService, RouterLinkPipe, SPARK_CONFIG, ShowedOn, SparkColumnTemplateDirective, SparkDetailFieldTemplateDirective, SparkFieldTemplateDirective, SparkIconComponent, SparkIconRegistry, SparkLanguageService, SparkPoCreateComponent, SparkPoDetailComponent, SparkPoEditComponent, SparkPoFormComponent, SparkQueryListComponent, SparkRetryActionModalComponent, SparkService, TranslateKeyPipe, defaultSparkConfig, hasShowedOnFlag, provideSpark, resolveTranslation, sparkRoutes };
-export type { CustomActionDefinition, EntityAttributeDefinition, EntityPermissions, EntityType, LookupReference, LookupReferenceListItem, LookupReferenceValue, PersistentObject, PersistentObjectAttribute, ProgramUnit, ProgramUnitGroup, ProgramUnitsConfiguration, RetryActionPayload, RetryActionResult, SparkColumnTemplateContext, SparkConfig, SparkDetailFieldTemplateContext, SparkFieldTemplateContext, SparkQuery, SparkRouteConfig, TranslatedString, ValidationError, ValidationRule };
+export { ArrayValuePipe, AsDetailCellValuePipe, AsDetailColumnsPipe, AsDetailDisplayValuePipe, AsDetailTypePipe, AttributeValuePipe, CanCreateDetailRowPipe, CanDeleteDetailRowPipe, ELookupDisplayType, ErrorForAttributePipe, IconNamePipe, InlineRefOptionsPipe, InputTypePipe, LookupDisplayTypePipe, LookupDisplayValuePipe, LookupOptionsPipe, RawAttributeValuePipe, ReferenceAttrValuePipe, ReferenceDisplayValuePipe, ReferenceLinkRoutePipe, ResolveTranslationPipe, RetryActionService, RouterLinkPipe, SPARK_ATTRIBUTE_RENDERERS, SPARK_CONFIG, ShowedOn, SparkIconComponent, SparkIconRegistry, SparkLanguageService, SparkPoCreateComponent, SparkPoDetailComponent, SparkPoEditComponent, SparkPoFormComponent, SparkQueryListComponent, SparkRetryActionModalComponent, SparkService, TranslateKeyPipe, defaultSparkConfig, hasShowedOnFlag, provideSpark, provideSparkAttributeRenderers, resolveTranslation, sparkRoutes };
+export type { AttributeGroup, AttributeTab, CustomActionDefinition, EntityAttributeDefinition, EntityPermissions, EntityType, LookupReference, LookupReferenceListItem, LookupReferenceValue, PersistentObject, PersistentObjectAttribute, ProgramUnit, ProgramUnitGroup, ProgramUnitsConfiguration, RetryActionPayload, RetryActionResult, SparkAttributeColumnRenderer, SparkAttributeDetailRenderer, SparkAttributeEditRenderer, SparkAttributeRendererRegistration, SparkConfig, SparkQuery, SparkRouteConfig, TranslatedString, ValidationError, ValidationRule };