Registry / devops / psb_interop-apis-bc-grpc-sync-client-lib

psb_interop-apis-bc-grpc-sync-client-lib

JSON →
library0.6.10jsnpmunverified

Mojaloop vNext gRPC synchronous API client library for building interop APIs. Current stable version is 0.6.10, with monthly releases. It provides a gRPC client abstraction for synchronous communication in the Mojaloop ecosystem, including configuration for Kafka, JWS, and authentication. Differentiator: strictly typed TypeScript with full SDK integration for Mojaloop vNext, requiring Node >=20.10.0.

npm install psb_interop-apis-bc-grpc-sync-client-lib
INSTALL
IMPORT
SIG · PSB_INTEROP-APIS-B
P
psb_interop-apis-bc-grpc-sync-client-lib
devopsjavascriptv0.6.10
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

GrpcSyncClient
import { GrpcSyncClient } from '@mojaloop-poc/interop-apis-bc-grpc-sync-client-lib'
const GrpcSyncClient = require('@mojaloop-poc/interop-apis-bc-grpc-sync-client-lib')
ESM only; use dynamic import for CJS.
createSyncClient
import { createSyncClient } from '@mojaloop-poc/interop-apis-bc-grpc-sync-client-lib'
import { createSyncClient } from 'grpc-sync-client-lib'
Full package name includes scoped prefix.
type GrpcSyncClientConfig
import type { GrpcSyncClientConfig } from '@mojaloop-poc/interop-apis-bc-grpc-sync-client-lib'
import { GrpcSyncClientConfig } from '@mojaloop-poc/interop-apis-bc-grpc-sync-client-lib'
This is a type; use import type to avoid runtime inclusion.

Creates a gRPC sync client with insecure credentials and makes a sample unary RPC call.

import { createSyncClient, GrpcSyncClient } from '@mojaloop-poc/interop-apis-bc-grpc-sync-client-lib'; import * as grpc from '@grpc/grpc-js'; const config: GrpcSyncClientConfig = { serviceUrl: process.env.SYNC_SVC_URL || 'localhost:50051', credentials: grpc.credentials.createInsecure(), }; const client = createSyncClient(config); async function callRpc(): Promise<void> { try { const response = await client.someRpc({ requestData: 'test' }); console.log('RPC response:', response); } catch (err) { console.error('RPC failed:', err); } } callRpc();
Debug
Known issues
breakingMinimum Node.js version required is 20.10.0; older versions cause install failures.
fix
Upgrade Node.js to >=20.10.0.
affects: <20.10.0
breakingESM-only package; using require() throws ERR_REQUIRE_ESM.
fix
Use import or dynamic import() instead of require().
affects: >=0.6.0
deprecatedThe package is scoped under @mojaloop-poc; migration to @mojaloop may occur.
fix
Watch for new scoped package name when stable.
affects: >=0.1.0
gotchaEnvironment variable KAFKA_URL is required if Kafka integration is used; missing causes silent start failures.
fix
Set KAFKA_URL to a valid Kafka broker address.
affects: >=0.1.0
Errors
Common errors & fixes
Error [ERR_REQUIRE_ESM]: require() of ES Module not supported.
Using CommonJS require() on an ESM-only package.
fix
Switch to import statement or use dynamic import().
Cannot find module '@mojaloop-poc/interop-apis-bc-grpc-sync-client-lib'
Package not installed or wrong import path.
fix
Run 'npm install @mojaloop-poc/interop-apis-bc-grpc-sync-client-lib' and verify the import path.
TypeError: client.someRpc is not a function
Attempting to call a method that does not exist on the client object.
fix
Check the generated gRPC proto definition for available RPC methods.
Upgrade
Version history
0.6.10latest on npm
Audit
Dependencies
@grpc/grpc-jsrequiredCore gRPC client library
protobufjsrequiredProtocol buffer serialization
Agent activity
6 hits · last 30 days
node
6
Resources
psb_interop-apis-bc-grpc-sync-client-lib — npm install psb_interop-apis-bc-grpc-sync-client-lib · libregistry