fix: add Group entity to IDynamicPerson type and introduce typeguards to find the entity type

[Mnickii]

Closes #2649

PR Type

Bugfix

Description of the changes

Update the IDynamicPerson type with Group entity
Include entityType as a way to find the selected person type

PR checklist

• Project builds (yarn build) and changes have been tested in at least two supported browsers (Edge + non-Chromium based browser)
• All public APIs (classes, methods, etc) have been documented following the jsdoc syntax
• Stories have been added and existing stories have been tested
• Added appropriate documentation. Docs PR:

• License header has been added to all new source files (yarn setLicense)
• Contains NO breaking changes

Other information

[microsoft-github-policy-service]

Thank you for creating a Pull Request @Mnickii.

This is a checklist for the PR reviewer(s) to complete before approving and merging this PR:

• I have verified a documentation PR has been linked and is approved (or not applicable)
• I have ran this PR locally and have tested the fix/feature
• I have verified that stories have been added to storybook (or not applicable)
• I have tested existing stories in storybook to verify no regression has occured
• I have tested the solution in at least two browsers (Edge + 1 non-Chromium based browser)

[Mnickii]

@sebastienlevert from your proposal you'd suggested using personType as the property added, but Person entity already has personType as a property , which can be of a class Person or Group.
I've renamed this to entityType that can be "user" | "people" | "group", would this work? Then it can be set where "personType in personDetails" as entityType: person and "groupTypes in personDetails" as entityType:group cc @gavinbarron

[sebastienlevert]

Renaming means breaking change. @gavinbarron do you have a suggestion for this case? We need to identify a way to know if a picked entity is a group or a person.

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[gavinbarron]

Renaming means breaking change. @gavinbarron do you have a suggestion for this case? We need to identify a way to know if a picked entity is a group or a person.

Adding a new property, which is what I think @Mnickii has done is not a breaking change though.

Adding to the type guard idea you can factor out the typing even further:

type IUser = (MicrosoftGraph.User | MicrosoftGraph.Person) & { entityType: 'user' }
type IContact = MicrosoftGraph.Contact & { entityType: 'contact' }
type IGroup MicrosoftGraph.Group & { entityType: 'group' }

export type IDynamicPerson = (
  IUser
  | IContact
  | IGroup
) & {
  /**
   * personDetails.personImage is a toolkit injected property to pass image between components
   * an optimization to avoid fetching the image when unnecessary.
   *
   * @type {string}
   */
  personImage?: string;
};

isGroup = (obj: IDynamicPerson): obj is Group => {
    return entityType === 'group';
};

[gavinbarron]

Actually, on reflection, perhaps the better approach here is to provide an exported isGroup type guard function for developers to use should they need to determine an object emitted in an event is a group or not? Thoughts?

[sebastienlevert]

I like this last proposal @gavinbarron!

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[sebastienlevert]

To illustrate this scenario, could we build a simple story?

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[gavinbarron]

Great work on simplifying by removing the entityType property.
Now we need to clean up the casting that was introduced when we had the entityType property.

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[github-actions]

The updated storybook is available here

[gavinbarron]

Fantastic stuff, this give us a nice clean mechanism for understanding the type of a result with minimal code changes.

I really appreciate the work that you put in to get this one over the line.