@sap/ux-specification 1.96.17 → 1.96.18

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

@@ -2,6 +2,10 @@ export declare enum SelectType {
     single = "single",
     multi = "multi"
 }
+export declare enum ActionPlacement {
+    After = "After",
+    Before = "Before"
+}
 /**
  * Action
  * @isViewNode true
@@ -28,14 +32,14 @@ export declare type ChartToolBarAction = {};
  * @isViewNode true
  */
 export interface Actions {
-    [key: string]: ToolBarAction;
+    [key: string]: ToolBarAction | CustomAction;
 }
 /**
  * Actions
  * @isViewNode true
  */
 export interface ViewActions {
-    [key: string]: ViewToolBarAction | ChartToolBarAction;
+    [key: string]: ViewToolBarAction | ChartToolBarAction | ViewTableCustomAction;
 }
 /**
  * Table Toolbar
@@ -51,3 +55,56 @@ export interface ToolBar {
 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/sync/common/generate/utils.d.ts

@@ -1,11 +1,15 @@
 import type { AnnotationTerm, ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
 import type { LineItem } from '@sap-ux/vocabularies-types/vocabularies/UI';
-import type { Definition } from 'typescript-json-schema';
+import type { Definition, DefinitionOrBoolean } from 'typescript-json-schema';
 import type { FacetConfig, FacetSection, SectionType } from '..';
 import type { SectionTypeV2 } from '../../v2/types';
 import type { PresentationVariantV4 } from '../../v4/types';
 import { UIAnnotationTerms } from '@sap-ux/vocabularies-types/vocabularies/UI';
 import { DefinitionName } from '..';
+interface PropertyInDefinition {
+    definition: string;
+    property?: string;
+}
 /**
  * Adds an enum filled with existing UI annotations of the given list (validAnnotations)
  * @param {EntityType} entityType
@@ -66,6 +70,14 @@ export declare function getFacetKeyInSchema(facetKey: string): string;
  * @returns {Definition} part of app schema that has been added and filled
  */
 export declare function parseSchemaDefinition(definition: string, facetKey: string, appSchema: Definition, useDefinitionAsKey?: boolean, subDefinitionName?: DefinitionName): Definition;
+/**
+ * Method receives custom extension base definition name and detect if it should be combined with lineItemId.
+ * @param appSchema - the app specific schema that shall get enhanced
+ * @param lineItemId - line item ID, as comprise in stable ID
+ * @param customColumnDefinitionName - (optional) definition name of custom extension.
+ * @returns $ref path for definition.
+ */
+export declare function getCustomExtensionDefinitionName(appSchema: Definition, lineItemId: string, customExtensionDefinitionName: string): string;
 /**
  * Functions used both by V2 and V4 to add the common definitions for a line item to the app schema
  * @param appSchema - the app specific schema that shall get enhanced
@@ -76,7 +88,7 @@ export declare function parseSchemaDefinition(definition: string, facetKey: stri
  *        Passed in the V4 case, then additional properties of this type will be allowed.
  * @returns the actions definition plus the annotation path to the given line item
  */
-export declare function addCommonLineItemDefinitions(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId: string, customColumnDefinitionName?: string): {
+export declare function addCommonLineItemDefinitions(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, lineItemId: string, customColumnDefinitionName?: string, customActionDefinitionName?: string): {
     actions: Definition;
     footerActions: Definition;
     lineItemPath: string;
@@ -150,3 +162,12 @@ export declare function getFacetAnnotationPath(facet: FacetConfig | Presentation
  * @param {SectionType} sectionPrefix - prefix to distinguish Section and HeaderSection
  */
 export declare function handleAddressContact(facet: FacetConfig, facetKey: string, sections: Definition, appSchema: Definition, sectionPrefix: SectionType, subSectionPrefix?: SectionType, versionPostfix?: string): void;
+/**
+ * Method adds enum with key and description to schema definition.
+ * Description can be easily used by UI to describe enum value/key.
+ * @param {Definition} appSchema App specific JSON schema
+ * @param {DefinitionOrBoolean} origin Origin schema object containing key and description.
+ * @param {PropertyInDefinition} target Target to update with enum.
+ */
+export declare function addDescriptiveEnumDefinition(appSchema: Definition, origin: DefinitionOrBoolean, target: PropertyInDefinition): void;
+export {};

package/dist/src/sync/common/types.d.ts

@@ -219,7 +219,7 @@ export interface ObjectPageSectionData {
     target: string;
     key?: string;
 }
-export declare const BindingPropertyRegexAsString = "^{[A-Za-z0-9{}&$!@#? _|,<>'()[\\]\\/:=.]+}$";
+export declare const BindingPropertyRegexAsString = "^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$";
 export declare enum ViewTemplateType {
     ResponsiveTableColumnsExtension = "ResponsiveTableColumnsExtension",
     AnalyticalTableColumnsExtension = "AnalyticalTableColumnsExtension",
@@ -239,6 +239,8 @@ export declare enum DefinitionName {
     AnnotationPathAsObject = "AnnotationPathAsObject",
     ChartToolBarAction = "ChartToolBarAction",
     CommonHeaderFacetSettings = "CommonHeaderFacetSettings",
+    CustomAction = "CustomAction",
+    CustomActionOP = "CustomActionOP",
     CustomColumn = "TableCustomColumn",
     CustomColumnOP = "TableCustomColumnOP",
     CustomColumns = "TableCustomColumns",
@@ -308,9 +310,13 @@ export declare enum DefinitionName {
     ToolBar = "ToolBar",
     ViewTableColumn = "ViewTableColumn",
     ViewCustomColumn = "ViewTableCustomColumn",
+    ViewCustomAction = "ViewTableCustomAction",
     ViewChartToolBar = "ViewChartToolBar",
     ViewToolBarAction = "ViewToolBarAction",
-    ViewPosition = "ViewPosition"
+    ViewPosition = "ViewPosition",
+    ViewCustomActionPosition = "ViewCustomActionPosition",
+    CustomActionPosition = "CustomActionPosition",
+    CustomActionPositionOP = "CustomActionPositionOP"
 }
 export declare enum PropertyName {
     actions = "actions",

package/dist/src/sync/common/utils.d.ts

@@ -241,3 +241,9 @@ export declare function convertEnumToCSV(manifestSection: any, configPart: any,
  * @returns the converted action ID
  */
 export declare function convertActionKeyToStableId(actionId: string): string;
+/**
+ * Method returns definition key for passed '$ref' property by removing 'definition' prefix
+ * @param $ref - definition reference.
+ * @returns Definition key.
+ */
+export declare function getDefinitionKey($ref: string): string;

package/dist/src/sync/v4/export/controls/ObjectPageToolBarAction.d.ts

@@ -1,4 +1,19 @@
-import type { ObjectPageToolBarAction as ToolBarActionIF, SelectType } from '../../../../specification/v4';
+import type { ObjectPageToolBarAction as ToolBarActionIF, SelectType, CustomAction as CustomActionIF, CustomActionPosition as PositionIF, ActionPlacement } from '../../../../specification/v4';
 export declare class ObjectPageToolBarAction implements ToolBarActionIF {
     enableOnSelect?: SelectType;
 }
+/**
+ * Sync class for Position
+ */
+export declare class CustomActionPositionOP implements PositionIF {
+    anchor?: string;
+    placement: ActionPlacement;
+}
+export declare class CustomActionOP implements CustomActionIF {
+    text: string;
+    position: CustomActionPositionOP;
+    press: string;
+    requiresSelection?: boolean;
+    visible?: boolean;
+    enabled?: boolean;
+}

package/dist/src/sync/v4/export/controls/ToolBar.d.ts

@@ -1,7 +1,7 @@
 import type { ToolBar as ToolBarIF, Actions as ActionsIF } from '../../../../specification/v4';
-import { ToolBarAction } from './ToolBarAction';
+import { ToolBarAction, CustomAction } from './ToolBarAction';
 export declare class Actions implements ActionsIF {
-    [key: string]: ToolBarAction;
+    [key: string]: ToolBarAction | CustomAction;
 }
 export declare class ToolBar implements ToolBarIF {
     actions: Actions;

package/dist/src/sync/v4/export/controls/ToolBarAction.d.ts

@@ -1,7 +1,37 @@
-import type { ToolBarAction as ToolBarActionIF, ViewToolBarAction as ViewToolBarActionIF, SelectType } from '../../../../specification/v4';
+import type { ToolBarAction as ToolBarActionIF, ViewToolBarAction as ViewToolBarActionIF, SelectType, CustomAction as CustomActionIF, CustomActionPosition as PositionIF, ViewTableCustomAction as ViewTableCustomActionIF, ViewCustomActionPosition as ViewCustomActionPositionIF, ActionPlacement } from '../../../../specification/v4';
 export declare class ToolBarAction implements ToolBarActionIF {
     enableOnSelect?: SelectType;
 }
 export declare class ViewToolBarAction implements ViewToolBarActionIF {
     enableOnSelect?: SelectType;
 }
+/**
+ * Sync class for Position
+ */
+export declare class CustomActionPosition implements PositionIF {
+    anchor?: string;
+    placement: ActionPlacement;
+}
+export declare class CustomAction implements CustomActionIF {
+    text: string;
+    position: CustomActionPosition;
+    press: string;
+    requiresSelection?: boolean;
+    visible?: boolean;
+    enabled?: boolean;
+}
+/**
+ * Sync class for Position
+ */
+export declare class ViewCustomActionPosition implements ViewCustomActionPositionIF {
+    anchor?: string;
+    placement: ActionPlacement;
+}
+export declare class ViewTableCustomAction implements ViewTableCustomActionIF {
+    text: string;
+    position: CustomActionPosition;
+    press: string;
+    requiresSelection?: boolean;
+    visible?: boolean;
+    enabled?: boolean;
+}

package/dist/src/sync/v4/utils/utils.d.ts

@@ -35,7 +35,7 @@ export declare function handleActionRecord(appSchema: Definition, entityType: En
  * @param columnDefinitionName - name of the column definition, i.e. TableColumn or ObjectPageTableColumn
  * @param customColumnDefinitionName - name of the custom column definition
  */
-export declare function addLineItemsType(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, lineItemId: string, columnDefinitionName?: string, customColumnDefinitionName?: string): void;
+export declare function addLineItemsType(appSchema: Definition, lineItemAnnotation: AnnotationTerm<LineItem>, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, lineItemId: string, columnDefinitionName?: string, customColumnDefinitionName?: string, customActionDefinitionName?: string): void;
 /**
  * Adds an enum or value help to position > anchor of custom column
  * @param appSchema - app specific JSON schema
@@ -45,6 +45,13 @@ export declare function addLineItemsType(appSchema: Definition, lineItemAnnotati
  * @param sectionIdInManifest - identifier of the current object page section in manifest
  */
 export declare function addFragmentEnumForAnchor(appSchema: Definition, lineItemId: string, v4Page: SapUiAppPageV4, positionName?: string, sectionIdInManifest?: string): void;
+/**
+ * Adds an enum or value help to position > anchor of custom column
+ * @param appSchema - app specific JSON schema
+ * @param definitionId - definition key of actions
+ * @param positionName - target definition to update
+ */
+export declare function addEnumForActionAnchor(appSchema: Definition, definitionId: string, positionName?: string): void;
 /**
  * Find the relevant V4 page under the routing targets of manifest,json
  * @param pages - list of all pages in manifest
@@ -61,3 +68,13 @@ export declare function findPageV4(pages: SapUiAppPageV4[], pageName: string, en
  * @returns the right definition name for the table in the schema
  */
 export declare function alignSchemaWithTemplateType(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): DefinitionName.Table | DefinitionName.ALPTableView;
+/**
+ * Common function for enhancing the LineItems definition of app schema by custom columns
+ * @param appSchema - app-specific JSON schema
+ * @param v4Page - actual page in the manifest
+ * @param logger - logger for error messages
+ * @param customColumnDefinitionName - custom column definition name
+ * @param sectionId - identifier of the current object page section in schema
+ * @param sectionIdInManifest - identifier of the current object page section in manifest
+ */
+export declare function addCustomActionDefinition(appSchema: Definition, v4Page: SapUiAppPageV4, logger: ExtensionLogger, customColumnDefinitionName?: string, sectionId?: string, sectionIdInManifest?: string): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/ux-specification",
-  "version": "1.96.17",
+  "version": "1.96.18",
   "displayName": "SAP Fiori tools - Specification",
   "description": "SAP Fiori tools - Specification",
   "files": [
@@ -46,7 +46,7 @@
   "publisher": "SAPSE",
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@sap-ux/fe-fpm-writer": "0.11.0"
+    "@sap-ux/fe-fpm-writer": "0.13.4"
   },
   "devDependencies": {
     "@sap-ux/annotation-converter": "0.5.7",
@@ -77,21 +77,21 @@
     "jest-sonar-reporter": "2.0.0",
     "jquery": "3.6.0",
     "lodash.unset": "4.5.2",
-    "mem-fs-editor": "9.3.0",
+    "mem-fs-editor": "9.4.0",
     "path": "0.12.7",
     "prettier": "2.5.1",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
     "sax": "1.2.4",
     "source-map-loader": "1.0.0",
-    "terser-webpack-plugin": "4.2.3",
+    "terser-webpack-plugin": "5.3.3",
     "ts-jest": "26.5.6",
     "ts-json-schema-generator": "0.96.0",
     "ts-loader": "9.1.2",
     "ts-node": "9.1.1",
     "typescript": "3.8.3",
     "typescript-json-schema": "0.48.0",
-    "webpack-cli": "4.7.2",
+    "webpack-cli": "4.10.0",
     "xml-js": "1.6.11"
   },
   "husky": {