docs(backend,shared): Update typedoc comments

.changeset/shiny-pumas-report.md

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

packages/agent-toolkit/src/lib/tools/index.ts

@@ -11,7 +11,7 @@ export const tools = {
   users,
 
   /**
-   * Tools for interacting with organizations.
+   * Tools for interacting with Organizations.
    * This is a wrapper around the `clerkClient.organizations` API.
    * For more information, see the [Clerk API documentation](https://clerk.com/docs/reference/backend-api/tag/Organizations).
    */

packages/astro/src/stores/external.ts

@@ -56,7 +56,7 @@ export const $sessionStore = computed([$authStore], auth => auth.session as Sign
 
 /**
  * A client side store that is populated after clerk-js has loaded.
- * The store returns the active organization of the authenticated user or `null`.
+ * The store returns the Active Organization of the authenticated user or `null`.
  * It is a nanostore, for instructions on how to use nanostores please review the [documentation](https://github.com/nanostores/nanostores)
  *
  * @example

packages/backend/src/api/endpoints/APIKeysApi.ts

@@ -10,7 +10,7 @@ const basePath = '/api_keys';
 
 type GetAPIKeyListParams = ClerkPaginationRequest<{
   /**
-   * The user or organization ID to query API keys by
+   * The user or Organization ID to query API keys by
    */
   subject: string;
   /**
@@ -27,7 +27,7 @@ type CreateAPIKeyParams = {
    */
   name: string;
   /**
-   * The user or organization ID to associate the API key with
+   * The user or Organization ID to associate the API key with
    */
   subject: string;
   /**

packages/backend/src/api/endpoints/InstanceApi.ts

@@ -52,17 +52,17 @@ type UpdateOrganizationSettingsParams = {
   adminDeleteEnabled?: boolean | null | undefined;
   domainsEnabled?: boolean | null | undefined;
   /**
-   * Specifies which [enrollment modes](https://clerk.com/docs/guides/organizations/verified-domains#enable-verified-domains) to enable for your Organization Domains.
+   * Specifies which [enrollment modes](https://clerk.com/docs/guides/organizations/add-members/verified-domains#enable-verified-domains) to enable for your Organization Domains.
    *
    * @remarks Supported modes are 'automatic_invitation' & 'automatic_suggestion'.
    */
   domainsEnrollmentModes?: Array<string> | undefined;
   /**
-   * Specifies what the default organization role is for an organization creator.
+   * Specifies what the default Organization Role is for an Organization creator.
    */
   creatorRoleId?: string | null | undefined;
   /**
-   * Specifies what the default organization role is for the organization domains.
+   * Specifies what the default Organization Role is for the Organization Domains.
    */
   domainsDefaultRoleId?: string | null | undefined;
 };

packages/backend/src/api/endpoints/OrganizationApi.ts

@@ -58,7 +58,7 @@ type GetOrganizationMembershipListParams = ClerkPaginationRequest<{
   organizationId: string;
 
   /**
-   * Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username.
+   * Sorts Organization memberships by phone_number, email_address, created_at, first_name, last_name or username.
    * By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.
    */
   orderBy?: WithSign<'phone_number' | 'email_address' | 'created_at' | 'first_name' | 'last_name' | 'username'>;
@@ -82,7 +82,7 @@ type GetOrganizationMembershipListParams = ClerkPaginationRequest<{
   /* Returns users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addressed not found are ignored. */
   web3Wallet?: string[];
 
-  /* Returns users with the specified roles. Accepts up to 100 roles. Any roles not found are ignored. */
+  /* Returns users with the specified Roles. Accepts up to 100 Roles. Any Roles not found are ignored. */
   role?: OrganizationMembershipRole[];
 
   /**
@@ -139,7 +139,7 @@ type GetOrganizationMembershipListParams = ClerkPaginationRequest<{
 
 type GetInstanceOrganizationMembershipListParams = ClerkPaginationRequest<{
   /**
-   * Sorts organizations memberships by phone_number, email_address, created_at, first_name, last_name or username.
+   * Sorts Organization memberships by phone_number, email_address, created_at, first_name, last_name or username.
    * By prepending one of those values with + or -, we can choose to sort in ascending (ASC) or descending (DESC) order.
    */
   orderBy?: WithSign<'phone_number' | 'email_address' | 'created_at' | 'first_name' | 'last_name' | 'username'>;

packages/backend/src/api/endpoints/SamlConnectionApi.ts

@@ -21,9 +21,9 @@ type SamlConnectionListParams = ClerkPaginationRequest<{
   orderBy?: WithSign<'phone_number' | 'email_address' | 'created_at' | 'first_name' | 'last_name' | 'username'>;
 
   /**
-   * Returns SAML connections that have an associated organization ID to the given organizations.
-   * For each organization id, the + and - can be prepended to the id, which denote whether the
-   * respective organization should be included or excluded from the result set. Accepts up to 100 organization ids.
+   * Returns SAML connections that have an associated Organization ID to the given Organizations.
+   * For each Organization ID, the + and - can be prepended to the ID, which denote whether the
+   * respective Organization should be included or excluded from the result set. Accepts up to 100 Organization IDs.
    */
   organizationId?: WithSign<string>[];
 }>;

packages/backend/src/api/endpoints/UserApi.ts

@@ -157,10 +157,10 @@ type UpdateUserParams = {
   /** If true, the user can delete themselves with the Frontend API. */
   deleteSelfEnabled?: boolean;
 
-  /** If true, the user can create organizations with the Frontend API. */
+  /** If true, the user can create Organizations with the Frontend API. */
   createOrganizationEnabled?: boolean;
 
-  /** The maximum number of organizations the user can create. 0 means unlimited. */
+  /** The maximum number of Organizations the user can create. 0 means unlimited. */
   createOrganizationsLimit?: number;
 } & UserMetadataParams &
   (UserPasswordHashingParams | object);

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

@@ -4,62 +4,62 @@ import { Feature } from './Feature';
 import type { BillingPlanJSON } from './JSON';
 
 /**
- * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
+ * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) object as it holds information about a Plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
 export class BillingPlan {
   constructor(
     /**
-     * The unique identifier for the plan.
+     * The unique identifier for the Plan.
      */
     readonly id: string,
     /**
-     * The name of the plan.
+     * The name of the Plan.
      */
     readonly name: string,
     /**
-     * The URL-friendly identifier of the plan.
+     * The URL-friendly identifier of the Plan.
      */
     readonly slug: string,
     /**
-     * The description of the plan.
+     * The description of the Plan.
      */
     readonly description: string | null,
     /**
-     * Whether the plan is the default plan.
+     * Whether the Plan is the default Plan.
      */
     readonly isDefault: boolean,
     /**
-     * Whether the plan is recurring.
+     * Whether the Plan is recurring.
      */
     readonly isRecurring: boolean,
     /**
-     * Whether the plan has a base fee.
+     * Whether the Plan has a base fee.
      */
     readonly hasBaseFee: boolean,
     /**
-     * Whether the plan is displayed in the `<PriceTable/>` component.
+     * Whether the Plan is displayed in the `<PriceTable/>` component.
      */
     readonly publiclyVisible: boolean,
     /**
-     * The monthly fee of the plan.
+     * The monthly fee of the Plan.
      */
     readonly fee: BillingMoneyAmount,
     /**
-     * The annual fee of the plan.
+     * The annual fee of the Plan.
      */
     readonly annualFee: BillingMoneyAmount | null,
     /**
-     * The annual fee of the plan on a monthly basis.
+     * The annual fee of the Plan on a monthly basis.
      */
     readonly annualMonthlyFee: BillingMoneyAmount | null,
     /**
-     * The type of payer for the plan.
+     * The type of payer for the Plan.
      */
     readonly forPayerType: 'org' | 'user',
     /**
-     * The features the plan offers.
+     * The features the Plan offers.
      */
     readonly features: Feature[],
   ) {}

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

@@ -19,7 +19,7 @@ export class BillingSubscriptionItem {
      */
     readonly status: BillingSubscriptionItemJSON['status'],
     /**
-     * The plan period for the subscription item.
+     * The Plan period for the subscription item.
      */
     readonly planPeriod: 'month' | 'annual',
     /**
@@ -47,11 +47,11 @@ export class BillingSubscriptionItem {
      */
     readonly amount: BillingMoneyAmount | undefined,
     /**
-     * The plan associated with this subscription item.
+     * The Plan associated with this subscription item.
      */
     readonly plan: BillingPlan | null,
     /**
-     * The plan ID.
+     * The Plan ID.
      */
     readonly planId: string | null,
     /**

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

@@ -1,30 +1,30 @@
 import type { FeatureJSON } from './JSON';
 
 /**
- * The `Feature` object represents a feature of a subscription plan.
+ * The `Feature` object represents a Feature of a Subscription Plan.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
 export class Feature {
   constructor(
     /**
-     * The unique identifier for the feature.
+     * The unique identifier for the Feature.
      */
     readonly id: string,
     /**
-     * The name of the feature.
+     * The name of the Feature.
      */
     readonly name: string,
     /**
-     * The description of the feature.
+     * The description of the Feature.
      */
     readonly description: string | null,
     /**
-     * The URL-friendly identifier of the feature.
+     * The URL-friendly identifier of the Feature.
      */
     readonly slug: string,
     /**
-     * The URL of the feature's avatar image.
+     * The URL of the Feature's avatar image.
      */
     readonly avatarUrl: string | null,
   ) {}

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

@@ -405,19 +405,19 @@ export interface OrganizationInvitationAcceptedJSON extends OrganizationInvitati
  */
 export interface PublicOrganizationDataJSON extends ClerkResourceJSON {
   /**
-   * The name of the organization.
+   * The name of the Organization.
    */
   name: string;
   /**
-   * The slug of the organization.
+   * The slug of the Organization.
    */
   slug: string;
   /**
-   * Holds the default organization profile image. Compatible with Clerk's [Image Optimization](https://clerk.com/docs/guides/development/image-optimization).
+   * Holds the default Organization profile image. Compatible with Clerk's [Image Optimization](https://clerk.com/docs/guides/development/image-optimization).
    */
   image_url?: string;
   /**
-   * Whether the organization has a profile image.
+   * Whether the Organization has a profile image.
    */
   has_image: boolean;
 }

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

@@ -1,7 +1,7 @@
 import type { OrganizationJSON } from './JSON';
 
 /**
- * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/javascript/organization) object as it holds information about an organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API.
+ * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/javascript/organization) object as it holds information about an Organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API.
  */
 export class Organization {
   private _raw: OrganizationJSON | null = null;
@@ -12,31 +12,31 @@ export class Organization {
 
   constructor(
     /**
-     * The unique identifier for the organization.
+     * The unique identifier for the Organization.
      */
     readonly id: string,
     /**
-     * The name of the organization.
+     * The name of the Organization.
      */
     readonly name: string,
     /**
-     * The URL-friendly identifier of the user's active organization. If supplied, it must be unique for the instance.
+     * The URL-friendly identifier of the user's active Organization. If supplied, it must be unique for the instance.
      */
     readonly slug: string,
     /**
-     * Holds the organization's logo. Compatible with Clerk's [Image Optimization](https://clerk.com/docs/guides/development/image-optimization).
+     * Holds the Organization's logo. Compatible with Clerk's [Image Optimization](https://clerk.com/docs/guides/development/image-optimization).
      */
     readonly imageUrl: string,
     /**
-     * Whether the organization has an image.
+     * Whether the Organization has an image.
      */
     readonly hasImage: boolean,
     /**
-     * The date when the organization was first created.
+     * The date when the Organization was first created.
      */
     readonly createdAt: number,
     /**
-     * The date when the organization was last updated.
+     * The date when the Organization was last updated.
      */
     readonly updatedAt: number,
     /**
@@ -48,19 +48,19 @@ export class Organization {
      */
     readonly privateMetadata: OrganizationPrivateMetadata = {},
     /**
-     * The maximum number of memberships allowed in the organization.
+     * The maximum number of memberships allowed in the Organization.
      */
     readonly maxAllowedMemberships: number,
     /**
-     * Whether the organization allows admins to delete users.
+     * Whether the Organization allows admins to delete users.
      */
     readonly adminDeleteEnabled: boolean,
     /**
-     * The number of members in the organization.
+     * The number of members in the Organization.
      */
     readonly membersCount?: number,
     /**
-     * The ID of the user who created the organization.
+     * The ID of the user who created the Organization.
      */
     readonly createdBy?: string,
   ) {}

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

@@ -2,7 +2,7 @@ import type { OrganizationInvitationStatus, OrganizationMembershipRole } from '.
 import type { OrganizationInvitationJSON, PublicOrganizationDataJSON } from './JSON';
 
 /**
- * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/javascript/types/organization-invitation) object as it's the model around an organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
+ * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/javascript/types/organization-invitation) object as it's the model around an Organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
  */
 export class OrganizationInvitation {
   private _raw: OrganizationInvitationJSON | null = null;
@@ -21,11 +21,11 @@ export class OrganizationInvitation {
      */
     readonly emailAddress: string,
     /**
-     * The role of the invited user.
+     * The Role of the invited user.
      */
     readonly role: OrganizationMembershipRole,
     /**
-     * The name of the role of the invited user.
+     * The name of the Role of the invited user.
      */
     readonly roleName: string,
     /**
@@ -61,7 +61,7 @@ export class OrganizationInvitation {
      */
     readonly privateMetadata: OrganizationInvitationPrivateMetadata = {},
     /**
-     * Public data about the organization that the user is invited to.
+     * Public data about the Organization that the user is invited to.
      */
     readonly publicOrganizationData?: PublicOrganizationDataJSON | null,
   ) {}