@ampsec/platform-client 10.4.0 → 11.1.0

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

@@ -2,3 +2,4 @@ export * from './agent.status';
 export * from './connector.status';
 export * from './finding.severity';
 export * from './finding.status';
+export * from './jobExecution.status';

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

@@ -18,4 +18,5 @@ __exportStar(require("./agent.status"), exports);
 __exportStar(require("./connector.status"), exports);
 __exportStar(require("./finding.severity"), exports);
 __exportStar(require("./finding.status"), exports);
+__exportStar(require("./jobExecution.status"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,qDAAmC;AACnC,qDAAmC;AACnC,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,qDAAmC;AACnC,qDAAmC;AACnC,mDAAiC;AACjC,wDAAsC"}

package/build/src/dto/enums/jobExecution.status.d.ts

@@ -0,0 +1,7 @@
+export declare enum JobExecutionStatus {
+    SCHEDULED = "SCHEDULED",
+    PAUSED = "PAUSED",
+    RUNNING = "RUNNING",
+    FAILED = "FAILED",
+    SUCCEEDED = "SUCCEEDED"
+}

package/build/src/dto/enums/jobExecution.status.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobExecutionStatus = void 0;
+/* eslint-disable no-unused-vars */
+var JobExecutionStatus;
+(function (JobExecutionStatus) {
+    JobExecutionStatus["SCHEDULED"] = "SCHEDULED";
+    JobExecutionStatus["PAUSED"] = "PAUSED";
+    JobExecutionStatus["RUNNING"] = "RUNNING";
+    JobExecutionStatus["FAILED"] = "FAILED";
+    JobExecutionStatus["SUCCEEDED"] = "SUCCEEDED";
+})(JobExecutionStatus = exports.JobExecutionStatus || (exports.JobExecutionStatus = {}));
+//# sourceMappingURL=jobExecution.status.js.map

package/build/src/dto/enums/jobExecution.status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobExecution.status.js","sourceRoot":"","sources":["../../../../src/dto/enums/jobExecution.status.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AACnC,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;AACzB,CAAC,EANW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAM7B"}

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

@@ -7,7 +7,6 @@ export * from './enums';
 export * from './extKeyMap.dto';
 export * from './findings.dto';
 export * from './message.dto';
-export * from './metrics.dto';
 export * from './page.dto';
 export * from './platform';
 export * from './providers.dto';

package/build/src/dto/index.js

@@ -23,7 +23,6 @@ __exportStar(require("./enums"), exports);
 __exportStar(require("./extKeyMap.dto"), exports);
 __exportStar(require("./findings.dto"), exports);
 __exportStar(require("./message.dto"), exports);
-__exportStar(require("./metrics.dto"), exports);
 __exportStar(require("./page.dto"), exports);
 __exportStar(require("./platform"), exports);
 __exportStar(require("./providers.dto"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,6CAA2B;AAC3B,mDAAiC;AACjC,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,gDAA8B;AAC9B,gDAA8B;AAC9B,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,gDAA8B;AAC9B,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/dto/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,6CAA2B;AAC3B,mDAAiC;AACjC,6CAA2B;AAC3B,0CAAwB;AACxB,kDAAgC;AAChC,iDAA+B;AAC/B,gDAA8B;AAC9B,6CAA2B;AAC3B,6CAA2B;AAC3B,kDAAgC;AAChC,sDAAoC;AACpC,yDAAuC;AACvC,mDAAiC;AACjC,uDAAqC;AACrC,kDAAgC;AAChC,gDAA8B;AAC9B,8CAA4B"}

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

@@ -2,7 +2,8 @@ export * from './platform.agents.dto';
 export * from './platform.assets.dto';
 export * from './platform.connectors.dto';
 export * from './platform.findings.dto';
-export * from './platform.metrics.dto';
+export * from './platform.jobExecutionState.dto';
+export * from './platform.jobSpec.dto';
 export * from './platform.providers.dto';
 export * from './platform.reportResults.dto';
 export * from './platform.saasAssets.dto';

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

@@ -18,7 +18,8 @@ __exportStar(require("./platform.agents.dto"), exports);
 __exportStar(require("./platform.assets.dto"), exports);
 __exportStar(require("./platform.connectors.dto"), exports);
 __exportStar(require("./platform.findings.dto"), exports);
-__exportStar(require("./platform.metrics.dto"), exports);
+__exportStar(require("./platform.jobExecutionState.dto"), exports);
+__exportStar(require("./platform.jobSpec.dto"), exports);
 __exportStar(require("./platform.providers.dto"), exports);
 __exportStar(require("./platform.reportResults.dto"), exports);
 __exportStar(require("./platform.saasAssets.dto"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/platform/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC;AACtC,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,2DAAyC;AACzC,+DAA6C;AAC7C,4DAA0C;AAC1C,gEAA8C;AAC9C,2DAAyC;AACzC,yDAAuC;AACvC,uDAAqC;AACrC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/dto/platform/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC;AACtC,4DAA0C;AAC1C,0DAAwC;AACxC,mEAAiD;AACjD,yDAAuC;AACvC,2DAAyC;AACzC,+DAA6C;AAC7C,4DAA0C;AAC1C,gEAA8C;AAC9C,2DAAyC;AACzC,yDAAuC;AACvC,uDAAqC;AACrC,qDAAmC"}

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

@@ -0,0 +1,26 @@
+import { BaseDto, BaseUpsertDto } from '../base.dto';
+import { JobExecutionStatus } from '../enums/jobExecution.status';
+import { TenantBased, UpsertTenantBased } from './tenant.based.dto';
+export type JobExecutionPagination = {
+    /** Expected number of object to process for whole job. */
+    expected: number;
+    /** Total number of object that have already been processed. */
+    processed: number;
+};
+export type PlatformJobExecutionStateUpsertDto = BaseUpsertDto & {
+    /** `JobSpecification` ID */
+    specId: string;
+    /** Latest execution status */
+    status: JobExecutionStatus;
+    /** Date the job execution started */
+    startedAt: Date;
+    /** Optional date the job execution finished */
+    finishedAt: Date | null;
+    /** High level indication of progress */
+    pagination: JobExecutionPagination;
+    /** Optional error message. */
+    error: string | null;
+    /** Scratch space for job executors to maintain state incase of failure. */
+    scratch: unknown;
+} & UpsertTenantBased;
+export type PlatformJobExecutionStateDto = BaseDto & PlatformJobExecutionStateUpsertDto & TenantBased;

package/build/src/dto/{metrics.dto.js → platform/platform.jobExecutionState.dto.js}

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

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

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

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

@@ -0,0 +1,30 @@
+import { BaseDto, BaseUpsertDto } from '../base.dto';
+import { JobExecutionStatus } from '../enums/jobExecution.status';
+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;
+    scratch: unknown;
+};
+export type PlatformJobSpecUpsertDto = BaseUpsertDto & {
+    /** Human readable name of the Job Specification */
+    displayValue: string;
+    /** Connector Id */
+    cid: string;
+    /** Schedule configuration for the job. */
+    schedule: BasicJobSchedule;
+    /** Context for the job execution, e.g. ingestion pipeline */
+    inputContext: IngestionPipelineContext;
+    /** Status of the current or latest job execution */
+    status: JobExecutionStatus;
+    /** Date of the next job execution */
+    nextExecutionAt: string;
+    /** Optional error message from the latest execution. Expected to be `null` if `status=JobExecutionStatus.SUCCEEDED */
+    error: string | null;
+} & UpsertTenantBased;
+export type PlatformJobSpecDto = BaseDto & PlatformJobSpecUpsertDto & TenantBased;

package/build/src/dto/platform/{platform.metrics.dto.js → platform.jobSpec.dto.js}

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

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

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

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

@@ -1,5 +1,8 @@
 import { BaseDto, BaseUpsertDto } from './base.dto';
 import { MetricKind } from './enums/metric.kind';
+export type Meta = {
+    [propName: string]: Meta | string | number;
+};
 export type BaseMetric = {
     /** Kind indicator for metric type */
     kind: MetricKind;
@@ -7,6 +10,8 @@ export type BaseMetric = {
     label: string;
     /** Primary display value */
     value: number;
+    /** Generic field to hold additional information */
+    meta?: Meta;
 };
 export type DescriptiveMetric = BaseMetric & {
     /** Additional context label */

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

@@ -1,5 +1,5 @@
 import { ChangeAwareDto, ChangeAwareUpsertDto } from './base.dto';
-import { MetricDto } from './metrics.dto';
+import { MetricResults } from './reportResults.dto';
 import { RiskContributorDto } from './riskContributors.dto';
 export type UserUpsertDto = ChangeAwareUpsertDto & {
     /** Tenant ID */
@@ -21,6 +21,6 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
     /** Risk Contributors associated with the user */
     riskContributors: RiskContributorDto[];
     /** Metrics associated with the user */
-    metrics: MetricDto[];
+    metrics?: MetricResults;
 };
 export type UserDto = ChangeAwareDto & UserUpsertDto;

package/build/src/services/AmpSdk.d.ts

@@ -2,6 +2,8 @@ import { PlatformAgentDto, PlatformAgentUpsertDto, PlatformAssetDto, PlatformAss
 import { AmpEntityService, AmpGlobalEntityService, AmpSaaSEntityService } from './entity.service';
 import { AmpDataService } from './data.service';
 import { AmpRestClientOptions, RestClient } from './rest';
+import { PlatformJobSpecDto, PlatformJobSpecUpsertDto } from '../dto/platform/platform.jobSpec.dto';
+import { PlatformJobExecutionStateDto, PlatformJobExecutionStateUpsertDto } from '../dto/platform/platform.jobExecutionState.dto';
 export type AmpSdkOptions = AmpRestClientOptions;
 /**
  * AMP API
@@ -19,6 +21,8 @@ export declare class AmpSdkServices {
     readonly asset: AmpGlobalEntityService<PlatformAssetUpsertDto, PlatformAssetDto>;
     readonly connectors: AmpEntityService<PlatformConnectorUpsertDto, PlatformConnectorDto>;
     readonly findings: AmpSaaSEntityService<PlatformFindingUpsertDto, PlatformFindingDto>;
+    readonly jobExecutions: AmpEntityService<PlatformJobExecutionStateUpsertDto, PlatformJobExecutionStateDto>;
+    readonly jobs: AmpEntityService<PlatformJobSpecUpsertDto, PlatformJobSpecDto>;
     readonly providers: AmpDataService<ProviderDto>;
     readonly reportResults: AmpSaaSEntityService<PlatformReportResultUpsertDto, PlatformReportResultDto>;
     readonly saasAssets: AmpSaaSEntityService<PlatformSaasAssetUpsertDto, PlatformSaasAssetDto>;

package/build/src/services/AmpSdk.js

@@ -22,6 +22,8 @@ class AmpSdkServices {
         this.asset = new entity_service_1.AmpGlobalEntityServiceImpl(rest, constants_1.KIND.ASSETS, constants_1.TARGET_API_PLATFORM);
         this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.CONNECTORS, constants_1.TARGET_API_PLATFORM);
         this.findings = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.FINDINGS, constants_1.TARGET_API_PLATFORM);
+        this.jobExecutions = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.JOB_EXECUTIONS, constants_1.TARGET_API_PLATFORM);
+        this.jobs = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.JOB_SPEC, constants_1.TARGET_API_PLATFORM);
         this.providers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.PROVIDERS, constants_1.TARGET_API_AGENT);
         this.reportResults = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.REPORT_RESULTS, constants_1.TARGET_API_PLATFORM);
         this.saasAssets = new entity_service_1.AmpSaaSEntityServiceImpl(rest, constants_1.KIND.SAAS_ASSETS, constants_1.TARGET_API_PLATFORM);

package/build/src/services/AmpSdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"AmpSdk.js","sourceRoot":"","sources":["../../../src/services/AmpSdk.ts"],"names":[],"mappings":";;;AAuBA,qDAA4K;AAC5K,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAwE;AAIxE;;;;;;;;;;GAUG;AACH,MAAa,cAAc;IAazB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2C,IAAI,EAAE,gBAAI,CAAC,MAAM,EAAE,+BAAmB,CAAC,CAAC;QACzH,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAA2C,IAAI,EAAE,gBAAI,CAAC,MAAM,EAAE,+BAAmB,CAAC,CAAC;QAC9H,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmD,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,+BAAmB,CAAC,CAAC;QACzI,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAwB,CAA+C,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,+BAAmB,CAAC,CAAC;QACrI,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,EAAE,4BAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,aAAa,GAAG,IAAI,yCAAwB,CAAyD,IAAI,EAAE,gBAAI,CAAC,cAAc,EAAE,+BAAmB,CAAC,CAAC;QAC1J,IAAI,CAAC,UAAU,GAAG,IAAI,yCAAwB,CAAmD,IAAI,EAAE,gBAAI,CAAC,WAAW,EAAE,+BAAmB,CAAC,CAAC;QAC9I,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAwB,CAA2D,IAAI,EAAE,gBAAI,CAAC,eAAe,EAAE,+BAAmB,CAAC,CAAC;QAC9J,IAAI,CAAC,SAAS,GAAG,IAAI,yCAAwB,CAAiD,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,+BAAmB,CAAC,CAAC;QAC1I,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,EAAE,+BAAmB,CAAC,CAAC;QAC7G,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAAyC,IAAI,EAAE,gBAAI,CAAC,KAAK,EAAE,+BAAmB,CAAC,CAAC;IAC7H,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AA/BD,wCA+BC"}
+{"version":3,"file":"AmpSdk.js","sourceRoot":"","sources":["../../../src/services/AmpSdk.ts"],"names":[],"mappings":";;;AAuBA,qDAA4K;AAC5K,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAwE;AAMxE;;;;;;;;;;GAUG;AACH,MAAa,cAAc;IAezB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2C,IAAI,EAAE,gBAAI,CAAC,MAAM,EAAE,+BAAmB,CAAC,CAAC;QACzH,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAA2C,IAAI,EAAE,gBAAI,CAAC,MAAM,EAAE,+BAAmB,CAAC,CAAC;QAC9H,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmD,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,+BAAmB,CAAC,CAAC;QACzI,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAwB,CAA+C,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,+BAAmB,CAAC,CAAC;QACrI,IAAI,CAAC,aAAa,GAAG,IAAI,qCAAoB,CAAmE,IAAI,EAAE,gBAAI,CAAC,cAAc,EAAE,+BAAmB,CAAC,CAAC;QAChK,IAAI,CAAC,IAAI,GAAG,IAAI,qCAAoB,CAA+C,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,+BAAmB,CAAC,CAAC;QAC7H,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,EAAE,4BAAgB,CAAC,CAAC;QAC7F,IAAI,CAAC,aAAa,GAAG,IAAI,yCAAwB,CAAyD,IAAI,EAAE,gBAAI,CAAC,cAAc,EAAE,+BAAmB,CAAC,CAAC;QAC1J,IAAI,CAAC,UAAU,GAAG,IAAI,yCAAwB,CAAmD,IAAI,EAAE,gBAAI,CAAC,WAAW,EAAE,+BAAmB,CAAC,CAAC;QAC9I,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAwB,CAA2D,IAAI,EAAE,gBAAI,CAAC,eAAe,EAAE,+BAAmB,CAAC,CAAC;QAC9J,IAAI,CAAC,SAAS,GAAG,IAAI,yCAAwB,CAAiD,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,+BAAmB,CAAC,CAAC;QAC1I,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,EAAE,+BAAmB,CAAC,CAAC;QAC7G,IAAI,CAAC,KAAK,GAAG,IAAI,2CAA0B,CAAyC,IAAI,EAAE,gBAAI,CAAC,KAAK,EAAE,+BAAmB,CAAC,CAAC;IAC7H,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF;AAnCD,wCAmCC"}

package/build/src/services/constants.d.ts

@@ -10,6 +10,8 @@ export declare const KIND: {
     ASSETS: string;
     CONNECTORS: string;
     FINDINGS: string;
+    JOB_EXECUTIONS: string;
+    JOB_SPEC: string;
     PROVIDERS: string;
     REPORT_RESULTS: string;
     SAAS_ASSETS: string;

package/build/src/services/constants.js

@@ -9,6 +9,8 @@ exports.KIND = {
     ASSETS: 'assets',
     CONNECTORS: 'connectors',
     FINDINGS: 'findings',
+    JOB_EXECUTIONS: 'jobs_executions',
+    JOB_SPEC: 'jobs',
     PROVIDERS: 'providers',
     REPORT_RESULTS: 'report_results',
     SAAS_ASSETS: 'saas_assets',

package/build/src/services/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AAEpC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACf,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,mBAAmB;IACnB,kBAAkB,EAAE,cAAc;CACnC,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AAEpC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,iBAAiB;IACjC,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACf,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,mBAAmB;IACnB,kBAAkB,EAAE,cAAc;CACnC,CAAC"}

package/package.json

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

package/src/dto/enums/index.ts

@@ -2,3 +2,4 @@ export * from './agent.status';
 export * from './connector.status';
 export * from './finding.severity';
 export * from './finding.status';
+export * from './jobExecution.status';

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

@@ -0,0 +1,8 @@
+/* eslint-disable no-unused-vars */
+export enum JobExecutionStatus {
+  SCHEDULED = 'SCHEDULED',
+  PAUSED = 'PAUSED',
+  RUNNING = 'RUNNING',
+  FAILED = 'FAILED',
+  SUCCEEDED = 'SUCCEEDED',
+}

package/src/dto/index.ts

@@ -7,7 +7,6 @@ export * from './enums';
 export * from './extKeyMap.dto';
 export * from './findings.dto';
 export * from './message.dto';
-export * from './metrics.dto';
 export * from './page.dto';
 export * from './platform';
 export * from './providers.dto';

package/src/dto/platform/index.ts

@@ -2,7 +2,8 @@ export * from './platform.agents.dto';
 export * from './platform.assets.dto';
 export * from './platform.connectors.dto';
 export * from './platform.findings.dto';
-export * from './platform.metrics.dto';
+export * from './platform.jobExecutionState.dto';
+export * from './platform.jobSpec.dto';
 export * from './platform.providers.dto';
 export * from './platform.reportResults.dto';
 export * from './platform.saasAssets.dto';

package/src/dto/platform/platform.jobExecutionState.dto.ts

@@ -0,0 +1,29 @@
+import {BaseDto, BaseUpsertDto} from '../base.dto';
+import {JobExecutionStatus} from '../enums/jobExecution.status';
+import {TenantBased, UpsertTenantBased} from './tenant.based.dto';
+
+export type JobExecutionPagination = {
+  /** Expected number of object to process for whole job. */
+  expected: number;
+  /** Total number of object that have already been processed. */
+  processed: number;
+};
+
+export type PlatformJobExecutionStateUpsertDto = BaseUpsertDto & {
+  /** `JobSpecification` ID */
+  specId: string;
+  /** Latest execution status */
+  status: JobExecutionStatus;
+  /** Date the job execution started */
+  startedAt: Date;
+  /** Optional date the job execution finished */
+  finishedAt: Date | null;
+  /** High level indication of progress */
+  pagination: JobExecutionPagination;
+  /** Optional error message. */
+  error: string | null;
+  /** Scratch space for job executors to maintain state incase of failure. */
+  scratch: unknown;
+} & UpsertTenantBased;
+
+export type PlatformJobExecutionStateDto = BaseDto & PlatformJobExecutionStateUpsertDto & TenantBased;

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

@@ -0,0 +1,34 @@
+import {BaseDto, BaseUpsertDto} from '../base.dto';
+import {JobExecutionStatus} from '../enums/jobExecution.status';
+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;
+  scratch: unknown;
+};
+
+export type PlatformJobSpecUpsertDto = BaseUpsertDto & {
+  /** Human readable name of the Job Specification */
+  displayValue: string;
+  /** Connector Id */
+  cid: string;
+  /** Schedule configuration for the job. */
+  schedule: BasicJobSchedule;
+  /** Context for the job execution, e.g. ingestion pipeline */
+  inputContext: IngestionPipelineContext;
+  /** Status of the current or latest job execution */
+  status: JobExecutionStatus;
+  /** Date of the next job execution */
+  nextExecutionAt: string;
+  /** Optional error message from the latest execution. Expected to be `null` if `status=JobExecutionStatus.SUCCEEDED */
+  error: string | null;
+} & UpsertTenantBased;
+
+export type PlatformJobSpecDto = BaseDto & PlatformJobSpecUpsertDto & TenantBased;

package/src/dto/reportResults.dto.ts

@@ -1,6 +1,10 @@
 import {BaseDto, BaseUpsertDto} from './base.dto';
 import {MetricKind} from './enums/metric.kind';
 
+export type Meta = {
+  [propName: string]: Meta | string | number;
+};
+
 export type BaseMetric = {
   /** Kind indicator for metric type */
   kind: MetricKind;
@@ -8,6 +12,8 @@ export type BaseMetric = {
   label: string;
   /** Primary display value */
   value: number;
+  /** Generic field to hold additional information */
+  meta?: Meta;
 };
 
 export type DescriptiveMetric = BaseMetric & {

package/src/dto/users.dto.ts

@@ -1,5 +1,5 @@
 import {ChangeAwareDto, ChangeAwareUpsertDto} from './base.dto';
-import {MetricDto} from './metrics.dto';
+import {MetricResults} from './reportResults.dto';
 import {RiskContributorDto} from './riskContributors.dto';
 
 export type UserUpsertDto = ChangeAwareUpsertDto & {
@@ -22,7 +22,7 @@ export type UserUpsertDto = ChangeAwareUpsertDto & {
   /** Risk Contributors associated with the user */
   riskContributors: RiskContributorDto[];
   /** Metrics associated with the user */
-  metrics: MetricDto[];
+  metrics?: MetricResults;
 };
 
 export type UserDto = ChangeAwareDto & UserUpsertDto;

package/src/services/AmpSdk.ts

@@ -25,6 +25,8 @@ import {AmpEntityService, AmpEntityServiceImpl, AmpGlobalEntityService, AmpGloba
 import {AmpDataService, AmpDataServiceImpl} from './data.service';
 import {AmpRestClientOptions, RestClient, getAmpRestClient} from './rest';
 import {KIND, TARGET_API_AGENT, TARGET_API_PLATFORM} from './constants';
+import {PlatformJobSpecDto, PlatformJobSpecUpsertDto} from '../dto/platform/platform.jobSpec.dto';
+import {PlatformJobExecutionStateDto, PlatformJobExecutionStateUpsertDto} from '../dto/platform/platform.jobExecutionState.dto';
 
 export type AmpSdkOptions = AmpRestClientOptions;
 
@@ -44,6 +46,8 @@ export class AmpSdkServices {
   readonly asset: AmpGlobalEntityService<PlatformAssetUpsertDto, PlatformAssetDto>;
   readonly connectors: AmpEntityService<PlatformConnectorUpsertDto, PlatformConnectorDto>;
   readonly findings: AmpSaaSEntityService<PlatformFindingUpsertDto, PlatformFindingDto>;
+  readonly jobExecutions: AmpEntityService<PlatformJobExecutionStateUpsertDto, PlatformJobExecutionStateDto>;
+  readonly jobs: AmpEntityService<PlatformJobSpecUpsertDto, PlatformJobSpecDto>;
   readonly providers: AmpDataService<ProviderDto>;
   readonly reportResults: AmpSaaSEntityService<PlatformReportResultUpsertDto, PlatformReportResultDto>;
   readonly saasAssets: AmpSaaSEntityService<PlatformSaasAssetUpsertDto, PlatformSaasAssetDto>;
@@ -57,6 +61,8 @@ export class AmpSdkServices {
     this.asset = new AmpGlobalEntityServiceImpl<PlatformAssetUpsertDto, PlatformAssetDto>(rest, KIND.ASSETS, TARGET_API_PLATFORM);
     this.connectors = new AmpEntityServiceImpl<PlatformConnectorUpsertDto, PlatformConnectorDto>(rest, KIND.CONNECTORS, TARGET_API_PLATFORM);
     this.findings = new AmpSaaSEntityServiceImpl<PlatformFindingUpsertDto, PlatformFindingDto>(rest, KIND.FINDINGS, 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.providers = new AmpDataServiceImpl<ProviderDto>(rest, KIND.PROVIDERS, TARGET_API_AGENT);
     this.reportResults = new AmpSaaSEntityServiceImpl<PlatformReportResultUpsertDto, PlatformReportResultDto>(rest, KIND.REPORT_RESULTS, TARGET_API_PLATFORM);
     this.saasAssets = new AmpSaaSEntityServiceImpl<PlatformSaasAssetUpsertDto, PlatformSaasAssetDto>(rest, KIND.SAAS_ASSETS, TARGET_API_PLATFORM);

package/src/services/constants.ts

@@ -13,6 +13,8 @@ export const KIND = {
   ASSETS: 'assets',
   CONNECTORS: 'connectors',
   FINDINGS: 'findings',
+  JOB_EXECUTIONS: 'jobs_executions',
+  JOB_SPEC: 'jobs',
   PROVIDERS: 'providers',
   REPORT_RESULTS: 'report_results',
   SAAS_ASSETS: 'saas_assets',

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

@@ -1,8 +0,0 @@
-import { BaseDto, BaseUpsertDto } from './base.dto';
-export type MetricUpsertDto = BaseUpsertDto & {
-    uid: string;
-    score: number;
-    scoreDelta: number;
-    rank: number;
-};
-export type MetricDto = BaseDto & MetricUpsertDto;

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

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

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

@@ -1,4 +0,0 @@
-import { MetricDto, MetricUpsertDto } from '../metrics.dto';
-import { TenantBased, UpsertTenantBased } from './tenant.based.dto';
-export type PlatformMetricUpsertDto = MetricUpsertDto & UpsertTenantBased;
-export type PlatformMetricDto = MetricDto & TenantBased;

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

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

package/src/dto/metrics.dto.ts

@@ -1,10 +0,0 @@
-import {BaseDto, BaseUpsertDto} from './base.dto';
-
-export type MetricUpsertDto = BaseUpsertDto & {
-  uid: string;
-  score: number;
-  scoreDelta: number;
-  rank: number;
-};
-
-export type MetricDto = BaseDto & MetricUpsertDto;

package/src/dto/platform/platform.metrics.dto.ts

@@ -1,6 +0,0 @@
-import {MetricDto, MetricUpsertDto} from '../metrics.dto';
-import {TenantBased, UpsertTenantBased} from './tenant.based.dto';
-
-export type PlatformMetricUpsertDto = MetricUpsertDto & UpsertTenantBased;
-
-export type PlatformMetricDto = MetricDto & TenantBased;