@mintplayer/ng-spark 0.0.8 → 0.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mintplayer/ng-spark",
   "private": false,
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Angular component library for MintPlayer.Spark CRUD applications",
   "repository": {
     "type": "git",
@@ -13,7 +13,7 @@
     "@angular/common": "^21.0.0",
     "@angular/router": "^21.0.0",
     "@angular/forms": "^21.0.0",
-    "@mintplayer/ng-bootstrap": "^21.9.0",
+    "@mintplayer/ng-bootstrap": "^21.12.4",
     "@mintplayer/pagination": "*",
     "rxjs": "~7.8.0"
   },

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

@@ -1,9 +1,11 @@
 import * as _angular_core from '@angular/core';
 import { WritableSignal, InjectionToken, Type, TemplateRef, PipeTransform, InputSignal, Provider } from '@angular/core';
+import { SortColumn, PaginationResponse } from '@mintplayer/pagination';
+import { Observable } from 'rxjs';
 import { Color } from '@mintplayer/ng-bootstrap';
 import { DatatableSettings } from '@mintplayer/ng-bootstrap/datatable';
-import { PaginationResponse } from '@mintplayer/pagination';
 import * as _mintplayer_ng_spark from '@mintplayer/ng-spark';
+import { VirtualDatatableDataSource } from '@mintplayer/ng-bootstrap/virtual-datatable';
 import * as _angular_platform_browser from '@angular/platform-browser';
 import { SafeHtml } from '@angular/platform-browser';
 import { Route, Routes } from '@angular/router';
@@ -150,20 +152,34 @@ interface ValidationError {
     ruleType: string;
 }
 
+type SparkQueryRenderMode = 'Pagination' | 'VirtualScrolling';
+interface SparkQuerySortColumn {
+    property: string;
+    direction: string;
+}
 interface SparkQuery {
     id: string;
     name: string;
     description?: TranslatedString;
     source: string;
     alias?: string;
-    sortBy?: string;
-    sortDirection: string;
+    sortColumns: SparkQuerySortColumn[];
+    renderMode?: SparkQueryRenderMode;
     /** Optional RavenDB index name for queries using indexes */
     indexName?: string;
     /** When true, uses the projection type from [QueryType] attribute */
     useProjection?: boolean;
     /** Optional entity type name (e.g., "Person"). When set, used for entity type resolution. */
     entityType?: string;
+    /** When true, this query uses WebSocket streaming with snapshot + patch updates. */
+    isStreamingQuery?: boolean;
+}
+
+interface QueryResult {
+    data: PersistentObject[];
+    totalRecords: number;
+    skip: number;
+    take: number;
 }
 
 interface ProgramUnit {
@@ -250,6 +266,24 @@ interface SparkConfig {
 declare const SPARK_CONFIG: InjectionToken<SparkConfig>;
 declare const defaultSparkConfig: SparkConfig;
 
+interface StreamingSnapshotMessage {
+    type: 'snapshot';
+    data: PersistentObject[];
+}
+interface StreamingPatchItem {
+    id: string;
+    attributes: Record<string, any>;
+}
+interface StreamingPatchMessage {
+    type: 'patch';
+    updated: StreamingPatchItem[];
+}
+interface StreamingErrorMessage {
+    type: 'error';
+    message: string;
+}
+type StreamingMessage = StreamingSnapshotMessage | StreamingPatchMessage | StreamingErrorMessage;
+
 declare class SparkService {
     private readonly config;
     private readonly baseUrl;
@@ -262,8 +296,15 @@ declare class SparkService {
     getQueries(): Promise<SparkQuery[]>;
     getQuery(id: string): Promise<SparkQuery>;
     getQueryByName(name: string): Promise<SparkQuery | undefined>;
-    executeQuery(queryId: string, sortBy?: string, sortDirection?: string, parentId?: string, parentType?: string): Promise<PersistentObject[]>;
-    executeQueryByName(queryName: string): Promise<PersistentObject[]>;
+    executeQuery(queryId: string, options?: {
+        sortColumns?: SortColumn[];
+        parentId?: string;
+        parentType?: string;
+        skip?: number;
+        take?: number;
+        search?: string;
+    }): Promise<QueryResult>;
+    executeQueryByName(queryName: string): Promise<QueryResult>;
     getProgramUnits(): Promise<ProgramUnitsConfiguration>;
     list(type: string): Promise<PersistentObject[]>;
     get(type: string, id: string): Promise<PersistentObject>;
@@ -285,6 +326,16 @@ declare class SparkService {
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<SparkService>;
 }
 
+declare class SparkStreamingService {
+    private readonly config;
+    private readonly baseUrl;
+    private readonly ngZone;
+    connectToStreamingQuery(queryId: string): Observable<StreamingMessage>;
+    private buildWebSocketUrl;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkStreamingService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<SparkStreamingService>;
+}
+
 declare class SparkLanguageService {
     private readonly http;
     private readonly config;
@@ -338,7 +389,7 @@ declare class SparkPoFormComponent {
     referenceModalItems: _angular_core.WritableSignal<PersistentObject[]>;
     referenceModalEntityType: _angular_core.WritableSignal<EntityType>;
     referenceModalPagination: _angular_core.WritableSignal<PaginationResponse<PersistentObject>>;
-    referenceModalSettings: DatatableSettings;
+    referenceModalSettings: _angular_core.WritableSignal<DatatableSettings>;
     referenceSearchTerm: string;
     editingLookupAttr: _angular_core.WritableSignal<EntityAttributeDefinition>;
     showLookupModal: _angular_core.WritableSignal<boolean>;
@@ -489,7 +540,9 @@ declare class SparkQueryListComponent {
     private readonly route;
     private readonly router;
     private readonly sparkService;
+    private readonly streamingService;
     private readonly rendererRegistry;
+    private readonly destroyRef;
     extraActionsTemplate: _angular_core.InputSignal<TemplateRef<void>>;
     rowClicked: _angular_core.OutputEmitterRef<PersistentObject>;
     createClicked: _angular_core.OutputEmitterRef<void>;
@@ -498,30 +551,38 @@ declare class SparkQueryListComponent {
     query: _angular_core.WritableSignal<SparkQuery>;
     entityType: _angular_core.WritableSignal<EntityType>;
     allEntityTypes: _angular_core.WritableSignal<EntityType[]>;
-    allItems: _angular_core.WritableSignal<PersistentObject[]>;
     lookupReferenceOptions: _angular_core.WritableSignal<Record<string, LookupReference>>;
     paginationData: _angular_core.WritableSignal<PaginationResponse<PersistentObject>>;
     searchTerm: string;
     canRead: _angular_core.WritableSignal<boolean>;
     canCreate: _angular_core.WritableSignal<boolean>;
-    settings: DatatableSettings;
-    private currentSortProperty;
-    private currentSortDirection;
+    isStreaming: _angular_core.WritableSignal<boolean>;
+    private streamingSub;
+    private allItems;
+    private filteredItems;
+    settings: _angular_core.WritableSignal<DatatableSettings>;
+    virtualDataSource: _angular_core.WritableSignal<VirtualDatatableDataSource<PersistentObject>>;
+    virtualSettings: _angular_core.WritableSignal<DatatableSettings>;
     constructor();
     private onParamsChange;
     private resolveEntityTypeForQuery;
     private extractSourceName;
     private singularize;
+    private initVirtualDataSource;
     loadItems(): Promise<void>;
     onSettingsChange(): void;
     onSearchChange(): void;
-    applyFilter(): void;
     clearSearch(): void;
+    isVirtualScrolling: _angular_core.Signal<boolean>;
     visibleAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
     getColumnRendererComponent(attr: EntityAttributeDefinition): Type<any> | null;
     getColumnRendererInputs(item: PersistentObject, attr: EntityAttributeDefinition): Record<string, any>;
     private loadLookupReferenceOptions;
     onCreate(): void;
+    private connectStreaming;
+    private disconnectStreaming;
+    private handleStreamingMessage;
+    private applyFilter;
     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"; }, never, never, true, never>;
 }
@@ -535,13 +596,18 @@ declare class SparkSubQueryComponent {
     query: _angular_core.WritableSignal<SparkQuery>;
     entityType: _angular_core.WritableSignal<EntityType>;
     allEntityTypes: _angular_core.WritableSignal<EntityType[]>;
-    items: _angular_core.WritableSignal<PersistentObject[]>;
+    paginationData: _angular_core.WritableSignal<PaginationResponse<PersistentObject>>;
     lookupReferenceOptions: _angular_core.WritableSignal<Record<string, LookupReference>>;
     loading: _angular_core.WritableSignal<boolean>;
     canRead: _angular_core.WritableSignal<boolean>;
+    settings: _angular_core.WritableSignal<DatatableSettings>;
+    virtualDataSource: _angular_core.WritableSignal<VirtualDatatableDataSource<PersistentObject>>;
+    virtualSettings: _angular_core.WritableSignal<DatatableSettings>;
     visibleAttributes: _angular_core.Signal<EntityAttributeDefinition[]>;
     constructor();
     private loadData;
+    private loadPage;
+    onSettingsChange(): void;
     private loadLookupReferenceOptions;
     getColumnRendererComponent(attr: EntityAttributeDefinition): Type<any> | null;
     getColumnRendererInputs(item: PersistentObject, attr: EntityAttributeDefinition): Record<string, any>;
@@ -789,5 +855,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_ATTRIBUTE_RENDERERS, SPARK_CONFIG, ShowedOn, SparkIconComponent, SparkIconRegistry, SparkLanguageService, SparkPoCreateComponent, SparkPoDetailComponent, SparkPoEditComponent, SparkPoFormComponent, SparkQueryListComponent, SparkRetryActionModalComponent, SparkService, SparkSubQueryComponent, TranslateKeyPipe, currentLanguage, 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 };
+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, SparkStreamingService, SparkSubQueryComponent, TranslateKeyPipe, currentLanguage, defaultSparkConfig, hasShowedOnFlag, provideSpark, provideSparkAttributeRenderers, resolveTranslation, sparkRoutes };
+export type { AttributeGroup, AttributeTab, CustomActionDefinition, EntityAttributeDefinition, EntityPermissions, EntityType, LookupReference, LookupReferenceListItem, LookupReferenceValue, PersistentObject, PersistentObjectAttribute, ProgramUnit, ProgramUnitGroup, ProgramUnitsConfiguration, QueryResult, RetryActionPayload, RetryActionResult, SparkAttributeColumnRenderer, SparkAttributeDetailRenderer, SparkAttributeEditRenderer, SparkAttributeRendererRegistration, SparkConfig, SparkQuery, SparkQueryRenderMode, SparkQuerySortColumn, SparkRouteConfig, StreamingErrorMessage, StreamingMessage, StreamingPatchItem, StreamingPatchMessage, StreamingSnapshotMessage, TranslatedString, ValidationError, ValidationRule };