@promptbook/cli 0.114.0-3 → 0.114.0-30

package/apps/agents-server/src/utils/agentProjects/createAgentProjectMarkdownReferences.ts

@@ -1,6 +1,22 @@
 import type { MarkdownInlineReference } from '@promptbook-local/types';
 import type { AgentProjectReferenceInfo } from './AgentProjectReferenceInfo';
-import { buildAgentProjectFilesHrefPrefix, buildAgentProjectProfileHref } from './agentProjectHrefs';
+import { buildAgentProjectFileHref, buildAgentProjectProfileHref } from './agentProjectHrefs';
+import { createAgentProjectInitials } from './createAgentProjectInitials';
+
+/**
+ * Stable action id used by a stopped project's open-and-start menu option.
+ */
+const OPEN_AGENT_PROJECT_ACTION_ID = 'open-agent-project';
+
+/**
+ * Stable action id used by a project runtime start menu option.
+ */
+const START_AGENT_PROJECT_ACTION_ID = 'start-agent-project';
+
+/**
+ * Stable action id used by a project runtime stop menu option.
+ */
+const STOP_AGENT_PROJECT_ACTION_ID = 'stop-agent-project';
 
 /**
  * Markdown inline reference data consumed by chat markdown rendering.
@@ -20,18 +36,40 @@ type CreateAgentProjectMarkdownReferencesOptions = {
      * Project references available to this agent chat.
      */
     readonly projects: ReadonlyArray<AgentProjectMarkdownReferenceInfo>;
+
+    /**
+     * Opens a project, starting its runtime first when needed.
+     */
+    readonly onOpenProject?: (project: AgentProjectMarkdownReferenceInfo) => void | Promise<void>;
+
+    /**
+     * Starts or stops one project runtime.
+     */
+    readonly onChangeProjectRuntime?: (
+        project: AgentProjectMarkdownReferenceInfo,
+        isRunning: boolean,
+    ) => void | Promise<void>;
 };
 
 /**
  * Project fields required to create a chat markdown reference.
  */
-type AgentProjectMarkdownReferenceInfo = Pick<
+export type AgentProjectMarkdownReferenceInfo = Pick<
     AgentProjectReferenceInfo,
-    'projectName' | 'displayName' | 'description' | 'isRunning' | 'projectUrl'
+    'projectName' | 'displayName' | 'description' | 'faviconRelativePath' | 'isRunning' | 'projectUrl'
 >;
 
 /**
- * Creates markdown references that render known `[[project-name]]` tokens as project profile chips.
+ * One menu option belonging to a project markdown reference.
+ */
+type AgentProjectMarkdownReferenceMenuOption = NonNullable<AgentProjectMarkdownReference['menu']>['options'][number];
+
+/**
+ * Creates markdown references rendering every mention of one project as a project chip.
+ *
+ * One project is mentioned either by its display name in chat prose, its `[[project-name]]` token,
+ * a link into its project page or files, or its public project URL. All of them render the same chip
+ * showing the project name together with its running state.
  *
  * @param options - Agent and project metadata.
  * @returns Inline markdown references for the shared chat renderer.
@@ -42,38 +80,105 @@ export function createAgentProjectMarkdownReferences(
     return options.projects.map((project) => {
         const projectProfileHref = buildAgentProjectProfileHref(options.agentPermanentId, project.projectName);
         const projectUrl = project.projectUrl || null;
+        const label = project.displayName || project.projectName;
+        const faviconHref = project.faviconRelativePath
+            ? buildAgentProjectFileHref(options.agentPermanentId, project.projectName, project.faviconRelativePath)
+            : null;
 
         return {
             reference: project.projectName,
-            label: project.displayName || project.projectName,
+            sourceTextAliases: [label],
+            label,
             href: projectProfileHref,
-            sourceHrefPrefixes: [
-                projectProfileHref,
-                buildAgentProjectFilesHrefPrefix(options.agentPermanentId, project.projectName),
-                ...(projectUrl ? [projectUrl] : []),
-            ],
-            title: project.description || project.displayName || project.projectName,
+            sourceHrefPrefixes: [projectProfileHref, ...(projectUrl ? [projectUrl] : [])],
+            title: project.description || label,
+            icon: {
+                src: faviconHref,
+                fallbackText: createAgentProjectInitials(project.projectName),
+            },
             menu: {
                 status: {
                     label: project.isRunning ? 'Project is running' : 'Project is not running',
                     isActive: project.isRunning ?? false,
                 },
                 options: [
-                    {
-                        label: 'Open the project in a new tab',
-                        href: project.isRunning ? projectUrl : null,
-                        title:
-                            project.isRunning && projectUrl
-                                ? 'Open the project in a new tab'
-                                : 'The project must run before it can be opened.',
-                    },
+                    createOpenAgentProjectMenuOption(project, options.onOpenProject),
                     {
                         label: 'Open the project page in a new tab',
                         href: projectProfileHref,
                         title: 'Open the project page in a new tab',
                     },
+                    ...(options.onChangeProjectRuntime
+                        ? [createChangeAgentProjectRuntimeMenuOption(project, options.onChangeProjectRuntime)]
+                        : []),
                 ],
             },
         };
     });
 }
+
+/**
+ * Creates the project destination option, using a client action when the runtime must be started.
+ *
+ * @param project - Project represented by the menu.
+ * @param onOpenProject - Optional open-and-start callback.
+ * @returns Project destination menu option.
+ */
+function createOpenAgentProjectMenuOption(
+    project: AgentProjectMarkdownReferenceInfo,
+    onOpenProject: CreateAgentProjectMarkdownReferencesOptions['onOpenProject'],
+): AgentProjectMarkdownReferenceMenuOption {
+    const projectUrl = project.projectUrl || null;
+
+    if (project.isRunning && projectUrl) {
+        return {
+            label: 'Open the project in a new tab',
+            href: projectUrl,
+            title: 'Open the project in a new tab',
+        };
+    }
+
+    if (onOpenProject) {
+        return {
+            label: 'Open the project in a new tab',
+            href: null,
+            title: 'Start the project and open it in a new tab',
+            action: {
+                id: OPEN_AGENT_PROJECT_ACTION_ID,
+                onSelect: () => onOpenProject(project),
+            },
+        };
+    }
+
+    return {
+        label: 'Open the project in a new tab',
+        href: null,
+        title: 'The project must run before it can be opened.',
+    };
+}
+
+/**
+ * Creates the start or stop action matching a project's current runtime state.
+ *
+ * @param project - Project represented by the menu.
+ * @param onChangeProjectRuntime - Runtime state callback.
+ * @returns Start or stop project menu option.
+ */
+function createChangeAgentProjectRuntimeMenuOption(
+    project: AgentProjectMarkdownReferenceInfo,
+    onChangeProjectRuntime: NonNullable<CreateAgentProjectMarkdownReferencesOptions['onChangeProjectRuntime']>,
+): AgentProjectMarkdownReferenceMenuOption {
+    const isRunning = project.isRunning === true;
+    const actionId = isRunning ? STOP_AGENT_PROJECT_ACTION_ID : START_AGENT_PROJECT_ACTION_ID;
+    const label = isRunning ? 'Stop the project' : 'Start the project';
+
+    return {
+        label,
+        href: null,
+        title: label,
+        action: {
+            id: actionId,
+            onSelect: () => onChangeProjectRuntime(project, !isRunning),
+        },
+    };
+}

package/apps/agents-server/src/utils/agentProjects/createAgentProjectsDnsRecordsSection.ts

@@ -0,0 +1,113 @@
+import type { DnsRecordsSection, DnsRecordsSectionVariant } from '../dnsRecords/DnsRecordsSection';
+import { createAgentProjectDnsRecord } from './createAgentProjectDnsRecords';
+
+/**
+ * Inputs of the generated project domain DNS section.
+ *
+ * @private helper for the Agents Server project DNS instructions
+ */
+type CreateAgentProjectsDnsRecordsSectionOptions = {
+    /**
+     * Whether at least one generated project domain currently fails DNS verification.
+     */
+    readonly isDnsIssue?: boolean;
+
+    /**
+     * Example generated project domain used by the single-project variants, when one already exists.
+     */
+    readonly projectDomain?: string | null;
+
+    /**
+     * Public VPS IP address, when known by the server.
+     */
+    readonly publicIpAddress: string | null | undefined;
+
+    /**
+     * Base server domain used by generated project domains.
+     */
+    readonly serverDomain: string;
+};
+
+/**
+ * Creates the DNS section which publishes the generated agent project domains.
+ *
+ * Exactly one of the variants has to be configured, because the wildcard and the single-project records as well as
+ * the A and the CNAME records would collide on the same hostname.
+ *
+ * @param options - Server domain, example project domain, and the public VPS IP address.
+ * @returns Generated project domain section.
+ *
+ * @private shared by the Agents Server DNS instruction views
+ */
+export function createAgentProjectsDnsRecordsSection(
+    options: CreateAgentProjectsDnsRecordsSectionOptions,
+): DnsRecordsSection {
+    return {
+        id: 'agent-projects',
+        title: `Project domains under ${options.serverDomain}`,
+        description: `Project URLs use a subdomain of ${options.serverDomain}. Configure exactly one of the following setups; do not add both the single-project and the wildcard records, or both the A and the CNAME record for the same hostname.`,
+        variantsLabel: 'Project domain setup',
+        variants: [
+            createAgentProjectsDnsRecordsSectionVariant(options, { isWildcardDomain: true, isCnameRecord: true }),
+            createAgentProjectsDnsRecordsSectionVariant(options, { isWildcardDomain: true, isCnameRecord: false }),
+            createAgentProjectsDnsRecordsSectionVariant(options, { isWildcardDomain: false, isCnameRecord: true }),
+            createAgentProjectsDnsRecordsSectionVariant(options, { isWildcardDomain: false, isCnameRecord: false }),
+        ],
+        statusSummary: options.isDnsIssue
+            ? 'One or more generated project domains do not resolve to this VPS yet. The recommended wildcard CNAME setup is selected below.'
+            : null,
+        isDnsIssue: options.isDnsIssue,
+    };
+}
+
+/**
+ * Creates one selectable generated project domain setup.
+ *
+ * @param options - Inputs of the whole section.
+ * @param variant - Selected domain coverage and record type.
+ * @returns One section variant with its single DNS record.
+ *
+ * @private function of `createAgentProjectsDnsRecordsSection`
+ */
+function createAgentProjectsDnsRecordsSectionVariant(
+    options: CreateAgentProjectsDnsRecordsSectionOptions,
+    variant: {
+        /**
+         * Whether the variant covers every generated project domain.
+         */
+        readonly isWildcardDomain: boolean;
+
+        /**
+         * Whether the variant uses a CNAME instead of an A record.
+         */
+        readonly isCnameRecord: boolean;
+    },
+): DnsRecordsSectionVariant {
+    const { isCnameRecord, isWildcardDomain } = variant;
+
+    return {
+        id: `${isWildcardDomain ? 'wildcard' : 'single-project'}-${isCnameRecord ? 'cname' : 'a'}`,
+        label: isWildcardDomain
+            ? isCnameRecord
+                ? 'Wildcard CNAME (all projects, recommended)'
+                : 'Wildcard A record (all projects)'
+            : isCnameRecord
+            ? 'Single project CNAME'
+            : 'Single project A record',
+        description: isWildcardDomain
+            ? `This covers all generated project domains under ${options.serverDomain}.`
+            : options.projectDomain
+            ? `This covers one project, for example ${options.projectDomain}. Repeat it for each project that needs a public URL.`
+            : 'This covers one generated project. Replace the project name placeholder above with its full hostname.',
+        recordSelection: 'one',
+        records: [
+            createAgentProjectDnsRecord({
+                isCnameRecord,
+                isWildcardDomain,
+                projectDomain: options.projectDomain,
+                publicIpAddress: options.publicIpAddress,
+                serverDomain: options.serverDomain,
+            }),
+        ],
+    };
+}

package/apps/agents-server/src/utils/agentProjects/createStaticAgentProjectServer.ts

@@ -3,15 +3,11 @@ import { readdir, readFile, stat } from 'fs/promises';
 import { basename, isAbsolute, join, relative, resolve } from 'path';
 import { NotAllowed } from '../../../../../src/errors/NotAllowed';
 import { spaceTrim } from '../../../../../src/utils/organization/spaceTrim';
+import { AGENT_PROJECT_INDEX_HTML_FILE_NAMES } from './agentProjectFileNames';
 import { assertSafeAgentProjectPathSegment } from './agentProjectsPaths';
 import { isMissingPathError } from './isMissingPathError';
 import { resolveAgentProjectFileContentType } from './resolveAgentProjectFileContentType';
 
-/**
- * Filenames served automatically when a request targets a project directory.
- */
-const STATIC_DIRECTORY_INDEX_FILENAMES = ['index.html', 'index.htm'] as const;
-
 /**
  * HTML content type used for generated static directory listings.
  */
@@ -170,7 +166,7 @@ async function serveStaticProjectDirectory(options: {
     readonly directoryPath: string;
     readonly response: ServerResponse;
 }): Promise<void> {
-    for (const indexFileName of STATIC_DIRECTORY_INDEX_FILENAMES) {
+    for (const indexFileName of AGENT_PROJECT_INDEX_HTML_FILE_NAMES) {
         const indexFilePath = join(options.directoryPath, indexFileName);
         const indexFileStats = await stat(indexFilePath).catch((error) => {
             if (isMissingPathError(error)) {

package/apps/agents-server/src/utils/agentProjects/humanizeAgentProjectName.ts

@@ -0,0 +1,25 @@
+import { capitalize } from '@promptbook-local/utils';
+
+/**
+ * Separators used between the words of one project directory name.
+ */
+const AGENT_PROJECT_NAME_WORD_SEPARATOR_REGEX = /[-_.\s]+/g;
+
+/**
+ * Converts one project directory name into a human-readable project name.
+ *
+ * For example `prague-murders-map` becomes `Prague Murders Map`.
+ *
+ * @param projectName - Project directory name.
+ * @returns Human-readable project name, or the original name when it cannot be humanized.
+ */
+export function humanizeAgentProjectName(projectName: string): string {
+    const humanizedProjectName = projectName
+        .trim()
+        .split(AGENT_PROJECT_NAME_WORD_SEPARATOR_REGEX)
+        .filter((projectNameWord) => projectNameWord !== '')
+        .map((projectNameWord) => capitalize(projectNameWord))
+        .join(' ');
+
+    return humanizedProjectName || projectName;
+}

package/apps/agents-server/src/utils/agentProjects/listAgentProjectChatReferences.ts

@@ -1,6 +1,7 @@
 import type { AgentProjectReferenceInfo } from './AgentProjectReferenceInfo';
 import { listAgentProjectRuntimes } from './agentProjectRuntimeRegistry';
 import { listAgentProjects } from './listAgentProjects';
+import { resolveAgentProjectPublicUrls } from './resolveAgentProjectPublicUrls';
 
 /**
  * Lists browser-safe project references enriched with their current runtime state for chat.
@@ -11,7 +12,11 @@ import { listAgentProjects } from './listAgentProjects';
 export async function listAgentProjectChatReferences(
     agentPermanentId: string,
 ): Promise<ReadonlyArray<AgentProjectReferenceInfo>> {
-    const [projects, runtimes] = await Promise.all([listAgentProjects(agentPermanentId), listAgentProjectRuntimes()]);
+    const [projects, runtimes, publicUrlByProjectName] = await Promise.all([
+        listAgentProjects(agentPermanentId),
+        listAgentProjectRuntimes(),
+        resolveAgentProjectPublicUrls(agentPermanentId),
+    ]);
     const runtimeByProjectName = new Map(
         runtimes
             .filter((runtime) => runtime.agentPermanentId.toLowerCase() === agentPermanentId.toLowerCase())
@@ -19,15 +24,17 @@ export async function listAgentProjectChatReferences(
     );
 
     return projects.map((project) => {
-        const runtime = runtimeByProjectName.get(project.projectName.toLowerCase());
+        const normalizedProjectName = project.projectName.toLowerCase();
+        const runtime = runtimeByProjectName.get(normalizedProjectName);
 
         return {
             projectName: project.projectName,
             displayName: project.displayName,
             description: project.description,
             sizeBytes: project.sizeBytes,
+            faviconRelativePath: project.faviconRelativePath ?? null,
             isRunning: runtime?.isRunning ?? false,
-            projectUrl: runtime?.publicUrl ?? null,
+            projectUrl: runtime?.publicUrl ?? publicUrlByProjectName.get(normalizedProjectName) ?? null,
         };
     });
 }

package/apps/agents-server/src/utils/agentProjects/listAgentProjectNames.ts

@@ -0,0 +1,35 @@
+import { readdir } from 'fs/promises';
+import { resolveAgentProjectsRootPath } from './agentProjectsPaths';
+import { isMissingPathError } from './isMissingPathError';
+
+/**
+ * Lists the directory names of all projects of one agent.
+ *
+ * This is the cheap half of `listAgentProjects` — it reads the `projects/` folder itself and never walks
+ * the project trees, so it can answer "did the set of projects change?" without measuring every project.
+ *
+ * A missing projects folder is reported as an empty list — the folder is created lazily
+ * when the agent (or the runner) first needs it.
+ *
+ * @param agentPermanentId - Permanent id of the agent.
+ * @returns Project directory names ordered by name.
+ */
+export async function listAgentProjectNames(agentPermanentId: string): Promise<ReadonlyArray<string>> {
+    const projectsRootPath = resolveAgentProjectsRootPath(agentPermanentId);
+
+    let projectsRootEntries;
+    try {
+        projectsRootEntries = await readdir(projectsRootPath, { withFileTypes: true });
+    } catch (error) {
+        if (isMissingPathError(error)) {
+            return [];
+        }
+
+        throw error;
+    }
+
+    return projectsRootEntries
+        .filter((projectsRootEntry) => projectsRootEntry.isDirectory())
+        .map((projectDirectoryEntry) => projectDirectoryEntry.name)
+        .sort((firstProjectName, secondProjectName) => firstProjectName.localeCompare(secondProjectName));
+}

package/apps/agents-server/src/utils/agentProjects/listAgentProjects.ts

@@ -1,7 +1,6 @@
-import { readdir } from 'fs/promises';
 import type { AgentProjectInfo } from './AgentProjectInfo';
 import { resolveAgentProjectsRootPath } from './agentProjectsPaths';
-import { isMissingPathError } from './isMissingPathError';
+import { listAgentProjectNames } from './listAgentProjectNames';
 import { createAgentProjectInfo } from './resolveAgentProjectInfo';
 
 /**
@@ -15,27 +14,11 @@ import { createAgentProjectInfo } from './resolveAgentProjectInfo';
  */
 export async function listAgentProjects(agentPermanentId: string): Promise<ReadonlyArray<AgentProjectInfo>> {
     const projectsRootPath = resolveAgentProjectsRootPath(agentPermanentId);
+    const projectNames = await listAgentProjectNames(agentPermanentId);
 
-    let projectsRootEntries;
-    try {
-        projectsRootEntries = await readdir(projectsRootPath, { withFileTypes: true });
-    } catch (error) {
-        if (isMissingPathError(error)) {
-            return [];
-        }
-
-        throw error;
-    }
-
-    const projects = await Promise.all(
-        projectsRootEntries
-            .filter((projectsRootEntry) => projectsRootEntry.isDirectory())
-            .map((projectDirectoryEntry): Promise<AgentProjectInfo> =>
-                createAgentProjectInfo(projectsRootPath, projectDirectoryEntry.name),
-            ),
-    );
-
-    return projects.sort((firstProject, secondProject) =>
-        firstProject.projectName.localeCompare(secondProject.projectName),
+    return await Promise.all(
+        projectNames.map(
+            (projectName): Promise<AgentProjectInfo> => createAgentProjectInfo(projectsRootPath, projectName),
+        ),
     );
 }

package/apps/agents-server/src/utils/agentProjects/listAllAgentProjectSummaries.ts

@@ -5,7 +5,8 @@ import { runWithServerContextOverride } from '@/src/tools/serverContextOverride'
 import { DatabaseError } from '../../../../../src/errors/DatabaseError';
 import { spaceTrim } from '../../../../../src/utils/organization/spaceTrim';
 import { createLocalAgentDirectoryName, resolveLocalAgentRootPath } from '../localChatRunner/ensureLocalAgentFolder';
-import { createServerPublicUrl, type ServerRecord, listRegisteredServersUsingServiceRole } from '../serverRegistry';
+import { createServerPublicUrl, type ServerRecord } from '../serverRegistry';
+import { listRegisteredServersUsingServiceRole } from '../serverRegistryNode';
 import type { AgentProjectsSummary, AllAgentProjectsReport } from './AgentProjectInfo';
 import { listAgentProjects } from './listAgentProjects';
 

package/apps/agents-server/src/utils/agentProjects/listAllLocalAgentProjectIdentities.ts

@@ -0,0 +1,48 @@
+import { readdir } from 'fs/promises';
+import { resolveLocalAgentRootPath } from '../localChatRunner/ensureLocalAgentFolder';
+import type { AgentProjectIdentity } from './agentProjectIdentity';
+import { parseAgentPermanentIdFromDirectoryName } from './agentProjectsPaths';
+import { isMissingPathError } from './isMissingPathError';
+import { listAgentProjectNames } from './listAgentProjectNames';
+
+/**
+ * Lists every project folder present on this machine, across all agents of all servers.
+ *
+ * Unlike `listAllAgentProjectSummaries` this never asks a database which agents exist and never
+ * measures a project tree — it only reads the two directory levels needed to name a project. That
+ * makes it usable before the first request is served, when no server database is selected yet.
+ *
+ * @returns Identities of all local agent projects ordered by agent and project name.
+ */
+export async function listAllLocalAgentProjectIdentities(): Promise<ReadonlyArray<AgentProjectIdentity>> {
+    const localAgentRootPath = resolveLocalAgentRootPath();
+    let localAgentRootEntries;
+
+    try {
+        localAgentRootEntries = await readdir(localAgentRootPath, { withFileTypes: true });
+    } catch (error) {
+        if (isMissingPathError(error)) {
+            return [];
+        }
+
+        throw error;
+    }
+
+    const agentPermanentIds = localAgentRootEntries
+        .filter((localAgentRootEntry) => localAgentRootEntry.isDirectory())
+        .map((agentDirectoryEntry) => parseAgentPermanentIdFromDirectoryName(agentDirectoryEntry.name))
+        .filter((agentPermanentId): agentPermanentId is string => agentPermanentId !== null)
+        .sort((firstAgentPermanentId, secondAgentPermanentId) =>
+            firstAgentPermanentId.localeCompare(secondAgentPermanentId),
+        );
+
+    const identitiesPerAgent = await Promise.all(
+        agentPermanentIds.map(async (agentPermanentId): Promise<ReadonlyArray<AgentProjectIdentity>> => {
+            const projectNames = await listAgentProjectNames(agentPermanentId);
+
+            return projectNames.map((projectName) => ({ agentPermanentId, projectName }));
+        }),
+    );
+
+    return identitiesPerAgent.flat();
+}