@sap/ux-specification 1.96.19 → 1.96.21

package/dist/src/specification/v4/controls/Table.d.ts

@@ -1,339 +0,0 @@
-import type { TableColumn, TableColumnAction, TableCustomColumn, ViewTableColumn, ViewTableColumnAction, ViewTableCustomColumn } from './../webapp/manifest/ManifestSettings';
-import type { ToolBar, ViewChartToolBar } from './ToolBar';
-export declare enum SelectionMode {
-    Multi = "Multi",
-    None = "None",
-    Single = "Single",
-    Auto = "Auto"
-}
-export declare enum TableTypeV4 {
-    ResponsiveTable = "ResponsiveTable",
-    GridTable = "GridTable",
-    AnalyticalTable = "AnalyticalTable"
-}
-export declare enum TableCreationModeType {
-    NewPage = "NewPage",
-    Inline = "Inline",
-    CreationRow = "CreationRow"
-}
-export declare enum InitialLoadType {
-    Disabled = "Disabled",
-    Enabled = "Enabled",
-    Auto = "Auto"
-}
-export declare enum DefaultPathType {
-    Primary = "primary",
-    Secondary = "secondary",
-    Both = "both"
-}
-export interface TableCreationMode {
-    /**
-     * The name property of TableCreationMode defines the creation mode; possible values are:
-     * - NewPage: The create action leads to a new page.
-     * - Inline: The create action leads to a new row at the table.
-     * - CreationRow: No create button will be rendered, an empty row is directly given.
-     * The default is "NewPage".
-     */
-    name?: TableCreationModeType;
-    /**
-     * In case of inline creation mode you can decide if the new row will be created at the end of the table, or directly after the currently selected table. The default value is "true"
-     */
-    createAtEnd?: boolean;
-}
-export interface ViewTableCreationMode {
-    /**
-     * The name property of TableCreationMode defines the creation mode; possible values are:
-     * - NewPage: The create action leads to a new page.
-     * - Inline: The create action leads to a new row at the table.
-     * - CreationRow: No create button will be rendered, an empty row is directly given.
-     * The default is "NewPage".
-     */
-    name?: TableCreationModeType;
-    /**
-     * In case of inline creation mode you can decide if the new row will be created at the end of the table, or directly after the currently selected table. The default value is "true"
-     */
-    createAtEnd?: boolean;
-}
-export interface PersonalizationType {
-    /**
-     * Defines whether the user can add and remove columns to a given table.
-     */
-    column?: boolean;
-    /**
-     * Defines whether the user can sort a given table.
-     */
-    sort?: boolean;
-    /**
-     * Defines whether the user can filter data of a given table.
-     */
-    filter?: boolean;
-}
-export interface ViewPersonalizationType {
-    /**
-     * Defines whether the user can add and remove columns to a given table.
-     */
-    column?: boolean;
-    /**
-     * Defines whether the user can sort a given table.
-     */
-    sort?: boolean;
-    /**
-     * Defines whether the user can filter data of a given table.
-     */
-    filter?: boolean;
-}
-export interface AnnotationPathAsObject {
-    annotationPath: string;
-}
-export interface AnnotationPathWithKey {
-    key: string;
-    annotationPath: string;
-    entitySet?: string;
-}
-export interface QuickVariantSelectionV4 {
-    /**
-     * List of annotation paths referring to SelectionVariant annotations
-     */
-    paths: AnnotationPathAsObject[];
-    /**
-     * You can hide the table and display only the titles of the tabs. To do so, add the hideTableTitle option and set it to true.
-     */
-    hideTableTitle?: boolean;
-    /**
-     * You can show the counts of entries of each view. To do so, add the showCounts option and set it to true.
-     */
-    showCounts?: boolean;
-}
-export interface GenericColumns {
-    [key: string]: TableColumn | TableColumnAction | TableCustomColumn;
-}
-export interface ViewColumns {
-    [key: string]: ViewTableColumn | ViewTableColumnAction | ViewTableCustomColumn;
-}
-export interface TableSettings {
-    /**
-     * 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?: TableTypeV4;
-    /**
-     * Applications can influence whether the table rows are selectable or not, and whether it allows for single selection or multiple selection. It can take the following values:
-     * - "Auto": This is the default value. In this mode, Fiori Elements first checks if there are any custom actions or IBN buttons in the table toolbar that require a context. If no such buttons are found, then no table selection is allowed in display mode. In edit mode too a selection is not allowed unless there is a Delete button in the table toolbar in which case multiple row selection will be allowed.
-     * - "Multi": This will allow end users to select multiple table records (in both display and edit mode)
-     * - "Single" This will allow end user to select only a single table record (in both display and edit mode)
-     * - "None": This will not allow the end user to select any table record in display mode. This will also be the case in edit mode unless the table has a delete button enabled, in which multiple selection is allowed in delete mode.
-     */
-    selectionMode?: SelectionMode;
-    /**
-     * The selectAll configuration overrides the selectionLimit and allows the user to select all the items. When set to true, the select all feature is enabled: a checkbox in the table header is displayed which selects all items when clicked.
-     */
-    selectAll?: boolean;
-    /**
-     * With the selectionLimit you can define how many items can be selected at a time,
-     */
-    selectionLimit?: number;
-    /**
-     * The exporting of the table to an Excel file is enabled in List Report tables by default. In Object Page, the export to Excel is available by default if the copy/paste feature is also available; otherwise it is disabled.
-     * To disable the export in List Report or to enable it in Object Page, use the "enableExport" property and set it to false or true.
-     */
-    enableExport?: boolean;
-    /**
-     * With quickVariantSelection you can switch on the multiple view feature (single table mode). It links to SelectionVariant (filters) or SelectionPresentationVariant (filters and sorters) you must have added to your annotations beforehand.
-     */
-    quickVariantSelection?: QuickVariantSelectionV4;
-    /**
-     * You can set the content density to condensed for ui.table on the list report and object page applications.
-     */
-    condensedTableLayout?: boolean;
-}
-export declare type ViewTypeV4 = LRTableView | LRChartView | TableViewExtension | boolean;
-/**
- * Views
- * @isViewNode true
- */
-export interface MultiTableModeV4 {
-    /**
-     * List of annotation paths
-     */
-    [key: string]: ViewTypeV4;
-    /**
-     * You can show the counts of entries of each view. To do so, add the showCounts option and set it to true.
-     */
-    showCounts?: boolean;
-}
-/**
- * Chart View
- * @isViewNode true
- */
-export interface ALPChartView {
-    /**
-     * The primary annotation path can be either UI.Chart, UI.PresentationVariant, or UI.SelectionPresentationVariant.
-     */
-    annotationPath: string;
-    /**
-     * Chart Toolbar
-     * @isViewNode true
-     */
-    toolBar?: ViewChartToolBar;
-}
-/**
- * Chart View
- * @isViewNode true
- */
-export interface LRChartView {
-    key: string;
-    index: number;
-    /**
-     * To use charts in multiple table mode, define a UI.Chart annotation, including a qualifier.
-     * Reference the UI.Chart annotation in your SelectionPresentationVariant or PresentationVariant for your view.
-     */
-    annotationPath: string;
-    /**
-     * Each chart can be based on a different entitySet.
-     */
-    entitySet?: string;
-    /**
-     * Chart Toolbar
-     * @isViewNode true
-     */
-    toolBar?: ViewChartToolBar;
-    /**
-     * Specifies whether the view is visible or not
-     */
-    visible?: boolean;
-}
-/**
- * Table View
- * @isViewNode true
- */
-export interface ALPTableView extends TableSettings {
-    /**
-     * The secondary annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.
-     */
-    annotationPath: string;
-    /**
-     * initialLoad defines whether or not the data in the table is automatically loaded.
-     * - Disabled - Data is never loaded when opening the app without an app state.
-     * - Enabled - Data is always loaded when opening the app.
-     * - Auto - Data is only loaded, if initial/preset filters are available (e.g. defined by "SelectionVariant" definition, URL parameters or user defaults).
-     */
-    initialLoad?: InitialLoadType;
-    /**
-     * Defines the personalization mode, currently only effective if variant management on page is either set to Page or Control.
-     * By default all table settings are enabled. You can change this for the different parts of the table by setting the properties "Column", "Sort" and "Filter" accordingly.
-     * Omitting a property is treated as false, this allows apps to avoid getting new features like grouping in upcoming releases.
-     */
-    personalization?: ViewPersonalizationType;
-    /**
-     * Defines the page behavior when a new record is created.
-     */
-    creationMode?: ViewTableCreationMode;
-    /**
-     * Table Toolbar
-     */
-    toolBar?: ToolBar;
-    columns?: ViewColumns;
-}
-/**
- * Table View Extension
- * @isViewNode true
- */
-export interface TableViewExtension {
-    /**
-     * Unique tab identifier.
-     */
-    key: string;
-    /**
-     * @hidden true
-     */
-    index: number;
-    /**
-     * View title (localization supported).
-     */
-    label?: string;
-    /**
-     * The name contains sap.app.id as a prefix, followed by the path in the app/webapp folder and the name of the XML view.
-     */
-    template: string;
-    /**
-     * Specifies whether the view is visible or not
-     */
-    visible?: boolean;
-}
-/**
- * Table View
- * @isViewNode true
- */
-export interface LRTableView extends TableSettings {
-    /**
-     * Unique tab identifier.
-     */
-    key: string;
-    index: number;
-    /**
-     * The annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.
-     */
-    annotationPath: string;
-    /**
-     * Each table can be based on a different entitySet.
-     */
-    entitySet?: string;
-    /**
-     *  The tab keeps the default LineItem ID (without the key), so the variant is applied to it.
-     */
-    keepPreviousPersonalization?: boolean;
-    /**
-     * Defines the personalization mode, currently only effective if variant management on page is either set to Page or Control.
-     * By default all table settings are enabled. You can change this for the different parts of the table by setting the properties "Column", "Sort" and "Filter" accordingly.
-     * Omitting a property is treated as false, this allows apps to avoid getting new features like grouping in upcoming releases.
-     */
-    personalization?: ViewPersonalizationType;
-    /**
-     * Defines the page behavior when a new record is created.
-     */
-    creationMode?: ViewTableCreationMode;
-    /**
-     * Table Toolbar
-     */
-    toolBar?: ToolBar;
-    /**
-     * Columns
-     */
-    columns?: ViewColumns;
-    /**
-     * Specifies whether the view is visible or not
-     */
-    visible?: boolean;
-}
-/**
- * Table
- * @isViewNode true
- */
-export interface Table extends TableSettings {
-    /**
-     * The secondary annotation path can be either UI.LineItem, UI.PresentationVariant, or UI.SelectionPresentationVariant.
-     */
-    annotationPath?: string;
-    /**
-     * initialLoad defines whether or not the data in the table is automatically loaded.
-     * - Disabled - Data is never loaded when opening the app without an app state.
-     * - Enabled - Data is always loaded when opening the app.
-     * - Auto - Data is only loaded, if initial/preset filters are available (e.g. defined by "SelectionVariant" definition, URL parameters or user defaults).
-     */
-    initialLoad?: InitialLoadType;
-    /**
-     * Defines the page behavior when a new record is created.
-     */
-    creationMode?: TableCreationMode;
-    /**
-     * Defines the personalization mode, currently only effective if variant management on page is either set to Page or Control.
-     * By default all table settings are enabled. You can change this for the different parts of the table by setting the properties "Column", "Sort" and "Filter" accordingly.
-     * Omitting a property is treated as false, this allows apps to avoid getting new features like grouping in upcoming releases.
-     */
-    personalization?: PersonalizationType;
-    views?: MultiTableModeV4;
-    /**
-     * Tool Bar
-     */
-    toolBar?: ToolBar;
-    columns?: GenericColumns;
-}

package/dist/src/specification/v4/controls/ToolBar.d.ts

@@ -1,110 +0,0 @@
-export declare enum SelectType {
-    single = "single",
-    multi = "multi"
-}
-export declare enum ActionPlacement {
-    After = "After",
-    Before = "Before"
-}
-/**
- * Action
- * @isViewNode true
- */
-export interface ToolBarAction {
-    /**
-     * Enables single selection for a bound action
-     */
-    enableOnSelect?: SelectType;
-}
-/**
- * Action
- * @isViewNode true
- */
-export interface ViewToolBarAction {
-    /**
-     * Enables single selection for a bound action
-     */
-    enableOnSelect?: SelectType;
-}
-export declare type ChartToolBarAction = {};
-/**
- * Actions
- * @isViewNode true
- */
-export interface Actions {
-    [key: string]: ToolBarAction | CustomAction;
-}
-/**
- * Actions
- * @isViewNode true
- */
-export interface ViewActions {
-    [key: string]: ViewToolBarAction | ChartToolBarAction | ViewTableCustomAction;
-}
-/**
- * Table Toolbar
- * @isViewNode true
- */
-export interface ToolBar {
-    actions: Actions;
-}
-/**
- * Chart Toolbar
- * @isViewNode true
- */
-export interface ViewChartToolBar {
-    actions: ViewActions;
-}
-export interface CustomActionPosition {
-    /**
-     * The key of another action to be used as placement anchor.
-     */
-    anchor?: string;
-    /**
-     * Define the placement, either before or after the anchor action.
-     */
-    placement: ActionPlacement;
-}
-/**
- * Action
- * @isViewNode true
- */
-export interface CustomAction {
-    /**
-     * The text that is displayed on the button (typically a binding to an i18n entry).
-     * @i18nClassification COL: Custom action text
-     */
-    text: string;
-    /**
-     * Defines the position of the action relative to other actions.
-     */
-    position?: CustomActionPosition;
-    /**
-     * Relevant for extension actions; allows the definition of a target action handler.
-     */
-    press: string;
-    /**
-     * Indicates whether the action requires a selection of items.
-     */
-    requiresSelection?: boolean;
-    /**
-     * Whether the action button should be visible on the screen.
-     */
-    visible?: boolean;
-    /**
-     * Whether the action button should be enabled. Default value is `true`.
-     */
-    enabled?: boolean;
-}
-export interface ViewCustomActionPosition extends CustomActionPosition {
-    /**
-     * The key of another action to be used as placement anchor.
-     */
-    anchor?: string;
-}
-export interface ViewTableCustomAction extends CustomAction {
-    /**
-     * Defines the position of the action relative to other actions.
-     */
-    position?: ViewCustomActionPosition;
-}

package/dist/src/specification/v4/controls/index.d.ts

@@ -1,10 +0,0 @@
-export * from './Table';
-export * from './FilterBar';
-export * from './ToolBar';
-export * from './ObjectPageToolBar';
-export * from './ObjectPageHeader';
-export * from './ObjectPageHeaderSection';
-export * from './ObjectPageLayout';
-export * from './ObjectPageSection';
-export * from './ObjectPageTable';
-export * from './ObjectPageFooter';

package/dist/src/specification/v4/index.d.ts

@@ -1,5 +0,0 @@
-export * from './pages';
-export * from './controls';
-export * from './webapp';
-export * from './ApplicationV4';
-export * from './page';

package/dist/src/specification/v4/page.d.ts

@@ -1,17 +0,0 @@
-import type { PagesBase, PageBase, PageTypeV4, SapUiGenericAppPageSettings } from '../common';
-import type { FlexibleColumnLayoutAggregations } from '.';
-export interface Pages extends PagesBase {
-    [key: string]: Page;
-}
-export interface Page extends PageBase {
-    view?: PageView;
-    controlAggregation?: FlexibleColumnLayoutAggregations;
-    pageType?: PageTypeV4;
-    options?: {
-        settings?: SapUiGenericAppPageSettings;
-    };
-}
-export interface PageView {
-    id: string;
-    name: string;
-}

package/dist/src/specification/v4/pages/FreestylePageConfig.d.ts

@@ -1,2 +0,0 @@
-import type { PageConfig } from '../../common';
-export declare type FreestylePageConfig = PageConfig;

package/dist/src/specification/v4/pages/ListReportConfig.d.ts

@@ -1,36 +0,0 @@
-import type { Table, FilterBar, ALPTableView, ALPChartView, DefaultPathType } from '../controls';
-import type { PageConfig } from '../../common/page';
-export declare enum VariantManagementTypeListReport {
-    None = "None",
-    Control = "Control",
-    Page = "Page"
-}
-export interface ListReportConfig extends PageConfig {
-    /**
-     * variantManagement defines how the variant management of page personalizations is controlled.
-     * - None - No variant management by default.
-     * - Control - Individual personalizations for each control.
-     */
-    variantManagement?: VariantManagementTypeListReport;
-    /**
-     * Filter Bar
-     */
-    filterBar?: FilterBar;
-    /**
-     * Chart
-     */
-    chart?: ALPChartView;
-    /**
-     * Table
-     */
-    table?: Table | ALPTableView;
-    /**
-     * defaultTemplateAnnotationPath must be a reference to a SelectionPresentationVariant.
-     * You use the SelectionPresentationVariant to configure the default visualizations and default filter values of the main content area.
-     */
-    defaultTemplateAnnotationPath?: string;
-    /**
-     * defaultPath can be "primary", "secondary", or "both". If it is "primary", SAP Fiori elements loads the app in chart-only view. If it is "secondary", SAP Fiori elements loads the app in table-only view. If it is "both", SAP Fiori elements loads the app in hybrid view.
-     */
-    defaultPath?: DefaultPathType;
-}

package/dist/src/specification/v4/pages/ObjectPageConfig.d.ts

@@ -1,18 +0,0 @@
-import type { PageConfig } from '../../common/page';
-import type { ObjectPageLayout, ObjectPageHeader, ObjectPageFooter, GenericSections, CustomSections } from '../controls';
-export declare enum VariantManagementTypeObjectPage {
-    None = "None",
-    Control = "Control"
-}
-export interface ObjectPageConfig extends PageConfig {
-    header?: ObjectPageHeader;
-    layout?: ObjectPageLayout;
-    /**
-     * variantManagement defines how the variant management of page personalizations is controlled.
-     * - None - No variant management by default.
-     * - Control - Individual personalizations for each control.
-     */
-    variantManagement?: VariantManagementTypeObjectPage;
-    sections?: GenericSections | CustomSections;
-    footer?: ObjectPageFooter;
-}

package/dist/src/specification/v4/pages/index.d.ts

@@ -1,3 +0,0 @@
-export * from './ObjectPageConfig';
-export * from './ListReportConfig';
-export * from './FreestylePageConfig';

package/dist/src/specification/v4/webapp/index.d.ts

@@ -1 +0,0 @@
-export * from './manifest';