ng-http-caching 19.0.1 → 21.0.1

package/{lib/ng-http-caching.service.d.ts → types/ng-http-caching.d.ts}

@@ -1,13 +1,56 @@
-import { InjectionToken } from '@angular/core';
-import { HttpRequest, HttpResponse, HttpEvent, HttpContextToken, HttpContext, HttpHeaders } from '@angular/common/http';
-import { Observable } from 'rxjs/internal/Observable';
-import { NgHttpCachingStorageInterface } from './storage/ng-http-caching-storage.interface';
-import * as i0 from "@angular/core";
-export type NgHttpCachingContext = Pick<NgHttpCachingConfig, 'getKey' | 'isCacheable' | 'isExpired' | 'isValid'>;
-export declare const NG_HTTP_CACHING_CONTEXT: HttpContextToken<NgHttpCachingContext>;
-export declare const withNgHttpCachingContext: (value: NgHttpCachingContext, context?: HttpContext) => HttpContext;
-export declare const checkCacheHeaders: (headers: HttpHeaders) => boolean;
-export interface NgHttpCachingEntry<K = any, T = any> {
+import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent, HttpResponse, HttpContextToken, HttpContext, HttpHeaders } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import * as i0 from '@angular/core';
+import { InjectionToken, ModuleWithProviders } from '@angular/core';
+import { Observable as Observable$1 } from 'rxjs/internal/Observable';
+
+declare class NgHttpCachingInterceptorService implements HttpInterceptor {
+    private readonly cacheService;
+    intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
+    /**
+     * Send http request (next handler)
+     */
+    sendRequest(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgHttpCachingInterceptorService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgHttpCachingInterceptorService>;
+}
+
+interface NgHttpCachingStorageInterface {
+    /**
+     * The number of cached entries.
+     */
+    readonly size: number;
+    /**
+     * Clear the cache.
+     */
+    clear(): void;
+    /**
+     * Delete the cache entry for the provided key.
+     */
+    delete(key: string): boolean;
+    /**
+     * The forEach() method executes a provided function once for each cache entry.
+     */
+    forEach<K = any, T = any>(callbackfn: (value: NgHttpCachingEntry<K, T>, key: string) => void): void;
+    /**
+     * Return the cache entry for the provided key.
+     */
+    get<K = any, T = any>(key: string): Readonly<NgHttpCachingEntry<K, T>> | undefined;
+    /**
+     * Return true if the cache entry exists the provided key.
+     */
+    has(key: string): boolean;
+    /**
+     * Set the cache entry for the provided key.
+     */
+    set<K = any, T = any>(key: string, value: NgHttpCachingEntry<K, T>): void;
+}
+
+type NgHttpCachingContext = Pick<NgHttpCachingConfig, 'getKey' | 'isCacheable' | 'isExpired' | 'isValid'>;
+declare const NG_HTTP_CACHING_CONTEXT: HttpContextToken<NgHttpCachingContext>;
+declare const withNgHttpCachingContext: (value: NgHttpCachingContext, context?: HttpContext) => HttpContext;
+declare const checkCacheHeaders: (headers: HttpHeaders) => boolean;
+interface NgHttpCachingEntry<K = any, T = any> {
     /**
      * URL
      */
@@ -29,45 +72,47 @@ export interface NgHttpCachingEntry<K = any, T = any> {
      */
     version: string;
 }
-export declare const NG_HTTP_CACHING_CONFIG: InjectionToken<NgHttpCachingContext>;
-export declare enum NgHttpCachingStrategy {
+declare const NG_HTTP_CACHING_CONFIG: InjectionToken<NgHttpCachingContext>;
+declare const NgHttpCachingStrategy: {
     /**
      * All request are cacheable if HTTP method is into `allowedMethod`
      */
-    ALLOW_ALL = "ALLOW_ALL",
+    ALLOW_ALL: string;
     /**
      * Only the request with `X-NG-HTTP-CACHING-ALLOW-CACHE` header are cacheable if HTTP method is into `allowedMethod`
      */
-    DISALLOW_ALL = "DISALLOW_ALL"
-}
-export declare enum NgHttpCachingHeaders {
+    DISALLOW_ALL: string;
+};
+type NgHttpCachingStrategy = typeof NgHttpCachingStrategy[keyof typeof NgHttpCachingStrategy];
+declare const NgHttpCachingHeaders: {
     /**
      * Request is cacheable if HTTP method is into `allowedMethod`
      */
-    ALLOW_CACHE = "X-NG-HTTP-CACHING-ALLOW-CACHE",
+    ALLOW_CACHE: string;
     /**
      * Request isn't cacheable
      */
-    DISALLOW_CACHE = "X-NG-HTTP-CACHING-DISALLOW-CACHE",
+    DISALLOW_CACHE: string;
     /**
      * Specific cache lifetime for the request
      */
-    LIFETIME = "X-NG-HTTP-CACHING-LIFETIME",
+    LIFETIME: string;
     /**
      * You can tag multiple request by adding this header with the same tag and
      * using `NgHttpCachingService.clearCacheByTag(tag: string)` for delete all the tagged request
      */
-    TAG = "X-NG-HTTP-CACHING-TAG"
-}
-export declare const NgHttpCachingHeadersList: NgHttpCachingHeaders[];
-export declare const NG_HTTP_CACHING_SECOND_IN_MS = 1000;
-export declare const NG_HTTP_CACHING_MINUTE_IN_MS: number;
-export declare const NG_HTTP_CACHING_HOUR_IN_MS: number;
-export declare const NG_HTTP_CACHING_DAY_IN_MS: number;
-export declare const NG_HTTP_CACHING_WEEK_IN_MS: number;
-export declare const NG_HTTP_CACHING_MONTH_IN_MS: number;
-export declare const NG_HTTP_CACHING_YEAR_IN_MS: number;
-export interface NgHttpCachingConfig {
+    TAG: string;
+};
+type NgHttpCachingHeaders = typeof NgHttpCachingHeaders[keyof typeof NgHttpCachingHeaders];
+declare const NgHttpCachingHeadersList: string[];
+declare const NG_HTTP_CACHING_SECOND_IN_MS = 1000;
+declare const NG_HTTP_CACHING_MINUTE_IN_MS: number;
+declare const NG_HTTP_CACHING_HOUR_IN_MS: number;
+declare const NG_HTTP_CACHING_DAY_IN_MS: number;
+declare const NG_HTTP_CACHING_WEEK_IN_MS: number;
+declare const NG_HTTP_CACHING_MONTH_IN_MS: number;
+declare const NG_HTTP_CACHING_YEAR_IN_MS: number;
+interface NgHttpCachingConfig {
     /**
      * Set the cache store. You can implement your custom store by implement the `NgHttpCachingStorageInterface` interface, eg.:
      */
@@ -122,7 +167,7 @@ export interface NgHttpCachingConfig {
      */
     isValid?: <K, T>(entry: NgHttpCachingEntry<K, T>) => boolean | undefined | void;
 }
-export interface NgHttpCachingDefaultConfig extends NgHttpCachingConfig {
+interface NgHttpCachingDefaultConfig extends NgHttpCachingConfig {
     store: NgHttpCachingStorageInterface;
     lifetime: number;
     allowedMethod: string[];
@@ -130,8 +175,8 @@ export interface NgHttpCachingDefaultConfig extends NgHttpCachingConfig {
     version: string;
     checkResponseHeaders: boolean;
 }
-export declare const NgHttpCachingConfigDefault: Readonly<NgHttpCachingDefaultConfig>;
-export declare class NgHttpCachingService {
+declare const NgHttpCachingConfigDefault: Readonly<NgHttpCachingDefaultConfig>;
+declare class NgHttpCachingService {
     private readonly queue;
     private readonly config;
     private gcLock;
@@ -144,7 +189,7 @@ export declare class NgHttpCachingService {
     /**
      * Return the queue map
      */
-    getQueue(): Readonly<Map<string, Observable<HttpEvent<any>>>>;
+    getQueue(): Readonly<Map<string, Observable$1<HttpEvent<any>>>>;
     /**
      * Return the cache store
      */
@@ -207,11 +252,11 @@ export declare class NgHttpCachingService {
     /**
      * Return observable from cache
      */
-    getFromQueue<K, T>(req: HttpRequest<K>): Observable<HttpEvent<T>> | undefined;
+    getFromQueue<K, T>(req: HttpRequest<K>): Observable$1<HttpEvent<T>> | undefined;
     /**
      * Add observable to cache
      */
-    addToQueue<K, T>(req: HttpRequest<K>, obs: Observable<HttpEvent<T>>): void;
+    addToQueue<K, T>(req: HttpRequest<K>, obs: Observable$1<HttpEvent<T>>): void;
     /**
      * Delete observable from cache
      */
@@ -225,3 +270,53 @@ export declare class NgHttpCachingService {
     static ɵfac: i0.ɵɵFactoryDeclaration<NgHttpCachingService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<NgHttpCachingService>;
 }
+
+declare class NgHttpCachingModule {
+    static forRoot(ngHttpCachingConfig?: NgHttpCachingConfig): ModuleWithProviders<NgHttpCachingModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgHttpCachingModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgHttpCachingModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgHttpCachingModule>;
+}
+
+declare function provideNgHttpCaching(ngHttpCachingConfig?: NgHttpCachingConfig): i0.EnvironmentProviders;
+
+declare class NgHttpCachingMemoryStorage extends Map<string, NgHttpCachingEntry<any, any>> implements NgHttpCachingStorageInterface {
+}
+
+interface NgHttpCachingStorageEntry {
+    url: string;
+    response: string;
+    request: string;
+    addedTime: number;
+    version: string;
+}
+declare const serializeRequest: (req: HttpRequest<any>) => string;
+declare const serializeResponse: (res: HttpResponse<any>) => string;
+declare const deserializeRequest: <T = any>(req: string) => HttpRequest<T>;
+declare const deserializeResponse: <T = any>(res: string) => HttpResponse<T>;
+declare class NgHttpCachingBrowserStorage implements NgHttpCachingStorageInterface {
+    private storage;
+    constructor(storage: Storage);
+    get size(): number;
+    clear(): void;
+    delete(key: string): boolean;
+    forEach(callbackfn: (value: NgHttpCachingEntry, key: string) => void): void;
+    get(key: string): Readonly<NgHttpCachingEntry> | undefined;
+    has(key: string): boolean;
+    set(key: string, value: NgHttpCachingEntry): void;
+    protected serialize(value: NgHttpCachingEntry): NgHttpCachingStorageEntry;
+    protected deserialize(value: NgHttpCachingStorageEntry): NgHttpCachingEntry;
+}
+
+declare class NgHttpCachingLocalStorage extends NgHttpCachingBrowserStorage {
+    constructor();
+}
+declare const withNgHttpCachingLocalStorage: () => NgHttpCachingLocalStorage;
+
+declare class NgHttpCachingSessionStorage extends NgHttpCachingBrowserStorage {
+    constructor();
+}
+declare const withNgHttpCachingSessionStorage: () => NgHttpCachingSessionStorage;
+
+export { NG_HTTP_CACHING_CONFIG, NG_HTTP_CACHING_CONTEXT, NG_HTTP_CACHING_DAY_IN_MS, NG_HTTP_CACHING_HOUR_IN_MS, NG_HTTP_CACHING_MINUTE_IN_MS, NG_HTTP_CACHING_MONTH_IN_MS, NG_HTTP_CACHING_SECOND_IN_MS, NG_HTTP_CACHING_WEEK_IN_MS, NG_HTTP_CACHING_YEAR_IN_MS, NgHttpCachingBrowserStorage, NgHttpCachingConfigDefault, NgHttpCachingHeaders, NgHttpCachingHeadersList, NgHttpCachingInterceptorService, NgHttpCachingLocalStorage, NgHttpCachingMemoryStorage, NgHttpCachingModule, NgHttpCachingService, NgHttpCachingSessionStorage, NgHttpCachingStrategy, checkCacheHeaders, deserializeRequest, deserializeResponse, provideNgHttpCaching, serializeRequest, serializeResponse, withNgHttpCachingContext, withNgHttpCachingLocalStorage, withNgHttpCachingSessionStorage };
+export type { NgHttpCachingConfig, NgHttpCachingContext, NgHttpCachingDefaultConfig, NgHttpCachingEntry, NgHttpCachingStorageEntry, NgHttpCachingStorageInterface };

package/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * Generated bundle index. Do not edit.
- */
-/// <amd-module name="ng-http-caching" />
-export * from './public-api';

package/lib/ng-http-caching-interceptor.service.d.ts

@@ -1,13 +0,0 @@
-import { HttpEvent, HttpHandler, HttpInterceptor, HttpRequest } from '@angular/common/http';
-import { Observable } from 'rxjs';
-import * as i0 from "@angular/core";
-export declare class NgHttpCachingInterceptorService implements HttpInterceptor {
-    private readonly cacheService;
-    intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
-    /**
-     * Send http request (next handler)
-     */
-    sendRequest(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgHttpCachingInterceptorService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NgHttpCachingInterceptorService>;
-}

package/lib/ng-http-caching-provider.d.ts

@@ -1,3 +0,0 @@
-import { EnvironmentProviders } from "@angular/core";
-import { NgHttpCachingConfig } from "./ng-http-caching.service";
-export declare function provideNgHttpCaching(ngHttpCachingConfig?: NgHttpCachingConfig): EnvironmentProviders[];

package/lib/ng-http-caching.module.d.ts

@@ -1,9 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { NgHttpCachingConfig } from './ng-http-caching.service';
-import * as i0 from "@angular/core";
-export declare class NgHttpCachingModule {
-    static forRoot(ngHttpCachingConfig?: NgHttpCachingConfig): ModuleWithProviders<NgHttpCachingModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgHttpCachingModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgHttpCachingModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgHttpCachingModule>;
-}

package/lib/storage/ng-http-caching-browser-storage.d.ts

@@ -1,27 +0,0 @@
-import { NgHttpCachingStorageInterface } from './ng-http-caching-storage.interface';
-import { NgHttpCachingEntry } from '../ng-http-caching.service';
-import { HttpRequest, HttpResponse } from '@angular/common/http';
-export interface NgHttpCachingStorageEntry {
-    url: string;
-    response: string;
-    request: string;
-    addedTime: number;
-    version: string;
-}
-export declare const serializeRequest: (req: HttpRequest<any>) => string;
-export declare const serializeResponse: (res: HttpResponse<any>) => string;
-export declare const deserializeRequest: <T = any>(req: string) => HttpRequest<T>;
-export declare const deserializeResponse: <T = any>(res: string) => HttpResponse<T>;
-export declare class NgHttpCachingBrowserStorage implements NgHttpCachingStorageInterface {
-    private storage;
-    constructor(storage: Storage);
-    get size(): number;
-    clear(): void;
-    delete(key: string): boolean;
-    forEach(callbackfn: (value: NgHttpCachingEntry, key: string) => void): void;
-    get(key: string): Readonly<NgHttpCachingEntry> | undefined;
-    has(key: string): boolean;
-    set(key: string, value: NgHttpCachingEntry): void;
-    protected serialize(value: NgHttpCachingEntry): NgHttpCachingStorageEntry;
-    protected deserialize(value: NgHttpCachingStorageEntry): NgHttpCachingEntry;
-}

package/lib/storage/ng-http-caching-local-storage.d.ts

@@ -1,5 +0,0 @@
-import { NgHttpCachingBrowserStorage } from './ng-http-caching-browser-storage';
-export declare class NgHttpCachingLocalStorage extends NgHttpCachingBrowserStorage {
-    constructor();
-}
-export declare const withNgHttpCachingLocalStorage: () => NgHttpCachingLocalStorage;

package/lib/storage/ng-http-caching-memory-storage.d.ts

@@ -1,4 +0,0 @@
-import { NgHttpCachingStorageInterface } from './ng-http-caching-storage.interface';
-import { NgHttpCachingEntry } from '../ng-http-caching.service';
-export declare class NgHttpCachingMemoryStorage extends Map<string, NgHttpCachingEntry<any, any>> implements NgHttpCachingStorageInterface {
-}

package/lib/storage/ng-http-caching-session-storage.d.ts

@@ -1,5 +0,0 @@
-import { NgHttpCachingBrowserStorage } from './ng-http-caching-browser-storage';
-export declare class NgHttpCachingSessionStorage extends NgHttpCachingBrowserStorage {
-    constructor();
-}
-export declare const withNgHttpCachingSessionStorage: () => NgHttpCachingSessionStorage;

package/lib/storage/ng-http-caching-storage.interface.d.ts

@@ -1,31 +0,0 @@
-import { NgHttpCachingEntry } from '../ng-http-caching.service';
-export interface NgHttpCachingStorageInterface {
-    /**
-     * The number of cached entries.
-     */
-    readonly size: number;
-    /**
-     * Clear the cache.
-     */
-    clear(): void;
-    /**
-     * Delete the cache entry for the provided key.
-     */
-    delete(key: string): boolean;
-    /**
-     * The forEach() method executes a provided function once for each cache entry.
-     */
-    forEach<K = any, T = any>(callbackfn: (value: NgHttpCachingEntry<K, T>, key: string) => void): void;
-    /**
-     * Return the cache entry for the provided key.
-     */
-    get<K = any, T = any>(key: string): Readonly<NgHttpCachingEntry<K, T>> | undefined;
-    /**
-     * Return true if the cache entry exists the provided key.
-     */
-    has(key: string): boolean;
-    /**
-     * Set the cache entry for the provided key.
-     */
-    set<K = any, T = any>(key: string, value: NgHttpCachingEntry<K, T>): void;
-}

package/public-api.d.ts

@@ -1,9 +0,0 @@
-export * from './lib/ng-http-caching-interceptor.service';
-export * from './lib/ng-http-caching.service';
-export * from './lib/ng-http-caching.module';
-export * from './lib/ng-http-caching-provider';
-export * from './lib/storage/ng-http-caching-storage.interface';
-export * from './lib/storage/ng-http-caching-memory-storage';
-export * from './lib/storage/ng-http-caching-local-storage';
-export * from './lib/storage/ng-http-caching-session-storage';
-export * from './lib/storage/ng-http-caching-browser-storage';