@farcaster/hub-web 0.2.2 → 0.2.3

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
@@ -9,6 +9,8 @@ A lightweight, fast Typescript interface for Farcaster Hubs. Designed to work wi
9
9
  - Has helpers to create and sign Farcaster messages.
10
10
  - Written entirely in TypeScript, with strict types for safety.
11
11
 
12
+ 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.
13
+
12
14
  ## Installation
13
15
 
14
16
  Install @farcaster/hub-web with the package manager of your choice
package/dist/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { HubResult } from '@farcaster/core';
2
2
  export * from '@farcaster/core';
3
3
  import { grpc } from '@improbable-eng/grpc-web';
4
+ export { grpc } from '@improbable-eng/grpc-web';
4
5
  import { Observable } from 'rxjs';
5
6
  export { Observable } from 'rxjs';
6
7
  import _m0 from 'protobufjs/minimal';
@@ -7880,9 +7881,6 @@ declare class GrpcWebError extends tsProtoGlobalThis.Error {
7880
7881
  constructor(message: string, code: grpc.Code, metadata: grpc.Metadata);
7881
7882
  }
7882
7883
 
7883
- declare const Code: typeof grpc.Code;
7884
- declare const Metadata: typeof grpc.Metadata;
7885
-
7886
7884
  type OriginalUnaryCall<T, U> = (request: T, metadata?: grpc.Metadata) => Promise<U>;
7887
7885
  type WrappedUnaryCall<T, U> = (request: T, metadata?: grpc.Metadata) => Promise<HubResult<U>>;
7888
7886
  type OriginalStream<T, U> = (request: T, metadata?: grpc.Metadata) => Observable<U>;
@@ -7898,4 +7896,4 @@ type AdminRpcClient = WrappedClient<AdminService>;
7898
7896
  declare const getAdminRpcClient: (url: string, isBrowser?: boolean) => AdminRpcClient;
7899
7897
  declare const getAuthMetadata: (username: string, password: string) => grpc.Metadata;
7900
7898
 
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 };
7899
+ 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 CHANGED
@@ -1102,19 +1102,19 @@ var require_Observable = __commonJS({
1102
1102
  var config_1 = require_config();
1103
1103
  var isFunction_1 = require_isFunction();
1104
1104
  var errorContext_1 = require_errorContext();
1105
- var Observable3 = function() {
1106
- function Observable4(subscribe) {
1105
+ var Observable4 = function() {
1106
+ function Observable5(subscribe) {
1107
1107
  if (subscribe) {
1108
1108
  this._subscribe = subscribe;
1109
1109
  }
1110
1110
  }
1111
- Observable4.prototype.lift = function(operator) {
1112
- var observable = new Observable4();
1111
+ Observable5.prototype.lift = function(operator) {
1112
+ var observable = new Observable5();
1113
1113
  observable.source = this;
1114
1114
  observable.operator = operator;
1115
1115
  return observable;
1116
1116
  };
1117
- Observable4.prototype.subscribe = function(observerOrNext, error, complete) {
1117
+ Observable5.prototype.subscribe = function(observerOrNext, error, complete) {
1118
1118
  var _this = this;
1119
1119
  var subscriber = isSubscriber(observerOrNext) ? observerOrNext : new Subscriber_1.SafeSubscriber(observerOrNext, error, complete);
1120
1120
  errorContext_1.errorContext(function() {
@@ -1123,14 +1123,14 @@ var require_Observable = __commonJS({
1123
1123
  });
1124
1124
  return subscriber;
1125
1125
  };
1126
- Observable4.prototype._trySubscribe = function(sink) {
1126
+ Observable5.prototype._trySubscribe = function(sink) {
1127
1127
  try {
1128
1128
  return this._subscribe(sink);
1129
1129
  } catch (err2) {
1130
1130
  sink.error(err2);
1131
1131
  }
1132
1132
  };
1133
- Observable4.prototype.forEach = function(next, promiseCtor) {
1133
+ Observable5.prototype.forEach = function(next, promiseCtor) {
1134
1134
  var _this = this;
1135
1135
  promiseCtor = getPromiseCtor(promiseCtor);
1136
1136
  return new promiseCtor(function(resolve, reject) {
@@ -1149,21 +1149,21 @@ var require_Observable = __commonJS({
1149
1149
  _this.subscribe(subscriber);
1150
1150
  });
1151
1151
  };
1152
- Observable4.prototype._subscribe = function(subscriber) {
1152
+ Observable5.prototype._subscribe = function(subscriber) {
1153
1153
  var _a;
1154
1154
  return (_a = this.source) === null || _a === void 0 ? void 0 : _a.subscribe(subscriber);
1155
1155
  };
1156
- Observable4.prototype[observable_1.observable] = function() {
1156
+ Observable5.prototype[observable_1.observable] = function() {
1157
1157
  return this;
1158
1158
  };
1159
- Observable4.prototype.pipe = function() {
1159
+ Observable5.prototype.pipe = function() {
1160
1160
  var operations = [];
1161
1161
  for (var _i = 0; _i < arguments.length; _i++) {
1162
1162
  operations[_i] = arguments[_i];
1163
1163
  }
1164
1164
  return pipe_1.pipeFromArray(operations)(this);
1165
1165
  };
1166
- Observable4.prototype.toPromise = function(promiseCtor) {
1166
+ Observable5.prototype.toPromise = function(promiseCtor) {
1167
1167
  var _this = this;
1168
1168
  promiseCtor = getPromiseCtor(promiseCtor);
1169
1169
  return new promiseCtor(function(resolve, reject) {
@@ -1177,12 +1177,12 @@ var require_Observable = __commonJS({
1177
1177
  });
1178
1178
  });
1179
1179
  };
1180
- Observable4.create = function(subscribe) {
1181
- return new Observable4(subscribe);
1180
+ Observable5.create = function(subscribe) {
1181
+ return new Observable5(subscribe);
1182
1182
  };
1183
- return Observable4;
1183
+ return Observable5;
1184
1184
  }();
1185
- exports2.Observable = Observable3;
1185
+ exports2.Observable = Observable4;
1186
1186
  function getPromiseCtor(promiseCtor) {
1187
1187
  var _a;
1188
1188
  return (_a = promiseCtor !== null && promiseCtor !== void 0 ? promiseCtor : config_1.config.Promise) !== null && _a !== void 0 ? _a : Promise;
@@ -13007,7 +13007,6 @@ __export(src_exports, {
13007
13007
  AdminServiceRebuildSyncTrieDesc: () => AdminServiceRebuildSyncTrieDesc,
13008
13008
  AdminServiceSubmitIdRegistryEventDesc: () => AdminServiceSubmitIdRegistryEventDesc,
13009
13009
  AdminServiceSubmitNameRegistryEventDesc: () => AdminServiceSubmitNameRegistryEventDesc,
13010
- Code: () => Code,
13011
13010
  GrpcWebError: () => GrpcWebError,
13012
13011
  GrpcWebImpl: () => GrpcWebImpl,
13013
13012
  HubServiceClientImpl: () => HubServiceClientImpl,
@@ -13042,10 +13041,11 @@ __export(src_exports, {
13042
13041
  HubServiceGetVerificationsByFidDesc: () => HubServiceGetVerificationsByFidDesc,
13043
13042
  HubServiceSubmitMessageDesc: () => HubServiceSubmitMessageDesc,
13044
13043
  HubServiceSubscribeDesc: () => HubServiceSubscribeDesc,
13045
- Metadata: () => Metadata,
13044
+ Observable: () => import_rxjs3.Observable,
13046
13045
  getAdminRpcClient: () => getAdminRpcClient,
13047
13046
  getAuthMetadata: () => getAuthMetadata,
13048
- getHubRpcClient: () => getHubRpcClient
13047
+ getHubRpcClient: () => getHubRpcClient,
13048
+ grpc: () => import_grpc_web3.grpc
13049
13049
  });
13050
13050
  module.exports = __toCommonJS(src_exports);
13051
13051
  init_cjs_shims();
@@ -18174,15 +18174,32 @@ var fromThrowable = Result.fromThrowable;
18174
18174
  var import_core = require("@farcaster/core");
18175
18175
  var import_rxjs2 = __toESM(require_cjs());
18176
18176
  var import_operators2 = __toESM(require_operators());
18177
- var Code = import_grpc_web2.grpc.Code;
18178
- var Metadata = import_grpc_web2.grpc.Metadata;
18177
+ var import_grpc_web3 = require("@improbable-eng/grpc-web");
18178
+ var import_rxjs3 = __toESM(require_cjs());
18179
+ var grpcCodeToHubErrorCode = (code) => {
18180
+ switch (code) {
18181
+ case import_grpc_web2.grpc.Code.Unauthenticated:
18182
+ return "unauthenticated";
18183
+ case import_grpc_web2.grpc.Code.PermissionDenied:
18184
+ return "unauthorized";
18185
+ case import_grpc_web2.grpc.Code.InvalidArgument:
18186
+ return "bad_request";
18187
+ case import_grpc_web2.grpc.Code.NotFound:
18188
+ return "not_found";
18189
+ case import_grpc_web2.grpc.Code.Unavailable:
18190
+ return "unavailable";
18191
+ default:
18192
+ return "unknown";
18193
+ }
18194
+ };
18179
18195
  var fromServiceError = (err2) => {
18196
+ var _a;
18180
18197
  let context = err2["message"];
18181
- if (err2.code === 14 && context === "No connection established") {
18198
+ if (err2.code === 2 && context === "Response closed without headers") {
18182
18199
  context = "Connection failed: please check that the hub\u2019s address, ports and authentication config are correct. " + context;
18183
18200
  return new import_core.HubError("unavailable", context);
18184
18201
  }
18185
- return new import_core.HubError(err2.metadata.get("errcode")[0], context);
18202
+ return new import_core.HubError(((_a = err2.metadata) == null ? void 0 : _a.get("errcode")[0]) || grpcCodeToHubErrorCode(err2.code), context);
18186
18203
  };
18187
18204
  var wrapClient = (client) => {
18188
18205
  return new Proxy(client, {
@@ -18241,7 +18258,6 @@ var getAuthMetadata = (username, password) => {
18241
18258
  AdminServiceRebuildSyncTrieDesc,
18242
18259
  AdminServiceSubmitIdRegistryEventDesc,
18243
18260
  AdminServiceSubmitNameRegistryEventDesc,
18244
- Code,
18245
18261
  GrpcWebError,
18246
18262
  GrpcWebImpl,
18247
18263
  HubServiceClientImpl,
@@ -18276,8 +18292,9 @@ var getAuthMetadata = (username, password) => {
18276
18292
  HubServiceGetVerificationsByFidDesc,
18277
18293
  HubServiceSubmitMessageDesc,
18278
18294
  HubServiceSubscribeDesc,
18279
- Metadata,
18295
+ Observable,
18280
18296
  getAdminRpcClient,
18281
18297
  getAuthMetadata,
18282
- getHubRpcClient
18298
+ getHubRpcClient,
18299
+ grpc
18283
18300
  });
package/dist/index.mjs CHANGED
@@ -1095,19 +1095,19 @@ var require_Observable = __commonJS({
1095
1095
  var config_1 = require_config();
1096
1096
  var isFunction_1 = require_isFunction();
1097
1097
  var errorContext_1 = require_errorContext();
1098
- var Observable3 = function() {
1099
- function Observable4(subscribe) {
1098
+ var Observable4 = function() {
1099
+ function Observable5(subscribe) {
1100
1100
  if (subscribe) {
1101
1101
  this._subscribe = subscribe;
1102
1102
  }
1103
1103
  }
1104
- Observable4.prototype.lift = function(operator) {
1105
- var observable = new Observable4();
1104
+ Observable5.prototype.lift = function(operator) {
1105
+ var observable = new Observable5();
1106
1106
  observable.source = this;
1107
1107
  observable.operator = operator;
1108
1108
  return observable;
1109
1109
  };
1110
- Observable4.prototype.subscribe = function(observerOrNext, error, complete) {
1110
+ Observable5.prototype.subscribe = function(observerOrNext, error, complete) {
1111
1111
  var _this = this;
1112
1112
  var subscriber = isSubscriber(observerOrNext) ? observerOrNext : new Subscriber_1.SafeSubscriber(observerOrNext, error, complete);
1113
1113
  errorContext_1.errorContext(function() {
@@ -1116,14 +1116,14 @@ var require_Observable = __commonJS({
1116
1116
  });
1117
1117
  return subscriber;
1118
1118
  };
1119
- Observable4.prototype._trySubscribe = function(sink) {
1119
+ Observable5.prototype._trySubscribe = function(sink) {
1120
1120
  try {
1121
1121
  return this._subscribe(sink);
1122
1122
  } catch (err2) {
1123
1123
  sink.error(err2);
1124
1124
  }
1125
1125
  };
1126
- Observable4.prototype.forEach = function(next, promiseCtor) {
1126
+ Observable5.prototype.forEach = function(next, promiseCtor) {
1127
1127
  var _this = this;
1128
1128
  promiseCtor = getPromiseCtor(promiseCtor);
1129
1129
  return new promiseCtor(function(resolve, reject) {
@@ -1142,21 +1142,21 @@ var require_Observable = __commonJS({
1142
1142
  _this.subscribe(subscriber);
1143
1143
  });
1144
1144
  };
1145
- Observable4.prototype._subscribe = function(subscriber) {
1145
+ Observable5.prototype._subscribe = function(subscriber) {
1146
1146
  var _a;
1147
1147
  return (_a = this.source) === null || _a === void 0 ? void 0 : _a.subscribe(subscriber);
1148
1148
  };
1149
- Observable4.prototype[observable_1.observable] = function() {
1149
+ Observable5.prototype[observable_1.observable] = function() {
1150
1150
  return this;
1151
1151
  };
1152
- Observable4.prototype.pipe = function() {
1152
+ Observable5.prototype.pipe = function() {
1153
1153
  var operations = [];
1154
1154
  for (var _i = 0; _i < arguments.length; _i++) {
1155
1155
  operations[_i] = arguments[_i];
1156
1156
  }
1157
1157
  return pipe_1.pipeFromArray(operations)(this);
1158
1158
  };
1159
- Observable4.prototype.toPromise = function(promiseCtor) {
1159
+ Observable5.prototype.toPromise = function(promiseCtor) {
1160
1160
  var _this = this;
1161
1161
  promiseCtor = getPromiseCtor(promiseCtor);
1162
1162
  return new promiseCtor(function(resolve, reject) {
@@ -1170,12 +1170,12 @@ var require_Observable = __commonJS({
1170
1170
  });
1171
1171
  });
1172
1172
  };
1173
- Observable4.create = function(subscribe) {
1174
- return new Observable4(subscribe);
1173
+ Observable5.create = function(subscribe) {
1174
+ return new Observable5(subscribe);
1175
1175
  };
1176
- return Observable4;
1176
+ return Observable5;
1177
1177
  }();
1178
- exports2.Observable = Observable3;
1178
+ exports2.Observable = Observable4;
1179
1179
  function getPromiseCtor(promiseCtor) {
1180
1180
  var _a;
1181
1181
  return (_a = promiseCtor !== null && promiseCtor !== void 0 ? promiseCtor : config_1.config.Promise) !== null && _a !== void 0 ? _a : Promise;
@@ -18117,16 +18117,33 @@ var fromThrowable = Result.fromThrowable;
18117
18117
  // src/client.ts
18118
18118
  var import_rxjs2 = __toESM(require_cjs());
18119
18119
  var import_operators2 = __toESM(require_operators());
18120
+ var import_rxjs3 = __toESM(require_cjs());
18120
18121
  import { HubError } from "@farcaster/core";
18121
- var Code = grpc2.Code;
18122
- var Metadata = grpc2.Metadata;
18122
+ import { grpc as grpc3 } from "@improbable-eng/grpc-web";
18123
+ var grpcCodeToHubErrorCode = (code) => {
18124
+ switch (code) {
18125
+ case grpc2.Code.Unauthenticated:
18126
+ return "unauthenticated";
18127
+ case grpc2.Code.PermissionDenied:
18128
+ return "unauthorized";
18129
+ case grpc2.Code.InvalidArgument:
18130
+ return "bad_request";
18131
+ case grpc2.Code.NotFound:
18132
+ return "not_found";
18133
+ case grpc2.Code.Unavailable:
18134
+ return "unavailable";
18135
+ default:
18136
+ return "unknown";
18137
+ }
18138
+ };
18123
18139
  var fromServiceError = (err2) => {
18140
+ var _a;
18124
18141
  let context = err2["message"];
18125
- if (err2.code === 14 && context === "No connection established") {
18142
+ if (err2.code === 2 && context === "Response closed without headers") {
18126
18143
  context = "Connection failed: please check that the hub\u2019s address, ports and authentication config are correct. " + context;
18127
18144
  return new HubError("unavailable", context);
18128
18145
  }
18129
- return new HubError(err2.metadata.get("errcode")[0], context);
18146
+ return new HubError(((_a = err2.metadata) == null ? void 0 : _a.get("errcode")[0]) || grpcCodeToHubErrorCode(err2.code), context);
18130
18147
  };
18131
18148
  var wrapClient = (client) => {
18132
18149
  return new Proxy(client, {
@@ -18177,6 +18194,7 @@ var getAuthMetadata = (username, password) => {
18177
18194
  }
18178
18195
  return metadata;
18179
18196
  };
18197
+ var export_Observable = import_rxjs3.Observable;
18180
18198
  export {
18181
18199
  AdminServiceClientImpl,
18182
18200
  AdminServiceDeleteAllMessagesFromDbDesc,
@@ -18184,7 +18202,6 @@ export {
18184
18202
  AdminServiceRebuildSyncTrieDesc,
18185
18203
  AdminServiceSubmitIdRegistryEventDesc,
18186
18204
  AdminServiceSubmitNameRegistryEventDesc,
18187
- Code,
18188
18205
  GrpcWebError,
18189
18206
  GrpcWebImpl,
18190
18207
  HubServiceClientImpl,
@@ -18219,8 +18236,9 @@ export {
18219
18236
  HubServiceGetVerificationsByFidDesc,
18220
18237
  HubServiceSubmitMessageDesc,
18221
18238
  HubServiceSubscribeDesc,
18222
- Metadata,
18239
+ export_Observable as Observable,
18223
18240
  getAdminRpcClient,
18224
18241
  getAuthMetadata,
18225
- getHubRpcClient
18242
+ getHubRpcClient,
18243
+ grpc3 as grpc
18226
18244
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@farcaster/hub-web",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "main": "./dist/index.js",
5
5
  "module": "./dist/index.mjs",
6
6
  "types": "./dist/index.d.ts",
@@ -29,7 +29,7 @@
29
29
  "ts-proto": "^1.146.0"
30
30
  },
31
31
  "dependencies": {
32
- "@farcaster/core": "^0.6.0",
32
+ "@farcaster/core": "^0.6.1",
33
33
  "@improbable-eng/grpc-web": "^0.15.0",
34
34
  "@improbable-eng/grpc-web-node-http-transport": "^0.15.0"
35
35
  }