@sap/artifact-management-types 1.22.1 → 1.23.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/artifact-management-types",
-  "version": "1.22.1",
+  "version": "1.23.2",
   "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.22.1"
+    "@sap/artifact-management-base-types": "1.23.2"
   },
   "devDependencies": {
     "gulp": "4.0.2"

package/src/definitions/PluginFactory.d.ts

@@ -19,7 +19,7 @@ declare class PluginFactory {
     getProjectReaders(readModuleAsProject: boolean): ProjectReader[];
     getProjectWrappers(): ProjectReader[];
     getProjectReaderFor(projectType: KeyIn<typeof ProjectType>, readModuleAsProject?: boolean): ProjectReader;
-    getModuleReaders(): ModuleReader[];
+    getModuleReaders(projectType?: KeyIn<typeof ProjectType>): ModuleReader[];
     getModuleReaderFor(moduleType: KeyIn<typeof ModuleType>): ModuleReader;
     getItemReaderFor(itemType: KeyIn<typeof ItemType>): ItemReader;
     addModuleReader(reader: ModuleReader): void;

package/src/plugins/bas/index.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from '@sap/artifact-management-base-types';
+declare const BasPlugin: Plugin;
+export default BasPlugin;

package/src/plugins/{ui5/readers/UI5ModuleReader.d.ts → bas/readers/BasEmptyModuleReader.d.ts}

@@ -1,14 +1,12 @@
-import { ProjectFileSystem, ProjectEntityReaderReadOptions, ModuleType, Item, ModuleData, ModuleReader, DetectionMechanism, KeyIn } from '@sap/artifact-management-base-types';
-export default class UI5ModuleReader extends ModuleReader {
-    private manifestJson;
+import { ProjectFileSystem, ProjectEntityReaderReadOptions, ModuleType, Item, ModuleData, ModuleReader, DetectionMechanism, KeyIn, ProjectContext } from '@sap/artifact-management-base-types';
+interface BasItemReaderContext {
+    withDetailInfo?: boolean;
+}
+export default class BasEmptyModuleReader extends ModuleReader {
     getType(): KeyIn<typeof ModuleType>;
     getDetectionMechanism(): DetectionMechanism;
     matchConditions: {
         requiredFilePatterns: string[];
-        rule: (context: {
-            matchType: 'required' | 'mustNotExist';
-            fs: ProjectFileSystem;
-        }) => Promise<boolean>;
     };
     itemTags: string[];
     itemReaders: {
@@ -20,13 +18,14 @@ export default class UI5ModuleReader extends ModuleReader {
         read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
     }[];
     tags: string[];
+    prepareItemReaderContext(fs: ProjectFileSystem, context: ProjectContext): Promise<BasItemReaderContext | undefined>;
     read({ fs }: {
         fs: ProjectFileSystem;
     }): Promise<ModuleData | undefined>;
-    readItems({ fs }: ProjectEntityReaderReadOptions): Promise<Item[]>;
-    private getMainService;
-    private removeTrailingSlash;
-    private addLeadingSlash;
-    private normalizeRef;
-    private getTemplateData;
+    readItems({ fs, context }: ProjectEntityReaderReadOptions): Promise<Item[]>;
+    private getServiceItem;
+    private getServiceEntityItems;
+    private getEntityItem;
+    private addDetailInfo;
 }
+export {};

package/src/plugins/bas/readers/BasEmptyProjectReader.d.ts

@@ -0,0 +1,14 @@
+import { DetectionMechanism, KeyIn, ProjectData, ProjectFileSystem, ProjectReader, ProjectReaderOptions, ProjectType } from '@sap/artifact-management-base-types';
+import BasEmptyModuleReader from './BasEmptyModuleReader';
+export default class BasEmptyProjectReader extends ProjectReader {
+    constructor();
+    getType(): KeyIn<typeof ProjectType>;
+    getDetectionMechanism(): DetectionMechanism;
+    additionalModuleReaders: BasEmptyModuleReader[][];
+    tags: string[];
+    read({ fs }: ProjectReaderOptions): Promise<ProjectData | undefined>;
+    isFristLevelFoder(absRootPath: string, absBasePath: string): boolean;
+    isEmptyProject(fs: ProjectFileSystem): Promise<boolean>;
+    isNotInAcceptedFolders(folder: string): boolean;
+    isNotInAcceptedFiles(file: string): boolean;
+}

package/src/plugins/bas/util/EdmxUtil.d.ts

@@ -0,0 +1,12 @@
+export interface EntitySet {
+    name: string;
+    type: string;
+}
+export default class EdmxUtil {
+    static parse(content: string): undefined;
+    static getEntitySet(edmxObject: any): EntitySet[];
+    static getEntityTypeProperties(edmxObject: any, type: string): any[];
+    private static getDataServices;
+    private static getEntitySetFromDataServices;
+    private static getEntitySetFromDataService;
+}

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

@@ -1,4 +1,4 @@
-import { ProjectFileSystem, Item, ModuleReader, ModuleType, ModuleData, ProjectEntityReaderReadOptions, DetectionMechanism, KeyIn, ItemDetailInfoOptions } from '@sap/artifact-management-base-types';
+import { ProjectFileSystem, Item, ModuleReader, ModuleType, ModuleData, ProjectEntityReaderReadOptions, DetectionMechanism, KeyIn, ItemDetailInfoOptions, ProjectContext } from '@sap/artifact-management-base-types';
 interface CapItemReaderContext {
     withDetailInfo?: boolean;
 }
@@ -27,41 +27,18 @@ export default class CapModuleReader extends ModuleReader {
         detailInfo?: undefined;
     })[];
     tags: string[];
-    prepareItemReaderContext(fs: ProjectFileSystem, withDetailInfo?: boolean): Promise<CapItemReaderContext | undefined>;
+    prepareItemReaderContext(fs: ProjectFileSystem, context: ProjectContext): 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, context }: ProjectEntityReaderReadOptions): Promise<Item[]>;
+    provideFromCds({ fs, matchedFiles, 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[]>;
-    private addLinksToAppLogicItem;
-    private getExternalServicePaths;
-    private getRef;
-    /**
-     * Get the service ref from service object.
-     * The method parses the service object and
-     * creates a ref following the same step as done be CDS.
-     * As a result, the value will match the service endpoint value generated by CDS.
-    */
-    private getServiceRef;
-    private getServiceEntityRef;
-    /**
-     * Since the path would be relative to the root, in case of win OS,
-     * 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 isDBEntity;
-    private addLink;
-    private getOperationItem;
-    private getOperationRef;
-    private addDetailInfoForOperaton;
-    private getNamespace;
-    private isContained;
-    private addNamespaceItemFromDBEntityItem;
+    private addUnboundFunctionItems;
+    private addUnboundActionItems;
+    private addEventItems;
 }
 export {};

package/src/plugins/cap/util/CdsUtil.d.ts

@@ -0,0 +1,10 @@
+import { ProjectFileSystem } from '@sap/artifact-management-base-types';
+import { CDSDefinition } from '@sap/artifact-management-base/dist/types/src/cp/CapApi';
+export default class CdsUtil {
+    static isProjectionEntity(entity: CDSDefinition): boolean;
+    static getNamespace(entity: CDSDefinition): string;
+    static getBaseEntity(entity: any): any;
+    static isDBEntity(entity: CDSDefinition): boolean;
+    static isEnteranlEntity(dbEntity: CDSDefinition): boolean;
+    static isContained(fs: ProjectFileSystem, cdsObject: any): boolean;
+}

package/src/plugins/cap/util/ItemUtil.d.ts

@@ -0,0 +1,29 @@
+import { Item, LinkType, ProjectFileSystem } from '@sap/artifact-management-base-types';
+import CapApi, { CDSDefinition } from '@sap/artifact-management-base/dist/types/src/cp/CapApi';
+export default class ItemUtil {
+    static getRef(fileName: string): string;
+    /**
+     * Get the service ref from service object.
+     * The method parses the service object and
+     * creates a ref following the same step as done be CDS.
+     * As a result, the value will match the service endpoint value generated by CDS.
+    */
+    static getServiceRef(service: any): string;
+    static getServiceEntityRef(serviceEnity: any): string;
+    static getOperationRef(operation: any): string;
+    static needLinkTo(dbEntity: any): boolean;
+    static addLink(entity: Item, target: any, linkType: LinkType, serviceRefs: {
+        [key: string]: string;
+    }): void;
+    static addLinksToAppLogicItem(fs: ProjectFileSystem, file: string, capApi: CapApi, logicItem: Item): Promise<void>;
+    private static addLinksToAppLogicItemWithEntity;
+    private static addLinksToAppLogicItemWithoutEntity;
+    static addLinkToRoles(cdsObject: CDSDefinition, item: Item): void;
+    static getOperationItem(fs: ProjectFileSystem, operation: any, tags: string[], withDetailInfo: boolean): Item;
+    static getEventItem(fs: ProjectFileSystem, event: any, tags: string[], withDetailInfo: boolean): Item;
+    static addDetailInfoForOperaton(item: Item, operation: any): void;
+    static addNamespaceItemFromDBEntityItem(items: Map<string, Item>, dbEntityItem: Item, namespace: string, itemTags: string[]): void;
+    static getAttributeInfo(entity: CDSDefinition): any;
+    private static collectAttributes;
+    private static getPath;
+}

package/src/plugins/cap/util/PathUtil.d.ts

@@ -0,0 +1,9 @@
+import { ProjectFileSystem } from '@sap/artifact-management-base-types';
+export default class PathUtil {
+    /**
+     * Since the path would be relative to the root, in case of win OS,
+     * we need to find the correct root drive and we need to prefix the path with the correct root drive (C:, D: etc.)
+     */
+    static getLocationForWindows(path: string, rootPath: string): string;
+    static getExternalServicePaths(fs: ProjectFileSystem): Promise<Set<string>>;
+}

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

@@ -1,4 +1,4 @@
-import { ModuleData, Item, ProjectFileSystem, FileSystemWatchManager, ModuleReader } from '@sap/artifact-management-base-types';
+import { ModuleData, Item, ProjectFileSystem, FileSystemWatchManager, ModuleReader, ProjectContext } from '@sap/artifact-management-base-types';
 import ItemSetInstance from './ItemSetInstance';
 import ProjectEntityInstance from './ProjectEntityInstance';
 declare class ModuleInstance extends ProjectEntityInstance<ModuleData | undefined> {
@@ -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, withDetailInfo?: boolean): Promise<ItemSetInstance[]>;
+    loadItemSets(moduleData: ModuleData | undefined, projectContext: ProjectContext): Promise<ItemSetInstance[]>;
     getData(): Promise<ModuleData | undefined>;
-    getItemSets(withDetailInfo?: boolean): Promise<ItemSetInstance[]>;
+    getItemSets(context: ProjectContext): Promise<ItemSetInstance[]>;
     getModuleType(): Promise<string>;
-    getItems(withDetailInfo?: boolean): Promise<{
+    getItems(context: ProjectContext): Promise<{
         items: Item[];
         info?: {};
     }>;

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

@@ -1,7 +1,7 @@
 import { IPluginManager, KeyIn, Tag } from '@sap/artifact-management-base-types';
 import ProjectApi from './ProjectApi';
 export default interface WorkspaceApi {
-    getProjects(tag?: KeyIn<typeof Tag>): Promise<ProjectApi[]>;
+    getProjects(tag?: KeyIn<typeof Tag>, path?: string): Promise<ProjectApi[]>;
     getProject(path: string): Promise<ProjectApi>;
     /**
      * Get all paths that contain projects in the workspace

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

@@ -6,7 +6,7 @@ export { VSCodeLike };
 export default class WorkspaceImpl implements WorkspaceApi {
     private api;
     constructor(pathOrWorkspace: string | VSCodeLike, readModuleAsProject?: boolean);
-    getProjects(tag?: KeyIn<typeof Tag>): Promise<ProjectApi[]>;
+    getProjects(tag?: KeyIn<typeof Tag>, path?: string): Promise<ProjectApi[]>;
     getProject(path: string): Promise<ProjectApi>;
     getProjectUris(): Promise<string[]>;
     startWatch(): void;

package/src/plugins/ui5/InfoList.d.ts

@@ -1,34 +0,0 @@
-export declare const InfoList: {
-    ERR_MODULE_SAP_APP_ID_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-    ERR_METADATA_NAME_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-    ERR_SAP_APP_TITLE_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-    ERR_CROSSNAVIGSTION_SEMANTIC_OBJECT_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-    ERR_CROSSNAVIGSTION_ACTION_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-    ERR_TARGET_ID_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-    ERR_SOURCETEMPLATE_ID_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-    ERR_ITEM_SAP_APP_ID_UNDEFINED: {
-        code: string;
-        description: string;
-    };
-};

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

@@ -1,10 +0,0 @@
-import { KeyIn, ModuleType, ModuleGeneratorContext, XSAppJson, MtaModuleRequires, MtaModule, UI5ModuleManifestGenerator } from '@sap/artifact-management-base-types';
-export default class UI5ModuleGenerator implements UI5ModuleManifestGenerator {
-    getXSAppJson(context: ModuleGeneratorContext): XSAppJson;
-    private modifyManifestJson;
-    getType(): KeyIn<typeof ModuleType>;
-    provideResources(): Promise<never[]>;
-    beforeBuildCommands(): Promise<string[]>;
-    getModuleManifest(context: ModuleGeneratorContext, useHeadlessGenerator?: boolean): Promise<MtaModule | null>;
-    requires(): MtaModuleRequires[];
-}

package/src/plugins/ui5/index.d.ts

@@ -1,4 +0,0 @@
-import { Plugin } from '@sap/artifact-management-base-types';
-declare const UI5Plugin: Plugin;
-export default UI5Plugin;
-export { InfoList } from './InfoList';