client: mark poaps and nfts as experimental, exclude constructors and…

… internal methods from docs (#821)

.changeset/curvy-birds-juggle.md

@@ -0,0 +1,5 @@
+---
+"@lens-protocol/client": patch
+---
+
+**chore:** marked Nfts and Poaps as experimental as they are not stable and might be removed in the future

packages/client/src/authentication/Authentication.ts

@@ -30,6 +30,9 @@ export class Authentication implements IAuthentication {
   private readonly api: AuthenticationApi;
   private readonly credentials: CredentialsStorage;
 
+  /**
+   * @internal
+   */
   constructor(context: LensContext) {
     this.api = new AuthenticationApi(context);
     this.credentials = new CredentialsStorage(context.storage, context.environment.name);
@@ -158,7 +161,9 @@ export class Authentication implements IAuthentication {
     });
   }
 
-  // privileged methods
+  /**
+   * @internal
+   */
   async requireAuthentication<
     TResult extends Result<TValue, TError>,
     TValue,
@@ -181,6 +186,9 @@ export class Authentication implements IAuthentication {
     return handler(profileId);
   }
 
+  /**
+   * @internal
+   */
   async requireAtLeastWalletAuthentication<
     TResult extends Result<TValue, TError>,
     TValue,
@@ -197,6 +205,9 @@ export class Authentication implements IAuthentication {
     return handler(result.value.getProfileId());
   }
 
+  /**
+   * @internal
+   */
   async getRequestHeader(): PromiseResult<
     Record<string, string>,
     CredentialsExpiredError | NotAuthenticatedError

packages/client/src/index.ts

@@ -55,5 +55,5 @@ export type {
 } from '@lens-protocol/shared-kernel';
 export type { IStorageProvider, InMemoryStorageProvider } from '@lens-protocol/storage';
 export type { TypedData, TypedDataResponse } from './types';
-export type { LensContext, MediaTransformsConfig } from './context';
+export type { MediaTransformsConfig } from './context';
 export type { PaginatedResult, PaginatedQueryData } from './helpers/buildPaginatedQueryResult';

packages/client/src/submodules/explore/Explore.ts

@@ -26,6 +26,9 @@ import { getSdk, Sdk } from './graphql/explore.generated';
 export class Explore {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     authentication: Authentication,

packages/client/src/submodules/feed/Feed.ts

@@ -29,6 +29,9 @@ import {
 export class Feed {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/handle/Handle.ts

@@ -15,6 +15,9 @@ import { Sdk, getSdk } from './graphql/handle.generated';
 export class Handle {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(context: LensContext, authentication: Authentication) {
     const client = new FetchGraphQLClient(context);
 

packages/client/src/submodules/invites/Invites.ts

@@ -16,6 +16,9 @@ import { InvitedResultFragment, Sdk, getSdk } from './graphql/invites.generated'
 export class Invites {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/modules/Modules.ts

@@ -34,6 +34,9 @@ import {
 export class Modules {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/momoka/Momoka.ts

@@ -30,6 +30,9 @@ export type MomokaTransaction =
 export class Momoka {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     authentication: Authentication,

packages/client/src/submodules/nfts/Nfts.ts

@@ -38,11 +38,15 @@ import {
 /**
  * Query owned NFTs. Challenge ownership. Create and manage NFT galleries.
  *
+ * @experimental This module is not stable and may be removed in a future release
  * @group LensClient Modules
  */
 export class Nfts {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     context: LensContext,
     private readonly authentication: Authentication,
@@ -59,6 +63,7 @@ export class Nfts {
    *
    * @param request - Request object for the query
    * @returns NFTs wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * When authenticated
@@ -121,6 +126,7 @@ export class Nfts {
    *
    * @param request - Request object for the query
    * @returns NFT collections wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -144,6 +150,7 @@ export class Nfts {
    *
    * @param request - Request object for the query
    * @returns NFT collections wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -170,6 +177,7 @@ export class Nfts {
    *
    * @param request - Request object for the query
    * @returns NFT collections with total owners wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -193,6 +201,7 @@ export class Nfts {
    *
    * @param request - Request object for the query
    * @returns Profiles wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -260,6 +269,7 @@ export class Nfts {
    *
    * @param request - Request object for the query
    * @returns Array of NFT galleries wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -288,6 +298,7 @@ export class Nfts {
    *
    * @param request - Request object for the mutation
    * @returns {@link PromiseResult} with the id of the new gallery
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -322,6 +333,7 @@ export class Nfts {
    *
    * @param request - Request object for the mutation
    * @returns {@link PromiseResult} with void
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -349,6 +361,7 @@ export class Nfts {
    *
    * @param request - Request object for the mutation
    * @returns {@link PromiseResult} with void
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -393,6 +406,7 @@ export class Nfts {
    *
    * @param request - Request object for the mutation
    * @returns {@link PromiseResult} with void
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -426,6 +440,7 @@ export class Nfts {
    *
    * @param request - Request object for the mutation
    * @returns {@link PromiseResult} with void
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts

packages/client/src/submodules/notifications/Notifications.ts

@@ -41,6 +41,9 @@ export type NotificationFragment =
 export class Notifications {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/poaps/Poaps.ts

@@ -19,11 +19,15 @@ import { PoapEventFragment, PoapTokenFragment, Sdk, getSdk } from './graphql/poa
 /**
  * POAP is a protocol for the preservation of memories as digital records.
  *
+ * @experimental This module is not stable and may be removed in a future release
  * @group LensClient Modules
  */
 export class Poaps {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     authentication: Authentication,
@@ -38,6 +42,7 @@ export class Poaps {
    *
    * @param request - The request object.
    * @returns POAP tokens wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -61,6 +66,7 @@ export class Poaps {
    *
    * @param request - The request object.
    * @returns Profiles wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -85,6 +91,7 @@ export class Poaps {
    *
    * @param request - The request object.
    * @returns POAP events wrapped in {@link PaginatedResult}
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts
@@ -111,6 +118,7 @@ export class Poaps {
    *
    * @param request - The request object.
    * @returns POAP event.
+   * @experimental This function is not stable and may be removed in a future release
    *
    * @example
    * ```ts

packages/client/src/submodules/profile/Profile.ts

@@ -72,6 +72,9 @@ import { FetchProfileOptions } from './types';
 export class Profile {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/publication/Publication.ts

@@ -66,6 +66,9 @@ import { FetchPublicationOptions, RequestOverwrites } from './types';
 export class Publication {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/publication/submodules/actions/Actions.ts

@@ -22,6 +22,9 @@ import {
 export class Actions {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/publication/submodules/bookmarks/Bookmarks.ts

@@ -26,6 +26,9 @@ import { getSdk, Sdk } from './graphql/bookmarks.generated';
 export class Bookmarks {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/publication/submodules/notInterested/NotInterested.ts

@@ -14,6 +14,9 @@ import { Sdk, getSdk } from './graphql/notInterested.generated';
 export class NotInterested {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/publication/submodules/reactions/Reactions.ts

@@ -25,6 +25,9 @@ import { getSdk, ProfileWhoReactedResultFragment, Sdk } from './graphql/reaction
 export class Reactions {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/revenue/Revenue.ts

@@ -27,6 +27,9 @@ import {
 export class Revenue {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     authentication: Authentication,

packages/client/src/submodules/search/Search.ts

@@ -20,6 +20,9 @@ import { getSdk, Sdk } from './graphql/search.generated';
 export class Search {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     authentication: Authentication,

packages/client/src/submodules/transaction/Transaction.ts

@@ -41,6 +41,9 @@ export class TransactionPollingError extends Error {
 export class Transaction {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     context: LensContext,
     private readonly authentication: Authentication,

packages/client/src/submodules/wallet/Wallet.ts

@@ -38,6 +38,9 @@ import {
 export class Wallet {
   private readonly sdk: Sdk;
 
+  /**
+   * @internal
+   */
   constructor(
     private readonly context: LensContext,
     private readonly authentication: Authentication,

packages/client/typedoc.json

@@ -2,5 +2,6 @@
   "tsconfig": "./tsconfig.json",
   "extends": ["../../typedoc.base.json"],
   "entryPoints": ["src/index.ts", "src/gated/index.ts"],
-  "intentionallyNotExported": ["Environment", "LensContext", "Typename", "PickByTypename"]
+  "intentionallyNotExported": ["Environment", "Typename", "PickByTypename"],
+  "groupOrder": ["LensClient", "LensClient Modules", "Variables", "Functions"]
 }