@jupiterone/integration-sdk-cli 10.7.1 → 11.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-cli",
-  "version": "10.7.1",
+  "version": "11.0.2",
   "description": "The SDK for developing JupiterOne integrations",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -25,8 +25,8 @@
   },
   "dependencies": {
     "@jupiterone/data-model": "^0.54.0",
-    "@jupiterone/integration-sdk-core": "^10.7.1",
-    "@jupiterone/integration-sdk-runtime": "^10.7.1",
+    "@jupiterone/integration-sdk-core": "^11.0.2",
+    "@jupiterone/integration-sdk-runtime": "^11.0.2",
     "chalk": "^4",
     "commander": "^9.4.0",
     "fs-extra": "^10.1.0",
@@ -44,7 +44,7 @@
     "vis": "^4.21.0-EOL"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-private-test-utils": "^10.7.1",
+    "@jupiterone/integration-sdk-private-test-utils": "^11.0.2",
     "@pollyjs/adapter-node-http": "^6.0.5",
     "@pollyjs/core": "^6.0.5",
     "@pollyjs/persister-fs": "^6.0.5",
@@ -56,5 +56,5 @@
     "memfs": "^3.2.0",
     "neo-forgery": "^2.0.0"
   },
-  "gitHead": "3866d5d186616eaedbe2d4dc9ef5401b3df276e5"
+  "gitHead": "73d005410944da3889d5b41812deb3a48ae5ba89"
 }

package/src/__tests__/options.test.ts

@@ -9,15 +9,12 @@ import {
   validateSyncOptions,
 } from '../commands/options';
 import {
-  DEFAULT_UPLOAD_BATCH_SIZE,
   JUPITERONE_DEV_API_BASE_URL,
   JUPITERONE_PROD_API_BASE_URL,
 } from '@jupiterone/integration-sdk-runtime';
 
 const syncOptions = (values?: Partial<SyncOptions>): SyncOptions => ({
   source: 'integration-managed',
-  uploadBatchSize: DEFAULT_UPLOAD_BATCH_SIZE,
-  uploadRelationshipBatchSize: DEFAULT_UPLOAD_BATCH_SIZE,
   skipFinalize: false,
   ...values,
 });

package/src/commands/options.ts

@@ -1,5 +1,4 @@
 import {
-  DEFAULT_UPLOAD_BATCH_SIZE,
   getAccountFromEnvironment,
   getApiKeyFromEnvironment,
   JUPITERONE_DEV_API_BASE_URL,
@@ -39,8 +38,6 @@ export interface SyncOptions {
   source: 'integration-managed' | 'integration-external' | 'api';
   scope?: string | undefined;
   integrationInstanceId?: string | undefined;
-  uploadBatchSize: number;
-  uploadRelationshipBatchSize: number;
   skipFinalize: boolean;
 }
 
@@ -69,18 +66,6 @@ export function addSyncOptionsToCommand(command: Command): Command {
       'integration-managed',
     )
     .option('--scope <anystring>', 'specify synchronization job scope value')
-    .option(
-      '-u, --upload-batch-size <number>',
-      'specify number of entities and relationships per upload batch',
-      (value, _previous: Number) => Number(value),
-      DEFAULT_UPLOAD_BATCH_SIZE,
-    )
-    .option(
-      '-ur, --upload-relationship-batch-size <number>',
-      'specify number of relationships per upload batch, overrides --upload-batch-size',
-      (value, _previous: Number) => Number(value),
-      DEFAULT_UPLOAD_BATCH_SIZE,
-    )
     .option(
       '--skip-finalize',
       'skip synchronization finalization to leave job open for additional uploads',
@@ -127,8 +112,6 @@ export function getSyncOptions(options: OptionValues): SyncOptions {
     source: options.source,
     scope: options.scope,
     integrationInstanceId: options.integrationInstanceId,
-    uploadBatchSize: options.uploadBatchSize,
-    uploadRelationshipBatchSize: options.uploadRelationshipBatchSize,
     skipFinalize: options.skipFinalize,
   };
 }

package/src/commands/run.ts

@@ -109,9 +109,6 @@ export function run(): Command {
                 stepId,
                 synchronizationJobContext: synchronizationContext,
                 uploadConcurrency: DEFAULT_UPLOAD_CONCURRENCY,
-                uploadBatchSize: options.uploadBatchSize,
-                uploadRelationshipsBatchSize:
-                  options.uploadRelationshipBatchSize,
               });
             },
           },

package/src/generator/template/.prettierignore.hbs

@@ -2,4 +2,5 @@ dist
 coverage/
 .j1-integration
 .j1-integration-cache
-.gitleaks.yml
+.gitleaks.yml
+CHANGELOG.md

package/src/utils/getSortedJupiterOneTypes.test.ts

@@ -6,8 +6,11 @@ import {
   StepMappedRelationshipMetadata,
   StepRelationshipMetadata,
 } from '@jupiterone/integration-sdk-core';
-import { collectGraphObjectMetadataFromSteps } from './getSortedJupiterOneTypes';
 import { randomUUID as uuid } from 'crypto';
+import {
+  alphabetizeMetadataProperties,
+  collectGraphObjectMetadataFromSteps,
+} from './getSortedJupiterOneTypes';
 
 function createIntegrationStep({
   entities = [],
@@ -214,3 +217,63 @@ describe('collectGraphObjectMetadataFromSteps', () => {
     });
   });
 });
+
+describe('alphabetizeMetadataProperties', () => {
+  it('should correctly sort an array of StepRelationshipMetadata', () => {
+    const { relationships } = alphabetizeMetadataProperties(
+      collectGraphObjectMetadataFromSteps([
+        createIntegrationStep({
+          relationships: [
+            {
+              _type: 'aws_account_has_service',
+              sourceType: 'aws_account',
+              _class: RelationshipClass.HAS,
+              targetType: 'aws_waf',
+            },
+          ],
+        }),
+        createIntegrationStep({
+          relationships: [
+            {
+              _type: 'aws_account_owns_service',
+              sourceType: 'aws_account',
+              _class: RelationshipClass.OWNS,
+              targetType: 'aws_apigateway',
+            },
+          ],
+        }),
+        createIntegrationStep({
+          relationships: [
+            {
+              _type: 'aws_account_has_service',
+              sourceType: 'aws_account',
+              _class: RelationshipClass.HAS,
+              targetType: 'aws_apigateway',
+            },
+          ],
+        }),
+      ]),
+    );
+
+    expect(relationships).toEqual([
+      {
+        _type: 'aws_account_has_service',
+        sourceType: 'aws_account',
+        _class: 'HAS',
+        targetType: 'aws_apigateway',
+      },
+      {
+        _type: 'aws_account_owns_service',
+        sourceType: 'aws_account',
+        _class: 'OWNS',
+        targetType: 'aws_apigateway',
+      },
+      {
+        _type: 'aws_account_has_service',
+        sourceType: 'aws_account',
+        _class: 'HAS',
+        targetType: 'aws_waf',
+      },
+    ]);
+  });
+});

package/src/utils/getSortedJupiterOneTypes.ts

@@ -1,14 +1,14 @@
-import { loadConfig } from '../config';
-import * as path from 'path';
-import { buildStepDependencyGraph } from '@jupiterone/integration-sdk-runtime';
 import {
   IntegrationStepExecutionContext,
   Step,
-  StepGraphObjectMetadataProperties,
   StepEntityMetadata,
-  StepRelationshipMetadata,
+  StepGraphObjectMetadataProperties,
   StepMappedRelationshipMetadata,
+  StepRelationshipMetadata,
 } from '@jupiterone/integration-sdk-core';
+import { buildStepDependencyGraph } from '@jupiterone/integration-sdk-runtime';
+import * as path from 'path';
+import { loadConfig } from '../config';
 
 export interface TypesCommandArgs {
   projectPath: string;
@@ -57,15 +57,26 @@ function alphabetizeEntityMetadataPropertyByTypeCompareFn(
 }
 
 function alphabetizeRelationshipMetadataPropertyByTypeCompareFn(
-  a: StepRelationshipMetadata,
-  b: StepRelationshipMetadata,
+  a: StepRelationshipMetadata | StepMappedRelationshipMetadata,
+  b: StepRelationshipMetadata | StepMappedRelationshipMetadata,
 ): number {
-  if (a._type > b._type) return 1;
-  if (a._type < b._type) return -1;
+  if (a.sourceType > b.sourceType) return 1;
+  if (a.sourceType < b.sourceType) return -1;
+
+  if (a.targetType > b.targetType) return 1;
+  if (a.targetType < b.targetType) return -1;
+
+  if (a._class > b._class) return 1;
+  if (a._class < b._class) return -1;
+
+  if ('direction' in a && 'direction' in b) {
+    if (a.direction > b.direction) return 1;
+    if (a.direction < b.direction) return -1;
+  }
   return 0;
 }
 
-function alphabetizeMetadataProperties(
+export function alphabetizeMetadataProperties(
   metadata: StepGraphObjectMetadataProperties,
 ): StepGraphObjectMetadataProperties {
   return {

package/src/visualization/__tests__/createMappedRelationshipNodesAndEdges.test.ts

@@ -17,7 +17,7 @@ describe('#createMappedRelationshipNodesAndEdges', () => {
       _mapping: {
         relationshipDirection: RelationshipDirection.FORWARD,
         sourceEntityKey: 'key-1',
-        targetFilterKeys: ['_key'],
+        targetFilterKeys: [['_key']],
         targetEntity: {
           _key: 'key-2',
         },
@@ -140,7 +140,7 @@ describe('#createMappedRelationshipNodesAndEdges', () => {
         _mapping: {
           relationshipDirection: RelationshipDirection.FORWARD,
           sourceEntityKey: 'key-1',
-          targetFilterKeys: ['_key'],
+          targetFilterKeys: [['_key']],
           targetEntity: {
             _key: '789',
           },
@@ -154,7 +154,7 @@ describe('#createMappedRelationshipNodesAndEdges', () => {
         _mapping: {
           relationshipDirection: RelationshipDirection.FORWARD,
           sourceEntityKey: 'key-2',
-          targetFilterKeys: ['_key'],
+          targetFilterKeys: [['_key']],
           targetEntity: {
             _key: '789',
           },
@@ -218,7 +218,7 @@ describe('#createMappedRelationshipNodesAndEdges', () => {
         _mapping: {
           relationshipDirection: RelationshipDirection.FORWARD,
           sourceEntityKey: 'key-1',
-          targetFilterKeys: ['_class'],
+          targetFilterKeys: [['_class']],
           targetEntity: {
             _class: '789',
           },
@@ -232,7 +232,7 @@ describe('#createMappedRelationshipNodesAndEdges', () => {
         _mapping: {
           relationshipDirection: RelationshipDirection.FORWARD,
           sourceEntityKey: 'key-2',
-          targetFilterKeys: ['_class'],
+          targetFilterKeys: [['_class']],
           targetEntity: {
             _class: '789',
           },
@@ -299,7 +299,7 @@ describe('#createMappedRelationshipNodesAndEdges', () => {
         _mapping: {
           relationshipDirection: RelationshipDirection.FORWARD,
           sourceEntityKey: 'key-1',
-          targetFilterKeys: ['_type'],
+          targetFilterKeys: [['_type']],
           targetEntity: {
             _type: '789',
           },
@@ -477,13 +477,12 @@ describe('#CreatePlaceholderEntity', () => {
           id: 'target-id',
           otherKey: 'otherValue',
         },
-        targetFilterKeys: ['_key', 'id', ['_key', '_type']],
+        targetFilterKeys: [['_key', '_type']],
       },
     };
 
     expect(createPlaceholderEntity(mappedRelationship._mapping)).toEqual({
       _key: 'target-key',
-      id: 'target-id',
       _type: 'target-type',
     });
   });