@jupiterone/integration-sdk-cli 11.8.0 → 12.0.1-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/integration-sdk-cli",
-  "version": "11.8.0",
+  "version": "12.0.1-alpha.2+6492b01",
   "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": "^11.8.0",
-    "@jupiterone/integration-sdk-runtime": "^11.8.0",
+    "@jupiterone/integration-sdk-core": "^12.0.1-alpha.2+6492b01",
+    "@jupiterone/integration-sdk-runtime": "^12.0.1-alpha.2+6492b01",
     "chalk": "^4",
     "commander": "^9.4.0",
     "fs-extra": "^10.1.0",
@@ -43,7 +43,7 @@
     "url-exists": "^1.0.3"
   },
   "devDependencies": {
-    "@jupiterone/integration-sdk-private-test-utils": "^11.8.0",
+    "@jupiterone/integration-sdk-private-test-utils": "^12.0.0",
     "@pollyjs/adapter-node-http": "^6.0.5",
     "@pollyjs/core": "^6.0.5",
     "@pollyjs/persister-fs": "^6.0.5",
@@ -56,5 +56,5 @@
     "neo-forgery": "^2.0.0",
     "vis": "^4.21.0-EOL"
   },
-  "gitHead": "f1c33a3033fabef92015238f3e092ec2accc083f"
+  "gitHead": "6492b018b9cde226ac8e5cdcf7594e8d27aa183b"
 }

package/src/__tests__/cli.test.ts

@@ -125,6 +125,9 @@ describe('collect', () => {
           partialTypes: [],
           encounteredTypes: ['test_account'],
           status: StepResultStatus.CACHED,
+          startTime: expect.any(Number),
+          endTime: expect.any(Number),
+          duration: expect.any(Number),
         },
         {
           id: 'fetch-groups',
@@ -134,6 +137,9 @@ describe('collect', () => {
           partialTypes: [],
           encounteredTypes: [],
           status: StepResultStatus.SUCCESS,
+          startTime: expect.any(Number),
+          endTime: expect.any(Number),
+          duration: expect.any(Number),
         },
         {
           id: 'fetch-users',
@@ -166,6 +172,9 @@ describe('collect', () => {
           partialTypes: [],
           encounteredTypes: [],
           status: StepResultStatus.SUCCESS,
+          startTime: expect.any(Number),
+          endTime: expect.any(Number),
+          duration: expect.any(Number),
         },
         {
           id: 'fetch-groups',
@@ -175,6 +184,9 @@ describe('collect', () => {
           partialTypes: [],
           encounteredTypes: [],
           status: StepResultStatus.SUCCESS,
+          startTime: expect.any(Number),
+          endTime: expect.any(Number),
+          duration: expect.any(Number),
         },
         {
           id: 'fetch-users',
@@ -183,6 +195,9 @@ describe('collect', () => {
           partialTypes: [],
           encounteredTypes: [],
           status: StepResultStatus.SUCCESS,
+          startTime: expect.any(Number),
+          endTime: expect.any(Number),
+          duration: expect.any(Number),
         },
       ],
       metadata: {
@@ -212,6 +227,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.FAILURE,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
         ],
         metadata: {
@@ -240,6 +258,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: ['my_user'],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
         ],
         metadata: {
@@ -288,6 +309,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
         ],
         metadata: {
@@ -319,6 +343,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
           {
             id: 'fetch-groups',
@@ -336,6 +363,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
         ],
         metadata: {
@@ -369,6 +399,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
           {
             id: 'fetch-groups',
@@ -386,6 +419,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
         ],
         metadata: {
@@ -416,6 +452,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
           {
             id: 'fetch-groups',
@@ -425,6 +464,9 @@ describe('collect', () => {
             partialTypes: [],
             encounteredTypes: [],
             status: StepResultStatus.SUCCESS,
+            startTime: expect.any(Number),
+            endTime: expect.any(Number),
+            duration: expect.any(Number),
           },
           {
             id: 'fetch-users',

package/src/generator/newIntegration.ts

@@ -90,10 +90,17 @@ function newIntegration(plop: NodePlopAPI) {
         return [];
       }
 
+      // @jupiterone/graph-foo -> graph-foo
+      // graph-foo -> graph-foo
+      const directoryName = path.join(
+        process.cwd(),
+        path.basename(data.packageName),
+      );
+
       const actions: any[] = [];
       actions.push({
         type: 'addMany',
-        destination: '.',
+        destination: directoryName,
         base: path.join(__dirname, '/template'),
         templateFiles: path.join(__dirname + '/template/**'),
         globOptions: { dot: true },
@@ -104,7 +111,10 @@ function newIntegration(plop: NodePlopAPI) {
       for (const step of data.steps) {
         actions.push({
           type: 'add',
-          path: path.normalize(`src/steps/${kebabCase(step.name)}/index.ts`),
+          path: path.join(
+            directoryName,
+            path.normalize(`src/steps/${kebabCase(step.name)}/index.ts`),
+          ),
           templateFile: path.join(__dirname, 'stepTemplate/index.ts.hbs'),
           data: step,
           force: true,
@@ -113,19 +123,19 @@ function newIntegration(plop: NodePlopAPI) {
 
       actions.push({
         type: 'yarnInstall',
-        path: '.',
+        path: directoryName,
         verbose: true,
       });
 
       actions.push({
         type: 'yarnFormat',
-        path: '.',
+        path: directoryName,
         verbose: true,
       });
 
       actions.push({
         type: 'yarnLint',
-        path: '.',
+        path: directoryName,
         verbose: true,
       });
 

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

@@ -27,27 +27,3 @@ jobs:
 
       - name: Run build
         run: yarn build
-
-  # Publishing is done in a separate job to allow
-  # for all matrix builds to complete.
-  BuildRelease:
-    needs: test
-    runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main'
-    name: Checkout Code
-    steps:
-      - name: Check out repo
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-          token: $\{{ secrets.AUTO_GITHUB_PAT_TOKEN }}
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18.x
-          cache: yarn
-      - 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 }}

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

@@ -1,10 +1,10 @@
 {
   "name": "{{packageName}}",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "{{packageDescription}}",
   "license": "MPL-2.0",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
   "files": [
     "src",
     "jupiterone"
@@ -13,7 +13,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=18.0.0 <19.x"
+    "node": ">=18.0.0 <20.x"
   },
   "scripts": {
     "start": "j1-integration collect",
@@ -36,28 +36,11 @@
     "postversion": "cp package.json ./dist/package.json"
   },
   "peerDependencies": {
-    "@jupiterone/integration-sdk-core": "^10.5.0"
+    "@jupiterone/integration-sdk-core": "^12.0.0"
   },
   "devDependencies": {
-    "@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": {
-    "plugins": [
-      [
-        "npm",
-        {
-          "setRcToken": false,
-          "publishFolder": "./dist"
-        }
-      ],
-      "released"
-    ],
-    "onlyPublishWithReleaseLabel": true,
-    "shipit": {
-      "prerelease": false
-    }
+    "@jupiterone/integration-sdk-core": "^12.0.0",
+    "@jupiterone/integration-sdk-dev-tools": "^12.0.0",
+    "@jupiterone/integration-sdk-testing": "^12.0.0",
   }
 }

package/dist/src/generator/template/.github/workflows/codeql-analysis.yml.hbs

@@ -1,69 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: 'CodeQL'
-
-on:
-  push:
-    branches: ['main']
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: ['main']
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: ['javascript']
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-        with:
-          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.
-
-          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          queries: security-extended,security-and-quality
-
-      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-      # If this step fails, then you should remove it and run the build manually (see below)
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
-
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-      #   If the Autobuild fails above, remove it and uncomment the following three lines.
-      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-      # - run: |
-      #   echo "Run, Build Application using script"
-      #   ./location_of_script_within_repo/buildscript.sh
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2

package/dist/src/generator/template/.github/workflows/integration-deployment.yml.hbs

@@ -1,36 +0,0 @@
-name: J1 Integration deployment
-
-on:
-  release:
-    types:
-      - published
-
-jobs:
-  j1-integration-deployment:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Get integration name
-        id: get-integration-name
-        uses: actions/github-script@0.9.0
-        with:
-          script: |
-            const repositoryName = context.payload.repository.name
-            const integrationName = repositoryName.replace("graph-", "")
-            core.setOutput('integrationName', integrationName)
-      - name: Get version number
-        id: get-version-number
-        uses: actions/github-script@0.9.0
-        with:
-          script: |
-            const tagName = context.payload.release.tag_name
-            const versionNumber = tagName.replace("v", "")
-            core.setOutput('versionNumber', versionNumber)
-      - name: Bump integration deployment version
-        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 }}

package/dist/src/generator/template/.github/workflows/peril.yml.hbs

@@ -1,90 +0,0 @@
-name: 'Peril'
-
-on:
-  pull_request:
-
-env:
-  TRANSPONDER_DOCKER_IMAGE: 081157560428.dkr.ecr.us-east-1.amazonaws.com/transponder:1
-  SECURITY_SCAN_IMAGE: ghcr.io/jupiterone/security-scan:latest
-
-jobs:
-  Peril:
-    name: Peril
-    permissions:
-      id-token: write
-      contents: read
-      packages: read
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: 18.x
-
-      - name: Run build
-        run: yarn install
-
-      - name: Get Variables
-        id: get-vars
-        run: |
-          if [[ "${GITHUB_REF}" == 'ref/head/main' && "${GITHUB_EVENT_NAME}" == 'push' ]];
-          then
-            echo ::set-output name=aws-oidc-role::arn:aws:iam::081157560428:role/github-main-role
-          else
-            echo ::set-output name=aws-oidc-role::arn:aws:iam::081157560428:role/github-pull-request-role
-          fi
-
-      - name: Configure aws credentials
-        uses: aws-actions/configure-aws-credentials@v1
-        with:
-          role-to-assume: $\{{ steps.get-vars.outputs.aws-oidc-role }}
-          role-session-name: pr-role-session
-          aws-region: us-east-1
-
-      - name: ECR login
-        uses: aws-actions/amazon-ecr-login@v1
-        id: amazon-ecr-login
-
-      - name: Login to GHCR
-        uses: docker/login-action@v2
-        with:
-          registry: ghcr.io
-          username: $\{{ github.actor }}
-          password: $\{{ secrets.PACKAGE_TOKEN }}
-
-      - name: Pull security-scan
-        run: |
-          docker pull $SECURITY_SCAN_IMAGE
-
-      - name: Run security-scan
-        run: |
-          docker run \
-          --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 GITHUB_REPOSITORY=$GITHUB_REPOSITORY \
-          -e GITHUB_REF_NAME=$GITHUB_REF_NAME \
-          -e GITHUB_RUN_NUMBER=$GITHUB_RUN_NUMBER \
-          -e GITHUB_SERVER_URL=$GITHUB_SERVER_URL \
-          -e GITHUB_RUN_ID=$GITHUB_RUN_ID \
-          -e MODE=ci \
-          -w `pwd` $SECURITY_SCAN_IMAGE
-
-      - name: Pull transponder
-        run: |
-          docker pull $TRANSPONDER_DOCKER_IMAGE
-
-      - 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 }} \
-          $TRANSPONDER_DOCKER_IMAGE

package/src/generator/template/.github/workflows/codeql-analysis.yml.hbs

@@ -1,69 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: 'CodeQL'
-
-on:
-  push:
-    branches: ['main']
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: ['main']
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: ['javascript']
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      # Initializes the CodeQL tools for scanning.
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-        with:
-          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.
-
-          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          queries: security-extended,security-and-quality
-
-      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-      # If this step fails, then you should remove it and run the build manually (see below)
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
-
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-      #   If the Autobuild fails above, remove it and uncomment the following three lines.
-      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-      # - run: |
-      #   echo "Run, Build Application using script"
-      #   ./location_of_script_within_repo/buildscript.sh
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2

package/src/generator/template/.github/workflows/integration-deployment.yml.hbs

@@ -1,36 +0,0 @@
-name: J1 Integration deployment
-
-on:
-  release:
-    types:
-      - published
-
-jobs:
-  j1-integration-deployment:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Get integration name
-        id: get-integration-name
-        uses: actions/github-script@0.9.0
-        with:
-          script: |
-            const repositoryName = context.payload.repository.name
-            const integrationName = repositoryName.replace("graph-", "")
-            core.setOutput('integrationName', integrationName)
-      - name: Get version number
-        id: get-version-number
-        uses: actions/github-script@0.9.0
-        with:
-          script: |
-            const tagName = context.payload.release.tag_name
-            const versionNumber = tagName.replace("v", "")
-            core.setOutput('versionNumber', versionNumber)
-      - name: Bump integration deployment version
-        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 }}