Remove several types from @public scope
#21142
Conversation
github-actions
bot
added
area: dds
| @@ -75,7 +75,7 @@ export interface ContainerWarning extends IErrorBase_2 { | |||
| export interface IAudience extends IEventProvider<IAudienceEvents> { | |||
| getMember(clientId: string): IClient | undefined; | |||
| getMembers(): Map<string, IClient>; | |||
| getSelf: () => ISelf | undefined; | |||
| getSelf(): ISelf | undefined; | |||
There was a problem hiding this comment.
when reviewing public APIs, I spotted this. I don't think the intention in this API was to have a mutable callback users could reassign OR call without the Audience object as its this. At least one implementation implemented this with a method, so I made the API match.
| readonly client?: IClient; | ||
| readonly clientId: string; |
There was a problem hiding this comment.
being able to reassign who self is seems like not something we support, do I cleaned this up too.
There was a problem hiding this comment.
I never had any issue with the content of this PR. It is I think the best we can do. The thing that caught my attention was the mention of encapsulated API. It is just still fuzzy. If any of those changed are actually meant to be internal then I wouldn't say they are part of encapsulated API [surface].
## Description Due to my previous changes to make IFluidDataStoreRuntime non-public, several types no longer need to be public. This moves more of them to alpha. Also includes a couple of `IAudience` related tweaks to make the types better convey what I I think is supported as far as method binding and modification. ## Breaking Changes The following types have been moved from `@public` to `@alpha`: - `IFluidSerializer` - `ISharedObjectEvents` - `IChannelServices` - `IChannelStorageService` - `IDeltaConnection` - `IDeltaHandler` These should not be needed by users of the declarative API, which is what `@public` is targeting.
Description
Due to my previous changes to make IFluidDataStoreRuntime non-public, several types no longer need to be public. This moves more of them to alpha.
Also includes a couple of
IAudiencerelated tweaks to make the types better convey what I I think is supported as far as method binding and modification.Breaking Changes
The following types have been moved from
@publicto@alpha:IFluidSerializerISharedObjectEventsIChannelServicesIChannelStorageServiceIDeltaConnectionIDeltaHandlerThese should not be needed by users of the declarative API, which is what
@publicis targeting.Reviewer Guidance
The review process is outlined on this wiki page.