@sap-ux/fiori-generator-shared 0.3.21 → 0.5.0

package/dist/getPackageScripts.d.ts

@@ -0,0 +1,17 @@
+import type { PackageJsonScripts, PackageScriptsOptions } from './types';
+/**
+ * Get an object reflecting the scripts that need to be added to the package.json.
+ *
+ * @param options Collection of mostly optional settings.
+ * @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
+ * @returns package.json scripts
+ */
+export declare function getPackageScripts({ localOnly, addMock, addTest, sapClient, flpAppId, startFile, localStartFile, generateIndex }: PackageScriptsOptions): PackageJsonScripts;
+//# sourceMappingURL=getPackageScripts.d.ts.map

package/dist/getPackageScripts.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPackageScripts = void 0;
+const i18n_1 = require("./i18n");
+/**
+ * Builds the command for the `start-noflp` script in `package.json`.
+ *
+ * This command is used to start the application without the FLP configuration.
+ *
+ * @param {boolean} localOnly - Indicates whether only a local server is available. If `true`,
+ *                               a warning message is returned instead of a command.
+ * @param {URLSearchParams} searchParams - The search parameters to be included in the command URL.
+ * @returns {string} - The command to be used in the `start-noflp` script. If `localOnly` is `true`,
+ *                     returns a warning message. Otherwise, returns a `fiori run` command with the
+ *                     appropriate parameters.
+ */
+function buildStartNoFLPCommand(localOnly, searchParams) {
+    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.
+ *
+ * @param {URLSearchParams} searchParams - The search parameters to include in the query string.
+ * @param {string} [flpAppId] - The FLP app ID to be included as a fragment identifier.
+ *                               If not provided, the fragment identifier will be omitted.
+ * @returns {string} - A string representing the combined query parameters and fragment identifier.
+ *                      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}` : '';
+    return `${searchParam}${hashFragment}`;
+}
+/**
+ * Constructs the command for the `start` script in `package.json`.
+ *
+ * @param {boolean} localOnly - Indicates whether only a local server is available. If `true`, a warning
+ *                               message is returned instead of a command.
+ * @param {string} params - The query parameters to be included in the command URL.
+ * @param {string} [startFile] - The path to the file to be opened with the `start` command.
+ *                                If not provided, defaults to `'test/flpSandbox.html'`.
+ * @returns {string} - The command for the `start` script, including either a warning message or the `fiori run`
+ *                     command with the specified file and parameters.
+ */
+function buildStartCommand(localOnly, params, startFile) {
+    if (localOnly) {
+        return `echo \\"${(0, i18n_1.t)('info.mockOnlyWarning')}\\"`;
+    }
+    return `fiori run --open "${startFile ?? 'test/flpSandbox.html'}${params}"`;
+}
+/**
+ * Generates a variant management script in preview mode.
+ *
+ * @param {string} sapClient - The SAP client parameter to include in the URL. If not provided, the URL will not include the `sap-client` parameter.
+ * @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('&')}`;
+    // 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
+    return `fiori run --open \"preview.html${urlParam}${previewAppAnchor}\"`;
+}
+/**
+ * Get an object reflecting the scripts that need to be added to the package.json.
+ *
+ * @param options Collection of mostly optional settings.
+ * @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
+ * @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);
+    const scripts = {
+        start: buildStartCommand(localOnly, params, startFile),
+        'start-local': `fiori run --config ./ui5-local.yaml --open "${localStartFile ?? 'test/flpSandbox.html'}${params}"`
+    };
+    if (generateIndex) {
+        scripts['start-noflp'] = buildStartNoFLPCommand(localOnly, searchParams);
+    }
+    if (addMock) {
+        scripts['start-mock'] = `fiori run --config ./ui5-mock.yaml --open "test/flpSandbox.html${params}"`;
+    }
+    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);
+    return scripts;
+}
+exports.getPackageScripts = getPackageScripts;
+//# sourceMappingURL=getPackageScripts.js.map

package/dist/i18n.d.ts

@@ -0,0 +1,14 @@
+import type { TOptions } from 'i18next';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18n(): Promise<void>;
+/**
+ * Helper function facading the call call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.initI18n = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const fiori_generator_shared_i18n_json_1 = __importDefault(require("./translations/fiori-generator-shared.i18n.json"));
+const NS = 'fiori-freestyle-writer';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+async function initI18n() {
+    await i18next_1.default.init({
+        resources: {
+            en: {
+                [NS]: fiori_generator_shared_i18n_json_1.default
+            }
+        },
+        lng: 'en',
+        fallbackLng: 'en',
+        defaultNS: NS,
+        ns: [NS]
+    });
+}
+exports.initI18n = initI18n;
+/**
+ * Helper function facading the call call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n().catch(() => {
+    // Ignore any errors since the write will still work
+});
+//# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export * from './cap';
 export * from './environment';
+export { getPackageScripts } from './getPackageScripts';
 export { getBootstrapResourceUrls } from './helpers';
 export { generateReadMe } from './read-me';
 export * from './system-utils';
+export { PackageJsonScripts } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,9 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReadMe = exports.getBootstrapResourceUrls = void 0;
+exports.generateReadMe = exports.getBootstrapResourceUrls = exports.getPackageScripts = void 0;
 __exportStar(require("./cap"), exports);
 __exportStar(require("./environment"), exports);
+var getPackageScripts_1 = require("./getPackageScripts");
+Object.defineProperty(exports, "getPackageScripts", { enumerable: true, get: function () { return getPackageScripts_1.getPackageScripts; } });
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "getBootstrapResourceUrls", { enumerable: true, get: function () { return helpers_1.getBootstrapResourceUrls; } });
 var read_me_1 = require("./read-me");

package/dist/translations/fiori-generator-shared.i18n.json

@@ -0,0 +1,5 @@
+{
+    "info": {
+        "mockOnlyWarning": "This application was generated with a local metadata file and does not reference a live server. Please add the required server configuration or start this application with mock data using the target: npm run start-mock"
+    }
+}

package/dist/types.d.ts

@@ -53,5 +53,43 @@ export interface ReadMe {
     /** Additional custom entries for the application. */
     additionalEntries?: AdditionalEntries[];
 }
+/**
+ * Defines the structure for the `package.json` scripts section.
+ */
+export interface PackageJsonScripts {
+    /** The command to start the application. */
+    start: string;
+    /** The command to start the application with local configuration */
+    'start-local': string;
+    /** Optional command to start the application without flp command. */
+    'start-noflp'?: string;
+    /** Optional command to start the application with a mock server configuration. */
+    'start-mock'?: string;
+    /** Optional command to run tests. */
+    'int-test'?: string;
+    /** Optional command to add the variants management script. */
+    'start-variants-management'?: string;
+}
+/**
+ * Defines the options for generating `package.json` scripts.
+ */
+export interface PackageScriptsOptions {
+    /** Specifies whether only a local server is available. If true, certain scripts may display a warning message. */
+    localOnly: boolean;
+    /** Indicates if a script for using a mock server should be added. Defaults to true. */
+    addMock?: boolean;
+    /** Indicates if a script for running integration tests should be added. Defaults to false. */
+    addTest?: boolean;
+    /** The SAP client to be used, if applicable. */
+    sapClient?: string;
+    /** The flp app ID to be used in URLs. */
+    flpAppId?: string;
+    /** The path to the file that should be opened with the `start` script. */
+    startFile?: string;
+    /** The path to the file that should be opened with the `start-local` script. */
+    localStartFile?: string;
+    /** If true, a script for starting the app without flp will be generated. Defaults to true. */
+    generateIndex?: boolean;
+}
 export {};
 //# 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.3.21",
+  "version": "0.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -17,10 +17,11 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "i18next": "20.6.1",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "@sap-ux/btp-utils": "0.15.2",
-    "@sap-ux/project-access": "1.27.3"
+    "@sap-ux/project-access": "1.27.4"
   },
   "devDependencies": {
     "@types/mem-fs-editor": "7.0.1",