Setup a New Single Package by CarlosCortizasCT · Pull Request #697 · commercetools/test-data

CarlosCortizasCT · 2024-10-23T09:25:32Z

The goal of this PR is to publish a single package for all the models. We are currently publishing 40+ packages every time we release a new version of the test data models which is not good for the repository maintainability nor for its consumers.

The goal of this task is to set up a new package in this repository which aggregates all the test data models so we only need to release that one and consumers can simplify the way they use test data models and also how they stay up to date with the latest changes

Note for reviewers: all the new package.json files in the presets/all-packages subdirectories are autogenerated files (using preconstruct) and are needed to be able to consume each model independently.

changeset-bot · 2024-10-23T09:25:36Z

🦋 Changeset detected

Latest commit: 810ef7b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 49 packages

Name	Type
@commercetools-test-data/generators	Minor
@commercetools-test-data/product-type	Minor
@commercetools-test-data/type	Minor
@commercetools-test-data/product	Minor
@commercetools/composable-commerce-test-data	Minor
@commercetools-test-data/cart-discount	Minor
@commercetools-test-data/cart	Minor
@commercetools-test-data/product-discount	Minor
@commercetools-test-data/product-projection	Minor
@commercetools-test-data/category	Minor
@commercetools-test-data/channel	Minor
@commercetools-test-data/inventory-entry	Minor
@commercetools-test-data/standalone-price	Minor
@commercetools-test-data/discount-code	Minor
@commercetools-test-data/order	Minor
@commercetools-test-data/quote-request	Minor
@commercetools-test-data/quote	Minor
@commercetools-test-data/staged-quote	Minor
@commercetools-test-data/commons	Minor
@commercetools-test-data/store	Minor
@commercetools-test-data/payment	Minor
@commercetools-test-data/associate-role	Minor
@commercetools-test-data/attribute-group	Minor
@commercetools-test-data/business-unit	Minor
@commercetools-test-data/custom-application	Minor
@commercetools-test-data/custom-object	Minor
@commercetools-test-data/custom-view	Minor
@commercetools-test-data/customer-group	Minor
@commercetools-test-data/customer	Minor
@commercetools-test-data/customers-search-list-my-view	Minor
@commercetools-test-data/discounts-custom-view	Minor
@commercetools-test-data/organization	Minor
@commercetools-test-data/platform-limits	Minor
@commercetools-test-data/product-selection	Minor
@commercetools-test-data/product-tailoring	Minor
@commercetools-test-data/review	Minor
@commercetools-test-data/shipping-method	Minor
@commercetools-test-data/shopping-list	Minor
@commercetools-test-data/state	Minor
@commercetools-test-data/tax-category	Minor
@commercetools-test-data/user	Minor
@commercetools-test-data/zone	Minor
@commercetools-test-data/organization-extension	Minor
@commercetools-test-data/project-extension	Minor
@commercetools-test-data/core	Minor
@commercetools-test-data/graphql-types	Minor
@commercetools-test-data/filter-values	Minor
@commercetools-test-data/project	Minor
@commercetools-test-data/utils	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

bradd123 · 2025-04-04T14:58:39Z

@@ -1,78 +1,157 @@
 {
-  "name": "@commercetools-frontend/test-data",
+  "name": "@commercetools/composable-commerce-test-data",


Renamed the package name to follow the latest NCR naming convention.

Reference: https://commercetools.atlassian.net/wiki/spaces/S/pages/187236397/NCR+NPM+package+names

… preset

CarlosCortizasCT · 2025-04-08T11:37:17Z

        });
    }

+    // 3. Update the single package preset


We need to:

Create a file in the source folder where we export the new model

Update the package.json to make sure we have a new entry point for the new model, we include its source in the dist package and we add the internal dependency.

We create the "proxy" package.json for the independent entry point (using preconstruct)

We install the new internal dependency

CarlosCortizasCT · 2025-04-08T11:37:40Z

@@ -1,5 +1,5 @@
 import { AttributeLocalizedEnumValue } from '@commercetools/platform-sdk';
-import { TLocalizedStringGraphql } from '@commercetools-test-data/commons/src';


Fixing an incorrect import.

CarlosCortizasCT · 2025-04-08T11:38:01Z

-  orderHint: ValueOf<CategoryOrderHints>;
-  __typename: 'CategoryOrderHint';
-};
+export type TCategoryOrderHintGraphql = TCtpCategoryOrderHint;


Use the generated GraphQL types is better.

CarlosCortizasCT · 2025-04-08T11:38:06Z

@@ -1,5 +1,5 @@
 import { CustomFieldLocalizedEnumValue } from '@commercetools/platform-sdk';
-import { TLocalizedStringGraphql } from '@commercetools-test-data/commons/src';
+import { TLocalizedStringGraphql } from '@commercetools-test-data/commons';


Fixing an incorrect import.

CarlosCortizasCT · 2025-04-08T11:39:11Z

@@ -0,0 +1,6 @@
+{


All these package.json files are autogenerated by preconstruct and required for it to be able to export independent entry points.

CarlosCortizasCT · 2025-04-08T11:39:43Z

@@ -0,0 +1 @@
+export * from '@commercetools-test-data/attribute-group';


This is how we re-export an internal package so it can be consumed independently.

CarlosCortizasCT · 2025-04-08T11:40:24Z

@@ -0,0 +1 @@
+export default {};


We don't want to export everything at once. Consumers will need to import whatever they need independently.

ismaelocaramelo · 2025-04-23T11:53:31Z

+      const presetPackageJson = (
+        await import(join(presetDirectoryPath, 'package.json'))
+      ).default;
+      presetPackageJson.files.push(modelCodename);


maybe worth to add some guards here if the structure isn't expected?

Not sure if I follow.
Are you worried about the structure of the package.json file import?
If that's the case, the file is managed by us and the files property is mandatory. Without it the preset would not work so I think it's safe to assume it will exists.

Please let me know if I misunderstood your comment 🙏

ismaelocaramelo

LTGM, I've just added a small doubt without having full context.

CarlosCortizasCT added 🚧 Status: WIP fe-chapter-rotation Tasks coming from frontend chapter work labels Oct 23, 2024

CarlosCortizasCT self-assigned this Oct 23, 2024

CarlosCortizasCT added 4 commits March 31, 2025 12:38

feat: publish single package

fef3df0

refactor: debugging export

55fdff8

refactor: group quotes related models

35bd4f6

refactor(quote): add missing types export

a686107

bradd123 force-pushed the cm-single-package-release branch from 419d3c7 to a686107 Compare March 31, 2025 10:46

chore: add rest of the models

77b1d47

bradd123 changed the title ~~[PoC] Single package release~~ FEC-181: Setup a New Single Package Apr 4, 2025

bradd123 reviewed Apr 4, 2025

View reviewed changes

Comment thread presets/all-packages/package.json

CarlosCortizasCT added 8 commits April 7, 2025 18:05

refactor(models): remove unnecessary config

5349ff7

refactor: revert changes to the quote models

16c6a55

Merge branch 'main' into cm-single-package-release

6230095

fix(models): adjust imports

bd37f70

refactor(models): remove debug files

73ab9b1

refactor(presets): use workspace dependencies

199e6b8

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

02eea52

… preset

fix(generators): fix ts errors

5440ddb

CarlosCortizasCT commented Apr 8, 2025

View reviewed changes

commercetools deleted a comment from bradd123 Apr 8, 2025

CarlosCortizasCT commented Apr 8, 2025

View reviewed changes

refactor(core): remove unnecessary config

f40d0cd

CarlosCortizasCT added 3 commits April 8, 2025 13:52

refactor(all-packages): add missing files

0745c7a

refactor(core): remove unnecessary config

9bc7542

chore: add changesets

467b336

CarlosCortizasCT marked this pull request as ready for review April 8, 2025 12:00

CarlosCortizasCT requested review from a team as code owners April 8, 2025 12:00

CarlosCortizasCT removed the 🚧 Status: WIP label Apr 8, 2025

CarlosCortizasCT requested review from a team and tdeekens April 8, 2025 12:01

ahmehri reviewed Apr 14, 2025

View reviewed changes

Comment thread presets/all-packages/README.md Outdated

Comment thread presets/all-packages/README.md Outdated

fix(all-packages): adjust readme

9b894da

ahmehri approved these changes Apr 14, 2025

View reviewed changes

Merge branch 'main' into cm-single-package-release

d72218c

tdeekens approved these changes Apr 14, 2025

View reviewed changes

CarlosCortizasCT changed the title ~~FEC-181: Setup a New Single Package~~ Setup a New Single Package Apr 15, 2025

ismaelocaramelo reviewed Apr 23, 2025

View reviewed changes

ismaelocaramelo approved these changes Apr 23, 2025

View reviewed changes

Merge branch 'main' into cm-single-package-release

810ef7b

CarlosCortizasCT merged commit de2f642 into main Apr 24, 2025
8 checks passed

CarlosCortizasCT deleted the cm-single-package-release branch April 24, 2025 11:00

ct-changesets Bot mentioned this pull request Apr 24, 2025

Version Packages #785

Merged

emmenko mentioned this pull request Apr 30, 2025

fix: preset package publish config #792

Merged

		@@ -1,5 +1,5 @@
		import { AttributeLocalizedEnumValue } from '@commercetools/platform-sdk';
		import { TLocalizedStringGraphql } from '@commercetools-test-data/commons/src';

		@@ -0,0 +1 @@
		export * from '@commercetools-test-data/attribute-group';

Conversation

CarlosCortizasCT commented Oct 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Oct 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ismaelocaramelo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

CarlosCortizasCT commented Oct 23, 2024 •

edited

Loading

changeset-bot Bot commented Oct 23, 2024 •

edited

Loading