feat(sdk): connect rpc client export

[eugenioenko]

Description
Generates and exports connectrpc service definitions.

PR Changes

• Updated connect client generation
• Re-exported generated client rpc services
• Added connectrpc framework as dependency
• Re-exported connectrpc framework lib
• Updated platform.sh script to generate client
• added make generate-platform to run the generator
• Added example component in web-app

Consumer Usage Example
This is an example of how the generated client can be used:

import { wellknown, platformConnect, platformConnectWeb } from '@opentdf/sdk/platform';

const transport = platformConnectWeb.createConnectTransport({
  baseUrl: '/api',
});

const wellknownClient = platformConnect.createClient(wellknown.WellKnownService, transport);


interface ConnectRpcExampleProps {
  accessToken?: string;
}

const handleWellknown = async () => {
  const response = await wellknownClient.getWellKnownConfiguration({});
};

Generating
To generate the service definition run:

make generate-platform

This will clone the platform into the repository and execute the generators based on the exported protos in the platform services

Details
To allow proto buf genrators to work, the platform needs to be cloned into lib/src/platform diretory. The script scripts/platform.sh handles that.

lib/buf.gen.yaml is the configuration for the generator. To execute the generator manually

cd lib
npx buf generate ../platform/service

This will generate lib/src/platform exports for each of the service.
Finally, lib/src/platform.ts re-exports those services and the connect rpc framework

Follow up

• update the sdk to use internally the generated rpc services
• updated web-app to use the exported rpc services

[github-actions]

If these changes look good, signoff on them with:

git pull && git commit --amend --signoff && git push --force-with-lease origin

If they aren't any good, please remove them with:

git pull && git reset --hard HEAD~1 && git push --force-with-lease origin

[eugenioenko]

These have been added as dependencies and are re-exported in lib/src/platform.ts. This way we can ensure that the generated client services will work with the connectrpc web framework.

One alternative I've considered here is to declare them as peerDependencies and actually not re-export them. When someone consumes @opentdf/sdk they will get a warning that @connectrcp needs to be added to their package.json.
I would have pushed for this option if the bundle size increased, but it has not. I think we are good with re-export

[dmihalcik-virtru]

Overall, this seems like a good consolidation over the previous work.

Have you actually managed to make these work? If you want to test them, you'll probably want to add code to the integration test packages (in the cli and web-app folders).

[eugenioenko]

Have you actually managed to make these work? If you want to test them, you'll probably want to add code to the integration test packages (in the cli and web-app folders).

I've tested the wellknownconfig endpoint with the local build to make sure it was exported and functional. (Thats how I got the example for the PR description)

As a follow up I do have to update the web-app to use the generated endpoints. If needed, I can do it as part of this PR

@dmihalcik-virtru
For the integration test packages, which integrations test do you want to see updated/added for this PR to be mergeable?

[dmihalcik-virtru]

Given that this is a refactor of existing code, I'm okay approving without a working integration test. However, it does actually expose the feature (I think? how do you initialize the client?), so we should get a test working before the next release to NPM.

For me, I'd like some code that shows how it works, something the integration test would perforce include

[dmihalcik-virtru]

oh sorry I see now in the PR description. We maybe still want to add it to the readme (maybe after doing the integration test), and I think the sample code in the description still needs auth configured

[github-actions]

If these changes look good, signoff on them with:

git pull && git commit --amend --signoff && git push --force-with-lease origin

If they aren't any good, please remove them with:

git pull && git reset --hard HEAD~1 && git push --force-with-lease origin

[sonarqubecloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud