@deenruv/admin-ui 1.0.0

package/core/providers/health-check/health-check.service.d.ts

@@ -0,0 +1,40 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export type SystemStatus = 'ok' | 'error';
+export interface HealthCheckResult {
+    status: SystemStatus;
+    info: {
+        [name: string]: HealthCheckSuccessResult;
+    };
+    details: {
+        [name: string]: HealthCheckSuccessResult | HealthCheckErrorResult;
+    };
+    error: {
+        [name: string]: HealthCheckErrorResult;
+    };
+}
+export interface HealthCheckSuccessResult {
+    status: 'up';
+}
+export interface HealthCheckErrorResult {
+    status: 'down';
+    message: string;
+}
+export declare class HealthCheckService {
+    private httpClient;
+    status$: Observable<SystemStatus>;
+    details$: Observable<Array<{
+        key: string;
+        result: HealthCheckSuccessResult | HealthCheckErrorResult;
+    }>>;
+    lastCheck$: Observable<Date>;
+    private readonly pollingDelayMs;
+    private readonly healthCheckEndpoint;
+    private readonly _refresh;
+    constructor(httpClient: HttpClient);
+    refresh(): void;
+    private checkHealth;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HealthCheckService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<HealthCheckService>;
+}

package/core/providers/i18n/custom-http-loader.d.ts

@@ -0,0 +1,21 @@
+import { HttpClient } from '@angular/common/http';
+import { TranslateLoader } from '@ngx-translate/core';
+import { Observable } from 'rxjs';
+export type Dictionary = {
+    [key: string]: string | Dictionary;
+};
+/**
+ * A loader for ngx-translate which extends the HttpLoader functionality by stripping out any
+ * values which are empty strings. This means that during development, translation keys which have
+ * been extracted but not yet defined will fall back to the raw key text rather than displaying nothing.
+ *
+ * Originally from https://github.com/ngx-translate/core/issues/662#issuecomment-377010232
+ */
+export declare class CustomHttpTranslationLoader implements TranslateLoader {
+    private http;
+    private prefix;
+    private suffix;
+    constructor(http: HttpClient, prefix?: string, suffix?: string);
+    getTranslation(lang: string): Observable<any>;
+    private process;
+}

package/core/providers/i18n/custom-message-format-compiler.d.ts

@@ -0,0 +1,15 @@
+import { TranslateMessageFormatCompiler } from 'ngx-translate-messageformat-compiler';
+import * as i0 from "@angular/core";
+/**
+ * Work-around for Angular 9 compat.
+ * See https://github.com/lephyrus/ngx-translate-messageformat-compiler/issues/53#issuecomment-583677994
+ *
+ * Also logs errors which would otherwise get swallowed by ngx-translate. This is important
+ * because it is quite easy to make errors in messageformat syntax, and without clear
+ * error messages it's very hard to debug.
+ */
+export declare class InjectableTranslateMessageFormatCompiler extends TranslateMessageFormatCompiler {
+    compileTranslations(value: any, lang: string): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<InjectableTranslateMessageFormatCompiler, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<InjectableTranslateMessageFormatCompiler>;
+}

package/core/providers/i18n/i18n.service.d.ts

@@ -0,0 +1,39 @@
+import { TranslateService } from '@ngx-translate/core';
+import { LanguageCode } from '../../common/generated-types';
+import * as i0 from "@angular/core";
+/** @dynamic */
+export declare class I18nService {
+    private ngxTranslate;
+    private document;
+    _availableLocales: string[];
+    _availableLanguages: LanguageCode[];
+    get availableLanguages(): LanguageCode[];
+    get availableLocales(): string[];
+    constructor(ngxTranslate: TranslateService, document: Document);
+    /**
+     * Set the default language
+     */
+    setDefaultLanguage(languageCode: LanguageCode): void;
+    /**
+     * Set the UI language
+     */
+    setLanguage(language: LanguageCode): void;
+    /**
+     * Set the available UI languages
+     */
+    setAvailableLanguages(languages: LanguageCode[]): void;
+    /**
+     * Set the available UI locales
+     */
+    setAvailableLocales(locales: string[]): void;
+    /**
+     * Translate the given key.
+     */
+    translate(key: string | string[], params?: any): string;
+    /**
+     * Returns true if the given language code is a right-to-left language.
+     */
+    isRTL(languageCode: LanguageCode): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<I18nService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<I18nService>;
+}

package/core/providers/job-queue/job-queue.service.d.ts

@@ -0,0 +1,22 @@
+import { OnDestroy } from '@angular/core';
+import { Observable } from 'rxjs';
+import { JobInfoFragment } from '../../common/generated-types';
+import { DataService } from '../../data/providers/data.service';
+import * as i0 from "@angular/core";
+export declare class JobQueueService implements OnDestroy {
+    private dataService;
+    activeJobs$: Observable<JobInfoFragment[]>;
+    private updateJob$;
+    private onCompleteHandlers;
+    private readonly subscription;
+    constructor(dataService: DataService);
+    ngOnDestroy(): void;
+    /**
+     * After a given delay, checks the server for any active jobs.
+     */
+    checkForJobs(delay?: number): void;
+    addJob(jobId: string, onComplete?: (job: JobInfoFragment) => void): void;
+    private handleJob;
+    static ɵfac: i0.ɵɵFactoryDeclaration<JobQueueService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<JobQueueService>;
+}

package/core/providers/local-storage/local-storage.service.d.ts

@@ -0,0 +1,66 @@
+import { Location } from '@angular/common';
+import { LanguageCode } from '../../common/generated-types';
+import { WidgetLayoutDefinition } from '../dashboard-widget/dashboard-widget-types';
+import * as i0 from "@angular/core";
+export type DataTableConfig = {
+    [id: string]: {
+        visibility: string[];
+        order: {
+            [id: string]: number;
+        };
+        showSearchFilterRow: boolean;
+        filterPresets: Array<{
+            name: string;
+            value: string;
+        }>;
+    };
+};
+export type LocalStorageTypeMap = {
+    activeChannelToken: string;
+    authToken: string;
+    uiLanguageCode: LanguageCode;
+    uiLocale: string | undefined;
+    contentLanguageCode: LanguageCode;
+    dashboardWidgetLayout: WidgetLayoutDefinition;
+    activeTheme: string;
+    livePreviewCollectionContents: boolean;
+    dataTableConfig: DataTableConfig;
+};
+export type LocalStorageLocationBasedTypeMap = {
+    shippingTestOrder: any;
+    shippingTestAddress: any;
+};
+/**
+ * Wrapper around the browser's LocalStorage / SessionStorage object, for persisting data to the browser.
+ */
+export declare class LocalStorageService {
+    private location;
+    private adminId;
+    constructor(location: Location);
+    setAdminId(adminId?: string | null): void;
+    /**
+     * Set a key-value pair in the browser's LocalStorage
+     */
+    set<K extends keyof LocalStorageTypeMap>(key: K, value: LocalStorageTypeMap[K]): void;
+    /**
+     * Set a key-value pair specific to the current location (url)
+     */
+    setForCurrentLocation<K extends keyof LocalStorageLocationBasedTypeMap>(key: K, value: LocalStorageLocationBasedTypeMap[K]): void;
+    /**
+     * Set a key-value pair in the browser's SessionStorage
+     */
+    setForSession<K extends keyof LocalStorageTypeMap>(key: K, value: LocalStorageTypeMap[K]): void;
+    /**
+     * Get the value of the given key from the SessionStorage or LocalStorage.
+     */
+    get<K extends keyof LocalStorageTypeMap>(key: K): LocalStorageTypeMap[K] | null;
+    /**
+     * Get the value of the given key for the current location (url)
+     */
+    getForCurrentLocation<K extends keyof LocalStorageLocationBasedTypeMap>(key: K): LocalStorageLocationBasedTypeMap[K];
+    remove(key: keyof LocalStorageTypeMap): void;
+    private getLocationBasedKey;
+    private keyName;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocalStorageService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<LocalStorageService>;
+}

package/core/providers/localization/localization.service.d.ts

@@ -0,0 +1,21 @@
+import { Observable } from 'rxjs';
+import { DataService } from '../../data/providers/data.service';
+import { I18nService } from '../../providers/i18n/i18n.service';
+import { LanguageCode } from '../../common/generated-types';
+import * as i0 from "@angular/core";
+export type LocalizationDirectionType = Observable<'ltr' | 'rtl'>;
+export type LocalizationLanguageCodeType = Observable<[LanguageCode, string | undefined]>;
+/**
+ * @description
+ * Provides localization helper functionality.
+ *
+ */
+export declare class LocalizationService {
+    private i18nService;
+    private dataService;
+    uiLanguageAndLocale$: LocalizationLanguageCodeType;
+    direction$: LocalizationDirectionType;
+    constructor(i18nService: I18nService, dataService: DataService);
+    static ɵfac: i0.ɵɵFactoryDeclaration<LocalizationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<LocalizationService>;
+}

package/core/providers/modal/modal.service.d.ts

@@ -0,0 +1,67 @@
+import { Type } from '@deenruv/common/lib/shared-types';
+import { Observable } from 'rxjs';
+import { OverlayHostService } from '../overlay-host/overlay-host.service';
+import { Dialog, DialogConfig, ModalOptions } from './modal.types';
+import * as i0 from "@angular/core";
+/**
+ * @description
+ * This service is responsible for instantiating a ModalDialog component and
+ * embedding the specified component within.
+ *
+ * @docsCategory services
+ * @docsPage ModalService
+ * @docsWeight 0
+ */
+export declare class ModalService {
+    private overlayHostService;
+    constructor(overlayHostService: OverlayHostService);
+    /**
+     * @description
+     * Create a modal from a component. The component must implement the {@link Dialog} interface.
+     * Additionally, the component should include templates for the title and the buttons to be
+     * displayed in the modal dialog. See example:
+     *
+     * @example
+     * ```ts
+     * class MyDialog implements Dialog {
+     *  resolveWith: (result?: any) => void;
+     *
+     *  okay() {
+     *    doSomeWork().subscribe(result => {
+     *      this.resolveWith(result);
+     *    })
+     *  }
+     *
+     *  cancel() {
+     *    this.resolveWith(false);
+     *  }
+     * }
+     * ```
+     *
+     * @example
+     * ```html
+     * <ng-template vdrDialogTitle>Title of the modal</ng-template>
+     *
+     * <p>
+     *   My Content
+     * </p>
+     *
+     * <ng-template vdrDialogButtons>
+     *   <button type="button"
+     *           class="btn"
+     *           (click)="cancel()">Cancel</button>
+     *   <button type="button"
+     *           class="btn btn-primary"
+     *           (click)="okay()">Okay</button>
+     * </ng-template>
+     * ```
+     */
+    fromComponent<T extends Dialog<any>, R>(component: Type<T> & Type<Dialog<R>>, options?: ModalOptions<T>): Observable<R | undefined>;
+    /**
+     * @description
+     * Displays a modal dialog with the provided title, body and buttons.
+     */
+    dialog<T>(config: DialogConfig<T>): Observable<T | undefined>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ModalService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ModalService>;
+}

package/core/providers/modal/modal.types.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @description
+ * Any component intended to be used with the ModalService.fromComponent() method must implement
+ * this interface.
+ *
+ * @docsCategory services
+ * @docsPage ModalService
+ */
+export interface Dialog<R = any> {
+    /**
+     * @description
+     * Function to be invoked in order to close the dialog when the action is complete.
+     * The Observable returned from the .fromComponent() method will emit the value passed
+     * to this method and then complete.
+     */
+    resolveWith: (result?: R) => void;
+}
+export interface DialogButtonConfig<T> {
+    label: string;
+    type: 'secondary' | 'primary' | 'danger';
+    translationVars?: Record<string, string | number>;
+    returnValue?: T;
+}
+/**
+ * @description
+ * Configures a generic modal dialog.
+ *
+ * @docsCategory services
+ * @docsPage ModalService
+ */
+export interface DialogConfig<T> {
+    title: string;
+    body?: string;
+    translationVars?: {
+        [key: string]: string | number;
+    };
+    buttons: Array<DialogButtonConfig<T>>;
+    size?: 'sm' | 'md' | 'lg' | 'xl';
+}
+/**
+ * @description
+ * Options to configure the behaviour of the modal.
+ *
+ * @docsCategory services
+ * @docsPage ModalService
+ */
+export interface ModalOptions<T> {
+    /**
+     * @description
+     * Sets the width of the dialog
+     */
+    size?: 'sm' | 'md' | 'lg' | 'xl';
+    /**
+     * @description
+     * Sets the vertical alignment of the dialog
+     */
+    verticalAlign?: 'top' | 'center' | 'bottom';
+    /**
+     * @description
+     * When true, the "x" icon is shown
+     * and clicking it or the mask will close the dialog
+     */
+    closable?: boolean;
+    /**
+     * @description
+     * Values to be passed directly to the component being instantiated inside the dialog.
+     */
+    locals?: Partial<T>;
+}

package/core/providers/nav-builder/nav-builder-types.d.ts

@@ -0,0 +1,279 @@
+import { Injector } from '@angular/core';
+import { ActivatedRoute } from '@angular/router';
+import { Observable } from 'rxjs';
+import { ActionBarLocationId } from '../../common/component-registry-types';
+import { DataService } from '../../data/providers/data.service';
+import { NotificationService } from '../notification/notification.service';
+export type NavMenuBadgeType = 'none' | 'info' | 'success' | 'warning' | 'error';
+/**
+ * @description
+ * A color-coded notification badge which will be displayed by the
+ * NavMenuItem's icon.
+ *
+ * @docsCategory nav-menu
+ * @docsPage navigation-types
+ */
+export interface NavMenuBadge {
+    type: NavMenuBadgeType;
+    /**
+     * @description
+     * If true, the badge will propagate to the NavMenuItem's
+     * parent section, displaying a notification badge next
+     * to the section name.
+     */
+    propagateToSection?: boolean;
+}
+/**
+ * @description
+ * A NavMenuItem is a menu item in the main (left-hand side) nav
+ * bar.
+ *
+ * @docsCategory nav-menu
+ */
+export interface NavMenuItem {
+    id: string;
+    label: string;
+    routerLink: RouterLinkDefinition;
+    onClick?: (event: MouseEvent) => void;
+    icon?: string;
+    /**
+     * Control the display of this item based on the user permissions.
+     */
+    requiresPermission?: string | ((userPermissions: string[]) => boolean);
+    statusBadge?: Observable<NavMenuBadge>;
+}
+/**
+ * @description
+ * A NavMenuSection is a grouping of links in the main
+ * (left-hand side) nav bar.
+ *
+ * @docsCategory nav-menu
+ */
+export interface NavMenuSection {
+    id: string;
+    label: string;
+    items: NavMenuItem[];
+    icon?: string;
+    displayMode?: 'regular' | 'settings';
+    /**
+     * @description
+     * Control the display of this item based on the user permissions. Note: if you attempt to pass a
+     * {@link PermissionDefinition} object, you will get a compilation error. Instead, pass the plain
+     * string version. For example, if the permission is defined as:
+     * ```ts
+     * export const MyPermission = new PermissionDefinition('ProductReview');
+     * ```
+     * then the generated permission strings will be:
+     *
+     * - `CreateProductReview`
+     * - `ReadProductReview`
+     * - `UpdateProductReview`
+     * - `DeleteProductReview`
+     */
+    requiresPermission?: string | ((userPermissions: string[]) => boolean);
+    collapsible?: boolean;
+    collapsedByDefault?: boolean;
+}
+/**
+ * @description
+ * Providers & data available to the `onClick` & `buttonState` functions of an {@link ActionBarItem},
+ * {@link ActionBarDropdownMenuItem} or {@link NavMenuItem}.
+ *
+ * @docsCategory action-bar
+ */
+export interface ActionBarContext {
+    /**
+     * @description
+     * The router's [ActivatedRoute](https://angular.dev/guide/routing/router-reference#activated-route) object for
+     * the current route. This object contains information about the route, its parameters, and additional data
+     * associated with the route.
+     */
+    route: ActivatedRoute;
+    /**
+     * @description
+     * The Angular [Injector](https://angular.dev/api/core/Injector) which can be used to get instances
+     * of services and other providers available in the application.
+     */
+    injector: Injector;
+    /**
+     * @description
+     * The [DataService](/reference/admin-ui-api/services/data-service), which provides methods for querying the
+     * server-side data.
+     */
+    dataService: DataService;
+    /**
+     * @description
+     * The [NotificationService](/reference/admin-ui-api/services/notification-service), which provides methods for
+     * displaying notifications to the user.
+     */
+    notificationService: NotificationService;
+    /**
+     * @description
+     * An observable of the current entity in a detail view. In a list view the observable will not emit any values.
+     *
+     * @example
+     * ```ts
+     * addActionBarDropdownMenuItem({
+     *     id: 'print-invoice',
+     *     locationId: 'order-detail',
+     *     label: 'Print Invoice',
+     *     icon: 'printer',
+     *     buttonState: context => {
+     *         // highlight-start
+     *         return context.entity$.pipe(
+     *             map((order) => {
+     *                 return order?.state === 'PaymentSettled'
+     *                     ? { disabled: false, visible: true }
+     *                     : { disabled: true, visible: true };
+     *             }),
+     *         );
+     *         // highlight-end
+     *     },
+     *     requiresPermission: ['UpdateOrder'],
+     * }),
+     * ```
+     *
+     * @since 2.2.0
+     */
+    entity$: Observable<Record<string, any> | undefined>;
+}
+export interface ActionBarButtonState {
+    disabled: boolean;
+    visible: boolean;
+}
+/**
+ * @description
+ * A button in the ActionBar area at the top of one of the list or detail views.
+ *
+ * @docsCategory action-bar
+ */
+export interface ActionBarItem {
+    /**
+     * @description
+     * A unique identifier for the item.
+     */
+    id: string;
+    /**
+     * @description
+     * The label to display for the item. This can also be a translation token,
+     * e.g. `invoice-plugin.print-invoice`.
+     */
+    label: string;
+    /**
+     * @description
+     * The location in the UI where this button should be displayed.
+     */
+    locationId: ActionBarLocationId;
+    /**
+     * @description
+     * Deprecated since v2.1.0 - use `buttonState` instead.
+     * @deprecated - use `buttonState` instead.
+     */
+    disabled?: Observable<boolean>;
+    /**
+     * @description
+     * A function which returns an observable of the button state, allowing you to
+     * dynamically enable/disable or show/hide the button.
+     *
+     * @since 2.1.0
+     */
+    buttonState?: (context: ActionBarContext) => Observable<ActionBarButtonState>;
+    onClick?: (event: MouseEvent, context: ActionBarContext) => void;
+    routerLink?: RouterLinkDefinition;
+    buttonColor?: 'primary' | 'success' | 'warning';
+    buttonStyle?: 'solid' | 'outline' | 'link';
+    /**
+     * @description
+     * An optional icon to display in the button. The icon
+     * should be a valid shape name from the [Clarity Icons](https://core.clarity.design/foundation/icons/shapes/)
+     * set.
+     */
+    icon?: string;
+    /**
+     * @description
+     * Control the display of this item based on the user permissions. Note: if you attempt to pass a
+     * {@link PermissionDefinition} object, you will get a compilation error. Instead, pass the plain
+     * string version. For example, if the permission is defined as:
+     *
+     * ```ts
+     * export const MyPermission = new PermissionDefinition('ProductReview');
+     * ```
+     *
+     * then the generated permission strings will be:
+     *
+     * - `CreateProductReview`
+     * - `ReadProductReview`
+     * - `UpdateProductReview`
+     * - `DeleteProductReview`
+     */
+    requiresPermission?: string | string[];
+}
+/**
+ * @description
+ * A dropdown menu item in the ActionBar area at the top of one of the list or detail views.
+ *
+ * @docsCategory action-bar
+ * @since 2.2.0
+ */
+export interface ActionBarDropdownMenuItem {
+    /**
+     * @description
+     * A unique identifier for the item.
+     */
+    id: string;
+    /**
+     * @description
+     * The label to display for the item. This can also be a translation token,
+     * e.g. `invoice-plugin.print-invoice`.
+     */
+    label: string;
+    /**
+     * @description
+     * The location in the UI where this menu item should be displayed.
+     */
+    locationId: ActionBarLocationId;
+    /**
+     * @description
+     * Whether to render a divider above this item.
+     */
+    hasDivider?: boolean;
+    /**
+     * @description
+     * A function which returns an observable of the button state, allowing you to
+     * dynamically enable/disable or show/hide the button.
+     */
+    buttonState?: (context: ActionBarContext) => Observable<ActionBarButtonState | undefined>;
+    onClick?: (event: MouseEvent, context: ActionBarContext) => void;
+    routerLink?: RouterLinkDefinition;
+    /**
+     * @description
+     * An optional icon to display with the item. The icon
+     * should be a valid shape name from the [Clarity Icons](https://core.clarity.design/foundation/icons/shapes/)
+     * set.
+     */
+    icon?: string;
+    /**
+     * @description
+     * Control the display of this item based on the user permissions. Note: if you attempt to pass a
+     * {@link PermissionDefinition} object, you will get a compilation error. Instead, pass the plain
+     * string version. For example, if the permission is defined as:
+     *
+     * ```ts
+     * export const MyPermission = new PermissionDefinition('ProductReview');
+     * ```
+     * then the generated permission strings will be:
+     *
+     * - `CreateProductReview`
+     * - `ReadProductReview`
+     * - `UpdateProductReview`
+     * - `DeleteProductReview`
+     */
+    requiresPermission?: string | string[];
+}
+/**
+ * @description
+ * A function which returns the router link for an {@link ActionBarItem} or {@link NavMenuItem}.
+ *
+ * @docsCategory action-bar
+ */
+export type RouterLinkDefinition = ((route: ActivatedRoute, context: ActionBarContext) => any[]) | any[];