@dx-do/client 6.3.0 → 6.3.2

package/dist/index.cjs.js

@@ -46686,6 +46686,94 @@ exports.OIService = void 0;
     };
 })(exports.OIService || (exports.OIService = {}));
 
+/**
+ * The `ess/users/v2/list` user-account listing.
+ *
+ * Hand-modelled from observed responses (no published schema): every field is
+ * inferred from live data across multiple tenants. `looseObject` is used
+ * throughout so undocumented server fields are tolerated rather than dropped or
+ * rejected, and single-observation fields (e.g. {@link UserSchema.shape.authMethod})
+ * are kept as plain strings rather than locked enums.
+ */
+exports.OIUsersV2 = void 0;
+(function (OIUsersV2) {
+    /** One email address attached to a user. */
+    OIUsersV2.EmailIdSchema = v4.z.looseObject({
+        emailAddr: v4.z.string().describe('the email address'),
+        qualifier: v4.z
+            .string()
+            .describe('email category; only "EMAILID" observed in live data'),
+    });
+    /** The user's assigned role. */
+    OIUsersV2.RoleSchema = v4.z.looseObject({
+        name: v4.z
+            .string()
+            .describe('role identifier, e.g. "VIEW105" / "TA" / "PU" / "UZ"'),
+        privileges: v4.z
+            .array(v4.z.unknown())
+            .describe('granted privilege entries; empty in all observed data'),
+        level: v4.z.number().describe('role level; 0 in all observed data'),
+    });
+    /** A single user account. */
+    OIUsersV2.UserSchema = v4.z.looseObject({
+        userRefID: v4.z.number().describe('numeric internal user reference id'),
+        userId: v4.z
+            .string()
+            .describe('login principal; usually the email address upper-cased'),
+        cohort: v4.z
+            .string()
+            .describe('per-user cohort id in dashed, upper-cased GUID form'),
+        firstName: v4.z.string().describe('given name'),
+        lastName: v4.z
+            .string()
+            .optional()
+            .describe('family name; occasionally absent'),
+        statusEnum: v4.z
+            .enum(['ACTIVE', 'INACTIVE'])
+            .describe('account status; only ACTIVE/INACTIVE observed'),
+        emailIds: v4.z
+            .array(OIUsersV2.EmailIdSchema)
+            .describe('email addresses associated with the user'),
+        hasImage: v4.z.boolean().describe('whether a profile image is set'),
+        authMethod: v4.z
+            .string()
+            .describe('authentication method; only "BASIC_AUTH" observed'),
+        dateCreated: v4.z
+            .string()
+            .describe('creation timestamp, ISO-8601 with +0000 offset (not "Z")'),
+        dateModified: v4.z
+            .string()
+            .describe('last-modified timestamp, ISO-8601 with +0000 offset'),
+        startLockTime: v4.z
+            .string()
+            .optional()
+            .describe('lock-start timestamp; present only when the account is locked'),
+        internalAttrs: v4.z
+            .array(v4.z.string().nullable())
+            .describe('internal attribute slots; observed as a length-3 array of nullable strings, semantics undocumented'),
+        tenant: v4.z.string().describe('tenant id the user belongs to'),
+        lockStatus: v4.z
+            .boolean()
+            .describe('whether the account is currently locked'),
+        role: OIUsersV2.RoleSchema.describe('the assigned role'),
+        hasAllDataAccess: v4.z
+            .boolean()
+            .describe('whether the user has unrestricted data access'),
+        userType: v4.z
+            .string()
+            .optional()
+            .describe('account type; the list request filters to USER_ACCOUNT, but the field is not always echoed back'),
+        deleted: v4.z.boolean().describe('soft-delete flag'),
+    });
+    /** The list envelope: a page of users plus the server-side total. */
+    OIUsersV2.UserListResponseSchema = v4.z.looseObject({
+        countTotal: v4.z
+            .number()
+            .describe('total users matching the query on the server, for pagination'),
+        users: v4.z.array(OIUsersV2.UserSchema).describe('the returned page of users'),
+    });
+})(exports.OIUsersV2 || (exports.OIUsersV2 = {}));
+
 /** @internal */
 function createPostmanRequest(request) {
     function createPostmanHeaders(request) {
@@ -48562,6 +48650,182 @@ exports.Situations = void 0;
 (function (Situations) {
 })(exports.Situations || (exports.Situations = {}));
 
+/**
+ * One row of an SLI's match criteria. SLIs select the metrics they watch by a
+ * list of these AND-ed filters (e.g. "Source contains bd605" AND "Metric ends
+ * with Web Agent Status").
+ */
+const SliFilterSchema = v4.z.looseObject({
+    fieldDescription: v4.z
+        .string()
+        .describe('Human label for the field, e.g. "Source" or "Metric"'),
+    field: v4.z
+        .string()
+        .describe('Wire field the filter matches on, e.g. "sourceName" or "attributeName"'),
+    value: v4.z.string().describe('Value to match against the field'),
+    condition: v4.z
+        .string()
+        .describe('Match operator, e.g. "contains", "ends_with", "regex"'),
+});
+/**
+ * A full SLI "group" as returned by `groups/search` (per `sliGroups[]` entry)
+ * and `groups?groupId=<id>` (single object). This is the **raw** shape that
+ * `sli export` writes to disk and `sli import` reads back.
+ *
+ * The wire terms are `groupName` / `groupId`; the CLI surfaces these to users
+ * as `sliName` / `sliId`. The deeply-nested `sliDefinition` / `sloDefinition` /
+ * `alertDefinition` blocks are kept **opaque** (loose passthrough) so they
+ * round-trip untouched — we model the envelope, not the SLI/SLO math.
+ */
+const SliGroupSchema = v4.z.looseObject({
+    groupName: v4.z.string().describe('SLI name (surfaced to users as `sliName`)'),
+    groupId: v4.z
+        .number()
+        .describe('Server-assigned SLI id (surfaced to users as `sliId`)'),
+    type: v4.z
+        .string()
+        .nullable()
+        .optional()
+        .describe('Group type; "sli" for SLIs. Save bodies set it; the GET-by-id response returns null'),
+    description: v4.z
+        .string()
+        .nullable()
+        .optional()
+        .describe('Free-text description; may be null or empty'),
+    mgId: v4.z
+        .unknown()
+        .nullable()
+        .optional()
+        .describe('Management-group id; null for SLIs'),
+    filters: v4.z
+        .array(SliFilterSchema)
+        .describe('AND-ed metric match criteria selecting the SLI source metrics'),
+    serviceNames: v4.z
+        .array(v4.z.string())
+        .describe('Service names this SLI is bound to. `sli import` overwrites this with the passed serviceName'),
+    sliDefinition: v4.z
+        .looseObject({ functions: v4.z.array(v4.z.unknown()).optional() })
+        .optional()
+        .describe('Opaque SLI computation spec ({ functions: [...] }); round-tripped verbatim'),
+    sloDefinition: v4.z
+        .looseObject({ functions: v4.z.array(v4.z.unknown()).optional() })
+        .optional()
+        .describe('Opaque SLO computation spec ({ functions: [...] }); round-tripped verbatim'),
+    alertDefinition: v4.z
+        .unknown()
+        .optional()
+        .describe('Opaque alert spec; null or an array. Normalized to [] on import when null'),
+    // Read-only server-managed fields (present on reads, ignored on save).
+    creationTime: v4.z.number().optional().describe('Epoch seconds the SLI was created'),
+    lastModifiedTime: v4.z.number().optional().describe('Epoch seconds the SLI was last modified'),
+    createdBy: v4.z.string().nullable().optional().describe('User that created the SLI'),
+    lastUpdatedBy: v4.z.string().nullable().optional().describe('User that last updated the SLI'),
+    totalMetrics: v4.z.number().optional().describe('Count of metrics currently matched by the SLI'),
+    breached: v4.z.boolean().optional().describe('Whether the SLO is currently breached'),
+    product: v4.z.unknown().nullable().optional().describe('Owning product; usually null'),
+    enabled: v4.z.boolean().optional().describe('Whether the SLI is active'),
+    sliStatusCode: v4.z.number().optional().describe('Registration status code; 0 = healthy'),
+    sliStatusMessage: v4.z.string().optional().describe('Human-readable registration status'),
+    fixRequired: v4.z.boolean().optional().describe('Whether the SLI needs attention to register'),
+    pipelineErrors: v4.z.array(v4.z.unknown()).optional().describe('Per-pipeline error details, if any'),
+    defaultGroup: v4.z.boolean().optional().describe('Whether this is a system default group'),
+});
+
+/**
+ * Request body for `POST oi/v2/metricconfig/groups/save`. Mirrors the writable
+ * subset of {@link SliGroupSchema} — read-only server fields (creationTime,
+ * createdBy, totalMetrics, …) are not sent.
+ *
+ * `groupId` is the create/update discriminator: present → update that group;
+ * absent → create a new one. `sli import` always omits it so import is
+ * create-only and can never overwrite an existing SLI.
+ */
+const SliSaveRequestSchema = v4.z.looseObject({
+    type: v4.z.string().describe('Always "sli" for SLIs'),
+    groupName: v4.z.string().describe('SLI name'),
+    description: v4.z.string().nullable().optional().describe('Free-text description'),
+    mgId: v4.z.unknown().nullable().optional().describe('Management-group id; null for SLIs'),
+    filters: v4.z.array(SliFilterSchema).describe('AND-ed metric match criteria'),
+    serviceNames: v4.z.array(v4.z.string()).describe('Service names the SLI binds to'),
+    sliDefinition: v4.z.unknown().describe('Opaque SLI computation spec, round-tripped from the export'),
+    sloDefinition: v4.z.unknown().describe('Opaque SLO computation spec, round-tripped from the export'),
+    alertDefinition: v4.z.unknown().optional().describe('Opaque alert spec; [] when none'),
+    groupId: v4.z
+        .number()
+        .optional()
+        .describe('Omit to create a new SLI; include to update an existing one'),
+});
+/**
+ * Response from `POST oi/v2/metricconfig/groups/save`.
+ */
+const SliSaveResponseSchema = v4.z.looseObject({
+    groupId: v4.z.number().describe('Id of the created/updated SLI'),
+    message: v4.z.array(v4.z.string()).describe('Server status messages'),
+    status: v4.z.string().describe('"Success" on success'),
+});
+/**
+ * Projects a read-model {@link SliGroup} onto the writable {@link SliSaveRequest}
+ * subset — dropping the read-only server fields (creationTime, createdBy,
+ * totalMetrics, …) and normalizing `type` (default `'sli'`) and
+ * `alertDefinition` (`null` → `[]`).
+ *
+ * @param group - The source SLI (e.g. from `getSli` or a raw export file).
+ * @param opts.serviceNames - Override the bound services; defaults to the group's.
+ * @param opts.create - When true, omit `groupId` so the save *creates* a new SLI;
+ *   otherwise `groupId` is carried through and the save *updates* in place.
+ */
+function toSliSaveRequest(group, opts = {}) {
+    const body = {
+        type: group.type ?? 'sli',
+        groupName: group.groupName,
+        description: group.description ?? '',
+        mgId: group.mgId ?? null,
+        filters: group.filters,
+        serviceNames: opts.serviceNames ?? group.serviceNames,
+        sliDefinition: group.sliDefinition,
+        sloDefinition: group.sloDefinition,
+        alertDefinition: group.alertDefinition ?? [],
+    };
+    if (!opts.create) {
+        body.groupId = group.groupId;
+    }
+    return body;
+}
+
+/**
+ * Request body for `POST oi/v2/metricconfig/groups/search`. Listing SLIs is a
+ * search scoped to `type: "sli"` with a large `pageSize` (the server returns
+ * all matching groups up to that cap).
+ */
+const SliSearchRequestSchema = v4.z.looseObject({
+    pageSize: v4.z
+        .number()
+        .describe('Max groups to return. Use a large value (e.g. 5000) to list all SLIs'),
+    type: v4.z
+        .string()
+        .describe('Group type to search; "sli" for SLIs'),
+});
+/**
+ * Response from `POST oi/v2/metricconfig/groups/search`. The SLIs are in
+ * `sliGroups`; the surrounding fields are tenant-wide metric-config limits.
+ */
+const SliSearchResponseSchema = v4.z.looseObject({
+    totalGroups: v4.z.number().optional().describe('Number of groups returned in `sliGroups`'),
+    pageSize: v4.z.number().optional().describe('Effective page size applied by the server'),
+    enabledMetrics: v4.z.number().optional().describe('Total metrics enabled across all SLIs'),
+    allowedMetricGroupsPerService: v4.z
+        .number()
+        .optional()
+        .describe('Tenant cap on SLI groups per service'),
+    allowedMetricsPerGroup: v4.z
+        .number()
+        .optional()
+        .describe('Tenant cap on metrics per SLI group'),
+    sliGroups: v4.z
+        .array(SliGroupSchema)
+        .describe('The SLI groups matching the search'),
+});
+
 exports.TAS = void 0;
 (function (TAS) {
     /** @internal */
@@ -64087,6 +64351,50 @@ class AuthorizationService {
     getUsers() {
         return this.dxSaaSService.tenantGet('oi/v2/api/users');
     }
+    /**
+     * Lists users via the ESS users v2 endpoint.
+     *
+     * The path's trailing segment is the cohort id in upper-cased, dashed GUID
+     * form (e.g. `6E82C5F4-8F16-4CD9-8BF0-6263F83054D5`). `oiGet` already injects
+     * the lowercase, dash-less cohort id as the base path segment, so we rebuild
+     * the GUID form here independently of how the config stores it.
+     *
+     * The response type is hand-modelled from observed data ({@link OIUsersV2});
+     * validation is defensive (`safeParse` + `log.warn`), so a server-side shape
+     * change logs a warning but still returns the raw payload to the caller.
+     *
+     * @remarks Response is validated, not thrown — see {@link OIUsersV2}.
+     */
+    async getUsersV2(startIndex = 1, endIndex = 500) {
+        const cohortGuid = this.toGuidCohortId(this.dxSaaSService.getCohortIDForURL());
+        const raw = await this.dxSaaSService.oiGet(`ess/users/v2/list/${cohortGuid}`, {
+            cachebuster: Math.random(),
+            preventCache: Math.random(),
+            start_index: startIndex,
+            end_index: endIndex,
+            sort_by_field: 'DATEMODIFIED',
+            sort_order: 'desc',
+            user_type: 'USER_ACCOUNT',
+        });
+        const result = exports.OIUsersV2.UserListResponseSchema.safeParse(raw);
+        if (!result.success) {
+            this.log.warn('OIUsersV2 response validation warning: ' + result.error.message);
+        }
+        return raw;
+    }
+    /** Reformats a cohort id to upper-cased, dashed GUID form (`8-4-4-4-12`). */
+    toGuidCohortId(cohortId) {
+        const hex = cohortId.replace(/-/g, '').toLowerCase();
+        return [
+            hex.slice(0, 8),
+            hex.slice(8, 12),
+            hex.slice(12, 16),
+            hex.slice(16, 20),
+            hex.slice(20, 32),
+        ]
+            .join('-')
+            .toUpperCase();
+    }
 }
 
 /**
@@ -66703,56 +67011,47 @@ const coerce$1 = (version, options) => {
 };
 var coerce_1 = coerce$1;
 
-var lrucache;
-var hasRequiredLrucache;
-
-function requireLrucache () {
-	if (hasRequiredLrucache) return lrucache;
-	hasRequiredLrucache = 1;
-
-	class LRUCache {
-	  constructor () {
-	    this.max = 1000;
-	    this.map = new Map();
-	  }
-
-	  get (key) {
-	    const value = this.map.get(key);
-	    if (value === undefined) {
-	      return undefined
-	    } else {
-	      // Remove the key from the map and add it to the end
-	      this.map.delete(key);
-	      this.map.set(key, value);
-	      return value
-	    }
-	  }
+class LRUCache {
+  constructor () {
+    this.max = 1000;
+    this.map = new Map();
+  }
 
-	  delete (key) {
-	    return this.map.delete(key)
-	  }
+  get (key) {
+    const value = this.map.get(key);
+    if (value === undefined) {
+      return undefined
+    } else {
+      // Remove the key from the map and add it to the end
+      this.map.delete(key);
+      this.map.set(key, value);
+      return value
+    }
+  }
 
-	  set (key, value) {
-	    const deleted = this.delete(key);
+  delete (key) {
+    return this.map.delete(key)
+  }
 
-	    if (!deleted && value !== undefined) {
-	      // If cache is full, delete the least recently used item
-	      if (this.map.size >= this.max) {
-	        const firstKey = this.map.keys().next().value;
-	        this.delete(firstKey);
-	      }
+  set (key, value) {
+    const deleted = this.delete(key);
 
-	      this.map.set(key, value);
-	    }
+    if (!deleted && value !== undefined) {
+      // If cache is full, delete the least recently used item
+      if (this.map.size >= this.max) {
+        const firstKey = this.map.keys().next().value;
+        this.delete(firstKey);
+      }
 
-	    return this
-	  }
-	}
+      this.map.set(key, value);
+    }
 
-	lrucache = LRUCache;
-	return lrucache;
+    return this
+  }
 }
 
+var lrucache = LRUCache;
+
 var range;
 var hasRequiredRange;
 
@@ -66974,7 +67273,7 @@ function requireRange () {
 
 	range = Range;
 
-	const LRU = requireLrucache();
+	const LRU = lrucache;
 	const cache = new LRU();
 
 	const parseOptions = parseOptions_1;
@@ -75987,6 +76286,80 @@ class ServiceService {
     }
 }
 
+/**
+ * Service for SLIs (Service Level Indicators), modeled by the OI metricconfig
+ * API as metric "groups" of `type: "sli"` under `oi/v2/metricconfig/groups/*`.
+ *
+ * These endpoints require the `x-authorizationview: VIEWALL` header, so this
+ * service uses {@link DxSaasService.oiPost} / {@link DxSaasService.oiGet}
+ * (which inject it) rather than the plain `tenant*` methods.
+ *
+ * Requests are validated against their input schema (throws `ZodError`);
+ * responses are `safeParse`-validated (warn-on-mismatch, raw still returned).
+ * Backs the `sli list` / `sli export` / `sli import` CLI commands.
+ */
+class SLIService {
+    dxSaasService;
+    log;
+    /**
+     * @param dxSaasService - An authenticated {@link DxSaasService} for the target tenant.
+     * @param log - Logger conforming to {@link SimpleLog} from `@dx-do/util`.
+     */
+    constructor(dxSaasService, log) {
+        this.dxSaasService = dxSaasService;
+        this.log = log;
+    }
+    /**
+     * Lists SLIs via `POST oi/v2/metricconfig/groups/search`.
+     *
+     * @remarks Defaults to `{ pageSize: 5000, type: 'sli' }`; pass a partial
+     *   override to change the cap. Response is validated but returned raw on
+     *   mismatch.
+     * @throws ZodError if the (merged) request fails schema validation.
+     */
+    async searchSlis(request) {
+        const body = { pageSize: 5000, type: 'sli', ...request };
+        SliSearchRequestSchema.parse(body);
+        const raw = await this.dxSaasService.oiPost('oi/v2/metricconfig/groups/search', body);
+        const result = SliSearchResponseSchema.safeParse(raw);
+        if (!result.success) {
+            this.log.warn('SliSearchResponse validation warning:', result.error.message);
+        }
+        return raw;
+    }
+    /**
+     * Retrieves a single SLI by id via `GET oi/v2/metricconfig/groups?groupId=<id>`.
+     * The returned object is the **raw** group `sli export` writes to disk.
+     *
+     * @remarks Response is validated but returned raw on mismatch.
+     */
+    async getSli(sliId) {
+        const raw = await this.dxSaasService.oiGet('oi/v2/metricconfig/groups', { groupId: sliId });
+        const result = SliGroupSchema.safeParse(raw);
+        if (!result.success) {
+            this.log.warn('SliGroup validation warning:', result.error.message);
+        }
+        return raw;
+    }
+    /**
+     * Creates or updates an SLI via `POST oi/v2/metricconfig/groups/save`. Omit
+     * `groupId` on the body to create; include it to update.
+     *
+     * @remarks Request is validated against {@link SliSaveRequestSchema}
+     *   (throws on bad input); response validated but returned raw on mismatch.
+     * @throws ZodError if the request fails schema validation.
+     */
+    async saveSli(body) {
+        SliSaveRequestSchema.parse(body);
+        const raw = await this.dxSaasService.oiPost('oi/v2/metricconfig/groups/save', body);
+        const result = SliSaveResponseSchema.safeParse(raw);
+        if (!result.success) {
+            this.log.warn('SliSaveResponse validation warning:', result.error.message);
+        }
+        return raw;
+    }
+}
+
 /**
  * Service for cluster/situation alarms: search, overview, lifecycle, inspection,
  * and triggering notifications for situations.
@@ -77971,6 +78344,7 @@ function createServiceMonolith(dxDoConfiguration, log = new NullSimpleLog()) {
         dxServiceService: new ServiceService(dxSaaSService, log),
         dxSessionService: new SessionService(dxSaaSService),
         dxSituationService: new SituationService(dxSaaSService, log),
+        dxSLIService: new SLIService(dxSaaSService, log),
         dxSQLService: new SQLService(dxSaaSService),
         dxStatesService: new DataStoreStatesService(dxSaaSService, log),
         dxTASService,
@@ -78127,12 +78501,19 @@ exports.QueryRequestSchema = QueryRequestSchema;
 exports.QueryResultSchema = QueryResultSchema;
 exports.QuerySpecSpecifierSchema = QuerySpecSpecifierSchema;
 exports.QuerySpecifierSchema = QuerySpecifierSchema;
+exports.SLIService = SLIService;
 exports.SQLService = SQLService;
 exports.ServiceFilterSpecifierSchema = ServiceFilterSpecifierSchema;
 exports.ServiceService = ServiceService;
 exports.SessionService = SessionService;
 exports.SimpleHTTPError = SimpleHTTPError;
 exports.SituationService = SituationService;
+exports.SliFilterSchema = SliFilterSchema;
+exports.SliGroupSchema = SliGroupSchema;
+exports.SliSaveRequestSchema = SliSaveRequestSchema;
+exports.SliSaveResponseSchema = SliSaveResponseSchema;
+exports.SliSearchRequestSchema = SliSearchRequestSchema;
+exports.SliSearchResponseSchema = SliSearchResponseSchema;
 exports.SourceNameAllSpecifierSchema = SourceNameAllSpecifierSchema;
 exports.SourceNameAndSpecifierSchema = SourceNameAndSpecifierSchema;
 exports.SourceNameExactSpecifierSchema = SourceNameExactSpecifierSchema;
@@ -78330,6 +78711,7 @@ exports.statistic = statistic;
 exports.summarizeDataStoreSchema = summarizeDataStoreSchema;
 exports.tagsGetAll = tagsGetAll;
 exports.timezonesList = timezonesList;
+exports.toSliSaveRequest = toSliSaveRequest;
 exports.userBlockDelete = userBlockDelete;
 exports.userBlockPut = userBlockPut;
 exports.userDelete = userDelete;