@spottoai/types-package 1.0.2-dev1138.12 → 1.0.2-dev1138.14

package/dist/reporting/jobs/reportJobRow.d.ts

@@ -0,0 +1,98 @@
+import { type ReportJobReportType, type ReportJobSpecV1 } from './reportJobSpec';
+import { type ReportJobFailureCode, type ReportJobFailureStage, type ReportJobNotificationStatus, type ReportJobStatus } from './reportJobStatus';
+export declare const REPORT_JOB_ROW_SCHEMA_VERSION = 1;
+export declare const REPORT_JOB_TRIGGERS: readonly ["api", "schedule"];
+export type ReportJobTrigger = (typeof REPORT_JOB_TRIGGERS)[number];
+/** UTF-8 byte limit of `sourceCoverageSummary` (a JSON object). */
+export declare const REPORT_JOB_COVERAGE_SUMMARY_MAX_BYTES: number;
+/** Written once by the API or the scheduler adapter; immutable afterwards. */
+export interface ReportJobProducerFieldsV1 {
+    PartitionKey: string;
+    RowKey: string;
+    schemaVersion: 1;
+    jobId: string;
+    companyId: string;
+    reportType: ReportJobReportType;
+    trigger: ReportJobTrigger;
+    /** Schedule jobs only. */
+    scheduleId?: string;
+    /** Schedule jobs only. */
+    definitionRevision?: number;
+    /** Schedule jobs only: the occurrence the job is for (the job ID's instant). */
+    scheduledForUtc?: string;
+    /** When the producer accepted the job (the job ID's instant for API jobs). */
+    requestedAtUtc: string;
+    requestedByUserId?: string;
+    coalescedOccurrenceCount?: number;
+    /** Canonical `serializeReportJobSpecV1` output. */
+    requestJson: string;
+    requestSha256: string;
+    fileName: string;
+    notificationPolicyId?: string;
+}
+/** Merged by reportworker. The producer inserts `status: 'accepted'` and `attemptCount: 0`. */
+export interface ReportJobWorkerFieldsV1 {
+    status: ReportJobStatus;
+    attemptCount: number;
+    leaseOwner?: string;
+    leaseExpiresAtUtc?: string;
+    startedAtUtc?: string;
+    lastAttemptAtUtc?: string;
+    sourceObservedAtUtc?: string;
+    sourceSnapshotSha256?: string;
+    /** A JSON object, at most 8 KiB of UTF-8. */
+    sourceCoverageSummary?: string;
+    generatedAtUtc?: string;
+    artifactContentSha256?: string;
+    artifactBytes?: number;
+    completedAtUtc?: string;
+    failureStage?: ReportJobFailureStage;
+    failureCode?: ReportJobFailureCode;
+    lastTransientErrorCode?: string;
+}
+/** Merged by cloud-engine's notifier (phase 6). The producer inserts `notificationStatus: 'none'`. */
+export interface ReportJobNotificationFieldsV1 {
+    notificationStatus: ReportJobNotificationStatus;
+}
+export type ReportJobRowV1 = ReportJobProducerFieldsV1 & ReportJobWorkerFieldsV1 & ReportJobNotificationFieldsV1;
+export declare const REPORT_JOB_PRODUCER_FIELDS: readonly ["PartitionKey", "RowKey", "schemaVersion", "jobId", "companyId", "reportType", "trigger", "scheduleId", "definitionRevision", "scheduledForUtc", "requestedAtUtc", "requestedByUserId", "coalescedOccurrenceCount", "requestJson", "requestSha256", "fileName", "notificationPolicyId"];
+export declare const REPORT_JOB_WORKER_FIELDS: readonly ["status", "attemptCount", "leaseOwner", "leaseExpiresAtUtc", "startedAtUtc", "lastAttemptAtUtc", "sourceObservedAtUtc", "sourceSnapshotSha256", "sourceCoverageSummary", "generatedAtUtc", "artifactContentSha256", "artifactBytes", "completedAtUtc", "failureStage", "failureCode", "lastTransientErrorCode"];
+export declare const REPORT_JOB_NOTIFICATION_FIELDS: readonly ["notificationStatus"];
+export type ReportJobRowParseResult = {
+    ok: true;
+    row: ReportJobRowV1;
+    spec: ReportJobSpecV1;
+} | {
+    ok: false;
+    code: Extract<ReportJobFailureCode, 'request-invalid' | 'request-hash-mismatch' | 'unsupported-schema-version'>;
+    errors: string[];
+};
+/**
+ * Validates a stored row and its request. Accepts REST (`PartitionKey`) and `@azure/data-tables` (`partitionKey`)
+ * key casing and ignores Table system properties. Checks keys against the body, the job ID against the trigger's
+ * instant, status against the fields that prove it, the report type and scope hash against the spec, the request's
+ * canonical form and `requestSha256`. Returns the row in REST casing. Never throws.
+ */
+export declare const parseReportJobRowV1: (entity: unknown) => Promise<ReportJobRowParseResult>;
+export type BuildReportJobRowInput = {
+    companyId: string;
+    spec: ReportJobSpecV1;
+    fileName: string;
+    requestedAtUtc: string;
+    requestedByUserId?: string;
+    notificationPolicyId?: string;
+} & ({
+    trigger: 'api';
+} | {
+    trigger: 'schedule';
+    scheduleId: string;
+    definitionRevision: number;
+    scheduledForUtc: string;
+    coalescedOccurrenceCount?: number;
+});
+/**
+ * Builds the row a producer inserts (status `accepted`, attempt 0, notification `none`), with the job ID derived
+ * from the trigger's instant and the request. The result is validated with `parseReportJobRowV1`; invalid input throws.
+ */
+export declare const buildReportJobRowV1: (input: BuildReportJobRowInput) => Promise<ReportJobRowV1>;
+//# sourceMappingURL=reportJobRow.d.ts.map

package/dist/reporting/jobs/reportJobRow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportJobRow.d.ts","sourceRoot":"","sources":["../../../src/reporting/jobs/reportJobRow.ts"],"names":[],"mappings":"AAqBA,OAAO,EAIL,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAML,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,eAAe,EACrB,MAAM,mBAAmB,CAAC;AAE3B,eAAO,MAAM,6BAA6B,IAAI,CAAC;AAC/C,eAAO,MAAM,mBAAmB,8BAA+B,CAAC;AAChE,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AACpE,mEAAmE;AACnE,eAAO,MAAM,qCAAqC,QAAW,CAAC;AAE9D,8EAA8E;AAC9E,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,CAAC,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,mBAAmB,CAAC;IAChC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,0BAA0B;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,+FAA+F;AAC/F,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,eAAe,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,6CAA6C;IAC7C,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACrC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,sGAAsG;AACtG,MAAM,WAAW,6BAA6B;IAC5C,kBAAkB,EAAE,2BAA2B,CAAC;CACjD;AAED,MAAM,MAAM,cAAc,GAAG,yBAAyB,GAAG,uBAAuB,GAAG,6BAA6B,CAAC;AAEjH,eAAO,MAAM,0BAA0B,mSAkB0B,CAAC;AAElE,eAAO,MAAM,wBAAwB,2TAiB0B,CAAC;AAEhE,eAAO,MAAM,8BAA8B,iCAA6F,CAAC;AA4BzI,MAAM,MAAM,uBAAuB,GAC/B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,GAAG,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GACxD;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC,oBAAoB,EAAE,iBAAiB,GAAG,uBAAuB,GAAG,4BAA4B,CAAC,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAwGrJ;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAU,QAAQ,OAAO,KAAG,OAAO,CAAC,uBAAuB,CA4B1F,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,GAAG,CACA;IAAE,OAAO,EAAE,KAAK,CAAA;CAAE,GAClB;IAAE,OAAO,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,kBAAkB,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,CAAC;IAAC,wBAAwB,CAAC,EAAE,MAAM,CAAA;CAAE,CACtI,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAU,OAAO,sBAAsB,KAAG,OAAO,CAAC,cAAc,CAwC/F,CAAC"}

package/dist/reporting/jobs/reportJobRow.js

@@ -0,0 +1,270 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildReportJobRowV1 = exports.parseReportJobRowV1 = exports.REPORT_JOB_NOTIFICATION_FIELDS = exports.REPORT_JOB_WORKER_FIELDS = exports.REPORT_JOB_PRODUCER_FIELDS = exports.REPORT_JOB_COVERAGE_SUMMARY_MAX_BYTES = exports.REPORT_JOB_TRIGGERS = exports.REPORT_JOB_ROW_SCHEMA_VERSION = void 0;
+/**
+ * The `reportjobs` row (core/specs/reporting/reporting-scheduler.md, "Report job table").
+ *
+ * PartitionKey = companyId, RowKey = jobId. Three writers own disjoint field groups and merge with ETag
+ * compare-and-swap: the producer (insert only), reportworker and, from phase 6, cloud-engine's notifier.
+ * The row carries no region (each region has its own table, queue and worker) and no time zone (reportworker uses
+ * the company's `preferredTimezone`, else UTC). The row never holds e-mail addresses, document content, source data, Blob paths or credentials.
+ */
+const reportingDigest_1 = require("../shared/reportingDigest");
+const reportingPaths_1 = require("../shared/reportingPaths");
+const reportingIds_1 = require("../shared/reportingIds");
+const reportTableEntities_1 = require("../shared/reportTableEntities");
+const reportJobIdentity_1 = require("./reportJobIdentity");
+const reportJobSpec_1 = require("./reportJobSpec");
+const reportJobStatus_1 = require("./reportJobStatus");
+exports.REPORT_JOB_ROW_SCHEMA_VERSION = 1;
+exports.REPORT_JOB_TRIGGERS = ['api', 'schedule'];
+/** UTF-8 byte limit of `sourceCoverageSummary` (a JSON object). */
+exports.REPORT_JOB_COVERAGE_SUMMARY_MAX_BYTES = 8 * 1024;
+exports.REPORT_JOB_PRODUCER_FIELDS = [
+    'PartitionKey',
+    'RowKey',
+    'schemaVersion',
+    'jobId',
+    'companyId',
+    'reportType',
+    'trigger',
+    'scheduleId',
+    'definitionRevision',
+    'scheduledForUtc',
+    'requestedAtUtc',
+    'requestedByUserId',
+    'coalescedOccurrenceCount',
+    'requestJson',
+    'requestSha256',
+    'fileName',
+    'notificationPolicyId',
+];
+exports.REPORT_JOB_WORKER_FIELDS = [
+    'status',
+    'attemptCount',
+    'leaseOwner',
+    'leaseExpiresAtUtc',
+    'startedAtUtc',
+    'lastAttemptAtUtc',
+    'sourceObservedAtUtc',
+    'sourceSnapshotSha256',
+    'sourceCoverageSummary',
+    'generatedAtUtc',
+    'artifactContentSha256',
+    'artifactBytes',
+    'completedAtUtc',
+    'failureStage',
+    'failureCode',
+    'lastTransientErrorCode',
+];
+exports.REPORT_JOB_NOTIFICATION_FIELDS = ['notificationStatus'];
+const REQUIRED_FIELDS = [
+    'PartitionKey',
+    'RowKey',
+    'schemaVersion',
+    'jobId',
+    'companyId',
+    'reportType',
+    'trigger',
+    'requestedAtUtc',
+    'requestJson',
+    'requestSha256',
+    'fileName',
+    'status',
+    'attemptCount',
+    'notificationStatus',
+];
+const OPTIONAL_FIELDS = [...exports.REPORT_JOB_PRODUCER_FIELDS, ...exports.REPORT_JOB_WORKER_FIELDS, ...exports.REPORT_JOB_NOTIFICATION_FIELDS].filter(field => !REQUIRED_FIELDS.includes(field));
+/** Statuses reached only after the source snapshot is durable. */
+const SNAPSHOT_STATUSES = ['source-ready', 'generated', 'completed', 'completed-with-notification-errors'];
+/** Statuses reached only after the artifact is durable. */
+const ARTIFACT_STATUSES = ['generated', 'completed', 'completed-with-notification-errors'];
+const isCount = (value) => typeof value === 'number' && Number.isInteger(value) && value >= 0 && value <= 2147483647;
+const isSha = (value) => typeof value === 'string' && reportingDigest_1.SHA256_HEX_PATTERN.test(value);
+const isText = (limit) => (value) => (0, reportingIds_1.isBoundedPlainText)(value, limit);
+const isOptional = (value, check) => value === undefined || check(value);
+const isCoverageSummary = (value) => {
+    if (typeof value !== 'string' || (0, reportingIds_1.utf8ByteLength)(value) > exports.REPORT_JOB_COVERAGE_SUMMARY_MAX_BYTES)
+        return false;
+    try {
+        const parsed = JSON.parse(value);
+        return typeof parsed === 'object' && parsed !== null;
+    }
+    catch {
+        return false;
+    }
+};
+/** `row` is already normalised (REST key casing, no system properties, no null values). */
+const validateShape = (row, errors) => {
+    const check = (field, ok) => {
+        if (!ok)
+            errors.push(`${field}: invalid`);
+    };
+    if (!(0, reportingIds_1.hasExactlyKeys)(row, REQUIRED_FIELDS, OPTIONAL_FIELDS)) {
+        const unknown = Object.keys(row).filter(key => !REQUIRED_FIELDS.includes(key) && !OPTIONAL_FIELDS.includes(key));
+        const missing = REQUIRED_FIELDS.filter(key => row[key] === undefined);
+        if (unknown.length > 0)
+            errors.push(`row: unknown fields ${unknown.join(', ')}`);
+        if (missing.length > 0)
+            errors.push(`row: missing fields ${missing.join(', ')}`);
+    }
+    check('companyId', (0, reportingIds_1.isReportJobCompanyId)(row.companyId) && row.PartitionKey === row.companyId);
+    const parsedId = (0, reportJobIdentity_1.parseReportJobId)(row.jobId);
+    check('jobId', parsedId !== null && row.RowKey === row.jobId);
+    check('reportType', parsedId !== null && row.reportType === parsedId.reportType);
+    check('trigger', row.trigger === 'api' || row.trigger === 'schedule');
+    check('requestedAtUtc', (0, reportingIds_1.isIsoUtcTimestamp)(row.requestedAtUtc));
+    check('requestJson', typeof row.requestJson === 'string' && (0, reportingIds_1.utf8ByteLength)(row.requestJson) <= reportJobSpec_1.REPORT_JOB_SPEC_MAX_BYTES);
+    check('requestSha256', isSha(row.requestSha256));
+    check('fileName', (0, reportingPaths_1.isReportFileName)(row.fileName));
+    // Requesters are identified by user ID, never by e-mail address.
+    check('requestedByUserId', isOptional(row.requestedByUserId, value => isText(128)(value) && !value.includes('@')));
+    check('notificationPolicyId', isOptional(row.notificationPolicyId, reportingIds_1.isReportEntityId));
+    check('coalescedOccurrenceCount', isOptional(row.coalescedOccurrenceCount, value => isCount(value) && value >= 1));
+    if (row.trigger === 'schedule') {
+        check('scheduleId', (0, reportingIds_1.isReportEntityId)(row.scheduleId));
+        check('definitionRevision', isCount(row.definitionRevision) && row.definitionRevision >= 1);
+        check('scheduledForUtc', (0, reportingIds_1.isIsoUtcTimestamp)(row.scheduledForUtc));
+    }
+    else {
+        check('scheduleId', row.scheduleId === undefined);
+        check('definitionRevision', row.definitionRevision === undefined);
+        check('scheduledForUtc', row.scheduledForUtc === undefined);
+        check('coalescedOccurrenceCount', row.coalescedOccurrenceCount === undefined);
+    }
+    const instant = row.trigger === 'schedule' ? row.scheduledForUtc : row.requestedAtUtc;
+    check('jobId', parsedId !== null && typeof instant === 'string' && parsedId.instant.toISOString() === instant);
+    check('status', (0, reportJobStatus_1.isReportJobStatus)(row.status));
+    check('attemptCount', isCount(row.attemptCount));
+    check('notificationStatus', (0, reportJobStatus_1.isReportJobNotificationStatus)(row.notificationStatus));
+    for (const field of ['leaseExpiresAtUtc', 'startedAtUtc', 'lastAttemptAtUtc', 'sourceObservedAtUtc', 'generatedAtUtc', 'completedAtUtc']) {
+        check(field, isOptional(row[field], reportingIds_1.isIsoUtcTimestamp));
+    }
+    check('leaseOwner', isOptional(row.leaseOwner, isText(256)));
+    check('sourceSnapshotSha256', isOptional(row.sourceSnapshotSha256, isSha));
+    check('artifactContentSha256', isOptional(row.artifactContentSha256, isSha));
+    check('artifactBytes', isOptional(row.artifactBytes, value => isCount(value) && value >= 1));
+    check('sourceCoverageSummary', isOptional(row.sourceCoverageSummary, isCoverageSummary));
+    check('failureStage', isOptional(row.failureStage, reportJobStatus_1.isReportJobFailureStage));
+    check('failureCode', isOptional(row.failureCode, reportJobStatus_1.isReportJobFailureCode));
+    check('lastTransientErrorCode', isOptional(row.lastTransientErrorCode, isText(128)));
+    // Cross-field rules: the status milestone and the fields that prove it agree.
+    if (!(0, reportJobStatus_1.isReportJobStatus)(row.status))
+        return;
+    const status = row.status;
+    if (status === 'failed') {
+        check('failureCode', (0, reportJobStatus_1.isReportJobFailureCode)(row.failureCode));
+        check('failureStage', (0, reportJobStatus_1.isReportJobFailureStage)(row.failureStage));
+        if ((0, reportJobStatus_1.isReportJobFailureCode)(row.failureCode) && (0, reportJobStatus_1.isReportJobFailureStage)(row.failureStage)) {
+            const expected = reportJobStatus_1.REPORT_JOB_FAILURE_STAGE_BY_CODE[row.failureCode];
+            check('failureStage', expected === null || expected === row.failureStage);
+        }
+    }
+    else {
+        check('failureCode', row.failureCode === undefined);
+        check('failureStage', row.failureStage === undefined);
+    }
+    if (SNAPSHOT_STATUSES.includes(status)) {
+        check('sourceSnapshotSha256', isSha(row.sourceSnapshotSha256));
+        check('sourceObservedAtUtc', (0, reportingIds_1.isIsoUtcTimestamp)(row.sourceObservedAtUtc));
+    }
+    if (ARTIFACT_STATUSES.includes(status)) {
+        check('artifactContentSha256', isSha(row.artifactContentSha256));
+        check('artifactBytes', isCount(row.artifactBytes) && row.artifactBytes >= 1);
+        check('generatedAtUtc', (0, reportingIds_1.isIsoUtcTimestamp)(row.generatedAtUtc));
+    }
+    if (status === 'completed' || status === 'completed-with-notification-errors')
+        check('completedAtUtc', (0, reportingIds_1.isIsoUtcTimestamp)(row.completedAtUtc));
+    if (status === 'accepted')
+        check('attemptCount', row.attemptCount === 0);
+};
+/**
+ * Validates a stored row and its request. Accepts REST (`PartitionKey`) and `@azure/data-tables` (`partitionKey`)
+ * key casing and ignores Table system properties. Checks keys against the body, the job ID against the trigger's
+ * instant, status against the fields that prove it, the report type and scope hash against the spec, the request's
+ * canonical form and `requestSha256`. Returns the row in REST casing. Never throws.
+ */
+const parseReportJobRowV1 = async (entity) => {
+    try {
+        if (!(0, reportingIds_1.isPlainRecord)(entity))
+            return { ok: false, code: 'request-invalid', errors: ['row: must be an object'] };
+        const normalized = (0, reportTableEntities_1.normalizeReportTableEntity)(entity);
+        if (normalized.schemaVersion !== exports.REPORT_JOB_ROW_SCHEMA_VERSION) {
+            return { ok: false, code: 'unsupported-schema-version', errors: ['schemaVersion: unsupported'] };
+        }
+        const errors = [];
+        validateShape(normalized, errors);
+        if (errors.length > 0)
+            return { ok: false, code: 'request-invalid', errors: Array.from(new Set(errors)) };
+        const row = normalized;
+        if ((await (0, reportingDigest_1.sha256Hex)(row.requestJson)) !== row.requestSha256) {
+            return { ok: false, code: 'request-hash-mismatch', errors: ['requestSha256: does not match requestJson'] };
+        }
+        const spec = (0, reportJobSpec_1.parseReportJobRequestJson)(row.requestJson);
+        if (!spec.ok)
+            return { ok: false, code: 'request-invalid', errors: spec.errors };
+        if (spec.value.reportType !== row.reportType)
+            return { ok: false, code: 'request-invalid', errors: ['reportType: does not match the request'] };
+        const scopeHash = await (0, reportJobIdentity_1.buildReportJobScopeHash)({
+            subscriptionIds: spec.value.scope.subscriptionIds,
+            scheduleId: row.trigger === 'schedule' ? row.scheduleId : undefined,
+        });
+        if ((0, reportJobIdentity_1.parseReportJobId)(row.jobId)?.scopeHash !== scopeHash) {
+            return { ok: false, code: 'request-invalid', errors: ['jobId: scope hash does not match the request'] };
+        }
+        return { ok: true, row, spec: spec.value };
+    }
+    catch {
+        return { ok: false, code: 'request-invalid', errors: ['row: unreadable'] };
+    }
+};
+exports.parseReportJobRowV1 = parseReportJobRowV1;
+/**
+ * Builds the row a producer inserts (status `accepted`, attempt 0, notification `none`), with the job ID derived
+ * from the trigger's instant and the request. The result is validated with `parseReportJobRowV1`; invalid input throws.
+ */
+const buildReportJobRowV1 = async (input) => {
+    const requestJson = (0, reportJobSpec_1.serializeReportJobSpecV1)(input.spec);
+    const spec = (0, reportJobSpec_1.parseReportJobRequestJson)(requestJson);
+    if (!spec.ok)
+        throw new Error(`Invalid report job spec: ${spec.errors.join('; ')}`);
+    const schedule = input.trigger === 'schedule' ? input : undefined;
+    const { jobId } = await (0, reportJobIdentity_1.deriveReportJobIdentity)({
+        instant: schedule ? schedule.scheduledForUtc : input.requestedAtUtc,
+        reportType: spec.value.reportType,
+        subscriptionIds: spec.value.scope.subscriptionIds,
+        scheduleId: schedule?.scheduleId,
+    });
+    const row = {
+        PartitionKey: input.companyId,
+        RowKey: jobId,
+        schemaVersion: 1,
+        jobId,
+        companyId: input.companyId,
+        reportType: spec.value.reportType,
+        trigger: input.trigger,
+        ...(schedule
+            ? {
+                scheduleId: schedule.scheduleId,
+                definitionRevision: schedule.definitionRevision,
+                scheduledForUtc: schedule.scheduledForUtc,
+                ...(schedule.coalescedOccurrenceCount === undefined ? {} : { coalescedOccurrenceCount: schedule.coalescedOccurrenceCount }),
+            }
+            : {}),
+        requestedAtUtc: input.requestedAtUtc,
+        ...(input.requestedByUserId === undefined ? {} : { requestedByUserId: input.requestedByUserId }),
+        requestJson,
+        requestSha256: await (0, reportingDigest_1.sha256Hex)(requestJson),
+        fileName: input.fileName,
+        ...(input.notificationPolicyId === undefined ? {} : { notificationPolicyId: input.notificationPolicyId }),
+        status: 'accepted',
+        attemptCount: 0,
+        notificationStatus: 'none',
+    };
+    const parsed = await (0, exports.parseReportJobRowV1)(row);
+    if (!parsed.ok)
+        throw new Error(`Invalid report job row: ${parsed.errors.join('; ')}`);
+    return row;
+};
+exports.buildReportJobRowV1 = buildReportJobRowV1;
+//# sourceMappingURL=reportJobRow.js.map

package/dist/reporting/jobs/reportJobRow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportJobRow.js","sourceRoot":"","sources":["../../../src/reporting/jobs/reportJobRow.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,+DAA0E;AAC1E,6DAA4D;AAC5D,yDAQgC;AAChC,uEAA2E;AAC3E,2DAAyG;AACzG,mDAMyB;AACzB,uDAU2B;AAEd,QAAA,6BAA6B,GAAG,CAAC,CAAC;AAClC,QAAA,mBAAmB,GAAG,CAAC,KAAK,EAAE,UAAU,CAAU,CAAC;AAEhE,mEAAmE;AACtD,QAAA,qCAAqC,GAAG,CAAC,GAAG,IAAI,CAAC;AAwDjD,QAAA,0BAA0B,GAAG;IACxC,cAAc;IACd,QAAQ;IACR,eAAe;IACf,OAAO;IACP,WAAW;IACX,YAAY;IACZ,SAAS;IACT,YAAY;IACZ,oBAAoB;IACpB,iBAAiB;IACjB,gBAAgB;IAChB,mBAAmB;IACnB,0BAA0B;IAC1B,aAAa;IACb,eAAe;IACf,UAAU;IACV,sBAAsB;CACyC,CAAC;AAErD,QAAA,wBAAwB,GAAG;IACtC,QAAQ;IACR,cAAc;IACd,YAAY;IACZ,mBAAmB;IACnB,cAAc;IACd,kBAAkB;IAClB,qBAAqB;IACrB,sBAAsB;IACtB,uBAAuB;IACvB,gBAAgB;IAChB,uBAAuB;IACvB,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,aAAa;IACb,wBAAwB;CACqC,CAAC;AAEnD,QAAA,8BAA8B,GAAG,CAAC,oBAAoB,CAAqE,CAAC;AAEzI,MAAM,eAAe,GAAG;IACtB,cAAc;IACd,QAAQ;IACR,eAAe;IACf,OAAO;IACP,WAAW;IACX,YAAY;IACZ,SAAS;IACT,gBAAgB;IAChB,aAAa;IACb,eAAe;IACf,UAAU;IACV,QAAQ;IACR,cAAc;IACd,oBAAoB;CACZ,CAAC;AAEX,MAAM,eAAe,GAAsB,CAAC,GAAG,kCAA0B,EAAE,GAAG,gCAAwB,EAAE,GAAG,sCAA8B,CAAC,CAAC,MAAM,CAC/I,KAAK,CAAC,EAAE,CAAC,CAAE,eAAqC,CAAC,QAAQ,CAAC,KAAK,CAAC,CACjE,CAAC;AAEF,kEAAkE;AAClE,MAAM,iBAAiB,GAA+B,CAAC,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,oCAAoC,CAAC,CAAC;AACvI,2DAA2D;AAC3D,MAAM,iBAAiB,GAA+B,CAAC,WAAW,EAAE,WAAW,EAAE,oCAAoC,CAAC,CAAC;AAMvH,MAAM,OAAO,GAAG,CAAC,KAAc,EAAW,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,UAAa,CAAC;AAC1I,MAAM,KAAK,GAAG,CAAC,KAAc,EAAW,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,oCAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACvG,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,IAAA,iCAAkB,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACvF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,KAAkC,EAAW,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAExH,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAW,EAAE;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAA,6BAAc,EAAC,KAAK,CAAC,GAAG,6CAAqC;QAAE,OAAO,KAAK,CAAC;IAC7G,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1C,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,CAAC;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,2FAA2F;AAC3F,MAAM,aAAa,GAAG,CAAC,GAA4B,EAAE,MAAgB,EAAQ,EAAE;IAC7E,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAW,EAAE,EAAE;QAC3C,IAAI,CAAC,EAAE;YAAE,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,WAAW,CAAC,CAAC;IAC5C,CAAC,CAAC;IACF,IAAI,CAAC,IAAA,6BAAc,EAAC,GAAG,EAAE,eAAe,EAAE,eAAe,CAAC,EAAE,CAAC;QAC3D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAE,eAAqC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACxI,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC;QACtE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,uBAAuB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,uBAAuB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnF,CAAC;IACD,KAAK,CAAC,WAAW,EAAE,IAAA,mCAAoB,EAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,YAAY,KAAK,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9F,MAAM,QAAQ,GAAG,IAAA,oCAAgB,EAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7C,KAAK,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9D,KAAK,CAAC,YAAY,EAAE,QAAQ,KAAK,IAAI,IAAI,GAAG,CAAC,UAAU,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjF,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,KAAK,KAAK,IAAI,GAAG,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC;IACtE,KAAK,CAAC,gBAAgB,EAAE,IAAA,gCAAiB,EAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;IAC/D,KAAK,CAAC,aAAa,EAAE,OAAO,GAAG,CAAC,WAAW,KAAK,QAAQ,IAAI,IAAA,6BAAc,EAAC,GAAG,CAAC,WAAW,CAAC,IAAI,yCAAyB,CAAC,CAAC;IAC1H,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;IACjD,KAAK,CAAC,UAAU,EAAE,IAAA,iCAAgB,EAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClD,iEAAiE;IACjE,KAAK,CACH,mBAAmB,EACnB,UAAU,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAE,KAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CACnG,CAAC;IACF,KAAK,CAAC,sBAAsB,EAAE,UAAU,CAAC,GAAG,CAAC,oBAAoB,EAAE,+BAAgB,CAAC,CAAC,CAAC;IACtF,KAAK,CACH,0BAA0B,EAC1B,UAAU,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAK,KAAgB,IAAI,CAAC,CAAC,CAC5F,CAAC;IACF,IAAI,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QAC/B,KAAK,CAAC,YAAY,EAAE,IAAA,+BAAgB,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,oBAAoB,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAK,GAAG,CAAC,kBAA6B,IAAI,CAAC,CAAC,CAAC;QACxG,KAAK,CAAC,iBAAiB,EAAE,IAAA,gCAAiB,EAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,YAAY,EAAE,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC;QAClD,KAAK,CAAC,oBAAoB,EAAE,GAAG,CAAC,kBAAkB,KAAK,SAAS,CAAC,CAAC;QAClE,KAAK,CAAC,iBAAiB,EAAE,GAAG,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC;QAC5D,KAAK,CAAC,0BAA0B,EAAE,GAAG,CAAC,wBAAwB,KAAK,SAAS,CAAC,CAAC;IAChF,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC;IACtF,KAAK,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,CAAC;IAC/G,KAAK,CAAC,QAAQ,EAAE,IAAA,mCAAiB,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IACjD,KAAK,CAAC,oBAAoB,EAAE,IAAA,+CAA6B,EAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACnF,KAAK,MAAM,KAAK,IAAI,CAAC,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,gBAAgB,CAAU,EAAE,CAAC;QAClJ,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,gCAAiB,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7D,KAAK,CAAC,sBAAsB,EAAE,UAAU,CAAC,GAAG,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC,CAAC;IAC3E,KAAK,CAAC,uBAAuB,EAAE,UAAU,CAAC,GAAG,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC,CAAC;IAC7E,KAAK,CACH,eAAe,EACf,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAK,KAAgB,IAAI,CAAC,CAAC,CACjF,CAAC;IACF,KAAK,CAAC,uBAAuB,EAAE,UAAU,CAAC,GAAG,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACzF,KAAK,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,yCAAuB,CAAC,CAAC,CAAC;IAC7E,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,wCAAsB,CAAC,CAAC,CAAC;IAC1E,KAAK,CAAC,wBAAwB,EAAE,UAAU,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAErF,8EAA8E;IAC9E,IAAI,CAAC,IAAA,mCAAiB,EAAC,GAAG,CAAC,MAAM,CAAC;QAAE,OAAO;IAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAC1B,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,KAAK,CAAC,aAAa,EAAE,IAAA,wCAAsB,EAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9D,KAAK,CAAC,cAAc,EAAE,IAAA,yCAAuB,EAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QACjE,IAAI,IAAA,wCAAsB,EAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAA,yCAAuB,EAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACzF,MAAM,QAAQ,GAAG,kDAAgC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YACnE,KAAK,CAAC,cAAc,EAAE,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,GAAG,CAAC,YAAY,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC;QACpD,KAAK,CAAC,cAAc,EAAE,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,KAAK,CAAC,sBAAsB,EAAE,KAAK,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC/D,KAAK,CAAC,qBAAqB,EAAE,IAAA,gCAAiB,EAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAK,GAAG,CAAC,aAAwB,IAAI,CAAC,CAAC,CAAC;QACzF,KAAK,CAAC,gBAAgB,EAAE,IAAA,gCAAiB,EAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,MAAM,KAAK,WAAW,IAAI,MAAM,KAAK,oCAAoC;QAAE,KAAK,CAAC,gBAAgB,EAAE,IAAA,gCAAiB,EAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9I,IAAI,MAAM,KAAK,UAAU;QAAE,KAAK,CAAC,cAAc,EAAE,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC;AAC3E,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,KAAK,EAAE,MAAe,EAAoC,EAAE;IAC7F,IAAI,CAAC;QACH,IAAI,CAAC,IAAA,4BAAa,EAAC,MAAM,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAC9G,MAAM,UAAU,GAAG,IAAA,gDAA0B,EAAC,MAAM,CAAC,CAAC;QACtD,IAAI,UAAU,CAAC,aAAa,KAAK,qCAA6B,EAAE,CAAC;YAC/D,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,4BAA4B,EAAE,MAAM,EAAE,CAAC,4BAA4B,CAAC,EAAE,CAAC;QACnG,CAAC;QACD,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAClC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAC1G,MAAM,GAAG,GAAG,UAAuC,CAAC;QACpD,IAAI,CAAC,MAAM,IAAA,2BAAS,EAAC,GAAG,CAAC,WAAW,CAAC,CAAC,KAAK,GAAG,CAAC,aAAa,EAAE,CAAC;YAC7D,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,uBAAuB,EAAE,MAAM,EAAE,CAAC,2CAA2C,CAAC,EAAE,CAAC;QAC7G,CAAC;QACD,MAAM,IAAI,GAAG,IAAA,yCAAyB,EAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,CAAC,EAAE;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QACjF,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,wCAAwC,CAAC,EAAE,CAAC;QAChJ,MAAM,SAAS,GAAG,MAAM,IAAA,2CAAuB,EAAC;YAC9C,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe;YACjD,UAAU,EAAE,GAAG,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;SACpE,CAAC,CAAC;QACH,IAAI,IAAA,oCAAgB,EAAC,GAAG,CAAC,KAAK,CAAC,EAAE,SAAS,KAAK,SAAS,EAAE,CAAC;YACzD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,8CAA8C,CAAC,EAAE,CAAC;QAC1G,CAAC;QACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC;IAC7E,CAAC;AACH,CAAC,CAAC;AA5BW,QAAA,mBAAmB,uBA4B9B;AAcF;;;GAGG;AACI,MAAM,mBAAmB,GAAG,KAAK,EAAE,KAA6B,EAA2B,EAAE;IAClG,MAAM,WAAW,GAAG,IAAA,wCAAwB,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,IAAA,yCAAyB,EAAC,WAAW,CAAC,CAAC;IACpD,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpF,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAClE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAA,2CAAuB,EAAC;QAC9C,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc;QACnE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU;QACjC,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe;QACjD,UAAU,EAAE,QAAQ,EAAE,UAAU;KACjC,CAAC,CAAC;IACH,MAAM,GAAG,GAAmB;QAC1B,YAAY,EAAE,KAAK,CAAC,SAAS;QAC7B,MAAM,EAAE,KAAK;QACb,aAAa,EAAE,CAAC;QAChB,KAAK;QACL,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU;QACjC,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,GAAG,CAAC,QAAQ;YACV,CAAC,CAAC;gBACE,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB;gBAC/C,eAAe,EAAE,QAAQ,CAAC,eAAe;gBACzC,GAAG,CAAC,QAAQ,CAAC,wBAAwB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,wBAAwB,EAAE,QAAQ,CAAC,wBAAwB,EAAE,CAAC;aAC5H;YACH,CAAC,CAAC,EAAE,CAAC;QACP,cAAc,EAAE,KAAK,CAAC,cAAc;QACpC,GAAG,CAAC,KAAK,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAChG,WAAW;QACX,aAAa,EAAE,MAAM,IAAA,2BAAS,EAAC,WAAW,CAAC;QAC3C,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,GAAG,CAAC,KAAK,CAAC,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,EAAE,CAAC;QACzG,MAAM,EAAE,UAAU;QAClB,YAAY,EAAE,CAAC;QACf,kBAAkB,EAAE,MAAM;KAC3B,CAAC;IACF,MAAM,MAAM,GAAG,MAAM,IAAA,2BAAmB,EAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvF,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAxCW,QAAA,mBAAmB,uBAwC9B"}

package/dist/reporting/jobs/reportJobSpec.d.ts

@@ -0,0 +1,92 @@
+export declare const REPORT_JOB_SPEC_SCHEMA_VERSION = 1;
+export declare const REPORT_JOB_REPORT_TYPES: readonly ["sdm", "architecture-assessment"];
+export type ReportJobReportType = (typeof REPORT_JOB_REPORT_TYPES)[number];
+export declare const REPORT_JOB_MAX_SUBSCRIPTIONS = 200;
+export declare const REPORT_JOB_MAX_CLOUD_ACCOUNTS = 20;
+export declare const REPORT_JOB_MAX_SERVICE_IDS = 20;
+export declare const REPORT_JOB_MAX_EXPLICIT_PERIOD_DAYS = 366;
+/** Maximum UTF-8 size of the canonical `requestJson`. */
+export declare const REPORT_JOB_SPEC_MAX_BYTES: number;
+export interface ReportJobScopeV1 {
+    /** 1..20 company-owned cloud account IDs, sorted. */
+    cloudAccountIds: string[];
+    /** 1..200 subscription GUIDs, lower-cased and sorted. */
+    subscriptionIds: string[];
+}
+export type ReportPeriodRuleV1 = {
+    kind: 'previous-calendar-month';
+} | {
+    kind: 'previous-calendar-quarter';
+};
+/** Explicit dates (API requests only). `YYYY-MM-DD`, start <= end, at most 366 days inclusive. */
+export interface ReportExplicitPeriodV1 {
+    kind: 'explicit';
+    startDate: string;
+    endDate: string;
+}
+export type ReportJobPeriodV1 = ReportPeriodRuleV1 | ReportExplicitPeriodV1;
+export declare const SDM_BACKGROUND_LAYOUTS: readonly ["spotto-layout", "monthly-insights"];
+export type SdmBackgroundLayout = (typeof SDM_BACKGROUND_LAYOUTS)[number];
+export declare const SDM_BACKGROUND_DETAIL_ROW_LIMITS: readonly [10, 25, 50, "all"];
+export type SdmBackgroundDetailRowLimit = (typeof SDM_BACKGROUND_DETAIL_ROW_LIMITS)[number];
+export interface SdmBackgroundConfigV1 {
+    /** Company Word templates are not supported in background runs. */
+    layout: SdmBackgroundLayout;
+    cloudIqServiceProfile: {
+        /** Service catalogue IDs, validated against the catalogue by reportworker. Order is kept. */
+        selectedServiceIds: string[];
+        detailRowLimit?: SdmBackgroundDetailRowLimit;
+    };
+}
+export declare const CURRENT_STATE_AUDIENCES: readonly ["customer", "internal"];
+export type CurrentStateBackgroundAudience = (typeof CURRENT_STATE_AUDIENCES)[number];
+export declare const CURRENT_STATE_SECTION_KEYS: readonly ["costOpportunities", "securityPosture", "reliabilityAvailability", "quickWins", "roadmap"];
+export type CurrentStateBackgroundSections = Record<(typeof CURRENT_STATE_SECTION_KEYS)[number], boolean>;
+export interface CurrentStateBackgroundConfigV1 {
+    audience: CurrentStateBackgroundAudience;
+    sections: CurrentStateBackgroundSections;
+    /** ISO 4217, upper case. */
+    scopeCurrencyCode: string;
+    /** 1..120 characters of plain text. Default: "<provider name> pre-sales team". */
+    preparedBy?: string;
+}
+export interface SdmReportJobSpecV1 {
+    schemaVersion: 1;
+    reportType: 'sdm';
+    scope: ReportJobScopeV1;
+    period: ReportJobPeriodV1;
+    configuration: SdmBackgroundConfigV1;
+}
+export interface CurrentStateReportJobSpecV1 {
+    schemaVersion: 1;
+    reportType: 'architecture-assessment';
+    scope: ReportJobScopeV1;
+    configuration: CurrentStateBackgroundConfigV1;
+}
+export type ReportJobSpecV1 = SdmReportJobSpecV1 | CurrentStateReportJobSpecV1;
+export type ReportJobSpecParseResult = {
+    ok: true;
+    value: ReportJobSpecV1;
+} | {
+    ok: false;
+    errors: string[];
+};
+export declare const isReportJobReportType: (value: unknown) => value is ReportJobReportType;
+/**
+ * Lower-cases, de-duplicates and sorts subscription IDs. Lower case is Spotto's canonical subscription ID form: the
+ * request and the scope hash use it, and so do the storage keys and paths reportworker builds from it.
+ */
+export declare const normalizeReportSubscriptionIds: (subscriptionIds: readonly string[]) => string[];
+/** Strict, normalising parser. Never throws (hostile getters are reported as an invalid spec). */
+export declare const parseReportJobSpecV1: (input: unknown) => ReportJobSpecParseResult;
+/**
+ * The canonical `requestJson`: validated, normalised, fixed key order. Producers store exactly this string, and
+ * `requestSha256` is the SHA-256 of its UTF-8 bytes. Throws on an invalid spec or one above 32 KiB.
+ */
+export declare const serializeReportJobSpecV1: (spec: unknown) => string;
+/**
+ * Parses stored `requestJson`. It must be valid JSON, a valid spec and already canonical (byte-equal to
+ * `serializeReportJobSpecV1` of itself), so a hash over the stored string identifies the request exactly.
+ */
+export declare const parseReportJobRequestJson: (requestJson: unknown) => ReportJobSpecParseResult;
+//# sourceMappingURL=reportJobSpec.d.ts.map

package/dist/reporting/jobs/reportJobSpec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reportJobSpec.d.ts","sourceRoot":"","sources":["../../../src/reporting/jobs/reportJobSpec.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,8BAA8B,IAAI,CAAC;AAChD,eAAO,MAAM,uBAAuB,6CAA8C,CAAC;AACnF,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3E,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAChD,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAC7C,eAAO,MAAM,mCAAmC,MAAM,CAAC;AACvD,yDAAyD;AACzD,eAAO,MAAM,yBAAyB,QAAY,CAAC;AAEnD,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,yDAAyD;IACzD,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,MAAM,kBAAkB,GAAG;IAAE,IAAI,EAAE,yBAAyB,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,2BAA2B,CAAA;CAAE,CAAC;AAE7G,kGAAkG;AAClG,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,UAAU,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;AAE5E,eAAO,MAAM,sBAAsB,gDAAiD,CAAC;AACrF,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,eAAO,MAAM,gCAAgC,8BAA+B,CAAC;AAC7E,MAAM,MAAM,2BAA2B,GAAG,CAAC,OAAO,gCAAgC,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5F,MAAM,WAAW,qBAAqB;IACpC,mEAAmE;IACnE,MAAM,EAAE,mBAAmB,CAAC;IAC5B,qBAAqB,EAAE;QACrB,6FAA6F;QAC7F,kBAAkB,EAAE,MAAM,EAAE,CAAC;QAC7B,cAAc,CAAC,EAAE,2BAA2B,CAAC;KAC9C,CAAC;CACH;AAED,eAAO,MAAM,uBAAuB,mCAAoC,CAAC;AACzE,MAAM,MAAM,8BAA8B,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtF,eAAO,MAAM,0BAA0B,sGAAuG,CAAC;AAC/I,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;AAE1G,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,8BAA8B,CAAC;IACzC,QAAQ,EAAE,8BAA8B,CAAC;IACzC,4BAA4B;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kFAAkF;IAClF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,CAAC,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;IAClB,KAAK,EAAE,gBAAgB,CAAC;IACxB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,aAAa,EAAE,qBAAqB,CAAC;CACtC;AAED,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,CAAC,CAAC;IACjB,UAAU,EAAE,yBAAyB,CAAC;IACtC,KAAK,EAAE,gBAAgB,CAAC;IACxB,aAAa,EAAE,8BAA8B,CAAC;CAC/C;AAED,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAAG,2BAA2B,CAAC;AAE/E,MAAM,MAAM,wBAAwB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAM9G,eAAO,MAAM,qBAAqB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,mBAC6B,CAAC;AAE9F;;;GAGG;AACH,eAAO,MAAM,8BAA8B,GAAI,iBAAiB,SAAS,MAAM,EAAE,KAAG,MAAM,EACV,CAAC;AAuLjF,kGAAkG;AAClG,eAAO,MAAM,oBAAoB,GAAI,OAAO,OAAO,KAAG,wBAMrD,CAAC;AA4CF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GAAI,MAAM,OAAO,KAAG,MAMxD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,GAAI,aAAa,OAAO,KAAG,wBAahE,CAAC"}