@opencloud-eu/n8n-nodes-opencloud 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2026 OpenCloud GmbH
+
+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,136 @@
+# @opencloud-eu/n8n-nodes-opencloud
+
+> n8n community node for [OpenCloud](https://opencloud.eu/) — files, folders
+> and shares against the OpenCloud API.
+
+Built on top of [Libre Graph](https://github.com/opencloud-eu/libre-graph-api)
+(metadata, sharing, drive enumeration) and OpenCloud WebDAV (content I/O,
+copy, move, delete).
+
+![Smoke workflow in the n8n editor — every operation in one chain](docs/smoke-workflow.png)
+
+---
+
+## Operations
+
+| Resource | Operations |
+| --- | --- |
+| **Space** | List |
+| **File** | Copy · Delete · Download · Move · Share · Upload |
+| **Folder** | Copy · Create · Delete · List · Move · Share |
+| **User** | Create · Delete · Get · Get Many · Update *(admin only)* |
+
+## Credentials
+
+| Field | Notes |
+| --- | --- |
+| **Server URL** | e.g. `https://opencloud.example.com` |
+| **User** | username or email |
+| **Password** | app token (preferred) or account password — Basic auth |
+| **Skip TLS verification** | accept self-signed or otherwise untrusted certs |
+
+Generate an app token from your OpenCloud profile for automation use; account
+passwords work for quick tests.
+
+## Install
+
+> **Status:** not yet published to npm. Once published, this will be installable
+> from n8n's UI: **Settings → Community Nodes → Install →
+> `@opencloud-eu/n8n-nodes-opencloud`**.
+
+For now, install from source:
+
+```bash
+git clone https://github.com/opencloud-eu/n8n-nodes-opencloud.git
+cd n8n-nodes-opencloud
+pnpm install
+pnpm build
+
+# Then either:
+#   a) symlink into your n8n custom-nodes directory
+mkdir -p ~/.n8n/custom
+ln -s "$(pwd)" ~/.n8n/custom/n8n-nodes-opencloud
+
+#   b) or pack and install via the n8n UI
+pnpm pack
+# Settings → Community Nodes → Install → upload the .tgz
+```
+
+Restart n8n after either step.
+
+---
+
+## Development
+
+Requires Node.js ≥ 20.15.
+
+```bash
+pnpm install
+pnpm build        # compile to dist/
+pnpm test         # vitest unit tests (mocked, fast)
+pnpm test:e2e     # Playwright end-to-end (see below)
+pnpm lint         # n8n-node lint, strict / Cloud-compatible
+pnpm typecheck
+```
+
+### Docker dev loop
+
+Pinned n8n in a container with this node mounted in; hot-reloads on `dist/`
+changes via `N8N_DEV_RELOAD=true`:
+
+```bash
+pnpm build              # one-off before first start
+docker compose up       # foreground
+pnpm build:w            # in another terminal — tsc --watch
+```
+
+Open <http://localhost:5678> and log in as **admin@example.com / admin**.
+Workflow editor → add node → search **OpenCloud**.
+
+Reset to a clean DB:
+
+```bash
+docker compose down -v
+```
+
+### Sample workflow
+
+`examples/smoke-test.workflow.json` exercises every operation against a real
+backend (the chain shown at the top of this README). Patch it with your
+credential id before importing:
+
+```bash
+./examples/apply-credentials.sh <credential-id> > /tmp/smoke.workflow.json
+```
+
+### End-to-end smoke
+
+`tests/e2e/smoke.spec.ts` is a Playwright test that automates the full path:
+log in to n8n → create the credential → import the example workflow → run from
+the manual trigger → assert success.
+
+For self-contained CI-style runs the compose file ships an OpenCloud service
+under the `ci` profile:
+
+```bash
+docker compose --profile ci up -d
+OPENCLOUD_URL=https://opencloud:9200 pnpm test:e2e
+```
+
+To target your own backend:
+
+```bash
+docker compose up -d
+OPENCLOUD_URL=https://host.docker.internal:9200 pnpm test:e2e
+```
+
+Env vars: `OPENCLOUD_URL` (required), `OPENCLOUD_USER` /
+`OPENCLOUD_PASSWORD` (default `admin`/`admin`), `N8N_URL` / `N8N_EMAIL` /
+`N8N_PASSWORD` (defaults match the compose stack). On failure Playwright
+saves traces, screenshots and videos to `test-results/`.
+
+---
+
+## License
+
+MIT — see [`LICENSE.md`](./LICENSE.md). Copyright OpenCloud GmbH.

package/dist/credentials/OpenCloudApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import type { ICredentialDataDecryptedObject, ICredentialTestRequest, ICredentialType, IHttpRequestOptions, Icon, INodeProperties } from 'n8n-workflow';
+export declare class OpenCloudApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    icon: Icon;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate(credentials: ICredentialDataDecryptedObject, requestOptions: IHttpRequestOptions): Promise<IHttpRequestOptions>;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/OpenCloudApi.credentials.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenCloudApi = void 0;
+class OpenCloudApi {
+    constructor() {
+        this.name = 'openCloudApi';
+        this.displayName = 'OpenCloud API';
+        this.icon = 'file:../icons/opencloud.svg';
+        this.documentationUrl = 'https://docs.opencloud.eu/';
+        this.properties = [
+            {
+                displayName: 'Server URL',
+                name: 'serverUrl',
+                type: 'string',
+                placeholder: 'https://opencloud.example.com',
+                default: '',
+                description: 'Base URL of the OpenCloud server',
+            },
+            {
+                displayName: 'User',
+                name: 'user',
+                type: 'string',
+                default: '',
+            },
+            {
+                displayName: 'Password',
+                name: 'password',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                description: 'OpenCloud app token (preferred) or account password. Generate an app token from your OpenCloud profile for automation use.',
+            },
+            {
+                displayName: 'Skip TLS Certificate Verification',
+                name: 'skipTlsVerification',
+                type: 'boolean',
+                default: false,
+                description: 'Whether to accept self-signed or otherwise untrusted TLS certificates. Useful for local dev OpenCloud instances; never enable against production servers.',
+            },
+        ];
+        this.test = {
+            request: {
+                baseURL: '={{ $credentials.serverUrl.replace(/\\/+$/, "") }}',
+                url: '/graph/v1.0/me/drives',
+                skipSslCertificateValidation: '={{$credentials.skipTlsVerification}}',
+            },
+        };
+    }
+    async authenticate(credentials, requestOptions) {
+        requestOptions.auth = {
+            username: credentials.user,
+            password: credentials.password,
+        };
+        if (credentials.skipTlsVerification === true) {
+            requestOptions.skipSslCertificateValidation = true;
+        }
+        return requestOptions;
+    }
+}
+exports.OpenCloudApi = OpenCloudApi;
+//# sourceMappingURL=OpenCloudApi.credentials.js.map

package/dist/credentials/OpenCloudApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenCloudApi.credentials.js","sourceRoot":"","sources":["../../credentials/OpenCloudApi.credentials.ts"],"names":[],"mappings":";;;AASA,MAAa,YAAY;IAAzB;QACC,SAAI,GAAG,cAAc,CAAC;QAEtB,gBAAW,GAAG,eAAe,CAAC;QAE9B,SAAI,GAAS,6BAA6B,CAAC;QAE3C,qBAAgB,GAAG,4BAA4B,CAAC;QAEhD,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+BAA+B;gBAC5C,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,kCAAkC;aAC/C;YACD;gBACC,WAAW,EAAE,MAAM;gBACnB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,UAAU;gBACvB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,WAAW,EACV,4HAA4H;aAC7H;YACD;gBACC,WAAW,EAAE,mCAAmC;gBAChD,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,KAAK;gBACd,WAAW,EACV,2JAA2J;aAC5J;SACD,CAAC;QAgBF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBAGR,OAAO,EAAE,oDAAoD;gBAC7D,GAAG,EAAE,uBAAuB;gBAC5B,4BAA4B,EAAE,uCAAuC;aACrE;SACD,CAAC;IACH,CAAC;IAvBA,KAAK,CAAC,YAAY,CACjB,WAA2C,EAC3C,cAAmC;QAEnC,cAAc,CAAC,IAAI,GAAG;YACrB,QAAQ,EAAE,WAAW,CAAC,IAAc;YACpC,QAAQ,EAAE,WAAW,CAAC,QAAkB;SACxC,CAAC;QACF,IAAI,WAAW,CAAC,mBAAmB,KAAK,IAAI,EAAE,CAAC;YAC9C,cAAc,CAAC,4BAA4B,GAAG,IAAI,CAAC;QACpD,CAAC;QACD,OAAO,cAAc,CAAC;IACvB,CAAC;CAWD;AAlED,oCAkEC"}

package/dist/icons/opencloud.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.dev/svgjs" width="512" height="512"><svg id="SvgjsSvg1001" xmlns="http://www.w3.org/2000/svg" width="512" height="512" viewBox="0 0 512 512"><rect x=".02" y="0" width="512" height="512" fill="#20434f"></rect><polygon points="255.98 342.75 271.89 333.57 271.89 267.12 329.08 234.1 329.08 215.78 313.18 206.6 255.6 239.84 198.83 207.06 182.93 216.24 182.93 234.56 240.12 267.58 240.12 333.59 255.98 342.75" fill="#e2baff"></polygon><polygon points="401.95 150.82 256 66.56 256 66.56 256 66.56 110.05 150.82 110.05 187.5 256 103.24 401.95 187.5 401.95 150.82" fill="#e2baff"></polygon><polygon points="401.95 324.5 256 408.76 110.06 324.5 110.06 361.17 256 445.43 256 445.43 256 445.43 401.95 361.17 401.95 324.5" fill="#e2baff"></polygon></svg><style>@media (prefers-color-scheme: light) { :root { filter: none; } }
+@media (prefers-color-scheme: dark) { :root { filter: none; } }
+</style></svg>

package/dist/nodes/OpenCloud/GenericFunctions.d.ts

@@ -0,0 +1,37 @@
+import type { IDataObject, IExecuteFunctions, IHookFunctions, IHttpRequestMethods, ILoadOptionsFunctions } from 'n8n-workflow';
+export interface Drive {
+    id?: string;
+    name?: string;
+    driveType?: string;
+}
+export interface DriveItem {
+    id?: string;
+    name?: string;
+    folder?: object;
+    file?: {
+        mimeType?: string;
+    };
+    parentReference?: {
+        driveId?: string;
+        id?: string;
+        name?: string;
+        path?: string;
+    };
+}
+export interface OpenCloudCollection<T> {
+    value?: T[];
+    '@odata.nextLink'?: string;
+}
+export type DrivesResponse = OpenCloudCollection<Drive>;
+export type DriveItemsResponse = OpenCloudCollection<DriveItem>;
+export interface UnifiedRolePermission {
+    allowedResourceActions?: string[];
+    condition?: string;
+}
+export interface RoleDefinition {
+    id?: string;
+    displayName?: string;
+    description?: string;
+    rolePermissions?: UnifiedRolePermission[];
+}
+export declare function openCloudApiRequest<T = unknown>(this: IExecuteFunctions | IHookFunctions | ILoadOptionsFunctions, method: IHttpRequestMethods, urlOrPath: string, body?: IDataObject | string | Buffer, headers?: IDataObject, json?: boolean, encoding?: 'arraybuffer'): Promise<T>;

package/dist/nodes/OpenCloud/GenericFunctions.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openCloudApiRequest = openCloudApiRequest;
+const n8n_workflow_1 = require("n8n-workflow");
+const NETWORK_ERROR_CODES = new Set([
+    'ENOTFOUND',
+    'ECONNREFUSED',
+    'ETIMEDOUT',
+    'EAI_AGAIN',
+    'ECONNRESET',
+    'EHOSTUNREACH',
+    'ENETUNREACH',
+    'EPROTO',
+    'CERT_HAS_EXPIRED',
+    'DEPTH_ZERO_SELF_SIGNED_CERT',
+    'SELF_SIGNED_CERT_IN_CHAIN',
+    'UNABLE_TO_VERIFY_LEAF_SIGNATURE',
+]);
+function extractErrorCode(error) {
+    var _a, _b;
+    const e = error;
+    const candidates = [e.httpCode, e.code, (_a = e.cause) === null || _a === void 0 ? void 0 : _a.code, (_b = e.cause) === null || _b === void 0 ? void 0 : _b.httpCode];
+    for (const c of candidates) {
+        if (typeof c === 'string' && c.length > 0)
+            return c;
+    }
+    return '';
+}
+async function openCloudApiRequest(method, urlOrPath, body = '', headers = {}, json = false, encoding) {
+    let url = urlOrPath;
+    if (!/^https?:\/\//i.test(urlOrPath)) {
+        const credentials = await this.getCredentials('openCloudApi');
+        const base = credentials.serverUrl.replace(/\/+$/, '');
+        url = `${base}${urlOrPath.startsWith('/') ? '' : '/'}${urlOrPath}`;
+    }
+    const options = {
+        method,
+        url,
+        body: body,
+        headers,
+        json,
+    };
+    if (encoding === 'arraybuffer') {
+        options.encoding = 'arraybuffer';
+    }
+    try {
+        return (await this.helpers.httpRequestWithAuthentication.call(this, 'openCloudApi', options));
+    }
+    catch (error) {
+        const code = extractErrorCode(error);
+        if (NETWORK_ERROR_CODES.has(code)) {
+            const credentials = await this.getCredentials('openCloudApi');
+            throw new n8n_workflow_1.NodeOperationError(this.getNode(), `Cannot reach OpenCloud server at ${credentials.serverUrl} (${code})`, {
+                description: 'The request never received a reply from the server. ' +
+                    'Verify the credential\'s "Server URL" is correct, that the OpenCloud server is running, ' +
+                    'and that n8n can reach it from inside its container (e.g. host.docker.internal for a host-running server).',
+            });
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=GenericFunctions.js.map

package/dist/nodes/OpenCloud/GenericFunctions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GenericFunctions.js","sourceRoot":"","sources":["../../../nodes/OpenCloud/GenericFunctions.ts"],"names":[],"mappings":";;AA6FA,kDA4DC;AAjJD,+CAAkD;AAOlD,MAAM,mBAAmB,GAAwB,IAAI,GAAG,CAAC;IACxD,WAAW;IACX,cAAc;IACd,WAAW;IACX,WAAW;IACX,YAAY;IACZ,cAAc;IACd,aAAa;IACb,QAAQ;IACR,kBAAkB;IAClB,6BAA6B;IAC7B,2BAA2B;IAC3B,iCAAiC;CACjC,CAAC,CAAC;AAEH,SAAS,gBAAgB,CAAC,KAAc;;IACvC,MAAM,CAAC,GAAG,KAIT,CAAC;IACF,MAAM,UAAU,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,MAAA,CAAC,CAAC,KAAK,0CAAE,IAAI,EAAE,MAAA,CAAC,CAAC,KAAK,0CAAE,QAAQ,CAAC,CAAC;IAC1E,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC5B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,EAAE,CAAC;AACX,CAAC;AAoDM,KAAK,UAAU,mBAAmB,CAExC,MAA2B,EAC3B,SAAiB,EACjB,OAAsC,EAAE,EACxC,UAAuB,EAAE,EACzB,OAAgB,KAAK,EACrB,QAAwB;IAExB,IAAI,GAAG,GAAG,SAAS,CAAC;IACpB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAwB,cAAc,CAAC,CAAC;QACrF,MAAM,IAAI,GAAG,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACvD,GAAG,GAAG,GAAG,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,SAAS,EAAE,CAAC;IACpE,CAAC;IAED,MAAM,OAAO,GAAwB;QACpC,MAAM;QACN,GAAG;QACH,IAAI,EAAE,IAAmC;QACzC,OAAO;QACP,IAAI;KACJ,CAAC;IACF,IAAI,QAAQ,KAAK,aAAa,EAAE,CAAC;QAChC,OAAO,CAAC,QAAQ,GAAG,aAAa,CAAC;IAClC,CAAC;IAED,IAAI,CAAC;QACJ,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC,IAAI,CAC5D,IAAI,EACJ,cAAc,EACd,OAAO,CACP,CAAM,CAAC;IACT,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAKnC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAwB,cAAc,CAAC,CAAC;YACrF,MAAM,IAAI,iCAAkB,CAC3B,IAAI,CAAC,OAAO,EAAE,EACd,oCAAoC,WAAW,CAAC,SAAS,KAAK,IAAI,GAAG,EACrE;gBACC,WAAW,EACV,sDAAsD;oBACtD,0FAA0F;oBAC1F,4GAA4G;aAC7G,CACD,CAAC;QACH,CAAC;QAOD,MAAM,KAAK,CAAC;IACb,CAAC;AACF,CAAC"}

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

@@ -0,0 +1,15 @@
+import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodeListSearchResult, INodePropertyOptions, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class OpenCloud implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getSpaces(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getLinkTypes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getShareRoles(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+        };
+        listSearch: {
+            searchRecipients(this: ILoadOptionsFunctions, filter?: string, paginationToken?: string): Promise<INodeListSearchResult>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}