@farcaster/frame-core 0.0.28 → 0.0.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/LICENSE +21 -0
  2. package/esm/actions/AddFrame.d.ts +27 -23
  3. package/esm/actions/AddFrame.js +9 -9
  4. package/esm/actions/Ready.d.ts +11 -11
  5. package/esm/actions/Ready.js +2 -2
  6. package/esm/actions/SignIn.d.ts +35 -33
  7. package/esm/actions/SignIn.js +5 -5
  8. package/esm/actions/Swap.d.ts +44 -43
  9. package/esm/actions/Swap.js +1 -1
  10. package/esm/actions/ViewProfile.d.ts +3 -3
  11. package/esm/actions/ViewProfile.js +1 -1
  12. package/esm/actions/ViewToken.d.ts +3 -3
  13. package/esm/actions/ViewToken.js +1 -1
  14. package/esm/actions/index.d.ts +6 -6
  15. package/esm/actions/index.js +6 -6
  16. package/esm/context.d.ts +65 -61
  17. package/esm/context.js +1 -1
  18. package/esm/errors.d.ts +9 -7
  19. package/esm/errors.js +6 -6
  20. package/esm/index.d.ts +5 -5
  21. package/esm/index.js +5 -5
  22. package/esm/internal/types.d.ts +18 -7
  23. package/esm/internal/types.js +1 -1
  24. package/esm/schemas/embeds.d.ts +346 -239
  25. package/esm/schemas/embeds.js +31 -23
  26. package/esm/schemas/events.d.ts +225 -129
  27. package/esm/schemas/events.js +17 -17
  28. package/esm/schemas/index.d.ts +5 -5
  29. package/esm/schemas/index.js +5 -5
  30. package/esm/schemas/manifest.d.ts +154 -110
  31. package/esm/schemas/manifest.js +29 -23
  32. package/esm/schemas/notifications.d.ts +86 -58
  33. package/esm/schemas/notifications.js +17 -17
  34. package/esm/schemas/shared.d.ts +53 -35
  35. package/esm/schemas/shared.js +25 -23
  36. package/esm/types.d.ts +70 -51
  37. package/esm/types.js +2 -2
  38. package/esm/wallet/ethereum.d.ts +50 -35
  39. package/esm/wallet/ethereum.js +1 -1
  40. package/esm/wallet/index.d.ts +1 -1
  41. package/esm/wallet/index.js +1 -1
  42. package/package.json +7 -1
package/esm/types.d.ts CHANGED
@@ -1,56 +1,75 @@
1
- import type { AddFrame, Ready, SignIn, Swap, ViewProfile, ViewToken } from './actions';
2
- import type { FrameContext } from './context';
3
- import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
4
- import type { Ethereum } from './wallet';
1
+ import type {
2
+ AddFrame,
3
+ Ready,
4
+ SignIn,
5
+ Swap,
6
+ ViewProfile,
7
+ ViewToken,
8
+ } from './actions'
9
+ import type { FrameContext } from './context'
10
+ import type {
11
+ EventFrameAdded,
12
+ EventFrameRemoved,
13
+ EventNotificationsDisabled,
14
+ EventNotificationsEnabled,
15
+ } from './schemas'
16
+ import type { Ethereum } from './wallet'
5
17
  export type SetPrimaryButtonOptions = {
6
- text: string;
7
- loading?: boolean;
8
- disabled?: boolean;
9
- hidden?: boolean;
10
- };
11
- export * from './wallet/ethereum';
12
- export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready';
13
- export type SignInOptions = SignIn.SignInOptions;
14
- export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
18
+ text: string
19
+ loading?: boolean
20
+ disabled?: boolean
21
+ hidden?: boolean
22
+ }
23
+ export * from './wallet/ethereum'
24
+ export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready'
25
+ export type SignInOptions = SignIn.SignInOptions
26
+ export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
15
27
  export type WireFrameHost = {
16
- context: FrameContext;
17
- close: () => void;
18
- ready: Ready.Ready;
19
- openUrl: (url: string) => void;
20
- signIn: SignIn.WireSignIn;
21
- setPrimaryButton: SetPrimaryButton;
22
- ethProviderRequest: Ethereum.EthProvideRequest;
23
- ethProviderRequestV2: Ethereum.RpcTransport;
24
- eip6963RequestProvider: () => void;
25
- addFrame: AddFrame.WireAddFrame;
26
- viewProfile: ViewProfile.ViewProfile;
27
- viewToken: ViewToken.ViewToken;
28
- swap: Swap.Swap;
29
- };
28
+ context: FrameContext
29
+ close: () => void
30
+ ready: Ready.Ready
31
+ openUrl: (url: string) => void
32
+ signIn: SignIn.WireSignIn
33
+ setPrimaryButton: SetPrimaryButton
34
+ ethProviderRequest: Ethereum.EthProvideRequest
35
+ ethProviderRequestV2: Ethereum.RpcTransport
36
+ eip6963RequestProvider: () => void
37
+ addFrame: AddFrame.WireAddFrame
38
+ viewProfile: ViewProfile.ViewProfile
39
+ viewToken: ViewToken.ViewToken
40
+ swap: Swap.Swap
41
+ }
30
42
  export type FrameHost = {
31
- context: FrameContext;
32
- close: () => void;
33
- ready: Ready.Ready;
34
- openUrl: (url: string) => void;
35
- signIn: SignIn.SignIn;
36
- setPrimaryButton: SetPrimaryButton;
37
- ethProviderRequest: Ethereum.EthProvideRequest;
38
- ethProviderRequestV2: Ethereum.RpcTransport;
39
- /**
40
- * Receive forwarded eip6963:requestProvider events from the frame document.
41
- * Hosts must emit an EventEip6963AnnounceProvider in response.
42
- */
43
- eip6963RequestProvider: () => void;
44
- addFrame: AddFrame.AddFrame;
45
- viewProfile: ViewProfile.ViewProfile;
46
- viewToken: ViewToken.ViewToken;
47
- swap: Swap.Swap;
48
- };
43
+ context: FrameContext
44
+ close: () => void
45
+ ready: Ready.Ready
46
+ openUrl: (url: string) => void
47
+ signIn: SignIn.SignIn
48
+ setPrimaryButton: SetPrimaryButton
49
+ ethProviderRequest: Ethereum.EthProvideRequest
50
+ ethProviderRequestV2: Ethereum.RpcTransport
51
+ /**
52
+ * Receive forwarded eip6963:requestProvider events from the frame document.
53
+ * Hosts must emit an EventEip6963AnnounceProvider in response.
54
+ */
55
+ eip6963RequestProvider: () => void
56
+ addFrame: AddFrame.AddFrame
57
+ viewProfile: ViewProfile.ViewProfile
58
+ viewToken: ViewToken.ViewToken
59
+ swap: Swap.Swap
60
+ }
49
61
  export type EventFrameAddRejected = {
50
- event: 'frame_add_rejected';
51
- reason: AddFrame.AddFrameRejectedReason;
52
- };
62
+ event: 'frame_add_rejected'
63
+ reason: AddFrame.AddFrameRejectedReason
64
+ }
53
65
  export type EventPrimaryButtonClicked = {
54
- event: 'primary_button_clicked';
55
- };
56
- export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | Ethereum.EventEip6963AnnounceProvider;
66
+ event: 'primary_button_clicked'
67
+ }
68
+ export type FrameClientEvent =
69
+ | EventFrameAdded
70
+ | EventFrameAddRejected
71
+ | EventFrameRemoved
72
+ | EventNotificationsEnabled
73
+ | EventNotificationsDisabled
74
+ | EventPrimaryButtonClicked
75
+ | Ethereum.EventEip6963AnnounceProvider
package/esm/types.js CHANGED
@@ -1,3 +1,3 @@
1
1
  // start backwards compat, remove in 1.0
2
- export * from './wallet/ethereum';
3
- export { DEFAULT_READY_OPTIONS } from './actions/Ready';
2
+ export * from './wallet/ethereum'
3
+ export { DEFAULT_READY_OPTIONS } from './actions/Ready'
@@ -1,43 +1,58 @@
1
- import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
2
- export type EthProvideRequest<schema extends RpcSchema.Generic = RpcSchema.Default> = Provider.RequestFn<schema>;
1
+ import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
2
+ export type EthProvideRequest<
3
+ schema extends RpcSchema.Generic = RpcSchema.Default,
4
+ > = Provider.RequestFn<schema>
3
5
  export type FrameEthProviderEventData = {
4
- type: 'frame_eth_provider_event';
5
- } & EthProviderWireEvent;
6
- export type RpcTransport = (request: RpcRequest.RpcRequest) => Promise<RpcResponse.RpcResponse>;
6
+ type: 'frame_eth_provider_event'
7
+ } & EthProviderWireEvent
8
+ export type RpcTransport = (
9
+ request: RpcRequest.RpcRequest,
10
+ ) => Promise<RpcResponse.RpcResponse>
7
11
  export type ProviderRpcError = {
8
- code: number;
9
- details?: string;
10
- message?: string;
11
- };
12
- export type EthProviderWireEvent = {
13
- event: 'accountsChanged';
14
- params: [readonly Address.Address[]];
15
- } | {
16
- event: 'chainChanged';
17
- params: [string];
18
- } | {
19
- event: 'connect';
20
- params: [Provider.ConnectInfo];
21
- } | {
22
- event: 'disconnect';
23
- params: [ProviderRpcError];
24
- } | {
25
- event: 'message';
26
- params: [Provider.Message];
27
- };
28
- export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(event: event, params: Extract<EthProviderWireEvent, {
29
- event: event;
30
- }>['params']) => void;
12
+ code: number
13
+ details?: string
14
+ message?: string
15
+ }
16
+ export type EthProviderWireEvent =
17
+ | {
18
+ event: 'accountsChanged'
19
+ params: [readonly Address.Address[]]
20
+ }
21
+ | {
22
+ event: 'chainChanged'
23
+ params: [string]
24
+ }
25
+ | {
26
+ event: 'connect'
27
+ params: [Provider.ConnectInfo]
28
+ }
29
+ | {
30
+ event: 'disconnect'
31
+ params: [ProviderRpcError]
32
+ }
33
+ | {
34
+ event: 'message'
35
+ params: [Provider.Message]
36
+ }
37
+ export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(
38
+ event: event,
39
+ params: Extract<
40
+ EthProviderWireEvent,
41
+ {
42
+ event: event
43
+ }
44
+ >['params'],
45
+ ) => void
31
46
  /**
32
47
  * Metadata of the EIP-1193 Provider.
33
48
  */
34
49
  export interface EIP6963ProviderInfo {
35
- icon: `data:image/${string}`;
36
- name: string;
37
- rdns: string;
38
- uuid: string;
50
+ icon: `data:image/${string}`
51
+ name: string
52
+ rdns: string
53
+ uuid: string
39
54
  }
40
55
  export type EventEip6963AnnounceProvider = {
41
- event: 'eip6963:announceProvider';
42
- info: EIP6963ProviderInfo;
43
- };
56
+ event: 'eip6963:announceProvider'
57
+ info: EIP6963ProviderInfo
58
+ }
@@ -1 +1 @@
1
- export {};
1
+ export {}
@@ -1 +1 @@
1
- export * as Ethereum from './ethereum';
1
+ export * as Ethereum from './ethereum'
@@ -1 +1 @@
1
- export * as Ethereum from './ethereum';
1
+ export * as Ethereum from './ethereum'
package/package.json CHANGED
@@ -1,6 +1,12 @@
1
1
  {
2
2
  "name": "@farcaster/frame-core",
3
- "version": "0.0.28",
3
+ "version": "0.0.29",
4
+ "license": "MIT",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/farcasterxyz/frames.git",
8
+ "directory": "packages/frame-core"
9
+ },
4
10
  "main": "dist/index.js",
5
11
  "module": "esm/index.js",
6
12
  "files": [