@sankhyalabs/core 1.0.20 → 1.0.23

package/src/dataunit/DataUnit.ts

@@ -0,0 +1,237 @@
+import { UnitMetadata, FieldMetadata } from "./metadata/UnitMetadata";
+import { convertType } from "./metadata/DataType";
+
+import { DataUnitAction, Action } from "./state/action/DataUnitAction";
+import StateManager from "./state/StateManager";
+
+import { HistReducer, canRedo, canUndo } from "./state/HistReducer";
+import { UnitMetadataReducer, getFieldMetadata, getMetadata } from "./state/slice/UnitMetadataSlice";
+import { RecordsReducer } from "./state/slice/RecordsSlice";
+import { SelectionReducer, getSelection, hasNext, hasPrevious } from "./state/slice/SelectionSlice";
+import { ChangesReducer, isDirty, getChangesToSave } from "./state/slice/ChangesSlice";
+import { RemovedRecordsReducer } from "./state/slice/RemovedRecordsSlice";
+import { AddedRecordsReducer } from "./state/slice/AddedRecordsSlice";
+import { CurrentRecordsReducer, getCurrentRecords, getFieldValue } from "./state/slice/CurrentRecordsSlice";
+
+export default class DataUnit {
+
+    private _name: string;
+    private _observers: Array<(action: DataUnitAction) => void>;
+    private _stateManager: StateManager;
+
+    public metadataLoader?: (dataUnit: string) => Promise<UnitMetadata>;
+    public dataLoader?: (dataUnit: string) => Promise<Array<Record>>;
+    public saveLoader?: (dataUnit: string, changes: Array<Change>) => Promise<Array<SavedRecord>>;
+
+    constructor(name: string) {
+        this._name = name;
+        this._stateManager = new StateManager(
+            [
+                HistReducer,
+                UnitMetadataReducer,
+                RecordsReducer,
+                RemovedRecordsReducer,
+                AddedRecordsReducer,
+                SelectionReducer,
+                ChangesReducer,
+                CurrentRecordsReducer
+            ]
+        );
+        this._observers = [];
+    }
+
+    public get name(): string {
+        return this._name;
+    }
+
+    // Métodos privados
+    private validateAndTypeValue(fieldName: string, newValue: any): any {
+        const fmd: FieldMetadata|undefined = getFieldMetadata(this._stateManager, fieldName);
+        if (!fmd) {
+            throw new Error(`Campo ${fieldName} não encontrado.`);
+        }
+
+        return convertType(fmd.dataType, newValue);
+    }
+
+    // Loaders
+    public loadMetadata(): void {
+        this.dispatchAction(Action.LOADING_METADATA);
+        if (this.metadataLoader) {
+            this.metadataLoader(this._name).then(
+                metadata => this.dispatchAction(Action.METADATA_LOADED, metadata)
+            );
+        }
+    }
+
+    public loadData(): void {
+        this.dispatchAction(Action.LOADING_DATA);
+        if (this.dataLoader) {
+            this.dataLoader(this._name).then(
+                records => this.dispatchAction(Action.DATA_LOADED, records)
+            );
+        }
+    }
+
+    public saveData(): void {
+
+        const changes: Array<Change> = getChangesToSave(this._stateManager);
+
+        if(changes.length > 0){
+            this.dispatchAction(Action.SAVING_DATA);
+            if(this.saveLoader){
+                this.saveLoader(this._name, changes).then(
+                    records => this.dispatchAction(Action.DATA_SAVED, {changes, records})
+                );
+            }
+        }
+    }
+
+    // API
+    public getMetadata(): UnitMetadata {
+        return getMetadata(this._stateManager);
+    }
+
+    public addRecord(): void {
+        this.dispatchAction(Action.RECORDS_ADDED, [{}]);
+    }
+
+    public removeSelectedRecords(): void {
+        const selection = getSelection(this._stateManager);
+        if (selection) {
+            this.dispatchAction(Action.RECORDS_REMOVED, selection);
+        }
+    }
+
+    public getRecords(): Array<Record>|undefined {
+        const records = getCurrentRecords(this._stateManager);
+        return records ? Array.from(records.values()) : undefined;
+    }
+
+    public getFieldValue(fieldName: string): any {
+        return getFieldValue(this._stateManager, fieldName);
+    }
+
+    public getSelection(): Array<string> {
+        return getSelection(this._stateManager);
+    }
+
+    public setSelection(selection: Array<string>): void {
+        this.dispatchAction(Action.SELECTION_CHANGED, { type: "id", selection });
+    }
+
+    public setSelectionByIndex(selection: Array<number>): void {
+        this.dispatchAction(Action.SELECTION_CHANGED, { type: "index", selection });
+    }
+
+    public nextRecord(): void {
+        this.dispatchAction(Action.NEXT_SELECTED);
+    }
+
+    public previousRecord(): void {
+        this.dispatchAction(Action.PREVIOUS_SELECTED);
+    }
+
+    public setFieldValue(fieldName: string, newValue: any): void {
+
+        const typedValue = this.validateAndTypeValue(fieldName, newValue);
+        const currentValue = this.getFieldValue(fieldName);
+
+        if (currentValue !== typedValue) {
+            this.dispatchAction(Action.DATA_CHANGED, { [fieldName]: typedValue });
+        }
+    }
+
+    public cancelEdition(): void {
+        this.dispatchAction(Action.EDITION_CANCELED);
+    }
+
+    public isDirty(): boolean {
+        return isDirty(this._stateManager);
+    }
+
+    public hasNext(): boolean {
+        return hasNext(this._stateManager);
+    }
+
+    public hasPrevious(): boolean {
+        return hasPrevious(this._stateManager);
+    }
+
+    public canUndo(): boolean {
+        return canUndo(this._stateManager);
+    }
+
+    public canRedo(): boolean {
+        return canRedo(this._stateManager);
+    }
+
+    public undo() {
+        this.dispatchAction(Action.CHANGE_UNDONE);
+    }
+
+    public redo() {
+        this.dispatchAction(Action.CHANGE_REDONE);
+    }
+
+    // Actions / State manager
+    private dispatchAction(actionType: Action, payload?: any): void {
+        const action = new DataUnitAction(actionType, payload);
+
+        //interceptor
+        this._stateManager.process(action);
+        this._observers.forEach(f => f(action));
+    }
+
+    public subscribe(observer: (action: DataUnitAction) => void) {
+        this._observers.push(observer);
+    }
+
+    public unsubscribe(observer: Function) {
+        this._observers = this._observers.filter(f => f !== observer);
+    }
+
+}
+
+export interface Record {
+    __record__id__: string;
+    __parent__record__id__?: string;
+    [key: string]: any;
+}
+
+export interface SavedRecord extends Record{
+    __old__id__?: string;
+}
+
+export enum ChangeOperation {
+    INSERT,
+    UPDATE,
+    DELETE
+}
+
+export class Change {
+
+    public record: Record;
+    public updatingFields: any;
+
+    private _operation: ChangeOperation;
+
+    constructor(record: Record, updates: any, operation: ChangeOperation) {
+        this.record = record;
+        this.updatingFields = updates;
+        this._operation = operation;
+    }
+
+    public isInsert(): boolean {
+        return this._operation === ChangeOperation.INSERT;
+    }
+
+    public isDelete(): boolean {
+        return this._operation === ChangeOperation.DELETE;
+    }
+
+    public isUpdate(): boolean {
+        return this._operation === ChangeOperation.UPDATE;
+    }
+
+}

package/src/dataunit/metadata/DataType.ts

@@ -0,0 +1,38 @@
+export enum DataType{
+    NUMBER = "NUMBER",
+    DATE = "DATE",
+    TEXT = "TEXT",
+    BOOLEAN = "BOOLEAN",
+    JSON = "JSON"
+}
+
+export const convertType = (dataType:DataType, value: any): any => {
+    if(value === undefined || value === null){
+        return value;
+    }
+    switch (dataType){
+        case DataType.NUMBER:
+            return value === "" || isNaN(value) ? null : Number(value);
+        case DataType.JSON:
+            return JSON.parse(value);
+        case DataType.BOOLEAN:
+            return Boolean(value);
+        case DataType.DATE:
+            return new Date(value.toString())
+        default:
+            return value;
+    }
+}
+
+export const toString = (dataType:DataType, value: any): string => {
+    
+    if(value === undefined || value === null){
+        return value;
+    }
+
+    if(dataType === DataType.JSON){
+        return JSON.stringify(value);
+    } else {
+        return value.toString();
+    }
+}

package/src/dataunit/metadata/UnitMetadata.ts

@@ -0,0 +1,55 @@
+import { DataType } from "./DataType";
+
+export interface UnitMetadata{
+    name: string;
+    label: string;
+    fields: Array<FieldMetadata>;
+}
+
+export interface FieldMetadata {
+    name: string;
+    label: string;
+    dataType: DataType;
+    userInterface?: UserInterface;
+    defaultValue?: string;
+    readOnly?: boolean;
+    required?: boolean;
+    properties?: Array<UIProperty>;
+    dependencies?: Array<FieldDependency>;
+}
+
+export interface UIProperty {
+    name: string;
+    value: string;
+}
+
+export interface FieldDependency {
+    masterFields: Array<string>;
+    type: DependencyType;
+    expression: string;
+}
+
+export enum DependencyType {
+    SEARCHING = "SEARCHING",
+    REQUIREMENT = "REQUIREMENT",
+    VISIBILITY = "REQUIREMENT"
+}
+
+export enum UserInterface {
+    FILE = "FILE",
+    IMAGE = "IMAGE",
+    DATE = "DATE",
+    DATETIME = "DATETIME",
+    ELAPSEDTIME = "ELAPSEDTIME",
+    CHECKBOX = "CHECKBOX",
+    SWITCH = "SWITCH",
+    OPTIONSELECTOR = "OPTIONSELECTOR",
+    DECIMALNUMBER = "DECIMALNUMBER",
+    INTEGERNUMBER = "INTEGERNUMBER",
+    SEARCH = "SEARCH",
+    SHORTTEXT = "SHORTTEXT",
+    PASSWORD = "PASSWORD",
+    MASKEDTEXT = "MASKEDTEXT",
+    LONGTEXT = "LONGTEXT",
+    HTML = "HTML"
+}

package/src/dataunit/state/HistReducer.ts

@@ -0,0 +1,34 @@
+import { ActionReducer } from "./StateManager";
+import { Action } from "./action/DataUnitAction";
+import StateManager, {StateAction} from "./StateManager";
+
+class HistReducerImpl implements ActionReducer {
+
+    public sliceName: string = "";
+
+    public reduce(stateManager: StateManager, _currentState: void, action: StateAction): void {
+        
+        switch (action.type) {
+            case Action.DATA_SAVED:
+            case Action.EDITION_CANCELED:
+                stateManager.clearUndo();
+                break;
+            case Action.CHANGE_UNDONE:
+                stateManager.undo();
+                break;
+            case Action.CHANGE_REDONE:
+                stateManager.redo();
+                break;
+        }
+    }
+}
+
+export const HistReducer = new HistReducerImpl();
+
+export const canUndo = (stateManager: StateManager): boolean => {
+    return stateManager.canUndo();
+}
+
+export const canRedo = (stateManager: StateManager): boolean =>{
+    return stateManager.canRedo();
+}

package/src/dataunit/state/StateManager.ts

@@ -0,0 +1,153 @@
+/**
+ * Essa classe representa uma interpretação do padrão de projetos Flux.
+ * No padrão Flux os dados da aplicação são chamados de "estado" e existem
+ * algumas regras para gerenciamento/manipulação desse estado:
+ * 
+ *  1 - O estado é imutável.
+ *  2 - Toda modificação de estado é representada por uma "ação".
+ *  3 - Quando "ações" acontecem a "store" cria um novo estado e notifica a todos interessados.
+ * 
+ * Nessa interpretação desse design pattern, o StateManager faz o papel da store,
+ * notificando os manipuladores de estado (handlers), que são responsáveis por pedaços
+ * do estado (slices). 
+ * 
+ * O StateManager mantém dois tipos de estados: "Histórico" e "Não Histórico". No estado
+ * "Histórico", sempre que uma alteração de estado acontece, o estado anterior é guardado em
+ * uma pilha, o que permite que possamos voltar no tempo, desfazendo algumas ações
+ */
+export default class StateManager {
+
+    private _reducers: Array<ActionReducer>;
+
+    private _past: Array<any> = [];
+    private _future: Array<any> = [];
+    private _present: any = {};
+
+    private _nonHist: any = {};
+    private _histClean: boolean = false;
+
+    constructor(reducers: Array<ActionReducer>) {
+        this._reducers = reducers;
+    }
+
+    public process(action: StateAction) {
+
+        const oldPresent: any = this._present;
+        let hasChange: boolean = false;
+        let hasHistChange: boolean = false;
+        this._histClean = false;
+        
+        this._reducers.forEach(
+            reducer => {
+                const sliceName = reducer.sliceName;
+                const isHistoric = this.isHistoric(sliceName);
+                const oldSlice = this.getSlice(sliceName, isHistoric);
+                const newSlice = reducer.reduce(this, oldSlice, action);
+                if (newSlice !== oldSlice) {
+                    this.updateSlice(sliceName, newSlice, isHistoric);
+                    hasChange = true;
+                    hasHistChange ||= isHistoric;
+                }
+            }
+        );
+
+        if (hasHistChange && !this._histClean) {
+            this._past.push(oldPresent);
+            this._future = [];
+            document.dispatchEvent(new CustomEvent("undoableAction", { detail: this }))
+        }
+
+        if (hasChange) {
+            console.log(JSON.stringify(this, (_key, value) => {
+                if (value instanceof Map) {
+                    return { dataType: "Map", value: Array.from(value.entries()) };
+                } else {
+                    return value;
+                }
+            }, 3));
+        }
+    }
+
+    public select(sliceName: string, selector: (state: any) => any): any {
+        const isHistoric = this.isHistoric(sliceName);
+        return selector(this.getSlice(sliceName, isHistoric));
+    }
+
+    private isHistoric(slice: string) {
+        return slice.startsWith("hist::");
+    }
+
+    private updateSlice(name: string, slice: any, isHistoric: boolean): void {
+        if (isHistoric) {
+            this._present = { ...this._present, [name]: slice };
+            if (slice === undefined) {
+                delete this._present[name];
+            }
+        } else {
+            this._nonHist = { ...this._nonHist, [name]: slice };
+            if (slice === undefined) {
+                delete this._nonHist[name];
+            }
+        }
+    }
+
+    private getSlice(name: string, isHistoric: boolean): any {
+        return isHistoric ? this._present[name] : this._nonHist[name];
+    }
+
+    public canUndo(): boolean {
+        return this._past.length > 0;
+    }
+
+    public canRedo(): boolean {
+        return this._future.length > 0;
+    }
+
+    public undo() {
+        if (this.canUndo()) {
+            this._future.push(this._present);
+            this._present = this._past.pop();
+        }
+    }
+
+    public redo() {
+        if (this.canRedo()) {
+            this._past.push(this._present);
+            this._present = this._future.pop();
+        }
+    }
+
+    public clearUndo() {
+        this._histClean = true;
+        this._past = [];
+        this._future = [];
+    }
+
+    public persist() {
+
+    }
+
+}
+
+/**
+ * Baseado no padrão Flux, qualquer alteração de estado parte de uma ação.
+ * Essa ação pode conter um payload ou não.
+ */
+export interface StateAction {
+    /**
+     * O tipo da ação representa o que aconteceu. Com base nesse tipo
+     * os manipuladores de estado agem criando um novo estado.
+     */
+    type: string,
+
+    /**
+     * Muitas ações contém informações importantes para compor o novo estado.
+     * Isso é chamado de payload.
+     */
+    payload?: any
+}
+
+export interface ActionReducer {
+    sliceName: string;
+    reduce(stateManager: StateManager, state: any, action: StateAction): any;
+}

package/src/dataunit/state/action/DataUnitAction.ts

@@ -0,0 +1,48 @@
+
+import { StateAction } from "../StateManager";
+
+export class DataUnitAction implements StateAction{
+
+    private _type: Action;
+    private _payload: any;
+    
+    constructor(type: Action, payload?:any){
+        this._type = type;
+        this._payload = payload;
+    }
+
+    public get type(): Action{
+        return this._type;
+    }
+
+    public get payload(): any{
+        return this._payload;
+    }
+}
+
+export enum Action{
+
+    LOADING_METADATA = "loadingMetadata",
+    METADATA_LOADED = "metadataLoaded",
+    
+    LOADING_DATA = "loadingData",
+    DATA_LOADED = "dataLoaded",
+
+    SAVING_DATA = "savingData",
+    DATA_SAVED = "dataSaved",
+
+    RECORDS_REMOVED = "recordsRemoved",
+    RECORDS_ADDED = "recordsAdded",
+    DATA_CHANGED = "dataChanged",
+
+    EDITION_CANCELED = "editionCanceled",
+    CHANGE_UNDONE = "changeUndone",
+    CHANGE_REDONE = "changeRedone",
+    
+    SELECTION_CHANGED = "selectionChanged",
+    NEXT_SELECTED = "nextSelected",
+    PREVIOUS_SELECTED = "previousSelected",
+
+    STATE_CHANGED = "stateChanged"
+    
+}

package/src/dataunit/state/slice/AddedRecordsSlice.ts

@@ -0,0 +1,31 @@
+
+import { ActionReducer, StateAction } from "../StateManager";
+import { Action } from "../action/DataUnitAction";
+import StateManager from "../StateManager";
+import { Record } from "../../DataUnit";
+
+class AddedRecordsReducerImpl implements ActionReducer{
+    
+    public sliceName: string = "hist::addedRecords";
+
+    public reduce(_stateManager:StateManager, currentState: Array<Record>, action: StateAction): Array<Record>|undefined {
+        switch(action.type){
+            case Action.RECORDS_ADDED:
+                const newState:Array <Record> = currentState ? currentState.slice() : [];
+                action.payload.forEach((r: any) => {
+                    newState.push({__record__id__: "NEW_" + (newState.length + 1), ...r});
+                });
+                return newState;
+            case Action.DATA_SAVED:
+            case Action.EDITION_CANCELED:
+                return undefined;
+        }
+        return currentState;
+    }
+}
+
+export const AddedRecordsReducer = new AddedRecordsReducerImpl();
+
+export const getAddedRecords = (stateManager: StateManager): Array<Record> => {
+    return stateManager.select(AddedRecordsReducer.sliceName, (state: Array<Record>) => state);
+};

package/src/dataunit/state/slice/ChangesSlice.ts

@@ -0,0 +1,91 @@
+
+import { ActionReducer, StateAction } from "../StateManager";
+import { Action } from "../action/DataUnitAction";
+import StateManager from "../StateManager";
+import { getSelection } from "./SelectionSlice";
+import { getRecords } from "./RecordsSlice";
+import { getRemovedRecords } from "./RemovedRecordsSlice";
+import { getAddedRecords } from "./AddedRecordsSlice";
+import { Change, ChangeOperation } from "../../DataUnit";
+
+class ChangesReducerImpl implements ActionReducer{
+    
+    public sliceName: string = "hist::changes";
+
+    public reduce(stateManager:StateManager, currentState: Map<string, any>, action: StateAction):  Map<string, any>|undefined {
+        switch(action.type){
+
+            case Action.DATA_CHANGED: 
+                const selection = getSelection(stateManager);
+                if(selection){
+                    const newState = new Map(currentState);
+                    selection.forEach(recordId => {
+                        newState.set(recordId, {...newState.get(recordId), ...action.payload});
+                    });
+                    return newState;
+                }
+                return currentState;
+
+            case Action.DATA_SAVED:
+            case Action.EDITION_CANCELED:
+                return undefined;
+        } 
+        return currentState;
+    }
+
+}
+
+export const ChangesReducer = new ChangesReducerImpl();
+
+export const getChanges = (stateManager: StateManager): Map<string, any> => {
+    return stateManager.select(ChangesReducer.sliceName, (state: Map<string, any>) => state);
+}
+
+export const isDirty = (stateManager: StateManager): boolean => {
+
+    if (getAddedRecords(stateManager) !== undefined) {
+        return true;
+    }
+
+    if (getRemovedRecords(stateManager) !== undefined) {
+        return true;
+    }
+
+    return getChanges(stateManager) !== undefined;
+}
+
+export const getChangesToSave = (stateManager: StateManager): Array<Change> => {
+    const result: Array<Change> = [];
+
+    const changes = getChanges(stateManager);
+    const records = getRecords(stateManager);
+
+    if (records) {
+        records.forEach(r => {
+            if(changes){
+                const c = changes.get(r.__record__id__);
+                if (c) {
+                    result.push(new Change(r, c, ChangeOperation.UPDATE));
+                }
+            }
+        });
+    }
+
+    const addedRecords = getAddedRecords(stateManager);
+    if (addedRecords) {
+        addedRecords.forEach(r => {
+            result.push(new Change(r, changes?.get(r.__record__id__), ChangeOperation.INSERT));
+        });
+    }
+
+    const removedRecords = getRemovedRecords(stateManager);
+    const recordsById: any = {};
+    records.forEach(r=>recordsById[r.__record__id__] = r);
+    if (removedRecords) {
+        removedRecords.forEach(id => {
+            result.push(new Change(recordsById[id], undefined, ChangeOperation.DELETE));
+        });
+    }
+
+    return result;
+}