@youdotcom-oss/n8n-nodes-youdotcom 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +117 -0
  2. package/package.json +91 -0
package/README.md ADDED
@@ -0,0 +1,117 @@
1
+ # n8n-nodes-youdotcom
2
+
3
+ An n8n community node for integrating [You.com APIs](https://you.com/api) into your n8n workflows. Search the web, extract content from URLs, or get AI-powered answers with citations.
4
+
5
+ ## Installation
6
+
7
+ Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
8
+
9
+ ```bash
10
+ npm install @youdotcom-oss/n8n-nodes-youdotcom
11
+ ```
12
+
13
+ Or install via the n8n UI:
14
+
15
+ 1. Go to **Settings > Community Nodes**
16
+ 2. Select **Install**
17
+ 3. Enter `@youdotcom-oss/n8n-nodes-youdotcom`
18
+ 4. Agree to the risks and select **Install**
19
+
20
+ ## Operations
21
+
22
+ ### Search
23
+
24
+ Search the web and news using You.com's search API.
25
+
26
+ | Parameter | Required | Description |
27
+ | ---------------- | -------- | ------------------------------------------------------- |
28
+ | Query | Yes | The search query to retrieve relevant results |
29
+ | Count | No | Maximum number of results per section (1-100) |
30
+ | Country | No | Country code for geographical focus (e.g., US, GB, DE) |
31
+ | Freshness | No | Filter by recency: day, week, month, or year |
32
+ | Language | No | Language of results (BCP 47 format) |
33
+ | Livecrawl | No | Fetch full page content for web, news, or all results |
34
+ | Livecrawl Format | No | Format for livecrawled content (HTML or Markdown) |
35
+ | Offset | No | Pagination offset (0-9) |
36
+ | Safe Search | No | Content moderation: off, moderate, or strict |
37
+ | Site | No | Restrict results to a specific domain |
38
+ | File Type | No | Filter results by file type (e.g., pdf, doc) |
39
+ | Exclude Terms | No | Terms to exclude (pipe-separated) |
40
+ | Exact Terms | No | Require exact phrase matches (pipe-separated) |
41
+
42
+ ### Get Contents
43
+
44
+ Extract content from one or more URLs. Returns clean text, HTML, or structured metadata.
45
+
46
+ | Parameter | Required | Description |
47
+ | ------------- | -------- | -------------------------------------------------------- |
48
+ | URLs | Yes | Comma-separated list of URLs to extract content from |
49
+ | Formats | No | Output formats: Markdown, HTML, and/or Metadata |
50
+ | Crawl Timeout | No | Timeout in seconds for page crawling (1-60) |
51
+
52
+ **Output formats:**
53
+
54
+ - **Markdown** - Clean text content, ideal for LLM processing
55
+ - **HTML** - Full HTML with layout preserved
56
+ - **Metadata** - Structured data (JSON-LD, OpenGraph, Twitter Cards)
57
+
58
+ ### Express (AI Agent)
59
+
60
+ Get AI-generated answers with web search and citations. Perfect for RAG (Retrieval-Augmented Generation) workflows.
61
+
62
+ | Parameter | Required | Description |
63
+ | ----------------- | -------- | ---------------------------------------------------- |
64
+ | Input | Yes | Question or prompt for the AI agent |
65
+ | Enable Web Search | No | Whether the AI should search the web (default: true) |
66
+
67
+ **Response includes:**
68
+
69
+ - `answer` - AI-generated response with citations
70
+ - `searchResults` - Web search results used for grounding (when web search is enabled)
71
+ - `agent` - Agent identifier
72
+
73
+ ## Credentials
74
+
75
+ 1. Visit [you.com/api](https://you.com/api) to get an API key
76
+ 2. In n8n, go to **Credentials > New Credential**
77
+ 3. Search for "You.com API"
78
+ 4. Enter your API key and save
79
+
80
+ ## Example Use Cases
81
+
82
+ - **Research workflows**: Search for information and extract full content from top results
83
+ - **Content aggregation**: Monitor news across topics with customizable filters
84
+ - **AI assistants**: Build chatbots with real-time web knowledge using Express
85
+ - **Data enrichment**: Extract metadata from URLs in your workflows
86
+ - **RAG pipelines**: Ground LLM responses with current web information
87
+
88
+ ## Development
89
+
90
+ ```bash
91
+ # Install dependencies
92
+ bun install
93
+
94
+ # Build the package
95
+ bun run build
96
+
97
+ # Run tests
98
+ bun test
99
+
100
+ # Type checking
101
+ bun run check:types
102
+
103
+ # Linting and formatting
104
+ bun run check
105
+ ```
106
+
107
+ ## Resources
108
+
109
+ - [You.com API Documentation](https://docs.you.com/)
110
+ - [Search API Reference](https://docs.you.com/api-reference/search)
111
+ - [Contents API Reference](https://docs.you.com/api-reference/search/contents)
112
+ - [Express Agent Reference](https://docs.you.com/agents/overview#express-agent)
113
+ - [n8n Community Nodes Documentation](https://docs.n8n.io/integrations/community-nodes/)
114
+
115
+ ## License
116
+
117
+ MIT
package/package.json ADDED
@@ -0,0 +1,91 @@
1
+ {
2
+ "name": "@youdotcom-oss/n8n-nodes-youdotcom",
3
+ "version": "0.0.1",
4
+ "description": "n8n community node for You.com APIs - Search, Contents extraction, and Express AI agent",
5
+ "license": "MIT",
6
+ "engines": {
7
+ "node": ">=18",
8
+ "bun": ">= 1.2.21"
9
+ },
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/youdotcom-oss/dx-toolkit.git",
13
+ "directory": "packages/n8n-nodes-youdotcom"
14
+ },
15
+ "bugs": {
16
+ "url": "https://github.com/youdotcom-oss/dx-toolkit/issues"
17
+ },
18
+ "homepage": "https://github.com/youdotcom-oss/dx-toolkit/tree/main/packages/n8n-nodes-youdotcom#readme",
19
+ "author": {
20
+ "name": "You.com",
21
+ "url": "https://you.com"
22
+ },
23
+ "keywords": [
24
+ "n8n",
25
+ "n8n-community-node-package",
26
+ "you.com",
27
+ "search",
28
+ "web search",
29
+ "ai search",
30
+ "contents",
31
+ "scrape",
32
+ "crawl",
33
+ "express",
34
+ "ai agent",
35
+ "rag",
36
+ "grounding"
37
+ ],
38
+ "type": "module",
39
+ "main": "./dist/main.js",
40
+ "exports": {
41
+ ".": {
42
+ "types": "./dist/main.d.ts",
43
+ "default": "./dist/main.js"
44
+ }
45
+ },
46
+ "files": [
47
+ "dist/**"
48
+ ],
49
+ "publishConfig": {
50
+ "access": "public"
51
+ },
52
+ "scripts": {
53
+ "build": "bun run build:js && bun run build:types && bun run build:assets",
54
+ "build:assets": "cp nodes/YouDotCom/youdotcom.svg dist/nodes/YouDotCom/ && cp nodes/YouDotCom/YouDotCom.node.json dist/nodes/YouDotCom/ && cp nodes/YouDotCom/youdotcom.svg dist/credentials/",
55
+ "build:js": "bun build ./src/main.ts --outfile ./dist/main.js --target=node && bun build ./nodes/YouDotCom/YouDotCom.node.ts --outfile ./dist/nodes/YouDotCom/YouDotCom.node.js --target=node && bun build ./credentials/YouDotComApi.credentials.ts --outfile ./dist/credentials/YouDotComApi.credentials.js --target=node",
56
+ "build:types": "tsc --project tsconfig.build.json",
57
+ "check": "bun run check:biome && bun run check:types && bun run check:package",
58
+ "check:biome": "biome check",
59
+ "check:package": "format-package --check",
60
+ "check:types": "tsc --noEmit",
61
+ "check:write": "bun run format && bun run lint:fix && bun run format:package",
62
+ "format": "biome format --write",
63
+ "format:check": "biome format",
64
+ "format:package": "format-package --write",
65
+ "lint": "biome lint",
66
+ "lint:fix": "biome lint --write",
67
+ "lint:n8n": "n8n-node lint",
68
+ "test": "bun test"
69
+ },
70
+ "n8n": {
71
+ "n8nNodesApiVersion": 1,
72
+ "credentials": [
73
+ "dist/credentials/YouDotComApi.credentials.js"
74
+ ],
75
+ "nodes": [
76
+ "dist/nodes/YouDotCom/YouDotCom.node.js"
77
+ ]
78
+ },
79
+ "types": "./dist/main.d.ts",
80
+ "dependencies": {
81
+ "@n8n/node-cli": "^0.18.0",
82
+ "zod": "^4.3.6"
83
+ },
84
+ "peerDependencies": {
85
+ "n8n-workflow": "^2.6.0"
86
+ },
87
+ "devDependencies": {
88
+ "eslint": "^9.29.0",
89
+ "n8n-workflow": "^2.6.0"
90
+ }
91
+ }