@farcaster/frame-core 0.0.27 → 0.0.28

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.
@@ -0,0 +1,13 @@
1
+ export type ReadyOptions = {
2
+ /**
3
+ * Disable native gestures. Use this option if your frame uses gestures
4
+ * that conflict with native gestures.
5
+ *
6
+ * @defaultValue false
7
+ */
8
+ disableNativeGestures: boolean;
9
+ };
10
+ export declare const DEFAULT_READY_OPTIONS: {
11
+ disableNativeGestures: false;
12
+ };
13
+ export type Ready = (options?: Partial<ReadyOptions>) => void;
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DEFAULT_READY_OPTIONS = void 0;
4
+ exports.DEFAULT_READY_OPTIONS = {
5
+ disableNativeGestures: false,
6
+ };
@@ -1,5 +1,6 @@
1
1
  export * as AddFrame from './AddFrame';
2
- export * as ViewProfile from './ViewProfile';
3
- export * as ViewToken from './ViewToken';
2
+ export * as Ready from './Ready';
4
3
  export * as SignIn from './SignIn';
5
4
  export * as Swap from './Swap';
5
+ export * as ViewProfile from './ViewProfile';
6
+ export * as ViewToken from './ViewToken';
@@ -33,9 +33,10 @@ var __importStar = (this && this.__importStar) || (function () {
33
33
  };
34
34
  })();
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.Swap = exports.SignIn = exports.ViewToken = exports.ViewProfile = exports.AddFrame = void 0;
36
+ exports.ViewToken = exports.ViewProfile = exports.Swap = exports.SignIn = exports.Ready = exports.AddFrame = void 0;
37
37
  exports.AddFrame = __importStar(require("./AddFrame"));
38
- exports.ViewProfile = __importStar(require("./ViewProfile"));
39
- exports.ViewToken = __importStar(require("./ViewToken"));
38
+ exports.Ready = __importStar(require("./Ready"));
40
39
  exports.SignIn = __importStar(require("./SignIn"));
41
40
  exports.Swap = __importStar(require("./Swap"));
41
+ exports.ViewProfile = __importStar(require("./ViewProfile"));
42
+ exports.ViewToken = __importStar(require("./ViewToken"));
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from './actions';
2
+ export * from './wallet';
2
3
  export * as Context from './context';
3
4
  export * from './types';
4
5
  export * from './schemas';
package/dist/index.js CHANGED
@@ -38,6 +38,7 @@ var __importStar = (this && this.__importStar) || (function () {
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
39
  exports.Context = void 0;
40
40
  __exportStar(require("./actions"), exports);
41
+ __exportStar(require("./wallet"), exports);
41
42
  exports.Context = __importStar(require("./context"));
42
43
  __exportStar(require("./types"), exports);
43
44
  __exportStar(require("./schemas"), exports);
package/dist/types.d.ts CHANGED
@@ -1,50 +1,26 @@
1
- import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
2
- import type { AddFrame, SignIn, Swap, ViewProfile, ViewToken } from './actions';
1
+ import type { AddFrame, Ready, SignIn, Swap, ViewProfile, ViewToken } from './actions';
3
2
  import type { FrameContext } from './context';
4
3
  import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
4
+ import type { Ethereum } from './wallet';
5
5
  export type SetPrimaryButtonOptions = {
6
6
  text: string;
7
7
  loading?: boolean;
8
8
  disabled?: boolean;
9
9
  hidden?: boolean;
10
10
  };
11
+ export * from './wallet/ethereum';
12
+ export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready';
13
+ export type SignInOptions = SignIn.SignInOptions;
11
14
  export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
12
- export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>;
13
- export type ReadyOptions = {
14
- /**
15
- * Disable native gestures. Use this option if your frame uses gestures
16
- * that conflict with native gestures.
17
- *
18
- * @defaultValue false
19
- */
20
- disableNativeGestures: boolean;
21
- };
22
- export declare const DEFAULT_READY_OPTIONS: ReadyOptions;
23
- export type SignInOptions = {
24
- /**
25
- * A random string used to prevent replay attacks.
26
- */
27
- nonce: string;
28
- /**
29
- * Start time at which the signature becomes valid.
30
- * ISO 8601 datetime.
31
- */
32
- notBefore?: string;
33
- /**
34
- * Expiration time at which the signature is no longer valid.
35
- * ISO 8601 datetime.
36
- */
37
- expirationTime?: string;
38
- };
39
15
  export type WireFrameHost = {
40
16
  context: FrameContext;
41
17
  close: () => void;
42
- ready: (options?: Partial<ReadyOptions>) => void;
18
+ ready: Ready.Ready;
43
19
  openUrl: (url: string) => void;
44
20
  signIn: SignIn.WireSignIn;
45
21
  setPrimaryButton: SetPrimaryButton;
46
- ethProviderRequest: EthProviderRequest;
47
- ethProviderRequestV2: RpcTransport;
22
+ ethProviderRequest: Ethereum.EthProvideRequest;
23
+ ethProviderRequestV2: Ethereum.RpcTransport;
48
24
  eip6963RequestProvider: () => void;
49
25
  addFrame: AddFrame.WireAddFrame;
50
26
  viewProfile: ViewProfile.ViewProfile;
@@ -54,12 +30,12 @@ export type WireFrameHost = {
54
30
  export type FrameHost = {
55
31
  context: FrameContext;
56
32
  close: () => void;
57
- ready: (options?: Partial<ReadyOptions>) => void;
33
+ ready: Ready.Ready;
58
34
  openUrl: (url: string) => void;
59
35
  signIn: SignIn.SignIn;
60
36
  setPrimaryButton: SetPrimaryButton;
61
- ethProviderRequest: EthProviderRequest;
62
- ethProviderRequestV2: RpcTransport;
37
+ ethProviderRequest: Ethereum.EthProvideRequest;
38
+ ethProviderRequestV2: Ethereum.RpcTransport;
63
39
  /**
64
40
  * Receive forwarded eip6963:requestProvider events from the frame document.
65
41
  * Hosts must emit an EventEip6963AnnounceProvider in response.
@@ -70,34 +46,6 @@ export type FrameHost = {
70
46
  viewToken: ViewToken.ViewToken;
71
47
  swap: Swap.Swap;
72
48
  };
73
- export type FrameEthProviderEventData = {
74
- type: 'frame_eth_provider_event';
75
- } & EthProviderWireEvent;
76
- export type RpcTransport = (request: RpcRequest.RpcRequest) => Promise<RpcResponse.RpcResponse>;
77
- export type ProviderRpcError = {
78
- code: number;
79
- details?: string;
80
- message?: string;
81
- };
82
- export type EthProviderWireEvent = {
83
- event: 'accountsChanged';
84
- params: [readonly Address.Address[]];
85
- } | {
86
- event: 'chainChanged';
87
- params: [string];
88
- } | {
89
- event: 'connect';
90
- params: [Provider.ConnectInfo];
91
- } | {
92
- event: 'disconnect';
93
- params: [ProviderRpcError];
94
- } | {
95
- event: 'message';
96
- params: [Provider.Message];
97
- };
98
- export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(event: event, params: Extract<EthProviderWireEvent, {
99
- event: event;
100
- }>['params']) => void;
101
49
  export type EventFrameAddRejected = {
102
50
  event: 'frame_add_rejected';
103
51
  reason: AddFrame.AddFrameRejectedReason;
@@ -105,17 +53,4 @@ export type EventFrameAddRejected = {
105
53
  export type EventPrimaryButtonClicked = {
106
54
  event: 'primary_button_clicked';
107
55
  };
108
- /**
109
- * Metadata of the EIP-1193 Provider.
110
- */
111
- export interface EIP6963ProviderInfo {
112
- icon: `data:image/${string}`;
113
- name: string;
114
- rdns: string;
115
- uuid: string;
116
- }
117
- export type EventEip6963AnnounceProvider = {
118
- event: 'eip6963:announceProvider';
119
- info: EIP6963ProviderInfo;
120
- };
121
- export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | EventEip6963AnnounceProvider;
56
+ export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | Ethereum.EventEip6963AnnounceProvider;
package/dist/types.js CHANGED
@@ -1,6 +1,21 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
2
16
  Object.defineProperty(exports, "__esModule", { value: true });
3
17
  exports.DEFAULT_READY_OPTIONS = void 0;
4
- exports.DEFAULT_READY_OPTIONS = {
5
- disableNativeGestures: false,
6
- };
18
+ // start backwards compat, remove in 1.0
19
+ __exportStar(require("./wallet/ethereum"), exports);
20
+ var Ready_1 = require("./actions/Ready");
21
+ Object.defineProperty(exports, "DEFAULT_READY_OPTIONS", { enumerable: true, get: function () { return Ready_1.DEFAULT_READY_OPTIONS; } });
@@ -0,0 +1,43 @@
1
+ import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
2
+ export type EthProvideRequest<schema extends RpcSchema.Generic = RpcSchema.Default> = Provider.RequestFn<schema>;
3
+ export type FrameEthProviderEventData = {
4
+ type: 'frame_eth_provider_event';
5
+ } & EthProviderWireEvent;
6
+ export type RpcTransport = (request: RpcRequest.RpcRequest) => Promise<RpcResponse.RpcResponse>;
7
+ 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;
31
+ /**
32
+ * Metadata of the EIP-1193 Provider.
33
+ */
34
+ export interface EIP6963ProviderInfo {
35
+ icon: `data:image/${string}`;
36
+ name: string;
37
+ rdns: string;
38
+ uuid: string;
39
+ }
40
+ export type EventEip6963AnnounceProvider = {
41
+ event: 'eip6963:announceProvider';
42
+ info: EIP6963ProviderInfo;
43
+ };
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1 @@
1
+ export * as Ethereum from './ethereum';
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.Ethereum = void 0;
37
+ exports.Ethereum = __importStar(require("./ethereum"));
@@ -0,0 +1,13 @@
1
+ export type ReadyOptions = {
2
+ /**
3
+ * Disable native gestures. Use this option if your frame uses gestures
4
+ * that conflict with native gestures.
5
+ *
6
+ * @defaultValue false
7
+ */
8
+ disableNativeGestures: boolean;
9
+ };
10
+ export declare const DEFAULT_READY_OPTIONS: {
11
+ disableNativeGestures: false;
12
+ };
13
+ export type Ready = (options?: Partial<ReadyOptions>) => void;
@@ -0,0 +1,3 @@
1
+ export const DEFAULT_READY_OPTIONS = {
2
+ disableNativeGestures: false,
3
+ };
@@ -1,5 +1,6 @@
1
1
  export * as AddFrame from './AddFrame';
2
- export * as ViewProfile from './ViewProfile';
3
- export * as ViewToken from './ViewToken';
2
+ export * as Ready from './Ready';
4
3
  export * as SignIn from './SignIn';
5
4
  export * as Swap from './Swap';
5
+ export * as ViewProfile from './ViewProfile';
6
+ export * as ViewToken from './ViewToken';
@@ -1,5 +1,6 @@
1
1
  export * as AddFrame from './AddFrame';
2
- export * as ViewProfile from './ViewProfile';
3
- export * as ViewToken from './ViewToken';
2
+ export * as Ready from './Ready';
4
3
  export * as SignIn from './SignIn';
5
4
  export * as Swap from './Swap';
5
+ export * as ViewProfile from './ViewProfile';
6
+ export * as ViewToken from './ViewToken';
package/esm/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from './actions';
2
+ export * from './wallet';
2
3
  export * as Context from './context';
3
4
  export * from './types';
4
5
  export * from './schemas';
package/esm/index.js CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from './actions';
2
+ export * from './wallet';
2
3
  export * as Context from './context';
3
4
  export * from './types';
4
5
  export * from './schemas';