feat(cli): allow storyblok create to use an existing space #385
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,29 @@ import { mapiClient } from '../../api'; | |
| import type { User } from '../user/actions'; | ||
| import { getUser } from '../user/actions'; | ||
|
|
||
| // Helper to show next steps and project ready message | ||
| function showNextSteps(technologyTemplate: string, finalProjectPath: string) { | ||
| konsola.br(); | ||
| konsola.ok(`Your ${chalk.hex(colorPalette.PRIMARY)(technologyTemplate)} project is ready 🎉 !`); | ||
| konsola.br(); | ||
| konsola.info(`Next steps:\n cd ${finalProjectPath}\n npm install\n npm run dev\n `); | ||
| konsola.info(`Or check the dedicated guide at: ${chalk.hex(colorPalette.PRIMARY)(`https://www.storyblok.com/docs/guides/${technologyTemplate}`)}`); | ||
| } | ||
|
|
||
| // Helper to create .env file and handle errors | ||
| async function handleEnvFileCreation(resolvedPath: string, token: string) { | ||
| try { | ||
| await createEnvFile(resolvedPath, token); | ||
| konsola.ok(`Created .env file with Storyblok access token`, true); | ||
| return true; | ||
| } | ||
| catch (error) { | ||
| konsola.warn(`Failed to create .env file: ${(error as Error).message}`); | ||
| konsola.info(`You can manually add this token to your .env file: ${token}`); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| const program = getProgram(); // Get the shared singleton instance | ||
|
|
||
| // Create root command | ||
|
|
@@ -23,12 +46,13 @@ export const createCommand = program | |
| .option('-t, --template <template>', 'technology starter template') | ||
| .option('-b, --blueprint <blueprint>', '[DEPRECATED] use --template instead') | ||
| .option('--skip-space', 'skip space creation') | ||
| .option('--key <key>', 'Storyblok access token (skip space creation and use this token)') | ||
|
||
| .action(async (projectPath: string, options: CreateOptions) => { | ||
| konsola.title(`${commands.CREATE}`, colorPalette.CREATE); | ||
| // Global options | ||
| const verbose = program.opts().verbose; | ||
| // Command options - handle backward compatibility | ||
| const { template, blueprint, key } = options; | ||
|
|
||
| // Handle deprecated blueprint option | ||
| let selectedTemplate = template; | ||
|
|
@@ -64,21 +88,6 @@ export const createCommand = program | |
| verbose: !isVitest, | ||
| }); | ||
|
|
||
| try { | ||
| spinnerBlueprints.start('Fetching starter templates...'); | ||
| const templates = await fetchBlueprintRepositories(); | ||
|
|
@@ -148,107 +157,118 @@ export const createCommand = program | |
| await generateProject(technologyTemplate!, projectName, targetDirectory); | ||
| konsola.ok(`Project ${chalk.hex(colorPalette.PRIMARY)(projectName)} created successfully in ${chalk.hex(colorPalette.PRIMARY)(finalProjectPath)}`, true); | ||
|
|
||
| // If key is provided, use it as the access token, skip space creation, and update env | ||
| let createdSpace; | ||
| let userData: User; | ||
| let whereToCreateSpace = 'personal'; | ||
| if (key) { | ||
| await handleEnvFileCreation(resolvedPath, key); | ||
| showNextSteps(technologyTemplate!, finalProjectPath); | ||
| return; | ||
| } | ||
| if (options.skipSpace) { | ||
| showNextSteps(technologyTemplate!, finalProjectPath); | ||
| return; | ||
| } | ||
| try { | ||
| try { | ||
| const user = await getUser(password, region); | ||
| if (!user) { | ||
| throw new Error('User data is undefined'); | ||
| } | ||
| userData = user; | ||
| } | ||
| catch (error) { | ||
| konsola.error('Failed to fetch user info. Please login again.', error); | ||
| konsola.br(); | ||
| return; | ||
| } | ||
|
|
||
| // Prepare choices for space creation | ||
| const choices = [ | ||
| { name: 'My personal account', value: 'personal' }, | ||
| ]; | ||
| if (userData.has_org) { | ||
| choices.push({ name: `Organization (${userData?.org?.name})`, value: 'org' }); | ||
| } | ||
| if (userData.has_partner) { | ||
| choices.push({ name: 'Partner Portal', value: 'partner' }); | ||
| } | ||
|
|
||
| if (region === 'eu' && (userData.has_partner || userData.has_org)) { | ||
| whereToCreateSpace = await select({ | ||
| message: `Where would you like to create this space?`, | ||
| choices, | ||
| }); | ||
| } | ||
| if (region !== 'eu' && userData.has_org) { | ||
|
||
| whereToCreateSpace = 'org'; | ||
| } | ||
| if (region !== 'eu' && !userData.has_org) { | ||
dipankarmaikap marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| konsola.warn(`Space creation in this region is limited to Enterprise accounts. If you're part of an organization, please ensure you have the required permissions. For more information about Enterprise access, contact our Sales Team.`); | ||
| konsola.br(); | ||
| return; | ||
| } | ||
|
|
||
| spinnerSpace.start(`Creating space "${toHumanReadable(projectName)}"`); | ||
|
|
||
| // Find the selected blueprint from the dynamic blueprints array | ||
| const selectedBlueprint = templates.find(bp => bp.value === technologyTemplate); | ||
| const blueprintDomain = selectedBlueprint?.location || 'https://localhost:3000/'; | ||
| const spaceToCreate: SpaceCreate = { | ||
| name: toHumanReadable(projectName), | ||
| domain: blueprintDomain, | ||
| }; | ||
| if (whereToCreateSpace === 'org') { | ||
| spaceToCreate.org = userData.org; | ||
| spaceToCreate.in_org = true; | ||
| } | ||
| else if (whereToCreateSpace === 'partner') { | ||
| spaceToCreate.assign_partner = true; | ||
| } | ||
| createdSpace = await createSpace(spaceToCreate); | ||
| spinnerSpace.succeed(`Space "${chalk.hex(colorPalette.PRIMARY)(toHumanReadable(projectName))}" created successfully`); | ||
|
|
||
| // Create .env file with the Storyblok token | ||
| if (createdSpace?.first_token) { | ||
| await handleEnvFileCreation(resolvedPath, createdSpace.first_token); | ||
| } | ||
|
|
||
| // Open the space in the browser | ||
| if (createdSpace?.id) { | ||
| try { | ||
| await openSpaceInBrowser(createdSpace.id, region); | ||
| konsola.info(`Opened space in your browser`); | ||
| } | ||
| catch (error) { | ||
| konsola.warn(`Failed to open browser: ${(error as Error).message}`); | ||
| const spaceUrl = generateSpaceUrl(createdSpace.id, region); | ||
| konsola.info(`You can manually open your space at: ${chalk.hex(colorPalette.PRIMARY)(spaceUrl)}`); | ||
| } | ||
| } | ||
|
|
||
| // Show next steps and space info | ||
| showNextSteps(technologyTemplate!, finalProjectPath); | ||
| if (createdSpace?.first_token) { | ||
| if (whereToCreateSpace === 'org') { | ||
| konsola.ok(`Storyblok space created in organization ${chalk.hex(colorPalette.PRIMARY)(userData?.org?.name)}, preview url and .env configured automatically. You can now open your space in the browser at ${chalk.hex(colorPalette.PRIMARY)(generateSpaceUrl(createdSpace.id, region))}`); | ||
| } | ||
| else if (whereToCreateSpace === 'partner') { | ||
| konsola.ok(`Storyblok space created in partner portal, preview url and .env configured automatically. You can now open your space in the browser at ${chalk.hex(colorPalette.PRIMARY)(generateSpaceUrl(createdSpace.id, region))}`); | ||
| } | ||
| else { | ||
| konsola.ok(`Storyblok space created, preview url and .env configured automatically. You can now open your space in the browser at ${chalk.hex(colorPalette.PRIMARY)(generateSpaceUrl(createdSpace.id, region))}`); | ||
| } | ||
| } | ||
| } | ||
| catch (error) { | ||
| spinnerSpace.failed(); | ||
| konsola.br(); | ||
| handleError(error as Error, verbose); | ||
| return; | ||
| } | ||
|
|
||
| // showNextSteps is already called in each relevant branch above; do not call it again here. | ||
| } | ||
| catch (error) { | ||
| spinnerSpace.failed(); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question(blocking):
@dipankarmaikap what do you think about naming it
token, oraccessToken? I know it used to be calledkey, but I believe those 2 are more descriptive and here we have a chance to improve the DX ;)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going with
token