@messaia/cdk 0.0.0-CDK

package/lib/base/base.module.d.ts

@@ -0,0 +1,25 @@
+import { BaseComponent } from './components/base.component';
+import { GenericFormBaseComponent } from './components/generic-form-base.component';
+import { GenericFormComponent } from './components/generic-form.component';
+import { GenericListComponent } from './components/generic-list.component';
+import { GenericReactiveFormComponent } from './components/generic-reactive-form.component';
+import { Common } from './constants/common';
+import { MessageType } from './enums/message-type';
+import { AuthHelper } from './helpers/auth-helper';
+import { BaseInterceptor } from './interceptors/base.interceptor';
+import { CachingInterceptor } from './interceptors/caching-interceptor';
+import { LoadingScreenInterceptor } from './interceptors/loading.interceptor';
+import { AuthUser } from './models/auth-user';
+import { FileService } from './services/file.service';
+import { LoadingScreenService } from './services/loading-screen.service';
+import { PrintService } from './services/print.service';
+import * as i0 from "@angular/core";
+import * as i1 from "@angular/common";
+import * as i2 from "@angular/forms";
+import * as i3 from "@angular/material/dialog";
+export { AuthUser, MessageType, AuthHelper, BaseComponent, GenericListComponent, GenericFormComponent, GenericFormBaseComponent, GenericReactiveFormComponent, Common, BaseInterceptor, CachingInterceptor, LoadingScreenInterceptor, FileService, LoadingScreenService, PrintService };
+export declare class VdBaseModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<VdBaseModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<VdBaseModule, never, [typeof i1.CommonModule, typeof i2.FormsModule, typeof i2.ReactiveFormsModule, typeof i3.MatDialogModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<VdBaseModule>;
+}

package/lib/base/components/base.component.d.ts

@@ -0,0 +1,258 @@
+import { Location } from '@angular/common';
+import { HttpHeaders } from '@angular/common/http';
+import { AfterViewInit, ChangeDetectorRef, ElementRef, OnInit, QueryList, Type } from '@angular/core';
+import { MatExpansionPanel } from '@angular/material/expansion';
+import { MatSnackBar } from '@angular/material/snack-bar';
+import { Title } from '@angular/platform-browser';
+import { ActivatedRoute, ActivatedRouteSnapshot, Router } from '@angular/router';
+import { Observable } from 'rxjs';
+import { AppSetting } from '../../common/models/app-setting';
+import { VdDialogService } from '../../dialogs/services/dialog.service';
+import { VdMediaService } from '../../media/services/media.service';
+import { Menu } from '../../menu/models/menu';
+import { MessageType } from '../enums/message-type';
+import { AuthUser } from '../models/auth-user';
+import * as i0 from "@angular/core";
+/**
+ * A base list component for components with pagination support
+ */
+export declare abstract class BaseComponent implements OnInit, AfterViewInit {
+    protected route: ActivatedRoute;
+    protected changeDetectorRef: ChangeDetectorRef;
+    /**
+     * App settings
+     */
+    appSetting: AppSetting;
+    /**
+     * Menu items
+     */
+    menu: Menu;
+    /**
+     * The name of the project
+     */
+    projectName: string;
+    /**
+     * The title of the current page
+     */
+    title: string;
+    /**
+     * The subtitle of the current outlet
+     */
+    subtitle: string;
+    /**
+     * If true, use some dummy data and show debug logs
+     */
+    debug: boolean;
+    /**
+     * Loading status
+     */
+    isLoading: boolean;
+    /**
+     * Saving status
+     */
+    _isSaving: boolean;
+    get isSaving(): boolean;
+    set isSaving(isSaving: boolean);
+    /**
+     * A flag eindicates that the editor is inited
+     */
+    isEditorInitialzed: boolean;
+    /**
+     * Represents the request errors
+     */
+    errors: Array<string>;
+    /**
+     * Used to evaluate whether a given media query is true or false given the current device's screen / window size.
+     */
+    media: VdMediaService;
+    /**
+     * Allowed file extensions
+     */
+    allowedExtensions: string[];
+    /**
+     * tinyMCE plugins
+     */
+    editorPlugins: string;
+    /**
+     * tinyMCE editor
+     */
+    editorToolbar: string;
+    /**
+     * Editor configuration
+     */
+    editorConfig: any;
+    /**
+     * Provides the navigation and url manipulation capabilities.
+     */
+    router: Router;
+    /**
+     * urlHash: string
+     */
+    urlHash: string;
+    /**
+     * Class name
+     */
+    className: string;
+    /**
+     * Create permission
+     */
+    canCreate: boolean;
+    /**
+     * Update permission
+     */
+    canUpdate: boolean;
+    /**
+     * Current route
+     */
+    currentRoute: string;
+    /**
+     * Current user object
+     */
+    currentUser: AuthUser;
+    /**
+     * A service that can be used to get and set the title of a current HTML document.
+     */
+    protected titleService: Title;
+    /**
+     * A service to dispatch Material Design snack bar messages.
+     */
+    protected snackBarService: MatSnackBar;
+    /**
+     * A service to show conirm and prompt dialogs.
+     */
+    protected dialogService: VdDialogService;
+    /**
+     * location: Location
+     */
+    protected location: Location;
+    /**
+     * If true, set url hash
+     */
+    protected setUrlHash: boolean;
+    /**
+     * MatExpansionPanel ref
+     */
+    protected matExpansionPanelElementQueryList: QueryList<ElementRef>;
+    /**
+     * MatExpansionPanel ref
+     */
+    protected matExpansionPanelQueryList: QueryList<MatExpansionPanel>;
+    /**
+     * Constructor
+     */
+    constructor(route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
+    /**
+     * Lifecycle hook that is called after data-bound properties
+     * of a directive are initialized.
+     */
+    ngOnInit(): void;
+    /**
+     * Lifecycle hook that is called after a component's view has been fully initialized.
+     */
+    ngAfterViewInit(): void;
+    /**
+     * Refreshs this page/component
+     */
+    reloadPage(): void;
+    /**
+     * Listen for expansion panel changes
+     */
+    protected onExpansionPanelChanges(): void;
+    /**
+     * Retrieves an instance from the injector based on the provided token.
+     * If not found:
+     * - Throws {@link NoProviderError} if no `notFoundValue` that is not equal to
+     * Injector.THROW_IF_NOT_FOUND is given
+     * - Returns the `notFoundValue` otherwise
+     */
+    protected getService<T>(token: Type<T>): T;
+    /**
+     * Gets base route
+     * @param snapshot
+     */
+    protected getMainRoute(snapshot: ActivatedRouteSnapshot): ActivatedRouteSnapshot;
+    /**
+         * Shows a confirm dialog to delete an item
+         */
+    protected showDeleteItemDialog(): Observable<any>;
+    /**
+     * Shows a confirm dialog to delete multiple items
+     */
+    protected showDeleteItemsDialog(): Observable<any>;
+    /**
+     * Shows a confirm dialog to send some data
+     * @param message The message to display
+     * @param observabe The observable instance
+     * @param successCallback A success callback
+     * @param errorCallback An error callback
+     */
+    showConfirmationDialog(message: string, observabe: Observable<any>, successCallback?: Function, errorCallback?: Function): void;
+    /**
+     * Shows a message
+     * @param message The message to display
+     * @param type The type of the message
+     */
+    protected showMessage(message?: string, type?: MessageType): void;
+    /**
+     * Initoalizes the tinymce editor
+     */
+    protected initEditor(editorConfig?: any): void;
+    /**
+     * Sets subtitle from curren menu
+     */
+    protected setTitles(): void;
+    /**
+     * Navigate based on the provided array of commands and a starting point.
+     * @param commands
+     */
+    protected navigate(commands: any[], queryParams?: any): void;
+    /**
+     * Convert Object to HttpHeaders
+     *
+     * @param body
+     */
+    protected toHttpHeaders(body: Object): HttpHeaders;
+    /**
+     * Parses http response errors
+     * @param errors
+     */
+    protected parseErrors(errors: Object): void;
+    /**
+     * Handle Http operation that failed.
+     * Let the app continue.
+     * @param operation - name of the operation that failed
+     * @param result - optional value to return as the observable result
+     */
+    protected handleError<T>(operation?: string, result?: T): (error: any) => Observable<T>;
+    /**
+     * Log to console
+     * @param message
+     * @param optionalParams
+     */
+    protected log(message: string, ...optionalParams: any[]): void;
+    /**
+     * Log to console
+     * @param message
+     * @param optionalParams
+     */
+    protected warn(message: string, ...optionalParams: any[]): void;
+    /**
+     * Cleans the objects
+     * Removes empty properties
+     * @param obj
+     */
+    protected clean(obj: any): any;
+    /**
+     * Sanitizes the specified object
+     * @param obj
+     * @returns
+     */
+    protected sanitizeObject(obj: any, ...ignore: string[]): any;
+    /**
+     * Checks if the user seleceted any text in the document
+     * @returns
+     */
+    protected isTextSelected: () => boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BaseComponent, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<BaseComponent, never, never, {}, {}, never>;
+}

package/lib/base/components/generic-form-base.component.d.ts

@@ -0,0 +1,310 @@
+import { StepperSelectionEvent } from '@angular/cdk/stepper';
+import { ChangeDetectorRef } from '@angular/core';
+import { AbstractControl, FormGroup, NgForm } from '@angular/forms';
+import { MatStepper } from '@angular/material/stepper';
+import { ActivatedRoute } from '@angular/router';
+import { Observable } from 'rxjs';
+import { IEntity } from '../../common/models/entity';
+import { SaveAction } from '../../common/models/save-action';
+import { GenericService } from '../../http/services/generic.service';
+import { TableMenuItem } from '../../table/models/table-menu-item';
+import { BaseComponent } from './base.component';
+import * as i0 from "@angular/core";
+export declare abstract class GenericFormBaseComponent<TEntity extends IEntity, TService extends GenericService<TEntity>> extends BaseComponent {
+    entityCtor: {
+        new (): TEntity;
+    };
+    protected service: TService;
+    protected route: ActivatedRoute;
+    protected changeDetectorRef: ChangeDetectorRef;
+    /**
+     * The action of the form (add | edit)
+     */
+    action: string;
+    /**
+     * A url to return to after save
+     */
+    returnUrl: string;
+    /**
+     * Action = edit?
+     */
+    isEditMode: boolean;
+    /**
+     * Save action
+     */
+    SaveAction: typeof SaveAction;
+    /**
+     * Routes
+     */
+    editSaveAndCloseRoute: string;
+    addSaveAndCloseRoute: string;
+    addSaveAndEditRoute: string;
+    addSaveAndNewRoute: string;
+    listRoute: string;
+    /**
+     * The id of the item to load
+     */
+    id: number | string;
+    /**
+     * The current item to add or edit
+     */
+    item: TEntity;
+    /**
+     * Represents the request errors
+     */
+    errors: Array<string>;
+    /**
+     * Includes
+     */
+    includes: string[];
+    /**
+     * Update includes
+     */
+    updateIncludes: string[];
+    /**
+     * Get params
+     */
+    query: any;
+    /**
+     * The current date
+     */
+    currentDate: Date;
+    /**
+     * Date & time mask
+     */
+    dateTimeMask: (string | number | RegExp)[];
+    /**
+     * Date mask
+     */
+    dateMask: (string | number | RegExp)[];
+    /**
+     * Time mask
+     */
+    timeMask: (string | RegExp)[];
+    /**
+     * A pattern to validate dates
+     */
+    datePattern: string;
+    /**
+     * Phone prefix validation pattern
+     */
+    phonePrefixPattern: string;
+    /**
+     * Phone number validation pattern
+     */
+    phoneNumberPattern: string;
+    /**
+     * Password validation pattern
+     */
+    passwordPattern: string;
+    /**
+     * Defaults modules and toolbar
+     */
+    editorOptions: {
+        modules: {
+            toolbar: (string[] | {
+                list: string;
+            }[] | {
+                indent: string;
+            }[] | {
+                size: (string | boolean)[];
+            }[] | {
+                header: (number | boolean)[];
+            }[] | ({
+                color: any[];
+                background?: undefined;
+            } | {
+                background: any[];
+                color?: undefined;
+            })[])[];
+            clipboard: {
+                matchVisual: boolean;
+            };
+        };
+    };
+    /**
+     * If true, show the menu 'Delete'
+     */
+    deletable: boolean;
+    /**
+     * Toolbar menu items
+     */
+    toolbarMenuItems: TableMenuItem[];
+    /**
+     * MatStepper ref
+     */
+    protected matStepper: MatStepper;
+    /**
+     * A reference to the input element
+     */
+    input: any;
+    /**
+     * Form group
+     */
+    form: NgForm | FormGroup;
+    /**
+     * Gets form value
+     */
+    abstract get formValue(): TEntity | any;
+    /**
+     * panelId: string
+     */
+    protected panelId: string;
+    /**
+     * Constructor
+     * @param service
+     */
+    constructor(entityCtor: {
+        new (): TEntity;
+    }, service: TService, route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
+    /**
+     * Called after the constructor, initializing input properties,
+     * and the first call to ngOnChanges.
+     */
+    ngOnInit(): void;
+    /**
+     * Lifecycle hook that is called after a component's view has been fully initialized.
+     */
+    ngAfterViewInit(): void;
+    /**
+     * Loads an item by ID
+     */
+    loadItem(): void;
+    /**
+     * Loads an item by ID asyncly
+     */
+    loadItemAsync(): Observable<TEntity>;
+    /**
+     * Saves data into database.
+     * @param action
+     */
+    save(action?: SaveAction, form?: NgForm | FormGroup): void;
+    /**
+     * Saves data and navigates to edit view
+     */
+    apply(): void;
+    /**
+     * Deletes the current record.
+     */
+    delete(): void;
+    /**
+     * Builds a new form
+     */
+    protected buildForm(): void;
+    /**
+     * Validates the form
+     * @param form
+     */
+    validateForm(form?: NgForm | FormGroup): void;
+    /**
+     * Validates the form
+     * @param form
+     */
+    isFormValid(form?: NgForm | FormGroup): boolean;
+    /**
+     * Resets form controls
+     * @param form
+     * @returns
+     */
+    resetForm(form: NgForm): void;
+    /**
+     * Invalidate controls recursively
+     * @param control
+     */
+    protected invalidateControl(control: AbstractControl): void;
+    /**
+     * Shows form errors
+     * @param form
+     */
+    protected debugForm(form?: NgForm | FormGroup): void;
+    /**
+     * Add toolbar menu items
+     */
+    protected addToolbarMenuItems(): void;
+    /**
+     * Loads the previous URL in the history list.
+     * @param action
+     */
+    back(action?: SaveAction): void;
+    /**
+     * Creates a new instance of the TEntity
+     */
+    protected newInstance(): TEntity;
+    /**
+     * Creates the entity
+     * @param httpOptions
+     * @returns
+     */
+    protected create<TEntity>(httpOptions?: Object): Observable<TEntity>;
+    /**
+     * Updates the entity
+     * @param httpOptions
+     * @returns
+     */
+    protected update(httpOptions?: Object): Observable<TEntity>;
+    /**
+     * Includes some navigations
+     * @param inc
+     * @param update
+     */
+    protected include(inc: string, update?: boolean): void;
+    /**
+     * Check if the item is deletable
+     */
+    protected canDelete(): boolean;
+    /**
+     * Event emitted when the selected step has changed.
+     * @param $event
+     */
+    protected onAfterStepChange($event: StepperSelectionEvent): void;
+    /**
+     * Event emitted when the entity has been loaded.
+     */
+    protected onAfterItemLoaded(): void;
+    /**
+     * Event emitted before the form has built.
+     */
+    protected onBeforeFormBuild(): void;
+    /**
+     * Event emitted when the form has built.
+     */
+    protected onAfterFormBuild(): void;
+    /**
+     * Event emitted when the entity has been created.
+     */
+    protected onBeforeCreate(): void;
+    /**
+     * Event emitted when the entity has been updated.
+     */
+    protected onBeforeUpdate(): void;
+    /**
+     * Called before data submition
+     */
+    protected beforeSubmit(_?: SaveAction): void;
+    /**
+     * Event emitted after data submition
+     * @param action
+     * @param response
+     */
+    protected onAfterSubmit(action?: SaveAction, response?: any): void;
+    /**
+     * Called after page reloaded
+     */
+    protected afterReload(): void;
+    /**
+     * Sets focus to first input
+     */
+    protected focus(): void;
+    /**
+     * Gets element error
+     * @param nativeElement
+     */
+    protected getElementError(nativeElement: any): string;
+    /**
+     * Responds to user-initiated events
+     * @param event
+     */
+    handleKeyboardEvent(event: KeyboardEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GenericFormBaseComponent<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<GenericFormBaseComponent<any, any>, never, never, {}, {}, never>;
+}

package/lib/base/components/generic-form.component.d.ts

@@ -0,0 +1,32 @@
+import { ChangeDetectorRef } from '@angular/core';
+import { NgForm } from '@angular/forms';
+import { ActivatedRoute } from '@angular/router';
+import { IEntity } from '../../common/models/entity';
+import { GenericService } from '../../http/services/generic.service';
+import { GenericFormBaseComponent } from './generic-form-base.component';
+import * as i0 from "@angular/core";
+export declare abstract class GenericFormComponent<TEntity extends IEntity, TService extends GenericService<TEntity>> extends GenericFormBaseComponent<TEntity, TService> {
+    entityCtor: {
+        new (): TEntity;
+    };
+    protected service: TService;
+    protected route: ActivatedRoute;
+    protected changeDetectorRef: ChangeDetectorRef;
+    /**
+     * Form group
+     */
+    form: NgForm;
+    /**
+     * Gets form value
+     */
+    get formValue(): TEntity | any;
+    /**
+     * Constructor
+     * @param service
+     */
+    constructor(entityCtor: {
+        new (): TEntity;
+    }, service: TService, route: ActivatedRoute, changeDetectorRef: ChangeDetectorRef);
+    static ɵfac: i0.ɵɵFactoryDeclaration<GenericFormComponent<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<GenericFormComponent<any, any>, never, never, {}, {}, never>;
+}