feat: exposes params.statsFor and params.profile.metadataSource in Le…

…nsConfig
lens-protocol · Nov 23, 2023 · c466b81 · c466b81
1 parent acfad68
commit c466b81
Show file tree

Hide file tree

Showing 40 changed files with 6,227 additions and 3,744 deletions.
diff --git a/.changeset/four-squids-clean.md b/.changeset/four-squids-clean.md
@@ -0,0 +1,7 @@
+---
+"@lens-protocol/api-bindings": minor
+"@lens-protocol/react": minor
+"@lens-protocol/react-web": minor
+---
+
+**feat:** introduces `params.statsFor` and `params.profile.metadataSource` in `LensConfig`
diff --git a/.changeset/young-mayflies-invent.md b/.changeset/young-mayflies-invent.md
@@ -0,0 +1,6 @@
+---
+"@lens-protocol/gated-content": patch
+"@lens-protocol/client": patch
+---
+
+**fix:** cleanup obsolete environment configuration
diff --git a/packages/api-bindings/src/apollo/__helpers__/mocks.ts b/packages/api-bindings/src/apollo/__helpers__/mocks.ts
@@ -2,6 +2,7 @@ import { GraphQLRequest, NormalizedCacheObject, OperationVariables } from '@apol
 import { MockedResponse, mockSingleLink } from '@apollo/client/testing';
 import { DocumentNode, ExecutionResult, GraphQLError } from 'graphql';
 
+import { SupportedFiatType } from '../../lens';
 import { SafeApolloClient } from '../SafeApolloClient';
 import { createLensCache, createSnapshotCache } from '../cache';
 import { ApolloServerErrorCode } from '../errors';
@@ -10,7 +11,17 @@ export function mockLensApolloClient(
   mocks: ReadonlyArray<MockedResponse<unknown>> = [],
 ): SafeApolloClient<NormalizedCacheObject> {
   return new SafeApolloClient({
-    cache: createLensCache(),
+    cache: createLensCache({
+      fxRateFor: SupportedFiatType.Usd,
+      image: {
+        medium: {},
+        small: {},
+      },
+      profile: {
+        cover: {},
+        thumbnail: {},
+      },
+    }),
 
     link: mockSingleLink(...mocks).setOnError((error) => {
       throw error;

diff --git a/packages/api-bindings/src/apollo/cache/createQueryParamsLocalFields.ts b/packages/api-bindings/src/apollo/cache/createQueryParamsLocalFields.ts
@@ -1,35 +1,77 @@
-import { FieldReadFunction } from '@apollo/client';
+import { FieldFunctionOptions, FieldReadFunction } from '@apollo/client';
+import { AppId } from '@lens-protocol/domain/entities';
+import { UnknownObject } from '@lens-protocol/shared-kernel';
 
 import { ImageSizeTransform, ImageTransform, SupportedFiatType } from '../../lens';
 
 /**
  * The common query parameters used across any query.
  */
 export type QueryParams = {
-  image: {
+  /**
+   * The size of the publication image.
+   *
+   * @defaultValue see individual fields
+   */
+  image?: {
     /**
      * The size of the small publication image
+     *
+     * @defaultValue width: 400px, height: auto, keepAspectRatio: true
      */
-    small: ImageTransform;
+    small?: ImageTransform;
     /**
      * The size of the medium publication image
+     *
+     * @defaultValue width: 700px, height: auto, keepAspectRatio: true
      */
-    medium: ImageTransform;
+    medium?: ImageTransform;
   };
-  profile: {
+  /**
+   * Profile related fields parameters
+   *
+   * @defaultValue see individual fields
+   */
+  profile?: {
     /**
      * The size of optimized profile image
+     *
+     * @defaultValue width: 256px, height: auto, keepAspectRatio: true
      */
-    thumbnail: ImageTransform;
+    thumbnail?: ImageTransform;
     /**
      * The size of the cover image
+     *
+     * @defaultValue width: 1100px, height: auto, keepAspectRatio: true
+     */
+    cover?: ImageTransform;
+    /**
+     * The source to use for fetching profile metadata details.
+     *
+     * If not provided, it will default to the global profile metadata for any profile fetched.
+     *
+     * If provided and a profile does not have bespoke profile metadata it will fallback to their global profile metadata.
+     *
+     * To know more about app specific profile metadata, see example with `appId` in {@link https://lens-protocol.github.io/metadata/functions/profile.html}.
+     *
+     * @defaultValue empty, global profile metadata
      */
-    cover: ImageTransform;
+    metadataSource?: AppId;
   };
   /**
    * The fiat currency to use for the fx rate
+   *
+   * @defaultValue USD
+   */
+  fxRateFor?: SupportedFiatType;
+  /**
+   * The App Ids for which to fetch Publication and Profile Stats for.
+   *
+   * Affects mainly comments, mirrors, and quotes counts.
+   *
+   * @defaultValue empty, all apps
    */
-  fxRateFor: SupportedFiatType;
+  statsFor?: AppId[];
 };
 
 function buildImageTransform(
@@ -63,43 +105,40 @@ export const defaultQueryParams: QueryParams = {
 /**
  * @internal
  */
-export type LocalOnlyFieldPolicies = {
-  fxRateFor: FieldReadFunction<SupportedFiatType>;
-
-  profileCoverSize: FieldReadFunction<ImageTransform>;
-
-  profilePictureSize: FieldReadFunction<ImageTransform>;
-
-  imageSmallSize: FieldReadFunction<ImageTransform>;
+export type WithStatsForVariable = UnknownObject & {
+  statsFor?: AppId[];
+};
 
-  imageMediumSize: FieldReadFunction<ImageTransform>;
+/**
+ * @internal
+ */
+export type LocalOnlyFieldPolicies = {
+  queryParams: FieldReadFunction<QueryParams>;
 };
 
 /**
  * @internal
  */
-export function createQueryParamsLocalFields(
-  params: QueryParams = defaultQueryParams,
-): LocalOnlyFieldPolicies {
+export function createQueryParamsLocalFields({
+  fxRateFor,
+  image,
+  profile,
+  statsFor,
+}: QueryParams = {}): LocalOnlyFieldPolicies {
   return {
-    fxRateFor() {
-      return params.fxRateFor;
-    },
-
-    profileCoverSize() {
-      return params.profile.cover;
-    },
-
-    profilePictureSize() {
-      return params.profile.thumbnail;
-    },
-
-    imageSmallSize() {
-      return params.image.small;
-    },
-
-    imageMediumSize() {
-      return params.image.medium;
+    queryParams(_, { variables }: FieldFunctionOptions<UnknownObject, WithStatsForVariable>) {
+      return {
+        image: Object.assign({}, defaultQueryParams.image, image),
+        profile: Object.assign(
+          {
+            metadataSource: null,
+          },
+          defaultQueryParams.profile,
+          profile,
+        ),
+        statsFor: variables?.statsFor ?? statsFor ?? defaultQueryParams.statsFor,
+        fxRateFor: fxRateFor ?? defaultQueryParams.fxRateFor,
+      };
     },
   };
 }
diff --git a/packages/api-bindings/src/apollo/index.ts b/packages/api-bindings/src/apollo/index.ts
@@ -15,7 +15,7 @@ export type ApolloClientConfig = {
   uri: string;
   logger: ILogger;
   pollingInterval: number;
-  queryParams: QueryParams;
+  queryParams?: QueryParams;
 };
 
 export function createLensApolloClient({

diff --git a/packages/api-bindings/src/lens/__helpers__/queries/mockAnyPaginatedResponse.ts b/packages/api-bindings/src/lens/__helpers__/queries/mockAnyPaginatedResponse.ts
@@ -19,6 +19,7 @@ export function mockAnyResponse(bulk: MockedResponse) {
         imageSmallSize: {},
         profileCoverSize: {},
         profilePictureSize: {},
+        profileMetadataSource: null,
       },
     },
     result: bulk.result,
@@ -52,6 +53,7 @@ export function mockAnyPaginatedResponse<V extends OperationVariables, I>({
         imageSmallSize: {},
         profileCoverSize: {},
         profilePictureSize: {},
+        profileMetadataSource: null,
       },
     },
     result: {

diff --git a/packages/api-bindings/src/lens/graphql/client.graphql b/packages/api-bindings/src/lens/graphql/client.graphql
@@ -2,16 +2,60 @@ extend type PaginatedResultInfo {
   moreAfter: Boolean!
 }
 
-type ImageTransformParam {
+type ImageTransformParams {
   height: ImageSizeTransform
   width: ImageSizeTransform
   keepAspectRatio: Boolean
 }
 
-extend type Query {
+type ImageQueryParams {
+  small: ImageTransformParams
+  medium: ImageTransformParams
+}
+
+type ProfileQueryParams {
+  cover: ImageTransformParams
+  thumbnail: ImageTransformParams
+  metadataSource: AppId
+}
+
+type QueryParams {
+  image: ImageQueryParams
+  profile: ProfileQueryParams
   fxRateFor: SupportedFiatType
-  profileCoverSize: ImageTransformParam
-  profilePictureSize: ImageTransformParam
-  imageSmallSize: ImageTransformParam
-  imageMediumSize: ImageTransformParam
+}
+
+extend type Query {
+  queryParams: QueryParams!
+}
+
+fragment InjectQueryParams on Query {
+  queryParams @client {
+    image {
+      small @export(as: "imageSmallSize") {
+        height
+        width
+        keepAspectRatio
+      }
+      medium @export(as: "imageMediumSize") {
+        height
+        width
+        keepAspectRatio
+      }
+    }
+    profile {
+      cover @export(as: "profileCoverSize") {
+        height
+        width
+        keepAspectRatio
+      }
+      thumbnail @export(as: "profilePictureSize") {
+        height
+        width
+        keepAspectRatio
+      }
+      metadataSource @export(as: "profileMetadataSource")
+    }
+    fxRateFor @export(as: "fxRateFor")
+  }
 }
diff --git a/packages/api-bindings/src/lens/graphql/explore.graphql b/packages/api-bindings/src/lens/graphql/explore.graphql
@@ -16,10 +16,11 @@ query ExplorePublications(
   $imageMediumSize: ImageTransform = {}
   $profileCoverSize: ImageTransform = {}
   $profilePictureSize: ImageTransform = {}
-  $activityOn: [AppId!]
+  $statsFor: [AppId!]
   $fxRateFor: SupportedFiatType = USD
+  $profileMetadataSource: AppId = null
 ) {
-  ...InjectCommonQueryParams
+  ...InjectQueryParams
   result: explorePublications(
     request: { orderBy: $orderBy, where: $where, limit: $limit, cursor: $cursor }
   ) {
@@ -39,10 +40,11 @@ query ExploreProfiles(
   $cursor: Cursor
   $profileCoverSize: ImageTransform = {}
   $profilePictureSize: ImageTransform = {}
-  $activityOn: [AppId!]
+  $statsFor: [AppId!]
   $fxRateFor: SupportedFiatType = USD
+  $profileMetadataSource: AppId = null
 ) {
-  ...InjectCommonQueryParams
+  ...InjectQueryParams
   result: exploreProfiles(
     request: { where: $where, orderBy: $orderBy, limit: $limit, cursor: $cursor }
   ) {

diff --git a/packages/api-bindings/src/lens/graphql/feed.graphql b/packages/api-bindings/src/lens/graphql/feed.graphql
@@ -38,8 +38,9 @@ query Feed(
   $imageMediumSize: ImageTransform = {}
   $profileCoverSize: ImageTransform = {}
   $profilePictureSize: ImageTransform = {}
-  $activityOn: [AppId!]
+  $statsFor: [AppId!]
   $fxRateFor: SupportedFiatType = USD
+  $profileMetadataSource: AppId = null
 ) {
   result: feed(request: { where: $where, cursor: $cursor }) {
     items {
@@ -68,10 +69,11 @@ query FeedHighlights(
   $imageMediumSize: ImageTransform = {}
   $profileCoverSize: ImageTransform = {}
   $profilePictureSize: ImageTransform = {}
-  $activityOn: [AppId!]
+  $statsFor: [AppId!]
   $fxRateFor: SupportedFiatType = USD
+  $profileMetadataSource: AppId = null
 ) {
-  ...InjectCommonQueryParams
+  ...InjectQueryParams
   result: feedHighlights(request: { where: $where, limit: $limit, cursor: $cursor }) {
     items {
       ...FeedHighlight
@@ -91,7 +93,7 @@ query FeedHighlights(
 #  $profilePictureSize: ImageTransform = {}
 #  $fxRateFor: SupportedFiatType = USD
 #) {
-#  ...InjectCommonQueryParams
+#  ...InjectQueryParams
 #  result: forYou(request: $request) {
 #    items {
 #      ... on Post {