@vendure/admin-ui 1.3.4 → 1.4.2

package/core/public_api.d.ts

@@ -69,6 +69,8 @@ export * from './data/utils/remove-readonly-custom-fields';
 export * from './data/utils/transform-relation-custom-field-inputs';
 export * from './providers/auth/auth.service';
 export * from './providers/component-registry/component-registry.service';
+export * from './providers/custom-detail-component/custom-detail-component-types';
+export * from './providers/custom-detail-component/custom-detail-component.service';
 export * from './providers/custom-field-component/custom-field-component.service';
 export * from './providers/dashboard-widget/dashboard-widget-types';
 export * from './providers/dashboard-widget/dashboard-widget.service';
@@ -101,6 +103,7 @@ export * from './shared/components/channel-badge/channel-badge.component';
 export * from './shared/components/chip/chip.component';
 export * from './shared/components/configurable-input/configurable-input.component';
 export * from './shared/components/currency-input/currency-input.component';
+export * from './shared/components/custom-detail-component-host/custom-detail-component-host.component';
 export * from './shared/components/custom-field-control/custom-field-control.component';
 export * from './shared/components/customer-label/customer-label.component';
 export * from './shared/components/data-table/data-table-column.component';
@@ -157,16 +160,19 @@ export * from './shared/components/rich-text-editor/rich-text-editor.component';
 export * from './shared/components/select-toggle/select-toggle.component';
 export * from './shared/components/simple-dialog/simple-dialog.component';
 export * from './shared/components/status-badge/status-badge.component';
+export * from './shared/components/tabbed-custom-fields/tabbed-custom-fields.component';
 export * from './shared/components/table-row-action/table-row-action.component';
 export * from './shared/components/tag-selector/tag-selector.component';
 export * from './shared/components/timeline-entry/timeline-entry.component';
 export * from './shared/components/title-input/title-input.component';
+export * from './shared/components/ui-extension-point/ui-extension-point.component';
 export * from './shared/directives/disabled.directive';
 export * from './shared/directives/if-default-channel-active.directive';
 export * from './shared/directives/if-directive-base';
 export * from './shared/directives/if-multichannel.directive';
 export * from './shared/directives/if-permissions.directive';
 export * from './shared/dynamic-form-inputs/boolean-form-input/boolean-form-input.component';
+export * from './shared/dynamic-form-inputs/code-editor-form-input/json-editor-form-input.component';
 export * from './shared/dynamic-form-inputs/currency-form-input/currency-form-input.component';
 export * from './shared/dynamic-form-inputs/customer-group-form-input/customer-group-form-input.component';
 export * from './shared/dynamic-form-inputs/date-form-input/date-form-input.component';
@@ -183,6 +189,7 @@ export * from './shared/dynamic-form-inputs/relation-form-input/product-variant/
 export * from './shared/dynamic-form-inputs/relation-form-input/relation-card/relation-card.component';
 export * from './shared/dynamic-form-inputs/relation-form-input/relation-form-input.component';
 export * from './shared/dynamic-form-inputs/relation-form-input/relation-selector-dialog/relation-selector-dialog.component';
+export * from './shared/dynamic-form-inputs/rich-text-form-input/rich-text-form-input.component';
 export * from './shared/dynamic-form-inputs/select-form-input/select-form-input.component';
 export * from './shared/dynamic-form-inputs/text-form-input/text-form-input.component';
 export * from './shared/dynamic-form-inputs/textarea-form-input/textarea-form-input.component';
@@ -197,6 +204,7 @@ export * from './shared/pipes/locale-currency-name.pipe';
 export * from './shared/pipes/locale-currency.pipe';
 export * from './shared/pipes/locale-date.pipe';
 export * from './shared/pipes/locale-language-name.pipe';
+export * from './shared/pipes/locale-region-name.pipe';
 export * from './shared/pipes/sentence-case.pipe';
 export * from './shared/pipes/sort.pipe';
 export * from './shared/pipes/state-i18n-token.pipe';

package/core/shared/components/action-bar-items/action-bar-items.component.d.ts

@@ -1,6 +1,7 @@
 import { OnChanges, OnInit, SimpleChanges } 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 { ActionBarItem } from '../../../providers/nav-builder/nav-builder-types';
 import { NavBuilderService } from '../../../providers/nav-builder/nav-builder.service';
@@ -10,7 +11,7 @@ export declare class ActionBarItemsComponent implements OnInit, OnChanges {
     private route;
     private dataService;
     private notificationService;
-    locationId: string;
+    locationId: ActionBarLocationId;
     items$: Observable<ActionBarItem[]>;
     private locationId$;
     constructor(navBuilderService: NavBuilderService, route: ActivatedRoute, dataService: DataService, notificationService: NotificationService);

package/core/shared/components/asset-picker-dialog/asset-picker-dialog.component.d.ts

@@ -6,7 +6,25 @@ import { DataService } from '../../../data/providers/data.service';
 import { Dialog } from '../../../providers/modal/modal.service';
 import { NotificationService } from '../../../providers/notification/notification.service';
 /**
+ * @description
  * A dialog which allows the creation and selection of assets.
+ *
+ * @example
+ * ```TypeScript
+ * selectAssets() {
+ *   this.modalService
+ *     .fromComponent(AssetPickerDialogComponent, {
+ *         size: 'xl',
+ *     })
+ *     .subscribe(result => {
+ *         if (result && result.length) {
+ *             // ...
+ *         }
+ *     });
+ * }
+ * ```
+ *
+ * @docsCategory components
  */
 export declare class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Dialog<Asset[]> {
     private dataService;

package/core/shared/components/asset-preview/asset-preview.component.d.ts

@@ -35,7 +35,6 @@ export declare class AssetPreviewComponent implements OnInit, OnDestroy {
     get fpy(): number | null;
     ngOnInit(): void;
     ngOnDestroy(): void;
-    customFieldIsSet(name: string): boolean;
     getSourceFileName(): string;
     onImageLoad(): void;
     updateDimensions(): void;

package/core/shared/components/chip/chip.component.d.ts

@@ -1,15 +1,35 @@
 import { EventEmitter } from '@angular/core';
 /**
+ * @description
  * A chip component for displaying a label with an optional action icon.
+ *
+ * @example
+ * ```HTML
+ * <vdr-chip [colorFrom]="item.value"
+ *           icon="close"
+ *           (iconClick)="clear(item)">
+ * {{ item.value }}</vdr-chip>
+ * ```
+ * @docsCategory components
  */
 export declare class ChipComponent {
+    /**
+     * @description
+     * The icon should be the name of one of the available Clarity icons: https://clarity.design/foundation/icons/shapes/
+     *
+     */
     icon: string;
     invert: boolean;
     /**
+     * @description
      * If set, the chip will have an auto-generated background
      * color based on the string value passed in.
      */
     colorFrom: string;
+    /**
+     * @description
+     * The color of the chip can also be one of the standard status colors.
+     */
     colorType: 'error' | 'success' | 'warning';
     iconClick: EventEmitter<MouseEvent>;
 }

package/core/shared/components/currency-input/currency-input.component.d.ts

@@ -3,8 +3,19 @@ import { ControlValueAccessor } from '@angular/forms';
 import { Observable } from 'rxjs';
 import { DataService } from '../../../data/providers/data.service';
 /**
+ * @description
  * A form input control which displays currency in decimal format, whilst working
  * with the integer cent value in the background.
+ *
+ * @example
+ * ```HTML
+ * <vdr-currency-input
+ *     [(ngModel)]="entityPrice"
+ *     [currencyCode]="currencyCode"
+ * ></vdr-currency-input>
+ * ```
+ *
+ * @docsCategory components
  */
 export declare class CurrencyInputComponent implements ControlValueAccessor, OnInit, OnChanges, OnDestroy {
     private dataService;

package/core/shared/components/custom-detail-component-host/custom-detail-component-host.component.d.ts

@@ -0,0 +1,17 @@
+import { ComponentFactoryResolver, OnDestroy, OnInit, ViewContainerRef } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { Observable } from 'rxjs';
+import { CustomDetailComponentLocationId } from '../../../common/component-registry-types';
+import { CustomDetailComponentService } from '../../../providers/custom-detail-component/custom-detail-component.service';
+export declare class CustomDetailComponentHostComponent implements OnInit, OnDestroy {
+    private viewContainerRef;
+    private componentFactoryResolver;
+    private customDetailComponentService;
+    locationId: CustomDetailComponentLocationId;
+    entity$: Observable<any>;
+    detailForm: FormGroup;
+    private componentRefs;
+    constructor(viewContainerRef: ViewContainerRef, componentFactoryResolver: ComponentFactoryResolver, customDetailComponentService: CustomDetailComponentService);
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+}

package/core/shared/components/data-table/data-table.component.d.ts

@@ -1,5 +1,64 @@
 import { AfterContentInit, EventEmitter, QueryList, TemplateRef } from '@angular/core';
 import { DataTableColumnComponent } from './data-table-column.component';
+/**
+ * @description
+ * A table for displaying PaginatedList results. It is designed to be used inside components which
+ * extend the {@link BaseListComponent} class.
+ *
+ * @example
+ * ```HTML
+ * <vdr-data-table
+ *   [items]="items$ | async"
+ *   [itemsPerPage]="itemsPerPage$ | async"
+ *   [totalItems]="totalItems$ | async"
+ *   [currentPage]="currentPage$ | async"
+ *   (pageChange)="setPageNumber($event)"
+ *   (itemsPerPageChange)="setItemsPerPage($event)"
+ * >
+ *   <!-- The header columns are defined first -->
+ *   <vdr-dt-column>{{ 'common.name' | translate }}</vdr-dt-column>
+ *   <vdr-dt-column></vdr-dt-column>
+ *   <vdr-dt-column></vdr-dt-column>
+ *
+ *   <!-- Then we define how a row is rendered -->
+ *   <ng-template let-taxRate="item">
+ *     <td class="left align-middle">{{ taxRate.name }}</td>
+ *     <td class="left align-middle">{{ taxRate.category.name }}</td>
+ *     <td class="left align-middle">{{ taxRate.zone.name }}</td>
+ *     <td class="left align-middle">{{ taxRate.value }}%</td>
+ *     <td class="right align-middle">
+ *       <vdr-table-row-action
+ *         iconShape="edit"
+ *         [label]="'common.edit' | translate"
+ *         [linkTo]="['./', taxRate.id]"
+ *       ></vdr-table-row-action>
+ *     </td>
+ *     <td class="right align-middle">
+ *       <vdr-dropdown>
+ *         <button type="button" class="btn btn-link btn-sm" vdrDropdownTrigger>
+ *           {{ 'common.actions' | translate }}
+ *           <clr-icon shape="caret down"></clr-icon>
+ *         </button>
+ *         <vdr-dropdown-menu vdrPosition="bottom-right">
+ *           <button
+ *               type="button"
+ *               class="delete-button"
+ *               (click)="deleteTaxRate(taxRate)"
+ *               [disabled]="!(['DeleteSettings', 'DeleteTaxRate'] | hasPermission)"
+ *               vdrDropdownItem
+ *           >
+ *               <clr-icon shape="trash" class="is-danger"></clr-icon>
+ *               {{ 'common.delete' | translate }}
+ *           </button>
+ *         </vdr-dropdown-menu>
+ *       </vdr-dropdown>
+ *     </td>
+ *   </ng-template>
+ * </vdr-data-table>
+ * ```
+ *
+ * @docsCategory components
+ */
 export declare class DataTableComponent<T> implements AfterContentInit {
     items: T[];
     itemsPerPage: number;

package/core/shared/components/datetime-picker/datetime-picker.component.d.ts

@@ -9,32 +9,49 @@ export declare type CurrentView = {
     month: number;
     year: number;
 };
+/**
+ * @description
+ * A form input for selecting datetime values.
+ *
+ * @example
+ * ```HTML
+ * <vdr-datetime-picker [(ngModel)]="startDate"></vdr-datetime-picker>
+ * ```
+ *
+ * @docsCategory components
+ */
 export declare class DatetimePickerComponent implements ControlValueAccessor, AfterViewInit, OnInit, OnDestroy {
     private changeDetectorRef;
     private datetimePickerService;
     /**
+     * @description
      * The range above and below the current year which is selectable from
      * the year select control. If a min or max value is set, these will
      * override the yearRange.
      */
     yearRange: any;
     /**
+     * @description
      * The day that the week should start with in the calendar view.
      */
     weekStartDay: DayOfWeek;
     /**
+     * @description
      * The granularity of the minutes time picker
      */
     timeGranularityInterval: number;
     /**
+     * @description
      * The minimum date as an ISO string
      */
     min: string | null;
     /**
+     * @description
      * The maximum date as an ISO string
      */
     max: string | null;
     /**
+     * @description
      * Sets the readonly state
      */
     readonly: boolean;

package/core/shared/components/dropdown/dropdown.component.d.ts

@@ -1,4 +1,29 @@
 import { ElementRef } from '@angular/core';
+/**
+ * @description
+ * Used for building dropdown menus.
+ *
+ * @example
+ * ```HTML
+ * <vdr-dropdown>
+ *   <button class="btn btn-outline" vdrDropdownTrigger>
+ *       <clr-icon shape="plus"></clr-icon>
+ *       Select type
+ *   </button>
+ *   <vdr-dropdown-menu vdrPosition="bottom-left">
+ *     <button
+ *       *ngFor="let typeName of allTypes"
+ *       type="button"
+ *       vdrDropdownItem
+ *       (click)="selectType(typeName)"
+ *     >
+ *       typeName
+ *     </button>
+ *   </vdr-dropdown-menu>
+ * </vdr-dropdown>
+ * ```
+ * @docsCategory components
+ */
 export declare class DropdownComponent {
     private isOpen;
     private onOpenChangeCallbacks;

package/core/shared/components/extension-host/extension-host.service.d.ts

@@ -1,14 +1,16 @@
 import { OnDestroy } from '@angular/core';
+import { ActivatedRouteSnapshot } from '@angular/router';
 import { DataService } from '../../../data/providers/data.service';
 import { NotificationService } from '../../../providers/notification/notification.service';
 export declare class ExtensionHostService implements OnDestroy {
     private dataService;
     private notificationService;
     private extensionWindow;
+    private routeSnapshot;
     private cancellationMessage$;
     private destroyMessage$;
     constructor(dataService: DataService, notificationService: NotificationService);
-    init(extensionWindow: Window): void;
+    init(extensionWindow: Window, routeSnapshot: ActivatedRouteSnapshot): void;
     destroy(): void;
     ngOnDestroy(): void;
     private handleMessage;

package/core/shared/components/facet-value-selector/facet-value-selector.component.d.ts

@@ -8,6 +8,28 @@ export declare type FacetValueSeletorItem = {
     id: string;
     value: FacetValue.Fragment;
 };
+/**
+ * @description
+ * A form control for selecting facet values.
+ *
+ * @example
+ * ```HTML
+ * <vdr-facet-value-selector
+ *   [facets]="facets"
+ *   (selectedValuesChange)="selectedValues = $event"
+ * ></vdr-facet-value-selector>
+ * ```
+ * The `facets` input should be provided from the parent component
+ * like this:
+ *
+ * @example
+ * ```TypeScript
+ * this.facets = this.dataService
+ *   .facet.getAllFacets()
+ *   .mapSingle(data => data.facets.items);
+ * ```
+ * @docsCategory components
+ */
 export declare class FacetValueSelectorComponent implements OnInit, ControlValueAccessor {
     private dataService;
     selectedValuesChange: EventEmitter<import("../../../common/generated-types").FacetValueFragment[]>;

package/core/shared/components/modal-dialog/modal-dialog.component.d.ts

@@ -2,7 +2,7 @@ import { TemplateRef, Type } from '@angular/core';
 import { Subject } from 'rxjs';
 import { Dialog, ModalOptions } from '../../../providers/modal/modal.service';
 /**
- * This component should only be instatiated dynamically by the ModalService. It should not be used
+ * This component should only be instantiated dynamically by the ModalService. It should not be used
  * directly in templates. See {@link ModalService.fromComponent} method for more detail.
  */
 export declare class ModalDialogComponent<T extends Dialog<any>> {

package/core/shared/components/object-tree/object-tree.component.d.ts

@@ -1,6 +1,14 @@
 import { OnInit } from '@angular/core';
 /**
+ * @description
  * This component displays a plain JavaScript object as an expandable tree.
+ *
+ * @example
+ * ```HTML
+ * <vdr-object-tree [value]="payment.metadata"></vdr-object-tree>
+ * ```
+ *
+ * @docsCategory components
  */
 export declare class ObjectTreeComponent implements OnInit {
     value: {

package/core/shared/components/order-state-label/order-state-label.component.d.ts

@@ -1,3 +1,13 @@
+/**
+ * @description
+ * Displays the state of an order in a colored chip.
+ *
+ * @example
+ * ```HTML
+ * <vdr-order-state-label [state]="order.state"></vdr-order-state-label>
+ * ```
+ * @docsCategory components
+ */
 export declare class OrderStateLabelComponent {
     state: string;
     get chipColorType(): "success" | "error" | "" | "warning";

package/core/shared/components/product-selector/product-selector.component.d.ts

@@ -2,6 +2,18 @@ import { EventEmitter, OnInit } from '@angular/core';
 import { Observable, Subject } from 'rxjs';
 import { ProductSelectorSearch } from '../../../common/generated-types';
 import { DataService } from '../../../data/providers/data.service';
+/**
+ * @description
+ * A component for selecting product variants via an autocomplete-style select input.
+ *
+ * @example
+ * ```HTML
+ * <vdr-product-selector
+ *   (productSelected)="selectResult($event)"></vdr-product-selector>
+ * ```
+ *
+ * @docsCategory components
+ */
 export declare class ProductSelectorComponent implements OnInit {
     private dataService;
     searchInput$: Subject<string>;

package/core/shared/components/rich-text-editor/rich-text-editor.component.d.ts

@@ -2,7 +2,18 @@ import { AfterViewInit, ChangeDetectorRef, OnDestroy } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
 import { ProsemirrorService } from './prosemirror/prosemirror.service';
 /**
- * A rich text (HTML) editor based on Trix (https://github.com/basecamp/trix)
+ * @description
+ * A rich text (HTML) editor based on Prosemirror (https://prosemirror.net/)
+ *
+ * @example
+ * ```HTML
+ * <vdr-rich-text-editor
+ *     [(ngModel)]="description"
+ *     label="Description"
+ * ></vdr-rich-text-editor>
+ * ```
+ *
+ * @docsCategory components
  */
 export declare class RichTextEditorComponent implements ControlValueAccessor, AfterViewInit, OnDestroy {
     private changeDetector;

package/core/shared/components/tabbed-custom-fields/tabbed-custom-fields.component.d.ts

@@ -0,0 +1,21 @@
+import { OnInit } from '@angular/core';
+import { AbstractControl } from '@angular/forms';
+import { CustomFieldConfig } from '../../../common/generated-types';
+import { CustomFieldEntityName } from '../../../providers/custom-field-component/custom-field-component.service';
+export declare type GroupedCustomFields = Array<{
+    tabName: string;
+    customFields: CustomFieldConfig[];
+}>;
+export declare class TabbedCustomFieldsComponent implements OnInit {
+    entityName: CustomFieldEntityName;
+    customFields: CustomFieldConfig[];
+    customFieldsFormGroup: AbstractControl;
+    readonly: boolean;
+    compact: boolean;
+    showLabel: boolean;
+    readonly defaultTabName = "__default_tab__";
+    tabbedCustomFields: GroupedCustomFields;
+    ngOnInit(): void;
+    customFieldIsSet(name: string): boolean;
+    private groupByTabs;
+}

package/core/shared/components/ui-extension-point/ui-extension-point.component.d.ts

@@ -0,0 +1,15 @@
+import { OnInit } from '@angular/core';
+import { Observable } from 'rxjs';
+import { UIExtensionLocationId } from '../../../common/component-registry-types';
+import { DataService } from '../../../data/providers/data.service';
+export declare class UiExtensionPointComponent implements OnInit {
+    private dataService;
+    locationId: UIExtensionLocationId;
+    topPx: number;
+    leftPx: number;
+    api: 'actionBar' | 'navMenu' | 'detailComponent';
+    display$: Observable<boolean>;
+    readonly isDevMode: boolean;
+    constructor(dataService: DataService);
+    ngOnInit(): void;
+}

package/core/shared/directives/if-multichannel.directive.d.ts

@@ -1,6 +1,20 @@
 import { TemplateRef, ViewContainerRef } from '@angular/core';
 import { DataService } from '../../data/providers/data.service';
 import { IfDirectiveBase } from './if-directive-base';
+/**
+ * @description
+ * Structural directive that displays the given element if the Vendure instance has multiple channels
+ * configured.
+ *
+ * @example
+ * ```html
+ * <div *vdrIfMultichannel class="channel-selector">
+ *   <!-- ... -->
+ * </ng-container>
+ * ```
+ *
+ * @docsCategory directives
+ */
 export declare class IfMultichannelDirective extends IfDirectiveBase<[]> {
     private dataService;
     constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, dataService: DataService);

package/core/shared/directives/if-permissions.directive.d.ts

@@ -3,6 +3,7 @@ import { Permission } from '../../common/generated-types';
 import { DataService } from '../../data/providers/data.service';
 import { IfDirectiveBase } from './if-directive-base';
 /**
+ * @description
  * Conditionally shows/hides templates based on the current active user having the specified permission.
  * Based on the ngIf source. Also support "else" templates:
  *
@@ -14,6 +15,8 @@ import { IfDirectiveBase } from './if-directive-base';
  *
  * The permission can be a single string, or an array. If an array is passed, then _all_ of the permissions
  * must match (logical AND)
+ *
+ * @docsCategory directives
  */
 export declare class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>> {
     private dataService;

package/core/shared/dynamic-form-inputs/boolean-form-input/boolean-form-input.component.d.ts

@@ -1,6 +1,13 @@
 import { FormControl } from '@angular/forms';
 import { DefaultFormComponentConfig, DefaultFormComponentId } from '@vendure/common/lib/shared-types';
 import { FormInputComponent } from '../../../common/component-registry-types';
+/**
+ * @description
+ * A checkbox input. The default input component for `boolean` fields.
+ *
+ * @docsCategory custom-input-components
+ * @docsPage default-inputs
+ */
 export declare class BooleanFormInputComponent implements FormInputComponent {
     static readonly id: DefaultFormComponentId;
     readonly: boolean;

package/core/shared/dynamic-form-inputs/code-editor-form-input/json-editor-form-input.component.d.ts

@@ -0,0 +1,32 @@
+import { AfterViewInit, ChangeDetectorRef, OnInit } from '@angular/core';
+import { FormControl, ValidatorFn } from '@angular/forms';
+import { DefaultFormComponentConfig, DefaultFormComponentId } from '@vendure/common/lib/shared-types';
+import { CodeJar } from 'codejar';
+import { FormInputComponent } from '../../../common/component-registry-types';
+export declare function jsonValidator(): ValidatorFn;
+/**
+ * @description
+ * A JSON editor input with syntax highlighting and error detection. Works well
+ * with `text` type fields.
+ *
+ * @docsCategory custom-input-components
+ * @docsPage default-inputs
+ */
+export declare class JsonEditorFormInputComponent implements FormInputComponent, AfterViewInit, OnInit {
+    private changeDetector;
+    static readonly id: DefaultFormComponentId;
+    readonly: boolean;
+    formControl: FormControl;
+    config: DefaultFormComponentConfig<'json-editor-form-input'>;
+    isValid: boolean;
+    errorMessage: string | undefined;
+    private editorElementRef;
+    jar: CodeJar;
+    constructor(changeDetector: ChangeDetectorRef);
+    get height(): string | undefined;
+    ngOnInit(): void;
+    ngAfterViewInit(): void;
+    private getJsonError;
+    private getErrorPos;
+    private syntaxHighlight;
+}

package/core/shared/dynamic-form-inputs/currency-form-input/currency-form-input.component.d.ts

@@ -4,6 +4,13 @@ import { Observable } from 'rxjs';
 import { FormInputComponent } from '../../../common/component-registry-types';
 import { CurrencyCode } from '../../../common/generated-types';
 import { DataService } from '../../../data/providers/data.service';
+/**
+ * @description
+ * An input for monetary values. Should be used with `int` type fields.
+ *
+ * @docsCategory custom-input-components
+ * @docsPage default-inputs
+ */
 export declare class CurrencyFormInputComponent implements FormInputComponent {
     private dataService;
     static readonly id: DefaultFormComponentId;

package/core/shared/dynamic-form-inputs/customer-group-form-input/customer-group-form-input.component.d.ts

@@ -5,6 +5,14 @@ import { Observable } from 'rxjs';
 import { FormInputComponent } from '../../../common/component-registry-types';
 import { GetCustomerGroups } from '../../../common/generated-types';
 import { DataService } from '../../../data/providers/data.service';
+/**
+ * @description
+ * Allows the selection of a Customer via an autocomplete select input.
+ * Should be used with `ID` type fields which represent Customer IDs.
+ *
+ * @docsCategory custom-input-components
+ * @docsPage default-inputs
+ */
 export declare class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
     private dataService;
     static readonly id: DefaultFormComponentId;

package/core/shared/dynamic-form-inputs/date-form-input/date-form-input.component.d.ts

@@ -1,9 +1,19 @@
 import { FormControl } from '@angular/forms';
 import { DefaultFormComponentConfig, DefaultFormComponentId } from '@vendure/common/lib/shared-types';
 import { FormInputComponent } from '../../../common/component-registry-types';
+/**
+ * @description
+ * Allows selection of a datetime. Default input for `datetime` type fields.
+ *
+ * @docsCategory custom-input-components
+ * @docsPage default-inputs
+ */
 export declare class DateFormInputComponent implements FormInputComponent {
     static readonly id: DefaultFormComponentId;
     readonly: boolean;
     formControl: FormControl;
     config: DefaultFormComponentConfig<'date-form-input'>;
+    get min(): string | undefined;
+    get max(): string | undefined;
+    get yearRange(): number | undefined;
 }

package/core/shared/dynamic-form-inputs/facet-value-form-input/facet-value-form-input.component.d.ts

@@ -5,6 +5,14 @@ import { Observable } from 'rxjs';
 import { FormInputComponent, InputComponentConfig } from '../../../common/component-registry-types';
 import { FacetWithValues } from '../../../common/generated-types';
 import { DataService } from '../../../data/providers/data.service';
+/**
+ * @description
+ * Allows the selection of multiple FacetValues via an autocomplete select input.
+ * Should be used with `ID` type **list** fields which represent FacetValue IDs.
+ *
+ * @docsCategory custom-input-components
+ * @docsPage default-inputs
+ */
 export declare class FacetValueFormInputComponent implements FormInputComponent, OnInit {
     private dataService;
     static readonly id: DefaultFormComponentId;