@simpleangularcontrols/sac-common 10.0.0-rc.3 → 10.0.0-rc.30

package/common/baseuploadcontrol.d.ts

@@ -1,284 +1,324 @@
-import { EventEmitter, Injector, NgZone, OnDestroy, OnInit, Renderer2 } from '@angular/core';
-import { AbstractControl, ValidationErrors } from '@angular/forms';
-import { UploadState, UploadxService } from 'ngx-uploadx';
-import { Observable } from 'rxjs';
-import { SacFormLayoutCommon } from '../controls/layout/formlayout';
-import { ISacIconService } from '../interfaces/ISacIconService';
-import { ISacLocalisationService } from '../interfaces/ISacLocalisationService';
-import { SacBaseModelControl } from './basemodelcontrol';
-/**
- * Base Klasse für Uploader Control
- */
-export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<VALUE> implements OnInit, OnDestroy {
-    private renderer;
-    private ngZone;
-    /**
-     * File Input Control
-     */
-    private uploadInput;
-    /**
-     * Erlaubte Dateitypen
-     */
-    private _allowedtypes;
-    /**
-     * Files automatisch hochladen
-     */
-    private _autoupload;
-    /**
-     * Pausieren von Uploads erlauben
-     */
-    private _enablepause;
-    /**
-     * API Endpoint
-     */
-    private _endpoint;
-    /**
-     * Upload Settings
-     */
-    private options;
-    /**
-     * icon service to receive icons for uploader
-     */
-    protected iconService: ISacIconService;
-    /**
-     * Upload Service
-     */
-    protected uploadService: UploadxService;
-    /**
-     * Definiert das Control als Required
-     */
-    isrequired: boolean;
-    /**
-     * Max. Dateigrösse für Files die hochgeladen werden können. 0 deaktiviert den Filter
-     */
-    maxfilesize: number;
-    /**
-     * Resource Key für Validation Message Required bei Control
-     */
-    validationmessagerequired: string;
-    /**
-     * Resource Key für Validation Message Required in Validation Summary
-     */
-    validationmessagesummaryrequired: string;
-    /**
-     * Event wenn ein Error in der Komponente ausgelöst wird.
-     */
-    onfileerror: EventEmitter<string>;
-    /**
-     * Handling von neuen Files im Input Control
-     */
-    fileListener: () => void;
-    /**
-     * Listener für Files
-     */
-    listenerFn: () => void;
-    /**
-     * Service für Error Localisation
-     */
-    lngResourceService: ISacLocalisationService;
-    /**
-     * Array von Uploads
-     */
-    uploads: SacUploadFile[];
-    /**
-     * Constructor
-     * @param formlayout SacFormLayoutCommon to define scoped layout settings
-     * @param injector Injector for injecting services
-     * @param renderer angular rendering engine
-     * @param ngZone ngzone for handling external scripts
-     */
-    constructor(formlayout: SacFormLayoutCommon, injector: Injector, renderer: Renderer2, ngZone: NgZone);
-    /**
-     * Erlaubte Dateitypen für den Upload. Format: ".xxx,.yyy,.zzz"
-     */
-    set allowedtypes(types: string);
-    /**
-     * Files nach der Auswahl automatisch hochladen
-     */
-    set autoupload(v: boolean);
-    /**
-     * Uploads können unterbrochen werden
-     */
-    set enablepause(v: boolean);
-    /**
-     * Definiert den Registration Endpoint für Uploads.
-     */
-    set endpoint(v: string);
-    /**
-     * Icon for browse button
-     */
-    get IconBrowse(): string;
-    /**
-     * icon for continous buttons
-     */
-    get IconContinue(): string;
-    /**
-     * icon for delete buttons
-     */
-    get IconDelete(): string;
-    /**
-     * icon for pause buttons
-     */
-    get IconPause(): string;
-    /**
-     * icon for upload button
-     */
-    get IconUpload(): string;
-    get allowedtypes(): string;
-    get autoupload(): boolean;
-    get enablepause(): boolean;
-    get endpoint(): string;
-    /**
-     * Name der Datei die Hochgeladen wird
-     * @returns Observable des Dateinamens.
-     */
-    Filename(): Observable<string>;
-    /**
-     * Gibt an ob Queue Elemente beinhaltet
-     * @returns Elemente in der Queue
-     */
-    HasQueueItem(): boolean;
-    /**
-     * Gibt an ob ein Upload abgeschlossen ist
-     * @returns Upload erfolgreich
-     */
-    HasSuccessUpload(): boolean;
-    /**
-     * Prüft ob ein Upload pausiert
-     * @returns Pausierter Upload ist vorhanden
-     */
-    IsPaused(): boolean;
-    /**
-     * Prüft ob in der Queue Elemente die zum Upload bereit sind vorhanden sind.
-     * @returns Elemente für Upload vorhanden
-     */
-    IsStateToUpload(): boolean;
-    /**
-     * Prüft ob ein Upload eines Files am laufen ist
-     * @returns Upload ist am laufen
-     */
-    IsUploading(): boolean;
-    /**
-     * Gibt den Uploadfortschritt zurück
-     * @returns Upload Fortschritt. Wert von 0-100
-     */
-    Progress(): number;
-    /**
-     * Cancel single upload
-     * @param uploadId ID of File to cancel
-     */
-    cancel(uploadId: any): void;
-    /**
-     * Cancel all Uploaded files
-     */
-    cancelAll(): void;
-    /**
-     * Destroy des Controls
-     */
-    ngOnDestroy(): void;
-    /**
-     * Initialisiert das Control
-     */
-    ngOnInit(): void;
-    /**
-     * Upload Event
-     *
-     * @param uploadsOutStream Upload Item
-     */
-    onUpload(ufile: UploadState): void;
-    /**
-     * Cancel Single File
-     * @param uploadId ID of File to Cancel
-     */
-    pause(uploadId: any): void;
-    /**
-     * Pause all Uploads
-     */
-    pauseAll(): void;
-    /**
-     * Upload Single File
-     *
-     * @param uploadId ID of File to Upload
-     */
-    upload(uploadId: any): void;
-    /**
-     * Upload all queued Files
-     */
-    uploadAll(): void;
-    /**
-     * Validiert das Upload Control
-     * @param c Control das validiert werden soll
-     */
-    validateData(c: AbstractControl): ValidationErrors | null;
-    /**
-     * Methode kann für Controls verwendet werden, zusätzliche Validierungen bei hinzufügen der Files zu machen
-     *
-     * @param file File das hinzugefügt wurde.
-     * @returns Valdierung ist erfolgreich
-     */
-    abstract CustomAddValidation(file: UploadState): boolean;
-    /**
-     * Methode welche die Upload ID's in das Model setzt oder löscht
-     *
-     * @param file Type von File ID's
-     */
-    abstract SetUploadValue(file: UploadState): void;
-    private UpdateFileCount;
-    /**
-     * Returns the number of uploaded files
-     */
-    private UploadedFileCount;
-    /**
-     * Prüft ob die Dateierweiterung gültig ist
-     *
-     * @param filename Dateiname
-     */
-    private isExtensionValid;
-    /**
-     * Prüft ob das File nicht zu gross ist.
-     *
-     * @param filesize Max File Size in Bytes
-     */
-    private isFileSizeValid;
-    /**
-     * Setzt die erlaubten Datentypen für den Upload
-     *
-     * @param types Erlaubte File Extensions
-     */
-    private setAllowedTypes;
-    /**
-     * Setzt den Upload Endpoit
-     * @param url Register URI
-     */
-    private setEndpoint;
-}
-/**
- * Klasse für den Upload einer Datei in der Upload Component
- */
-export declare class SacUploadFile {
-    /**
-     * Document ID
-     */
-    documentid: string;
-    /**
-     * Dateiname
-     */
-    name: string;
-    /**
-     * Upload Fortschritt
-     */
-    progress: number;
-    /**
-     * Upload Status
-     */
-    status: string;
-    /**
-     * Upload ID
-     */
-    uploadId: string;
-    /**
-     * Konstruktor
-     * @param ufile Upload Status
-     */
-    constructor(ufile: UploadState);
-}
+import { SacFormLayoutCommon } from '../controls/layout/formlayout';
+import { ISacLocalisationService } from '../interfaces/ISacLocalisationService';
+import { ISacUploadEventCompleteState } from '../interfaces/ISacUploadEventCompleteState';
+import { SacBaseModelControl } from './basemodelcontrol';
+import { EventEmitter, Injector, NgZone, OnDestroy, OnInit, Renderer2 } from '@angular/core';
+import { AbstractControl, ValidationErrors } from '@angular/forms';
+import { UploadState, UploadxService } from 'ngx-uploadx';
+import { Observable } from 'rxjs';
+/**
+ * Base class for uploader control
+ */
+export declare abstract class SacUploadBase<VALUE> extends SacBaseModelControl<VALUE> implements OnInit, OnDestroy {
+    private renderer;
+    private ngZone;
+    /**
+     * Allowed file types
+     */
+    private _allowedtypes;
+    /**
+     * Automatically uploads files
+     */
+    private _autoupload;
+    /**
+     * Allow pausing of uploads
+     */
+    private _enablepause;
+    /**
+     * API Endpoint
+     */
+    private _endpoint;
+    /**
+     * Token for Bearer Authentication
+     */
+    private _token;
+    /**
+     * Upload Settings
+     */
+    private options;
+    /**
+     * File Input Control
+     */
+    private uploadInput;
+    /**
+     * Upload Service
+     */
+    protected uploadService: UploadxService;
+    /**
+     * Handling of new files in the input control
+     */
+    fileListener: () => void;
+    /**
+     * Defines the control as required
+     */
+    isrequired: boolean;
+    /**
+     * Listener for files
+     */
+    listenerFn: () => void;
+    /**
+     * Service für Error Localisation
+     */
+    lngResourceService: ISacLocalisationService;
+    /**
+     * Max. file size for files that can be uploaded. 0 disables the filter
+     */
+    maxfilesize: number;
+    /**
+     * Event when an error is triggered in the component.
+     */
+    onfileerror: EventEmitter<string>;
+    /**
+     * Event when a file has been uploaded. The event is triggered for multiple uploads per file.
+     */
+    onuploadcomplete: EventEmitter<ISacUploadEventCompleteState>;
+    /**
+     * Array of uploads
+     */
+    uploads: SacUploadFile[];
+    /**
+     * Resource key for validation message 'required' at control
+     */
+    validationmessagerequired: string;
+    /**
+     * Resource key for validation message 'required' in validation summary
+     */
+    validationmessagesummaryrequired: string;
+    /**
+     * Constructor
+     * @param formlayout SacFormLayoutCommon to define scoped layout settings
+     * @param injector Injector for injecting services
+     * @param renderer angular rendering engine
+     * @param ngZone ngzone for handling external scripts
+     */
+    constructor(formlayout: SacFormLayoutCommon, injector: Injector, renderer: Renderer2, ngZone: NgZone);
+    /**
+     * Icon for browse button
+     */
+    get IconBrowse(): string;
+    /**
+     * icon for continous buttons
+     */
+    get IconContinue(): string;
+    /**
+     * icon for delete buttons
+     */
+    get IconDelete(): string;
+    /**
+     * icon for pause buttons
+     */
+    get IconPause(): string;
+    /**
+     * icon for upload button
+     */
+    get IconUpload(): string;
+    get allowedtypes(): string;
+    /**
+     * Allowed file types for upload. Format: ".xxx,.yyy,.zzz"
+     */
+    set allowedtypes(types: string);
+    /**
+     * Indicates whether files should be uploaded automatically after selection.
+     * @returns true when auto-upload is enabled.
+     */
+    get autoupload(): boolean;
+    /**
+     * Automatically uploads files after selection.
+     * @param v true to enable automatic upload.
+     */
+    set autoupload(v: boolean);
+    /**
+     * Indicates whether upload pause is allowed.
+     * @returns true when pause support is active.
+     */
+    get enablepause(): boolean;
+    /**
+     * Uploads can be paused.
+     * @param v true to allow pausing uploads.
+     */
+    set enablepause(v: boolean);
+    /**
+     * API endpoint for upload registration.
+     * @returns configured endpoint URL.
+     */
+    get endpoint(): string;
+    /**
+     * Defines the registration endpoint for uploads.
+     * @param v upload endpoint URL.
+     */
+    set endpoint(v: string);
+    /**
+     * Bearer authentication token used by upload service.
+     * @returns current auth token or null.
+     */
+    get token(): string | null;
+    /**
+     * Sets Bearer authentication token for service requests.
+     * @param v token string or null to clear token.
+     */
+    set token(v: string | null);
+    /**
+     * Method can be used for controls to perform additional validations when adding files
+     *
+     * @param file File that was added.
+     * @returns Validation is successful
+     */
+    abstract CustomAddValidation(file: UploadState): boolean;
+    /**
+     * Name of the file being uploaded
+     * @returns Observable of the file name.
+     */
+    Filename(): Observable<string>;
+    /**
+     * Indicates whether the queue contains elements
+     * @returns Elements in the queue
+     */
+    HasQueueItem(): boolean;
+    /**
+     * Indicates whether an upload is complete
+     * @returns Upload successful
+     */
+    HasSuccessUpload(): boolean;
+    /**
+     * Checks if an upload is paused
+     * @returns Paused upload is present
+     */
+    IsPaused(): boolean;
+    /**
+     * Checks if there are elements in the queue ready for upload.
+     * @returns Elements available for upload
+     */
+    IsStateToUpload(): boolean;
+    /**
+     * Checks if a file upload is in progress
+     * @returns Upload is in progress
+     */
+    IsUploading(): boolean;
+    /**
+     * Returns the upload progress
+     * @returns Upload progress. Value from 0-100
+     */
+    Progress(): number;
+    /**
+     * Method that sets or deletes the upload IDs in the model
+     *
+     * @param file Type of file IDs
+     */
+    abstract SetUploadValue(file: UploadState): void;
+    /**
+     * Cancel single upload
+     * @param uploadId ID of File to cancel
+     */
+    cancel(uploadId: any): void;
+    /**
+     * Cancel all Uploaded files
+     */
+    cancelAll(): void;
+    /**
+     * Destroy the control
+     */
+    ngOnDestroy(): void;
+    /**
+     * Initializes the control
+     */
+    ngOnInit(): void;
+    /**
+     * Upload event
+     *
+     * @param uploadsOutStream Upload item
+     */
+    onUpload(ufile: UploadState): void;
+    /**
+     * Cancel single file
+     * @param uploadId ID of file to cancel
+     */
+    pause(uploadId: any): void;
+    /**
+     * Pause all uploads
+     */
+    pauseAll(): void;
+    /**
+     * Sets the bearer token in the upload service
+     */
+    setToken(value: string): void;
+    /**
+     * Upload Single File
+     *
+     * @param uploadId ID of File to Upload
+     */
+    upload(uploadId: any): void;
+    /**
+     * Upload all queued Files
+     */
+    uploadAll(): void;
+    /**
+     * Validates the upload control
+     * @param c Control to be validated
+     */
+    validateData(c: AbstractControl): ValidationErrors | null;
+    /**
+     * get max. files that can be uploaded
+     */
+    protected abstract GetMaxFiles(): number;
+    /**
+     * Updates the file count on the form control
+     */
+    private UpdateFileCount;
+    /**
+     * Returns the number of uploaded files
+     */
+    private UploadedFileCount;
+    /**
+     * Checks whether the file extension is valid
+     *
+     * @param filename File name
+     */
+    private isExtensionValid;
+    /**
+     * Checks if the file is not too large.
+     *
+     * @param filesize Max file size in bytes
+     */
+    private isFileSizeValid;
+    /**
+     * Sets the allowed data types for upload
+     *
+     * @param types Allowed file extensions
+     */
+    private setAllowedTypes;
+    /**
+     * Sets the upload endpoint
+     * @param url Register URI
+     */
+    private setEndpoint;
+}
+/**
+ * Class for uploading a file in the upload component
+ */
+export declare class SacUploadFile {
+    /**
+     * Document ID
+     */
+    documentid: string;
+    /**
+     * File name
+     */
+    name: string;
+    /**
+     * Upload progress
+     */
+    progress: number;
+    /**
+     * Upload status
+     */
+    status: string;
+    /**
+     * Upload ID
+     */
+    uploadId: string;
+    /**
+     * Constructor
+     * @param ufile Upload state
+     */
+    constructor(ufile: UploadState);
+}

package/common/baseuploadcontrol.ngfactory.d.ts

@@ -1 +1 @@
-export {};
+export {};