@sap/artifact-management-types 1.53.3 → 1.53.4

package/package.json

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

package/src/commons/CallDeferred.d.ts

@@ -1,4 +1,4 @@
-declare type CallDeferredOptions = {
+type CallDeferredOptions = {
     func: Function;
     triggerDelay: number;
     maxTriggerDelay: number;

package/src/commons/ResourceManager.d.ts

@@ -1,4 +1,4 @@
-declare type Constructor<T> = {
+type Constructor<T> = {
     new (...args: any): T;
 };
 export interface Resource<T> {

package/src/cp/CFProjectBuilder.d.ts

@@ -1,7 +1,7 @@
 import { ProjectFileSystem, Project, NameFactory, ProjectManifestGenerator, ModuleManifestGenerator, Service, ModuleGeneratorContext, UI5ModuleManifestGenerator } from '@sap/artifact-management-base-types';
 import MtaGeneratorSettings from '../mta-generator/MtaGeneratorSettings';
 import { ProjectBuilder } from '../project/ProjectBuilder';
-export declare type ProjectGeneratorOptions = {
+export type ProjectGeneratorOptions = {
     project: Project;
     fs: ProjectFileSystem;
     options: MtaGeneratorSettings;

package/src/cp/Defs.d.ts

@@ -1,8 +1,8 @@
 export declare const NavigationMode: Readonly<{
-    EMBEDDED: string;
-    NEW_WINDOW: string;
-    REPLACE: string;
-    NEW_WINDOW_THEN_EMBEDDED: string;
+    EMBEDDED: "embedded";
+    NEW_WINDOW: "newWindow";
+    REPLACE: "replace";
+    NEW_WINDOW_THEN_EMBEDDED: "newWindowThenEmbedded";
 }>;
 export declare const WEBAPP_SECTION_DESCRIPTION: {
     ZERO_APPS: string;

package/src/mta-generator/MtaBuilder.d.ts

@@ -1,5 +1,5 @@
 import { ProjectFileSystem } from '@sap/artifact-management-base-types';
-export declare type Mta = {
+export type Mta = {
     '_schema-version': string;
     ID: string;
     version: string;
@@ -16,7 +16,7 @@ export declare type Mta = {
     modules: any;
     resources: any;
 };
-export declare type MtaRequires = {
+export type MtaRequires = {
     name: string;
     parameters: {
         'content-target'?: boolean;

package/src/plugins/abap/readers/AbapModuleReader.d.ts

@@ -15,10 +15,10 @@ export default class AbapModuleReader extends CapModuleReader {
         matchConditions: {
             requiredFilePatterns: string[];
         };
-        types: string[];
+        types: ("com.sap.abap/Service" | "com.sap.abap/ServiceEntity" | "com.sap.abap/ProjectionEntity" | "com.sap.abap/BusinessObjectEntity")[];
         tags: string[];
         read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
-        detailInfo: (fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions | undefined) => Promise<Item | undefined>;
+        detailInfo: (fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions) => Promise<Item | undefined>;
     }[];
     read({ fs }: {
         fs: ProjectFileSystem;

package/src/plugins/abap/readers/AbapProjectReader.d.ts

@@ -4,6 +4,6 @@ export default class AbapProjectReader extends ProjectReader {
     getType(): KeyIn<typeof ProjectType>;
     getDetectionMechanism(): DetectionMechanism;
     moduleSearchPattern(): Promise<string[]>;
-    tags: string[];
+    tags: "abap"[];
     read({ fs, matchedFiles }: ProjectReaderOptions): Promise<ProjectData | undefined>;
 }

package/src/plugins/abap/utils/AbapFioriUtils.d.ts

@@ -1,6 +1,6 @@
 import { Item, ProjectData, ProjectFileSystem, VSCodeFileSystem } from '@sap/artifact-management-base-types';
 import { AppGenInfoFile } from '@sap/artifact-management-fioriplugin';
-export declare type ServiceItemsMap = Map<string, Item[]>;
+export type ServiceItemsMap = Map<string, Item[]>;
 export declare function updateUiItem(UiItem: Item, serviceItem: Item): void;
 export declare function updateUiItems(appGenInfoFile: AppGenInfoFile, serviceCsnsMap: ServiceItemsMap, projectFs: ProjectFileSystem | VSCodeFileSystem, fioriUiItem: Item): void;
 export declare function initFioriUiItem(projectInfo: ProjectData): Item;

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

@@ -13,11 +13,11 @@ export default class BasEmptyModuleReader extends ModuleReader {
         matchConditions: {
             requiredFilePatterns: string[];
         };
-        types: string[];
+        types: ("com.sap.bas.empty/Service" | "com.sap.bas.empty/Entity")[];
         tags: string[];
         read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
     }[];
-    tags: string[];
+    tags: ("module" | "bas" | "empty")[];
     prepareItemReaderContext(fs: ProjectFileSystem, context: ProjectContext): Promise<BasItemReaderContext | undefined>;
     read({ fs }: {
         fs: ProjectFileSystem;

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

@@ -6,7 +6,7 @@ export default class BasEmptyProjectReader extends ProjectReader {
     getDetectionMechanism(): DetectionMechanism;
     additionalModuleReaders: BasEmptyModuleReader[][];
     moduleSearchPattern(): Promise<string[]>;
-    tags: string[];
+    tags: ("project" | "bas" | "empty")[];
     read({ fs }: ProjectReaderOptions): Promise<ProjectData | undefined>;
     private isBasProjectsFolder;
     private isFristLevelFoder;

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

@@ -1,4 +1,4 @@
-import { ProjectFileSystem, Item, ModuleReader, ModuleType, ModuleData, ProjectEntityReaderReadOptions, DetectionMechanism, KeyIn, ItemDetailInfoOptions, ProjectContext } from '@sap/artifact-management-base-types';
+import { ProjectFileSystem, Item, ModuleReader, ModuleType, ModuleData, ProjectEntityReaderReadOptions, DetectionMechanism, KeyIn, ItemReader, ItemDetailInfoOptions, ProjectContext } from '@sap/artifact-management-base-types';
 interface CapItemReaderContext {
     withDetailInfo?: boolean;
 }
@@ -10,23 +10,7 @@ export default class CapModuleReader extends ModuleReader {
     };
     itemTags: string[];
     testTag: string;
-    itemReaders: ({
-        matchConditions: {
-            requiredFilePatterns: string[];
-        };
-        types: string[];
-        tags: string[];
-        read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
-        detailInfo: (fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions | undefined) => Promise<Item | undefined>;
-    } | {
-        matchConditions: {
-            requiredFilePatterns: string[];
-        };
-        types: string[];
-        tags: string[];
-        read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
-        detailInfo?: undefined;
-    })[];
+    itemReaders: ItemReader[];
     tags: string[];
     prepareItemReaderContext(fs: ProjectFileSystem, context: ProjectContext): Promise<CapItemReaderContext | undefined>;
     getCapModulesFolderMap(fs: ProjectFileSystem): Promise<any>;

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

@@ -5,7 +5,7 @@ export default class CapProjectReader extends ProjectReader {
     getType(): KeyIn<typeof ProjectType>;
     getDetectionMechanism(): DetectionMechanism;
     additionalModuleReaders: XsSecurityModuleReader[][];
-    tags: string[];
+    tags: ("project" | "cap")[];
     read({ fs }: ProjectReaderOptions): Promise<ProjectData | undefined>;
     isCapProject(fs: ProjectFileSystem, helper: ProjectReaderHelper): Promise<boolean>;
     moduleSearchPattern(): Promise<string[]>;

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

@@ -1,7 +1,8 @@
-import { ProjectFileSystem, ModuleData, ProjectEntityReaderReadOptions } from '@sap/artifact-management-base-types';
+import { ProjectFileSystem, ModuleType, ModuleData, ProjectEntityReaderReadOptions } from '@sap/artifact-management-base-types';
+import type { KeyIn } from '@sap/artifact-management-base-types';
 import CapModuleReader from './CapModuleReader';
 export default class CapSampleDataModuleReader extends CapModuleReader {
-    getType(): string;
+    getType(): KeyIn<typeof ModuleType>;
     matchConditions: {
         requiredFilePatterns: string[];
     };
@@ -9,7 +10,7 @@ export default class CapSampleDataModuleReader extends CapModuleReader {
         matchConditions: {
             requiredFilePatterns: string[];
         };
-        types: string[];
+        types: "mimetype/csv"[];
         tags: string[];
         read: (options: ProjectEntityReaderReadOptions) => Promise<import("@sap/artifact-management-base").Item[]>;
     }[];

package/src/plugins/cap/readers/calculation-view/model/model.d.ts

@@ -303,7 +303,7 @@ export declare enum TemporalCondition {
     INCLUDE_BOTH = "INCLUDE_BOTH"
 }
 export declare enum AggregationBehavior {
-    NONE = "none",
+    NONE = "none",// special one; not present in legacy model
     SUM = "sum",
     MIN = "min",
     MAX = "max",

package/src/plugins/cap/readers/calculation-view/model/modelbase.d.ts

@@ -60,18 +60,18 @@ export declare abstract class AbstractModel {
     constructor(isLoading?: any);
     $getModel(): AbstractModel;
 }
-declare type IfEquals<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
-declare type NonReadonlyKeys<T> = {
+type IfEquals<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
+type NonReadonlyKeys<T> = {
     [K in keyof T]: IfEquals<{
         -readonly [P in K]: T[P];
     }, {
         [P in K]: T[P];
     }> extends true ? K : never;
 }[keyof T];
-declare type NonFunctionKeys<T> = {
+type NonFunctionKeys<T> = {
     [K in keyof T]: T[K] extends Function ? never : K;
 }[keyof T];
-export declare type WritableCalcViewModel<T> = Partial<Pick<T, NonReadonlyKeys<T> & NonFunctionKeys<T>>>;
+export type WritableCalcViewModel<T> = Partial<Pick<T, NonReadonlyKeys<T> & NonFunctionKeys<T>>>;
 export declare abstract class AbstractModelClass<T extends AbstractModelClass<T>> {
     private $$containingFeature;
     private $$model;

package/src/plugins/cap/readers/calculation-view/viewmodel/CalculationViewXmlParser.d.ts

@@ -56,7 +56,7 @@ export default abstract class CalculationViewXmlParser {
     private static excecuteLoadPostProcessingCallBackQueue;
 }
 export declare const getElementFromColumnView: (columnView: ColumnView, name: string) => Element | null;
-export declare const getEntity: (columnView: ColumnView, id: string, entityType?: EntityType | undefined) => Entity;
+export declare const getEntity: (columnView: ColumnView, id: string, entityType?: EntityType) => Entity;
 export declare const getElementFromsharedEntity: (entity: Entity, elementName: string) => Element;
 export declare const getParameterFromColumnView: (columnView: ColumnView, name: string) => import("../model/model").Parameter | null;
 export declare const processUDFParameter: (columnView: ColumnView, udfParameter: any, values: any) => any;

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

@@ -1,5 +1,5 @@
 import * as t from '@babel/types';
-export declare type PhaseType = 'before' | 'on' | 'after';
+export type PhaseType = 'before' | 'on' | 'after';
 export declare const phases: string[];
 export declare const EVENT_UNDEFINED = "__undefined__";
 export declare const DEFAULT_INDENT = 4;

package/src/plugins/java/readers/JavaModuleReader.d.ts

@@ -6,18 +6,34 @@ export default class JavaModuleReader extends CapModuleReader {
         matchConditions: {
             requiredFilePatterns: string[];
         };
-        types: string[];
+        types: ("com.sap.cap/Service" | "com.sap.cap/Function" | "com.sap.cap/Action" | "com.sap.cds/Entity" | "org.oasis-open.odata/Entity")[];
         tags: string[];
         read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
-        detailInfo: (fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions | undefined) => Promise<Item | undefined>;
+        detailInfo: (fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions) => Promise<Item | undefined>;
     } | {
         matchConditions: {
             requiredFilePatterns: string[];
         };
-        types: string[];
+        types: "mimetype/csv"[];
         tags: string[];
         read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
         detailInfo?: undefined;
+    } | {
+        matchConditions: {
+            requiredFilePatterns: string[];
+        };
+        types: "com.sap.cap/ApplicationLogic"[];
+        tags: string[];
+        read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
+        detailInfo?: undefined;
+    } | {
+        matchConditions: {
+            requiredFilePatterns: string[];
+        };
+        types: "com.sap.hana/CalculationView"[];
+        tags: "calculationView"[];
+        read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
+        detailInfo: (fs: ProjectFileSystem, ref: string, options?: ItemDetailInfoOptions) => Promise<Item | undefined>;
     })[];
     readJavaApplicationLogic({ fs, matchedFiles }: ProjectEntityReaderReadOptions): Promise<Item[]>;
     read({ fs }: {

package/src/plugins/java/readers/JavaProjectReader.d.ts

@@ -4,7 +4,7 @@ export default class JavaProjectReader extends ProjectReader {
     getType(): KeyIn<typeof ProjectType>;
     getDetectionMechanism(): DetectionMechanism;
     moduleSearchPattern(): Promise<string[]>;
-    tags: string[];
+    tags: "java"[];
     capServices: string[];
     read({ fs }: ProjectReaderOptions): Promise<ProjectData | undefined>;
     resolveProperty(value: string, properties: Record<string, string>): string;

package/src/plugins/java/readers/JavaSampleDataModuleReader.d.ts

@@ -1,4 +1,5 @@
+import { ModuleType, KeyIn } from '@sap/artifact-management-base-types';
 import CapSampleDataModuleReader from '../../cap/readers/CapSampleDataModuleReader';
 export default class JavaSampleDataModuleReader extends CapSampleDataModuleReader {
-    getType(): string;
+    getType(): KeyIn<typeof ModuleType>;
 }

package/src/plugins/xsuaa/readers/XsSecurityModuleReader.d.ts

@@ -5,16 +5,16 @@ export default class XsSecurityModuleReader extends ModuleReader {
     matchConditions: {
         requiredFilePatterns: string[];
     };
-    itemTags: string[];
+    itemTags: ("item" | "xsuaa")[];
     itemReaders: {
         matchConditions: {
             requiredFilePatterns: string[];
         };
-        types: string[];
-        tags: string[];
+        types: ("com.sap.ui/Application" | "com.sap.ui/Component" | "com.sap.ui/View")[];
+        tags: ("item" | "xsuaa")[];
         read: (options: ProjectEntityReaderReadOptions) => Promise<Item[]>;
     }[];
-    tags: string[];
+    tags: ("module" | "xsuaa")[];
     readPackageJson(fs: ProjectFileSystem): Promise<any>;
     readDefaultRoles(fs: ProjectFileSystem): Promise<any>;
     read({ fs }: {

package/src/project/PlatformContext.d.ts

@@ -1,6 +1,6 @@
 export declare const PLATFORM: Readonly<{
-    CF: string;
-    K8s: string;
+    CF: "cloudfoundry";
+    K8s: "kubernetes";
 }>;
 export interface PlatformContext {
     platform: string;

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import { ProjectFileSystem, FileSystemWatchManager, IProjectInstance } from '@sap/artifact-management-base-types';
 declare class AutoBuilder extends EventEmitter {

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

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

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { ItemFilter, Item, FileSystemWatchManager } from '@sap/artifact-management-base-types';
 import { ProjectInstance } from './ProjectInstance';
 import { EventEmitter } from 'events';

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Item } from '@sap/artifact-management-base-types';
 import { EventEmitter } from 'events';
 declare interface ItemWatcherApi {

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import { ProjectFileSystem, FileSystemWatchManager, ChangeListener, Observer } from '@sap/artifact-management-base-types';
 /**

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { FSWatcher } from 'fs';
 import { IPluginManager, KeyIn, Tag } from '@sap/artifact-management-base-types';
 import ProjectApi from './ProjectApi';

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

@@ -1,12 +1,11 @@
-/// <reference types="node" />
 import { ProjectFileSystem, FileSystemWatchManager, ProjectEntityReader } from '@sap/artifact-management-base-types';
 import { EventEmitter } from 'events';
-declare type LoadResult<T> = {
+type LoadResult<T> = {
     data: T | undefined;
     watchPatterns: string[];
     watchContent: string[];
 } | undefined;
-declare type LoadData<T> = () => Promise<LoadResult<T>>;
+type LoadData<T> = () => Promise<LoadResult<T>>;
 export default class ProjectEntityInstance<T> extends EventEmitter {
     protected readonly watchManager: FileSystemWatchManager;
     protected fs: ProjectFileSystem;

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

@@ -4,7 +4,7 @@ import ProjectEntityInstance from './ProjectEntityInstance';
 /**
  * Module directories of the project
  */
-declare type LoadResult<T> = {
+type LoadResult<T> = {
     data: T | undefined;
     watchPatterns: string[];
     watchContent: string[];