Update Workflow Metadata with Ironclad API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Update Workflow Metadata with the Ironclad 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 Ironclad 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 Update Workflow Metadata action
1. Connect your Ironclad account
2. Select a Workflow ID
3. Optional- Configure Comment
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#

Update Workflow Metadata on Ironclad

Description:Updates the metadata of an existing workflow. [See the documentation]()

Version:0.0.1

Key:ironclad-update-workflow

View on GitHub

Action Code#

import ironclad from "../../ironclad.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import {
  getAttributeDescription, parseValue,
} from "../../common/utils.mjs";

export default {
  key: "ironclad-update-workflow",
  name: "Update Workflow Metadata",
  description: "Updates the metadata of an existing workflow. [See the documentation]()",
  version: "0.0.1",
  type: "action",
  props: {
    ironclad,
    workflowId: {
      propDefinition: [
        ironclad,
        "workflowId",
      ],
      reloadProps: true,
    },
    comment: {
      type: "string",
      label: "Comment",
      description: "A comment that explains the updates you are making to the workflow",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.workflowId) {
      return props;
    }
    const { schema } = await this.ironclad.getWorkflow({
      workflowId: this.workflowId,
    });
    for (const [
      key,
      value,
    ] of Object.entries(schema)) {
      if (!value?.readOnly) {
        props[key] = {
          type: value.type === "boolean"
            ? "boolean"
            : value.type === "array"
              ? "string[]"
              : "string",
          label: value.displayName,
          description: getAttributeDescription(value),
          optional: true,
        };
        if (key === "paperSource") {
          props[key].options = [
            "Counterparty paper",
            "Our paper",
          ];
        }
      }
    }
    return props;
  },
  async run({ $ }) {
    const {
      ironclad,
      workflowId,
      comment,
      ...attributes
    } = this;

    const parsedAttributes = {};
    for (const [
      key,
      value,
    ] of Object.entries(attributes)) {
      parsedAttributes[key] = parseValue(value);
    }

    try {
      const response = await ironclad.updateWorkflowMetadata({
        $,
        workflowId: workflowId,
        data: {
          updates: Object.entries(parsedAttributes).map(([
            key,
            value,
          ]) => ({
            action: "set",
            path: key,
            value,
          })),
          comment: comment,
        },
      });
      $.export("$summary", `Workflow ${workflowId} updated successfully`);
      return response;
    } catch (error) {
      const msg = JSON.parse(error.message);
      const { schema } = await ironclad.getWorkflow({
        workflowId,
      });
      if (msg.code === "MISSING_PARAM") {
        const paramNames = (JSON.parse(msg.param)).map((p) => `\`${schema[p].displayName}\``);
        throw new ConfigurationError(`Please enter or update the following required parameters: ${paramNames.join(", ")}`);
      }
      if (msg.code === "INVALID_PARAM") {
        const paramName = schema[msg.metadata.keyPath].displayName;
        throw new ConfigurationError(`Invalid parameter: \`${paramName}\`. ${msg.message}`);
      }
      throw new ConfigurationError(msg.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
Ironclad	`ironclad`	`app`	This component uses the Ironclad app.
Workflow ID	`workflowId`	`string`	Select a value from the drop down menu.
Comment	`comment`	`string`	A comment that explains the updates you are making to the workflow

Action Authentication#

Ironclad uses OAuth authentication. When you connect your Ironclad account, Pipedream will open a popup window where you can sign into Ironclad and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Ironclad API.

Pipedream requests the following authorization scopes when you connect your account:

scim.users.readUserspublic.workflows.readWorkflowspublic.records.readSchemaspublic.records.readRecordspublic.records.createRecordspublic.workflows.createWorkflowspublic.workflows.updateWorkflowspublic.webhooks.createWebhookspublic.webhooks.deleteWebhookspublic.workflows.readSchemas