Merge pull request #576 from lens-protocol/fix/missing__typename

fix: missing __typename(s) and profile.invitedBy fields

.changeset/config.json

@@ -5,7 +5,7 @@
   "fixed": [["@lens-protocol/react", "@lens-protocol/react-web"]],
   "linked": [],
   "access": "public",
-  "baseBranch": "main",
+  "baseBranch": "lens-v2",
   "updateInternalDependencies": "patch",
   "ignore": ["example-*"]
 }

.changeset/new-doors-sip.md

@@ -0,0 +1,6 @@
+---
+"@lens-protocol/api-bindings": patch
+"@lens-protocol/react": patch
+---
+
+**fix:** adds missing `__typename` and expose `ProfileFields` from `Profile.invitedBy`

.changeset/pre.json

@@ -36,6 +36,7 @@
     "large-cars-know",
     "lemon-drinks-exercise",
     "long-carpets-marry",
+    "new-doors-sip",
     "old-carrots-breathe",
     "shaggy-carrots-cry",
     "shy-pugs-taste",

examples/web/src/publications/components/PublicationCard.tsx

@@ -1,9 +1,38 @@
-import { Comment, Mirror, Post, Quote, isPostPublication } from '@lens-protocol/react';
+import { Comment, Post, AnyPublication, PublicationMetadata } from '@lens-protocol/react';
 
 import { ProfilePicture } from '../../profiles/components/ProfilePicture';
 
+function MetadataSwitch({ metadata }: { metadata: PublicationMetadata }) {
+  switch (metadata.__typename) {
+    case 'ArticleMetadataV3':
+    case 'TextOnlyMetadataV3':
+      return <p>{metadata.content}</p>;
+
+    default:
+      return <p>{metadata.__typename} not supported in this example</p>;
+  }
+}
+
+function PublicationContent({ publication }: { publication: Post | Comment }) {
+  return (
+    <section>
+      <MetadataSwitch metadata={publication.metadata} />
+    </section>
+  );
+}
+
+function PublicationSwitch({ publication }: { publication: AnyPublication }) {
+  switch (publication.__typename) {
+    case 'Post':
+    case 'Comment':
+      return <PublicationContent publication={publication} />;
+    default:
+      return null;
+  }
+}
+
 type PublicationCardProps = {
-  publication: Post | Comment | Mirror | Quote;
+  publication: AnyPublication;
 };
 
 export function PublicationCard({ publication }: PublicationCardProps) {
@@ -14,9 +43,7 @@ export function PublicationCard({ publication }: PublicationCardProps) {
         {publication.__typename} by{' '}
         {publication.by.metadata?.displayName ?? publication.by.handle ?? publication.by.id}
       </p>
-      {isPostPublication(publication) && 'content' in publication.metadata && (
-        <p>{publication.metadata.content}</p>
-      )}
+      <PublicationSwitch publication={publication} />
     </article>
   );
 }

packages/api-bindings/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lens-protocol/api-bindings
 
+## 0.11.0-alpha.2
+
+### Patch Changes
+
+- 6f51659c: **fix:** adds missing `__typename` and expose `ProfileFields` from `Profile.invitedBy`
+
 ## 0.11.0-alpha.1
 
 ### Patch Changes

packages/api-bindings/codegen-api.yml

@@ -86,8 +86,10 @@ generates:
           skipTypename: true
           immutableTypes: false
           inlineFragmentTypes: combine
+          exportFragmentSpreadSubTypes: false # we do not want odd named fragment types ProfilePicture_ImageSet_
           omitOperationSuffix: true
           operationResultSuffix: 'Data'
+          dedupeFragments: true
       - 'typescript-react-apollo':
           pureMagicComment: true # keep
           omitOperationSuffix: true # MUST goes with typescript-operations.omitOperationSuffix

packages/api-bindings/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lens-protocol/api-bindings",
-  "version": "0.11.0-alpha.1",
+  "version": "0.11.0-alpha.2",
   "description": "Graphql fragments, react hooks, typescript types of lens API.",
   "repository": {
     "directory": "packages/api-bindings",

packages/api-bindings/src/lens/MetadataAttribute.ts

@@ -0,0 +1,36 @@
+import {
+  MetadataBooleanAttribute,
+  MetadataDateAttribute,
+  MetadataJsonAttribute,
+  MetadataNumberAttribute,
+  MetadataStringAttribute,
+} from './graphql/generated';
+
+/**
+ * Convenience type for metadata attributes.
+ *
+ * @example
+ * Use this type as prop type for a component that renders metadata attributes.
+ * ```tsx
+ *
+ * function PublicationAttribute({ attribute }: { attribute: MetadataAttribute }) {
+ *   switch (attribute.__typename) {
+ *     case 'MetadataBooleanAttribute':
+ *       return <p><strong>{attribute.key}</strong>{attribute.value === 'true' ? 'Yes' : 'No'}</p>;
+ *
+ *     case 'MetadataDateAttribute':
+ *       return <p><strong>{attribute.key}</strong>{new Date(attribute.value).toLocaleString()}</p>;
+ *
+ *     case 'MetadataNumberAttribute':
+ *       return <p><strong>{attribute.key}</strong>{parseFloat(attribute.value).toFixed(2)}</p>;
+ *
+ *     // ...
+ * }
+ * ```
+ */
+export type MetadataAttribute =
+  | MetadataBooleanAttribute
+  | MetadataDateAttribute
+  | MetadataNumberAttribute
+  | MetadataJsonAttribute
+  | MetadataStringAttribute;

packages/api-bindings/src/lens/__helpers__/fragments.ts

@@ -3,14 +3,19 @@ import { mockProfileId, mockPublicationId, mockTransactionHash } from '@lens-pro
 import { mockEvmAddress } from '@lens-protocol/shared-kernel/mocks';
 
 import {
+  CanDecryptResponse,
   Comment,
   FeedItem,
   Mirror,
+  NetworkAddress,
+  OptimisticStatusResult,
   PaginatedResultInfo,
   Post,
   Profile,
   ProfileActionHistory,
   ProfileActionHistoryType,
+  ProfileOnchainIdentity,
+  ProfileOperations,
   ProfileReactionResult,
   ProfileStats,
   ProfileWhoReactedResult,
@@ -21,6 +26,62 @@ import {
   TriStateValue,
 } from '../graphql/generated';
 
+function mockNetworkAddressFragment(overrides?: Partial<NetworkAddress>): NetworkAddress {
+  return {
+    address: mockEvmAddress(),
+    chainId: 1,
+    ...overrides,
+    __typename: 'NetworkAddress',
+  };
+}
+
+function mockOptimisticStatusResultFragment(
+  overrides?: Partial<OptimisticStatusResult>,
+): OptimisticStatusResult {
+  return {
+    value: true,
+    isFinalisedOnchain: false,
+    ...overrides,
+    __typename: 'OptimisticStatusResult',
+  };
+}
+
+function mockProfileOperationsFragment(overrides?: Partial<ProfileOperations>): ProfileOperations {
+  return {
+    id: mockProfileId(),
+    canBlock: false,
+    canUnblock: false,
+    canFollow: TriStateValue.Unknown,
+    canUnfollow: false,
+    isBlockedByMe: mockOptimisticStatusResultFragment(),
+    isFollowedByMe: mockOptimisticStatusResultFragment(),
+    isFollowingMe: mockOptimisticStatusResultFragment(),
+    ...overrides,
+    __typename: 'ProfileOperations',
+  };
+}
+
+function mockProfileOnchainIdentityFragment(
+  overrides?: Partial<ProfileOnchainIdentity>,
+): ProfileOnchainIdentity {
+  return {
+    proofOfHumanity: false,
+    ens: null,
+    sybilDotOrg: {
+      source: {
+        twitter: {
+          handle: null,
+        },
+      },
+    },
+    worldcoin: {
+      isHuman: false,
+    },
+    ...overrides,
+    __typename: 'ProfileOnchainIdentity',
+  };
+}
+
 export function mockProfileFragment(overrides?: Partial<Profile>): Profile {
   const firstName = faker.name.firstName();
   const lastName = faker.name.lastName();
@@ -34,39 +95,11 @@ export function mockProfileFragment(overrides?: Partial<Profile>): Profile {
     invitesLeft: 0,
     sponsor: false,
     lensManager: false,
-    ownedBy: {
-      address: mockEvmAddress(),
-      chainId: 1,
-    },
-    operations: {
-      id: mockProfileId(),
-      canBlock: false,
-      canUnblock: false,
-      canFollow: TriStateValue.Unknown,
-      canUnfollow: false,
-      isBlockedByMe: { value: false, isFinalisedOnchain: false },
-      isFollowedByMe: { value: false, isFinalisedOnchain: false },
-      isFollowingMe: { value: false, isFinalisedOnchain: false },
-    },
+    ownedBy: mockNetworkAddressFragment(),
+    operations: mockProfileOperationsFragment(),
     guardian: null,
-    onchainIdentity: {
-      proofOfHumanity: false,
-      ens: null,
-      sybilDotOrg: {
-        source: {
-          twitter: {
-            handle: null,
-          },
-        },
-      },
-      worldcoin: {
-        isHuman: false,
-      },
-    },
-    followNftAddress: {
-      address: mockEvmAddress(),
-      chainId: 1,
-    },
+    onchainIdentity: mockProfileOnchainIdentityFragment(),
+    followNftAddress: mockNetworkAddressFragment(),
     followModule: null,
     metadata: null,
     invitedBy: null,
@@ -139,7 +172,9 @@ export function mockMirrorFragment(overrides?: Partial<Omit<Mirror, '__typename'
   };
 }
 
-export function mockPublicationTextOnlyMetadata(overrides: Partial<TextOnlyMetadataV3> = {}) {
+export function mockPublicationTextOnlyMetadata(
+  overrides: Partial<TextOnlyMetadataV3> = {},
+): TextOnlyMetadataV3 {
   return {
     id: faker.helpers.unique(faker.datatype.uuid),
     rawURI: faker.internet.url(),
@@ -154,6 +189,19 @@ export function mockPublicationTextOnlyMetadata(overrides: Partial<TextOnlyMetad
     encryptedWith: null,
 
     ...overrides,
+    __typename: 'TextOnlyMetadataV3',
+  };
+}
+
+function mockCanDecryptResponseFragment(
+  overrides?: Partial<ProfileOperations>,
+): CanDecryptResponse {
+  return {
+    result: false,
+    reasons: null,
+    extraDetails: null,
+    ...overrides,
+    __typename: 'CanDecryptResponse',
   };
 }
 
@@ -170,14 +218,11 @@ export function mockPublicationOperationsFragment(
     hasMirrored: false,
     hasUpvoted: false,
     hasDownvoted: false,
-    hasCollected: { value: false, isFinalisedOnchain: false },
-    canDecrypt: {
-      result: false,
-      reasons: null,
-      extraDetails: null,
-    },
+    hasCollected: mockOptimisticStatusResultFragment(),
+    canDecrypt: mockCanDecryptResponseFragment(),
 
     ...overrides,
+    __typename: 'PublicationOperations',
   };
 }
 
@@ -207,6 +252,7 @@ export function mockPublicationStatsFragment(
     downvotes: faker.datatype.number(),
 
     ...overrides,
+    __typename: 'PublicationStats',
   };
 }
 
@@ -227,6 +273,7 @@ export function mockProfileStatsFragment(overrides: Partial<ProfileStats> = {}):
     downvoted: faker.datatype.number(),
 
     ...overrides,
+    __typename: 'ProfileStats',
   };
 }
 
@@ -239,6 +286,7 @@ export function mockFeedItemFragment(overrides?: Partial<FeedItem>): FeedItem {
     reactions: [],
 
     ...overrides,
+    __typename: 'FeedItem',
   };
 }
 
@@ -264,6 +312,7 @@ export function mockProfileReactionResultFragment(
     reactionAt: faker.date.past().toISOString(),
 
     ...overrides,
+    __typename: 'ProfileReactionResult',
   };
 }
 
@@ -275,5 +324,6 @@ export function mockProfileWhoReactedResultFragment(
     reactions: [mockProfileReactionResultFragment()],
 
     ...overrides,
+    __typename: 'ProfileWhoReactedResult',
   };
 }

packages/api-bindings/src/lens/__helpers__/queries/publication.ts

@@ -7,7 +7,7 @@ import {
   SearchPublicationsDocument,
   SearchPublicationsVariables,
 } from '../../graphql/generated';
-import { AnyPublication, PrimaryPublication } from '../../utils';
+import { AnyPublication, PrimaryPublication } from '../../publication';
 import { mockPaginatedResultInfo } from '../fragments';
 import { mockAnyPaginatedResponse } from './mockAnyPaginatedResponse';
 

packages/api-bindings/src/lens/graphql/auth.graphql

@@ -1,11 +1,12 @@
-fragment AuthChallenge on AuthChallengeResult {
+fragment AuthChallengeResult on AuthChallengeResult {
+  __typename
   id
   text
 }
 
 query AuthChallenge($request: ChallengeRequest!) {
   result: challenge(request: $request) {
-    ...AuthChallenge
+    ...AuthChallengeResult
   }
 }
 

packages/api-bindings/src/lens/graphql/feed.graphql

@@ -7,6 +7,7 @@ fragment ReactionEvent on ReactionEvent {
 }
 
 fragment FeedItem on FeedItem {
+  __typename
   id
   root {
     ... on Post {