angular-toolbox 1.4.0 → 1.4.2

package/lib/component/layout/border-layout/border-layout.component.d.ts

@@ -48,7 +48,7 @@ export declare class BorderLayout extends IdentifiableComponent implements After
     /**
      * @private
      */
-    constructor(subscribeSvc: SubscriptionService);
+    constructor(subscribeSvc: SubscriptionService, document: Document);
     /**
      * @private
      * For test purpose only.

package/lib/component/layout/border-layout/util/border-layout-renderer.d.ts

@@ -16,6 +16,7 @@ import { BorderLayoutBoundsManager } from './border-layout-bounds-manager';
  */
 export declare class BorderLayoutRenderer extends IdentifiableComponent implements Destroyable {
     private subscribeSvc;
+    private document;
     /**
      * Emits events each time the user starts, or stops dragging handle.
      */
@@ -35,7 +36,15 @@ export declare class BorderLayoutRenderer extends IdentifiableComponent implemen
     /**
      * @private
      */
-    constructor(subscribeSvc: SubscriptionService);
+    private storedStopHandler;
+    /**
+     * @private
+     */
+    private storedMoveHandler;
+    /**
+     * @private
+     */
+    constructor(subscribeSvc: SubscriptionService, document: Document);
     /**
      * Add the list `BorderLayoutContainer` objects associated with the main container to this controller.
      *
@@ -83,5 +92,12 @@ export declare class BorderLayoutRenderer extends IdentifiableComponent implemen
      * @private
      */
     private render;
+    /**
+     * @private
+     */
     private checkLytContainer;
+    /**
+     * @private
+     */
+    private deleteStoredHandlers;
 }

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/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.4.0",
+  "version": "1.4.2",
   "license": "SEE LICENSE IN LICENSE",
   "peerDependencies": {
     "@angular/common": "^18.0.0",