angular-toolbox 1.3.3 → 1.4.1

package/lib/framework/index.d.ts

@@ -1,3 +1,4 @@
 export * from './mock/http';
 export * from './mock/http-monitoring-console';
+export * from './mock/documentation';
 export * from './logging';

package/lib/framework/mock/documentation/component/atx-mock-description/atx-mock-description.component.d.ts

@@ -0,0 +1,14 @@
+import * as i0 from "@angular/core";
+/**
+ * @private
+ * A conmponent that renders mock config description ppoperties.
+ */
+export declare class AtxMockDescriptionComponent {
+    /**
+     * @private
+     * The description to render. Can contains HTML tags.
+     */
+    description: string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AtxMockDescriptionComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AtxMockDescriptionComponent, "atx-mock-description", never, { "description": { "alias": "description"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/framework/mock/documentation/component/atx-mock-documentation/atx-mock-documentation.component.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { ElementRef } from '@angular/core';
+import { HttpMockConfig } from '../../../../../model';
+import * as i0 from "@angular/core";
+/**
+ * An easy-to-use component that displays the documentation of a `HttpMockConfig` object.
+ */
+export declare class AtxMockDocumentation {
+    private elmRef;
+    /**
+     * @private
+     */
+    protected configApi: HttpMockConfig;
+    /**
+     * @private
+     */
+    protected expanded: boolean;
+    /**
+     * Specifies the title of the current display.
+     */
+    title: string;
+    /**
+     * Gets or sets the `HttpMockConfig` object for which to display documentation.
+     */
+    set config(value: HttpMockConfig);
+    get config(): HttpMockConfig;
+    /**
+     * @private
+     */
+    constructor(elmRef: ElementRef);
+    /**
+     * @private
+     */
+    protected toggleExpandState(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AtxMockDocumentation, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AtxMockDocumentation, "atx-mock-documentation", never, { "title": { "alias": "title"; "required": false; }; "config": { "alias": "config"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/framework/mock/documentation/component/atx-mock-full-description/atx-mock-full-description.component.d.ts

@@ -0,0 +1,15 @@
+import { FullDescription } from '../../model/business/full-description.type';
+import * as i0 from "@angular/core";
+/**
+ * @private
+ * A convenient component that displays the description and the origin of a mock config section.
+ */
+export declare class AtxMockFullDescriptionComponent {
+    /**
+     * @public
+     * The config object taht contains the description to display.
+     */
+    config: FullDescription;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AtxMockFullDescriptionComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AtxMockFullDescriptionComponent, "atx-mock-full-description", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/framework/mock/documentation/component/atx-mock-methods/atx-mock-methods.component.d.ts

@@ -0,0 +1,29 @@
+import { HttpMockEndpoint } from '../../../../../model';
+import { MethodDocDescriptor } from '../../model/business/method-doc-descriptor.type';
+import * as i0 from "@angular/core";
+/**
+ * @private
+ * A convenient component that allows to display documentation for HTTP methods of an endpoint.
+ */
+export declare class AtxMockMethodsComponent {
+    /**
+     * @private
+     */
+    protected methods: MethodDocDescriptor[];
+    /**
+     * @private
+     */
+    private _endpoint;
+    /**
+     * @private
+     * The endpoint for which to show HTTP methods documentation.
+     */
+    set endpoint(value: HttpMockEndpoint);
+    get endpoint(): HttpMockEndpoint;
+    /**
+     * @private
+     */
+    protected initMethodList(endpoint: HttpMockEndpoint): MethodDocDescriptor[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<AtxMockMethodsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AtxMockMethodsComponent, "atx-mock-methods", never, { "endpoint": { "alias": "endpoint"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/framework/mock/documentation/component/atx-mock-param/atx-mock-param.component.d.ts

@@ -0,0 +1,15 @@
+import { HttpParameterDescriptor } from '../../../../../model';
+import * as i0 from "@angular/core";
+/**
+ * @private
+ * Displays documentation for HTTP fragment parameters, or query parameters.
+ */
+export declare class AtxMockParamComponent {
+    /**
+     * @private
+     * The list of `HttpParameterDescriptor` object that contains information to display.
+     */
+    params: HttpParameterDescriptor[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<AtxMockParamComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AtxMockParamComponent, "atx-mock-param", never, { "params": { "alias": "params"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/framework/mock/documentation/index.d.ts

@@ -0,0 +1 @@
+export * from './component/atx-mock-documentation/atx-mock-documentation.component';

package/lib/framework/mock/documentation/model/business/full-description.type.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * @private
+ * Used internally to manage the full description of a mock config object.
+ */
+export type FullDescription = {
+    /**
+     * @private
+     */
+    description?: string;
+    /**
+     * @private
+     */
+    origin?: string;
+};

package/lib/framework/mock/documentation/model/business/method-doc-descriptor.type.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { HttpMockMethodDescriptor } from '../../../../../model';
+/**
+ * @private
+ * Used internally to manage the display of HTTP method descriptor objects.
+ */
+export type MethodDocDescriptor = {
+    /**
+     * @private
+     */
+    method: string;
+    /**
+     * @private
+     */
+    descriptor: HttpMockMethodDescriptor | undefined;
+};

package/lib/framework/mock/http/util/http-mock-response.builder.d.ts

@@ -46,14 +46,6 @@ export declare class HttpResponseMockBuilder {
      * @returns A reference to this `HttpResponseMockBuilder` instance.
      */
     status(status: number): HttpResponseMockBuilder;
-    /**
-     * Sets the `statusText` property of the new `HttpResponseMock` instance with the specified `statusText` value.
-     *
-     * @param statusText The value used to set the `statusText` property of the new `HttpResponseMock` instance.
-     *
-     * @returns A reference to this `HttpResponseMockBuilder` instance.
-     */
-    statusText(statusText: string): HttpResponseMockBuilder;
     /**
      * Sets the `url` property of the new `HttpResponseMock` instance with the specified `url` value.
      *

package/lib/framework/mock/http/util/http-status-text-finder.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { HttpStatusCode } from "@angular/common/http";
+import { HttpStatusText } from "./http-status-text.enum";
+/**
+ * @private
+ * A utility class that helps to retreive a status text depending on its status code.
+ */
+export declare class HttpStatusTextFinder {
+    /**
+     * @private
+     * Retreives and return a status text depending on its status code.
+     *
+     * @param code The status code for which to find the status text.
+     * @returns A `HttpStatusText` constant.
+     */
+    static getStatusText(code: HttpStatusCode): HttpStatusText;
+}

package/lib/framework/mock/http/util/http-status-text.enum.d.ts

@@ -0,0 +1,252 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * The list of all HTTP status text.
+ */
+export declare enum HttpStatusText {
+    /**
+     * The status text associated with the status code `100`.
+     */
+    CONTINUE = "Continue",
+    /**
+     * The status text associated with the status code `101`.
+     */
+    SWITCHING_PROTOCOLS = "Switching Protocols",
+    /**
+     * The status text associated with the status code `102`.
+     */
+    PROCESSING = "Processing",
+    /**
+     * The status text associated with the status code `103`.
+     */
+    EARLY_HINTS = "Early Hints",
+    /**
+     * The status text associated with the status code `200`.
+     */
+    OK = "OK",
+    /**
+     * The status text associated with the status code `201`.
+     */
+    CREATED = "Created",
+    /**
+     * The status text associated with the status code `202`.
+     */
+    ACCEPTED = "Accepted",
+    /**
+     * The status text associated with the status code `203`.
+     */
+    NON_AUTHORITATIVE_INFORMATION = "Non-authoritative Information",
+    /**
+     * The status text associated with the status code `204`.
+     */
+    NO_CONTENT = "No Content",
+    /**
+     * The status text associated with the status code `205`.
+     */
+    RESET_CONTENT = "Reset Content",
+    /**
+     * The status text associated with the status code `206`.
+     */
+    PARTIAL_CONTENT = "Partial Content",
+    /**
+     * The status text associated with the status code `207`.
+     */
+    MULTI_STATUS = "Multi-Status",
+    /**
+     * The status text associated with the status code `208`.
+     */
+    ALREADY_REPORTED = "Already Reported",
+    /**
+     * The status text associated with the status code `226`.
+     */
+    IM_USED = "IM Used",
+    /**
+     * The status text associated with the status code `300`.
+     */
+    MULTIPLE_CHOICES = "Multiple Choices",
+    /**
+     * The status text associated with the status code `301`.
+     */
+    MOVED_PERMANENTLY = "Moved Permanently",
+    /**
+     * The status text associated with the status code `302`.
+     */
+    FOUND = "Found",
+    /**
+     * The status text associated with the status code `303`.
+     */
+    SEE_OTHER = "See Other",
+    /**
+     * The status text associated with the status code `304`.
+     */
+    NOT_MODIFIED = "Not Modified",
+    /**
+     * The status text associated with the status code `307`.
+     */
+    TEMPORARY_REDIRECT = "Temporary Redirect",
+    /**
+     * The status text associated with the status code `308`.
+     */
+    PERMANENT_REDIRECT = "Permanent Redirect",
+    /**
+     * The status text associated with the status code `400`.
+     */
+    BAD_REQUEST = "Bad Request",
+    /**
+     * The status text associated with the status code `401`.
+     */
+    UNAUTHORIZED = "Unauthorized",
+    /**
+     * The status text associated with the status code `402`.
+     */
+    PAYMENT_REQUIRED = "Payment Required",
+    /**
+     * The status text associated with the status code `403`.
+     */
+    FORBIDDEN = "Forbidden",
+    /**
+     * The status text associated with the status code `404`.
+     */
+    NOT_FOUND = "Not Found",
+    /**
+     * The status text associated with the status code `405`.
+     */
+    METHOD_NOT_ALLOWED = "Method Not Allowed",
+    /**
+     * The status text associated with the status code `406`.
+     */
+    NOT_ACCEPTABLE = "Not Acceptable",
+    /**
+     * The status text associated with the status code `407`.
+     */
+    PROXY_AUTHENTICATION_REQUIRED = "Proxy Authentication Required",
+    /**
+     * The status text associated with the status code `408`.
+     */
+    REQUEST_TIMEOUT = "Request Timeout",
+    /**
+     * The status text associated with the status code `409`.
+     */
+    CONFLICT = "Conflict",
+    /**
+     * The status text associated with the status code `410`.
+     */
+    GONE = "Gone",
+    /**
+     * The status text associated with the status code `411`.
+     */
+    LENGTH_REQUIRED = "Length Required",
+    /**
+     * The status text associated with the status code `412`.
+     */
+    PRECONDITION_FAILED = "Precondition Failed",
+    /**
+     * The status text associated with the status code `413`.
+     */
+    PAYLOAD_TOO_LARGE = "Payload Too Large",
+    /**
+     * The status text associated with the status code `414`.
+     */
+    URI_TOO_LONG = "URI Too Long",
+    /**
+     * The status text associated with the status code `415`.
+     */
+    UNSUPPORTED_MEDIA_TYPE = "Unsupported Media Type",
+    /**
+     * The status text associated with the status code `416`.
+     */
+    RANGE_NOT_SATISFIABLE = "Range Not Satisfiable",
+    /**
+     * The status text associated with the status code `417`.
+     */
+    EXPECTATION_FAILED = "Expectation Failed",
+    /**
+     * The status text associated with the status code `418`.
+     */
+    I_M_A_TEAPOT = "I'm a teapot",
+    /**
+     * The status text associated with the status code `421`.
+     */
+    MISDIRECTED_REQUEST = "Misdirected Request",
+    /**
+     * The status text associated with the status code `422`.
+     */
+    UNPROCESSABLE_ENTITY = "Unprocessable Entity",
+    /**
+     * The status text associated with the status code `423`.
+     */
+    LOCKED = "Locked",
+    /**
+     * The status text associated with the status code `424`.
+     */
+    FAILED_DEPENDENCY = "Failed Dependency",
+    /**
+     * The status text associated with the status code `426`.
+     */
+    UPGRADE_REQUIRED = "Upgrade Required",
+    /**
+     * The status text associated with the status code `428`.
+     */
+    PRECONDITION_REQUIRED = "Precondition Required",
+    /**
+     * The status text associated with the status code `429`.
+     */
+    TOO_MANY_REQUESTS = "Too Many Requests",
+    /**
+     * The status text associated with the status code `431`.
+     */
+    REQUEST_HEADER_FIELDS_TOO_LARGE = "Request Header Fields Too Large",
+    /**
+     * The status text associated with the status code `451`.
+     */
+    UNAVAILABLE_FOR_LEGAL_REASONS = "Unavailable For Legal Reasons",
+    /**
+     * The status text associated with the status code `500`.
+     */
+    INTERNAL_SERVER_ERROR = "Internal Server Error",
+    /**
+     * The status text associated with the status code `501`.
+     */
+    NOT_IMPLEMENTED = "Not Implemented",
+    /**
+     * The status text associated with the status code `502`.
+     */
+    BAD_GATEWAY = "Bad Gateway",
+    /**
+     * The status text associated with the status code `503`.
+     */
+    SERVICE_UNAVAILABLE = "Service Unavailable",
+    /**
+     * The status text associated with the status code `504`.
+     */
+    GATEWAY_TIMEOUT = "Gateway Timeout",
+    /**
+     * The status text associated with the status code `505`.
+     */
+    HTTP_VERSION_NOT_SUPPORTED = "HTTP Version Not Supported",
+    /**
+     * The status text associated with the status code `506`.
+     */
+    VARIANT_ALSO_NEGOTIATES = "Variant Also Negotiates",
+    /**
+     * The status text associated with the status code `507`.
+     */
+    INSUFFICIENT_STORAGE = "Insufficient Storage",
+    /**
+     * The status text associated with the status code `508`.
+     */
+    LOOP_DETECTED = "Loop Detected",
+    /**
+     * The status text associated with the status code `510`.
+     */
+    NOT_EXTENDED = "Not Extended",
+    /**
+     * The status text associated with the status code `511`.
+     */
+    NETWORK_AUTHENTICATION_REQUIRED = "Network Authentication Required"
+}

package/lib/framework/mock/http/util/index.d.ts

@@ -3,3 +3,5 @@ export * from './http-headers-mock.builder';
 export * from './fetch-client.builder';
 export * from './fetch-client-response-type.enum';
 export * from './http-mock-max-delay';
+export * from './http-status-text.enum';
+export * from './http-status-text-finder';

package/lib/model/business/mock/http/http-method-mock.d.ts

@@ -8,6 +8,7 @@
 import { HttpRequest } from "@angular/common/http";
 import { HttpResponseMock } from "./http-response-mock";
 import { HttpMockParameters } from "../../../../framework";
+import { HttpMockMethodDescriptor } from "./http-mock-method-descriptor";
 /**
  * The `HttpMethodMock` interface defines the behavior of actions invoked each time an Angular
  * `HttpClient` instance sends requests to a specific API endpoint.
@@ -27,4 +28,8 @@ export interface HttpMethodMock {
      * @returns A user-defined `HttpResponse` mock object.
      */
     data: (request: HttpRequest<any>, parameters?: HttpMockParameters) => HttpResponseMock;
+    /**
+     * The API descriptor of the associated with this HTTP method.
+     */
+    descriptor?: HttpMockMethodDescriptor;
 }

package/lib/model/business/mock/http/http-mock-config.d.ts

@@ -25,4 +25,8 @@ export interface HttpMockConfig {
      * The configuration of mocking strategies for each specific API.
      */
     interceptors: HttpMockInterceptor[];
+    /**
+     * The description of this HTTP API.
+     */
+    description?: string;
 }

package/lib/model/business/mock/http/http-mock-endpoint-descriptor.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { HttpParameterDescriptor } from "./http-mock-parameter-descriptor";
+/**
+ * Provides the API to create documentation for a specific endpoint.
+ */
+export interface HttpMockEndpointDescriptor {
+    /**
+     * The description of the endpoint associated with this descriptor.
+     */
+    description?: string;
+    /**
+     * The description all parameters of the endpoint associated with this descriptor.
+     */
+    params?: HttpParameterDescriptor[];
+}

package/lib/model/business/mock/http/http-mock-endpoint.d.ts

@@ -6,10 +6,15 @@
  * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
  */
 import { HttpMethodMock } from "./http-method-mock";
+import { HttpMockEndpointDescriptor } from "./http-mock-endpoint-descriptor";
 /**
  * Provides the API to define mocking strategies for a specific endpoint.
  */
 export interface HttpMockEndpoint {
+    /**
+     * The API descriptor for this endpoint.
+     */
+    descriptor?: HttpMockEndpointDescriptor;
     /**
      * The route part of the endpoint to mock.
      */

package/lib/model/business/mock/http/http-mock-interceptor.d.ts

@@ -24,4 +24,8 @@ export interface HttpMockInterceptor {
      * A list of endpoints that must be intercepted by the HTTP Mocking Framework.
      */
     endpoints: HttpMockEndpoint[];
+    /**
+     * The description of this interceptor.
+     */
+    description?: string;
 }

package/lib/model/business/mock/http/http-mock-method-descriptor.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+import { HttpParameterDescriptor } from "./http-mock-parameter-descriptor";
+/**
+ * Provides the API to create documentation for a specific HTTP method.
+ */
+export interface HttpMockMethodDescriptor {
+    /**
+     * The description of the method associated with this descriptor.
+     */
+    description?: string;
+    /**
+     * The payload description for the method associated with this descriptor.
+     */
+    payload?: string;
+    /**
+     * The body description for the method associated with this descriptor.
+     */
+    body?: string;
+    /**
+     * The list of query string parameters for the method associated with this descriptor.
+     */
+    queryParams?: HttpParameterDescriptor[];
+}

package/lib/model/business/mock/http/http-mock-parameter-descriptor.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright Pascal ECHEMANN. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be found in
+ * the LICENSE file at https://pascalechemann.com/angular-toolbox/resources/license
+ */
+/**
+ * Provides the API to create documentation for a specific HTTP parameter.
+ */
+export interface HttpParameterDescriptor {
+    /**
+     * The description of the HTTP parameter associated with this descriptor.
+     */
+    description: string;
+    /**
+     * The referrence to the HTTP parameter associated with this descriptor.
+     */
+    ref: string;
+}

package/lib/model/business/mock/http/index.d.ts

@@ -2,6 +2,9 @@ export * from './http-response-mock';
 export * from './http-method-mock';
 export * from './http-mock-config';
 export * from './http-mock-endpoint';
+export * from './http-mock-endpoint-descriptor';
+export * from './http-mock-method-descriptor';
+export * from './http-mock-parameter-descriptor';
 export * from './http-mock-interceptor';
 export * from './http-mock-error';
 export * from './http-mock-request-metadata';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-toolbox",
-  "version": "1.3.3",
+  "version": "1.4.1",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",