@jupiterone/integration-sdk-core
Advanced tools
Comparing version 4.0.1 to 4.1.0
import { IntegrationInstance, IntegrationInstanceConfig } from './instance'; | ||
import { JobState } from './jobState'; | ||
import { IntegrationLogger } from './logger'; | ||
export declare type Execution = { | ||
startedOn: number; | ||
endedOn?: number; | ||
}; | ||
export declare type ExecutionHistory = { | ||
lastExecution: Execution; | ||
lastSuccessfulExecution?: Execution; | ||
}; | ||
export interface ExecutionContext { | ||
logger: IntegrationLogger; | ||
history?: ExecutionHistory; | ||
} | ||
@@ -7,0 +16,0 @@ /** |
@@ -11,4 +11,5 @@ export * from './config'; | ||
export * from './metric'; | ||
export * from './storage'; | ||
export * from './persistedObject'; | ||
export * from './entity'; | ||
export * from './relationship'; |
@@ -23,2 +23,3 @@ "use strict"; | ||
__exportStar(require("./metric"), exports); | ||
__exportStar(require("./storage"), exports); | ||
__exportStar(require("./persistedObject"), exports); | ||
@@ -25,0 +26,0 @@ __exportStar(require("./entity"), exports); |
@@ -0,4 +1,4 @@ | ||
import { RelationshipClass } from '@jupiterone/data-model'; | ||
import { ExecutionContext, IntegrationStepExecutionContext, StepExecutionContext } from './context'; | ||
import { IntegrationInstanceConfig } from './instance'; | ||
import { RelationshipClass } from '@jupiterone/data-model'; | ||
export interface StepStartState { | ||
@@ -31,10 +31,13 @@ /** | ||
/** | ||
* Entity or relatioship types that were declared | ||
* when the step was configured. | ||
* Entity or relationship types declared by the step definition. | ||
*/ | ||
declaredTypes: string[]; | ||
/** | ||
* Entity or relationship types that were encountered during | ||
* the step's execution. | ||
* Entity or relationship types declared to be partial collections by the step | ||
* definition. | ||
*/ | ||
partialTypes: string[]; | ||
/** | ||
* Entity or relationship types encountered during step execution. | ||
*/ | ||
encounteredTypes: string[]; | ||
@@ -45,2 +48,16 @@ }; | ||
_type: string; | ||
/** | ||
* Indicates the set of data represented by this `_type` should always be | ||
* considered a partial dataset. | ||
* | ||
* This is useful in steps that ingest an ever growing collection of a type of | ||
* data, ensuring the synchronization system does not delete older data that | ||
* will not be seen as ingestion progresses through the collection over | ||
* numerous executions. For example: | ||
* | ||
* * Vulnerability findings | ||
* * SCM pull requests | ||
* * Ticket systems | ||
*/ | ||
partial?: boolean; | ||
} | ||
@@ -47,0 +64,0 @@ export interface StepEntityMetadata extends StepGraphObjectMetadata { |
{ | ||
"name": "@jupiterone/integration-sdk-core", | ||
"version": "4.0.1", | ||
"version": "4.1.0", | ||
"description": "The SDK for developing JupiterOne integrations", | ||
@@ -33,3 +33,3 @@ "main": "dist/src/index.js", | ||
}, | ||
"gitHead": "93c9e694cf1fe11dd89aa2e82164571459892aca" | ||
"gitHead": "144834ddf08b540e071423c01c478864c19f500f" | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
362968
79
2308