gRPC SDK

The gRPC SDK (@conduitplatform/grpc-sdk) is the TypeScript toolkit for custom module authors and trusted server-side processes that talk to Conduit over gRPC. Application web and mobile clients use the Client API with user bearer tokens instead.

When to use

Installation

npm install @conduitplatform/grpc-sdk

What the SDK provides

• Module lifecycle — ConduitModule base class, initialization hooks, health integration
• Service clients — typed grpcSdk accessors to database, storage, authentication, communications, and other modules
• Schema helpers — ConduitSchema and model constructors for module-owned collections
• Route registration — register Client API or Admin API routes from module code via RoutingManager

Usage sketch

Custom module entry

import { ConduitModule } from "@conduitplatform/grpc-sdk";

class MyModule extends ConduitModule {
  async initialize() {
    // Register routes, subscribe to events, wire grpcSdk clients
  }
}

Schema definition

import { ConduitSchema } from "@conduitplatform/grpc-sdk";

const OrderSchema = new ConduitSchema("Order", {
  total: { type: "Number", required: true },
  status: { type: "String", default: "pending" },
});

Client API route from a module

this.routeManager.registerRoute({
  path: "/my-module/health",
  method: "GET",
  handler: async (_req, res) => {
    res.json({ ok: true });
  },
});

For exhaustive types and APIs, use the package source and TypeScript definitions in the Conduit monorepo.

v0.17 notes

• admin, commons, and core packages merged into packages/core. Depend on @conduitplatform/grpc-sdk and documented packages/core paths only — see Migration v0.16 → v0.17.
• Communications — legacy client names (grpcSdk.email, grpcSdk.sms, grpcSdk.pushNotifications) route to the communications module automatically.

Other languages

Conduit modules can be implemented in any gRPC-compatible language:

1. Use proto definitions from the Conduit repository (packages/commons protofiles)
2. Implement the module service interfaces for your runtime
3. Register with core over gRPC

TypeScript teams typically use this SDK; other languages use generated stubs from the same protos.

Related