feat(backend): Add TypeDoc comments to OAuth Application endpoints (#6378)

Author: SarahSoutoul

.changeset/blue-comics-kneel.md

@@ -0,0 +1,5 @@
+---
+'@clerk/backend': minor
+---
+
+Add missing properties to OAuthApplicationJSON

.changeset/small-moments-find.md

@@ -0,0 +1,2 @@
+---
+---

.typedoc/__tests__/__snapshots__/file-structure.test.ts.snap

@@ -238,6 +238,7 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
   "backend/infer-auth-object-from-token.mdx",
   "backend/invitation-status.mdx",
   "backend/invitation.mdx",
+  "backend/o-auth-application.mdx",
   "backend/organization-invitation-status.mdx",
   "backend/organization-invitation.mdx",
   "backend/organization-membership-public-user-data.mdx",

packages/backend/src/api/resources/JSON.ts

@@ -320,6 +320,11 @@ export interface OAuthApplicationJSON extends ClerkResourceJSON {
   instance_id: string;
   name: string;
   client_id: string;
+  client_uri: string | null;
+  client_image_url: string | null;
+  dynamically_registered: boolean;
+  consent_screen_enabled: boolean;
+  pkce_required: boolean;
   public: boolean;
   scopes: string;
   redirect_uris: Array<string>;

packages/backend/src/api/resources/OAuthApplication.ts

@@ -1,21 +1,89 @@
 import type { OAuthApplicationJSON } from './JSON';
 
+/**
+ * The Backend `OAuthApplication` object holds information about an OAuth application.
+ */
 export class OAuthApplication {
   constructor(
+    /**
+     * The unique identifier for the OAuth application.
+     */
     readonly id: string,
+    /**
+     * The ID of the instance that this OAuth application belongs to.
+     */
     readonly instanceId: string,
+    /**
+     * The name of the new OAuth application.
+     */
     readonly name: string,
+    /**
+     * The ID of the client associated with the OAuth application.
+     */
     readonly clientId: string,
+    /**
+     * The public-facing URL of the OAuth application, often shown on consent screens.
+     */
+    readonly clientUri: string | null,
+    /**
+     * The URL of the image or logo representing the OAuth application.
+     */
+    readonly clientImageUrl: string | null,
+    /**
+     * Specifies whether the OAuth application is dynamically registered.
+     */
+    readonly dynamicallyRegistered: boolean,
+    /**
+     * Specifies whether the consent screen should be displayed in the authentication flow. Cannot be disabled for dynamically registered OAuth applications.
+     */
+    readonly consentScreenEnabled: boolean,
+    /**
+     * Specifies whether the Proof Key of Code Exchange (PKCE) flow should be required in the authentication flow.
+     */
+    readonly pkceRequired: boolean,
+    /**
+     * Indicates whether the client is public. If true, the Proof Key of Code Exchange (PKCE) flow can be used.
+     */
     readonly isPublic: boolean, // NOTE: `public` is reserved
+    /**
+     * Scopes for the new OAuth application.
+     */
     readonly scopes: string,
+    /**
+     * An array of redirect URIs of the new OAuth application.
+     */
     readonly redirectUris: Array<string>,
+    /**
+     * The URL used to authorize the user and obtain an authorization code.
+     */
     readonly authorizeUrl: string,
+    /**
+     * The URL used by the client to exchange an authorization code for an access token.
+     */
     readonly tokenFetchUrl: string,
+    /**
+     * The URL where the client can retrieve user information using an access token.
+     */
     readonly userInfoUrl: string,
+    /**
+     * The OpenID Connect discovery endpoint URL for this OAuth application.
+     */
     readonly discoveryUrl: string,
+    /**
+     * The URL used to introspect and validate issued access tokens.
+     */
     readonly tokenIntrospectionUrl: string,
+    /**
+     * The date when the OAuth application was first created.
+     */
     readonly createdAt: number,
+    /**
+     * The date when the OAuth application was last updated.
+     */
     readonly updatedAt: number,
+    /**
+     * The client secret associated with the OAuth application. Empty if public client.
+     */
     readonly clientSecret?: string,
   ) {}
 
@@ -25,6 +93,11 @@ export class OAuthApplication {
       data.instance_id,
       data.name,
       data.client_id,
+      data.client_uri,
+      data.client_image_url,
+      data.dynamically_registered,
+      data.consent_screen_enabled,
+      data.pkce_required,
       data.public,
       data.scopes,
       data.redirect_uris,