@sap-ux/fiori-generator-shared 0.13.1 → 0.13.3

package/dist/constants.d.ts

@@ -1,3 +1,4 @@
 export declare const YUI_EXTENSION_ID = "sapos.yeoman-ui";
 export declare const YUI_MIN_VER_FILES_GENERATED_MSG = "1.16.6";
+export declare const SCRIPT_FLP_SANDBOX = "/test/flpSandbox.html";
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.YUI_MIN_VER_FILES_GENERATED_MSG = exports.YUI_EXTENSION_ID = void 0;
+exports.SCRIPT_FLP_SANDBOX = exports.YUI_MIN_VER_FILES_GENERATED_MSG = exports.YUI_EXTENSION_ID = void 0;
 exports.YUI_EXTENSION_ID = 'sapos.yeoman-ui';
 // From YUI version 1.16.6 the message 'The files have been generated.' is not shown unless a top level dir is created
 exports.YUI_MIN_VER_FILES_GENERATED_MSG = '1.16.6';
+exports.SCRIPT_FLP_SANDBOX = '/test/flpSandbox.html';
 //# sourceMappingURL=constants.js.map

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPackageScripts = getPackageScripts;
 const i18n_1 = require("../i18n");
+const constants_1 = require("../constants");
 /**
  * Builds the command for the `start-noflp` script in `package.json`.
  *
@@ -20,7 +21,7 @@ function buildStartNoFLPCommand(localOnly, searchParams) {
     if (localOnly) {
         return `echo \\"${(0, i18n_1.t)('info.mockOnlyWarning')}\\"`;
     }
-    return `fiori run --open "index.html${searchParam}"`;
+    return `fiori run --open "/index.html${searchParam}"`;
 }
 /**
  * Constructs a URL parameter string from search parameters and an optional FLP app ID.
@@ -43,7 +44,7 @@ function buildParams(searchParams, flpAppId) {
  *                               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'`.
+ *                                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.
  */
@@ -51,7 +52,7 @@ function buildStartCommand(localOnly, params, startFile) {
     if (localOnly) {
         return `echo \\"${(0, i18n_1.t)('info.mockOnlyWarning')}\\"`;
     }
-    return `fiori run --open "${startFile ?? 'test/flpSandbox.html'}${params}"`;
+    return `fiori run --open "${startFile ?? constants_1.SCRIPT_FLP_SANDBOX}${params}"`;
 }
 /**
  * Generates a variant management script in preview mode.
@@ -74,7 +75,7 @@ function getVariantPreviewAppScript(addSearchParams) {
     // 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}\"`;
+    return `fiori run --open \"/preview.html${urlParam}${previewAppAnchor}\"`;
 }
 /**
  * Get an object reflecting the scripts that need to be added to the package.json.
@@ -95,16 +96,16 @@ function getPackageScripts({ localOnly, addMock = true, addTest = false, flpAppI
     const queryParams = buildParams(supportVirtualEndpoints ? undefined : viewCacheSearchParams, flpAppId);
     const scripts = {
         start: buildStartCommand(localOnly, queryParams, startFile),
-        'start-local': `fiori run --config ./ui5-local.yaml --open "${localStartFile ?? 'test/flpSandbox.html'}${queryParams}"`
+        'start-local': `fiori run --config ./ui5-local.yaml --open "${localStartFile ?? constants_1.SCRIPT_FLP_SANDBOX}${queryParams}"`
     };
     if (generateIndex) {
         scripts['start-noflp'] = buildStartNoFLPCommand(localOnly, viewCacheSearchParams);
     }
     if (addMock) {
-        scripts['start-mock'] = `fiori run --config ./ui5-mock.yaml --open "${localStartFile ?? 'test/flpSandbox.html'}${queryParams}"`;
+        scripts['start-mock'] = `fiori run --config ./ui5-mock.yaml --open "${localStartFile ?? constants_1.SCRIPT_FLP_SANDBOX}${queryParams}"`;
     }
     if (addTest) {
-        scripts['int-test'] = 'fiori run --config ./ui5-mock.yaml --open "test/integration/opaTests.qunit.html"';
+        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')}\\"`

package/dist/types/app-gen.d.ts

@@ -78,5 +78,32 @@ export interface AppGenInfo {
      */
     externalParameters?: ExternalParameters;
 }
+/**
+ * Due to ts(18033) we cannot use the type values directly here:
+ * FF_SIMPLE = FFTemplateType.Basic // Once https://github.com/microsoft/TypeScript/pull/59475 is merged we can remove the hardcoded values and directly use the template values
+ */
+export declare enum FloorplanFF {
+    FF_SIMPLE = "basic"
+}
+/**
+ * Due to ts(18033) we cannot use the type values directly here:
+ * Once https://github.com/microsoft/TypeScript/pull/59475 is merged we can remove hardcoded values and directly use the template values
+ * FE_FPM = FETemplateType.FlexibleProgrammingModel,
+ * FE_LROP = FETemplateType.ListReportObjectPage,
+ * FE_OVP = FETemplateType.OverviewPage,
+ * FE_ALP = FETemplateType.AnalyticalListPage,
+ * FE_FEOP = FETemplateType.FormEntryObjectPage,
+ * FE_WORKLIST = FETemplateType.Worklist
+ */
+export declare enum FloorplanFE {
+    FE_FPM = "fpm",
+    FE_LROP = "lrop",
+    FE_OVP = "ovp",
+    FE_ALP = "alp",
+    FE_FEOP = "feop",
+    FE_WORKLIST = "worklist"
+}
+export type Floorplan = FloorplanFE | FloorplanFF;
+export type FloorplanKey = keyof typeof FloorplanFE | keyof typeof FloorplanFF;
 export {};
 //# sourceMappingURL=app-gen.d.ts.map

package/dist/types/app-gen.js

@@ -1,3 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FloorplanFE = exports.FloorplanFF = void 0;
+// Union types to expose a single interface property for Floorplan
+// This provides a layer of abstraction to isolate internal changes from external headless API consumers
+// Since these keys are used as an external API definiton they need to be meaningful
+// Note that ordering here determines rendering order
+/**
+ * Due to ts(18033) we cannot use the type values directly here:
+ * FF_SIMPLE = FFTemplateType.Basic // Once https://github.com/microsoft/TypeScript/pull/59475 is merged we can remove the hardcoded values and directly use the template values
+ */
+var FloorplanFF;
+(function (FloorplanFF) {
+    FloorplanFF["FF_SIMPLE"] = "basic";
+})(FloorplanFF || (exports.FloorplanFF = FloorplanFF = {}));
+/**
+ * Due to ts(18033) we cannot use the type values directly here:
+ * Once https://github.com/microsoft/TypeScript/pull/59475 is merged we can remove hardcoded values and directly use the template values
+ * FE_FPM = FETemplateType.FlexibleProgrammingModel,
+ * FE_LROP = FETemplateType.ListReportObjectPage,
+ * FE_OVP = FETemplateType.OverviewPage,
+ * FE_ALP = FETemplateType.AnalyticalListPage,
+ * FE_FEOP = FETemplateType.FormEntryObjectPage,
+ * FE_WORKLIST = FETemplateType.Worklist
+ */
+var FloorplanFE;
+(function (FloorplanFE) {
+    FloorplanFE["FE_FPM"] = "fpm";
+    FloorplanFE["FE_LROP"] = "lrop";
+    FloorplanFE["FE_OVP"] = "ovp";
+    FloorplanFE["FE_ALP"] = "alp";
+    FloorplanFE["FE_FEOP"] = "feop";
+    FloorplanFE["FE_WORKLIST"] = "worklist";
+})(FloorplanFE || (exports.FloorplanFE = FloorplanFE = {}));
 //# sourceMappingURL=app-gen.js.map

package/dist/types/cap.d.ts

@@ -0,0 +1,2 @@
+export type CapRuntime = 'Node.js' | 'Java';
+//# sourceMappingURL=cap.d.ts.map

package/dist/types/cap.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=cap.js.map

package/dist/types/headless.d.ts

@@ -1,3 +1,6 @@
+import type { Annotations } from '@sap-ux/axios-extension';
+import type { FloorplanKey } from './app-gen';
+import type { CapRuntime } from './cap';
 /**
  * Shared types used by headless generation from multiple modules
  */
@@ -67,4 +70,56 @@ export interface FLPConfig {
     readonly title?: string;
     readonly semanticObject?: string;
 }
+/**
+ * Defines the external interface used to generate in headless mode (no prompts)
+ * This is a deliberate re-definition of internal interfaces to avoid consumers having
+ * to update when internal interfaces are changed
+ * NOTE: Any breaking changes to this interface require a version bump
+ */
+export interface AppConfig {
+    readonly version: string;
+    readonly floorplan: FloorplanKey;
+    project: {
+        readonly name: string;
+        targetFolder?: string;
+        readonly namespace?: string;
+        readonly title?: string;
+        readonly description?: string;
+        readonly ui5Theme?: string;
+        readonly ui5Version?: string;
+        readonly localUI5Version?: string;
+        readonly sapux?: boolean;
+        readonly skipAnnotations?: boolean;
+        readonly enableCodeAssist?: boolean;
+        readonly enableEslint?: boolean;
+        readonly enableTypeScript?: boolean;
+    };
+    service?: {
+        readonly host?: string;
+        readonly servicePath?: string;
+        readonly client?: string;
+        readonly scp?: boolean;
+        readonly destination?: string;
+        readonly destinationInstance?: string;
+        readonly edmx?: string;
+        readonly annotations?: Annotations | Annotations[];
+        readonly capService?: {
+            readonly projectPath: string;
+            readonly serviceName: string;
+            readonly serviceCdsPath: string;
+            readonly capType?: CapRuntime;
+            readonly appPath?: string;
+        };
+        readonly apiHubApiKey?: string;
+    };
+    deployConfig?: DeployConfig;
+    flpConfig?: FLPConfig;
+    /**
+     * Adds telemetry data when passed to generator `@sap/generator-fiori:headless`
+     */
+    telemetryData?: {
+        generationSourceName?: string;
+        generationSourceVersion?: string;
+    };
+}
 //# sourceMappingURL=headless.d.ts.map

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from './app-gen';
+export * from './cap';
 export * from './environment';
 export * from './headless';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./app-gen"), exports);
+__exportStar(require("./cap"), exports);
 __exportStar(require("./environment"), exports);
 __exportStar(require("./headless"), exports);
 //# sourceMappingURL=index.js.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.13.1",
+  "version": "0.13.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -34,6 +34,7 @@
     "@types/semver": "7.5.2",
     "@types/vscode": "1.73.1",
     "@types/yeoman-environment": "2.10.11",
+    "@sap-ux/axios-extension": "1.22.3",
     "@sap-ux/logger": "0.7.0"
   },
   "engines": {