@prismatic-io/prism 5.2.11 → 6.0.0-preview1

package/lib/templates/action/action.ts.ejs

@@ -0,0 +1,33 @@
+import { action, input } from "@prismatic-io/spectral";
+import { createClient } from "./client";
+
+const myConnectionField = input({
+  label: "Connection",
+  type: "connection",
+  required: true,
+});
+
+const myInputField = input({
+  label: "My Input",
+  type: "string",
+  required: true,
+});
+
+export const <%= action.key %> = action({
+  display: {
+    label: "<%= action.label %>",
+    description: "<%= action.description %>",
+  },
+  perform: async (context, { connection, myInput }) => {
+    const client = createClient(connection);
+    return {
+      data: await client.call(myInput),
+    };
+  },
+  inputs: {
+    connection: myConnectionField,
+    myInput: myInputField,
+  },
+});
+
+export default { <%= action.key %> };

package/lib/templates/component/jest.config.js.ejs

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/lib/templates/component/package.json.ejs

@@ -0,0 +1,6 @@
+{
+  "name": "<%= component.name %>",
+  "version": "0.0.1",
+  "main": "index.js",
+  "private": true
+}

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

@@ -0,0 +1,10 @@
+import { Connection } from "@prismatic-io/spectral";
+
+export const createClient = (connection: Connection) => {
+  // Create a client using the provided Connection for the
+  // service you're consuming from this Component.
+  return {
+    call: async (name: unknown) =>
+      Promise.resolve(`Hello, ${name} using connection ${connection.key}`),
+  };
+};

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

@@ -0,0 +1,47 @@
+import { myAction } from "./actions";
+import { myTrigger } from "./triggers";
+import { myDataSource } from "./dataSources";
+import { myConnection } from "./connections";
+import {
+  invoke,
+  invokeTrigger,
+  invokeDataSource,
+  defaultTriggerPayload,
+  createConnection,
+} from "@prismatic-io/spectral/dist/testing";
+
+describe("test my action", () => {
+  test("verify the return value of my action", async () => {
+    const { result } = await invoke(myAction, {
+      connection: createConnection(myConnection, {
+        username: process.env.MY_APP_USERNAME, // A username saved as an environment variable
+        password: process.env.MY_APP_PASSWORD, // A password saved as an environment variable
+      }),
+      myInput: "some input",
+    });
+    expect(result.data).toBe("Hello, some input using connection myConnection");
+  });
+});
+
+describe("test my trigger", () => {
+  test("verify the return value of my trigger", async () => {
+    const expectedPayload = defaultTriggerPayload();
+    const {
+      result: { payload },
+    } = await invokeTrigger(myTrigger, {}, defaultTriggerPayload());
+    expect(payload).toStrictEqual(expectedPayload);
+  });
+});
+
+describe("test my data source", () => {
+  test("verify the return value of my data source", async () => {
+    const { result } = await invokeDataSource(myDataSource, {
+      connection: createConnection(myConnection, {
+        username: process.env.MY_APP_USERNAME, // A username saved as an environment variable
+        password: process.env.MY_APP_PASSWORD, // A password saved as an environment variable
+      }),
+      myInput: "some input",
+    });
+    expect(result).toBe("Hello, some input using connection myConnection");
+  });
+});

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

@@ -0,0 +1,19 @@
+import { component } from "@prismatic-io/spectral";
+import actions from "./actions";
+import triggers from "./triggers";
+import dataSources from "./dataSources";
+import connections from "./connections";
+
+export default component({
+  key: "<%= component.key %>",
+  public: false,
+  display: {
+    label: "<%= component.name %>",
+    description: "<%= component.description %>",
+    iconPath: "icon.png",
+  },
+  actions,
+  triggers,
+  dataSources,
+  connections,
+});

package/lib/templates/component/tsconfig.json.ejs

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["esnext"],
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node"
+  },
+  "include": ["src"]
+}

package/lib/templates/component/webpack.config.js.ejs

@@ -0,0 +1,36 @@
+const path = require("path");
+const CopyPlugin = require("copy-webpack-plugin");
+
+module.exports = {
+  mode: "production",
+  target: "node",
+  plugins: [
+    new CopyPlugin({
+      patterns: [{ from: "assets", to: path.resolve(__dirname, "dist") }],
+    }),
+  ],
+  module: {
+    rules: [
+      {
+        sideEffects: false,
+      },
+      {
+        test: /\.ts/,
+        use: "ts-loader",
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    extensions: [".ts", ".js"],
+  },
+  optimization: {
+    usedExports: true,
+  },
+  entry: "./src/index.ts",
+  output: {
+    filename: "index.js",
+    path: path.resolve(__dirname, "dist"),
+    libraryTarget: "commonjs2",
+  },
+};

package/lib/templates/connection/basic.ts.ejs

@@ -0,0 +1,25 @@
+import { connection } from "@prismatic-io/spectral";
+
+export const <%= connection.key %> = connection({
+  key: "<%= connection.key %>",
+  label: "<%= connection.label %>",
+  comments: "<%= connection.comments %>",
+  inputs: {
+    username: {
+      label: "Username",
+      placeholder: "Username",
+      type: "string",
+      required: true,
+      comments: "Username for my Connection",
+    },
+    password: {
+      label: "Password",
+      placeholder: "Password",
+      type: "password",
+      required: true,
+      comments: "Password for my Connection",
+    },
+  },
+});
+
+export default [<%= connection.key %>];

package/lib/templates/connection/oauth.ts.ejs

@@ -0,0 +1,65 @@
+import {
+	connection,
+  oauth2Connection,
+  OAuth2Type,
+} from "@prismatic-io/spectral";
+
+export const <%= connection.key %> = oauth2Connection({
+  key: "<%= connection.key %>",
+  label: "<%= connection.label %>",
+  comments: "<%= connection.comments %>",
+  oauth2Type: OAuth2Type.AuthorizationCode,
+  inputs: {
+    authorizeUrl: {
+      label: "Authorize URL",
+      placeholder: "Authorize URL",
+      type: "string",
+      required: true,
+      shown: true,
+      comments: "The OAuth 2.0 Authorization URL for the API",
+    },
+    tokenUrl: {
+      label: "Token URL",
+      placeholder: "Token URL",
+      type: "string",
+      required: true,
+      shown: true,
+      comments: "The OAuth 2.0 Token URL for the API",
+    },
+    scopes: {
+      label: "Scopes",
+      placeholder: "Scopes",
+      type: "string",
+      required: false,
+      shown: true,
+      comments: "Space separated OAuth 2.0 permission scopes for the API",
+      default: "",
+    },
+    clientId: {
+      label: "Client ID",
+      placeholder: "Client ID",
+      type: "string",
+      required: true,
+      shown: true,
+      comments: "Client Identifier of your app for the API",
+    },
+    clientSecret: {
+      label: "Client Secret",
+      placeholder: "Client Secret",
+      type: "password",
+      required: true,
+      shown: true,
+      comments: "Client Secret of your app for the API",
+    },
+    headers: {
+      label: "Headers",
+      type: "string",
+      collection: "keyvaluelist",
+      required: false,
+      shown: true,
+      comments: "Additional header to supply to authorization requests",
+    },
+  },
+});
+
+export default [<%= connection.key %>];

package/lib/templates/dataSource/dataSource.ts.ejs

@@ -0,0 +1,34 @@
+import { dataSource, input } from "@prismatic-io/spectral";
+import { createClient } from "./client";
+
+const myConnectionField = input({
+  label: "Connection",
+  type: "connection",
+  required: true,
+});
+
+const myInputField = input({
+  label: "My Input",
+  type: "string",
+  required: true,
+});
+
+export const <%= dataSource.key %> = dataSource({
+  display: {
+    label: "<%= dataSource.label %>",
+    description: "<%= dataSource.description %>",
+  },
+  perform: async (context, { connection, myInput }) => {
+    const client = createClient(connection);
+    return {
+      result: await client.call(myInput),
+    };
+  },
+  inputs: {
+    connection: myConnectionField,
+    myInput: myInputField,
+  },
+  dataSourceType: "string",
+});
+
+export default { <%= dataSource.key %> };

package/lib/templates/flow/flow.ts.ejs

@@ -0,0 +1,37 @@
+import { flow } from "@prismatic-io/spectral";
+import { createClient } from "./client";
+import type { ConfigPages } from "./configPages";
+
+export const <%= flow.key %> = flow<ConfigPages>({
+  name: "<%= flow.name %>",
+  stableKey: "<%= flow.stableKey %>",
+  description: "<%= flow.description %>",
+  onTrigger: async (context, payload, params) => {
+    const { logger } = context;
+
+    logger.info(`Trigger context: ${JSON.stringify(context)}`);
+    logger.info(`Trigger payload: ${JSON.stringify(payload)}`);
+    logger.info(`Trigger params: ${JSON.stringify(params)}`);
+
+    return Promise.resolve({
+      payload,
+    });
+  },
+  onExecution: async (context, params) => {
+    const { logger, configVars } = context;
+
+    if (!configVars?.connection1) {
+      throw new Error("Missing connection1 configuration");
+    }
+
+    logger.info(`Action context: ${JSON.stringify(context)}`);
+    logger.info(`Action params: ${JSON.stringify(params)}`);
+
+    const client = createClient(configVars.connection1);
+    return {
+      data: await client.call("<%= flow.name %>"),
+    };
+  },
+});
+
+export default [<%= flow.key %>];

package/lib/templates/formats/jest.config.js.ejs

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/lib/templates/formats/tsconfig.json.ejs

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["esnext"],
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node"
+  },
+  "include": ["src"]
+}

package/lib/templates/formats/webpack.config.js.ejs

@@ -0,0 +1,36 @@
+const path = require("path");
+const CopyPlugin = require("copy-webpack-plugin");
+
+module.exports = {
+  mode: "production",
+  target: "node",
+  plugins: [
+    new CopyPlugin({
+      patterns: [{ from: "assets", to: path.resolve(__dirname, "dist") }],
+    }),
+  ],
+  module: {
+    rules: [
+      {
+        sideEffects: false,
+      },
+      {
+        test: /\.ts/,
+        use: "ts-loader",
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    extensions: [".ts", ".js"],
+  },
+  optimization: {
+    usedExports: true,
+  },
+  entry: "./src/index.ts",
+  output: {
+    filename: "index.js",
+    path: path.resolve(__dirname, "dist"),
+    libraryTarget: "commonjs2",
+  },
+};

package/lib/templates/integration/basic.ts.ejs

@@ -0,0 +1,29 @@
+import { configPage, connectionConfigVar } from "@prismatic-io/spectral";
+
+export const configPages = {
+  Connections: configPage({
+    elements: {
+      "<%= configVar.key %>": connectionConfigVar({
+        stableKey: "<%= configVar.stableKey %>",
+        inputs: {
+          username: {
+            label: "Username",
+            placeholder: "Username",
+            type: "string",
+            required: true,
+            comments: "Username for my Connection",
+          },
+          password: {
+            label: "Password",
+            placeholder: "Password",
+            type: "password",
+            required: true,
+            comments: "Password for my Connection",
+          },
+        },
+      }),
+    },
+  }),
+};
+
+export type ConfigPages = typeof configPages;

package/lib/templates/integration/jest.config.js.ejs

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/lib/templates/integration/oauth.ts.ejs

@@ -0,0 +1,69 @@
+import {
+  configPage,
+  connectionConfigVar,
+  OAuth2Type,
+} from "@prismatic-io/spectral";
+
+export const configPages = {
+  Connections: configPage({
+    elements: {
+      "<%= configVar.key %>": connectionConfigVar({
+        stableKey: "<%= configVar.stableKey %>",
+        oauth2Type: OAuth2Type.AuthorizationCode,
+        inputs: {
+          authorizeUrl: {
+            label: "Authorize URL",
+            placeholder: "Authorize URL",
+            type: "string",
+            required: true,
+            shown: true,
+            comments: "The OAuth 2.0 Authorization URL for the API",
+          },
+          tokenUrl: {
+            label: "Token URL",
+            placeholder: "Token URL",
+            type: "string",
+            required: true,
+            shown: true,
+            comments: "The OAuth 2.0 Token URL for the API",
+          },
+          scopes: {
+            label: "Scopes",
+            placeholder: "Scopes",
+            type: "string",
+            required: false,
+            shown: true,
+            comments: "Space separated OAuth 2.0 permission scopes for the API",
+            default: "",
+          },
+          clientId: {
+            label: "Client ID",
+            placeholder: "Client ID",
+            type: "string",
+            required: true,
+            shown: true,
+            comments: "Client Identifier of your app for the API",
+          },
+          clientSecret: {
+            label: "Client Secret",
+            placeholder: "Client Secret",
+            type: "password",
+            required: true,
+            shown: true,
+            comments: "Client Secret of your app for the API",
+          },
+          headers: {
+            label: "Headers",
+            type: "string",
+            collection: "keyvaluelist",
+            required: false,
+            shown: true,
+            comments: "Additional header to supply to authorization requests",
+          },
+        },
+      }),
+    },
+  }),
+};
+
+export type ConfigPages = typeof configPages;

package/lib/templates/integration/package.json.ejs

@@ -0,0 +1,6 @@
+{
+  "name": "<%= integration.name %>",
+  "version": "0.0.1",
+  "main": "index.js",
+  "private": true
+}

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

@@ -0,0 +1,10 @@
+import { Connection } from "@prismatic-io/spectral";
+
+export const createClient = (connection: Connection) => {
+  // Create a client using the provided Connection for the
+  // service you're consuming from this Integration.
+  return {
+    call: async (name: unknown) =>
+      Promise.resolve(`Hello, ${name} using connection ${connection.key}`),
+  };
+};

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

@@ -0,0 +1,18 @@
+import { flow1 } from "./flows";
+import { invokeFlow } from "@prismatic-io/spectral/dist/testing";
+
+describe("test my flow", () => {
+  test("verify the return value of my flow", async () => {
+    const { result } = await invokeFlow(flow1, {
+      connection1: {
+        fields: {
+          username: process.env.MY_APP_USERNAME, // A username saved as an environment variable
+          password: process.env.MY_APP_PASSWORD, // A password saved as an environment variable
+        },
+      },
+    });
+    expect(result?.data).toBe(
+      "Hello, <%= flow.name %> using connection connection1",
+    );
+  });
+});

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

@@ -0,0 +1,11 @@
+import { integration } from "@prismatic-io/spectral";
+import flows from "./flows";
+import { configPages } from "./configPages";
+
+export default integration({
+  name: "<%= integration.name %>",
+  description: "<%= integration.description %>",
+  iconPath: "icon.png",
+  flows,
+  configPages,
+});

package/lib/templates/integration/tsconfig.json.ejs

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["esnext"],
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node"
+  },
+  "include": ["src"]
+}

package/lib/templates/integration/webpack.config.js.ejs

@@ -0,0 +1,36 @@
+const path = require("path");
+const CopyPlugin = require("copy-webpack-plugin");
+
+module.exports = {
+  mode: "production",
+  target: "node",
+  plugins: [
+    new CopyPlugin({
+      patterns: [{ from: "assets", to: path.resolve(__dirname, "dist") }],
+    }),
+  ],
+  module: {
+    rules: [
+      {
+        sideEffects: false,
+      },
+      {
+        test: /\.ts/,
+        use: "ts-loader",
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    extensions: [".ts", ".js"],
+  },
+  optimization: {
+    usedExports: true,
+  },
+  entry: "./src/index.ts",
+  output: {
+    filename: "index.js",
+    path: path.resolve(__dirname, "dist"),
+    libraryTarget: "commonjs2",
+  },
+};

package/lib/templates/trigger/trigger.ts.ejs

@@ -0,0 +1,19 @@
+import { trigger } from "@prismatic-io/spectral";
+
+export const <%= trigger.key %> = trigger({
+  display: {
+    label: "<%= trigger.label %>",
+    description: "<%= trigger.description %>",
+  },
+  perform: async (context, payload, params) => {
+    console.log("<%= trigger.label %> params", params);
+    return Promise.resolve({
+      payload,
+    });
+  },
+  inputs: {},
+  synchronousResponseSupport: "valid",
+  scheduleSupport: "valid",
+});
+
+export default { <%= trigger.key %> };