@carbonbox/domain 0.52.0 → 0.54.0

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/exceptions/InvalidAuditedCarbonFootprintConfigurationsError.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidAuditedCarbonFootprintConfigurationsError = void 0;
+const CodedRootError_1 = require("../../../../shared/domain/exceptions/CodedRootError");
+const ErrorCode_1 = require("../../../../shared/domain/enums/ErrorCode");
+/**
+ * The audited carbon footprint configurations of an engagement are empty or repeated (D2, D10:
+ * an explicit list with at least one footprint).
+ */
+class InvalidAuditedCarbonFootprintConfigurationsError extends CodedRootError_1.CodedRootError {
+    constructor(reason) {
+        const technicalMessage = `Invalid audited carbon footprint configurations: ${reason}`;
+        const context = {
+            reason,
+            timestamp: new Date().toISOString(),
+        };
+        const suggestions = [
+            'Select at least one carbon footprint configuration to audit',
+            'Do not repeat a carbon footprint configuration',
+        ];
+        super(ErrorCode_1.ErrorCode.INVALID_AUDITED_CARBON_FOOTPRINT_CONFIGURATIONS, technicalMessage, context, suggestions);
+        this.name = 'InvalidAuditedCarbonFootprintConfigurationsError';
+    }
+    static create(reason) {
+        return new InvalidAuditedCarbonFootprintConfigurationsError(reason);
+    }
+    logError() {
+        return `${this.name}: ${this.technicalMessage}`;
+    }
+}
+exports.InvalidAuditedCarbonFootprintConfigurationsError = InvalidAuditedCarbonFootprintConfigurationsError;

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/policies/AuditEngagementAccessPolicy.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementAccessPolicy = void 0;
+const AuditEngagementEvaluatedAt_1 = require("../value-objects/AuditEngagementEvaluatedAt");
+const AuditEngagementNotActiveError_1 = require("../exceptions/AuditEngagementNotActiveError");
+/**
+ * Pure domain policy: whether an audit engagement grants the auditor access to the audited
+ * footprints at a given moment (AUD-D05, §5.1 of the auditor plan). Single source of truth for
+ * the data scope of the auditor and for every auditor write (findings, verification statement).
+ *
+ * Rule: status ACTIVE **and** the moment within `[validFrom, validTo]` (both ends included; `validTo`
+ * is the end of the last contract day, D15). Checking the dates on every read protects the carbon
+ * client even if the contract synchronization worker falls behind.
+ */
+class AuditEngagementAccessPolicy {
+    constructor() {
+        // Static-only — not instantiable.
+    }
+    /**
+     * Whether the engagement grants access at `now` (`DD/MM/YYYY HH:mm:ss`).
+     */
+    static grantsAccessAt(engagement, now) {
+        const evaluatedAt = AuditEngagementEvaluatedAt_1.AuditEngagementEvaluatedAt.create(now);
+        return engagement.status.isActive()
+            && engagement.validFrom.isReachedAt(evaluatedAt)
+            && engagement.validTo.isPassedAt(evaluatedAt) === false;
+    }
+    /**
+     * Throws `AuditEngagementNotActiveError` when the engagement does not grant access at `now`.
+     */
+    static assertGrantsAccessAt(engagement, now) {
+        if (AuditEngagementAccessPolicy.grantsAccessAt(engagement, now) === false) {
+            throw AuditEngagementNotActiveError_1.AuditEngagementNotActiveError.create(engagement.id.toPrimitives(), engagement.validTo.toPrimitives());
+        }
+    }
+}
+exports.AuditEngagementAccessPolicy = AuditEngagementAccessPolicy;

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/repository/IAuditEngagementRepository.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/types/AuditEngagementAssignProps.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/types/AuditEngagementIndependenceDeclarationPrimitives.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/types/AuditEngagementPrimitives.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/types/AuditEngagementProps.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/types/AuditEngagementStatusChangePrimitives.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementAuditedCarbonFootprintConfigurations.js

@@ -0,0 +1,77 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AuditEngagementAuditedCarbonFootprintConfigurations_instances, _AuditEngagementAuditedCarbonFootprintConfigurations_items, _AuditEngagementAuditedCarbonFootprintConfigurations_guardAgainstRepeatedIds;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementAuditedCarbonFootprintConfigurations = void 0;
+const ValueObject_1 = require("../../../../shared/domain/value-objects/ValueObject");
+const InvalidAuditedCarbonFootprintConfigurationsError_1 = require("../exceptions/InvalidAuditedCarbonFootprintConfigurationsError");
+const AuditedCarbonFootprintConfiguration_1 = require("./AuditedCarbonFootprintConfiguration");
+/**
+ * Carbon footprint configurations audited by an engagement (D2, D10): an explicit list the carbon
+ * client chose, with at least one footprint and no repeated ids. A footprint created later does not
+ * join on its own. That every footprint belongs to the audited carbon client is checked by the
+ * application (the references carry no owner).
+ */
+class AuditEngagementAuditedCarbonFootprintConfigurations extends ValueObject_1.ValueObject {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementAuditedCarbonFootprintConfigurations.PROPERTY_NAME, 'CarbonFootprintConfigurationReferencePrimitives[]');
+        _AuditEngagementAuditedCarbonFootprintConfigurations_instances.add(this);
+        _AuditEngagementAuditedCarbonFootprintConfigurations_items.set(this, void 0);
+        if (skipDomainValidation === false) {
+            AuditEngagementAuditedCarbonFootprintConfigurations.guardAgainstInvalidList(value);
+            __classPrivateFieldSet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_items, value.map((item) => AuditedCarbonFootprintConfiguration_1.AuditedCarbonFootprintConfiguration.create(item)), "f");
+            __classPrivateFieldGet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_instances, "m", _AuditEngagementAuditedCarbonFootprintConfigurations_guardAgainstRepeatedIds).call(this);
+        }
+        else {
+            __classPrivateFieldSet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_items, value.map((item) => AuditedCarbonFootprintConfiguration_1.AuditedCarbonFootprintConfiguration.fromPrimitives(item)), "f");
+        }
+    }
+    static create(value) {
+        return new AuditEngagementAuditedCarbonFootprintConfigurations(value, false);
+    }
+    static fromPrimitives(primitives) {
+        const value = primitives.map((primitive) => ({
+            id: primitive.id,
+            footprintType: primitive.footprintType,
+        }));
+        return new AuditEngagementAuditedCarbonFootprintConfigurations(value, true);
+    }
+    static guardAgainstInvalidList(value) {
+        if (Array.isArray(value) === false) {
+            throw InvalidAuditedCarbonFootprintConfigurationsError_1.InvalidAuditedCarbonFootprintConfigurationsError.create('a list of carbon footprint configurations is required');
+        }
+        if (value.length === 0) {
+            throw InvalidAuditedCarbonFootprintConfigurationsError_1.InvalidAuditedCarbonFootprintConfigurationsError.create('at least one carbon footprint configuration is required');
+        }
+    }
+    get items() {
+        return __classPrivateFieldGet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_items, "f");
+    }
+    includes(carbonFootprintConfigurationId) {
+        return __classPrivateFieldGet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_items, "f").some((item) => item.hasId(carbonFootprintConfigurationId));
+    }
+    ids() {
+        return __classPrivateFieldGet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_items, "f").map((item) => item.id);
+    }
+    toPrimitives() {
+        return __classPrivateFieldGet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_items, "f").map((item) => item.toPrimitives());
+    }
+}
+exports.AuditEngagementAuditedCarbonFootprintConfigurations = AuditEngagementAuditedCarbonFootprintConfigurations;
+_AuditEngagementAuditedCarbonFootprintConfigurations_items = new WeakMap(), _AuditEngagementAuditedCarbonFootprintConfigurations_instances = new WeakSet(), _AuditEngagementAuditedCarbonFootprintConfigurations_guardAgainstRepeatedIds = function _AuditEngagementAuditedCarbonFootprintConfigurations_guardAgainstRepeatedIds() {
+    const ids = __classPrivateFieldGet(this, _AuditEngagementAuditedCarbonFootprintConfigurations_items, "f").map((item) => item.id);
+    if (new Set(ids).size !== ids.length) {
+        throw InvalidAuditedCarbonFootprintConfigurationsError_1.InvalidAuditedCarbonFootprintConfigurationsError.create('a carbon footprint configuration is repeated');
+    }
+};
+AuditEngagementAuditedCarbonFootprintConfigurations.PROPERTY_NAME = 'auditedCarbonFootprintConfigurations';

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementCarbonAuditorId.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementCarbonAuditorId = void 0;
+const UserId_1 = require("../../../../shared/domain/value-objects/UserId");
+const SemanticUuidPrefix_1 = require("../../../../shared/domain/enums/SemanticUuidPrefix");
+const InvalidUserPrefixError_1 = require("../../../../shared/domain/exceptions/InvalidUserPrefixError");
+/**
+ * Id of the carbon auditor of an audit engagement (`USR-STH-AUD_<id>`).
+ */
+class AuditEngagementCarbonAuditorId extends UserId_1.UserId {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation);
+    }
+    static create(value) {
+        UserId_1.UserId.guardAgainstEmptyValue(value, AuditEngagementCarbonAuditorId.CARBON_AUDITOR_ID_PROPERTY_NAME);
+        UserId_1.UserId.guardAgainstInvalidType(value, AuditEngagementCarbonAuditorId.CARBON_AUDITOR_ID_PROPERTY_NAME);
+        UserId_1.UserId.guardAgainstInvalidId(value, AuditEngagementCarbonAuditorId.CARBON_AUDITOR_ID_PROPERTY_NAME);
+        // Validate that the prefix belongs to a carbon auditor
+        AuditEngagementCarbonAuditorId.guardAgainstInvalidCarbonAuditorPrefix(value);
+        return new AuditEngagementCarbonAuditorId(value, false);
+    }
+    /**
+     * Validates that the id has the carbon auditor prefix.
+     * The id format was already validated, so the prefix can be extracted safely.
+     */
+    static guardAgainstInvalidCarbonAuditorPrefix(value) {
+        const prefix = new AuditEngagementCarbonAuditorId(value, true).extractPrefix();
+        if (AuditEngagementCarbonAuditorId.VALID_PREFIXES.includes(prefix) === false) {
+            throw InvalidUserPrefixError_1.InvalidUserPrefixError.create(value, prefix, AuditEngagementCarbonAuditorId.VALID_PREFIXES);
+        }
+    }
+    static fromPrimitives(primitive) {
+        const value = primitive;
+        return new AuditEngagementCarbonAuditorId(value, true);
+    }
+    toPrimitives() {
+        return this.value;
+    }
+}
+exports.AuditEngagementCarbonAuditorId = AuditEngagementCarbonAuditorId;
+AuditEngagementCarbonAuditorId.CARBON_AUDITOR_ID_PROPERTY_NAME = 'carbonAuditorId';
+AuditEngagementCarbonAuditorId.VALID_PREFIXES = [
+    SemanticUuidPrefix_1.SemanticUuidPrefix.USR_STH_AUDITOR,
+];

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementEvaluatedAt.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementEvaluatedAt = void 0;
+const DateTimeString_1 = require("../../../../shared/domain/value-objects/DateTimeString");
+/**
+ * The moment at which an audit engagement is evaluated (a transition, or an access check).
+ * The domain does not read the clock: the caller passes the current moment and this value
+ * object validates its format.
+ */
+class AuditEngagementEvaluatedAt extends DateTimeString_1.DateTimeString {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementEvaluatedAt.PROPERTY_NAME);
+    }
+    static create(value) {
+        DateTimeString_1.DateTimeString.guardAgainstEmptyValue(value, AuditEngagementEvaluatedAt.PROPERTY_NAME);
+        DateTimeString_1.DateTimeString.guardAgainstInvalidType(value, AuditEngagementEvaluatedAt.PROPERTY_NAME);
+        DateTimeString_1.DateTimeString.guardAgainstInvalidDateTimeFormat(value);
+        return new AuditEngagementEvaluatedAt(value, false);
+    }
+    static fromPrimitives(primitive) {
+        const value = primitive;
+        return new AuditEngagementEvaluatedAt(value, true);
+    }
+    toPrimitives() {
+        return this.value;
+    }
+}
+exports.AuditEngagementEvaluatedAt = AuditEngagementEvaluatedAt;
+AuditEngagementEvaluatedAt.PROPERTY_NAME = 'now';

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementId.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementId = void 0;
+const AggregateId_1 = require("../../../../shared/domain/value-objects/AggregateId");
+const SemanticUuidPrefix_1 = require("../../../../shared/domain/enums/SemanticUuidPrefix");
+const InvalidAggregatePrefixError_1 = require("../../../../shared/domain/exceptions/InvalidAggregatePrefixError");
+/**
+ * Identity of an AuditEngagement aggregate (`CFA-ENG_<id>`).
+ */
+class AuditEngagementId extends AggregateId_1.AggregateId {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementId.PROPERTY_NAME);
+    }
+    static create(value) {
+        AggregateId_1.AggregateId.guardAgainstEmptyValue(value, AuditEngagementId.PROPERTY_NAME);
+        AggregateId_1.AggregateId.guardAgainstInvalidType(value, AuditEngagementId.PROPERTY_NAME);
+        AggregateId_1.AggregateId.guardAgainstInvalidId(value, AuditEngagementId.PROPERTY_NAME);
+        // Validate that the prefix is valid for AuditEngagement
+        AuditEngagementId.guardAgainstInvalidPrefix(value);
+        return new AuditEngagementId(value, false);
+    }
+    /**
+     * Validates that the id has the AuditEngagement prefix.
+     * The id format was already validated, so the prefix can be extracted safely.
+     */
+    static guardAgainstInvalidPrefix(value) {
+        const prefix = new AuditEngagementId(value, true).extractPrefix();
+        if (AuditEngagementId.VALID_PREFIXES.includes(prefix) === false) {
+            throw InvalidAggregatePrefixError_1.InvalidAggregatePrefixError.create(value, 'AuditEngagement', prefix, AuditEngagementId.VALID_PREFIXES, AuditEngagementId.PROPERTY_NAME);
+        }
+    }
+    static fromPrimitives(primitive) {
+        const value = primitive;
+        return new AuditEngagementId(value, true);
+    }
+    toPrimitives() {
+        return this.value;
+    }
+}
+exports.AuditEngagementId = AuditEngagementId;
+AuditEngagementId.PROPERTY_NAME = 'id';
+AuditEngagementId.VALID_PREFIXES = [
+    SemanticUuidPrefix_1.SemanticUuidPrefix.CFA_AUDIT_ENGAGEMENT,
+];

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementIndependenceDeclaration.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementIndependenceDeclaration = void 0;
+const ValueObject_1 = require("../../../../shared/domain/value-objects/ValueObject");
+const InvalidPropertyValueError_1 = require("../../../../shared/domain/exceptions/InvalidPropertyValueError");
+const AuditEngagementEvaluatedAt_1 = require("./AuditEngagementEvaluatedAt");
+/**
+ * Independence and no conflict of interest declaration the auditor signs when accepting the
+ * engagement (D9), or null while the engagement was not accepted.
+ *
+ * Invariants: the declaration version is a non-empty text up to 50 characters and the acceptance
+ * moment is a valid datetime.
+ */
+class AuditEngagementIndependenceDeclaration extends ValueObject_1.ValueObject {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementIndependenceDeclaration.PROPERTY_NAME, 'AuditEngagementIndependenceDeclarationPrimitives or null', { allowNull: true, allowUndefined: false });
+        if (skipDomainValidation === false && value !== null) {
+            AuditEngagementIndependenceDeclaration.guardAgainstInvalidDeclarationVersion(value.declarationVersion);
+            AuditEngagementEvaluatedAt_1.AuditEngagementEvaluatedAt.create(value.acceptedAt);
+        }
+    }
+    static create(value) {
+        return new AuditEngagementIndependenceDeclaration(value, false);
+    }
+    static fromPrimitives(primitives) {
+        const value = primitives === null
+            ? null
+            : { declarationVersion: primitives.declarationVersion, acceptedAt: primitives.acceptedAt };
+        return new AuditEngagementIndependenceDeclaration(value, true);
+    }
+    static guardAgainstInvalidDeclarationVersion(declarationVersion) {
+        if (typeof declarationVersion !== 'string' || declarationVersion.trim() === '') {
+            throw InvalidPropertyValueError_1.InvalidPropertyValueError.create('declarationVersion', 'a non-empty text', String(declarationVersion));
+        }
+        if (declarationVersion.trim().length > AuditEngagementIndependenceDeclaration.DECLARATION_VERSION_MAX_LENGTH) {
+            throw InvalidPropertyValueError_1.InvalidPropertyValueError.create('declarationVersion', `up to ${AuditEngagementIndependenceDeclaration.DECLARATION_VERSION_MAX_LENGTH} characters`, `${declarationVersion.trim().length} characters`);
+        }
+    }
+    hasValue() {
+        return this.value !== null;
+    }
+    toPrimitives() {
+        return this.value === null
+            ? null
+            : { declarationVersion: this.value.declarationVersion.trim(), acceptedAt: this.value.acceptedAt };
+    }
+}
+exports.AuditEngagementIndependenceDeclaration = AuditEngagementIndependenceDeclaration;
+AuditEngagementIndependenceDeclaration.PROPERTY_NAME = 'independenceDeclaration';
+AuditEngagementIndependenceDeclaration.DECLARATION_VERSION_MAX_LENGTH = 50;

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementReplacesAuditEngagementId.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementReplacesAuditEngagementId = void 0;
+const ValueObject_1 = require("../../../../shared/domain/value-objects/ValueObject");
+const AuditEngagementId_1 = require("./AuditEngagementId");
+/**
+ * Engagement replaced by this one when the carbon client changed the auditor (D5), or null for a
+ * first assignment. A non-null value is validated as an AuditEngagement id (`CFA-ENG_<id>`).
+ */
+class AuditEngagementReplacesAuditEngagementId extends ValueObject_1.ValueObject {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementReplacesAuditEngagementId.PROPERTY_NAME, 'AuditEngagement id or null', { allowNull: true, allowUndefined: false });
+        if (skipDomainValidation === false && value !== null) {
+            AuditEngagementId_1.AuditEngagementId.create(value);
+        }
+    }
+    static create(value) {
+        return new AuditEngagementReplacesAuditEngagementId(value, false);
+    }
+    static fromPrimitives(primitive) {
+        const value = primitive;
+        return new AuditEngagementReplacesAuditEngagementId(value, true);
+    }
+    hasValue() {
+        return this.value !== null;
+    }
+    toPrimitives() {
+        return this.value;
+    }
+}
+exports.AuditEngagementReplacesAuditEngagementId = AuditEngagementReplacesAuditEngagementId;
+AuditEngagementReplacesAuditEngagementId.PROPERTY_NAME = 'replacesAuditEngagementId';

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementServiceCode.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementServiceCode = void 0;
+const String_1 = require("../../../../shared/domain/value-objects/String");
+/**
+ * Code of the purchase contract service that grants an audit engagement
+ * (today `AUDITOR_ACCESS_SERVICE_CODE`; which code is allowed is checked when assigning).
+ */
+class AuditEngagementServiceCode extends String_1.String {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementServiceCode.PROPERTY_NAME);
+    }
+    static create(value) {
+        String_1.String.guardAgainstEmptyValue(value, AuditEngagementServiceCode.PROPERTY_NAME);
+        String_1.String.guardAgainstInvalidType(value, AuditEngagementServiceCode.PROPERTY_NAME);
+        return new AuditEngagementServiceCode(value, false);
+    }
+    static fromPrimitives(primitive) {
+        const value = primitive;
+        return new AuditEngagementServiceCode(value, true);
+    }
+    toPrimitives() {
+        return this.value;
+    }
+}
+exports.AuditEngagementServiceCode = AuditEngagementServiceCode;
+AuditEngagementServiceCode.PROPERTY_NAME = 'serviceCode';

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementSourcePurchaseContractId.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementSourcePurchaseContractId = void 0;
+const AggregateId_1 = require("../../../../shared/domain/value-objects/AggregateId");
+const SemanticUuidPrefix_1 = require("../../../../shared/domain/enums/SemanticUuidPrefix");
+const InvalidAggregatePrefixError_1 = require("../../../../shared/domain/exceptions/InvalidAggregatePrefixError");
+/**
+ * Purchase contract that sells the auditor service of an audit engagement (`PMS-PC_<id>`).
+ * The engagement validity follows this contract (renewed, suspended, cancelled, expired).
+ */
+class AuditEngagementSourcePurchaseContractId extends AggregateId_1.AggregateId {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementSourcePurchaseContractId.PROPERTY_NAME);
+    }
+    static create(value) {
+        AggregateId_1.AggregateId.guardAgainstEmptyValue(value, AuditEngagementSourcePurchaseContractId.PROPERTY_NAME);
+        AggregateId_1.AggregateId.guardAgainstInvalidType(value, AuditEngagementSourcePurchaseContractId.PROPERTY_NAME);
+        AggregateId_1.AggregateId.guardAgainstInvalidId(value, AuditEngagementSourcePurchaseContractId.PROPERTY_NAME);
+        // Validate that the prefix is valid for PurchaseContract
+        AuditEngagementSourcePurchaseContractId.guardAgainstInvalidPrefix(value);
+        return new AuditEngagementSourcePurchaseContractId(value, false);
+    }
+    /**
+     * Validates that the id has the PurchaseContract prefix.
+     * The id format was already validated, so the prefix can be extracted safely.
+     */
+    static guardAgainstInvalidPrefix(value) {
+        const prefix = new AuditEngagementSourcePurchaseContractId(value, true).extractPrefix();
+        if (AuditEngagementSourcePurchaseContractId.VALID_PREFIXES.includes(prefix) === false) {
+            throw InvalidAggregatePrefixError_1.InvalidAggregatePrefixError.create(value, 'PurchaseContract', prefix, AuditEngagementSourcePurchaseContractId.VALID_PREFIXES, AuditEngagementSourcePurchaseContractId.PROPERTY_NAME);
+        }
+    }
+    static fromPrimitives(primitive) {
+        const value = primitive;
+        return new AuditEngagementSourcePurchaseContractId(value, true);
+    }
+    toPrimitives() {
+        return this.value;
+    }
+}
+exports.AuditEngagementSourcePurchaseContractId = AuditEngagementSourcePurchaseContractId;
+AuditEngagementSourcePurchaseContractId.PROPERTY_NAME = 'sourcePurchaseContractId';
+AuditEngagementSourcePurchaseContractId.VALID_PREFIXES = [
+    SemanticUuidPrefix_1.SemanticUuidPrefix.PMS_PURCHASE_CONTRACT,
+];

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementStatus.js

@@ -0,0 +1,68 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AuditEngagementStatus_instances, _AuditEngagementStatus_guardAgainstInvalidStatus;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementStatus = void 0;
+const String_1 = require("../../../../shared/domain/value-objects/String");
+const AuditEngagementStatus_1 = require("../enums/AuditEngagementStatus");
+const InvalidAuditEngagementStatusError_1 = require("../exceptions/InvalidAuditEngagementStatusError");
+class AuditEngagementStatus extends String_1.String {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementStatus.PROPERTY_NAME);
+        _AuditEngagementStatus_instances.add(this);
+        if (skipDomainValidation === false) {
+            __classPrivateFieldGet(this, _AuditEngagementStatus_instances, "m", _AuditEngagementStatus_guardAgainstInvalidStatus).call(this, value);
+        }
+    }
+    static create(value) {
+        String_1.String.guardAgainstEmptyValue(value, AuditEngagementStatus.PROPERTY_NAME);
+        String_1.String.guardAgainstInvalidType(value, AuditEngagementStatus.PROPERTY_NAME);
+        return new AuditEngagementStatus(value, false);
+    }
+    static fromPrimitives(primitive) {
+        const value = primitive;
+        return new AuditEngagementStatus(value, true);
+    }
+    is(status) {
+        return this.value === status;
+    }
+    isOneOf(statuses) {
+        return statuses.includes(this.value);
+    }
+    isPendingAcceptance() {
+        return this.is(AuditEngagementStatus_1.AuditEngagementStatus.PENDING_ACCEPTANCE);
+    }
+    isActive() {
+        return this.is(AuditEngagementStatus_1.AuditEngagementStatus.ACTIVE);
+    }
+    /**
+     * Whether the engagement can still change (PENDING_ACCEPTANCE, ACTIVE or SUSPENDED).
+     */
+    isLive() {
+        return this.isOneOf(AuditEngagementStatus.LIVE_STATUSES);
+    }
+    toPrimitives() {
+        return this.value;
+    }
+    toEnum() {
+        return this.value;
+    }
+}
+exports.AuditEngagementStatus = AuditEngagementStatus;
+_AuditEngagementStatus_instances = new WeakSet(), _AuditEngagementStatus_guardAgainstInvalidStatus = function _AuditEngagementStatus_guardAgainstInvalidStatus(value) {
+    const validStatuses = Object.values(AuditEngagementStatus_1.AuditEngagementStatus);
+    if (!validStatuses.includes(value)) {
+        throw InvalidAuditEngagementStatusError_1.InvalidAuditEngagementStatusError.create(value, validStatuses);
+    }
+};
+AuditEngagementStatus.PROPERTY_NAME = 'status';
+// Statuses from which the engagement can still change (the others are final)
+AuditEngagementStatus.LIVE_STATUSES = [
+    AuditEngagementStatus_1.AuditEngagementStatus.PENDING_ACCEPTANCE,
+    AuditEngagementStatus_1.AuditEngagementStatus.ACTIVE,
+    AuditEngagementStatus_1.AuditEngagementStatus.SUSPENDED,
+];

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementStatusChangedByStakeholder.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementStatusChangedByStakeholder = void 0;
+const NullableStakeholderReference_1 = require("../../../../shared/domain/value-objects/NullableStakeholderReference");
+/**
+ * Stakeholder who changed the status of an audit engagement, or null when the system changed it
+ * (the purchase contract expired, was suspended or was cancelled).
+ */
+class AuditEngagementStatusChangedByStakeholder extends NullableStakeholderReference_1.NullableStakeholderReference {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementStatusChangedByStakeholder.PROPERTY_NAME);
+    }
+    static create(value) {
+        return new AuditEngagementStatusChangedByStakeholder(value, false);
+    }
+    static fromPrimitives(primitives) {
+        const value = primitives;
+        return new AuditEngagementStatusChangedByStakeholder(value, true);
+    }
+    toPrimitives() {
+        return this.value;
+    }
+}
+exports.AuditEngagementStatusChangedByStakeholder = AuditEngagementStatusChangedByStakeholder;
+AuditEngagementStatusChangedByStakeholder.PROPERTY_NAME = 'changedByStakeholder';

package/build/carbonbox/carbon-footprint-audits/audit-engagements/domain/value-objects/AuditEngagementStatusHistory.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditEngagementStatusHistory = void 0;
+const ValueObject_1 = require("../../../../shared/domain/value-objects/ValueObject");
+const InvalidPropertyValueError_1 = require("../../../../shared/domain/exceptions/InvalidPropertyValueError");
+const AuditEngagementStatus_1 = require("../enums/AuditEngagementStatus");
+const AuditEngagementStatus_2 = require("./AuditEngagementStatus");
+const AuditEngagementEvaluatedAt_1 = require("./AuditEngagementEvaluatedAt");
+const AuditEngagementStatusChangedByStakeholder_1 = require("./AuditEngagementStatusChangedByStakeholder");
+/**
+ * Status history of an audit engagement, oldest first. It is what the carbon client and the host
+ * read to know who assigned, accepted, declined, replaced or revoked the engagement and when.
+ *
+ * Invariants: at least one entry, the first one is the assignment (PENDING_ACCEPTANCE), every
+ * status is valid, every moment is a valid datetime and reasons are up to 1000 characters.
+ */
+class AuditEngagementStatusHistory extends ValueObject_1.ValueObject {
+    constructor(value, skipDomainValidation) {
+        super(value, skipDomainValidation, AuditEngagementStatusHistory.PROPERTY_NAME, 'AuditEngagementStatusChangePrimitives[]');
+        if (skipDomainValidation === false) {
+            AuditEngagementStatusHistory.guardAgainstInvalidHistory(value);
+        }
+    }
+    static create(value) {
+        return new AuditEngagementStatusHistory(value, false);
+    }
+    static fromPrimitives(primitives) {
+        const value = primitives.map((primitive) => ({
+            status: primitive.status,
+            changedAt: primitive.changedAt,
+            changedByStakeholder: primitive.changedByStakeholder,
+            reason: primitive.reason,
+        }));
+        return new AuditEngagementStatusHistory(value, true);
+    }
+    static guardAgainstInvalidHistory(value) {
+        if (Array.isArray(value) === false || value.length === 0) {
+            throw InvalidPropertyValueError_1.InvalidPropertyValueError.create(AuditEngagementStatusHistory.PROPERTY_NAME, 'at least the assignment entry', 'an empty history');
+        }
+        if (value[0].status !== AuditEngagementStatus_1.AuditEngagementStatus.PENDING_ACCEPTANCE) {
+            throw InvalidPropertyValueError_1.InvalidPropertyValueError.create(AuditEngagementStatusHistory.PROPERTY_NAME, 'a first entry with status PENDING_ACCEPTANCE (the assignment)', String(value[0].status));
+        }
+        value.forEach((change) => {
+            AuditEngagementStatus_2.AuditEngagementStatus.create(change.status);
+            AuditEngagementEvaluatedAt_1.AuditEngagementEvaluatedAt.create(change.changedAt);
+            AuditEngagementStatusChangedByStakeholder_1.AuditEngagementStatusChangedByStakeholder.create(change.changedByStakeholder);
+            AuditEngagementStatusHistory.guardAgainstInvalidReason(change.reason);
+        });
+    }
+    static guardAgainstInvalidReason(reason) {
+        if (reason === null) {
+            return;
+        }
+        if (typeof reason !== 'string' || reason.trim() === '') {
+            throw InvalidPropertyValueError_1.InvalidPropertyValueError.create('reason', 'a non-empty text or null', String(reason));
+        }
+        if (reason.trim().length > AuditEngagementStatusHistory.REASON_MAX_LENGTH) {
+            throw InvalidPropertyValueError_1.InvalidPropertyValueError.create('reason', `up to ${AuditEngagementStatusHistory.REASON_MAX_LENGTH} characters`, `${reason.trim().length} characters`);
+        }
+    }
+    /**
+     * Returns the history with one more entry at the end (the history never changes in place).
+     */
+    append(change) {
+        return AuditEngagementStatusHistory.create([
+            ...this.toPrimitives(),
+            { ...change, reason: change.reason === null ? null : change.reason.trim() },
+        ]);
+    }
+    /**
+     * The last change to the given status, or null when the engagement never had it.
+     */
+    findLastChangeTo(status) {
+        const changes = this.value.filter((change) => change.status === status);
+        return changes.length === 0 ? null : changes[changes.length - 1];
+    }
+    toPrimitives() {
+        return this.value.map((change) => ({
+            status: change.status,
+            changedAt: change.changedAt,
+            changedByStakeholder: change.changedByStakeholder,
+            reason: change.reason,
+        }));
+    }
+}
+exports.AuditEngagementStatusHistory = AuditEngagementStatusHistory;
+AuditEngagementStatusHistory.PROPERTY_NAME = 'statusHistory';
+AuditEngagementStatusHistory.REASON_MAX_LENGTH = 1000;