feat(types): add util to transform get response to an update request

[riqwan]

what:

• add util to transform get response to an update request

RESOLVES CORE-1687

Given an update data object, we can infer the fields and selects of a data object using a util we already have - getSelectsAndRelationsFromObjectArray. Using the fields and selects, we can call either the module retrieve or list method to get a snapshot of the data down to its exact attributes. We can pass this data into the revert step.

In the revert step, we just need to convert the snapshot received from retrieve or list to a shape that the update methods will accept. The util that is introduced in this PR aims to do exactly that, so that the revert step looks as simple as:

const { snapshotData, selects, relations } = revertInput

await promotionModule.updateCampaigns(
  convertItemResponseToUpdateRequest(snapshotData, selects, relations)
)

entity before update:

Campaign: {
  id: "campaign-test-1",
  name: "test campaign",
  budget: {
    total: 2000
  },
  promotions: [{ id: "promotion-1" }],
  rules: [
    { id: "rule-1", operator: "gt", value: "10" }
  ]
}

This is how the util will transform the data for different types of attributes in the object:

simple attributes:

invoke:
{
  id: "campaign-test-1",
  name: "change name",
}

compensate:
{
  id: "test-1",
  name: "test campaign"
}

one to one relationship:

invoke:
{
  id: "campaign-test-1",
  budget: { total: 4000 }
}

compensate:
{
  id: "campaign-test-1",
  budget: { total: 2000 }
}

one to many / many to many relationship:

invoke:
{
  id: "campaign-test-1",
  promotions: [{ id: "promotion-2" }]
  rules: [
    { id: "rule-1", operator: "gt", value: "20" },
    { operator: "gt", value: "20" }
  ]
}

compensate:
{
  id: "campaign-test-1",
  promotions: [{ id: "promotion-1" }]
  rules: [{ id: "rule-1", operator: "gt", value: "20" }]
}

all together:

invoke:
{
  id: "campaign-test-1",
  name: "change name",
  promotions: [{ id: "promotion-2" }],
  budget: { total: 4000 },
  rules: [
    { id: "rule-1", operator: "gt", value: "20" },
    { operator: "gt", value: "20" }
  ]
}

compensate:
{
  id: "test-1",
  name: "test campaign",
  promotions: [{ id: "promotion-1" }],
  budget: { total: 2000 },
  rules: [{ id: "rule-1", operator: "gt", value: "20" }],
}

[changeset-bot]

🦋 Changeset detected

Latest commit: 40be54d

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

This PR includes changesets to release 1 package

Name	Type
@medusajs/utils	Patch

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
medusa-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 28, 2024 10:58am

3 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
api-reference	⬜️ Ignored (Inspect)			Feb 28, 2024 10:58am
docs-ui	⬜️ Ignored (Inspect)	Visit Preview		Feb 28, 2024 10:58am
medusa-docs	⬜️ Ignored (Inspect)	Visit Preview		Feb 28, 2024 10:58am

[srindom]

@riqwan - can you add more context to the functionality here. It's hard to decode as is; a few examples in the PR description would be very helpful

[olivermrbl]

@riqwan, just bumping this one. Is this PR still relevant? If so, can I get you to add some examples of what this introduces?

[riqwan]

Added a description, let me know if that helps 🤞🏻

[srindom]

LGTM