[FEATURE] Update Algolia components to make them easier to understand and use

Author: jcortes

components/algolia/actions/browse-records/browse-records.mjs

@@ -0,0 +1,37 @@
+import app from "../../algolia.app.mjs";
+
+export default {
+  key: "algolia-browse-records",
+  name: "Browse Records",
+  description: "Browse for records in the given index. [See the documentation](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/browse/?client=javascript).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    indexName: {
+      propDefinition: [
+        app,
+        "indexName",
+      ],
+    },
+  },
+  methods: {
+    browse(args) {
+      return this.app._client().browse(args);
+    },
+  },
+  async run({ $ }) {
+    const {
+      browse,
+      indexName,
+    } = this;
+
+    const response = await browse({
+      indexName,
+    });
+
+    $.export("$summary", `Successfully fetched records from ${indexName} index.`);
+
+    return response;
+  },
+};

components/algolia/actions/create-objects/create-objects.mjs

@@ -0,0 +1,50 @@
+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;
+
+    if (!Array.isArray(recordIds)) {
+      throw new Error("Record IDs must be an array");
+    }
+
+    const response = await deleteRecords({
+      indexName,
+      objectIDs: utils.parseArray(recordIds),
+      waitForTasks: true,
+    });
+
+    $.export("$summary", "Successfully deleted records.");
+
+    return response;
+  },
+};

components/algolia/actions/delete-objects/delete-objects.mjs

@@ -0,0 +1,45 @@
+import app from "../../algolia.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "algolia-save-records",
+  name: "Save Records",
+  description: "Adds records to an index. [See the documentation](https://www.algolia.com/doc/libraries/javascript/v5/helpers/#save-records).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    indexName: {
+      propDefinition: [
+        app,
+        "indexName",
+      ],
+    },
+    records: {
+      type: "string[]",
+      label: "Records From JSON Objects",
+      description: "The records to add to the index. Each record should be a JSON object. Eg. `{\"objectID\": \"1\", \"name\": \"Jane Doe\"}`. For a better user experience, you can use the [**CSV File To Objects**](https://pipedream.com/apps/helper-functions/actions/csv-file-to-objects) **Helper Function** action to convert a CSV file to an array of objects and then map the objects to the records field here as a **Custom Expression**. Eg. `{{steps.csv_file_to_objects.$return_value}}`.",
+    },
+  },
+  methods: {
+    saveRecords(args = {}) {
+      return this.app._client().saveObjects(args);
+    },
+  },
+  async run({ $ }) {
+    const {
+      saveRecords,
+      indexName,
+      records,
+    } = this;
+
+    const response = await saveRecords({
+      indexName,
+      objects: utils.parseArrayAndMap(records),
+      waitForTasks: true,
+    });
+
+    $.export("$summary", "Successfully created records.");
+    return response;
+  },
+};

components/algolia/actions/delete-records/delete-records.mjs

@@ -9,8 +9,7 @@ export default {
       description: "The name of the index",
       type: "string",
       async options() {
-        const indexes = await this.getIndexes();
-
+        const { items: indexes } = await this.listIndices();
         return indexes.map((index) => index.name);
       },
     },
@@ -25,23 +24,8 @@ export default {
     _client() {
       return algoliasearch(this._applicationId(), this._apiKey());
     },
-    _index(indexName) {
-      return this._client().initIndex(indexName);
-    },
-    async getIndexes() {
-      const response = await this._client().listIndices();
-
-      return response.items;
-    },
-    async createObjects({
-      indexName, objects, options,
-    }) {
-      return this._index(indexName).saveObjects(objects, options);
-    },
-    async deleteObjects({
-      indexName, objectIds,
-    }) {
-      return this._index(indexName).deleteObjects(objectIds);
+    listIndices() {
+      return this._client().listIndices();
     },
   },
 };

components/algolia/actions/save-records/save-records.mjs

@@ -0,0 +1,51 @@
+import { ConfigurationError } from "@pipedream/platform";
+
+function isJson(value) {
+  value =
+    typeof(value) !== "string"
+      ? JSON.stringify(value)
+      : value;
+
+  try {
+    value = JSON.parse(value);
+  } catch (e) {
+    return false;
+  }
+
+  return typeof(value) === "object" && value !== null;
+}
+
+function valueToObject(value) {
+  if (!isJson(value)) {
+    return value;
+  }
+  return JSON.parse(value);
+}
+
+function parseArray(value) {
+  try {
+    if (!value) {
+      return [];
+    }
+
+    if (Array.isArray(value)) {
+      return value;
+    }
+
+    const parsedValue = JSON.parse(value);
+
+    if (!Array.isArray(parsedValue)) {
+      throw new Error("Not an array");
+    }
+
+    return parsedValue;
+
+  } catch (e) {
+    throw new ConfigurationError("Make sure the custom expression contains a valid JSON array object");
+  }
+}
+
+export default {
+  parseArray,
+  parseArrayAndMap: (value) => parseArray(value)?.map(valueToObject),
+};

components/algolia/algolia.app.mjs

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/algolia",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Pipedream Algolia Components",
   "main": "algolia.app.js",
   "keywords": [
@@ -14,6 +14,6 @@
     "access": "public"
   },
   "dependencies": {
-    "algoliasearch": "^4.13.1"
+    "algoliasearch": "^5.17.1"
   }
 }