@jupiterone/integration-sdk-core 8.1.3 → 8.2.0

package/dist/src/types/config.d.ts

@@ -1,7 +1,7 @@
 import { IntegrationInstanceConfig } from './instance';
 import { GetStepStartStatesFunction, Step } from './step';
 import { InvocationValidationFunction } from './validation';
-import { ExecutionContext, IntegrationExecutionContext, StepExecutionContext, IntegrationStepExecutionContext } from './context';
+import { ExecutionContext, IntegrationExecutionContext, StepExecutionContext, IntegrationStepExecutionContext, IntegrationExecutionConfig } from './context';
 import { Entity } from './entity';
 /**
  * Normalization transform for tracking keys in an integration. Allows
@@ -14,12 +14,16 @@ import { Entity } from './entity';
  */
 export declare type KeyNormalizationFunction = (_key: string) => string;
 export declare type BeforeAddEntityHookFunction<TExecutionContext extends ExecutionContext> = (context: TExecutionContext, entity: Entity) => Entity;
+export declare type LoadExecutionConfigFunction<TInstanceConfig extends IntegrationInstanceConfig = IntegrationInstanceConfig, TExecutionConfig extends IntegrationExecutionConfig = IntegrationExecutionConfig> = (options: {
+    config: TInstanceConfig;
+}) => TExecutionConfig;
 export interface InvocationConfig<TExecutionContext extends ExecutionContext, TStepExecutionContext extends StepExecutionContext> {
     validateInvocation?: InvocationValidationFunction<TExecutionContext>;
     getStepStartStates?: GetStepStartStatesFunction<TExecutionContext>;
     integrationSteps: Step<TStepExecutionContext>[];
     normalizeGraphObjectKey?: KeyNormalizationFunction;
     beforeAddEntity?: BeforeAddEntityHookFunction<TExecutionContext>;
+    loadExecutionConfig?: LoadExecutionConfigFunction;
     /**
      * An optional array of identifiers used to execute dependency
      * graphs in a specific order. These values should match the

package/dist/src/types/context.d.ts

@@ -14,19 +14,37 @@ export interface ExecutionContext {
     logger: IntegrationLogger;
     executionHistory: ExecutionHistory;
 }
+/**
+ * A configuration object constructed by an integration just before the
+ * integration is executed. This is distinct from the
+ * `IntegrationInstanceConfig`, containing dynamic values perhaps calculated
+ * based on the instance config.
+ */
+export declare type IntegrationExecutionConfig = object;
 /**
  * @param TConfig the integration specific type of the `instance.config`
  * property
  */
-export declare type IntegrationExecutionContext<TConfig extends IntegrationInstanceConfig = IntegrationInstanceConfig> = ExecutionContext & {
+export declare type IntegrationLoadExecutionConfigContext<TConfig extends IntegrationInstanceConfig> = ExecutionContext & {
     instance: IntegrationInstance<TConfig>;
 };
+/**
+ * @param TConfig the integration specific type of the `instance.config`
+ * property
+ * @param TExecutionConfig the configuration type produced by the
+ * integration's optional `loadExecutionConfig` function
+ */
+export declare type IntegrationExecutionContext<TConfig extends IntegrationInstanceConfig = IntegrationInstanceConfig, TExecutionConfig extends IntegrationExecutionConfig = IntegrationExecutionConfig> = IntegrationLoadExecutionConfigContext<TConfig> & {
+    executionConfig: TExecutionConfig;
+};
 export declare type StepExecutionContext = ExecutionContext & {
     jobState: JobState;
 };
 /**
  * @param TConfig the integration specific type of the `instance.config`
  * property
+ * @param TExecutionConfig the configuration type produced by the
+ * integration's optional `loadExecutionConfig` function
  */
-export interface IntegrationStepExecutionContext<TConfig extends IntegrationInstanceConfig = IntegrationInstanceConfig> extends IntegrationExecutionContext<TConfig>, StepExecutionContext {
+export interface IntegrationStepExecutionContext<TConfig extends IntegrationInstanceConfig = IntegrationInstanceConfig, TExecutionConfig extends IntegrationExecutionConfig = IntegrationExecutionConfig> extends IntegrationExecutionContext<TConfig, TExecutionConfig>, StepExecutionContext {
 }

package/dist/tsconfig.dist.tsbuildinfo

@@ -572,8 +572,8 @@
         "affectsGlobalScope": false
       },
       "../src/types/context.ts": {
-        "version": "bc21346b9de5efe7e8cd464300d683eb9217e1449a76bfbccffd97af56f2579b",
-        "signature": "8e3ac2a6307f130147aad76654298fd0fa55f67c253c5f1d0ff1c491269cee09",
+        "version": "11560d1b1144f46e3ec5937ae34c5ae75a4559225350443bd0060b42abac6a25",
+        "signature": "e773b60c789844210fb71a9d1128a32e00ebb439a1754f83f6d03a528c506b56",
         "affectsGlobalScope": false
       },
       "../src/types/persistedObject.ts": {
@@ -602,8 +602,8 @@
         "affectsGlobalScope": false
       },
       "../src/types/config.ts": {
-        "version": "83cde32a7aefa7568de6d77fba63ee5b1d8b388c03b62eea9aa3053dea3c510e",
-        "signature": "5c3127adee065bf7b37a65f629b88f53231dcd0d74af03877cf2f9e26cc74f3c",
+        "version": "e24c96c68acb773f7f7dcffcf9ace5b7feb15d2bed00772df404e3fde5f649eb",
+        "signature": "56f9040d9d5b5c31f5ee297052d578da43f0df72844f0c45a8db29173832e4d4",
         "affectsGlobalScope": false
       },
       "../src/types/partialDatasets.ts": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-core",
-  "version": "8.1.3",
+  "version": "8.2.0",
   "description": "The SDK for developing JupiterOne integrations",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -30,5 +30,5 @@
   "devDependencies": {
     "@types/lodash": "^4.14.168"
   },
-  "gitHead": "3f6a4c09f1091768419d230a9d23dbec04df2fdb"
+  "gitHead": "7531882f83d9ac9107f101c64e1b1e042c3bcd72"
 }