@pipedream/form_io 0.0.2 → 0.1.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Form.io API empowers developers to manage forms and submissions on Pipedream, enabling the automation of workflows that require data collection and processing. With Form.io on Pipedream, you can create, update, and fetch forms, as well as handle form submissions. This is ideal for tasks like dynamically generating forms based on user input, streamlining data collection processes, and integrating form data with other services for further analysis or action.
+
+# Example Use Cases
+
+- **Form Submission Trigger to Slack Notification**: When a new form submission is received in Form.io, trigger a Pipedream workflow to send a custom alert to a Slack channel, informing the team about the submission details.
+
+- **Dynamic Form Creation and Data Storage**: Automatically create a new form in Form.io using a Pipedream workflow whenever a specific event occurs (like a new product launch), and store the form data in a Pipedream data store for later use or analysis.
+
+- **Form Data to Google Sheets Integration**: Use Pipedream to send new Form.io submissions to Google Sheets. Each submission can be added as a new row in a sheet, providing easy access for non-technical team members to review and process the data.

package/actions/create-form/create-form.mjs

@@ -0,0 +1,101 @@
+import formIo from "../../form_io.app.mjs";
+import { parseJson } from "../../common/utils.mjs";
+
+export default {
+  key: "form_io-create-form",
+  name: "Create Form",
+  description: "Create a form or resource in Form.io. Use **List Forms** to review existing forms. The `components` prop is a JSON-string array of Form.io component schema objects. [See the documentation](https://apidocs.form.io/#c864243f-1ff5-409b-912f-de5670be9130).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    title: {
+      propDefinition: [
+        formIo,
+        "title",
+      ],
+      description: "The human-readable title of the form (e.g. `Contact Form`).",
+    },
+    name: {
+      propDefinition: [
+        formIo,
+        "name",
+      ],
+      description: "The machine name of the form (e.g. `contactform`).",
+    },
+    path: {
+      propDefinition: [
+        formIo,
+        "path",
+      ],
+      description: "The URL path for the form (e.g. `contactform`).",
+    },
+    type: {
+      propDefinition: [
+        formIo,
+        "type",
+      ],
+    },
+    components: {
+      propDefinition: [
+        formIo,
+        "components",
+      ],
+      description: "JSON-string array of Form.io component schema objects. Example: `[{\"type\":\"textfield\",\"key\":\"name\",\"label\":\"Name\",\"input\":true}]`. Parsed with JSON.parse() before sending.",
+    },
+    display: {
+      propDefinition: [
+        formIo,
+        "display",
+      ],
+    },
+    tags: {
+      propDefinition: [
+        formIo,
+        "tags",
+      ],
+    },
+    settings: {
+      propDefinition: [
+        formIo,
+        "settings",
+      ],
+      description: "JSON-string object of form settings. Example: `{\"theme\":\"default\"}`.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      title,
+      name,
+      path,
+      type,
+      components,
+      display,
+      tags,
+      settings,
+    } = this;
+
+    const response = await this.formIo.createForm({
+      $,
+      data: {
+        title,
+        name,
+        path,
+        type,
+        components: parseJson(components, "components", "array"),
+        display,
+        tags,
+        settings: parseJson(settings, "settings", "object"),
+      },
+    });
+
+    $.export("$summary", `Created form "${response.title}" (${response._id})`);
+    return response;
+  },
+};

package/actions/create-form-action/create-form-action.mjs

@@ -0,0 +1,89 @@
+import formIo from "../../form_io.app.mjs";
+import { parseJson } from "../../common/utils.mjs";
+
+export default {
+  key: "form_io-create-form-action",
+  name: "Create Form Action",
+  description: "Attach an action (e.g. email, webhook, save) to a Form.io form. Use **List Forms** to find the form ID and **List Form Actions** to review existing actions. The `settings` prop is a JSON-string object specific to the action type. Example: `actionType` `webhook`, `title` `Notify endpoint`, `handler` `[after]`, `method` `[create]`, `settings` `{\"url\":\"https://example.com/hook\",\"method\":\"post\"}` → returns the new action with its `_id`. [See the documentation](https://apidocs.form.io/#b3435953-c007-48d9-9f4c-a8e2ee717419).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+    actionType: {
+      type: "string",
+      label: "Action Type",
+      description: "The Form.io action type to attach — e.g. `webhook`, `email`, `save`, `login`, `role`. This selects which built-in action runs; it is NOT a display label (use `title` for that).",
+    },
+    title: {
+      propDefinition: [
+        formIo,
+        "title",
+      ],
+      description: "The human-readable title of the action.",
+    },
+    handler: {
+      propDefinition: [
+        formIo,
+        "handler",
+      ],
+    },
+    method: {
+      propDefinition: [
+        formIo,
+        "method",
+      ],
+    },
+    priority: {
+      propDefinition: [
+        formIo,
+        "priority",
+      ],
+    },
+    settings: {
+      propDefinition: [
+        formIo,
+        "settings",
+      ],
+      description: "JSON-string object of action-specific settings. Example: `{\"transport\":\"default\",\"from\":\"noreply@example.com\",\"to\":\"admin@example.com\",\"subject\":\"New submission\"}`. Parsed from a JSON string before sending.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      formId,
+      actionType,
+      title,
+      handler,
+      method,
+      priority,
+      settings,
+    } = this;
+
+    const response = await this.formIo.createFormAction({
+      $,
+      formId,
+      data: {
+        name: actionType,
+        title,
+        handler,
+        method,
+        priority,
+        settings: parseJson(settings, "settings", "object"),
+      },
+    });
+
+    $.export("$summary", `Created form action "${response.title}" (${response._id})`);
+    return response;
+  },
+};

package/actions/create-role/create-role.mjs

@@ -0,0 +1,49 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-create-role",
+  name: "Create Role",
+  description: "Create a role in the Form.io project. Use **List Roles** to review existing roles. Example: title `Reviewer`, description `Can review submissions` → returns the new role with its `_id`. [See the documentation](https://apidocs.form.io/#5123aaee-8a9d-42f0-b46f-0bd73b0477dd).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    title: {
+      propDefinition: [
+        formIo,
+        "title",
+      ],
+      description: "The title of the role (e.g. `Manager`).",
+    },
+    description: {
+      propDefinition: [
+        formIo,
+        "description",
+      ],
+      description: "A description of the role.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      title,
+      description,
+    } = this;
+
+    const response = await this.formIo.createRole({
+      $,
+      data: {
+        title,
+        description,
+      },
+    });
+
+    $.export("$summary", `Created role "${response.title}" (${response._id})`);
+    return response;
+  },
+};

package/actions/create-submission/create-submission.mjs

@@ -0,0 +1,48 @@
+import formIo from "../../form_io.app.mjs";
+import { parseJson } from "../../common/utils.mjs";
+
+export default {
+  key: "form_io-create-submission",
+  name: "Create Submission",
+  description: "Create a submission for a Form.io form. Use **List Forms** to find the form ID. The `data` prop is a JSON-string object of field key-value pairs matching the form's component keys. [See the documentation](https://apidocs.form.io/#fe0e1c46-ec0b-9141-fa11-db6e165fdcbd).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+    data: {
+      propDefinition: [
+        formIo,
+        "data",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      formId,
+      data,
+    } = this;
+
+    const response = await this.formIo.createSubmission({
+      $,
+      formId,
+      data: {
+        data: parseJson(data, "data", "object"),
+      },
+    });
+
+    $.export("$summary", `Created submission ${response._id} for form ${formId}`);
+    return response;
+  },
+};

package/actions/delete-form/delete-form.mjs

@@ -0,0 +1,33 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-delete-form",
+  name: "Delete Form",
+  description: "Permanently delete a form or resource from Form.io. Use **List Forms** to find the form ID. This is irreversible. [See the documentation](https://apidocs.form.io/#1e1a35ef-1456-4dd0-9b4e-62416759a73d).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: true,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.formIo.deleteForm({
+      $,
+      formId: this.formId,
+    });
+
+    $.export("$summary", `Deleted form ${this.formId}`);
+    return response;
+  },
+};

package/actions/delete-form-action/delete-form-action.mjs

@@ -0,0 +1,45 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-delete-form-action",
+  name: "Delete Form Action",
+  description: "Permanently remove an action attached to a Form.io form. Use **List Form Actions** to find the action ID. This is irreversible. [See the documentation](https://apidocs.form.io/#994dc489-e530-4920-9389-813ba2ac9005).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: true,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+    actionId: {
+      propDefinition: [
+        formIo,
+        "actionId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      formId,
+      actionId,
+    } = this;
+
+    const response = await this.formIo.deleteFormAction({
+      $,
+      formId,
+      actionId,
+    });
+
+    $.export("$summary", `Deleted form action ${actionId}`);
+    return response;
+  },
+};

package/actions/delete-role/delete-role.mjs

@@ -0,0 +1,33 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-delete-role",
+  name: "Delete Role",
+  description: "Permanently delete a role from the Form.io project. Obtain the role ID from **List Roles** (it is the role's 24-character hex `_id`, e.g. `64f8a1b2c3d4e5f60718293a`). This is irreversible. [See the documentation](https://apidocs.form.io/#df393393-6262-4c3a-8a5d-d3abb3182409).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: true,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    roleId: {
+      propDefinition: [
+        formIo,
+        "roleId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.formIo.deleteRole({
+      $,
+      roleId: this.roleId,
+    });
+
+    $.export("$summary", `Deleted role ${this.roleId}`);
+    return response;
+  },
+};

package/actions/delete-submission/delete-submission.mjs

@@ -0,0 +1,45 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-delete-submission",
+  name: "Delete Submission",
+  description: "Permanently delete a submission from a Form.io form. Use **List Submissions** to find the submission ID. This is irreversible. [See the documentation](https://apidocs.form.io/#080c6368-e029-c581-951b-a993bc02578a).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: true,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+    submissionId: {
+      propDefinition: [
+        formIo,
+        "submissionId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      formId,
+      submissionId,
+    } = this;
+
+    const response = await this.formIo.deleteSubmission({
+      $,
+      formId,
+      submissionId,
+    });
+
+    $.export("$summary", `Deleted submission ${submissionId}`);
+    return response;
+  },
+};

package/actions/get-form/get-form.mjs

@@ -0,0 +1,33 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-get-form",
+  name: "Get Form",
+  description: "Retrieve a single form or resource by its ID from Form.io. Use **List Forms** to find the form ID. [See the documentation](https://apidocs.form.io/#fc94dbcd-7ac6-4d0f-9824-f7979bb6e67f).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.formIo.getForm({
+      $,
+      formId: this.formId,
+    });
+
+    $.export("$summary", `Retrieved form "${response.title}" (${response._id})`);
+    return response;
+  },
+};

package/actions/get-form-action/get-form-action.mjs

@@ -0,0 +1,45 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-get-form-action",
+  name: "Get Form Action",
+  description: "Retrieve a single action attached to a Form.io form. Use **List Form Actions** to find the action ID. [See the documentation](https://apidocs.form.io/#72821b94-cc96-41b4-b271-cb5d9e9261cd).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+    actionId: {
+      propDefinition: [
+        formIo,
+        "actionId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      formId,
+      actionId,
+    } = this;
+
+    const response = await this.formIo.getFormAction({
+      $,
+      formId,
+      actionId,
+    });
+
+    $.export("$summary", `Retrieved form action "${response.title}" (${response._id})`);
+    return response;
+  },
+};

package/actions/get-role/get-role.mjs

@@ -0,0 +1,33 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-get-role",
+  name: "Get Role",
+  description: "Retrieve a single role by its ID from the Form.io project. Obtain the role ID from **List Roles** (it is the role's 24-character hex `_id`, e.g. `64f8a1b2c3d4e5f60718293a`). [See the documentation](https://apidocs.form.io/#df393393-6262-4c3a-8a5d-d3abb3182409).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    roleId: {
+      propDefinition: [
+        formIo,
+        "roleId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.formIo.getRole({
+      $,
+      roleId: this.roleId,
+    });
+
+    $.export("$summary", `Retrieved role "${response.title}" (${response._id})`);
+    return response;
+  },
+};

package/actions/get-submission/get-submission.mjs

@@ -0,0 +1,45 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-get-submission",
+  name: "Get Submission",
+  description: "Retrieve a single submission for a Form.io form. Use **List Forms** to find the form ID and **List Submissions** to find the submission ID. [See the documentation](https://apidocs.form.io/#bc4aaf65-ee01-9c85-005f-ac7b433612d8).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+    submissionId: {
+      propDefinition: [
+        formIo,
+        "submissionId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      formId,
+      submissionId,
+    } = this;
+
+    const response = await this.formIo.getSubmission({
+      $,
+      formId,
+      submissionId,
+    });
+
+    $.export("$summary", `Retrieved submission ${response._id}`);
+    return response;
+  },
+};

package/actions/list-form-actions/list-form-actions.mjs

@@ -0,0 +1,67 @@
+import formIo from "../../form_io.app.mjs";
+
+export default {
+  key: "form_io-list-form-actions",
+  name: "List Form Actions",
+  description: "List all actions attached to a Form.io form. Use **List Forms** to find the form ID. Form.io returns up to `limit` records (default 10); if you receive a full page there may be more — raise `limit` (up to 1000) or page with `skip` to retrieve them all. [See the documentation](https://apidocs.form.io/#3f2531ad-bd2e-4e8e-889f-1bce44ce9651).",
+  version: "0.0.1",
+  type: "action",
+  ai: "optimized",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    formIo,
+    formId: {
+      propDefinition: [
+        formIo,
+        "formId",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        formIo,
+        "limit",
+      ],
+    },
+    skip: {
+      propDefinition: [
+        formIo,
+        "skip",
+      ],
+    },
+    sort: {
+      propDefinition: [
+        formIo,
+        "sort",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      formId,
+      limit,
+      skip,
+      sort,
+    } = this;
+
+    const response = await this.formIo.listFormActions({
+      $,
+      formId,
+      params: {
+        limit,
+        skip,
+        sort,
+      },
+    });
+
+    const actions = Array.isArray(response)
+      ? response
+      : response?.data ?? [];
+
+    $.export("$summary", `Retrieved ${actions.length} form action(s)`);
+    return response;
+  },
+};