feat: created frame module (#172)

coinbase · Feb 22, 2024 · 605ce64 · 605ce64
1 parent c78fb08
commit 605ce64
Show file tree

Hide file tree

Showing 20 changed files with 32 additions and 19 deletions.
diff --git a/.changeset/orange-rockets-collect.md b/.changeset/orange-rockets-collect.md
@@ -0,0 +1,5 @@
+---
+'@coinbase/onchainkit': patch
+---
+
+- **feat**: created `frame` module. By @zizzamia #172
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,8 @@
 
 ### Minor Changes
 
-- 311b027: - **feat**: prep the identity `identity` module. By @zizzamia #171
-  - **feat**: added initial version of `getEASAttestations`, which helps getting the user attestations from the Ethereum Attetation Service (EAS). By @alvaroraminelli #126
+- **feat**: prep the identity `identity` module. By @zizzamia #171 311b027
+- **feat**: added initial version of `getEASAttestations`, which helps getting the user attestations from the Ethereum Attetation Service (EAS). By @alvaroraminelli #126
 
 ## 0.8.2
 

diff --git a/package.json b/package.json
@@ -105,6 +105,16 @@
       },
       "default": "./lib/farcaster/index.js"
     },
+    "./frame": {
+      "types": "./lib/frame/index.d.ts",
+      "browser": {
+        "types": "./esm/frame/index.d.ts",
+        "module": "./esm/frame/index.js",
+        "import": "./esm/frame/index.js",
+        "default": "./lib/frame/index.js"
+      },
+      "default": "./lib/frame/index.js"
+    },
     "./identity": {
       "types": "./lib/identity/index.d.ts",
       "browser": {

diff --git a/src/core/index.ts b/src/core/index.ts
@@ -1,10 +1,10 @@
 // 🌲☀️🌲
 // This file is the entry point for the core utilities
 // that have no dependencies on external libraries.
-export { getFrameHtmlResponse } from './getFrameHtmlResponse';
-export { getFrameMetadata } from './getFrameMetadata';
-export { getFrameMessage } from './getFrameMessage';
-export { getMockFrameRequest } from './getMockFrameRequest';
+export { getFrameHtmlResponse } from '../frame/getFrameHtmlResponse';
+export { getFrameMetadata } from '../frame/getFrameMetadata';
+export { getFrameMessage } from '../frame/getFrameMessage';
+export { getMockFrameRequest } from '../frame/getMockFrameRequest';
 export type {
   FrameButtonMetadata,
   FrameImageMetadata,
@@ -15,4 +15,4 @@ export type {
   FrameValidationData,
   MockFrameRequest,
   MockFrameRequestOptions,
-} from './types';
+} from '../frame/types';
diff --git a/src/frame/FrameMetadata.test.tsx → src/frame/components/FrameMetadata.test.tsx b/src/frame/FrameMetadata.test.tsx → src/frame/components/FrameMetadata.test.tsx
diff --git a/src/frame/FrameMetadata.tsx → src/frame/components/FrameMetadata.tsx b/src/frame/FrameMetadata.tsx → src/frame/components/FrameMetadata.tsx
@@ -1,5 +1,5 @@
 import { Fragment } from 'react';
-import type { FrameMetadataReact } from '../core/types';
+import type { FrameMetadataReact } from '../types';
 
 /**
  * FrameMetadata component

diff --git a/src/core/getFrameHtmlResponse.test.ts → src/frame/getFrameHtmlResponse.test.ts b/src/core/getFrameHtmlResponse.test.ts → src/frame/getFrameHtmlResponse.test.ts
diff --git a/src/core/getFrameHtmlResponse.ts → src/frame/getFrameHtmlResponse.ts b/src/core/getFrameHtmlResponse.ts → src/frame/getFrameHtmlResponse.ts
diff --git a/src/core/getFrameMessage.integ.ts → src/frame/getFrameMessage.integ.ts b/src/core/getFrameMessage.integ.ts → src/frame/getFrameMessage.integ.ts
diff --git a/src/core/getFrameMessage.test.ts → src/frame/getFrameMessage.test.ts b/src/core/getFrameMessage.test.ts → src/frame/getFrameMessage.test.ts
diff --git a/src/core/getFrameMessage.ts → src/frame/getFrameMessage.ts b/src/core/getFrameMessage.ts → src/frame/getFrameMessage.ts
diff --git a/src/core/getFrameMetadata.test.ts → src/frame/getFrameMetadata.test.ts b/src/core/getFrameMetadata.test.ts → src/frame/getFrameMetadata.test.ts
diff --git a/src/core/getFrameMetadata.ts → src/frame/getFrameMetadata.ts b/src/core/getFrameMetadata.ts → src/frame/getFrameMetadata.ts
diff --git a/src/core/getMockFrameRequest.ts → src/frame/getMockFrameRequest.ts b/src/core/getMockFrameRequest.ts → src/frame/getMockFrameRequest.ts
diff --git a/src/core/mock.ts → src/frame/mock.ts b/src/core/mock.ts → src/frame/mock.ts
diff --git a/src/core/types.ts → src/frame/types.ts b/src/core/types.ts → src/frame/types.ts
diff --git a/src/index.ts b/src/index.ts
@@ -1,10 +1,10 @@
 // 🌲☀️🌲
 export { version } from './version';
-export { getFrameHtmlResponse } from './core/getFrameHtmlResponse';
-export { getFrameMetadata } from './core/getFrameMetadata';
-export { getFrameMessage } from './core/getFrameMessage';
-export { getMockFrameRequest } from './core/getMockFrameRequest';
-export { FrameMetadata } from './frame/FrameMetadata';
+export { getFrameHtmlResponse } from './frame/getFrameHtmlResponse';
+export { getFrameMetadata } from './frame/getFrameMetadata';
+export { getFrameMessage } from './frame/getFrameMessage';
+export { getMockFrameRequest } from './frame/getMockFrameRequest';
+export { FrameMetadata } from './frame/components/FrameMetadata';
 export { Avatar } from './identity/components/Avatar';
 export { Name } from './identity/components/Name';
 export { useAvatar } from './identity/hooks/useAvatar';
@@ -19,4 +19,4 @@ export type {
   FrameValidationData,
   MockFrameRequest,
   MockFrameRequestOptions,
-} from './core/types';
+} from './frame/types';
diff --git a/src/utils/neynar/frame/neynarFrameFunctions.ts b/src/utils/neynar/frame/neynarFrameFunctions.ts
@@ -1,6 +1,4 @@
-import { version } from '../../../version';
-import { FrameValidationData } from '../../../core/types';
-import { FetchError } from '../exceptions/FetchError';
+import { FrameValidationData } from '../../../frame/types';
 import { convertToNeynarResponseModel } from './neynarFrameModels';
 import { postDataToNeynar } from '../postDataToNeynar';
 

diff --git a/src/utils/neynar/frame/neynarFrameModels.ts b/src/utils/neynar/frame/neynarFrameModels.ts
@@ -1,4 +1,4 @@
-import { FrameValidationData } from '../../../core/types';
+import { FrameValidationData } from '../../../frame/types';
 import { NeynarFrameValidationInternalModel } from './types';
 
 export function convertToNeynarResponseModel(data: any): FrameValidationData | undefined {

diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const version = '0.9.0';
+export const version = '0.9.1';