n8n-nodes-gereft 0.1.0 → 0.1.2

package/README.md

@@ -1,69 +1,60 @@
 # n8n-nodes-gereft
 
-نود n8n برای API گرفت. فیلدها به‌صورت خودکار از روی Swagger بک‌اند (`/docs/swagger.json`) با کتابخانه‌ی
-[`@devlikeapro/n8n-openapi-node`](https://github.com/devlikeapro/n8n-openapi-node) ساخته می‌شوند.
+An [n8n](https://n8n.io) community node for the Gereft API.
 
-- هر **tag** در Swagger یک **Resource** است و هر endpoint یک **Operation**.
-- فیلدهای اجباری (path و query/body اجباری) مستقیم نمایش داده می‌شوند. همه‌ی فیلدهای اختیاری در
-  **Additional Fields** هستند و فقط فیلدهایی ارسال می‌شوند که کاربر اضافه کرده است. این کار جلوی پاک شدن داده
-  در endpointهای update با مقدارهای پیش‌فرض (`''`، `0`، `true`) را می‌گیرد.
-- آبجکت‌ها و آرایه‌های تو در توی body یک فیلد JSON هستند.
-- endpointهای `multipart` (مثل `POST /media/upload`) پشتیبانی نمی‌شوند و برای آن‌ها از نود HTTP Request استفاده کنید.
+The node is generated from Gereft's OpenAPI spec, so it covers the whole API: each API section (Invoice, Note, Rfq, …)
+is a **Resource**, and each endpoint is an **Operation**. Required parameters are shown directly. Optional ones are
+under **Additional Fields**, and only the fields you add there are sent. Nested objects and arrays in a request body
+are entered as JSON.
 
-## دستورها
+The node can also be used as a tool by n8n's AI Agent.
 
-```bash
-pnpm install
-pnpm update        # دریافت اسپک از api.gereft.com + build
-pnpm build         # فقط build از openapi/gereft.json موجود
-node scripts/fetch-spec.mjs ../backend/dist/public/swagger.json   # اسپک از بک‌اند لوکال
-pnpm e2e           # تست end-to-end داخل n8n واقعی (Docker) با mock server
-```
+## Installation
 
-کدام tagها وارد نود شوند در `spec.config.json` تعیین می‌شود (`includeTags` خالی یعنی همه، به‌جز `excludeTags`).
+### From the n8n UI (recommended)
 
-بعد از هر تغییر API در بک‌اند: `pnpm update`، نسخه را در `package.json` بالا ببرید و دوباره نصب کنید.
+1. In n8n, open **Settings → Community Nodes**.
+2. Click **Install**, enter `n8n-nodes-gereft`, accept the risk notice, and click **Install**.
+3. The **Gereft** node now appears in the node panel.
 
-## نصب روی n8n (self-hosted / Docker)
+To update, open **Settings → Community Nodes** and click **Update** on the package.
 
-**روش ۱: پوشه‌ی custom (ساده‌ترین)**
-پوشه‌ی `dist` را در کانتینر n8n در `/home/node/.n8n/custom/n8n-nodes-gereft` قرار دهید (یا mount کنید) و n8n را
-ری‌استارت کنید:
+> Community nodes are only available on self-hosted n8n. The n8n server needs access to `registry.npmjs.org`. If it
+> doesn't have that access, use the manual install below.
 
-```yaml
-services:
-  n8n:
-    volumes:
-      - ./n8n-nodes-gereft/dist:/home/node/.n8n/custom/n8n-nodes-gereft:ro
-```
+### Manual install (offline / no npm access)
 
-**روش ۲: پکیج npm**
-پکیج روی npm منتشر شده است: در n8n به Settings → Community Nodes → Install بروید و `n8n-nodes-gereft` را وارد کنید.
-(در Docker باید `N8N_COMMUNITY_PACKAGES_ENABLED` فعال باشد، که پیش‌فرض فعال است.)
+1. Download the package on a machine with internet access:
+   ```bash
+   npm pack n8n-nodes-gereft
+   ```
+2. Copy the `.tgz` file into the n8n container and install it:
+   ```bash
+   docker cp n8n-nodes-gereft-<version>.tgz <n8n-container>:/tmp/
+   docker exec -u node <n8n-container> sh -c \
+     'mkdir -p ~/.n8n/nodes && cd ~/.n8n/nodes && npm install /tmp/n8n-nodes-gereft-<version>.tgz'
+   ```
+3. Restart n8n: `docker restart <n8n-container>`.
 
-بدون اینترنت: `pnpm pack` یک فایل `.tgz` می‌سازد. آن را داخل کانتینر در `~/.n8n/nodes` با `npm install <file>.tgz` نصب کنید.
+## Credentials
 
-انتشار نسخه‌ی جدید: نسخه را در `package.json` بالا ببرید و `npm publish` بزنید (`prepublishOnly` خودش build می‌کند).
+Create a credential of type **Gereft API**:
 
-> نوع نود در روش ۱ `CUSTOM.gereft` و در روش ۲ `n8n-nodes-gereft.gereft` است. workflowها بین این دو روش جابه‌جا نمی‌شوند،
-> پس از اول یکی را انتخاب کنید.
+| Field          | Value                                          |
+|----------------|------------------------------------------------|
+| Base URL       | `https://api.gereft.com` (default)             |
+| Authentication | **API Key** or **Bearer Token (JWT)**          |
 
-## Credential
+- **API Key**: a server API key. It has full access, but requests are not tied to a user. Endpoints that depend on the
+  current user (for example `/auth/me` or "my" lists) won't work with it.
+- **Bearer Token (JWT)**: a Gereft user's token. Requests run as that user, with that user's permissions. The token
+  expires and then has to be replaced.
 
-در n8n یک credential از نوع **Gereft API** بسازید:
+## Limitations
 
-| فیلد | توضیح |
-|---|---|
-| Base URL | پیش‌فرض `https://api.gereft.com` |
-| Authentication | `API Key` یا `Bearer Token (JWT)` |
+- File uploads (`multipart/form-data` endpoints such as `POST /media/upload`) aren't supported. Use n8n's
+  **HTTP Request** node for those.
 
-- **API Key**: هدر `x-api-key` برابر با `API_KEY` بک‌اند. هر دو guard (Auth و Roles) را دور می‌زند، پس دسترسی کامل
-  دارد، ولی **`req.user` ست نمی‌شود**. endpointهایی که به کاربر جاری نیاز دارند (`/auth/me`، `createdBy`، «درخواست‌های من»
-  و …) با این روش درست کار نمی‌کنند.
-- **Bearer Token**: JWT یک کاربر گرفت، با همان سطح دسترسی آن کاربر. توکن منقضی می‌شود.
+## License
 
-دکمه‌ی Test credential در حالت API Key درخواست `GET /config` و در حالت Bearer درخواست `GET /auth/me` می‌زند.
-
-## Tool برای AI Agent
-
-نود `usableAsTool` است و می‌توان آن را مستقیم به AI Agent در n8n وصل کرد.
+[MIT](LICENSE)

package/dist/credentials/GereftApi.credentials.js

@@ -5,7 +5,7 @@ class GereftApi {
     name = 'gereftApi';
     displayName = 'Gereft API';
     documentationUrl = 'https://api.gereft.com/swagger';
-    icon = 'file:gereft.svg';
+    icon = { dark: 'file:gereft.dark.png', light: 'file:gereft.png' };
     properties = [
         {
             default: 'https://api.gereft.com',

package/dist/nodes/Gereft/Gereft.node.js

@@ -16,7 +16,7 @@ class Gereft {
         description: "Interact with the Gereft API",
         displayName: "Gereft",
         group: ["transform"],
-        icon: "file:gereft.svg",
+        icon: { dark: "file:gereft.dark.png", light: "file:gereft.png" },
         inputs: ["main"],
         name: "gereft",
         outputs: ["main"],