[Components] Metabase - new components (#17008)

Author: jcortes

components/metabase/.gitignore

@@ -2,10 +2,23 @@
 
 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
+- **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,78 @@
+import app from "../../metabase.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "metabase-create-dashboard",
+  name: "Create Dashboard",
+  description: "Create a new Dashboard. [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,
+    },
+    collectionPosition: {
+      type: "integer",
+      label: "Collection Position",
+      description: "Position within the collection (must be greater than zero)",
+      min: 1,
+      optional: true,
+    },
+    cacheTtl: {
+      type: "integer",
+      label: "Cache TTL",
+      description: "Cache time-to-live in seconds (must be greater than zero)",
+      min: 1,
+      optional: true,
+    },
+    parameters: {
+      type: "string[]",
+      label: "Parameters",
+      description: "Array of parameter definition objects.\n\n**Required properties:**\n- `id` (string) - Parameter identifier\n- `type` (string) - Parameter type (e.g., \"date/single\", \"text\", \"category\")\n\n**Optional properties:**\n- `name` (string) - Display name\n- `slug` (string) - URL-friendly identifier\n- `sectionId` (string) - Section grouping\n- `default` - Default value\n- `values_source_type` (enum) - \"static-list\", \"card\", or null\n- `values_source_config` (object) - Dynamic value configuration with `card_id`, `label_field`, `value_field`, `values`\n- `temporal_units` (array) - Time-based parameter units\n\n**Example:** `{\"id\": \"date_param\", \"type\": \"date/single\", \"name\": \"Date Filter\", \"slug\": \"date_filter\", \"default\": \"2024-01-01\"}`",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      name,
+      description,
+      collectionId,
+      collectionPosition,
+      cacheTtl,
+      parameters,
+    } = this;
+
+    const response = await app.createDashboard({
+      $,
+      data: {
+        name,
+        description,
+        collection_id: collectionId,
+        collection_position: collectionPosition,
+        cache_ttl: cacheTtl,
+        parameters: utils.parseArray(parameters),
+      },
+    });
+
+    $.export("$summary", `Successfully created dashboard with ID \`${response?.id}\``);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,33 @@
+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/{id}).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    dashboardId: {
+      propDefinition: [
+        app,
+        "dashboardId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      dashboardId,
+    } = this;
+
+    const response = await app.getDashboard({
+      $,
+      dashboardId,
+    });
+
+    $.export("$summary", `Successfully retrieved dashboard with ID \`${response?.id}\``);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,63 @@
+import app from "../../metabase.app.mjs";
+
+export default {
+  key: "metabase-get-database",
+  name: "Get Database",
+  description: "Retrieve database information. [See the documentation](https://www.metabase.com/docs/latest/api#tag/apidatabase/get/api/database/{id}).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    databaseId: {
+      propDefinition: [
+        app,
+        "databaseId",
+      ],
+    },
+    include: {
+      type: "string",
+      label: "Include",
+      description: "What to include in the response",
+      options: [
+        "tables",
+        "tables.fields",
+      ],
+      optional: true,
+    },
+    includeEditableDataModel: {
+      type: "boolean",
+      label: "Include Editable Data Model",
+      description: "Whether to include editable data model information",
+      optional: true,
+    },
+    excludeUneditableDetails: {
+      type: "boolean",
+      label: "Exclude Uneditable Details",
+      description: "Whether to exclude uneditable details from the response",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      databaseId,
+      include,
+      includeEditableDataModel,
+      excludeUneditableDetails,
+    } = this;
+
+    const response = await app.getDatabase({
+      $,
+      databaseId,
+      params: {
+        include,
+        include_editable_data_model: includeEditableDataModel,
+        exclude_uneditable_details: excludeUneditableDetails,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved database with ID \`${response?.id}\``);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,43 @@
+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/pivot/{card-id}/query).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    cardId: {
+      propDefinition: [
+        app,
+        "cardId",
+      ],
+    },
+    ignoreCache: {
+      type: "boolean",
+      label: "Ignore Cache",
+      description: "Whether to ignore the cache and run the query again",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      cardId,
+      ignoreCache,
+    } = this;
+
+    const response = await app.runCardQuery({
+      $,
+      cardId,
+      data: {
+        ignore_cache: ignoreCache,
+      },
+    });
+
+    $.export("$summary", "Successfully executed query");
+
+    return response;
+  },
+};

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

@@ -0,0 +1,51 @@
+const parseJson = (input, maxDepth = 100) => {
+  const seen = new WeakSet();
+  const parse = (value) => {
+    if (maxDepth <= 0) {
+      return value;
+    }
+    if (typeof(value) === "string") {
+      // Only parse if the string looks like a JSON object or array
+      const trimmed = value.trim();
+      if (
+        (trimmed.startsWith("{") && trimmed.endsWith("}")) ||
+        (trimmed.startsWith("[") && trimmed.endsWith("]"))
+      ) {
+        try {
+          return parseJson(JSON.parse(value), maxDepth - 1);
+        } catch (e) {
+          return value;
+        }
+      }
+      return value;
+    } else if (typeof(value) === "object" && value !== null) {
+      if (seen.has(value)) {
+        return value;
+      }
+      seen.add(value);
+      return Object.entries(value)
+        .reduce((acc, [
+          key,
+          val,
+        ]) => Object.assign(acc, {
+          [key]: parse(val),
+        }), {});
+    }
+    return value;
+  };
+
+  return parse(input);
+};
+
+function parseArray(input, maxDepth = 100) {
+  if (!Array.isArray(input)) {
+    return input;
+  }
+
+  return input.map((item) => parseJson(item, maxDepth));
+}
+
+export default {
+  parseArray,
+  parseJson,
+};