@0xobelisk/grpc-client 1.2.0-pre.100

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+export type DubheMetadata = {
+    components: Array<Record<string, {
+        fields: Array<Record<string, any>>;
+        keys: string[];
+        offchain?: boolean;
+    }>>;
+    resources: Array<Record<string, {
+        fields: Array<Record<string, any>>;
+        keys: string[];
+        offchain?: boolean;
+    }>>;
+    enums: any[];
+};

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './to-json';

package/dist/utils/to-json.d.ts

@@ -0,0 +1,3 @@
+import { JsonValue } from '@protobuf-ts/runtime';
+import { Struct } from '../index';
+export declare function structToJson(struct: Struct | undefined): JsonValue;

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@0xobelisk/grpc-client",
+  "version": "1.2.0-pre.100",
+  "description": "Toolkit for interacting with dubhe gRPC indexer",
+  "keywords": [
+    "sui",
+    "obelisk labs",
+    "move",
+    "blockchain",
+    "grpc",
+    "indexer"
+  ],
+  "homepage": "https://github.com/0xobelisk/dubhe/tree/main/packages/grpc-client#readme",
+  "bugs": "https://github.com/0xobelisk/dubhe/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0xobelisk/dubhe.git"
+  },
+  "license": "Apache-2.0",
+  "author": "team@obelisk.build",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@protobuf-ts/grpcweb-transport": "^2.11.1",
+    "@protobuf-ts/runtime": "^2.11.1",
+    "@protobuf-ts/runtime-rpc": "^2.11.1"
+  },
+  "devDependencies": {
+    "@protobuf-ts/plugin": "^2.11.1",
+    "@types/node": "^24.2.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "3.3.3",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "tsup": "^7.1.0",
+    "typescript": "^5.2.2"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run build:types && pnpm run build:tsup",
+    "build:tsup": "tsup ./src/index.ts --format esm,cjs --sourcemap",
+    "build:types": "tsc --build",
+    "clean": "rm -rf tsconfig.tsbuildinfo ./dist",
+    "generate": "rm -rf src/proto && mkdir src/proto && pnpm generate:proto && pnpm lint && pnpm prettier:fix",
+    "generate:proto": "protoc --ts_out=./src/proto --ts_opt force_server_none --ts_opt optimize_code_size --ts_opt ts_nocheck  -I ../../crates/dubhe-indexer-grpc/proto ../../crates/dubhe-indexer-grpc/proto/dubhe_grpc.proto",
+    "lint": "eslint . --ext .ts",
+    "prettier:check": "prettier -c --ignore-unknown .",
+    "prettier:fix": "prettier -w --ignore-unknown .",
+    "type-check": "tsc --noEmit"
+  }
+}

package/src/client.ts

@@ -0,0 +1,28 @@
+import type { GrpcWebOptions } from '@protobuf-ts/grpcweb-transport';
+import { GrpcWebFetchTransport } from '@protobuf-ts/grpcweb-transport';
+import { DubheGrpcClient as ProtoDubheGrpcClient } from './proto/dubhe_grpc.client';
+
+export class DubheGrpcClient {
+  public dubheGrpcClient: ProtoDubheGrpcClient;
+  private currentOptions: GrpcWebOptions;
+
+  constructor(options: GrpcWebOptions) {
+    this.currentOptions = options;
+    this.dubheGrpcClient = new ProtoDubheGrpcClient(new GrpcWebFetchTransport(options));
+  }
+
+  /**
+   * Update gRPC configuration dynamically
+   * @param options - Partial configuration to update (same type as constructor)
+   */
+  updateConfig(options: Partial<GrpcWebOptions>) {
+    // Merge with current options
+    this.currentOptions = {
+      ...this.currentOptions,
+      ...options
+    };
+
+    // Recreate transport and client with new options
+    this.dubheGrpcClient = new ProtoDubheGrpcClient(new GrpcWebFetchTransport(this.currentOptions));
+  }
+}

package/src/index.ts

@@ -0,0 +1,30 @@
+// Type exports
+export * from './types';
+
+// Protobuf client export (for advanced usage)
+export { DubheGrpcClient as ProtoDubheGrpcClient } from './proto/dubhe_grpc.client';
+
+// Re-export protobuf enums as values
+export { FilterOperator, SortDirection } from './proto/dubhe_grpc';
+
+// Re-export protobuf types
+export type {
+  QueryRequest,
+  QueryResponse,
+  SubscribeRequest,
+  TableChange,
+  FilterCondition,
+  FilterValue,
+  SortSpecification,
+  PaginationRequest,
+  PaginationResponse
+} from './proto/dubhe_grpc';
+
+// Re-export protobuf types
+export { Struct } from './proto/google/protobuf/struct';
+
+// Utils
+export * from './utils';
+
+// Index
+export { DubheGrpcClient } from './client';

package/src/proto/dubhe_grpc.client.ts

@@ -0,0 +1,83 @@
+// @generated by protobuf-ts 2.11.1 with parameter force_server_none,optimize_code_size,ts_nocheck
+// @generated from protobuf file "dubhe_grpc.proto" (package "dubhe_grpc", syntax proto3)
+// tslint:disable
+// @ts-nocheck
+import type { RpcTransport } from '@protobuf-ts/runtime-rpc';
+import type { ServiceInfo } from '@protobuf-ts/runtime-rpc';
+import { DubheGrpc } from './dubhe_grpc';
+import type { TableChange } from './dubhe_grpc';
+import type { SubscribeRequest } from './dubhe_grpc';
+import type { ServerStreamingCall } from '@protobuf-ts/runtime-rpc';
+import { stackIntercept } from '@protobuf-ts/runtime-rpc';
+import type { QueryResponse } from './dubhe_grpc';
+import type { QueryRequest } from './dubhe_grpc';
+import type { UnaryCall } from '@protobuf-ts/runtime-rpc';
+import type { RpcOptions } from '@protobuf-ts/runtime-rpc';
+/**
+ * GRPC service definition
+ *
+ * @generated from protobuf service dubhe_grpc.DubheGrpc
+ */
+export interface IDubheGrpcClient {
+  /**
+   * Query data from a specific table with filters, sorting, and pagination
+   *
+   * @generated from protobuf rpc: QueryTable
+   */
+  queryTable(input: QueryRequest, options?: RpcOptions): UnaryCall<QueryRequest, QueryResponse>;
+  /**
+   * Subscribe to table updates
+   *
+   * @generated from protobuf rpc: SubscribeTable
+   */
+  subscribeTable(
+    input: SubscribeRequest,
+    options?: RpcOptions
+  ): ServerStreamingCall<SubscribeRequest, TableChange>;
+}
+/**
+ * GRPC service definition
+ *
+ * @generated from protobuf service dubhe_grpc.DubheGrpc
+ */
+export class DubheGrpcClient implements IDubheGrpcClient, ServiceInfo {
+  typeName = DubheGrpc.typeName;
+  methods = DubheGrpc.methods;
+  options = DubheGrpc.options;
+  constructor(private readonly _transport: RpcTransport) {}
+  /**
+   * Query data from a specific table with filters, sorting, and pagination
+   *
+   * @generated from protobuf rpc: QueryTable
+   */
+  queryTable(input: QueryRequest, options?: RpcOptions): UnaryCall<QueryRequest, QueryResponse> {
+    const method = this.methods[0],
+      opt = this._transport.mergeOptions(options);
+    return stackIntercept<QueryRequest, QueryResponse>(
+      'unary',
+      this._transport,
+      method,
+      opt,
+      input
+    );
+  }
+  /**
+   * Subscribe to table updates
+   *
+   * @generated from protobuf rpc: SubscribeTable
+   */
+  subscribeTable(
+    input: SubscribeRequest,
+    options?: RpcOptions
+  ): ServerStreamingCall<SubscribeRequest, TableChange> {
+    const method = this.methods[1],
+      opt = this._transport.mergeOptions(options);
+    return stackIntercept<SubscribeRequest, TableChange>(
+      'serverStreaming',
+      this._transport,
+      method,
+      opt,
+      input
+    );
+  }
+}