import type { AdpPreviewConfig } from '@sap-ux/adp-tooling'; import type { UI5FlexLayer } from '@sap-ux/project-access'; /** * Intent object consisting of an object and an action. */ export interface Intent { object: string; action: string; } /** * Configuration for additional applications */ export interface App { target: string; /** * Either a local path to a folder containing the application or the componentId of a remote app */ local?: string; /** * Optional component id if it differs from the manifest (e.g. for adaptation projects) */ componentId?: string; intent?: Intent; } export interface RtaEditor { path: string; developerMode?: boolean; pluginScript?: string; generator?: string; } export type RtaConfig = Omit & { endpoints: RtaEditor[]; }; interface InternalRtaConfig { layer?: UI5FlexLayer; options?: { [key: string]: unknown; baseId?: string; projectId?: string; scenario?: string; appName?: string; }; editors: RtaEditor[]; } /** * FLP preview configuration. */ export interface FlpConfig { path: string; intent: Intent; /** * Optional: if set to true then a locate-reuse-libs script will be attached to the html */ libs?: boolean; apps: App[]; theme?: string; /** * Optional: allows to specify a custom init script executed in addition to the default one */ init?: string; /** * Optional: if set to true then the new FLP homepage will be enabled */ enhancedHomePage?: boolean; /** * Optional: if set to true, opts in to the new FLP Sandbox when the UI5 version qualifies (>= 1.150). * Defaults to false. */ useNewSandbox?: boolean; /** * Optional: if set to true, the new FLP Sandbox will navigate directly to the app on startup * instead of showing the FLP home screen first. Only applies when the new Sandbox is active. * Defaults to false. */ navigateToApp?: boolean; } /** * Configration for the virtual test pages endpoints. */ export interface TestConfig { framework: 'OPA5' | 'QUnit' | 'Testsuite'; /** * Path hosting the main test page */ path?: string; /** * Path to the init script */ init?: string; /** * Pattern to match the test files */ pattern?: string; /** * Optional: when true, each OPA5 journey runs in its own isolated test page. * Only meaningful when framework is 'OPA5'. */ isolateJourneys?: boolean; } /** * Test configuration that has been enriched with the defaults in case of missing values. */ export type CompleteTestConfig = Required; /** * Test configuration defaults. */ export type TestConfigDefaults = { qunit: { path: '/test/unitTests.qunit.html'; init: '/test/unitTests.qunit.js'; pattern: '/test/**/*Test.{js,ts}'; framework: 'QUnit'; isolateJourneys: false; }; opa5: { path: '/test/opaTests.qunit.html'; init: '/test/opaTests.qunit.js'; pattern: '/test/**/*Journey{,.gen}.{js,ts}'; framework: 'OPA5'; isolateJourneys: false; }; testsuite: { path: '/test/testsuite.qunit.html'; init: '/test/testsuite.qunit.js'; pattern: ''; framework: 'Testsuite'; isolateJourneys: false; }; }; export type CardGeneratorConfig = { path?: string; }; /** * Middleware configuration. */ export interface MiddlewareConfig { flp?: Partial; test?: TestConfig[]; /** * @deprecated use editors.rta instead. */ rta?: InternalRtaConfig; editors?: { rta?: RtaConfig; cardGenerator?: CardGeneratorConfig; }; adp?: AdpPreviewConfig; debug?: boolean; } export type DefaultFlpPath = '/test/flp.html'; export type DefaultIntent = { object: 'app'; action: 'preview'; }; type FLPAppsCatalog = { identification: { id: string; title: string; }; payload: { viz: string[]; }; }; type FLPAppVisualization = { vizType: string; businessApp: string; vizConfig: { 'sap.app': { title: string; subTitle: string; }; 'sap.flp': { target: { appId: string; inboundId: string; parameters: { name: string; value: string; }[]; }; }; }; }; type FLPApp = { 'sap.app': { id: string; title: string; crossNavigation: { inbounds: { [key: string]: { semanticObject: string; action: string; title: string; subTitle: string; signature: { additionalParameters: string; }; }; }; }; }; 'sap.ui5': { componentName: string; }; 'sap.ui': { technology: string; }; 'sap.platform.runtime': { componentProperties: { url: string; asyncHints: Record; }; }; }; type FLPSectionVizConfig = { id: string; vizId: string; }; type FLPSection = { id: string; title: string; default: boolean; layout: { vizOrder: FLPSectionVizConfig['id'][]; }; viz: Record; }; type FLPPage = { identification: { id: string; title: string; }; payload: { layout: { sectionOrder: FLPSection['id'][]; }; sections: Record; }; }; /** * FLP CDM configuration. */ export type FLPCdmConfig = { _version: string; catalogs: Record; visualizations: Record; applications: Record; pages: Record; }; /** * Default FLP homepage configuration. */ export declare const FLPHomePageDefaults: { pageName: string; catalogId: string; sectionId: string; }; export type Ui5Version = { major: number; minor: number; patch: number; label?: string; /** * Indicates if the UI5 version is served from CDN. */ isCdn: boolean; }; export interface MultiCardsPayload { type: string; manifest: CardManifest; entitySet: string; } export interface I18nEntry { key: string; value: string; comment?: string; annotation?: string; } export interface CardManifest { 'sap.card'?: { type?: string; header?: Record; data?: { request?: { url: string; }; }; configuration?: { parameters?: Record>; }; [key: string]: unknown; }; 'sap.insights': { versions?: { dtpMiddleware?: string; }; }; } export {}; //# sourceMappingURL=index.d.ts.map