@sap/ux-specification 1.96.19 → 1.96.21

package/dist/src/specification/v2/controls/FilterBar.d.ts

@@ -1,234 +0,0 @@
-export declare const enum DateRangeType {
-    DATERANGE = "DATERANGE",
-    DATE = "DATE",
-    FROM = "FROM",
-    TO = "TO",
-    DAYS = "DAYS",
-    LASTDAYS = "LASTDAYS",
-    LASTWEEKS = "LASTWEEKS",
-    WEEK = "WEEK",
-    LASTMONTHS = "LASTMONTHS",
-    MONTH = "MONTH",
-    QUARTER = "QUARTER",
-    LASTQUARTERS = "LASTQUARTERS",
-    LASTYEARS = "LASTYEARS",
-    LASTYEAR = "LASTYEAR",
-    YEAR = "YEAR",
-    NEXTDAYS = "NEXTDAYS",
-    NEXTWEEKS = "NEXTWEEKS",
-    NEXTMONTHS = "NEXTMONTHS",
-    NEXTQUARTERS = "NEXTQUARTERS",
-    NEXTYEARS = "NEXTYEARS",
-    NEXT = "NEXT",
-    SPECIFICMONTH = "SPECIFICMONTH",
-    YESTERDAY = "YESTERDAY",
-    YEARTODATE = "YEARTODATE",
-    TODAY = "TODAY",
-    TOMORROW = "TOMORROW",
-    THISWEEK = "THISWEEK",
-    LASTWEEK = "LASTWEEK",
-    LAST2WEEKS = "LAST2WEEKS",
-    LAST3WEEKS = "LAST3WEEKS",
-    LAST4WEEKS = "LAST4WEEKS",
-    LAST5WEEKS = "LAST5WEEKS",
-    NEXTWEEK = "NEXTWEEK",
-    NEXT2WEEKS = "NEXT2WEEKS",
-    NEXT3WEEKS = "NEXT3WEEKS",
-    NEXT4WEEKS = "NEXT4WEEKS",
-    NEXT5WEEKS = "NEXT5WEEKS",
-    THISMONTH = "THISMONTH",
-    LASTMONTH = "LASTMONTH",
-    NEXTMONTH = "NEXTMONTH",
-    THISQUARTER = "THISQUARTER",
-    LASTQUARTER = "LASTQUARTER",
-    NEXTQUARTER = "NEXTQUARTER",
-    QUARTER1 = "QUARTER1",
-    QUARTER2 = "QUARTER2",
-    QUARTER3 = "QUARTER3",
-    QUARTER4 = "QUARTER4",
-    TODAYFROMTO = "TODAYFROMTO"
-}
-export declare const enum DefaultDateRangeValueType {
-    YESTERDAY = "YESTERDAY",
-    TODAY = "TODAY",
-    THISWEEK = "THISWEEK",
-    LASTWEEK = "LASTWEEK",
-    THISMONTH = "THISMONTH",
-    TOMORROW = "TOMORROW",
-    LASTMONTH = "LASTMONTH",
-    THISQUARTER = "THISQUARTER",
-    LASTQUARTER = "LASTQUARTER",
-    THISYEAR = "THISYEAR",
-    LASTYEAR = "LASTYEAR",
-    LAST2WEEKS = "LAST2WEEKS",
-    LAST3WEEKS = "LAST3WEEKS",
-    LAST4WEEKS = "LAST4WEEKS",
-    LAST5WEEKS = "LAST5WEEKS",
-    YEARTODATE = "YEARTODATE",
-    QUARTER1 = "QUARTER1",
-    QUARTER2 = "QUARTER2",
-    QUARTER3 = "QUARTER3",
-    QUARTER4 = "QUARTER4",
-    DATETOYEAR = "DATETOYEAR"
-}
-/**
- * Filter Field
- * @isViewNode true
- */
-export declare type SelectionField = {} | SelectionFieldDateSettings;
-/**
- * Filter Field for Date Settings
- * @isViewNode true
- */
-export interface SelectionFieldDateSettings {
-    /**
-     * The selectedValues property is a set of standard date range values that you want to include or exclude.
-     */
-    selectedValues?: DateRangeType[];
-    /**
-     * The exclude property is set to True by default. This means excluding all values given as selectedValues from the list of date range filters. If the exclude property is set to False, the application shows only selected values in the list of date range filters.
-     */
-    exclude?: boolean;
-    /**
-     * This property references a JS class, which you use to modify the date range value list. You can either remove standard data range values or add custom values.
-     * The customDateRangeImplementation setting takes priority followed by filter and selectedValues when excluding date range types.
-     */
-    customDateRangeImplementation?: string;
-    /**
-     * You can use the filter settings to include and exclude specific date range values.
-     */
-    filter?: FilterType[];
-    /**
-     * You can set a default value for semantic date range.
-     */
-    defaultValue?: DefaultDateRange;
-}
-/**
- * Filter Fields
- * @isViewNode true
- */
-export interface SelectionFields {
-    [key: string]: SelectionField;
-}
-export declare type FilterTypeCategory = {
-    /**
-     * Choose 'key' to define filter values for single values of the date range type, or 'category' to filter by a whole subset.
-     */
-    path: 'category';
-    /**
-     * The 'contains' string specifies a filter describing a set of values of the date range type.
-     */
-    contains?: string;
-    /**
-     * Defines a single value of the standard date range type.
-     */
-    equals?: DateRangeType[];
-    /**
-     * The exclude property is set to True by default. This means excluding all values given as selectedValues from the list of date range filters. If the exclude property is set to False, the application shows only selected values in the list of date range filters.
-     */
-    exclude?: boolean;
-};
-export declare type FilterTypeKey = {
-    /**
-     * Choose 'key' to define filter values for single values of the date range, or 'category' to filter by a whole subset.
-     */
-    path: 'key';
-    /**
-     * The 'contains' string specifies a filter describing a set of values of the date range type.
-     */
-    contains?: string;
-    /**
-     * Defines a single value of the standard date range type.
-     */
-    equals?: DateRangeType[];
-    /**
-     * The exclude property is set to True by default. This means excluding all values given as selectedValues from the list of date range filters. If the exclude property is set to False, the application shows only selected values in the list of date range filters.
-     */
-    exclude?: boolean;
-};
-export declare type FilterType = FilterTypeKey | FilterTypeCategory;
-export interface DefaultDateRange {
-    /**
-     * The operation property is the value that will be set for semantic date range.
-     */
-    operation: DefaultDateRangeValueType;
-}
-export interface DateRange {
-    /**
-     * If set to true all date fields with filter restriction interval will be treated as DateTimeRange filters.
-     */
-    useDateRange?: boolean;
-    /**
-     * The selectedValues property is a set of standard date range values that you want to include or exclude.
-     */
-    selectedValues?: DateRangeType[];
-    /**
-     * The exclude property is set to True by default. This means excluding all values given as selectedValues from the list of date range filters. If the exclude property is set to False, the application shows only selected values in the list of date range filters.
-     */
-    exclude?: boolean;
-}
-export interface CommonFilterBar {
-    /**
-     * Controls whether smart variant management is active. Default is true.
-     */
-    smartVariantManagement?: boolean;
-    /**
-     * If liveMode is set, the search will be automatically triggered when a filter value is set.
-     */
-    liveMode?: boolean;
-    /**
-     * If you set the flag to true, then standard variant management is not available in the app. The app name is displayed instead.
-     * If you set the flag to false or if the flag is not at all contained in the manifest of the app, the standard variant management is available and can be enabled or disabled.
-     */
-    variantManagementHidden?: boolean;
-    /**
-     * You can choose an app-specific title by setting the corresponding value for the subTitleIfVariantMgmtHidden property.
-     * @i18nClassification TIT: Subtitle if variant management is hidden
-     */
-    subTitleIfVariantMgmtHidden?: string;
-    /**
-     * Use to set date settings for fields in smart filter bar
-     */
-    dateSettings?: DateRange;
-    /**
-     * Handles visibility of the Clear button on the FilterBar.
-     */
-    showClearOnFB?: boolean;
-    /**
-     * Handles visibility of the Filter button on the FilterBar.
-     */
-    showFilterConfiguration?: boolean;
-    /**
-     * Handles visibility of the Restore button on the FilterBar.
-     */
-    showRestoreOnFB?: boolean;
-    /**
-     * @isViewNode true
-     * Selection Fields
-     */
-    selectionFields?: SelectionFields;
-}
-/**
- * Filter Bar
- * @isViewNode true
- */
-export interface ListReportFilterBar extends CommonFilterBar {
-    /**
-     * Lets you to add default values for FilterBar using SelectionVariant annotation
-     */
-    annotationPath?: string;
-}
-/**
- * Filter Bar
- * @isViewNode true
- */
-export interface AnalyticalListPageFilterBar extends CommonFilterBar {
-    /**
-     * Go button is displayed for compact filters when this is set to true
-     */
-    showGoButtonOnFilterBar?: boolean;
-    /**
-     * Lets you to add default values for FilterBar using SelectionVariant annotation
-     */
-    filterDefaultsFromSelectionVariant?: boolean;
-}

package/dist/src/specification/v2/controls/Footer.d.ts

@@ -1,20 +0,0 @@
-import type { ObjectPageFooterAction } from './Action';
-import type { Actions } from '.';
-interface ObjectPageFooterActions {
-    [id: string]: ObjectPageFooterAction;
-}
-/**
- * Footer
- * @isViewNode true
- */
-export interface GenericFooter {
-    actions?: Actions;
-}
-/**
- * Footer
- * @isViewNode true
- */
-export interface ObjectPageFooter<ACT = ObjectPageFooterActions> {
-    actions?: ACT;
-}
-export {};

package/dist/src/specification/v2/controls/ObjectPageChart.d.ts

@@ -1,16 +0,0 @@
-/**
- * Chart
- * @isViewNode true
- */
-export interface ObjectPageChart {
-    /**
-     * To enable variant management for charts in an object page
-     */
-    variantManagement?: boolean;
-}
-export interface GlobalChartSettings {
-    /**
-     * To enable variant management for charts in an object page
-     */
-    variantManagement?: boolean;
-}

package/dist/src/specification/v2/controls/ObjectPageForm.d.ts

@@ -1,15 +0,0 @@
-import type { FormAction, Field } from '.';
-/**
- * Object Page Form
- * @isViewNode true
- */
-export interface ObjectPageForm {
-    fields?: ObjectPageFormFields;
-    actions?: ObjectPageFormActions;
-}
-export interface ObjectPageFormFields {
-    [key: string]: Field;
-}
-export interface ObjectPageFormActions {
-    [key: string]: FormAction;
-}

package/dist/src/specification/v2/controls/ObjectPageHeader.d.ts

@@ -1,32 +0,0 @@
-/// <reference types="@sapui5/ts-types-esm" />
-import type { HeaderAction } from '.';
-import type AvatarShape from 'sap/m/AvatarShape';
-export interface GenericActions {
-    [id: string]: HeaderAction;
-}
-/**
- * Header
- * @isViewNode true
- */
-export interface ObjectPageHeader<ACT = GenericActions> {
-    /**
-     * Set showRelatedApps to true to show the navigation button for related apps.
-     */
-    showRelatedApps?: boolean;
-    /**
-     * Set editableHeaderContent to true to make the header fields editable.
-     */
-    editableHeaderContent?: boolean;
-    /**
-     * Set simpleHeaderFacets to true to use simpler header facets.
-     */
-    simpleHeaderFacets?: boolean;
-    /**
-     * With displayShape you can define the shape of the avatar.
-     */
-    displayShape?: AvatarShape;
-    /**
-     * Set properties of actions on Object Page Header
-     */
-    actions?: ACT;
-}

package/dist/src/specification/v2/controls/ObjectPageLayout.d.ts

@@ -1,22 +0,0 @@
-/**
- * Page Layout
- * @isViewNode true
- */
-export interface ObjectPageLayout {
-    /**
-     * showHeaderContent determines the visibility of the Header content.
-     */
-    showHeaderContent?: boolean;
-    /**
-     * showAnchorBar determines whether the navigation bar (anchor bar) is displayed.
-     */
-    showAnchorBar?: boolean;
-    /**
-     * useIconTabBar determines whether the navigation mode is tab-based instead of based on the default anchor bar.
-     */
-    useIconTabBar?: boolean;
-    /**
-     * alwaysShowContentHeader determines whether header content will always be expanded on desktop.
-     */
-    alwaysShowContentHeader?: boolean;
-}

package/dist/src/specification/v2/controls/ObjectPageSection.d.ts

@@ -1,120 +0,0 @@
-import type { ObjectPageResponsiveTableWithMultiSelect, ObjectPageResponsiveTableWithInlineDelete, ObjectPageAnalyticalTable, ObjectPageGridTable, ObjectPageTreeTable, ObjectPageChart, ObjectPageForm } from './index';
-import type { ViewTypes, SAPUI5_FRAGMENT_CLASS, SAPUI5_VIEW_CLASS } from '../../common/webapp/manifest/sapUi5';
-/**
- * Section
- * @isViewNode true
- */
-export interface ObjectPageSectionV2 {
-    /**
-     * Whether the section should be visible on the screen.
-     */
-    visible?: boolean;
-}
-/**
- * Form
- * @isViewNode true
- */
-export interface ObjectPageSectionFormV2 extends ObjectPageSectionV2 {
-    form?: ObjectPageForm;
-}
-export declare type AnyObjectPageTableType = ObjectPageResponsiveTableWithMultiSelect | ObjectPageResponsiveTableWithInlineDelete | ObjectPageAnalyticalTable | ObjectPageGridTable | ObjectPageTreeTable;
-/**
- * Table
- * @isViewNode true
- */
-export interface ObjectPageSectionTableV2 extends ObjectPageSectionV2 {
-    table?: AnyObjectPageTableType;
-}
-/**
- * Chart
- * @isViewNode true
- */
-export interface ObjectPageSectionChartV2 extends ObjectPageSectionV2 {
-    chart?: ObjectPageChart;
-}
-export interface ObjectPageSectionContactV2 extends ObjectPageSectionV2 {
-    /**
-     * Contact
-     *  @isViewNode true
-     */
-    contact?: object;
-}
-export interface ObjectPageSectionAddressV2 extends ObjectPageSectionV2 {
-    /**
-     * Address
-     *  @isViewNode true
-     */
-    address?: object;
-}
-export interface ObjectPageSubSectionContactV2 extends ObjectPageSectionV2 {
-    /**
-     * Contact
-     *  @isViewNode true
-     */
-    contact?: object;
-}
-export interface ObjectPageSubSectionAddressV2 extends ObjectPageSectionV2 {
-    /**
-     * Address
-     *  @isViewNode true
-     */
-    address?: object;
-}
-export declare type AnySubSectionType = ObjectPageSectionTableV2 | ObjectPageSectionChartV2 | ObjectPageSectionFormV2 | ObjectPageSubSectionContactV2 | ObjectPageSubSectionAddressV2;
-export interface GenericSubSections {
-    [key: string]: AnySubSectionType;
-}
-/**
- * Subsection
- * @isViewNode true
- */
-export interface ObjectPageSubSectionV2 extends ObjectPageSectionV2 {
-    subsections?: GenericSubSections;
-}
-export declare type AnySectionType = ObjectPageSectionTableV2 | ObjectPageSectionChartV2 | ObjectPageSectionFormV2 | ObjectPageSectionContactV2 | ObjectPageSectionAddressV2 | ObjectPageSectionV2 | ObjectPageSubSectionV2;
-export interface GenericSections {
-    [key: string]: AnySectionType;
-}
-export declare type CustomSectionTypeV2 = ObjectPageCustomSectionView | ObjectPageCustomSectionFragment;
-/**
- * Custom Sections
- * @isViewNode true
- */
-export interface CustomSections {
-    custom?: CustomSectionTypeV2[];
-}
-export interface ObjectPageCustomSectionBase {
-    relatedFacet: string;
-    relativePosition: SectionPosition;
-    /**
-     * The label of the custom section, preferably as an i18n key
-     * @i18nClassification TIT: Custom section title
-     */
-    title: string;
-}
-/**
- * View
- * @isViewNode true
- */
-export interface ObjectPageCustomSectionView extends ObjectPageCustomSectionBase {
-    className: typeof SAPUI5_VIEW_CLASS;
-    viewName: string;
-    type: ViewTypes;
-}
-/**
- * Fragment
- * @isViewNode true
- */
-export interface ObjectPageCustomSectionFragment extends ObjectPageCustomSectionBase {
-    className: typeof SAPUI5_FRAGMENT_CLASS;
-    fragmentName: string;
-    type: ExtensionFragmentTypes;
-}
-export declare enum SectionPosition {
-    AfterFacet = "AfterFacet",
-    BeforeFacet = "BeforeFacet",
-    ReplaceFacet = "ReplaceFacet"
-}
-export declare enum ExtensionFragmentTypes {
-    XML = "XML"
-}

package/dist/src/specification/v2/controls/ObjectPageTable.d.ts

@@ -1,186 +0,0 @@
-/// <reference types="@sapui5/ts-types-esm" />
-import type { GenericColumns, TableTypeV2, QuickVariant } from './Table';
-import type { ObjectPageToolBar } from './ObjectPageToolBar';
-import type { PopinLayout } from 'sap/m/library';
-import type { smarttable } from 'sap/ui/comp/library';
-export interface QuickVariantSelectionOP {
-    /**
-     * To show the number of records available, set showCounts to true.
-     */
-    showCounts?: boolean;
-    /**
-     * The variants section contains a set of entries that point to SelectionVariants or SelectionPresentationVariants defined in the annotations.
-     */
-    variants: {
-        [key: number]: QuickVariant;
-    };
-}
-export interface FieldPathOP {
-    path: string;
-}
-export interface CreationFieldKeysOP {
-    [key: string]: FieldPathOP;
-}
-export interface Fields4DialogOP {
-    fields: CreationFieldKeysOP;
-}
-export declare enum CreateMode {
-    inline = "inline"
-}
-export interface ObjectPageCommonTableSettings<COLS = GenericColumns> {
-    /**
-     * You can enable the creation of objects that have a maximum of 8 data fields through a dialog in the list report page.
-     */
-    createWithParameterDialog?: Fields4DialogOP;
-    /**
-     *  With editable you can control if a table can be edited. It should be set to false for smart tables with non-editable content.
-     */
-    editable?: boolean;
-    /**
-     * The 'Select All' button is disabled by default. To enable it, set selectAll to true.
-     */
-    selectAll?: boolean;
-    /**
-     * If new data needs to be loaded from the back-end system for this, the number of lines to be loaded is restricted to the specified limit. The default value for this limit is 200. If selectAll is true, the selection limit is not evaluated.
-     */
-    selectionLimit?: number;
-    /**
-     * With quickVariantSelection you can switch on the multiple view feature. It links to variants you must have been added to your annotations before.
-     */
-    quickVariantSelection?: QuickVariantSelectionOP;
-    /**
-     * useExportToExcel must be set to true if you want to export data to a spreadsheet application, for example Microsoft Excel.
-     */
-    useExportToExcel?: boolean;
-    /**
-     * Specifies the type of export to be used in the SmartTable control. UI5Client is the default option.
-     */
-    exportType?: smarttable.ExportType;
-    /**
-     * Use createMode 'inline' to enable inline creation of table entries for draft enabled applications.
-     */
-    createMode?: CreateMode;
-    /**
-     * If createMode is set to inline, you can use this setting to disable the default sort order.
-     */
-    disableDefaultInlineCreateSort?: boolean;
-    /**
-     * To enable variant management for a specific table on an object page.
-     */
-    variantManagement?: boolean;
-    /**
-     * Tool Bar
-     */
-    toolBar?: ObjectPageToolBar;
-    /**
-     * Columns
-     */
-    columns?: COLS;
-}
-/**
- * @controlProperty type
- */
-export interface ObjectPageResponsiveTableCommonSettings extends ObjectPageCommonTableSettings {
-    /**
-     * Use type to define the table type. Note: Grid tables, analytical tables, and tree tables cannot be rendered on smartphones. Instead, responsive tables always show on smartphones.
-     */
-    type?: TableTypeV2.ResponsiveTable;
-    /**
-     * Set includeItemInSelection to true if you want items to be selectable when clicked, rather than after the selection control has been set.
-     */
-    includeItemInSelection?: boolean;
-    /**
-     * popinLayout defines the layout in which the table pop-in rows shall be rendered.
-     */
-    popinLayout?: PopinLayout;
-    /**
-     * growingThreshold defines the number of items to be requested from the model for each grow. This property can only be used if the growing property is set to true.
-     */
-    growingThreshold?: number;
-}
-/**
- * Table
- * @isViewNode true
- * @controlProperty type
- */
-export interface ObjectPageResponsiveTableWithMultiSelect extends ObjectPageResponsiveTableCommonSettings {
-    /**
-     * Single selection in tables is enabled by default. If you want, you can enable multi-select.
-     */
-    multiSelect?: boolean;
-}
-/**
- * Table
- * @isViewNode true
- * @controlProperty type
- */
-export interface ObjectPageResponsiveTableWithInlineDelete extends ObjectPageResponsiveTableCommonSettings {
-    /**
-     *  Used to enable inline deletion in a responsive table of list report and object page
-     */
-    inlineDelete?: boolean;
-}
-/**
- * Table
- * @isViewNode true
- * @controlProperty type
- */
-export interface ObjectPageResponsiveTable extends ObjectPageResponsiveTableCommonSettings, ObjectPageResponsiveTableWithMultiSelect, ObjectPageResponsiveTableWithInlineDelete {
-}
-/**
- * Table
- * @isViewNode true
- * @controlProperty type
- */
-export interface ObjectPageAnalyticalTable extends ObjectPageCommonTableSettings {
-    /**
-     * Use type to define the table type. Note: Grid tables, analytical tables, and tree tables cannot be rendered on smartphones. Instead, responsive tables always show on smartphones.
-     */
-    type?: TableTypeV2.AnalyticalTable;
-    /**
-     * For the analytical table, grid table and tree table you can decide on a condensed table layout by setting condensedTableLayout to true.
-     */
-    condensedTableLayout?: boolean;
-    /**
-     * Single selection in tables is enabled by default. If you want, you can enable multi-select.
-     */
-    multiSelect?: boolean;
-}
-/**
- * Table
- * @isViewNode true
- * @controlProperty type
- */
-export interface ObjectPageGridTable extends ObjectPageCommonTableSettings {
-    /**
-     * Use type to define the table type. Note: Grid tables, analytical tables, and tree tables cannot be rendered on smartphones. Instead, responsive tables always show on smartphones.
-     */
-    type?: TableTypeV2.GridTable;
-    /**
-     * For the analytical table, grid table and tree table you can decide on a condensed table layout by setting condensedTableLayout to true.
-     */
-    condensedTableLayout?: boolean;
-    /**
-     * Single selection in tables is enabled by default. If you want, you can enable multi-select.
-     */
-    multiSelect?: boolean;
-}
-/**
- * Table
- * @isViewNode true
- * @controlProperty type
- */
-export interface ObjectPageTreeTable extends ObjectPageCommonTableSettings {
-    /**
-     * Use type to define the table type. Note: Grid tables, analytical tables, and tree tables cannot be rendered on smartphones. Instead, responsive tables always show on smartphones.
-     */
-    type?: TableTypeV2.TreeTable;
-    /**
-     * For the analytical table, grid table and tree table you can decide on a condensed table layout by setting condensedTableLayout to true.
-     */
-    condensedTableLayout?: boolean;
-    /**
-     * Single selection in tables is enabled by default. If you want, you can enable multi-select.
-     */
-    multiSelect?: boolean;
-}

package/dist/src/specification/v2/controls/ObjectPageToolBar.d.ts

@@ -1,15 +0,0 @@
-import type { ObjectPageToolBarAction } from '.';
-/**
- * Actions
- * @isViewNode true
- */
-export interface ObjectPageToolBarActions {
-    [key: string]: ObjectPageToolBarAction;
-}
-/**
- * Toolbar
- * @isViewNode true
- */
-export interface ObjectPageToolBar {
-    actions: ObjectPageToolBarActions;
-}