@sebgroup/green-angular 10.0.3 → 10.0.4

package/src/v-angular/drag-drop/index.d.ts

@@ -1,4 +1,233 @@
-export * from './drag-drop.component';
-export * from './drag-drop.models';
-export * from './drag-drop.module';
-export * from './drag-drop.pipes';
+import * as rxjs from 'rxjs';
+import { Observable, Subscription } from 'rxjs';
+import * as _sebgroup_green_angular_src_v_angular_drag_drop from '@sebgroup/green-angular/src/v-angular/drag-drop';
+import * as i0 from '@angular/core';
+import { OnInit, OnDestroy, EventEmitter, PipeTransform, KeyValueDiffers } from '@angular/core';
+import * as i5 from '@sebgroup/green-angular/src/v-angular/modal';
+import { NggvDialogComponent, DialogEvent } from '@sebgroup/green-angular/src/v-angular/modal';
+import * as i3 from '@angular/common/http';
+import { HttpEvent } from '@angular/common/http';
+import * as i4 from '@jsverse/transloco';
+import * as i6 from '@sebgroup/green-angular/src/lib/shared';
+import * as i7 from '@angular/common';
+
+type UploadState = 'local' | 'uploading' | 'aborted' | 'uploaded' | 'validating' | 'error' | 'deleted' | 'done';
+type StateMap = {
+    [key in UploadState]: string | string[];
+};
+interface LocalFile {
+    raw: File | undefined;
+    progress: number;
+    uploadState: UploadState;
+    uploadRequests: Subscription | undefined;
+}
+interface APIStatusReason {
+    originatorId: string;
+    reason: string;
+    additionalInformation?: string;
+}
+interface APIStatusBaseProperties {
+    internalStatusReasonCode: string | null;
+    statusReasonInformation: APIStatusReason[] | null;
+}
+type APIStatus<T = APIStatusBaseProperties> = T & {
+    id: string;
+    status: string;
+};
+interface APIFileBaseProperties {
+    principal: string;
+    uploadDate: string;
+    registrarId: string;
+    registrarName: string;
+}
+type APIFile<T = APIFileBaseProperties, U = APIStatusBaseProperties> = APIStatus<U> & T & {
+    id: string;
+    fileName: string;
+};
+interface EventStateChange extends Partial<APIStatus> {
+    uploadState: UploadState;
+    fileName: string;
+}
+interface FileService<T = APIFileBaseProperties, U = APIStatusBaseProperties> {
+    uploadFile(file: File): Observable<HttpEvent<APIFile<T, U>>>;
+    fetchFiles(statuses?: string[]): Observable<Array<APIFile<T, U>>>;
+    fetchStatus(id: string): Observable<APIStatus<U> | undefined>;
+    /** Uses file as param to fetch file status. */
+    fetchStatusFor?(file: APIFile<T, U>): Observable<APIStatus<U> | undefined>;
+    removeFile(id: string): Observable<void>;
+    /** Uses file as param to remove file. */
+    removeFileFor?(file: APIFile<T, U>): Observable<void>;
+}
+
+type DragDropState = 'normal' | 'over' | 'uploading' | 'done';
+declare class NggvDragDropComponent implements OnInit, OnDestroy {
+    /** @internal */
+    deleteModalRef: NggvDialogComponent;
+    /** Special property used for selecting DOM elements during automated UI testing. */
+    thook: string | null | undefined;
+    /** Allowing selecting or dropping multiple files. */
+    service: FileService | undefined;
+    /** Mime types allowed. */
+    accept?: string;
+    /** Disables deletion or cancellation during defined states [local | uploading | aborted | uploaded | validating | error | deleted | done]. */
+    disableRemove: UploadState[];
+    /** File size limit in mega bytes. */
+    fileLimit: number;
+    /** Allowing selecting or dropping multiple files. */
+    multiple: boolean;
+    /** Determines if list should be shown under upload, disabling list disables multiple upload. */
+    list: boolean;
+    /** Frequency of requests which to send to the API requesting status updates. */
+    throttle: number;
+    /** Maximum number of attempts to request a status update from the API if service is unreachable. */
+    retryAttempts: number;
+    /** If selection of multiple file should be possible with a checkbox.
+     * @experimental work in progress and should not yet be used.
+     * @internal
+     */
+    selectable: boolean;
+    /** Allows multiple values from `apiFile.status` to be mapped to a single file upload state. */
+    stateMap: StateMap;
+    /** Statuses allowed to be fetch during the initial load. Used to hide "done" states from list. */
+    fetchStatuses: string[];
+    /** Statuses allowed be shown when status is "rejected". Will fallback to generic message. `null` allows all. */
+    errorCodes: string[] | null;
+    /** Event triggered on initialization and every time the "uploadState" for a file changes. */
+    stateChange: EventEmitter<EventStateChange>;
+    /** Event triggered when view details is clicked. */
+    detailsClick: EventEmitter<LocalFile & _sebgroup_green_angular_src_v_angular_drag_drop.APIStatusBaseProperties & {
+        id: string;
+        status: string;
+    } & _sebgroup_green_angular_src_v_angular_drag_drop.APIFileBaseProperties & {
+        id: string;
+        fileName: string;
+    }>;
+    /** @internal */
+    isDragDropAvailable: boolean;
+    /** @internal */
+    componentState: DragDropState;
+    /** @internal */
+    files: Map<string, LocalFile & APIFile>;
+    /** @internal */
+    lastFile: (LocalFile & APIFile) | undefined;
+    /** @internal */
+    selected: string[];
+    /** @internal */
+    loading: boolean;
+    /** @internal */
+    markedForDeletion: APIFile | undefined;
+    /**
+     * Initialize the component and warn if service is not defined. Will also fetch files for the list if enabled.
+     */
+    ngOnInit(): void;
+    /** Destroy all event listeners and polling running */
+    ngOnDestroy(): void;
+    /** @internal Warn user trying to leave page before all uploads are done. Custom message only works in older browsers. */
+    onBeforeUnload(event: Event): "You still have files uploading, are you sure you want to leave this page?" | undefined;
+    /** @internal Event handler for when a file is held over the drop area */
+    onDragEnter(event: DragEvent): void;
+    /** @internal Event handler for when a file leaves the drop area */
+    onDragLeave(event: DragEvent): void;
+    /** @internal Event handler for when a file is dropped on the drop area or when `input` files are selected */
+    onDrop(event: DragEvent | Event): void;
+    /** @internal Event trigger for when delete button is pressed */
+    onRemove(id: string, state: UploadState): void;
+    /** @internal */
+    onConfirmRemove(event: DialogEvent<LocalFile & APIFile>): void;
+    /** @internal Event handler for when the files should be uploaded */
+    onSubmit(): void;
+    /**
+     * @internal
+     * Using the state map convert `apiFile.state` to one of {@link UploadState}
+     * @param apiState the state given by the file to be used for mapping
+     */
+    determineUploadState(apiState: string): UploadState;
+    /** @internal */
+    uploadStateIsArray(state: string | string[]): state is string[];
+    /** @internal used for translation templating parameters */
+    translateParams(file: LocalFile & APIFile): {
+        fileLimit: string;
+        raw: File | undefined;
+        progress: number;
+        uploadState: UploadState;
+        uploadRequests: rxjs.Subscription | undefined;
+        internalStatusReasonCode: string | null;
+        statusReasonInformation: _sebgroup_green_angular_src_v_angular_drag_drop.APIStatusReason[] | null;
+        id: string;
+        status: string;
+        principal: string;
+        uploadDate: string;
+        registrarId: string;
+        registrarName: string;
+        fileName: string;
+    };
+    /**
+     * Poll the status endpoint to determine when file is valid
+     * @param file file used to check state and update
+     * @param delay how long each interval should wait before sending a request
+     */
+    private checkValidity;
+    private fallbackError;
+    /**
+     * Check so that no files are still validating
+     */
+    private allValidationDone;
+    /**
+     * Check so that no files are still uploading
+     */
+    private allUploadingDone;
+    /**
+     * Helper to update the component state to done and then back to normal
+     */
+    private setComponentStateDone;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NggvDragDropComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<NggvDragDropComponent, "nggv-drag-drop", never, { "thook": { "alias": "thook"; "required": false; }; "service": { "alias": "service"; "required": false; }; "accept": { "alias": "accept"; "required": false; }; "disableRemove": { "alias": "disableRemove"; "required": false; }; "fileLimit": { "alias": "fileLimit"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "list": { "alias": "list"; "required": false; }; "throttle": { "alias": "throttle"; "required": false; }; "retryAttempts": { "alias": "retryAttempts"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; "stateMap": { "alias": "stateMap"; "required": false; }; "fetchStatuses": { "alias": "fetchStatuses"; "required": false; }; "errorCodes": { "alias": "errorCodes"; "required": false; }; }, { "stateChange": "stateChange"; "detailsClick": "detailsClick"; }, never, never, false, never>;
+}
+
+declare class ValuePipe implements PipeTransform {
+    private readonly differs;
+    constructor(differs: KeyValueDiffers);
+    private differ;
+    private values;
+    transform<K, V>(input: null): null;
+    transform<V>(input: {
+        [key: string]: V;
+    } | Map<string, V>): Array<V>;
+    transform<V>(input: {
+        [key: string]: V;
+    } | Map<string, V> | null): Array<V> | null;
+    transform<K, V>(input: Map<K, V>): Array<V>;
+    transform<K, V>(input: Map<K, V> | null): Array<V> | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ValuePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<ValuePipe, "value", false>;
+}
+/**
+ * Stand-alone version of existing value pipe.
+ *
+ * Impure flag needed due to keep track of changes in complex values (such as objects or arrays).
+ */
+declare class ValueImpurePipe implements PipeTransform {
+    private readonly differs;
+    private differ;
+    private values;
+    transform<K, V>(input: null): null;
+    transform<V>(input: {
+        [key: string]: V;
+    } | Map<string, V>): Array<V>;
+    transform<V>(input: {
+        [key: string]: V;
+    } | Map<string, V> | null): Array<V> | null;
+    transform<K, V>(input: Map<K, V>): Array<V>;
+    transform<K, V>(input: Map<K, V> | null): Array<V> | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ValueImpurePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<ValueImpurePipe, "valueImpure", true>;
+}
+
+declare class NggvDragDropModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<NggvDragDropModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NggvDragDropModule, [typeof ValuePipe, typeof NggvDragDropComponent], [typeof i3.HttpClientModule, typeof i4.TranslocoModule, typeof i5.NggvModalModule, typeof i6.NggCoreWrapperModule, typeof i7.CommonModule], [typeof NggvDragDropComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NggvDragDropModule>;
+}
+
+export { NggvDragDropComponent, NggvDragDropModule, ValueImpurePipe, ValuePipe };
+export type { APIFile, APIFileBaseProperties, APIStatus, APIStatusBaseProperties, APIStatusReason, DragDropState, EventStateChange, FileService, LocalFile, StateMap, UploadState };