Merge pull request #957 from JupiterOne/improve-integration-generator

Geovanni Pacheco · web-flow · commit 472ca0141d5f · 2023-09-15T17:44:02.000-03:00
Improve integration generator
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,10 @@ and this project adheres to
 
 ## Unreleased
 
+## 10.5.2 - 2023-09-14
+
+- Improvements to integration graph generator
+
 ## 10.5.0 - 2023-09-12
 
 - Add `error_unexpected_error` to IntegrationErrorEventName
diff --git a/lerna.json b/lerna.json
@@ -4,5 +4,5 @@
     "packages/integration-sdk-*",
     "packages/cli"
   ],
-  "version": "10.5.1"
+  "version": "10.5.2"
 }
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/cli",
-  "version": "10.5.1",
+  "version": "10.5.2",
   "description": "The JupiterOne cli",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -24,8 +24,8 @@
     "test": "jest"
   },
   "dependencies": {
-    "@jupiterone/integration-sdk-core": "^10.5.1",
-    "@jupiterone/integration-sdk-runtime": "^10.5.1",
+    "@jupiterone/integration-sdk-core": "^10.5.2",
+    "@jupiterone/integration-sdk-runtime": "^10.5.2",
     "@lifeomic/attempt": "^3.0.3",
     "commander": "^5.0.0",
     "globby": "^11.0.1",
diff --git a/packages/integration-sdk-benchmark/package.json b/packages/integration-sdk-benchmark/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-benchmark",
-  "version": "10.5.1",
+  "version": "10.5.2",
   "private": true,
   "description": "SDK benchmarking scripts",
   "main": "./src/index.js",
@@ -15,8 +15,8 @@
     "benchmark": "for file in ./src/benchmarks/*; do yarn prebenchmark && node $file; done"
   },
   "dependencies": {
-    "@jupiterone/integration-sdk-core": "^10.5.1",
-    "@jupiterone/integration-sdk-runtime": "^10.5.1",
+    "@jupiterone/integration-sdk-core": "^10.5.2",
+    "@jupiterone/integration-sdk-runtime": "^10.5.2",
     "benchmark": "^2.1.4"
   }
 }
diff --git a/packages/integration-sdk-cli/README.md b/packages/integration-sdk-cli/README.md
@@ -1,11 +1,20 @@
 # @jupiterone/integration-sdk-cli
 
-_NOTE:_ This project is currently under development and the API interface is not
-stable. Use at your own risk.
-
 This package exposes a CLI tool that assists with executing integrations
 locally.
 
+## Integration graph generator
+
+Create a git repository for your integration graph with
+`graph-(integrationName)` name and execute the following command inside it:
+
+```
+npx @jupiterone/integration-sdk-cli generate
+```
+
+You will be prompted with some questions and the graph code will be generated so
+you can start development.
+
 ## Installation
 
 ```
diff --git a/packages/integration-sdk-cli/package.json b/packages/integration-sdk-cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-cli",
-  "version": "10.5.1",
+  "version": "10.5.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.5.1",
-    "@jupiterone/integration-sdk-runtime": "^10.5.1",
+    "@jupiterone/integration-sdk-core": "^10.5.2",
+    "@jupiterone/integration-sdk-runtime": "^10.5.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.5.1",
+    "@jupiterone/integration-sdk-private-test-utils": "^10.5.2",
     "@pollyjs/adapter-node-http": "^6.0.5",
     "@pollyjs/core": "^6.0.5",
     "@pollyjs/persister-fs": "^6.0.5",
diff --git a/packages/integration-sdk-cli/src/generator/template/.github/workflows/build.yml.hbs b/packages/integration-sdk-cli/src/generator/template/.github/workflows/build.yml.hbs
@@ -40,7 +40,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-          token: ${{ secrets.AUTO_GITHUB_PAT_TOKEN }}
+          token: $\{{ secrets.AUTO_GITHUB_PAT_TOKEN }}
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
@@ -49,5 +49,5 @@ jobs:
       - name: Build and Release
         uses: jupiterone/action-npm-build-release@v1
         with:
-          npm_auth_token: ${{ secrets.NPM_AUTH_TOKEN }}
-          gh_token: ${{ secrets.AUTO_GITHUB_PAT_TOKEN }}
+          npm_auth_token: $\{{ secrets.NPM_AUTH_TOKEN }}
+          gh_token: $\{{ secrets.AUTO_GITHUB_PAT_TOKEN }}
diff --git a/packages/integration-sdk-cli/src/generator/template/.github/workflows/codeql-analysis.yml.hbs b/packages/integration-sdk-cli/src/generator/template/.github/workflows/codeql-analysis.yml.hbs
@@ -42,7 +42,7 @@ jobs:
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2
         with:
-          languages: ${{ matrix.language }}
+          languages: $\{{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
           # By default, queries listed here will override any specified in a config file.
           # Prefix the list here with "+" to use these queries and those in the config file.
diff --git a/packages/integration-sdk-cli/src/generator/template/.github/workflows/integration-deployment.yml.hbs b/packages/integration-sdk-cli/src/generator/template/.github/workflows/integration-deployment.yml.hbs
@@ -29,8 +29,8 @@ jobs:
         uses: JupiterOne/integration-github-actions/create-integration-deployment@v1
         with:
           integrationName:
-            ${{ steps.get-integration-name.outputs.integrationName }}
-          releaseNotes: ${{ github.event.release.body }}
-          version: ${{ steps.get-version-number.outputs.versionNumber }}
-          githubToken: ${{ secrets.AUTO_GITHUB_PAT_TOKEN }}
-          npmAuthToken: ${{ secrets.NPM_AUTH_TOKEN }}
+            $\{{ steps.get-integration-name.outputs.integrationName }}
+          releaseNotes: $\{{ github.event.release.body }}
+          version: $\{{ steps.get-version-number.outputs.versionNumber }}
+          githubToken: $\{{ secrets.AUTO_GITHUB_PAT_TOKEN }}
+          npmAuthToken: $\{{ secrets.NPM_AUTH_TOKEN }}
diff --git a/packages/integration-sdk-cli/src/generator/template/.github/workflows/peril.yml.hbs b/packages/integration-sdk-cli/src/generator/template/.github/workflows/peril.yml.hbs
@@ -41,7 +41,7 @@ jobs:
       - name: Configure aws credentials
         uses: aws-actions/configure-aws-credentials@v1
         with:
-          role-to-assume: ${{ steps.get-vars.outputs.aws-oidc-role }}
+          role-to-assume: $\{{ steps.get-vars.outputs.aws-oidc-role }}
           role-session-name: pr-role-session
           aws-region: us-east-1
 
@@ -53,8 +53,8 @@ jobs:
         uses: docker/login-action@v2
         with:
           registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.PACKAGE_TOKEN }}
+          username: $\{{ github.actor }}
+          password: $\{{ secrets.PACKAGE_TOKEN }}
 
       - name: Pull security-scan
         run: |
@@ -66,9 +66,9 @@ jobs:
           --user root \
           -v /var/run/docker.sock:/var/run/docker.sock \
           -v `pwd`:`pwd` \
-          -e AWS_ACCESS_KEY_ID=${{ env.AWS_ACCESS_KEY_ID }} \
-          -e AWS_SECRET_ACCESS_KEY=${{ env.AWS_SECRET_ACCESS_KEY }} \
-          -e AWS_SESSION_TOKEN=${{ env.AWS_SESSION_TOKEN }} \
+          -e AWS_ACCESS_KEY_ID=$\{{ env.AWS_ACCESS_KEY_ID }} \
+          -e AWS_SECRET_ACCESS_KEY=$\{{ env.AWS_SECRET_ACCESS_KEY }} \
+          -e AWS_SESSION_TOKEN=$\{{ env.AWS_SESSION_TOKEN }} \
           -e GITHUB_REPOSITORY=$GITHUB_REPOSITORY \
           -e GITHUB_REF_NAME=$GITHUB_REF_NAME \
           -e GITHUB_RUN_NUMBER=$GITHUB_RUN_NUMBER \
@@ -84,7 +84,7 @@ jobs:
       - name: Run transponder
         run: |
           docker run --rm -v `pwd`:`pwd` -w `pwd` \
-          -e J1_API_KEY=${{ secrets.J1_API_KEY_TRANSPONDER }} \
-          -e J1_API_DOMAIN=${{ secrets.J1_API_DOMAIN_TRANSPONDER }} \
-          -e J1_ACCOUNT_ID=${{ secrets.J1_ACCOUNT_ID_TRANSPONDER }} \
+          -e J1_API_KEY=$\{{ secrets.J1_API_KEY_TRANSPONDER }} \
+          -e J1_API_DOMAIN=$\{{ secrets.J1_API_DOMAIN_TRANSPONDER }} \
+          -e J1_ACCOUNT_ID=$\{{ secrets.J1_ACCOUNT_ID_TRANSPONDER }} \
           $TRANSPONDER_DOCKER_IMAGE
diff --git a/packages/integration-sdk-cli/src/generator/template/.github/workflows/questions.yml.hbs b/packages/integration-sdk-cli/src/generator/template/.github/workflows/questions.yml.hbs
@@ -14,8 +14,8 @@ jobs:
       - name: Check out target branch questions
         uses: actions/checkout@v3
         with:
-          ref: ${{github.event.pull_request.head.ref}}
-          repository: ${{github.event.pull_request.head.repo.full_name}}
+          ref: $\{{github.event.pull_request.head.ref}}
+          repository: $\{{github.event.pull_request.head.repo.full_name}}
           path: target
 
       - id: setup-node
@@ -30,9 +30,9 @@ jobs:
       - name: Validate questions on target branch
         env:
           MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID:
-            ${{ secrets.MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID }}
+            $\{{ secrets.MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID }}
           MANAGED_QUESTIONS_JUPITERONE_API_KEY:
-            ${{ secrets.MANAGED_QUESTIONS_JUPITERONE_API_KEY }}
+            $\{{ secrets.MANAGED_QUESTIONS_JUPITERONE_API_KEY }}
         run:
           yarn --cwd source j1-integration validate-question-file -a
           --frozen-lockfile $MANAGED_QUESTIONS_JUPITERONE_ACCOUNT_ID -k
diff --git a/packages/integration-sdk-cli/src/generator/template/package.json.hbs b/packages/integration-sdk-cli/src/generator/template/package.json.hbs
@@ -36,12 +36,12 @@
     "postversion": "cp package.json ./dist/package.json"
   },
   "peerDependencies": {
-    "@jupiterone/integration-sdk-core": "^9.0.0"
+    "@jupiterone/integration-sdk-core": "^10.5.0"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-core": "^9.0.0",
-    "@jupiterone/integration-sdk-dev-tools": "^9.0.0",
-    "@jupiterone/integration-sdk-testing": "^9.0.0",
+    "@jupiterone/integration-sdk-core": "^10.5.0",
+    "@jupiterone/integration-sdk-dev-tools": "^10.5.0",
+    "@jupiterone/integration-sdk-testing": "^10.5.0",
     "auto": "^10.36.5"
   },
   "auto": {
diff --git a/packages/integration-sdk-cli/src/generator/template/src/config.ts.hbs b/packages/integration-sdk-cli/src/generator/template/src/config.ts.hbs
@@ -2,20 +2,19 @@ import {
   IntegrationExecutionContext,
   {{#if configFields}}IntegrationValidationError,{{/if}}
   IntegrationInstanceConfigFieldMap,
-  IntegrationInstanceConfig,
 } from '@jupiterone/integration-sdk-core';
 import { createAPIClient } from './client';
 
-export const instanceConfigFields: IntegrationInstanceConfigFieldMap = {
+export const instanceConfigFields = {
   {{#each configFields}}
   {{camelCase field}}: {
     type: '{{type}}',
     mask: {{mask}}
   },
   {{/each}}
-};
+} satisfies IntegrationInstanceConfigFieldMap;
 
-export interface IntegrationConfig extends IntegrationInstanceConfig {
+export interface IntegrationConfig {
   {{#each configFields}}
   {{camelCase field}}: {{ type }};
   {{/each}}
diff --git a/packages/integration-sdk-cli/src/generator/template/src/steps/constants.ts.hbs b/packages/integration-sdk-cli/src/generator/template/src/steps/constants.ts.hbs
@@ -4,25 +4,23 @@ import {
   StepRelationshipMetadata,
 } from '@jupiterone/integration-sdk-core';
 
-export const Steps: Record<{{#unless steps}}string{{/unless}}{{#each steps}}'{{constantCase name}}'{{#unless @last}}|{{/unless}}{{/each}}, string> = {
+export const Steps = {
   {{#each steps}}
   {{constantCase name}}: '{{kebabCase name}}',
   {{/each}}
-};
+} satisfies Record<string, string>;
 
-export const Entities: Record<{{#unless entities}}string{{/unless}}{{#each entities}}'{{constantCase resourceName}}'{{#unless @last}}|{{/unless}}{{/each}}
-, StepEntityMetadata > = {
+export const Entities = {
   {{#each entities}}
   {{constantCase resourceName}}: {
     resourceName: '{{resourceName}}',
     _type: '{{_type}}',
     _class: [{{#each _class}}'{{this}}'{{#unless @last}},{{/unless}}{{/each}}],
   },
   {{/each}}
-};
+} satisfies Record<string, StepEntityMetadata>;
 
-export const Relationships: Record<{{#unless relationships}}string{{/unless}}{{#each relationships}}'{{constantCase (generateRelationshipName this)}}'{{#unless @last}}|{{/unless}}{{/each}},
-StepRelationshipMetadata> = {
+export const Relationships = {
   {{#each relationships}}
   {{constantCase (generateRelationshipName this)}}: {
     sourceType: Entities.{{ constantCase from.resourceName }}._type,
@@ -31,4 +29,4 @@ StepRelationshipMetadata> = {
     _class: RelationshipClass.{{_class}},
   },
   {{/each}}
-};
+} satisfies Record<string, StepRelationshipMetadata>;
diff --git a/packages/integration-sdk-core/package.json b/packages/integration-sdk-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-core",
-  "version": "10.5.1",
+  "version": "10.5.2",
   "description": "The SDK for developing JupiterOne integrations",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
diff --git a/packages/integration-sdk-dev-tools/package.json b/packages/integration-sdk-dev-tools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-dev-tools",
-  "version": "10.5.1",
+  "version": "10.5.2",
   "description": "A collection of developer tools that will assist with building integrations.",
   "repository": "git@github.com:JupiterOne/sdk.git",
   "author": "JupiterOne <dev@jupiterone.io>",
@@ -15,8 +15,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@jupiterone/integration-sdk-cli": "^10.5.1",
-    "@jupiterone/integration-sdk-testing": "^10.5.1",
+    "@jupiterone/integration-sdk-cli": "^10.5.2",
+    "@jupiterone/integration-sdk-testing": "^10.5.2",
     "@types/jest": "^29.5.3",
     "@types/node": "^18",
     "@typescript-eslint/eslint-plugin": "^6.2.1",
diff --git a/packages/integration-sdk-entities/package.json b/packages/integration-sdk-entities/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-entities",
-  "version": "10.5.1",
+  "version": "10.5.2",
   "description": "Generated types for the JupiterOne data-model",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
diff --git a/packages/integration-sdk-http-client/package.json b/packages/integration-sdk-http-client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-http-client",
-  "version": "10.5.1",
+  "version": "10.5.2",
   "description": "The HTTP client for use in JupiterOne integrations",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -26,8 +26,8 @@
     "node-fetch": "^2.6.0"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-dev-tools": "^10.5.1",
-    "@jupiterone/integration-sdk-private-test-utils": "^10.5.1",
+    "@jupiterone/integration-sdk-dev-tools": "^10.5.2",
+    "@jupiterone/integration-sdk-private-test-utils": "^10.5.2",
     "fetch-mock-jest": "^1.5.1"
   },
   "bugs": {
diff --git a/packages/integration-sdk-private-test-utils/package.json b/packages/integration-sdk-private-test-utils/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@jupiterone/integration-sdk-private-test-utils",
   "private": true,
-  "version": "10.5.1",
+  "version": "10.5.2",
   "description": "The SDK for developing JupiterOne integrations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
     "build:dist": "tsc -p tsconfig.json --declaration"
   },
   "dependencies": {
-    "@jupiterone/integration-sdk-core": "^10.5.1",
+    "@jupiterone/integration-sdk-core": "^10.5.2",
     "lodash": "^4.17.15"
   },
   "devDependencies": {
diff --git a/packages/integration-sdk-runtime/package.json b/packages/integration-sdk-runtime/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-runtime",
-  "version": "10.5.1",
+  "version": "10.5.2",
   "description": "The SDK for developing JupiterOne integrations",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -23,7 +23,7 @@
     "prepack": "yarn build:dist"
   },
   "dependencies": {
-    "@jupiterone/integration-sdk-core": "^10.5.1",
+    "@jupiterone/integration-sdk-core": "^10.5.2",
     "@lifeomic/alpha": "^5.1.1",
     "@lifeomic/attempt": "^3.0.3",
     "async-sema": "^3.1.0",
@@ -41,7 +41,7 @@
     "rimraf": "^3.0.2"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-private-test-utils": "^10.5.1",
+    "@jupiterone/integration-sdk-private-test-utils": "^10.5.2",
     "get-port": "^5.1.1",
     "memfs": "^3.2.0",
     "ts-node": "^9.1.0",
diff --git a/packages/integration-sdk-testing/package.json b/packages/integration-sdk-testing/package.json

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`	`"packages/integration-sdk-*",`
`5`	`5`	`"packages/cli"`
`6`	`6`	`],`
`7`		`- "version": "10.5.1"`
	`7`	`+ "version": "10.5.2"`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@jupiterone/integration-sdk-benchmark",`
`3`		`- "version": "10.5.1",`
	`3`	`+ "version": "10.5.2",`
`4`	`4`	`"private": true,`
`5`	`5`	`"description": "SDK benchmarking scripts",`
`6`	`6`	`"main": "./src/index.js",`
`@@ -15,8 +15,8 @@`
`15`	`15`	`"benchmark": "for file in ./src/benchmarks/*; do yarn prebenchmark && node $file; done"`
`16`	`16`	`},`
`17`	`17`	`"dependencies": {`
`18`		`- "@jupiterone/integration-sdk-core": "^10.5.1",`
`19`		`- "@jupiterone/integration-sdk-runtime": "^10.5.1",`
	`18`	`+ "@jupiterone/integration-sdk-core": "^10.5.2",`
	`19`	`+ "@jupiterone/integration-sdk-runtime": "^10.5.2",`
`20`	`20`	`"benchmark": "^2.1.4"`
`21`	`21`	`}`
`22`	`22`	`}`