Setup a New Single Package (#697)

* feat: publish single package

* refactor: debugging export

* refactor: group quotes related models

* refactor(quote): add missing types export

* chore: add rest of the models

* refactor(models): remove unnecessary config

* refactor: revert changes to the quote models

* fix(models): adjust imports

* refactor(models): remove debug files

* refactor(presets): use workspace dependencies

* feat(generators): include the new created package in the all-packages preset

* fix(generators): fix ts errors

* refactor(core): remove unnecessary config

* refactor(all-packages): add missing files

* refactor(core): remove unnecessary config

* chore: add changesets

* fix(all-packages): adjust readme

---------

Co-authored-by: Brahma Reddy <brahmareddychlkl@gmail.com>

Author: CarlosCortizasCT

.changeset/curly-boats-boil.md

@@ -0,0 +1,5 @@
+---
+'@commercetools-test-data/generators': minor
+---
+
+Extend the test data model generator so the created ones are registered in the new single aggregated package.

.changeset/friendly-deers-allow.md

@@ -0,0 +1,6 @@
+---
+'@commercetools-test-data/product-type': patch
+'@commercetools-test-data/type': patch
+---
+
+Fix incorrect `import` statement.

.changeset/friendly-rice-cover.md

@@ -0,0 +1,5 @@
+---
+'@commercetools-test-data/product': patch
+---
+
+Use Graphql generated Typescript type instead of a manual one.

.changeset/pretty-rules-hope.md

@@ -0,0 +1,5 @@
+---
+'@commercetools/composable-commerce-test-data': minor
+---
+
+New package which acts as an aggregator for all the test data models so consumers just need to use one dependency.

generators/src/new-test-model/new-test-model.generator.ts

@@ -1,3 +1,4 @@
+import { execSync } from 'node:child_process';
 import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
 import { dirname, join } from 'node:path';
 import snakeCase from 'lodash/snakeCase';
@@ -6,6 +7,12 @@ import { render as renderTemplate } from 'squirrelly';
 import { CodeGenerator } from '../types';
 import { packageTemplatesData, modelTemplatesData } from './templates';
 
+type TExecCommandError = Error & {
+  status?: number;
+  stdout?: Buffer;
+  stderr?: Buffer;
+};
+
 const servicesToTypePrefixMap = {
   core: 'TCore',
   ctp: 'TCtp',
@@ -114,7 +121,7 @@ export const newTestModelGenerator: CodeGenerator = {
       join(__dirname, '..', '..', '..', 'core', 'package.json')
     );
 
-    // 2. Generate the files
+    // 2. Generate the model files
     const templatesData = {
       modelName,
       modelCodename,
@@ -188,6 +195,61 @@ export const newTestModelGenerator: CodeGenerator = {
         });
     }
 
+    // 3. Update the single package preset
+    if (generationType === 'standalone') {
+      const presetDirectoryPath = join(
+        __dirname,
+        '..',
+        '..',
+        '..',
+        'presets',
+        'all-packages'
+      );
+      // Generate the re-export proxy file
+      writeFileSync(
+        join(presetDirectoryPath, 'src', `${modelCodename}.ts`),
+        `export * from '@commercetools-test-data/${modelCodename}';`
+      );
+      // Update package.json
+      const presetPackageJson = (
+        await import(join(presetDirectoryPath, 'package.json'))
+      ).default;
+      presetPackageJson.files.push(modelCodename);
+      presetPackageJson.preconstruct.entrypoints.push(`${modelCodename}.ts`);
+      presetPackageJson.dependencies[
+        `@commercetools-test-data/${modelCodename}`
+      ] = 'workspace:*';
+      writeFileSync(
+        join(presetDirectoryPath, 'package.json'),
+        JSON.stringify(presetPackageJson, null, 2)
+      );
+
+      // Run preconstruct to generate the proxy package.json file
+      const rootDirectoryPath = join(__dirname, '..', '..', '..');
+      try {
+        execSync('npx preconstruct fix', {
+          cwd: rootDirectoryPath,
+        });
+      } catch (err) {
+        const error = err as TExecCommandError;
+        throw new Error(
+          `Failed to run "preconstruct fix": ${error.message} - Exit code: ${error.status} - stdout: ${error.stdout?.toString()} - stderr: ${error.stderr?.toString()} - cwd: ${rootDirectoryPath}`
+        );
+      }
+
+      // Run pnpm install to install the new package
+      try {
+        execSync('pnpm install', {
+          cwd: rootDirectoryPath,
+        });
+      } catch (err) {
+        const error = err as TExecCommandError;
+        throw new Error(
+          `Failed to run "pnpm install": ${error.message} - Exit code: ${error.status} - stdout: ${error.stdout?.toString()} - stderr: ${error.stderr?.toString()} - cwd: ${rootDirectoryPath}`
+        );
+      }
+    }
+
     console.log(
       "\n 🚀 All set! We've generated all files. You can now adjust them to your needs."
     );

models/product-type/src/attribute-localized-enum-value/types.ts

@@ -1,5 +1,5 @@
 import { AttributeLocalizedEnumValue } from '@commercetools/platform-sdk';
-import { TLocalizedStringGraphql } from '@commercetools-test-data/commons/src';
+import { TLocalizedStringGraphql } from '@commercetools-test-data/commons';
 import type { TBuilder } from '@commercetools-test-data/core';
 
 export type TAttributeLocalizedEnumValue = AttributeLocalizedEnumValue;

models/product/src/product-data/types.ts

@@ -3,12 +3,11 @@ import {
   ProductData,
   ProductVariant,
   SearchKeyword,
-  CategoryOrderHints,
   Category,
 } from '@commercetools/platform-sdk';
 import { TLocalizedStringGraphql } from '@commercetools-test-data/commons';
 import type { TBuilder } from '@commercetools-test-data/core';
-import { ValueOf } from '@commercetools-test-data/core/src/@jackfranklin/test-data-bot';
+import { TCtpCategoryOrderHint } from '@commercetools-test-data/graphql-types';
 
 // The base generator model. Consumers configure these fields.
 export type TProductData = Omit<ProductData, 'categories'> & {
@@ -25,11 +24,7 @@ export type TProductDataRest = Omit<ProductData, 'categories'> & {
 };
 
 // This type only appears in the GraphQL representation
-export type TCategoryOrderHintGraphql = {
-  categoryId: keyof CategoryOrderHints;
-  orderHint: ValueOf<CategoryOrderHints>;
-  __typename: 'CategoryOrderHint';
-};
+export type TCategoryOrderHintGraphql = TCtpCategoryOrderHint;
 
 export type TCategoryReferenceGraphql = CategoryReference & {
   __typename: 'Reference';

package.json

@@ -4,7 +4,7 @@
   "description": "Modules to generate test data for commercetools APIs",
   "private": true,
   "preconstruct": {
-    "packages": ["core", "graphql-types", "models/*", "utils", "generators"]
+    "packages": ["core", "graphql-types", "models/*", "utils", "generators", "presets/*"]
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",