@sap/artifact-management-types 1.41.0 → 1.42.0

package/package.json

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

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

@@ -11,7 +11,8 @@ declare class ItemWatcher extends EventEmitter implements ItemWatcherApi {
     private project;
     private watchManager;
     private filter?;
-    constructor(project: ProjectInstance, watchManager: FileSystemWatchManager, filter?: ItemFilter | undefined);
+    private pattern?;
+    constructor(project: ProjectInstance, watchManager: FileSystemWatchManager, filter?: ItemFilter | undefined, pattern?: string[] | undefined);
     destroy(): Promise<void>;
     readItems(): Promise<Item[]>;
 }

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

@@ -12,12 +12,13 @@ export default class LocalFileSystemWatchManager extends EventEmitter implements
     private eventInQueue;
     constructor(rootPath: string);
     removeFileSystemWatcher(observersToDel: Observer[]): void;
-    createFileSystemWatcher(fs: ProjectFileSystem, globPatterns: string[], listener: ChangeListener): Observer[];
-    createObserver(fs: ProjectFileSystem, globPattern: string, listener: ChangeListener): Observer;
-    addObserver(fs: ProjectFileSystem, globPattern: string, listener: ChangeListener): Observer;
+    createFileSystemWatcher(fs: ProjectFileSystem, globPatterns: string[], watchContent: any[], listener: ChangeListener): Observer[];
+    createObserver(fs: ProjectFileSystem, globPattern: string, watchContent: any, listener: ChangeListener): Observer;
+    addObserver(fs: ProjectFileSystem, globPattern: string, watchContent: any[], listener: ChangeListener): Observer;
     logObservers(): void;
     destroy(): void;
     enable(): Promise<void>;
     disable(): void;
     watchEvent(event: string, filename: string): Promise<void>;
+    compareJsonObjects(objA: any, objB: any, parentKey?: string): string[];
 }

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

@@ -18,7 +18,7 @@ export default interface ProjectApi {
      * Watch items
      *
      */
-    watchItems(filter?: ItemFilter, logger?: IChildLogger): Promise<ItemWatcherApi>;
+    watchItems(filter?: ItemFilter, pattern?: string[], logger?: IChildLogger): Promise<ItemWatcherApi>;
     /**
      * Auto build artifacts required when working with development tools
      */
@@ -102,4 +102,8 @@ export default interface ProjectApi {
      * Get the edmx of a service
      */
     getServiceEdmx(path: string, name: string): Promise<string>;
+    /**
+     * add watch pattern
+     */
+    addWatchPattern(pattern: string, func: (event: string, file: string) => void): void;
 }

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

@@ -4,6 +4,7 @@ import { EventEmitter } from 'events';
 declare type LoadResult<T> = {
     data: T | undefined;
     watchPatterns: string[];
+    watchContent: string[];
 } | undefined;
 declare type LoadData<T> = () => Promise<LoadResult<T>>;
 export default class ProjectEntityInstance<T> extends EventEmitter {
@@ -51,7 +52,7 @@ export default class ProjectEntityInstance<T> extends EventEmitter {
         load: LoadData<T>;
         onDataChanged?: (newData: T, oldData: T) => void;
     }): Promise<T>;
-    registerWatchPatterns(patterns: string[], callback?: (event: string, file: string) => void): Promise<void>;
+    registerWatchPatterns(patterns: string[], watchConent: any[], callback?: (event: string, file: string) => void): Promise<void>;
     flagModuleDirty(path: string): Promise<void>;
     unRegisterWatchPatterns(): void;
     loadByReader(reader: ProjectEntityReader<T>, context?: any): Promise<LoadResult<T>>;

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

@@ -25,9 +25,10 @@ export default class ProjectImpl implements ProjectApi {
      * Watch items
      *
      */
-    watchItems(filter?: ItemFilter, logger?: IChildLogger): Promise<ItemWatcher>;
+    watchItems(filter?: ItemFilter, pattern?: string[], logger?: IChildLogger): Promise<ItemWatcher>;
     startWatch(): LocalFileSystemWatchManager | undefined;
     stopWatch(obj: any): void;
+    addWatchPattern(pattern: string, func: (event: string, file: string) => void): void;
     /**
      * Read project, its modules and entities
      *

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

@@ -10,6 +10,7 @@ export declare class ProjectInstance extends ProjectEntityInstance<ProjectData>
     loadData(): Promise<{
         data: ProjectData | undefined;
         watchPatterns: string[];
+        watchContent: string[];
     } | undefined>;
     loadProjectInstance(projectData: ProjectData): Promise<ProjectModulesInstance | undefined>;
     getProjectInstance(): Promise<ProjectModulesInstance | undefined>;

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

@@ -4,14 +4,16 @@ import ProjectEntityInstance from './ProjectEntityInstance';
 /**
  * Module directories of the project
  */
+declare type LoadResult<T> = {
+    data: T | undefined;
+    watchPatterns: string[];
+    watchContent: string[];
+} | undefined;
 export default class ProjectModulesInstance extends ProjectEntityInstance<string[]> {
     readonly projectData: ProjectData;
     private readModuleAsProject;
     constructor(watchManager: FileSystemWatchManager, fs: ProjectFileSystem, projectData: ProjectData, readModuleAsProject?: boolean);
-    loadModuleDirectories(): Promise<{
-        data: string[];
-        watchPatterns: string[];
-    }>;
+    loadModuleDirectories(): Promise<LoadResult<string[]>>;
     loadModuleInstances(directoryPaths: string[]): Promise<ModuleInstance[]>;
     getModules(): Promise<ModuleData[]>;
     readDeep(withDetailInfo?: boolean): Promise<Project | undefined>;
@@ -21,3 +23,4 @@ export default class ProjectModulesInstance extends ProjectEntityInstance<string
     private getItemsFilteredByTags;
     detailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, options?: ItemDetailInfoOptions): Promise<Item | undefined>;
 }
+export {};