@farcaster/hub-web 0.2.1 → 0.2.3

package/README.md

@@ -9,6 +9,8 @@ A lightweight, fast Typescript interface for Farcaster Hubs. Designed to work wi
 - Has helpers to create and sign Farcaster messages.
 - Written entirely in TypeScript, with strict types for safety.
 
+APIs are the same as hub-nodejs (except client initialization). Read the [documentation](https://github.com/farcasterxyz/hubble/tree/main/packages/hub-nodejs/docs), see more [examples](https://github.com/farcasterxyz/hubble/tree/main/packages/hub-nodejs/examples) or get started with the guide below.
+
 ## Installation
 
 Install @farcaster/hub-web with the package manager of your choice
@@ -22,14 +24,14 @@ pnpm install @farcaster/hub-web
 ### Fetching Data from Hubs
 
 ```typescript
-import { getInsecureHubRpcClient } from '@farcaster/hub-web';
+import { getHubRpcClient } from '@farcaster/hub-web';
 
 (async () => {
   // if you are testing from a node environment
-  // const client = getInsecureHubRpcClient('testnet1.farcaster.xyz:2284', false);
+  // const client = getHubRpcClient('https://testnet1.farcaster.xyz:2284', false);
 
-  // if you are testing from a braowser environment
-  const client = getInsecureHubRpcClient('testnet1.farcaster.xyz:2284');
+  // if you are testing from a browser environment
+  const client = getHubRpcClient('https://testnet1.farcaster.xyz:2284');
 
   const castsResult = await client.getCastsByFid({ fid: 7884 });
 

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import { HubResult } from '@farcaster/core';
 export * from '@farcaster/core';
 import { grpc } from '@improbable-eng/grpc-web';
+export { grpc } from '@improbable-eng/grpc-web';
 import { Observable } from 'rxjs';
+export { Observable } from 'rxjs';
 import _m0 from 'protobufjs/minimal';
 
 declare enum NameRegistryEventType {
@@ -7889,9 +7891,9 @@ type WrappedClient<C> = {
     [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;
 };
 type HubRpcClient = WrappedClient<HubService>;
-declare const getSSLHubRpcClient: (address: string, isBrowser?: boolean) => HubRpcClient;
-declare const getInsecureHubRpcClient: (address: string, isBrowser?: boolean) => HubRpcClient;
+declare const getHubRpcClient: (url: string, isBrowser?: boolean) => HubRpcClient;
 type AdminRpcClient = WrappedClient<AdminService>;
-declare const getAdminRpcClient: (address: string, isBrowser?: boolean) => AdminRpcClient;
+declare const getAdminRpcClient: (url: string, isBrowser?: boolean) => AdminRpcClient;
+declare const getAuthMetadata: (username: string, password: string) => grpc.Metadata;
 
-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 };
+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, getAuthMetadata, getHubRpcClient };

package/dist/index.js

@@ -1102,19 +1102,19 @@ var require_Observable = __commonJS({
     var config_1 = require_config();
     var isFunction_1 = require_isFunction();
     var errorContext_1 = require_errorContext();
-    var Observable3 = function() {
-      function Observable4(subscribe) {
+    var Observable4 = function() {
+      function Observable5(subscribe) {
         if (subscribe) {
           this._subscribe = subscribe;
         }
       }
-      Observable4.prototype.lift = function(operator) {
-        var observable = new Observable4();
+      Observable5.prototype.lift = function(operator) {
+        var observable = new Observable5();
         observable.source = this;
         observable.operator = operator;
         return observable;
       };
-      Observable4.prototype.subscribe = function(observerOrNext, error, complete) {
+      Observable5.prototype.subscribe = function(observerOrNext, error, complete) {
         var _this = this;
         var subscriber = isSubscriber(observerOrNext) ? observerOrNext : new Subscriber_1.SafeSubscriber(observerOrNext, error, complete);
         errorContext_1.errorContext(function() {
@@ -1123,14 +1123,14 @@ var require_Observable = __commonJS({
         });
         return subscriber;
       };
-      Observable4.prototype._trySubscribe = function(sink) {
+      Observable5.prototype._trySubscribe = function(sink) {
         try {
           return this._subscribe(sink);
         } catch (err2) {
           sink.error(err2);
         }
       };
-      Observable4.prototype.forEach = function(next, promiseCtor) {
+      Observable5.prototype.forEach = function(next, promiseCtor) {
         var _this = this;
         promiseCtor = getPromiseCtor(promiseCtor);
         return new promiseCtor(function(resolve, reject) {
@@ -1149,21 +1149,21 @@ var require_Observable = __commonJS({
           _this.subscribe(subscriber);
         });
       };
-      Observable4.prototype._subscribe = function(subscriber) {
+      Observable5.prototype._subscribe = function(subscriber) {
         var _a;
         return (_a = this.source) === null || _a === void 0 ? void 0 : _a.subscribe(subscriber);
       };
-      Observable4.prototype[observable_1.observable] = function() {
+      Observable5.prototype[observable_1.observable] = function() {
         return this;
       };
-      Observable4.prototype.pipe = function() {
+      Observable5.prototype.pipe = function() {
         var operations = [];
         for (var _i = 0; _i < arguments.length; _i++) {
           operations[_i] = arguments[_i];
         }
         return pipe_1.pipeFromArray(operations)(this);
       };
-      Observable4.prototype.toPromise = function(promiseCtor) {
+      Observable5.prototype.toPromise = function(promiseCtor) {
         var _this = this;
         promiseCtor = getPromiseCtor(promiseCtor);
         return new promiseCtor(function(resolve, reject) {
@@ -1177,12 +1177,12 @@ var require_Observable = __commonJS({
           });
         });
       };
-      Observable4.create = function(subscribe) {
-        return new Observable4(subscribe);
+      Observable5.create = function(subscribe) {
+        return new Observable5(subscribe);
       };
-      return Observable4;
+      return Observable5;
     }();
-    exports2.Observable = Observable3;
+    exports2.Observable = Observable4;
     function getPromiseCtor(promiseCtor) {
       var _a;
       return (_a = promiseCtor !== null && promiseCtor !== void 0 ? promiseCtor : config_1.config.Promise) !== null && _a !== void 0 ? _a : Promise;
@@ -13041,9 +13041,11 @@ __export(src_exports, {
   HubServiceGetVerificationsByFidDesc: () => HubServiceGetVerificationsByFidDesc,
   HubServiceSubmitMessageDesc: () => HubServiceSubmitMessageDesc,
   HubServiceSubscribeDesc: () => HubServiceSubscribeDesc,
+  Observable: () => import_rxjs3.Observable,
   getAdminRpcClient: () => getAdminRpcClient,
-  getInsecureHubRpcClient: () => getInsecureHubRpcClient,
-  getSSLHubRpcClient: () => getSSLHubRpcClient
+  getAuthMetadata: () => getAuthMetadata,
+  getHubRpcClient: () => getHubRpcClient,
+  grpc: () => import_grpc_web3.grpc
 });
 module.exports = __toCommonJS(src_exports);
 init_cjs_shims();
@@ -17760,6 +17762,7 @@ var GrpcWebError = class extends tsProtoGlobalThis6.Error {
 // src/client.ts
 init_cjs_shims();
 var import_grpc_web_node_http_transport = require("@improbable-eng/grpc-web-node-http-transport");
+var import_grpc_web2 = require("@improbable-eng/grpc-web");
 
 // ../../node_modules/neverthrow/dist/index.es.js
 init_cjs_shims();
@@ -18171,13 +18174,32 @@ var fromThrowable = Result.fromThrowable;
 var import_core = require("@farcaster/core");
 var import_rxjs2 = __toESM(require_cjs());
 var import_operators2 = __toESM(require_operators());
+var import_grpc_web3 = require("@improbable-eng/grpc-web");
+var import_rxjs3 = __toESM(require_cjs());
+var grpcCodeToHubErrorCode = (code) => {
+  switch (code) {
+    case import_grpc_web2.grpc.Code.Unauthenticated:
+      return "unauthenticated";
+    case import_grpc_web2.grpc.Code.PermissionDenied:
+      return "unauthorized";
+    case import_grpc_web2.grpc.Code.InvalidArgument:
+      return "bad_request";
+    case import_grpc_web2.grpc.Code.NotFound:
+      return "not_found";
+    case import_grpc_web2.grpc.Code.Unavailable:
+      return "unavailable";
+    default:
+      return "unknown";
+  }
+};
 var fromServiceError = (err2) => {
+  var _a;
   let context = err2["message"];
-  if (err2.code === 14 && context === "No connection established") {
+  if (err2.code === 2 && context === "Response closed without headers") {
     context = "Connection failed: please check that the hub\u2019s address, ports and authentication config are correct. " + context;
     return new import_core.HubError("unavailable", context);
   }
-  return new import_core.HubError("unknown", context);
+  return new import_core.HubError(((_a = err2.metadata) == null ? void 0 : _a.get("errcode")[0]) || grpcCodeToHubErrorCode(err2.code), context);
 };
 var wrapClient = (client) => {
   return new Proxy(client, {
@@ -18210,18 +18232,24 @@ var wrapClient = (client) => {
     }
   });
 };
-var getSSLHubRpcClient = (address, isBrowser = true) => {
-  throw new Error("getSSLHubRpcClient not implemented");
-};
-var getInsecureHubRpcClient = (address, isBrowser = true) => {
-  return wrapClient(new HubServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
+var getHubRpcClient = (url, isBrowser = true) => {
+  return wrapClient(new HubServiceClientImpl(getRpcWebClient(url, isBrowser)));
 };
-var getAdminRpcClient = (address, isBrowser = true) => {
-  return wrapClient(new AdminServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
+var getAdminRpcClient = (url, isBrowser = true) => {
+  return wrapClient(new AdminServiceClientImpl(getRpcWebClient(url, isBrowser)));
 };
 var getRpcWebClient = (address, isBrowser = true) => {
   return new GrpcWebImpl(address, isBrowser ? {} : { transport: (0, import_grpc_web_node_http_transport.NodeHttpTransport)() });
 };
+var getAuthMetadata = (username, password) => {
+  const metadata = new import_grpc_web2.grpc.Metadata();
+  if (typeof btoa === "undefined") {
+    metadata.set("authorization", `Basic ${Buffer.from(`${username}:${password}`).toString("base64")}`);
+  } else {
+    metadata.set("authorization", `Basic ${btoa(`${username}:${password}`)}`);
+  }
+  return metadata;
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AdminServiceClientImpl,
@@ -18264,7 +18292,9 @@ var getRpcWebClient = (address, isBrowser = true) => {
   HubServiceGetVerificationsByFidDesc,
   HubServiceSubmitMessageDesc,
   HubServiceSubscribeDesc,
+  Observable,
   getAdminRpcClient,
-  getInsecureHubRpcClient,
-  getSSLHubRpcClient
+  getAuthMetadata,
+  getHubRpcClient,
+  grpc
 });

package/dist/index.mjs

@@ -1095,19 +1095,19 @@ var require_Observable = __commonJS({
     var config_1 = require_config();
     var isFunction_1 = require_isFunction();
     var errorContext_1 = require_errorContext();
-    var Observable3 = function() {
-      function Observable4(subscribe) {
+    var Observable4 = function() {
+      function Observable5(subscribe) {
         if (subscribe) {
           this._subscribe = subscribe;
         }
       }
-      Observable4.prototype.lift = function(operator) {
-        var observable = new Observable4();
+      Observable5.prototype.lift = function(operator) {
+        var observable = new Observable5();
         observable.source = this;
         observable.operator = operator;
         return observable;
       };
-      Observable4.prototype.subscribe = function(observerOrNext, error, complete) {
+      Observable5.prototype.subscribe = function(observerOrNext, error, complete) {
         var _this = this;
         var subscriber = isSubscriber(observerOrNext) ? observerOrNext : new Subscriber_1.SafeSubscriber(observerOrNext, error, complete);
         errorContext_1.errorContext(function() {
@@ -1116,14 +1116,14 @@ var require_Observable = __commonJS({
         });
         return subscriber;
       };
-      Observable4.prototype._trySubscribe = function(sink) {
+      Observable5.prototype._trySubscribe = function(sink) {
         try {
           return this._subscribe(sink);
         } catch (err2) {
           sink.error(err2);
         }
       };
-      Observable4.prototype.forEach = function(next, promiseCtor) {
+      Observable5.prototype.forEach = function(next, promiseCtor) {
         var _this = this;
         promiseCtor = getPromiseCtor(promiseCtor);
         return new promiseCtor(function(resolve, reject) {
@@ -1142,21 +1142,21 @@ var require_Observable = __commonJS({
           _this.subscribe(subscriber);
         });
       };
-      Observable4.prototype._subscribe = function(subscriber) {
+      Observable5.prototype._subscribe = function(subscriber) {
         var _a;
         return (_a = this.source) === null || _a === void 0 ? void 0 : _a.subscribe(subscriber);
       };
-      Observable4.prototype[observable_1.observable] = function() {
+      Observable5.prototype[observable_1.observable] = function() {
         return this;
       };
-      Observable4.prototype.pipe = function() {
+      Observable5.prototype.pipe = function() {
         var operations = [];
         for (var _i = 0; _i < arguments.length; _i++) {
           operations[_i] = arguments[_i];
         }
         return pipe_1.pipeFromArray(operations)(this);
       };
-      Observable4.prototype.toPromise = function(promiseCtor) {
+      Observable5.prototype.toPromise = function(promiseCtor) {
         var _this = this;
         promiseCtor = getPromiseCtor(promiseCtor);
         return new promiseCtor(function(resolve, reject) {
@@ -1170,12 +1170,12 @@ var require_Observable = __commonJS({
           });
         });
       };
-      Observable4.create = function(subscribe) {
-        return new Observable4(subscribe);
+      Observable5.create = function(subscribe) {
+        return new Observable5(subscribe);
       };
-      return Observable4;
+      return Observable5;
     }();
-    exports2.Observable = Observable3;
+    exports2.Observable = Observable4;
     function getPromiseCtor(promiseCtor) {
       var _a;
       return (_a = promiseCtor !== null && promiseCtor !== void 0 ? promiseCtor : config_1.config.Promise) !== null && _a !== void 0 ? _a : Promise;
@@ -17706,6 +17706,7 @@ var GrpcWebError = class extends tsProtoGlobalThis6.Error {
 // src/client.ts
 init_esm_shims();
 import { NodeHttpTransport } from "@improbable-eng/grpc-web-node-http-transport";
+import { grpc as grpc2 } from "@improbable-eng/grpc-web";
 
 // ../../node_modules/neverthrow/dist/index.es.js
 init_esm_shims();
@@ -18116,14 +18117,33 @@ var fromThrowable = Result.fromThrowable;
 // src/client.ts
 var import_rxjs2 = __toESM(require_cjs());
 var import_operators2 = __toESM(require_operators());
+var import_rxjs3 = __toESM(require_cjs());
 import { HubError } from "@farcaster/core";
+import { grpc as grpc3 } from "@improbable-eng/grpc-web";
+var grpcCodeToHubErrorCode = (code) => {
+  switch (code) {
+    case grpc2.Code.Unauthenticated:
+      return "unauthenticated";
+    case grpc2.Code.PermissionDenied:
+      return "unauthorized";
+    case grpc2.Code.InvalidArgument:
+      return "bad_request";
+    case grpc2.Code.NotFound:
+      return "not_found";
+    case grpc2.Code.Unavailable:
+      return "unavailable";
+    default:
+      return "unknown";
+  }
+};
 var fromServiceError = (err2) => {
+  var _a;
   let context = err2["message"];
-  if (err2.code === 14 && context === "No connection established") {
+  if (err2.code === 2 && context === "Response closed without headers") {
     context = "Connection failed: please check that the hub\u2019s address, ports and authentication config are correct. " + context;
     return new HubError("unavailable", context);
   }
-  return new HubError("unknown", context);
+  return new HubError(((_a = err2.metadata) == null ? void 0 : _a.get("errcode")[0]) || grpcCodeToHubErrorCode(err2.code), context);
 };
 var wrapClient = (client) => {
   return new Proxy(client, {
@@ -18156,18 +18176,25 @@ var wrapClient = (client) => {
     }
   });
 };
-var getSSLHubRpcClient = (address, isBrowser = true) => {
-  throw new Error("getSSLHubRpcClient not implemented");
-};
-var getInsecureHubRpcClient = (address, isBrowser = true) => {
-  return wrapClient(new HubServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
+var getHubRpcClient = (url, isBrowser = true) => {
+  return wrapClient(new HubServiceClientImpl(getRpcWebClient(url, isBrowser)));
 };
-var getAdminRpcClient = (address, isBrowser = true) => {
-  return wrapClient(new AdminServiceClientImpl(getRpcWebClient("http://" + address, isBrowser)));
+var getAdminRpcClient = (url, isBrowser = true) => {
+  return wrapClient(new AdminServiceClientImpl(getRpcWebClient(url, isBrowser)));
 };
 var getRpcWebClient = (address, isBrowser = true) => {
   return new GrpcWebImpl(address, isBrowser ? {} : { transport: NodeHttpTransport() });
 };
+var getAuthMetadata = (username, password) => {
+  const metadata = new grpc2.Metadata();
+  if (typeof btoa === "undefined") {
+    metadata.set("authorization", `Basic ${Buffer.from(`${username}:${password}`).toString("base64")}`);
+  } else {
+    metadata.set("authorization", `Basic ${btoa(`${username}:${password}`)}`);
+  }
+  return metadata;
+};
+var export_Observable = import_rxjs3.Observable;
 export {
   AdminServiceClientImpl,
   AdminServiceDeleteAllMessagesFromDbDesc,
@@ -18209,7 +18236,9 @@ export {
   HubServiceGetVerificationsByFidDesc,
   HubServiceSubmitMessageDesc,
   HubServiceSubscribeDesc,
+  export_Observable as Observable,
   getAdminRpcClient,
-  getInsecureHubRpcClient,
-  getSSLHubRpcClient
+  getAuthMetadata,
+  getHubRpcClient,
+  grpc3 as grpc
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/hub-web",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -29,7 +29,7 @@
     "ts-proto": "^1.146.0"
   },
   "dependencies": {
-    "@farcaster/core": "^0.6.0",
+    "@farcaster/core": "^0.6.1",
     "@improbable-eng/grpc-web": "^0.15.0",
     "@improbable-eng/grpc-web-node-http-transport": "^0.15.0"
   }