@ampsec/platform-client 58.11.0 → 59.0.0

package/build/src/dto/enums/supportedMessageChannelKind.enum.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSupportedMessageChannelKindFrom = exports.SupportedMessageChannelKind = void 0;
-var SupportedMessageChannelKind;
-(function (SupportedMessageChannelKind) {
-    SupportedMessageChannelKind["SLACK"] = "SLACK";
-    SupportedMessageChannelKind["UNSUPPORTED"] = "UNSUPPORTED";
-})(SupportedMessageChannelKind || (exports.SupportedMessageChannelKind = SupportedMessageChannelKind = {}));
-const getSupportedMessageChannelKindFrom = (description) => {
-    if (description) {
-        for (const kind in SupportedMessageChannelKind) {
-            if (description.toUpperCase().includes(kind)) {
-                return SupportedMessageChannelKind[kind];
-            }
-        }
-    }
-    return SupportedMessageChannelKind.UNSUPPORTED;
-};
-exports.getSupportedMessageChannelKindFrom = getSupportedMessageChannelKindFrom;
-//# sourceMappingURL=supportedMessageChannelKind.enum.js.map

package/build/src/dto/enums/supportedMessageChannelKind.enum.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"supportedMessageChannelKind.enum.js","sourceRoot":"","sources":["../../../../src/dto/enums/supportedMessageChannelKind.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACrC,8CAAe,CAAA;IACf,0DAA2B,CAAA;AAC7B,CAAC,EAHW,2BAA2B,2CAA3B,2BAA2B,QAGtC;AAEM,MAAM,kCAAkC,GAAG,CAAC,WAA+B,EAA+B,EAAE;IACjH,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,2BAA2B,EAAE,CAAC;YAC/C,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7C,OAAO,2BAA2B,CAAC,IAAgD,CAAgC,CAAC;YACtH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,2BAA2B,CAAC,WAAW,CAAC;AACjD,CAAC,CAAC;AAVW,QAAA,kCAAkC,sCAU7C"}

package/build/src/dto/enums/workflowStep.kind.d.ts

@@ -1,4 +0,0 @@
-export declare enum WorkflowStepKind {
-    NOTIFICATION = "NOTIFICATION",
-    PAUSE = "PAUSE"
-}

package/build/src/dto/enums/workflowStep.kind.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowStepKind = void 0;
-var WorkflowStepKind;
-(function (WorkflowStepKind) {
-    WorkflowStepKind["NOTIFICATION"] = "NOTIFICATION";
-    WorkflowStepKind["PAUSE"] = "PAUSE";
-})(WorkflowStepKind || (exports.WorkflowStepKind = WorkflowStepKind = {}));
-//# sourceMappingURL=workflowStep.kind.js.map

package/build/src/dto/enums/workflowStep.kind.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflowStep.kind.js","sourceRoot":"","sources":["../../../../src/dto/enums/workflowStep.kind.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iDAA6B,CAAA;IAC7B,mCAAe,CAAA;AACjB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}

package/build/src/dto/enums/workflowTrigger.kind.d.ts

@@ -1,5 +0,0 @@
-export declare enum WorkflowTriggerKind {
-    FINDING = "FINDING",
-    USER = "USER",
-    SAAS_COMPONENT = "SAAS_COMPONENT"
-}

package/build/src/dto/enums/workflowTrigger.kind.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowTriggerKind = void 0;
-var WorkflowTriggerKind;
-(function (WorkflowTriggerKind) {
-    WorkflowTriggerKind["FINDING"] = "FINDING";
-    WorkflowTriggerKind["USER"] = "USER";
-    WorkflowTriggerKind["SAAS_COMPONENT"] = "SAAS_COMPONENT";
-})(WorkflowTriggerKind || (exports.WorkflowTriggerKind = WorkflowTriggerKind = {}));
-//# sourceMappingURL=workflowTrigger.kind.js.map

package/build/src/dto/enums/workflowTrigger.kind.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflowTrigger.kind.js","sourceRoot":"","sources":["../../../../src/dto/enums/workflowTrigger.kind.ts"],"names":[],"mappings":";;;AAAA,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,oCAAa,CAAA;IACb,wDAAiC,CAAA;AACnC,CAAC,EAJW,mBAAmB,mCAAnB,mBAAmB,QAI9B"}

package/build/src/dto/platform/platform.workflow.dto.d.ts

@@ -1,6 +0,0 @@
-import { WorkflowDto, WorkflowProgressDto, WorkflowProgressUpsertDto, WorkflowUpsertDto } from '../workflow.dto';
-import { TenantBased } from './tenant.based.dto';
-export type PlatformWorkflowUpsertDto = WorkflowUpsertDto & TenantBased;
-export type PlatformWorkflowDto = WorkflowDto & TenantBased;
-export type PlatformWorkflowProgressUpsertDto = WorkflowProgressUpsertDto & TenantBased;
-export type PlatformWorkflowProgressDto = WorkflowProgressDto & TenantBased;

package/build/src/dto/platform/platform.workflow.dto.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=platform.workflow.dto.js.map

package/build/src/dto/platform/platform.workflow.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"platform.workflow.dto.js","sourceRoot":"","sources":["../../../../src/dto/platform/platform.workflow.dto.ts"],"names":[],"mappings":""}

package/build/src/dto/platform/platform.workflowAssignment.dto.d.ts

@@ -1,4 +0,0 @@
-import { WorkflowAssignmentUpsertDto } from '../workflowAssignment.dto';
-import { TenantBased } from './tenant.based.dto';
-export type PlatformWorkflowAssignmentUpsertDto = WorkflowAssignmentUpsertDto & TenantBased;
-export type PlatformWorkflowAssignmentDto = PlatformWorkflowAssignmentUpsertDto & TenantBased;

package/build/src/dto/platform/platform.workflowAssignment.dto.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=platform.workflowAssignment.dto.js.map

package/build/src/dto/platform/platform.workflowAssignment.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"platform.workflowAssignment.dto.js","sourceRoot":"","sources":["../../../../src/dto/platform/platform.workflowAssignment.dto.ts"],"names":[],"mappings":""}

package/build/src/dto/workflow.dto.d.ts

@@ -1,85 +0,0 @@
-import { BaseDto } from './base.dto';
-import { ContentStrategyKind, DeliveryStrategyKind } from './enums';
-import { FindingOutcome } from './enums/finding.outcome';
-import { WorkflowStepKind } from './enums/workflowStep.kind';
-import { WorkflowTriggerKind } from './enums/workflowTrigger.kind';
-export type WorflowStepDescriptor = {
-    /** Type of the notification step, either NOTIFICATION or PAUSE */
-    kind: WorkflowStepKind;
-    /** Optional default values to be used of no other is provided */
-    defaults?: {
-        [propName: string]: string | number | boolean | FindingOutcome;
-    };
-};
-export type NotificationStepDescriptor = WorflowStepDescriptor & {
-    /** Delivery strategy to be used for the notification */
-    deliveryStrategyKinds: DeliveryStrategyKind[];
-};
-export type PauseStepDescriptor = WorflowStepDescriptor & {
-    /** Duration, in days, to wait before executing the next step in the workflow */
-    pauseDuration: number;
-};
-export type ContentDescriptor = {
-    /** Kind of the content that will be generated for the notification */
-    kind: ContentStrategyKind;
-};
-export type TemplateContentDescriptor = ContentDescriptor & {
-    /** ID of the template to be used for the notification */
-    templateId: string;
-};
-export type WorkflowStep = {
-    /** Indicates the type of workflow step and contains relevant information for each */
-    stepDescriptor: NotificationStepDescriptor | PauseStepDescriptor;
-    /** Content to be used for the notification */
-    contentDescriptor?: ContentDescriptor | TemplateContentDescriptor;
-    /** Step number to transition the workflow to on success */
-    successStepNumber: number | null;
-    /** Step number to transition the workflow to on failure */
-    failureStepNumber: number | null;
-};
-export type WorkflowSteps = {
-    [propName: number]: WorkflowStep;
-};
-export type WorkflowTriggerRule = {
-    [propName: string]: string | number | boolean | null | {
-        [propName: string]: string | number | boolean | WorkflowTriggerRule;
-    } | WorkflowTriggerRule[];
-};
-export type WorkflowTrigger = {
-    /** Kind of the trigger */
-    kind: WorkflowTriggerKind;
-    /** Rule to which the applicable entity type must conform to trigger the workflow */
-    rule: unknown;
-    /** Number of days a finding has to exist in addition to matching the above rule */
-    sla?: number;
-};
-export type WorkflowUpsertDto = {
-    /** Name of the workflow */
-    name: string;
-    /** Description of the workflow */
-    description?: string;
-    /** Trigger that begins execution of the workflow */
-    trigger: WorkflowTrigger;
-    /** Steps in the workflow */
-    steps: WorkflowSteps;
-};
-export type WorkflowDto = BaseDto & WorkflowUpsertDto;
-export type WorkflowProgressUpsertDto = {
-    /** ID of the workflow */
-    wfid: string;
-    /** ID of the finding for which the workflow is being executed */
-    fid?: string | null;
-    /** Step number to transition the workflow to next */
-    nextStep: number | null;
-    /** ID of the user for which the workflow is being executed */
-    uid: string;
-    /** whether or not this instance of the workflow has been completed */
-    workflowCompleted: boolean;
-    /**
-     * Used as the naive implementation of notification schedules inside Flows.
-     * "Resets" notifications schedule after pause or failed verification.
-     * Defaults to "NOW".
-     */
-    nextNotificationAfter?: string;
-};
-export type WorkflowProgressDto = BaseDto & WorkflowProgressUpsertDto;

package/build/src/dto/workflow.dto.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=workflow.dto.js.map

package/build/src/dto/workflow.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflow.dto.js","sourceRoot":"","sources":["../../../src/dto/workflow.dto.ts"],"names":[],"mappings":""}

package/build/src/dto/workflowAssignment.dto.d.ts

@@ -1,8 +0,0 @@
-import { BaseDto } from './base.dto';
-export type WorkflowAssignmentUpsertDto = {
-    /** ID of the workflow */
-    wfid: string;
-    /** ID of the user to which the workflow is being assigned */
-    uid: string;
-};
-export type WorkflowAssignmentDto = BaseDto & WorkflowAssignmentUpsertDto;

package/build/src/dto/workflowAssignment.dto.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=workflowAssignment.dto.js.map

package/build/src/dto/workflowAssignment.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflowAssignment.dto.js","sourceRoot":"","sources":["../../../src/dto/workflowAssignment.dto.ts"],"names":[],"mappings":""}

package/src/dto/enums/contentStrategy.kind.ts

@@ -1,5 +0,0 @@
-export enum ContentStrategyKind {
-  LLM = 'LLM',
-  RAW = 'RAW',
-  TEMPLATE = 'TEMPLATE',
-}

package/src/dto/enums/deliveryStrategy.kind.ts

@@ -1,4 +0,0 @@
-export enum DeliveryStrategyKind {
-  EMAIL = 'EMAIL',
-  MESSAGING = 'MESSAGING',
-}

package/src/dto/enums/notification.status.ts

@@ -1,6 +0,0 @@
-export enum NotificationStatus {
-  INVALID = 'INVALID',
-  PENDING = 'PENDING',
-  READ = 'READ',
-  SENT = 'SENT',
-}

package/src/dto/enums/supportedMessageChannelKind.enum.ts

@@ -1,16 +0,0 @@
-export enum SupportedMessageChannelKind {
-  SLACK = 'SLACK',
-  UNSUPPORTED = 'UNSUPPORTED',
-}
-
-export const getSupportedMessageChannelKindFrom = (description: string | undefined): SupportedMessageChannelKind => {
-  if (description) {
-    for (const kind in SupportedMessageChannelKind) {
-      if (description.toUpperCase().includes(kind)) {
-        return SupportedMessageChannelKind[kind as keyof typeof SupportedMessageChannelKind] as SupportedMessageChannelKind;
-      }
-    }
-  }
-
-  return SupportedMessageChannelKind.UNSUPPORTED;
-};

package/src/dto/enums/workflowStep.kind.ts

@@ -1,4 +0,0 @@
-export enum WorkflowStepKind {
-  NOTIFICATION = 'NOTIFICATION',
-  PAUSE = 'PAUSE',
-}

package/src/dto/enums/workflowTrigger.kind.ts

@@ -1,5 +0,0 @@
-export enum WorkflowTriggerKind {
-  FINDING = 'FINDING',
-  USER = 'USER',
-  SAAS_COMPONENT = 'SAAS_COMPONENT',
-}

package/src/dto/platform/platform.workflow.dto.ts

@@ -1,10 +0,0 @@
-import {WorkflowDto, WorkflowProgressDto, WorkflowProgressUpsertDto, WorkflowUpsertDto} from '../workflow.dto';
-import {TenantBased} from './tenant.based.dto';
-
-export type PlatformWorkflowUpsertDto = WorkflowUpsertDto & TenantBased;
-
-export type PlatformWorkflowDto = WorkflowDto & TenantBased;
-
-export type PlatformWorkflowProgressUpsertDto = WorkflowProgressUpsertDto & TenantBased;
-
-export type PlatformWorkflowProgressDto = WorkflowProgressDto & TenantBased;

package/src/dto/platform/platform.workflowAssignment.dto.ts

@@ -1,6 +0,0 @@
-import {WorkflowAssignmentUpsertDto} from '../workflowAssignment.dto';
-import {TenantBased} from './tenant.based.dto';
-
-export type PlatformWorkflowAssignmentUpsertDto = WorkflowAssignmentUpsertDto & TenantBased;
-
-export type PlatformWorkflowAssignmentDto = PlatformWorkflowAssignmentUpsertDto & TenantBased;

package/src/dto/workflow.dto.ts

@@ -1,104 +0,0 @@
-import {BaseDto} from './base.dto';
-import {ContentStrategyKind, DeliveryStrategyKind} from './enums';
-import {FindingOutcome} from './enums/finding.outcome';
-import {WorkflowStepKind} from './enums/workflowStep.kind';
-import {WorkflowTriggerKind} from './enums/workflowTrigger.kind';
-
-export type WorflowStepDescriptor = {
-  /** Type of the notification step, either NOTIFICATION or PAUSE */
-  kind: WorkflowStepKind;
-  /** Optional default values to be used of no other is provided */
-  defaults?: {
-    [propName: string]: string | number | boolean | FindingOutcome;
-  };
-};
-
-export type NotificationStepDescriptor = WorflowStepDescriptor & {
-  /** Delivery strategy to be used for the notification */
-  deliveryStrategyKinds: DeliveryStrategyKind[];
-};
-
-export type PauseStepDescriptor = WorflowStepDescriptor & {
-  /** Duration, in days, to wait before executing the next step in the workflow */
-  pauseDuration: number;
-};
-
-export type ContentDescriptor = {
-  /** Kind of the content that will be generated for the notification */
-  kind: ContentStrategyKind;
-};
-
-export type TemplateContentDescriptor = ContentDescriptor & {
-  /** ID of the template to be used for the notification */
-  templateId: string;
-};
-
-export type WorkflowStep = {
-  /** Indicates the type of workflow step and contains relevant information for each */
-  stepDescriptor: NotificationStepDescriptor | PauseStepDescriptor;
-  /** Content to be used for the notification */
-  contentDescriptor?: ContentDescriptor | TemplateContentDescriptor;
-  /** Step number to transition the workflow to on success */
-  successStepNumber: number | null;
-  /** Step number to transition the workflow to on failure */
-  failureStepNumber: number | null;
-};
-
-export type WorkflowSteps = {
-  [propName: number]: WorkflowStep;
-};
-
-export type WorkflowTriggerRule = {
-  [propName: string]:
-    | string
-    | number
-    | boolean
-    | null
-    | {
-        [propName: string]: string | number | boolean | WorkflowTriggerRule;
-      }
-    | WorkflowTriggerRule[];
-};
-
-export type WorkflowTrigger = {
-  /** Kind of the trigger */
-  kind: WorkflowTriggerKind;
-  /** Rule to which the applicable entity type must conform to trigger the workflow */
-  rule: unknown;
-  /** Number of days a finding has to exist in addition to matching the above rule */
-  sla?: number;
-};
-
-export type WorkflowUpsertDto = {
-  /** Name of the workflow */
-  name: string;
-  /** Description of the workflow */
-  description?: string;
-  /** Trigger that begins execution of the workflow */
-  trigger: WorkflowTrigger;
-  /** Steps in the workflow */
-  steps: WorkflowSteps;
-};
-
-export type WorkflowDto = BaseDto & WorkflowUpsertDto;
-
-export type WorkflowProgressUpsertDto = {
-  /** ID of the workflow */
-  wfid: string;
-  /** ID of the finding for which the workflow is being executed */
-  fid?: string | null;
-  /** Step number to transition the workflow to next */
-  nextStep: number | null;
-  /** ID of the user for which the workflow is being executed */
-  uid: string;
-  /** whether or not this instance of the workflow has been completed */
-  workflowCompleted: boolean;
-  /**
-   * Used as the naive implementation of notification schedules inside Flows.
-   * "Resets" notifications schedule after pause or failed verification.
-   * Defaults to "NOW".
-   */
-  nextNotificationAfter?: string;
-};
-
-export type WorkflowProgressDto = BaseDto & WorkflowProgressUpsertDto;

package/src/dto/workflowAssignment.dto.ts

@@ -1,10 +0,0 @@
-import {BaseDto} from './base.dto';
-
-export type WorkflowAssignmentUpsertDto = {
-  /** ID of the workflow */
-  wfid: string;
-  /** ID of the user to which the workflow is being assigned */
-  uid: string;
-};
-
-export type WorkflowAssignmentDto = BaseDto & WorkflowAssignmentUpsertDto;