NestJS module and controllers for Neuroline pipeline APIs with DI support.

English | Русский

neuroline-nestjs

NestJS integration for Neuroline — dynamic module with full DI support for creating pipeline API controllers.

Installation

yarn add neuroline neuroline-nestjs
# or
npm install neuroline neuroline-nestjs

Features

• Dynamic Module — NeurolineModule.forRootAsync() with full NestJS DI support
• Auto-generated Controllers — no boilerplate, just configuration
• Guards Support — apply guards per controller
• PipelineClient Compatible — API format matches neuroline/client expectations
• NeurolineService — access manager/storage in your services
• MongoDB Re-exports — MongoPipelineStorage, PipelineSchema included

Quick Start

import { Module } from '@nestjs/common';
import { MongooseModule, getModelToken } from '@nestjs/mongoose';
import {
  NeurolineModule,
  MongoPipelineStorage,
  PipelineSchema,
} from 'neuroline-nestjs';
import { myPipeline } from './pipelines';
import { AuthGuard } from './guards';

@Module({
  imports: [
    MongooseModule.forRoot('mongodb://localhost:27017/neuroline'),
    MongooseModule.forFeature([{ name: 'Pipeline', schema: PipelineSchema }]),

    NeurolineModule.forRootAsync({
      imports: [MongooseModule],
      useFactory: (model) => new MongoPipelineStorage(model),
      inject: [getModelToken('Pipeline')],
      controllers: [
        {
          path: 'api/v1/my-pipeline',
          pipeline: myPipeline,
          guards: [AuthGuard],       // guards для всего контроллера
          adminGuards: [AdminGuard], // guards для admin-эндпоинтов
        },
      ],
    }),
  ],
})
export class AppModule {}

Using NeurolineService

import { Injectable } from '@nestjs/common';
import { NeurolineService } from 'neuroline-nestjs';

@Injectable()
export class MyService {
  constructor(private readonly neuroline: NeurolineService) {}

  async runPipeline(data: any) {
    const { pipelineId } = await this.neuroline.startPipeline('my-pipeline', data);
    return pipelineId;
  }

  async checkStatus(pipelineId: string) {
    return this.neuroline.getStatus(pipelineId);
  }
}

Direct DI Access

import { Injectable, Inject } from '@nestjs/common';
import { NEUROLINE_MANAGER, NEUROLINE_STORAGE } from 'neuroline-nestjs';
import type { PipelineManager, PipelineStorage } from 'neuroline';

@Injectable()
export class MyService {
  constructor(
    @Inject(NEUROLINE_MANAGER) private readonly manager: PipelineManager,
    @Inject(NEUROLINE_STORAGE) private readonly storage: PipelineStorage,
  ) {}
}

API Endpoints

The generated controllers expose the following endpoints:

POST /api/v1/my-pipeline

Start a new pipeline.

Request:

curl -X POST http://localhost:3000/api/v1/my-pipeline \
  -H "Content-Type: application/json" \
  -d '{
    "input": { "seed": 123, "name": "test" },
    "jobOptions": {
      "compute": { "multiplier": 2.0 }
    }
  }'

Response:

{
  "success": true,
  "data": {
    "pipelineId": "abc123",
    "isNew": true
  }
}

GET ?action=status&id=xxx

Get pipeline status.

GET ?action=result&id=xxx[&jobName=yyy]

Get job result (artifact). If jobName is not provided, returns the last job result.

GET ?action=list&page=1&limit=10

List pipelines with pagination.

Admin Endpoints

These endpoints return full pipeline/job data (input, options, artifacts) and are disabled by default. Enable with adminGuards.

Endpoint	Description
?action=job&id=xxx&jobName=yyy	Job details (input, options, artifact)
?action=pipeline&id=xxx	Full pipeline state

// Admin доступен только авторизованным
adminGuards: [AdminGuard]

// Admin доступен всем (открытый доступ)
adminGuards: []

// Admin отключён (по умолчанию)
// просто не указывайте adminGuards

Multiple Pipelines

NeurolineModule.forRootAsync({
  imports: [MongooseModule],
  useFactory: (model) => new MongoPipelineStorage(model),
  inject: [getModelToken('Pipeline')],
  controllers: [
    {
      path: 'api/v1/demo',
      pipeline: demoPipeline,
    },
    {
      path: 'api/v1/analytics',
      pipeline: analyticsPipeline,
      guards: [AdminGuard],
    },
  ],
})

Exports

Export	Type	Description
NeurolineModule	Class	Dynamic module with forRootAsync()
NeurolineService	Class	Service for accessing manager/storage
NEUROLINE_MANAGER	Token	DI token for PipelineManager
NEUROLINE_STORAGE	Token	DI token for PipelineStorage
MongoPipelineStorage	Class	MongoDB storage (re-export)
PipelineSchema	Schema	Mongoose schema (re-export)
PipelineControllerOptions	Type	Controller configuration
NeurolineModuleAsyncOptions	Type	Module configuration

License

UNLICENSED

---

neuroline-nestjs

Интеграция NestJS для Neuroline — динамический модуль с полной поддержкой DI для создания API-контроллеров.

Установка

yarn add neuroline neuroline-nestjs
# или
npm install neuroline neuroline-nestjs

Возможности

• Динамический модуль — NeurolineModule.forRootAsync() с полной поддержкой NestJS DI
• Автогенерация контроллеров — без boilerplate, только конфигурация
• Поддержка Guards — применяйте guards для каждого контроллера
• Совместимость с PipelineClient — формат API соответствует neuroline/client
• NeurolineService — доступ к manager/storage в ваших сервисах
• Реэкспорт MongoDB — MongoPipelineStorage, PipelineSchema включены

Быстрый старт

import { Module } from '@nestjs/common';
import { MongooseModule, getModelToken } from '@nestjs/mongoose';
import {
  NeurolineModule,
  MongoPipelineStorage,
  PipelineSchema,
} from 'neuroline-nestjs';
import { myPipeline } from './pipelines';
import { AuthGuard } from './guards';

@Module({
  imports: [
    MongooseModule.forRoot('mongodb://localhost:27017/neuroline'),
    MongooseModule.forFeature([{ name: 'Pipeline', schema: PipelineSchema }]),

    NeurolineModule.forRootAsync({
      imports: [MongooseModule],
      useFactory: (model) => new MongoPipelineStorage(model),
      inject: [getModelToken('Pipeline')],
      controllers: [
        {
          path: 'api/v1/my-pipeline',
          pipeline: myPipeline,
          guards: [AuthGuard],       // guards для всего контроллера
          adminGuards: [AdminGuard], // guards для admin-эндпоинтов
        },
      ],
    }),
  ],
})
export class AppModule {}

Использование NeurolineService

import { Injectable } from '@nestjs/common';
import { NeurolineService } from 'neuroline-nestjs';

@Injectable()
export class MyService {
  constructor(private readonly neuroline: NeurolineService) {}

  async runPipeline(data: any) {
    const { pipelineId } = await this.neuroline.startPipeline('my-pipeline', data);
    return pipelineId;
  }

  async checkStatus(pipelineId: string) {
    return this.neuroline.getStatus(pipelineId);
  }
}

Прямой доступ через DI

import { Injectable, Inject } from '@nestjs/common';
import { NEUROLINE_MANAGER, NEUROLINE_STORAGE } from 'neuroline-nestjs';
import type { PipelineManager, PipelineStorage } from 'neuroline';

@Injectable()
export class MyService {
  constructor(
    @Inject(NEUROLINE_MANAGER) private readonly manager: PipelineManager,
    @Inject(NEUROLINE_STORAGE) private readonly storage: PipelineStorage,
  ) {}
}

API Эндпоинты

Сгенерированные контроллеры предоставляют следующие эндпоинты:

POST /api/v1/my-pipeline

Запустить новый pipeline.

Запрос:

curl -X POST http://localhost:3000/api/v1/my-pipeline \
  -H "Content-Type: application/json" \
  -d '{
    "input": { "seed": 123, "name": "test" },
    "jobOptions": {
      "compute": { "multiplier": 2.0 }
    }
  }'

Ответ:

{
  "success": true,
  "data": {
    "pipelineId": "abc123",
    "isNew": true
  }
}

GET ?action=status&id=xxx

Получить статус pipeline.

GET ?action=result&id=xxx[&jobName=yyy]

Получить результат job (артефакт). Если jobName не передан, возвращается результат последней job.

GET ?action=list&page=1&limit=10

Список pipelines с пагинацией.

Admin-эндпоинты

Эти эндпоинты возвращают полные данные pipeline/job (input, options, artifacts) и отключены по умолчанию. Включите через adminGuards.

Эндпоинт	Описание
?action=job&id=xxx&jobName=yyy	Детали job (input, options, artifact)
?action=pipeline&id=xxx	Полное состояние pipeline

// Admin доступен только авторизованным
adminGuards: [AdminGuard]

// Admin доступен всем (открытый доступ)
adminGuards: []

// Admin отключён (по умолчанию)
// просто не указывайте adminGuards

Несколько Pipelines

NeurolineModule.forRootAsync({
  imports: [MongooseModule],
  useFactory: (model) => new MongoPipelineStorage(model),
  inject: [getModelToken('Pipeline')],
  controllers: [
    {
      path: 'api/v1/demo',
      pipeline: demoPipeline,
    },
    {
      path: 'api/v1/analytics',
      pipeline: analyticsPipeline,
      guards: [AdminGuard],
    },
  ],
})

Экспорты

Экспорт	Тип	Описание
NeurolineModule	Class	Динамический модуль с forRootAsync()
NeurolineService	Class	Сервис для доступа к manager/storage
NEUROLINE_MANAGER	Token	DI токен для PipelineManager
NEUROLINE_STORAGE	Token	DI токен для PipelineStorage
MongoPipelineStorage	Class	MongoDB storage (реэкспорт)
PipelineSchema	Schema	Mongoose схема (реэкспорт)
PipelineControllerOptions	Type	Конфигурация контроллера
NeurolineModuleAsyncOptions	Type	Конфигурация модуля

Лицензия

UNLICENSED