@impeccable/reviews 0.1.7 → 0.1.8

package/dist/vercel-bypass.js

@@ -14,10 +14,12 @@ export const BYPASS_HEADER = 'x-vercel-protection-bypass';
 export const SECRET_NOTE = 'Impeccable reviews';
 /** Vercel makes its secrets of 32 letters and digits, and takes no other. */
 export const isBypassSecret = (value) => typeof value === 'string' && /^[A-Za-z0-9]{32}$/.test(value);
-/** The CLI's read of the linked project's protection: `protectionBypass` maps each secret to its note and creation time. */
+/** The CLI's read of the linked project's protection, or with `name` that project's: `protectionBypass` maps each secret to its note and creation time. */
 export const READ = ['project', 'protection', '--format', 'json', '--non-interactive'];
-/** The CLI's own way to make a secret, which carries no label, for a CLI without `api`. */
+const readArgs = (name) => (name ? ['project', 'protection', name, ...READ.slice(2)] : READ);
+/** The CLI's own way to make a secret, which carries no label, for a CLI without `api`; with `name`, on that project. */
 export const MAKE_CLI = ['project', 'protection', 'enable', '--protection-bypass', '--non-interactive'];
+const makeArgs = (name) => (name ? ['project', 'protection', 'enable', name, ...MAKE_CLI.slice(3)] : MAKE_CLI);
 /** `vercel api` (beta) for PATCH /v1/projects/{id}/protection-bypass with `generate.note`, so the secret carries the label; a team's project needs its team on the request. */
 export const makeApi = (link) => [
     'api',
@@ -30,21 +32,23 @@ const record = (value) => (value !== null && typeof value === 'object' && !Array
 /** The ids as Vercel makes them, and nothing else goes into a request's path: the file is in the checkout, which the repository and the sandboxed agent write. */
 const PROJECT_ID = /^prj_[A-Za-z0-9]+$/;
 const ORG_ID = /^(?:team_)?[A-Za-z0-9]+$/;
+/** A project and its team or account as Vercel names them, or null for ids that are not Vercel's. */
+export const asLink = (projectId, orgId) => typeof projectId === 'string' && PROJECT_ID.test(projectId) && typeof orgId === 'string' && ORG_ID.test(orgId) ? { projectId, orgId } : null;
 /** The link as the file has it; null with no file, or ids that are not Vercel's. What project the ids name is the CLI's to confirm (readOwnProject in vercel.ts). */
 export async function readLink(cwd) {
     try {
         const link = record(JSON.parse(await readFile(join(cwd, '.vercel', 'project.json'), 'utf8')));
-        return typeof link?.projectId === 'string' && PROJECT_ID.test(link.projectId) && typeof link.orgId === 'string' && ORG_ID.test(link.orgId) ? { projectId: link.projectId, orgId: link.orgId } : null;
+        return asLink(link?.projectId, link?.orgId);
     }
     catch {
         return null;
     }
 }
 /** The linked project's name and automation secrets; null when the CLI could not say: signed out, not linked, or the role does not allow it; or when what it read is not the project `link` names. */
-async function readProject(run, link) {
+async function readProject(run, link, name) {
     let settings;
     try {
-        const printed = await run(READ);
+        const printed = await run(readArgs(name));
         settings = record(JSON.parse(printed.slice(printed.indexOf('{'), printed.lastIndexOf('}') + 1)));
     }
     catch {
@@ -64,7 +68,7 @@ function pick(secrets, before) {
     return newest(secrets.filter((s) => s.note === SECRET_NOTE)) ?? (before && newest(secrets.filter((s) => !before.has(s.value))));
 }
 /** Makes the secret with the label through `vercel api`; a CLI without `api` (or one Vercel refuses) falls back to its own command, which the same role check stops. */
-async function make(run, link) {
+async function make(run, link, name) {
     if (link) {
         try {
             await run(makeApi(link));
@@ -75,7 +79,7 @@ async function make(run, link) {
         }
     }
     try {
-        await run(MAKE_CLI);
+        await run(makeArgs(name));
         return true;
     }
     catch {
@@ -90,7 +94,7 @@ async function make(run, link) {
  */
 export async function passVercelLogin(deps) {
     const link = await deps.link();
-    const project = await readProject(deps.run, link);
+    const project = await readProject(deps.run, link, deps.project);
     const from = project?.name ? { project: project.name } : {};
     const finish = async (secret, how) => {
         deps.remember(secret);
@@ -116,10 +120,10 @@ export async function passVercelLogin(deps) {
             if (!(await deps.consent()))
                 return { status: 'skipped', reason: 'The person skipped creating a bypass secret.', ...from };
             const before = new Set(project.secrets.map((s) => s.value));
-            if (!(await make(deps.run, link)))
+            if (!(await make(deps.run, link, deps.project)))
                 stopped = 'The Vercel CLI could not make a bypass secret on the project: that takes the Member role or Project Administrator.';
             else {
-                const ours = pick((await readProject(deps.run, link))?.secrets ?? [], before);
+                const ours = pick((await readProject(deps.run, link, deps.project))?.secrets ?? [], before);
                 if (!ours)
                     stopped = 'The secret the Vercel CLI made could not be read back.';
                 else {

package/dist/vercel.js

@@ -1,8 +1,8 @@
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { setTimeout as sleep } from 'node:timers/promises';
-import { matchesBranch, TEST_DRIVE_BRANCH } from './host-previews.js';
-import { readLink } from './vercel-bypass.js';
+import { folderOf, matchesBranch, TEST_DRIVE_BRANCH } from './host-previews.js';
+import { asLink, readLink } from './vercel-bypass.js';
 /** `vercel whoami`: the CLI prints the username, or says it has no credentials and exits 1. */
 export async function vercelStatus(vercel) {
     try {
@@ -135,7 +135,8 @@ export async function readLinkedProject(vercel, link) {
     const ignore = project.commandForIgnoringBuildStep;
     // The live app: the production deployment's first alias, the project's own domain, as Vercel lists them (its automatic aliases follow). Its own hashed address is one build's, which the next production deployment leaves behind: never the before.
     const live = target && !failed(target) ? (Array.isArray(target.alias) ? target.alias : []).map(hostname).find(Boolean) : undefined;
-    return { ...(typeof project.name === 'string' && project.name ? { name: project.name } : {}), production: exists ? 'exists' : 'none', ...(typeof branch === 'string' && branch ? { productionBranch: branch } : {}), ...(live ? { productionUrl: `https://${live}` } : {}), protection: typeof protection === 'string' ? protection : null, previewsProtected, deploymentHosts: new Set(hosts), ...(repository ? { repository } : {}), ignoredBuildStep: typeof ignore === 'string' && ignore.trim().length > 0, githubDeployments: record(project.gitProviderOptions)?.createDeployments !== 'disabled' };
+    const root = folderOf(project.rootDirectory);
+    return { ...(root !== undefined ? { rootDirectory: root } : {}), ...(typeof project.name === 'string' && project.name ? { name: project.name } : {}), production: exists ? 'exists' : 'none', ...(typeof branch === 'string' && branch ? { productionBranch: branch } : {}), ...(live ? { productionUrl: `https://${live}` } : {}), protection: typeof protection === 'string' ? protection : null, previewsProtected, deploymentHosts: new Set(hosts), ...(repository ? { repository } : {}), ignoredBuildStep: typeof ignore === 'string' && ignore.trim().length > 0, githubDeployments: record(project.gitProviderOptions)?.createDeployments !== 'disabled' };
 }
 /**
  * The linked project as this repository's: read now, and connected to the repository on Vercel, which its Git link
@@ -150,6 +151,41 @@ export async function readOwnProject(vercel, link, repository) {
         return { reason: `The Vercel project this folder is linked to${project.name ? ` (${project.name})` : ''} is not connected to this repository on Vercel.` };
     return project;
 }
+/** Vercel's project names, which go into the CLI's arguments. */
+const PROJECT_NAME = /^[a-z0-9][a-z0-9._-]{0,99}$/;
+/**
+ * The Vercel project that builds `directory` of `repository`, on a repository with several apps: of the projects Vercel
+ * lists as connected to the repository (GET /v10/projects?repoUrl=), in the team `team` names (the root link's) or the
+ * CLI's current scope, the one whose Root Directory is that folder. Never the newest, nor the one the root link names:
+ * none, or several, is a `reason`, so one app never borrows another's project.
+ */
+export async function vercelProjectFor(vercel, repository, directory, team) {
+    const where = directory ? `the folder ${directory}` : "the repository's root";
+    let listed;
+    try {
+        const query = `repoUrl=${encodeURIComponent(`https://github.com/${repository}`)}&limit=100${team?.startsWith('team_') ? `&teamId=${encodeURIComponent(team)}` : ''}`;
+        const printed = await vercel(['api', `/v10/projects?${query}`, '--raw', '--non-interactive']);
+        listed = record(JSON.parse(printed.slice(printed.indexOf('{'), printed.lastIndexOf('}') + 1)))?.projects;
+    }
+    catch {
+        return { reason: "The Vercel CLI could not list this repository's projects (vercel api): it is signed out, or this CLI has no api command." };
+    }
+    if (!Array.isArray(listed))
+        return { reason: "The Vercel CLI could not list this repository's projects (vercel api): it is signed out, or this CLI has no api command." };
+    const builds = listed.map(record).filter((p) => {
+        const git = record(p?.link);
+        return git?.type === 'github' && `${git.org}/${git.repo}`.toLowerCase() === repository.toLowerCase() && folderOf(p.rootDirectory) === folderOf(directory);
+    });
+    const found = builds.flatMap((p) => {
+        const link = asLink(p.id, p.accountId);
+        return link && typeof p.name === 'string' && PROJECT_NAME.test(p.name) ? [{ link, name: p.name }] : [];
+    });
+    if (builds.length > 1)
+        return { reason: `Several Vercel projects build ${where} (${found.map((p) => p.name).join(', ') || 'unnamed'}), so which one is this app's cannot be told.` };
+    if (!found.length)
+        return { reason: `No Vercel project of this repository builds ${where} (its Root Directory), as far as the Vercel CLI here can see.` };
+    return found[0];
+}
 /**
  * Whether the project made the deployment at `host`: one of its latest, as the project read lists them; else, since a
  * project lists its newest deployments alone while an older pull request's preview stays served, the deployment read
@@ -174,15 +210,16 @@ export async function projectMadeDeployment(vercel, link, project, host) {
  * (readOwnProject): another repository's settings are never the fact. Nothing here changes Vercel: the fact is reported.
  * Undefined where the checkout names no Vercel setting and is linked to no project.
  */
-export async function vercelPreviewsFact(cwd, repository, vercel) {
+export async function vercelPreviewsFact(cwd, repository, vercel, app) {
     let setting;
     try {
-        setting = record(record(JSON.parse(await readFile(join(cwd, 'vercel.json'), 'utf8')))?.git)?.deploymentEnabled;
+        // An app's project reads the vercel.json of the folder it builds.
+        setting = record(record(JSON.parse(await readFile(join(cwd, app?.directory ?? '', 'vercel.json'), 'utf8')))?.git)?.deploymentEnabled;
     }
     catch {
         // No vercel.json, or none that reads as JSON: Vercel's default, every branch.
     }
-    const link = await readLink(cwd);
+    const link = app ? app.link : await readLink(cwd);
     if (setting === undefined && !link)
         return undefined;
     // The CLI runs only for a linked project, and only this repository's own counts.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@impeccable/reviews",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "Set up a repository for Impeccable for PRs from your terminal.",
   "license": "SEE LICENSE IN LICENSE",
   "private": false,