Перейти к содержимому
Документация

TypeScript SDK (code-first)

SDK @inquir/compute превращает функции в код, который можно ревьюить, типизировать и версионировать: обработчик, его лимиты и схемы входа/выхода живут в одном файле репозитория, а CLI деплоит ровно то, что объявлено в коде.

Используйте его, когда основным местом для кода становится не браузерный редактор, а командные репозитории, код-ревью и развёртывание из CI, — с теми же средой выполнения, шлюзом и наблюдаемостью.

Структура проекта#

inquir init создаёт рабочий проект с inquir.config.json в корне. Конфиг подсказывает CLI, где искать функции:

inquir.config.jsonjson
{
  "functionsDir": "inquir/functions",
  "pipelinesDir": "inquir/pipelines",
  "generatedDir": ".inquir/generated"
}

Всё в functionsDir, что экспортирует управляемую функцию, обнаруживается автоматически — вручную поддерживать манифест не нужно.

Описываем функцию#

defineFunction связывает конфигурацию с обработчиком. Схемы входа и выхода — типы Zod: SDK валидирует событие до запуска вашего кода и выводит TypeScript-сигнатуру обработчика из схемы.

greet.tstypescript
import { defineFunction } from '@inquir/compute';
import { z } from 'zod';

// Config, validation, and types live next to the code — no console clicking.
export const greet = defineFunction(
  {
    name: 'greet',
    timeoutMs: 10_000,
    memoryMB: 256,
    moduleType: 'esm', // skip content sniffing for .js entry files
    input: z.object({ name: z.string() }),
    output: z.object({ greeting: z.string() }),
  },
  async ({ name }) => ({ greeting: `Hello, ${name}!` })
);

Все опции зеркалят настройки консоли — timeoutMs, memoryMB, allowNetwork, environment и moduleType, который избавляет от угадывания ESM/CommonJS для обычных .js-входов.

Ежедневный цикл#

  • inquir list — показать локальные ассеты, которые нашёл SDK (с -r — что развёрнуто удалённо).
  • inquir run greet --payload '{"name":"World"}' — выполнить функцию локально с валидацией схемы, без деплоя.
  • inquir deploy greet — упаковать функцию и выводить логи сборки, пока эндпоинт не заработает.
  • inquir logs greet — показать недавние удалённые вызовы прямо из терминала.

SDK или редактор#

Браузерный редактор — самый быстрый способ проверить идею, и он полностью поддерживается: оба инструмента работают с одними и теми же функциями. Переходите на SDK, когда изменениям нужны ревью, тесты и CI: функции в коде получают типизированные контракты и воспроизводимые развёртывания, а редактор остаётся удобным для быстрой диагностики в продакшене.

Проверка стека из кода: validateCompose#

Начиная с @inquir/compute 0.4.5 SDK экспортирует validateCompose(client, { document, files, name }). Функция отправляет inquir-compose.yaml (текстом или разобранным объектом) валидатору самой платформы, POST /v1/compose/validate, и возвращает ok, все ошибки и предупреждения с путём в файле, а для корректного стека — план: сервисы в порядке развёртывания, CPU, память и тома. Ничего не создаётся. Для каталога стека ответ перечисляет в wanted файлы, которые проверка использовала (inquir.yaml и Dockerfile каждого сервиса): передайте их в files и вызовите функцию снова. Именно так работает inquir compose validate в CLI 0.4.4.