@esfaenza/httpservice 19.2.11 → 19.2.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,65 +0,0 @@
1
- import { IHttpServiceExtensions } from './IHttpServiceExtensions';
2
- import * as i0 from "@angular/core";
3
- /**
4
- * Classe d'estensione che permette di modificare il comportamento della libreria negli hook definiti da interfaccia, in modo da poterla adattare
5
- * con un certo grado di customizzazione a qualsiasi struttura di frontend
6
- */
7
- export declare class HttpServiceExtensions implements IHttpServiceExtensions {
8
- /**
9
- * Hook per recuperare l'access token con cui effettuare le chiamate HTTP
10
- */
11
- retrieveAccessToken(): string;
12
- /**
13
- * Hook per recuperare l'Identity corrente in un oggetto generico con le informazioni di User e Tenant
14
- */
15
- retrieveIdentity(): {
16
- IdUser: string;
17
- Idtenant: string;
18
- };
19
- /**
20
- * Hook per leggere dallo stato dell'applicazione se stiamo già venendo ridirezionati al login, in modo da non tentare di effettuare
21
- * N redirect contemporaneamente qualora molte API fallissero allo stesso tempo nell'autenticazione
22
- */
23
- readRedirectingToLogin(): boolean;
24
- /**
25
- * Hook per scrivere nello stato dell'applicazione se stiamo effettuando un redirect al login o meno
26
- */
27
- writeRedirectingToLogin(status: boolean): void;
28
- /**
29
- * Hook per effettuare il redirect al login
30
- */
31
- redirectToLogin(): void;
32
- /**
33
- * Hook per leggere dallo stato dell'applicazione se stiamo già gestendo un errore, in modo da non tentare di gestire
34
- * N errori contemporaneamente qualora molte API fallissero allo stesso tempo
35
- */
36
- readHandlingErrorStatus(): boolean;
37
- /**
38
- * Hook per scrivere nello stato dell'applicazione se stiamo gestendo un errore o meno
39
- */
40
- writeHandlingErrorStatus(status: boolean): void;
41
- /**
42
- * Hook per leggere dallo stato dell'applicazione se stiamo già gestendo un redirect, in modo da non tentare di gestire
43
- * N redirect contemporaneamente qualora molte API lo richiedessero allo stesso tempo
44
- */
45
- readRedirectionStatus(): boolean;
46
- /**
47
- * Hook per scrivere nello stato dell'applicazione se stiamo gestendo un redirect o meno
48
- */
49
- writeRedirectionStatus(status: boolean): void;
50
- /**
51
- * Hook per indicare se l'applicazione può gestire eccezioni del tipo "NotConfigured" (444). Qualora l'applicazione che lo implementa dichiari di gestirle verrà chiamata
52
- * la funzione **handleBlockingException** per ognuno di questi errori
53
- */
54
- handleNotConfiguredException(): boolean;
55
- /**
56
- * Hook per la gestione di un qualsiasi errore bloccante per l'operazione attuale, ma non fatale (Generalmente gestibile da dialog di avviso)
57
- */
58
- handleBlockingException(status: number, text: string): void;
59
- /**
60
- * Hook per la gestione di un qualsiasi errore fatale (Generalmente gestibile tramite navigazione a una pagina di errore custom per l'applicativo)
61
- */
62
- handleException(status: number | string, text: string): void;
63
- static ɵfac: i0.ɵɵFactoryDeclaration<HttpServiceExtensions, never>;
64
- static ɵprov: i0.ɵɵInjectableDeclaration<HttpServiceExtensions>;
65
- }
@@ -1,25 +0,0 @@
1
- /**
2
- * Classe di configurazione per il Modulo della libreria
3
- */
4
- export declare class HttpServiceModuleConfig {
5
- /**
6
- * Indica quali chiamate vengono invalidate da quali chiamate quando viene utilizzata una cache sulle risposte
7
- */
8
- httpInvalidation?: Record<string, string[]>;
9
- /**
10
- * Indica la durata della cache lato client (Browser), se utilizzata
11
- */
12
- clientCacheDurationS?: number;
13
- /**
14
- * Nome dell'applicazione che sta utilizzando la libreria, utilizzato per creare chiavi di cache specifiche per app
15
- */
16
- appName?: string;
17
- /**
18
- * Indica se la cache deve basarsi non solo sull'applicazione ma anche sull'utente connesso
19
- */
20
- cacheByUser?: boolean;
21
- /**
22
- * Abilita o disabilità la modalità di debug (Log a console)
23
- */
24
- debugMode?: boolean;
25
- }
@@ -1,61 +0,0 @@
1
- /**
2
- * Interfaccia per la classe d'estensione che permette di modificare il comportamento della libreria negli hook definiti da interfaccia, in modo da poterla adattare
3
- * con un certo grado di customizzazione a qualsiasi struttura di frontend
4
- */
5
- export interface IHttpServiceExtensions {
6
- /**
7
- * Hook per recuperare l'access token con cui effettuare le chiamate HTTP
8
- */
9
- retrieveAccessToken(): string;
10
- /**
11
- * Hook per recuperare l'Identity corrente in un oggetto generico con le informazioni di User e Tenant
12
- */
13
- retrieveIdentity(): {
14
- IdUser: string;
15
- Idtenant: string;
16
- };
17
- /**
18
- * Hook per leggere dallo stato dell'applicazione se stiamo già venendo ridirezionati al login, in modo da non tentare di effettuare
19
- * 10 redirect contemporaneamente qualora molte API fallissero allo stesso tempo nell'autenticazione
20
- */
21
- readRedirectingToLogin(): boolean;
22
- /**
23
- * Hook per scrivere nello stato dell'applicazione se stiamo effettuando un redirect al login o meno
24
- */
25
- writeRedirectingToLogin(status: boolean): any;
26
- /**
27
- * Hook per effettuare il redirect al login
28
- */
29
- redirectToLogin(): void;
30
- /**
31
- * Hook per leggere dallo stato dell'applicazione se stiamo già gestendo un errore, in modo da non tentare di gestire
32
- * N errori contemporaneamente qualora molte API fallissero allo stesso tempo
33
- */
34
- readHandlingErrorStatus(): boolean;
35
- /**
36
- * Hook per scrivere nello stato dell'applicazione se stiamo gestendo un errore o meno
37
- */
38
- writeHandlingErrorStatus(status: boolean): any;
39
- /**
40
- * Hook per leggere dallo stato dell'applicazione se stiamo già gestendo un redirect, in modo da non tentare di gestire
41
- * N redirect contemporaneamente qualora molte API lo richiedessero allo stesso tempo
42
- */
43
- readRedirectionStatus(): boolean;
44
- /**
45
- * Hook per scrivere nello stato dell'applicazione se stiamo gestendo un redirect o meno
46
- */
47
- writeRedirectionStatus(status: boolean): void;
48
- /**
49
- * Hook per indicare se l'applicazione può gestire eccezioni del tipo "NotConfigured" (444). Qualora l'applicazione che lo implementa dichiari di gestirle verrà chiamata
50
- * la funzione **handleBlockingException** per ognuno di questi errori
51
- */
52
- handleNotConfiguredException(): boolean;
53
- /**
54
- * Hook per la gestione di un qualsiasi errore bloccante per l'operazione attuale, ma non fatale (Generalmente gestibile da dialog di avviso)
55
- */
56
- handleBlockingException(status: number, text: string): any;
57
- /**
58
- * Hook per la gestione di un qualsiasi errore fatale (Generalmente gestibile tramite navigazione a una pagina di errore custom per l'applicativo)
59
- */
60
- handleException(status: number, text: string): any;
61
- }
@@ -1,9 +0,0 @@
1
- import { ModuleWithProviders } from '@angular/core';
2
- import { HttpServiceModuleConfig } from './config/HttpServiceModuleConfig';
3
- import * as i0 from "@angular/core";
4
- export declare class HttpserviceModule {
5
- static forRoot(config?: HttpServiceModuleConfig): ModuleWithProviders<HttpserviceModule>;
6
- static ɵfac: i0.ɵɵFactoryDeclaration<HttpserviceModule, never>;
7
- static ɵmod: i0.ɵɵNgModuleDeclaration<HttpserviceModule, never, never, never>;
8
- static ɵinj: i0.ɵɵInjectorDeclaration<HttpserviceModule>;
9
- }
@@ -1,380 +0,0 @@
1
- import { HttpClient, HttpParams } from "@angular/common/http";
2
- import { CacheService } from "@esfaenza/preferences";
3
- import { HashingService, UtilityService } from "@esfaenza/extensions";
4
- import { BaseLocalization } from "@esfaenza/localizations";
5
- import { Observable, Subject } from "rxjs";
6
- import { HttpServiceExtensions } from './config/HttpServiceExtensions';
7
- import { Download } from './models/Download';
8
- import * as i0 from "@angular/core";
9
- /**
10
- * Servizio utilizzato per effettuare qualsiasi tipo di chiamata HTTP dall'applicazione, gestisce errori e cache delle risposte nativamente e ne può essere
11
- * esteso/modificato il comportamento implementando la classe di "hook" **IHttpServiceExtensions** e registrandola nel provider della classe **HttpServiceExtensions**
12
- */
13
- export declare class HTTPService {
14
- private EXTENSION_CLASS;
15
- private HTTP_INVALIDATION;
16
- private CLIENT_CACHE_DURATION_S;
17
- private CACHE_BY_USER;
18
- private HTTP_DEBUG_MODE;
19
- private bc;
20
- private http;
21
- private localStorage;
22
- private hash;
23
- private utisExts;
24
- /** Cache dello stato delle chiamate HTTP attualmente effettuate. Ogni chiamata è rappresentata da un GUID e lo status assume valore **false** solo sugli errori */
25
- private callStatus;
26
- /** Nome della cache in cui vengono storicizzate le informazioni sulle risposte delle chiamate sotto forma di dictionary */
27
- private localStorageHttpCacheKey;
28
- /** Nome della cache in cui vengono storicizzate le informazioni sulle risposte delle chiamate sotto forma di dictionary, solo per le chiamate con un tempo definito di caching */
29
- private localStorageHttpTimedCacheKey;
30
- /** Nome della cache in cui vengono storicizzate le informazioni sullo scadere della cache stessa */
31
- private localStorageHttpCacheExpireKey;
32
- /** Identità collegata al token di autenticazione da usare, richiesta al programma che utilizza la libreria attraverso l'hook **retrieveIdentity** della **HttpServiceExtensions** */
33
- private me;
34
- /** Indica che la cache a tempo dev'essere persistita il prima possibile */
35
- private PersistTimedCacheASAP;
36
- /** Indica che la cache senza limiti di tempo dev'essere persistita il prima possibile */
37
- private PersistUntimedCacheASAP;
38
- /** Subject emesso quando il servizio http si stabilizza, cioè quando non c'è nessuna chiamata pending o in corso da qualche istante */
39
- Stabilized: Subject<true>;
40
- /**
41
- * Implementazione della classe di estensione per collegare i comportamenti della libreria all'applicazione in cui è usata.
42
- *
43
- * Se è stato effettuato il provide della classe **HttpServiceExtensions** verrà usato quel provider, altrimenti verrà creata una nuova istanza di default
44
- */
45
- private ExtensionsImpl;
46
- /** Lista delle ultime 3 chiamate completate con successo in ordine di completamento (in posizione 0 c'è l'ultima completata eccetera...) */
47
- LastThreeCompletedCalls: string[];
48
- private CacheInitialized;
49
- /**
50
- * @ignore
51
- */
52
- constructor(EXTENSION_CLASS: HttpServiceExtensions, HTTP_INVALIDATION: any, CLIENT_CACHE_DURATION_S: any, CACHE_BY_USER: boolean, HTTP_DEBUG_MODE: boolean, bc: BaseLocalization, http: HttpClient, localStorage: CacheService, hash: HashingService, utisExts: UtilityService);
53
- setAppConfig(myconfig: {
54
- AppData: {
55
- ModuleId: string;
56
- ModuleDefId: number;
57
- ComponentEnvironment: string;
58
- ComponentVersion: string;
59
- ModuleDescription: string;
60
- };
61
- }): void;
62
- /**
63
- * Se vedo che ci sono elementi salvati nel localStorage provo a toglierli e a risalvarli via preference.
64
- * Nel caso migliore li sposto dal localStorage al DB di preference, nel caso peggiore li tolgo e li risalvo nel localStorage
65
- */
66
- private adjustOldStorageSystem;
67
- getlocaleObservable(): Observable<string>;
68
- /**
69
- * Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
70
- *
71
- * @param {string} url URL su cui effettuare la chiamata
72
- * @param {HttpParams} params Parametri della chiamata
73
- * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
74
- * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
75
- * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
76
- * @param {Function} errorCallback Callback chiamato in caso di errore
77
- *
78
- * @returns {Observable<T>} Observable che contiene il risultato della chiamata
79
- */
80
- get<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: Function): Observable<T>;
81
- /**
82
- * Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
83
- *
84
- * Caso specifico di chiamata che deve restituire un Blob o un ArrayBuffer nativo da elaborare
85
- *
86
- * @param {string} url URL su cui effettuare la chiamata
87
- * @param {HttpParams} params Parametri della chiamata
88
- * @param {"arraybuffer"| "blob"} type Tipo di ritorno richiesto
89
- * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
90
- * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
91
- * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
92
- * @param {Function} errorCallback Callback chiamato in caso di errore
93
- *
94
- * @returns {Observable<Blob | ArrayBuffer>} Observable che contiene il risultato della chiamata
95
- */
96
- getRaw(url: string, params?: HttpParams, type?: "arraybuffer" | "blob", transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: any): Observable<Blob | ArrayBuffer>;
97
- /**
98
- * Esecuzione di una POST HTTP
99
- *
100
- * @param {string} url URL su cui effettuare la chiamata
101
- * @param {any} bodyData DTO per la chiamata
102
- * @param {HttpParams} params Parametri della chiamata
103
- * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
104
- * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
105
- * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
106
- *
107
- * @returns {Observable<T>} Observable che contiene il risultato della chiamata
108
- */
109
- post<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
110
- /**
111
- * Esecuzione di una DELETE HTTP
112
- *
113
- * @param {string} url URL su cui effettuare la chiamata
114
- * @param {HttpParams} params Parametri della chiamata
115
- * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
116
- * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
117
- * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
118
- *
119
- * @returns {Observable<T>} Observable che contiene il risultato della chiamata
120
- */
121
- delete<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
122
- /**
123
- * Esecuzione di una PUT HTTP
124
- *
125
- * @param {string} url URL su cui effettuare la chiamata
126
- * @param {any} bodyData DTO per la chiamata
127
- * @param {HttpParams} params Parametri della chiamata
128
- * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
129
- * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
130
- * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
131
- *
132
- * @returns {Observable<T>} Observable che contiene il risultato della chiamata
133
- */
134
- put<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
135
- /**
136
- * Esecuzione di una POST HTTP
137
- *
138
- * Casistica particolare in cui bisogna anche inviare dei File
139
- *
140
- * @param {string} url URL su cui effettuare la chiamata
141
- * @param {any} bodyData DTO per la chiamata
142
- * @param {File[] | File} fileArrayOrFile Singolo file o lista di file da inviare. Il tipo **File** è quello nativo del Javascript
143
- *
144
- * @returns {Observable<T>} Observable che contiene il risultato della chiamata
145
- */
146
- postwithFiles<T>(url: string, bodyData: any, fileArrayOrFile: File[] | File, params?: HttpParams, succesfulResultMandatory?: boolean, onError?: () => void): Observable<T>;
147
- /**
148
- * Esecuzione di una POST HTTP
149
- *
150
- * Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
151
- * La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
152
- *
153
- * @param {string} url URL su cui effettuare la chiamata
154
- * @param {K} bodyData DTO per la chiamata
155
- * @param {string} filename Nome del file che si sta richiedendo, rimane lato Frontend e serve per assegnare arbitrariamente un nome al file restituito, se vuoto viene utilizzata la Content-Disposition della risposta
156
- * @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
157
- * @param {Function} afterGetFile Callback da chiamare dopo aver gestito la risposta del **getFileCallback**, in caso **handleError** fosse **false** verrà richiamato anche in caso di errore
158
- * @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
159
- */
160
- postGetFile<K>(url: string, bodyData: K, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean, pars?: HttpParams): Promise<void>;
161
- /**
162
- * Esecuzione di una GET HTTP
163
- *
164
- * Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
165
- * La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
166
- *
167
- * @param {string} url URL su cui effettuare la chiamata
168
- * @param {HttpParams} params Parametri della chiamata
169
- * @param {string} filename Nome del file che si sta richiedendo, rimane lato Frontend e serve per assegnare arbitrariamente un nome al file restituito, se vuoto viene utilizzata la Content-Disposition della risposta
170
- * @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
171
- * @param {Function} afterGetFile Callback da chiamare dopo aver gestito la risposta del **getFileCallback**, in caso **handleError** fosse **false** verrà richiamato anche in caso di errore
172
- * @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
173
- */
174
- getFile(url: string, params: HttpParams, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean): Promise<void>;
175
- /**
176
- * Download nativo di un file. Internamente utilizza il pattern **window.location.href = "..."**
177
- *
178
- * @param {string} url URL su cui effettuare la chiamata
179
- * @param {HttpParams} params Parametri della chiamata
180
- */
181
- getFileNative(url: string, params?: HttpParams): void;
182
- /**
183
- * Esecuzione di una GET di un file che emette i vari eventi di progresso di download.
184
- * Utilizzarla per overridare la dialog nativa di progress del browser e sostituirla con qualcosa tipo quello che fa MEGA.
185
- *
186
- * In caso si voglia ottenere il risultato nativo del browser del download utilizzare **getFileNative(url, pars)**
187
- *
188
- * @param {string} url URL su cui effettuare la chiamata
189
- * @param {HttpParams} params Parametri della chiamata
190
- * @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
191
- *
192
- * @returns {Observable<Download>} Observable dei vari step di progresso del download
193
- */
194
- getFileWithProgress(url: string, params: HttpParams, getFileCallback: (url: string, filename: string) => any): Observable<Download>;
195
- /**
196
- * Riconosce se l'evento HTTP è di tipo **HttpResponse** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
197
- */
198
- private isHttpResponse;
199
- /**
200
- * Riconosce se l'evento HTTP è di tipo **HttpProgressEvent** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
201
- */
202
- private isHttpProgressEvent;
203
- /**
204
- * Gestione dell'inizio di una chiamata ad un certo URL, viene generato un GUID da assegnarci, controllata la scadenza della cache,
205
- * e eventualmente loggato il fatto che sta per essere effettuata una chiamata HTTP
206
- *
207
- * @param {string} url Url a cui effettuare la chiamata
208
- * @returns {string} GUID assegnato alla chiamata
209
- */
210
- private defaultStartCall;
211
- /**
212
- * Dato un url vengono controllate le informazioni su tutti gli url da invalidare collegati all'url chiamato e, se presenti in cache, invalidati
213
- *
214
- * @param {string} url URL per cui controllare se ci sono chiamate in cache da invalidare
215
- */
216
- private checkCacheInvalidation;
217
- /**
218
- * Finalizzazione di una chiamata
219
- *
220
- * @param {string} guid GUID collegato alla chiamata appena terminata
221
- * @param {boolean} persistCacheIfIdle Effettua il persist della cache HTTP solo se non ci sono altre chiamate in corso, per evitare
222
- * che mi cambi sotto l'oggetto di cache mentre sto salvando le informazioni
223
- */
224
- private tryFinalizeByGuid;
225
- /**
226
- * Helper che dato un unico File o una lista di File crea un oggetto FormData che può essere inviato comodamente
227
- * ad un backend ASP.NET da cui si potrà accedere a Request.Form.Files
228
- *
229
- * @param {File | File[]} fileArrayOrFile Singolo File o lista di File. N.B: nella firma della funzione viene considerato **any** per fare test sulle proprietà
230
- * invece che fare test con l'**istanceof**
231
- *
232
- * @returns {FormData} FormData contenente tutti i file passati
233
- */
234
- private getFilesFormData;
235
- /**
236
- * Helper che in base ai parametri disponibili genera gli Header HTTP per la chiamata da effettuare
237
- *
238
- * @param {string} contentType Indica se aggiungere agli header "Content-Type", valorizzato al valore del parametro
239
- * @param {string} accept Indica se aggiungere agli header "Accept", valorizzato al valore del parametro
240
- * @param {boolean} includeAuth Indica se aggiungere agli header "Authorization", valorizzato col token recuperato dall'hook **retrieveAccessToken** della classe di estensione
241
- * @param {string} transactionId Indica se aggiungere agli header "X-TX-ID", valorizzato al valore del parametro
242
- *
243
- * @returns {HttpHeaders} Header generati in base ai parametri
244
- */
245
- private getHeaders;
246
- /**
247
- * Gestione di default degli errori
248
- *
249
- * @param {any} res Risultato della chiamata effettuata
250
- * @param {string} guid Identificativo GUID della chiamata effettuata
251
- */
252
- private onError;
253
- /**
254
- * Dato un errore restituisce una promise con la stringa finale dell'errore in modo da poter fare un await
255
- *
256
- * @param {any} err Errore da controllare
257
- *
258
- * @returns {Promise<string>} Promise che risolve con la stringa finale dell'errore
259
- */
260
- private getHttpErrorText;
261
- /**
262
- * Riconosce se l'oggetto è di tipo **CallResult** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
263
- *
264
- * @param {any} err Errore da controllare
265
- */
266
- private isCallResult;
267
- /**
268
- * Riconosce se l'errore è di tipo **HttpErrorResponse** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
269
- *
270
- * @param {any} err Errore da controllare
271
- */
272
- private isHttpErrorResponse;
273
- /**
274
- * Riconosce se l'errore è di tipo **TypeError** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
275
- *
276
- * @param {any} err Errore da controllare
277
- */
278
- private isTypeError;
279
- /**
280
- * Come dice il nome, registra un errore e restituisce un Observable vuoto come risultato della chiamata
281
- *
282
- * @param {any} res Risultato della chiamata effettuata
283
- * @param {string} guid Identificativo GUID della chiamata effettuata
284
- * @param {boolean} handleError Indica se gestire l'errore via libreria o se limitarsi a restituire l'Observable vuoto
285
- *
286
- * @returns {Observable<any>} Observable vuoto
287
- */
288
- private registerErrorAndReturnEmptyObservable;
289
- /**
290
- * Dato un Url e dei parametri cerca di recuperare l'eventuale oggetto già salvato in cache con le informazioni base della cache stessa
291
- *
292
- * @param {string} url URL su cui effettuare la chiamata
293
- * @param {HttpParams} params Parametri della chiamata (nulli in caso di POST)
294
- *
295
- * @returns {CacheInfos} Oggetto contenente le informazioni sulla cache per l'oggetto specificato
296
- */
297
- private tryGetCacheInformations;
298
- /**
299
- * Inserisce un oggetto nella cache appropriata in base alle informazioni contenute nel parametro **cacheInfos**
300
- *
301
- * @param {T} item Oggetto da inserire nella cache
302
- * @param {CacheInfos} cacheInfos Informazioni sulla cache recuperate da una chiamata precedente a **tryGetCacheInformations**
303
- */
304
- private cacheResponse;
305
- /**
306
- * Controlla se la cache per le chiamate senza expire time è scaduta
307
- *
308
- * @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
309
- */
310
- private untimedCacheExpired;
311
- /**
312
- * Controlla se la cache per una chiamata che ha un tempo di vita ben definito è scaduta o meno
313
- *
314
- * @param {any} item Oggetto recuperato dalla cache a cui ho aggiunto la chiave interna __expire
315
- *
316
- * @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
317
- */
318
- private timedCacheItemExpired;
319
- /**
320
- * Ripulisce la cache e imposta la prossima scadenza ad adesso + **CLIENT_CACHE_DURATION_S** (token valorizzato in fase di configurazione dalla proprietà **clientCacheDurationS** della classe **HttpServiceModuleConfig**)
321
- */
322
- resetHttpUntimedCacheStorage(): Promise<void>;
323
- /**
324
- * Ripulisce la cache delle chiamate con un tempo di expire definito
325
- */
326
- resetHttpTimedCacheStorage(): Promise<void>;
327
- /**
328
- * Genera una chiave per la cache delle chiamate in base ad URL e Parametri HTTP
329
- *
330
- * @param {string} url URL su cui effettuare la chiamata
331
- * @param {HttpParams} params Parametri della chiamata
332
- *
333
- * @returns {string} Chiave che rappresenta in maniera univoca la chiamata
334
- */
335
- private makeCacheKey;
336
- /**
337
- * Generazione GUID
338
- *
339
- * @returns {string} Nuovo GUID generato in maniera casuale
340
- */
341
- private getGUID;
342
- /**
343
- * Metodo per scrivere log a console qualora **DEBUG_MODE** risultasse **true**
344
- *
345
- * @param {string} message Messaggio di log
346
- */
347
- private log;
348
- /**
349
- * Helper per la localizzazione dei messaggi
350
- *
351
- * @param {string} message Messaggio da localizzare
352
- *
353
- * @returns {string} Messaggio localizzato
354
- */
355
- private loc;
356
- /**
357
- * Helper per lanciare la selezione di tutto quello che è relativo a un api di ricerca con AppSearch (di cui non utilizzo il tipo vero per ridurre le dipendenze)
358
- */
359
- getAll<T>(view: {
360
- items: T[];
361
- page: number;
362
- itemsperpageoverride: number;
363
- selection: {
364
- exclusions: T[];
365
- all: boolean;
366
- items: T[];
367
- };
368
- }, api: string, pars?: HttpParams, transaction?: string): Observable<T[]>;
369
- /*****************************************************************************************************************************************
370
- ***************************************************** TRANSACTION HELPERS ***************************************************************
371
- *****************************************************************************************************************************************/
372
- private GET_Trans_BeginTrans;
373
- private GET_Trans_CheckExecution;
374
- private GET_Trans_EndTrans;
375
- beginTransaction(executionKey: string, secondsTimeout?: number): Observable<string>;
376
- checkTransaction(executionKey: string): Observable<number>;
377
- endTransaction(transactionKey: string, transactionResult: boolean): Observable<string>;
378
- static ɵfac: i0.ɵɵFactoryDeclaration<HTTPService, [null, { optional: true; }, { optional: true; }, { optional: true; }, { optional: true; }, { optional: true; }, null, { optional: true; }, { optional: true; }, { optional: true; }]>;
379
- static ɵprov: i0.ɵɵInjectableDeclaration<HTTPService>;
380
- }
@@ -1,8 +0,0 @@
1
- export declare class CacheInfos {
2
- finalUrl: string;
3
- cache: boolean;
4
- cacheKey: string;
5
- cacheTime: string;
6
- cacheItem: any;
7
- constructor(finalUrl: string, cache: boolean, cacheKey: string, cacheTime: string, cacheItem: any);
8
- }
@@ -1,5 +0,0 @@
1
- export declare class Download {
2
- state: 'PENDING' | 'IN_PROGRESS' | 'DONE';
3
- progress: number;
4
- content: Blob | null;
5
- }
package/lib/tokens.d.ts DELETED
@@ -1,21 +0,0 @@
1
- import { InjectionToken } from '@angular/core';
2
- /**
3
- * Dizionario di invalidazioni delle chiamate HTTP
4
- */
5
- export declare const HTTP_INVALIDATION: InjectionToken<Record<string, string[]>>;
6
- /**
7
- * Durata della cache lato libreria dopo il quale la cache verrà ripulita
8
- */
9
- export declare const CLIENT_CACHE_DURATION_S: InjectionToken<number>;
10
- /**
11
- * Nome dell'APP utilizzato per creare le chiavi delle cache specifiche per l'applicazione corrente
12
- */
13
- export declare const APP_NAME: InjectionToken<string>;
14
- /**
15
- * Indica se utilizzare l'identificativo utente nella cache
16
- */
17
- export declare const CACHE_BY_USER: InjectionToken<boolean>;
18
- /**
19
- * Indica se fare log nella console ad ogni azione significativa
20
- */
21
- export declare const HTTP_DEBUG_MODE: InjectionToken<boolean>;
package/public-api.d.ts DELETED
@@ -1,7 +0,0 @@
1
- export * from './lib/tokens';
2
- export * from './lib/httpservice.service';
3
- export * from './lib/httpservice.module';
4
- export * from './lib/config/HttpServiceModuleConfig';
5
- export * from './lib/config/IHttpServiceExtensions';
6
- export * from './lib/config/HttpServiceExtensions';
7
- export * from './lib/models/Download';