@attlaz/client 1.93.0 → 1.95.0

package/dist/DataQuality/Model/QualityDataset.d.ts

@@ -12,6 +12,12 @@ export declare class QualityDataset {
     autoCloseMode: string;
     config: Record<string, unknown> | null;
     createdAt: Date | null;
+    /**
+     * Totals for the overview: how much is being watched, and how much currently needs attention.
+     * Only the list endpoint counts them — both stay null when a single dataset is fetched.
+     */
+    entityCount: number | null;
+    openProblemCount: number | null;
     constructor(id: string, project: string, name: string);
     static parse(raw: ApiRecord): QualityDataset;
 }

package/dist/DataQuality/Model/QualityDataset.js

@@ -11,6 +11,12 @@ export class QualityDataset {
     autoCloseMode = '';
     config = null;
     createdAt = null;
+    /**
+     * Totals for the overview: how much is being watched, and how much currently needs attention.
+     * Only the list endpoint counts them — both stay null when a single dataset is fetched.
+     */
+    entityCount = null;
+    openProblemCount = null;
     constructor(id, project, name) {
         this.id = id;
         this.project = project;
@@ -21,6 +27,8 @@ export class QualityDataset {
         dataset.autoCloseMode = raw.auto_close_mode ?? '';
         dataset.config = raw.config ?? null;
         dataset.createdAt = raw.created_at ? new Date(raw.created_at) : null;
+        dataset.entityCount = raw.entity_count === undefined ? null : Number(raw.entity_count);
+        dataset.openProblemCount = raw.open_problem_count === undefined ? null : Number(raw.open_problem_count);
         return dataset;
     }
 }

package/dist/DataQuality/Model/QualityProblemDefinition.d.ts

@@ -0,0 +1,29 @@
+import { ApiRecord } from '../../Model/ApiRecord.js';
+/**
+ * The catalogue entry behind a problem code — the `/data_quality/definitions` resource.
+ *
+ * A code is a machine key (`verlichting.ean_invalid_checkdigit`); the definition is what makes it
+ * readable, so anything showing a code to a user should resolve it here. Definitions are either
+ * platform-owned (`ownerProject` null, shipped by Attlaz) or owned by a project, and a project's
+ * own definition takes precedence over a platform one with the same code.
+ *
+ * `blocking` is orthogonal to `defaultSeverity`: severity is how bad the problem is, blocking is
+ * whether the entity can be published to a channel at all.
+ */
+export declare class QualityProblemDefinition {
+    id: string;
+    code: string;
+    ownerProject: string | null;
+    label: string | null;
+    description: string | null;
+    dimension: string | null;
+    defaultSeverity: string | null;
+    blocking: boolean;
+    helpUrl: string | null;
+    pack: string | null;
+    property: string | null;
+    constructor(id: string, code: string);
+    /** What to show a user for this code: the label when it has one, the raw code otherwise. */
+    get displayName(): string;
+    static parse(raw: ApiRecord): QualityProblemDefinition;
+}

package/dist/DataQuality/Model/QualityProblemDefinition.js

@@ -0,0 +1,45 @@
+/**
+ * The catalogue entry behind a problem code — the `/data_quality/definitions` resource.
+ *
+ * A code is a machine key (`verlichting.ean_invalid_checkdigit`); the definition is what makes it
+ * readable, so anything showing a code to a user should resolve it here. Definitions are either
+ * platform-owned (`ownerProject` null, shipped by Attlaz) or owned by a project, and a project's
+ * own definition takes precedence over a platform one with the same code.
+ *
+ * `blocking` is orthogonal to `defaultSeverity`: severity is how bad the problem is, blocking is
+ * whether the entity can be published to a channel at all.
+ */
+export class QualityProblemDefinition {
+    id;
+    code;
+    ownerProject = null;
+    label = null;
+    description = null;
+    dimension = null;
+    defaultSeverity = null;
+    blocking = false;
+    helpUrl = null;
+    pack = null;
+    property = null;
+    constructor(id, code) {
+        this.id = id;
+        this.code = code;
+    }
+    /** What to show a user for this code: the label when it has one, the raw code otherwise. */
+    get displayName() {
+        return this.label ?? this.code;
+    }
+    static parse(raw) {
+        const definition = new QualityProblemDefinition(raw.id, raw.code);
+        definition.ownerProject = raw.owner_project ?? null;
+        definition.label = raw.label ?? null;
+        definition.description = raw.description ?? null;
+        definition.dimension = raw.dimension ?? null;
+        definition.defaultSeverity = raw.default_severity ?? null;
+        definition.blocking = raw.blocking === true;
+        definition.helpUrl = raw.help_url ?? null;
+        definition.pack = raw.pack ?? null;
+        definition.property = raw.property ?? null;
+        return definition;
+    }
+}

package/dist/DataQuality/Service/QualityEndpoint.d.ts

@@ -3,6 +3,7 @@ import { QualityEntity } from '../Model/QualityEntity.js';
 import { QualityEntityFilters } from '../Model/QualityEntityFilters.js';
 import { QualityFilterOptions } from '../Model/QualityFilterOptions.js';
 import { QualityProblem } from '../Model/QualityProblem.js';
+import { QualityProblemDefinition } from '../Model/QualityProblemDefinition.js';
 import { QualityProblemEvent } from '../Model/QualityProblemEvent.js';
 import { QualitySummary } from '../Model/QualitySummary.js';
 import { QualitySuppression } from '../Model/QualitySuppression.js';
@@ -33,6 +34,12 @@ export declare class QualityEndpoint extends Endpoint {
     getFilterOptions(datasetId: string): Promise<QualityFilterOptions>;
     /** Both groupings in one call: `counts` by (property, severity) and `codes` for the fix cards. */
     getSummary(datasetId: string): Promise<QualitySummary>;
+    /**
+     * The catalogue for a project: the platform's definitions plus the project's own. Use it to turn
+     * codes into something readable — `summary`/`filter-options` only carry codes that currently
+     * have open problems, so a fully suppressed or resolved code has no label there.
+     */
+    getDefinitions(projectId: string, pack?: string | null): Promise<CollectionResult<QualityProblemDefinition>>;
     getSuppressions(datasetId: string): Promise<CollectionResult<QualitySuppression>>;
     /**
      * Suppress a code, either on one entity or — with both entity fields omitted — across the whole

package/dist/DataQuality/Service/QualityEndpoint.js

@@ -2,6 +2,7 @@ import { QueryString } from '../../Http/Data/QueryString.js';
 import { QualityDataset } from '../Model/QualityDataset.js';
 import { QualityEntity } from '../Model/QualityEntity.js';
 import { QualityProblem } from '../Model/QualityProblem.js';
+import { QualityProblemDefinition } from '../Model/QualityProblemDefinition.js';
 import { QualityProblemEvent } from '../Model/QualityProblemEvent.js';
 import { QualitySuppression } from '../Model/QualitySuppression.js';
 import { Endpoint } from '../../Service/Endpoint.js';
@@ -117,6 +118,20 @@ export class QualityEndpoint extends Endpoint {
         }), 'GET');
         return result.getData() ?? { counts: [], codes: [] };
     }
+    // ---- Problem definitions ----
+    /**
+     * The catalogue for a project: the platform's definitions plus the project's own. Use it to turn
+     * codes into something readable — `summary`/`filter-options` only carry codes that currently
+     * have open problems, so a fully suppressed or resolved code has no label there.
+     */
+    async getDefinitions(projectId, pack = null) {
+        const queryString = new QueryString('/data_quality/definitions');
+        queryString.set('project', projectId);
+        if (pack !== null) {
+            queryString.set('pack', pack);
+        }
+        return await this.requestCollection(queryString, QualityProblemDefinition.parse);
+    }
     // ---- Suppressions ----
     async getSuppressions(datasetId) {
         return await this.requestCollection('/data_quality/datasets/' + datasetId + '/suppressions', QualitySuppression.parse);
@@ -127,14 +142,18 @@ export class QualityEndpoint extends Endpoint {
      * is there rather than only on future scans.
      */
     async createSuppression(datasetId, suppression) {
-        const body = { code: suppression.code };
-        if (suppression.entityType && suppression.entityId) {
-            body.entity_type = suppression.entityType;
-            body.entity_id = suppression.entityId;
-        }
-        if (suppression.reason) {
-            body.reason = suppression.reason;
-        }
+        // Both entity keys are always sent, explicitly null for a dataset-wide suppression: the
+        // endpoint requires them to be present so that a dropped or renamed key is an error rather
+        // than a silent widening to the whole dataset.
+        //
+        // `entity`, not `entity_id`: formatKey() strips a trailing `_id`, so `entity_id` is not
+        // expressible from this client at all.
+        const body = {
+            code: suppression.code,
+            entity_type: suppression.entityType ?? null,
+            entity: suppression.entityId ?? null,
+            reason: suppression.reason ?? null,
+        };
         const result = await this.requestObject('/data_quality/datasets/' + datasetId + '/suppressions', body, (raw) => ({
             suppression: raw.id ? QualitySuppression.parse(raw) : null,
             muted: Number(raw.muted ?? 0),

package/dist/index.d.ts

@@ -135,6 +135,7 @@ export { PulseStatisticsEndpoint } from './Pulse/Service/PulseStatisticsEndpoint
 export { QualityDataset } from './DataQuality/Model/QualityDataset.js';
 export { QualityEntity } from './DataQuality/Model/QualityEntity.js';
 export { QualityProblem } from './DataQuality/Model/QualityProblem.js';
+export { QualityProblemDefinition } from './DataQuality/Model/QualityProblemDefinition.js';
 export { QualityProblemEvent } from './DataQuality/Model/QualityProblemEvent.js';
 export { QualitySuppression } from './DataQuality/Model/QualitySuppression.js';
 export { QualityCodeOption } from './DataQuality/Model/QualityCodeOption.js';

package/dist/index.js

@@ -108,6 +108,7 @@ export { PulseStatisticsEndpoint } from './Pulse/Service/PulseStatisticsEndpoint
 export { QualityDataset } from './DataQuality/Model/QualityDataset.js';
 export { QualityEntity } from './DataQuality/Model/QualityEntity.js';
 export { QualityProblem } from './DataQuality/Model/QualityProblem.js';
+export { QualityProblemDefinition } from './DataQuality/Model/QualityProblemDefinition.js';
 export { QualityProblemEvent } from './DataQuality/Model/QualityProblemEvent.js';
 export { QualitySuppression } from './DataQuality/Model/QualitySuppression.js';
 export { QualityEndpoint } from './DataQuality/Service/QualityEndpoint.js';

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.93.0";
+export declare const VERSION = "1.94.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "1.93.0";
+export const VERSION = "1.94.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@attlaz/client",
-  "version": "1.93.0",
+  "version": "1.95.0",
   "description": "Javascript Client to access Attlaz API",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",