@apimatic/cli 1.5.0 → 2.0.0-beta.1

package/lib/prompts/portal/authorization.js

@@ -0,0 +1,29 @@
+import { log } from '@clack/prompts';
+import { format as f } from '../format.js';
+const PRICING_URL = 'https://www.apimatic.io/pricing';
+/**
+ * Shared by `portal generate` and `portal serve` so the same refusal always reads the
+ * same way, whichever command hit it.
+ */
+export function reportAuthorizationFailure(failure) {
+    switch (failure.kind) {
+        case 'unauthenticated': {
+            const message = `You need to be signed in to generate a portal. ` +
+                `Run ${f.cmdAlt('apimatic', 'auth', 'login')}, ` +
+                `or pass a key with ${f.flag('auth-key')}.`;
+            log.error(message);
+            return;
+        }
+        case 'unverifiable': {
+            const message = `Could not verify your subscription with ${f.var(failure.host)}. ${failure.error.errorMessage}`;
+            log.error(message);
+            return;
+        }
+        case 'notEntitled': {
+            const message = `Your subscription does not include portal generation. ` + `See ${f.link(PRICING_URL)} to upgrade.`;
+            log.error(message);
+            return;
+        }
+    }
+}
+//# sourceMappingURL=authorization.js.map

package/lib/prompts/portal/authorization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.js","sourceRoot":"","sources":["../../../src/prompts/portal/authorization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,WAAW,GAAG,iCAAiC,CAAC;AAEtD;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CAAC,OAAmC;IAC5E,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,iBAAiB,EAAE,CAAC;YACvB,MAAM,OAAO,GACX,iDAAiD;gBACjD,OAAO,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI;gBAChD,sBAAsB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAC9C,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnB,OAAO;QACT,CAAC;QACD,KAAK,cAAc,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,2CAA2C,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAChH,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnB,OAAO;QACT,CAAC;QACD,KAAK,aAAa,EAAE,CAAC;YACnB,MAAM,OAAO,GACX,wDAAwD,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;YACtG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnB,OAAO;QACT,CAAC;IACH,CAAC;AACH,CAAC"}

package/lib/prompts/portal/code-samples.d.ts

@@ -0,0 +1 @@
+export declare function reportUnplacedSamples(endpoints: string[]): void;

package/lib/prompts/portal/code-samples.js

@@ -0,0 +1,9 @@
+import { log } from '@clack/prompts';
+import { format as f } from '../format.js';
+export function reportUnplacedSamples(endpoints) {
+    if (endpoints.length === 0) {
+        return;
+    }
+    log.warn(`No operation in ${f.var('spec')} takes the code samples for ${endpoints.join(', ')}.`);
+}
+//# sourceMappingURL=code-samples.js.map

package/lib/prompts/portal/code-samples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-samples.js","sourceRoot":"","sources":["../../../src/prompts/portal/code-samples.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,UAAU,qBAAqB,CAAC,SAAmB;IACvD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO;IACT,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,+BAA+B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnG,CAAC"}

package/lib/prompts/portal/generate.d.ts

@@ -1,15 +1,20 @@
-import { DirectoryPath } from "../../types/file/directoryPath.js";
-import { Result } from "neverthrow";
-import { FilePath } from "../../types/file/filePath.js";
-import { ServiceError } from "../../infrastructure/service-error.js";
+import { DirectoryPath } from '../../types/file/directoryPath.js';
+import { FilePath } from '../../types/file/filePath.js';
+import { PortalBuildFailure, PortalBuildResult } from '../../infrastructure/portal-build-service.js';
+import { PortalSaveProblem } from '../../types/portal-context.js';
+import { Result } from 'neverthrow';
 export declare class PortalGeneratePrompts {
     overwritePortal(directory: DirectoryPath): Promise<boolean>;
     directoryCannotBeSame(directory: DirectoryPath): void;
-    srcDirectoryEmpty(directory: DirectoryPath): void;
     portalDirectoryNotEmpty(): void;
-    generatePortal(fn: Promise<Result<NodeJS.ReadableStream, ServiceError | NodeJS.ReadableStream>>): Promise<Result<NodeJS.ReadableStream, NodeJS.ReadableStream | ServiceError>>;
-    portalGenerationError(error: string): void;
-    portalGenerationSdkMergeFailed(sdkMergeFailedErrors: string[]): void;
-    portalGenerationErrorWithReport(reportPath: FilePath): void;
+    destinationContainsSource(sourceDirectory: DirectoryPath, portalDirectory: DirectoryPath): void;
+    /**
+     * A portal build runs for tens of seconds with no output of its own, so the spinner
+     * carries an elapsed timer rather than a static message.
+     */
+    buildPortal(fn: Promise<Result<PortalBuildResult, PortalBuildFailure>>): Promise<Result<PortalBuildResult, PortalBuildFailure>>;
+    buildFailed(output: string, logPath: FilePath | null): void;
+    savePortal(fn: Promise<Result<void, PortalSaveProblem>>): Promise<Result<void, PortalSaveProblem>>;
     portalGenerated(portal: DirectoryPath): void;
+    nextSteps(portal: DirectoryPath, zipped: boolean): void;
 }

package/lib/prompts/portal/generate.js

@@ -1,6 +1,16 @@
-import { isCancel, confirm, log } from "@clack/prompts";
-import { format as f } from "../format.js";
-import { noteWrapped, withSpinner } from "../prompt.js";
+import { isCancel, confirm, log } from '@clack/prompts';
+import { NOT_FOUND_FILE_NAME, ZIP_FILE_NAME } from '../../types/portal-context.js';
+import { format as f } from '../format.js';
+import { logTail, noteWrapped, withSpinner } from '../prompt.js';
+function describeSaveProblem(problem) {
+    switch (problem.kind) {
+        case 'stagingFailed':
+            return `The portal could not be written (${problem.reason}). The previous portal is unchanged.`;
+        case 'replaceFailed':
+            return (`The previous portal could not be replaced (${problem.reason}). ` +
+                `Whatever could not be moved into place is still at ${f.path(problem.stagedAt)}; move it up a level by hand.`);
+    }
+}
 export class PortalGeneratePrompts {
     async overwritePortal(directory) {
         const overwrite = await confirm({
@@ -13,39 +23,51 @@ export class PortalGeneratePrompts {
         return overwrite;
     }
     directoryCannotBeSame(directory) {
-        const message = `The ${f.var("src")} and ${f.var("portal")} directories must be different. Current value: ${f.path(directory)}`;
-        log.error(message);
-    }
-    srcDirectoryEmpty(directory) {
-        const message = `The ${f.var("src")} directory is either empty or invalid: ${f.path(directory)}`;
+        const message = `The ${f.var('src')} and ${f.var('portal')} directories must be different. Current value: ${f.path(directory)}`;
         log.error(message);
     }
     portalDirectoryNotEmpty() {
-        const message = `Please enter a different destination folder or remove the existing files and try again.`;
-        log.error(message);
+        log.error('Please enter a different destination folder or remove the existing files and try again.');
     }
-    generatePortal(fn) {
-        return withSpinner("Generating API Portal", "Portal generated successfully.", "Portal Generation failed.", fn);
+    destinationContainsSource(sourceDirectory, portalDirectory) {
+        const message = `The destination ${f.path(portalDirectory)} contains your source directory ` +
+            `${f.path(sourceDirectory)}, and everything in the destination is replaced by the ` +
+            `generated portal. Choose a destination outside it, such as ` +
+            `${f.flag('destination', './portal')}.`;
+        log.error(message);
     }
-    portalGenerationError(error) {
-        log.error(error);
+    /**
+     * A portal build runs for tens of seconds with no output of its own, so the spinner
+     * carries an elapsed timer rather than a static message.
+     */
+    buildPortal(fn) {
+        return withSpinner('Building the portal', ({ pageCount }) => `Built ${pageCount} ${pageCount === 1 ? 'page' : 'pages'}.`, (failure) => failure.message, fn, { indicator: 'timer' });
     }
-    portalGenerationSdkMergeFailed(sdkMergeFailedErrors) {
-        log.error(`Saved changes couldn't be applied to one or more SDKs.`);
-        const language = sdkMergeFailedErrors.length === 1 ? sdkMergeFailedErrors[0] : "<language>";
-        log.error(`Merge conflicts found in:\n- ${sdkMergeFailedErrors.join("\n- ")}`);
-        const message = `Review and resolve the conflicts first by running:
-'${f.cmdAlt("apimatic", "sdk", "generate")} ${f.flag("language", language)}'
-After resolving merge conflicts, retry ${f.cmdAlt("apimatic", "portal", "generate")}.`;
-        noteWrapped(message, "Next Steps");
+    buildFailed(output, logPath) {
+        const tail = logTail(output);
+        if (tail.length > 0) {
+            log.message(tail);
+        }
+        if (logPath === null) {
+            log.error('The full build log could not be written beside the portal.');
+        }
+        else {
+            log.error(`The full build log is at ${f.path(logPath)}.`);
+        }
     }
-    portalGenerationErrorWithReport(reportPath) {
-        const message = `An error occurred during portal generation.
-A report has been written at the destination path ${f.path(reportPath)}`;
-        log.error(message);
+    savePortal(fn) {
+        return withSpinner('Writing the portal', 'Portal written.', describeSaveProblem, fn);
     }
     portalGenerated(portal) {
         log.info(`Portal artifacts can be found at ${f.path(portal)}.`);
     }
+    nextSteps(portal, zipped) {
+        const message = zipped
+            ? `Unpack ${f.var(ZIP_FILE_NAME)} in ${f.path(portal)} onto any static host.\n` +
+                `Configure ${f.var(NOT_FOUND_FILE_NAME)} as the error document so deep links resolve.`
+            : `Upload the contents of ${f.path(portal)} to any static host.\n` +
+                `Configure ${f.var(NOT_FOUND_FILE_NAME)} as the error document so deep links resolve.`;
+        noteWrapped(message, 'Next steps');
+    }
 }
 //# sourceMappingURL=generate.js.map

package/lib/prompts/portal/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/prompts/portal/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAI3C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAExD,MAAM,OAAO,qBAAqB;IACzB,KAAK,CAAC,eAAe,CAAC,SAAwB;QACnD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;YAC9B,OAAO,EAAE,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,0CAA0C;YACvF,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,qBAAqB,CAAC,SAAwB;QACnD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,kDAAkD,CAAC,CAAC,IAAI,CAChH,SAAS,CACV,EAAE,CAAC;QACJ,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,iBAAiB,CAAC,SAAwB;QAC/C,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACjG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,uBAAuB;QAC5B,MAAM,OAAO,GAAG,yFAAyF,CAAC;QAC1G,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,cAAc,CAAC,EAAgF;QACpG,OAAO,WAAW,CAChB,uBAAuB,EACvB,gCAAgC,EAChC,2BAA2B,EAC3B,EAAE,CACH,CAAC;IACJ,CAAC;IAEM,qBAAqB,CAAC,KAAa;QACxC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAEM,8BAA8B,CAAC,oBAA8B;QAClE,GAAG,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACpE,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;QAC5F,GAAG,CAAC,KAAK,CAAC,gCAAgC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG;GACjB,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC;yCACjC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,GAAG,CAAC;QACnF,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;IAEM,+BAA+B,CAAC,UAAoB;QACzD,MAAM,OAAO,GAAG;oDACgC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACrE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,eAAe,CAAC,MAAqB;QAC1C,GAAG,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;CACF"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/prompts/portal/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAIxD,OAAO,EAAE,mBAAmB,EAAqB,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEtG,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEjE,SAAS,mBAAmB,CAAC,OAA0B;IACrD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,eAAe;YAClB,OAAO,oCAAoC,OAAO,CAAC,MAAM,sCAAsC,CAAC;QAClG,KAAK,eAAe;YAClB,OAAO,CACL,8CAA8C,OAAO,CAAC,MAAM,KAAK;gBACjE,sDAAsD,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,+BAA+B,CAC9G,CAAC;IACN,CAAC;AACH,CAAC;AAED,MAAM,OAAO,qBAAqB;IACzB,KAAK,CAAC,eAAe,CAAC,SAAwB;QACnD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;YAC9B,OAAO,EAAE,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,0CAA0C;YACvF,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,qBAAqB,CAAC,SAAwB;QACnD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,kDAAkD,CAAC,CAAC,IAAI,CAChH,SAAS,CACV,EAAE,CAAC;QACJ,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,uBAAuB;QAC5B,GAAG,CAAC,KAAK,CAAC,yFAAyF,CAAC,CAAC;IACvG,CAAC;IAEM,yBAAyB,CAAC,eAA8B,EAAE,eAA8B;QAC7F,MAAM,OAAO,GACX,mBAAmB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,kCAAkC;YAC5E,GAAG,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,yDAAyD;YACnF,6DAA6D;YAC7D,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG,CAAC;QAC1C,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,EAA0D;QAC3E,OAAO,WAAW,CAChB,qBAAqB,EACrB,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,SAAS,IAAI,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,GAAG,EAC9E,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAC5B,EAAE,EACF,EAAE,SAAS,EAAE,OAAO,EAAE,CACvB,CAAC;IACJ,CAAC;IAEM,WAAW,CAAC,MAAc,EAAE,OAAwB;QACzD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;QACD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,GAAG,CAAC,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAEM,UAAU,CAAC,EAA4C;QAC5D,OAAO,WAAW,CAAC,oBAAoB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAC;IACvF,CAAC;IAEM,eAAe,CAAC,MAAqB;QAC1C,GAAG,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IAEM,SAAS,CAAC,MAAqB,EAAE,MAAe;QACrD,MAAM,OAAO,GAAG,MAAM;YACpB,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,0BAA0B;gBAC7E,aAAa,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,+CAA+C;YACxF,CAAC,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,wBAAwB;gBAChE,aAAa,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,+CAA+C,CAAC;QAC3F,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACrC,CAAC;CACF"}

package/lib/prompts/portal/prepare-project.d.ts

@@ -0,0 +1,20 @@
+import { Result } from 'neverthrow';
+import { ServiceError } from '../../infrastructure/service-error.js';
+import { PortalAuthorizationFailure } from '../../infrastructure/services/portal-authorization-service.js';
+import { DirectoryPath } from '../../types/file/directoryPath.js';
+import { FileName } from '../../types/file/fileName.js';
+import { ContentNotices } from '../../types/portal/content-notices.js';
+import { MissingArtifacts } from '../../types/portal/generated-pages.js';
+import { PortalArtifacts } from '../../types/portal/portal-artifacts.js';
+import { PortalSourceProblem } from '../../types/portal/portal-source.js';
+/** What both `portal generate` and `portal serve` say while the project they share is prepared. */
+export declare class PreparePortalProjectPrompts {
+    runtimeUnsupported(reason: string): void;
+    authorizationFailed(failure: PortalAuthorizationFailure): void;
+    generateArtifacts(fn: Promise<Result<PortalArtifacts, ServiceError>>): Promise<Result<PortalArtifacts, ServiceError>>;
+    sourceProblem(problem: PortalSourceProblem, sourceDirectory: DirectoryPath): void;
+    filesShadowedByStatic(shadowed: FileName[]): void;
+    contentNotices(notices: ContentNotices, sourceDirectory: DirectoryPath): void;
+    unplacedSamples(endpoints: string[]): void;
+    artifactsIncomplete(missing: MissingArtifacts): void;
+}

package/lib/prompts/portal/prepare-project.js

@@ -0,0 +1,36 @@
+import { log } from '@clack/prompts';
+import { format as f } from '../format.js';
+import { describeMissingArtifacts, generateArtifacts } from './artifacts.js';
+import { reportAuthorizationFailure } from './authorization.js';
+import { reportUnplacedSamples } from './code-samples.js';
+import { reportContentNotices, reportShadowedFiles, reportSourceProblem } from './source.js';
+/** What both `portal generate` and `portal serve` say while the project they share is prepared. */
+export class PreparePortalProjectPrompts {
+    runtimeUnsupported(reason) {
+        log.error(reason);
+    }
+    authorizationFailed(failure) {
+        reportAuthorizationFailure(failure);
+    }
+    generateArtifacts(fn) {
+        return generateArtifacts(fn);
+    }
+    sourceProblem(problem, sourceDirectory) {
+        reportSourceProblem(problem, sourceDirectory);
+    }
+    filesShadowedByStatic(shadowed) {
+        reportShadowedFiles(shadowed);
+    }
+    contentNotices(notices, sourceDirectory) {
+        reportContentNotices(notices, sourceDirectory);
+    }
+    unplacedSamples(endpoints) {
+        reportUnplacedSamples(endpoints);
+    }
+    // A run delivers everything or nothing, so a gap is the server's, and trying again is the fix.
+    artifactsIncomplete(missing) {
+        log.error(`The portal artifacts did not include ${describeMissingArtifacts(missing)}, which the portal's pages ` +
+            `need. Try again, and if it keeps happening, reach out to our team at ${f.var('support@apimatic.io')}.`);
+    }
+}
+//# sourceMappingURL=prepare-project.js.map

package/lib/prompts/portal/prepare-project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepare-project.js","sourceRoot":"","sources":["../../../src/prompts/portal/prepare-project.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAUrC,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC7E,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAE7F,mGAAmG;AACnG,MAAM,OAAO,2BAA2B;IAC/B,kBAAkB,CAAC,MAAc;QACtC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,CAAC;IAEM,mBAAmB,CAAC,OAAmC;QAC5D,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAEM,iBAAiB,CAAC,EAAkD;QACzE,OAAO,iBAAiB,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAEM,aAAa,CAAC,OAA4B,EAAE,eAA8B;QAC/E,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAChD,CAAC;IAEM,qBAAqB,CAAC,QAAoB;QAC/C,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAEM,cAAc,CAAC,OAAuB,EAAE,eAA8B;QAC3E,oBAAoB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACjD,CAAC;IAEM,eAAe,CAAC,SAAmB;QACxC,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,+FAA+F;IACxF,mBAAmB,CAAC,OAAyB;QAClD,GAAG,CAAC,KAAK,CACP,wCAAwC,wBAAwB,CAAC,OAAO,CAAC,6BAA6B;YACpG,wEAAwE,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAC1G,CAAC;IACJ,CAAC;CACF"}

package/lib/prompts/portal/serve.d.ts

@@ -1,15 +1,35 @@
-import { UrlPath } from "../../types/file/urlPath.js";
-import { DirectoryPath } from "../../types/file/directoryPath.js";
+import { DirectoryPath } from '../../types/file/directoryPath.js';
+import { UrlPath } from '../../types/file/urlPath.js';
+import { ContentNotices } from '../../types/portal/content-notices.js';
+import { MissingArtifacts } from '../../types/portal/generated-pages.js';
+import { ContentProblem, PortalSourceProblem } from '../../types/portal/portal-source.js';
+import { PortalDevServer, PortalDevServerFailure } from '../../infrastructure/portal-dev-server-service.js';
+import { Result } from 'neverthrow';
 export declare class PortalServePrompts {
-    usingFallbackPort(currentPort: number, availablePort: number): void;
-    serverStartFailed(port: number): void;
-    noPortalSource(buildDirectory: DirectoryPath): void;
-    invalidBuildConfig(buildDirectory: DirectoryPath): void;
-    baseUrlPortUpdated(updatedUrl: UrlPath): void;
-    portalServed(urlPath: UrlPath): void;
-    promptForExit(): void;
-    changesDetected(): void;
-    watcherError(): void;
+    usingFallbackPort(requestedPort: number, availablePort: number): void;
+    /** The first start of a project pre-bundles dependencies and can take a minute. */
+    startPreview(fn: Promise<Result<PortalDevServer, PortalDevServerFailure>>): Promise<Result<PortalDevServer, PortalDevServerFailure>>;
+    startFailed(output: string): void;
+    portalServed(url: UrlPath, sourceDirectory: DirectoryPath): void;
+    configApplied(): void;
+    /** Explained as `portal generate` would explain it, since the same rules refused it. */
+    configRejected(problem: PortalSourceProblem, sourceDirectory: DirectoryPath): void;
+    editNeedsRestart(missing: MissingArtifacts): void;
+    configNotApplied(reason: string): void;
+    /** Vite reads its public directory once, and a missing one is served as none. */
+    staticDirectoryNotServed(sourceDirectory: DirectoryPath): void;
+    configNotWatched(reason: string): void;
+    configWatchFailed(reason: string): void;
+    /** Explained as `portal generate` would explain it, since the same rules refused it. */
+    contentRejected(problems: ContentProblem[], sourceDirectory: DirectoryPath): void;
+    contentNotApplied(reason: string, sourceDirectory: DirectoryPath): void;
+    contentNotChecked(reason: string, sourceDirectory: DirectoryPath): void;
+    contentAccepted(sourceDirectory: DirectoryPath): void;
+    contentNotices(notices: ContentNotices, sourceDirectory: DirectoryPath): void;
+    contentNotWatched(reason: string, sourceDirectory: DirectoryPath): void;
+    contentWatchFailed(reason: string, sourceDirectory: DirectoryPath): void;
+    stopping(): void;
+    /** The preview stopped on its own: whatever it printed on the way out is the explanation. */
+    previewStopped(output: string): void;
     blockExecution(): Promise<void>;
-    hotReloadEnabled(srcDirectory: DirectoryPath): void;
 }

package/lib/prompts/portal/serve.js

@@ -1,54 +1,117 @@
-import { log } from "@clack/prompts";
-import { format as f } from "../format.js";
-import { once } from "events";
-import { noteWrapped } from "../prompt.js";
+import { log } from '@clack/prompts';
+import { once } from 'node:events';
+import { APIMATIC_CONFIG_FILE_NAME } from '../../types/apimatic-config/document.js';
+import { NAVIGATION_FILE_NAME } from '../../types/portal/portal-navigation.js';
+import { format as f } from '../format.js';
+import { logTail, noteWrapped, withSpinner } from '../prompt.js';
+import { describeMissingArtifacts } from './artifacts.js';
+import { contentPath, reportContentNotices, reportContentProblems, reportSourceProblem, specPath, staticPath } from './source.js';
 export class PortalServePrompts {
-    usingFallbackPort(currentPort, availablePort) {
-        const message = `Port ${f.var(currentPort.toString())} is already in use. The portal will use port ${f.var(availablePort.toString())} instead.`;
+    usingFallbackPort(requestedPort, availablePort) {
+        const message = `Port ${f.var(requestedPort.toString())} is already in use. ` +
+            `The portal will use port ${f.var(availablePort.toString())} instead.`;
         log.step(message);
     }
-    serverStartFailed(port) {
-        const message = `Could not start the portal server on port ${f.var(port.toString())}; ` +
-            `it may have just been taken by another process. Please try again.`;
-        log.error(message);
+    /** The first start of a project pre-bundles dependencies and can take a minute. */
+    startPreview(fn) {
+        return withSpinner('Starting the portal preview', 'Portal preview ready.', (failure) => failure.message, fn, {
+            indicator: 'timer'
+        });
     }
-    noPortalSource(buildDirectory) {
-        const message = `No portal source found at ${f.path(buildDirectory)}. ` +
-            `Run ${f.cmdAlt("apimatic", "portal", "quickstart")} to set one up.`;
-        log.error(message);
+    startFailed(output) {
+        const tail = logTail(output);
+        if (tail.length > 0) {
+            log.message(tail);
+        }
     }
-    invalidBuildConfig(buildDirectory) {
-        const message = `Could not read the build configuration in ${f.path(buildDirectory)}. ` +
-            `Ensure ${f.var("APIMATIC-BUILD.json")} exists and is valid JSON.`;
-        log.error(message);
+    portalServed(url, sourceDirectory) {
+        log.message(`The portal is running at ${f.link(url.toString())}`);
+        noteWrapped([
+            `Edits to the Markdown pages in ${contentPath(sourceDirectory)}, to the order, tabs and titles in a ` +
+                `${f.var(NAVIGATION_FILE_NAME)}, and to the ${f.var('portal')} block of ` +
+                `${f.var(APIMATIC_CONFIG_FILE_NAME)} appear in the browser automatically, and so does a language ` +
+                `removed from its ${f.var('languages')} block, which updates the SDK pages, or its ${f.var('plugin')} ` +
+                `block removed, which removes the Context Plugin tab. A mistake in ${f.var(APIMATIC_CONFIG_FILE_NAME)}, ` +
+                `a page or a ${f.var(NAVIGATION_FILE_NAME)} is reported when you save it, and the preview keeps what it ` +
+                `last accepted.`,
+            '',
+            `Adding a language or a ${f.var('plugin')} block, whose SDK or plugin is fetched when the preview ` +
+                `starts, adding or removing a page in ${contentPath(sourceDirectory)}, creating ` +
+                `${staticPath(sourceDirectory)}, or changing which documents are in ${specPath(sourceDirectory)} ` +
+                `needs the preview restarted.`,
+            '',
+            'Press CTRL+C to stop the server.'
+        ].join('\n'), 'Live preview');
     }
-    baseUrlPortUpdated(updatedUrl) {
-        const message = `Updated the base URL in ${f.var("APIMATIC-BUILD.json")} to ${f.var(updatedUrl.toString())} to match the serve port.`;
-        log.info(message);
+    configApplied() {
+        log.success(`Applied the changes to ${f.var(APIMATIC_CONFIG_FILE_NAME)}.`);
     }
-    portalServed(urlPath) {
-        const message = `The portal is running at ${f.link(urlPath.toString())}`;
-        log.message(message);
+    /** Explained as `portal generate` would explain it, since the same rules refused it. */
+    configRejected(problem, sourceDirectory) {
+        reportSourceProblem(problem, sourceDirectory, { offerQuickstart: false });
+        log.message('The preview keeps showing what it last accepted until the file is fixed.');
     }
-    promptForExit() {
-        const message = "Press CTRL+C to stop the server.";
-        log.message(message);
+    // The artifacts are fetched once, before the preview starts.
+    editNeedsRestart(missing) {
+        log.warn(`This edit to ${f.var(APIMATIC_CONFIG_FILE_NAME)} needs ${describeMissingArtifacts(missing)}, which the ` +
+            `preview was started without. Restart the preview to fetch them; until then it keeps showing what ` +
+            `it last accepted.`);
     }
-    changesDetected() {
-        const message = "Changes detected...";
-        log.info(message);
+    configNotApplied(reason) {
+        log.warn(`The changes to ${f.var(APIMATIC_CONFIG_FILE_NAME)} could not be applied to the preview: ${reason}`);
     }
-    watcherError() {
-        const message = `An unexpected error occurred while watching your build folder for changes. Please try again later. If the issue persists, contact our team at ${f.var("support@apimatic.io")}`;
-        log.error(message);
+    /** Vite reads its public directory once, and a missing one is served as none. */
+    staticDirectoryNotServed(sourceDirectory) {
+        const message = `${staticPath(sourceDirectory)} did not exist when the preview started, so the files ` +
+            `in it are not served. Restart the preview to show them.`;
+        log.warn(message);
     }
-    async blockExecution() {
-        await Promise.race([once(process, "SIGINT"), once(process, "SIGTERM")]);
+    configNotWatched(reason) {
+        log.warn(`${f.var(APIMATIC_CONFIG_FILE_NAME)} cannot be watched (${reason}), so edits to it need the preview restarted.`);
+    }
+    configWatchFailed(reason) {
+        log.warn(`${f.var(APIMATIC_CONFIG_FILE_NAME)} is no longer watched (${reason}), so further edits to it need the ` +
+            `preview restarted.`);
+    }
+    /** Explained as `portal generate` would explain it, since the same rules refused it. */
+    contentRejected(problems, sourceDirectory) {
+        reportContentProblems(problems, sourceDirectory);
+        log.message(`The preview keeps showing what it last accepted until ${contentPath(sourceDirectory)} is ` +
+            `fixed; a build would stop here.`);
+    }
+    contentNotApplied(reason, sourceDirectory) {
+        log.warn(`The changes to ${contentPath(sourceDirectory)} could not be applied to the preview: ${reason}`);
+    }
+    contentNotChecked(reason, sourceDirectory) {
+        log.warn(`The changes to ${contentPath(sourceDirectory)} could not be checked: ${reason}`);
+    }
+    contentAccepted(sourceDirectory) {
+        log.success(`${contentPath(sourceDirectory)} is fixed; a build would accept it again.`);
     }
-    hotReloadEnabled(srcDirectory) {
-        noteWrapped(`Hot reload is enabled.
-
-Watching the directory ${f.path(srcDirectory)} for any changes`, `Note`);
+    contentNotices(notices, sourceDirectory) {
+        reportContentNotices(notices, sourceDirectory);
+    }
+    contentNotWatched(reason, sourceDirectory) {
+        log.warn(`${contentPath(sourceDirectory)} cannot be watched (${reason}), so a mistake in a page or a ` +
+            `${f.var(NAVIGATION_FILE_NAME)} is only reported when the preview is restarted.`);
+    }
+    contentWatchFailed(reason, sourceDirectory) {
+        log.warn(`${contentPath(sourceDirectory)} is no longer watched (${reason}), so a mistake in a page or ` +
+            `a ${f.var(NAVIGATION_FILE_NAME)} is only reported when the preview is restarted.`);
+    }
+    stopping() {
+        log.info('Stopping the portal preview.');
+    }
+    /** The preview stopped on its own: whatever it printed on the way out is the explanation. */
+    previewStopped(output) {
+        log.error('The portal preview stopped unexpectedly.');
+        const tail = logTail(output);
+        if (tail.length > 0) {
+            log.message(tail);
+        }
+    }
+    async blockExecution() {
+        await Promise.race([once(process, 'SIGINT'), once(process, 'SIGTERM')]);
     }
 }
 //# sourceMappingURL=serve.js.map

package/lib/prompts/portal/serve.js.map

@@ -1 +1 @@
-{"version":3,"file":"serve.js","sourceRoot":"","sources":["../../../src/prompts/portal/serve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,OAAO,kBAAkB;IACtB,iBAAiB,CAAC,WAAmB,EAAE,aAAqB;QACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,gDAAgD,CAAC,CAAC,GAAG,CACxG,aAAa,CAAC,QAAQ,EAAE,CACzB,WAAW,CAAC;QACb,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,iBAAiB,CAAC,IAAY;QACnC,MAAM,OAAO,GACX,6CAA6C,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI;YACvE,mEAAmE,CAAC;QACtE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,cAAc,CAAC,cAA6B;QACjD,MAAM,OAAO,GACX,6BAA6B,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI;YACvD,OAAO,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,iBAAiB,CAAC;QACvE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,kBAAkB,CAAC,cAA6B;QACrD,MAAM,OAAO,GACX,6CAA6C,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI;YACvE,UAAU,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,4BAA4B,CAAC;QACrE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,kBAAkB,CAAC,UAAmB;QAC3C,MAAM,OAAO,GAAG,2BAA2B,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,2BAA2B,CAAC;QACtI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,YAAY,CAAC,OAAgB;QAClC,MAAM,OAAO,GAAG,4BAA4B,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;QACzE,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAEM,aAAa;QAClB,MAAM,OAAO,GAAG,kCAAkC,CAAC;QACnD,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAEM,eAAe;QACpB,MAAM,OAAO,GAAG,qBAAqB,CAAC;QACtC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,YAAY;QACjB,MAAM,OAAO,GAAG,iJAAiJ,CAAC,CAAC,GAAG,CACpK,qBAAqB,CACtB,EAAE,CAAC;QACJ,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IAEM,gBAAgB,CAAC,YAA2B;QACjD,WAAW,CACT;;yBAEmB,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,kBAAkB,EACzD,MAAM,CACP,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"serve.js","sourceRoot":"","sources":["../../../src/prompts/portal/serve.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAKpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAI/E,OAAO,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EACL,WAAW,EACX,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,QAAQ,EACR,UAAU,EACX,MAAM,aAAa,CAAC;AAErB,MAAM,OAAO,kBAAkB;IACtB,iBAAiB,CAAC,aAAqB,EAAE,aAAqB;QACnE,MAAM,OAAO,GACX,QAAQ,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,sBAAsB;YAC7D,4BAA4B,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC;QACzE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAED,mFAAmF;IAC5E,YAAY,CAAC,EAA4D;QAC9E,OAAO,WAAW,CAAC,6BAA6B,EAAE,uBAAuB,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE;YAC3G,SAAS,EAAE,OAAO;SACnB,CAAC,CAAC;IACL,CAAC;IAEM,WAAW,CAAC,MAAc;QAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAEM,YAAY,CAAC,GAAY,EAAE,eAA8B;QAC9D,GAAG,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;QAClE,WAAW,CACT;YACE,kCAAkC,WAAW,CAAC,eAAe,CAAC,uCAAuC;gBACnG,GAAG,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY;gBACzE,GAAG,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,+DAA+D;gBAClG,oBAAoB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,+CAA+C,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG;gBACvG,qEAAqE,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,IAAI;gBACzG,eAAe,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,+DAA+D;gBACzG,gBAAgB;YAClB,EAAE;YACF,0BAA0B,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,0DAA0D;gBACjG,wCAAwC,WAAW,CAAC,eAAe,CAAC,aAAa;gBACjF,GAAG,UAAU,CAAC,eAAe,CAAC,wCAAwC,QAAQ,CAAC,eAAe,CAAC,GAAG;gBAClG,8BAA8B;YAChC,EAAE;YACF,kCAAkC;SACnC,CAAC,IAAI,CAAC,IAAI,CAAC,EACZ,cAAc,CACf,CAAC;IACJ,CAAC;IAEM,aAAa;QAClB,GAAG,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;IAC7E,CAAC;IAED,wFAAwF;IACjF,cAAc,CAAC,OAA4B,EAAE,eAA8B;QAChF,mBAAmB,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1E,GAAG,CAAC,OAAO,CAAC,0EAA0E,CAAC,CAAC;IAC1F,CAAC;IAED,6DAA6D;IACtD,gBAAgB,CAAC,OAAyB;QAC/C,GAAG,CAAC,IAAI,CACN,gBAAgB,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,UAAU,wBAAwB,CAAC,OAAO,CAAC,cAAc;YACvG,mGAAmG;YACnG,mBAAmB,CACtB,CAAC;IACJ,CAAC;IAEM,gBAAgB,CAAC,MAAc;QACpC,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,yCAAyC,MAAM,EAAE,CAAC,CAAC;IAChH,CAAC;IAED,iFAAiF;IAC1E,wBAAwB,CAAC,eAA8B;QAC5D,MAAM,OAAO,GACX,GAAG,UAAU,CAAC,eAAe,CAAC,wDAAwD;YACtF,yDAAyD,CAAC;QAC5D,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpB,CAAC;IAEM,gBAAgB,CAAC,MAAc;QACpC,GAAG,CAAC,IAAI,CACN,GAAG,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,uBAAuB,MAAM,+CAA+C,CAChH,CAAC;IACJ,CAAC;IAEM,iBAAiB,CAAC,MAAc;QACrC,GAAG,CAAC,IAAI,CACN,GAAG,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,0BAA0B,MAAM,qCAAqC;YACtG,oBAAoB,CACvB,CAAC;IACJ,CAAC;IAED,wFAAwF;IACjF,eAAe,CAAC,QAA0B,EAAE,eAA8B;QAC/E,qBAAqB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QACjD,GAAG,CAAC,OAAO,CACT,yDAAyD,WAAW,CAAC,eAAe,CAAC,MAAM;YACzF,iCAAiC,CACpC,CAAC;IACJ,CAAC;IAEM,iBAAiB,CAAC,MAAc,EAAE,eAA8B;QACrE,GAAG,CAAC,IAAI,CAAC,kBAAkB,WAAW,CAAC,eAAe,CAAC,yCAAyC,MAAM,EAAE,CAAC,CAAC;IAC5G,CAAC;IAEM,iBAAiB,CAAC,MAAc,EAAE,eAA8B;QACrE,GAAG,CAAC,IAAI,CAAC,kBAAkB,WAAW,CAAC,eAAe,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;IAC7F,CAAC;IAEM,eAAe,CAAC,eAA8B;QACnD,GAAG,CAAC,OAAO,CAAC,GAAG,WAAW,CAAC,eAAe,CAAC,2CAA2C,CAAC,CAAC;IAC1F,CAAC;IAEM,cAAc,CAAC,OAAuB,EAAE,eAA8B;QAC3E,oBAAoB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACjD,CAAC;IAEM,iBAAiB,CAAC,MAAc,EAAE,eAA8B;QACrE,GAAG,CAAC,IAAI,CACN,GAAG,WAAW,CAAC,eAAe,CAAC,uBAAuB,MAAM,iCAAiC;YAC3F,GAAG,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,kDAAkD,CACnF,CAAC;IACJ,CAAC;IAEM,kBAAkB,CAAC,MAAc,EAAE,eAA8B;QACtE,GAAG,CAAC,IAAI,CACN,GAAG,WAAW,CAAC,eAAe,CAAC,0BAA0B,MAAM,+BAA+B;YAC5F,KAAK,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,kDAAkD,CACrF,CAAC;IACJ,CAAC;IAEM,QAAQ;QACb,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC3C,CAAC;IAED,6FAA6F;IACtF,cAAc,CAAC,MAAc;QAClC,GAAG,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/lib/prompts/portal/source.d.ts

@@ -0,0 +1,26 @@
+import { DirectoryPath } from '../../types/file/directoryPath.js';
+import { ContentNotices } from '../../types/portal/content-notices.js';
+import { ContentProblem, PortalSourceProblem } from '../../types/portal/portal-source.js';
+import { SharedTabName } from '../../types/portal/portal-tabs.js';
+import { FileName } from '../../types/file/fileName.js';
+import { FilePath } from '../../types/file/filePath.js';
+export declare const specPath: (sourceDirectory: DirectoryPath) => string;
+export declare const contentPath: (sourceDirectory: DirectoryPath) => string;
+export declare const staticPath: (sourceDirectory: DirectoryPath) => string;
+export declare const convertToOpenApi3: () => string;
+/**
+ * Shared by `portal generate` and `portal serve`: both read the same source directory, so
+ * a broken one has to be explained the same way in both. `offerQuickstart` is false once a
+ * preview of the directory is running: quickstart refuses a directory that is not empty.
+ */
+export declare function reportSourceProblem(problem: PortalSourceProblem, sourceDirectory: DirectoryPath, { offerQuickstart }?: {
+    offerQuickstart?: boolean;
+}): void;
+/** Each problem in turn, so one run lists everything a build would refuse in `content/`. */
+export declare function reportContentProblems(problems: ContentProblem[], sourceDirectory: DirectoryPath): void;
+export declare function reportShadowedFiles(shadowed: FileName[]): void;
+export declare function reportIgnoredNavigationFiles(files: FilePath[], sourceDirectory: DirectoryPath): void;
+export declare function reportContentNotices(notices: ContentNotices, sourceDirectory: DirectoryPath): void;
+export declare function reportFolderTabs(folders: DirectoryPath[]): void;
+export declare function reportSharedTabNames(shared: SharedTabName[], sourceDirectory: DirectoryPath): void;
+export declare function reportHiddenPages(files: FilePath[], sourceDirectory: DirectoryPath): void;