packages/cli/cloud/src/link/action.ts - develop - githubmirror/strapi

packages/cli/cloud/src/link/action.ts
214 строк6 KB
kibwashere
chore: update cli deploy copies
29 июн 2026, 13:49
29 июн 2026, 13:49f0fa460
import chalk from 'chalk';

import type { Answers } from 'inquirer';
import type { CLIContext } from '../types';
import type { CloudApiService } from '../services/cli-api';

import { LocalSave } from '../services/strapi-info-save';
import { cloudApiFactory, tokenServiceFactory, local } from '../services';
import { promptLogin } from '../login/action';
import { trackEvent } from '../utils/analytics';
import { getLocalConfig } from '../utils/get-local-config';

const QUIT_OPTION = 'Quit';

interface LinkProjectValue {
  name: string;
  displayName: string;
}

interface LinkProjectAnswer extends Answers {
  linkProject: LinkProjectValue;
}

interface LinkProjectInput extends Answers {
  linkProject: LinkProjectValue | string;
}

type ProjectsList = {
  name: string;
  value: {
    name: string;
    displayName: string;
  };
}[];

type Project = {
  name: string;
  displayName: string;
  isMaintainer: boolean;
};

async function promptForRelink(
  ctx: CLIContext,
  cloudApiService: CloudApiService,
  existingConfig: LocalSave | null
) {
  if (existingConfig && existingConfig.project) {
    const { default: inquirer } = await import('inquirer');
    const { shouldRelink } = await inquirer.prompt([
      {
        type: 'confirm',
        name: 'shouldRelink',
        message: `A project named ${chalk.cyan(
          existingConfig.project.displayName
            ? existingConfig.project.displayName
            : existingConfig.project.name
        )} is already linked to this local folder. Do you want to update the link?`,
        default: false,
      },
    ]);

    if (!shouldRelink) {
      await trackEvent(ctx, cloudApiService, 'didNotLinkProject', {
        currentProjectName: existingConfig.project?.name,
      });
      return false;
    }
  }

  return true;
}

async function getProjectsList(
  ctx: CLIContext,
  cloudApiService: CloudApiService,
  existingConfig: LocalSave | null
) {
  const spinner = ctx.logger.spinner('Fetching your projects...\n').start();

  try {
    const {
      data: { data: projectList },
    } = await cloudApiService.listLinkProjects();
    spinner.succeed();

    if (!Array.isArray(projectList)) {
      ctx.logger.log(
        'No Cloud project found. To link a project, first create it via the Cloud dashboard (https://cloud.strapi.io).'
      );
      return null;
    }
    const projects: ProjectsList = (projectList as unknown as Project[])
      .filter(
        (project: Project) =>
          !(project.isMaintainer || project.name === existingConfig?.project?.name)
      )
      .map((project: Project) => {
        return {
          name: project.displayName,
          value: { name: project.name, displayName: project.displayName },
        };
      });
    if (projects.length === 0) {
      ctx.logger.log(
        'No Cloud project found. To link a project, first create it via the Cloud dashboard (https://cloud.strapi.io).'
      );
      return null;
    }
    return projects;
  } catch (e) {
    spinner.fail('An error occurred while fetching your projects from Strapi Cloud.');
    ctx.logger.debug('Failed to list projects', e);
    return null;
  }
}

async function getUserSelection(
  ctx: CLIContext,
  projects: ProjectsList
): Promise<LinkProjectAnswer | null> {
  const { logger } = ctx;
  try {
    const { default: inquirer } = await import('inquirer');
    const answer: LinkProjectInput = await inquirer.prompt([
      {
        type: 'list',
        name: 'linkProject',
        message: 'Which project do you want to link?',
        choices: [...projects, { name: chalk.grey(`(${QUIT_OPTION})`), value: null }],
      },
    ]);

    if (!answer.linkProject) {
      return null;
    }

    return answer as LinkProjectAnswer;
  } catch (e) {
    logger.debug('Failed to get user input', e);
    logger.error('An error occurred while trying to get your input.');
    return null;
  }
}

export default async (ctx: CLIContext) => {
  const { getValidToken } = await tokenServiceFactory(ctx);
  const token = await getValidToken(ctx, promptLogin);
  const { logger } = ctx;

  if (!token) {
    return;
  }

  const cloudApiService = await cloudApiFactory(ctx, token);

  const existingConfig: LocalSave | null = await getLocalConfig(ctx);
  const shouldRelink = await promptForRelink(ctx, cloudApiService, existingConfig);

  if (!shouldRelink) {
    return;
  }
  await trackEvent(ctx, cloudApiService, 'willLinkProject', {});

  const projects: ProjectsList | null | undefined = await getProjectsList(
    ctx,
    cloudApiService,
    existingConfig
  );

  if (!projects) {
    return;
  }

  const answer: LinkProjectAnswer | null = await getUserSelection(ctx, projects);

  if (!answer) {
    return;
  }

  try {
    const { default: inquirer } = await import('inquirer');
    const { confirmAction } = await inquirer.prompt([
      {
        type: 'confirm',
        name: 'confirmAction',
        message:
          'Warning: Once linked, deploying from CLI will replace the existing project and its data. Confirm to proceed:',
        default: false,
      },
    ]);

    if (!confirmAction) {
      await trackEvent(ctx, cloudApiService, 'didNotLinkProject', {
        cancelledProjectName: answer.linkProject.name,
        currentProjectName: existingConfig ? existingConfig.project?.name : null,
      });
      return;
    }

    await local.save({ project: answer.linkProject });
    logger.log(
      ` You have successfully linked your project to ${chalk.cyan(answer.linkProject.displayName)}. You are now able to deploy your project.`
    );
    await trackEvent(ctx, cloudApiService, 'didLinkProject', {
      projectInternalName: answer.linkProject,
    });
  } catch (e) {
    logger.debug('Failed to link project', e);
    logger.error('An error occurred while linking the project.');
    await trackEvent(ctx, cloudApiService, 'didNotLinkProject', {
      projectInternalName: answer.linkProject,
    });
  }
};