Skip to content

Add the public API analyzer #5009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 10, 2024
Merged

Add the public API analyzer #5009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f539f1
Add the public API analyzer
bgavrilMS Dec 2, 2024
72acc44
undo
bgavrilMS Dec 2, 2024
e2759ad
update
bgavrilMS Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<DelaySign>false</DelaySign>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
<!-- Projects must set this individually -->
<!-- Projects must set these individually -->
<IsPackable>false</IsPackable>
</PropertyGroup>

Expand Down
1 change: 1 addition & 0 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
<PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.8.14" PrivateAssets="All" />
<PackageVersion Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0" PrivateAssets="All" />
<PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
<PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4" PrivateAssets="All" />
</ItemGroup>
<ItemGroup>
<!-- Packages for the tests -->
Expand Down
6 changes: 5 additions & 1 deletion src/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,12 @@

<PlatformTarget>AnyCPU</PlatformTarget>
</PropertyGroup>

<ItemGroup Label="Build Tools" Condition="$([MSBuild]::IsOsPlatform('Windows'))">
<PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All" />
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
</ItemGroup>
</Project>
4 changes: 4 additions & 0 deletions src/client/Microsoft.Identity.Client.Broker/Microsoft.Identity.Client.Broker.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,8 @@
<ProjectReference Include="..\Microsoft.Identity.Client\Microsoft.Identity.Client.csproj" />
</ItemGroup>

<ItemGroup>
<AdditionalFiles Include="PublicAPI/PublicAPI.Shipped.txt" />
<AdditionalFiles Include="PublicAPI/PublicAPI.Unshipped.txt" />
</ItemGroup>
</Project>
4 changes: 4 additions & 0 deletions src/client/Microsoft.Identity.Client.Broker/PublicApi/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Microsoft.Identity.Client.Broker.BrokerExtension
static Microsoft.Identity.Client.Broker.BrokerExtension.WithBroker(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, Microsoft.Identity.Client.BrokerOptions brokerOptions) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
static Microsoft.Identity.Client.Broker.BrokerExtension.WithBrokerPreview(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, bool enableBroker = true) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
static Microsoft.Identity.Client.Broker.BrokerExtension.WithSsoPolicy(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
Empty file added src/client/Microsoft.Identity.Client.Broker/PublicApi/PublicAPI.Unshipped.txt
View file
Open in desktop
Empty file.
5 changes: 5 additions & 0 deletions src/client/Microsoft.Identity.Client.Desktop/Microsoft.Identity.Client.Desktop.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,10 @@
<ProjectReference Include="..\Microsoft.Identity.Client.Broker\Microsoft.Identity.Client.Broker.csproj" />
<ProjectReference Include="..\Microsoft.Identity.Client\Microsoft.Identity.Client.csproj" />
</ItemGroup>

<ItemGroup>
<AdditionalFiles Include="PublicAPI/PublicAPI.Shipped.txt" />
<AdditionalFiles Include="PublicAPI/PublicAPI.Unshipped.txt" />
</ItemGroup>

</Project>
7 changes: 7 additions & 0 deletions src/client/Microsoft.Identity.Client.Desktop/PublicApi/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Microsoft.Identity.Client.Desktop.DesktopExtensions
Microsoft.Identity.Client.Desktop.WamExtension
static Microsoft.Identity.Client.Desktop.DesktopExtensions.WithDesktopFeatures(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
static Microsoft.Identity.Client.Desktop.DesktopExtensions.WithWindowsDesktopFeatures(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, Microsoft.Identity.Client.BrokerOptions brokerOptions) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
static Microsoft.Identity.Client.Desktop.DesktopExtensions.WithWindowsEmbeddedBrowserSupport(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
static Microsoft.Identity.Client.Desktop.WamExtension.WithBroker(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, Microsoft.Identity.Client.BrokerOptions brokerOptions) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
static Microsoft.Identity.Client.Desktop.WamExtension.WithWindowsBroker(this Microsoft.Identity.Client.PublicClientApplicationBuilder builder, bool enableBroker = true) -> Microsoft.Identity.Client.PublicClientApplicationBuilder
Empty file added src/client/Microsoft.Identity.Client.Desktop/PublicApi/PublicAPI.Unshipped.txt
View file
Open in desktop
Empty file.
5 changes: 5 additions & 0 deletions ...icrosoft.Identity.Client.Extensions.Msal/Microsoft.Identity.Client.Extensions.Msal.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,9 @@
<PackageReference Include="System.IO.FileSystem.AccessControl" />
</ItemGroup>

<ItemGroup>
<AdditionalFiles Include="PublicAPI/PublicAPI.Shipped.txt" />
<AdditionalFiles Include="PublicAPI/PublicAPI.Unshipped.txt" />
</ItemGroup>

</Project>
68 changes: 68 additions & 0 deletions src/client/Microsoft.Identity.Client.Extensions.Msal/PublicApi/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
const Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.LinuxKeyRingDefaultCollection = "default" -> string
const Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.LinuxKeyRingSessionCollection = "session" -> string
Microsoft.Identity.Client.Extensions.Msal.CacheChangedEventArgs
Microsoft.Identity.Client.Extensions.Msal.CacheChangedEventArgs.CacheChangedEventArgs(System.Collections.Generic.IEnumerable<string> added, System.Collections.Generic.IEnumerable<string> removed) -> void
Microsoft.Identity.Client.Extensions.Msal.CrossPlatLock
Microsoft.Identity.Client.Extensions.Msal.CrossPlatLock.CrossPlatLock(string lockfilePath, int lockFileRetryDelay = 100, int lockFileRetryCount = 600) -> void
Microsoft.Identity.Client.Extensions.Msal.CrossPlatLock.Dispose() -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.CacheChanged -> System.EventHandler<Microsoft.Identity.Client.Extensions.Msal.CacheChangedEventArgs>
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.Clear() -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.LoadUnencryptedTokenCache() -> byte[]
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.RegisterCache(Microsoft.Identity.Client.ITokenCache tokenCache) -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.SaveUnencryptedTokenCache(byte[] tokenCache) -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.UnregisterCache(Microsoft.Identity.Client.ITokenCache tokenCache) -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.VerifyPersistence() -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCachePersistenceException
Microsoft.Identity.Client.Extensions.Msal.MsalCachePersistenceException.MsalCachePersistenceException() -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCachePersistenceException.MsalCachePersistenceException(string message) -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCachePersistenceException.MsalCachePersistenceException(string message, System.Exception innerException) -> void
Microsoft.Identity.Client.Extensions.Msal.MsalCachePersistenceException.MsalCachePersistenceException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) -> void
Microsoft.Identity.Client.Extensions.Msal.SharedUtilities
Microsoft.Identity.Client.Extensions.Msal.Storage
Microsoft.Identity.Client.Extensions.Msal.Storage.Clear(bool ignoreExceptions = false) -> void
Microsoft.Identity.Client.Extensions.Msal.Storage.ReadData() -> byte[]
Microsoft.Identity.Client.Extensions.Msal.Storage.VerifyPersistence() -> void
Microsoft.Identity.Client.Extensions.Msal.Storage.WriteData(byte[] data) -> void
Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties
Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.Authority.get -> string
Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.CacheFilePath.get -> string
Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.ClientId.get -> string
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.Build() -> Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.CustomizeLockRetry(int lockRetryDelay, int lockRetryCount) -> Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.StorageCreationPropertiesBuilder(string cacheFileName, string cacheDirectory) -> void
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.StorageCreationPropertiesBuilder(string cacheFileName, string cacheDirectory, string clientId) -> void
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.WithCacheChangedEvent(string clientId, string authority = "https://login.microsoftonline.com/common") -> Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.WithLinuxKeyring(string schemaName, string collection, string secretLabel, System.Collections.Generic.KeyValuePair<string, string> attribute1, System.Collections.Generic.KeyValuePair<string, string> attribute2) -> Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.WithLinuxUnprotectedFile() -> Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.WithMacKeyChain(string serviceName, string accountName) -> Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder
Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder.WithUnprotectedFile() -> Microsoft.Identity.Client.Extensions.Msal.StorageCreationPropertiesBuilder
Microsoft.Identity.Client.Extensions.Msal.TraceSourceLogger
Microsoft.Identity.Client.Extensions.Msal.TraceSourceLogger.LogError(string message) -> void
Microsoft.Identity.Client.Extensions.Msal.TraceSourceLogger.LogInformation(string message) -> void
Microsoft.Identity.Client.Extensions.Msal.TraceSourceLogger.LogWarning(string message) -> void
Microsoft.Identity.Client.Extensions.Msal.TraceSourceLogger.Source.get -> System.Diagnostics.TraceSource
Microsoft.Identity.Client.Extensions.Msal.TraceSourceLogger.TraceSourceLogger(System.Diagnostics.TraceSource traceSource) -> void
readonly Microsoft.Identity.Client.Extensions.Msal.CacheChangedEventArgs.AccountsAdded -> System.Collections.Generic.IEnumerable<string>
readonly Microsoft.Identity.Client.Extensions.Msal.CacheChangedEventArgs.AccountsRemoved -> System.Collections.Generic.IEnumerable<string>
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.CacheDirectory -> string
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.CacheFileName -> string
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.KeyringAttribute1 -> System.Collections.Generic.KeyValuePair<string, string>
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.KeyringAttribute2 -> System.Collections.Generic.KeyValuePair<string, string>
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.KeyringCollection -> string
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.KeyringSchemaName -> string
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.KeyringSecretLabel -> string
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.LockRetryCount -> int
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.LockRetryDelay -> int
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.MacKeyChainAccountName -> string
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.MacKeyChainServiceName -> string
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.UseLinuxUnencryptedFallback -> bool
readonly Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties.UseUnencryptedFallback -> bool
static Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.CreateAsync(Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties storageCreationProperties, System.Diagnostics.TraceSource logger = null) -> System.Threading.Tasks.Task<Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper>
static Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.UserRootDirectory.get -> string
static Microsoft.Identity.Client.Extensions.Msal.SharedUtilities.GetUserRootDirectory() -> string
static Microsoft.Identity.Client.Extensions.Msal.SharedUtilities.IsLinuxPlatform() -> bool
static Microsoft.Identity.Client.Extensions.Msal.SharedUtilities.IsMacPlatform() -> bool
static Microsoft.Identity.Client.Extensions.Msal.SharedUtilities.IsWindowsPlatform() -> bool
static Microsoft.Identity.Client.Extensions.Msal.Storage.Create(Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties creationProperties, System.Diagnostics.TraceSource logger = null) -> Microsoft.Identity.Client.Extensions.Msal.Storage
Empty file added src/client/Microsoft.Identity.Client.Extensions.Msal/PublicApi/PublicAPI.Unshipped.txt
View file
Open in desktop
Empty file.
1 change: 0 additions & 1 deletion src/client/Microsoft.Identity.Client/AppConfig/PublicClientApplicationBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,6 @@ public PublicClientApplicationBuilder WithIosKeychainSecurityGroup(string keycha
#if ANDROID || iOS
/// <summary>
/// Brokers (Microsoft Authenticator, Intune Company Portal) enable Single-Sign-On, device identification,

/// and application identification verification. To enable one of these features,
/// you need to set the WithBroker(bool) parameters to true on Android and iOS.
/// On desktop platforms, install the NuGet package Microsoft.Identity.Client.Broker and call the extension method .WithBroker(BrokerOptions)
Expand Down
4 changes: 4 additions & 0 deletions src/client/Microsoft.Identity.Client/Microsoft.Identity.Client.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,8 @@
<PackageReference Include="Microsoft.IdentityModel.Abstractions" />
</ItemGroup>

<ItemGroup Label="For public api analyzer support">
<AdditionalFiles Include="PublicAPI/$(TargetFramework)/PublicAPI.Shipped.txt" />
<AdditionalFiles Include="PublicAPI/$(TargetFramework)/PublicAPI.Unshipped.txt" />
</ItemGroup>
</Project>
Loading
Loading