@detergent-software/atk 8.9.0-dev.21 → 8.9.0-dev.23

package/build/lib/publish-flow.js

@@ -1,16 +1,16 @@
 import { writeFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { compare as semverCompare, valid as semverValid } from 'semver';
-import { loadAllAdapters } from './adapter.js';
+import { loadAllAdapters, resolveInstalledPaths } from './adapter.js';
 import { isApiError } from './api-client.js';
 import { getCredential } from './auth.js';
 import { errorGuidance, errorMessage } from './errors.js';
-import { detectCompatibleTools, getSignedInUserName } from './init.js';
+import { detectCompatibleTools, getEntrypointName, getSignedInUserName } from './init.js';
 import { findInstalledAsset, readLockfile } from './lockfile.js';
 import { diffManifests, fetchExistingManifest } from './manifest-diff.js';
 import { parseOrgFromName } from './org.js';
 import { findProjectRoot } from './paths.js';
-import { buildPublishPlan, buildStagingArea, bumpVersion, checkRegistryVersion, detectAssetFromPath, detectPublishType, executePublish, findSiblingDependencies, isOrgScopedTarget, loadPublishBatch, loadPublishEntries, mapPublishError, missingDependencies, resolvePlanDependencies, unknownToolsError, updateManifestField, updateManifestVersion, validatePublishTarget, } from './publisher.js';
+import { buildPublishPlan, buildStagingArea, bumpVersion, checkRegistryVersion, detectAssetFromPath, detectPublishType, executePublish, filledManifestFields, findSiblingDependencies, isOrgScopedTarget, loadPublishBatch, loadPublishEntries, mapPublishError, missingDependencies, readManifestFile, resolvePlanDependencies, unknownToolsError, updateManifestField, updateManifestVersion, validatePublishTarget, } from './publisher.js';
 import { clearCache, fetchAssetFileBytes, fetchAssetReadme, fetchRegistry, findAsset } from './registry.js';
 import { parseReviewersInput, validateGithubUsername } from './reviewers.js';
 import { stageInstalledFiles } from './staging.js';
@@ -162,6 +162,64 @@ async function firstFailure(edits) {
     }
     return undefined;
 }
+/**
+ * The metadata step of a raw publish, for a raw folder or an installed asset, whose `source`
+ * gives its org and any description of its own: the signed-in author, the description from
+ * --description or the source, the tags from --tags, and the tools from --tools or detection.
+ * An interactive run goes on to ask for what is missing; a non-interactive one stages the
+ * manifest now, or fails without a description or tools.
+ */
+async function gatherRawMetadata(state, ctx, detection, source) {
+    const [signedIn, tools] = await Promise.all([
+        getSignedInUserName(),
+        state.flags.toolsFlag ? splitList(state.flags.toolsFlag) : detectCompatibleTools(detection.assetType),
+    ]);
+    if (ctx.cancelled())
+        return;
+    const author = signedIn ?? '';
+    const description = state.flags.descriptionFlag?.trim() || source.description;
+    if (!state.nonInteractive) {
+        ctx.dispatch({
+            authorValue: author,
+            ...(description ? { description } : {}),
+            orgValue: source.org ?? '',
+            rawDetection: detection,
+            toolsDetected: tools,
+            type: 'RAW_DETECT_DONE',
+        });
+        return;
+    }
+    if (!description) {
+        ctx.dispatch({
+            message: state.flags.fromInstalled
+                ? `description required: provide --description (the lockfile has none for '${detection.name}')`
+                : 'description required: provide --description or include in manifest.json',
+            type: 'ERROR',
+        });
+        return;
+    }
+    if (tools.length === 0) {
+        ctx.dispatch({
+            message: `--tools <comma-separated> required: no tools detected for type ${detection.assetType}`,
+            type: 'ERROR',
+        });
+        return;
+    }
+    const stagingDir = await buildStagingArea(detection, {
+        author,
+        description,
+        ...(source.org ? { org: source.org } : {}),
+        tags: splitList(state.flags.tagsFlag),
+        tools,
+    });
+    ctx.stage(stagingDir);
+    if (ctx.cancelled())
+        return;
+    const detected = await detectPublishType(stagingDir);
+    if (ctx.cancelled())
+        return;
+    ctx.dispatch({ rawDetection: detection, target: detected, type: 'RAW_DETECT_DONE_NON_INTERACTIVE' });
+}
 function stepFor(state) {
     switch (state.phase) {
         case 'building-plan':
@@ -226,10 +284,10 @@ function toErrorAction(err, override) {
 }
 /**
  * Write what the run changed in memory to the manifests on disk: the root's bump and each
- * entry's, and the tags and tools the prompts asked for. Only once the publish has opened its
- * PR, so a cancelled or failed one leaves every manifest as it was. A file whose write fails
- * takes none of its later edits and comes back as one warning naming the fields it lacks; the
- * other files are still written.
+ * entry's, and the tags and tools the publish sent on top of the root's manifest (from flags,
+ * prompts or detection). Only once the publish has opened its PR, so a cancelled or failed one
+ * leaves every manifest as it was. A file whose write fails takes none of its later edits and
+ * comes back as one warning naming the fields it lacks; the other files are still written.
  */
 async function writeManifestEdits(state) {
     const target = state.target;
@@ -241,19 +299,14 @@ async function writeManifestEdits(state) {
         files.set(path, [...(files.get(path) ?? []), { field, value, write }]);
     };
     const version = (dir, file, value) => edit(dir, file, 'version', value, () => updateManifestVersion(dir, file, value));
-    const field = (name, value) => edit(target.sourceDir, 'manifest.json', name, value, () => updateManifestField(target.sourceDir, 'manifest.json', name, value));
+    const manifestFile = target.type === 'asset' ? 'manifest.json' : 'bundle.json';
     if (state.versionCheck?.status === 'needs-bump' && state.resolvedVersion) {
-        version(target.sourceDir, target.type === 'asset' ? 'manifest.json' : 'bundle.json', state.resolvedVersion);
+        version(target.sourceDir, manifestFile, state.resolvedVersion);
     }
-    // Only an asset's manifest.json takes the prompted tags and tools, as the target (and so the plan) has them.
-    if (target.type === 'asset') {
-        const { tags, tools } = target.data;
-        if (state.promptTagsValue && tags && tags.length > 0) {
-            field('tags', tags);
-        }
-        if (state.selectedPromptTools.length > 0) {
-            field('tools', tools);
-        }
+    // A manifest that can't be read now takes no field edits; its version edit, if any, warns.
+    const written = await readManifestFile(target).catch(() => undefined);
+    for (const [name, value] of Object.entries(written ? filledManifestFields(written, target) : {})) {
+        edit(target.sourceDir, manifestFile, name, value, () => updateManifestField(target.sourceDir, manifestFile, name, value));
     }
     for (const entry of state.entries) {
         if (entry.versionCheck?.status === 'needs-bump' && entry.resolvedVersion) {
@@ -266,7 +319,7 @@ async function writeManifestEdits(state) {
         if (!failed)
             continue;
         const missing = edits.slice(failed.index);
-        // Only the version matters to the next publish: it asks for missing tags and tools again.
+        // Only the version matters to the next publish: it fills missing tags and tools again.
         const again = missing.some((e) => e.field === 'version') ? ' before you publish it again' : '';
         unwritten.push(`The PR is open, but ${path} wasn't updated (${errorMessage(failed.error)}): set ${missing.map((e) => `"${e.field}" to ${JSON.stringify(e.value)}`).join(', ')}${again}.`);
     }
@@ -275,29 +328,45 @@ async function writeManifestEdits(state) {
 // ---------------------------------------------------------------------------
 // Steps, one per phase that waits on work
 // ---------------------------------------------------------------------------
+/**
+ * The installed asset's files, at their source paths, through a raw publish's metadata step,
+ * with the version, entrypoint, dependencies, org and description its lockfile entry records.
+ */
 const resolvingInstalled = {
     async run(state, ctx) {
         const source = await findInstalledSource(state, ctx);
         if (!source)
             return;
         const { adapter, installed, projectRoot } = source;
-        // Copy the installed files into a temp directory, preserving their source paths
-        const tempDir = await stageInstalledFiles(installed, adapter, projectRoot);
-        ctx.stage(tempDir);
-        if (ctx.cancelled())
-            return;
-        // Generate manifest.json in the temp dir
-        const manifest = {
-            author: 'unknown',
-            description: `Published from installed asset ${installed.name}`,
-            entrypoint: installed.files[0]?.sourcePath ?? 'index.md',
+        const { files } = resolveInstalledPaths(installed, adapter, projectRoot);
+        // An older lockfile entry has no entrypoint: the type's usual one when it was installed, else its first file.
+        const usual = getEntrypointName(installed.type, installed.name);
+        const entrypoint = installed.entrypoint ?? (files.some((file) => file.sourcePath === usual) ? usual : files[0]?.sourcePath);
+        const dependencies = (installed.dependencies ?? []).map(({ name, type, version }) => ({
+            name,
+            type,
+            ...(version ? { version } : {}),
+        }));
+        const detection = {
+            assetType: installed.type,
+            ...(dependencies.length > 0 ? { dependencies } : {}),
+            ...(entrypoint ? { entrypoint } : {}),
+            files: files.map((file) => ({
+                absolutePath: join(projectRoot, file.installedPath),
+                relativePath: file.sourcePath,
+            })),
             name: installed.name,
-            ...(installed.org ? { org: installed.org } : {}),
-            type: installed.type,
+            sourceDir: projectRoot,
             version: installed.version,
         };
-        await writeFile(join(tempDir, 'manifest.json'), JSON.stringify(manifest, null, 2) + '\n', 'utf-8');
-        ctx.dispatch({ resolvedPath: tempDir, type: 'RESOLVED_INSTALLED' });
+        // A --with folder that is missing, a bundle or a repeat fails here, before any prompt, as in detecting.
+        if (state.flags.withPaths?.length) {
+            const entries = await loadPublishEntries(state.flags.withPaths, projectRoot);
+            if (ctx.cancelled())
+                return;
+            ctx.dispatch({ entries, type: 'ENTRIES_LOADED' });
+        }
+        await gatherRawMetadata(state, ctx, detection, { description: installed.description, org: installed.org });
     },
 };
 const resolvingUpdate = {
@@ -396,66 +465,11 @@ const detecting = {
         const detection = await detectAssetFromPath(state.resolvedPath, adapter, projectRoot);
         if (ctx.cancelled())
             return;
-        // Pre-fill metadata
-        const author = (await getSignedInUserName()) ?? '';
-        if (ctx.cancelled())
-            return;
+        // No manifest exists yet, so the project's org and the flags and prompts give the metadata.
         const lockfile = await readLockfile(projectRoot);
         if (ctx.cancelled())
             return;
-        const tools = await detectCompatibleTools(detection.assetType);
-        if (ctx.cancelled())
-            return;
-        // Non-interactive mode (raw publish — no manifest exists yet, so the only
-        // sources for description are --description flag or exit-1; tags come from
-        // --tags or default to empty). Tool detection runs for both modes above.
-        if (!state.nonInteractive) {
-            // Interactive mode — gather metadata from the user
-            ctx.dispatch({
-                authorValue: author,
-                orgValue: lockfile.org ?? '',
-                rawDetection: detection,
-                toolsDetected: tools,
-                type: 'RAW_DETECT_DONE',
-            });
-            return;
-        }
-        if (!state.flags.descriptionFlag) {
-            ctx.dispatch({
-                message: 'description required: provide --description or include in manifest.json',
-                type: 'ERROR',
-            });
-            return;
-        }
-        // Tools resolution: --tools flag -> detected (already populated above)
-        let toolsList;
-        if (state.flags.toolsFlag) {
-            toolsList = splitList(state.flags.toolsFlag);
-        }
-        else if (tools.length > 0) {
-            toolsList = tools;
-        }
-        else {
-            ctx.dispatch({
-                message: `--tools <comma-separated> required: no tools detected for type ${detection.assetType}`,
-                type: 'ERROR',
-            });
-            return;
-        }
-        const stagingDir = await buildStagingArea(detection, {
-            author,
-            description: state.flags.descriptionFlag,
-            ...(lockfile.org ? { org: lockfile.org } : {}),
-            tags: splitList(state.flags.tagsFlag),
-            tools: toolsList,
-        });
-        ctx.stage(stagingDir);
-        if (ctx.cancelled())
-            return;
-        const detected = await detectPublishType(stagingDir);
-        if (ctx.cancelled())
-            return;
-        ctx.dispatch({ rawDetection: detection, target: detected, type: 'RAW_DETECT_DONE_NON_INTERACTIVE' });
+        await gatherRawMetadata(state, ctx, detection, { org: lockfile.org });
     },
 };
 /** The `building-staging` sub-phase of `gathering-metadata`: the manifest from the prompts' answers. */
@@ -536,14 +550,13 @@ const validating = {
     },
 };
 /**
- * In interactive mode, loads adapters for the multi-select prompt. In non-interactive
- * mode, resolves tools via manifest -> --tools flag -> detectCompatibleTools(assetType)
- * -> exit 1, then dispatches RESOLVE_TOOLS_NONINTERACTIVE to advance directly to
- * checking-registry.
+ * In interactive mode without --tools, loads adapters for the multi-select prompt. Otherwise
+ * resolves tools via manifest -> --tools flag -> detectCompatibleTools(assetType) -> exit 1,
+ * then dispatches RESOLVE_TOOLS_NONINTERACTIVE to advance past the prompt.
  */
 const loadingTools = {
     async run(state, ctx) {
-        if (!state.nonInteractive) {
+        if (!state.nonInteractive && !state.flags.toolsFlag) {
             const adapters = await loadAllAdapters();
             if (ctx.cancelled())
                 return;
@@ -825,19 +838,23 @@ export function publishReducer(state, action) {
         case 'PUBLISH_PROGRESS':
             return { ...state, progressMessage: action.message };
         case 'RAW_DETECT_DONE':
+            // Ask only for what neither a flag nor the installed asset gave.
             return {
                 ...state,
                 authorValue: action.authorValue,
-                isRawPublish: true,
+                descriptionValue: action.description ?? '',
+                isRawPublish: !state.flags.fromInstalled,
+                metadataSubPhase: action.description === undefined ? 'description' : metadataAfterDescription(state),
                 orgValue: action.orgValue,
                 phase: 'gathering-metadata',
                 rawDetection: action.rawDetection,
+                tagsValue: state.flags.tagsFlag ?? '',
                 toolsDetected: action.toolsDetected,
             };
         case 'RAW_DETECT_DONE_NON_INTERACTIVE':
             return {
                 ...state,
-                isRawPublish: true,
+                isRawPublish: !state.flags.fromInstalled,
                 phase: 'validating',
                 rawDetection: action.rawDetection,
                 target: action.target,
@@ -857,34 +874,32 @@ export function publishReducer(state, action) {
             }
             else {
                 // needs-bump
-                if (state.nonInteractive) {
-                    if (state.flags.bump && state.target) {
-                        // Auto-bump using the flag value; a successful publish writes it to the manifest
-                        try {
-                            bumpedVersion = bumpVersion(versionCheck.latestVersion, state.flags.bump);
-                            bumpedTarget = {
-                                ...state.target,
-                                data: { ...state.target.data, version: bumpedVersion },
-                            };
-                            nextPhase = 'building-plan';
-                        }
-                        catch {
-                            errorMessage = 'Failed to compute bumped version.';
-                            nextPhase = 'error';
-                        }
-                    }
-                    else if (isBatch(state.flags)) {
-                        // advanceToPlan lists every asset of the batch that needs --bump, once the entries are checked.
+                if (state.flags.bump && state.target) {
+                    // --bump applies in any run; a successful publish writes it to the manifest
+                    try {
+                        bumpedVersion = bumpVersion(versionCheck.latestVersion, state.flags.bump);
+                        bumpedTarget = {
+                            ...state.target,
+                            data: { ...state.target.data, version: bumpedVersion },
+                        };
                         nextPhase = 'building-plan';
                     }
-                    else {
-                        errorMessage = `--bump <patch|minor|major> required: registry has v${versionCheck.latestVersion} but manifest is not newer`;
+                    catch {
+                        errorMessage = 'Failed to compute bumped version.';
                         nextPhase = 'error';
                     }
                 }
-                else {
+                else if (!state.nonInteractive) {
                     nextPhase = 'bump-prompt';
                 }
+                else if (isBatch(state.flags)) {
+                    // advanceToPlan lists every asset of the batch that needs --bump, once the entries are checked.
+                    nextPhase = 'building-plan';
+                }
+                else {
+                    errorMessage = `--bump <patch|minor|major> required: registry has v${versionCheck.latestVersion} but manifest is not newer`;
+                    nextPhase = 'error';
+                }
             }
             const checked = {
                 ...state,
@@ -907,16 +922,11 @@ export function publishReducer(state, action) {
                 : undefined;
             return {
                 ...state,
-                phase: 'checking-registry',
+                // An interactive run's --tools stood in for the tools prompt; the reviewer prompt may still follow.
+                phase: state.nonInteractive ? 'checking-registry' : phaseAfterMetadata(updatedTarget),
                 target: updatedTarget,
             };
         }
-        case 'RESOLVED_INSTALLED':
-            return {
-                ...state,
-                phase: 'detecting',
-                resolvedPath: action.resolvedPath,
-            };
         case 'RESOLVED_UPDATE':
             return {
                 ...state,
@@ -999,7 +1009,7 @@ export function publishReducer(state, action) {
             return {
                 ...state,
                 descriptionValue: trimmed,
-                metadataSubPhase: 'tags',
+                metadataSubPhase: metadataAfterDescription(state),
             };
         }
         case 'SUBMIT_PROMPT_TAGS': {
@@ -1107,19 +1117,21 @@ export function publishReducer(state, action) {
                     validation: action.validation,
                 };
             }
-            // Non-interactive path: resolve tags from --tags flag (or empty) right here, then
-            // either route to loading-tools (effect resolves tools async) or directly to
-            // checking-registry. Manifest tags always win when present. The reviewer prompt
-            // never applies here — non-interactive mode always skips it.
+            // A manifest without tags takes them from --tags right here, in any run: a non-interactive
+            // one without the flag publishes none, an interactive one asks. Manifest tags always win.
+            const tagsFromFlag = !hasTags && (state.nonInteractive || state.flags.tagsFlag !== undefined);
+            let nextTarget = state.target;
+            if (tagsFromFlag && nextTarget) {
+                const flagTags = splitList(state.flags.tagsFlag);
+                nextTarget = {
+                    ...nextTarget,
+                    data: { ...nextTarget.data, tags: flagTags.length > 0 ? flagTags : undefined },
+                };
+            }
+            // Non-interactive path: either route to loading-tools (effect resolves tools async) or
+            // directly to checking-registry. The reviewer prompt never applies here — non-interactive
+            // mode always skips it.
             if (state.nonInteractive) {
-                let nextTarget = state.target;
-                if (!hasTags && nextTarget) {
-                    const flagTags = splitList(state.flags.tagsFlag);
-                    nextTarget = {
-                        ...nextTarget,
-                        data: { ...nextTarget.data, tags: flagTags.length > 0 ? flagTags : undefined },
-                    };
-                }
                 let nextPhase;
                 if (!hasTools) {
                     // The loading-tools effect detects whether we're non-interactive and
@@ -1138,7 +1150,7 @@ export function publishReducer(state, action) {
                 };
             }
             let nextPhase;
-            if (!hasTags) {
+            if (!hasTags && !tagsFromFlag) {
                 nextPhase = 'prompting-tags';
             }
             else if (!hasTools) {
@@ -1151,6 +1163,7 @@ export function publishReducer(state, action) {
                 ...state,
                 phase: nextPhase,
                 reviewerValue,
+                target: nextTarget,
                 validation: action.validation,
             };
         }
@@ -1161,7 +1174,7 @@ export function publishReducer(state, action) {
 /**
  * The step before `building-plan`, once the root asset's own checks are done:
  * check the entries not yet checked, then settle each entry that needs a bump
- * (the bump prompt; `--bump` or an error when non-interactive), then plan.
+ * (`--bump`; without it, the bump prompt, or an error when non-interactive), then plan.
  */
 function advanceToPlan(state) {
     if (state.entries.some((entry) => !entry.versionCheck)) {
@@ -1191,18 +1204,17 @@ function advanceToPlan(state) {
     if (entry?.versionCheck?.status !== 'needs-bump') {
         return { ...state, bumpEntry: undefined, phase: 'building-plan' };
     }
+    if (state.flags.bump) {
+        return bumpEntryAt(state, index, state.flags.bump);
+    }
     if (!state.nonInteractive) {
         return { ...state, bumpEntry: index, bumpSelection: '', phase: 'bump-prompt' };
     }
-    const { latestVersion } = entry.versionCheck;
-    if (!state.flags.bump) {
-        return {
-            ...state,
-            errorMessage: `--bump <patch|minor|major> required: registry has v${latestVersion} of ${entry.target.assetType}:${entry.target.data.name} (from ${entry.label}) but its manifest is not newer`,
-            phase: 'error',
-        };
-    }
-    return bumpEntryAt(state, index, state.flags.bump);
+    return {
+        ...state,
+        errorMessage: `--bump <patch|minor|major> required: registry has v${entry.versionCheck.latestVersion} of ${entry.target.assetType}:${entry.target.data.name} (from ${entry.label}) but its manifest is not newer`,
+        phase: 'error',
+    };
 }
 /**
  * Bump the entry at `index` from its registry version, then go on toward the
@@ -1221,6 +1233,10 @@ function bumpEntryAt(state, index, bump) {
     }
     return advanceToPlan({ ...state, entries: replaceEntry(state.entries, index, withVersion(entry, version)) });
 }
+/** A raw publish's step after its description: the tags prompt, unless --tags answered it. */
+function metadataAfterDescription(state) {
+    return state.flags.tagsFlag === undefined ? 'tags' : 'building-staging';
+}
 /**
  * Phase to enter once the tags/tools metadata prompts are resolved: org-scoped
  * targets get the reviewer prompt, everything else proceeds to the registry check.