@getxflow/cli 0.1.4 → 0.1.5

package/README.md

@@ -24,6 +24,7 @@ xflow publish
 | `functions list` / `functions deploy` | облачные функции проекта из `functions/<имя>/index.ts` |
 | `functions invoke` / `functions logs` | вызвать функцию, посмотреть её падения со стеком |
 | `schedules list` / `set` / `rm` | запуск функций по времени (таймер-триггеры) |
+| `env` / `env check` / `env set` | переменные окружения функций, значения наружу не отдаются |
 | `logs` | ошибки выложенного приложения в браузере |
 | `projects list` / `projects get` / `open` | проекты организации и адреса приложения |
 | `skills` | инструкция о платформе для ИИ-агента (формат [Agent Skills](https://agentskills.io)) |

package/dist/bin.js

@@ -12,6 +12,7 @@ const version_1 = require("./version");
 const auth_1 = require("./commands/auth");
 const projects_1 = require("./commands/projects");
 const db_1 = require("./commands/db");
+const env_1 = require("./commands/env");
 const functions_1 = require("./commands/functions");
 const logs_1 = require("./commands/logs");
 const schedules_1 = require("./commands/schedules");
@@ -84,6 +85,24 @@ async function run(args) {
         case 'logs':
             await (0, logs_1.logs)(rest);
             return;
+        case 'env':
+            if (second === 'set') {
+                await (0, env_1.envSet)(rest);
+                return;
+            }
+            if (second === 'rm' || second === 'remove') {
+                await (0, env_1.envRemove)(rest);
+                return;
+            }
+            if (second === 'check') {
+                await (0, env_1.envCheck)();
+                return;
+            }
+            if (second === undefined || second === 'list' || second === 'pull') {
+                await (0, env_1.envList)();
+                return;
+            }
+            throw new errors_1.CliError(`Неизвестная команда: env ${second}`, 'Есть list, check, set и rm');
         case 'schedules':
             if (second === 'set') {
                 await (0, schedules_1.schedulesSet)(rest);

package/dist/commands/env.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.envList = envList;
+exports.envCheck = envCheck;
+exports.envSet = envSet;
+exports.envRemove = envRemove;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const api_1 = require("../api");
+const args_1 = require("../args");
+const config_1 = require("../config");
+const errors_1 = require("../errors");
+const session_1 = require("../session");
+const ui_1 = require("../ui");
+const FUNCTIONS_DIR = 'functions';
+/** Что функции просят у окружения: `process.env.NAME` и `process.env['NAME']`. */
+const ENV_REFERENCE = /process\.env(?:\.([A-Z0-9_]+)|\[['"]([A-Z0-9_]+)['"]\])/g;
+/** Свои переменные платформа кладёт сама, спрашивать их у пользователя незачем. */
+const PROVIDED = new Set([
+    'XFLOW_PROJECT_ID',
+    'XFLOW_PROJECT_TOKEN',
+    'XFLOW_PROJECT_SCHEMA',
+    'XFLOW_FUNCTION_NAME',
+    'XFLOW_API_URL',
+    'DATABASE_URL',
+    'NODE_ENV',
+]);
+function sourceFiles(dir, found = []) {
+    if (!(0, node_fs_1.existsSync)(dir))
+        return found;
+    for (const entry of (0, node_fs_1.readdirSync)(dir)) {
+        const full = (0, node_path_1.join)(dir, entry);
+        if ((0, node_fs_1.statSync)(full).isDirectory())
+            sourceFiles(full, found);
+        else if (/\.(ts|js|mjs)$/.test(entry))
+            found.push(full);
+    }
+    return found;
+}
+/** Какие переменные упоминают функции проекта, и в какой из них. */
+function referencedByFunctions(root) {
+    const references = new Map();
+    for (const file of sourceFiles((0, node_path_1.join)(root, FUNCTIONS_DIR))) {
+        const functionName = file.slice((0, node_path_1.join)(root, FUNCTIONS_DIR).length + 1).split(/[\\/]/)[0];
+        const code = (0, node_fs_1.readFileSync)(file, 'utf-8');
+        for (const match of code.matchAll(ENV_REFERENCE)) {
+            const name = match[1] || match[2];
+            if (!name || PROVIDED.has(name))
+                continue;
+            const users = references.get(name) ?? [];
+            if (!users.includes(functionName))
+                users.push(functionName);
+            references.set(name, users);
+        }
+    }
+    return references;
+}
+async function fetchVariables() {
+    const { root, config } = (0, config_1.requireProject)();
+    const client = (0, session_1.connect)(config);
+    const data = await (0, api_1.apiJson)(client, `/api/v1/projects/${config.projectId}/env`);
+    return { names: new Set(data.variables.map((row) => row.name)), rows: data.variables, root };
+}
+async function envList() {
+    const { rows } = await fetchVariables();
+    if (rows.length === 0) {
+        (0, ui_1.note)('Переменных нет');
+        (0, ui_1.note)((0, ui_1.dim)('  Записать: xflow env set SMTP_PASSWORD=секрет'));
+        return;
+    }
+    (0, ui_1.table)(rows.map((row) => [row.name, row.scope === 'project' ? 'только этот проект' : 'вся организация']));
+    (0, ui_1.note)((0, ui_1.dim)('  Значения платформа не отдаёт: их видно только внутри функции'));
+}
+/**
+ * Сверить, хватает ли функциям переменных.
+ *
+ * Это ответ на самый частый способ потерять полчаса: функция выкатилась, а падает
+ * на пустом process.env, потому что переменную забыли записать наверх.
+ */
+async function envCheck() {
+    const { names, root } = await fetchVariables();
+    const referenced = referencedByFunctions(root);
+    if (referenced.size === 0) {
+        (0, ui_1.note)('Функции проекта не читают переменных окружения');
+        return;
+    }
+    const missing = [];
+    const present = [];
+    for (const [name, users] of [...referenced.entries()].sort()) {
+        const row = [name, users.join(', ')];
+        if (names.has(name))
+            present.push(row);
+        else
+            missing.push(row);
+    }
+    if (present.length > 0) {
+        (0, ui_1.out)((0, ui_1.bold)('На платформе:'));
+        (0, ui_1.table)(present);
+    }
+    if (missing.length === 0) {
+        (0, ui_1.ok)('Всем функциям хватает переменных');
+        return;
+    }
+    (0, ui_1.out)('');
+    (0, ui_1.fail)('Нет на платформе:');
+    (0, ui_1.table)(missing);
+    throw new errors_1.CliError(`Переменных не хватает: ${missing.length}`, 'Записать: xflow env set ИМЯ=значение. Пока их нет, функция получит undefined');
+}
+async function envSet(args) {
+    const { root, config } = (0, config_1.requireProject)();
+    const client = (0, session_1.connect)(config);
+    const pair = args.words[1];
+    if (!pair || !pair.includes('=')) {
+        throw new errors_1.CliError('Нужна пара ИМЯ=значение', 'Например: xflow env set SMTP_PASSWORD=секрет');
+    }
+    const name = pair.slice(0, pair.indexOf('=')).trim();
+    const value = pair.slice(pair.indexOf('=') + 1);
+    const result = await (0, api_1.apiJson)(client, `/api/v1/projects/${config.projectId}/env`, {
+        method: 'POST',
+        body: { name, value, scope: (0, args_1.flagString)(args, 'scope') === 'project' ? 'project' : 'organization' },
+    });
+    (0, ui_1.ok)(`${(0, ui_1.bold)(result.name)} записана (${result.scope === 'project' ? 'только этот проект' : 'вся организация'})`);
+    // Значение попадает в функцию на выкатке, а не в момент записи: пока функцию
+    // не передеплоили, в её окружении лежит прежнее.
+    const users = referencedByFunctions(root).get(name);
+    if (users && users.length > 0) {
+        (0, ui_1.note)((0, ui_1.dim)(`  Чтобы значение доехало, перевыложите: xflow functions deploy ${users.join(' && xflow functions deploy ')}`));
+    }
+}
+async function envRemove(args) {
+    const { config } = (0, config_1.requireProject)();
+    const client = (0, session_1.connect)(config);
+    const name = args.words[1];
+    if (!name)
+        throw new errors_1.CliError('Нужно имя переменной', 'Что записано: xflow env');
+    const result = await (0, api_1.apiJson)(client, `/api/v1/projects/${config.projectId}/env?name=${encodeURIComponent(name)}`, { method: 'DELETE' });
+    if (!result.removed) {
+        (0, ui_1.note)(`Переменной ${name} нет`);
+        return;
+    }
+    (0, ui_1.ok)(`${name} удалена`);
+    (0, ui_1.note)((0, ui_1.dim)('  В уже выложенных функциях значение останется до следующей выкатки'));
+}

package/dist/help.js

@@ -44,6 +44,9 @@ ${(0, ui_1.bold)('Функции')}
   xflow schedules set <имя> "0 3 ? * * *"
                                   запускать функцию по расписанию (UTC)
   xflow schedules rm <имя>        снять расписание
+  xflow env [check]               переменные функций: что записано, чего не хватает
+  xflow env set ИМЯ=значение      записать переменную
+  xflow env rm ИМЯ                удалить переменную
 
 ${(0, ui_1.bold)('База данных')}
   xflow db status                 какие миграции применены, а какие ждут
@@ -106,6 +109,27 @@ ${(0, ui_1.bold)('xflow functions invoke')}.
 
 Ошибки браузера собирает ${(0, ui_1.bold)('src/utils/error-logger.ts')} шаблона и только с
 выложенных адресов: локальный ${(0, ui_1.bold)('npm run dev')} сюда не пишет.`,
+    env: `${(0, ui_1.bold)('xflow env')} — переменные окружения функций
+
+Ключи, пароли и адреса чужих сервисов хранит платформа, а не репозиторий.
+Значение уходит наверх и обратно не возвращается: увидеть его можно только внутри
+функции. Так что своё же значение придётся хранить там, где вы его взяли.
+
+  xflow env                        что записано (имена, не значения)
+  xflow env check                  чего не хватает функциям этого проекта
+  xflow env set SMTP_PASSWORD=…    записать
+  xflow env rm SMTP_PASSWORD       удалить
+
+  --scope project                  видно только этому проекту, а не всей организации
+
+${(0, ui_1.bold)('check')} читает исходники в ${(0, ui_1.bold)('functions/')} и ищет обращения ${(0, ui_1.bold)('process.env.ИМЯ')}. Это же
+правило действует на выкатке: функция получает только те переменные, которые сама
+упоминает по имени. Имя, собранное выражением (${(0, ui_1.bold)("process.env['KEY_' + n]")}), в окружение
+не попадёт — читайте переменные буквально.
+
+Значение доезжает до функции на выкатке, а не в момент записи: после ${(0, ui_1.bold)('env set')} нужно
+${(0, ui_1.bold)('xflow functions deploy')} затронутых функций. То же и после удаления: в уже выложенной
+функции старое значение останется до следующей выкатки.`,
     schedules: `${(0, ui_1.bold)('xflow schedules')} — запуск функций по времени
 
 Расписание это таймер-триггер Yandex: он зовёт функцию сам, без участия

package/dist/version.js

@@ -6,6 +6,6 @@ exports.DEFAULT_API_URL = exports.CLI_VERSION = void 0;
  * рантайме нельзя, после сборки он лежит на уровень выше dist и в бандл не
  * попадает.
  */
-exports.CLI_VERSION = '0.1.4';
+exports.CLI_VERSION = '0.1.5';
 /** Адрес платформы по умолчанию. Переопределяется XFLOW_API_URL и полем `api` в xflow.json. */
 exports.DEFAULT_API_URL = 'https://app.getxflow.com';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getxflow/cli",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "CLI платформы XFlow: синхронизация кода, деплой и публикация приложений",
   "license": "UNLICENSED",
   "engines": {

package/skills/xflow/SKILL.md

@@ -58,8 +58,14 @@ and needs `xflow deploy` again.
 Treat a function as a public API: the token ships inside the frontend bundle, so anyone
 who opens the app can call it.
 
-Organization secrets reach a function only if it mentions them via `process.env`, so
-read them by name and do not build variable names dynamically.
+Keys and passwords live on the platform, not in the repository: `xflow env set SMTP_PASSWORD=…`
+writes one, `xflow env` lists the names, `xflow env check` tells you which variables your
+functions read but the platform does not have. Values never come back out — the only place
+they exist is inside the running function.
+
+A function receives only the variables it mentions by name via `process.env.NAME`, so never
+assemble a variable name from an expression. New values arrive on the next
+`xflow functions deploy`, not at the moment they are written.
 
 To run a function on a timer: `xflow schedules set report "0 3 ? * * *"` (daily at 03:00).
 Six fields, UTC, and exactly one of day-of-month / day-of-week must be `?` — that is