n8n-nodes-redlib 0.1.1 → 1.0.1

package/README.md

@@ -1,247 +1,147 @@
-![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)
-
 # n8n-nodes-redlib
 
-This starter repository helps you build custom integrations for [n8n](https://n8n.io). It includes example nodes, credentials, the node linter, and all the tooling you need to get started.
-
-## Quick Start
-
-> [!TIP]
-> **New to building n8n nodes?** The fastest way to get started is with `npm create @n8n/node`. This command scaffolds a complete node package for you using the [@n8n/node-cli](https://www.npmjs.com/package/@n8n/node-cli).
-
-**To create a new node package from scratch:**
-
-```bash
-npm create @n8n/node
-```
-
-**Already using this starter? Start developing with:**
-
-```bash
-npm run dev
-```
-
-This starts n8n with your nodes loaded and hot reload enabled.
-
-## What's Included
-
-This starter repository includes two example nodes to learn from:
-
-- **[Example Node](nodes/Example/)** - A simple starter node that shows the basic structure with a custom `execute` method
-- **[GitHub Issues Node](nodes/GithubIssues/)** - A complete, production-ready example built using the **declarative style**:
-  - **Low-code approach** - Define operations declaratively without writing request logic
-  - Multiple resources (Issues, Comments)
-  - Multiple operations (Get, Get All, Create)
-  - Two authentication methods (OAuth2 and Personal Access Token)
-  - List search functionality for dynamic dropdowns
-  - Proper error handling and typing
-  - Ideal for HTTP API-based integrations
-
-> [!TIP]
-> The declarative/low-code style (used in GitHub Issues) is the recommended approach for building nodes that interact with HTTP APIs. It significantly reduces boilerplate code and handles requests automatically.
+[n8n](https://n8n.io/) community node for fetching Reddit data through Redlib without OAuth authentication.
 
-Browse these examples to understand both approaches, then modify them or create your own.
+> **Disclaimer**: This project is not affiliated with, endorsed by, or connected to [Redlib](https://github.com/redlib-org/redlib) in any way. Redlib is a separate independent project. This node simply uses publicly accessible Redlib instances to fetch Reddit data.
 
-## Finding Inspiration
+## Why This Node?
 
-Looking for more examples? Check out these resources:
+In November 2025, Reddit introduced the [Responsible Builder Policy](https://www.reddit.com/r/redditdev/comments/1oug31u/introducing_the_responsible_builder_policy_new/), which significantly restricts the creation of new OAuth2 applications. Developers can no longer self-serve OAuth2 apps and must instead submit a support ticket with a low approval rate.
 
-- **[npm Community Nodes](https://www.npmjs.com/search?q=keywords:n8n-community-node-package)** - Browse thousands of community-built nodes on npm using the `n8n-community-node-package` tag
-- **[n8n Built-in Nodes](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes)** - Study the source code of n8n's official nodes for production-ready patterns and best practices
-- **[n8n Credentials](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/credentials)** - See how authentication is implemented for various services
+This node exists to help n8n users continue to fetch Reddit data for automation workflows without needing OAuth2 credentials. It uses [Redlib](https://github.com/redlib-org/redlib)—a private Reddit frontend—to scrape public Reddit data and return it in the same format as the Reddit API.
 
-These are excellent resources to understand how to structure your nodes, handle different API patterns, and implement advanced features.
+## What is Redlib?
 
-## Prerequisites
+Redlib is an alternative private front-end to Reddit. It provides a clean, privacy-focused interface for browsing Reddit without tracking. This node uses Redlib instances to fetch public Reddit data (posts, comments, subreddit information) and parses the HTML to return structured data compatible with the Reddit API format.
 
-Before you begin, install the following on your development machine:
+> **Note**: This project is independent from Redlib. For issues related to Redlib itself, please visit the [Redlib GitHub repository](https://github.com/redlib-org/redlib).
 
-### Required
+[Installation](#installation)
+[Operations](#operations)
+[Credentials](#credentials)
+[Compatibility](#compatibility)
+[Resources](#resources)
 
-- **[Node.js](https://nodejs.org/)** (v22 or higher) and npm
-  - Linux/Mac/WSL: Install via [nvm](https://github.com/nvm-sh/nvm)
-  - Windows: Follow [Microsoft's NodeJS guide](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows)
-- **[git](https://git-scm.com/downloads)**
+## Installation
 
-### Recommended
-
-- Follow n8n's [development environment setup guide](https://docs.n8n.io/integrations/creating-nodes/build/node-development-environment/)
-
-> [!NOTE]
-> The `@n8n/node-cli` is included as a dev dependency and will be installed automatically when you run `npm install`. The CLI includes n8n for local development, so you don't need to install n8n globally.
-
-## Getting Started with this Starter
-
-Follow these steps to create your own n8n community node package:
-
-### 1. Create Your Repository
-
-[Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from this template, then clone it:
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
 
 ```bash
-git clone https://github.com/<your-organization>/<your-repo-name>.git
-cd <your-repo-name>
+# In your n8n installation directory
+npm install n8n-nodes-redlib
 ```
 
-### 2. Install Dependencies
-
-```bash
-npm install
-```
+## Operations
 
-This installs all required dependencies including the `@n8n/node-cli`.
+### Post
 
-### 3. Explore the Examples
+| Operation | Description |
+|-----------|-------------|
+| **Search** | Search for posts in a subreddit by keyword |
+| **Get** | Get a single post by ID |
+| **Get Many** | Get multiple posts from a subreddit (hot/new/top/rising) |
 
-Browse the example nodes in [nodes/](nodes/) and [credentials/](credentials/) to understand the structure:
+### Post Comment
 
-- Start with [nodes/Example/](nodes/Example/) for a basic node
-- Study [nodes/GithubIssues/](nodes/GithubIssues/) for a real-world implementation
+| Operation | Description |
+|-----------|-------------|
+| **Search** | Search for posts containing a keyword |
+| **Get** | Get comments from a specific post |
+| **Get Many** | Get comments from multiple posts |
 
-### 4. Build Your Node
+### Subreddit
 
-Edit the example nodes to fit your use case, or create new node files by copying the structure from [nodes/Example/](nodes/Example/).
+| Operation | Description |
+|-----------|-------------|
+| **Search** | Search for subreddits by keyword |
+| **Get** | Get subreddit information |
+| **Get Many** | Get multiple subreddits or trending subreddits |
 
-> [!TIP]
-> If you want to scaffold a completely new node package, use `npm create @n8n/node` to start fresh with the CLI's interactive generator.
+## Credentials
 
-### 5. Configure Your Package
+**Redlib API** - Configure access to a Redlib instance.
 
-Update `package.json` with your details:
+| Property | Description |
+|----------|-------------|
+| **Instance URL** | URL of the Redlib instance to use (default: `https://redlib.catsarch.com`) |
+| **Authentication** | None or Basic Auth (if your Redlib instance requires authentication) |
+| **Username** | Username for Basic Auth (if required) |
+| **Password** | Password for Basic Auth (if required) |
 
-- `name` - Your package name (must start with `n8n-nodes-`)
-- `author` - Your name and email
-- `repository` - Your repository URL
-- `description` - What your node does
+### Finding a Redlib Instance
 
-Make sure your node is registered in the `n8n.nodes` array.
+You can use any public Redlib instance. A list of public instances is available at [redlibinstances.github.io](https://redlibinstances.github.io). Popular instances include:
 
-### 6. Develop and Test Locally
+- `https://redlib.catsarch.com`
+- `https://redlib.privacydev.net`
+- `https://redlib.nerdvpn.de`
 
-Start n8n with your node loaded:
+> **Note**: Public instances may have rate limits. Consider hosting your own Redlib instance for production use.
 
-```bash
-npm run dev
-```
+## Compatibility
 
-This command runs `n8n-node dev` which:
+Minimum n8n version: **1.0.0**
 
-- Builds your node with watch mode
-- Starts n8n with your node available
-- Automatically rebuilds when you make changes
-- Opens n8n in your browser (usually http://localhost:5678)
+Tested with n8n versions: **1.x**
 
-You can now test your node in n8n workflows!
+## Usage
 
-> [!NOTE]
-> Learn more about CLI commands in the [@n8n/node-cli documentation](https://www.npmjs.com/package/@n8n/node-cli).
+### Example: Get Posts from a Subreddit
 
-### 7. Lint Your Code
+1. Add the **Redlib** node to your workflow
+2. Select **Post** > **Get Many** operation
+3. Enter subreddit name (e.g., `technology`)
+4. Select category (hot, new, top, or rising)
+5. Set the limit for number of results
 
-Check for errors:
+### Example: Search for Posts
 
-```bash
-npm run lint
-```
+1. Add the **Redlib** node to your workflow
+2. Select **Post** > **Search** operation
+3. Enter subreddit name (e.g., `SaaS`)
+4. Enter search keyword (e.g., `marketing`)
+5. Sort by relevance, hot, top, or new
 
-Auto-fix issues when possible:
+### Example: Get Comments from a Post
 
-```bash
-npm run lint:fix
-```
+1. Add the **Redlib** node to your workflow
+2. Select **Post Comment** > **Get** operation
+3. Enter subreddit name (e.g., `technology`)
+4. Enter post ID (e.g., `1pudg98`)
+5. Set the limit for number of comments
 
-### 8. Build for Production
+### Output Format
 
-When ready to publish:
+The node returns data in the same format as the Reddit API:
 
-```bash
-npm run build
+```json
+{
+  "kind": "Listing",
+  "data": {
+    "children": [
+      {
+        "kind": "t3",
+        "data": {
+          "id": "1pudg98",
+          "title": "Post title",
+          "author": "username",
+          "subreddit": "SaaS",
+          "selftext": "Post content",
+          "score": 74,
+          "num_comments": 52,
+          "created_utc": 1766547398.0,
+          "permalink": "/r/SaaS/comments/1pudg98/...",
+          "url": "https://www.reddit.com/..."
+        }
+      }
+    ]
+  }
+}
 ```
 
-This compiles your TypeScript code to the `dist/` folder.
-
-### 9. Prepare for Publishing
-
-Before publishing:
-
-1. **Update documentation**: Replace this README with your node's documentation. Use [README_TEMPLATE.md](README_TEMPLATE.md) as a starting point.
-2. **Update the LICENSE**: Add your details to the [LICENSE](LICENSE.md) file.
-3. **Test thoroughly**: Ensure your node works in different scenarios.
-
-### 10. Publish to npm
-
-Publish your package to make it available to the n8n community:
-
-```bash
-npm publish
-```
-
-Learn more about [publishing to npm](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
-
-### 11. Submit for Verification (Optional)
-
-Get your node verified for n8n Cloud:
-
-1. Ensure your node meets the [requirements](https://docs.n8n.io/integrations/creating-nodes/deploy/submit-community-nodes/):
-   - Uses MIT license ✅ (included in this starter)
-   - No external package dependencies
-   - Follows n8n's design guidelines
-   - Passes quality and security review
-
-2. Submit through the [n8n Creator Portal](https://creators.n8n.io/nodes)
-
-**Benefits of verification:**
-
-- Available directly in n8n Cloud
-- Discoverable in the n8n nodes panel
-- Verified badge for quality assurance
-- Increased visibility in the n8n community
-
-## Available Scripts
-
-This starter includes several npm scripts to streamline development:
-
-| Script                | Description                                                      |
-| --------------------- | ---------------------------------------------------------------- |
-| `npm run dev`         | Start n8n with your node and watch for changes (runs `n8n-node dev`) |
-| `npm run build`       | Compile TypeScript to JavaScript for production (runs `n8n-node build`) |
-| `npm run build:watch` | Build in watch mode (auto-rebuild on changes)                    |
-| `npm run lint`        | Check your code for errors and style issues (runs `n8n-node lint`) |
-| `npm run lint:fix`    | Automatically fix linting issues when possible (runs `n8n-node lint --fix`) |
-| `npm run release`     | Create a new release (runs `n8n-node release`)                   |
-
-> [!TIP]
-> These scripts use the [@n8n/node-cli](https://www.npmjs.com/package/@n8n/node-cli) under the hood. You can also run CLI commands directly, e.g., `npx n8n-node dev`.
-
-## Troubleshooting
-
-### My node doesn't appear in n8n
-
-1. Make sure you ran `npm install` to install dependencies
-2. Check that your node is listed in `package.json` under `n8n.nodes`
-3. Restart the dev server with `npm run dev`
-4. Check the console for any error messages
-
-### Linting errors
-
-Run `npm run lint:fix` to automatically fix most common issues. For remaining errors, check the [n8n node development guidelines](https://docs.n8n.io/integrations/creating-nodes/).
-
-### TypeScript errors
-
-Make sure you're using Node.js v22 or higher and have run `npm install` to get all type definitions.
-
 ## Resources
 
-- **[n8n Node Documentation](https://docs.n8n.io/integrations/creating-nodes/)** - Complete guide to building nodes
-- **[n8n Community Forum](https://community.n8n.io/)** - Get help and share your nodes
-- **[@n8n/node-cli Documentation](https://www.npmjs.com/package/@n8n/node-cli)** - CLI tool reference
-- **[n8n Creator Portal](https://creators.n8n.io/nodes)** - Submit your node for verification
-- **[Submit Community Nodes Guide](https://docs.n8n.io/integrations/creating-nodes/deploy/submit-community-nodes/)** - Verification requirements and process
-
-## Contributing
-
-Have suggestions for improving this starter? [Open an issue](https://github.com/n8n-io/n8n-nodes-starter/issues) or submit a pull request!
-
-## License
-
-[MIT](https://github.com/n8n-io/n8n-nodes-starter/blob/master/LICENSE.md)
+* [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+* [Redlib GitHub Repository](https://github.com/redlib-org/redlib)
+* [Public Redlib Instances](https://redlibinstances.github.io)
+* [n8n Node Development Guide](https://docs.n8n.io/integrations/creating-nodes/)

package/dist/credentials/RedlibApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import type { ICredentialType, INodeProperties, IAuthenticateGeneric, ICredentialTestRequest } from 'n8n-workflow';
+export declare class RedlibApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    testedBy: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/RedlibApi.credentials.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedlibApi = void 0;
+class RedlibApi {
+    constructor() {
+        this.name = 'redlibApi';
+        this.displayName = 'Redlib API';
+        this.documentationUrl = 'https://github.com/yuangwei/n8n-nodes-redlib';
+        this.testedBy = 'redlib';
+        this.properties = [
+            {
+                displayName: 'Instance URL',
+                name: 'instanceUrl',
+                type: 'string',
+                default: 'https://redlib.catsarch.com',
+                required: true,
+                description: 'URL of the Redlib instance to use',
+            },
+            {
+                displayName: 'Authentication',
+                name: 'authType',
+                type: 'options',
+                options: [
+                    {
+                        name: 'None',
+                        value: 'none',
+                        description: 'No authentication required',
+                    },
+                    {
+                        name: 'Basic Auth',
+                        value: 'basicAuth',
+                        description: 'Username and password authentication',
+                    },
+                ],
+                default: 'none',
+            },
+            {
+                displayName: 'Username',
+                name: 'username',
+                type: 'string',
+                displayOptions: {
+                    show: {
+                        authType: ['basicAuth'],
+                    },
+                },
+                default: '',
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                displayOptions: {
+                    show: {
+                        authType: ['basicAuth'],
+                    },
+                },
+                default: '',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    'User-Agent': 'n8n-redlib-node/1.0',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.instanceUrl}}',
+                url: '/',
+            },
+        };
+    }
+}
+exports.RedlibApi = RedlibApi;
+//# sourceMappingURL=RedlibApi.credentials.js.map

package/dist/credentials/RedlibApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedlibApi.credentials.js","sourceRoot":"","sources":["../../credentials/RedlibApi.credentials.ts"],"names":[],"mappings":";;;AAQA,MAAa,SAAS;IAAtB;QACE,SAAI,GAAG,WAAW,CAAC;QACnB,gBAAW,GAAG,YAAY,CAAC;QAC3B,qBAAgB,GAAG,8CAA8C,CAAC;QAClE,aAAQ,GAAG,QAAQ,CAAC;QACpB,eAAU,GAAsB;YAC9B;gBACE,WAAW,EAAE,cAAc;gBAC3B,IAAI,EAAE,aAAa;gBACnB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,mCAAmC;aACjD;YACD;gBACE,WAAW,EAAE,gBAAgB;gBAC7B,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAM;wBACZ,KAAK,EAAE,MAAM;wBACb,WAAW,EAAE,4BAA4B;qBAC1C;oBACD;wBACE,IAAI,EAAE,YAAY;wBAClB,KAAK,EAAE,WAAW;wBAClB,WAAW,EAAE,sCAAsC;qBACpD;iBACF;gBACD,OAAO,EAAE,MAAM;aAChB;YACD;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,cAAc,EAAE;oBACd,IAAI,EAAE;wBACJ,QAAQ,EAAE,CAAC,WAAW,CAAC;qBACxB;iBACF;gBACD,OAAO,EAAE,EAAE;aACZ;YACD;gBACE,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;iBACf;gBACD,cAAc,EAAE;oBACd,IAAI,EAAE;wBACJ,QAAQ,EAAE,CAAC,WAAW,CAAC;qBACxB;iBACF;gBACD,OAAO,EAAE,EAAE;aACZ;SACF,CAAC;QACF,iBAAY,GAAyB;YACnC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,YAAY,EAAE,qBAAqB;iBACpC;aACF;SACF,CAAC;QACF,SAAI,GAA2B;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,+BAA+B;gBACxC,GAAG,EAAE,GAAG;aACT;SACF,CAAC;IACJ,CAAC;CAAA;AAxED,8BAwEC"}

package/dist/icons/redlib.dark.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" fill="none">
+ <rect x="10" y="10" width="80" height="80" rx="12" fill="#FF4500" stroke="#E0E0E0" stroke-width="2"/>
+ <path d="M30 40 Q50 30 70 40" stroke="#FFFFFF" stroke-width="4" stroke-linecap="round" fill="none"/>
+ <circle cx="35" cy="45" r="8" fill="#FFFFFF"/>
+ <circle cx="65" cy="45" r="8" fill="#FFFFFF"/>
+ <circle cx="35" cy="45" r="3" fill="#E0E0E0"/>
+ <circle cx="65" cy="45" r="3" fill="#E0E0E0"/>
+ <path d="M40 60 Q50 70 60 60" stroke="#FFFFFF" stroke-width="3" stroke-linecap="round" fill="none"/>
+ <rect x="20" y="25" width="25" height="8" rx="2" fill="#FF5722"/>
+ <rect x="55" y="25" width="25" height="8" rx="2" fill="#FF5722"/>
+</svg>

package/dist/icons/redlib.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" fill="none">
+ <rect x="10" y="10" width="80" height="80" rx="12" fill="#FF4500" stroke="#1A1A1B" stroke-width="2"/>
+ <path d="M30 40 Q50 30 70 40" stroke="#FFFFFF" stroke-width="4" stroke-linecap="round" fill="none"/>
+ <circle cx="35" cy="45" r="8" fill="#FFFFFF"/>
+ <circle cx="65" cy="45" r="8" fill="#FFFFFF"/>
+ <circle cx="35" cy="45" r="3" fill="#1A1A1B"/>
+ <circle cx="65" cy="45" r="3" fill="#1A1A1B"/>
+ <path d="M40 60 Q50 70 60 60" stroke="#FFFFFF" stroke-width="3" stroke-linecap="round" fill="none"/>
+ <rect x="20" y="25" width="25" height="8" rx="2" fill="#FF5722"/>
+ <rect x="55" y="25" width="25" height="8" rx="2" fill="#FF5722"/>
+</svg>

package/dist/nodes/Redlib/Redlib.node.d.ts

@@ -0,0 +1,6 @@
+import { type IExecuteFunctions, type INodeType, type INodeTypeDescription, type INodeExecutionData } from 'n8n-workflow';
+export declare class Redlib implements INodeType {
+    description: INodeTypeDescription;
+    private getNodeProperties;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}