Merge pull request #3816 from MoShizzle/interface-trigger

feat: interfaces trigger poc

package.json

@@ -124,6 +124,7 @@
     "lottie-web": "5.12.2",
     "mailparser": "3.6.7",
     "marked": "4.3.0",
+    "mime": "4.0.1",
     "mime-types": "2.1.35",
     "monaco-editor": "0.34.1",
     "monday-sdk-js": "0.5.2",

packages/backend/src/app/helper/package-manager.ts

@@ -58,6 +58,7 @@ export const packageManager = {
 
         const config = [
             '--prefer-offline',
+            '--ignore-scripts',
             '--config.lockfile=false',
             '--config.auto-install-peers=true',
         ]

packages/pieces/community/interfaces/.eslintrc.json

@@ -0,0 +1,33 @@
+{
+  "extends": [
+    "../../../../.eslintrc.json"
+  ],
+  "ignorePatterns": [
+    "!**/*"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.ts",
+        "*.tsx",
+        "*.js",
+        "*.jsx"
+      ],
+      "rules": {}
+    },
+    {
+      "files": [
+        "*.ts",
+        "*.tsx"
+      ],
+      "rules": {}
+    },
+    {
+      "files": [
+        "*.js",
+        "*.jsx"
+      ],
+      "rules": {}
+    }
+  ]
+}

packages/pieces/community/interfaces/README.md

@@ -0,0 +1,7 @@
+# pieces-interfaces
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build pieces-interfaces` to build the library.

packages/pieces/community/interfaces/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@activepieces/piece-interfaces",
+  "version": "0.0.1"
+}

packages/pieces/community/interfaces/project.json

@@ -0,0 +1,43 @@
+{
+  "name": "pieces-interfaces",
+  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/pieces/community/interfaces/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": [
+        "{options.outputPath}"
+      ],
+      "options": {
+        "outputPath": "dist/packages/pieces/community/interfaces",
+        "tsConfig": "packages/pieces/community/interfaces/tsconfig.lib.json",
+        "packageJson": "packages/pieces/community/interfaces/package.json",
+        "main": "packages/pieces/community/interfaces/src/index.ts",
+        "assets": [
+          "packages/pieces/community/interfaces/*.md"
+        ],
+        "buildableProjectDepsInPackageJsonType": "dependencies",
+        "updateBuildableProjectDepsInPackageJson": true
+      }
+    },
+    "publish": {
+      "command": "node tools/scripts/publish.mjs pieces-interfaces {args.ver} {args.tag}",
+      "dependsOn": [
+        "build"
+      ]
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": [
+        "{options.outputFile}"
+      ],
+      "options": {
+        "lintFilePatterns": [
+          "packages/pieces/community/interfaces/**/*.ts"
+        ]
+      }
+    }
+  },
+  "tags": []
+}

packages/pieces/community/interfaces/src/index.ts

@@ -0,0 +1,14 @@
+import { createPiece, PieceAuth } from '@activepieces/pieces-framework';
+import { returnFile } from './lib/actions/return-file';
+import { returnMarkdown } from './lib/actions/return-markdown';
+import { onFormSubmission } from './lib/triggers/interface-trigger';
+
+export const interfaces = createPiece({
+  displayName: 'Interfaces',
+  auth: PieceAuth.None(),
+  minimumSupportedRelease: '0.9.0',
+  logoUrl: 'https://cdn.activepieces.com/pieces/interfaces.png',
+  authors: ['MoShizzle'],
+  actions: [returnFile, returnMarkdown],
+  triggers: [onFormSubmission],
+});

packages/pieces/community/interfaces/src/lib/actions/return-file.ts

@@ -0,0 +1,43 @@
+import { Property, createAction } from '@activepieces/pieces-framework';
+import { FileResponseInterface } from '@activepieces/shared';
+import { StatusCodes } from 'http-status-codes';
+import mimeTypes from 'mime-types';
+export const returnFile = createAction({
+  name: 'return_file',
+  displayName: 'Respond with a file',
+  description: 'Download a file as a response.',
+  props: {
+    file: Property.File({
+      displayName: 'File',
+      required: true,
+    }),
+  },
+  async run({ propsValue, run }) {
+    const fileName = propsValue.file.filename;
+    const fileExtension = propsValue.file.extension;
+    const fileBase64 = propsValue.file.base64;
+
+    const mimeType = fileExtension ? mimeTypes.lookup(fileExtension) : 'application/octet-stream';
+    const base64Url = `data:${mimeType};base64,${fileBase64}`;
+
+    const value: FileResponseInterface = {
+      base64Url,
+      fileName,
+      extension: fileExtension,
+
+    }
+    const response = {
+      status: StatusCodes.OK,
+      body: {
+        type: 'file',
+        value,
+      },
+      headers: {},
+    };
+
+    run.stop({
+      response: response,
+    });
+    return response;
+  },
+});

packages/pieces/community/interfaces/src/lib/actions/return-markdown.ts

@@ -0,0 +1,31 @@
+import { Property, createAction } from '@activepieces/pieces-framework';
+import { StatusCodes } from 'http-status-codes';
+
+export const returnMarkdown = createAction({
+  name: 'return_markdown',
+  displayName: 'Respond with a Markdown',
+  description: 'Display a markdown as a response.',
+  props: {
+    markdown: Property.LongText({
+      displayName: 'Markdown',
+      required: true,
+    }),
+  },
+
+  async run({ propsValue, run }) {
+
+    const response = {
+      status: StatusCodes.OK,
+      body: {
+        type: 'markdown',
+        value: propsValue.markdown,
+      },
+      headers: {},
+    };
+
+    run.stop({
+      response: response,
+    });
+    return response;
+  },
+});

packages/pieces/community/interfaces/src/lib/triggers/interface-trigger.ts

@@ -0,0 +1,66 @@
+import {
+  Property,
+  TriggerStrategy,
+  createTrigger,
+} from '@activepieces/pieces-framework';
+
+const markdown = `
+Go to this URL to see the interface: \n
+\`{{interfaceUrl}}\`
+`;
+
+export const onFormSubmission = createTrigger({
+  name: 'form_submission',
+  displayName: 'On Form Submission',
+  description: 'Trigger the flow by submitting a form.',
+  props: {
+    about: Property.MarkDown({
+      value: markdown,
+    }),
+    inputs: Property.Array({
+      displayName: 'Inputs',
+      required: true,
+      properties: {
+        displayName: Property.ShortText({
+          displayName: 'Field Name',
+          required: true,
+        }),
+        type: Property.StaticDropdown({
+          displayName: 'Field Type',
+          required: true,
+          options: {
+            options: [
+              { value: 'text', label: 'Text' },
+              { value: 'file', label: 'File' },
+            ],
+          },
+        }),
+        description: Property.ShortText({
+          displayName: 'Field Description',
+          required: false,
+        }),
+        required: Property.Checkbox({
+          displayName: 'Required',
+          required: true,
+        }),
+      },
+    }),
+    waitForResponse: Property.Checkbox({
+      displayName: 'Wait for Response',
+      description:
+        'If enabled, the interface will return the flow output to the frontend. Make sure to use the Return Response action to return a response.',
+      required: true,
+    }),
+  },
+  sampleData: {},
+  type: TriggerStrategy.WEBHOOK,
+  async onEnable() {
+    return;
+  },
+  async onDisable() {
+    return;
+  },
+  async run(context) {
+    return [context.payload.body];
+  },
+});

packages/pieces/community/interfaces/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "../../../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    }
+  ]
+}

packages/pieces/community/interfaces/tsconfig.lib.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../../../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"],
+  "include": ["src/**/*.ts"]
+}

packages/shared/src/index.ts

@@ -50,6 +50,7 @@ export * from './lib/flows/dto/flow-template-request'
 export * from './lib/flows'
 export * from './lib/flows/dto/list-flows-request'
 export * from './lib/project/project'
+export { FileResponseInterface } from './lib/interfaces'
 import { TypeSystem } from '@sinclair/typebox/system'
 export { RetryFlowRequestBody } from './lib/flow-run/test-flow-run-request'
 export * from './lib/flows/dto/flow-template-request'

packages/shared/src/lib/interfaces/index.ts

@@ -0,0 +1,10 @@
+import { Static, Type } from '@sinclair/typebox'
+
+
+export const FileResponseInterface = Type.Object({
+    base64Url: Type.String(),
+    fileName: Type.String(),
+    extension: Type.Optional(Type.String()),
+})
+
+export type FileResponseInterface = Static<typeof FileResponseInterface>