@sap/artifact-management 1.20.2 → 1.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/README.md +40 -0
  2. package/dist/projectapi.js +1 -1
  3. package/dist/src/commons/ResourceManager.js +2 -1
  4. package/dist/src/commons/ResourceManager.js.map +1 -1
  5. package/dist/src/cp/CFProjectBuilder.js +5 -3
  6. package/dist/src/cp/CFProjectBuilder.js.map +1 -1
  7. package/dist/src/cp/Defs.js +20 -0
  8. package/dist/src/cp/Defs.js.map +1 -0
  9. package/dist/src/cp/LaunchpadPageGenerator.js +4 -7
  10. package/dist/src/cp/LaunchpadPageGenerator.js.map +1 -1
  11. package/dist/src/cp/OverviewPageGenerator.js +5 -10
  12. package/dist/src/cp/OverviewPageGenerator.js.map +1 -1
  13. package/dist/src/cp/templates/file-templates/OverviewPage-template.html +2 -2
  14. package/dist/src/cp/templates/file-templates/launchpadPage-template.html +3 -3
  15. package/dist/src/definitions/PluginDefintionProvider.js +24 -22
  16. package/dist/src/definitions/PluginDefintionProvider.js.map +1 -1
  17. package/dist/src/definitions/PluginFactory.js +5 -21
  18. package/dist/src/definitions/PluginFactory.js.map +1 -1
  19. package/dist/src/plugins/cap/CapRun.js +24 -1
  20. package/dist/src/plugins/cap/CapRun.js.map +1 -1
  21. package/dist/src/project-api/CommandExecutor.js +23 -18
  22. package/dist/src/project-api/CommandExecutor.js.map +1 -1
  23. package/dist/src/project-api/DataFirstUtil.js +2 -1
  24. package/dist/src/project-api/DataFirstUtil.js.map +1 -1
  25. package/dist/src/project-api/LocalFileSystemWatchManager.js +1 -0
  26. package/dist/src/project-api/LocalFileSystemWatchManager.js.map +1 -1
  27. package/dist/src/project-api/NodeWorkspace.js +4 -0
  28. package/dist/src/project-api/NodeWorkspace.js.map +1 -1
  29. package/dist/src/project-api/ProjectCLI.js +12 -2
  30. package/dist/src/project-api/ProjectCLI.js.map +1 -1
  31. package/dist/src/project-api/ProjectImpl.js +11 -4
  32. package/dist/src/project-api/ProjectImpl.js.map +1 -1
  33. package/dist/src/project-api/ProjectInstance.js +11 -4
  34. package/dist/src/project-api/ProjectInstance.js.map +1 -1
  35. package/dist/src/project-api/VSCodeWorkspace.js +4 -0
  36. package/dist/src/project-api/VSCodeWorkspace.js.map +1 -1
  37. package/dist/src/project-api/WorkspaceApi.js.map +1 -1
  38. package/dist/src/project-api/WorkspaceImpl.js +3 -0
  39. package/dist/src/project-api/WorkspaceImpl.js.map +1 -1
  40. package/dist/templates/file-templates/OverviewPage-template.html +2 -2
  41. package/dist/templates/file-templates/launchpadPage-template.html +3 -3
  42. package/dist/tsconfig.tsbuildinfo +50 -35
  43. package/dist/types/src/cp/Defs.d.ts +16 -0
  44. package/dist/types/src/definitions/PluginDefintionProvider.d.ts +8 -9
  45. package/dist/types/src/mta-generator/MtaGeneratorSettings.d.ts +3 -0
  46. package/dist/types/src/project-api/ModuleInstance.d.ts +1 -1
  47. package/dist/types/src/project-api/NodeWorkspace.d.ts +2 -1
  48. package/dist/types/src/project-api/ProjectApi.d.ts +1 -0
  49. package/dist/types/src/project-api/ProjectImpl.d.ts +4 -4
  50. package/dist/types/src/project-api/VSCodeWorkspace.d.ts +2 -1
  51. package/dist/types/src/project-api/WorkspaceApi.d.ts +2 -1
  52. package/dist/types/src/project-api/WorkspaceImpl.d.ts +2 -1
  53. package/package.json +5 -5
package/README.md CHANGED
@@ -188,7 +188,23 @@ ws.onWorkspaceChanged((event: string, folders: WorkspaceFolder[]) => {
188
188
  // add implementation
189
189
  });
190
190
  ```
191
+ ### getPluginManager
192
+ ###### Description
193
+ it returns an IPluginManager instance which can be used to register the custom plugin.
194
+ ###### Method
195
+ `getPluginManager() : IPluginManager`
196
+
197
+ ###### returns
198
+ - an `IPluginManager` instance
199
+
200
+ ###### Example
201
+ ```
202
+ import * as vscode from 'vscode';
191
203
 
204
+ const ws = new WorkspaceImpl(vscode);
205
+ const pluginManager = ws.getPluginManager();
206
+ pluginManager.register(customPlugin);
207
+ ```
192
208
  ---
193
209
 
194
210
  ## Access to project properties
@@ -636,6 +652,30 @@ resources:
636
652
  ...
637
653
 
638
654
  ```
655
+ ---
656
+
657
+ #### Build MTA Manifest content
658
+ ###### Method
659
+ `buildManifest(options? : MtaGeneratorSettings, logger? : IChildLogger) : Promise<void>;`
660
+ ###### Description
661
+ Generate manifest for the project and all the modules and create a `mta.yaml`
662
+ ###### Parameters
663
+ - logger: (Optional) An instance of IChildLogger which can be implemented by consumers of Project API.
664
+ ###### returns
665
+ - `Promise<void>`
666
+ ###### Example
667
+ ```
668
+ const api = new ProjectImpl(projectPath);
669
+ await api.buildManifest();
670
+ ```
671
+ or
672
+
673
+ ```
674
+ const api = new ProjectImpl(projectPath);
675
+ await api.buildManifest({ui5version: '1.1112.3', ui5theme: 'sap_belize'});
676
+ ```
677
+ ---
678
+
639
679
 
640
680
  #### Get MTA Manifest content
641
681
  ###### Method