@sap-ux/fiori-app-sub-generator 0.0.2

package/generators/types/constants.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Features = exports.defaultNavActionDisplay = exports.defaultNavActionTile = exports.minSupportedUi5VersionV4 = exports.minSupportedUi5Version = exports.FPM_DEFAULT_PAGE_NAME = exports.generatorName = exports.MAIN_MODEL_NAME = exports.MAIN_DATASOURCE_NAME = exports.DEFAULT_SERVICE_PATH = exports.DEFAULT_CAP_HOST = exports.DEFAULT_HOST = exports.FIORI_STEPS = exports.STEP_FLP_CONFIG = exports.STEP_DEPLOY_CONFIG = exports.STEP_PROJECT_ATTRIBUTES = exports.STEP_ENTITY = exports.STEP_DATASOURCE_AND_SERVICE = exports.STEP_FLOORPLAN = exports.API_HUB_TYPE = exports.API_HUB_API_KEY = exports.SAP_CLIENT_KEY = exports.UI5_VERSION_PROPS = exports.PLATFORMS = exports.LEGACY_CAP_TYPE_JAVA = exports.LEGACY_CAP_TYPE_NODE = void 0;
+const i18n_1 = require("../utils/i18n");
+exports.LEGACY_CAP_TYPE_NODE = 'capNode';
+exports.LEGACY_CAP_TYPE_JAVA = 'capJava';
+exports.PLATFORMS = {
+    VSCODE: {
+        name: 'Visual Studio Code',
+        technical: 'VSCode'
+    },
+    SBAS: {
+        name: 'SAP Business Application Studio',
+        technical: 'SBAS'
+    },
+    CLI: {
+        name: 'CLI',
+        technical: 'CLI'
+    }
+};
+exports.UI5_VERSION_PROPS = {
+    OFFICIAL_URL: 'https://ui5.sap.com',
+    BCP_OFFICIAL_URL: 'https://sapui5.hana.ondemand.com',
+    SNAPSHOT_URL: 'https://sapui5preview-sapui5.dispatcher.int.sap.eu2.hana.ondemand.com',
+    VERSIONS_FILE: 'neo-app.json'
+};
+exports.SAP_CLIENT_KEY = 'sap-client';
+exports.API_HUB_API_KEY = 'API_HUB_API_KEY';
+exports.API_HUB_TYPE = 'API_HUB_TYPE';
+exports.STEP_FLOORPLAN = 'FLOORPLAN';
+exports.STEP_DATASOURCE_AND_SERVICE = 'DATASOURCE_AND_SERVICE';
+exports.STEP_ENTITY = 'ENTITY';
+exports.STEP_PROJECT_ATTRIBUTES = 'PROJECT_ATTRIBUTES';
+exports.STEP_DEPLOY_CONFIG = 'DEPLOY_CONFIG';
+exports.STEP_FLP_CONFIG = 'FLP_CONFIG';
+// All steps keyed on name
+exports.FIORI_STEPS = [
+    {
+        key: exports.STEP_FLOORPLAN,
+        name: (0, i18n_1.t)('steps.templateSelection.title'),
+        description: (0, i18n_1.t)('steps.templateSelection.description'),
+        order: 0
+    },
+    {
+        key: exports.STEP_DATASOURCE_AND_SERVICE,
+        name: (0, i18n_1.t)('steps.datasourceAndServiceSelection.title'),
+        description: (0, i18n_1.t)('steps.datasourceAndServiceSelection.description'),
+        order: 1
+    },
+    {
+        key: exports.STEP_ENTITY,
+        name: (0, i18n_1.t)('steps.entityOrViewConfig.title'),
+        description: (0, i18n_1.t)('steps.entityOrViewConfig.description'),
+        order: 2
+    },
+    {
+        key: exports.STEP_PROJECT_ATTRIBUTES,
+        name: (0, i18n_1.t)('steps.projectAttributesConfig.title'),
+        description: (0, i18n_1.t)('steps.projectAttributesConfig.description'),
+        order: 3
+    },
+    {
+        key: exports.STEP_DEPLOY_CONFIG,
+        name: (0, i18n_1.t)('steps.deployConfig.title'),
+        description: (0, i18n_1.t)('steps.deployConfig.description'),
+        dependency: (0, i18n_1.t)('steps.projectAttributesConfig.title'),
+        order: 4
+    },
+    {
+        key: exports.STEP_FLP_CONFIG,
+        name: (0, i18n_1.t)('steps.flpConfig.title'),
+        description: (0, i18n_1.t)('steps.flpConfig.decription'),
+        dependency: (0, i18n_1.t)('steps.projectAttributesConfig.title'),
+        order: 5
+    }
+];
+exports.DEFAULT_HOST = 'http://localhost';
+exports.DEFAULT_CAP_HOST = 'http://localhost:4004';
+exports.DEFAULT_SERVICE_PATH = '/sap/opu/odata';
+// Manifest constants
+exports.MAIN_DATASOURCE_NAME = 'mainService';
+exports.MAIN_MODEL_NAME = 'mainModel';
+// The generator name to appear in README.md, telemetry events and logs
+exports.generatorName = 'SAP Fiori Application Generator';
+exports.FPM_DEFAULT_PAGE_NAME = 'Main';
+// App gen specific (not writer specific) supported UI5 versions
+exports.minSupportedUi5Version = '1.65.0';
+exports.minSupportedUi5VersionV4 = '1.84.0';
+exports.defaultNavActionTile = 'tile';
+exports.defaultNavActionDisplay = 'display';
+/**
+ * Represents a list of App Generator specific feature toggles.
+ */
+var Features;
+(function (Features) {
+    Features["enableGAIntegration"] = "enableGAIntegration"; // Adds support for GA launch commands with GA links
+})(Features || (exports.Features = Features = {}));
+//# sourceMappingURL=constants.js.map

package/generators/types/external.d.ts

@@ -0,0 +1,261 @@
+import type { IPrompt as Step } from '@sap-devx/yeoman-ui-types';
+import type { Annotations } from '@sap-ux/axios-extension';
+import { TemplateType as FETemplateType } from '@sap-ux/fiori-elements-writer';
+import { TemplateType as FFTemplateType } from '@sap-ux/fiori-freestyle-writer';
+import type { PromptSeverityMessage } from '@sap-ux/inquirer-common';
+import type { DeployConfig, FLPConfig } from '@sap-ux/fiori-generator-shared';
+import type { CapRuntime, EntityRelatedAnswers } from '@sap-ux/odata-service-inquirer';
+import { OdataVersion } from '@sap-ux/odata-service-inquirer';
+import { promptNames as ui5AppInquirerPromptNames } from '@sap-ux/ui5-application-inquirer';
+import type { Answers, Question } from 'inquirer';
+import { type ALPOptions, type Project, type Service, type Floorplan, FloorplanFE, FloorplanFF } from './state';
+export { Floorplan, FloorplanFE, FloorplanFF };
+export type FloorplanKey = keyof typeof FloorplanFE | keyof typeof FloorplanFF;
+type FloorplanAttributesType = {
+    [K in Floorplan]: {
+        supportedODataVersion: OdataVersion[];
+        deprecated?: boolean;
+        templateType: FETemplateType | FFTemplateType;
+    };
+};
+export declare const FloorplanAttributes: FloorplanAttributesType;
+/**
+ * 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;
+    };
+}
+/**
+ * Defines the entity config property of the external app config interface used to generate in headless mode (no prompts)
+ */
+export interface EntityConfig {
+    mainEntity?: {
+        entityName: string;
+        type?: any;
+    };
+    filterEntityType?: string;
+    navigationEntity?: {
+        EntitySet: string;
+        Name: string;
+        Role?: string;
+    };
+    generateFormAnnotations?: boolean;
+    generateLROPAnnotations?: boolean;
+    qualifier?: string;
+    tableType?: EntityRelatedAnswers['tableType'];
+    hierarchyQualifier?: 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 FEAppConfig extends AppConfig {
+    readonly entityConfig: EntityConfig;
+    readonly alpOptions?: ALPOptions;
+}
+/**
+ * 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 FFAppConfig extends AppConfig {
+    project: AppConfig['project'] & {
+        readonly viewName?: string;
+    };
+    service?: AppConfig['service'];
+}
+/**
+ * Checks the capType provided for headless generation and converts
+ * to the new version (Node.js, Java) if required. Defaults to `Node.js` if not provided.
+ *
+ * @param capType - legacyCapType (capNode, capJava) OR cds runtime (Node.js, Java)
+ * @returns - CapRuntime (Node.js, Java)
+ */
+export declare function capTypeConversion(capType?: string): CapRuntime;
+/**
+ * Externally configurable generator settings, can be passed as options or by providing _getSettings() in generator extensions
+ *
+ * @deprecated These are legacy settings and should be provided via generator extensions if they relate to S/4 explicitly.
+ * In some cases they should be directly set as prompt options (e.g. from adaptors).
+ * See for example: https://github.wdf.sap.corp/ux-engineering/s4-fiori-tools-extensions/issues/385 .
+ * We can directly set the hiding of ui5 version prompt from inquirer prompt options via the extensions interface instead of a specific setting.
+ *
+ * NOTE: Only options specific to FE/FF generators should be passed as options, all other options should be provided via generator extensions
+ */
+export interface FioriGeneratorSettings {
+    /**
+     * Toggles ui5 version prompting
+     *
+     * @deprecated Use extensions + prompt options (UI5ApplcationInquirer `ui5Version` options 'hide') to control this
+     */
+    hideUI5VersionPrompt?: boolean;
+    /**
+     * Toggles the generation of index.html and excludes the start-noflp script from package.json
+     */
+    generateIndexHtml?: boolean;
+    /**
+     * Entity passed in to be set as the default in the (FE) mainEntity prompt
+     */
+    preselectedEntityName?: string;
+    /**
+     * Toggles whether a warning is shown if the service is draft enabled but does not support collaborative draft.
+     */
+    showCollabDraftWarning?: boolean;
+    /**
+     * Toggles Table Type prompt and layout options for LROP, Worklist and ALP floorplans
+     */
+    showLayoutPrompts?: boolean;
+}
+/**
+ * Defines the currently allowed extension points for a Fiori Generator prompt
+ * todo: Include open source inquirer prompt options (UI5ApplicationInquirer prompt options) also so extensions can directly use them
+ *
+ */
+export type PromptExtension = {
+    [key in ui5AppInquirerPromptNames]?: {
+        validate?: Question['validate'];
+        default?: Question['default'];
+        additionalMessages?: PromptSeverityMessage;
+    };
+};
+export interface FioriGeneratorPromptExtension {
+    [generatorName: string]: PromptExtension;
+}
+export interface ConditionalStep extends Step {
+    /**
+     * Provide a function which returns true when a step should be added, answers to previous questions will be provided
+     *
+     * @param answers
+     * @returns
+     */
+    when?: (answers?: Answers) => boolean;
+}
+/**
+ * Defines the API to extend and customise the Fiori Generator
+ *
+ */
+export interface FioriGeneratorExtensionAPI {
+    /**
+     * Returns the settings to control some prompt and generation options
+     */
+    _getSettings?: () => FioriGeneratorSettings;
+    /**
+     * Returns the extensions which extend existing Fiori generator prompts
+     */
+    _getExtensions?: () => FioriGeneratorPromptExtension;
+    /**
+     * Returns the navigation steps which group new prompts provided in the prompting phase
+     */
+    _getSteps?: () => ConditionalStep[];
+    /**
+     * Opt in for extension Telemetry
+     * Enabling this will result in SAP capturing extension name and version
+     */
+    enableTelemetryData?: boolean;
+}
+export type RecursiveReadonly<T> = {
+    readonly [P in keyof T]: RecursiveReadonly<T[P]>;
+};
+/**
+ * Fiori Elements internal floorplan/template/project types
+ *
+ * @deprecated Use FloorplanFE instead, will be removed shortly
+ */
+export declare enum PROJECT_TYPE {
+    Worklist = "worklist",
+    OverviewPage = "ovp",
+    ListReportObjectPage = "lrop",
+    AnalyticalListPage = "alp",
+    FormEntryObjectPage = "feop",
+    FlexibleProgrammingModel = "fpm"
+}
+/**
+ * Fiori Freestyle internal floorplan/template/project types
+ *
+ * @deprecated Use FloorplanFF instead, will be removed shortly
+ */
+export declare enum Template {
+    Simple = "basic"
+}
+/**
+ * To support deprecation of the project properties `projectType` from `@sap/generator-fiori-elements`
+ * and `template` from `@sap/generator-fiori-freestyle`, which used to be sub-generator specific, before merging the generators,
+ * adding the same properties to the exported ReadonlyState that is used by extensions to maintain compatibility with existing extensions.
+ * These will be removed in future.
+ */
+interface DeprecatedProjectProperties {
+    /**
+     * @deprecated Use ReadonlyState.floorplan instead
+     */
+    projectType?: PROJECT_TYPE;
+    /**
+     * @deprecated Use ReadonlyState.floorplan instead
+     */
+    template?: Template;
+}
+/**
+ * Export of internal Fiori generator state with all properties marked as readonly.
+ * For use with sub-generator extensions.
+ */
+export interface ReadonlyState {
+    readonly project: RecursiveReadonly<Partial<Project>> & DeprecatedProjectProperties;
+    readonly service: RecursiveReadonly<Partial<Service>>;
+    readonly entityRelatedConfig?: RecursiveReadonly<EntityRelatedAnswers>;
+    readonly floorplan: Floorplan;
+}
+export declare const defaultPromptValues: {
+    enableCodeAssist: boolean;
+    enableEslint: boolean;
+    skipAnnotations: boolean;
+    enableTypeScript: boolean;
+};
+//# sourceMappingURL=external.d.ts.map

package/generators/types/external.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultPromptValues = exports.Template = exports.PROJECT_TYPE = exports.FloorplanAttributes = exports.FloorplanFF = exports.FloorplanFE = void 0;
+exports.capTypeConversion = capTypeConversion;
+const fiori_elements_writer_1 = require("@sap-ux/fiori-elements-writer");
+const fiori_freestyle_writer_1 = require("@sap-ux/fiori-freestyle-writer");
+const odata_service_inquirer_1 = require("@sap-ux/odata-service-inquirer");
+const ui5_application_inquirer_1 = require("@sap-ux/ui5-application-inquirer");
+const constants_1 = require("./constants");
+const state_1 = require("./state");
+Object.defineProperty(exports, "FloorplanFE", { enumerable: true, get: function () { return state_1.FloorplanFE; } });
+Object.defineProperty(exports, "FloorplanFF", { enumerable: true, get: function () { return state_1.FloorplanFF; } });
+exports.FloorplanAttributes = {
+    [state_1.FloorplanFE.FE_LROP]: {
+        supportedODataVersion: [odata_service_inquirer_1.OdataVersion.v2, odata_service_inquirer_1.OdataVersion.v4],
+        templateType: fiori_elements_writer_1.TemplateType.ListReportObjectPage
+    },
+    [state_1.FloorplanFE.FE_ALP]: {
+        supportedODataVersion: [odata_service_inquirer_1.OdataVersion.v2, odata_service_inquirer_1.OdataVersion.v4],
+        templateType: fiori_elements_writer_1.TemplateType.AnalyticalListPage
+    },
+    [state_1.FloorplanFE.FE_WORKLIST]: {
+        supportedODataVersion: [odata_service_inquirer_1.OdataVersion.v2, odata_service_inquirer_1.OdataVersion.v4],
+        templateType: fiori_elements_writer_1.TemplateType.Worklist
+    },
+    [state_1.FloorplanFE.FE_FEOP]: {
+        supportedODataVersion: [odata_service_inquirer_1.OdataVersion.v4],
+        templateType: fiori_elements_writer_1.TemplateType.FormEntryObjectPage
+    },
+    [state_1.FloorplanFE.FE_OVP]: {
+        supportedODataVersion: [odata_service_inquirer_1.OdataVersion.v2, odata_service_inquirer_1.OdataVersion.v4],
+        templateType: fiori_elements_writer_1.TemplateType.OverviewPage
+    },
+    [state_1.FloorplanFE.FE_FPM]: {
+        supportedODataVersion: [odata_service_inquirer_1.OdataVersion.v4],
+        templateType: fiori_elements_writer_1.TemplateType.FlexibleProgrammingModel
+    },
+    [state_1.FloorplanFF.FF_SIMPLE]: {
+        supportedODataVersion: [odata_service_inquirer_1.OdataVersion.v2, odata_service_inquirer_1.OdataVersion.v4],
+        templateType: fiori_freestyle_writer_1.TemplateType.Basic
+    }
+};
+/**
+ * Checks the capType provided for headless generation and converts
+ * to the new version (Node.js, Java) if required. Defaults to `Node.js` if not provided.
+ *
+ * @param capType - legacyCapType (capNode, capJava) OR cds runtime (Node.js, Java)
+ * @returns - CapRuntime (Node.js, Java)
+ */
+function capTypeConversion(capType) {
+    if (capType === constants_1.LEGACY_CAP_TYPE_NODE || capType === 'Node.js') {
+        return 'Node.js';
+    }
+    else if (capType === constants_1.LEGACY_CAP_TYPE_JAVA || capType === 'Java') {
+        return 'Java';
+    }
+    return 'Node.js';
+}
+/**
+ * Fiori Elements internal floorplan/template/project types
+ *
+ * @deprecated Use FloorplanFE instead, will be removed shortly
+ */
+var PROJECT_TYPE;
+(function (PROJECT_TYPE) {
+    PROJECT_TYPE["Worklist"] = "worklist";
+    PROJECT_TYPE["OverviewPage"] = "ovp";
+    PROJECT_TYPE["ListReportObjectPage"] = "lrop";
+    PROJECT_TYPE["AnalyticalListPage"] = "alp";
+    PROJECT_TYPE["FormEntryObjectPage"] = "feop";
+    PROJECT_TYPE["FlexibleProgrammingModel"] = "fpm";
+})(PROJECT_TYPE || (exports.PROJECT_TYPE = PROJECT_TYPE = {}));
+/**
+ * Fiori Freestyle internal floorplan/template/project types
+ *
+ * @deprecated Use FloorplanFF instead, will be removed shortly
+ */
+var Template;
+(function (Template) {
+    Template["Simple"] = "basic";
+})(Template || (exports.Template = Template = {}));
+exports.defaultPromptValues = {
+    [ui5_application_inquirer_1.promptNames.enableCodeAssist]: false,
+    [ui5_application_inquirer_1.promptNames.enableEslint]: false,
+    [ui5_application_inquirer_1.promptNames.skipAnnotations]: false,
+    [ui5_application_inquirer_1.promptNames.enableTypeScript]: false
+};
+//# sourceMappingURL=external.js.map

package/generators/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './state';
+export * from './constants';
+export * from './common';
+export * from './yeomanUiStepConfig';
+export * from './external';
+export * from './telemetryEvents';
+//# sourceMappingURL=index.d.ts.map

package/generators/types/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./state"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./yeomanUiStepConfig"), exports);
+__exportStar(require("./external"), exports);
+__exportStar(require("./telemetryEvents"), exports);
+//# sourceMappingURL=index.js.map

package/generators/types/state.d.ts

@@ -0,0 +1,149 @@
+import type { Annotations } from '@sap-ux/axios-extension';
+import type { CapServiceCdsInfo } from '@sap-ux/cap-config-writer';
+import type { CdsUi5PluginInfo, UI5FlexLayer } from '@sap-ux/project-access';
+import type { TableSelectionMode } from '@sap-ux/fiori-elements-writer';
+import type { CapService, DatasourceType, EntityRelatedAnswers, OdataServiceAnswers, OdataVersion } from '@sap-ux/odata-service-inquirer';
+import type { ApiHubType, SapSystemSourceType } from '../types/constants';
+import type { Script } from './common';
+export interface Project {
+    targetFolder: string;
+    addDeployConfig?: boolean;
+    addFlpConfig?: boolean;
+    name: string;
+    namespace?: string;
+    title: string;
+    description: string;
+    ui5Theme: string;
+    ui5Version: string;
+    ui5FrameworkUrl?: string;
+    localUI5Version: string;
+    sapux?: boolean;
+    skipAnnotations?: boolean;
+    enableCodeAssist?: boolean;
+    enableEslint?: boolean;
+    enableTypeScript?: boolean;
+    formEntry?: boolean;
+    flpAppId?: string;
+    minSupportedUI5Version?: string;
+    manifestMinUI5Version?: string;
+}
+export interface Credentials {
+    username: string;
+    password?: string;
+}
+/**
+ * To be replaced with `@sap-ux/odata-service-inquirer`'s `OdataService` type once all data source flows are migrated ro open-ux-tools
+ *
+ */
+export interface Service {
+    host?: string;
+    client?: string;
+    destinationName?: string;
+    servicePath?: string;
+    edmx?: string;
+    annotations?: Annotations[];
+    version?: OdataVersion;
+    /**
+     * While the required type `CapServiceCdsInfo` mandates `cdsUi5PluginInfo` when writing to cap config, this information is not intially available.
+     * So we make it optional here.
+     */
+    capService?: Omit<CapServiceCdsInfo, 'cdsUi5PluginInfo'> & {
+        cdsUi5PluginInfo?: CdsUi5PluginInfo;
+    };
+    source: DatasourceType;
+    sapSystemSource?: SapSystemSourceType;
+    localEdmxFilePath?: string;
+    /**
+     * Connected system information, used for preview settings and deploy configurations
+     */
+    connectedSystem?: OdataServiceAnswers['connectedSystem'];
+    /**
+     * Only used by adaptors to specify the authentication type, use `connectedSystem.destination.Authentication` instead
+     */
+    destinationAuthType?: string;
+    apiHubConfig?: ApiHubConfig;
+    ignoreCertError?: boolean;
+}
+/**
+ * Defines the api hub service properties or enterprise and non-enterprise versions
+ */
+export interface ApiHubConfig {
+    apiHubKey: string;
+    apiHubType: ApiHubType;
+}
+export interface CapServiceCdsInfoInternal extends CapService {
+    capCdsInfo?: CdsUi5PluginInfo;
+}
+/** package.json interface */
+export interface PackageJson {
+    name: string;
+    description: string;
+    startCommand: string;
+    startLocalCommand: string;
+    startNoFlpCommand: string;
+    startVariantsCommand: string;
+    addMockCommand?: boolean;
+    sapClientParam?: string;
+    flpAppId?: string;
+    devDependencies: {
+        [key: string]: string;
+    };
+    ui5Dependencies: string[];
+    sapux?: boolean;
+    startFile?: string;
+    localStartFile?: string;
+    runTasks?: Script[];
+    enableEslint: boolean;
+    sapuxLayer?: UI5FlexLayer;
+}
+export interface State {
+    project: Project;
+    service: Service;
+    /**
+     * Entity configuration for templates that require it
+     */
+    entityRelatedConfig?: EntityRelatedAnswers;
+    /**
+     * View name for templates that require it (e.g. freestyle)
+     */
+    viewName?: string;
+    /**
+     * The template selected by the user, maybe FE or FF
+     */
+    floorplan: Floorplan;
+}
+/** Only used by headless */
+export interface ALPOptions {
+    qualifier: string;
+    multiSelect: boolean;
+    autoHide: boolean;
+    smartVariantManagement: boolean;
+    selectionMode: TableSelectionMode;
+}
+/**
+ * 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;
+//# sourceMappingURL=state.d.ts.map

package/generators/types/state.js

@@ -0,0 +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=state.js.map