@jupiterone/integration-sdk-core - npm Package Compare versions

Comparing version 5.2.1 to 5.3.0

dist/src/types/step.d.ts

@@ -45,2 +45,10 @@ import { RelationshipClass } from '@jupiterone/data-model';
 export declare type IntegrationStep<TConfig extends IntegrationInstanceConfig = IntegrationInstanceConfig> = StepMetadata & Step<IntegrationStepExecutionContext<TConfig>>;
+export interface GraphObjectIndexMetadata {
+    /**
+     * Whether the index of the graph object store is enabled or not. For example,
+     * in the case leveraging the `FileSystemGraphObjectStore`, this value
+     * determines whether we need to write the specific graph object to disk.
+     */
+    enabled: boolean;
+}
 export interface StepGraphObjectMetadata {
@@ -62,2 +70,6 @@ _type: string;
     partial?: boolean;
+    /**
+     * Contains metadadata that can be leveraged inside of the graph object store
+     */
+    indexMetadata?: GraphObjectIndexMetadata;
 }
@@ -64,0 +76,0 @@ export interface StepEntityMetadata extends StepGraphObjectMetadata {

dist/src/types/storage.d.ts

 import { Entity } from './entity';
 import { GraphObjectFilter, GraphObjectIteratee, GraphObjectLookupKey } from './jobState';
 import { Relationship } from './relationship';
+import { GraphObjectIndexMetadata } from '../types/step';
+export interface GetIndexMetadataForGraphObjectTypeParams {
+    stepId: string;
+    _type: string;
+    graphObjectCollectionType: 'entities' | 'relationships';
+}
 /**
@@ -15,2 +21,3 @@ * Persists entities and relationships to a durable medium for the duration of
     flush(onEntitiesFlushed?: (entities: Entity[]) => Promise<void>, onRelationshipsFlushed?: (relationships: Relationship[]) => Promise<void>): Promise<void>;
+    getIndexMetadataForGraphObjectType?: (params: GetIndexMetadataForGraphObjectTypeParams) => GraphObjectIndexMetadata | undefined;
 }

package.json

 {
   "name": "@jupiterone/integration-sdk-core",
-  "version": "5.2.1",
+  "version": "5.3.0",
   "description": "The SDK for developing JupiterOne integrations",
@@ -33,3 +33,3 @@ "main": "dist/src/index.js",
   },
-  "gitHead": "d51a70ff77217b9186ce0e7584ab38c922f34c3a"
+  "gitHead": "8061b53472a147e4ca0550483a7ba20bddc5821e"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

365283

increased by0.24%

Lines of code

2332

increased by0.82%

No dependency changes