@ampsec/platform-client 59.3.1 → 59.5.0

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

@@ -0,0 +1,9 @@
+import { FlowSpecCreateDto, FlowSpecDto, FlowSpecUpsertDto, Page } from '../dto';
+import { RestClient } from './rest';
+import { AmpEntityServiceImpl, EntityCallOptions } from './entity.service';
+export declare class FlowSpecsService extends AmpEntityServiceImpl<FlowSpecUpsertDto, FlowSpecDto> {
+    constructor(rest: RestClient);
+    /** @deprecated Use `createFromName` instead */
+    create: (_model: FlowSpecUpsertDto | FlowSpecUpsertDto[], _options?: EntityCallOptions) => Promise<Page<FlowSpecDto>>;
+    createFromName: (model: FlowSpecCreateDto) => Promise<FlowSpecDto>;
+}

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowSpecsService = void 0;
+const constants_1 = require("./constants");
+const entity_service_1 = require("./entity.service");
+class FlowSpecsService extends entity_service_1.AmpEntityServiceImpl {
+    constructor(rest) {
+        super(rest, constants_1.KIND.FINDINGS);
+        /** @deprecated Use `createFromName` instead */
+        this.create = (_model, _options) => {
+            throw new Error('Method not implemented.');
+        };
+        this.createFromName = async (model) => {
+            const res = await this.call({
+                url: `/${this.targetApi}/v1/${this.kind}`,
+                method: 'POST',
+                data: model,
+            }, (error) => {
+                const message = error instanceof Error ? error.message : 'Unknown error';
+                return {
+                    data: [],
+                    kind: this.kind.toUpperCase(),
+                    error: message,
+                    hints: {},
+                };
+            });
+            return res.data[0];
+        };
+    }
+}
+exports.FlowSpecsService = FlowSpecsService;
+//# sourceMappingURL=flowSpecs.service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"flowSpecs.service.js","sourceRoot":"","sources":["../../../src/services/flowSpecs.service.ts"],"names":[],"mappings":";;;AAGA,2CAAiC;AACjC,qDAAyE;AAEzE,MAAa,gBAAiB,SAAQ,qCAAoD;IACxF,YAAY,IAAgB;QAC1B,KAAK,CAAC,IAAI,EAAE,gBAAI,CAAC,QAAQ,CAAC,CAAC;QAG7B,+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;IAzBF,CAAC;CA0BF;AA7BD,4CA6BC"}

package/package.json

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

package/src/dto/flows.dto.ts

@@ -56,7 +56,8 @@ export const _FlowStateStatusDto = z.enum(['RUNNING', 'ERROR', 'SUCCESS', 'CANCE
 export type FlowStateStatusDto = z.infer<typeof _FlowStateStatusDto>;
 
 export const _FlowStateDto = _BaseDto.extend({
-  specId: z.string(),
+  /** `undefined` on NOOP Actions */
+  specId: z.string().optional(),
   uid: z.string().optional(),
   fid: z.string().optional(),
   status: _FlowStateStatusDto,
@@ -80,27 +81,87 @@ export type FlowStateFilter = z.infer<typeof _FlowStateFilter>;
  * |      FlowSpec      |
  * \====================/
  */
+export const _FlowSpecCreateDto = z.object({
+  name: z.string(),
+  description: z.string(),
+});
+export type FlowSpecCreateDto = z.infer<typeof _FlowSpecCreateDto>;
+
+export enum FlowSpecStatusKind {
+  ACTIVE = 'ACTIVE',
+  PAUSED = 'PAUSED',
+  ERROR = 'ERROR',
+}
+
+const _FlowTrigger = z.object({
+  key: z.string(),
+  displayValue: z.string().optional(),
+});
+export type FlowTrigger = z.infer<typeof _FlowTrigger>;
+
+const _FlowTriggerFilter = z.object({
+  trigger: z.array(_FlowTrigger),
+  custom: z.record(z.unknown()).optional(),
+});
+export type FlowTriggerFilter = z.infer<typeof _FlowTriggerFilter>;
+const _FlowFilter = z.object({
+  cohorts: z.array(z.unknown()),
+  custom: z.record(z.unknown()).optional(),
+});
+const _FlowTone = z.object({
+  kind: z.string(),
+});
+export const _FlowInterval = z.object({
+  minutes: z.number(),
+  value: z.number().optional(),
+  units: z.string().optional(),
+});
+export type FlowInterval = z.infer<typeof _FlowInterval>;
+
+export const _FlowActions = z.object({
+  includeInstructions: z.boolean().optional(),
+  // TODO instructions contact address???
+  expirationActionId: z.string().optional(),
+});
+export type FlowActions = z.infer<typeof _FlowActions>;
+export const _FlowRewardsConfig = z.object({
+  isUpperBound: z.boolean(),
+  points: z.number(),
+  minutes: z.number(),
+  value: z.number().optional(),
+  units: z.string().optional(),
+});
+export type FlowRewardsConfig = z.infer<typeof _FlowRewardsConfig>;
+
 export const _FlowSpecDto = _BaseDto.merge(
   z.object({
     id: z.string(),
-    tid: z.string().optional(),
+    tid: z.string(),
+    status: z.nativeEnum(FlowSpecStatusKind),
     name: z.string(),
-    fslStrategy: z.enum(['STANDARD']),
-    triggerFilter: z.object({
-      trigger: z.string(),
-      custom: z.record(z.unknown()).optional(),
-    }),
+    description: z.string(),
+    fslStrategy: z.enum(['STANDARD']).optional().default('STANDARD'),
+    triggerFilter: _FlowTriggerFilter,
     /** cohort filter */
-    filter: z.object({
-      cohorts: z.unknown().optional(),
-      custom: z.record(z.unknown()).optional(),
-    }),
+    filter: _FlowFilter,
+    engagementChannelCids: z.array(z.string()),
+    tone: _FlowTone.optional(),
+    targetResolution: _FlowInterval.optional(),
+    reminderInterval: _FlowInterval.optional(),
+    actions: _FlowActions.optional(),
+    rewards: z.array(_FlowRewardsConfig).optional(),
+    activity: z
+      .object({
+        lastTriggered: z.string().optional(),
+        activeCount: z.number().default(0),
+        totalCount: z.number().default(0),
+      })
+      .optional(),
   })
 );
-
 export type FlowSpecDto = z.infer<typeof _FlowSpecDto>;
 
-export const _FlowSpecUpsertDto = _FlowSpecDto.merge(_BaseUpsertDto);
+export const _FlowSpecUpsertDto = _FlowSpecDto.omit({activity: true}).merge(_BaseUpsertDto);
 export type FlowSpecUpsertDto = z.infer<typeof _FlowSpecUpsertDto>;
 
 export const _FlowSpecFilter = _FlowSpecDto.omit({triggerFilter: true, filter: true}).partial().merge(_PaginationFilter).merge(_SortFilter);

package/src/dto/platform/platform.flows.dto.ts

@@ -1,5 +1,5 @@
 import {z} from 'zod';
-import {_FlowSpecDto, _FlowSpecUpsertDto, _FlowStateDto, _FlowStateUpsertDto} from '../flows.dto';
+import {FlowSpecStatusKind, _FlowSpecDto, _FlowSpecUpsertDto, _FlowStateDto, _FlowStateUpsertDto} from '../flows.dto';
 import {_TenantBased, _UpsertTenantBased} from './tenant.based.dto';
 
 /*
@@ -26,13 +26,19 @@ export type PlatformFlowStateDto = z.infer<typeof _PlatformFlowStateDto>;
 
 export const NOOP_FLOW_SPEC: PlatformFlowSpecDto = {
   id: '000000000000',
+  tid: '000000000000',
+  status: FlowSpecStatusKind.ACTIVE,
+  engagementChannelCids: [],
   createdAt: '2023-04-17T13:00:00.000Z',
   updatedAt: '2023-04-17T13:00:00.000Z',
   deletedAt: null,
   name: 'NOOP - DROP TRIGGER EVENT',
+  description: 'Used internally to drop trigger events',
   fslStrategy: 'STANDARD',
   triggerFilter: {
-    trigger: 'noop',
+    trigger: [{key: 'noop', displayValue: 'NOOP'}],
+  },
+  filter: {
+    cohorts: [],
   },
-  filter: {},
 };

package/src/services/flowSpecs.service.ts

@@ -0,0 +1,36 @@
+import _ from 'lodash';
+import {FlowSpecCreateDto, FlowSpecDto, FlowSpecUpsertDto, Page} from '../dto';
+import {RestClient} from './rest';
+import {KIND} from './constants';
+import {AmpEntityServiceImpl, EntityCallOptions} from './entity.service';
+
+export class FlowSpecsService extends AmpEntityServiceImpl<FlowSpecUpsertDto, FlowSpecDto> {
+  constructor(rest: RestClient) {
+    super(rest, KIND.FINDINGS);
+  }
+
+  /** @deprecated Use `createFromName` instead */
+  create = (_model: FlowSpecUpsertDto | FlowSpecUpsertDto[], _options?: EntityCallOptions): Promise<Page<FlowSpecDto>> => {
+    throw new Error('Method not implemented.');
+  };
+
+  createFromName = async (model: FlowSpecCreateDto): Promise<FlowSpecDto> => {
+    const res: Page<FlowSpecDto> = await this.call(
+      {
+        url: `/${this.targetApi}/v1/${this.kind}`,
+        method: 'POST',
+        data: model,
+      },
+      (error: unknown) => {
+        const message = error instanceof Error ? error.message : 'Unknown error';
+        return {
+          data: [],
+          kind: this.kind.toUpperCase(),
+          error: message,
+          hints: {},
+        };
+      }
+    );
+    return res.data[0];
+  };
+}