neon 7.0.5 → 7.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.js +5 -3
- package/dist/commands/api.js +60 -10
- package/dist/commands/projects.js +95 -26
- package/dist/index.js +1 -0
- package/package.json +3 -3
package/dist/api.js
CHANGED
|
@@ -208,7 +208,8 @@ function validateRequestTimeout(ms) {
|
|
|
208
208
|
}
|
|
209
209
|
const makeTimedFetch = (requestTimeoutMs) => async (input, init) => {
|
|
210
210
|
const timeout = AbortSignal.timeout(requestTimeoutMs);
|
|
211
|
-
const
|
|
211
|
+
const callerSignal = init?.signal ?? (input instanceof Request ? input.signal : void 0);
|
|
212
|
+
const signal = callerSignal ? AbortSignal.any([callerSignal, timeout]) : timeout;
|
|
212
213
|
const method = init?.method ?? (input instanceof Request ? input.method : "GET");
|
|
213
214
|
const url = input instanceof Request ? input.url : String(input);
|
|
214
215
|
log.debug("%s %s", method.toUpperCase(), url);
|
|
@@ -220,7 +221,7 @@ const makeTimedFetch = (requestTimeoutMs) => async (input, init) => {
|
|
|
220
221
|
log.debug("%d %s", response.status, response.statusText);
|
|
221
222
|
return response;
|
|
222
223
|
} catch (err) {
|
|
223
|
-
if (timeout.aborted && !
|
|
224
|
+
if (timeout.aborted && !callerSignal?.aborted) throw new RequestTimeoutError(requestTimeoutMs, err);
|
|
224
225
|
throw err;
|
|
225
226
|
}
|
|
226
227
|
};
|
|
@@ -365,8 +366,9 @@ const getApiClient = ({ apiKey, apiHost, requestTimeoutMs = REQUEST_TIMEOUT_MS }
|
|
|
365
366
|
client,
|
|
366
367
|
query
|
|
367
368
|
})),
|
|
368
|
-
listSharedProjects: (query = {}) => call(() => raw.listSharedProjects({
|
|
369
|
+
listSharedProjects: (query = {}, options = {}) => call(() => raw.listSharedProjects({
|
|
369
370
|
client,
|
|
371
|
+
signal: options.signal,
|
|
370
372
|
query: {
|
|
371
373
|
...query.cursor !== void 0 ? { cursor: query.cursor } : {},
|
|
372
374
|
...query.limit !== void 0 ? { limit: query.limit } : {},
|
package/dist/commands/api.js
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
import { t as __exportAll } from "../_chunks/rolldown-runtime-8H4AJuhK.js";
|
|
2
|
+
import { codeFromBody, isNeonApiError } from "../api.js";
|
|
2
3
|
import { writer } from "../writer.js";
|
|
3
4
|
import { describeOperation, getEndpoints, loadSpec } from "../utils/openapi.js";
|
|
4
5
|
import { readFileSync } from "node:fs";
|
|
5
6
|
import { resolve } from "node:path";
|
|
7
|
+
import chalk from "chalk";
|
|
6
8
|
import YAML from "yaml";
|
|
7
9
|
//#region src/commands/api.ts
|
|
8
10
|
var api_exports = /* @__PURE__ */ __exportAll({
|
|
9
11
|
buildBody: () => buildBody,
|
|
10
12
|
buildQuery: () => buildQuery,
|
|
11
13
|
builder: () => builder,
|
|
14
|
+
colorizeJson: () => colorizeJson,
|
|
12
15
|
command: () => command,
|
|
13
16
|
describe: () => describe,
|
|
14
17
|
handler: () => handler,
|
|
@@ -101,6 +104,23 @@ function parseHeaders(pairs) {
|
|
|
101
104
|
function assertMethod(method) {
|
|
102
105
|
if (!HTTP_METHODS.includes(method)) throw new Error(`Unsupported method "${method}". Use one of: ${HTTP_METHODS.join(", ")}.`);
|
|
103
106
|
}
|
|
107
|
+
const JSON_TOKEN = /("(?:\\.|[^"\\])*")(\s*:)?|\b(true|false)\b|\bnull\b|-?\d+(?:\.\d+)?(?:[eE][+-]?\d+)?/g;
|
|
108
|
+
/** Color the tokens of serialized JSON without changing a byte of the text itself. */
|
|
109
|
+
function colorizeJson(json) {
|
|
110
|
+
return json.replace(JSON_TOKEN, (token, string, colon, bool) => {
|
|
111
|
+
if (string !== void 0) return colon !== void 0 ? `${chalk.cyan(string)}${colon}` : chalk.green(string);
|
|
112
|
+
if (bool !== void 0) return chalk.magenta(token);
|
|
113
|
+
if (token === "null") return chalk.dim(token);
|
|
114
|
+
return chalk.yellow(token);
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
const METHOD_COLORS = {
|
|
118
|
+
GET: chalk.green,
|
|
119
|
+
POST: chalk.cyan,
|
|
120
|
+
PUT: chalk.yellow,
|
|
121
|
+
PATCH: chalk.yellow,
|
|
122
|
+
DELETE: chalk.red
|
|
123
|
+
};
|
|
104
124
|
async function readStdin() {
|
|
105
125
|
const chunks = [];
|
|
106
126
|
for await (const chunk of process.stdin) chunks.push(Buffer.from(chunk));
|
|
@@ -138,7 +158,8 @@ async function listEndpoints(args) {
|
|
|
138
158
|
"summary"
|
|
139
159
|
],
|
|
140
160
|
title: `Neon API endpoints (${endpoints.length})`,
|
|
141
|
-
emptyMessage: "No endpoints found in the spec."
|
|
161
|
+
emptyMessage: "No endpoints found in the spec.",
|
|
162
|
+
renderColumns: { method: (endpoint) => useColor(args) ? (METHOD_COLORS[endpoint.method] ?? String)(endpoint.method) : endpoint.method }
|
|
142
163
|
});
|
|
143
164
|
}
|
|
144
165
|
function isListing(args) {
|
|
@@ -242,16 +263,45 @@ async function runRequest(args) {
|
|
|
242
263
|
...hasBody ? { body } : {},
|
|
243
264
|
...Object.keys(headers).length > 0 ? { headers } : {}
|
|
244
265
|
};
|
|
245
|
-
|
|
246
|
-
|
|
266
|
+
let response;
|
|
267
|
+
try {
|
|
268
|
+
response = await args.apiClient.request(params);
|
|
269
|
+
} catch (err) {
|
|
270
|
+
if (args.include && isNeonApiError(err) && err.status !== void 0 && err.status !== 401 && !isSsoCode(codeFromBody(err.data))) await writeResponse(args, {
|
|
271
|
+
status: err.status,
|
|
272
|
+
statusText: err.statusText ?? "",
|
|
273
|
+
headers: err.headers ?? {},
|
|
274
|
+
data: err.data
|
|
275
|
+
});
|
|
276
|
+
throw err;
|
|
277
|
+
}
|
|
278
|
+
await writeResponse(args, response);
|
|
279
|
+
}
|
|
280
|
+
const isSsoCode = (code) => code === "SSO_AUTHORIZATION_REQUIRED" || code === "SSO_ORG_CREDS_ONLY";
|
|
281
|
+
/** Pipes stay plain regardless of FORCE_COLOR, so `neon api … | jq` never sees escapes. */
|
|
282
|
+
const useColor = (args) => process.stdout.isTTY === true && args.color !== false && !process.env.NO_COLOR && chalk.level > 0;
|
|
283
|
+
/** Resolves once stdout has taken the text, so a following `process.exit` can't cut it off. */
|
|
284
|
+
async function writeResponse(args, response) {
|
|
285
|
+
const color = useColor(args);
|
|
286
|
+
let text = "";
|
|
247
287
|
if (args.include) {
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
288
|
+
const status = `HTTP ${response.status} ${response.statusText}`;
|
|
289
|
+
const statusColor = response.status < 400 ? chalk.green : chalk.red;
|
|
290
|
+
text += `${color ? statusColor.bold(status) : status}\n`;
|
|
291
|
+
for (const [key, value] of Object.entries(response.headers)) text += `${color ? chalk.cyan(key) : key}: ${value}\n`;
|
|
292
|
+
text += "\n";
|
|
251
293
|
}
|
|
252
|
-
if (response.data
|
|
253
|
-
|
|
254
|
-
|
|
294
|
+
if (response.data !== void 0) {
|
|
295
|
+
if (args.output === "yaml") text += YAML.stringify(response.data);
|
|
296
|
+
else {
|
|
297
|
+
const json = JSON.stringify(response.data, null, 2);
|
|
298
|
+
text += `${color ? colorizeJson(json) : json}\n`;
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
if (text === "") return;
|
|
302
|
+
await new Promise((resolve, reject) => {
|
|
303
|
+
process.stdout.write(text, (err) => err ? reject(err) : resolve());
|
|
304
|
+
});
|
|
255
305
|
}
|
|
256
306
|
const command = "api [path]";
|
|
257
307
|
const describe = "Call any Neon API route directly (authenticated passthrough)";
|
|
@@ -335,4 +385,4 @@ const handler = async (args) => {
|
|
|
335
385
|
await runRequest(apiArgs);
|
|
336
386
|
};
|
|
337
387
|
//#endregion
|
|
338
|
-
export { buildBody, buildQuery, builder, command, describe, handler, parseHeaders, parseKeyValue, parseTypedValue, setDeep, api_exports as t };
|
|
388
|
+
export { buildBody, buildQuery, builder, colorizeJson, command, describe, handler, parseHeaders, parseKeyValue, parseTypedValue, setDeep, api_exports as t };
|
|
@@ -2,12 +2,13 @@ import { t as __exportAll } from "../_chunks/rolldown-runtime-8H4AJuhK.js";
|
|
|
2
2
|
import { isCi } from "../env.js";
|
|
3
3
|
import { log } from "../log.js";
|
|
4
4
|
import { isNeonApiError, messageFromBody } from "../api.js";
|
|
5
|
-
import { updateContextFile } from "../context.js";
|
|
5
|
+
import { readContextFile, updateContextFile } from "../context.js";
|
|
6
6
|
import { getCliName } from "../utils/cli_name.js";
|
|
7
7
|
import { projectCreateRequest, projectUpdateRequest } from "../parameters.gen.js";
|
|
8
8
|
import { writer } from "../writer.js";
|
|
9
9
|
import { getComputeUnits } from "../utils/compute_units.js";
|
|
10
10
|
import { psql } from "../utils/psql.js";
|
|
11
|
+
import chalk from "chalk";
|
|
11
12
|
import prompts from "prompts";
|
|
12
13
|
//#region src/commands/projects.ts
|
|
13
14
|
var projects_exports = /* @__PURE__ */ __exportAll({
|
|
@@ -18,6 +19,7 @@ var projects_exports = /* @__PURE__ */ __exportAll({
|
|
|
18
19
|
builder: () => builder,
|
|
19
20
|
command: () => command,
|
|
20
21
|
describe: () => describe,
|
|
22
|
+
formatDuration: () => formatDuration,
|
|
21
23
|
handler: () => handler
|
|
22
24
|
});
|
|
23
25
|
const PROJECT_FIELDS = [
|
|
@@ -176,37 +178,56 @@ const builder = (argv) => {
|
|
|
176
178
|
const handler = (args) => {
|
|
177
179
|
return args;
|
|
178
180
|
};
|
|
181
|
+
const listAll = async (fetchPage) => {
|
|
182
|
+
const result = [];
|
|
183
|
+
let cursor;
|
|
184
|
+
let end = false;
|
|
185
|
+
while (!end) {
|
|
186
|
+
const { data } = await fetchPage(cursor);
|
|
187
|
+
result.push(...data.projects);
|
|
188
|
+
cursor = data.pagination?.cursor;
|
|
189
|
+
log.debug("Got %d projects, with cursor: %s", data.projects.length, cursor);
|
|
190
|
+
if (data.projects.length < PROJECTS_LIST_LIMIT) end = true;
|
|
191
|
+
}
|
|
192
|
+
return result;
|
|
193
|
+
};
|
|
194
|
+
const projectColumns = (props) => {
|
|
195
|
+
const current = readContextFile(props.contextFile).projectId;
|
|
196
|
+
return { name: (project) => project.id === current ? `${chalk.green("[current]")} ${project.name}` : project.name };
|
|
197
|
+
};
|
|
179
198
|
const list = async (props) => {
|
|
180
|
-
const
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
}
|
|
198
|
-
const
|
|
199
|
-
const sharedProjects = props.orgId || props.recoverableOnly ? [] : await getList(props.apiClient.listSharedProjects);
|
|
199
|
+
const query = (cursor) => ({
|
|
200
|
+
limit: PROJECTS_LIST_LIMIT,
|
|
201
|
+
org_id: props.orgId,
|
|
202
|
+
recoverable: props.recoverableOnly,
|
|
203
|
+
cursor
|
|
204
|
+
});
|
|
205
|
+
const includeShared = !props.orgId && !props.recoverableOnly;
|
|
206
|
+
const ownedRequest = listAll((cursor) => props.apiClient.listProjects(query(cursor)));
|
|
207
|
+
const sharedAbort = new AbortController();
|
|
208
|
+
const sharedRequest = includeShared ? listAll((cursor) => props.apiClient.listSharedProjects(query(cursor), { signal: sharedAbort.signal })) : void 0;
|
|
209
|
+
sharedRequest?.catch(() => void 0);
|
|
210
|
+
let ownedProjects;
|
|
211
|
+
try {
|
|
212
|
+
ownedProjects = await ownedRequest;
|
|
213
|
+
} catch (err) {
|
|
214
|
+
sharedAbort.abort();
|
|
215
|
+
throw err;
|
|
216
|
+
}
|
|
217
|
+
const sharedProjects = await sharedRequest ?? [];
|
|
200
218
|
const out = writer(props);
|
|
219
|
+
const renderColumns = projectColumns(props);
|
|
201
220
|
out.write(ownedProjects, {
|
|
202
221
|
fields: props.recoverableOnly ? RECOVERABLE_PROJECT_FIELDS : PROJECT_FIELDS,
|
|
203
222
|
title: "Projects",
|
|
204
|
-
emptyMessage: props.recoverableOnly ? "You don't have any recoverable projects." : "You don't have any projects yet. See how to create a new project:\n> neon projects create --help"
|
|
223
|
+
emptyMessage: props.recoverableOnly ? "You don't have any recoverable projects." : "You don't have any projects yet. See how to create a new project:\n> neon projects create --help",
|
|
224
|
+
renderColumns
|
|
205
225
|
});
|
|
206
|
-
if (
|
|
226
|
+
if (includeShared) out.write(sharedProjects, {
|
|
207
227
|
fields: PROJECT_FIELDS,
|
|
208
228
|
title: "Shared with you",
|
|
209
|
-
emptyMessage: "No projects have been shared with you"
|
|
229
|
+
emptyMessage: "No projects have been shared with you",
|
|
230
|
+
renderColumns
|
|
210
231
|
});
|
|
211
232
|
out.end();
|
|
212
233
|
};
|
|
@@ -303,7 +324,55 @@ const recover = async (props) => {
|
|
|
303
324
|
};
|
|
304
325
|
const get = async (props) => {
|
|
305
326
|
const { data } = await props.apiClient.getProject(props.id);
|
|
306
|
-
|
|
327
|
+
if (props.output === "json" || props.output === "yaml") {
|
|
328
|
+
writer(props).end(data.project, { fields: PROJECT_FIELDS });
|
|
329
|
+
return;
|
|
330
|
+
}
|
|
331
|
+
writer(props).end(projectDetails(data.project), {
|
|
332
|
+
fields: PROJECT_DETAIL_FIELDS,
|
|
333
|
+
humanTitle: "Project"
|
|
334
|
+
});
|
|
335
|
+
};
|
|
336
|
+
const PROJECT_DETAIL_FIELDS = [
|
|
337
|
+
"name",
|
|
338
|
+
"id",
|
|
339
|
+
"region_id",
|
|
340
|
+
"postgres_version",
|
|
341
|
+
"organization",
|
|
342
|
+
"default_compute",
|
|
343
|
+
"history_retention",
|
|
344
|
+
"created_at",
|
|
345
|
+
"updated_at"
|
|
346
|
+
];
|
|
347
|
+
/** Table-only view of a project; the field names become the row labels. */
|
|
348
|
+
const projectDetails = (project) => ({
|
|
349
|
+
name: project.name,
|
|
350
|
+
id: project.id,
|
|
351
|
+
region_id: project.region_id,
|
|
352
|
+
postgres_version: project.pg_version,
|
|
353
|
+
organization: project.org_id,
|
|
354
|
+
default_compute: formatComputeRange(project.default_endpoint_settings),
|
|
355
|
+
history_retention: project.history_retention_seconds === void 0 ? void 0 : formatDuration(project.history_retention_seconds),
|
|
356
|
+
created_at: project.created_at,
|
|
357
|
+
updated_at: project.updated_at
|
|
358
|
+
});
|
|
359
|
+
const formatComputeRange = (settings) => {
|
|
360
|
+
const min = settings?.autoscaling_limit_min_cu;
|
|
361
|
+
const max = settings?.autoscaling_limit_max_cu;
|
|
362
|
+
if (min === void 0 || max === void 0) return;
|
|
363
|
+
return min === max ? `${min} CU` : `${min}-${max} CU`;
|
|
364
|
+
};
|
|
365
|
+
const DURATION_UNITS = [
|
|
366
|
+
["day", 86400],
|
|
367
|
+
["hour", 3600],
|
|
368
|
+
["minute", 60]
|
|
369
|
+
];
|
|
370
|
+
const formatDuration = (seconds) => {
|
|
371
|
+
for (const [unit, size] of DURATION_UNITS) if (seconds > 0 && seconds % size === 0) {
|
|
372
|
+
const count = seconds / size;
|
|
373
|
+
return `${count} ${unit}${count === 1 ? "" : "s"}`;
|
|
374
|
+
}
|
|
375
|
+
return `${seconds} second${seconds === 1 ? "" : "s"}`;
|
|
307
376
|
};
|
|
308
377
|
const handleMissingOrgId = async (args, cmd) => {
|
|
309
378
|
try {
|
|
@@ -367,4 +436,4 @@ const onPromptState = (state) => {
|
|
|
367
436
|
}
|
|
368
437
|
};
|
|
369
438
|
//#endregion
|
|
370
|
-
export { PROJECT_FIELDS, RECOVERABLE_PROJECT_FIELDS, REGIONS, aliases, builder, command, describe, handler, projects_exports as t };
|
|
439
|
+
export { PROJECT_FIELDS, RECOVERABLE_PROJECT_FIELDS, REGIONS, aliases, builder, command, describe, formatDuration, handler, projects_exports as t };
|
package/dist/index.js
CHANGED
|
@@ -179,6 +179,7 @@ async function handleError(msg, err, canRetry) {
|
|
|
179
179
|
} else {
|
|
180
180
|
const serverMessage = messageFromBody(err.data);
|
|
181
181
|
if (serverMessage) log.error(serverMessage);
|
|
182
|
+
else log.error([`HTTP ${err.status ?? ""} ${err.statusText ?? ""}`.trim(), err.requestPath].filter(Boolean).join(" | "));
|
|
182
183
|
log.debug("status: %d %s | path: %s", err.status, err.statusText, err.requestPath);
|
|
183
184
|
sendError(err, "API_ERROR");
|
|
184
185
|
return false;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "neon",
|
|
3
|
-
"version": "7.0.
|
|
3
|
+
"version": "7.0.7",
|
|
4
4
|
"description": "CLI tool for Neon, the cloud backend primitives built around Lakebase Postgres",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"neon",
|
|
@@ -64,9 +64,9 @@
|
|
|
64
64
|
"yaml": "^2.9.0",
|
|
65
65
|
"yargs": "17.7.2",
|
|
66
66
|
"yoctocolors": "^2.1.2",
|
|
67
|
-
"@neon/
|
|
67
|
+
"@neon/config-runtime": "1.7.3",
|
|
68
68
|
"@neon/config": "1.8.3",
|
|
69
|
-
"@neon/
|
|
69
|
+
"@neon/sdk": "7.0.0"
|
|
70
70
|
},
|
|
71
71
|
"optionalDependencies": {
|
|
72
72
|
"@napi-rs/keyring": "1.3.0",
|