[Components] Metabase - new components

Author: jcortes

components/metabase/.gitignore

@@ -2,10 +2,24 @@
 
 The Metabase API opens a gateway to interact with Metabase programmatically, enabling you to automate reporting, dashboards, and data analysis operations. With Pipedream, you can harness this API to trigger workflows, manipulate data, and integrate with various other apps to create a seamless data ecosystem. Think of syncing Metabase insights with other tools, automating report generation, or reacting to events within your Metabase instance in real-time.
 
+# Available Actions
+
+This Metabase integration provides the following actions:
+
+- **Run Query** - Execute a saved question/card and return the results
+- **Create Card** - Create a new question/card in Metabase
+- **Get Dashboard** - Retrieve dashboard information and its cards  
+- **Create Dashboard** - Create a new dashboard in Metabase
+- **Get Database** - Retrieve database information and metadata
+
 # Example Use Cases
 
 - **Automated Reporting**: Use Pipedream to set up scheduled triggers that fetch reports from Metabase and send them via email or Slack. This workflow can help teams stay updated with the latest insights without manual intervention.
 
 - **Dashboard Sync**: Create a workflow that listens for updates in a specific Metabase dashboard and synchronizes those changes with a Google Sheets document. This allows for easy sharing and collaboration on data insights with stakeholders who prefer working in spreadsheets.
 
 - **Alerting on Metrics**: Set up a Pipedream workflow that monitors specific metrics within Metabase. If certain thresholds are crossed, actions can be taken automatically, like sending alerts through SMS using Twilio or creating a task in project management tools like Trello.
+
+- **Data Pipeline Automation**: Automatically create new cards and dashboards when new data sources are added, or when specific business events occur.
+
+- **Cross-Platform Integration**: Sync Metabase insights with CRM systems, marketing tools, or business intelligence platforms to create a unified view of your data across all systems.

components/metabase/README.md

@@ -0,0 +1,88 @@
+import app from "../../metabase.app.mjs";
+import { VISUALIZATION_TYPES } from "../../common/constants.mjs";
+
+export default {
+  key: "metabase-create-card",
+  name: "Create Card",
+  description: "Create a new question/card in Metabase. [See the documentation](https://www.metabase.com/docs/latest/api#tag/apicard/POST/api/card/).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the card",
+    },
+    databaseId: {
+      propDefinition: [
+        app,
+        "databaseId",
+      ],
+    },
+    query: {
+      type: "object",
+      label: "Query",
+      description: "The query definition object. For native queries, use {\"native\": {\"query\": \"SELECT * FROM table\"}}. For structured queries, provide the query object.",
+    },
+    collectionId: {
+      propDefinition: [
+        app,
+        "collectionId",
+      ],
+      optional: true,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "Description of the card",
+      optional: true,
+    },
+    visualizationType: {
+      type: "string",
+      label: "Visualization Type",
+      description: "The type of visualization",
+      options: VISUALIZATION_TYPES,
+      default: "table",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      databaseId,
+      query,
+      collectionId,
+      description,
+      visualizationType,
+    } = this;
+
+    const data = {
+      name,
+      database_id: databaseId,
+      dataset_query: {
+        database: databaseId,
+        ...query,
+      },
+      display: visualizationType || "table",
+      visualization_settings: {},
+    };
+
+    if (collectionId !== undefined) {
+      data.collection_id = collectionId;
+    }
+
+    if (description) {
+      data.description = description;
+    }
+
+    const response = await this.app.createCard({
+      $,
+      data,
+    });
+
+    $.export("$summary", `Successfully created card "${name}" with ID ${response.id}`);
+
+    return response;
+  },
+};

components/metabase/actions/create-card/create-card.mjs

@@ -0,0 +1,66 @@
+import app from "../../metabase.app.mjs";
+
+export default {
+  key: "metabase-create-dashboard",
+  name: "Create Dashboard",
+  description: "Create a new dashboard in Metabase. [See the documentation](https://www.metabase.com/docs/latest/api#tag/apidashboard/POST/api/dashboard/).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the dashboard",
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "Description of the dashboard",
+      optional: true,
+    },
+    collectionId: {
+      propDefinition: [
+        app,
+        "collectionId",
+      ],
+      optional: true,
+    },
+    parameters: {
+      type: "object",
+      label: "Parameters",
+      description: "Dashboard parameters configuration",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      description,
+      collectionId,
+      parameters,
+    } = this;
+
+    const data = {
+      name,
+      parameters: parameters || [],
+    };
+
+    if (description) {
+      data.description = description;
+    }
+
+    if (collectionId !== undefined) {
+      data.collection_id = collectionId;
+    }
+
+    const response = await this.app.createDashboard({
+      $,
+      data,
+    });
+
+    $.export("$summary", `Successfully created dashboard "${name}" with ID ${response.id}`);
+
+    return response;
+  },
+};

components/metabase/actions/create-dashboard/create-dashboard.mjs

@@ -0,0 +1,30 @@
+import app from "../../metabase.app.mjs";
+
+export default {
+  key: "metabase-get-dashboard",
+  name: "Get Dashboard",
+  description: "Retrieve dashboard information and its cards. [See the documentation](https://www.metabase.com/docs/latest/api#tag/apidashboard/GET/api/dashboard/).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    dashboardId: {
+      propDefinition: [
+        app,
+        "dashboardId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { dashboardId } = this;
+
+    const response = await this.app.getDashboard({
+      $,
+      dashboardId,
+    });
+
+    $.export("$summary", `Successfully retrieved dashboard "${response.name}" with ${response.dashcards?.length || 0} cards`);
+
+    return response;
+  },
+};

components/metabase/actions/get-dashboard/get-dashboard.mjs

@@ -0,0 +1,46 @@
+import app from "../../metabase.app.mjs";
+
+export default {
+  key: "metabase-get-database",
+  name: "Get Database",
+  description: "Retrieve database information and metadata. [See the documentation](https://www.metabase.com/docs/latest/api#tag/apidatabase/GET/api/database/).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    databaseId: {
+      propDefinition: [
+        app,
+        "databaseId",
+      ],
+    },
+    includeMetadata: {
+      type: "boolean",
+      label: "Include Metadata",
+      description: "Whether to include detailed metadata about tables and fields",
+      default: false,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      databaseId, includeMetadata,
+    } = this;
+
+    let response = await this.app.getDatabase({
+      $,
+      databaseId,
+    });
+
+    if (includeMetadata) {
+      response = await this.app._makeRequest({
+        $,
+        path: `/database/${databaseId}/metadata`,
+      });
+    }
+
+    $.export("$summary", `Successfully retrieved database "${response.name}" information`);
+
+    return response;
+  },
+};

components/metabase/actions/get-database/get-database.mjs

@@ -0,0 +1,39 @@
+import app from "../../metabase.app.mjs";
+
+export default {
+  key: "metabase-run-query",
+  name: "Run Query",
+  description: "Execute a saved question/card and return the results. [See the documentation](https://www.metabase.com/docs/latest/api#tag/apicard/POST/api/card/{card-id}/query).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    cardId: {
+      propDefinition: [
+        app,
+        "cardId",
+      ],
+    },
+    parameters: {
+      type: "object",
+      label: "Parameters",
+      description: "Parameters to pass to the query (if the question has parameters)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      cardId, parameters,
+    } = this;
+
+    const response = await this.app.runCardQuery({
+      $,
+      cardId,
+      data: parameters || {},
+    });
+
+    $.export("$summary", `Successfully executed query for card ${cardId}`);
+
+    return response;
+  },
+};

components/metabase/actions/run-query/run-query.mjs

@@ -0,0 +1,46 @@
+export const VISUALIZATION_TYPES = [
+  "table",
+  "bar",
+  "line",
+  "area",
+  "pie",
+  "scalar",
+  "smartscalar",
+  "gauge",
+  "progress",
+  "combo",
+  "row",
+  "waterfall",
+  "funnel",
+  "scatter",
+  "map",
+];
+
+export const QUERY_TYPES = {
+  NATIVE: "native",
+  STRUCTURED: "query",
+};
+
+export const parseMetabaseError = (error) => {
+  if (error.response?.data?.message) {
+    return error.response.data.message;
+  }
+  if (error.response?.data?.errors) {
+    return Object.values(error.response.data.errors).join(", ");
+  }
+  return error.message || "An error occurred";
+};
+
+export const formatCardSummary = (card) => {
+  const {
+    id, name, display,
+  } = card;
+  return `Card "${name}" (ID: ${id}, Type: ${display})`;
+};
+
+export const formatDashboardSummary = (dashboard) => {
+  const {
+    id, name, dashcards = [],
+  } = dashboard;
+  return `Dashboard "${name}" (ID: ${id}, Cards: ${dashcards.length})`;
+};