@farcaster/hub-web 0.2.1 → 0.2.2

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.
package/README.md CHANGED
@@ -22,14 +22,14 @@ pnpm install @farcaster/hub-web
22
22
  ### Fetching Data from Hubs
23
23
 
24
24
  ```typescript
25
- import { getInsecureHubRpcClient } from '@farcaster/hub-web';
25
+ import { getHubRpcClient } from '@farcaster/hub-web';
26
26
 
27
27
  (async () => {
28
28
  // if you are testing from a node environment
29
- // const client = getInsecureHubRpcClient('testnet1.farcaster.xyz:2284', false);
29
+ // const client = getHubRpcClient('https://testnet1.farcaster.xyz:2284', false);
30
30
 
31
- // if you are testing from a braowser environment
32
- const client = getInsecureHubRpcClient('testnet1.farcaster.xyz:2284');
31
+ // if you are testing from a browser environment
32
+ const client = getHubRpcClient('https://testnet1.farcaster.xyz:2284');
33
33
 
34
34
  const castsResult = await client.getCastsByFid({ fid: 7884 });
35
35
 
package/dist/index.d.ts CHANGED
@@ -2,6 +2,7 @@ import { HubResult } from '@farcaster/core';
2
2
  export * from '@farcaster/core';
3
3
  import { grpc } from '@improbable-eng/grpc-web';
4
4
  import { Observable } from 'rxjs';
5
+ export { Observable } from 'rxjs';
5
6
  import _m0 from 'protobufjs/minimal';
6
7
 
7
8
  declare enum NameRegistryEventType {
@@ -7879,6 +7880,9 @@ declare class GrpcWebError extends tsProtoGlobalThis.Error {
7879
7880
  constructor(message: string, code: grpc.Code, metadata: grpc.Metadata);
7880
7881
  }
7881
7882
 
7883
+ declare const Code: typeof grpc.Code;
7884
+ declare const Metadata: typeof grpc.Metadata;
7885
+
7882
7886
  type OriginalUnaryCall<T, U> = (request: T, metadata?: grpc.Metadata) => Promise<U>;
7883
7887
  type WrappedUnaryCall<T, U> = (request: T, metadata?: grpc.Metadata) => Promise<HubResult<U>>;
7884
7888
  type OriginalStream<T, U> = (request: T, metadata?: grpc.Metadata) => Observable<U>;
@@ -7889,9 +7893,9 @@ type WrappedClient<C> = {
7889
7893
  [prop in keyof C]: C[prop] extends OriginalUnaryCall<infer T, infer U> ? WrappedUnaryCall<T, U> : C[prop] extends OriginalStream<infer T, infer U> ? WrappedStream<T, U> : never;
7890
7894
  };
7891
7895
  type HubRpcClient = WrappedClient<HubService>;
7892
- declare const getSSLHubRpcClient: (address: string, isBrowser?: boolean) => HubRpcClient;
7893
- declare const getInsecureHubRpcClient: (address: string, isBrowser?: boolean) => HubRpcClient;
7896
+ declare const getHubRpcClient: (url: string, isBrowser?: boolean) => HubRpcClient;
7894
7897
  type AdminRpcClient = WrappedClient<AdminService>;
7895
- declare const getAdminRpcClient: (address: string, isBrowser?: boolean) => AdminRpcClient;
7898
+ declare const getAdminRpcClient: (url: string, isBrowser?: boolean) => AdminRpcClient;
7899
+ declare const getAuthMetadata: (username: string, password: string) => grpc.Metadata;
7896
7900
 
7897
- export { AdminRpcClient, AdminService, AdminServiceClientImpl, AdminServiceDeleteAllMessagesFromDbDesc, AdminServiceDesc, AdminServiceRebuildSyncTrieDesc, AdminServiceSubmitIdRegistryEventDesc, AdminServiceSubmitNameRegistryEventDesc, GrpcWebError, GrpcWebImpl, HubRpcClient, HubService, HubServiceClientImpl, HubServiceDesc, HubServiceGetAllCastMessagesByFidDesc, HubServiceGetAllMessagesBySyncIdsDesc, HubServiceGetAllReactionMessagesByFidDesc, HubServiceGetAllSignerMessagesByFidDesc, HubServiceGetAllSyncIdsByPrefixDesc, HubServiceGetAllUserDataMessagesByFidDesc, HubServiceGetAllVerificationMessagesByFidDesc, HubServiceGetCastDesc, HubServiceGetCastsByFidDesc, HubServiceGetCastsByMentionDesc, HubServiceGetCastsByParentDesc, HubServiceGetEventDesc, HubServiceGetFidsDesc, HubServiceGetIdRegistryEventByAddressDesc, HubServiceGetIdRegistryEventDesc, HubServiceGetInfoDesc, HubServiceGetNameRegistryEventDesc, HubServiceGetReactionDesc, HubServiceGetReactionsByCastDesc, HubServiceGetReactionsByFidDesc, HubServiceGetSignerDesc, HubServiceGetSignersByFidDesc, HubServiceGetSyncMetadataByPrefixDesc, HubServiceGetSyncSnapshotByPrefixDesc, HubServiceGetUserDataByFidDesc, HubServiceGetUserDataDesc, HubServiceGetVerificationDesc, HubServiceGetVerificationsByFidDesc, HubServiceSubmitMessageDesc, HubServiceSubscribeDesc, getAdminRpcClient, getInsecureHubRpcClient, getSSLHubRpcClient };
7901
+ export { AdminRpcClient, AdminService, AdminServiceClientImpl, AdminServiceDeleteAllMessagesFromDbDesc, AdminServiceDesc, AdminServiceRebuildSyncTrieDesc, AdminServiceSubmitIdRegistryEventDesc, AdminServiceSubmitNameRegistryEventDesc, Code, GrpcWebError, GrpcWebImpl, HubRpcClient, HubService, HubServiceClientImpl, HubServiceDesc, HubServiceGetAllCastMessagesByFidDesc, HubServiceGetAllMessagesBySyncIdsDesc, HubServiceGetAllReactionMessagesByFidDesc, HubServiceGetAllSignerMessagesByFidDesc, HubServiceGetAllSyncIdsByPrefixDesc, HubServiceGetAllUserDataMessagesByFidDesc, HubServiceGetAllVerificationMessagesByFidDesc, HubServiceGetCastDesc, HubServiceGetCastsByFidDesc, HubServiceGetCastsByMentionDesc, HubServiceGetCastsByParentDesc, HubServiceGetEventDesc, HubServiceGetFidsDesc, HubServiceGetIdRegistryEventByAddressDesc, HubServiceGetIdRegistryEventDesc, HubServiceGetInfoDesc, HubServiceGetNameRegistryEventDesc, HubServiceGetReactionDesc, HubServiceGetReactionsByCastDesc, HubServiceGetReactionsByFidDesc, HubServiceGetSignerDesc, HubServiceGetSignersByFidDesc, HubServiceGetSyncMetadataByPrefixDesc, HubServiceGetSyncSnapshotByPrefixDesc, HubServiceGetUserDataByFidDesc, HubServiceGetUserDataDesc, HubServiceGetVerificationDesc, HubServiceGetVerificationsByFidDesc, HubServiceSubmitMessageDesc, HubServiceSubscribeDesc, Metadata, getAdminRpcClient, getAuthMetadata, getHubRpcClient };
package/dist/index.js CHANGED
@@ -13007,6 +13007,7 @@ __export(src_exports, {
13007
13007
  AdminServiceRebuildSyncTrieDesc: () => AdminServiceRebuildSyncTrieDesc,
13008
13008
  AdminServiceSubmitIdRegistryEventDesc: () => AdminServiceSubmitIdRegistryEventDesc,
13009
13009
  AdminServiceSubmitNameRegistryEventDesc: () => AdminServiceSubmitNameRegistryEventDesc,
13010
+ Code: () => Code,
13010
13011
  GrpcWebError: () => GrpcWebError,
13011
13012
  GrpcWebImpl: () => GrpcWebImpl,
13012
13013
  HubServiceClientImpl: () => HubServiceClientImpl,
@@ -13041,9 +13042,10 @@ __export(src_exports, {
13041
13042
  HubServiceGetVerificationsByFidDesc: () => HubServiceGetVerificationsByFidDesc,
13042
13043
  HubServiceSubmitMessageDesc: () => HubServiceSubmitMessageDesc,
13043
13044
  HubServiceSubscribeDesc: () => HubServiceSubscribeDesc,
13045
+ Metadata: () => Metadata,
13044
13046
  getAdminRpcClient: () => getAdminRpcClient,
13045
- getInsecureHubRpcClient: () => getInsecureHubRpcClient,
13046
- getSSLHubRpcClient: () => getSSLHubRpcClient
13047
+ getAuthMetadata: () => getAuthMetadata,
13048
+ getHubRpcClient: () => getHubRpcClient
13047
13049
  });
13048
13050
  module.exports = __toCommonJS(src_exports);
13049
13051
  init_cjs_shims();
@@ -17760,6 +17762,7 @@ var GrpcWebError = class extends tsProtoGlobalThis6.Error {
17760
17762
  // src/client.ts
17761
17763
  init_cjs_shims();
17762
17764
  var import_grpc_web_node_http_transport = require("@improbable-eng/grpc-web-node-http-transport");
17765
+ var import_grpc_web2 = require("@improbable-eng/grpc-web");
17763
17766
 
17764
17767
  // ../../node_modules/neverthrow/dist/index.es.js
17765
17768
  init_cjs_shims();
@@ -18171,13 +18174,15 @@ var fromThrowable = Result.fromThrowable;
18171
18174
  var import_core = require("@farcaster/core");
18172
18175
  var import_rxjs2 = __toESM(require_cjs());
18173
18176
  var import_operators2 = __toESM(require_operators());
18177
+ var Code = import_grpc_web2.grpc.Code;
18178
+ var Metadata = import_grpc_web2.grpc.Metadata;
18174
18179
  var fromServiceError = (err2) => {
18175
18180
  let context = err2["message"];
18176
18181
  if (err2.code === 14 && context === "No connection established") {
18177
18182
  context = "Connection failed: please check that the hub\u2019s address, ports and authentication config are correct. " + context;
18178
18183
  return new import_core.HubError("unavailable", context);
18179
18184
  }
18180
- return new import_core.HubError("unknown", context);
18185
+ return new import_core.HubError(err2.metadata.get("errcode")[0], context);
18181
18186
  };
18182
18187
  var wrapClient = (client) => {
18183
18188
  return new Proxy(client, {
@@ -18210,18 +18215,24 @@ var wrapClient = (client) => {
18210
18215
  }
18211
18216
  });
18212
18217
  };
18213
- var getSSLHubRpcClient = (address, isBrowser = true) => {
18214
- throw new Error("getSSLHubRpcClient not implemented");
18218
+ var getHubRpcClient = (url, isBrowser = true) => {
18219
+ return wrapClient(new HubServiceClientImpl(getRpcWebClient(url, isBrowser)));
18215
18220
  };
18216
- var getInsecureHubRpcClient = (address, isBrowser = true) => {
18217
- return wrapClient(new HubServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
18218
- };
18219
- var getAdminRpcClient = (address, isBrowser = true) => {
18220
- return wrapClient(new AdminServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
18221
+ var getAdminRpcClient = (url, isBrowser = true) => {
18222
+ return wrapClient(new AdminServiceClientImpl(getRpcWebClient(url, isBrowser)));
18221
18223
  };
18222
18224
  var getRpcWebClient = (address, isBrowser = true) => {
18223
18225
  return new GrpcWebImpl(address, isBrowser ? {} : { transport: (0, import_grpc_web_node_http_transport.NodeHttpTransport)() });
18224
18226
  };
18227
+ var getAuthMetadata = (username, password) => {
18228
+ const metadata = new import_grpc_web2.grpc.Metadata();
18229
+ if (typeof btoa === "undefined") {
18230
+ metadata.set("authorization", `Basic ${Buffer.from(`${username}:${password}`).toString("base64")}`);
18231
+ } else {
18232
+ metadata.set("authorization", `Basic ${btoa(`${username}:${password}`)}`);
18233
+ }
18234
+ return metadata;
18235
+ };
18225
18236
  // Annotate the CommonJS export names for ESM import in node:
18226
18237
  0 && (module.exports = {
18227
18238
  AdminServiceClientImpl,
@@ -18230,6 +18241,7 @@ var getRpcWebClient = (address, isBrowser = true) => {
18230
18241
  AdminServiceRebuildSyncTrieDesc,
18231
18242
  AdminServiceSubmitIdRegistryEventDesc,
18232
18243
  AdminServiceSubmitNameRegistryEventDesc,
18244
+ Code,
18233
18245
  GrpcWebError,
18234
18246
  GrpcWebImpl,
18235
18247
  HubServiceClientImpl,
@@ -18264,7 +18276,8 @@ var getRpcWebClient = (address, isBrowser = true) => {
18264
18276
  HubServiceGetVerificationsByFidDesc,
18265
18277
  HubServiceSubmitMessageDesc,
18266
18278
  HubServiceSubscribeDesc,
18279
+ Metadata,
18267
18280
  getAdminRpcClient,
18268
- getInsecureHubRpcClient,
18269
- getSSLHubRpcClient
18281
+ getAuthMetadata,
18282
+ getHubRpcClient
18270
18283
  });
package/dist/index.mjs CHANGED
@@ -17706,6 +17706,7 @@ var GrpcWebError = class extends tsProtoGlobalThis6.Error {
17706
17706
  // src/client.ts
17707
17707
  init_esm_shims();
17708
17708
  import { NodeHttpTransport } from "@improbable-eng/grpc-web-node-http-transport";
17709
+ import { grpc as grpc2 } from "@improbable-eng/grpc-web";
17709
17710
 
17710
17711
  // ../../node_modules/neverthrow/dist/index.es.js
17711
17712
  init_esm_shims();
@@ -18117,13 +18118,15 @@ var fromThrowable = Result.fromThrowable;
18117
18118
  var import_rxjs2 = __toESM(require_cjs());
18118
18119
  var import_operators2 = __toESM(require_operators());
18119
18120
  import { HubError } from "@farcaster/core";
18121
+ var Code = grpc2.Code;
18122
+ var Metadata = grpc2.Metadata;
18120
18123
  var fromServiceError = (err2) => {
18121
18124
  let context = err2["message"];
18122
18125
  if (err2.code === 14 && context === "No connection established") {
18123
18126
  context = "Connection failed: please check that the hub\u2019s address, ports and authentication config are correct. " + context;
18124
18127
  return new HubError("unavailable", context);
18125
18128
  }
18126
- return new HubError("unknown", context);
18129
+ return new HubError(err2.metadata.get("errcode")[0], context);
18127
18130
  };
18128
18131
  var wrapClient = (client) => {
18129
18132
  return new Proxy(client, {
@@ -18156,18 +18159,24 @@ var wrapClient = (client) => {
18156
18159
  }
18157
18160
  });
18158
18161
  };
18159
- var getSSLHubRpcClient = (address, isBrowser = true) => {
18160
- throw new Error("getSSLHubRpcClient not implemented");
18162
+ var getHubRpcClient = (url, isBrowser = true) => {
18163
+ return wrapClient(new HubServiceClientImpl(getRpcWebClient(url, isBrowser)));
18161
18164
  };
18162
- var getInsecureHubRpcClient = (address, isBrowser = true) => {
18163
- return wrapClient(new HubServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
18164
- };
18165
- var getAdminRpcClient = (address, isBrowser = true) => {
18166
- return wrapClient(new AdminServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
18165
+ var getAdminRpcClient = (url, isBrowser = true) => {
18166
+ return wrapClient(new AdminServiceClientImpl(getRpcWebClient(url, isBrowser)));
18167
18167
  };
18168
18168
  var getRpcWebClient = (address, isBrowser = true) => {
18169
18169
  return new GrpcWebImpl(address, isBrowser ? {} : { transport: NodeHttpTransport() });
18170
18170
  };
18171
+ var getAuthMetadata = (username, password) => {
18172
+ const metadata = new grpc2.Metadata();
18173
+ if (typeof btoa === "undefined") {
18174
+ metadata.set("authorization", `Basic ${Buffer.from(`${username}:${password}`).toString("base64")}`);
18175
+ } else {
18176
+ metadata.set("authorization", `Basic ${btoa(`${username}:${password}`)}`);
18177
+ }
18178
+ return metadata;
18179
+ };
18171
18180
  export {
18172
18181
  AdminServiceClientImpl,
18173
18182
  AdminServiceDeleteAllMessagesFromDbDesc,
@@ -18175,6 +18184,7 @@ export {
18175
18184
  AdminServiceRebuildSyncTrieDesc,
18176
18185
  AdminServiceSubmitIdRegistryEventDesc,
18177
18186
  AdminServiceSubmitNameRegistryEventDesc,
18187
+ Code,
18178
18188
  GrpcWebError,
18179
18189
  GrpcWebImpl,
18180
18190
  HubServiceClientImpl,
@@ -18209,7 +18219,8 @@ export {
18209
18219
  HubServiceGetVerificationsByFidDesc,
18210
18220
  HubServiceSubmitMessageDesc,
18211
18221
  HubServiceSubscribeDesc,
18222
+ Metadata,
18212
18223
  getAdminRpcClient,
18213
- getInsecureHubRpcClient,
18214
- getSSLHubRpcClient
18224
+ getAuthMetadata,
18225
+ getHubRpcClient
18215
18226
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farcaster/hub-web",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "main": "./dist/index.js",
5
5
  "module": "./dist/index.mjs",
6
6
  "types": "./dist/index.d.ts",