@prismatic-io/prism 3.3.0 → 4.2.0

package/templates/component/openapi/request.ts

@@ -1,161 +0,0 @@
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-// @ts-ignore
-import FormData from "form-data";
-import { AxiosResponse } from "axios";
-import { util } from "@prismatic-io/spectral";
-import { types } from "util";
-// @ts-ignore
-import type { ApiRequestOptions } from "./ApiRequestOptions";
-// @ts-ignore
-import { EnhancedOpenAPI } from "./OpenAPI";
-
-function isDefined<T>(
-  value: T | null | undefined
-): value is Exclude<T, null | undefined> {
-  return value !== undefined && value !== null;
-}
-
-function isString(value: any): value is string {
-  return typeof value === "string";
-}
-
-function isStringWithValue(value: any): value is string {
-  return isString(value) && value !== "";
-}
-
-function isBinary(value: any): value is Buffer | ArrayBuffer | ArrayBufferView {
-  const isBuffer = Buffer.isBuffer(value);
-  const isArrayBuffer = types.isArrayBuffer(value);
-  const isArrayBufferView = types.isArrayBufferView(value);
-  return isBuffer || isArrayBuffer || isArrayBufferView;
-}
-
-function getUrl(options: ApiRequestOptions): string {
-  const path = options.path.replace(/[:]/g, "_");
-  const url = `${EnhancedOpenAPI.BASE}${path}`;
-
-  return url;
-}
-
-function getFormData(params: Record<string, any>): FormData {
-  const formData = new FormData();
-  Object.entries(params).forEach(([key, value]) => {
-    if (isDefined(value)) {
-      formData.append(key, value);
-    }
-  });
-  return formData;
-}
-
-type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
-
-async function resolve<T>(
-  options: ApiRequestOptions,
-  resolver?: T | Resolver<T>
-): Promise<T | undefined> {
-  if (typeof resolver === "function") {
-    return (resolver as Resolver<T>)(options);
-  }
-  return resolver;
-}
-
-async function getHeaders(options: ApiRequestOptions): Promise<any> {
-  const [token, username, password, defaultHeaders] = await Promise.all([
-    resolve(options, EnhancedOpenAPI.TOKEN),
-    resolve(options, EnhancedOpenAPI.USERNAME),
-    resolve(options, EnhancedOpenAPI.PASSWORD),
-    resolve(options, EnhancedOpenAPI.HEADERS),
-  ]);
-
-  const headers = {
-    Accept: "application/json",
-    ...defaultHeaders,
-    ...options.headers,
-  };
-
-  if (EnhancedOpenAPI.timeout) {
-    headers["timeout"] = util.types.toInt(EnhancedOpenAPI.timeout);
-  }
-
-  if (isStringWithValue(token)) {
-    headers["Authorization"] = `Bearer ${token}`;
-  }
-
-  if (isStringWithValue(username) && isStringWithValue(password)) {
-    const credentials = Buffer.from(`${username}:${password}`).toString(
-      "base64"
-    );
-    headers["Authorization"] = `Basic ${credentials}`;
-  }
-
-  if (options.body) {
-    if (isBinary(options.body)) {
-      headers["Content-Type"] = "application/octet-stream";
-    } else if (isString(options.body)) {
-      headers["Content-Type"], "text/plain";
-    } else {
-      headers["Content-Type"] = "application/json";
-    }
-  }
-
-  return headers;
-}
-
-function getRequestBody(options: ApiRequestOptions) {
-  if (options.formData) {
-    return getFormData(options.formData);
-  }
-  if (options.body) {
-    if (isString(options.body) || isBinary(options.body)) {
-      return options.body;
-    } else {
-      return JSON.stringify(options.body);
-    }
-  }
-  return undefined;
-}
-interface RequestProps {
-  options: ApiRequestOptions;
-  url: string;
-}
-
-async function sendRequest({
-  options,
-  url,
-}: RequestProps): Promise<Partial<AxiosResponse>> {
-  const result = await EnhancedOpenAPI.CLIENT.request({
-    url,
-    method: options.method,
-    headers: await getHeaders(options),
-    data: getRequestBody(options),
-    params: options.query ? { ...options.query } : undefined,
-  });
-
-  return result;
-}
-
-/**
- * Request using Axios client
- * @param options The request options from the the service
- * @returns Partial<AxiosResponse> & {
-    body: AxiosResponse["data"];
-  }
- */
-export async function request(
-  options: ApiRequestOptions
-): Promise<
-  Partial<AxiosResponse> & {
-    body: AxiosResponse["data"];
-  }
-> {
-  const url = getUrl(options);
-
-  const response = await sendRequest({
-    options,
-    url,
-  });
-
-  return { ...response, body: await response.data };
-}

package/templates/component/package.json

@@ -1,24 +0,0 @@
-{
-  "name": "<<COMPONENT_NAME>>",
-  "version": "0.0.1",
-  "main": "index.js",
-  "private": true,
-  "scripts": {
-    "build": "webpack",
-    "publish": "npm run build && prism components:publish",
-    "test": "jest"
-  },
-  "dependencies": {
-    "extraDeps": ""
-  },
-  "devDependencies": {
-    "@types/jest": "26.0.24",
-    "copy-webpack-plugin": "9.0.1",
-    "jest": "27.0.6",
-    "ts-jest": "27.0.3",
-    "ts-loader": "9.2.3",
-    "typescript": "4.3.5",
-    "webpack": "5.43.0",
-    "webpack-cli": "4.7.2"
-  }
-}

package/templates/component/src/actions.ts

@@ -1,33 +0,0 @@
-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 myAction = action({
-  display: {
-    label: "My Action",
-    description: "This is my action",
-  },
-  perform: async (context, { connection, myInput }) => {
-    const client = createClient(connection);
-    return {
-      data: `Hello, ${myInput}`,
-    };
-  },
-  inputs: {
-    connection: myConnectionField,
-    myInput: myInputField,
-  },
-});
-
-export default { myAction };

package/templates/component/src/client.ts

@@ -1,7 +0,0 @@
-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 {};
-};

package/templates/component/src/connections.ts

@@ -1,25 +0,0 @@
-import { connection } from "@prismatic-io/spectral";
-
-export const myConnection = connection({
-  key: "myConnection",
-  label: "My Connection",
-  comments: "My Connection",
-  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 [myConnection];

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

@@ -1,32 +0,0 @@
-import { myAction } from "./actions";
-import { myTrigger } from "./triggers";
-import { myConnection } from "./connections";
-import {
-  invoke,
-  invokeTrigger,
-  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");
-  });
-});
-
-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);
-  });
-});

package/templates/component/src/index.ts

@@ -1,17 +0,0 @@
-import { component } from "@prismatic-io/spectral";
-import actions from "./actions";
-import triggers from "./triggers";
-import connections from "./connections";
-
-export default component({
-  key: "<<COMPONENT_NAME>>",
-  public: false,
-  display: {
-    label: "<<COMPONENT_NAME>>",
-    description: "Prism-generated Component",
-    iconPath: "icon.png",
-  },
-  actions,
-  triggers,
-  connections,
-});

package/templates/component/src/triggers.ts

@@ -1,18 +0,0 @@
-import { trigger } from "@prismatic-io/spectral";
-
-export const myTrigger = trigger({
-  display: {
-    label: "My Trigger",
-    description: "This is my trigger",
-  },
-  perform: async (context, payload, params) => {
-    return {
-      payload,
-    };
-  },
-  inputs: {},
-  synchronousResponseSupport: "valid",
-  scheduleSupport: "valid",
-});
-
-export default { myTrigger };

package/templates/component/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "lib": ["esnext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "isolatedModules": false,
-    "strictNullChecks": false,
-    "noImplicitAny": false
-  },
-  "include": ["src"]
-}

package/templates/component/webpack.config.js

@@ -1,44 +0,0 @@
-const path = require("path");
-const webpack = require("webpack");
-const CopyPlugin = require("copy-webpack-plugin");
-
-module.exports = {
-  mode: "development",
-  target: "node",
-  plugins: [
-    new CopyPlugin({
-      patterns: [
-        { from: "assets", to: path.resolve(__dirname, "dist") },
-        {
-          from: "*.wsdl",
-          to: path.resolve(__dirname, "dist"),
-          noErrorOnMissing: true,
-        },
-      ],
-    }),
-  ],
-  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",
-  },
-};