@jupiterone/integration-sdk-cli 9.5.0 → 9.6.2

package/dist/src/generator/template/src/config.ts.hbs

@@ -0,0 +1,39 @@
+import {
+  IntegrationExecutionContext,
+  {{#if configFields}}IntegrationValidationError,{{/if}}
+  IntegrationInstanceConfigFieldMap,
+  IntegrationInstanceConfig,
+} from '@jupiterone/integration-sdk-core';
+import { createAPIClient } from './client';
+
+export const instanceConfigFields: IntegrationInstanceConfigFieldMap = {
+  {{#each configFields}}
+  {{camelCase field}}: {
+    type: '{{type}}',
+    mask: {{mask}}
+  },
+  {{/each}}
+};
+
+export interface IntegrationConfig extends IntegrationInstanceConfig {
+  {{#each configFields}}
+  {{camelCase field}}: {{ type }};
+  {{/each}}
+}
+
+export async function validateInvocation(
+  context: IntegrationExecutionContext<IntegrationConfig>,
+) {
+  const { config } = context.instance;
+
+  {{#if configFields}}
+  if ({{#each configFields}}!config.{{camelCase field}}{{#unless @last}}||{{/unless}}{{/each}}) {
+    throw new IntegrationValidationError(
+      'Config requires all of {{#each configFields}}{{camelCase field}}{{#unless @last}},{{/unless}}{{/each}}',
+    );
+  }
+  {{/if}}
+
+  const apiClient = createAPIClient(config);
+  await apiClient.verifyAuthentication();
+}

package/dist/src/generator/template/src/index.ts.hbs

@@ -0,0 +1,14 @@
+import { IntegrationInvocationConfig } from '@jupiterone/integration-sdk-core';
+import { integrationSteps } from './steps';
+import {
+  validateInvocation,
+  IntegrationConfig,
+  instanceConfigFields,
+} from './config';
+
+export const invocationConfig: IntegrationInvocationConfig<IntegrationConfig> =
+  {
+    instanceConfigFields,
+    validateInvocation,
+    integrationSteps,
+  };

package/dist/src/generator/template/src/steps/constants.ts.hbs

@@ -0,0 +1,34 @@
+import {
+  {{#if relationships}}RelationshipClass,{{/if}}
+  StepEntityMetadata,
+  StepRelationshipMetadata,
+} from '@jupiterone/integration-sdk-core';
+
+export const Steps: Record<{{#unless steps}}string{{/unless}}{{#each steps}}'{{constantCase name}}'{{#unless @last}}|{{/unless}}{{/each}}, string> = {
+  {{#each steps}}
+  {{constantCase name}}: '{{kebabCase name}}',
+  {{/each}}
+};
+
+export const Entities: Record<{{#unless entities}}string{{/unless}}{{#each entities}}'{{constantCase resourceName}}'{{#unless @last}}|{{/unless}}{{/each}}
+, StepEntityMetadata > = {
+  {{#each entities}}
+  {{constantCase resourceName}}: {
+    resourceName: '{{resourceName}}',
+    _type: '{{_type}}',
+    _class: [{{#each _class}}'{{this}}'{{#unless @last}},{{/unless}}{{/each}}],
+  },
+  {{/each}}
+};
+
+export const Relationships: Record<{{#unless relationships}}string{{/unless}}{{#each relationships}}'{{constantCase (generateRelationshipName this)}}'{{#unless @last}}|{{/unless}}{{/each}},
+StepRelationshipMetadata> = {
+  {{#each relationships}}
+  {{constantCase (generateRelationshipName this)}}: {
+    sourceType: Entities.{{ constantCase from.resourceName }}._type,
+    targetType: Entities.{{ constantCase to.resourceName }}._type,
+    _type: '{{snakeCase (generateRelationshipType this)}}',
+    _class: RelationshipClass.{{_class}},
+  },
+  {{/each}}
+};

package/dist/src/generator/template/src/steps/index.ts.hbs

@@ -0,0 +1,7 @@
+{{#each steps}}
+import { {{camelCase name}}Steps } from './{{kebabCase name}}'
+{{/each}}
+
+const integrationSteps = [{{#each steps}}...{{camelCase name}}Steps{{#unless @last}},{{/unless}}{{/each}}];
+
+export { integrationSteps };

package/dist/src/generator/template/src/validateInvocation.ts.hbs

@@ -0,0 +1,23 @@
+import { Recording } from '@jupiterone/integration-sdk-testing';
+
+describe('#validateInvocation', () => {
+  let recording: Recording;
+
+  afterEach(async () => {
+    if (recording) {
+      await recording.stop();
+    }
+  });
+
+  test.todo('requires valid config', async () => {
+    // TODO
+  });
+
+  test.todo('successfully validates invocation', async () => {
+    // TODO
+  });
+
+  describe('fails validating invocation', () => {
+    // TODO
+  });
+});

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

@@ -0,0 +1,4 @@
+# Testing Integrations
+
+For information on testing integrations see: 
+

package/dist/src/generator/template/test/config.ts.hbs

@@ -0,0 +1,30 @@
+import { IntegrationInvocationConfig } from '@jupiterone/integration-sdk-core';
+import { StepTestConfig } from '@jupiterone/integration-sdk-testing';
+import * as dotenv from 'dotenv';
+import * as path from 'path';
+import { invocationConfig } from '../src';
+import { IntegrationConfig } from '../src/config';
+
+if (process.env.LOAD_ENV) {
+  dotenv.config({
+    path: path.join(__dirname, '../.env'),
+  });
+}
+
+{{#each configField}}
+const DEFAULT_{{constantCase field}} = '';
+{{/each}}
+
+export const integrationConfig: IntegrationConfig = {
+  {{#each configField}}
+  {{camelCase field}}: process.env.{{constantCase field}} || DEFAULT_{{constantCase field}}
+  {{/each}}
+};
+
+export function buildStepTestConfigForStep(stepId: string): StepTestConfig {
+  return {
+    stepId,
+    instanceConfig: integrationConfig,
+    invocationConfig: invocationConfig as IntegrationInvocationConfig,
+  };
+}

package/dist/src/generator/template/test/recording.ts.hbs

@@ -0,0 +1,74 @@
+import {
+  setupRecording,
+  Recording,
+  SetupRecordingInput,
+  mutations,
+} from '@jupiterone/integration-sdk-testing';
+
+export { Recording };
+
+export function setupProjectRecording(
+  input: Omit<SetupRecordingInput, 'mutateEntry'>,
+): Recording {
+  return setupRecording({
+    ...input,
+    redactedRequestHeaders: ['Authorization'],
+    redactedResponseHeaders: ['set-cookie'],
+    mutateEntry: mutations.unzipGzippedRecordingEntry,
+    /*mutateEntry: (entry) => {
+      redact(entry);
+    },*/
+  });
+}
+
+// a more sophisticated redaction example below:
+
+/*
+function getRedactedOAuthResponse() {
+  return {
+    access_token: '[REDACTED]',
+    expires_in: 9999,
+    token_type: 'Bearer',
+  };
+}
+
+function redact(entry): void {
+  if (entry.request.postData) {
+    entry.request.postData.text = '[REDACTED]';
+  }
+
+  if (!entry.response.content.text) {
+    return;
+  }
+
+  //let's unzip the entry so we can modify it
+  mutations.unzipGzippedRecordingEntry(entry);
+
+  //we can just get rid of all response content if this was the token call
+  const requestUrl = entry.request.url;
+  if (requestUrl.match(/oauth\/token/)) {
+    entry.response.content.text = JSON.stringify(getRedactedOAuthResponse());
+    return;
+  }
+
+  //if it wasn't a token call, parse the response text, removing any carriage returns or newlines
+  const responseText = entry.response.content.text;
+  const parsedResponseText = JSON.parse(responseText.replace(/\r?\n|\r/g, ''));
+
+  //now we can modify the returned object as desired
+  //in this example, if the return text is an array of objects that have the 'tenant' property...
+  if (parsedResponseText[0]?.tenant) {
+    for (let i = 0; i < parsedResponseText.length; i++) {
+      parsedResponseText[i].client_secret = '[REDACTED]';
+      parsedResponseText[i].jwt_configuration = '[REDACTED]';
+      parsedResponseText[i].signing_keys = '[REDACTED]';
+      parsedResponseText[i].encryption_key = '[REDACTED]';
+      parsedResponseText[i].addons = '[REDACTED]';
+      parsedResponseText[i].client_metadata = '[REDACTED]';
+      parsedResponseText[i].mobile = '[REDACTED]';
+      parsedResponseText[i].native_social_login = '[REDACTED]';
+    }
+  }
+
+  entry.response.content.text = JSON.stringify(parsedResponseText);
+} */

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

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src", "package.json"],
+  "exclude": [
+    "dist",
+    "**/*.test.ts",
+    "**/*.test.js",
+    "**/*/__tests__/**/*.ts",
+    "**/*/__tests__/**/*.js",
+    "**/*/__mocks__/**/*.ts",
+    "**/*/__mocks__/**/*.js"
+  ]
+}

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

@@ -0,0 +1,7 @@
+{
+  "extends": "./node_modules/@jupiterone/integration-sdk-dev-tools/config/typescript",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "exclude": ["dist"]
+}

package/dist/src/generator/util.d.ts

@@ -0,0 +1,9 @@
+import { Entity } from './entitiesFlow';
+declare function askRepeatedly<T>(inquirer: any, cb: () => Promise<void>): Promise<void>;
+declare function generateChoicesFromEntities(entities: any): {
+    name: string;
+    value: Entity;
+}[];
+declare function confirmPrompt(inquiurer: any, message: any): Promise<any>;
+declare function askAgain(inquirer: any): Promise<any>;
+export { askAgain, askRepeatedly, confirmPrompt, generateChoicesFromEntities };

package/dist/src/generator/util.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateChoicesFromEntities = exports.confirmPrompt = exports.askRepeatedly = exports.askAgain = void 0;
+async function askRepeatedly(inquirer, cb) {
+    let again = false;
+    do {
+        await cb();
+        again = await askAgain(inquirer);
+    } while (again);
+}
+exports.askRepeatedly = askRepeatedly;
+function generateChoicesFromEntities(entities) {
+    const choices = [];
+    for (const entity of entities) {
+        choices.push({
+            name: entity._type,
+            value: entity,
+        });
+    }
+    return choices;
+}
+exports.generateChoicesFromEntities = generateChoicesFromEntities;
+async function confirmPrompt(inquiurer, message) {
+    return (await inquiurer.prompt({
+        type: 'confirm',
+        name: 'value',
+        message,
+    })).value;
+}
+exports.confirmPrompt = confirmPrompt;
+async function askAgain(inquirer) {
+    return await confirmPrompt(inquirer, 'Add another?');
+}
+exports.askAgain = askAgain;
+//# sourceMappingURL=util.js.map

package/dist/src/generator/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/generator/util.ts"],"names":[],"mappings":";;;AAEA,KAAK,UAAU,aAAa,CAC1B,QAAQ,EACR,EAAuB;IAEvB,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,GAAG;QACD,MAAM,EAAE,EAAE,CAAC;QACX,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAClC,QAAQ,KAAK,EAAE;AAClB,CAAC;AA2BkB,sCAAa;AAzBhC,SAAS,2BAA2B,CAAC,QAAQ;IAC3C,MAAM,OAAO,GAAsC,EAAE,CAAC;IACtD,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;QAC7B,OAAO,CAAC,IAAI,CAAC;YACX,IAAI,EAAE,MAAM,CAAC,KAAK;YAClB,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;KACJ;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAgBgD,kEAA2B;AAd5E,KAAK,UAAU,aAAa,CAAC,SAAS,EAAE,OAAO;IAC7C,OAAO,CACL,MAAM,SAAS,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,OAAO;QACb,OAAO;KACR,CAAC,CACH,CAAC,KAAK,CAAC;AACV,CAAC;AAMiC,sCAAa;AAJ/C,KAAK,UAAU,QAAQ,CAAC,QAAQ;IAC9B,OAAO,MAAM,aAAa,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AACvD,CAAC;AAEQ,4BAAQ"}

package/dist/src/index.js

@@ -17,7 +17,8 @@ function createCli() {
         .addCommand((0, commands_1.visualizeDependencies)())
         .addCommand((0, commands_1.generateIntegrationGraphSchemaCommand)())
         .addCommand((0, commands_1.generateIngestionSourcesConfigCommand)())
-        .addCommand((0, commands_1.troubleshootLocalExecution)());
+        .addCommand((0, commands_1.troubleshootLocalExecution)())
+        .addCommand((0, commands_1.generate)());
 }
 exports.createCli = createCli;
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA0C;AAE1C,yCAcoB;AAEpB,SAAgB,SAAS;IACvB,OAAO,IAAA,yBAAa,GAAE;SACnB,UAAU,CAAC,IAAA,kBAAO,GAAE,CAAC;SACrB,UAAU,CAAC,IAAA,eAAI,GAAE,CAAC;SAClB,UAAU,CAAC,IAAA,oBAAS,GAAE,CAAC;SACvB,UAAU,CAAC,IAAA,eAAI,GAAE,CAAC;SAClB,UAAU,CAAC,IAAA,cAAG,GAAE,CAAC;SACjB,UAAU,CAAC,IAAA,yBAAc,GAAE,CAAC;SAC5B,UAAU,CAAC,IAAA,mBAAQ,GAAE,CAAC;SACtB,UAAU,CAAC,IAAA,+BAAoB,GAAE,CAAC;SAClC,UAAU,CAAC,IAAA,gBAAK,GAAE,CAAC;SACnB,UAAU,CAAC,IAAA,gCAAqB,GAAE,CAAC;SACnC,UAAU,CAAC,IAAA,gDAAqC,GAAE,CAAC;SACnD,UAAU,CAAC,IAAA,gDAAqC,GAAE,CAAC;SACnD,UAAU,CAAC,IAAA,qCAA0B,GAAE,CAAC,CAAC;AAC9C,CAAC;AAfD,8BAeC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA0C;AAE1C,yCAeoB;AAEpB,SAAgB,SAAS;IACvB,OAAO,IAAA,yBAAa,GAAE;SACnB,UAAU,CAAC,IAAA,kBAAO,GAAE,CAAC;SACrB,UAAU,CAAC,IAAA,eAAI,GAAE,CAAC;SAClB,UAAU,CAAC,IAAA,oBAAS,GAAE,CAAC;SACvB,UAAU,CAAC,IAAA,eAAI,GAAE,CAAC;SAClB,UAAU,CAAC,IAAA,cAAG,GAAE,CAAC;SACjB,UAAU,CAAC,IAAA,yBAAc,GAAE,CAAC;SAC5B,UAAU,CAAC,IAAA,mBAAQ,GAAE,CAAC;SACtB,UAAU,CAAC,IAAA,+BAAoB,GAAE,CAAC;SAClC,UAAU,CAAC,IAAA,gBAAK,GAAE,CAAC;SACnB,UAAU,CAAC,IAAA,gCAAqB,GAAE,CAAC;SACnC,UAAU,CAAC,IAAA,gDAAqC,GAAE,CAAC;SACnD,UAAU,CAAC,IAAA,gDAAqC,GAAE,CAAC;SACnD,UAAU,CAAC,IAAA,qCAA0B,GAAE,CAAC;SACxC,UAAU,CAAC,IAAA,mBAAQ,GAAE,CAAC,CAAC;AAC5B,CAAC;AAhBD,8BAgBC"}