@sap/artifact-management-types 1.17.2 → 1.19.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/artifact-management-types",
-  "version": "1.17.2",
+  "version": "1.19.0",
   "description": "Type signatures for artifact management",
   "types": "./src/index.d.ts",
   "main": "./src/index.d.ts",
@@ -10,7 +10,7 @@
     "pack": "npm run modify-types-import && npm pack"
   },
   "dependencies": {
-    "@sap/artifact-management-base-types": "1.16.0"
+    "@sap/artifact-management-base-types": "1.19.0"
   },
   "devDependencies": {
     "gulp": "4.0.2"

package/src/definitions/PluginDefintionProvider.d.ts

@@ -3,6 +3,7 @@ export declare const PLUGIN: {
     XSUAA: string;
     UI5: string;
     MDK: string;
+    HANA: string;
 };
 /**
  * Central entrypoint for project and module specific implementations ("plugins").

package/src/index.d.ts

@@ -4,5 +4,6 @@ export { default as ProjectImpl } from './project-api/ProjectImpl';
 export { default as WorkspaceImpl } from './project-api/WorkspaceImpl';
 export { default as ItemWatcherApi, ItemWatcherType } from './project-api/ItemWatcherApi';
 export { default as AutoBuilder } from './project-api/AutoBuilder';
+export { default as CommandExecutor } from './project-api/CommandExecutor';
 export * from './project-api/buildServiceInfo';
 export * from '@sap/artifact-management-base-types';

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

@@ -1,4 +1,7 @@
 import { ProjectFileSystem, Item, ModuleReader, ModuleType, ModuleData, ProjectEntityReaderReadOptions, DetectionMechanism, KeyIn, ItemDetailInfoOptions } from '@sap/artifact-management-base-types';
+interface CapItemReaderContext {
+    withDetailInfo?: boolean;
+}
 export default class CapModuleReader extends ModuleReader {
     getType(): KeyIn<typeof ModuleType>;
     getDetectionMechanism(): DetectionMechanism;
@@ -24,12 +27,13 @@ export default class CapModuleReader extends ModuleReader {
         detailInfo?: undefined;
     })[];
     tags: string[];
+    prepareItemReaderContext(fs: ProjectFileSystem, withDetailInfo?: boolean): Promise<CapItemReaderContext | undefined>;
     getCapModulesFolderMap(fs: ProjectFileSystem): Promise<any>;
     getMappedFolderType(folderPath: string, fs: ProjectFileSystem): Promise<string | undefined>;
     read({ fs }: {
         fs: ProjectFileSystem;
     }): Promise<ModuleData | undefined>;
-    provideFromCds({ fs }: ProjectEntityReaderReadOptions): Promise<Item[]>;
+    provideFromCds({ fs, context }: ProjectEntityReaderReadOptions): Promise<Item[]>;
     detailInfo(fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions): Promise<Item | undefined>;
     readCSV({ fs, matchedFiles }: ProjectEntityReaderReadOptions): Promise<Item[]>;
     readApplicationLogic({ fs, matchedFiles }: ProjectEntityReaderReadOptions): Promise<Item[]>;
@@ -48,4 +52,8 @@ export default class CapModuleReader extends ModuleReader {
      * we need to find the correct root drive and we need to prefix the path with the correct root drive (C:, D: etc.)
      */
     private getLocationForWindows;
+    private needLinkTo;
+    private isEnteranlEntity;
+    private addLink;
 }
+export {};

package/src/plugins/ui5/readers/UI5ModuleReader.d.ts

@@ -24,6 +24,7 @@ export default class UI5ModuleReader extends ModuleReader {
         fs: ProjectFileSystem;
     }): Promise<ModuleData | undefined>;
     readItems({ fs }: ProjectEntityReaderReadOptions): Promise<Item[]>;
+    private getMainService;
     private removeTrailingSlash;
     private addLeadingSlash;
     private normalizeRef;

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

@@ -0,0 +1,5 @@
+declare class CommandExecutorClass {
+    execute(command: string, ...params: any[]): Promise<any>;
+}
+declare const CommandExecutor: CommandExecutorClass;
+export default CommandExecutor;

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

@@ -2,7 +2,8 @@ import { ItemReader, Item, ProjectFileSystem, FileSystemWatchManager } from '@sa
 import ProjectEntityInstance from './ProjectEntityInstance';
 export default class ItemSetInstance extends ProjectEntityInstance<Item[]> {
     private itemReader;
-    constructor(watchManager: FileSystemWatchManager, fs: ProjectFileSystem, itemReader: ItemReader);
+    private itemReaderContext?;
+    constructor(watchManager: FileSystemWatchManager, fs: ProjectFileSystem, itemReader: ItemReader, itemReaderContext?: any);
     getItemReader(): ItemReader;
     getItems(): Promise<Item[]>;
 }

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

@@ -6,11 +6,11 @@ declare class ModuleInstance extends ProjectEntityInstance<ModuleData | undefine
     constructor(watchManager: FileSystemWatchManager, fs: ProjectFileSystem, readers: ModuleReader[]);
     watchForChangesInModuleRootFolder(): void;
     getFs(): ProjectFileSystem;
-    loadItemSets(moduleData: ModuleData | undefined): Promise<ItemSetInstance[]>;
+    loadItemSets(moduleData: ModuleData | undefined, withDetailInfo?: boolean): Promise<ItemSetInstance[]>;
     getData(): Promise<ModuleData | undefined>;
-    getItemSets(): Promise<ItemSetInstance[]>;
+    getItemSets(withDetailInfo?: boolean): Promise<ItemSetInstance[]>;
     getModuleType(): Promise<string>;
-    getItems(): Promise<{
+    getItems(withDetailInfo?: boolean): Promise<{
         items: Item[];
         info?: {} | undefined;
     }>;

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

@@ -29,6 +29,12 @@ export default interface ProjectApi {
      * @param filter
      */
     readItems(filter?: ItemFilter, logger?: IChildLogger): Promise<Item[]>;
+    /**
+     * Read entities with detail information provided by the project
+     *
+     * @param filter
+     */
+    readDetailItems(filter?: ItemFilter, logger?: IChildLogger): Promise<Item[]>;
     /**
      * Read detail information for the required type, ref and optional entityPath provided by the project.
      * Currently, we support only "com.sap.cds/Entity" type.

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

@@ -1,2 +1 @@
-#!/usr/bin/env node
 export declare function cli(): Promise<void>;

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

@@ -54,7 +54,7 @@ export default class ProjectEntityInstance<T> extends EventEmitter {
     registerWatchPatterns(patterns: string[], callback?: (event: string, file: string) => void): Promise<void>;
     flagModuleDirty(path: string): Promise<void>;
     unRegisterWatchPatterns(): void;
-    loadByReader(reader: ProjectEntityReader<T>): Promise<LoadResult<T>>;
+    loadByReader(reader: ProjectEntityReader<T>, context?: any): Promise<LoadResult<T>>;
     loadByReaders(readers: ProjectEntityReader<T>[], deepSearch?: boolean): Promise<LoadResult<T>>;
     invalidate(): Promise<void>;
     unload(): void;

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

@@ -40,6 +40,12 @@ export default class ProjectImpl implements ProjectApi {
      * @param filter
      */
     readItems(filter?: ItemFilter, logger?: IChildLogger): Promise<Item[]>;
+    /**
+     * Read entities with detail information provided by the project
+     *
+     * @param filter
+     */
+    readDetailItems(filter?: ItemFilter, logger?: IChildLogger): Promise<Item[]>;
     /**
      * Read detail information for the required type and ref provided by the project
      *

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

@@ -14,7 +14,7 @@ export declare class ProjectInstance extends ProjectEntityInstance<ProjectData>
     loadProjectInstance(projectData: ProjectData): Promise<ProjectModulesInstance | undefined>;
     getProjectInstance(): Promise<ProjectModulesInstance | undefined>;
     readDeep(tag?: KeyIn<typeof Tag>): Promise<Project | undefined>;
-    readItems(filter?: ItemFilter): Promise<Item[]>;
+    readItems(filter?: ItemFilter, withDetailInfo?: boolean): Promise<Item[]>;
     readModules(): Promise<ModuleData[]>;
     detailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, options?: ItemDetailInfoOptions): Promise<Item | undefined>;
     getPath(): string;

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

@@ -14,10 +14,10 @@ export default class ProjectModulesInstance extends ProjectEntityInstance<string
     }>;
     loadModuleInstances(directoryPaths: string[]): Promise<ModuleInstance[]>;
     getModules(): Promise<ModuleData[]>;
-    readDeep(): Promise<Project | undefined>;
+    readDeep(withDetailInfo?: boolean): Promise<Project | undefined>;
     getModuleDirectories(): Promise<string[]>;
     getModuleInstances(): Promise<ModuleInstance[]>;
-    readItems(filter?: ItemFilter): Promise<Item[]>;
+    readItems(filter?: ItemFilter, withDetailInfo?: boolean): Promise<Item[]>;
     private getItemsFilteredByTags;
     detailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, options?: ItemDetailInfoOptions): Promise<Item | undefined>;
 }