[Numbers] Format Number with Formatting API on New Document in Firestore Collection from Firebase Admin API

Pipedream makes it easy to connect APIs for Formatting, Firebase Admin and 2,800+ other apps remarkably fast.

Trigger workflow on

New Document in Firestore Collection from the Firebase Admin API

Next, do this

[Numbers] Format Number with the Formatting API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Firebase Admin trigger and Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Document in Firestore Collection trigger
1. Connect your Firebase Admin account
2. Configure Polling Interval
3. Optional- Select a Database Region
4. Configure Structured Query
Configure the [Numbers] Format Number action
1. Connect your Formatting account
2. Configure Input
3. Optional- Select a Input Decimal Mark
4. Select a Output Format
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Document in Firestore Collection on Firebase Admin

Description:Emit new event when a structured query returns new documents

Version:0.0.8

Key:firebase_admin_sdk-new-doc-in-firestore-collection

View on GitHub

Firebase Admin Overview#

The Firebase Admin SDK API provides powerful backend functionality for Firebase apps. It allows you to interact with Firebase services like Firestore, Firebase Realtime Database, Firebase Storage, and Firebase Authentication directly from a server. With Pipedream, you can harness this API to automate complex workflows, respond to Firebase events in real-time, and integrate with countless other services.

Trigger Code#

import common from "../common/common.mjs";

export default {
  ...common,
  key: "firebase_admin_sdk-new-doc-in-firestore-collection",
  name: "New Document in Firestore Collection",
  description: "Emit new event when a structured query returns new documents",
  version: "0.0.8",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    query: {
      propDefinition: [
        common.props.firebase,
        "query",
      ],
    },
  },
  methods: {
    ...common.methods,
    async processEvent() {
      const structuredQuery = JSON.parse(this.query);

      const queryResults = await this.firebase.runQuery(structuredQuery);

      for (const result of queryResults) {
        const meta = this.generateMeta(result);
        this.$emit(result, meta);
      }
    },
    generateMeta({ document }) {
      const {
        name,
        createTime,
      } = document;
      const id = name.substring(name.lastIndexOf("/") + 1);
      return {
        id,
        summary: name,
        ts: Date.parse(createTime),
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Firebase Admin	`firebase`	`app`	This component uses the Firebase Admin app.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database Region	`databaseRegion`	`string`	Select a value from the drop down menu:`{ "label": "us-central1", "value": "firebaseio.com" }{ "label": "europe-west1", "value": "europe-west1.firebasedatabase.app" }{ "label": "asia-southeast1", "value": "asia-southeast1.firebasedatabase.app" }`
Structured Query	`query`	`string`	Enter a structured query that returns new records from your target collection. Example: `{ "select": { "fields": [] }, "from": [ { "collectionId": "<YOUR COLLECTION>", "allDescendants": "true" } ] }`

Trigger Authentication#

Firebase Admin uses API keys for authentication. When you connect your Firebase Admin account, Pipedream securely stores the keys so you can easily authenticate to Firebase Admin APIs in both code and no-code steps.

About Firebase Admin#

Firebase is Google's mobile platform that helps you quickly develop high-quality apps and grow your business.

Action#

[Numbers] Format Number on Formatting

Description:Format a number to a new style. Does not perform any rounding or padding of the number.

Version:0.0.6

Key:formatting-format-number

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import { ConfigurationError } from "@pipedream/platform";
import formatNumber from "../../common/numbers/formatNumber.mjs";
import { DECIMAL_MARK_OPTIONS, FINAL_FORMAT_OPTIONS, } from "../../common/numbers/numberFormattingOptions.mjs";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Numbers] Format Number",
    description: "Format a number to a new style. Does not perform any rounding or padding of the number.",
    key: "formatting-format-number",
    version: "0.0.6",
    annotations: {
        destructiveHint: false,
        openWorldHint: true,
        readOnlyHint: false,
    },
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "Number string you would like to format.",
            type: "string",
        },
        inputDecimalMark: {
            label: "Input Decimal Mark",
            description: "The character the input uses to denote the decimal/fractional portion of the number. Defaults to period `.`",
            type: "string",
            options: DECIMAL_MARK_OPTIONS,
            optional: true,
        },
        toFormat: {
            label: "Output Format",
            description: "The format the number will be converted to.",
            type: "string",
            options: FINAL_FORMAT_OPTIONS,
        },
    },
    async run({ $ }) {
        const { inputDecimalMark, toFormat, } = this;
        const input = this.input.toString();
        const decimalMark = inputDecimalMark ?? ".";
        const splitInput = input.split(decimalMark);
        if (splitInput.length > 2) {
            throw new ConfigurationError(`Input has more than one decimal mark (\`${decimalMark}\`). Check if the \`Input Decimal Mark\` prop is set correctly.`);
        }
        const [integer, decimal,] = splitInput;
        const [groupChar, decimalChar,] = toFormat.split("");
        const result = formatNumber(integer, decimal, groupChar, decimalChar);
        $.export("$summary", "Successfully formatted number");
        return result;
    },
});

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Formatting	`app`	`app`	This component uses the Formatting app.
Input	`input`	`string`	Number string you would like to format.
Input Decimal Mark	`inputDecimalMark`	`string`	Select a value from the drop down menu:`{ "label": "comma", "value": "," }{ "label": "period", "value": "." }`
Output Format	`toFormat`	`string`	Select a value from the drop down menu:`{ "label": "Comma for grouping & period for decimal", "value": ",." }{ "label": "Period for grouping & comma for decimal", "value": ".," }{ "label": "Space for grouping & period for decimal", "value": " ." }{ "label": "Space for grouping & comma for decimal", "value": " ," }`