Skip to content

spoud/sdm-proto-api

Repository files navigation

SDM Proto API

Single source of truth for all SDM gRPC service definitions.

Published as versioned packages for Java (Maven) and TypeScript (npm), so consumers can depend on specific versions and get automated updates via Dependabot.

Packages

Maven (Java + gRPC + Mutiny stubs)

<dependency>
  <groupId>io.spoud.sdm</groupId>
  <artifactId>sdm-proto-api</artifactId>
  <version>1.0.0</version>
</dependency>

Requires the GitHub Packages Maven repository:

<repository>
  <id>github</id>
  <url>https://maven.pkg.github.com/spoud/sdm-proto-api</url>
</repository>

npm (Connect-RPC TypeScript types)

npm install @spoud/sdm-proto-api

Requires .npmrc with GitHub Packages registry:

@spoud:registry=https://npm.pkg.github.com

Development

Prerequisites

Building locally

# Lint proto files
buf lint

# Build Java package
mvn -B package

# Build TypeScript package
cd ts && npm ci && npm run build

Proto structure

activities/    collaboration/  global/
hooks/         logistics/     looker/         permission/
profiler/      schema/        search/         topology/

Each domain module contains domain/, service/, selection/, and/or mutation/ subdirectories with versioned proto files (v1, v1alpha, v1alpha1).

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

3 watching

Forks

Packages

 
 
 

Contributors