@duffcloudservices/cli 0.4.3 → 0.4.4

package/README.md

@@ -42,6 +42,14 @@ dcs whoami
 dcs logout
 ```
 
+The CLI talks to the production portal by default (`config.portalApiUrl` in this
+package's `package.json`). Set `DCS_API_URL` to point every command - login, token
+refresh, logout and the API client - at another portal, for example a staging one:
+
+```bash
+DCS_API_URL=https://portal-staging.example.test dcs login
+```
+
 ### Site Management
 
 ```bash

package/dist/index.js

@@ -5,7 +5,10 @@ import { Command } from "commander";
 import chalk8 from "chalk";
 
 // package.json
-var version = "0.4.3";
+var version = "0.4.4";
+var config = {
+  portalApiUrl: "https://portal.duffcloudservices.com"
+};
 
 // src/commands/auth.ts
 import chalk2 from "chalk";
@@ -289,11 +292,11 @@ function getKeychain() {
 // src/auth/credentials.ts
 var ACCOUNT = "auth";
 function defaultLegacyStore() {
-  const config = new Conf({ projectName: "dcs-cli" });
+  const config2 = new Conf({ projectName: "dcs-cli" });
   return {
-    read: () => config.get("auth"),
+    read: () => config2.get("auth"),
     clear: () => {
-      if (config.has("auth")) config.delete("auth");
+      if (config2.has("auth")) config2.delete("auth");
     }
   };
 }
@@ -370,8 +373,20 @@ function getStorageBackendName() {
   return getKeychain().name;
 }
 
+// src/config/portal-api-url.ts
+var PORTAL_API_URL_ENV = "DCS_API_URL";
+function trimTrailingSlashes(url) {
+  return url.replace(/\/+$/, "");
+}
+function resolvePortalApiUrl(explicit) {
+  const fromArg = explicit?.trim();
+  if (fromArg) return trimTrailingSlashes(fromArg);
+  const fromEnv = process.env[PORTAL_API_URL_ENV]?.trim();
+  if (fromEnv) return trimTrailingSlashes(fromEnv);
+  return trimTrailingSlashes(config.portalApiUrl);
+}
+
 // src/auth/device-flow.ts
-var DEFAULT_API_URL = "https://portal.duffcloudservices.com";
 var RefreshTokenRevokedError = class extends Error {
   constructor(message = "Refresh token was rejected (expired or revoked).") {
     super(message);
@@ -388,7 +403,7 @@ function sleep(ms) {
   return new Promise((resolve2) => setTimeout(resolve2, ms));
 }
 async function startDeviceAuth(options = {}) {
-  const apiUrl = options.apiUrl || DEFAULT_API_URL;
+  const apiUrl = resolvePortalApiUrl(options.apiUrl);
   const clientId = options.clientId || "dcs-cli";
   const response = await fetch(`${apiUrl}/api/v1/cli/auth/device`, {
     method: "POST",
@@ -437,7 +452,7 @@ async function pollForToken(deviceCode, apiUrl) {
   };
 }
 async function login(options = {}) {
-  const apiUrl = options.apiUrl || DEFAULT_API_URL;
+  const apiUrl = resolvePortalApiUrl(options.apiUrl);
   const spinner = ora("Starting authentication...").start();
   let deviceAuth;
   try {
@@ -505,7 +520,7 @@ async function login(options = {}) {
 }
 var REVOKE_TIMEOUT_MS = 1e4;
 async function revokeRefreshToken(refreshToken, options = {}) {
-  const apiUrl = options.apiUrl || DEFAULT_API_URL;
+  const apiUrl = resolvePortalApiUrl(options.apiUrl);
   const response = await fetch(`${apiUrl}/api/v1/cli/auth/logout`, {
     method: "POST",
     headers: {
@@ -521,7 +536,7 @@ async function revokeRefreshToken(refreshToken, options = {}) {
   return data?.revoked === true;
 }
 async function refreshAccessToken(refreshToken, options = {}) {
-  const apiUrl = options.apiUrl || DEFAULT_API_URL;
+  const apiUrl = resolvePortalApiUrl(options.apiUrl);
   const response = await fetch(`${apiUrl}/api/v1/cli/auth/refresh`, {
     method: "POST",
     headers: {
@@ -600,11 +615,10 @@ import chalk3 from "chalk";
 import Table from "cli-table3";
 
 // src/api/portal-client.ts
-var DEFAULT_API_URL2 = "https://portal.duffcloudservices.com";
 var PortalClient = class {
   apiUrl;
   constructor(options = {}) {
-    this.apiUrl = options.apiUrl || process.env.DCS_API_URL || DEFAULT_API_URL2;
+    this.apiUrl = resolvePortalApiUrl(options.apiUrl);
   }
   /**
    * Refresh the session using the stored refresh token. Exactly one attempt —
@@ -1061,7 +1075,8 @@ async function initCommand(options) {
   const generatedFiles = [];
   const timestamp = (/* @__PURE__ */ new Date()).toISOString();
   try {
-    const siteYaml = generateSiteYaml({ siteSlug, siteName, timestamp, framework });
+    const portalApiUrl = resolvePortalApiUrl();
+    const siteYaml = generateSiteYaml({ siteSlug, siteName, timestamp, framework, portalApiUrl });
     generatedFiles.push(await writeFile(targetDir, ".dcs/site.yaml", siteYaml, { dryRun, force }));
     const pagesYaml = generatePagesYaml({ siteSlug, timestamp });
     generatedFiles.push(await writeFile(targetDir, ".dcs/pages.yaml", pagesYaml, { dryRun, force }));
@@ -1073,7 +1088,7 @@ async function initCommand(options) {
     generatedFiles.push(
       await writeFile(targetDir, ".dcs/SECTION-CONVENTIONS.md", sectionConventions, { dryRun, force })
     );
-    const copilotInstructions = generateCopilotInstructions({ siteName });
+    const copilotInstructions = generateCopilotInstructions({ siteName, portalApiUrl });
     generatedFiles.push(
       await writeFile(targetDir, ".github/copilot-instructions.md", copilotInstructions, { dryRun, force })
     );
@@ -1152,7 +1167,7 @@ azure:
   subscription_id: ""
 
 # Portal API Configuration
-portal_api_url: "https://portal.duffcloudservices.com"
+portal_api_url: "${data.portalApiUrl}"
 
 # Site metadata for portal
 metadata:
@@ -1303,7 +1318,7 @@ function generateCopilotInstructions(data) {
 ## Project Overview
 
 This is a **DCS-managed customer site**. Content and feature changes are managed
-through the DCS Portal at https://portal.duffcloudservices.com.
+through the DCS Portal at ${data.portalApiUrl}.
 
 ## Technology Stack
 
@@ -1800,27 +1815,27 @@ async function validateSiteYaml(dcsDir, verbose) {
   };
   try {
     const content = await fs5.readFile(filePath, "utf8");
-    const config = yaml.load(content);
-    if (!config.site_name) {
+    const config2 = yaml.load(content);
+    if (!config2.site_name) {
       result.errors.push("Missing required field: site_name");
       result.valid = false;
     }
-    if (!config.site_slug) {
+    if (!config2.site_slug) {
       result.errors.push("Missing required field: site_slug");
       result.valid = false;
-    } else if (!/^[a-z0-9-]+$/.test(config.site_slug)) {
+    } else if (!/^[a-z0-9-]+$/.test(config2.site_slug)) {
       result.errors.push("site_slug must be lowercase alphanumeric with hyphens only");
       result.valid = false;
     }
-    if (!config.swa_resource_id) {
+    if (!config2.swa_resource_id) {
       result.warnings.push("swa_resource_id is not set (required for deployment)");
     }
-    if (!config.production_url) {
+    if (!config2.production_url) {
       result.warnings.push("production_url is not set");
     }
     if (verbose) {
-      console.log(chalk5.dim(`  site_name: ${config.site_name}`));
-      console.log(chalk5.dim(`  site_slug: ${config.site_slug}`));
+      console.log(chalk5.dim(`  site_name: ${config2.site_name}`));
+      console.log(chalk5.dim(`  site_slug: ${config2.site_slug}`));
     }
   } catch (error) {
     if (error.code === "ENOENT") {
@@ -1842,16 +1857,16 @@ async function validatePagesYaml(dcsDir, verbose) {
   };
   try {
     const content = await fs5.readFile(filePath, "utf8");
-    const config = yaml.load(content);
-    if (config.version === void 0) {
+    const config2 = yaml.load(content);
+    if (config2.version === void 0) {
       result.errors.push("Missing required field: version");
       result.valid = false;
     }
-    if (!config.siteSlug) {
+    if (!config2.siteSlug) {
       result.errors.push("Missing required field: siteSlug");
       result.valid = false;
     }
-    const pages = config.pages;
+    const pages = config2.pages;
     if (!pages || !Array.isArray(pages)) {
       result.errors.push("Missing or invalid pages array");
       result.valid = false;
@@ -1898,22 +1913,22 @@ async function validateContentYaml(dcsDir, verbose) {
   };
   try {
     const content = await fs5.readFile(filePath, "utf8");
-    const config = yaml.load(content);
-    if (config.version === void 0) {
+    const config2 = yaml.load(content);
+    if (config2.version === void 0) {
       result.errors.push("Missing required field: version");
       result.valid = false;
     }
-    if (config.global !== void 0 && typeof config.global !== "object") {
+    if (config2.global !== void 0 && typeof config2.global !== "object") {
       result.errors.push("global must be an object");
       result.valid = false;
     }
-    if (config.pages !== void 0 && typeof config.pages !== "object") {
+    if (config2.pages !== void 0 && typeof config2.pages !== "object") {
       result.errors.push("pages must be an object");
       result.valid = false;
     }
     if (verbose) {
-      const globalKeys = config.global ? Object.keys(config.global).length : 0;
-      const pageCount = config.pages ? Object.keys(config.pages).length : 0;
+      const globalKeys = config2.global ? Object.keys(config2.global).length : 0;
+      const pageCount = config2.pages ? Object.keys(config2.pages).length : 0;
       console.log(chalk5.dim(`  ${globalKeys} global keys, ${pageCount} page sections`));
     }
   } catch (error) {
@@ -1936,12 +1951,12 @@ async function validateSeoYaml(dcsDir, verbose) {
   };
   try {
     const content = await fs5.readFile(filePath, "utf8");
-    const config = yaml.load(content);
-    if (config.version === void 0) {
+    const config2 = yaml.load(content);
+    if (config2.version === void 0) {
       result.errors.push("Missing required field: version");
       result.valid = false;
     }
-    const global = config.global;
+    const global = config2.global;
     if (!global) {
       result.errors.push("Missing required section: global");
       result.valid = false;
@@ -1956,7 +1971,7 @@ async function validateSeoYaml(dcsDir, verbose) {
         result.warnings.push("global.defaultDescription is not set");
       }
     }
-    const pages = config.pages;
+    const pages = config2.pages;
     if (pages && typeof pages === "object") {
       const pageKeys = Object.keys(pages);
       if (!pageKeys.includes("home")) {
@@ -2492,6 +2507,49 @@ import path5 from "path";
 import yaml3 from "js-yaml";
 import chalk7 from "chalk";
 import ora3 from "ora";
+
+// src/commands/redirectedCapture.ts
+var RedirectedPageError = class extends Error {
+  constructor(requested, landed) {
+    super(`redirected to ${landed}`);
+    this.requested = requested;
+    this.landed = landed;
+    this.name = "RedirectedPageError";
+  }
+};
+var SYNTHETIC_CAPTURE_PARAMS = ["dcs-hide-ribbon", "dcs-no-telemetry"];
+function normalisePath(pathname) {
+  const trimmed = pathname.replace(/\/+$/, "");
+  return trimmed === "" ? "/" : trimmed;
+}
+function landedOffPath(requestedUrl, landedUrl) {
+  let requested;
+  let landed;
+  try {
+    requested = new URL(requestedUrl);
+  } catch {
+    return landedUrl;
+  }
+  try {
+    landed = new URL(landedUrl);
+  } catch {
+    return landedUrl;
+  }
+  const sameOrigin = requested.origin === landed.origin;
+  const samePath = normalisePath(requested.pathname) === normalisePath(landed.pathname);
+  if (sameOrigin && samePath) return null;
+  return `${landed.origin}${normalisePath(landed.pathname)}`;
+}
+function carriesSyntheticMarker(url) {
+  try {
+    const params = new URL(url).searchParams;
+    return SYNTHETIC_CAPTURE_PARAMS.some((p) => params.has(p));
+  } catch {
+    return false;
+  }
+}
+
+// src/commands/capture-snapshots.ts
 var CARD_THUMBNAIL_ASPECT_RATIO = 16 / 9;
 var ASSET_WAIT_TIMEOUT_MS = 5e3;
 async function disableCaptureMotion(page) {
@@ -2673,9 +2731,9 @@ function getValidTextKeysForPage(contentConfig, pageSlug) {
   }
   return keys;
 }
-async function resolveAllPages(config) {
+async function resolveAllPages(config2) {
   const resolved2 = [];
-  for (const page of config.pages) {
+  for (const page of config2.pages) {
     if (page.type === "dynamic" && page.instances) {
       for (const instance of page.instances) {
         const instancePath = page.pathTemplate ? page.pathTemplate.replace(/:[\w]+/, instance) : `${page.path}/${instance}`;
@@ -2811,11 +2869,18 @@ async function capturePageSnapshot(browser, pageInfo, snapshotConfig, siteSlug,
   }
   try {
     await page.goto(url, { waitUntil: "domcontentloaded", timeout: 3e4 });
+    const landedElsewhere = landedOffPath(url, page.url());
+    if (landedElsewhere !== null) {
+      const unmarked = !carriesSyntheticMarker(page.url());
+      await context.close();
+      throw new RedirectedPageError(url, `${landedElsewhere}${unmarked ? " (markers dropped)" : ""}`);
+    }
     await disableCaptureMotion(page);
     await page.waitForLoadState("networkidle", { timeout: 1e4 }).catch(() => {
       if (verbose) console.log(`    Note: networkidle timeout, continuing anyway`);
     });
   } catch (error) {
+    if (error instanceof RedirectedPageError) throw error;
     console.error(`    Failed to load: ${error}`);
     await context.close();
     throw error;
@@ -3066,16 +3131,16 @@ async function captureSnapshotsCommand(options) {
   console.log(chalk7.gray(`Target:   ${targetDir}`));
   console.log(chalk7.gray(`Base URL: ${baseUrl}`));
   process.env.SITE_BASE_URL = baseUrl;
-  let config;
+  let config2;
   try {
-    config = loadPagesConfig(targetDir);
+    config2 = loadPagesConfig(targetDir);
   } catch (error) {
     console.error(chalk7.red("Error:"), error.message);
     console.log(chalk7.yellow("\nMake sure .dcs/pages.yaml exists in the target directory."));
     process.exit(1);
   }
-  console.log(chalk7.gray(`Site:     ${config.siteSlug}`));
-  const outputDir = path5.join(targetDir, config.snapshot.outputDir || ".dcs/snapshots");
+  console.log(chalk7.gray(`Site:     ${config2.siteSlug}`));
+  const outputDir = path5.join(targetDir, config2.snapshot.outputDir || ".dcs/snapshots");
   const contentConfig = loadContentConfig(targetDir);
   if (contentConfig) {
     const pageCount = Object.keys(contentConfig.pages || {}).length;
@@ -3104,7 +3169,7 @@ async function captureSnapshotsCommand(options) {
     console.log(chalk7.green("\n\u2705 Snapshot capture skipped (as requested)"));
     return;
   }
-  let pagesToCapture = await resolveAllPages(config);
+  let pagesToCapture = await resolveAllPages(config2);
   console.log(chalk7.gray(`Found ${pagesToCapture.length} total pages in configuration`));
   if (targetedPages && targetedPages.length > 0) {
     const targetedSlugs = new Set(targetedPages);
@@ -3143,6 +3208,7 @@ async function captureSnapshotsCommand(options) {
   spinner.succeed("Browser launched");
   const snapshots = [];
   const failures = [];
+  const redirectStubs = [];
   for (const pageInfo of pagesToCapture) {
     const pageSpinner = ora3(`Capturing ${pageInfo.slug}...`).start();
     try {
@@ -3150,17 +3216,24 @@ async function captureSnapshotsCommand(options) {
       const snapshot = await capturePageSnapshot(
         browser,
         pageInfo,
-        config.snapshot,
-        config.siteSlug,
+        config2.snapshot,
+        config2.siteSlug,
         validTextKeys,
         outputDir,
         verbose || false
       );
       snapshots.push(snapshot);
-      const snapshotPath = path5.join(outputDir, config.siteSlug, pageInfo.slug, "snapshot.json");
+      const snapshotPath = path5.join(outputDir, config2.siteSlug, pageInfo.slug, "snapshot.json");
       fs7.writeFileSync(snapshotPath, JSON.stringify(snapshot, null, 2));
       pageSpinner.succeed(`${pageInfo.slug}: ${snapshot.sections.length} sections captured`);
     } catch (error) {
+      if (error instanceof RedirectedPageError) {
+        redirectStubs.push(`${pageInfo.slug} -> ${error.landed}`);
+        pageSpinner.warn(
+          `${pageInfo.slug}: redirect stub -> ${error.landed} - skipped (C-1553: not a page of its own, and the redirect drops the synthetic markers)`
+        );
+        continue;
+      }
       const message = `${pageInfo.slug}: ${error.message}`;
       failures.push(message);
       pageSpinner.fail(`${pageInfo.slug}: Failed - ${error.message}`);
@@ -3168,11 +3241,11 @@ async function captureSnapshotsCommand(options) {
   }
   await browser.close();
   const manifest = {
-    siteSlug: config.siteSlug,
+    siteSlug: config2.siteSlug,
     capturedAt: (/* @__PURE__ */ new Date()).toISOString(),
     capturedVersion: process.env.GITHUB_SHA,
     deploymentRef: process.env.GITHUB_REF || "local",
-    pagesConfigVersion: config.version,
+    pagesConfigVersion: config2.version,
     pages: snapshots.map((s) => ({
       pageSlug: s.pageSlug,
       pagePath: s.path,
@@ -3184,7 +3257,7 @@ async function captureSnapshotsCommand(options) {
       hasSnapshot: true
     }))
   };
-  const manifestPath = path5.join(outputDir, config.siteSlug, "manifest.json");
+  const manifestPath = path5.join(outputDir, config2.siteSlug, "manifest.json");
   if (isTargetedCapture) {
     console.log(chalk7.gray("   Targeted capture: leaving the existing remote manifest intact"));
   } else {
@@ -3193,6 +3266,9 @@ async function captureSnapshotsCommand(options) {
   console.log("");
   console.log(chalk7.green("\u2705 Snapshot capture complete!"));
   console.log(chalk7.gray(`   Captured ${snapshots.length} pages`));
+  if (redirectStubs.length > 0) {
+    console.log(chalk7.yellow(`   Skipped ${redirectStubs.length} redirect stub(s): ${redirectStubs.join("; ")}`));
+  }
   console.log(chalk7.gray(`   - Static:  ${snapshots.filter((s) => s.type === "static").length}`));
   console.log(chalk7.gray(`   - Index:   ${snapshots.filter((s) => s.type === "index").length}`));
   console.log(chalk7.gray(`   - Dynamic: ${snapshots.filter((s) => s.type === "dynamic").length}`));