Registry / devops / depi-node-client

depi-node-client

JSON →
library1.0.3jsnpmunverified

A gRPC client library for communicating with DEPI from Node.js, written in TypeScript. v1.0.3 provides proto-generated classes and higher-level utility functions (depiUtils) for streamlined interaction. Includes VS Code extension integration (DepiExtensionApi) for reusing sessions and invoking DEPI UI. Published on npm, ships TypeScript definitions. Use depiUtils for most operations; low-level async methods via addAsyncMethods. Build requires grpc-tools and ts-protoc-gen.

devops
npm install depi-node-client
package ↗
INSTALL
IMPORT
SIG · DEPI-NODE-CLIENT
D
depi-node-client
devopsjavascriptv1.0.3
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.

depiUtils
✓ import { depiUtils } from 'depi-node-client'
✗ const depiUtils = require('depi-node-client').depiUtils
ESM style works with TypeScript; CommonJS requires destructuring
DepiExtensionApi
✓ import { DepiExtensionApi } from 'depi-node-client'
✗ import DepiExtensionApi from 'depi-node-client'
Named export, not default
DepiClient
✓ import { DepiClient } from 'depi-node-client/dist/pbs/depi_grpc_pb'
✗ import { DepiClient } from 'depi-node-client'
DepiClient is not exported from the package root; must use full path to generated file

Authenticates to a DEPI server and lists resource groups using high-level utility functions.

import { depiUtils } from 'depi-node-client'; const url = '127.0.0.1:5051'; const userName = 'demo'; const password = '123456'; async function main() { const session = await depiUtils.logInDepiClient(url, userName, password); const resourceGroups = await depiUtils.getResourceGroups(session); resourceGroups.forEach(rg => console.log(JSON.stringify(rg))); await depiUtils.logOut(session); } main().catch(console.error);
Debug
Known issues
gotchaDepiClient class is not exported from the package root. Must import from 'depi-node-client/dist/pbs/depi_grpc_pb'.
fix
Use the full path: import { DepiClient } from 'depi-node-client/dist/pbs/depi_grpc_pb'
affects: >=1.0
gotchaAsync methods are not available by default on DepiClient. Must call addAsyncMethods(client) after instantiation.
fix
const client = new DepiClient(url, creds); addAsyncMethods(client); const res = await client.loginAsync(req);
affects: >=1.0
gotchaApple M1 users must install with --target_arch=x64 due to grpc-tools lacking arm64 support.
fix
npm install --target_arch=x64
affects: >=1.0
Errors
Common errors & fixes
Cannot find module 'depi-node-client'
Package not installed or import path incorrect.
fix
Run 'npm install depi-node-client' and ensure import uses correct path.
DepiClient is not a constructor
Importing DepiClient incorrectly (e.g. as default import).
fix
Use named import: import { DepiClient } from 'depi-node-client/dist/pbs/depi_grpc_pb'
Client does not have method loginAsync
addAsyncMethods not called on client instance.
fix
After creating client, call addAsyncMethods(client) before using async methods.
Upgrade
Version history
1.0.3latest on npm
Audit
Dependencies
@grpc/grpc-jsrequiredgRPC transport
Agent activity
10 hits · last 30 days
node
10
Resources
packagedepi-node-client ↗
depi-node-client — npm install depi-node-client · libregistry