@zintrust/zedgi
v2.9.0
Published
Zedgi HTTPS transport drivers for ZinTrust cache, database, and queue.
Downloads
874
Maintainers
Readme
@zintrust/zedgi
Zedgi HTTPS transport drivers for ZinTrust cache, database, and queue integrations.
This package lets a ZinTrust app reach Redis, MySQL, PostgreSQL, and BullMQ queue operations through a Zedgi gateway by changing driver environment variables.
Install
npm install @zintrust/zedgi @zedgi/zedgi-clientIn ZinTrust monorepo builds, this package is auto-discovered when one of the Zedgi drivers is selected.
Environment
USE_ZEDGI=true
ZEDGI_URL=https://YOUR_SUBDOMAIN.zedgi.app
ZEDGI_KEY=zk_...
# Optional. The SDK auto-pulls these when omitted.
ZEDGI_SIGNING_SECRET=
ZEDGI_PUBLIC_KEY=
ZEDGI_ACCOUNT_ID=
ZEDGI_KEY_VERSION=
ZEDGI_TIMEOUT=10000
# Optional signed plaintext metadata forwarded by Zedgi.
ZEDGI_REDIS_HEADER=
ZEDGI_QUEUE_HEADER=
ZEDGI_MYSQL_HEADER=
ZEDGI_POSTGRES_HEADER=Drivers
CACHE_DRIVER=redis-zedgi
DB_CONNECTION=mysql-zedgi
# or DB_CONNECTION=postgres-zedgi
# or DB_CONNECTION=pg-zedgi
QUEUE_DRIVER=queue-zedgiZedgi stores the target host/port in its dashboard service registration. ZinTrust sends only auth/selection fields through the client SDK:
- Redis:
password,db, optionalheader - MySQL/Postgres:
user,password,database, optionalssl, optionalheader
The package uses one shared Zedgi client/options object so account key, signing secret, and encrypted credential blobs are cached across cache, DB, and queue usage.
Queue Support
queue-zedgi supports:
enqueuelengthdrainack
Pull-based dequeue is intentionally unsupported because the Zedgi queue API does not currently expose a safe visibility-timeout claim operation. Use queue-zedgi for producers and monitoring, and run workers against the same Redis service directly.
Registration
The package registers:
- Cache:
redis-zedgi - Database:
mysql-zedgi,postgres-zedgi,pg-zedgi - Queue:
queue-zedgi
Manual registration is available with:
import '@zintrust/zedgi/register';