@sap/artifact-management-types 1.13.0 → 1.14.2

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@sap/artifact-management-types",
-  "version": "1.13.0",
+  "version": "1.14.2",
   "description": "Type signatures for artifact management",
   "types": "./src/index.d.ts",
   "main": "./src/index.d.ts",
   "scripts": {
     "compile": "tsc -p ./",
-    "modify-types-import": "npm i && gulp --gulpfile ../../gulpfile.js modifyTypesImport",
+    "modify-types-import": "npm i --no-save ../../../artifact-management-base/out/lib-types/*.tgz && npm i && gulp --gulpfile ../../gulpfile.js modifyTypesImport",
     "pack": "npm run modify-types-import && npm pack"
   },
   "dependencies": {
-    "@sap/artifact-management-base-types": "^1.1.0"
+    "@sap/artifact-management-base-types": "1.14.2"
   },
   "devDependencies": {
     "gulp": "4.0.2"

package/src/cp/CFProjectBuilder.d.ts

@@ -17,12 +17,13 @@ export default class CFProjectBuilder implements ProjectBuilder {
     projectGeneratorContext: ModuleGeneratorContext;
     fs: ProjectFileSystem;
     nameFactory: NameFactory;
+    useHeadlessGenerator: boolean;
     private moduleCommandMap;
     /**
      * Temporary files required for MTAR build
      */
     buildFs: ProjectFileSystem;
-    constructor(project: Project, fs: ProjectFileSystem);
+    constructor(project: Project, fs: ProjectFileSystem, useHeadlessGenerator?: boolean);
     private filterWorkflowModule;
     build(): Promise<void>;
     isApplicationSummaryFilePresent(): Promise<boolean>;

package/src/definitions/BuildFactory.d.ts

@@ -2,5 +2,5 @@ import { PlatformContext } from '../project/PlatformContext';
 import CFProjectBuilder from '../cp/CFProjectBuilder';
 import { ProjectFileSystem, Project } from '@sap/artifact-management-base-types';
 export default class BuildFactory {
-    static getBuilder(context: PlatformContext, project: Project, fs: ProjectFileSystem): CFProjectBuilder;
+    static getBuilder(context: PlatformContext, project: Project, fs: ProjectFileSystem, useHeadlessGenerator?: boolean): CFProjectBuilder;
 }

package/src/plugins/cap/CapRun.d.ts

@@ -2,5 +2,6 @@ import { KeyIn, ProjectType, ProjectRunner, RunOptions } from '@sap/artifact-man
 export default class CapRun extends ProjectRunner {
     getType(): KeyIn<typeof ProjectType>;
     run({ fs, project, options }: RunOptions): Promise<void>;
+    private needRun;
     private buildOptions;
 }

package/src/plugins/cap/readers/CapModuleReader.d.ts

@@ -1,4 +1,4 @@
-import { ProjectFileSystem, Item, ModuleReader, ModuleType, ModuleData, ProjectEntityReaderReadOptions, DetectionMechanism, KeyIn } from '@sap/artifact-management-base-types';
+import { ProjectFileSystem, Item, ModuleReader, ModuleType, ModuleData, ProjectEntityReaderReadOptions, DetectionMechanism, KeyIn, ItemDetailInfoOptions } from '@sap/artifact-management-base-types';
 export default class CapModuleReader extends ModuleReader {
     getType(): KeyIn<typeof ModuleType>;
     getDetectionMechanism(): DetectionMechanism;
@@ -13,7 +13,7 @@ export default class CapModuleReader extends ModuleReader {
         types: string[];
         tags: string[];
         read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
-        detailInfo: (fs: ProjectFileSystem, ref: string) => Promise<Item | undefined>;
+        detailInfo: (fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions | undefined) => Promise<Item | undefined>;
     } | {
         matchConditions: {
             requiredFilePatterns: string[];
@@ -30,7 +30,7 @@ export default class CapModuleReader extends ModuleReader {
         fs: ProjectFileSystem;
     }): Promise<ModuleData | undefined>;
     provideFromCds({ fs }: ProjectEntityReaderReadOptions): Promise<Item[]>;
-    detailInfo(fs: ProjectFileSystem, ref: string): Promise<Item | undefined>;
+    detailInfo(fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions): Promise<Item | undefined>;
     readCSV({ fs, matchedFiles }: ProjectEntityReaderReadOptions): Promise<Item[]>;
     private getExternalServicePaths;
     private getRef;

package/src/plugins/ui5/generators/UI5ModuleGenerator.d.ts

@@ -5,6 +5,7 @@ export default class UI5ModuleGenerator implements UI5ModuleManifestGenerator {
     getType(): KeyIn<typeof ModuleType>;
     provideResources(): Promise<never[]>;
     beforeBuildCommands(): Promise<string[]>;
-    getModuleManifest(context: ModuleGeneratorContext): Promise<MtaModule | null>;
+    getModuleManifest(context: ModuleGeneratorContext, useHeadlessGenerator?: boolean): Promise<MtaModule | null>;
     requires(): MtaModuleRequires[];
+    runHeadlessDeploymentGenerator(context: ModuleGeneratorContext): Promise<void>;
 }

package/src/project-api/DataFirstUtil.d.ts

@@ -0,0 +1,17 @@
+export default class DataFirstUtil {
+    private projectImpl;
+    constructor(projectImpl: any);
+    parseCSVFile(path: string, absolutePath?: boolean): Promise<any>;
+    parseXMLFile(path: string, absolutePath?: boolean): Promise<any>;
+    setMainEntity(data: any, mainEntityName?: string): void;
+    private processDataTypes;
+    private processValues;
+    private normalizeValues;
+    private setKeyColumn;
+    private alignAssociationProps;
+    private propsNeedAligned;
+    private getJsDataType;
+    private getExcelDataType;
+    private checkIfUUIDColumn;
+    private isId;
+}

package/src/project-api/ProjectApi.d.ts

@@ -1,4 +1,4 @@
-import { Project, ItemFilter, Item, ProjectFileSystem, Tag, ItemType, ProjectData, ModuleData, KeyIn } from '@sap/artifact-management-base-types';
+import { Project, ItemFilter, Item, ProjectFileSystem, Tag, ItemType, ProjectData, ModuleData, KeyIn, ItemDetailInfoOptions } from '@sap/artifact-management-base-types';
 import ItemWatcherApi from './ItemWatcherApi';
 import AutoBuilder from './AutoBuilder';
 import { IChildLogger } from '@vscode-logging/types';
@@ -37,7 +37,7 @@ export default interface ProjectApi {
      * @param ref
      * @param entityPath
      */
-    getDetailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, logger?: IChildLogger): Promise<Item | undefined>;
+    getDetailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, options?: ItemDetailInfoOptions, logger?: IChildLogger): Promise<Item | undefined>;
     /**
      * It starts the CDS server and watches for any modifications in the files, if any changes detected it automatically restarts to serve the new content.
      * @param options comma separated list of options and their values. e.g. ['port', '8008', 'open']. Currently only supports port number and open option.

package/src/project-api/ProjectImpl.d.ts

@@ -1,4 +1,4 @@
-import { Project, ItemFilter, Tag, ItemType, ModuleData, ProjectData, KeyIn, ProjectFileSystem, Item } from '@sap/artifact-management-base-types';
+import { Project, ItemFilter, Tag, ItemType, ModuleData, ProjectData, KeyIn, ProjectFileSystem, Item, ItemDetailInfoOptions } from '@sap/artifact-management-base-types';
 import { ProjectInstance } from './ProjectInstance';
 import ProjectApi from './ProjectApi';
 import ItemWatcher from './ItemWatcher';
@@ -12,7 +12,8 @@ export default class ProjectImpl implements ProjectApi {
     private watchClients;
     private watchManager?;
     private readModuleAsProject;
-    constructor(path: string, readModuleAsProject?: boolean);
+    private useHeadlessGenerator;
+    constructor(path: string, readModuleAsProject?: boolean, useHeadlessGenerator?: boolean);
     autoBuild(logger?: IChildLogger): Promise<AutoBuilder>;
     projectInstance(): ProjectInstance;
     /**
@@ -45,7 +46,7 @@ export default class ProjectImpl implements ProjectApi {
      * @param type
      * @param ref
      */
-    getDetailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, logger?: IChildLogger): Promise<Item | undefined>;
+    getDetailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, options?: ItemDetailInfoOptions, logger?: IChildLogger): Promise<Item | undefined>;
     run(options?: string[] | undefined, logger?: IChildLogger): Promise<void>;
     buildManifest(context?: PlatformContext, logger?: IChildLogger): Promise<void>;
     getManifest(logger?: IChildLogger): Promise<any>;
@@ -67,8 +68,4 @@ export default class ProjectImpl implements ProjectApi {
     } | undefined>;
     invalidate_cachedLaunchURL(): Promise<void>;
     getDataInfo(data: any, mainEntityName?: string, logger?: IChildLogger): Promise<any>;
-    private parseCSVFile;
-    private parseXMLFile;
-    private processValues;
-    private isId;
 }

package/src/project-api/ProjectInstance.d.ts

@@ -1,4 +1,4 @@
-import { ProjectData, Project, ItemFilter, Item, ModuleData, Tag, FileSystemWatchManager, ProjectFileSystem, ItemType, IProjectInstance, KeyIn } from '@sap/artifact-management-base-types';
+import { ProjectData, Project, ItemFilter, Item, ModuleData, Tag, FileSystemWatchManager, ProjectFileSystem, ItemType, IProjectInstance, KeyIn, ItemDetailInfoOptions } from '@sap/artifact-management-base-types';
 import ProjectModulesInstance from './ProjectModulesInstance';
 import ProjectEntityInstance from './ProjectEntityInstance';
 export declare class ProjectInstance extends ProjectEntityInstance<ProjectData> implements IProjectInstance {
@@ -16,6 +16,6 @@ export declare class ProjectInstance extends ProjectEntityInstance<ProjectData>
     readDeep(tag?: KeyIn<typeof Tag>): Promise<Project | undefined>;
     readItems(filter?: ItemFilter): Promise<Item[]>;
     readModules(): Promise<ModuleData[]>;
-    detailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string): Promise<Item | undefined>;
+    detailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, options?: ItemDetailInfoOptions): Promise<Item | undefined>;
     getPath(): string;
 }

package/src/project-api/ProjectModulesInstance.d.ts

@@ -1,4 +1,4 @@
-import { ProjectFileSystem, ProjectData, Project, ItemFilter, Item, ModuleData, FileSystemWatchManager, ItemType, KeyIn } from '@sap/artifact-management-base-types';
+import { ProjectFileSystem, ProjectData, Project, ItemFilter, Item, ModuleData, FileSystemWatchManager, ItemType, KeyIn, ItemDetailInfoOptions } from '@sap/artifact-management-base-types';
 import ModuleInstance from './ModuleInstance';
 import ProjectEntityInstance from './ProjectEntityInstance';
 /**
@@ -19,5 +19,5 @@ export default class ProjectModulesInstance extends ProjectEntityInstance<string
     getModuleInstances(): Promise<ModuleInstance[]>;
     readItems(filter?: ItemFilter): Promise<Item[]>;
     private getItemsFilteredByTags;
-    detailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string): Promise<Item | undefined>;
+    detailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, options?: ItemDetailInfoOptions): Promise<Item | undefined>;
 }

package/src/project-api/WorkspaceImpl.d.ts

@@ -5,12 +5,14 @@ import { KeyIn, Tag } from '@sap/artifact-management-base-types';
 import ProjectApi from './ProjectApi';
 import WorkspaceApi from './WorkspaceApi';
 export default class WorkspaceImpl implements WorkspaceApi {
-    workspaceFolders: readonly WorkspaceFolder[] | undefined;
+    workspaceFolders: WorkspaceFolder[] | undefined;
     workspaceWatcher?: FSWatcher;
     workspaceChangeHandler?: (event: string, folders: WorkspaceFolder[]) => void;
     private watch?;
     private readModuleAsProject;
-    constructor();
+    private path?;
+    constructor(path?: string);
+    getWorksapceFolders(): Promise<WorkspaceFolder[] | undefined>;
     getProjects(tag?: KeyIn<typeof Tag>): Promise<ProjectApi[]>;
     getProjectUris(): Promise<Uri[]>;
     startWatch(): void;