@hmcts/opal-frontend-common 0.0.2 → 0.0.3

package/components/moj/moj-pagination/moj-pagination.component.d.ts

@@ -0,0 +1,108 @@
+import { EventEmitter, OnChanges } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class MojPaginationComponent implements OnChanges {
+    currentPage: number;
+    total: number;
+    maxPagesToShow: number;
+    limit: number;
+    ariaLabel: string;
+    changePage: EventEmitter<number>;
+    pages: import("@angular/core").WritableSignal<(string | number)[]>;
+    totalPages: import("@angular/core").WritableSignal<number>;
+    startItem: import("@angular/core").WritableSignal<number>;
+    endItem: import("@angular/core").WritableSignal<number>;
+    totalItems: import("@angular/core").WritableSignal<number>;
+    /**
+     * Updates the pagination signals based on the current state.
+     *
+     * This method recalculates and sets the following signals:
+     * - `totalPages`: The total number of pages based on the total items and items per page limit.
+     * - `startItem`: The index of the first item on the current page.
+     * - `endItem`: The index of the last item on the current page.
+     * - `pages`: The array of page numbers to be displayed.
+     * - `totalItems`: The total number of items.
+     *
+     * @private
+     */
+    private setSignals;
+    /**
+     * Calculates the total number of pages based on the total number of items and the limit of items per page.
+     *
+     * @param total - The total number of items.
+     * @param limit - The number of items per page.
+     * @returns The total number of pages.
+     */
+    private getTotalPages;
+    /**
+     * Sets the pagination pages based on the current page and total pages.
+     * This method updates the `pages` property with the result of the `getPages` method.
+     *
+     * @private
+     */
+    private setPages;
+    /**
+     * Calculates the starting item index for pagination.
+     *
+     * @param currentPage - The current page number.
+     * @param limit - The number of items per page.
+     * @returns The starting item index for the given page.
+     */
+    private getStartItem;
+    /**
+     * Calculates the end item index for pagination.
+     *
+     * @param currentPage - The current page number.
+     * @param limit - The number of items per page.
+     * @param total - The total number of items.
+     * @returns The index of the last item on the current page, or the total number of items if the end of the list is reached.
+     */
+    private getEndItem;
+    /**
+     * Updates the total number of items by setting the value of `totalItems` to the current `total`.
+     *
+     * @private
+     */
+    private setTotalItems;
+    /**
+     * Generates an array of page numbers and ellipses for pagination display.
+     *
+     * @param currentPage - The current active page number.
+     * @param totalPages - The total number of pages available.
+     * @returns An array of page numbers and ellipses representing the pagination.
+     *
+     * The function ensures that the pagination display shows a maximum of 5 pages at a time.
+     * It calculates the range of pages to display based on the current page and total pages.
+     * If the start page is greater than 1, it adds an ellipsis and the first page at the beginning.
+     * If the end page is less than the total pages, it adds an ellipsis and the last page at the end.
+     */
+    private getPages;
+    /**
+     * Calculates the start page for pagination based on the current page, total pages, and the number of pages to show on either side of the current page.
+     *
+     * @param currentPage - The current active page number.
+     * @param totalPages - The total number of pages available.
+     * @param halfPagesToShow - The number of pages to show on either side of the current page.
+     * @returns The start page number for pagination.
+     */
+    private calculateStartPage;
+    /**
+     * Calculates the end page number for pagination based on the current page, total pages, and the number of pages to show.
+     *
+     * @param currentPage - The current page number.
+     * @param totalPages - The total number of pages.
+     * @param halfPagesToShow - Half the number of pages to show around the current page.
+     * @returns The calculated end page number.
+     */
+    private calculateEndPage;
+    /**
+     * Generates an array of page numbers from the startPage to the endPage.
+     *
+     * @param startPage - The starting page number.
+     * @param endPage - The ending page number.
+     * @returns An array of page numbers from startPage to endPage.
+     */
+    private generatePageNumbers;
+    ngOnChanges(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojPaginationComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojPaginationComponent, "opal-lib-moj-pagination,", never, { "currentPage": { "alias": "currentPage"; "required": false; }; "total": { "alias": "total"; "required": false; }; "maxPagesToShow": { "alias": "maxPagesToShow"; "required": false; }; "limit": { "alias": "limit"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; }, { "changePage": "changePage"; }, never, never, true, never>;
+}

package/components/moj/moj-primary-navigation/moj-primary-navigation-item/moj-primary-navigation-item.component.d.ts

@@ -0,0 +1,18 @@
+import * as i0 from "@angular/core";
+export declare class MojPrimaryNavigationItemComponent {
+    private readonly router;
+    private readonly route;
+    primaryNavigationItemId: string;
+    primaryNavigationItemFragment: string;
+    primaryNavigationItemText: string;
+    activeItemFragment: string;
+    isLastItem: boolean;
+    /**
+     * Handles the click event of a sub-navigation item.
+     * @param event - The click event.
+     * @param item - The item string.
+     */
+    handleItemClick(event: Event, item: string): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojPrimaryNavigationItemComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojPrimaryNavigationItemComponent, "opal-lib-moj-primary-navigation-item, [opal-lib-moj-primary-navigation-item]", never, { "primaryNavigationItemId": { "alias": "primaryNavigationItemId"; "required": true; }; "primaryNavigationItemFragment": { "alias": "primaryNavigationItemFragment"; "required": true; }; "primaryNavigationItemText": { "alias": "primaryNavigationItemText"; "required": true; }; "activeItemFragment": { "alias": "activeItemFragment"; "required": true; }; "isLastItem": { "alias": "isLastItem"; "required": false; }; }, {}, never, never, true, never>;
+}

package/components/moj/moj-primary-navigation/moj-primary-navigation.component.d.ts

@@ -0,0 +1,26 @@
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class MojPrimaryNavigationComponent implements OnInit, OnDestroy {
+    private readonly router;
+    private readonly route;
+    private readonly ngUnsubscribe;
+    primaryNavigationId: string;
+    activeItemFragment: EventEmitter<string>;
+    /**
+     * Sets up the listeners for the route fragment changes.
+     * Emits the active navigation item when a fragment is present in the route.
+     */
+    private setupListeners;
+    /**
+     * Initializes the component.
+     * This method is called after the component has been created and initialized.
+     */
+    ngOnInit(): void;
+    /**
+     * Lifecycle hook that is called when the component is about to be destroyed.
+     * Unsubscribes from the route fragment subscription.
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojPrimaryNavigationComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojPrimaryNavigationComponent, "opal-lib-moj-primary-navigation", never, { "primaryNavigationId": { "alias": "primaryNavigationId"; "required": true; }; }, { "activeItemFragment": "activeItemFragment"; }, never, ["*"], true, never>;
+}

package/components/moj/moj-sortable-table/moj-sortable-table-header/moj-sortable-table-header.component.d.ts

@@ -0,0 +1,24 @@
+import { EventEmitter } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class MojSortableTableHeaderComponent {
+    columnKey: string;
+    sortDirection: 'ascending' | 'descending' | 'none';
+    dataIndex: number;
+    sortChange: EventEmitter<{
+        key: string;
+        sortType: "ascending" | "descending";
+    }>;
+    get ariaSort(): string | null;
+    hostScope: string;
+    get hostClass(): string;
+    /**
+     * Toggles the sort direction between 'ascending' and 'descending' for the table column.
+     * Emits a sortChange event with the column key and the new sort direction.
+     *
+     * @public
+     * @returns {void}
+     */
+    toggleSort(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojSortableTableHeaderComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojSortableTableHeaderComponent, "opal-lib-moj-sortable-table-header, [opal-lib-moj-sortable-table-header]", never, { "columnKey": { "alias": "columnKey"; "required": false; }; "sortDirection": { "alias": "sortDirection"; "required": false; }; "dataIndex": { "alias": "dataIndex"; "required": false; }; }, { "sortChange": "sortChange"; }, never, ["*"], true, never>;
+}

package/components/moj/moj-sortable-table/moj-sortable-table-row/moj-sortable-table-row.component.d.ts

@@ -0,0 +1,7 @@
+import * as i0 from "@angular/core";
+export declare class MojSortableTableRowComponent {
+    bodyRowClasses: string;
+    get hostClass(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojSortableTableRowComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojSortableTableRowComponent, "opal-lib-moj-sortable-table-row,[opal-lib-moj-sortable-table-row]", never, { "bodyRowClasses": { "alias": "bodyRowClasses"; "required": false; }; }, {}, never, ["*"], true, never>;
+}

package/components/moj/moj-sortable-table/moj-sortable-table.component.d.ts

@@ -0,0 +1,6 @@
+import * as i0 from "@angular/core";
+export declare class MojSortableTableComponent {
+    tableClasses: string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojSortableTableComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojSortableTableComponent, "opal-lib-moj-sortable-table", never, { "tableClasses": { "alias": "tableClasses"; "required": false; }; }, {}, never, ["[head]", "[row]", "[results]", "[status]"], true, never>;
+}

package/components/moj/moj-sub-navigation/moj-sub-navigation-item/moj-sub-navigation-item.component.d.ts

@@ -0,0 +1,17 @@
+import * as i0 from "@angular/core";
+export declare class MojSubNavigationItemComponent {
+    private readonly router;
+    private readonly route;
+    subNavItemId: string;
+    subNavItemFragment: string;
+    subNavItemText: string;
+    activeSubNavItemFragment: string;
+    /**
+     * Handles the click event of a sub-navigation item.
+     * @param event - The click event.
+     * @param item - The item string.
+     */
+    handleItemClick(event: Event, item: string): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojSubNavigationItemComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojSubNavigationItemComponent, "opal-lib-moj-sub-navigation-item", never, { "subNavItemId": { "alias": "subNavItemId"; "required": true; }; "subNavItemFragment": { "alias": "subNavItemFragment"; "required": true; }; "subNavItemText": { "alias": "subNavItemText"; "required": true; }; "activeSubNavItemFragment": { "alias": "activeSubNavItemFragment"; "required": true; }; }, {}, never, never, true, never>;
+}

package/components/moj/moj-sub-navigation/moj-sub-navigation.component.d.ts

@@ -0,0 +1,21 @@
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class MojSubNavigationComponent implements OnInit, OnDestroy {
+    private readonly route;
+    private readonly ngUnsubscribe;
+    subNavId: string;
+    activeSubNavItemFragment: EventEmitter<string>;
+    /**
+     * Sets up the listeners for the route fragment changes.
+     * Emits the active navigation item when a fragment is present in the route.
+     */
+    private setupListeners;
+    ngOnInit(): void;
+    /**
+     * Lifecycle hook that is called when the component is about to be destroyed.
+     * Unsubscribes from the route fragment subscription.
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojSubNavigationComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojSubNavigationComponent, "opal-lib-moj-sub-navigation", never, { "subNavId": { "alias": "subNavId"; "required": true; }; }, { "activeSubNavItemFragment": "activeSubNavItemFragment"; }, never, ["*"], true, never>;
+}

package/components/moj/moj-ticket-panel/moj-ticket-panel.component.d.ts

@@ -0,0 +1,8 @@
+import * as i0 from "@angular/core";
+export declare class MojTicketPanelComponent {
+    componentClasses: string;
+    sectionClasses: string;
+    alert: boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojTicketPanelComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojTicketPanelComponent, "opal-lib-moj-ticket-panel", never, { "componentClasses": { "alias": "componentClasses"; "required": false; }; "sectionClasses": { "alias": "sectionClasses"; "required": false; }; "alert": { "alias": "alert"; "required": false; }; }, {}, never, ["*"], true, never>;
+}

package/components/moj/moj-timeline/moj-timeline-item/moj-timeline-item.component.d.ts

@@ -0,0 +1,5 @@
+import * as i0 from "@angular/core";
+export declare class MojTimelineItemComponent {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojTimelineItemComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojTimelineItemComponent, "opal-lib-moj-timeline-item", never, {}, {}, never, ["[title]", "[user]", "[date]", "[description]"], true, never>;
+}

package/components/moj/moj-timeline/moj-timeline.component.d.ts

@@ -0,0 +1,5 @@
+import * as i0 from "@angular/core";
+export declare class MojTimelineComponent {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MojTimelineComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MojTimelineComponent, "opal-lib-moj-timeline", never, {}, {}, never, ["*"], true, never>;
+}

package/components/moj/public-api.d.ts

@@ -0,0 +1,24 @@
+export * from './moj-badge/moj.badge.component';
+export * from './moj-banner/moj-banner.component';
+export * from './moj-button-menu/moj-button-menu-item/moj-button-menu-item.component';
+export * from './moj-button-menu/moj-button-menu.component';
+export * from './moj-date-picker/moj-date-picker.component';
+export * from './moj-header/moj-header-navigation-item/moj-header-navigation-item.component';
+export * from './moj-header/moj-header.component';
+export * from './moj-page-header/moj-page-header.component';
+export * from './moj-pagination/moj-pagination-item/moj-pagination-item.component';
+export * from './moj-pagination/moj-pagination-link/moj-pagination-link.component';
+export * from './moj-pagination/moj-pagination-list/moj-pagination-list.component';
+export * from './moj-pagination/moj-pagination.component';
+export * from './moj-primary-navigation/moj-primary-navigation-item/moj-primary-navigation-item.component';
+export * from './moj-primary-navigation/moj-primary-navigation.component';
+export * from './moj-sortable-table/moj-sortable-table-header/moj-sortable-table-header.component';
+export * from './moj-sortable-table/moj-sortable-table-row/moj-sortable-table-row.component';
+export * from './moj-sortable-table/moj-sortable-table.component';
+export * from './moj-sub-navigation/moj-sub-navigation-item/moj-sub-navigation-item.component';
+export * from './moj-sub-navigation/moj-sub-navigation.component';
+export * from './moj-ticket-panel/moj-ticket-panel.component';
+export * from './moj-timeline/moj-timeline-item/moj-timeline-item.component';
+export * from './moj-timeline/moj-timeline.component';
+export * from './moj-header/interfaces/moj-header-links.interface';
+export * from './moj-header/constants/moj-header-links.constant';

package/constants/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@hmcts/opal-frontend-common/constants" />
+export * from './public-api';

package/constants/public-api.d.ts

@@ -0,0 +1,4 @@
+export * from './src/routing-paths.constant';
+export * from './src/routing-titles.constant';
+export * from './src/session-endpoints.constant';
+export * from './src/sso-endpoints.constant';

package/constants/src/routing-paths.constant.d.ts

@@ -0,0 +1,2 @@
+import { IPagesRoutingPaths } from '@hmcts/opal-frontend-common/interfaces';
+export declare const PAGES_ROUTING_PATHS: IPagesRoutingPaths;

package/constants/src/routing-titles.constant.d.ts

@@ -0,0 +1,2 @@
+import { IPagesRoutingPaths } from '@hmcts/opal-frontend-common/interfaces';
+export declare const PAGES_ROUTING_TITLES: IPagesRoutingPaths;

package/constants/src/session-endpoints.constant.d.ts

@@ -0,0 +1,2 @@
+import { ISessionEndpoints } from '@hmcts/opal-frontend-common/interfaces';
+export declare const SESSION_ENDPOINTS: ISessionEndpoints;

package/constants/src/sso-endpoints.constant.d.ts

@@ -0,0 +1,2 @@
+import { ISsoEndpoints } from '@hmcts/opal-frontend-common/interfaces';
+export declare const SSO_ENDPOINTS: ISsoEndpoints;