Delete Records with Algolia API on New Package Version from npm API

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

Trigger workflow on

New Package Version from the npm API

Next, do this

Delete Records with the Algolia 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 Algolia action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Delete Records action
1. Connect your Algolia account
2. Select a Index Name
3. Configure Record IDs
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 Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

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`
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#

Delete Records on Algolia

Description:Delete records from the given index. [See the documentation](https://www.algolia.com/doc/libraries/javascript/v5/helpers/#delete-records)

Version:0.0.1

Key:algolia-delete-records

View on GitHub

Algolia Overview#

Algolia is a powerful search-as-a-service platform that makes it easy to deliver fast, relevant search experiences to users. The Algolia API allows developers to programmatically manage search indices, perform searches, and capture insights about search activity. With Pipedream, you can harness this API to automate and integrate Algolia's capabilities with other apps, creating efficient workflows that enhance search functionalities and user engagement. You can sync data across platforms, automate content indexing, and trigger actions based on search patterns or user behaviors.

Action Code#

import app from "../../algolia.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "algolia-delete-records",
  name: "Delete Records",
  description: "Delete records from the given index. [See the documentation](https://www.algolia.com/doc/libraries/javascript/v5/helpers/#delete-records)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    indexName: {
      propDefinition: [
        app,
        "indexName",
      ],
    },
    recordIds: {
      type: "string[]",
      label: "Record IDs",
      description: "IDs of the records to delete also known as `objectIDs`. Eg. `[\"1\", \"2\"]`. If you don't know the IDs, you can use the **Browse Records** action to find them, then map them and then use them here as a custom expression. Eg. `{{steps.map_records_to_objectids.$return_value}}`.",
    },
  },
  methods: {
    deleteRecords(args = {}) {
      return this.app._client().deleteObjects(args);
    },
  },
  async run({ $ }) {
    const {
      deleteRecords,
      indexName,
      recordIds,
    } = this;

    const response = await deleteRecords({
      indexName,
      objectIDs: utils.parseArray(recordIds),
      waitForTasks: true,
    });

    $.export("$summary", "Successfully deleted records.");

    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
Algolia	`app`	`app`	This component uses the Algolia app.
Index Name	`indexName`	`string`	Select a value from the drop down menu.
Record IDs	`recordIds`	`string[]`	IDs of the records to delete also known as `objectIDs`. Eg. `["1", "2"]`. If you don't know the IDs, you can use the Browse Records action to find them, then map them and then use them here as a custom expression. Eg. `{{steps.map_records_to_objectids.$return_value}}`.

Action Authentication#

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

In your Algolia Dashboard, select the API Keys section. Here you'll find your Application ID and API Keys. You can use either your Admin API Key or create another API key with permissions scoped to a specific index / operations (recommended).

Once done, enter both values below.