@vsf-enterprise/storefront-cli

3.0.0

Major Changes

• CHANGED Guarantee compatibility with @alokai/connect package.
• CHANGED create command. Now it uses @alokai/ecosystem package to create a project
• CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

• Upgraded to the latest version of Node.js 22
• Updated CI pipelines to use Node.js 22 for consistency.
• Updated .nvmrc or .node-version files to specify Node.js version 22.14.
• Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

• Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
• While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested. [FIX] extensions of CLI bin scripts CHANGED Replaced core dependencies with a new @alokai/connect package. @vue-storefront/middleware, @vue-storefront/sdk, vue-storefront/logger, vue-storefront/unified-data-model, @vue-storefront/multistore were replaced with @alokai/connect. The replacement preserves the same functionality and interface as the original packages. To read more about the @alokai/connect package, please refer to the documentation.

[FIX] Build output and command generation for the storefront-cli

• CHANGED add-module command uses @alokai/ecosystem version to install the module

Minor Changes

ADDED The --store-id flag for the add-module command. This flag can be used to specify which store you want to install a module to. Usage example: @vsf-enterprise/storefront-cli add-module --store-id my-test-store quick-order.

• CHANGED Update MODULES_CONFIG_PATH in storefront-cli to packages-modules

Patch Changes

[FIX] change output dir from lib to dist [FIX] sync code with recent changes

• ADDED "get-port-please" and "defu" packages has been added to dependencies [CHANGE] isVSFMiddlewareInProject detects @alokai/connect instead of @vue-storefront/middleware
• FIXED Renaming .template files in node_modules
• FIXED Add missing tiny-exec dep
• FIXED Remove framework files on cleanup step
• FIXED Generated projects for @alokai/ecosystem, which are ignored by the npm pack command such as .gitignore, .npmrc receive right now a .template suffix in file name. This suffix is then removed by the @vsf-enterprise/storefront-cli create command.
• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0

3.0.0-rc.17

Patch Changes

• FIXED Renaming .template files in node_modules

3.0.0-rc.16

Patch Changes

• FIXED Generated projects for @alokai/ecosystem, which are ignored by the npm pack command such as .gitignore, .npmrc receive right now a .template suffix in file name. This suffix is then removed by the @vsf-enterprise/storefront-cli create command.

3.0.0-rc.15

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.8

3.0.0-rc.14

Patch Changes

• FIXED Add missing tiny-exec dep

3.0.0-rc.13

Patch Changes

• ADDED "get-port-please" and "defu" packages has been added to dependencies

3.0.0-rc.12

Patch Changes

• FIXED Remove framework files on cleanup step

3.0.0-rc.11

Major Changes

• CHANGED create command. Now it uses @alokai/ecosystem package to create a project
• CHANGED add-module command uses @alokai/ecosystem version to install the module

Minor Changes

ADDED The --store-id flag for the add-module command. This flag can be used to specify which store you want to install a module to. Usage example: @vsf-enterprise/storefront-cli add-module --store-id my-test-store quick-order.

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.7

3.0.0-rc.10

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.6

3.0.0-rc.9

Major Changes

• CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

• Upgraded to the latest version of Node.js 22
• Updated CI pipelines to use Node.js 22 for consistency.
• Updated .nvmrc or .node-version files to specify Node.js version 22.14.
• Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

• Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
• While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.5

3.0.0-rc.8

Minor Changes

• CHANGED Update MODULES_CONFIG_PATH in storefront-cli to packages-modules

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.4

3.0.0-rc.7

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.3

3.0.0-rc.6

Patch Changes

[CHANGE] isVSFMiddlewareInProject detects @alokai/connect instead of @vue-storefront/middleware

3.0.0-rc.5

Patch Changes

[FIX] sync code with recent changes

3.0.0-rc.4

Patch Changes

[FIX] change output dir from lib to dist

3.0.0-rc.3

Major Changes

[FIX] extensions of CLI bin scripts

3.0.0-rc.2

Major Changes

[FIX] Build output and command generation for the storefront-cli

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.2

3.0.0-rc.1

Major Changes

Update packages to work with connect rc version Fix builds

Patch Changes

• Updated dependencies:
  • @vsf-enterprise/module-kit@3.0.0-rc.1

3.0.0-rc.0

Major Changes

Replace legacy packages with a connect package

2.1.0

Minor Changes

• ADDED: The consoleProjectName and cloudRegion flags in CLI create command. They allows to define Console's project name and selected Cloud region in alokai.config.json during the project bootstrapping. CHANGED: Moved all multistore related functionalities to the @alokai/cli CHANGED: Renamed the --inheritance-only flag to --template.

Patch Changes

• FIXED: Bug during create that blocks the process

2.1.0-rc.2

Patch Changes

• FIXED: Bug during create that blocks the process

2.1.0-rc.1

Minor Changes

CHANGED: Renamed the --inheritance-only flag to --template.

2.1.0-rc.0

Minor Changes

CHANGED: Moved all multistore related functionalities to the @alokai/cli

2.0.3

Patch Changes

• [UPDATED] @vsf-enterprise/module-kit version bump

2.0.2

Patch Changes

• FIXED add-module --release flag expects a string value instead of a numeric one.

2.0.1

Patch Changes

• CHANGED removed leftovers of deprecated --candidate flag

2.0.0

Major Changes

• CHANGED BREAKING --release flag now requires you to pass semver-compliant version

- @vsf-enterprise/storefront-cli create -r 27
+ @vsf-enterprise/storefront-cli create -r 1.2.1

If you wish to use CLI storefront version released before semver versioning was added - use older CLI. For example @vsf-enterprise/storefront-cli version 1.29.12

@vsf-enterprise/storefront-cli@1.29.12 create -r 27

• REMOVED BREAKING removed --candidate flag

- @vsf-enterprise/storefront-cli create -r 27 -c
+ @vsf-enterprise/storefront-cli create -r 1.2.1-rc

Minor Changes

• ADDED Support for custom Storefront schema scripts for the create command.

Patch Changes

• CHANGED - update @vsf-enterprise/sdk package to 3.4.1

2.0.0-rc.0

Major Changes

• CHANGED BREAKING --release flag now requires you to pass semver-compliant version

- @vsf-enterprise/storefront-cli create -r 27
+ @vsf-enterprise/storefront-cli create -r 1.2.1

If you wish to use CLI storefront version released before semver versioning was added - use older CLI. For example @vsf-enterprise/storefront-cli version 1.29.12

@vsf-enterprise/storefront-cli@1.29.12 create -r 27

• REMOVED BREAKING removed --candidate flag

- @vsf-enterprise/storefront-cli create -r 27 -c
+ @vsf-enterprise/storefront-cli create -r 1.2.1-rc

Minor Changes

• ADDED Support for custom Storefront schema scripts for the create command.

1.30.0

Minor Changes

Added support for AI contexts

Patch Changes

FIXED --ref-module flag was not working. Now it's properly used to fetch module metadata details & content.

1.29.12

Patch Changes

• REMOVED .github/actions folder from the generated storefront, as it contained redundant files.

1.29.11

Patch Changes

• CHANGED - update @vsf-enterprise/module-kit package to 1.3.1

1.29.10

Patch Changes

• CHANGED updated @vsf-enterprise/module-kit package to 1.3.0 which enables modules support for commercetools

1.29.9

Patch Changes

ADDED: --force optional boolean flag to force project generation when running the create command.

npx @vsf-enterprise/storefront-cli create "generated-project" -f nextjs -e sapcc --force

ADDED: --modules (-m) optional boolean flag to install recommended modules when running the create command. Default: true.

npx @vsf-enterprise/storefront-cli create "generated-project" -f nextjs -e sapcc --modules

Skip recommended modules installation when creating a new project

npx @vsf-enterprise/storefront-cli create "generated-project" -f nextjs -e sapcc --no-modules

ADDED: --force optional boolean flag to force module installation when running the add-module command.

npx @vsf-enterprise/storefront-cli add-module checkout -e sapcc --force

1.29.8

Patch Changes

• CHANGED Gitguardian parts removed after creating project with cleanup phase.

1.29.7

Patch Changes

• FIXED CLI cannot find a compatible module FIXED: Stop CLI from adding config.ts in Playwright setup in releases above Sprint-24. Now Playwright config is declared directly in the storefront codebase - no need to generate it via CLI.

1.29.6

Patch Changes

FIXED: The module installation process has been improved. The CLI now checks which frameworks are supported by a given module and installs it only in those that are available both in the module and the project.

1.29.5

Patch Changes

• FIXED: Running all schemas for given framework in modules dev mode

1.29.4

Patch Changes

• REMOVED Checkout pages are removed for release-24 and onwards

1.29.3

Patch Changes

Updated dependencies: @vsf-enterprise/module-kit@1.0.5

1.29.2

Patch Changes

• FIXED show module id when commerce is not supported

1.29.1

Patch Changes

• FIXED Create /tmp/vsf-module if it doesn't exist.

1.29.0

Minor Changes

• ADDED Support for modules for other commerces than sapcc

1.28.2

Patch Changes

• FIXED Remove only unused frontend frameworks on project create finish.

1.28.1

Patch Changes

• FIXED Finding latest release when -c flag provided

1.28.0

Minor Changes

• ADDED Support for new modules structure and the module installation scripts.
• CHANGED Move all storefront subdependencies to @vsf-enterprise/module-kit package.
• ADDED Debug mode. Now you can enable it by setting DEBUG env variable to storefront-cli or *. For more info, consult docs.

DEBUG=storefront-cli npx @vsf-enterprise/storefront-cli <COMMAND>

1.27.0

Minor Changes

• REMOVED Option to copy RenderComponent component from the CMS modules (as a CMS wrapper).

Example for the Contentful Module, file (packages/storefront-cli/src/utils/setupProjectForModules/schemas/cms-contentful.ts):

- {
-   from: `${path.join(paths.modulesDir, "cms-contentful", "components", "RenderComponent", "RenderComponent.vue")}`,
-   to: `${path.join(paths.appRoot, "components", "cms", "wrappers")}`,
- },

1.26.1

Patch Changes

• FIXED race condition during cleanup, improve and fix cleanup docker files and playwright, add missing checkout-b2b installation scripts

1.26.0

Minor Changes

• ADDED Installation script for cms-contentstack module

1.25.1

Patch Changes

• FIXED Added missing schema for Builder.io + Next.js

1.25.0

Minor Changes

• ADDED Posibility to use CLI in dev mode

1.24.0

Minor Changes

• ADDED schemas for cms-amplience and cms-builderio modules

1.23.0

Minor Changes

• ADDED support for new modules structure
• FIXED release version autoselect for add-module command

1.22.0

Minor Changes

• ADDED Auto bootstrapping for cms-contentful module for Nuxt

1.21.1

Patch Changes

• FIXED Updated code after introducing cms-mock to the unified-storefront-demo

1.21.0

Minor Changes

• ADDED Support for cms-contentful package
• CHANGED add-module command is now using @vsf-enterprise/project-modifier in the implementation

1.20.4

Patch Changes

• FIXED Change placement of script for updating engines node property in package.json in CLI package due to none existing file on "postinstall"

1.20.3

Patch Changes

• FIXED Update engines node version in package.json

1.20.2

Patch Changes

• FIXED fetching continuous delivery file

1.20.1

Patch Changes

• FIXED fetching continous delivery script from proper release

1.20.0

Minor Changes

add possibility to specify git refs to fetch the unified or modules codebase from

Patch Changes

• FIXED setup a powertools product catalog for sap b2b store

1.19.0

Minor Changes

• ADDED method overrides and normalizers generation

1.18.3

Patch Changes

• FIXED generating sap b2b store

1.18.2

Patch Changes

update faulty file-modifier version

1.18.1

Patch Changes

add missing dependencies to package.json

1.18.0

Minor Changes

add automated checkout modules installation

1.17.0

Minor Changes

add --release and --candidate flags to @vsf-enteprise/storefront-cli add-module command

1.16.1

Patch Changes

• FIXED Cleanup redundant files in storefront-middleware and dependencies in package.json
• FIXED Removed redundant scripts from root package.json
• FIXED Removed redundant -<commerce> suffix in package.json version

1.16.0

Minor Changes

• CHANGED Removed the --latest flag. Introduced conditional cleanup operations depending on generated storefront version.

1.15.0

Minor Changes

• CHANGED CLI adjusted to the recent Middleware changes (i.e. removing the config directory).

1.14.1

Patch Changes

CLI now takes "release" and "candidate" flags into account when installing modules during storefront creation 🚀

1.14.0

Minor Changes

Fixed zod schema validation error while selecting sapcc-b2b as ecommerce.

1.13.0

Minor Changes

Users can generate projects from candidate releases using the --candidate (-c) flag.

1.12.1

Patch Changes

• ADDED Exported to the unifiedApiExtension.
• ADDED Export of the UnifiedEndpoints type from middleware.config.ts file.

1.12.0

Minor Changes

Added --release (-r) flag allowing to create a project from a specific storefront release

Patch Changes

• FIXED displaying size filters as a FilterSize component in de language.

1.11.0

Minor Changes

FIXED missing categories after changing language.

1.10.0

Minor Changes

Added the --dependencies (-d) flag to the create command allowing to opt-out of installing packages after creating a new project.

1.9.0

Minor Changes

• a48d94e: ADDED Downloading modules based on latest released. latest flag is respected when modules are installed with create and added for add-module.

1.8.3

Patch Changes

• bcd9880: FIXED continuous-delivery.yml file is generated for all framework / ecommerce configurations.

1.8.2

Patch Changes

• c2fbcbf: FIXED wrong detection of existing storefront project while using add-module command, previously while using this command error Error: Unable to verify if project is a Alokai project. was displayed. After change there is no error and project is found correctly.

1.8.1

Patch Changes

• 9a6e0ff: fix CLI error with not existing directory

1.8.0

Minor Changes

• 466ec10: ADDED Unified Adobe Commerce (Magento 2) boilerplate support.

1.7.1

Patch Changes

• b377337: FIXED SAPCC project initialization FIXED Prerequisite for adding modules - we no longer check for the existance of @vue-storefront/unified-data-model in the root package.json, we check @vue-storefront/middleware instead

1.7.0

Minor Changes

• 244d6fa: Support SAP B2B initialization and install recommended modules instalation

Patch Changes

• c27d055: Always use path.join for path handling

1.6.4

Patch Changes

• 76943cc: Added a print out when latest tag was used, specifying that current main branch is used

1.6.3

Patch Changes

• 9c8aa7c: Remove the default @vsf-enterprise/algolia-api after introducing the Unified Algolia integration

1.6.2

Patch Changes

• 459d20a: Update middleware config template.

1.6.1

Patch Changes

• 19836ae: CLI create command update

1.6.0

Minor Changes

• 51a1014: Install modules for SAP commerce and handle modules installation for ecommerce platforms

1.4.1

Patch Changes

• 65e0806: Remove gguardian check from pre-commit hooks

1.4.0

Minor Changes

• 62cbfd70: Added SFCC as available e-commerce integration

1.3.0

Minor Changes

• 82d7ae2a: Created demo uses updated continuous-delivery.yml file

1.2.0

Minor Changes

• Added an initial commit to create command. This commit will be used as a base for the next changes.

  As a consequence, now after running npx @vsf-enterprise/storefront-cli create you will see an initial commit in your repository.

1.1.0

Minor Changes

• Added arguments to be able to install a single module with command

1.0.0

Major Changes

• Add module CLI command can install modules

0.0.4

Patch Changes

• Fix "Cannot find package 'prompts'" error

0.0.3

Patch Changes

• Fix Cannot find package 'isomorphic-git' issue