@one-paragon/angular-utilities 0.3.10 → 0.3.11-beta.1

package/{table-builder/interfaces/dictionary.d.ts → src/table-builder/interfaces/dictionary.ts}

@@ -1,3 +1,3 @@
-export interface Dictionary<T> {
-    [key: string]: T;
-}
+export interface Dictionary<T> {
+  [key: string]: T;
+}

package/src/table-builder/interfaces/report-def.ts

@@ -0,0 +1,153 @@
+import { Dictionary } from './dictionary';
+import { PipeTransform, Predicate, TemplateRef } from '@angular/core';
+import { TableBuilderExport } from '../classes/TableBuilderConfig';
+import { QueryParamsHandling } from '@angular/router';
+
+
+export enum FieldType {
+    Unknown = 0,
+    Date = 1,
+    Link = 2,
+    ImageUrl = 3,
+    Currency = 4,
+    Array = 5,
+    Hidden = 6,
+    Number = 7,
+    String = 8,
+    Boolean = 9,
+    PhoneNumber = 10,
+    Expression = 11,
+    Enum = 12,
+    DateTime = 13,
+}
+
+export enum SortDirection {
+    asc= 'asc',
+    desc= 'desc'
+}
+
+export enum Target {
+  Blank = '_blank',
+  Self = '_self',
+  Parent = '_parent',
+  Top = '_top'
+}
+
+export interface MetaData<T = any, AdditionalFields extends string[] = any> {
+  key: (keyof T | AdditionalFields[number]) & string;
+  displayName?: string;
+  fieldType: FieldType;
+  additional?: Additional<T>;
+  order?: number;
+  preSort?: SortDef;
+  _internalNotUserDefined?: boolean;
+  width?: string;
+  noExport?: boolean;
+  noFilter?: boolean;
+  noSort?: boolean;
+  customCell?: boolean;
+  transform?: ((o: T, ...args: any[])=> any) | ((o: string, ...args: any[])=> any) | PipeTransform;
+  click?: (element: T, key: string ) => void;
+  template?: TemplateRef<any>;
+  classes?: Dictionary<Predicate<T>>;
+  toolTip?: string | ((t:T) => string);
+  useIcon?: boolean;
+}
+export interface  ReportDef<DataType = any> {
+    data: DataType[];
+    metaData: MetaData [];
+    totalRecords?: number;
+    count: number;
+}
+
+export interface SortDef {
+    direction: SortDirection;
+    precedence?: number;
+}
+
+export interface FilterOptions {
+  filterableValues : string[]
+}
+export interface DateTimeOptions {
+  format?: string;
+  includeSeconds?: boolean;
+  includeMilliseconds: boolean;
+}
+type interpolatedRoute = string;
+export interface Additional<T = any> {
+  link? : {
+    base?: string;
+    urlKey?: string;
+    target?: Target;
+    useRouterLink?: boolean;
+    /**
+     * If you want to use a route with interpolated params, you can use this. Wrap the property name in curly braces.
+     * For example, if interpolatedRoute = /users/{id}/edit, {id} will be replaced with the value of the element's id property.
+     */
+    interpolatedRoute?: interpolatedRoute;
+    routerLinkOptions?:{
+      queryParams?: [string, interpolatedRoute][];
+      fragment?: string;
+      preserveFragment?: boolean;
+      queryParamsHandling?: QueryParamsHandling;
+    }
+  }
+  /**
+   * @deprecated Please use link.base
+   */
+  base?: string;
+  /**
+   * @deprecated Please use link.urlKey
+   */
+  urlKey?: string;
+  /**
+   * @deprecated Please use link.target
+   */
+  target?: Target;
+  /**
+   * @deprecated Please use link.useRouterLink
+   */
+  useRouterLink?: boolean;
+  footer?: { type: 'sum' };
+  export?: TableBuilderExport;
+  dateFormat?: string;
+  dateTimeOptions?:  DateTimeOptions;
+  filterOptions?: FilterOptions;
+  styles?: Dictionary<string | {condition: (t:T) => boolean | true, value: (t:T) => string | string}>;
+  columnPartStyles?: {
+    header?: Dictionary<string>,
+    body?: Dictionary<string | {condition: (t: T) => boolean | true, value: (t: T) => string | string}>,
+    footer?: Dictionary<string>,
+  }
+  columnPartClasses?: {
+    header?: Dictionary<Predicate<T>>,
+    footer?: Dictionary<Predicate<T>>,
+  }
+  enumMap?: {[key:number]:string};
+  boolean? : {
+    showForFalse? : true | { icon : string },
+    forTrue? : { icon : string }
+  }
+}
+
+export enum ArrayStyle {
+  CommaDelimited,
+  NewLine
+}
+
+export interface ArrayAdditional extends Additional {
+    limit?: number;
+    arrayStyle?: ArrayStyle;
+}
+
+
+
+export function metaDataArrToDict<T = MetaData>(arr: MetaData[], transform?: (m : MetaData) => T): Dictionary<T>{
+  const dict = {};
+  if(transform){
+    arr.forEach(e => dict[e.key] = transform(e));
+  } else {
+    arr.forEach(e => dict[e.key] = e);
+  }
+  return dict;
+}

package/src/table-builder/ngrx/tableBuilderStateStore.ts

@@ -0,0 +1,143 @@
+import { ComponentStore } from "@ngrx/component-store";
+import { Injectable } from "@angular/core";
+import { Observable, filter, tap } from "rxjs";
+import { concatLatestFrom } from "@ngrx/effects";
+import { Dictionary } from "../interfaces/dictionary";
+
+@Injectable({ providedIn: 'root'})
+export class TableBuilderStateStore extends ComponentStore<GlobalStorageState> {
+  constructor(){
+    super(loadGlobalStorageState())
+  }
+
+  //selectors
+  selectLocalProfile = (key:string) => this.select(state => 
+    state.localProfiles[key]);
+  
+  selectLocalProfileState = (key:string) => this.select(
+    this.selectLocalProfile(key),
+    (profile: Profile) => {
+      if(profile) {
+        return  profile.states[profile.current ?? profile.default];
+      }
+      return null;
+  });
+
+  selectLocalProfileCurrentKey = (key:string) => this.select(
+    this.selectLocalProfile(key),
+    (profile: Profile) => {
+      if(profile) {
+        return  profile.current ?? profile.default;
+      }
+      return 'default';
+  });
+
+  selectLocalProfileKeys = <T>(key:string) =>  this.select(
+    this.selectLocalProfile(key),
+    (profile: Profile<T>) => {
+      if(profile) {
+        return  Object.keys(profile.states).filter( key => key);
+      }
+      return null;
+  });
+
+
+  // reducers
+  setLocalProfile = this.updater((state, props: { key: string, value: any }) => {
+    let profile = state.localProfiles[props.key];
+    if(!profile) {
+      profile =  {default: 'default', current: 'default', states : {
+        default: props.value
+      }};
+    } else {
+      profile = {...profile, states: {...profile.states, [profile.current ?? profile.default] : props.value} };
+    }
+    return {...state, localProfiles: {...state.localProfiles, [props.key]: profile} }
+  });
+
+  setLocalProfilesState = this.updater((state, props: { key: string, current: string }) => {
+    let profile = state.localProfiles[props.key];
+    if(!profile) {
+      profile =  {default: props.current, current: props.current , states : {[props.current]: null }};
+    } else {
+      const state = profile.states[props.current] ?? profile.states[profile.current ?? profile.default];
+      profile = {...profile, current: props.current, states: {...profile.states, [props.current] : state }};
+    }
+    return {...state, localProfiles: {...state.localProfiles, [props.key]: profile}};
+  });
+
+  deleteLocalProfilesState = this.updater((state, props: { key: string, stateKey: string }) => {
+    let profile = state.localProfiles[props.key];
+    if(profile) {
+      const current = profile.current === props.stateKey ? profile.default : profile.current;
+      profile = {...profile,current, states: { ...profile.states}};
+      delete profile.states[props.stateKey];
+      return {...state, localProfiles: {...state.localProfiles, [props.key]: profile} };
+    } else {
+      return state;
+    }
+  });
+
+  // effects
+  saveLocalProfile = this.effect((props$: Observable<{ key: string, value: any, persist?: boolean }>) => props$.pipe(
+    filter( action => !!action.persist),
+    concatLatestFrom((action) =>  this.selectLocalProfile(action.key)),
+    tap( ([action, profile]) => {
+      const globalSavedState: GlobalStorageState = JSON.parse(localStorage.getItem('global-state-storage') ?? JSON.stringify(defaultStorageState) );
+      if(!profile) {
+        profile =  {default: 'default', current: 'default', states : {default: action.value}};
+        globalSavedState.localProfiles[action.key] = profile;
+      } {
+        if(!globalSavedState.localProfiles[action.key]) {
+          globalSavedState.localProfiles[action.key] = {...profile,states: {[profile.current ?? profile.default]: action.value}};
+        } else {
+          globalSavedState.localProfiles[action.key].states[profile.current ?? profile.default] = action.value;
+        }
+
+      }
+      localStorage.setItem('global-state-storage', JSON.stringify( globalSavedState));
+      this.setLocalProfile(action);
+    })
+  ));
+
+  deleteLocalProfile = this.effect((props$: Observable<{ key: string, stateKey: string }>) => props$.pipe(
+    tap((props) => {
+      const globalSavedState: GlobalStorageState = JSON.parse(localStorage.getItem('global-state-storage') ?? JSON.stringify(defaultStorageState) );
+        if(!globalSavedState.localProfiles[props.key]) {
+          return;
+        } else {
+          delete globalSavedState.localProfiles[props.key].states[props.stateKey];
+        }
+      localStorage.setItem('global-state-storage', JSON.stringify( globalSavedState));
+      this.deleteLocalProfilesState(props)
+    })
+  ))
+}
+
+function loadGlobalStorageState() : GlobalStorageState {
+  const storage = localStorage.getItem('global-state-storage');
+  if(storage) {
+    return {...defaultStorageState, ...JSON.parse(storage)};
+  }
+  return defaultStorageState;
+}
+
+export interface Profile<T = any> {
+  default: string;
+  current: string;
+  states: Dictionary<T>;
+}
+
+export interface GlobalStorageState {
+  globalProfileKeys : string [];
+  currentGlobalProfile: string;
+  globalProfiles: Dictionary<Profile>;
+  localProfiles: Dictionary<Profile>;
+}
+
+export const defaultStorageState: GlobalStorageState = {
+  globalProfileKeys: ['Default'],
+  currentGlobalProfile: 'Default',
+  globalProfiles: {},
+  localProfiles: {}
+}

package/src/table-builder/pipes/column-total.pipe.ts

@@ -0,0 +1,17 @@
+import { Pipe, PipeTransform } from '@angular/core';
+import { MetaData } from '../interfaces/report-def';
+import {sumBy} from 'lodash';
+
+@Pipe({
+  name: 'columnTotal',
+    standalone: true
+  })
+export class ColumnTotalPipe implements PipeTransform {
+  transform(data: any[], metaData: MetaData) {
+    const dataToCalculate = data.filter(d => !d.isGroupHeader)
+    switch (metaData.additional!.footer!.type) {
+      case 'sum':
+      return sumBy(dataToCalculate, metaData.key);
+    }
+  }
+}

package/src/table-builder/pipes/format-filter-type.pipe.ts

@@ -0,0 +1,12 @@
+import { Pipe, PipeTransform } from '@angular/core';
+import { FilterType } from '../enums/filterTypes';
+
+@Pipe({name: 'formatFilterType', standalone: true})
+export class FormatFilterTypePipe implements PipeTransform {
+  transform(filterType: FilterType, value: any){
+    if(filterType === FilterType.IsNull){
+      return value ? filterType : 'Is Not Blank'
+    }
+    return filterType;
+  }
+}

package/src/table-builder/pipes/format-filter-value.pipe.ts

@@ -0,0 +1,41 @@
+import { Pipe, PipeTransform } from '@angular/core';
+import { TableStore } from '../classes/table-store';
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { FieldType } from '../interfaces/report-def';
+import { DatePipe } from '@angular/common';
+import { FilterType } from '../enums/filterTypes';
+import { spaceCase } from '../../utilities/pipes/space-case.pipes';
+import { DateTimeFilterFuncs } from '../functions/date-filter-function';
+
+
+@Pipe({name: 'formatFilterValue', standalone: true})
+export class FormatFilterValuePipe implements PipeTransform {
+  constructor( public tableState: TableStore , private datePipe: DatePipe) {
+  }
+  transform(value: any, key: string, filterType: FilterType): Observable<string> {
+    return this.tableState.getMetaData$(key).pipe(
+      map( md => {
+        if(filterType === FilterType.IsNull) {
+          return '';
+        }
+        if(value && (filterType === FilterType.In )){
+          if(md.fieldType === FieldType.Enum) {
+            return value.map( (v: any) => spaceCase(md.additional!.enumMap![v])).join(', ') ?? value;
+          }
+          return value.join(', ') ?? value;
+        }
+        if(filterType === FilterType.NumberBetween){
+          return value.Start + ' - ' + value.End;
+        }
+        if(md.fieldType === FieldType.Date){
+          return this.datePipe.transform(value, 'MM/dd/yy');
+        }
+        if(md.fieldType === FieldType.DateTime){
+          return !!DateTimeFilterFuncs[filterType] ? this.datePipe.transform(value, 'short') : this.datePipe.transform(value, 'MM/dd/yy');
+        }
+        return value
+      })
+    );
+  }
+}

package/src/table-builder/pipes/key-display.ts

@@ -0,0 +1,16 @@
+import { Pipe, PipeTransform } from '@angular/core';
+import { TableStore } from '../classes/table-store';
+import { spaceCase } from '../../utilities/pipes/space-case.pipes';
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+
+@Pipe({name: 'keyDisplay', standalone: true})
+export class KeyDisplayPipe implements PipeTransform {
+  constructor( public tableState: TableStore) {
+  }
+  transform(key: string): Observable<string> {
+    return this.tableState.getMetaData$(key).pipe(
+      map( metaData => metaData.displayName || spaceCase(key))
+    );
+  }
+}

package/src/table-builder/services/export-to-csv.service.ts

@@ -0,0 +1,96 @@
+import { DatePipe } from '@angular/common';
+import { Inject, Injectable } from '@angular/core';
+import { Observable } from 'rxjs';
+import { first, map  } from 'rxjs/operators';
+import { combineLatest} from 'rxjs';
+import { orderMetaData, TableStore } from '../classes/table-store';
+import { TableBuilderConfig, TableBuilderConfigToken } from '../classes/TableBuilderConfig';
+import { downloadData } from '../functions/download-data';
+import { ArrayAdditional, ArrayStyle, FieldType, MetaData } from '../interfaces/report-def';
+import { TableState } from '../classes/TableState';
+import { isPipe } from './transform-creator';
+import { get } from 'lodash';
+
+@Injectable()
+export class ExportToCsvService<T> {
+  constructor(
+    public state: TableStore,
+    @Inject(TableBuilderConfigToken) private config: TableBuilderConfig,
+    private datePipe: DatePipe,
+  ){}
+
+  exportToCsv = (data: Observable<T[]>) => {
+    const exportableFields$ = this.state.state$.pipe(
+      map(mapExportableFields)
+    );
+
+    combineLatest([data,exportableFields$]).pipe(
+      first(),
+      map(([data,fields]) => this.csvData(data,fields)),
+    ).subscribe(csv => downloadData(csv,'export.csv','text/csv') );
+  }
+
+  csvData = (data:Array<T>, metaData: MetaData<T>[]) => {
+    const res = data.map(row => metaData.map(meta => this.metaToField(meta, row)).join(','));
+    res.unshift(metaData.map(meta => meta.displayName || meta.key).join(','));
+    return res.join('\n');
+  }
+
+  metaToField = (meta: MetaData<T>, row: T) => {
+    let val: any = get( row,meta.key);
+    if (val == null && !meta.transform) return val
+    if(meta.transform && meta.fieldType !== FieldType.Expression){
+      const transform = meta.transform as any;
+      return  isPipe(transform) ? transform.transform(val) : transform(val);
+    }
+    switch (meta.fieldType) {
+      case FieldType.Date:
+        const dateFormat = meta.additional?.export?.dateFormat || this.config?.export?.dateFormat || meta.additional?.dateFormat;
+        val = this.transform(val, dateFormat);
+        break;
+      case FieldType.DateTime:
+        const dateTimeFormat = meta.additional?.export?.dateTimeFormat || this.config?.export?.dateTimeFormat || meta.additional?.dateTimeOptions?.format;
+        val = this.transform(val, dateTimeFormat);
+        break;
+      case FieldType.String:
+        const prepend: string = meta.additional?.export?.prepend || this.config?.export?.prepend || '';
+        val = prepend + val;
+        break;
+      case FieldType.Array:
+        const additional = meta.additional as ArrayAdditional;
+        val = (val as Array<string>).slice(0,additional.limit).join(additional.arrayStyle === ArrayStyle.NewLine ? '\n' : ', ');
+        break;
+      case FieldType.Expression:
+        val = (meta.transform as any)(row);
+        break;
+    }
+    if (typeof val === 'string' && (val.includes(',') || val.includes('"') || val.includes('\n'))) {
+      val = val.replaceAll('"', '""');
+      val = '"' + val + '"';
+    }
+    return val;
+  }
+
+  private transform(val: any, dateFormat: any) {
+    if (this.config.transformers && this.config.transformers[FieldType.Date]) {
+      return this.config.transformers[FieldType.Date]!(val);
+    }
+    return this.datePipe.transform(val, dateFormat);
+  }
+}
+
+export const removeFromMetaData = (state: TableState, keysToRemove: string[]) =>
+
+  orderMetaData(state)
+  .filter( meta => !keysToRemove.includes(meta.key));
+
+
+export const nonExportableFields = (state: TableState) => Object.values( state.metaData)
+  .filter(md => md.noExport )
+  .map( md => md.key );
+
+export const mapExportableFields = (state: TableState) => {
+  const fieldsToRemove = nonExportableFields(state)
+    .concat(state.hiddenKeys);
+   return removeFromMetaData(state, fieldsToRemove);
+}

package/src/table-builder/services/link-creator.service.ts

@@ -0,0 +1,68 @@
+import { get } from "lodash";
+import { FieldType, MetaData } from "../interfaces/report-def";
+import { Dictionary } from "@ngrx/entity";
+import { QueryParamsHandling } from "@angular/router";
+
+export function createLinkCreatorDict<T>(metaDatas: MetaData<T>[]){
+  return metaDatas.reduce((acc, md) => {
+    if(md.fieldType === FieldType.Link){ acc[md.key]= createLinkCreator(md)}
+    return acc;
+  },{} as Dictionary<LinkInfo>)
+}
+
+export function createLinkCreator<T>(metaData: MetaData<T>): LinkInfo{
+  const target = metaData.additional?.link?.target || metaData.additional?.target || '_blank';
+  const useRouterLink = metaData.additional?.link?.useRouterLink || metaData.additional?.useRouterLink || false;
+  const hasRoute = !!metaData.additional?.link?.interpolatedRoute;
+  const routerLinkOptions = useRouterLink ? {
+    queryParams: (element) => metaData.additional!.link!.routerLinkOptions?.queryParams?.reduce((map, [key, value]) => {
+      map[key] = parseInterpolated(value, element);
+      return map;
+    }, {}) ?? null,
+    fragment: metaData.additional!.link?.routerLinkOptions?.fragment,
+    preserveFragment: metaData.additional!.link!.routerLinkOptions?.preserveFragment ?? false,
+    queryParamsHandling: metaData.additional!.link!.routerLinkOptions?.queryParamsHandling ?? '',
+  }
+  : undefined;
+
+
+  if (hasRoute) {
+    return ({
+      link: (element: T) => parseInterpolated(metaData.additional!.link!.interpolatedRoute!, element),
+      target,
+      useRouterLink,
+      routerLinkOptions,
+    });
+  } else {
+    const slashIfNeeded = !metaData.additional?.link?.base?.endsWith('/') ? '/' : '';
+    const base = metaData.additional!.link?.base || metaData.additional!.base;
+    const getKey = key(metaData);
+    return ({
+      link: (element: T) => `${base}${slashIfNeeded}${getKey(element)}`,
+      target,
+      useRouterLink,
+      routerLinkOptions,
+    });
+  }
+}
+
+const key = (metaData : MetaData) => metaData.additional!.link?.urlKey ? 
+  (element:any) => get(element, (metaData.additional!.link!.urlKey as string)) :
+    metaData.additional!.urlKey ?
+  (element:any) => get(element, (metaData.additional!.urlKey as string)) :
+  (element:any) => get(element, metaData.key);
+
+const parseInterpolated = ( interpolatedString: string, element: any ) =>
+  interpolatedString.replace(/{([^}]+)}/g, (_, key) => get(element ,key));
+
+export interface LinkInfo {
+  link: (element: any) => string;
+  target: string;
+  useRouterLink: boolean;
+  routerLinkOptions?: {
+    queryParams: (element: any) => any;
+    fragment?: string;
+    preserveFragment?: boolean;
+    queryParamsHandling?: QueryParamsHandling;
+  }
+}

package/src/table-builder/services/table-template-service.ts

@@ -0,0 +1,55 @@
+import { ComponentFactoryResolver, Injector, inject } from "@angular/core";
+import { Injectable, TemplateRef } from "@angular/core";
+import { ArrayAdditional, ArrayStyle, FieldType, MetaData } from "../interfaces/report-def";
+import { InitializationComponent } from "../components/initialization-component/initialization-component";
+import { TableBuilderConfigToken } from "../classes/TableBuilderConfig";
+
+@Injectable({providedIn: 'root'})
+export class TableTemplateService {
+  instance!: InitializationComponent;
+  templates;
+
+  initTemplates() {
+    this.templates = { };
+    this.templates[FieldType.Array] = this.instance.arrayNewLineTemplate;
+    this.templates[FieldType.Array + .5] = this.instance.arrayCommaTemplate;
+    this.templates[FieldType.Boolean] = this.instance.defaultWithIcon;
+    this.templates[FieldType.Currency] = this.instance.defaultTemplate;
+    this.templates[FieldType.Date] = this.instance.defaultTemplate;
+    this.templates[FieldType.DateTime] = this.instance.defaultTemplate;
+    this.templates[FieldType.Expression] = this.instance.defaultTemplate;
+    this.templates[FieldType.ImageUrl] = this.instance.imageUrlTemplate;
+    this.templates[FieldType.Link] = this.instance.linkTemplate;
+    this.templates[FieldType.Link + .5] = this.instance.routerLinkTemplate;
+    this.templates[FieldType.Number] = this.instance.defaultTemplate;
+    this.templates[FieldType.PhoneNumber] = this.instance.defaultTemplate;
+    this.templates[FieldType.String] = this.instance.defaultTemplate;
+    this.templates[FieldType.Unknown] = this.instance.defaultTemplate;
+    this.templates[FieldType.Enum] = this.instance.defaultTemplate;
+  }
+  getTemplate(metaData: MetaData) : TemplateRef<any> {
+
+    let tmp = metaData.fieldType === FieldType.Link && metaData.additional?.link?.useRouterLink
+      ? this.templates[FieldType.Link + .5] 
+      : 
+      metaData.fieldType === FieldType.Array && ((metaData.additional as ArrayAdditional)?.arrayStyle === ArrayStyle.CommaDelimited || this.tableConfig?.arrayInfo?.arrayStyle === ArrayStyle.CommaDelimited)
+      ? this.templates[FieldType.Array + .5] 
+      :
+      this.templates[metaData.fieldType];
+    if(metaData.useIcon) {
+      if(tmp === this.instance.defaultTemplate) {
+        tmp = this.instance.defaultWithIcon;
+      }
+    }
+    return tmp;
+  }
+
+  constructor(resolver: ComponentFactoryResolver, i: Injector,  ) {
+        const factory = resolver.resolveComponentFactory(InitializationComponent);
+        const c = factory.create(i);
+        this.instance = c.instance;
+        this.initTemplates();
+  }
+
+  tableConfig = inject(TableBuilderConfigToken);
+}