Create Assembly with Transloadit API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Assembly with the Transloadit 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 Transloadit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Assembly action
1. Connect your Transloadit account
2. Configure info
3. Configure Allow Steps Override
4. Optional- Select a Template ID
5. Optional- Configure Steps
6. Optional- Configure Notify URL
7. Optional- Configure Quiet
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

import app from "../../npm.app.mjs";

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

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`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
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#

Create Assembly on Transloadit

Description:Create a new assembly to process files using a specified template and steps. [See the documentation](https://transloadit.com/docs/api/assemblies-post/)

Version:0.0.1

Key:transloadit-create-assembly

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import transloadit from "../../transloadit.app.mjs";

export default {
  key: "transloadit-create-assembly",
  name: "Create Assembly",
  description: "Create a new assembly to process files using a specified template and steps. [See the documentation](https://transloadit.com/docs/api/assemblies-post/)",
  version: "0.0.1",
  type: "action",
  props: {
    transloadit,
    info: {
      type: "alert",
      alertType: "info",
      content: "Note: By default, the `steps` parameter allows you to override Template Steps at runtime. However, if `Allow Steps Override` is set to `false`, then steps and `Template Id` become mutually exclusive. In this case, you can only supply one of these parameters. See [Overruling Templates at Runtime](https://transloadit.com/docs/topics/templates/#overruling-templates-at-runtime).",
    },
    allowStepsOverride: {
      type: "boolean",
      label: "Allow Steps Override",
      description: "Set this to `false` to disallow [Overruling Templates at Runtime](https://transloadit.com/docs/topics/templates/#overruling-templates-at-runtime). If you set this to `false` then `Template Id` and `Steps` will be mutually exclusive and you may only supply one of those parameters. Recommended when deploying Transloadit in untrusted environments. This makes sense to set as part of a Template, rather than on the Assembly itself when creating it.",
      default: true,
    },
    templateId: {
      propDefinition: [
        transloadit,
        "templateId",
      ],
      optional: true,
    },
    steps: {
      type: "object",
      label: "Steps",
      description: "Assembly Instructions comprise all the Steps executed on uploaded/imported files by the Transloadit back-end during file conversion or encoding. [See the documentation](https://transloadit.com/docs/topics/assembly-instructions/) for more information.",
      optional: true,
    },
    notifyUrl: {
      type: "string",
      label: "Notify URL",
      description: "Transloadit can send a Pingback to your server when the Assembly is completed. We'll send the Assembly status in a form url-encoded JSON string inside of a `transloadit` field in a multipart POST request to the URL supplied here.",
      optional: true,
    },
    quiet: {
      type: "boolean",
      label: "Quiet",
      description: "Set this to `true` to reduce the response from an Assembly POST request to only the necessary fields. This prevents any potentially confidential information being leaked to the end user who is making the Assembly request. A successful Assembly will only include the `ok` and `assembly_id` fields. An erroneous Assembly will only include the `error`, `http_code`, `message` and `assembly_id` fields. The full Assembly Status will then still be sent to the `Notify URL` if one was specified.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.allowStepsOverride && this.templateId && this.steps) {
      throw new ConfigurationError("Either 'templateId' or 'steps' must be provided, not both.");
    }
    if (!this.templateId && !this.steps) {
      throw new ConfigurationError("Either 'templateId' or 'steps' must be provided.");
    }

    try {
      const response = await this.transloadit.createAssembly({
        params: {
          template_id: this.templateId,
          steps: parseObject(this.steps),
          notify_url: this.notifyUrl,
          allow_steps_override: this.allowStepsOverride,
          quiet: this.quiet,
        },
      });

      if (response.results.resize) {
        $.export("$summary", `Assembly created successfully with ID ${response.assembly_id}`);
      } else {
        $.export("$summary", "The Assembly didn't produce any output. Make sure you used a valid image file");
      }

      return response;
    } catch (err) {
      let message = `Unable to process Assembly. ${err}`;
      if (err.assemblyId) {
        message += `More info: https://transloadit.com/assemblies/${err.assemblyId}`;
      }
      throw new ConfigurationError(message);
    }
  },
};

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
Transloadit	`transloadit`	`app`	This component uses the Transloadit app.
Allow Steps Override	`allowStepsOverride`	`boolean`	Set this to `false` to disallow Overruling Templates at Runtime. If you set this to `false` then `Template Id` and `Steps` will be mutually exclusive and you may only supply one of those parameters. Recommended when deploying Transloadit in untrusted environments. This makes sense to set as part of a Template, rather than on the Assembly itself when creating it.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Steps	`steps`	`object`	Assembly Instructions comprise all the Steps executed on uploaded/imported files by the Transloadit back-end during file conversion or encoding. See the documentation for more information.
Notify URL	`notifyUrl`	`string`	Transloadit can send a Pingback to your server when the Assembly is completed. We'll send the Assembly status in a form url-encoded JSON string inside of a `transloadit` field in a multipart POST request to the URL supplied here.
Quiet	`quiet`	`boolean`	Set this to `true` to reduce the response from an Assembly POST request to only the necessary fields. This prevents any potentially confidential information being leaked to the end user who is making the Assembly request. A successful Assembly will only include the `ok` and `assembly_id` fields. An erroneous Assembly will only include the `error`, `http_code`, `message` and `assembly_id` fields. The full Assembly Status will then still be sent to the `Notify URL` if one was specified.