@osaas/client-services 0.13.0 → 0.14.0

package/lib/generated/n8n-io-n8n.js

@@ -0,0 +1,88 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getN8nIoN8nInstance = exports.removeN8nIoN8nInstance = exports.createN8nIoN8nInstance = void 0;
+const client_core_1 = require("@osaas/client-core");
+/**
+ * @namespace n8n-io-n8n
+ * @description Supercharge your team's productivity with n8n, the ultimate workflow automation platform. Enjoy seamless integration with 400+ apps, built-in AI, and full control over your data. Flexibility meets efficiency.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2026 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} N8nIoN8nConfig
+ * @property {string} name - Name of n8n
+ * @property {string} [DatabaseUrl] - Connection string URL for the database that n8n uses to store workflow data, execution history, credentials, and other persistent information. This is essential for production deployments where data needs to be preserved across restarts.
+ * @property {string} RunnersAuthToken - Authentication token used to secure communication between n8n main process and task runners. Required for isolating and executing code in separate processes for enhanced security.
+
+ *
+ */
+/**
+ * @typedef {Object} N8nIoN8n
+ * @property {string} name - Name of the n8n instance
+ * @property {string} url - URL of the n8n instance
+ *
+ */
+/**
+ * Create a new n8n instance
+ *
+ * @memberOf n8n-io-n8n
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {N8nIoN8nConfig} body - Service instance configuration
+ * @returns {N8nIoN8n} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createN8nIoN8nInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: N8nIoN8nConfig = { name: 'myinstance', ... };
+ * const instance = await createN8nIoN8nInstance(ctx, body);
+ * console.log(instance.url);
+ */
+async function createN8nIoN8nInstance(ctx, body) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('n8n-io-n8n');
+    const instance = await (0, client_core_1.createInstance)(ctx, 'n8n-io-n8n', serviceAccessToken, body);
+    await (0, client_core_1.waitForInstanceReady)('n8n-io-n8n', instance.name, ctx);
+    return instance;
+}
+exports.createN8nIoN8nInstance = createN8nIoN8nInstance;
+/**
+ * Remove a n8n instance
+ *
+ * @memberOf n8n-io-n8n
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the n8n to be removed
+ */
+async function removeN8nIoN8nInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('n8n-io-n8n');
+    await (0, client_core_1.removeInstance)(ctx, 'n8n-io-n8n', name, serviceAccessToken);
+}
+exports.removeN8nIoN8nInstance = removeN8nIoN8nInstance;
+/**
+ * Get a n8n instance
+ *
+ * @memberOf n8n-io-n8n
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the n8n to be retrieved
+ * @returns {N8nIoN8n} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getN8nIoN8nInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getN8nIoN8nInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+async function getN8nIoN8nInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('n8n-io-n8n');
+    return await (0, client_core_1.getInstance)(ctx, 'n8n-io-n8n', name, serviceAccessToken);
+}
+exports.getN8nIoN8nInstance = getN8nIoN8nInstance;
+//# sourceMappingURL=n8n-io-n8n.js.map

package/lib/generated/n8n-io-n8n.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"n8n-io-n8n.js","sourceRoot":"","sources":["../../src/generated/n8n-io-n8n.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAghBH,oDAM4B;AAC5B;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,sBAAsB,CAC1C,GAAY,EACZ,IAAoB;IAEpB,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IACzE,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAc,EACnC,GAAG,EACH,YAAY,EACZ,kBAAkB,EAClB,IAAI,CACL,CAAC;IACF,MAAM,IAAA,kCAAoB,EAAC,YAAY,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7D,OAAO,QAAQ,CAAC;AAClB,CAAC;AAbD,wDAaC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,sBAAsB,CAC1C,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IACzE,MAAM,IAAA,4BAAc,EAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AACpE,CAAC;AAND,wDAMC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,mBAAmB,CACvC,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IACzE,OAAO,MAAM,IAAA,yBAAW,EAAC,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AACxE,CAAC;AAND,kDAMC"}

package/lib/generated/n8n-io-task-runner-launcher.d.ts

@@ -0,0 +1,592 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    '/': {
+        /** Health check endpoint */
+        get: {
+            parameters: {
+                query: {
+                    verbose?: boolean;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: Partial<string> & Partial<{
+                        status: string;
+                        versions: {
+                            '@osaas/orchestrator': string;
+                        };
+                        environment: string;
+                        _links: {
+                            self: {
+                                href: string;
+                            };
+                            api: {
+                                href: string;
+                            };
+                        };
+                    }>;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        status: string;
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/task-runner-launcherinstance': {
+        /** List all running task-runner-launcher instances */
+        get: {
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: ({
+                        /** @description Name of the task-runner-launcher instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        TaskBrokerUri: string;
+                        AuthToken: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    })[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Launch a new task-runner-launcher instance */
+        post: {
+            parameters: {
+                query: {
+                    beta?: boolean;
+                };
+                body: {
+                    body?: {
+                        /** @description Name of the task-runner-launcher instance */
+                        name: string;
+                        TaskBrokerUri: string;
+                        AuthToken: string;
+                    };
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the task-runner-launcher instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        TaskBrokerUri: string;
+                        AuthToken: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                403: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                409: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/restart/{id}': {
+        /** Restart task-runner-launcher */
+        post: {
+            parameters: {
+                path: {
+                    /** Name of the task-runner-launcher instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/task-runner-launcherinstance/{id}': {
+        /** Obtain status and resource URLs for an task-runner-launcher instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the task-runner-launcher instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the task-runner-launcher instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        TaskBrokerUri: string;
+                        AuthToken: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                404: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Stop and remove an task-runner-launcher instance */
+        delete: {
+            parameters: {
+                path: {
+                    /** Name of the task-runner-launcher instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                204: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+        /** Patch task-runner-launcher instance with new parameters and restart */
+        patch: {
+            parameters: {
+                body: {
+                    body?: {
+                        /** @description Name of the task-runner-launcher instance */
+                        name?: string;
+                        TaskBrokerUri?: string;
+                        AuthToken?: string;
+                    };
+                };
+                path: {
+                    /** Name of the task-runner-launcher instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @description Name of the task-runner-launcher instance */
+                        name: string;
+                        /** @description URL to instance API */
+                        url: string;
+                        resources: {
+                            license: {
+                                /** @description URL to license information */
+                                url: string;
+                            };
+                            apiDocs?: {
+                                /** @description URL to instance API documentation */
+                                url: string;
+                            };
+                            app?: {
+                                /** @description URL to instance application (GUI) */
+                                url: string;
+                            };
+                        };
+                        TaskBrokerUri: string;
+                        AuthToken: string;
+                    } & {
+                        _links: {
+                            self: {
+                                /** @description Instance resource */
+                                href: string;
+                            };
+                            logs?: {
+                                /** @description Get logs for this instance */
+                                href: string;
+                            };
+                            health?: {
+                                /** @description Get health status for this instance */
+                                href: string;
+                            };
+                            ports?: {
+                                /** @description Get exposed ports for this instance */
+                                href: string;
+                            };
+                            restart?: {
+                                /** @description Restart this instance */
+                                href: string;
+                            };
+                            update?: {
+                                /** @description Update this instance */
+                                href: string;
+                            };
+                            scale?: {
+                                /** @description Scale this instance */
+                                href: string;
+                            };
+                        };
+                    };
+                };
+                /** Default Response */
+                400: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                404: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/health/{id}': {
+        /** Return status of task-runner-launcher instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the task-runner-launcher instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        /** @enum {string} */
+                        status: 'starting' | 'running' | 'stopped' | 'failed' | 'unknown';
+                        images?: string[];
+                    };
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/logs/{id}': {
+        /** Return the latest logs from the task-runner-launcher instance */
+        get: {
+            parameters: {
+                query: {
+                    timestamps?: boolean;
+                    sinceSeconds?: number;
+                };
+                path: {
+                    /** Name of the task-runner-launcher instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: string;
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+    '/ports/{id}': {
+        /** Return the exposed extra ports for task-runner-launcher instance */
+        get: {
+            parameters: {
+                path: {
+                    /** Name of the task-runner-launcher instance */
+                    id: string;
+                };
+            };
+            responses: {
+                /** Default Response */
+                200: {
+                    schema: {
+                        externalIp: string;
+                        externalPort: number;
+                        internalPort: number;
+                    }[];
+                };
+                /** Default Response */
+                500: {
+                    schema: {
+                        /** @description Reason why something failed */
+                        reason: string;
+                    };
+                };
+            };
+        };
+    };
+}
+export interface definitions {
+}
+export interface operations {
+}
+export interface external {
+}
+export type N8nIoTaskRunnerLauncher = paths['/task-runner-launcherinstance/{id}']['get']['responses']['200']['schema'];
+export type N8nIoTaskRunnerLauncherConfig = paths['/task-runner-launcherinstance']['post']['parameters']['body']['body'];
+import { Context } from '@osaas/client-core';
+/**
+ * @namespace n8n-io-task-runner-launcher
+ * @description Optimize resource use with the Task Runner Launcher, a CLI tool that powers on-demand n8n task execution. Ensure efficiency and resilience in task management while keeping system operations seamless.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2026 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} N8nIoTaskRunnerLauncherConfig
+ * @property {string} name - Name of task-runner-launcher
+ * @property {string} TaskBrokerUri - TaskBrokerUri
+ * @property {string} AuthToken - AuthToken
+
+ *
+ */
+/**
+ * @typedef {Object} N8nIoTaskRunnerLauncher
+ * @property {string} name - Name of the n8n runner instance
+ * @property {string} url - URL of the n8n runner instance
+ *
+ */
+/**
+ * Create a new n8n runner instance
+ *
+ * @memberOf n8n-io-task-runner-launcher
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {N8nIoTaskRunnerLauncherConfig} body - Service instance configuration
+ * @returns {N8nIoTaskRunnerLauncher} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createN8nIoTaskRunnerLauncherInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: N8nIoTaskRunnerLauncherConfig = { name: 'myinstance', ... };
+ * const instance = await createN8nIoTaskRunnerLauncherInstance(ctx, body);
+ * console.log(instance.url);
+ */
+export declare function createN8nIoTaskRunnerLauncherInstance(ctx: Context, body: N8nIoTaskRunnerLauncherConfig): Promise<N8nIoTaskRunnerLauncher>;
+/**
+ * Remove a n8n runner instance
+ *
+ * @memberOf n8n-io-task-runner-launcher
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the runner to be removed
+ */
+export declare function removeN8nIoTaskRunnerLauncherInstance(ctx: Context, name: string): Promise<void>;
+/**
+ * Get a n8n runner instance
+ *
+ * @memberOf n8n-io-task-runner-launcher
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the runner to be retrieved
+ * @returns {N8nIoTaskRunnerLauncher} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getN8nIoTaskRunnerLauncherInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getN8nIoTaskRunnerLauncherInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+export declare function getN8nIoTaskRunnerLauncherInstance(ctx: Context, name: string): Promise<N8nIoTaskRunnerLauncher>;
+//# sourceMappingURL=n8n-io-task-runner-launcher.d.ts.map