n8n-nodes-docker-api 0.1.0

package/dist/nodes/Docker/actions/container/start.operation.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startContainer = startContainer;
+const errorHandler_1 = require("../../helpers/errorHandler");
+const normalizeContainer_1 = require("../../helpers/normalizeContainer");
+const resolveContainer_1 = require("../../helpers/resolveContainer");
+async function startContainer(docker, itemIndex) {
+    try {
+        const containerId = this.getNodeParameter('containerId', itemIndex);
+        // Resolve name to ID first
+        const resolved = await (0, resolveContainer_1.resolveContainer)(docker, containerId);
+        const container = docker.getContainer(resolved.id);
+        await container.start();
+        // Get updated info using the same container instance
+        const containerInfo = await container.inspect();
+        return (0, normalizeContainer_1.normalizeContainerInfo)(containerInfo);
+    }
+    catch (error) {
+        throw new Error((0, errorHandler_1.translateDockerError)(error));
+    }
+}

package/dist/nodes/Docker/actions/container/stop.operation.d.ts

@@ -0,0 +1,3 @@
+import Docker from 'dockerode';
+import { IExecuteFunctions } from 'n8n-workflow';
+export declare function stopContainer(this: IExecuteFunctions, docker: Docker, itemIndex: number): Promise<any>;

package/dist/nodes/Docker/actions/container/stop.operation.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stopContainer = stopContainer;
+const errorHandler_1 = require("../../helpers/errorHandler");
+const normalizeContainer_1 = require("../../helpers/normalizeContainer");
+const resolveContainer_1 = require("../../helpers/resolveContainer");
+async function stopContainer(docker, itemIndex) {
+    try {
+        const containerId = this.getNodeParameter('containerId', itemIndex);
+        const timeout = this.getNodeParameter('timeout', itemIndex, 10);
+        const dryRun = this.getNodeParameter('dryRun', itemIndex, false);
+        // Resolve name to ID first
+        const resolved = await (0, resolveContainer_1.resolveContainer)(docker, containerId);
+        const container = docker.getContainer(resolved.id);
+        // Handle dry run
+        if (dryRun) {
+            return {
+                dryRun: true,
+                action: 'stop',
+                target: {
+                    id: resolved.id,
+                    shortId: resolved.id.substring(0, 12),
+                    name: resolved.name,
+                },
+                executed: false,
+                message: `Dry run: container '${resolved.name}' (${resolved.id.substring(0, 12)}) would have been stopped.`,
+            };
+        }
+        // Actually stop the container
+        await container.stop({ t: timeout });
+        // Get updated info using the same container instance
+        const containerInfo = await container.inspect();
+        return (0, normalizeContainer_1.normalizeContainerInfo)(containerInfo);
+    }
+    catch (error) {
+        throw new Error((0, errorHandler_1.translateDockerError)(error));
+    }
+}

package/dist/nodes/Docker/actions/index.d.ts

@@ -0,0 +1,3 @@
+import Docker from 'dockerode';
+import { IExecuteFunctions } from 'n8n-workflow';
+export declare function executeContainerOperation(this: IExecuteFunctions, docker: Docker, operation: string, itemIndex: number): Promise<any[]>;

package/dist/nodes/Docker/actions/index.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeContainerOperation = executeContainerOperation;
+const list_operation_1 = require("./container/list.operation");
+const getLogs_operation_1 = require("./container/getLogs.operation");
+const start_operation_1 = require("./container/start.operation");
+const stop_operation_1 = require("./container/stop.operation");
+async function executeContainerOperation(docker, operation, itemIndex) {
+    switch (operation) {
+        case 'list':
+            const listResult = await list_operation_1.listContainers.call(this, docker, itemIndex);
+            return listResult.map((item) => ({ json: item }));
+        case 'getLogs':
+            const logsResult = await getLogs_operation_1.getContainerLogs.call(this, docker, itemIndex);
+            return [{ json: logsResult }];
+        case 'start':
+            const startResult = await start_operation_1.startContainer.call(this, docker, itemIndex);
+            return [{ json: startResult }];
+        case 'stop':
+            const stopResult = await stop_operation_1.stopContainer.call(this, docker, itemIndex);
+            return [{ json: stopResult }];
+        default:
+            throw new Error(`Unknown operation: ${operation}`);
+    }
+}

package/dist/nodes/Docker/descriptions/container/getLogs.description.d.ts

@@ -0,0 +1,2 @@
+import { INodeProperties } from 'n8n-workflow';
+export declare const getLogsContainerFields: INodeProperties[];

package/dist/nodes/Docker/descriptions/container/getLogs.description.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLogsContainerFields = void 0;
+exports.getLogsContainerFields = [
+    {
+        displayName: 'Container ID or Name',
+        name: 'containerId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['getLogs'],
+            },
+        },
+        default: '',
+        description: 'The ID or name of the container to retrieve logs from',
+        placeholder: 'my-container or abc123def456',
+    },
+    {
+        displayName: 'Tail (Lines)',
+        name: 'tail',
+        type: 'number',
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['getLogs'],
+            },
+        },
+        default: 100,
+        description: 'Number of lines from the end of the log to return. Use 0 for all lines.',
+    },
+    {
+        displayName: 'Include Timestamps',
+        name: 'timestamps',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['getLogs'],
+            },
+        },
+        default: false,
+        description: 'Whether to prepend timestamps to each log line',
+    },
+    {
+        displayName: 'Stream',
+        name: 'stream',
+        type: 'options',
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['getLogs'],
+            },
+        },
+        options: [
+            { name: 'Both (stdout + stderr)', value: 'both' },
+            { name: 'stdout Only', value: 'stdout' },
+            { name: 'stderr Only', value: 'stderr' },
+        ],
+        default: 'both',
+        description: 'Which output stream(s) to include in the logs',
+    },
+];

package/dist/nodes/Docker/descriptions/container/list.description.d.ts

@@ -0,0 +1,2 @@
+import { INodeProperties } from 'n8n-workflow';
+export declare const listContainerFields: INodeProperties[];

package/dist/nodes/Docker/descriptions/container/list.description.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listContainerFields = void 0;
+exports.listContainerFields = [
+    {
+        displayName: 'Show All Containers',
+        name: 'showAll',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['list'],
+            },
+        },
+        default: false,
+        description: 'Whether to show stopped and exited containers in addition to running ones',
+    },
+    {
+        displayName: 'Filters',
+        name: 'filters',
+        type: 'collection',
+        placeholder: 'Add Filter',
+        default: {},
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['list'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Name',
+                name: 'name',
+                type: 'string',
+                default: '',
+                description: 'Filter containers by name (partial match supported)',
+            },
+            {
+                displayName: 'Status',
+                name: 'status',
+                type: 'options',
+                options: [
+                    { name: 'All', value: '' },
+                    { name: 'Running', value: 'running' },
+                    { name: 'Exited', value: 'exited' },
+                    { name: 'Paused', value: 'paused' },
+                ],
+                default: '',
+                description: 'Filter containers by status',
+            },
+        ],
+    },
+    {
+        displayName: 'Include Labels',
+        name: 'includeLabels',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['list'],
+            },
+        },
+        default: true,
+        description: 'Whether to include container labels in the output (can be verbose)',
+    },
+];

package/dist/nodes/Docker/descriptions/container/start.description.d.ts

@@ -0,0 +1,2 @@
+import { INodeProperties } from 'n8n-workflow';
+export declare const startContainerFields: INodeProperties[];

package/dist/nodes/Docker/descriptions/container/start.description.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startContainerFields = void 0;
+exports.startContainerFields = [
+    {
+        displayName: 'Container ID or Name',
+        name: 'containerId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['start'],
+            },
+        },
+        default: '',
+        description: 'The ID or name of the container to start',
+        placeholder: 'my-container or abc123def456',
+    },
+];

package/dist/nodes/Docker/descriptions/container/stop.description.d.ts

@@ -0,0 +1,2 @@
+import { INodeProperties } from 'n8n-workflow';
+export declare const stopContainerFields: INodeProperties[];

package/dist/nodes/Docker/descriptions/container/stop.description.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stopContainerFields = void 0;
+exports.stopContainerFields = [
+    {
+        displayName: 'Container ID or Name',
+        name: 'containerId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['stop'],
+            },
+        },
+        default: '',
+        description: 'The ID or name of the container to stop',
+        placeholder: 'my-container or abc123def456',
+    },
+    {
+        displayName: 'Timeout (Seconds)',
+        name: 'timeout',
+        type: 'number',
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['stop'],
+            },
+        },
+        default: 10,
+        description: 'Seconds to wait before force-killing the container. Default is 10.',
+    },
+    {
+        displayName: 'Dry Run',
+        name: 'dryRun',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['container'],
+                operation: ['stop'],
+            },
+        },
+        default: false,
+        description: 'Whether to preview the action without executing it. No changes will be made.',
+    },
+];

package/dist/nodes/Docker/descriptions/index.d.ts

@@ -0,0 +1,3 @@
+import { INodeProperties } from 'n8n-workflow';
+export declare const containerOperations: INodeProperties[];
+export declare const containerFields: INodeProperties[];

package/dist/nodes/Docker/descriptions/index.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.containerFields = exports.containerOperations = void 0;
+const list_description_1 = require("./container/list.description");
+const getLogs_description_1 = require("./container/getLogs.description");
+const start_description_1 = require("./container/start.description");
+const stop_description_1 = require("./container/stop.description");
+exports.containerOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['container'],
+            },
+        },
+        options: [
+            {
+                name: 'List Containers',
+                value: 'list',
+                description: 'List all containers',
+                action: 'List containers',
+            },
+            {
+                name: 'Get Container Logs',
+                value: 'getLogs',
+                description: 'Retrieve logs from a container',
+                action: 'Get container logs',
+            },
+            {
+                name: 'Start Container',
+                value: 'start',
+                description: 'Start a container',
+                action: 'Start container',
+            },
+            {
+                name: 'Stop Container',
+                value: 'stop',
+                description: 'Stop a container',
+                action: 'Stop container',
+            },
+        ],
+        default: 'list',
+    },
+];
+exports.containerFields = [
+    ...list_description_1.listContainerFields,
+    ...getLogs_description_1.getLogsContainerFields,
+    ...start_description_1.startContainerFields,
+    ...stop_description_1.stopContainerFields,
+];

package/dist/nodes/Docker/helpers/accessGuard.d.ts

@@ -0,0 +1,2 @@
+import { ICredentialDataDecryptedObject } from 'n8n-workflow';
+export declare function enforceAccessMode(credentials: ICredentialDataDecryptedObject, operation: string): void;

package/dist/nodes/Docker/helpers/accessGuard.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enforceAccessMode = enforceAccessMode;
+// Operations that require full-control access
+const WRITE_OPERATIONS = ['start', 'stop', 'remove', 'restart', 'run', 'pull', 'build', 'prune'];
+function enforceAccessMode(credentials, operation) {
+    const accessMode = credentials.accessMode;
+    if (accessMode === 'readonly' && WRITE_OPERATIONS.includes(operation)) {
+        throw new Error(`Operation "${operation}" requires Full Control access. ` +
+            `This credential is configured as Read Only. ` +
+            `Update your Docker API credential to enable write operations.`);
+    }
+}

package/dist/nodes/Docker/helpers/errorHandler.d.ts

@@ -0,0 +1 @@
+export declare function translateDockerError(error: unknown): string;

package/dist/nodes/Docker/helpers/errorHandler.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.translateDockerError = translateDockerError;
+function translateDockerError(error) {
+    var _a;
+    const msg = (_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : String(error);
+    if (msg.includes('ECONNREFUSED')) {
+        return 'Cannot connect to Docker daemon. Is Docker running? Check your connection settings.';
+    }
+    if (msg.includes('ENOENT') && msg.includes('docker.sock')) {
+        return 'Docker socket not found at the specified path. Verify the socket path in your credential.';
+    }
+    if (msg.toLowerCase().includes('permission denied')) {
+        return 'Permission denied accessing Docker socket. Ensure the n8n process has permission to access the socket.';
+    }
+    if (msg.includes('No such container') || msg.includes('not found')) {
+        return 'Container not found. Verify the container ID or name is correct and the container exists.';
+    }
+    if (msg.includes('is not running')) {
+        return 'Container is not running. Start the container before performing this operation.';
+    }
+    if (msg.includes('already started') || msg.includes('already running')) {
+        return 'Container is already running.';
+    }
+    if (msg.includes('404')) {
+        return 'Resource not found. The container or image may have been removed.';
+    }
+    if (msg.includes('409')) {
+        return 'Conflict: The container may already be in the requested state.';
+    }
+    if (msg.includes('timeout') || msg.includes('ETIMEDOUT')) {
+        return 'Connection timed out. Check network connectivity to the Docker host.';
+    }
+    // Fallback: return original message without prefix for cleaner output
+    return msg;
+}

package/dist/nodes/Docker/helpers/normalizeContainer.d.ts

@@ -0,0 +1,16 @@
+import { ContainerInfo, ContainerInspectInfo } from 'dockerode';
+export interface NormalizedContainer {
+    id: string;
+    shortId: string;
+    name: string;
+    image: string;
+    status: 'running' | 'stopped' | 'exited' | 'paused' | 'restarting' | 'dead' | 'created' | 'unknown';
+    createdAt: string;
+    ports: Array<{
+        containerPort: number;
+        hostPort?: number;
+        protocol: string;
+    }>;
+    labels?: Record<string, string>;
+}
+export declare function normalizeContainerInfo(raw: ContainerInfo | ContainerInspectInfo, includeLabels?: boolean): NormalizedContainer;

package/dist/nodes/Docker/helpers/normalizeContainer.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeContainerInfo = normalizeContainerInfo;
+function normalizeContainerInfo(raw, includeLabels = true) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    // Handle both ContainerInfo (from listContainers) and ContainerInspectInfo (from inspect)
+    const isInspectInfo = 'Name' in raw;
+    const name = isInspectInfo
+        ? raw.Name.replace(/^\//, '')
+        : (_c = (_b = (_a = raw.Names) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.replace(/^\//, '')) !== null && _c !== void 0 ? _c : 'unknown';
+    const dockerState = isInspectInfo
+        ? (_e = (_d = raw.State) === null || _d === void 0 ? void 0 : _d.Status) !== null && _e !== void 0 ? _e : 'unknown'
+        : (_f = raw.State) !== null && _f !== void 0 ? _f : 'unknown';
+    const status = mapStatus(dockerState);
+    // Handle ports - only available in ContainerInfo
+    const portsInfo = raw.Ports;
+    const seenPorts = new Set();
+    const uniquePorts = [];
+    if (portsInfo) {
+        for (const port of portsInfo) {
+            const key = `${port.PrivatePort}-${(_g = port.PublicPort) !== null && _g !== void 0 ? _g : 'none'}-${port.Type}`;
+            if (!seenPorts.has(key)) {
+                seenPorts.add(key);
+                uniquePorts.push({
+                    containerPort: port.PrivatePort,
+                    hostPort: port.PublicPort,
+                    protocol: port.Type,
+                });
+            }
+        }
+    }
+    // Handle image
+    const image = isInspectInfo
+        ? (_j = (_h = raw.Config) === null || _h === void 0 ? void 0 : _h.Image) !== null && _j !== void 0 ? _j : 'unknown'
+        : (_k = raw.Image) !== null && _k !== void 0 ? _k : 'unknown';
+    // Handle created timestamp
+    const created = isInspectInfo
+        ? (_l = raw.Created) !== null && _l !== void 0 ? _l : new Date().toISOString()
+        : new Date(((_m = raw.Created) !== null && _m !== void 0 ? _m : 0) * 1000).toISOString();
+    // Handle labels - only include if requested
+    const labelsData = isInspectInfo
+        ? (_p = (_o = raw.Config) === null || _o === void 0 ? void 0 : _o.Labels) !== null && _p !== void 0 ? _p : {}
+        : (_q = raw.Labels) !== null && _q !== void 0 ? _q : {};
+    const result = {
+        id: raw.Id,
+        shortId: raw.Id.substring(0, 12),
+        name,
+        image,
+        status,
+        createdAt: created,
+        ports: uniquePorts,
+    };
+    // Only add labels field if includeLabels is true
+    if (includeLabels) {
+        result.labels = labelsData;
+    }
+    return result;
+}
+function mapStatus(dockerState) {
+    var _a;
+    const map = {
+        running: 'running',
+        exited: 'exited',
+        stopped: 'stopped',
+        paused: 'paused',
+        restarting: 'restarting',
+        dead: 'dead',
+        created: 'created',
+    };
+    return (_a = map[dockerState === null || dockerState === void 0 ? void 0 : dockerState.toLowerCase()]) !== null && _a !== void 0 ? _a : 'unknown';
+}

package/dist/nodes/Docker/helpers/resolveContainer.d.ts

@@ -0,0 +1,11 @@
+import Docker from 'dockerode';
+/**
+ * Resolves a container ID or name to a full container info object.
+ * Docker API requires exact ID or name (with leading /).
+ * This function handles user-friendly names by finding the matching container.
+ */
+export declare function resolveContainer(docker: Docker, containerIdOrName: string): Promise<{
+    id: string;
+    name: string;
+    info: Docker.ContainerInfo;
+}>;

package/dist/nodes/Docker/helpers/resolveContainer.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveContainer = resolveContainer;
+/**
+ * Resolves a container ID or name to a full container info object.
+ * Docker API requires exact ID or name (with leading /).
+ * This function handles user-friendly names by finding the matching container.
+ */
+async function resolveContainer(docker, containerIdOrName) {
+    var _a, _b, _c;
+    const allContainers = await docker.listContainers({ all: true });
+    // Try exact match first (ID or name with /)
+    let containerInfo = allContainers.find((c) => {
+        var _a;
+        return c.Id === containerIdOrName ||
+            c.Id.startsWith(containerIdOrName) ||
+            ((_a = c.Names) === null || _a === void 0 ? void 0 : _a.some((n) => n === containerIdOrName || n === `/${containerIdOrName}`));
+    });
+    // If not found, try name without leading /
+    if (!containerInfo) {
+        containerInfo = allContainers.find((c) => { var _a; return (_a = c.Names) === null || _a === void 0 ? void 0 : _a.some((n) => n.replace(/^\//, '') === containerIdOrName); });
+    }
+    if (!containerInfo) {
+        throw new Error(`Container '${containerIdOrName}' not found. Verify the container ID or name is correct and the container exists.`);
+    }
+    const name = (_c = (_b = (_a = containerInfo.Names) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.replace(/^\//, '')) !== null && _c !== void 0 ? _c : 'unknown';
+    return {
+        id: containerInfo.Id,
+        name,
+        info: containerInfo,
+    };
+}

package/dist/utils/dockerClient.d.ts

@@ -0,0 +1,3 @@
+import Docker from 'dockerode';
+import { ICredentialDataDecryptedObject } from 'n8n-workflow';
+export declare function createDockerClient(credentials: ICredentialDataDecryptedObject): Docker;

package/dist/utils/dockerClient.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDockerClient = createDockerClient;
+const dockerode_1 = __importDefault(require("dockerode"));
+function createDockerClient(credentials) {
+    const { authMode, socketPath, host, port, tlsPort, ca, cert, clientKey } = credentials;
+    if (authMode === 'socket') {
+        return new dockerode_1.default({ socketPath: socketPath });
+    }
+    if (authMode === 'tcp') {
+        return new dockerode_1.default({
+            host: host,
+            port: port,
+            protocol: 'http',
+        });
+    }
+    if (authMode === 'tls') {
+        return new dockerode_1.default({
+            host: host,
+            port: tlsPort,
+            ca: ca,
+            cert: cert,
+            key: clientKey,
+            protocol: 'https',
+        });
+    }
+    throw new Error(`Unknown authMode: ${authMode}`);
+}