Generate PDF with MergeMole API on New Package Version from npm API

Pipedream makes it easy to connect APIs for MergeMole, npm and 2,900+ other apps remarkably fast.

Trigger workflow on

New Package Version from the npm API

Next, do this

Generate PDF with the MergeMole 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 npm trigger and MergeMole action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Generate PDF action
1. Connect your MergeMole account
2. Select a Template ID
3. Configure Document Name
4. Configure syncDir
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 Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Generate PDF on MergeMole

Description:Generate a PDF document based on the specified template. [See the documentation](https://documenter.getpostman.com/view/41321603/2sB2j3AWqz#a389449f-ada9-4e2e-9d8a-f1bde20da980)

Version:0.0.3

Key:mergemole-generate-pdf

View on GitHub

Action Code#

import mergemole from "../../mergemole.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import fs from "fs";

export default {
  key: "mergemole-generate-pdf",
  name: "Generate PDF",
  description: "Generate a PDF document based on the specified template. [See the documentation](https://documenter.getpostman.com/view/41321603/2sB2j3AWqz#a389449f-ada9-4e2e-9d8a-f1bde20da980)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    mergemole,
    templateId: {
      propDefinition: [
        mergemole,
        "templateId",
      ],
      reloadProps: true,
    },
    documentName: {
      type: "string",
      label: "Document Name",
      description: "The name of the generated PDF document",
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.templateId) {
      return props;
    }
    const templateVariables = await this.mergemole.getTemplateVariables({
      templateId: this.templateId,
    });
    if (!templateVariables?.length) {
      throw new ConfigurationError(`No template variables found for template \`${this.templateId}\``);
    }
    for (const variable of templateVariables) {
      props[variable.key] = {
        type: "string",
        label: variable.label,
        optional: true,
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      mergemole,
      templateId,
      documentName,
      ...templateVariables
    } = this;

    const data = [];
    for (const [
      key,
      value,
    ] of Object.entries(templateVariables)) {
      data.push({
        placeholder: key,
        value,
      });
    }

    const response = await mergemole.generatePdf({
      $,
      data: {
        data,
        template_id: templateId,
        document_name: documentName,
      },
      responseType: "arraybuffer",
    });

    const filePath = `${process.env.STASH_DIR || "/tmp"}/${documentName}`;
    fs.writeFileSync(filePath, Buffer.from(response));

    $.export("$summary", "Successfully generated PDF");

    return {
      filename: documentName,
      downloadedFilepath: filePath,
    };
  },
};

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
MergeMole	`mergemole`	`app`	This component uses the MergeMole app.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Document Name	`documentName`	`string`	The name of the generated PDF document
syncDir	`syncDir`	`dir`