Create Page with Documenterra API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Page with the Documenterra 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 Documenterra 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 Page action
1. Connect your Documenterra account
2. Select a Project Identity
3. Configure Page ID
4. Configure Assignee User Name
5. Configure Owner User Name
6. Select a Status Name
7. Optional- Configure Page Title
8. Optional- Configure Body HTML
9. Optional- Configure Index Keywords
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 Page on Documenterra

Description:Creates a new page. [See the documentation](https://documenterra.ru/docs/user-manual/api-sozdaniye-stranitsy.html)

Version:0.0.2

Key:documenterra-create-page

View on GitHub

Action Code#

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

export default {
  key: "documenterra-create-page",
  name: "Create Page",
  description: "Creates a new page. [See the documentation](https://documenterra.ru/docs/user-manual/api-sozdaniye-stranitsy.html)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    projectId: {
      propDefinition: [
        app,
        "projectId",
      ],
    },
    id: {
      type: "string",
      label: "Page ID",
      description: "The unique identifier for the page.",
    },
    assigneeUserName: {
      type: "string",
      label: "Assignee User Name",
      description: "Login of the artist to whom the page is assigned.",
    },
    ownerUserName: {
      type: "string",
      label: "Owner User Name",
      description: "The name of the user who is the owner of the page.",
    },
    statusName: {
      type: "string",
      label: "Status Name",
      description: "Page workflow status.",
      options: [
        "Ready",
        "Draft",
        "Under Review",
      ],
    },
    title: {
      type: "string",
      label: "Page Title",
      description: "The title of the page.",
      optional: true,
    },
    bodyHtml: {
      type: "string",
      label: "Body HTML",
      description: "HTML content of the page.",
      optional: true,
    },
    indexKeywords: {
      type: "string[]",
      label: "Index Keywords",
      description: "An array of strings containing keywords to be used when creating the page.",
      optional: true,
    },
  },
  methods: {
    createPage({
      projectId, ...args
    } = {}) {
      return this.app.post({
        path: `/projects/${projectId}/articles`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createPage,
      projectId,
      assigneeUserName,
      id,
      ownerUserName,
      statusName,
      title,
      bodyHtml,
      indexKeywords,
    } = this;

    const response = await createPage({
      $,
      projectId,
      data: {
        assigneeUserName,
        id,
        ownerUserName,
        statusName,
        title,
        bodyHtml,
        indexKeywords,
      },
    });

    $.export("$summary", `Successfully created a new page with ID: \`${response?.id}\`.`);
    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
Documenterra	`app`	`app`	This component uses the Documenterra app.
Project Identity	`projectId`	`string`	Select a value from the drop down menu.
Page ID	`id`	`string`	The unique identifier for the page.
Assignee User Name	`assigneeUserName`	`string`	Login of the artist to whom the page is assigned.
Owner User Name	`ownerUserName`	`string`	The name of the user who is the owner of the page.
Status Name	`statusName`	`string`	Select a value from the drop down menu:`ReadyDraftUnder Review`
Page Title	`title`	`string`	The title of the page.
Body HTML	`bodyHtml`	`string`	HTML content of the page.
Index Keywords	`indexKeywords`	`string[]`	An array of strings containing keywords to be used when creating the page.