Create Document with DocsAutomator API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Document with the DocsAutomator 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 DocsAutomator 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 Document action
1. Connect your DocsAutomator account
2. Select a Automation ID
3. Optional- Configure Document Name
4. Optional- Configure Record ID
5. Optional- Configure Task ID
6. Optional- Configure Data
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 Document on DocsAutomator

Description:Generate a new document from a pre-existing template. [See the documentation](https://docs.docsautomator.co/integrations-api/docsautomator-api)

Version:0.0.1

Key:docsautomator-create-document

View on GitHub

Action Code#

import { parseObject } from "../../common/utils.mjs";
import docsautomator from "../../docsautomator.app.mjs";

export default {
  key: "docsautomator-create-document",
  name: "Create Document",
  description: "Generate a new document from a pre-existing template. [See the documentation](https://docs.docsautomator.co/integrations-api/docsautomator-api)",
  version: "0.0.1",
  type: "action",
  props: {
    docsautomator,
    automationId: {
      propDefinition: [
        docsautomator,
        "automationId",
      ],
    },
    documentName: {
      propDefinition: [
        docsautomator,
        "documentName",
      ],
    },
    recId: {
      propDefinition: [
        docsautomator,
        "recId",
      ],
    },
    taskId: {
      propDefinition: [
        docsautomator,
        "taskId",
      ],
    },
    data: {
      propDefinition: [
        docsautomator,
        "data",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.docsautomator.createDocument({
      $,
      data: {
        docId: this.automationId,
        documentName: this.documentName,
        recId: this.recId,
        taskId: this.taskId,
        data: parseObject(this.data),
      },
    });

    $.export("$summary", `Successfully created document with automation ID ${this.automationId}`);
    return response;
  },
};

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
DocsAutomator	`docsautomator`	`app`	This component uses the DocsAutomator app.
Automation ID	`automationId`	`string`	Select a value from the drop down menu.
Document Name	`documentName`	`string`	The name of the generated document
Record ID	`recId`	`string`	Record ID for Airtable (Airtable only — data not required)
Task ID	`taskId`	`string`	Task ID for ClickUp (ClickUp only — data not required)
Data	`data`	`object`	Placeholders data for the template. See the documentation for further information.