docs

coinbase · Feb 21, 2024 · 20e62d2 · 20e62d2
1 parent 520db0f
commit 20e62d2
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 4 deletions.
diff --git a/site/docs/pages/getting-started.mdx b/site/docs/pages/getting-started.mdx
@@ -53,6 +53,12 @@ OnchainKit is divided into various theme utilities and components that are avail
   - [Framegear](/framekit/framegear)
 
 - [Identity Kit](/identitykit/introduction)
+
   - Components:
     - [`<Avatar />`](/identitykit/avatar)
     - [`<Name />`](/identitykit/name)
+
+- [XMTP Kit](/xmtpkit/introduction)
+  - Utilities:
+    - [`getXmtpFrameMessage`](/xmtpkit/get-xmtp-frame-message)
+    - [`isXmtpFrameRequest`](/xmtpkit/is-xmtp-frame-request)
diff --git a/site/docs/pages/index.mdx b/site/docs/pages/index.mdx
@@ -99,6 +99,7 @@ OnchainKit offers three themes packed with React components and TypeScript utili
 - [XMTP Kit](/xmtpkit/introduction)
   - Utilities:
     - [`getXmtpFrameMessage`](/xmtpkit/get-xmtp-frame-message)
+    - [`isXmtpFrameRequest`](/xmtpkit/is-xmtp-frame-request)
 
 # Community
 

diff --git a/site/docs/pages/xmtpkit/get-xmtp-frame-message.mdx b/site/docs/pages/xmtpkit/get-xmtp-frame-message.mdx
@@ -30,8 +30,8 @@ async function getResponse(req: any): Promise<NextResponse> {
 
 ## Returns
 
-[`Promise<XmtpFrameValidationResponse>`](/framekit/types#xmtpframevalidationresponse)
+[`Promise<XmtpFrameValidationResponse>`](/xmtpkit/types#xmtpframevalidationresponse)
 
 ## Parameters
 
-[`Promise<XmtpFramesRequest>`](/framekit/types#xmtpframesrequest)
+[`Promise<XmtpFramesRequest>`](/xmtpkit/types#xmtpframesrequest)
diff --git a/site/docs/pages/xmtpkit/introduction.mdx b/site/docs/pages/xmtpkit/introduction.mdx
@@ -30,3 +30,4 @@ To assist you in engaging with XMTP, here is the XMTP Kit which includes:
 - [XMTP Kit](/xmtpkit/introduction)
   - Utilities:
     - [`getXmtpFrameMessage`](/xmtpkit/get-xmtp-frame-message)
+    - [`isXmtpFrameRequest`](/xmtpkit/is-xmtp-frame-request)
diff --git a/site/docs/pages/xmtpkit/is-xmtp-frame-request.mdx b/site/docs/pages/xmtpkit/is-xmtp-frame-request.mdx
@@ -1,3 +1,23 @@
 # isXmtpFrameRequest
 
-isXmtpFrameRequest
+```ts
+import { FrameRequest } from '@coinbase/onchainkit';
+import { isXmtpFrameRequest } from '@coinbase/onchainkit/xmtp'; // [!code focus]
+import { NextResponse } from 'next/server';
+
+async function getResponse(req: any): Promise<NextResponse> {
+  const body: FrameRequest = await req.json();
+  if (isXmtpFrameRequest(body)) { // [!code focus]
+    // [!code focus]
+    // ...
+  }
+}
+```
+
+## Returns
+
+- **Type:** `boolean`
+
+## Parameters
+
+[`XmtpFramesRequest`](/xmtpkit/types#xmtpframesrequest)
diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const version = '0.8.0';
+export const version = '0.8.2';
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export const version = '0.8.0';
		export const version = '0.8.2';