@vincentt-xr/cli 0.17.0 → 0.18.0

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.
Files changed (95) hide show
  1. package/MIGRATION.md +24 -0
  2. package/README.md +94 -1
  3. package/dist/cli/index.js +170 -84
  4. package/dist/cli/usage-text.js +32 -10
  5. package/dist/domain/api.d.ts +10 -8
  6. package/dist/domain/api.js +14 -9
  7. package/dist/domain/command.js +25 -16
  8. package/dist/domain/copy.d.ts +6 -3
  9. package/dist/domain/copy.js +10 -6
  10. package/dist/dx/command.d.ts +24 -4
  11. package/dist/dx/command.js +80 -25
  12. package/dist/dx/consent.js +6 -5
  13. package/dist/dx/journal.d.ts +17 -2
  14. package/dist/dx/journal.js +19 -3
  15. package/dist/dx/report.js +4 -3
  16. package/dist/dx/reportIo.js +6 -5
  17. package/dist/dx/send.js +6 -5
  18. package/dist/lib/backend.d.ts +0 -16
  19. package/dist/lib/backend.js +2 -26
  20. package/dist/lib/detect.d.ts +87 -0
  21. package/dist/lib/detect.js +867 -0
  22. package/dist/lib/diagnostics.js +2 -2
  23. package/dist/lib/feedback.js +1 -1
  24. package/dist/lib/feedbackCopy.js +1 -1
  25. package/dist/lib/initFrom.js +4 -4
  26. package/dist/lib/lifecycle.d.ts +2 -0
  27. package/dist/lib/lifecycle.js +9 -3
  28. package/dist/lib/listProjects.js +2 -1
  29. package/dist/lib/projects.d.ts +37 -2
  30. package/dist/lib/projects.js +86 -21
  31. package/dist/lib/settings.d.ts +113 -0
  32. package/dist/lib/settings.js +284 -0
  33. package/dist/lib/settingsCopy.d.ts +6 -0
  34. package/dist/lib/settingsCopy.js +99 -0
  35. package/dist/lib/settle.d.ts +61 -0
  36. package/dist/lib/settle.js +338 -0
  37. package/dist/lib/template.d.ts +19 -0
  38. package/dist/lib/template.js +73 -0
  39. package/dist/lib/terminalText.d.ts +3 -0
  40. package/dist/lib/terminalText.js +10 -0
  41. package/dist/lib/version.js +5 -11
  42. package/dist/lib/whoami.js +10 -3
  43. package/dist/library/assetsCommand.js +1 -1
  44. package/dist/library/client.js +8 -3
  45. package/dist/library/render.js +8 -6
  46. package/dist/login/authBackend.js +3 -2
  47. package/dist/login/ensure.d.ts +8 -2
  48. package/dist/login/ensure.js +21 -10
  49. package/dist/login/guard.js +5 -4
  50. package/dist/login/loginCommand.d.ts +2 -2
  51. package/dist/login/loginCommand.js +29 -5
  52. package/dist/login/pkce.js +1 -1
  53. package/dist/login/pkceLogin.js +1 -1
  54. package/dist/platform/outdated.js +2 -2
  55. package/dist/platform/upgradeReport.js +16 -12
  56. package/dist/preview/api.d.ts +5 -11
  57. package/dist/preview/api.js +13 -15
  58. package/dist/preview/command.d.ts +29 -0
  59. package/dist/preview/command.js +61 -1
  60. package/dist/preview/copy.d.ts +35 -3
  61. package/dist/preview/copy.js +102 -10
  62. package/dist/preview/proxy.d.ts +38 -1
  63. package/dist/preview/proxy.js +151 -2
  64. package/dist/preview/qrPage.js +1 -1
  65. package/dist/preview/runner.d.ts +25 -13
  66. package/dist/preview/runner.js +127 -26
  67. package/dist/preview/viewers.js +1 -1
  68. package/dist/publish/api.d.ts +22 -5
  69. package/dist/publish/api.js +80 -9
  70. package/dist/publish/command.d.ts +25 -0
  71. package/dist/publish/command.js +211 -35
  72. package/dist/publish/copy.d.ts +78 -5
  73. package/dist/publish/copy.js +271 -37
  74. package/dist/publish/fit.d.ts +15 -0
  75. package/dist/publish/fit.js +103 -0
  76. package/dist/publish/manifest.d.ts +44 -3
  77. package/dist/publish/manifest.js +172 -3
  78. package/dist/publish/prompt.d.ts +4 -0
  79. package/dist/publish/prompt.js +15 -1
  80. package/dist/publish/upload.d.ts +6 -0
  81. package/dist/publish/upload.js +11 -1
  82. package/dist/publish/visibility.d.ts +21 -0
  83. package/dist/publish/visibility.js +68 -0
  84. package/dist/relay/annotations.js +9 -4
  85. package/dist/relay/server.d.ts +21 -0
  86. package/dist/relay/server.js +35 -1
  87. package/dist/shared/authError.d.ts +27 -0
  88. package/dist/shared/authError.js +48 -4
  89. package/dist/shared/config.d.ts +21 -1
  90. package/dist/shared/config.js +39 -8
  91. package/dist/shared/countLimit.d.ts +7 -2
  92. package/dist/shared/countLimit.js +12 -5
  93. package/dist/shared/http.d.ts +23 -0
  94. package/dist/shared/http.js +58 -0
  95. package/package.json +7 -3
@@ -12,6 +12,7 @@ import { randomBytes } from "node:crypto";
12
12
  import { promises as fs } from "node:fs";
13
13
  import os from "node:os";
14
14
  import path from "node:path";
15
+ import { NotSignedInError } from "./authError.js";
15
16
  import { recordLocation } from "./recordLocation.js";
16
17
  export const MACHINE_CONFIG_PATH = path.join(os.homedir(), ".vincentt", "config.json");
17
18
  const BINDING_DIR = ".vincentt";
@@ -216,9 +217,41 @@ async function ensureGitignored(cwd, pattern) {
216
217
  // A missing/unwritable .gitignore must not fail project creation.
217
218
  }
218
219
  }
219
- export const DEFAULT_API_URL = "http://localhost:5051";
220
+ /**
221
+ * Every environment variable the CLI reads a credential from. They are removed
222
+ * from the environment of the creator's dev command, which is repo-controlled.
223
+ * A credential read added to this file without a name here fails a unit test.
224
+ */
225
+ export const CLI_CREDENTIAL_ENV = ["VINCENTT_PAT"];
226
+ export function withoutCliCredentials(env) {
227
+ const out = { ...env };
228
+ // Compared upper-cased: Windows environment names are case-insensitive.
229
+ for (const key of Object.keys(out)) {
230
+ if (CLI_CREDENTIAL_ENV.includes(key.toUpperCase()))
231
+ delete out[key];
232
+ }
233
+ return out;
234
+ }
235
+ export const DEFAULT_API_URL = "https://api.vincentt.studio";
236
+ /**
237
+ * The API host the person running the command configured: an explicit flag, then
238
+ * VINCENTT_API_URL, then the machine config, then the default. Every verb reads
239
+ * its host through here, so a token is never sent to one host by one verb and to
240
+ * another by the next. A binding's override is layered on top by decideApiUrl.
241
+ */
242
+ export function configuredApiUrl(input) {
243
+ return strip(input.flagApiUrl || input.envApiUrl || input.machineApiUrl || DEFAULT_API_URL);
244
+ }
245
+ /** configuredApiUrl from this process's environment and a machine config already read. */
246
+ export function machineApiUrl(machine, flagApiUrl) {
247
+ return configuredApiUrl({
248
+ flagApiUrl,
249
+ envApiUrl: process.env.VINCENTT_API_URL,
250
+ machineApiUrl: machine.apiUrl,
251
+ });
252
+ }
220
253
  export function decideApiUrl(input) {
221
- const configuredUrl = input.envApiUrl ?? input.machineApiUrl ?? DEFAULT_API_URL;
254
+ const configuredUrl = configuredApiUrl(input);
222
255
  const binding = input.bindingApiUrl;
223
256
  if (!binding || strip(binding) === strip(configuredUrl)) {
224
257
  return { apiUrl: configuredUrl, configuredUrl };
@@ -255,10 +288,8 @@ export async function resolveConfig(cwd, opts = {}) {
255
288
  }
256
289
  }
257
290
  const pat = process.env.VINCENTT_PAT ?? machine.pat;
258
- if (!pat) {
259
- throw new Error(`No Vincentt access token found. Add {"apiUrl":"…","pat":"…"} to ${MACHINE_CONFIG_PATH}, ` +
260
- `or set the VINCENTT_PAT env var.`);
261
- }
291
+ if (!pat)
292
+ throw new NotSignedInError();
262
293
  return { apiUrl: strip(decided.apiUrl), pat };
263
294
  }
264
295
  const BINDING_REL_PATH = `${BINDING_DIR}/${BINDING_FILE}`;
@@ -292,8 +323,8 @@ export function apiUrlAdvisory(decided, ctx) {
292
323
  ` your machine config:${pad} ${decided.configuredUrl}`,
293
324
  "",
294
325
  " Your access token is sent with every request, so it would go to",
295
- ` ${hostOf(decided.ignoredBindingApiUrl)}. A binding file travels with a repository —`,
296
- " anyone who can commit to it can set this.",
326
+ ` ${hostOf(decided.ignoredBindingApiUrl)}. A binding file travels with a repository,`,
327
+ " so anyone who can commit to it can set this.",
297
328
  "",
298
329
  " Ignoring the binding and using your machine config.",
299
330
  " To use the binding's API on purpose, re-run with --allow-custom-api.",
@@ -74,7 +74,12 @@ export declare function countRows(i: ResolvedCountLimit, axisLabel: string, plan
74
74
  */
75
75
  export declare function consoleLines(i: ResolvedCountLimit, path: string): string[];
76
76
  /**
77
- * The published-project ceiling, refused at open-publish.
77
+ * The published-project ceiling, refused at open-publish or at commit.
78
+ *
79
+ * Commit re-checks because two publishes opened in the same org can both be
80
+ * admitted and race to go live; the loser is refused after its bytes were
81
+ * uploaded. The api keeps those bytes as a stored version, so the last line
82
+ * changes to say so and nothing else does.
78
83
  *
79
84
  * "One published project" means ONE LIVE ADDRESS AT A TIME, and the copy says
80
85
  * so, because the other reading — one project ever published — is what makes a
@@ -85,7 +90,7 @@ export declare function consoleLines(i: ResolvedCountLimit, path: string): strin
85
90
  * though it is: a creator refused here is publishing a SECOND project, so the
86
91
  * exclusion never applies on the screen that would explain it.
87
92
  */
88
- export declare function publishedLimitRefused(i: ResolvedCountLimit): string[];
93
+ export declare function publishedLimitRefused(i: ResolvedCountLimit, stage?: "open" | "commit"): string[];
89
94
  /**
90
95
  * The concurrent-preview ceiling, refused at mint.
91
96
  *
@@ -61,7 +61,7 @@ export function countRows(i, axisLabel, planSuffix) {
61
61
  if (i.orgName || i.orgSlug)
62
62
  rows.push(["Organization", orgLabel(i.orgName, i.orgSlug)]);
63
63
  if (i.planName)
64
- rows.push(["Plan", `${i.planName} — ${planSuffix}`]);
64
+ rows.push(["Plan", `${i.planName} (${planSuffix})`]);
65
65
  rows.push([axisLabel, `${i.count} of ${i.ceiling} used`]);
66
66
  return alignedRows(rows);
67
67
  }
@@ -92,7 +92,12 @@ export function consoleLines(i, path) {
92
92
  // A renderer for it added here would be an export with no caller, which is worse
93
93
  // than nothing: it reads as coverage and cannot fail.
94
94
  /**
95
- * The published-project ceiling, refused at open-publish.
95
+ * The published-project ceiling, refused at open-publish or at commit.
96
+ *
97
+ * Commit re-checks because two publishes opened in the same org can both be
98
+ * admitted and race to go live; the loser is refused after its bytes were
99
+ * uploaded. The api keeps those bytes as a stored version, so the last line
100
+ * changes to say so and nothing else does.
96
101
  *
97
102
  * "One published project" means ONE LIVE ADDRESS AT A TIME, and the copy says
98
103
  * so, because the other reading — one project ever published — is what makes a
@@ -103,7 +108,7 @@ export function consoleLines(i, path) {
103
108
  * though it is: a creator refused here is publishing a SECOND project, so the
104
109
  * exclusion never applies on the screen that would explain it.
105
110
  */
106
- export function publishedLimitRefused(i) {
111
+ export function publishedLimitRefused(i, stage = "open") {
107
112
  return [
108
113
  "",
109
114
  "✗ This organization is already publishing as many projects as its plan allows.",
@@ -115,7 +120,9 @@ export function publishedLimitRefused(i) {
115
120
  " everything already published stays exactly as it is.",
116
121
  "",
117
122
  ...consoleLines(i, "projects"),
118
- " Nothing was uploaded.",
123
+ stage === "commit"
124
+ ? " Your files were uploaded and kept, but nothing went live."
125
+ : " Nothing was uploaded.",
119
126
  "",
120
127
  ];
121
128
  }
@@ -135,7 +142,7 @@ export function previewLimitRefused(i) {
135
142
  "",
136
143
  ...countRows(i, "Previews", "previews are counted per organization"),
137
144
  "",
138
- " Every preview that was running is still running — this one did not start.",
145
+ " Every preview that was running is still running. This one did not start.",
139
146
  " A preview stops when whoever started it stops it, or when it reaches its",
140
147
  " 12-hour limit.",
141
148
  "",
@@ -0,0 +1,23 @@
1
+ /** A request that did not finish inside its deadline. Nothing is known about its outcome. */
2
+ export declare class RequestTimeout extends Error {
3
+ readonly ms: number;
4
+ constructor(ms: number);
5
+ }
6
+ export declare const API_DEADLINE_MS = 30000;
7
+ /**
8
+ * Wrap a fetch so each call is aborted after `ms`. The deadline covers the body
9
+ * read too: the timer is not cleared when headers arrive, and aborting a request
10
+ * whose body was already read is a no-op. The timer is unref'd so it never holds
11
+ * the process open. A caller's own signal still aborts the request.
12
+ */
13
+ export declare function withDeadline(fetchImpl: typeof fetch, ms: number): typeof fetch;
14
+ /**
15
+ * The global fetch with the api deadline. Looked up per call, never captured, so
16
+ * a test that stubs the global still reaches its stub.
17
+ */
18
+ export declare const apiFetch: typeof fetch;
19
+ /**
20
+ * A request abandoned by the network or by its deadline, as opposed to a
21
+ * response the server sent. Its outcome on the server is unknown.
22
+ */
23
+ export declare function isTransportError(err: unknown): boolean;
@@ -0,0 +1,58 @@
1
+ // The one fetch wrapper with a deadline. Every api call goes through apiFetch, so
2
+ // a stalled server or a dead network ends in a bounded error instead of a hang
3
+ // (including the Ctrl-C path, which ends the preview session with an api call).
4
+ /** A request that did not finish inside its deadline. Nothing is known about its outcome. */
5
+ export class RequestTimeout extends Error {
6
+ ms;
7
+ constructor(ms) {
8
+ super(`the request did not finish within ${Math.round(ms / 1000)}s`);
9
+ this.ms = ms;
10
+ this.name = "RequestTimeout";
11
+ }
12
+ }
13
+ export const API_DEADLINE_MS = 30_000;
14
+ /**
15
+ * Wrap a fetch so each call is aborted after `ms`. The deadline covers the body
16
+ * read too: the timer is not cleared when headers arrive, and aborting a request
17
+ * whose body was already read is a no-op. The timer is unref'd so it never holds
18
+ * the process open. A caller's own signal still aborts the request.
19
+ */
20
+ export function withDeadline(fetchImpl, ms) {
21
+ return (async (input, init = {}) => {
22
+ const controller = new AbortController();
23
+ const timer = setTimeout(() => controller.abort(new RequestTimeout(ms)), ms);
24
+ timer.unref?.();
25
+ const outer = init.signal;
26
+ if (outer) {
27
+ if (outer.aborted)
28
+ controller.abort(outer.reason);
29
+ else
30
+ outer.addEventListener("abort", () => controller.abort(outer.reason), {
31
+ once: true,
32
+ });
33
+ }
34
+ try {
35
+ return await fetchImpl(input, { ...init, signal: controller.signal });
36
+ }
37
+ catch (err) {
38
+ if (controller.signal.reason instanceof RequestTimeout)
39
+ throw controller.signal.reason;
40
+ throw err;
41
+ }
42
+ });
43
+ }
44
+ /**
45
+ * The global fetch with the api deadline. Looked up per call, never captured, so
46
+ * a test that stubs the global still reaches its stub.
47
+ */
48
+ export const apiFetch = withDeadline((input, init) => globalThis.fetch(input, init), API_DEADLINE_MS);
49
+ /**
50
+ * A request abandoned by the network or by its deadline, as opposed to a
51
+ * response the server sent. Its outcome on the server is unknown.
52
+ */
53
+ export function isTransportError(err) {
54
+ if (err instanceof RequestTimeout)
55
+ return true;
56
+ // undici reports a refused, reset or unresolvable connection as a TypeError.
57
+ return err instanceof TypeError || (err instanceof Error && err.name === "AbortError");
58
+ }
package/package.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "name": "@vincentt-xr/cli",
3
- "version": "0.17.0",
3
+ "version": "0.18.0",
4
4
  "description": "Vincentt CLI — the vincentt command-line dev loop (login, create, publish, preview, diagnostics, feedback, relay)",
5
5
  "license": "UNLICENSED",
6
6
  "type": "module",
7
7
  "files": [
8
- "dist"
8
+ "dist",
9
+ "MIGRATION.md"
9
10
  ],
10
11
  "exports": {
11
12
  "./preview": {
@@ -20,11 +21,14 @@
20
21
  "bin": {
21
22
  "vincentt": "./dist/cli/index.js"
22
23
  },
24
+ "engines": {
25
+ "node": ">=18"
26
+ },
23
27
  "dependencies": {
24
28
  "qrcode": "^1.5.4",
25
29
  "ws": "^8.18.0",
26
30
  "zod": "^3.23.8",
27
- "@vincentt-xr/harness": "1.5.0"
31
+ "@vincentt-xr/harness": "1.6.0"
28
32
  },
29
33
  "devDependencies": {
30
34
  "@types/qrcode": "^1.5.5",