S3 - Upload Files with AWS API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

S3 - Upload Files with the AWS 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 AWS 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 S3 - Upload Files action
1. Connect your AWS account
2. Select a AWS Region
3. Select a S3 Bucket Name
4. Configure Prefix
5. Configure File Path, Url, Or Folder Path
6. Optional- Configure S3 Filename Key
7. Optional- 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 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#

S3 - Upload Files on AWS

Description:Upload files to S3. Accepts either a file URL, a local file path, or a directory path. [See the documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html)

Version:0.0.3

Key:aws-s3-upload-files

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Action Code#

import { join } from "path";
import fs from "fs";
import {
  getFileStreamAndMetadata,
  ConfigurationError,
} from "@pipedream/platform";
import common from "../../common/common-s3.mjs";

export default {
  ...common,
  key: "aws-s3-upload-files",
  name: "S3 - Upload Files",
  description: "Upload files to S3. Accepts either a file URL, a local file path, or a directory path. [See the documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/upload-objects.html)",
  version: "0.0.3",
  type: "action",
  props: {
    aws: common.props.aws,
    region: common.props.region,
    bucket: common.props.bucket,
    prefix: {
      type: "string",
      label: "Prefix",
      description: "This is the destination S3 prefix. Files or folders would both get uploaded to the prefix.",
    },
    path: {
      type: "string",
      label: "File Path, Url, Or Folder Path",
      description: "Provide either a file URL, a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`), or a directory path to upload all files.",
    },
    customFilename: {
      type: common.props.key.type,
      label: common.props.key.label,
      description: common.props.key.description,
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    streamToBase64(stream) {
      return new Promise((resolve, reject) => {
        const chunks = [];
        stream.on("data", (chunk) => chunks.push(chunk));
        stream.on("end", () => {
          const buffer = Buffer.concat(chunks);
          resolve(buffer.toString("base64"));
        });
        stream.on("error", reject);
      });
    },
    getFilesRecursive(dir) {
      let results = [];
      const items = fs.readdirSync(dir);
      for (const item of items) {
        const itemPath = join(dir, item);
        const stat = fs.statSync(itemPath);
        if (stat.isDirectory()) {
          results = results.concat(this.getFilesRecursive(itemPath));
        } else {
          results.push(itemPath);
        }
      }
      return results;
    },
    async uploadFolderFiles($, folderPath) {
      const {
        uploadFile,
        bucket,
        prefix,
      } = this;
      const files = this.getFilesRecursive(folderPath);
      const response = await Promise.all(files.map(async (filePath) => {
        const {
          stream,
          metadata,
        } = await getFileStreamAndMetadata(filePath);
        const relativePath = filePath.substring(folderPath.length + 1);
        const s3Key = join(prefix, relativePath);

        await uploadFile({
          Bucket: bucket,
          Key: s3Key,
          Body: stream,
          ContentType: metadata.contentType,
          ContentLength: metadata.size,
        });
        return {
          filePath,
          s3Key,
          status: "uploaded",
        };
      }));
      $.export("$summary", `Uploaded all files from ${folderPath} to S3`);
      return response;
    },
    async uploadSingleFile($, filePath) {
      const {
        uploadFile,
        bucket,
        prefix,
        customFilename,
      } = this;

      const {
        stream,
        metadata,
      } = await getFileStreamAndMetadata(filePath);
      const filename = customFilename || filePath.split("/").pop();

      const response = await uploadFile({
        Bucket: bucket,
        Key: join(prefix, filename),
        Body: stream,
        ContentType: metadata.contentType,
        ContentLength: metadata.size,
      });

      $.export("$summary", `Uploaded file ${filename} to S3`);
      return response;
    },
  },
  async run({ $ }) {
    const {
      uploadSingleFile,
      uploadFolderFiles,
      path,
    } = this;

    // If path is a URL, treat it as a single file
    if (path.startsWith("http://") || path.startsWith("https://")) {
      return await uploadSingleFile($, path);
    }

    // For local paths, check if it exists
    if (!fs.existsSync(path)) {
      throw new ConfigurationError(`The file or directory path \`${path}\` does not exist. Please verify the path and include the leading /tmp if needed.`);
    }

    const stat = fs.statSync(path);
    return stat.isDirectory()
      ? await uploadFolderFiles($, path)
      : await uploadSingleFile($, path);
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
S3 Bucket Name	`bucket`	`string`	Select a value from the drop down menu.
Prefix	`prefix`	`string`	This is the destination S3 prefix. Files or folders would both get uploaded to the prefix.
File Path, Url, Or Folder Path	`path`	`string`	Provide either a file URL, a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`), or a directory path to upload all files.
S3 Filename Key	`customFilename`	`string`	The name of the S3 key with extension you'd like to upload this file to
syncDir	`syncDir`	`dir`

Action Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

More Ways to Connect AWS + npm#

Other Popular Integrations#

DynamoDB - Create Table with AWS API on npm Download Counts from npm API

npm + AWS

S3 - Upload Files with AWS API on New Download Counts from npm API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular