feat(cli): add an option to dump the model without any item id references.

Author: Plopix

components/cli/CHANGELOG.md

@@ -2,85 +2,119 @@
 
 All notable changes to this project will be documented in this file.
 
+## [5.10.0]
+
+- add an option to dump the model without any item id references.
+
+## [5.9.3]
+
+- bump libs and schema lib to 5.2.
+
+## [5.9.2]
+
+- bump libs and schema lib to 5.1.
+
+## [5.9.1]
+
+- added more errors on the serve command when authentication is failing.
+
+## [5.9.0]
+
+- piece name are now maintained in the content model dump.
+
+## [5.8.2]
+
+- move a log to a debug log.
+
+## [5.8.1]
+
+- allow relative path in bynary uploads.
+
+## [5.8.0]
+
+- update libs.
+- use new js-api-client.
+- handle file uploads in extra mutations.
+
 ## [5.7.6]
 
-- adds codes to messages that are streamed to FE while tenant is being updated with selected template
+- adds codes to messages that are streamed to FE while tenant is being updated with selected template.
 
 ## [5.7.5]
 
 - schema 4.0.0
-- compatible with Mass Operations for Customers
+- compatible with Mass Operations for Customers.
 
 ## [5.7.4]
 
-- replace all iteration of the placeholders in the install process
+- replace all iteration of the placeholders in the install process.
 
 ## [5.7.3]
 
-- Enable CORS
+- Enable CORS.
 
 ## [5.7.2]
 
-- Expose the Crystallize Env in the web server default response
+- Expose the Crystallize Env in the web server default response.
 
 ## [5.7.1]
 
-- simplify building
+- simplify building.
 
 ## [5.7.0]
 
-- expose the CLI enroll command
-- add the enroll command
+- expose the CLI enroll command.
+- add the enroll command.
 
 ## [5.6.0]
 
-- bumping libs
+- bumping libs.
 
 ## [5.5.0]
 
-- bump Bun version to 1.2.4
-- call the bashcompinit if complete does not exist in the shell for autocompletion
+- bump Bun version to 1.2.4.
+- call the bashcompinit if complete does not exist in the shell for autocompletion.
 
 ## [5.4.6]
 
-- really fixing typo introduced in 5.4.4
+- really fixing typo introduced in 5.4.4.
 
 ## [5.4.5]
 
-- fix typo introduced in 5.4.4
+- fix typo introduced in 5.4.4.
 
 ## [5.4.4]
 
-- adding the product configurator boilerplate
-- a bit more messages on the install trace
+- adding the product configurator boilerplate.
+- a bit more messages on the install trace.
 
 ## [5.4.3]
 
-- fix the completion file
-- add documentation
-- add doc command
+- fix the completion file.
+- add documentation.
+- add doc command.
 
 ## [5.4.2]
 
-- add the Furnitut boilerplate
+- add the Furnitut boilerplate.
 
 ## [5.4.1]
 
-- Fix duplicates in the content model dump
+- Fix duplicates in the content model dump.
 
 ## [5.4.0]
 
-- add a command to upload assets
-- add a command to execute mutations with dependencies
+- add a command to upload assets.
+- add a command to execute mutations with dependencies.
 
 ## [5.3.0]
 
-- fix tenantId that was not setup on the .env file after installation
-- add discovery api tenant ignition
+- fix tenantId that was not setup on the .env file after installation.
+- add discovery api tenant ignition.
 
 ## [5.2.2]
 
-- fix bug introduced in the 5.2.1 for tenant create command
+- fix bug introduced in the 5.2.1 for tenant create command.
 
 ## [5.2.1]
 
@@ -91,7 +125,7 @@ All notable changes to this project will be documented in this file.
 ### Added
 
 - new boilerplates
-- dump content model as Mass Operations
+- dump content model as Mass Operations.
 - create invite(s) command.
 - get Shop Auth token command.
 - get Static Auth token command.
@@ -108,17 +142,17 @@ All notable changes to this project will be documented in this file.
 - `CHANGELOG.md` file is not present and can be used.
 - add the `changelog` command.
 - script completion file is installed on program run, and the install bash is reloading the SHELL.
-- create tenant command
+- create tenant command.
 
 ### Changed
 
-- revamped the command organization. (BC)
+- revamped the command organization. (BC).
 
 ## [5.0.1]
 
 ### Added
 
-- (internal) Make it work on the Crystallize Staging environement
+- (internal) Make it work on the Crystallize Staging environement.
 
 ## [5.0.0]
 
@@ -133,9 +167,9 @@ This is the new version that will live in the future, built on top of Bun.js it
 
 ## [4.x]
 
-The 4.x version called `@crystallize/cli-next`, hosted in NPMJS is now deprecated, it was mainly used to install boilerplates, dump and import
-tenant data. It was using `@crystallize/import-utilities` which is now deprecated in favor of Mass Operation
+The 4.x version called `@crystallize/cli-next`, hosted in NPMJS is now deprecated, it was mainly used to install boilerplates, dump and import.
+tenant data. It was using `@crystallize/import-utilities` which is now deprecated in favor of Mass Operation.
 
 ## [3.x]
 
-The 3.x version called `@crystallize/cli`, hosted in NPMJS is now deprecated, it was mainly used to install old-legacy boilerplates
+The 3.x version called `@crystallize/cli`, hosted in NPMJS is now deprecated, it was mainly used to install old-legacy boilerplates.

components/cli/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@crystallize/cli",
-    "version": "5.9.3",
+    "version": "5.10.0",
     "description": "Crystallize CLI",
     "module": "src/index.ts",
     "repository": "https://github.com/CrystallizeAPI/crystallize-cli",

components/cli/src/command/mass-operation/dump-content-model.ts

@@ -24,6 +24,7 @@ export const createDumpContentModelMassOperationCommand = ({
     command.description('Create a valid Mass Operation file on your machine.');
     command.addArgument(new Argument('<tenant-identifier>', 'The tenant identifier to use.'));
     command.addArgument(new Argument('<file>', 'The file that will contains the Operations.'));
+    command.addOption(new Option('--no-item-ids', 'Remove all reference to exising itemId. (like for Quick Select)'));
     command.addOption(new Option('-f, --force', 'Force and override the file it it exits.'));
     addInteractiveAndTokenOption(command);
 
@@ -41,6 +42,7 @@ export const createDumpContentModelMassOperationCommand = ({
             const intent = queryBus.createQuery('CreateContentModelMassOperationFile', {
                 tenantIdentifier,
                 credentials,
+                withItemIds: flags.itemIds,
             });
             const { result } = await queryBus.dispatch(intent);
             if (!result) {

components/cli/src/domain/use-cases/create-content-model-mass-operation.ts

@@ -23,6 +23,7 @@ type Deps = {
 type Query = {
     tenantIdentifier: string;
     credentials: PimCredentials;
+    withItemIds?: boolean;
 };
 
 export type CreateContentModelMassOperationFileHandlerDefinition = QueryHandlerDefinition<
@@ -33,7 +34,7 @@ export type CreateContentModelMassOperationFileHandlerDefinition = QueryHandlerD
 
 const handler = async (envelope: Envelope<Query>, deps: Deps) => {
     const { createCrystallizeClient } = deps;
-    const { tenantIdentifier, credentials } = envelope.message;
+    const { tenantIdentifier, credentials, withItemIds } = envelope.message;
 
     const client = await createCrystallizeClient({
         tenantIdentifier: tenantIdentifier,
@@ -246,6 +247,20 @@ const handler = async (envelope: Envelope<Query>, deps: Deps) => {
                 },
             };
         }
+        if (component.type === 'itemRelations') {
+            const config = component.config as ItemRelationsConfig;
+            return {
+                [component.type]: {
+                    ...config,
+                    ...(config.quickSelect && {
+                        quickSelect: {
+                            ...config.quickSelect,
+                            folders: withItemIds === false ? [] : config.quickSelect.folders,
+                        },
+                    }),
+                },
+            };
+        }
         return {
             [component.type]: component.config,
         };
@@ -390,15 +405,15 @@ const handler = async (envelope: Envelope<Query>, deps: Deps) => {
                         })) || [],
                     ...(shape.type === 'product'
                         ? {
-                              variantComponents:
-                                  shape.variantComponents?.map((component) => ({
-                                      id: component.id,
-                                      type: component.type,
-                                      name: component.name,
-                                      description: component.description,
-                                      config: mapConfig(component),
-                                  })) || [],
-                          }
+                            variantComponents:
+                                shape.variantComponents?.map((component) => ({
+                                    id: component.id,
+                                    type: component.type,
+                                    name: component.name,
+                                    description: component.description,
+                                    config: mapConfig(component),
+                                })) || [],
+                        }
                         : {}),
                 });
             }