@jupiterone/integration-sdk-cli 12.7.1 → 12.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-cli",
-  "version": "12.7.1",
+  "version": "12.8.1",
   "description": "The SDK for developing JupiterOne integrations",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -17,16 +17,17 @@
     "access": "public"
   },
   "scripts": {
+    "test": "jest",
     "prebuild:dist": "rm -rf dist && mkdir dist",
-    "build:dist": "tsc -p tsconfig.dist.json --declaration && yarn copy-files",
-    "prepack": "yarn build:dist",
+    "build:dist": "tsc -p tsconfig.dist.json --declaration && npm run copy-files",
+    "prepack": "npm run build:dist",
     "copy-files": "cp -r src/generator/template dist/src/generator/template && cp -r src/generator/stepTemplate dist/src/generator/stepTemplate",
     "plop": "plop --plopfile dist/src/generator/newIntegration.js"
   },
   "dependencies": {
-    "@jupiterone/data-model": "^0.55.0",
-    "@jupiterone/integration-sdk-core": "^12.7.1",
-    "@jupiterone/integration-sdk-runtime": "^12.7.1",
+    "@jupiterone/data-model": "^0.61.3",
+    "@jupiterone/integration-sdk-core": "^12.8.1",
+    "@jupiterone/integration-sdk-runtime": "^12.8.1",
     "chalk": "^4",
     "commander": "^9.4.0",
     "fs-extra": "^10.1.0",
@@ -43,7 +44,7 @@
     "url-exists": "^1.0.3"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-private-test-utils": "^12.7.1",
+    "@jupiterone/integration-sdk-private-test-utils": "^12.8.1",
     "@pollyjs/adapter-node-http": "^6.0.5",
     "@pollyjs/core": "^6.0.5",
     "@pollyjs/persister-fs": "^6.0.5",
@@ -56,5 +57,5 @@
     "neo-forgery": "^2.0.0",
     "vis": "^4.21.0-EOL"
   },
-  "gitHead": "e4d3dbe3b95d47e043d10f508355195a99ea4da3"
+  "gitHead": "01bd7c6824a549f9931ac045468d5642fb2cc677"
 }

package/src/commands/generate-integration-graph-schema.test.ts

@@ -128,6 +128,62 @@ describe('#generateIntegrationGraphSchema', () => {
     });
   });
 
+  test('should dedup entity metadata with schema', () => {
+    const steps: IntegrationStep<IntegrationInstanceConfig>[] = [
+      getMockIntegrationStep({
+        entities: [
+          {
+            _class: 'User',
+            _type: 'my_user',
+            resourceName: 'The user',
+            schema: {
+              $id: 'id',
+            },
+          },
+          {
+            _class: 'User',
+            _type: 'my_user',
+            resourceName: 'The user',
+            schema: {
+              $id: 'id',
+            },
+          },
+        ],
+        relationships: [],
+        mappedRelationships: [],
+      }),
+      getMockIntegrationStep({
+        entities: [
+          {
+            _class: 'User',
+            _type: 'my_user',
+            resourceName: 'The user',
+            schema: {
+              $id: 'id',
+            },
+          },
+        ],
+        relationships: [],
+        mappedRelationships: [],
+      }),
+    ];
+
+    expect(generateIntegrationGraphSchema(steps)).toEqual({
+      entities: [
+        {
+          _class: 'User',
+          _type: 'my_user',
+          resourceName: 'The user',
+          schema: {
+            $id: 'id',
+          },
+        },
+      ],
+      relationships: [],
+      mappedRelationships: [],
+    });
+  });
+
   test('should dedup relationship metadata', () => {
     const steps: IntegrationStep<IntegrationInstanceConfig>[] = [
       getMockIntegrationStep({

package/src/commands/generate-integration-graph-schema.ts

@@ -1,4 +1,5 @@
 import {
+  GraphObjectSchema,
   IntegrationInstanceConfig,
   IntegrationStepExecutionContext,
   Step,
@@ -63,6 +64,7 @@ type IntegrationGraphSchemaEntityMetadata = {
   resourceName: string;
   _class: string | string[];
   _type: string;
+  schema?: GraphObjectSchema;
 };
 
 type IntegrationGraphSchemaRelationshipMetadata = {
@@ -210,6 +212,7 @@ function toIntegrationGraphSchemaEntityMetadata(
     resourceName: stepEntityMetadata.resourceName,
     _class: stepEntityMetadata._class,
     _type: stepEntityMetadata._type,
+    schema: stepEntityMetadata.schema,
   };
 }
 

package/src/commands/generate.ts

@@ -5,7 +5,7 @@ const dynamicImport = new Function('specifier', 'return import(specifier)');
 export function generate() {
   return createCommand('generate')
     .description('generate integrations in whole and in part')
-    .action(async (cmdOpts) => {
+    .action(async () => {
       const Plop = await dynamicImport('plop');
       const configPath = path.resolve(
         path.join(__dirname, '../generator/newIntegration.js'),

package/src/generator/actions.ts

@@ -22,6 +22,7 @@ async function spawnCommand(config, command, args): Promise<string> {
   });
 }
 
+// Yarn commands
 async function yarnInstall(_answers, config, _plop) {
   return spawnCommand(config, 'yarn', ['install']);
 }
@@ -34,4 +35,18 @@ async function yarnLint(_answers, config, _plop) {
   return spawnCommand(config, 'yarn', ['lint']);
 }
 
-export { yarnInstall, yarnFormat, yarnLint };
+// NPM commands
+
+async function npmInstall(_answers, config, _plop) {
+  return spawnCommand(config, 'npm', ['install']);
+}
+
+async function npmFormat(_answers, config, _plop): Promise<string> {
+  return spawnCommand(config, 'npm', [`run format`]);
+}
+
+async function npmLint(_answers, config, _plop) {
+  return spawnCommand(config, 'npm', ['run lint']);
+}
+
+export { yarnInstall, yarnFormat, yarnLint, npmInstall, npmFormat, npmLint };

package/src/generator/newIntegration.ts

@@ -4,7 +4,14 @@ import { configFieldsFlow } from './configFieldsFlow';
 import { stepsFlow } from './stepsFlow';
 import { generateRelationshipName } from './helpers';
 import { generateRelationshipType } from '@jupiterone/integration-sdk-core';
-import { yarnFormat, yarnInstall, yarnLint } from './actions';
+import {
+  npmFormat,
+  npmInstall,
+  npmLint,
+  yarnFormat,
+  yarnInstall,
+  yarnLint,
+} from './actions';
 import { kebabCase } from 'lodash';
 import checkboxPlus from 'inquirer-checkbox-plus-prompt';
 import path from 'path';
@@ -19,9 +26,15 @@ function newIntegration(plop: NodePlopAPI) {
   });
 
   plop.setHelper('generateRelationshipName', generateRelationshipName);
+  // NPM
+  plop.setActionType('npmFormat', npmFormat);
+  plop.setActionType('npmInstall', npmInstall);
+  plop.setActionType('npmLint', npmLint);
+  // Yarn
   plop.setActionType('yarnFormat', yarnFormat);
   plop.setActionType('yarnInstall', yarnInstall);
   plop.setActionType('yarnLint', yarnLint);
+
   plop.setPrompt('checkbox-plus', checkboxPlus);
 
   plop.setGenerator('new:integration', {
@@ -66,6 +79,14 @@ function newIntegration(plop: NodePlopAPI) {
         },
       });
 
+      const { packageManager } = await inquirer.prompt({
+        type: 'list',
+        name: 'packageManager',
+        message: 'Which package manager do you want to use?',
+        choices: ['npm', 'yarn'],
+        default: 'npm',
+      });
+
       const configFields = await configFieldsFlow(inquirer);
       const entities = await entitiesFlow(inquirer, vendorName);
       let relationships: Relationship[] = [];
@@ -83,6 +104,7 @@ function newIntegration(plop: NodePlopAPI) {
         entities,
         relationships,
         steps,
+        packageManager,
       };
     },
     actions: function (data) {
@@ -90,6 +112,8 @@ function newIntegration(plop: NodePlopAPI) {
         return [];
       }
 
+      const { packageManager } = data;
+
       // @jupiterone/graph-foo -> graph-foo
       // graph-foo -> graph-foo
       const directoryName = path.join(
@@ -122,19 +146,19 @@ function newIntegration(plop: NodePlopAPI) {
       }
 
       actions.push({
-        type: 'yarnInstall',
+        type: packageManager === 'yarn' ? 'yarnInstall' : 'npmInstall',
         path: directoryName,
         verbose: true,
       });
 
       actions.push({
-        type: 'yarnFormat',
+        type: packageManager === 'yarn' ? 'yarnFormat' : 'npmFormat',
         path: directoryName,
         verbose: true,
       });
 
       actions.push({
-        type: 'yarnLint',
+        type: packageManager === 'yarn' ? 'yarnLint' : 'npmLint',
         path: directoryName,
         verbose: true,
       });

package/src/generator/template/.github/workflows/build.yml.hbs

@@ -12,6 +12,7 @@ jobs:
       - name: Check out code repository source code
         uses: actions/checkout@v3
 
+      {{#if_eq packageManager 'yarn'}}
       - id: setup-node
         name: Setup Node
         uses: actions/setup-node@v3
@@ -27,3 +28,20 @@ jobs:
 
       - name: Run build
         run: yarn build
+      {{else}}
+      - id: setup-node
+        name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: npm
+
+      - name: Install dependencies
+        run: npm run --frozen-lockfile
+
+      - name: Run tests
+        run: npm run test:ci
+
+      - name: Run build
+        run: npm run build
+      {{/if_eq}}

package/src/generator/template/.github/workflows/questions.yml.hbs

@@ -24,9 +24,13 @@ jobs:
         with:
           node-version: 18.x
 
+      {{#if_eq packageManager 'yarn'}}
       - name: Install dependencies for `main` branch
         run: yarn install --cwd source --frozen-lockfile
-
+      {{else}}
+      - name: Install dependencies for `main` branch
+        run: npm install --cwd source --frozen-lockfile
+      {{/if_eq}}
       - name: Validate questions on target branch
         env:
           MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID:
@@ -34,7 +38,14 @@ jobs:
           MANAGED_QUESTIONS_JUPITERONE_API_KEY:
             $\{{ secrets.MANAGED_QUESTIONS_JUPITERONE_API_KEY }}
         run:
+          {{#if_eq packageManager 'yarn'}}
           yarn --cwd source j1-integration validate-question-file -a
           --frozen-lockfile $MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID -k
           $MANAGED_QUESTIONS_JUPITERONE_API_KEY -p
           ../target/jupiterone/questions/questions.yaml
+          {{else}}
+          npm run --cwd source j1-integration validate-question-file -a
+          --frozen-lockfile $MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID -k
+          $MANAGED_QUESTIONS_JUPITERONE_API_KEY -p
+          ../target/jupiterone/questions/questions.yaml
+          {{/if_eq}}

package/src/generator/template/Dockerfile.hbs

@@ -1,3 +1,4 @@
+{{#if_eq packageManager 'yarn'}}
 FROM node:18-alpine
 
 ENV JUPITERONE_INTEGRATION_DIR=/opt/jupiterone/integration
@@ -9,3 +10,18 @@ WORKDIR ${JUPITERONE_INTEGRATION_DIR}
 RUN yarn install
 
 ENTRYPOINT /usr/local/bin/yarn --silent j1-integration run -i ${INTEGRATION_INSTANCE_ID} --disable-schema-validation --api-base-url ${JUPITERONE_API_BASE_URL:-https://api.us.jupiterone.io} --account ${JUPITERONE_ACCOUNT} --api-key ${JUPITERONE_API_KEY}
+
+{{else}}
+
+FROM node:18-alpine
+
+ENV JUPITERONE_INTEGRATION_DIR=/opt/jupiterone/integration
+
+COPY package.json package-lock.json tsconfig.json LICENSE ${JUPITERONE_INTEGRATION_DIR}/
+COPY src/ ${JUPITERONE_INTEGRATION_DIR}/src
+
+WORKDIR ${JUPITERONE_INTEGRATION_DIR}
+RUN npm install
+
+ENTRYPOINT /usr/local/bin/npm --silent run j1-integration -- -i ${INTEGRATION_INSTANCE_ID} --disable-schema-validation --api-base-url ${JUPITERONE_API_BASE_URL:-https://api.us.jupiterone.io} --account ${JUPITERONE_ACCOUNT} --api-key ${JUPITERONE_API_KEY}
+{{/if_eq}}

package/src/generator/template/README.md.hbs

@@ -34,9 +34,15 @@ with JupiterOne in the [integration documentation](docs/jupiterone.md).
 
 #### Running directly
 
+{{#if_eq packageManager 'yarn'}}
 1. `yarn start` to collect data
 2. `yarn graph` to show a visualization of the collected data
 3. `yarn j1-integration -h` for additional commands
+{{else}}
+1. `npm run start` to collect data
+2. `npm run graph` to show a visualization of the collected data
+3. `npm run j1-integration -h` for additional commands
+{{/if_eq}}
 
 #### Running with Docker
 
@@ -65,11 +71,19 @@ developing this integration.
 
 ## Testing the integration
 
+{{#if_eq packageManager 'yarn'}}
 Ideally, all major calls to the API and converter functions would be tested. You
-can run the tests with `yarn test`, and you can run the tests as they execute in
-the CI/CD environment with `yarn test:ci` (adds linting and type-checking to
-`yarn test`). If you have a valid runtime configuration, you can run the tests
-with your credentials using `yarn test:env`.
+can run the tests with `npm run test`, and you can run the tests as they execute in
+the CI/CD environment with `npm run test:ci` (adds linting and type-checking to
+`npm run test`). If you have a valid runtime configuration, you can run the tests
+with your credentials using `npm run test:env`.
+{{else}}
+Ideally, all major calls to the API and converter functions would be tested. You
+can run the tests with `npm run test`, and you can run the tests as they execute in
+the CI/CD environment with `npm run test:ci` (adds linting and type-checking to
+`npm run test`). If you have a valid runtime configuration, you can run the tests
+with your credentials using `npm run test:env`.
+{{/if_eq}}
 
 For more details on setting up tests, and specifically on using recordings to
 simulate API responses, see `test/README.md`.
@@ -111,4 +125,4 @@ different naming conventions).
 
 We are not currently using the functionality for auto to update the CHANGELOG.
 As such, please remember to update CHANGELOG.md with the appropriate version,
-date, and changes.
+date, and changes.

package/src/generator/template/package.json.hbs

@@ -28,11 +28,17 @@
     "format:check": "prettier --check \"**/*.{ts,js,json,css,md,yml}\"",
     "type-check": "tsc",
     "test": "jest",
+    {{#if_eq packageManager 'yarn'}}
     "test:env": "LOAD_ENV=1 yarn test",
     "test:ci": "yarn format:check && yarn lint && yarn type-check && yarn test",
+    "prepush": "yarn format:check && yarn lint && yarn type-check && jest --changedSince main",
+    {{else}}
+    "test:env": "LOAD_ENV=1 npm run test",
+    "test:ci": "npm run format:check && npm run lint && npm run type-check && npm run test",
+    "prepush": "npm run format:check && npm run lint && npm run type-check && jest --changedSince main",
+    {{/if_eq}}
     "build": "tsc -p tsconfig.dist.json --declaration && cp README.md dist/README.md && cp -r jupiterone/ dist/jupiterone/",
     "build:docker": "tsc --declaration false --emitDeclarationOnly false -p tsconfig.dist.json",
-    "prepush": "yarn format:check && yarn lint && yarn type-check && jest --changedSince main",
     "postversion": "cp package.json ./dist/package.json"
   },
   "dependencies": {
@@ -46,4 +52,4 @@
     "@jupiterone/integration-sdk-dev-tools": "^12.0.0",
     "@jupiterone/integration-sdk-testing": "^12.0.0"
   }
-}
+}

package/src/neo4j/README.md

@@ -30,7 +30,8 @@ of pushing to an external Neo4j database.
 
 ## Usage
 
-Data is still collected in the same way as before with a call to `yarn start`.
+Data is still collected in the same way as before with a call to
+`npm run start`.
 
 Once data has been collected, you can run `j1-integration neo4j push`. This will
 push data to the Neo4j server listed in the NEO4J_URI .env parameter. If running