@vendure/admin-ui 1.3.4 → 1.4.2

package/core/common/utilities/get-default-ui-language.d.ts

@@ -1,2 +1,3 @@
 import { LanguageCode } from '../generated-types';
 export declare function getDefaultUiLanguage(): LanguageCode;
+export declare function getDefaultUiLocale(): string | undefined;

package/core/common/version.d.ts

@@ -1 +1 @@
-export declare const ADMIN_UI_VERSION = "1.3.4";
+export declare const ADMIN_UI_VERSION = "1.4.2";

package/core/components/app-shell/app-shell.component.d.ts

@@ -15,7 +15,7 @@ export declare class AppShellComponent implements OnInit {
     private modalService;
     private localStorageService;
     userName$: Observable<string>;
-    uiLanguage$: Observable<LanguageCode>;
+    uiLanguageAndLocale$: Observable<[LanguageCode, string | undefined]>;
     availableLanguages: LanguageCode[];
     constructor(authService: AuthService, dataService: DataService, router: Router, i18nService: I18nService, modalService: ModalService, localStorageService: LocalStorageService);
     ngOnInit(): void;

package/core/components/ui-language-switcher-dialog/ui-language-switcher-dialog.component.d.ts

@@ -1,8 +1,21 @@
-import { LanguageCode } from '../../common/generated-types';
+import { OnInit } from '@angular/core';
+import { CurrencyCode, LanguageCode } from '../../common/generated-types';
 import { Dialog } from '../../providers/modal/modal.service';
-export declare class UiLanguageSwitcherDialogComponent implements Dialog<LanguageCode> {
-    resolveWith: (result?: LanguageCode) => void;
+export declare class UiLanguageSwitcherDialogComponent implements Dialog<[LanguageCode, string | undefined]>, OnInit {
+    resolveWith: (result?: [LanguageCode, string | undefined]) => void;
     currentLanguage: LanguageCode;
     availableLanguages: LanguageCode[];
-    setLanguage(languageCode: LanguageCode): void;
+    currentLocale: string | undefined;
+    availableLocales: string[];
+    availableCurrencyCodes: CurrencyCode[];
+    selectedCurrencyCode: string;
+    previewLocale: string;
+    readonly browserDefaultLocale: string | undefined;
+    readonly now: string;
+    constructor();
+    ngOnInit(): void;
+    updatePreviewLocale(): void;
+    setLanguage(): void;
+    cancel(): void;
+    private createLocaleString;
 }

package/core/components/user-menu/user-menu.component.d.ts

@@ -3,7 +3,7 @@ import { LanguageCode } from '../../common/generated-types';
 export declare class UserMenuComponent {
     userName: string;
     availableLanguages: LanguageCode[];
-    uiLanguage: LanguageCode;
+    uiLanguageAndLocale: [LanguageCode, string | undefined];
     logOut: EventEmitter<void>;
     selectUiLanguage: EventEmitter<void>;
 }

package/core/data/client-state/client-defaults.d.ts

@@ -14,5 +14,5 @@ export declare function getClientDefaults(localStorageService: LocalStorageServi
     };
     uiState: {
         __typename?: "UiState" | undefined;
-    } & Pick<import("../../common/generated-types").UiState, "language" | "contentLanguage" | "theme">;
+    } & Pick<import("../../common/generated-types").UiState, "language" | "locale" | "contentLanguage" | "theme" | "displayUiExtensionPoints">;
 };

package/core/data/definitions/client-definitions.d.ts

@@ -3,7 +3,9 @@ export declare const REQUEST_COMPLETED: import("graphql").DocumentNode;
 export declare const USER_STATUS_FRAGMENT: import("graphql").DocumentNode;
 export declare const SET_AS_LOGGED_IN: import("graphql").DocumentNode;
 export declare const SET_AS_LOGGED_OUT: import("graphql").DocumentNode;
-export declare const SET_UI_LANGUAGE: import("graphql").DocumentNode;
+export declare const SET_UI_LANGUAGE_AND_LOCALE: import("graphql").DocumentNode;
+export declare const SET_UI_LOCALE: import("graphql").DocumentNode;
+export declare const SET_DISPLAY_UI_EXTENSION_POINTS: import("graphql").DocumentNode;
 export declare const SET_CONTENT_LANGUAGE: import("graphql").DocumentNode;
 export declare const SET_UI_THEME: import("graphql").DocumentNode;
 export declare const GET_NEWTORK_STATUS: import("graphql").DocumentNode;

package/core/data/definitions/customer-definitions.d.ts

@@ -1,5 +1,6 @@
 export declare const ADDRESS_FRAGMENT: import("graphql").DocumentNode;
 export declare const CUSTOMER_FRAGMENT: import("graphql").DocumentNode;
+export declare const CUSTOMER_GROUP_FRAGMENT: import("graphql").DocumentNode;
 export declare const GET_CUSTOMER_LIST: import("graphql").DocumentNode;
 export declare const GET_CUSTOMER: import("graphql").DocumentNode;
 export declare const CREATE_CUSTOMER: import("graphql").DocumentNode;

package/core/data/definitions/settings-definitions.d.ts

@@ -21,6 +21,7 @@ export declare const UPDATE_TAX_CATEGORY: import("graphql").DocumentNode;
 export declare const DELETE_TAX_CATEGORY: import("graphql").DocumentNode;
 export declare const TAX_RATE_FRAGMENT: import("graphql").DocumentNode;
 export declare const GET_TAX_RATE_LIST: import("graphql").DocumentNode;
+export declare const GET_TAX_RATE_LIST_SIMPLE: import("graphql").DocumentNode;
 export declare const GET_TAX_RATE: import("graphql").DocumentNode;
 export declare const CREATE_TAX_RATE: import("graphql").DocumentNode;
 export declare const UPDATE_TAX_RATE: import("graphql").DocumentNode;

package/core/data/providers/client-data.service.d.ts

@@ -14,9 +14,11 @@ export declare class ClientDataService {
     logOut(): import("rxjs").Observable<unknown>;
     userStatus(): import("../query-result").QueryResult<import("../../common/generated-types").GetUserStatusQuery, Record<string, any>>;
     uiState(): import("../query-result").QueryResult<import("../../common/generated-types").GetUiStateQuery, Record<string, any>>;
-    setUiLanguage(languageCode: LanguageCode): import("rxjs").Observable<import("../../common/generated-types").SetUiLanguageMutation>;
+    setUiLanguage(languageCode: LanguageCode, locale?: string): import("rxjs").Observable<import("../../common/generated-types").SetUiLanguageMutation>;
+    setUiLocale(locale: string | undefined): import("rxjs").Observable<import("../../common/generated-types").SetUiLocaleMutation>;
     setContentLanguage(languageCode: LanguageCode): import("rxjs").Observable<import("../../common/generated-types").SetContentLanguageMutation>;
     setUiTheme(theme: string): import("rxjs").Observable<import("../../common/generated-types").SetUiThemeMutation>;
+    setDisplayUiExtensionPoints(display: boolean): import("rxjs").Observable<import("../../common/generated-types").SetDisplayUiExtensionPointsMutation>;
     setActiveChannel(channelId: string): import("rxjs").Observable<import("../../common/generated-types").SetActiveChannelMutation>;
     updateUserChannels(channels: CurrentUserChannelInput[]): import("rxjs").Observable<import("../../common/generated-types").UpdateUserChannelsMutation>;
 }

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

@@ -14,26 +14,68 @@ import { ProductDataService } from './product-data.service';
 import { PromotionDataService } from './promotion-data.service';
 import { SettingsDataService } from './settings-data.service';
 import { ShippingMethodDataService } from './shipping-method-data.service';
+/**
+ * @description
+ * Used to interact with the Admin API via GraphQL queries. Internally this service uses the
+ * Apollo Client, which means it maintains a normalized entity cache. For this reason, it is
+ * advisable to always select the `id` field of any entity, which will allow the returned data
+ * to be effectively cached.
+ *
+ * @docsCategory providers
+ * @docsPage DataService
+ * @docsWeight 0
+ */
 export declare class DataService {
     private baseDataService;
-    promotion: PromotionDataService;
-    administrator: AdministratorDataService;
-    auth: AuthDataService;
-    collection: CollectionDataService;
-    product: ProductDataService;
-    client: ClientDataService;
-    facet: FacetDataService;
-    order: OrderDataService;
-    settings: SettingsDataService;
-    customer: CustomerDataService;
-    shippingMethod: ShippingMethodDataService;
+    /** @internal */ promotion: PromotionDataService;
+    /** @internal */ administrator: AdministratorDataService;
+    /** @internal */ auth: AuthDataService;
+    /** @internal */ collection: CollectionDataService;
+    /** @internal */ product: ProductDataService;
+    /** @internal */ client: ClientDataService;
+    /** @internal */ facet: FacetDataService;
+    /** @internal */ order: OrderDataService;
+    /** @internal */ settings: SettingsDataService;
+    /** @internal */ customer: CustomerDataService;
+    /** @internal */ shippingMethod: ShippingMethodDataService;
+    /** @internal */
     constructor(baseDataService: BaseDataService);
     /**
-     * Perform a GraphQL query.
+     * @description
+     * Perform a GraphQL query. Returns a {@link QueryResult} which allows further control over
+     * they type of result returned, e.g. stream of values, single value etc.
+     *
+     * @example
+     * ```TypeScript
+     * const result$ = this.dataService.query(gql`
+     *   query MyQuery($id: ID!) {
+     *     product(id: $id) {
+     *       id
+     *       name
+     *       slug
+     *     }
+     *   },
+     *   { id: 123 },
+     * ).mapSingle(data => data.product);
+     * ```
      */
     query<T, V = Record<string, any>>(query: DocumentNode, variables?: V, fetchPolicy?: WatchQueryFetchPolicy): QueryResult<T, V>;
     /**
+     * @description
      * Perform a GraphQL mutation.
+     *
+     * @example
+     * ```TypeScript
+     * const result$ = this.dataService.mutate(gql`
+     *   mutation MyMutation($input: UpdateEntityInput!) {
+     *     updateEntity(input: $input) {
+     *       id
+     *       name
+     *     }
+     *   },
+     *   { input: updateEntityInput },
+     * );
+     * ```
      */
     mutate<T, V = Record<string, any>>(mutation: DocumentNode, variables?: V, update?: MutationUpdaterFn<T>): Observable<T>;
 }

package/core/data/providers/settings-data.service.d.ts

@@ -33,6 +33,9 @@ export declare class SettingsDataService {
     getTaxRates(take?: number, skip?: number, fetchPolicy?: FetchPolicy): import("../query-result").QueryResult<import("../../common/generated-types").GetTaxRateListQuery, import("../../common/generated-types").Exact<{
         options?: import("../../common/generated-types").Maybe<import("../../common/generated-types").TaxRateListOptions> | undefined;
     }>>;
+    getTaxRatesSimple(take?: number, skip?: number, fetchPolicy?: FetchPolicy): import("../query-result").QueryResult<import("../../common/generated-types").GetTaxRateListSimpleQuery, import("../../common/generated-types").Exact<{
+        options?: import("../../common/generated-types").Maybe<import("../../common/generated-types").TaxRateListOptions> | undefined;
+    }>>;
     getTaxRate(id: string): import("../query-result").QueryResult<import("../../common/generated-types").GetTaxRateQuery, import("../../common/generated-types").Exact<{
         id: string;
     }>>;

package/core/data/query-result.d.ts

@@ -1,8 +1,12 @@
 import { Apollo, QueryRef } from 'apollo-angular';
 import { Observable, Subject } from 'rxjs';
 /**
+ * @description
  * This class wraps the Apollo Angular QueryRef object and exposes some getters
  * for convenience.
+ *
+ * @docsCategory providers
+ * @docsPage DataService
  */
 export declare class QueryResult<T, V = Record<string, any>> {
     private queryRef;
@@ -11,23 +15,28 @@ export declare class QueryResult<T, V = Record<string, any>> {
     completed$: Subject<unknown>;
     private valueChanges;
     /**
-     * Refetch this query whenever the active Channel changes.
+     * @description
+     * Re-fetch this query whenever the active Channel changes.
      */
-    refetchOnChannelChange(): this;
+    refetchOnChannelChange(): QueryResult<T, V>;
     /**
+     * @description
      * Returns an Observable which emits a single result and then completes.
      */
     get single$(): Observable<T>;
     /**
+     * @description
      * Returns an Observable which emits until unsubscribed.
      */
     get stream$(): Observable<T>;
     get ref(): QueryRef<T, V>;
     /**
+     * @description
      * Returns a single-result Observable after applying the map function.
      */
     mapSingle<R>(mapFn: (item: T) => R): Observable<R>;
     /**
+     * @description
      * Returns a multiple-result Observable after applying the map function.
      */
     mapStream<R>(mapFn: (item: T) => R): Observable<R>;

package/core/providers/custom-detail-component/custom-detail-component-types.d.ts

@@ -0,0 +1,25 @@
+import { Type } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { Observable } from 'rxjs';
+import { CustomDetailComponentLocationId } from '../../common/component-registry-types';
+/**
+ * @description
+ * CustomDetailComponents allow any arbitrary Angular components to be embedded in entity detail
+ * pages of the Admin UI.
+ *
+ * @docsCategory custom-detail-components
+ */
+export interface CustomDetailComponent {
+    entity$: Observable<any>;
+    detailForm: FormGroup;
+}
+/**
+ * @description
+ * Configures a {@link CustomDetailComponent} to be placed in the given location.
+ *
+ * @docsCategory custom-detail-components
+ */
+export interface CustomDetailComponentConfig {
+    locationId: CustomDetailComponentLocationId;
+    component: Type<CustomDetailComponent>;
+}

package/core/providers/custom-detail-component/custom-detail-component.service.d.ts

@@ -0,0 +1,15 @@
+import { Provider } from '@angular/core';
+import { CustomDetailComponentConfig } from './custom-detail-component-types';
+/**
+ * @description
+ * Registers a {@link CustomDetailComponent} to be placed in a given location. This allows you
+ * to embed any type of custom Angular component in the entity detail pages of the Admin UI.
+ *
+ * @docsCategory custom-detail-components
+ */
+export declare function registerCustomDetailComponent(config: CustomDetailComponentConfig): Provider;
+export declare class CustomDetailComponentService {
+    private customDetailComponents;
+    registerCustomDetailComponent(config: CustomDetailComponentConfig): void;
+    getCustomDetailComponentsFor(locationId: string): CustomDetailComponentConfig[];
+}

package/core/providers/custom-field-component/custom-field-component.service.d.ts

@@ -1,4 +1,3 @@
-import { ComponentFactoryResolver } from '@angular/core';
 import { Type } from '@vendure/common/lib/shared-types';
 import { FormInputComponent } from '../../common/component-registry-types';
 import { CustomFields, CustomFieldsFragment } from '../../common/generated-types';
@@ -9,11 +8,12 @@ export interface CustomFieldControl extends FormInputComponent<CustomFieldConfig
 export declare type CustomFieldEntityName = Exclude<keyof CustomFields, '__typename'>;
 /**
  * This service allows the registration of custom controls for customFields.
+ *
+ * @deprecated The ComponentRegistryService now handles custom field components directly.
  */
 export declare class CustomFieldComponentService {
-    private componentFactoryResolver;
     private componentRegistryService;
-    constructor(componentFactoryResolver: ComponentFactoryResolver, componentRegistryService: ComponentRegistryService);
+    constructor(componentRegistryService: ComponentRegistryService);
     /**
      * Register a CustomFieldControl component to be used with the specified customField and entity.
      */

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

@@ -5,6 +5,7 @@ export declare type LocalStorageTypeMap = {
     activeChannelToken: string;
     authToken: string;
     uiLanguageCode: LanguageCode;
+    uiLocale: string | undefined;
     contentLanguageCode: LanguageCode;
     orderListLastCustomFilters: any;
     dashboardWidgetLayout: WidgetLayoutDefinition;

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

@@ -3,11 +3,16 @@ import { Type } from '@vendure/common/lib/shared-types';
 import { Observable } from 'rxjs';
 import { OverlayHostService } from '../overlay-host/overlay-host.service';
 /**
+ * @description
  * Any component intended to be used with the ModalService.fromComponent() method must implement
  * this interface.
+ *
+ * @docsCategory providers
+ * @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.
@@ -20,7 +25,11 @@ export interface DialogButtonConfig<T> {
     returnValue?: T;
 }
 /**
+ * @description
  * Configures a generic modal dialog.
+ *
+ * @docsCategory providers
+ * @docsPage ModalService
  */
 export interface DialogConfig<T> {
     title: string;
@@ -31,38 +40,56 @@ export interface DialogConfig<T> {
     buttons: Array<DialogButtonConfig<T>>;
 }
 /**
+ * @description
  * Options to configure the behaviour of the modal.
+ *
+ * @docsCategory providers
+ * @docsPage ModalService
  */
 export interface ModalOptions<T> {
-    /** Sets the width of the dialog */
+    /**
+     * @description
+     * Sets the width of the dialog
+     */
     size?: 'sm' | 'md' | 'lg' | 'xl';
-    /** Sets the vertical alignment of the dialog */
+    /**
+     * @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;
     /**
-     * Values to be passed directly to the component.
+     * @description
+     * Values to be passed directly to the component being instantiated inside the dialog.
      */
     locals?: Partial<T>;
 }
 /**
+ * @description
  * This service is responsible for instantiating a ModalDialog component and
  * embedding the specified component within.
+ *
+ * @docsCategory providers
+ * @docsPage ModalService
+ * @docsWeight 0
  */
 export declare class ModalService {
     private componentFactoryResolver;
     private overlayHostService;
     constructor(componentFactoryResolver: ComponentFactoryResolver, 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
-     * ```
+     * ```HTML
      * class MyDialog implements Dialog {
      *  resolveWith: (result?: any) => void;
      *
@@ -78,25 +105,27 @@ export declare class ModalService {
      * }
      * ```
      *
-     * ```
+     * @example
+     * ```HTML
      * <ng-template vdrDialogTitle>Title of the modal</ng-template>
      *
      * <p>
-     *     My Content
+     *   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>
+     *   <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>;

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

@@ -1,15 +1,21 @@
 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 declare 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.
@@ -17,8 +23,11 @@ export interface NavMenuBadge {
     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;
@@ -33,8 +42,11 @@ export interface NavMenuItem {
     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;
@@ -48,7 +60,10 @@ export interface NavMenuSection {
     collapsedByDefault?: boolean;
 }
 /**
+ * @description
  * Utilities available to the onClick handler of an ActionBarItem.
+ *
+ * @docsCategory action-bar
  */
 export interface OnClickContext {
     route: ActivatedRoute;
@@ -56,12 +71,15 @@ export interface OnClickContext {
     notificationService: NotificationService;
 }
 /**
+ * @description
  * A button in the ActionBar area at the top of one of the list or detail views.
+ *
+ * @docsCategory action-bar
  */
 export interface ActionBarItem {
     id: string;
     label: string;
-    locationId: string;
+    locationId: ActionBarLocationId;
     disabled?: Observable<boolean>;
     onClick?: (event: MouseEvent, context: OnClickContext) => void;
     routerLink?: RouterLinkDefinition;

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

@@ -16,16 +16,18 @@ import { ActionBarItem, NavMenuBadgeType, NavMenuItem, NavMenuSection, RouterLin
  *   imports: [SharedModule],
  *   providers: [
  *     addNavMenuSection({
- *       id: 'reviews',
- *       label: 'Product Reviews',
- *       routerLink: ['/extensions/reviews'],
- *       icon: 'star',
+ *       id: 'reports',
+ *       label: 'Reports',
+ *       items: [{
+ *           // ...
+ *       }],
  *     },
  *     'settings'),
  *   ],
  * })
  * export class MyUiExtensionModule {}
  * ```
+ * @docsCategory nav-menu
  */
 export declare function addNavMenuSection(config: NavMenuSection, before?: string): Provider;
 /**
@@ -44,17 +46,18 @@ export declare function addNavMenuSection(config: NavMenuSection, before?: strin
  *   imports: [SharedModule],
  *   providers: [
  *     addNavMenuItem({
- *       id: 'reports',
- *       label: 'Reports',
- *       items: [{
- *           // ...
- *       }],
+ *       id: 'reviews',
+ *       label: 'Product Reviews',
+ *       routerLink: ['/extensions/reviews'],
+ *       icon: 'star',
  *     },
  *     'marketing'),
  *   ],
  * })
  * export class MyUiExtensionModule {}
- * ```
+ * ``
+ *
+ * @docsCategory nav-menu
  */
 export declare function addNavMenuItem(config: NavMenuItem, sectionId: string, before?: string): Provider;
 /**
@@ -80,6 +83,7 @@ export declare function addNavMenuItem(config: NavMenuItem, sectionId: string, b
  * })
  * export class MyUiExtensionModule {}
  * ```
+ * @docsCategory action-bar
  */
 export declare function addActionBarItem(config: ActionBarItem): Provider;
 /**

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

@@ -1,7 +1,21 @@
 import { ComponentFactoryResolver } from '@angular/core';
 import { I18nService } from '../i18n/i18n.service';
 import { OverlayHostService } from '../overlay-host/overlay-host.service';
+/**
+ * @description
+ * The types of notification available.
+ *
+ * @docsCategory providers
+ * @docsPage NotificationService
+ */
 export declare type NotificationType = 'info' | 'success' | 'error' | 'warning';
+/**
+ * @description
+ * Configuration for a toast notification.
+ *
+ * @docsCategory providers
+ * @docsPage NotificationService
+ */
 export interface ToastConfig {
     message: string;
     translationVars?: {
@@ -11,7 +25,25 @@ export interface ToastConfig {
     duration?: number;
 }
 /**
+ * @description
  * Provides toast notification functionality.
+ *
+ * @example
+ * ```TypeScript
+ * class MyComponent {
+ *   constructor(private notificationService: NotificationService) {}
+ *
+ *   save() {
+ *     this.notificationService
+ *         .success(_('asset.notify-create-assets-success'), {
+ *           count: successCount,
+ *         });
+ *   }
+ * }
+ *
+ * @docsCategory providers
+ * @docsPage NotificationService
+ * @docsWeight 0
  */
 export declare class NotificationService {
     private i18nService;
@@ -21,30 +53,35 @@ export declare class NotificationService {
     private openToastRefs;
     constructor(i18nService: I18nService, resolver: ComponentFactoryResolver, overlayHostService: OverlayHostService);
     /**
+     * @description
      * Display a success toast notification
      */
     success(message: string, translationVars?: {
         [key: string]: string | number;
     }): void;
     /**
+     * @description
      * Display an info toast notification
      */
     info(message: string, translationVars?: {
         [key: string]: string | number;
     }): void;
     /**
+     * @description
      * Display a warning toast notification
      */
     warning(message: string, translationVars?: {
         [key: string]: string | number;
     }): void;
     /**
+     * @description
      * Display an error toast notification
      */
     error(message: string, translationVars?: {
         [key: string]: string | number;
     }): void;
     /**
+     * @description
      * Display a toast notification.
      */
     notify(config: ToastConfig): void;