@ampsec/platform-client 85.0.1 → 86.0.0

package/build/src/services/findings.service.d.ts

@@ -10,5 +10,5 @@ export declare class FindingsService extends AmpEntityServiceImpl<PlatformFindin
     constructor(rest: RestClient, targetApi?: TargetApi);
     patch(id: string, values: FindingPatchDto | FindingPatchDto[]): Promise<Page<FindingDto>>;
     patchAll(values: FindingPatchDto[]): Promise<Page<FindingDto>>;
-    getInstructions(finding: FindingDto): Promise<RestResponse>;
+    getInstructions(finding: Pick<FindingDto, 'id'>): Promise<RestResponse>;
 }

package/build/src/services/findings.service.js

@@ -32,7 +32,9 @@ class FindingsService extends entity_service_1.AmpEntityServiceImpl {
         return this.rest.call({
             url,
             method: 'GET',
-            params: finding,
+            params: {
+                id: finding.id,
+            },
         });
     }
 }

package/build/src/services/findings.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"findings.service.js","sourceRoot":"","sources":["../../../src/services/findings.service.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAGvB,2CAA+D;AAC/D,qDAAsD;AAOtD,MAAa,eAAgB,SAAQ,qCAAkE;IACrG,YAAY,IAAgB,EAAE,YAAuB,KAAK;QACxD,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,EAAU,EAAE,MAA2C;QAC3D,MAAM,GAAG,GAAG,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;QAClH,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,MAAyB;QAChC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,OAAmB;QACjC,MAAM,GAAG,GAAG,IAAI,6BAAiB,OAAO,IAAI,CAAC,IAAI,eAAe,CAAC;QACjE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACpB,GAAG;YACH,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AA/BD,0CA+BC"}
+{"version":3,"file":"findings.service.js","sourceRoot":"","sources":["../../../src/services/findings.service.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAGvB,2CAA+D;AAC/D,qDAAsD;AAOtD,MAAa,eAAgB,SAAQ,qCAAkE;IACrG,YAAY,IAAgB,EAAE,YAAuB,KAAK;QACxD,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,EAAU,EAAE,MAA2C;QAC3D,MAAM,GAAG,GAAG,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;QAClH,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,MAAyB;QAChC,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,OAA+B;QAC7C,MAAM,GAAG,GAAG,IAAI,6BAAiB,OAAO,IAAI,CAAC,IAAI,eAAe,CAAC;QACjE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YACpB,GAAG;YACH,MAAM,EAAE,KAAK;YACb,MAAM,EAAE;gBACN,EAAE,EAAE,OAAO,CAAC,EAAE;aACf;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAjCD,0CAiCC"}

package/build/src/services/flowSpecs.service.d.ts

@@ -11,4 +11,29 @@ export declare class FlowSpecsService extends AmpEntityServiceImpl<FlowSpecUpser
     _summary: (filter: FilterCriteria) => Promise<Page<FlowSpecDto>>;
     getActiveEngagements: (filter: ActiveEngagementFilterCriteria) => Promise<Page<ActiveEngagement>>;
     testEngagement: (spec: FlowSpecDto, input: TestEngagementRequestDto) => Promise<void>;
+    /**
+     * Get impact summary for a given flow spec. This will return the number of impacted workflows and a message describing the impact.
+     * @param spec
+     * @returns
+     */
+    getImpactSummary: (specId: string, input: {
+        temporalTypes?: Record<string, string[]>;
+    }) => Promise<{
+        affectedTimeoutWorkflows: number;
+        flowSpecId: string;
+        message: string;
+    }>;
+    /**
+     * Terminate impacted workflows for a given flow spec.
+     * This will terminate all workflows that are impacted by the flow spec and return a message describing the result.
+     * @param specId
+     * @param input
+     * @returns
+     */
+    terminateImpactedWorkflows: (specId: string, input: {
+        temporalTypes?: Record<string, string[]>;
+    }) => Promise<{
+        success: boolean;
+        message: string;
+    }>;
 }

package/build/src/services/flowSpecs.service.js

@@ -58,6 +58,34 @@ class FlowSpecsService extends entity_service_1.AmpEntityServiceImpl {
                 };
             });
         };
+        /**
+         * Get impact summary for a given flow spec. This will return the number of impacted workflows and a message describing the impact.
+         * @param spec
+         * @returns
+         */
+        this.getImpactSummary = async (specId, input) => {
+            const res = await this.rest.call({
+                url: `/${this.targetApi}/v1/${this.kind}/${specId}/impact-summary`,
+                method: 'POST',
+                data: input,
+            });
+            return res.data;
+        };
+        /**
+         * Terminate impacted workflows for a given flow spec.
+         * This will terminate all workflows that are impacted by the flow spec and return a message describing the result.
+         * @param specId
+         * @param input
+         * @returns
+         */
+        this.terminateImpactedWorkflows = async (specId, input) => {
+            const res = await this.rest.call({
+                url: `/${this.targetApi}/v1/${this.kind}/${specId}/terminate-impacted-workflows`,
+                method: 'POST',
+                data: input,
+            });
+            return res.data;
+        };
     }
 }
 exports.FlowSpecsService = FlowSpecsService;

package/build/src/services/flowSpecs.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"flowSpecs.service.js","sourceRoot":"","sources":["../../../src/services/flowSpecs.service.ts"],"names":[],"mappings":";;;AAGA,2CAAiC;AACjC,qDAAyE;AAIzE,MAAa,gBAAiB,SAAQ,qCAAoD;IACxF,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QAG/B,+CAA+C;QAC/C,WAAM,GAAG,CAAC,MAA+C,EAAE,QAA4B,EAA8B,EAAE;YACrH,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,mBAAc,GAAG,KAAK,EAAE,KAAwB,EAAwB,EAAE;YACxE,MAAM,GAAG,GAAsB,MAAM,IAAI,CAAC,IAAI,CAC5C;gBACE,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;gBACzC,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,KAAK;aACZ,EACD,CAAC,KAAc,EAAE,EAAE;gBACjB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;gBACzE,OAAO;oBACL,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC7B,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,EAAE;iBACV,CAAC;YACJ,CAAC,CACF,CAAC;YACF,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrB,CAAC,CAAC;QACF,aAAQ,GAAG,KAAK,EAAE,MAAsB,EAA8B,EAAE;YACtE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,WAAW;gBAClD,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAyB,CAAC;QACvC,CAAC,CAAC;QACF,yBAAoB,GAAG,KAAK,EAAE,MAAsC,EAAmC,EAAE;YACvG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,qBAAqB;gBAC5D,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAA8B,CAAC;QAC5C,CAAC,CAAC;QAEF,8DAA8D;QAC9D,mBAAc,GAAG,KAAK,EAAE,IAAiB,EAAE,KAA+B,EAAiB,EAAE;YAC3F,MAAM,IAAI,CAAC,IAAI,CACb;gBACE,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,kBAAkB;gBACpE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,KAAK;aACZ,EACD,CAAC,KAAc,EAAE,EAAE;gBACjB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;gBACzE,OAAO;oBACL,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC7B,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,EAAE;iBACV,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC;IA7DF,CAAC;CA8DF;AAjED,4CAiEC"}
+{"version":3,"file":"flowSpecs.service.js","sourceRoot":"","sources":["../../../src/services/flowSpecs.service.ts"],"names":[],"mappings":";;;AAGA,2CAAiC;AACjC,qDAAyE;AAIzE,MAAa,gBAAiB,SAAQ,qCAAoD;IACxF,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QAG/B,+CAA+C;QAC/C,WAAM,GAAG,CAAC,MAA+C,EAAE,QAA4B,EAA8B,EAAE;YACrH,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,mBAAc,GAAG,KAAK,EAAE,KAAwB,EAAwB,EAAE;YACxE,MAAM,GAAG,GAAsB,MAAM,IAAI,CAAC,IAAI,CAC5C;gBACE,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;gBACzC,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,KAAK;aACZ,EACD,CAAC,KAAc,EAAE,EAAE;gBACjB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;gBACzE,OAAO;oBACL,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC7B,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,EAAE;iBACV,CAAC;YACJ,CAAC,CACF,CAAC;YACF,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrB,CAAC,CAAC;QACF,aAAQ,GAAG,KAAK,EAAE,MAAsB,EAA8B,EAAE;YACtE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,WAAW;gBAClD,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAAyB,CAAC;QACvC,CAAC,CAAC;QACF,yBAAoB,GAAG,KAAK,EAAE,MAAsC,EAAmC,EAAE;YACvG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,qBAAqB;gBAC5D,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAA8B,CAAC;QAC5C,CAAC,CAAC;QAEF,8DAA8D;QAC9D,mBAAc,GAAG,KAAK,EAAE,IAAiB,EAAE,KAA+B,EAAiB,EAAE;YAC3F,MAAM,IAAI,CAAC,IAAI,CACb;gBACE,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,kBAAkB;gBACpE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,KAAK;aACZ,EACD,CAAC,KAAc,EAAE,EAAE;gBACjB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;gBACzE,OAAO;oBACL,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBAC7B,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,EAAE;iBACV,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC;QAEF;;;;WAIG;QACH,qBAAgB,GAAG,KAAK,EACtB,MAAc,EACd,KAAiD,EACiC,EAAE;YACpF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,MAAM,iBAAiB;gBAClE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAA+E,CAAC;QAC7F,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,+BAA0B,GAAG,KAAK,EAAE,MAAc,EAAE,KAAiD,EAAgD,EAAE;YACrJ,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAC/B,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,MAAM,+BAA+B;gBAChF,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,IAA2C,CAAC;QACzD,CAAC,CAAC;IA9FF,CAAC;CA+FF;AAlGD,4CAkGC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "85.0.1",
+  "version": "86.0.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/services/findings.service.ts

@@ -32,12 +32,14 @@ export class FindingsService extends AmpEntityServiceImpl<PlatformFindingUpsertD
     });
   }
 
-  getInstructions(finding: FindingDto): Promise<RestResponse> {
+  getInstructions(finding: Pick<FindingDto, 'id'>): Promise<RestResponse> {
     const url = `/${TARGET_API_ENGAGE}/v1/${this.kind}/instructions`;
     return this.rest.call({
       url,
       method: 'GET',
-      params: finding,
+      params: {
+        id: finding.id,
+      },
     });
   }
 }

package/src/services/flowSpecs.service.ts

@@ -71,4 +71,37 @@ export class FlowSpecsService extends AmpEntityServiceImpl<FlowSpecUpsertDto, Fl
       }
     );
   };
+
+  /**
+   * Get impact summary for a given flow spec. This will return the number of impacted workflows and a message describing the impact.
+   * @param spec
+   * @returns
+   */
+  getImpactSummary = async (
+    specId: string,
+    input: {temporalTypes?: Record<string, string[]>}
+  ): Promise<{affectedTimeoutWorkflows: number; flowSpecId: string; message: string}> => {
+    const res = await this.rest.call({
+      url: `/${this.targetApi}/v1/${this.kind}/${specId}/impact-summary`,
+      method: 'POST',
+      data: input,
+    });
+    return res.data as {affectedTimeoutWorkflows: number; flowSpecId: string; message: string};
+  };
+
+  /**
+   * Terminate impacted workflows for a given flow spec.
+   * This will terminate all workflows that are impacted by the flow spec and return a message describing the result.
+   * @param specId
+   * @param input
+   * @returns
+   */
+  terminateImpactedWorkflows = async (specId: string, input: {temporalTypes?: Record<string, string[]>}): Promise<{success: boolean; message: string}> => {
+    const res = await this.rest.call({
+      url: `/${this.targetApi}/v1/${this.kind}/${specId}/terminate-impacted-workflows`,
+      method: 'POST',
+      data: input,
+    });
+    return res.data as {success: boolean; message: string};
+  };
 }