@dx-do/client 5.2.38 → 5.2.43

package/README.md

@@ -81,6 +81,61 @@ const list = await monolith.dxAlertService.retrieveAllAlertsV2();
 
 Same **`AlertService`** behavior as above: `monolith.dxAlertService` is an `AlertService` instance sharing `monolith.dxSaaSService`.
 
+## DataStore services
+
+The `services/datastore/` namespace contains direct REST clients for the DX SaaS DataStore microservices that sit behind the gateway. Each service mirrors a Java REST controller and is built around hand-authored Zod schemas in `model/datastore/<name>/` (see `nx run client:generate-datastore-models`). All of them validate request bodies with `…Schema.parse(...)` and lenient-validate responses with `safeParse(...)` — bad responses are logged via the injected `SimpleLog` and the raw payload is still returned.
+
+The `DataStoreXxxService` classes are wired into `createServiceMonolith` alongside the legacy services. The legacy keys (`dxTASService`, `dxNASSService`, `dxBlobService`) still point to the older [`TASService`](src/lib/services/tas.service.ts) / [`NASSService`](src/lib/services/nass.service.ts) / [`BlobService`](src/lib/services/blob.service.ts) implementations and are retained for backwards compatibility — new code should prefer the `dxDataStore…` / `dxBlobStorageService` keys.
+
+| Service | Monolith key | Class |
+|---------|-------------|-------|
+| TAS graph queries | `dxDataStoreTASService` | [`DataStoreTASService`](src/lib/services/datastore/datastore-tas.service.ts) |
+| NASSQL metric queries | `dxDataStoreNASSQLService` | [`DataStoreNASSQLService`](src/lib/services/datastore/datastore-nassql.service.ts) |
+| Metrics metadata | `dxDataStoreMetricsMetadataService` | [`DataStoreMetricsMetadataService`](src/lib/services/datastore/datastore-metrics-metadata.service.ts) |
+| States | `dxStatesService` | [`DataStoreStatesService`](src/lib/services/datastore/datastore-states.service.ts) |
+| Authorization views | `dxAuthViewsService` | [`DataStoreAuthViewsService`](src/lib/services/datastore/datastore-auth-views.service.ts) |
+| Audit | `dxAuditService` | [`DataStoreAuditService`](src/lib/services/datastore/datastore-audit.service.ts) |
+| Blob storage | `dxBlobStorageService` | [`DataStoreBlobStorageService`](src/lib/services/datastore/datastore-blobstorage.service.ts) |
+| Tokens | `dxTokensService` | [`DataStoreTokensService`](src/lib/services/datastore/datastore-tokens.service.ts) |
+| Features | `dxFeaturesService` | [`DataStoreFeaturesService`](src/lib/services/datastore/datastore-features.service.ts) |
+
+`DataStoreBlobStorageService` covers the full `/blobstorage` REST surface (`store`, `bulk-store`, `fetch`, `query`, `delete`, `bulk-delete`, `schema/list`, `executeAsync`, `asyncResult`) and should be preferred over the legacy `BlobService` for new code.
+
+### `DataStoreStatesService`
+
+Wraps `/states/state/{store,fetch,range,republish}`. Filters use the `VertexStateFilter` discriminated union (`ALL | AND | OR | ALERT | METRIC | STATE | VERTEX_ID | NAMESPACE | MANAGEMENT_MODULE | EMPTY | COLLECT_GROUPS`). `fetchStates` supports incremental polling via `version` and projections `DETAILED | BRIEF | EXTRA_IDS`. `republishStates` is intended for recovering from Kafka outages and re-emits state-change events.
+
+### `DataStoreAuthViewsService`
+
+Wraps the data-store-level authorization views API at `/views/{view,default,query,queryView}`. Note: this is distinct from the higher-level APM Universe API (`/atc/views/view`) wrapped by [`ApmUniverseService`](src/lib/services/apm-universe.service.ts). Per `view-rest.adoc`, mutation endpoints (`createView`, `updateView`, `deleteView`, `setDefaultView`) require admin/MA roles. Filters use the `ALL | ID | ACTIVE | ATTRIBUTE | AND | OR` discriminated union.
+
+### `DataStoreAuditService`
+
+Wraps `/audit/{store,query,globalquery}`. `storeAudit` requires the documented audit-record fields (`eventTime`, `serviceId`, `resource`, `action`, `result`); other fields are validated as optional. `queryAudit` and `globalQueryAudit` are exposed by `AuditController` but their request/response shapes are kept loose (`z.looseObject({})`) until upstream docs firm up. `globalQueryAudit` requires master/global-admin privileges.
+
+### `DataStoreBlobStorageService`
+
+Wraps the full `/blobstorage` REST surface. Notes:
+
+- `storeBlob(params, body, attributes)` POSTs the raw body with required query params `schema`, `id`, `ttl` plus free-form attribute query params, matching the Java `BlobStorageController` contract.
+- `fetchBlob(schema, id, version?)` POSTs an empty body with the params on the query string and returns the raw response — fixing the legacy `BlobService.fetchBlob` quirk that cast an `AxiosResponse` directly.
+- `executeAsync` initiates async commands such as `DELETE_SCHEMA`, returning a `correlationKey` to poll via `asyncResult`.
+- The legacy `BlobService` and `model/blob/blob.model.ts` are intentionally retained side-by-side and are not coupled to this service.
+
+### `DataStoreTokensService`
+
+Wraps `/session/validate` and the full `/tenants/token/...` lifecycle (verify, getAndVerify, query, publicKey, user/agent/tenant/internal create+update, revoke/cancelRevoke/delete/import). Per `tokens-rest.adoc`:
+
+- Operations are role-gated server-side (MA/GA/TA/PU/UZ/AGENT). The client does **not** enforce these checks; callers must hold a token with the right role.
+- `queryTokens` accepts either the `query` string grammar or the `filter` JSON, but **not both** — this is enforced via `refine` on `TokenQueryRequestSchema`.
+- `createTenantToken(request, impersonate?)` accepts an optional `Auth-Impersonate` header value, used by internal tokens to impersonate a tenant scope.
+- `getPublicKey()` returns the JSON form. Use `getPublicKeyText()` for the raw PEM (sets `Accept: text/plain`).
+- `createInternalToken` and `importToken` require the master token.
+
+### `DataStoreFeaturesService`
+
+Wraps `/features/{store,delete,query,toggles,queryToggles,deleteToggles}`. Features form a hierarchical authorization tree with optional API regex lists and `datascopes` (filter templates of types `TAS | NASS | ES | REST`). MA/GA can toggle features globally; TA can override per-tenant but cannot undo MA/GA-set toggles. `toggleFeatures` accepts a flat array of feature ids; `deleteToggles([])` resets all toggles.
+
 ## Imports
 
 Public API is re-exported from the package root (`@dx-do/client`). Prefer:
@@ -115,6 +170,9 @@ The following symbols are retained for backwards compatibility but should not be
 | `DXSaaSConfiguration3` | `DXSaaSConfiguration4` |
 | `ChannelResponse.WebhookSpec` | `DXChannelWebhookSpecificConfiguration` |
 | `TemplatesResponse.LinkedEntity` | `PolicyResponse.LinkedEntity` |
+| `BlobService` (`monolith.dxBlobService`) | `DataStoreBlobStorageService` (`monolith.dxBlobStorageService`) |
+| `TASService` (`monolith.dxTASService`) | `DataStoreTASService` (`monolith.dxDataStoreTASService`) |
+| `NASSService.query` (`monolith.dxNASSService.query`) | `DataStoreNASSQLService.query` (`monolith.dxDataStoreNASSQLService.query`) |
 
 ## ASM integration
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dx-do/client",
-  "version": "5.2.38",
+  "version": "5.2.43",
   "description": "Opinionated TS client library for DX O2",
   "author": "Ki Alam",
   "logo": {