@sap/artifact-management-types 1.1.2 → 1.4.0

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@sap/artifact-management-types",
-  "version": "1.1.2",
+  "version": "1.4.0",
   "description": "Type signatures for artifact management",
   "types": "./src/index.d.ts",
   "main": "./src/index.d.ts",
   "scripts": {
-    "compile": "tsc -p ./"
+    "compile": "tsc -p ./",
+    "modify-types-import": "npm i && gulp --gulpfile ../../gulpfile.js modifyTypesImport",
+    "pack": "npm run modify-types-import && npm pack"
   },
   "dependencies": {
-    "@sap/artifact-management-base-types": "^1.1.0"
+    "@sap/artifact-management-base-types": "^1.1.0",
+    "gulp": "4.0.2"
   },
   "keywords": [
     "artifact-management-types",

package/src/cp/CFProjectBuilder.d.ts

@@ -22,6 +22,7 @@ export default class CFProjectBuilder implements ProjectBuilder {
      */
     buildFs: ProjectFileSystem;
     constructor(project: Project, fs: ProjectFileSystem);
+    private filterWorkflowModule;
     build(): Promise<void>;
     generateManifest(): Promise<void>;
     private addResources;
@@ -34,6 +35,8 @@ export default class CFProjectBuilder implements ProjectBuilder {
     mtarFileName(): string;
     private buildMtar;
     deploy(): Promise<void>;
+    updateDeployedTime(): Promise<void>;
+    getDeployedTime(): Promise<string>;
     getProjectOverviewURL(): Promise<string | undefined>;
     getOverviewApplicationId(): Promise<string>;
     private generateOverviewApplication;

package/src/cp/LaunchpadPageGenerator.d.ts

@@ -5,6 +5,15 @@ export default class LaunchpadPageGenerator {
     render(project: Project, fs: ProjectFileSystem, isCurrentApiDeploy: boolean): Promise<number>;
     buildUShellConfig(applications: RunUIApplication[], isCurrentApiDeploy: boolean): {
         defaultRenderer: string;
+        renderers: {
+            fiori2: {
+                componentData: {
+                    config: {
+                        enableSearch: boolean;
+                    };
+                };
+            };
+        };
         applications: any;
     };
 }

package/src/cp/OverviewPageGenerator.d.ts

@@ -5,4 +5,5 @@ export default class OverviewPageGenerator {
     private render;
     private getServicesTableData;
     private addRoutesToServiceInXsApp;
+    private getWorkflowAppsData;
 }

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

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

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

@@ -32,6 +32,8 @@ export default class CapModuleReader extends ModuleReader {
     provideFromCds({ fs }: ProjectEntityReaderReadOptions): Promise<Item[]>;
     detailInfo(fs: ProjectFileSystem, ref: string): Promise<Item | undefined>;
     readCSV({ fs, matchedFiles }: ProjectEntityReaderReadOptions): Promise<Item[]>;
+    private getExternalServicePaths;
+    private getRef;
     /**
      * Get the service ref from service object.
      * The method parses the service object and

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

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

package/src/plugins/workflow/readers/WorkflowModuleParser.d.ts

@@ -0,0 +1,12 @@
+import { ProjectFileSystem } from '@sap/artifact-management-base-types';
+export default class WorkflowModuleParser {
+    private fs;
+    private path;
+    private json;
+    constructor(fs: ProjectFileSystem, path: string);
+    findTaskUIDependencies(): Promise<string[]>;
+    findSchemaDependencies(): Promise<[string, [string, boolean][]][]>;
+    private getJson;
+    private getServiceAndEntitiesForWorkflow;
+    private getServiceRef;
+}

package/src/plugins/workflow/readers/WorkflowModuleReader.d.ts

@@ -19,4 +19,6 @@ export default class WorkflowModuleReader extends ModuleReader {
     static asPattern(extension: string): string;
     private asItems;
     private asItem;
+    private asWorkflowItem;
+    private addLink;
 }

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

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

package/src/project/ProjectBuilder.d.ts

@@ -3,4 +3,6 @@ export interface ProjectBuilder {
     build: () => Promise<void>;
     deploy: () => Promise<void>;
     getProjectOverviewURL: () => Promise<string | undefined>;
+    updateDeployedTime: () => Promise<void>;
+    getDeployedTime: () => Promise<string>;
 }

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

@@ -9,6 +9,7 @@ declare class ModuleInstance extends ProjectEntityInstance<ModuleData | undefine
     loadItemSets(moduleData: ModuleData | undefined): Promise<ItemSetInstance[]>;
     getData(): Promise<ModuleData | undefined>;
     getItemSets(): Promise<ItemSetInstance[]>;
+    getModuleType(): Promise<string>;
     getItems(): Promise<{
         items: Item[];
         info?: StateMessage[] | undefined;

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

@@ -52,6 +52,9 @@ export default interface ProjectApi {
     /**
      * get Launch URL of Project Already Deployed
      */
+    /**
+     * @deprecated Use getApplicationDeploymentSummary() instead
+     */
     getProjectOverviewURL(logger?: IChildLogger): Promise<string | undefined>;
     /**
      * Get Project level info of the project
@@ -65,4 +68,11 @@ export default interface ProjectApi {
      * Get contents of mta.yaml file
      */
     getManifest(logger?: IChildLogger): Promise<any>;
+    /**
+     * Get summary of application deployment
+     */
+    getApplicationDeploymentSummary(logger?: IChildLogger): Promise<{
+        ProjectOverviewURL?: string;
+        DeployedUTCTime?: string;
+    } | undefined>;
 }

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

@@ -1,4 +1,4 @@
-import { Project, ItemFilter, Tag, ItemType, ModuleData, ProjectData, KeyIn } from '@sap/artifact-management-base-types';
+import { Project, ItemFilter, Tag, ItemType, ModuleData, ProjectData, KeyIn, ProjectFileSystem, Item } from '@sap/artifact-management-base-types';
 import { ProjectInstance } from './ProjectInstance';
 import ProjectApi from './ProjectApi';
 import ItemWatcher from './ItemWatcher';
@@ -12,6 +12,7 @@ export default class ProjectImpl implements ProjectApi {
     private watchClients;
     private watchManager?;
     private readModuleAsProject;
+    private application_summary;
     constructor(path: string, readModuleAsProject?: boolean);
     autoBuild(logger?: IChildLogger): Promise<AutoBuilder>;
     projectInstance(): ProjectInstance;
@@ -32,26 +33,34 @@ export default class ProjectImpl implements ProjectApi {
      *
      */
     tryRead(): Promise<Project>;
-    fs(): import("@sap/artifact-management-base").ProjectFileSystem;
+    fs(): ProjectFileSystem;
     /**
      * Read entities provided by the project
      *
      * @param filter
      */
-    readItems(filter?: ItemFilter, logger?: IChildLogger): Promise<import("@sap/artifact-management-base").Item[]>;
+    readItems(filter?: ItemFilter, logger?: IChildLogger): Promise<Item[]>;
     /**
      * Read detail information for the required type and ref provided by the project
      *
      * @param type
      * @param ref
      */
-    getDetailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, logger?: IChildLogger): Promise<import("@sap/artifact-management-base").Item | undefined>;
-    run(options?: string[] | undefined, logger?: IChildLogger): Promise<any>;
+    getDetailInfo(type: KeyIn<typeof ItemType>, ref: string, entityPath?: string, logger?: IChildLogger): Promise<Item | undefined>;
+    run(options?: string[] | undefined, logger?: IChildLogger): Promise<void>;
     buildManifest(context?: PlatformContext, logger?: IChildLogger): Promise<void>;
     getManifest(logger?: IChildLogger): Promise<any>;
     build(context?: PlatformContext, logger?: IChildLogger): Promise<void>;
     deploy(logger?: IChildLogger): Promise<void>;
     getProjectInfo(logger?: IChildLogger): Promise<ProjectData | undefined>;
     getModulesInfo(logger?: IChildLogger): Promise<ModuleData[]>;
+    /**
+     * @deprecated Use getApplicationDeploymentSummary() instead
+     */
     getProjectOverviewURL(logger?: IChildLogger): Promise<string | undefined>;
+    getApplicationDeploymentSummary(logger?: IChildLogger): Promise<{
+        ProjectOverviewURL?: string;
+        DeployedUTCTime?: string;
+    } | undefined>;
+    invalidate_cachedLaunchURL(): Promise<void>;
 }