@sap/ux-ui5-tooling 1.21.0 → 1.22.0

package/dist/preview-middleware/dist/client/adp/api-handler.js

@@ -11,6 +11,9 @@ sap.ui.define(["../utils/error"], function (___utils_error) {
     ApiEndpoints["CODE_EXT"] = "/adp/api/code_ext";
     ApiEndpoints["ANNOTATION_FILE"] = "/adp/api/annotation";
     ApiEndpoints["MANIFEST_APP_DESCRIPTOR"] = "/manifest.appdescr_variant";
+    ApiEndpoints["OVP_DATA_SOURCES"] = "/adp/api/ovp/datasources";
+    ApiEndpoints["OVP_METAMODEL"] = "/adp/api/ovp/metamodel";
+    ApiEndpoints["I18N_STORE"] = "/editor/i18n";
     return ApiEndpoints;
   }(ApiEndpoints || {});
   var RequestMethod = /*#__PURE__*/function (RequestMethod) {

package/dist/preview-middleware/dist/client/adp/api-handler.ts

@@ -7,7 +7,10 @@ export const enum ApiEndpoints {
     CONTROLLER = '/adp/api/controller',
     CODE_EXT = '/adp/api/code_ext',
     ANNOTATION_FILE = '/adp/api/annotation',
-    MANIFEST_APP_DESCRIPTOR = '/manifest.appdescr_variant'
+    MANIFEST_APP_DESCRIPTOR = '/manifest.appdescr_variant',
+    OVP_DATA_SOURCES = '/adp/api/ovp/datasources',
+    OVP_METAMODEL = '/adp/api/ovp/metamodel',
+    I18N_STORE = '/editor/i18n'
 }
 
 export const enum RequestMethod {

package/dist/preview-middleware/dist/client/adp/init.js

@@ -67,8 +67,17 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
       const extPointService = new ExtensionPointService(rta);
       extPointService.init();
     }
-    const applicationType = getApplicationType(rta.getRootControlInstance().getManifest());
+    const manifest = rta.getRootControlInstance().getManifest();
+    const applicationType = getApplicationType(manifest);
     const quickActionRegistries = await loadDefinitions(applicationType);
+
+    // Initialize OVP bridge functions if the application is an OVP app
+    if (manifest['sap.ovp']) {
+      const {
+        initOvpWindowFunctions
+      } = await __ui5_require_async('open/ux/preview/client/adp/ovp-window-functions');
+      initOvpWindowFunctions();
+    }
     await init(rta, quickActionRegistries);
 
     // Register synchronious views detection and warning

package/dist/preview-middleware/dist/client/adp/init.ts

@@ -50,9 +50,16 @@ export default async function (rta: RuntimeAuthoring) {
         extPointService.init();
     }
 
-    const applicationType = getApplicationType(rta.getRootControlInstance().getManifest());
+    const manifest = rta.getRootControlInstance().getManifest();
+    const applicationType = getApplicationType(manifest);
     const quickActionRegistries = await loadDefinitions(applicationType);
 
+    // Initialize OVP bridge functions if the application is an OVP app
+    if (manifest['sap.ovp']) {
+        const { initOvpWindowFunctions } = await import('open/ux/preview/client/adp/ovp-window-functions');
+        initOvpWindowFunctions();
+    }
+
     await init(rta, quickActionRegistries);
 
     // Register synchronious views detection and warning

package/dist/preview-middleware/dist/client/adp/ovp-window-functions.js

@@ -0,0 +1,130 @@
+"use strict";
+
+sap.ui.define(["sap/base/Log", "sap/ui/model/odata/v2/ODataModel"], function (log, ODataModel) {
+  "use strict";
+
+  /**
+   * Returns the base URL for API requests.
+   *
+   * @returns Base URL string
+   */
+  function getBaseUrl() {
+    return document.getElementById('root')?.dataset.openUxPreviewBaseUrl ?? '';
+  }
+
+  /**
+   * Creates a UI5 ODataModel with annotation URLs and returns its metamodel
+   * with entity containers, schema, and model information.
+   *
+   * @param serviceInfo Service URL and annotation details from the server
+   * @returns Promise resolving to a metamodel object
+   */
+  async function buildMetaModel(serviceInfo) {
+    const annotationUris = serviceInfo.annotations.map(a => a.Uri);
+    const model = new ODataModel(serviceInfo.serviceUrl, {
+      annotationURI: annotationUris,
+      loadAnnotationsJoined: true,
+      skipMetadataAnnotationParsing: false,
+      json: true
+    });
+    const metaModel = model.getMetaModel();
+    await metaModel.loaded();
+    return {
+      oEntityContainers: metaModel.getODataEntityContainer(),
+      oSchema: metaModel.getObject('/dataServices/schema'),
+      modelInformation: serviceInfo.modelInformation
+    };
+  }
+
+  /**
+   * Writes i18n entries to the adaptation project's i18n properties file.
+   * Fire-and-forget: the OVP runtime does not await the result.
+   *
+   * @param _path - i18n path (ignored; server resolves from project context)
+   * @param properties - Array of i18n key-value entries to write
+   */
+  function writeToI18n(_path, properties) {
+    const entries = properties.map(p => ({
+      key: p.key,
+      value: p.value,
+      annotation: p.textType
+    }));
+    fetch(`${getBaseUrl()}/editor/i18n`, {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json'
+      },
+      body: JSON.stringify(entries)
+    }).catch(error => {
+      log.error('OVP writeToI18n failed', error);
+    });
+  }
+
+  /**
+   * Fetches available OData V2 services from the ABAP system catalog.
+   *
+   * @param _path - Application path (ignored; server uses its own provider)
+   * @returns Promise resolving to an object with a results array of service metadata
+   */
+  async function getNewDataSources(_path) {
+    const response = await fetch(`${getBaseUrl()}/adp/api/ovp/datasources`);
+    if (!response.ok) {
+      throw new Error(`Failed to fetch data sources: ${response.status}`);
+    }
+    return response.json();
+  }
+
+  /**
+   * Fetches the OData metadata model for a selected data source service.
+   * Creates a real UI5 ODataModel with annotations to build a full metamodel
+   * compatible with the OVP dialog.
+   *
+   * @param selectedDataSources - Array of selected data source objects
+   * @param _path - Application path (ignored; server uses its own provider)
+   * @returns Promise resolving to a metamodel object
+   */
+  async function getMetaModelForNewDataSource(selectedDataSources, _path) {
+    const response = await fetch(`${getBaseUrl()}/adp/api/ovp/metamodel`, {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json'
+      },
+      body: JSON.stringify({
+        dataSource: selectedDataSources[0]
+      })
+    });
+    if (!response.ok) {
+      throw new Error(`Failed to fetch metamodel: ${response.status}`);
+    }
+    const serviceInfo = await response.json();
+    if (!serviceInfo) {
+      return undefined;
+    }
+    return buildMetaModel(serviceInfo);
+  }
+
+  /**
+   * Initializes OVP bridge functions required by the sap.ovp library for the
+   * "Add New Card" flow in the adaptation editor.
+   *
+   * These bridge functions are registered as globals on the window object
+   * and connect the OVP runtime (in the preview iframe) to the server-side
+   * adaptation tooling middleware via fetch requests.
+   */
+  function initOvpWindowFunctions() {
+    // OVP runtime expects these as window globals
+    // eslint-disable-next-line @sap-ux/fiori-tools/sap-no-global-define
+    window.writeToI18n = writeToI18n;
+    // eslint-disable-next-line @sap-ux/fiori-tools/sap-no-global-define
+    window.getNewDataSources = getNewDataSources;
+    // eslint-disable-next-line @sap-ux/fiori-tools/sap-no-global-define
+    window.getMetaModelForNewDataSource = getMetaModelForNewDataSource;
+    log.info('OVP bridge functions initialized (writeToI18n, getNewDataSources, getMetaModelForNewDataSource)');
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.initOvpWindowFunctions = initOvpWindowFunctions;
+  return __exports;
+});
+//# sourceMappingURL=ovp-window-functions.js.map

package/dist/preview-middleware/dist/client/adp/ovp-window-functions.ts

@@ -0,0 +1,171 @@
+import log from 'sap/base/Log';
+import ODataModel from 'sap/ui/model/odata/v2/ODataModel';
+
+interface I18nProperty {
+    key: string;
+    value: string;
+    textType?: string;
+}
+
+interface DataSourceInfo {
+    ID: string;
+    Title: string;
+    Description?: string;
+    TechnicalServiceName?: string;
+    TechnicalServiceVersion?: number;
+    ServiceUrl?: string;
+    MetadataUrl?: string;
+}
+
+interface DataSourcesResponse {
+    results: DataSourceInfo[];
+}
+
+interface ServiceInfoResponse {
+    serviceUrl: string;
+    annotations: Array<{ TechnicalName: string; Uri: string }>;
+    modelInformation: OvpModelInformation;
+}
+
+interface OvpModelInformation {
+    serviceURI: string;
+    serviceAnnotation: string;
+    serviceAnnotationURI: string;
+}
+
+interface OvpMetaModelResult {
+    oEntityContainers: Record<string, unknown>;
+    oSchema: Record<string, unknown>[];
+    modelInformation: OvpModelInformation;
+}
+
+declare global {
+    interface Window {
+        writeToI18n: (path: string, properties: I18nProperty[]) => void;
+        getNewDataSources: (path: string) => Promise<DataSourcesResponse>;
+        getMetaModelForNewDataSource: (
+            selectedDataSources: DataSourceInfo[],
+            path: string
+        ) => Promise<OvpMetaModelResult | undefined>;
+    }
+}
+
+/**
+ * Returns the base URL for API requests.
+ *
+ * @returns Base URL string
+ */
+function getBaseUrl(): string {
+    return document.getElementById('root')?.dataset.openUxPreviewBaseUrl ?? '';
+}
+
+/**
+ * Creates a UI5 ODataModel with annotation URLs and returns its metamodel
+ * with entity containers, schema, and model information.
+ *
+ * @param serviceInfo Service URL and annotation details from the server
+ * @returns Promise resolving to a metamodel object
+ */
+async function buildMetaModel(serviceInfo: ServiceInfoResponse): Promise<OvpMetaModelResult> {
+    const annotationUris = serviceInfo.annotations.map((a) => a.Uri);
+
+    const model = new ODataModel(serviceInfo.serviceUrl, {
+        annotationURI: annotationUris,
+        loadAnnotationsJoined: true,
+        skipMetadataAnnotationParsing: false,
+        json: true
+    });
+
+    const metaModel = model.getMetaModel();
+    await metaModel.loaded();
+
+    return {
+        oEntityContainers: metaModel.getODataEntityContainer() as Record<string, unknown>,
+        oSchema: metaModel.getObject('/dataServices/schema') as Record<string, unknown>[],
+        modelInformation: serviceInfo.modelInformation
+    };
+}
+
+/**
+ * Writes i18n entries to the adaptation project's i18n properties file.
+ * Fire-and-forget: the OVP runtime does not await the result.
+ *
+ * @param _path - i18n path (ignored; server resolves from project context)
+ * @param properties - Array of i18n key-value entries to write
+ */
+function writeToI18n(_path: string, properties: I18nProperty[]): void {
+    const entries = properties.map((p) => ({
+        key: p.key,
+        value: p.value,
+        annotation: p.textType
+    }));
+    fetch(`${getBaseUrl()}/editor/i18n`, {
+        method: 'POST',
+        headers: { 'content-type': 'application/json' },
+        body: JSON.stringify(entries)
+    }).catch((error) => {
+        log.error('OVP writeToI18n failed', error);
+    });
+}
+
+/**
+ * Fetches available OData V2 services from the ABAP system catalog.
+ *
+ * @param _path - Application path (ignored; server uses its own provider)
+ * @returns Promise resolving to an object with a results array of service metadata
+ */
+async function getNewDataSources(_path: string): Promise<DataSourcesResponse> {
+    const response = await fetch(`${getBaseUrl()}/adp/api/ovp/datasources`);
+    if (!response.ok) {
+        throw new Error(`Failed to fetch data sources: ${response.status}`);
+    }
+    return response.json();
+}
+
+/**
+ * Fetches the OData metadata model for a selected data source service.
+ * Creates a real UI5 ODataModel with annotations to build a full metamodel
+ * compatible with the OVP dialog.
+ *
+ * @param selectedDataSources - Array of selected data source objects
+ * @param _path - Application path (ignored; server uses its own provider)
+ * @returns Promise resolving to a metamodel object
+ */
+async function getMetaModelForNewDataSource(
+    selectedDataSources: DataSourceInfo[],
+    _path: string
+): Promise<OvpMetaModelResult | undefined> {
+    const response = await fetch(`${getBaseUrl()}/adp/api/ovp/metamodel`, {
+        method: 'POST',
+        headers: { 'content-type': 'application/json' },
+        body: JSON.stringify({ dataSource: selectedDataSources[0] })
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to fetch metamodel: ${response.status}`);
+    }
+    const serviceInfo = (await response.json()) as ServiceInfoResponse | null;
+    if (!serviceInfo) {
+        return undefined;
+    }
+    return buildMetaModel(serviceInfo);
+}
+
+/**
+ * Initializes OVP bridge functions required by the sap.ovp library for the
+ * "Add New Card" flow in the adaptation editor.
+ *
+ * These bridge functions are registered as globals on the window object
+ * and connect the OVP runtime (in the preview iframe) to the server-side
+ * adaptation tooling middleware via fetch requests.
+ */
+export function initOvpWindowFunctions(): void {
+    // OVP runtime expects these as window globals
+    // eslint-disable-next-line @sap-ux/fiori-tools/sap-no-global-define
+    window.writeToI18n = writeToI18n;
+    // eslint-disable-next-line @sap-ux/fiori-tools/sap-no-global-define
+    window.getNewDataSources = getNewDataSources;
+    // eslint-disable-next-line @sap-ux/fiori-tools/sap-no-global-define
+    window.getMetaModelForNewDataSource = getMetaModelForNewDataSource;
+
+    log.info('OVP bridge functions initialized (writeToI18n, getNewDataSources, getMetaModelForNewDataSource)');
+}

package/dist/preview-middleware/dist/client/cpe/odata-health/odata-health-checker.js

@@ -112,9 +112,19 @@ sap.ui.define(["sap/base/Log", "sap/ui/model/odata/v2/ODataModel", "sap/ui/model
       () => oModel.destroy());
     }
     getServices() {
-      const manifest = this.rta.getRootControlInstance().getManifest();
+      const rootControl = this.rta.getRootControlInstance();
+      const manifest = rootControl.getManifest();
       const dataSources = manifest?.['sap.app']?.dataSources;
-      return Object.values(dataSources ?? {}).filter(this.isOdataService).map(this.toOdataServiceInfo);
+      const odataServices = Object.values(dataSources ?? {}).filter(this.isOdataService);
+      const isCloudFoundry = !!this.rta.getFlexSettings().isCloudFoundry;
+      if (isCloudFoundry) {
+        const manifestObject = rootControl.getManifestObject();
+        return odataServices.map(src => ({
+          serviceUrl: manifestObject.resolveUri(src.uri),
+          oDataVersion: src.settings?.odataVersion ?? ODataHealthChecker.DEFAULT_ODATA_VERSION
+        }));
+      }
+      return odataServices.map(this.toOdataServiceInfo);
     }
   }
   var __exports = {

package/dist/preview-middleware/dist/client/cpe/odata-health/odata-health-checker.ts

@@ -141,10 +141,20 @@ export class ODataHealthChecker {
     }
 
     private getServices(): ODataServiceInfo[] {
-        const manifest: Manifest = this.rta.getRootControlInstance().getManifest() as unknown as Manifest;
+        const rootControl = this.rta.getRootControlInstance();
+        const manifest: Manifest = rootControl.getManifest() as unknown as Manifest;
         const dataSources = manifest?.['sap.app']?.dataSources;
-        return Object.values(dataSources ?? {})
-            .filter(this.isOdataService)
-            .map(this.toOdataServiceInfo);
+        const odataServices = Object.values(dataSources ?? {}).filter(this.isOdataService);
+
+        const isCloudFoundry = !!this.rta.getFlexSettings().isCloudFoundry;
+        if (isCloudFoundry) {
+            const manifestObject = rootControl.getManifestObject();
+            return odataServices.map((src) => ({
+                serviceUrl: manifestObject.resolveUri(src.uri),
+                oDataVersion: (src.settings?.odataVersion ?? ODataHealthChecker.DEFAULT_ODATA_VERSION)
+            }));
+        }
+
+        return odataServices.map(this.toOdataServiceInfo);
     }
 }

package/dist/preview-middleware/dist/client/flp/WorkspaceConnector.js

@@ -88,6 +88,7 @@ sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStor
       if (settings?.scenario === 'ADAPTATION_PROJECT') {
         features.isVariantAdaptationEnabled = true;
       }
+      features.isAnnotationChangeEnabled = false;
       return features;
     }
   });

package/dist/preview-middleware/dist/client/flp/WorkspaceConnector.ts

@@ -92,6 +92,8 @@ const connector = merge({}, ObjectStorageConnector, {
             features.isVariantAdaptationEnabled = true;
         }
 
+        features.isAnnotationChangeEnabled = false;
+
         return features;
     }
 }) as typeof ObjectStorageConnector;