feat: docs and examples for publication submodule

examples/node/scripts/publication/fetchAll.ts

@@ -1,4 +1,4 @@
-import { LensClient, development } from "@lens-protocol/client";
+import { LensClient, development, isPostPublication } from "@lens-protocol/client";
 
 async function main() {
   const client = new LensClient({
@@ -13,11 +13,25 @@ async function main() {
   });
 
   console.log(
-    `Publications from profileId ${profileId}: `,
+    `All publications from profileId ${profileId}: `,
     result.items.map((p) => ({
       id: p.id,
     }))
   );
+
+  const posts = result.items.filter(isPostPublication);
+
+  console.log(
+    `Only posts: `,
+    JSON.stringify(
+      posts.map((i) => ({
+        id: i.id,
+        metadata: i.metadata,
+      })),
+      null,
+      2
+    )
+  );
 }
 
 main();

examples/node/scripts/publication/hide.ts

@@ -0,0 +1,18 @@
+import { getAuthenticatedClientFromEthersWallet } from "../shared/getAuthenticatedClient";
+import { setupWallet } from "../shared/setupWallet";
+
+async function main() {
+  const wallet = setupWallet();
+  const client = await getAuthenticatedClientFromEthersWallet(wallet);
+
+  // get user's publications
+  // hide one of them
+
+  const result = await client.publication.hide({
+    for: "0x014e-0x0a",
+  });
+
+  console.log(`Publication was hidden: `, result);
+}
+
+main();

examples/node/scripts/publication/report.ts

@@ -0,0 +1,26 @@
+import {
+  PublicationReportingReason,
+  PublicationReportingSpamSubreason,
+} from "@lens-protocol/client";
+import { getAuthenticatedClientFromEthersWallet } from "../shared/getAuthenticatedClient";
+import { setupWallet } from "../shared/setupWallet";
+
+async function main() {
+  const wallet = setupWallet();
+  const client = await getAuthenticatedClientFromEthersWallet(wallet);
+
+  const result = await client.publication.report({
+    for: "0x014e-0x0a",
+    reason: {
+      spamReason: {
+        reason: PublicationReportingReason.Spam,
+        subreason: PublicationReportingSpamSubreason.FakeEngagement,
+      },
+    },
+    additionalComments: "comment",
+  });
+
+  console.log(`Publication was hidden: `, result);
+}
+
+main();

packages/client/codegen-api.yml

@@ -16,14 +16,13 @@ config:
     CreateHandle: string
     Cursor: string
     DateTime: string
+    EncryptedPath: string
     EncryptedValue: string
     Ens: string
     EvmAddress: string
     Handle: string
     ImageSizeTransform: ImageSizeTransform
-    IpfsCid: string
     Jwt: string
-    # TODO: should 'Scalar' be appended here?
     LimitScalar: number
     Locale: string
     Markdown: string
@@ -33,6 +32,7 @@ config:
     NftGalleryId: string
     NftGalleryName: string
     Nonce: string
+    OnchainPublicationId: string
     ProfileId: string
     PublicationId: string
     Signature: string
@@ -42,8 +42,8 @@ config:
     UnixTimestamp: string
     URI: string
     URL: string
+    UUID: string
     Void: string
-    OnchainPublicationId: string
 
   avoidOptionals:
     field: true