@prismatic-io/prism 7.3.1-rc.0 → 7.3.1-rc.1

package/lib/index.js

@@ -64899,7 +64899,7 @@ To test the component, run "npm run test" or "yarn test"
 To build the component, run "npm run build" or "yarn build"
 To publish the component, run "prism components:publish"
 
-For documentation on writing custom components, visit https://prismatic.io/docs/custom-components/writing-custom-components/
+For documentation on writing custom components, visit https://prismatic.io/docs/custom-connectors/
     `)}static async invoke(e,n){await MVe.run(Nze(e),n)}}class fet extends XEe.Command{static description="Initialize a new Component";static flags={"wsdl-path":XEe.Flags.string({required:!1,description:"Path to the WSDL definition file used to generate a Component"}),"open-api-path":XEe.Flags.string({required:!1,description:"The path to an OpenAPI Specification file (JSON or YAML) used to generate a Component"}),verbose:XEe.Flags.boolean({required:!1,default:!1,description:"Output more verbose logging from Component generation"})};static args={name:XEe.Args.string({required:!0,description:"Name of the new component to create (alphanumeric characters, hyphens, and underscores)"})};async run(){let e=process.cwd();try{let{args:{name:n},flags:{verbose:o,"wsdl-path":c,"open-api-path":p}}=await this.parse(fet),g=c?zMe.resolve(c):void 0,T=p?zMe.resolve(p):void 0;if(!qWe.test(n))this.error(`'${n}' contains invalid characters. Please select a component name that starts and ends with alphanumeric characters, and contains only alphanumeric characters, hyphens, and underscores. See https://regex101.com/?regex=${encodeURIComponent(qWe.source)}`,{exit:1});if(g&&!g?.includes(".wsdl"))this.error("If a WSDL is provided it must have an extension of '.wsdl'",{exit:1});if(this.log(`Creating component directory for "${n}"...`),await G7u.mkdir(n),process.chdir(n),T)await MVe.invoke({name:n,openapi:T},this.config);else if(await C9e.invoke({name:n,description:"Prism-generated Component"},this.config),process.chdir(e),g){if(!o)AVi.Logger.disabled();let[I]=zMe.basename(g).split(".wsdl");await SVi.parseAndGenerate(g,n,{caseInsensitiveNames:!0}),await $Ei({projectRoot:n,projectTemplateName:I,projectTemplatePath:g})}process.chdir(zMe.join(e,n)),await Pze({path:"package.json",scripts:{build:"webpack",publish:"npm run build && prism components:publish","generate:manifest":"npm run build && npx @prismatic-io/spectral component-manifest","generate:manifest:dev":"npm run build && npx @prismatic-io/spectral component-manifest --skip-signature-verify",test:"jest",lint:"eslint --ext .ts ."},eslintConfig:{root:!0,extends:["@prismatic-io/eslint-config-spectral"]},dependencies:{"@prismatic-io/spectral":"*",...g?{soap:"1.1.10"}:{}},devDependencies:W4t});let N=await u3t(n);await s3t(n,N),this.log(`
         "${n}" is ready for development.
         To install dependencies, run either "npm install" or "yarn install"
@@ -65286,7 +65286,7 @@ To run unit tests for the integration, run "npm run test" or "yarn test"
 To build the integration, run "npm run build" or "yarn build"
 To import the integration, run "prism integrations:import"
 
-For documentation on writing code-native integrations, visit https://prismatic.io/docs/code-native-integrations/
+For documentation on writing code-native integrations, visit https://prismatic.io/docs/integrations/code-native/
     `)}}var VMe=Qm(zE(),1);class Wet extends Ag{static description="List Integration versions";static flags={...VMe.ux.table.flags(),"latest-available":VMe.Flags.boolean({char:"l",description:"Show only the latest available version"})};static args={integration:VMe.Args.string({required:!0,description:"ID of an integration"})};async run(){let{flags:e,args:{integration:n}}=await this.parse(Wet),o=await km({document:bm`
         query listIntegrationVersions(
           $integrationId: ID!

package/lib/templates/component/src/actions.test.ts.ejs

@@ -10,40 +10,39 @@
  * https://prismatic.io/docs/custom-connectors/unit-testing/
  */
 
-import {
-  createConnection,
-  createHarness,
-} from "@prismatic-io/spectral/dist/testing";
+import { createConnection, createHarness } from "@prismatic-io/spectral/dist/testing";
 import myComponent from ".";
-import { apiKeyConnection } from "./connections";
+import { acmeApiKey } from "./connections";
 
 const harness = createHarness(myComponent);
 
-const acmeConnection = createConnection(apiKeyConnection, {
+const acmeConnection = createConnection(acmeApiKey, {
   baseUrl: "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
   apiKey: "P@s$W0rD",
 });
 
+const expectedItems = [
+  {
+    id: 1,
+    name: "Widgets",
+    quantity: 20,
+  },
+  {
+    id: 2,
+    name: "Whatsits",
+    quantity: 100,
+  },
+  {
+    id: 3,
+    name: "Gadgets",
+    quantity: 5,
+  },
+];
+
 describe("Test Actions", () => {
   test("Verify listItems returns the correct number of items", async () => {
     const result = await harness.action("listItems", { acmeConnection });
-    expect(result?.data).toStrictEqual([
-      {
-        id: 1,
-        name: "Widgets",
-        quantity: 20,
-      },
-      {
-        id: 2,
-        name: "Whatsits",
-        quantity: 100,
-      },
-      {
-        id: 3,
-        name: "Gadgets",
-        quantity: 5,
-      },
-    ]);
+    expect(result?.data).toStrictEqual(expectedItems);
   });
 
   test("Verify getItem returns the correct item", async () => {
@@ -51,11 +50,7 @@ describe("Test Actions", () => {
       acmeConnection,
       itemId: "3",
     });
-    expect(result?.data).toStrictEqual({
-      id: 3,
-      name: "Gadgets",
-      quantity: 5,
-    });
+    expect(result?.data).toStrictEqual(expectedItems[2]);
   });
 
   test("Verify addItem adds an item to inventory", async () => {
@@ -66,4 +61,15 @@ describe("Test Actions", () => {
     });
     expect(result?.data).toMatchObject({ name: "My New Item", quantity: 50 });
   });
+
+  test("Verify raw request works as expected", async () => {
+    const result = await harness.action("rawRequest", {
+      acmeConnection,
+      url: "/items",
+      method: "get",
+      responseType: "json",
+      queryParams: [{ key: "id", value: "2" }],
+    });
+    expect(result?.data).toStrictEqual([expectedItems[1]]);
+  });
 });

package/lib/templates/component/src/actions.ts.ejs

@@ -9,6 +9,10 @@
  */
 
 import { action, input, util } from "@prismatic-io/spectral";
+import {
+  inputs as httpClientInputs,
+  sendRawRequest,
+} from "@prismatic-io/spectral/dist/clients/http";
 import { createAcmeClient } from "./client";
 
 interface Item {
@@ -124,4 +128,30 @@ const addItem = action({
   },
 });
 
-export default { addItem, getItem, listItems };
+const rawRequest = action({
+  display: {
+    label: "Raw Request",
+    description: "Send an HTTP request to any Acme endpoint",
+  },
+  inputs: {
+    acmeConnection: connectionInput,
+    ...httpClientInputs,
+    url: {
+      // Optional; this adds component-specific instructions to the URL input
+      ...httpClientInputs.url,
+      comments:
+        "The base URL from your connection is already included (https://my-json-server.typicode.com/prismatic-io/placeholder-data). For example, to connect to https://my-json-server.typicode.com/prismatic-io/placeholder-data/items, only /items is entered in this field.",
+      example: "/items",
+    },
+  },
+  perform: async (context, { acmeConnection, ...httpClientInputs }) => {
+    const { data } = await sendRawRequest(
+      util.types.toString(acmeConnection.fields.baseUrl),
+      httpClientInputs,
+      { Authorization: `Bearer ${acmeConnection.fields.apiKey}` }, // Authorization methods vary by API
+    );
+    return { data };
+  },
+});
+
+export default { addItem, getItem, listItems, rawRequest };

package/lib/templates/component/src/connections.ts.ejs

@@ -13,7 +13,7 @@
 
 import { connection } from "@prismatic-io/spectral";
 
-export const apiKeyConnection = connection({
+export const acmeApiKey = connection({
   key: "apiKey",
   display: {
     label: "Acme Connection",
@@ -24,8 +24,7 @@ export const apiKeyConnection = connection({
       label: "Acme Base URL",
       type: "string",
       required: true,
-      default:
-        "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
+      default: "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
       example: "https://my-company.api.acme.com/",
     },
     apiKey: {
@@ -38,4 +37,4 @@ export const apiKeyConnection = connection({
   },
 });
 
-export default [apiKeyConnection];
+export default [acmeApiKey];

package/lib/templates/component/src/dataSources.test.ts.ejs

@@ -9,16 +9,13 @@
  * https://prismatic.io/docs/custom-connectors/unit-testing/
  */
 
-import {
-  createConnection,
-  createHarness,
-} from "@prismatic-io/spectral/dist/testing";
+import { createConnection, createHarness } from "@prismatic-io/spectral/dist/testing";
 import myComponent from ".";
-import { apiKeyConnection } from "./connections";
+import { acmeApiKey } from "./connections";
 
 const harness = createHarness(myComponent);
 
-const acmeConnection = createConnection(apiKeyConnection, {
+const acmeConnection = createConnection(acmeApiKey, {
   baseUrl: "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
   apiKey: "P@s$W0rD",
 });

package/lib/templates/component/src/dataSources.ts.ejs

@@ -24,8 +24,7 @@ interface Item {
 export const selectItem = dataSource({
   display: {
     label: "Select Item",
-    description:
-      "This data source fetches a list of items, and presents them as a dropdown menu",
+    description: "This data source fetches a list of items, and presents them as a dropdown menu",
   },
   dataSourceType: "picklist",
   inputs: {

package/lib/templates/component/src/triggers.test.ts.ejs

@@ -15,11 +15,11 @@ import {
   defaultTriggerPayload,
 } from "@prismatic-io/spectral/dist/testing";
 import myComponent from ".";
-import { apiKeyConnection } from "./connections";
+import { acmeApiKey } from "./connections";
 
 const harness = createHarness(myComponent);
 
-const acmeConnection = createConnection(apiKeyConnection, {
+const acmeConnection = createConnection(acmeApiKey, {
   baseUrl: "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
   apiKey: "P@s$W0rD",
 });
@@ -37,9 +37,7 @@ describe("Test Trigger", () => {
       acmeConnection,
     });
 
-    expect(result?.payload.rawBody.data).toEqual(
-      JSON.stringify({ foo: "bar", baz: "buz" })
-    );
+    expect(result?.payload.rawBody.data).toEqual(JSON.stringify({ foo: "bar", baz: "buz" }));
   });
 
   test("Test invalid HMAC signature", async () => {

package/lib/templates/component/src/triggers.ts.ejs

@@ -24,9 +24,7 @@ export const exampleTrigger = trigger({
     }),
   },
   perform: async (context, payload, params) => {
-    const hmacSecretKey = util.types.toString(
-      params.acmeConnection.fields.apiKey
-    );
+    const hmacSecretKey = util.types.toString(params.acmeConnection.fields.apiKey);
     const { "x-hmac-256": hmacSignature } = payload.headers;
 
     // Compute the HMAC hash of the request using the connection's API key

package/lib/templates/integration/.spectral/index.ts.ejs

@@ -1,37 +1,37 @@
 import type { ComponentManifest, ConfigPage, ScopedConfigVar } from "@prismatic-io/spectral";
 
 // @ts-ignore
-import type { configPages, componentRegistry, userLevelConfigPages, scopedConfigVars } from "../src";
+import type {
+  configPages,
+  componentRegistry,
+  userLevelConfigPages,
+  scopedConfigVars,
+} from "../src";
 
 type IsAny<T> = 0 extends 1 & T ? true : false;
 
-type TConfigPages =
-  IsAny<typeof configPages> extends true
-    ? { [key: string]: ConfigPage }
-    : typeof configPages;
+type TConfigPages = IsAny<typeof configPages> extends true
+  ? { [key: string]: ConfigPage }
+  : typeof configPages;
 
-type TUserLevelConfigPages =
-  IsAny<typeof userLevelConfigPages> extends true
-    ? { [key: string]: ConfigPage }
-    : typeof userLevelConfigPages;
+type TUserLevelConfigPages = IsAny<typeof userLevelConfigPages> extends true
+  ? { [key: string]: ConfigPage }
+  : typeof userLevelConfigPages;
 
-type TComponentRegistry =
-  IsAny<typeof componentRegistry> extends true
-    ? { [key: string]: ComponentManifest }
-    : typeof componentRegistry;
+type TComponentRegistry = IsAny<typeof componentRegistry> extends true
+  ? { [key: string]: ComponentManifest }
+  : typeof componentRegistry;
 
-type TScopedConfigVarMap =
-  IsAny<typeof scopedConfigVars> extends true
-    ? { [key: string]: ScopedConfigVar }
-    : typeof scopedConfigVars;
+type TScopedConfigVarMap = IsAny<typeof scopedConfigVars> extends true
+  ? { [key: string]: ScopedConfigVar }
+  : typeof scopedConfigVars;
 
 declare module "@prismatic-io/spectral" {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface IntegrationDefinitionConfigPages extends TConfigPages {}
 
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
-  interface IntegrationDefinitionUserLevelConfigPages
-    extends TUserLevelConfigPages {}
+  interface IntegrationDefinitionUserLevelConfigPages extends TUserLevelConfigPages {}
 
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface IntegrationDefinitionComponentRegistry extends TComponentRegistry {}
@@ -39,4 +39,3 @@ declare module "@prismatic-io/spectral" {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface IntegrationDefinitionScopedConfigVars extends TScopedConfigVarMap {}
 }
-

package/lib/templates/integration/src/configPages.ts.ejs

@@ -36,8 +36,7 @@ export const configPages = {
             label: "Acme Base URL",
             type: "string",
             required: true,
-            default:
-              "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
+            default: "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
             example: "https://my-company.api.acme.com/",
           },
           apiKey: {
@@ -62,9 +61,7 @@ export const configPages = {
         dataSourceType: "picklist",
         perform: async (context) => {
           // Create an authenticated reusable HTTP client from client.ts
-          const client = createAcmeClient(
-            context.configVars["Acme Connection"] as Connection
-          );
+          const client = createAcmeClient(context.configVars["Acme Connection"] as Connection);
           const { data: items } = await client.get<Item[]>("/items");
           const options: Element[] = items.map((item) => ({
             key: `${item.id}`,

package/lib/templates/integration/src/flows.test.ts.ejs

@@ -14,8 +14,7 @@ import { listItems } from "./flows";
 
 const acmeConnection = {
   fields: {
-    baseUrl:
-      "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
+    baseUrl: "https://my-json-server.typicode.com/prismatic-io/placeholder-data",
     apiKey: "P@s$W0rD",
   },
 };
@@ -37,10 +36,8 @@ describe("Verify flow works as expected", () => {
       configVars: { "Acme Connection": acmeConnection, "Select Item": "2" },
     });
     expect(loggerMock.info).toHaveBeenCalledWith(
-      'During configuration, the customer selected the item "2"'
-    );
-    expect(loggerMock.info).toHaveBeenCalledWith(
-      'Item "Widgets" with ID "1" has quantity "20"'
+      'During configuration, the customer selected the item "2"',
     );
+    expect(loggerMock.info).toHaveBeenCalledWith('Item "Widgets" with ID "1" has quantity "20"');
   });
 });

package/lib/templates/integration/src/flows.ts.ejs

@@ -26,21 +26,19 @@ export const listItems = flow({
   },
   onExecution: async (context, params) => {
     context.logger.info(
-      `During configuration, the customer selected the item "${context.configVars["Select Item"]}"`
+      `During configuration, the customer selected the item "${context.configVars["Select Item"]}"`,
     );
 
     // Create an authenticated reusable HTTP client from client.ts
-    const acmeErpClient = createAcmeClient(
-      context.configVars["Acme Connection"] as Connection
-    );
+    const acmeErpClient = createAcmeClient(context.configVars["Acme Connection"] as Connection);
     const response = await acmeErpClient.get<Item[]>("/items");
     for (const item of response.data) {
       context.logger.info(
-        `Item "${item.name}" with ID "${item.id}" has quantity "${item.quantity}"`
+        `Item "${item.name}" with ID "${item.id}" has quantity "${item.quantity}"`,
       );
     }
     return { data: response.data };
   },
 });
 
-export default [listItems];
+export default [listItems];

package/lib/templates/yaml/.spectral/index.ts.ejs

@@ -1,37 +1,37 @@
 import type { ComponentManifest, ConfigPage, ScopedConfigVar } from "@prismatic-io/spectral";
 
 // @ts-ignore
-import type { configPages, componentRegistry, userLevelConfigPages, scopedConfigVars } from "../src";
+import type {
+  configPages,
+  componentRegistry,
+  userLevelConfigPages,
+  scopedConfigVars,
+} from "../src";
 
 type IsAny<T> = 0 extends 1 & T ? true : false;
 
-type TConfigPages =
-  IsAny<typeof configPages> extends true
-    ? { [key: string]: ConfigPage }
-    : typeof configPages;
+type TConfigPages = IsAny<typeof configPages> extends true
+  ? { [key: string]: ConfigPage }
+  : typeof configPages;
 
-type TUserLevelConfigPages =
-  IsAny<typeof userLevelConfigPages> extends true
-    ? { [key: string]: ConfigPage }
-    : typeof userLevelConfigPages;
+type TUserLevelConfigPages = IsAny<typeof userLevelConfigPages> extends true
+  ? { [key: string]: ConfigPage }
+  : typeof userLevelConfigPages;
 
-type TComponentRegistry =
-  IsAny<typeof componentRegistry> extends true
-    ? { [key: string]: ComponentManifest }
-    : typeof componentRegistry;
+type TComponentRegistry = IsAny<typeof componentRegistry> extends true
+  ? { [key: string]: ComponentManifest }
+  : typeof componentRegistry;
 
-type TScopedConfigVarMap =
-  IsAny<typeof scopedConfigVars> extends true
-    ? { [key: string]: ScopedConfigVar }
-    : typeof scopedConfigVars;
+type TScopedConfigVarMap = IsAny<typeof scopedConfigVars> extends true
+  ? { [key: string]: ScopedConfigVar }
+  : typeof scopedConfigVars;
 
 declare module "@prismatic-io/spectral" {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface IntegrationDefinitionConfigPages extends TConfigPages {}
 
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
-  interface IntegrationDefinitionUserLevelConfigPages
-    extends TUserLevelConfigPages {}
+  interface IntegrationDefinitionUserLevelConfigPages extends TUserLevelConfigPages {}
 
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface IntegrationDefinitionComponentRegistry extends TComponentRegistry {}
@@ -39,4 +39,3 @@ declare module "@prismatic-io/spectral" {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface IntegrationDefinitionScopedConfigVars extends TScopedConfigVarMap {}
 }
-

package/oclif.manifest.json

@@ -5346,5 +5346,5 @@
       "enableJsonFlag": false
     }
   },
-  "version": "7.3.1-rc.0"
+  "version": "7.3.1-rc.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prismatic-io/prism",
-  "version": "7.3.1-rc.0",
+  "version": "7.3.1-rc.1",
   "description": "Build, deploy, and support integrations in Prismatic from the comfort of your command line",
   "keywords": ["prismatic", "cli"],
   "homepage": "https://prismatic.io",