PANGOLIN-3185 - New package for model: State

[jmcreasman]

This PR consists of a new State folder with the following models: State/StateDraft

[changeset-bot]

⚠️ No Changeset found

Latest commit: fec1765

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

[emmenko]

Thanks a lot for contributing! 🙌

In general the structure looks good but I noticed some minor things that should we improved.

[emmenko]

The GraphQL type is a bit more complicated.

For example we prefer to use nameAllLocales instead of name, etc.
You can take Channel as an example:

test-data/models/channel/src/types.ts

Lines 19 to 35 in d6ca721

	export type TChannelGraphql = Omit<
	TChannel,
	// In GraphQL, we prefer to use `nameAllLocales` instead of `name`.
	| 'name'
	// In GraphQL, we prefer to use `descriptionAllLocales` instead of `description`.
	| 'description'
	// In GraphQL, the object shape is different.
	| 'createdBy'
	// In GraphQL, the object shape is different.
	| 'lastModifiedBy'
	> & {
	__typename: 'Channel';
	createdBy: TClientLoggingGraphql;
	lastModifiedBy: TClientLoggingGraphql;
	nameAllLocales?: TLocalizedStringGraphql | null;
	descriptionAllLocales?: TLocalizedStringGraphql | null;
	};

[emmenko]

Also technically there is transitions and transitionsRef.

I would keep using transitions, no need to implement transitionsRef.

However, the transitions field in the Rest definition is a list of references that can be expanded, but in GraphQL it's a list of State objects.

[emmenko]

Shouldn't this be randomly generated as well?

[jmcreasman]

I'm assuming you're referring to type? We ran into some fun issues with that conflicting with roles depending on what each were set at so setting it to LineItemState prevented that.

[valoriecarli]

@jmcreasman This is one of the many topics that should still be ironed out for when usage picks up.
The general idea w/in the generators is that we kick out as much realistic data here as possible (there are gray areas).
The LineItemState is very specific to our use case, so here we can def let it randomize. We can either create a simple change-history-data preset, or you can override it w/in the state-creat.ts resource file (e.g: const stateDraft = StateDraft.random() .type('LineItemState') .buildRest<TStateDraft>();)

[valoriecarli]

didn't you say that this type corresponds with a specific role?

also, please don't forget to add a spec for this

[jmcreasman]

It does, it corresponds to role of return which is what we set roles to already. Unless we need to randomize roles too? But I don't think that was mentioned in any of the feed back.

• pushed up the test -

[valoriecarli]

for the sake of symmetry, lets just randomize all fields, then create a preset to target the type & role combo platter.

[valoriecarli]

Thanks for also taking a stab at the graphql, you got it in a good place for the next person. It's def a bit more complex if you're not actively using it. A++