fix: Workflow sort

Author: Gérard Collin

libs/dc-workflow/projects/dc-workflow/src/lib/abstract/abstract-dc-workflow.ts

@@ -1,8 +1,8 @@
 import { DcWorkflow } from '../definition/dc-workflow';
 import { Component, inject, input, InputSignal } from '@angular/core';
-import { DcWorkflowModel } from '../models/dc-workflow-model';
+import { DcWorkflowModel, DcWorkflowSortModel, DcWorkflowSortOption } from '../models/dc-workflow-model';
 import { XtCompositeComponent, XtResolverService } from 'xt-components';
-import { XtSignalStore, XtStoreManagerService } from 'xt-store';
+import { XtSignalStore, XtSortBy, XtSortByDirection, XtStoreEntityFeatureOptions, XtStoreManagerService } from 'xt-store';
 import { ManagedData } from 'xt-type';
 
 /**
@@ -13,7 +13,7 @@ import { ManagedData } from 'xt-type';
   imports: [],
   template: ''
 })
-export class AbstractDcWorkflow<T extends ManagedData> extends XtCompositeComponent<T> implements DcWorkflow {
+export class AbstractDcWorkflow<T extends ManagedData=ManagedData> extends XtCompositeComponent<T> implements DcWorkflow {
   /**
    * The workflow config must be provided
    * @protected
@@ -27,9 +27,9 @@ export class AbstractDcWorkflow<T extends ManagedData> extends XtCompositeCompon
 
   protected findStore (): XtSignalStore<T> | null {
     if (this.store===undefined) {
-      this.store=this.storeMgr.getStoreFor(this.config().entity, this.resolver.typeResolver);
-      if (this.store!=null)
-        this.applyConfigToStore (this.config(), this.store);
+      const config = this.config();
+      const storeOptions = this.generateStoreOptions(config);
+      this.store=this.storeMgr.getStoreFor(config.entity, this.resolver.typeResolver, storeOptions);
     }
     return (this.store==null)?null:this.store;
   }
@@ -40,7 +40,29 @@ export class AbstractDcWorkflow<T extends ManagedData> extends XtCompositeCompon
     return ret;
   }
 
-  protected applyConfigToStore (config: DcWorkflowModel, store:XtSignalStore<T>): void {
+  protected generateStoreOptions (config: DcWorkflowModel): XtStoreEntityFeatureOptions<T> | undefined {
+    const options = {sort:[]} as XtStoreEntityFeatureOptions<T>;
+    if( config.data?.sort!=null) {
+     for (const sortKey in config.data.sort) {
+       options.sort?.push(this.toSortOption(sortKey, config.data.sort[sortKey]));
+     }
+   }
 
+    return (options.sort!.length>0)?options:undefined;
+  }
+
+  protected toSortOption (name:string, sort:DcWorkflowSortOption): XtSortBy<T> {
+    const ret = { by:name } as XtSortBy<T>;
+
+    if (sort==="ascending" || sort==="descending" ) {
+      ret.direction=(sort==="ascending")?XtSortByDirection.Ascending:XtSortByDirection.None;
+    } else if (sort==null){
+      ret.direction=XtSortByDirection.None;
+    } else if (sort.type=='metadata') {
+      throw new Error ("Metadata sort is not supported yet for element "+name);
+    } else {
+      ret.direction=(sort.direction==="ascending")?XtSortByDirection.Ascending:XtSortByDirection.Descending;
+    }
+    return ret;
   }
 }

libs/dc-workflow/projects/dc-workflow/src/lib/models/dc-workflow-model.ts

@@ -9,11 +9,13 @@ export type DcWorkflowModel = {
 }
 
 export type DcWorkflowSortModel = {
-  [key in DcMetadataTypes|string]: 'ascending' | 'descending' | {
+  [key in DcMetadataTypes|string]: DcWorkflowSortOption
+}
+
+export type DcWorkflowSortOption = 'ascending' | 'descending' | {
   direction: 'ascending' | 'descending',
   type: 'metadata'|'field',
 }
-}
 
 export type DcWorkflowDisplayModel = {
   fields?: {

libs/xt-store/projects/store/src/store-entity/store-entity-feature.ts

@@ -62,10 +62,11 @@ export type XtSignalStore<T> = {
  * @param storeProvider
  * @param storeMgr
  * @param typeRegistry
+ * @param options
  */
-export function withXtStoreProvider<T extends ManagedData = ManagedData> (entityName:string, storeProvider?:XtStoreProvider<T>, storeMgr?:XtStoreManager, typeRegistry?: XtTypeResolver, options?: XtStoreEntityFeatureOptions) {
+export function withXtStoreProvider<T extends ManagedData = ManagedData> (entityName:string, storeProvider?:XtStoreProvider<T>, storeMgr?:XtStoreManager, typeRegistry?: XtTypeResolver, options?: XtStoreEntityFeatureOptions<T>) {
   return signalStoreFeature(
-    withState ({ entityName, loading:false, sort:options?.sort, filter:options?.filter} as StoreState),
+    withState ({ entityName, loading:false, sort:options?.sort, filter:options?.filter} as StoreState<T>),
     withEntities(xtStoreEntityConfig<T> ()),
     withProps ( () => ({
       _storeProvider:storeProvider??storeMgr!.getProviderSafe<T>(entityName),
@@ -165,6 +166,11 @@ export function withXtStoreProvider<T extends ManagedData = ManagedData> (entity
         }
       },
 
+      async updateStoreOptions (option:XtStoreEntityFeatureOptions<T>):Promise<void> {
+        patchState(store, {sort:option.sort, filter:option.filter});
+        await this.fetchEntities();
+      },
+
       /**
        * Detects and replace all referenced objects by the key value that will be stored.
        * @param toClear

libs/xt-store/projects/store/src/store-manager-service/xt-store-manager.service.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@angular/core';
 import { signalStore } from '@ngrx/signals';
 import { ManagedData, XtTypeResolver } from 'xt-type';
 import { xtStoreManager } from '../store-manager/xt-store-manager';
-import { withXtStoreProvider, XtSignalStore } from '../store-entity/store-entity-feature';
+import { withXtStoreProvider, XtSignalStore, XtStoreEntityFeatureOptions } from '../store-entity/store-entity-feature';
 import { XtStoreProvider } from '../store-provider/xt-store-provider';
 
 @Injectable({
@@ -16,7 +16,7 @@ export class XtStoreManagerService {
   constructor() {
   }
 
-  getStoreFor<T extends ManagedData>(entityName: string, typeMgr?:XtTypeResolver): XtSignalStore<T> {
+  getStoreFor<T extends ManagedData>(entityName: string, typeMgr?:XtTypeResolver, options?:XtStoreEntityFeatureOptions<T>): XtSignalStore<T> {
     let store = this.entityToStoreMap.get(entityName);
     if (store == null) {
       const provider = this.storeManager.getProvider<T>(entityName);
@@ -25,13 +25,13 @@ export class XtStoreManagerService {
       } else {
         if( typeMgr==null) {
           const res = signalStore(
-            withXtStoreProvider(entityName, provider)
+            withXtStoreProvider(entityName, provider, undefined, undefined, options)
           );
           store= new res();
         } else {
             // We have a type mgr, so let's use it in our store
           const res = signalStore(
-            withXtStoreProvider(entityName, provider, this.storeManager, typeMgr)
+            withXtStoreProvider(entityName, provider, this.storeManager, typeMgr, options)
           );
           store= new res();