@vendure/admin-ui 2.2.0-next.6 → 2.2.0-next.7

package/catalog/catalog.module.d.ts

@@ -7,8 +7,8 @@ import * as i4 from "./components/facet-detail/facet-detail.component";
 import * as i5 from "./components/generate-product-variants/generate-product-variants.component";
 import * as i6 from "./components/apply-facet-dialog/apply-facet-dialog.component";
 import * as i7 from "./components/asset-list/asset-list.component";
-import * as i8 from "./components/assets/assets.component";
-import * as i9 from "./components/variant-price-detail/variant-price-detail.component";
+import * as i8 from "./components/variant-price-detail/variant-price-detail.component";
+import * as i9 from "./components/variant-price-strategy-detail/variant-price-strategy-detail.component";
 import * as i10 from "./components/collection-list/collection-list.component";
 import * as i11 from "./components/collection-detail/collection-detail.component";
 import * as i12 from "./components/collection-tree/collection-tree.component";
@@ -38,6 +38,6 @@ export declare class CatalogModule {
     private static hasRegisteredTabsAndBulkActions;
     constructor(bulkActionRegistryService: BulkActionRegistryService, pageService: PageService);
     static ɵfac: i0.ɵɵFactoryDeclaration<CatalogModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<CatalogModule, [typeof i1.ProductListComponent, typeof i2.ProductDetailComponent, typeof i3.FacetListComponent, typeof i4.FacetDetailComponent, typeof i5.GenerateProductVariantsComponent, typeof i6.ApplyFacetDialogComponent, typeof i7.AssetListComponent, typeof i8.AssetsComponent, typeof i9.VariantPriceDetailComponent, typeof i10.CollectionListComponent, typeof i11.CollectionDetailComponent, typeof i12.CollectionTreeComponent, typeof i13.CollectionTreeNodeComponent, typeof i14.CollectionContentsComponent, typeof i15.ProductVariantsTableComponent, typeof i16.OptionValueInputComponent, typeof i17.UpdateProductOptionDialogComponent, typeof i18.ProductVariantsEditorComponent, typeof i19.AssignProductsToChannelDialogComponent, typeof i20.AssetDetailComponent, typeof i21.ConfirmVariantDeletionDialogComponent, typeof i22.ProductOptionsEditorComponent, typeof i23.BulkAddFacetValuesDialogComponent, typeof i24.CollectionDataTableComponent, typeof i25.CollectionBreadcrumbPipe, typeof i26.MoveCollectionsDialogComponent, typeof i27.ProductVariantListComponent, typeof i2.ProductDetailComponent, typeof i28.ProductVariantDetailComponent, typeof i29.CreateProductVariantDialogComponent, typeof i30.CreateProductOptionGroupDialogComponent, typeof i31.ProductVariantQuickJumpComponent, typeof i32.CreateFacetValueDialogComponent], [typeof i33.SharedModule, typeof i34.RouterModule], [typeof i1.ProductListComponent, typeof i2.ProductDetailComponent, typeof i3.FacetListComponent, typeof i4.FacetDetailComponent, typeof i5.GenerateProductVariantsComponent, typeof i6.ApplyFacetDialogComponent, typeof i7.AssetListComponent, typeof i8.AssetsComponent, typeof i9.VariantPriceDetailComponent, typeof i10.CollectionListComponent, typeof i11.CollectionDetailComponent, typeof i12.CollectionTreeComponent, typeof i13.CollectionTreeNodeComponent, typeof i14.CollectionContentsComponent, typeof i15.ProductVariantsTableComponent, typeof i16.OptionValueInputComponent, typeof i17.UpdateProductOptionDialogComponent, typeof i18.ProductVariantsEditorComponent, typeof i19.AssignProductsToChannelDialogComponent, typeof i20.AssetDetailComponent, typeof i21.ConfirmVariantDeletionDialogComponent, typeof i22.ProductOptionsEditorComponent, typeof i23.BulkAddFacetValuesDialogComponent, typeof i24.CollectionDataTableComponent, typeof i25.CollectionBreadcrumbPipe, typeof i26.MoveCollectionsDialogComponent, typeof i27.ProductVariantListComponent, typeof i2.ProductDetailComponent, typeof i28.ProductVariantDetailComponent, typeof i29.CreateProductVariantDialogComponent, typeof i30.CreateProductOptionGroupDialogComponent, typeof i31.ProductVariantQuickJumpComponent, typeof i32.CreateFacetValueDialogComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<CatalogModule, [typeof i1.ProductListComponent, typeof i2.ProductDetailComponent, typeof i3.FacetListComponent, typeof i4.FacetDetailComponent, typeof i5.GenerateProductVariantsComponent, typeof i6.ApplyFacetDialogComponent, typeof i7.AssetListComponent, typeof i8.VariantPriceDetailComponent, typeof i9.VariantPriceStrategyDetailComponent, typeof i10.CollectionListComponent, typeof i11.CollectionDetailComponent, typeof i12.CollectionTreeComponent, typeof i13.CollectionTreeNodeComponent, typeof i14.CollectionContentsComponent, typeof i15.ProductVariantsTableComponent, typeof i16.OptionValueInputComponent, typeof i17.UpdateProductOptionDialogComponent, typeof i18.ProductVariantsEditorComponent, typeof i19.AssignProductsToChannelDialogComponent, typeof i20.AssetDetailComponent, typeof i21.ConfirmVariantDeletionDialogComponent, typeof i22.ProductOptionsEditorComponent, typeof i23.BulkAddFacetValuesDialogComponent, typeof i24.CollectionDataTableComponent, typeof i25.CollectionBreadcrumbPipe, typeof i26.MoveCollectionsDialogComponent, typeof i27.ProductVariantListComponent, typeof i2.ProductDetailComponent, typeof i28.ProductVariantDetailComponent, typeof i29.CreateProductVariantDialogComponent, typeof i30.CreateProductOptionGroupDialogComponent, typeof i31.ProductVariantQuickJumpComponent, typeof i32.CreateFacetValueDialogComponent], [typeof i33.SharedModule, typeof i34.RouterModule], [typeof i1.ProductListComponent, typeof i2.ProductDetailComponent, typeof i3.FacetListComponent, typeof i4.FacetDetailComponent, typeof i5.GenerateProductVariantsComponent, typeof i6.ApplyFacetDialogComponent, typeof i7.AssetListComponent, typeof i8.VariantPriceDetailComponent, typeof i9.VariantPriceStrategyDetailComponent, typeof i10.CollectionListComponent, typeof i11.CollectionDetailComponent, typeof i12.CollectionTreeComponent, typeof i13.CollectionTreeNodeComponent, typeof i14.CollectionContentsComponent, typeof i15.ProductVariantsTableComponent, typeof i16.OptionValueInputComponent, typeof i17.UpdateProductOptionDialogComponent, typeof i18.ProductVariantsEditorComponent, typeof i19.AssignProductsToChannelDialogComponent, typeof i20.AssetDetailComponent, typeof i21.ConfirmVariantDeletionDialogComponent, typeof i22.ProductOptionsEditorComponent, typeof i23.BulkAddFacetValuesDialogComponent, typeof i24.CollectionDataTableComponent, typeof i25.CollectionBreadcrumbPipe, typeof i26.MoveCollectionsDialogComponent, typeof i27.ProductVariantListComponent, typeof i2.ProductDetailComponent, typeof i28.ProductVariantDetailComponent, typeof i29.CreateProductVariantDialogComponent, typeof i30.CreateProductOptionGroupDialogComponent, typeof i31.ProductVariantQuickJumpComponent, typeof i32.CreateFacetValueDialogComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<CatalogModule>;
 }

package/catalog/components/variant-price-strategy-detail/variant-price-strategy-detail.component.d.ts

@@ -0,0 +1,10 @@
+import { CurrencyCode, ProductVariantDetailQueryProductVariantFragmentFragment } from '@vendure/admin-ui/core';
+import * as i0 from "@angular/core";
+export declare class VariantPriceStrategyDetailComponent {
+    channelPriceIncludesTax: boolean;
+    variant: ProductVariantDetailQueryProductVariantFragmentFragment;
+    channelDefaultCurrencyCode: CurrencyCode;
+    calculatedPriceDiffersFromInputPrice(): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<VariantPriceStrategyDetailComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<VariantPriceStrategyDetailComponent, "vdr-variant-price-strategy-detail", never, { "channelPriceIncludesTax": { "alias": "channelPriceIncludesTax"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "channelDefaultCurrencyCode": { "alias": "channelDefaultCurrencyCode"; "required": false; }; }, {}, never, never, false, never>;
+}

package/catalog/public_api.d.ts

@@ -3,7 +3,6 @@ export * from './catalog.routes';
 export * from './components/apply-facet-dialog/apply-facet-dialog.component';
 export * from './components/asset-detail/asset-detail.component';
 export * from './components/asset-list/asset-list.component';
-export * from './components/assets/assets.component';
 export * from './components/assign-products-to-channel-dialog/assign-products-to-channel-dialog.component';
 export * from './components/bulk-add-facet-values-dialog/bulk-add-facet-values-dialog.component';
 export * from './components/bulk-add-facet-values-dialog/bulk-add-facet-values-dialog.graphql';
@@ -43,6 +42,7 @@ export * from './components/product-variants-editor/product-variants-editor.comp
 export * from './components/product-variants-table/product-variants-table.component';
 export * from './components/update-product-option-dialog/update-product-option-dialog.component';
 export * from './components/variant-price-detail/variant-price-detail.component';
+export * from './components/variant-price-strategy-detail/variant-price-strategy-detail.component';
 export * from './providers/product-detail/product-detail.service';
 export * from './providers/product-detail/replace-last';
 export * from './providers/routing/product-variants-resolver';

package/core/common/generated-types.d.ts

@@ -583,6 +583,12 @@ export type CoordinateInput = {
     x: Scalars['Float']['input'];
     y: Scalars['Float']['input'];
 };
+/**
+ * A Country of the world which your shop operates in.
+ *
+ * The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
+ * `UpdateAddressInput` and `CreateAddressInput` to specify the country.
+ */
 export type Country = Node & Region & {
     __typename?: 'Country';
     code: Scalars['String']['output'];
@@ -665,6 +671,13 @@ export type CouponCodeLimitError = ErrorResult & {
     limit: Scalars['Int']['output'];
     message: Scalars['String']['output'];
 };
+/**
+ * Input used to create an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type CreateAddressInput = {
     city?: InputMaybe<Scalars['String']['input']>;
     company?: InputMaybe<Scalars['String']['input']>;
@@ -5480,6 +5493,13 @@ export type UpdateActiveAdministratorInput = {
     lastName?: InputMaybe<Scalars['String']['input']>;
     password?: InputMaybe<Scalars['String']['input']>;
 };
+/**
+ * Input used to update an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type UpdateAddressInput = {
     city?: InputMaybe<Scalars['String']['input']>;
     company?: InputMaybe<Scalars['String']['input']>;

package/core/common/version.d.ts

@@ -1 +1 @@
-export declare const ADMIN_UI_VERSION = "2.2.0-next.6";
+export declare const ADMIN_UI_VERSION = "2.2.0-next.7";

package/core/core.module.d.ts

@@ -1,12 +1,10 @@
 import { PlatformLocation } from '@angular/common';
 import { HttpClient } from '@angular/common/http';
 import { Title } from '@angular/platform-browser';
-import { DataService } from './data/providers/data.service';
 import { AlertsService } from './providers/alerts/alerts.service';
 import { CustomHttpTranslationLoader } from './providers/i18n/custom-http-loader';
 import { I18nService } from './providers/i18n/i18n.service';
 import { LocalStorageService } from './providers/local-storage/local-storage.service';
-import { NotificationService } from './providers/notification/notification.service';
 import * as i0 from "@angular/core";
 import * as i1 from "./components/app-shell/app-shell.component";
 import * as i2 from "./components/user-menu/user-menu.component";
@@ -30,9 +28,7 @@ export declare class CoreModule {
     private localStorageService;
     private titleService;
     private alertsService;
-    private dataService;
-    private notificationService;
-    constructor(i18nService: I18nService, localStorageService: LocalStorageService, titleService: Title, alertsService: AlertsService, dataService: DataService, notificationService: NotificationService);
+    constructor(i18nService: I18nService, localStorageService: LocalStorageService, titleService: Title, alertsService: AlertsService);
     private initUiLanguagesAndLocales;
     private initUiTitle;
     private initAlerts;

package/core/data/utils/is-entity-create-or-update-mutation.d.ts

@@ -0,0 +1,6 @@
+import { DocumentNode } from 'graphql';
+/**
+ * Checks the current documentNode for an operation with a variable named "Create<Entity>Input" or "Update<Entity>Input"
+ * and if a match is found, returns the <Entity> name.
+ */
+export declare function isEntityCreateOrUpdateMutation(documentNode: DocumentNode): string | undefined;

package/core/data/utils/remove-readonly-custom-fields.d.ts

@@ -1,4 +1,3 @@
-import { DocumentNode } from 'graphql';
 import { CustomFieldConfig } from '../../common/generated-types';
 type InputWithOptionalCustomFields = Record<string, any> & {
     customFields?: Record<string, any>;
@@ -6,18 +5,13 @@ type InputWithOptionalCustomFields = Record<string, any> & {
 type EntityInput = InputWithOptionalCustomFields & {
     translations?: InputWithOptionalCustomFields[];
 };
-/**
- * Checks the current documentNode for an operation with a variable named "Create<Entity>Input" or "Update<Entity>Input"
- * and if a match is found, returns the <Entity> name.
- */
-export declare function isEntityCreateOrUpdateMutation(documentNode: DocumentNode): string | undefined;
+type Variable = EntityInput | EntityInput[];
+type WrappedVariable = {
+    input: Variable;
+};
 /**
  * Removes any `readonly` custom fields from an entity (including its translations).
  * To be used before submitting the entity for a create or update request.
  */
-export declare function removeReadonlyCustomFields(variables: {
-    input?: EntityInput | EntityInput[];
-} | EntityInput | EntityInput[], customFieldConfig: CustomFieldConfig[]): {
-    input?: EntityInput | EntityInput[];
-} | EntityInput | EntityInput[];
+export declare function removeReadonlyCustomFields(variables: Variable | WrappedVariable | WrappedVariable[], customFieldConfig: CustomFieldConfig[]): any;
 export {};

package/core/extension/register-alert.d.ts

@@ -0,0 +1,11 @@
+import { FactoryProvider } from '@angular/core';
+import { AlertConfig } from '../providers/alerts/alerts.service';
+/**
+ * @description
+ * Registers an alert which can be displayed in the Admin UI alert dropdown in the top bar.
+ * The alert is configured using the {@link AlertConfig} object.
+ *
+ * @since 2.2.0
+ * @docsCategory alerts
+ */
+export declare function registerAlert(config: AlertConfig): FactoryProvider;

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

@@ -1,19 +1,113 @@
+import { Injector } from '@angular/core';
 import { Observable } from 'rxjs';
 import { Permission } from '../../common/generated-types';
+import { DataService } from '../../data/providers/data.service';
+import { ModalService } from '../modal/modal.service';
+import { NotificationService } from '../notification/notification.service';
 import { PermissionsService } from '../permissions/permissions.service';
 import * as i0 from "@angular/core";
+/**
+ * @description
+ * The context object which is passed to the `check`, `isAlert`, `label` and `action` functions of an
+ * {@link AlertConfig} object.
+ *
+ * @since 2.2.0
+ * @docsCategory alerts
+ */
+export interface AlertContext {
+    /**
+     * @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
+     * The [ModalService](/reference/admin-ui-api/services/modal-service), which provides methods for
+     * opening modal dialogs.
+     */
+    modalService: ModalService;
+}
+/**
+ * @description
+ * A configuration object for an Admin UI alert.
+ *
+ * @since 2.2.0
+ * @docsCategory alerts
+ */
 export interface AlertConfig<T = any> {
+    /**
+     * @description
+     * A unique identifier for the alert.
+     */
     id: string;
-    check: () => T | Promise<T> | Observable<T>;
-    recheckIntervalMs?: number;
-    isAlert: (value: T) => boolean;
-    action: (data: T) => void;
-    label: (data: T) => {
+    /**
+     * @description
+     * A function which is gets the data used to determine whether the alert should be shown.
+     * Typically, this function will query the server or some other remote data source.
+     *
+     * This function will be called once when the Admin UI app bootstraps, and can be also
+     * set to run at regular intervals by setting the `recheckIntervalMs` property.
+     */
+    check: (context: AlertContext) => T | Promise<T> | Observable<T>;
+    /**
+     * @description
+     * A function which returns an Observable which is used to determine when to re-run the `check`
+     * function. Whenever the observable emits, the `check` function will be called again.
+     *
+     * A basic time-interval-based recheck can be achieved by using the `interval` function from RxJS.
+     *
+     * @example
+     * ```ts
+     * import { interval } from 'rxjs';
+     *
+     * // ...
+     * recheck: () => interval(60_000)
+     * ```
+     *
+     * If this is not set, the `check` function will only be called once when the Admin UI app bootstraps.
+     *
+     * @default undefined
+     */
+    recheck?: (context: AlertContext) => Observable<any>;
+    /**
+     * @description
+     * A function which determines whether the alert should be shown based on the data returned by the `check`
+     * function.
+     */
+    isAlert: (data: T, context: AlertContext) => boolean;
+    /**
+     * @description
+     * A function which is called when the alert is clicked in the Admin UI.
+     */
+    action: (data: T, context: AlertContext) => void;
+    /**
+     * @description
+     * A function which returns the text used in the UI to describe the alert.
+     */
+    label: (data: T, context: AlertContext) => {
         text: string;
         translationVars?: {
             [key: string]: string | number;
         };
     };
+    /**
+     * @description
+     * A list of permissions which the current Administrator must have in order. If the current
+     * Administrator does not have these permissions, none of the other alert functions will be called.
+     */
     requiredPermissions?: Permission[];
 }
 export interface ActiveAlert {
@@ -29,22 +123,28 @@ export interface ActiveAlert {
 }
 export declare class Alert<T> {
     private config;
+    private context;
     activeAlert$: Observable<ActiveAlert | undefined>;
     private hasRun$;
     private data$;
-    constructor(config: AlertConfig<T>);
+    constructor(config: AlertConfig<T>, context: AlertContext);
     get id(): string;
     runCheck(): void;
 }
 export declare class AlertsService {
     private permissionsService;
+    private injector;
+    private dataService;
+    private notificationService;
+    private modalService;
     activeAlerts$: Observable<ActiveAlert[]>;
     private alertsMap;
     private configUpdated;
-    constructor(permissionsService: PermissionsService);
+    constructor(permissionsService: PermissionsService, injector: Injector, dataService: DataService, notificationService: NotificationService, modalService: ModalService);
     configureAlert<T>(config: AlertConfig<T>): void;
     hasSufficientPermissions(permissions?: Permission[]): Observable<boolean>;
     refresh(id?: string): void;
+    protected createContext(): AlertContext;
     static ɵfac: i0.ɵɵFactoryDeclaration<AlertsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AlertsService>;
 }

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

@@ -22,7 +22,7 @@ export declare class ModalService {
      * displayed in the modal dialog. See example:
      *
      * @example
-     * ```HTML
+     * ```ts
      * class MyDialog implements Dialog {
      *  resolveWith: (result?: any) => void;
      *
@@ -39,7 +39,7 @@ export declare class ModalService {
      * ```
      *
      * @example
-     * ```HTML
+     * ```html
      * <ng-template vdrDialogTitle>Title of the modal</ng-template>
      *
      * <p>

package/core/public_api.d.ts

@@ -71,6 +71,7 @@ export * from './data/query-result';
 export * from './data/server-config';
 export * from './data/utils/add-custom-fields';
 export * from './data/utils/get-server-location';
+export * from './data/utils/is-entity-create-or-update-mutation';
 export * from './data/utils/remove-readonly-custom-fields';
 export * from './data/utils/transform-relation-custom-field-inputs';
 export * from './extension/add-action-bar-dropdown-menu-item';
@@ -79,6 +80,7 @@ export * from './extension/add-nav-menu-item';
 export * from './extension/components/angular-route.component';
 export * from './extension/components/route.component';
 export * from './extension/providers/page-metadata.service';
+export * from './extension/register-alert';
 export * from './extension/register-bulk-action';
 export * from './extension/register-custom-detail-component';
 export * from './extension/register-dashboard-widget';
@@ -138,6 +140,7 @@ export * from './shared/components/asset-preview/asset-preview.component';
 export * from './shared/components/asset-preview-dialog/asset-preview-dialog.component';
 export * from './shared/components/asset-preview-links/asset-preview-links.component';
 export * from './shared/components/asset-search-input/asset-search-input.component';
+export * from './shared/components/assets/assets.component';
 export * from './shared/components/assign-to-channel-dialog/assign-to-channel-dialog.component';
 export * from './shared/components/bulk-action-menu/bulk-action-menu.component';
 export * from './shared/components/card/card.component';

package/{catalog → core/shared}/components/assets/assets.component.d.ts

@@ -1,6 +1,7 @@
 import { CdkDragDrop } from '@angular/cdk/drag-drop';
 import { ChangeDetectorRef, EventEmitter } from '@angular/core';
-import { Asset, ModalService, Permission } from '@vendure/admin-ui/core';
+import { Asset, Permission } from '../../../common/generated-types';
+import { ModalService } from '../../../providers/modal/modal.service';
 import * as i0 from "@angular/core";
 export interface AssetChange {
     assets: Asset[];