@esfaenza/httpservice 19.2.15 → 19.2.17

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.
@@ -0,0 +1,25 @@
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
+ }
@@ -0,0 +1,61 @@
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
+ }
@@ -0,0 +1,9 @@
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
+ }
@@ -0,0 +1,405 @@
1
+ import { HttpClient, HttpParams } from "@angular/common/http";
2
+ import { CacheService } from "@esfaenza/preferences";
3
+ import { BaseLocalization } from "@esfaenza/localizations";
4
+ import { Observable, Subject } from "rxjs";
5
+ import { HttpServiceExtensions } from './config/HttpServiceExtensions';
6
+ import { Download } from './models/Download';
7
+ import * as i0 from "@angular/core";
8
+ /**
9
+ * Servizio utilizzato per effettuare qualsiasi tipo di chiamata HTTP dall'applicazione, gestisce errori e cache delle risposte nativamente e ne può essere
10
+ * esteso/modificato il comportamento implementando la classe di "hook" **IHttpServiceExtensions** e registrandola nel provider della classe **HttpServiceExtensions**
11
+ */
12
+ export declare class HTTPService {
13
+ private EXTENSION_CLASS;
14
+ private HTTP_INVALIDATION;
15
+ private CLIENT_CACHE_DURATION_S;
16
+ private CACHE_BY_USER;
17
+ private HTTP_DEBUG_MODE;
18
+ private bc;
19
+ private http;
20
+ private localStorage;
21
+ /** Cache dello stato delle chiamate HTTP attualmente effettuate. Ogni chiamata è rappresentata da un GUID e lo status assume valore **false** solo sugli errori */
22
+ private callStatus;
23
+ /** Nome della cache in cui vengono storicizzate le informazioni sulle risposte delle chiamate sotto forma di dictionary */
24
+ private localStorageHttpCacheKey;
25
+ /** 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 */
26
+ private localStorageHttpTimedCacheKey;
27
+ /** Nome della cache in cui vengono storicizzate le informazioni sullo scadere della cache stessa */
28
+ private localStorageHttpCacheExpireKey;
29
+ /** Identità collegata al token di autenticazione da usare, richiesta al programma che utilizza la libreria attraverso l'hook **retrieveIdentity** della **HttpServiceExtensions** */
30
+ private me;
31
+ /** Indica che la cache a tempo dev'essere persistita il prima possibile */
32
+ private PersistTimedCacheASAP;
33
+ /** Indica che la cache senza limiti di tempo dev'essere persistita il prima possibile */
34
+ private PersistUntimedCacheASAP;
35
+ /** Subject emesso quando il servizio http si stabilizza, cioè quando non c'è nessuna chiamata pending o in corso da qualche istante */
36
+ Stabilized: Subject<true>;
37
+ /**
38
+ * Implementazione della classe di estensione per collegare i comportamenti della libreria all'applicazione in cui è usata.
39
+ *
40
+ * Se è stato effettuato il provide della classe **HttpServiceExtensions** verrà usato quel provider, altrimenti verrà creata una nuova istanza di default
41
+ */
42
+ private ExtensionsImpl;
43
+ /** Lista delle ultime 3 chiamate completate con successo in ordine di completamento (in posizione 0 c'è l'ultima completata eccetera...) */
44
+ LastThreeCompletedCalls: {
45
+ api: string;
46
+ requestJson: string;
47
+ responseJson: any;
48
+ }[];
49
+ private CacheInitialized;
50
+ /**
51
+ * @ignore
52
+ */
53
+ 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);
54
+ setAppConfig(myconfig: {
55
+ AppData: {
56
+ ModuleId: string;
57
+ ModuleDefId: number;
58
+ ComponentEnvironment: string;
59
+ ComponentVersion: string;
60
+ ModuleDescription: string;
61
+ };
62
+ }): void;
63
+ /**
64
+ * Se vedo che ci sono elementi salvati nel localStorage provo a toglierli e a risalvarli via preference.
65
+ * Nel caso migliore li sposto dal localStorage al DB di preference, nel caso peggiore li tolgo e li risalvo nel localStorage
66
+ */
67
+ private adjustOldStorageSystem;
68
+ getlocaleObservable(): Observable<string>;
69
+ /**
70
+ * Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
71
+ *
72
+ * @param {string} url URL su cui effettuare la chiamata
73
+ * @param {HttpParams} params Parametri della chiamata
74
+ * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
75
+ * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
76
+ * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
77
+ * @param {Function} errorCallback Callback chiamato in caso di errore
78
+ *
79
+ * @returns {Observable<T>} Observable che contiene il risultato della chiamata
80
+ */
81
+ get<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: Function): Observable<T>;
82
+ /**
83
+ * Esecuzione di una GET HTTP con eventualmente la gestione della cache qualora la chiamata termini con la convenzione "#cache"
84
+ *
85
+ * Caso specifico di chiamata che deve restituire un Blob o un ArrayBuffer nativo da elaborare
86
+ *
87
+ * @param {string} url URL su cui effettuare la chiamata
88
+ * @param {HttpParams} params Parametri della chiamata
89
+ * @param {"arraybuffer"| "blob"} type Tipo di ritorno richiesto
90
+ * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
91
+ * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
92
+ * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
93
+ * @param {Function} errorCallback Callback chiamato in caso di errore
94
+ *
95
+ * @returns {Observable<Blob | ArrayBuffer>} Observable che contiene il risultato della chiamata
96
+ */
97
+ getRaw(url: string, params?: HttpParams, type?: "arraybuffer" | "blob", transaction?: string, succesfulResultMandatory?: boolean, errorCallback?: any): Observable<Blob | ArrayBuffer>;
98
+ /**
99
+ * Esecuzione di una POST HTTP
100
+ *
101
+ * @param {string} url URL su cui effettuare la chiamata
102
+ * @param {any} bodyData DTO per la chiamata
103
+ * @param {HttpParams} params Parametri della chiamata
104
+ * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
105
+ * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
106
+ * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
107
+ *
108
+ * @returns {Observable<T>} Observable che contiene il risultato della chiamata
109
+ */
110
+ post<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
111
+ /**
112
+ * Esecuzione di una DELETE HTTP
113
+ *
114
+ * @param {string} url URL su cui effettuare la chiamata
115
+ * @param {HttpParams} params Parametri della chiamata
116
+ * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
117
+ * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
118
+ * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
119
+ *
120
+ * @returns {Observable<T>} Observable che contiene il risultato della chiamata
121
+ */
122
+ delete<T>(url: string, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
123
+ /**
124
+ * Esecuzione di una PUT HTTP
125
+ *
126
+ * @param {string} url URL su cui effettuare la chiamata
127
+ * @param {any} bodyData DTO per la chiamata
128
+ * @param {HttpParams} params Parametri della chiamata
129
+ * @param {string} transaction Codice transazione collegato a questa chiamata. Viene inserito nell'Header "X-TX-ID" e lato Backend dovrà essere gestito di conseguenza
130
+ * @param {boolean} succesfulResultMandatory Indica che questa chiamata deve assolutamente andare bene. In caso contrario viene fisicamente fatto il throw che può essere
131
+ * raccolto da chi usa la libreria nella pipe "onError" dell'Observable restituito ed essere gestito in maniera non standard
132
+ *
133
+ * @returns {Observable<T>} Observable che contiene il risultato della chiamata
134
+ */
135
+ put<T>(url: string, bodyData: any, params?: HttpParams, transaction?: string, succesfulResultMandatory?: boolean): Observable<T>;
136
+ /**
137
+ * Esecuzione di una POST HTTP
138
+ *
139
+ * Casistica particolare in cui bisogna anche inviare dei File
140
+ *
141
+ * @param {string} url URL su cui effettuare la chiamata
142
+ * @param {any} bodyData DTO per la chiamata
143
+ * @param {File[] | File} fileArrayOrFile Singolo file o lista di file da inviare. Il tipo **File** è quello nativo del Javascript
144
+ *
145
+ * @returns {Observable<T>} Observable che contiene il risultato della chiamata
146
+ */
147
+ postwithFiles<T>(url: string, bodyData: any, fileArrayOrFile: File[] | File, params?: HttpParams, succesfulResultMandatory?: boolean, onError?: () => void): Observable<T>;
148
+ /**
149
+ * Esecuzione di una POST HTTP
150
+ *
151
+ * Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
152
+ * La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
153
+ *
154
+ * @param {string} url URL su cui effettuare la chiamata
155
+ * @param {K} bodyData DTO per la chiamata
156
+ * @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
157
+ * @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
158
+ * @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
159
+ * @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
160
+ */
161
+ postGetFile<K>(url: string, bodyData: K, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean, pars?: HttpParams): Promise<void>;
162
+ /**
163
+ * Esecuzione di una GET HTTP
164
+ *
165
+ * Casistica particolare in cui viene restituito un file gestito come ObjectURL il cui URL si può gestire dal parametro di callback **getFileCallback**.
166
+ * La chiamata non ha un tipo restituito in quanto il risultato dev'essere gestito attraverso la callback **getFileCallback**
167
+ *
168
+ * @param {string} url URL su cui effettuare la chiamata
169
+ * @param {HttpParams} params Parametri della chiamata
170
+ * @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
171
+ * @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
172
+ * @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
173
+ * @param {boolean} handleError Indica se di default gli errori devono essere gestiti dalla libreria o se devono essere ignorati
174
+ */
175
+ getFile(url: string, params: HttpParams, filename: string, getFileCallback: (url: string, filename: string) => any, afterGetFile?: () => any, handleError?: boolean): Promise<void>;
176
+ /**
177
+ * Download nativo di un file. Internamente utilizza il pattern **window.location.href = "..."**
178
+ *
179
+ * @param {string} url URL su cui effettuare la chiamata
180
+ * @param {HttpParams} params Parametri della chiamata
181
+ */
182
+ getFileNative(url: string, params?: HttpParams): void;
183
+ /**
184
+ * Esecuzione di una GET di un file che emette i vari eventi di progresso di download.
185
+ * Utilizzarla per overridare la dialog nativa di progress del browser e sostituirla con qualcosa tipo quello che fa MEGA.
186
+ *
187
+ * In caso si voglia ottenere il risultato nativo del browser del download utilizzare **getFileNative(url, pars)**
188
+ *
189
+ * @param {string} url URL su cui effettuare la chiamata
190
+ * @param {HttpParams} params Parametri della chiamata
191
+ * @param {Function} getFileCallback Callback a due parametri (url: string, filename: string) per gestire il risultato del file richiesto. **Utilizzare UtilityService.fileDownload** di @esfaenza/extensions
192
+ *
193
+ * @returns {Observable<Download>} Observable dei vari step di progresso del download
194
+ */
195
+ getFileWithProgress(url: string, params: HttpParams, getFileCallback: (url: string, filename: string) => any): Observable<Download>;
196
+ /**
197
+ * 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
198
+ */
199
+ private isHttpResponse;
200
+ /**
201
+ * 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
202
+ */
203
+ private isHttpProgressEvent;
204
+ /**
205
+ * Gestione dell'inizio di una chiamata ad un certo URL, viene generato un GUID da assegnarci, controllata la scadenza della cache,
206
+ * e eventualmente loggato il fatto che sta per essere effettuata una chiamata HTTP
207
+ *
208
+ * @param {string} url Url a cui effettuare la chiamata
209
+ * @returns {string} GUID assegnato alla chiamata
210
+ */
211
+ private defaultStartCall;
212
+ /**
213
+ * Dato un url vengono controllate le informazioni su tutti gli url da invalidare collegati all'url chiamato e, se presenti in cache, invalidati
214
+ *
215
+ * @param {string} url URL per cui controllare se ci sono chiamate in cache da invalidare
216
+ */
217
+ private checkCacheInvalidation;
218
+ /**
219
+ * Finalizzazione di una chiamata
220
+ *
221
+ * @param {string} guid GUID collegato alla chiamata appena terminata
222
+ * @param {boolean} persistCacheIfIdle Effettua il persist della cache HTTP solo se non ci sono altre chiamate in corso, per evitare
223
+ * che mi cambi sotto l'oggetto di cache mentre sto salvando le informazioni
224
+ */
225
+ private tryFinalizeByGuid;
226
+ /**
227
+ * Helper che dato un unico File o una lista di File crea un oggetto FormData che può essere inviato comodamente
228
+ * ad un backend ASP.NET da cui si potrà accedere a Request.Form.Files
229
+ *
230
+ * @param {File | File[]} fileArrayOrFile Singolo File o lista di File. N.B: nella firma della funzione viene considerato **any** per fare test sulle proprietà
231
+ * invece che fare test con l'**istanceof**
232
+ *
233
+ * @returns {FormData} FormData contenente tutti i file passati
234
+ */
235
+ private getFilesFormData;
236
+ /**
237
+ * Helper che in base ai parametri disponibili genera gli Header HTTP per la chiamata da effettuare
238
+ *
239
+ * @param {string} contentType Indica se aggiungere agli header "Content-Type", valorizzato al valore del parametro
240
+ * @param {string} accept Indica se aggiungere agli header "Accept", valorizzato al valore del parametro
241
+ * @param {boolean} includeAuth Indica se aggiungere agli header "Authorization", valorizzato col token recuperato dall'hook **retrieveAccessToken** della classe di estensione
242
+ * @param {string} transactionId Indica se aggiungere agli header "X-TX-ID", valorizzato al valore del parametro
243
+ *
244
+ * @returns {HttpHeaders} Header generati in base ai parametri
245
+ */
246
+ private getHeaders;
247
+ /**
248
+ * Gestione di default degli errori
249
+ *
250
+ * @param {any} res Risultato della chiamata effettuata
251
+ * @param {string} guid Identificativo GUID della chiamata effettuata
252
+ */
253
+ private onError;
254
+ /**
255
+ * Dato un errore restituisce una promise con la stringa finale dell'errore in modo da poter fare un await
256
+ *
257
+ * @param {any} err Errore da controllare
258
+ *
259
+ * @returns {Promise<string>} Promise che risolve con la stringa finale dell'errore
260
+ */
261
+ private getHttpErrorText;
262
+ /**
263
+ * Riconosce se l'oggetto è di tipo **CallResult** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
264
+ *
265
+ * @param {any} err Errore da controllare
266
+ */
267
+ private isCallResult;
268
+ /**
269
+ * Riconosce se l'errore è di tipo **HttpErrorResponse** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
270
+ *
271
+ * @param {any} err Errore da controllare
272
+ */
273
+ private isHttpErrorResponse;
274
+ /**
275
+ * Riconosce se l'errore è di tipo **TypeError** e, se sì, lo casta al tipo corretto per essere utilizzato correttamente nel blocco di codice successivo
276
+ *
277
+ * @param {any} err Errore da controllare
278
+ */
279
+ private isTypeError;
280
+ /**
281
+ * Come dice il nome, registra un errore e restituisce un Observable vuoto come risultato della chiamata
282
+ *
283
+ * @param {any} res Risultato della chiamata effettuata
284
+ * @param {string} guid Identificativo GUID della chiamata effettuata
285
+ * @param {boolean} handleError Indica se gestire l'errore via libreria o se limitarsi a restituire l'Observable vuoto
286
+ *
287
+ * @returns {Observable<any>} Observable vuoto
288
+ */
289
+ private registerErrorAndReturnEmptyObservable;
290
+ /**
291
+ * Dato un Url e dei parametri cerca di recuperare l'eventuale oggetto già salvato in cache con le informazioni base della cache stessa
292
+ *
293
+ * @param {string} url URL su cui effettuare la chiamata
294
+ * @param {HttpParams} params Parametri della chiamata (nulli in caso di POST)
295
+ *
296
+ * @returns {CacheInfos} Oggetto contenente le informazioni sulla cache per l'oggetto specificato
297
+ */
298
+ private tryGetCacheInformations;
299
+ /**
300
+ * Inserisce un oggetto nella cache appropriata in base alle informazioni contenute nel parametro **cacheInfos**
301
+ *
302
+ * @param {T} item Oggetto da inserire nella cache
303
+ * @param {CacheInfos} cacheInfos Informazioni sulla cache recuperate da una chiamata precedente a **tryGetCacheInformations**
304
+ */
305
+ private cacheResponse;
306
+ /**
307
+ * Controlla se la cache per le chiamate senza expire time è scaduta
308
+ *
309
+ * @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
310
+ */
311
+ private untimedCacheExpired;
312
+ /**
313
+ * Controlla se la cache per una chiamata che ha un tempo di vita ben definito è scaduta o meno
314
+ *
315
+ * @param {any} item Oggetto recuperato dalla cache a cui ho aggiunto la chiave interna __expire
316
+ *
317
+ * @returns {boolean} **true** se la cache è scaduta e dev'essere ripulita, **false** altrimenti
318
+ */
319
+ private timedCacheItemExpired;
320
+ /**
321
+ * 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**)
322
+ */
323
+ resetHttpUntimedCacheStorage(): Promise<void>;
324
+ /**
325
+ * Ripulisce la cache delle chiamate con un tempo di expire definito
326
+ */
327
+ resetHttpTimedCacheStorage(): Promise<void>;
328
+ /**
329
+ * Genera una chiave per la cache delle chiamate in base ad URL e Parametri HTTP
330
+ *
331
+ * @param {string} url URL su cui effettuare la chiamata
332
+ * @param {HttpParams} params Parametri della chiamata
333
+ *
334
+ * @returns {string} Chiave che rappresenta in maniera univoca la chiamata
335
+ */
336
+ private makeCacheKey;
337
+ /**
338
+ * Generazione GUID
339
+ *
340
+ * @returns {string} Nuovo GUID generato in maniera casuale
341
+ */
342
+ private getGUID;
343
+ /**
344
+ * Metodo per scrivere log a console qualora **DEBUG_MODE** risultasse **true**
345
+ *
346
+ * @param {string} message Messaggio di log
347
+ */
348
+ private log;
349
+ /**
350
+ * Helper per la localizzazione dei messaggi
351
+ *
352
+ * @param {string} message Messaggio da localizzare
353
+ *
354
+ * @returns {string} Messaggio localizzato
355
+ */
356
+ private loc;
357
+ /**
358
+ * 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)
359
+ */
360
+ getAll<T>(view: {
361
+ items: T[];
362
+ page: number;
363
+ itemsperpageoverride: number;
364
+ selection: {
365
+ exclusions: T[];
366
+ all: boolean;
367
+ items: T[];
368
+ };
369
+ }, api: string, pars?: HttpParams, transaction?: string): Observable<T[]>;
370
+ private hashObject;
371
+ /*****************************************************************************************************************************************
372
+ ***************************************************** TRANSACTION HELPERS ***************************************************************
373
+ *****************************************************************************************************************************************/
374
+ private GET_Trans_BeginTrans;
375
+ private GET_Trans_CheckExecution;
376
+ private GET_Trans_EndTrans;
377
+ beginTransaction(executionKey: string, secondsTimeout?: number): Observable<string>;
378
+ checkTransaction(executionKey: string): Observable<number>;
379
+ endTransaction(transactionKey: string, transactionResult: boolean): Observable<string>;
380
+ /*****************************************************************************************************************************************
381
+ ***************************************************** ROBA PER HASHING ******************************************************************
382
+ *****************************************************************************************************************************************/
383
+ /**
384
+ * Blacklist dei tipi da ignorare quando si effettua l'hashing degli oggetti
385
+ */
386
+ private objBlacklist;
387
+ /**
388
+ * Hash più semplice e più veloce dell'md5, ma meno sicuro
389
+ *
390
+ * Vedi https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript
391
+ *
392
+ * @param {string} str Stringa di cui calcolare l'hash
393
+ */
394
+ private simpleHash;
395
+ /**
396
+ * Genera una stringa che identifica univocamente l'oggetto in questione
397
+ *
398
+ * @param {any} o Oggetto di cui calcolare la stringa univoca
399
+ * @param {number} level Livello di ricorsione nel caso venga effettuato l'hash di un oggetto che contiene altri oggetti
400
+ * @param {boolean} navigateFullDepth Indica se navigare l'oggetto per l'intera lunghezza. In caso contrario si ferma al secondo livello
401
+ */
402
+ private stringify;
403
+ static ɵfac: i0.ɵɵFactoryDeclaration<HTTPService, [null, { optional: true; }, { optional: true; }, { optional: true; }, { optional: true; }, { optional: true; }, null, { optional: true; }]>;
404
+ static ɵprov: i0.ɵɵInjectableDeclaration<HTTPService>;
405
+ }
@@ -0,0 +1,8 @@
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
+ }
@@ -0,0 +1,5 @@
1
+ export declare class Download {
2
+ state: 'PENDING' | 'IN_PROGRESS' | 'DONE';
3
+ progress: number;
4
+ content: Blob | null;
5
+ }
@@ -0,0 +1,21 @@
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/package.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "name": "@esfaenza/httpservice",
3
- "version": "19.2.15",
3
+ "version": "19.2.17",
4
4
  "dependencies": {
5
5
  "tslib": "^2.3.0"
6
6
  },
7
7
  "peerDependencies": {
8
- "@angular/common": "^19.2.14",
9
- "@angular/core": "^19.2.14",
10
- "@esfaenza/localizations": "^19.2.0",
11
- "@esfaenza/preferences": "^19.2.10"
8
+ "@angular/common": "^19.2.15",
9
+ "@angular/core": "^19.2.15",
10
+ "@esfaenza/localizations": "^19.2.15",
11
+ "@esfaenza/preferences": "^19.2.11"
12
12
  },
13
13
  "module": "fesm2022/esfaenza-httpservice.mjs",
14
14
  "typings": "index.d.ts",
@@ -0,0 +1,7 @@
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';