Create A Space with Pencil Spaces API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create A Space with the Pencil Spaces 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 Pencil Spaces 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 A Space action
1. Connect your Pencil Spaces account
2. Optional- Configure Title
3. Optional- Select a Space To Clone Id
4. Optional- Select a Owner Id
5. Optional- Select one or more Host Ids
6. Optional- Select one or more Participant Ids
7. Optional- Select a Visibility
8. Configure Notify Invitees
9. Optional- Select a Site Id
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 A Space on Pencil Spaces

Description:Create a new space in Pencil Spaces. [See the documentation](https://api.pencilspaces.com/reference#tag/spaces/POST/spaces/create)

Version:0.0.1

Key:pencil_spaces-create-space

View on GitHub

Action Code#

import { VISIBILITY_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import pencilSpaces from "../../pencil_spaces.app.mjs";

export default {
  key: "pencil_spaces-create-space",
  name: "Create A Space",
  description: "Create a new space in Pencil Spaces. [See the documentation](https://api.pencilspaces.com/reference#tag/spaces/POST/spaces/create)",
  version: "0.0.1",
  type: "action",
  props: {
    pencilSpaces,
    title: {
      type: "string",
      label: "Title",
      description: "The title of the Space. If not provided and `Space To Clone Id` is set, the existing Space name will be used. If not, a random Space name will be generated.",
      optional: true,
    },
    spaceToCloneId: {
      propDefinition: [
        pencilSpaces,
        "spaceToCloneId",
      ],
      optional: true,
    },
    ownerId: {
      propDefinition: [
        pencilSpaces,
        "ownerId",
      ],
      optional: true,
    },
    hostIds: {
      propDefinition: [
        pencilSpaces,
        "ownerId",
      ],
      type: "string[]",
      label: "Host Ids",
      description: "The hosts you wish to invite to the Space. The user associated with your API key will always be added as a host.",
      optional: true,
    },
    participantIds: {
      propDefinition: [
        pencilSpaces,
        "ownerId",
      ],
      type: "string[]",
      label: "Participant Ids",
      description: "The participants you wish to invite to the Space.",
      optional: true,
    },
    visibility: {
      type: "string",
      label: "Visibility",
      description: "The visibility of the Space.",
      options: VISIBILITY_OPTIONS,
      optional: true,
    },
    notifyInvitees: {
      type: "boolean",
      label: "Notify Invitees",
      description: "Whether you want to automatically notify invitees when you create your Space.",
    },
    siteId: {
      propDefinition: [
        pencilSpaces,
        "siteId",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.pencilSpaces.createSpace({
      $,
      data: {
        title: this.title,
        spaceToCloneId: this.spaceToCloneId,
        ownerId: {
          userId: this.ownerId,
        },
        hostIds: parseObject(this.hostIds)?.map((hostId) => ({
          userId: hostId,
        })),
        participantIds: parseObject(this.participantIds)?.map((participantId) => ({
          userId: participantId,
        })),
        visibility: this.visibility,
        notifyInvitees: this.notifyInvitees,
        siteId: this.siteId,
      },
    });

    $.export("$summary", `Successfully created space with ID: "${response.spaceId}"`);
    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
Pencil Spaces	`pencilSpaces`	`app`	This component uses the Pencil Spaces app.
Title	`title`	`string`	The title of the Space. If not provided and `Space To Clone Id` is set, the existing Space name will be used. If not, a random Space name will be generated.
Space To Clone Id	`spaceToCloneId`	`string`	Select a value from the drop down menu.
Owner Id	`ownerId`	`string`	Select a value from the drop down menu.
Host Ids	`hostIds`	`string[]`	Select a value from the drop down menu.
Participant Ids	`participantIds`	`string[]`	Select a value from the drop down menu.
Visibility	`visibility`	`string`	Select a value from the drop down menu:`{ "label": "Public", "value": "public" }{ "label": "Private", "value": "private" }`
Notify Invitees	`notifyInvitees`	`boolean`	Whether you want to automatically notify invitees when you create your Space.
Site Id	`siteId`	`string`	Select a value from the drop down menu.