@algolia/n8n-nodes-algolia 0.4.2

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# n8n-nodes-algolia
+
+This is an n8n community node. It lets you use Algolia in your n8n workflows.
+
+Algolia is a hosted search API that provides search-as-a-service solutions. It offers powerful search capabilities including full-text search, faceting, geo-search, and instant search with typo tolerance.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+
+[Installation](#installation)  
+[Operations](#operations)  
+[Credentials](#credentials)  
+[Compatibility](#compatibility)  
+[Resources](#resources)
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Operations
+
+This node supports the following operations:
+
+**Index**
+
+- List Indices: List all indices in your Algolia application
+- Search Index: Search for records in a specific index
+
+**Objects**
+
+- Add Object: Add a new object to an index
+
+## Credentials
+
+To use this node, you need to authenticate with Algolia using API credentials.
+
+### Prerequisites
+
+1. Sign up for an [Algolia account](https://www.algolia.com)
+2. Create an application in your Algolia dashboard
+
+### Authentication Setup
+
+1. In your Algolia dashboard, go to Settings > API Keys
+2. Copy your Application ID
+3. Copy your Admin API Key (required for write operations)
+4. In n8n, create new Algolia API credentials with:
+   - **Application ID**: Your Algolia Application ID
+   - **Admin API Key**: Your Algolia Admin API Key
+
+## Compatibility
+
+This node requires n8n version 1.0.0 or higher and Node.js 20.15 or higher.
+
+## Resources
+
+- [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+- [Algolia API documentation](https://www.algolia.com/doc/api-reference/)
+- [Algolia dashboard](https://www.algolia.com/apps)

package/dist/credentials/AlgoliaApi.credentials.js

@@ -0,0 +1,41 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+class AlgoliaApi {
+  constructor() {
+    this.name = "algoliaApi";
+    this.displayName = "Algolia API";
+    this.documentationUrl = "https://www.algolia.com";
+    this.properties = [
+      {
+        displayName: "Application ID",
+        name: "appId",
+        type: "string",
+        required: true,
+        default: ""
+      },
+      {
+        displayName: "Admin API Key",
+        name: "adminApiKey",
+        type: "string",
+        typeOptions: {
+          password: true
+        },
+        required: true,
+        default: ""
+      }
+    ];
+    this.authenticate = {
+      type: "generic",
+      properties: {
+        headers: {
+          "X-Algolia-Application-Id": "={{ $credentials.appId }}",
+          "X-Algolia-API-Key": "={{ $credentials.adminApiKey }}"
+        }
+      }
+    };
+  }
+}
+
+exports.AlgoliaApi = AlgoliaApi;

package/dist/dist/home/runner/work/n8n-nodes-algolia/n8n-nodes-algolia/nodes/Algolia/Algolia.node.json

@@ -0,0 +1,21 @@
+{
+	"node": "n8n-nodes-base.Algolia",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": [
+		"Data & Storage",
+		"Development"
+	],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://www.algolia.com/doc/guides/security/api-keys/"
+			}
+		],
+		"primaryDocumentation": [
+			{
+			"url": "https://www.algolia.com/doc/rest-api/search/"
+			}
+		]
+	}
+}

package/dist/dist/home/runner/work/n8n-nodes-algolia/n8n-nodes-algolia/nodes/Algolia/algolia.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 500 500"><defs><style>.cls-1{fill:#003dff;}.cls-2{fill:#fff;}</style></defs><rect class="cls-1" x="0" y="0" width="500" height="500" rx="250" ry="250"/><path class="cls-2" d="M239.73,122.82c-69.46,0-126.08,56-127.08,125.23-1.02,70.3,56.02,128.56,126.33,128.96,21.72,.13,42.63-5.18,61.2-15.28,1.81-.98,2.09-3.47,.55-4.84l-11.89-10.54c-2.42-2.14-5.86-2.75-8.83-1.48-12.96,5.52-27.05,8.33-41.57,8.16-56.81-.7-102.72-47.97-101.81-104.78,.89-56.09,46.8-101.45,103.1-101.45h103.12v183.28l-58.5-51.98c-1.89-1.68-4.79-1.35-6.32,.67-9.39,12.43-24.69,20.17-41.68,18.99-23.57-1.63-42.67-20.6-44.43-44.16-2.11-28.1,20.16-51.64,47.82-51.64,25.02,0,45.62,19.26,47.77,43.73,.19,2.18,1.17,4.21,2.81,5.66l15.24,13.51c1.73,1.53,4.47,.59,4.9-1.68,1.1-5.87,1.48-12,1.05-18.27-2.45-35.78-31.44-64.57-67.24-66.78-41.04-2.53-75.36,29.58-76.45,69.83-1.06,39.22,31.07,73.03,70.3,73.9,16.38,.36,31.55-4.79,43.82-13.71l76.44,67.76c3.28,2.9,8.45,.58,8.45-3.8V127.64c0-2.66-2.16-4.82-4.82-4.82h-122.27Z"/></svg>

package/dist/nodes/Algolia/Algolia.node.js

@@ -0,0 +1,579 @@
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const n8nWorkflow = require('n8n-workflow');
+
+class Description {
+  /**
+   * This helper creates a node description that can be added to an n8n node class.
+   * @param description A node description as specified by the n8n reference
+   * @see https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/#outline-structure-for-a-declarative-style-node
+   */
+  constructor(description) {
+    this.resources = [];
+    this.description = {
+      version: 1,
+      group: [],
+      inputs: [n8nWorkflow.NodeConnectionType.Main],
+      outputs: [n8nWorkflow.NodeConnectionType.Main],
+      properties: [],
+      ...description
+    };
+    this.resourcesDescription = {
+      displayName: "Resource",
+      name: "resource",
+      noDataExpression: true,
+      default: void 0,
+      // TODO: allow customizing resource type
+      // https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/#resource-objects
+      type: "options",
+      options: []
+    };
+  }
+  /**
+   * Adds a {@link Resource} to this Description.
+   * @param resource The resource's option object as specified by the n8n reference
+   * @param setDefault Whether to make this Resource selected by default
+   * @chainable
+   * @see https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/#resource-objects
+   */
+  addResource(resource, setDefault = false) {
+    this.resources.push(resource);
+    if (setDefault) {
+      this.resourcesDescription.default = resource.value;
+    }
+    return this;
+  }
+  /**
+   * Returns a description that is compatible with n8n.
+   */
+  apply() {
+    const resourcesData = this.resources.reduce(
+      ({ resources, operations, fields }, resource) => {
+        const {
+          definition,
+          operations: resourceOperations,
+          fields: resourceFields
+        } = resource.apply();
+        return {
+          resources: [...resources, definition],
+          operations: [...operations, resourceOperations],
+          fields: [...fields, ...resourceFields]
+        };
+      },
+      { resources: [], operations: [], fields: [] }
+    );
+    return {
+      ...this.description,
+      properties: [
+        {
+          ...this.resourcesDescription,
+          default: this.resourcesDescription.default || this.resources[0]?.value,
+          options: resourcesData.resources
+        },
+        ...resourcesData.operations,
+        ...resourcesData.fields
+      ]
+    };
+  }
+}
+
+class Operation {
+  /**
+   * This helper creates an operation that can be added to a {@link Resource}.
+   * @param operation An operation's option object as specified by the n8n reference
+   * @param additionalParams
+   * @see https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/#operations-objects
+   */
+  constructor(operation, additionalParams = {
+    additionalFieldsLabel: "Additional Fields"
+  }) {
+    this.operation = operation;
+    this.additionalParams = additionalParams;
+    this.fields = [];
+    this.additionalFields = [];
+  }
+  /**
+   * Adds a field to this Operation.
+   * `displayOptions` is automatically applied by the Operation.
+   * @param field The UI element object as specified by the n8n reference
+   * @chainable
+   * @see https://docs.n8n.io/integrations/creating-nodes/build/reference/ui-elements/
+   */
+  addField(...field) {
+    this.fields.push(...field);
+    return this;
+  }
+  /**
+   * Adds a field to this Operation's additional fields drawer.
+   * @param field The UI element object as specified by the n8n reference
+   * @chainable
+   * @see https://docs.n8n.io/integrations/creating-nodes/build/reference/ui-elements/
+   */
+  addAdditionalField(...field) {
+    this.additionalFields.push(...field);
+    return this;
+  }
+  /**
+   * Adds a `postReceive` transformation on the routing output and a UI field that give users the ability to receive a simplified version of the data.
+   * @param transformFn The transform method that will return a simplified version of the provided output
+   * @chainable
+   */
+  addSimplifiedOutput(transformFn) {
+    if (!this.operation.routing) {
+      throw new Error(
+        `The operation "${this.operation.name}" needs a routing object in order to transform its output.`
+      );
+    }
+    if (!this.operation.routing.output?.postReceive) {
+      this.operation.routing.output = {
+        ...this.operation.routing.output || {},
+        postReceive: this.operation.routing.output?.postReceive || []
+      };
+    }
+    this.operation.routing.output.postReceive.push(async function postReceiveFn(items) {
+      if (!this.getNodeParameter("simplify", false)) {
+        return items;
+      }
+      return items.map((item) => ({
+        ...item,
+        json: transformFn(item.json)
+      }));
+    });
+    if (!this.fields.find(({ name }) => name === "simplify")) {
+      this.addField({
+        displayName: "Simplify",
+        name: "simplify",
+        description: "Whether to return a simplified version of the response instead of the raw data",
+        type: "boolean",
+        default: false
+      });
+    }
+    return this;
+  }
+  /**
+   * Returns a description of this Operation, to be used by the Resource and the Description helpers in order to create a compatible n8n Node description.
+   * @internal
+   */
+  apply() {
+    const additionalFields = this.additionalFields.length > 0 ? [
+      {
+        displayName: this.additionalParams.additionalFieldsLabel,
+        name: "additionalFields",
+        type: "collection",
+        default: {},
+        options: this.additionalFields
+      }
+    ] : [];
+    return {
+      definition: this.operation,
+      fields: this.fields.sort((field1, field2) => {
+        if (field1.name === "simplify" && field2.name !== "simplify") {
+          return 1;
+        } else if (field1.name !== "simplify" && field2.name === "simplify") {
+          return -1;
+        }
+        return 0;
+      }).concat(additionalFields).map((field) => ({
+        ...field,
+        displayOptions: {
+          show: {
+            ...field.displayOptions?.show || {},
+            operation: [this.operation.value]
+          }
+        }
+      }))
+    };
+  }
+  /**
+   * The Operation's identifier
+   */
+  get value() {
+    return this.operation.value;
+  }
+}
+
+class Resource {
+  /**
+   * This helper creates a resource that can be added to a {@link Description}.
+   * @param resource A resource's option object as specified by the n8n reference
+   * @param additionalParameters
+   * @see https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/#resource-objects
+   */
+  constructor(resource) {
+    this.resource = resource;
+    this.operations = [];
+    this.operationDescription = {
+      displayName: "Operation",
+      name: "operation",
+      // TODO: allow customizing operation type
+      // https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/#operations-objects
+      type: "options",
+      noDataExpression: true,
+      default: void 0,
+      options: []
+    };
+  }
+  /**
+   * Adds an {@link Operation} to this Resource.
+   * `displayOptions` is automatically applied by the Resource.
+   * @param operation The operation's option object as specified by the n8n reference
+   * @param setDefault Whether to make this Operation selected by default
+   * @chainable
+   * @see https://docs.n8n.io/integrations/creating-nodes/build/reference/node-base-files/#operations-objects
+   */
+  addOperation(operation, setDefault = false) {
+    this.operations.push(operation);
+    if (setDefault) {
+      this.operationDescription.default = operation.value;
+    }
+    return this;
+  }
+  /**
+   * Returns a description of the Resource, to be used by the {@link Description} helper in order to create a compatible n8n Node description.
+   * @internal
+   */
+  apply() {
+    const operationsData = this.operations.reduce(
+      ({ operations: operations2, fields }, operation) => {
+        const { definition, fields: operationFields } = operation.apply();
+        return {
+          operations: [...operations2, definition],
+          fields: [...fields, ...operationFields]
+        };
+      },
+      { operations: [], fields: [] }
+    );
+    if (this.operations.length === 0) {
+      throw new Error(
+        `The resource "${this.resource.name}" needs to contain at least one operation.`
+      );
+    }
+    const operations = {
+      ...this.operationDescription,
+      displayOptions: {
+        show: {
+          resource: [this.resource.value]
+        }
+      },
+      default: this.operationDescription.default || this.operations[0]?.value || "",
+      options: operationsData.operations
+    };
+    return {
+      definition: this.resource,
+      operations,
+      fields: operationsData.fields
+    };
+  }
+  /**
+   * The resource's identifier
+   */
+  get value() {
+    return this.resource.value;
+  }
+}
+
+const name = "@algolia/n8n-nodes-algolia";
+const version = "0.4.2";
+const pkg = {
+  name,
+  version};
+
+const listIndices = new Operation({
+  name: "List Indices",
+  action: "List indices",
+  value: "listIndices",
+  description: "List all indices",
+  routing: {
+    request: {
+      method: "GET",
+      url: "/1/indexes"
+    }
+  }
+}).addSimplifiedOutput((json) => json.items);
+
+const attributesToRetrieve = {
+  displayName: "Attributes to Retrieve",
+  name: "attributesToRetrieve",
+  type: "string",
+  default: [],
+  typeOptions: {
+    multipleValues: true,
+    multipleValueButtonText: "Add attribute"
+  },
+  routing: {
+    request: {
+      body: {
+        attributesToRetrieve: "={{ $value }}"
+      }
+    }
+  }
+};
+
+const hitsPerPage = {
+  displayName: "hitsPerPage",
+  name: "hitsPerPage",
+  description: "The number of hits per page",
+  type: "number",
+  default: 20,
+  typeOptions: {
+    minValue: 0,
+    maxValue: 1e3
+  },
+  routing: {
+    request: {
+      body: {
+        hitsPerPage: "={{ $value }}"
+      }
+    }
+  }
+};
+
+const indexName = {
+  displayName: "Index Name",
+  name: "indexName",
+  type: "options",
+  required: true,
+  default: "",
+  typeOptions: {
+    loadOptions: {
+      routing: {
+        request: {
+          method: "GET",
+          url: "/1/indexes"
+        },
+        output: {
+          postReceive: [
+            {
+              type: "rootProperty",
+              properties: {
+                property: "items"
+              }
+            },
+            {
+              type: "setKeyValue",
+              properties: {
+                name: "={{ $responseItem.name }}",
+                value: "={{ $responseItem.name }}"
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+};
+
+const page = {
+  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+  displayName: "page",
+  name: "page",
+  description: "The page to retrieve",
+  type: "number",
+  default: 0,
+  typeOptions: {
+    minValue: 0
+  },
+  routing: {
+    request: {
+      body: {
+        page: "={{ $value }}"
+      }
+    }
+  }
+};
+
+const query = {
+  displayName: "Query",
+  name: "query",
+  type: "string",
+  description: "The text used to search an index",
+  default: "",
+  routing: {
+    request: {
+      body: {
+        query: "={{ $value }}"
+      }
+    }
+  }
+};
+
+const searchIndex = new Operation(
+  {
+    name: "Search Index",
+    action: "Search index",
+    value: "searchIndex",
+    description: "Returns objects in an index that match the query",
+    routing: {
+      request: {
+        method: "POST",
+        url: "=/1/indexes/{{ $parameter.indexName }}/query"
+      }
+    }
+  },
+  {
+    additionalFieldsLabel: "Search Parameters"
+  }
+).addField(indexName, query).addAdditionalField(attributesToRetrieve, hitsPerPage, page).addSimplifiedOutput((json) => json.hits);
+
+const index = new Resource({
+  name: "Index",
+  value: "index"
+}).addOperation(listIndices).addOperation(searchIndex);
+
+const objectTypeSelector = {
+  displayName: "Object",
+  name: "object",
+  type: "options",
+  default: "json",
+  options: [
+    {
+      name: "From JSON",
+      value: "json"
+    },
+    {
+      name: "Using Fields Below",
+      value: "keypair"
+    }
+  ]
+};
+const jsonObject = {
+  displayName: "JSON",
+  name: "json",
+  type: "json",
+  default: "",
+  placeholder: `{
+"firstname": "John",
+"lastname": "Doe",
+"age": 25
+}`,
+  typeOptions: {
+    rows: 5
+  },
+  displayOptions: {
+    show: {
+      object: ["json"]
+    }
+  }
+};
+const formObject = {
+  displayName: "Object Fields",
+  name: "keypair",
+  type: "fixedCollection",
+  placeholder: "Add Field",
+  default: {},
+  typeOptions: {
+    multipleValues: true
+  },
+  displayOptions: {
+    show: {
+      object: ["keypair"]
+    }
+  },
+  options: [
+    {
+      displayName: "Field",
+      name: "list",
+      values: [
+        {
+          displayName: "Name",
+          name: "name",
+          type: "string",
+          default: ""
+        },
+        {
+          displayName: "Value",
+          name: "value",
+          type: "string",
+          default: ""
+        }
+      ]
+    }
+  ]
+};
+const object = [objectTypeSelector, jsonObject, formObject];
+
+const addObject = new Operation({
+  name: "Add Object",
+  action: "Add Object",
+  value: "addObject",
+  description: "Add an object to the index, automatically assigning it an object ID",
+  routing: {
+    request: {
+      method: "POST",
+      url: "=/1/indexes/{{ $parameter.indexName }}",
+      json: true,
+      body: '={{ $parameter.object === "keypair" ? $parameter.keypair.list.smartJoin("name", "value") : JSON.parse($parameter.json) }}'
+    }
+  }
+}).addField(indexName).addField(...object);
+
+const attributesToRetrieveQuery = {
+  ...attributesToRetrieve,
+  routing: {
+    request: {
+      qs: {
+        attributesToRetrieve: '={{ $value.filter(attr => attr.trim() !== "").length > 0 ? $value.filter(attr => attr.trim() !== "").join(",") : undefined }}'
+      }
+    }
+  }
+};
+
+const objectId = {
+  displayName: "Object ID",
+  name: "objectId",
+  type: "string",
+  default: "",
+  required: true,
+  description: "The unique identifier of the object to retrieve",
+  placeholder: "e.g., myObjectId123"
+};
+
+const getObject = new Operation({
+  name: "Get Object",
+  action: "Get object",
+  value: "getObject",
+  description: "Retrieve a single object from an index using its object ID",
+  routing: {
+    request: {
+      method: "GET",
+      url: "=/1/indexes/{{ $parameter.indexName }}/{{ $parameter.objectId }}"
+    }
+  }
+}).addField(indexName, objectId).addAdditionalField(attributesToRetrieveQuery);
+
+const objects = new Resource({
+  name: "Objects",
+  value: "objects"
+}).addOperation(addObject).addOperation(getObject);
+
+const description = new Description({
+  name: "Algolia",
+  displayName: "Algolia",
+  description: "Use Algolia in your n8n workflows",
+  subtitle: '={{ $parameter.operation.replace(/([a-z])([A-Z])/g, "$1 $2").toTitleCase() }}',
+  icon: "file:algolia.svg",
+  defaults: {
+    name: "Algolia"
+  },
+  credentials: [
+    {
+      name: "algoliaApi",
+      required: true
+    }
+  ],
+  requestDefaults: {
+    baseURL: "=https://{{ $credentials.appId }}.algolia.net",
+    headers: {
+      "User-Agent": `${pkg.name} (${pkg.version})`
+    }
+  }
+}).addResource(index).addResource(objects);
+class Algolia {
+  constructor() {
+    this.description = description.apply();
+  }
+}
+
+exports.Algolia = Algolia;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@algolia/n8n-nodes-algolia",
+  "version": "0.4.2",
+  "description": "Algolia nodes for n8n",
+  "keywords": [
+    "n8n-community-node-package",
+    "algolia",
+    "n8n"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/algolia/n8n-nodes-algolia",
+  "author": {
+    "name": "Algolia",
+    "email": "support@algolia.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/algolia/n8n-nodes-algolia.git"
+  },
+  "engines": {
+    "node": ">=20.15"
+  },
+  "main": "index.js",
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "format": "prettier nodes credentials --write",
+    "lint": "eslint nodes credentials package.json",
+    "lintfix": "eslint nodes credentials package.json --fix",
+    "prepublishOnly": "npm run build && npm run lint -c .eslintrc.prepublish.js nodes credentials package.json",
+    "release": "shipjs prepare"
+  },
+  "files": [
+    "dist"
+  ],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "credentials": [
+      "dist/credentials/AlgoliaApi.credentials.js"
+    ],
+    "nodes": [
+      "dist/nodes/Algolia/Algolia.node.js"
+    ]
+  },
+  "devDependencies": {
+    "@typescript-eslint/parser": "~8.32.0",
+    "concurrently": "^9.2.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-n8n-nodes-base": "^1.16.3",
+    "prettier": "^3.5.3",
+    "shelljs": "^0.10.0",
+    "shipjs": "^0.27.0",
+    "tsc-alias": "^1.8.16",
+    "typescript": "^5.8.2",
+    "vite": "^7.0.6",
+    "vite-plugin-static-copy": "^3.1.1"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}