@ampsec/platform-client 58.9.2 → 58.10.0

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

@@ -0,0 +1,38 @@
+import {z} from 'zod';
+import {_FlowSpecDto, _FlowSpecUpsertDto, _FlowStateDto, _FlowStateUpsertDto} from '../flows.dto';
+import {_TenantBased, _UpsertTenantBased} from './tenant.based.dto';
+
+/*
+ * /====================\
+ * |      FlowSpec      |
+ * \====================/
+ */
+export const _PlatformFlowSpecUpsertDto = _FlowSpecUpsertDto;
+export type PlatformFlowSpecUpsertDto = z.infer<typeof _PlatformFlowSpecUpsertDto>;
+
+export const _PlatformFlowSpecDto = _FlowSpecDto;
+export type PlatformFlowSpecDto = z.infer<typeof _PlatformFlowSpecDto>;
+
+/*
+ * /=====================\
+ * |      FlowState      |
+ * \=====================/
+ */
+export const _PlatformFlowStateUpsertDto = _FlowStateUpsertDto.merge(_UpsertTenantBased);
+export type PlatformFlowStateUpsertDto = z.infer<typeof _PlatformFlowStateUpsertDto>;
+
+export const _PlatformFlowStateDto = _FlowStateDto.merge(_TenantBased);
+export type PlatformFlowStateDto = z.infer<typeof _PlatformFlowStateDto>;
+
+export const NOOP_FLOW_SPEC: PlatformFlowSpecDto = {
+  id: '000000000000',
+  createdAt: '2023-04-17T13:00:00.000Z',
+  updatedAt: '2023-04-17T13:00:00.000Z',
+  deletedAt: null,
+  name: 'NOOP - DROP TRIGGER EVENT',
+  fslStrategy: 'STANDARD',
+  triggerFilter: {
+    trigger: 'noop',
+  },
+  filter: {},
+};

package/src/dto/platform/tenant.based.dto.ts

@@ -1,11 +1,10 @@
-import {BaseDto, BaseUpsertDto} from '../base.dto';
+import {z} from 'zod';
+import {_BaseDto} from '../base.dto';
 
-export type UpsertTenantBased = BaseUpsertDto & {
-  /** Tenant Id */
-  tid?: string;
-};
+export const _TenantBased = _BaseDto.extend({
+  tid: z.string(),
+});
+export type TenantBased = z.infer<typeof _TenantBased>;
 
-export type TenantBased = BaseDto & {
-  /** Tenant Id */
-  tid: string;
-};
+export const _UpsertTenantBased = _TenantBased.partial();
+export type UpsertTenantBased = z.infer<typeof _UpsertTenantBased>;

package/src/services/AmpSdk.ts

@@ -28,6 +28,7 @@ import {AmpSdkSettingsService} from './settings.service';
 import {AmpSaaSEntityService, AmpSaaSEntityServiceImpl, AmpSdkSaasAssetService, AmpSdkSaasComponentService, AmpSdkSaasUserService} from './saasEntity.service';
 import {ContentfulService} from './contentful.service';
 import {FindingsInsightsService} from './findingsInsights.service';
+import {PlatformFlowSpecDto, PlatformFlowSpecUpsertDto, PlatformFlowStateDto, PlatformFlowStateUpsertDto} from '../dto/platform/platform.flows.dto';
 
 export type AmpSdkOptions = AmpRestClientOptions;
 
@@ -48,6 +49,8 @@ export class AmpSdkServices {
   readonly enums: EnumService;
   readonly findings: AmpSaaSEntityService<PlatformFindingUpsertDto, PlatformFindingDto>;
   readonly findingsInsights: FindingsInsightsService;
+  readonly flowSpecs: AmpSaaSEntityService<PlatformFlowSpecUpsertDto, PlatformFlowSpecDto>;
+  readonly flowStates: AmpSaaSEntityService<PlatformFlowStateUpsertDto, PlatformFlowStateDto>;
   readonly jobExecutions: AmpEntityService<PlatformJobExecutionStateUpsertDto, PlatformJobExecutionStateDto>;
   readonly jobs: AmpEntityService<PlatformJobSpecUpsertDto, PlatformJobSpecDto>;
   readonly notifications: AmpEntityService<PlatformNotificationUpsertDto, PlatformNotificationDto>;
@@ -70,6 +73,8 @@ export class AmpSdkServices {
     this.enums = new DefaultEnumService(rest, TARGET_API_PLATFORM);
     this.findings = new AmpSaaSEntityServiceImpl<PlatformFindingUpsertDto, PlatformFindingDto>(rest, KIND.FINDINGS, TARGET_API_PLATFORM);
     this.findingsInsights = new FindingsInsightsService(rest, KIND.FINDINGS_INSIGHTS, TARGET_API_PLATFORM);
+    this.flowSpecs = new AmpSaaSEntityServiceImpl<PlatformFlowSpecUpsertDto, PlatformFlowSpecDto>(rest, KIND.FLOW_SPECS, TARGET_API_PLATFORM);
+    this.flowStates = new AmpSaaSEntityServiceImpl<PlatformFlowStateUpsertDto, PlatformFlowStateDto>(rest, KIND.FLOW_STATES, TARGET_API_PLATFORM);
     this.jobExecutions = new AmpEntityServiceImpl<PlatformJobExecutionStateUpsertDto, PlatformJobExecutionStateDto>(rest, KIND.JOB_EXECUTIONS, TARGET_API_PLATFORM);
     this.jobs = new AmpEntityServiceImpl<PlatformJobSpecUpsertDto, PlatformJobSpecDto>(rest, KIND.JOB_SPEC, TARGET_API_PLATFORM);
     this.notifications = new AmpEntityServiceImpl<PlatformNotificationUpsertDto, PlatformNotificationDto>(rest, KIND.NOTIFICATIONS, TARGET_API_PLATFORM);

package/src/services/constants.ts

@@ -18,6 +18,8 @@ export const KIND = {
   ENUM_TITLES: 'titles',
   FINDINGS: 'findings',
   FINDINGS_INSIGHTS: 'findings_insights',
+  FLOW_SPECS: 'flow_specs',
+  FLOW_STATES: 'flow_states',
   JOB_EXECUTIONS: 'job_executions',
   JOB_SPEC: 'jobs',
   NOTIFICATIONS: 'notifications',

package/src/services/utils.ts

@@ -1,4 +1,20 @@
 import _ from 'lodash';
+import {customAlphabet} from 'nanoid';
+
+const alphabet = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
+const idGenerator = customAlphabet(alphabet, 12);
+
+export const genAmpId = (length = 12): string => {
+  return idGenerator(length);
+};
+
+export const genShortAmpId = (): string => {
+  return genAmpId(6);
+};
+
+export const genLongAmpId = (): string => {
+  return genAmpId(32);
+};
 
 export function formatMacAddress(raw: string): string {
   const lower = raw.toLowerCase().replace(/[^a-f0-9]/g, '');