Add getter api to @xstate/store

[expelledboy]

Merge getters implementation from #5183 onto #5175

[changeset-bot]

⚠️ No Changeset found

Latest commit: ac5993d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[expelledboy]

Obv you get a circular reference between the getters type and the second arg of its definition.

Depending on how many second pass getters you have there are two approaches

Define the type of ctx for parents

const store = createStore({
  context: { price: 10, quantity: 2 },
  getters: {
    subtotal: (ctx: { price: number; quantity: number }) =>
      ctx.price * ctx.quantity,
    tax: (_, getters) => getters.subtotal * 0.1,
    total: (_, getters) => getters.subtotal + getters.tax
  },
  on: {
    updatePrice: (ctx, ev: { value: number }) => ({ price: ev.value })
  }
});

Or just define the type of getters

const store = createStore({
  context: { price: 10, quantity: 2 },
  getters: {
    subtotal: (ctx) => ctx.price * ctx.quantity,
    tax: (_, getters: { subtotal: number }): number =>
      getters.subtotal * 0.1,
    total: (_, getters: { subtotal: number; tax: number }): number =>
      getters.subtotal + getters.tax
  },
  on: {
    updatePrice: (ctx, ev: { value: number }) => ({ price: ev.value })
  }
});

Probably would want to include this in the docs.

Unless anyone has a better idea on the API here.

[expelledboy]

@davidkpiano Please can you assist me merging this? I dont want there to be massive merge conflicts in 2-4 months with the v3 branch.

Mostly I need assistance getting the types working in the surrounding utils.

And / or if you agree to the API itself.

[expelledboy]

Guessing this was closed because of the merge.