@sap-ux/fiori-generator-shared 0.10.2 → 0.11.0

package/dist/npm-package-scripts/getPackageScripts.d.ts

@@ -6,12 +6,12 @@ import type { PackageJsonScripts, PackageScriptsOptions } from './types';
  * @param options.localOnly no server available
  * @param options.addMock add a script for using the mockserver
  * @param options.addTest add a script for executing OPA tests
- * @param options.sapClient SAP client required for connecting to the backend
  * @param options.flpAppId local FLP id
  * @param options.startFile path that should be opened with the start script
  * @param options.localStartFile path that should be opend with the start-local script
  * @param options.generateIndex exclude the start-noflp script
+ * @param options.supportVirtualEndpoints whether to support virtual endpoints - search params will not be added as they are injected at runtime
  * @returns package.json scripts
  */
-export declare function getPackageScripts({ localOnly, addMock, addTest, sapClient, flpAppId, startFile, localStartFile, generateIndex }: PackageScriptsOptions): PackageJsonScripts;
+export declare function getPackageScripts({ localOnly, addMock, addTest, flpAppId, startFile, localStartFile, generateIndex, supportVirtualEndpoints }: PackageScriptsOptions): PackageJsonScripts;
 //# sourceMappingURL=getPackageScripts.d.ts.map

package/dist/npm-package-scripts/getPackageScripts.js

@@ -15,30 +15,13 @@ const i18n_1 = require("../i18n");
  *                     appropriate parameters.
  */
 function buildStartNoFLPCommand(localOnly, searchParams) {
-    const searchParamString = searchParams.toString();
+    const searchParamString = searchParams?.toString();
     const searchParam = searchParamString ? `?${searchParamString}` : '';
     if (localOnly) {
         return `echo \\"${(0, i18n_1.t)('info.mockOnlyWarning')}\\"`;
     }
     return `fiori run --open "index.html${searchParam}"`;
 }
-/**
- * Constructs a `URLSearchParams` object with the specified query parameters.
- *
- * This function creates a `URLSearchParams` instance and appends the `sap-client` parameter if provided,
- * along with a default `sap-ui-xx-viewCache` parameter set to `false`.
- *
- * @param {string} [sapClient] - The SAP client value to be included as a query parameter.
- * @returns {URLSearchParams} - The `URLSearchParams` object containing the specified query parameters.
- */
-function buildSearchParams(sapClient) {
-    const params = new URLSearchParams();
-    if (sapClient) {
-        params.append('sap-client', sapClient);
-    }
-    params.append('sap-ui-xx-viewCache', 'false');
-    return params;
-}
 /**
  * Constructs a URL parameter string from search parameters and an optional FLP app ID.
  *
@@ -49,9 +32,8 @@ function buildSearchParams(sapClient) {
  *                      If `searchParams` is empty, only the fragment identifier will be included.
  */
 function buildParams(searchParams, flpAppId) {
-    const searchParamString = searchParams.toString();
-    const searchParam = searchParamString ? `?${searchParamString}` : '';
     const hashFragment = flpAppId ? `#${flpAppId}` : '';
+    const searchParam = searchParams ? `?${searchParams.toString()}` : '';
     return `${searchParam}${hashFragment}`;
 }
 /**
@@ -73,22 +55,22 @@ function buildStartCommand(localOnly, params, startFile) {
 }
 /**
  * Generates a variant management script in preview mode.
+ * Default search parameters are added to the command if `addSearchParams` is `true`.
+ * These parameters are necessary when virtual endpoints are not used.
+ * When virtual endpoints are used, the search parameters are injected at runtime.
  *
- * @param {string} sapClient - The SAP client parameter to include in the URL. If not provided, the URL will not include the `sap-client` parameter.
+ * @param {boolean} addSearchParams - Indicates whether to include search parameters in the command.
  * @returns {string} A variant management script to run the application in preview mode.
  */
-function getVariantPreviewAppScript(sapClient) {
-    const previewAppAnchor = '#preview-app';
-    const disableCacheParam = 'sap-ui-xx-viewCache=false';
-    const sapClientParam = sapClient ? `&sap-client=${sapClient}` : '';
-    const urlParam = `?${[
-        sapClientParam,
-        disableCacheParam,
-        'fiori-tools-rta-mode=true',
-        'sap-ui-rta-skip-flex-validation=true'
-    ]
-        .filter(Boolean)
-        .join('&')}`;
+function getVariantPreviewAppScript(addSearchParams) {
+    const previewAppAnchor = '#app-preview';
+    let urlParam = '';
+    if (addSearchParams) {
+        const disableCacheParam = 'sap-ui-xx-viewCache=false';
+        urlParam = `?${[disableCacheParam, 'fiori-tools-rta-mode=true', 'sap-ui-rta-skip-flex-validation=true']
+            .filter(Boolean)
+            .join('&')}`;
+    }
     // Please keep the special characters in the below command
     // as removing them may cause the browser to misinterpret the URI components without the necessary escaping and quotes.
     // eslint-disable-next-line no-useless-escape
@@ -101,32 +83,32 @@ function getVariantPreviewAppScript(sapClient) {
  * @param options.localOnly no server available
  * @param options.addMock add a script for using the mockserver
  * @param options.addTest add a script for executing OPA tests
- * @param options.sapClient SAP client required for connecting to the backend
  * @param options.flpAppId local FLP id
  * @param options.startFile path that should be opened with the start script
  * @param options.localStartFile path that should be opend with the start-local script
  * @param options.generateIndex exclude the start-noflp script
+ * @param options.supportVirtualEndpoints whether to support virtual endpoints - search params will not be added as they are injected at runtime
  * @returns package.json scripts
  */
-function getPackageScripts({ localOnly, addMock = true, addTest = false, sapClient, flpAppId = '', startFile, localStartFile, generateIndex = true }) {
-    const searchParams = buildSearchParams(sapClient);
-    const params = buildParams(searchParams, flpAppId);
+function getPackageScripts({ localOnly, addMock = true, addTest = false, flpAppId = '', startFile, localStartFile, generateIndex = true, supportVirtualEndpoints = false }) {
+    const viewCacheSearchParams = new URLSearchParams([['sap-ui-xx-viewCache', 'false']]);
+    const queryParams = buildParams(supportVirtualEndpoints ? undefined : viewCacheSearchParams, flpAppId);
     const scripts = {
-        start: buildStartCommand(localOnly, params, startFile),
-        'start-local': `fiori run --config ./ui5-local.yaml --open "${localStartFile ?? 'test/flpSandbox.html'}${params}"`
+        start: buildStartCommand(localOnly, queryParams, startFile),
+        'start-local': `fiori run --config ./ui5-local.yaml --open "${localStartFile ?? 'test/flpSandbox.html'}${queryParams}"`
     };
     if (generateIndex) {
-        scripts['start-noflp'] = buildStartNoFLPCommand(localOnly, searchParams);
+        scripts['start-noflp'] = buildStartNoFLPCommand(localOnly, viewCacheSearchParams);
     }
     if (addMock) {
-        scripts['start-mock'] = `fiori run --config ./ui5-mock.yaml --open "test/flpSandbox.html${params}"`;
+        scripts['start-mock'] = `fiori run --config ./ui5-mock.yaml --open "${localStartFile ?? 'test/flpSandbox.html'}${queryParams}"`;
     }
     if (addTest) {
         scripts['int-test'] = 'fiori run --config ./ui5-mock.yaml --open "test/integration/opaTests.qunit.html"';
     }
     scripts['start-variants-management'] = localOnly
         ? `echo \\"${(0, i18n_1.t)('info.mockOnlyWarning')}\\"`
-        : getVariantPreviewAppScript(sapClient);
+        : getVariantPreviewAppScript(!supportVirtualEndpoints);
     return scripts;
 }
 //# sourceMappingURL=getPackageScripts.js.map

package/dist/npm-package-scripts/types.d.ts

@@ -37,5 +37,13 @@ export interface PackageScriptsOptions {
     localStartFile?: string;
     /** If true, a script for starting the app without flp will be generated. Defaults to true. */
     generateIndex?: boolean;
+    /**
+     * By default, search parameters are added to the preview scripts.
+     * If `supportVirtualEndpoints` is true, the generated scripts will not include the default search parameters.
+     * When virtual endpoints are used, the search parameters are injected at runtime.
+     *
+     * @default false
+     */
+    supportVirtualEndpoints?: boolean;
 }
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-generator-shared",
   "description": "Commonly used shared functionality and types to support the fiori generator.",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -25,8 +25,8 @@
     "os-name": "4.0.1",
     "semver": "7.5.4",
     "@sap-ux/btp-utils": "1.0.3",
-    "@sap-ux/project-access": "1.29.18",
-    "@sap-ux/telemetry": "0.5.74"
+    "@sap-ux/project-access": "1.29.19",
+    "@sap-ux/telemetry": "0.5.75"
   },
   "devDependencies": {
     "@types/mem-fs-editor": "7.0.1",