fix a few typedoc issues

lens-protocol · Jan 24, 2024 · ff859f6 · ff859f6
1 parent 0eb3421
commit ff859f6
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 8 deletions.
diff --git a/packages/client/src/LensClient.ts b/packages/client/src/LensClient.ts
@@ -6,6 +6,7 @@ import { Environment } from './environments';
 import {
   Explore,
   Feed,
+  Handle,
   Invites,
   Modules,
   Momoka,
@@ -19,7 +20,6 @@ import {
   Transaction,
   Wallet,
 } from './submodules';
-import { Handle } from './submodules/handle';
 
 /**
  * LensClient configuration

diff --git a/packages/client/src/graphql/index.ts b/packages/client/src/graphql/index.ts
@@ -124,10 +124,12 @@ export type {
   LastLoggedInProfileRequest,
   LinkHandleToProfileRequest,
   UnlinkHandleFromProfileRequest,
+  HandleToAddressRequest,
   HidePublicationRequest,
   InviteRequest,
   LegacyCollectRequest,
   LensTransactionStatusRequest,
+  ModuleMetadataRequest,
   MomokaCommentRequest,
   MomokaMirrorRequest,
   MomokaPostRequest,
@@ -217,14 +219,22 @@ export type {
   FeeFollowModuleRedeemInput,
   FollowModuleInput,
   FollowModuleRedeemInput,
+  FraudReasonInput,
+  IllegalReasonInput,
   MultirecipientFeeCollectModuleInput,
   NetworkAddressInput,
   NftInput,
   OpenActionModuleInput,
+  ProfileFraudReasonInput,
+  ProfileReportingReasonInput,
+  ProfileSpamReasonInput,
   PublicationStatsInput,
   RecipientDataInput,
   ReferenceModuleInput,
+  ReportingReasonInput,
+  SensitiveReasonInput,
   SimpleCollectOpenActionModuleInput,
+  SpamReasonInput,
   UnknownFollowModuleInput,
   UnknownFollowModuleRedeemInput,
   UnknownOpenActionActRedeemInput,
@@ -245,6 +255,7 @@ export type {
   ChangeProfileManager,
   Exact,
   Follow,
+  FollowStatusBulk,
   ImageTransform,
   InputMaybe,
   Maybe,
@@ -282,11 +293,13 @@ export {
   MarketplaceMetadataAttributeDisplayType,
   ModuleType,
   MomokaValidatorError,
+  NftCollectionOwnersOrder,
   NftContractType,
   NotificationType,
   OpenActionCategoryType,
   OpenActionModuleType,
   PoapTokenLayerType,
+  PopularNftCollectionsOrder,
   ProfileActionHistoryType,
   ProfileInterestTypes,
   ProfileReportingFraudSubreason,

diff --git a/packages/client/src/submodules/index.ts b/packages/client/src/submodules/index.ts
@@ -1,5 +1,6 @@
 export * from './explore';
 export * from './feed';
+export * from './handle';
 export * from './invites';
 export * from './modules';
 export * from './momoka';

diff --git a/packages/client/src/submodules/publication/Publication.ts b/packages/client/src/submodules/publication/Publication.ts
@@ -879,12 +879,14 @@ export class Publication {
    * Predict the next onchain Publication id for a Profile.
    *
    * @param request - Request object for the method
-   * @param request.from - ProfileId of the profile to predict the next onchain publication id for
    * @returns Publication Id
    */
   async predictNextOnChainPublicationId({
     from,
   }: {
+    /**
+     * Profile Id of the profile to predict the next onchain Publication Id for
+     */
     from: Scalars['ProfileId']['input'];
   }): Promise<Scalars['PublicationId']['output']> {
     const result = await this.fetchAll({

diff --git a/packages/react-web/src/inbox/useEnhanceConversation.ts b/packages/react-web/src/inbox/useEnhanceConversation.ts
@@ -29,7 +29,7 @@ export type UseEnhanceConversationResult = {
 /**
  * Enhance XMTP conversation with a profile of the conversation's peer
  *
- * You MUST be authenticated via {@link useLogin} to use this hook.
+ * You MUST be authenticated via `useLogin` to use this hook.
  *
  * @example
  * ```tsx

diff --git a/packages/react-web/src/inbox/useEnhanceConversations.ts b/packages/react-web/src/inbox/useEnhanceConversations.ts
@@ -19,7 +19,7 @@ export type UseEnhanceConversationsResult = Prettify<
  * Enhance XMTP conversations with profiles of the conversations' peers,
  * if conversation is between two Lens profiles.
  *
- * You MUST be authenticated via {@link useLogin} to use this hook.
+ * You MUST be authenticated via `useLogin` to use this hook.
  *
  * @example
  * ```tsx

diff --git a/packages/react-web/src/inbox/useStartLensConversation.ts b/packages/react-web/src/inbox/useStartLensConversation.ts
@@ -22,7 +22,7 @@ export type UseStartLensConversationResult = ReturnType<typeof useStartConversat
 /**
  * Start a new XMTP conversation between two Lens profiles.
  *
- * You MUST be authenticated via {@link useLogin} to use this hook.
+ * You MUST be authenticated via `useLogin` to use this hook.
  *
  * @example
  * ```tsx

diff --git a/packages/react-web/src/inbox/useXmtpClient.ts b/packages/react-web/src/inbox/useXmtpClient.ts
@@ -41,11 +41,11 @@ const defaultOptions: InitXmtpClientOptions = {
 };
 
 /**
- * Initialize XMTP client using the same Signer as the one provided with {@link LensConfig}.
+ * Initialize XMTP client using the same Signer as the one provided with `LensConfig`.
  * Store XMTP user's decryption key in storage to improve UX.
  * Be aware that XMTP user's key must be stored safely.
  *
- * You MUST be authenticated via {@link useLogin} to use this hook.
+ * You MUST be authenticated via `useLogin` to use this hook.
  *
  * @example
  * ```tsx

diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts
@@ -130,7 +130,10 @@ export {
   UserRejectedError,
   WalletConnectionError,
 } from '@lens-protocol/domain/entities';
-export { BroadcastingError } from '@lens-protocol/domain/use-cases/transactions';
+export {
+  BroadcastingError,
+  BroadcastingErrorReason,
+} from '@lens-protocol/domain/use-cases/transactions';
 export { NotFoundError } from './NotFoundError';
 export {
   InsufficientAllowanceError,