@esfaenza/httpservice 16.2.27 → 17.3.15
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.
- package/esm2022/esfaenza-httpservice.mjs +4 -4
- package/esm2022/lib/config/HttpServiceExtensions.mjs +86 -86
- package/esm2022/lib/config/HttpServiceModuleConfig.mjs +5 -5
- package/esm2022/lib/config/IHttpServiceExtensions.mjs +1 -1
- package/esm2022/lib/httpservice.module.mjs +22 -22
- package/esm2022/lib/httpservice.service.mjs +842 -842
- package/esm2022/lib/models/CacheInfos.mjs +9 -9
- package/esm2022/lib/models/Download.mjs +2 -2
- package/esm2022/lib/tokens.mjs +21 -21
- package/esm2022/public-api.mjs +10 -10
- package/fesm2022/esfaenza-httpservice.mjs +962 -962
- package/fesm2022/esfaenza-httpservice.mjs.map +1 -1
- package/index.d.ts +5 -5
- package/lib/config/HttpServiceExtensions.d.ts +65 -65
- package/lib/config/HttpServiceModuleConfig.d.ts +25 -25
- package/lib/config/IHttpServiceExtensions.d.ts +61 -61
- package/lib/httpservice.module.d.ts +9 -9
- package/lib/httpservice.service.d.ts +379 -379
- package/lib/models/CacheInfos.d.ts +8 -8
- package/lib/models/Download.d.ts +5 -5
- package/lib/tokens.d.ts +21 -21
- package/package.json +7 -7
- package/public-api.d.ts +7 -7
|
@@ -1,379 +1,379 @@
|
|
|
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
|
-
/**
|
|
68
|
-
* Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
|
|
69
|
-
*
|
|
70
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
71
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
72
|
-
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
73
|
-
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
74
|
-
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
75
|
-
* @param {Function} errorCallback Callback chiamato in caso di errore
|
|
76
|
-
*
|
|
77
|
-
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
78
|
-
*/
|
|
79
|
-
get<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: Function): Observable<T>;
|
|
80
|
-
/**
|
|
81
|
-
* Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
|
|
82
|
-
*
|
|
83
|
-
* Caso specifico di chiamata che deve restituire un Blob o un ArrayBuffer nativo da elaborare
|
|
84
|
-
*
|
|
85
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
86
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
87
|
-
* @param {"arraybuffer"| "blob"} type Tipo di ritorno richiesto
|
|
88
|
-
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
89
|
-
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
90
|
-
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
91
|
-
* @param {Function} errorCallback Callback chiamato in caso di errore
|
|
92
|
-
*
|
|
93
|
-
* @returns {Observable<Blob | ArrayBuffer>} Observable che contiene il risultato della chiamata
|
|
94
|
-
*/
|
|
95
|
-
getRaw(url: string, params?: HttpParams, type?: "arraybuffer" | "blob", transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: any): Observable<Blob | ArrayBuffer>;
|
|
96
|
-
/**
|
|
97
|
-
* Esecuzione di una POST HTTP
|
|
98
|
-
*
|
|
99
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
100
|
-
* @param {any} bodyData DTO per la chiamata
|
|
101
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
102
|
-
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
103
|
-
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
104
|
-
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
105
|
-
*
|
|
106
|
-
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
107
|
-
*/
|
|
108
|
-
post<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
|
|
109
|
-
/**
|
|
110
|
-
* Esecuzione di una DELETE HTTP
|
|
111
|
-
*
|
|
112
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
113
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
114
|
-
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
115
|
-
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
116
|
-
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
117
|
-
*
|
|
118
|
-
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
119
|
-
*/
|
|
120
|
-
delete<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
|
|
121
|
-
/**
|
|
122
|
-
* Esecuzione di una PUT HTTP
|
|
123
|
-
*
|
|
124
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
125
|
-
* @param {any} bodyData DTO per la chiamata
|
|
126
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
127
|
-
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
128
|
-
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
129
|
-
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
130
|
-
*
|
|
131
|
-
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
132
|
-
*/
|
|
133
|
-
put<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
|
|
134
|
-
/**
|
|
135
|
-
* Esecuzione di una POST HTTP
|
|
136
|
-
*
|
|
137
|
-
* Casistica particolare in cui bisogna anche inviare dei File
|
|
138
|
-
*
|
|
139
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
140
|
-
* @param {any} bodyData DTO per la chiamata
|
|
141
|
-
* @param {File[] | File} fileArrayOrFile Singolo file o lista di file da inviare. Il tipo **File** è quello nativo del Javascript
|
|
142
|
-
*
|
|
143
|
-
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
144
|
-
*/
|
|
145
|
-
postwithFiles<T>(url: string, bodyData: any, fileArrayOrFile: File[] | File, params?: HttpParams, succesfulResultMandatory?: boolean, onError?: () => void): Observable<T>;
|
|
146
|
-
/**
|
|
147
|
-
* Esecuzione di una POST HTTP
|
|
148
|
-
*
|
|
149
|
-
* Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
|
|
150
|
-
* La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
|
|
151
|
-
*
|
|
152
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
153
|
-
* @param {K} bodyData DTO per la chiamata
|
|
154
|
-
* @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
|
|
155
|
-
* @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
|
|
156
|
-
* @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
|
|
157
|
-
* @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
|
|
158
|
-
*/
|
|
159
|
-
postGetFile<K>(url: string, bodyData: K, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean, pars?: HttpParams): Promise<void>;
|
|
160
|
-
/**
|
|
161
|
-
* Esecuzione di una GET HTTP
|
|
162
|
-
*
|
|
163
|
-
* Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
|
|
164
|
-
* La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
|
|
165
|
-
*
|
|
166
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
167
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
168
|
-
* @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
|
|
169
|
-
* @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
|
|
170
|
-
* @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
|
|
171
|
-
* @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
|
|
172
|
-
*/
|
|
173
|
-
getFile(url: string, params: HttpParams, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean): Promise<void>;
|
|
174
|
-
/**
|
|
175
|
-
* Download nativo di un file. Internamente utilizza il pattern **window.location.href = "..."**
|
|
176
|
-
*
|
|
177
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
178
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
179
|
-
*/
|
|
180
|
-
getFileNative(url: string, params?: HttpParams): void;
|
|
181
|
-
/**
|
|
182
|
-
* Esecuzione di una GET di un file che emette i vari eventi di progresso di download.
|
|
183
|
-
* Utilizzarla per overridare la dialog nativa di progress del browser e sostituirla con qualcosa tipo quello che fa MEGA.
|
|
184
|
-
*
|
|
185
|
-
* In caso si voglia ottenere il risultato nativo del browser del download utilizzare **getFileNative(url, pars)**
|
|
186
|
-
*
|
|
187
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
188
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
189
|
-
* @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
|
|
190
|
-
*
|
|
191
|
-
* @returns {Observable<Download>} Observable dei vari step di progresso del download
|
|
192
|
-
*/
|
|
193
|
-
getFileWithProgress(url: string, params: HttpParams, getFileCallback: (url: string, filename: string) => any): Observable<Download>;
|
|
194
|
-
/**
|
|
195
|
-
* 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
|
|
196
|
-
*/
|
|
197
|
-
private isHttpResponse;
|
|
198
|
-
/**
|
|
199
|
-
* 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
|
|
200
|
-
*/
|
|
201
|
-
private isHttpProgressEvent;
|
|
202
|
-
/**
|
|
203
|
-
* Gestione dell'inizio di una chiamata ad un certo URL, viene generato un GUID da assegnarci, controllata la scadenza della cache,
|
|
204
|
-
* e eventualmente loggato il fatto che sta per essere effettuata una chiamata HTTP
|
|
205
|
-
*
|
|
206
|
-
* @param {string} url Url a cui effettuare la chiamata
|
|
207
|
-
* @returns {string} GUID assegnato alla chiamata
|
|
208
|
-
*/
|
|
209
|
-
private defaultStartCall;
|
|
210
|
-
/**
|
|
211
|
-
* Dato un url vengono controllate le informazioni su tutti gli url da invalidare collegati all'url chiamato e, se presenti in cache, invalidati
|
|
212
|
-
*
|
|
213
|
-
* @param {string} url URL per cui controllare se ci sono chiamate in cache da invalidare
|
|
214
|
-
*/
|
|
215
|
-
private checkCacheInvalidation;
|
|
216
|
-
/**
|
|
217
|
-
* Finalizzazione di una chiamata
|
|
218
|
-
*
|
|
219
|
-
* @param {string} guid GUID collegato alla chiamata appena terminata
|
|
220
|
-
* @param {boolean} persistCacheIfIdle Effettua il persist della cache HTTP solo se non ci sono altre chiamate in corso, per evitare
|
|
221
|
-
* che mi cambi sotto l'oggetto di cache mentre sto salvando le informazioni
|
|
222
|
-
*/
|
|
223
|
-
private tryFinalizeByGuid;
|
|
224
|
-
/**
|
|
225
|
-
* Helper che dato un unico File o una lista di File crea un oggetto FormData che può essere inviato comodamente
|
|
226
|
-
* ad un backend ASP.NET da cui si potrà accedere a Request.Form.Files
|
|
227
|
-
*
|
|
228
|
-
* @param {File | File[]} fileArrayOrFile Singolo File o lista di File. N.B: nella firma della funzione viene considerato **any** per fare test sulle proprietà
|
|
229
|
-
* invece che fare test con l'**istanceof**
|
|
230
|
-
*
|
|
231
|
-
* @returns {FormData} FormData contenente tutti i file passati
|
|
232
|
-
*/
|
|
233
|
-
private getFilesFormData;
|
|
234
|
-
/**
|
|
235
|
-
* Helper che in base ai parametri disponibili genera gli Header HTTP per la chiamata da effettuare
|
|
236
|
-
*
|
|
237
|
-
* @param {string} contentType Indica se aggiungere agli header "Content-Type", valorizzato al valore del parametro
|
|
238
|
-
* @param {string} accept Indica se aggiungere agli header "Accept", valorizzato al valore del parametro
|
|
239
|
-
* @param {boolean} includeAuth Indica se aggiungere agli header "Authorization", valorizzato col token recuperato dall'hook **retrieveAccessToken** della classe di estensione
|
|
240
|
-
* @param {string} transactionId Indica se aggiungere agli header "X-TX-ID", valorizzato al valore del parametro
|
|
241
|
-
*
|
|
242
|
-
* @returns {HttpHeaders} Header generati in base ai parametri
|
|
243
|
-
*/
|
|
244
|
-
private getHeaders;
|
|
245
|
-
/**
|
|
246
|
-
* Gestione di default degli errori
|
|
247
|
-
*
|
|
248
|
-
* @param {any} res Risultato della chiamata effettuata
|
|
249
|
-
* @param {string} guid Identificativo GUID della chiamata effettuata
|
|
250
|
-
*/
|
|
251
|
-
private onError;
|
|
252
|
-
/**
|
|
253
|
-
* Dato un errore restituisce una promise con la stringa finale dell'errore in modo da poter fare un await
|
|
254
|
-
*
|
|
255
|
-
* @param {any} err Errore da controllare
|
|
256
|
-
*
|
|
257
|
-
* @returns {Promise<string>} Promise che risolve con la stringa finale dell'errore
|
|
258
|
-
*/
|
|
259
|
-
private getHttpErrorText;
|
|
260
|
-
/**
|
|
261
|
-
* Riconosce se l'oggetto è di tipo **CallResult** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
|
|
262
|
-
*
|
|
263
|
-
* @param {any} err Errore da controllare
|
|
264
|
-
*/
|
|
265
|
-
private isCallResult;
|
|
266
|
-
/**
|
|
267
|
-
* Riconosce se l'errore è di tipo **HttpErrorResponse** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
|
|
268
|
-
*
|
|
269
|
-
* @param {any} err Errore da controllare
|
|
270
|
-
*/
|
|
271
|
-
private isHttpErrorResponse;
|
|
272
|
-
/**
|
|
273
|
-
* Riconosce se l'errore è di tipo **TypeError** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
|
|
274
|
-
*
|
|
275
|
-
* @param {any} err Errore da controllare
|
|
276
|
-
*/
|
|
277
|
-
private isTypeError;
|
|
278
|
-
/**
|
|
279
|
-
* Come dice il nome, registra un errore e restituisce un Observable vuoto come risultato della chiamata
|
|
280
|
-
*
|
|
281
|
-
* @param {any} res Risultato della chiamata effettuata
|
|
282
|
-
* @param {string} guid Identificativo GUID della chiamata effettuata
|
|
283
|
-
* @param {boolean} handleError Indica se gestire l'errore via libreria o se limitarsi a restituire l'Observable vuoto
|
|
284
|
-
*
|
|
285
|
-
* @returns {Observable<any>} Observable vuoto
|
|
286
|
-
*/
|
|
287
|
-
private registerErrorAndReturnEmptyObservable;
|
|
288
|
-
/**
|
|
289
|
-
* Dato un Url e dei parametri cerca di recuperare l'eventuale oggetto già salvato in cache con le informazioni base della cache stessa
|
|
290
|
-
*
|
|
291
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
292
|
-
* @param {HttpParams} params Parametri della chiamata (nulli in caso di POST)
|
|
293
|
-
*
|
|
294
|
-
* @returns {CacheInfos} Oggetto contenente le informazioni sulla cache per l'oggetto specificato
|
|
295
|
-
*/
|
|
296
|
-
private tryGetCacheInformations;
|
|
297
|
-
/**
|
|
298
|
-
* Inserisce un oggetto nella cache appropriata in base alle informazioni contenute nel parametro **cacheInfos**
|
|
299
|
-
*
|
|
300
|
-
* @param {T} item Oggetto da inserire nella cache
|
|
301
|
-
* @param {CacheInfos} cacheInfos Informazioni sulla cache recuperate da una chiamata precedente a **tryGetCacheInformations**
|
|
302
|
-
*/
|
|
303
|
-
private cacheResponse;
|
|
304
|
-
/**
|
|
305
|
-
* Controlla se la cache per le chiamate senza expire time è scaduta
|
|
306
|
-
*
|
|
307
|
-
* @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
|
|
308
|
-
*/
|
|
309
|
-
private untimedCacheExpired;
|
|
310
|
-
/**
|
|
311
|
-
* Controlla se la cache per una chiamata che ha un tempo di vita ben definito è scaduta o meno
|
|
312
|
-
*
|
|
313
|
-
* @param {any} item Oggetto recuperato dalla cache a cui ho aggiunto la chiave interna __expire
|
|
314
|
-
*
|
|
315
|
-
* @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
|
|
316
|
-
*/
|
|
317
|
-
private timedCacheItemExpired;
|
|
318
|
-
/**
|
|
319
|
-
* 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**)
|
|
320
|
-
*/
|
|
321
|
-
resetHttpUntimedCacheStorage(): Promise<void>;
|
|
322
|
-
/**
|
|
323
|
-
* Ripulisce la cache delle chiamate con un tempo di expire definito
|
|
324
|
-
*/
|
|
325
|
-
resetHttpTimedCacheStorage(): Promise<void>;
|
|
326
|
-
/**
|
|
327
|
-
* Genera una chiave per la cache delle chiamate in base ad URL e Parametri HTTP
|
|
328
|
-
*
|
|
329
|
-
* @param {string} url URL su cui effettuare la chiamata
|
|
330
|
-
* @param {HttpParams} params Parametri della chiamata
|
|
331
|
-
*
|
|
332
|
-
* @returns {string} Chiave che rappresenta in maniera univoca la chiamata
|
|
333
|
-
*/
|
|
334
|
-
private makeCacheKey;
|
|
335
|
-
/**
|
|
336
|
-
* Generazione GUID
|
|
337
|
-
*
|
|
338
|
-
* @returns {string} Nuovo GUID generato in maniera casuale
|
|
339
|
-
*/
|
|
340
|
-
private getGUID;
|
|
341
|
-
/**
|
|
342
|
-
* Metodo per scrivere log a console qualora **DEBUG_MODE** risultasse **true**
|
|
343
|
-
*
|
|
344
|
-
* @param {string} message Messaggio di log
|
|
345
|
-
*/
|
|
346
|
-
private log;
|
|
347
|
-
/**
|
|
348
|
-
* Helper per la localizzazione dei messaggi
|
|
349
|
-
*
|
|
350
|
-
* @param {string} message Messaggio da localizzare
|
|
351
|
-
*
|
|
352
|
-
* @returns {string} Messaggio localizzato
|
|
353
|
-
*/
|
|
354
|
-
private loc;
|
|
355
|
-
/**
|
|
356
|
-
* 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)
|
|
357
|
-
*/
|
|
358
|
-
getAll<T>(view: {
|
|
359
|
-
items: T[];
|
|
360
|
-
page: number;
|
|
361
|
-
itemsperpageoverride: number;
|
|
362
|
-
selection: {
|
|
363
|
-
exclusions: T[];
|
|
364
|
-
all: boolean;
|
|
365
|
-
items: T[];
|
|
366
|
-
};
|
|
367
|
-
}, api: string, pars?: HttpParams, transaction?: string): Observable<T[]>;
|
|
368
|
-
/*****************************************************************************************************************************************
|
|
369
|
-
***************************************************** TRANSACTION HELPERS ***************************************************************
|
|
370
|
-
*****************************************************************************************************************************************/
|
|
371
|
-
private GET_Trans_BeginTrans;
|
|
372
|
-
private GET_Trans_CheckExecution;
|
|
373
|
-
private GET_Trans_EndTrans;
|
|
374
|
-
beginTransaction(executionKey: string, secondsTimeout?: number): Observable<string>;
|
|
375
|
-
checkTransaction(executionKey: string): Observable<number>;
|
|
376
|
-
endTransaction(transactionKey: string, transactionResult: boolean): Observable<string>;
|
|
377
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<HTTPService, [null, { optional: true; }, null, null, null, null, null, null, null, null]>;
|
|
378
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<HTTPService>;
|
|
379
|
-
}
|
|
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
|
+
/**
|
|
68
|
+
* Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
|
|
69
|
+
*
|
|
70
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
71
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
72
|
+
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
73
|
+
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
74
|
+
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
75
|
+
* @param {Function} errorCallback Callback chiamato in caso di errore
|
|
76
|
+
*
|
|
77
|
+
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
78
|
+
*/
|
|
79
|
+
get<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: Function): Observable<T>;
|
|
80
|
+
/**
|
|
81
|
+
* Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
|
|
82
|
+
*
|
|
83
|
+
* Caso specifico di chiamata che deve restituire un Blob o un ArrayBuffer nativo da elaborare
|
|
84
|
+
*
|
|
85
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
86
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
87
|
+
* @param {"arraybuffer"| "blob"} type Tipo di ritorno richiesto
|
|
88
|
+
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
89
|
+
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
90
|
+
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
91
|
+
* @param {Function} errorCallback Callback chiamato in caso di errore
|
|
92
|
+
*
|
|
93
|
+
* @returns {Observable<Blob | ArrayBuffer>} Observable che contiene il risultato della chiamata
|
|
94
|
+
*/
|
|
95
|
+
getRaw(url: string, params?: HttpParams, type?: "arraybuffer" | "blob", transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: any): Observable<Blob | ArrayBuffer>;
|
|
96
|
+
/**
|
|
97
|
+
* Esecuzione di una POST HTTP
|
|
98
|
+
*
|
|
99
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
100
|
+
* @param {any} bodyData DTO per la chiamata
|
|
101
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
102
|
+
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
103
|
+
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
104
|
+
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
105
|
+
*
|
|
106
|
+
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
107
|
+
*/
|
|
108
|
+
post<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
|
|
109
|
+
/**
|
|
110
|
+
* Esecuzione di una DELETE HTTP
|
|
111
|
+
*
|
|
112
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
113
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
114
|
+
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
115
|
+
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
116
|
+
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
117
|
+
*
|
|
118
|
+
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
119
|
+
*/
|
|
120
|
+
delete<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
|
|
121
|
+
/**
|
|
122
|
+
* Esecuzione di una PUT HTTP
|
|
123
|
+
*
|
|
124
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
125
|
+
* @param {any} bodyData DTO per la chiamata
|
|
126
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
127
|
+
* @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
|
|
128
|
+
* @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
|
|
129
|
+
* raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
|
|
130
|
+
*
|
|
131
|
+
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
132
|
+
*/
|
|
133
|
+
put<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
|
|
134
|
+
/**
|
|
135
|
+
* Esecuzione di una POST HTTP
|
|
136
|
+
*
|
|
137
|
+
* Casistica particolare in cui bisogna anche inviare dei File
|
|
138
|
+
*
|
|
139
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
140
|
+
* @param {any} bodyData DTO per la chiamata
|
|
141
|
+
* @param {File[] | File} fileArrayOrFile Singolo file o lista di file da inviare. Il tipo **File** è quello nativo del Javascript
|
|
142
|
+
*
|
|
143
|
+
* @returns {Observable<T>} Observable che contiene il risultato della chiamata
|
|
144
|
+
*/
|
|
145
|
+
postwithFiles<T>(url: string, bodyData: any, fileArrayOrFile: File[] | File, params?: HttpParams, succesfulResultMandatory?: boolean, onError?: () => void): Observable<T>;
|
|
146
|
+
/**
|
|
147
|
+
* Esecuzione di una POST HTTP
|
|
148
|
+
*
|
|
149
|
+
* Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
|
|
150
|
+
* La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
|
|
151
|
+
*
|
|
152
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
153
|
+
* @param {K} bodyData DTO per la chiamata
|
|
154
|
+
* @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
|
|
155
|
+
* @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
|
|
156
|
+
* @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
|
|
157
|
+
* @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
|
|
158
|
+
*/
|
|
159
|
+
postGetFile<K>(url: string, bodyData: K, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean, pars?: HttpParams): Promise<void>;
|
|
160
|
+
/**
|
|
161
|
+
* Esecuzione di una GET HTTP
|
|
162
|
+
*
|
|
163
|
+
* Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
|
|
164
|
+
* La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
|
|
165
|
+
*
|
|
166
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
167
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
168
|
+
* @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
|
|
169
|
+
* @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
|
|
170
|
+
* @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
|
|
171
|
+
* @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
|
|
172
|
+
*/
|
|
173
|
+
getFile(url: string, params: HttpParams, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean): Promise<void>;
|
|
174
|
+
/**
|
|
175
|
+
* Download nativo di un file. Internamente utilizza il pattern **window.location.href = "..."**
|
|
176
|
+
*
|
|
177
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
178
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
179
|
+
*/
|
|
180
|
+
getFileNative(url: string, params?: HttpParams): void;
|
|
181
|
+
/**
|
|
182
|
+
* Esecuzione di una GET di un file che emette i vari eventi di progresso di download.
|
|
183
|
+
* Utilizzarla per overridare la dialog nativa di progress del browser e sostituirla con qualcosa tipo quello che fa MEGA.
|
|
184
|
+
*
|
|
185
|
+
* In caso si voglia ottenere il risultato nativo del browser del download utilizzare **getFileNative(url, pars)**
|
|
186
|
+
*
|
|
187
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
188
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
189
|
+
* @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
|
|
190
|
+
*
|
|
191
|
+
* @returns {Observable<Download>} Observable dei vari step di progresso del download
|
|
192
|
+
*/
|
|
193
|
+
getFileWithProgress(url: string, params: HttpParams, getFileCallback: (url: string, filename: string) => any): Observable<Download>;
|
|
194
|
+
/**
|
|
195
|
+
* 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
|
|
196
|
+
*/
|
|
197
|
+
private isHttpResponse;
|
|
198
|
+
/**
|
|
199
|
+
* 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
|
|
200
|
+
*/
|
|
201
|
+
private isHttpProgressEvent;
|
|
202
|
+
/**
|
|
203
|
+
* Gestione dell'inizio di una chiamata ad un certo URL, viene generato un GUID da assegnarci, controllata la scadenza della cache,
|
|
204
|
+
* e eventualmente loggato il fatto che sta per essere effettuata una chiamata HTTP
|
|
205
|
+
*
|
|
206
|
+
* @param {string} url Url a cui effettuare la chiamata
|
|
207
|
+
* @returns {string} GUID assegnato alla chiamata
|
|
208
|
+
*/
|
|
209
|
+
private defaultStartCall;
|
|
210
|
+
/**
|
|
211
|
+
* Dato un url vengono controllate le informazioni su tutti gli url da invalidare collegati all'url chiamato e, se presenti in cache, invalidati
|
|
212
|
+
*
|
|
213
|
+
* @param {string} url URL per cui controllare se ci sono chiamate in cache da invalidare
|
|
214
|
+
*/
|
|
215
|
+
private checkCacheInvalidation;
|
|
216
|
+
/**
|
|
217
|
+
* Finalizzazione di una chiamata
|
|
218
|
+
*
|
|
219
|
+
* @param {string} guid GUID collegato alla chiamata appena terminata
|
|
220
|
+
* @param {boolean} persistCacheIfIdle Effettua il persist della cache HTTP solo se non ci sono altre chiamate in corso, per evitare
|
|
221
|
+
* che mi cambi sotto l'oggetto di cache mentre sto salvando le informazioni
|
|
222
|
+
*/
|
|
223
|
+
private tryFinalizeByGuid;
|
|
224
|
+
/**
|
|
225
|
+
* Helper che dato un unico File o una lista di File crea un oggetto FormData che può essere inviato comodamente
|
|
226
|
+
* ad un backend ASP.NET da cui si potrà accedere a Request.Form.Files
|
|
227
|
+
*
|
|
228
|
+
* @param {File | File[]} fileArrayOrFile Singolo File o lista di File. N.B: nella firma della funzione viene considerato **any** per fare test sulle proprietà
|
|
229
|
+
* invece che fare test con l'**istanceof**
|
|
230
|
+
*
|
|
231
|
+
* @returns {FormData} FormData contenente tutti i file passati
|
|
232
|
+
*/
|
|
233
|
+
private getFilesFormData;
|
|
234
|
+
/**
|
|
235
|
+
* Helper che in base ai parametri disponibili genera gli Header HTTP per la chiamata da effettuare
|
|
236
|
+
*
|
|
237
|
+
* @param {string} contentType Indica se aggiungere agli header "Content-Type", valorizzato al valore del parametro
|
|
238
|
+
* @param {string} accept Indica se aggiungere agli header "Accept", valorizzato al valore del parametro
|
|
239
|
+
* @param {boolean} includeAuth Indica se aggiungere agli header "Authorization", valorizzato col token recuperato dall'hook **retrieveAccessToken** della classe di estensione
|
|
240
|
+
* @param {string} transactionId Indica se aggiungere agli header "X-TX-ID", valorizzato al valore del parametro
|
|
241
|
+
*
|
|
242
|
+
* @returns {HttpHeaders} Header generati in base ai parametri
|
|
243
|
+
*/
|
|
244
|
+
private getHeaders;
|
|
245
|
+
/**
|
|
246
|
+
* Gestione di default degli errori
|
|
247
|
+
*
|
|
248
|
+
* @param {any} res Risultato della chiamata effettuata
|
|
249
|
+
* @param {string} guid Identificativo GUID della chiamata effettuata
|
|
250
|
+
*/
|
|
251
|
+
private onError;
|
|
252
|
+
/**
|
|
253
|
+
* Dato un errore restituisce una promise con la stringa finale dell'errore in modo da poter fare un await
|
|
254
|
+
*
|
|
255
|
+
* @param {any} err Errore da controllare
|
|
256
|
+
*
|
|
257
|
+
* @returns {Promise<string>} Promise che risolve con la stringa finale dell'errore
|
|
258
|
+
*/
|
|
259
|
+
private getHttpErrorText;
|
|
260
|
+
/**
|
|
261
|
+
* Riconosce se l'oggetto è di tipo **CallResult** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
|
|
262
|
+
*
|
|
263
|
+
* @param {any} err Errore da controllare
|
|
264
|
+
*/
|
|
265
|
+
private isCallResult;
|
|
266
|
+
/**
|
|
267
|
+
* Riconosce se l'errore è di tipo **HttpErrorResponse** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
|
|
268
|
+
*
|
|
269
|
+
* @param {any} err Errore da controllare
|
|
270
|
+
*/
|
|
271
|
+
private isHttpErrorResponse;
|
|
272
|
+
/**
|
|
273
|
+
* Riconosce se l'errore è di tipo **TypeError** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
|
|
274
|
+
*
|
|
275
|
+
* @param {any} err Errore da controllare
|
|
276
|
+
*/
|
|
277
|
+
private isTypeError;
|
|
278
|
+
/**
|
|
279
|
+
* Come dice il nome, registra un errore e restituisce un Observable vuoto come risultato della chiamata
|
|
280
|
+
*
|
|
281
|
+
* @param {any} res Risultato della chiamata effettuata
|
|
282
|
+
* @param {string} guid Identificativo GUID della chiamata effettuata
|
|
283
|
+
* @param {boolean} handleError Indica se gestire l'errore via libreria o se limitarsi a restituire l'Observable vuoto
|
|
284
|
+
*
|
|
285
|
+
* @returns {Observable<any>} Observable vuoto
|
|
286
|
+
*/
|
|
287
|
+
private registerErrorAndReturnEmptyObservable;
|
|
288
|
+
/**
|
|
289
|
+
* Dato un Url e dei parametri cerca di recuperare l'eventuale oggetto già salvato in cache con le informazioni base della cache stessa
|
|
290
|
+
*
|
|
291
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
292
|
+
* @param {HttpParams} params Parametri della chiamata (nulli in caso di POST)
|
|
293
|
+
*
|
|
294
|
+
* @returns {CacheInfos} Oggetto contenente le informazioni sulla cache per l'oggetto specificato
|
|
295
|
+
*/
|
|
296
|
+
private tryGetCacheInformations;
|
|
297
|
+
/**
|
|
298
|
+
* Inserisce un oggetto nella cache appropriata in base alle informazioni contenute nel parametro **cacheInfos**
|
|
299
|
+
*
|
|
300
|
+
* @param {T} item Oggetto da inserire nella cache
|
|
301
|
+
* @param {CacheInfos} cacheInfos Informazioni sulla cache recuperate da una chiamata precedente a **tryGetCacheInformations**
|
|
302
|
+
*/
|
|
303
|
+
private cacheResponse;
|
|
304
|
+
/**
|
|
305
|
+
* Controlla se la cache per le chiamate senza expire time è scaduta
|
|
306
|
+
*
|
|
307
|
+
* @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
|
|
308
|
+
*/
|
|
309
|
+
private untimedCacheExpired;
|
|
310
|
+
/**
|
|
311
|
+
* Controlla se la cache per una chiamata che ha un tempo di vita ben definito è scaduta o meno
|
|
312
|
+
*
|
|
313
|
+
* @param {any} item Oggetto recuperato dalla cache a cui ho aggiunto la chiave interna __expire
|
|
314
|
+
*
|
|
315
|
+
* @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
|
|
316
|
+
*/
|
|
317
|
+
private timedCacheItemExpired;
|
|
318
|
+
/**
|
|
319
|
+
* 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**)
|
|
320
|
+
*/
|
|
321
|
+
resetHttpUntimedCacheStorage(): Promise<void>;
|
|
322
|
+
/**
|
|
323
|
+
* Ripulisce la cache delle chiamate con un tempo di expire definito
|
|
324
|
+
*/
|
|
325
|
+
resetHttpTimedCacheStorage(): Promise<void>;
|
|
326
|
+
/**
|
|
327
|
+
* Genera una chiave per la cache delle chiamate in base ad URL e Parametri HTTP
|
|
328
|
+
*
|
|
329
|
+
* @param {string} url URL su cui effettuare la chiamata
|
|
330
|
+
* @param {HttpParams} params Parametri della chiamata
|
|
331
|
+
*
|
|
332
|
+
* @returns {string} Chiave che rappresenta in maniera univoca la chiamata
|
|
333
|
+
*/
|
|
334
|
+
private makeCacheKey;
|
|
335
|
+
/**
|
|
336
|
+
* Generazione GUID
|
|
337
|
+
*
|
|
338
|
+
* @returns {string} Nuovo GUID generato in maniera casuale
|
|
339
|
+
*/
|
|
340
|
+
private getGUID;
|
|
341
|
+
/**
|
|
342
|
+
* Metodo per scrivere log a console qualora **DEBUG_MODE** risultasse **true**
|
|
343
|
+
*
|
|
344
|
+
* @param {string} message Messaggio di log
|
|
345
|
+
*/
|
|
346
|
+
private log;
|
|
347
|
+
/**
|
|
348
|
+
* Helper per la localizzazione dei messaggi
|
|
349
|
+
*
|
|
350
|
+
* @param {string} message Messaggio da localizzare
|
|
351
|
+
*
|
|
352
|
+
* @returns {string} Messaggio localizzato
|
|
353
|
+
*/
|
|
354
|
+
private loc;
|
|
355
|
+
/**
|
|
356
|
+
* 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)
|
|
357
|
+
*/
|
|
358
|
+
getAll<T>(view: {
|
|
359
|
+
items: T[];
|
|
360
|
+
page: number;
|
|
361
|
+
itemsperpageoverride: number;
|
|
362
|
+
selection: {
|
|
363
|
+
exclusions: T[];
|
|
364
|
+
all: boolean;
|
|
365
|
+
items: T[];
|
|
366
|
+
};
|
|
367
|
+
}, api: string, pars?: HttpParams, transaction?: string): Observable<T[]>;
|
|
368
|
+
/*****************************************************************************************************************************************
|
|
369
|
+
***************************************************** TRANSACTION HELPERS ***************************************************************
|
|
370
|
+
*****************************************************************************************************************************************/
|
|
371
|
+
private GET_Trans_BeginTrans;
|
|
372
|
+
private GET_Trans_CheckExecution;
|
|
373
|
+
private GET_Trans_EndTrans;
|
|
374
|
+
beginTransaction(executionKey: string, secondsTimeout?: number): Observable<string>;
|
|
375
|
+
checkTransaction(executionKey: string): Observable<number>;
|
|
376
|
+
endTransaction(transactionKey: string, transactionResult: boolean): Observable<string>;
|
|
377
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<HTTPService, [null, { optional: true; }, null, null, null, null, null, null, null, null]>;
|
|
378
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<HTTPService>;
|
|
379
|
+
}
|