@ampsec/platform-client 21.3.0 → 22.1.0

package/build/src/FilterCriteria.d.ts

@@ -36,6 +36,9 @@ export type DateMatcher = {
     $lte?: string;
     $gte?: string;
 };
+export type SortOptions = {
+    [key: string]: 'ASC' | 'DESC';
+};
 export type FilterCriteria = {
     /** Number of records to return. */
     limit?: number;
@@ -59,6 +62,8 @@ export type FilterCriteria = {
     updatedAt?: DateMatcher;
     /** Deleted at Date. `null` if not deleted */
     deletedAt?: DateMatcher | null;
+    /** Sort Criteria */
+    sort?: SortOptions;
     /** catch all bucket for other fields */
     [key: string]: string | StringMatcher | number | NumberMatcher | boolean | null | undefined;
 };

package/build/src/dto/enums/platformJobKind.d.ts

@@ -0,0 +1,6 @@
+export declare enum PlatformJobKind {
+    INGESTION_PIPELINE_CONTEXT = "INGESTION_PIPELINE_CONTEXT",
+    INSIGHT_FINDINGS_CONTEXT = "INSIGHT_FINDINGS_CONTEXT",
+    INSIGHT_REPORTS_CONTEXT = "INSIGHT_REPORTS_CONTEXT",
+    AMPSEC_PLATFORM_CONTEXT = "AMPSEC_PLATFORM_CONTEXT"
+}

package/build/src/dto/enums/platformJobKind.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformJobKind = void 0;
+/* eslint-disable no-unused-vars */
+var PlatformJobKind;
+(function (PlatformJobKind) {
+    PlatformJobKind["INGESTION_PIPELINE_CONTEXT"] = "INGESTION_PIPELINE_CONTEXT";
+    PlatformJobKind["INSIGHT_FINDINGS_CONTEXT"] = "INSIGHT_FINDINGS_CONTEXT";
+    PlatformJobKind["INSIGHT_REPORTS_CONTEXT"] = "INSIGHT_REPORTS_CONTEXT";
+    PlatformJobKind["AMPSEC_PLATFORM_CONTEXT"] = "AMPSEC_PLATFORM_CONTEXT";
+})(PlatformJobKind || (exports.PlatformJobKind = PlatformJobKind = {}));
+//# sourceMappingURL=platformJobKind.js.map

package/build/src/dto/enums/platformJobKind.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platformJobKind.js","sourceRoot":"","sources":["../../../../src/dto/enums/platformJobKind.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,4EAAyD,CAAA;IACzD,wEAAqD,CAAA;IACrD,sEAAmD,CAAA;IACnD,sEAAmD,CAAA;AACrD,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B"}

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

@@ -1,25 +1,26 @@
 import { BaseDto, BaseUpsertDto } from '../base.dto';
 import { JobExecutionStatus } from '../enums/jobExecution.status';
+import { PlatformJobKind } from '../enums/platformJobKind';
 import { TenantBased, UpsertTenantBased } from './tenant.based.dto';
 export type BasicJobSchedule = {
     kind: 'basic';
     offset: number;
     interval: number;
 };
-export type IngestionPipelineContext = {
-    kind: 'INGESTION_PIPELINE_CONTEXT';
-    cid: string;
+export type JobInputContext = {
     scratch: unknown;
 };
 export type PlatformJobSpecUpsertDto = BaseUpsertDto & {
-    /** Human readable name of the Job Specification */
-    displayValue: string;
+    /** Job type */
+    kind: PlatformJobKind;
+    /** Tenant Id */
+    tid?: string;
     /** Connector Id */
-    cid: string;
+    cid?: string;
     /** Schedule configuration for the job. */
     schedule: BasicJobSchedule;
     /** Context for the job execution, e.g. ingestion pipeline */
-    inputContext: IngestionPipelineContext;
+    inputContext: JobInputContext;
     /** Status of the current or latest job execution */
     status: JobExecutionStatus;
     /** Date of the next job execution */

package/package.json

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

package/src/FilterCriteria.ts

@@ -38,6 +38,10 @@ export type DateMatcher = {
   $gte?: string;
 };
 
+export type SortOptions = {
+  [key: string]: 'ASC' | 'DESC';
+};
+
 export type FilterCriteria = {
   /** Number of records to return. */
   limit?: number;
@@ -61,6 +65,8 @@ export type FilterCriteria = {
   updatedAt?: DateMatcher;
   /** Deleted at Date. `null` if not deleted */
   deletedAt?: DateMatcher | null;
+  /** Sort Criteria */
+  sort?: SortOptions;
   /** catch all bucket for other fields */
   [key: string]: string | StringMatcher | number | NumberMatcher | boolean | null | undefined;
 };

package/src/dto/enums/platformJobKind.ts

@@ -0,0 +1,7 @@
+/* eslint-disable no-unused-vars */
+export enum PlatformJobKind {
+  INGESTION_PIPELINE_CONTEXT = 'INGESTION_PIPELINE_CONTEXT',
+  INSIGHT_FINDINGS_CONTEXT = 'INSIGHT_FINDINGS_CONTEXT',
+  INSIGHT_REPORTS_CONTEXT = 'INSIGHT_REPORTS_CONTEXT',
+  AMPSEC_PLATFORM_CONTEXT = 'AMPSEC_PLATFORM_CONTEXT',
+}

package/src/dto/platform/platform.jobSpec.dto.ts

@@ -1,5 +1,6 @@
 import {BaseDto, BaseUpsertDto} from '../base.dto';
 import {JobExecutionStatus} from '../enums/jobExecution.status';
+import {PlatformJobKind} from '../enums/platformJobKind';
 import {TenantBased, UpsertTenantBased} from './tenant.based.dto';
 
 export type BasicJobSchedule = {
@@ -8,21 +9,21 @@ export type BasicJobSchedule = {
   interval: number;
 };
 
-export type IngestionPipelineContext = {
-  kind: 'INGESTION_PIPELINE_CONTEXT';
-  cid: string;
+export type JobInputContext = {
   scratch: unknown;
 };
 
 export type PlatformJobSpecUpsertDto = BaseUpsertDto & {
-  /** Human readable name of the Job Specification */
-  displayValue: string;
+  /** Job type */
+  kind: PlatformJobKind;
+  /** Tenant Id */
+  tid?: string;
   /** Connector Id */
-  cid: string;
+  cid?: string;
   /** Schedule configuration for the job. */
   schedule: BasicJobSchedule;
   /** Context for the job execution, e.g. ingestion pipeline */
-  inputContext: IngestionPipelineContext;
+  inputContext: JobInputContext;
   /** Status of the current or latest job execution */
   status: JobExecutionStatus;
   /** Date of the next job execution */