@von-development-studio/angular-rest-service 19.2.0 → 20.3.0

package/index.d.ts

@@ -1,5 +1,149 @@
+import { HttpHeaders, HttpParams, HttpInterceptor, HttpRequest, HttpHandler, HttpEvent, HttpErrorResponse, HttpClient } from '@angular/common/http';
+import { Router } from '@angular/router';
+import { Observable } from 'rxjs';
+import { DomSanitizer, SafeResourceUrl } from '@angular/platform-browser';
+
+interface VonErrorRestInterceptorModel {
+    status: number;
+    message: string;
+    body?: any;
+}
+
+type HeaderParams = {
+    contentType?: string;
+    accept?: string;
+    responseType?: 'json';
+};
+
+interface VonHttpOptionsModel {
+    headers?: HttpHeaders | {
+        [header: string]: string | string[];
+    };
+    observe?: 'body';
+    params?: HttpParams | {
+        [param: string]: string | string[];
+    };
+    reportProgress?: boolean;
+    responseType?: 'json';
+    withCredentials?: boolean;
+}
+
 /**
- * Generated bundle index. Do not edit.
+ * @deprecated Define this model in the solution
  */
-/// <amd-module name="@von-development-studio/angular-rest-service" />
-export * from './public-api';
+interface VonPageResponseModel<T> {
+    content: T[];
+    last: boolean;
+    totalPages: number;
+    totalElements: number;
+    size: number;
+    numberOfElements: number;
+    number: number;
+}
+
+interface GenericParams {
+    [key: string]: any;
+}
+interface BaseParams {
+    url: string;
+    urlParams?: GenericParams;
+    queryParams?: GenericParams;
+    headerParams?: HeaderParams;
+    /**
+     * @deprecated Use headerParams instead
+     */
+    header?: HeaderParams;
+    /**
+     * @deprecated Use queryParams instead
+     */
+    params?: GenericParams;
+}
+type BodyParams<B = GenericParams | FormData> = BaseParams & {
+    body?: B;
+};
+
+declare abstract class VonRestInterceptorService implements HttpInterceptor {
+    protected router: Router;
+    protected consoleDebug: boolean;
+    protected errorResponseUnknown: string;
+    protected errorResponseForbidden: string;
+    constructor(router: Router);
+    intercept(request: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
+    protected mapEvent: (event: HttpEvent<any>) => HttpEvent<any>;
+    protected catchError: (errorResponse: HttpErrorResponse) => Observable<never>;
+    /**
+     * Execute custom implementation before any other pipe from the subscription.
+     */
+    protected executeBeforePipesOnSuccess: () => void;
+    /**
+     * Execute custom implementation before any other pipe from the subscription.
+     */
+    protected executeBeforePipesOnError: () => void;
+    /**
+     * Execute custom implementation to redirect to 403 page based on a specific condition.
+     */
+    protected execute403Redirect: () => void;
+    /**
+     * @deprecated Use the new custom method execute403Redirect() to trigger redirect to 403. This property is marked to be removed.
+     * TODO: Remove this property
+     */
+    protected urlWhoAmI: string;
+    /**
+     * @deprecated Use the new custom method execute403Redirect() to trigger redirect to 403. This property is marked to be removed.
+     * TODO: Remove this property
+     */
+    protected redirectOn403: boolean;
+    /**
+     * @deprecated Use the new custom method execute403Redirect() to trigger redirect to 403. This property is marked to be removed.
+     * TODO: Remove this property
+     */
+    protected redirect403Url: string[];
+    /**
+     * @deprecated Use either executeBeforePipesOnSuccess() or executeBeforePipesOnError() base on your case. This method is marked to be removed.
+     */
+    protected postHttpRequest: () => void;
+}
+
+/**
+ * Rest service wrapper for API calls. This class needs to be extended in a `@Injectable({ providedIn: 'root' })` service.
+ * Parameters needed:
+ * @HttpClient
+ * @DomSanitizer
+ */
+declare abstract class VonRestService {
+    protected http: HttpClient;
+    protected sanitizer: DomSanitizer;
+    constructor(http: HttpClient, sanitizer: DomSanitizer);
+    /**
+     * Allows to set the default headers
+     * @param headerParams Check HeaderParams interface to verify allowed overrides
+     * @returns
+     * ```json
+     * {
+     *   "Content-Type": "application/json",
+     *   "Accept": "application/json",
+     *   "Access-Control-Allow-Origin": "*"
+     * }
+     * ```
+     */
+    protected setHeaders: (headerParams?: HeaderParams) => HttpHeaders;
+    protected setOptions: ({ headerParams, queryParams: params, }?: {
+        headerParams?: HeaderParams;
+        queryParams?: GenericParams;
+    }) => VonHttpOptionsModel;
+    protected setOptionsForFile: ({ headerParams, queryParams, }?: {
+        headerParams?: HeaderParams;
+        queryParams?: GenericParams;
+    }) => VonHttpOptionsModel;
+    protected setUrlParams: (url: string, params?: GenericParams) => string;
+    protected authenticate: (url: string, username: string, password: string) => Observable<any>;
+    protected get: <R = any>({ url, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BaseParams) => Observable<R>;
+    protected delete: <R = any>({ url, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BaseParams) => Observable<R>;
+    protected post: <R = any, B = GenericParams | FormData>({ url, body, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BodyParams<B>) => Observable<R>;
+    protected put: <R = any, B = GenericParams | FormData>({ url, body, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BodyParams<B>) => Observable<R>;
+    protected patch: <R = any, B = GenericParams | FormData>({ url, body, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BodyParams<B>) => Observable<R>;
+    protected file: ({ url, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BaseParams) => Observable<SafeResourceUrl>;
+}
+
+export { VonRestInterceptorService, VonRestService };
+export type { BaseParams, BodyParams, GenericParams, HeaderParams, VonErrorRestInterceptorModel, VonHttpOptionsModel, VonPageResponseModel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@von-development-studio/angular-rest-service",
-  "version": "19.2.0",
+  "version": "20.3.0",
   "description": "Angular Rest Service wrapper.",
   "repository": {
     "type": "git",
@@ -8,14 +8,14 @@
   },
   "keywords": [
     "angular",
-    "angular 19",
+    "angular 20",
     "rest client"
   ],
   "author": "Luis García Castro",
   "license": "MIT",
   "peerDependencies": {
-    "@angular/common": "^19.2.0",
-    "@angular/core": "^19.2.0"
+    "@angular/common": "^20.3.0",
+    "@angular/core": "^20.3.0"
   },
   "dependencies": {
     "tslib": "^2.4.0"

package/lib/models/von-error-rest-interceptor.model.d.ts

@@ -1,5 +0,0 @@
-export interface VonErrorRestInterceptorModel {
-    status: number;
-    message: string;
-    body?: any;
-}

package/lib/models/von-header-params.model.d.ts

@@ -1,5 +0,0 @@
-export type HeaderParams = {
-    contentType?: string;
-    accept?: string;
-    responseType?: 'json';
-};

package/lib/models/von-http-options.model.d.ts

@@ -1,13 +0,0 @@
-import { HttpHeaders, HttpParams } from '@angular/common/http';
-export interface VonHttpOptionsModel {
-    headers?: HttpHeaders | {
-        [header: string]: string | string[];
-    };
-    observe?: 'body';
-    params?: HttpParams | {
-        [param: string]: string | string[];
-    };
-    reportProgress?: boolean;
-    responseType?: 'json';
-    withCredentials?: boolean;
-}

package/lib/models/von-page-response.model.d.ts

@@ -1,12 +0,0 @@
-/**
- * @deprecated Define this model in the solution
- */
-export interface VonPageResponseModel<T> {
-    content: T[];
-    last: boolean;
-    totalPages: number;
-    totalElements: number;
-    size: number;
-    numberOfElements: number;
-    number: number;
-}

package/lib/models/von-rest-definition.model.d.ts

@@ -1,21 +0,0 @@
-import { HeaderParams } from './von-header-params.model';
-export interface GenericParams {
-    [key: string]: any;
-}
-export interface BaseParams {
-    url: string;
-    urlParams?: GenericParams;
-    queryParams?: GenericParams;
-    headerParams?: HeaderParams;
-    /**
-     * @deprecated Use headerParams instead
-     */
-    header?: HeaderParams;
-    /**
-     * @deprecated Use queryParams instead
-     */
-    params?: GenericParams;
-}
-export type BodyParams<B = GenericParams | FormData> = BaseParams & {
-    body?: B;
-};

package/lib/von-rest-interceptor.service.d.ts

@@ -1,44 +0,0 @@
-import { HttpErrorResponse, HttpEvent, HttpHandler, HttpInterceptor, HttpRequest } from '@angular/common/http';
-import { Router } from '@angular/router';
-import { Observable } from 'rxjs';
-export declare abstract class VonRestInterceptorService implements HttpInterceptor {
-    protected router: Router;
-    protected consoleDebug: boolean;
-    protected errorResponseUnknown: string;
-    protected errorResponseForbidden: string;
-    constructor(router: Router);
-    intercept(request: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>>;
-    protected mapEvent: (event: HttpEvent<any>) => HttpEvent<any>;
-    protected catchError: (errorResponse: HttpErrorResponse) => Observable<never>;
-    /**
-     * Execute custom implementation before any other pipe from the subscription.
-     */
-    protected executeBeforePipesOnSuccess: () => void;
-    /**
-     * Execute custom implementation before any other pipe from the subscription.
-     */
-    protected executeBeforePipesOnError: () => void;
-    /**
-     * Execute custom implementation to redirect to 403 page based on a specific condition.
-     */
-    protected execute403Redirect: () => void;
-    /**
-     * @deprecated Use the new custom method execute403Redirect() to trigger redirect to 403. This property is marked to be removed.
-     * TODO: Remove this property
-     */
-    protected urlWhoAmI: string;
-    /**
-     * @deprecated Use the new custom method execute403Redirect() to trigger redirect to 403. This property is marked to be removed.
-     * TODO: Remove this property
-     */
-    protected redirectOn403: boolean;
-    /**
-     * @deprecated Use the new custom method execute403Redirect() to trigger redirect to 403. This property is marked to be removed.
-     * TODO: Remove this property
-     */
-    protected redirect403Url: string[];
-    /**
-     * @deprecated Use either executeBeforePipesOnSuccess() or executeBeforePipesOnError() base on your case. This method is marked to be removed.
-     */
-    protected postHttpRequest: () => void;
-}

package/lib/von-rest.service.d.ts

@@ -1,46 +0,0 @@
-import { HttpClient, HttpHeaders } from '@angular/common/http';
-import { DomSanitizer, SafeResourceUrl } from '@angular/platform-browser';
-import { Observable } from 'rxjs';
-import { HeaderParams } from './models/von-header-params.model';
-import { VonHttpOptionsModel } from './models/von-http-options.model';
-import { BaseParams, BodyParams, GenericParams } from './models/von-rest-definition.model';
-/**
- * Rest service wrapper for API calls. This class needs to be extended in a `@Injectable({ providedIn: 'root' })` service.
- * Parameters needed:
- * @HttpClient
- * @DomSanitizer
- */
-export declare abstract class VonRestService {
-    protected http: HttpClient;
-    protected sanitizer: DomSanitizer;
-    constructor(http: HttpClient, sanitizer: DomSanitizer);
-    /**
-     * Allows to set the default headers
-     * @param headerParams Check HeaderParams interface to verify allowed overrides
-     * @returns
-     * ```json
-     * {
-     *   "Content-Type": "application/json",
-     *   "Accept": "application/json",
-     *   "Access-Control-Allow-Origin": "*"
-     * }
-     * ```
-     */
-    protected setHeaders: (headerParams?: HeaderParams) => HttpHeaders;
-    protected setOptions: ({ headerParams, queryParams: params, }?: {
-        headerParams?: HeaderParams;
-        queryParams?: GenericParams;
-    }) => VonHttpOptionsModel;
-    protected setOptionsForFile: ({ headerParams, queryParams, }?: {
-        headerParams?: HeaderParams;
-        queryParams?: GenericParams;
-    }) => VonHttpOptionsModel;
-    protected setUrlParams: (url: string, params?: GenericParams) => string;
-    protected authenticate: (url: string, username: string, password: string) => Observable<any>;
-    protected get: <R = any>({ url, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BaseParams) => Observable<R>;
-    protected delete: <R = any>({ url, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BaseParams) => Observable<R>;
-    protected post: <R = any, B = GenericParams | FormData>({ url, body, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BodyParams<B>) => Observable<R>;
-    protected put: <R = any, B = GenericParams | FormData>({ url, body, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BodyParams<B>) => Observable<R>;
-    protected patch: <R = any, B = GenericParams | FormData>({ url, body, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BodyParams<B>) => Observable<R>;
-    protected file: ({ url, urlParams, queryParams: params, headerParams, header: oldHeaderParams, params: oldParams, }: BaseParams) => Observable<SafeResourceUrl>;
-}

package/public-api.d.ts

@@ -1,7 +0,0 @@
-export * from './lib/models/von-error-rest-interceptor.model';
-export * from './lib/models/von-header-params.model';
-export * from './lib/models/von-http-options.model';
-export * from './lib/models/von-page-response.model';
-export * from './lib/models/von-rest-definition.model';
-export * from './lib/von-rest-interceptor.service';
-export * from './lib/von-rest.service';